ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.209 by root, Mon Feb 12 01:25:55 2007 UTC vs.
Revision 1.546 by root, Thu May 6 22:57:49 2010 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
2 24
3use utf8; 25use common::sense;
4use strict;
5 26
6use Symbol; 27use Symbol;
7use List::Util; 28use List::Util;
8use Storable; 29use Socket;
30use EV;
9use Opcode; 31use Opcode;
10use Safe; 32use Safe;
11use Safe::Hole; 33use Safe::Hole;
34use Storable ();
35use Carp ();
12 36
37use Guard ();
13use Coro 3.5 (); 38use Coro ();
39use Coro::State;
40use Coro::Handle;
41use Coro::EV;
14use Coro::Event; 42use Coro::AnyEvent;
15use Coro::Timer; 43use Coro::Timer;
16use Coro::Signal; 44use Coro::Signal;
17use Coro::Semaphore; 45use Coro::Semaphore;
46use Coro::SemaphoreSet;
47use Coro::AnyEvent;
18use Coro::AIO; 48use Coro::AIO;
49use Coro::BDB 1.6;
50use Coro::Storable;
51use Coro::Util ();
19 52
53use JSON::XS 2.01 ();
20use BDB (); 54use BDB ();
21use Data::Dumper; 55use Data::Dumper;
22use Digest::MD5;
23use Fcntl; 56use Fcntl;
24use IO::AIO 2.32 ();
25use YAML::Syck (); 57use YAML::XS ();
58use IO::AIO ();
26use Time::HiRes; 59use Time::HiRes;
27use Compress::LZF; 60use Compress::LZF;
61use Digest::MD5 ();
28 62
63AnyEvent::detect;
64
65# configure various modules to our taste
66#
67$Storable::canonical = 1; # reduce rsync transfers
68Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
69
70$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
71
72# make sure c-lzf reinitialises itself
73Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 74Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 75
31use Event; $Event::Eval = 1; # no idea why this is required, but it is 76# strictly for debugging
77$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
32 78
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 79sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 80
35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 81our @ORIG_INC;
36$YAML::Syck::ImplicitUnicode = 1;
37
38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39 82
40our %COMMAND = (); 83our %COMMAND = ();
41our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
42 85
43our @EXTS = (); # list of extension package names 86our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 89our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 90our %EXT_MAP = (); # pluggable maps
47 91
92our $RELOAD; # number of reloads so far, non-zero while in reload
48our @EVENT; 93our @EVENT;
49our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
50 96
51our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
52our $TICK_WATCHER; 98our $DATADIR = datadir;
53our $AIO_POLL_WATCHER; 99our $LIBDIR = "$DATADIR/ext";
54our $WRITE_RUNTIME_WATCHER; 100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE; # unused
112
113our $OUTPUT_RATE_MIN = 3000;
114our $OUTPUT_RATE_MAX = 1000000;
115
116our $MAX_LINKS = 32; # how many chained exits to follow
117our $VERBOSE_IO = 1;
118
119our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 121our $NEXT_TICK;
56our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off 122our $USE_FSYNC = 1; # use fsync to write maps - default on
58 123
124our $BDB_DEADLOCK_WATCHER;
125our $BDB_CHECKPOINT_WATCHER;
59our $BDB_POLL_WATCHER; 126our $BDB_TRICKLE_WATCHER;
60our $DB_ENV; 127our $DB_ENV;
128
129our @EXTRA_MODULES = qw(pod match mapscript incloader);
61 130
62our %CFG; 131our %CFG;
63 132
64our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
65our $RUNTIME; 134our $RUNTIME;
135our $NOW;
66 136
67our %PLAYER; # all users 137our (%PLAYER, %PLAYER_LOADING); # all users
68our %MAP; # all maps 138our (%MAP, %MAP_LOADING ); # all maps
69our $LINK_MAP; # the special {link} map, which is always available 139our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 140
76# used to convert map paths into valid unix filenames by replacing / by ∕ 141# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 143
144our $LOAD; # a number between 0 (idle) and 1 (too many objects)
145our $LOADAVG; # same thing, but with alpha-smoothing
146our $JITTER; # average jitter
147our $TICK_START; # for load detecting purposes
148
149our @POST_INIT;
150
151our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
152our $REALLY_UNLOOP; # never set to true, please :)
153
79binmode STDOUT; 154binmode STDOUT;
80binmode STDERR; 155binmode STDERR;
81 156
82# read virtual server time, if available 157# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
84 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
85 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
86 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
87} 162}
88 163
89mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
90mkdir cf::localdir . "/" . cf::playerdir; 165
91mkdir cf::localdir . "/" . cf::tmpdir; 166mkdir $_
92mkdir cf::localdir . "/" . cf::uniquedir; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 168
96our $EMERGENCY_POSITION; 169our $EMERGENCY_POSITION;
97 170
98sub cf::map::normalise; 171sub cf::map::normalise;
172
173sub in_main() {
174 $Coro::current == $Coro::main
175}
176
177#############################################################################
178
179%REFLECT = ();
180for (@REFLECT) {
181 my $reflect = JSON::XS::decode_json $_;
182 $REFLECT{$reflect->{class}} = $reflect;
183}
184
185# this is decidedly evil
186$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
99 187
100############################################################################# 188#############################################################################
101 189
102=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
103 191
110=item $cf::RUNTIME 198=item $cf::RUNTIME
111 199
112The time this server has run, starts at 0 and is increased by $cf::TICK on 200The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick. 201every server tick.
114 202
115=item $cf::LIBDIR 203=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
204$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
205$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116 206
117The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
118be found. It will be added to C<@INC> automatically. 208directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
209unique-items directory, player file directory, random maps directory and
210database environment.
119 211
120=item $cf::NOW 212=item $cf::NOW
121 213
122The time of the last (current) server tick. 214The time of the last (current) server tick.
123 215
124=item $cf::TICK 216=item $cf::TICK
125 217
126The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
127 219
220=item $cf::LOADAVG
221
222The current CPU load on the server (alpha-smoothed), as a value between 0
223(none) and 1 (overloaded), indicating how much time is spent on processing
224objects per tick. Healthy values are < 0.5.
225
226=item $cf::LOAD
227
228The raw value load value from the last tick.
229
128=item %cf::CFG 230=item %cf::CFG
129 231
130Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
131from wherever your confdir points to. 233from wherever your confdir points to.
132 234
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 235=item cf::wait_for_tick, cf::wait_for_tick_begin
134 236
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 237These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 238returns directly I<after> the tick processing (and consequently, can only wake one thread
137processing has been done. Call C<< ->wait >> on them to maximise the 239per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick. 240
241=cut
242
243sub wait_for_tick();
244sub wait_for_tick_begin();
245
246=item @cf::INVOKE_RESULTS
247
248This array contains the results of the last C<invoke ()> call. When
249C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
250that call.
251
252=item %cf::REFLECT
253
254Contains, for each (C++) class name, a hash reference with information
255about object members (methods, scalars, arrays and flags) and other
256metadata, which is useful for introspection.
139 257
140=back 258=back
141 259
142=cut 260=cut
143 261
144BEGIN { 262sub error(@) { LOG llevError, join "", @_ }
145 *CORE::GLOBAL::warn = sub { 263sub warn (@) { LOG llevWarn , join "", @_ }
264sub info (@) { LOG llevInfo , join "", @_ }
265sub debug(@) { LOG llevDebug, join "", @_ }
266sub trace(@) { LOG llevTrace, join "", @_ }
267
268$Coro::State::WARNHOOK = sub {
146 my $msg = join "", @_; 269 my $msg = join "", @_;
147 utf8::encode $msg;
148 270
149 $msg .= "\n" 271 $msg .= "\n"
150 unless $msg =~ /\n$/; 272 unless $msg =~ /\n$/;
151 273
274 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
275
152 LOG llevError, $msg; 276 LOG llevWarn, $msg;
153 }; 277};
154} 278
279$Coro::State::DIEHOOK = sub {
280 return unless $^S eq 0; # "eq", not "=="
281
282 error Carp::longmess $_[0];
283
284 if (in_main) {#d#
285 error "DIEHOOK called in main context, Coro bug?\n";#d#
286 return;#d#
287 }#d#
288
289 # kill coroutine otherwise
290 Coro::terminate
291};
155 292
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 293@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 294@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 295@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 296@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 297@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
298@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 299@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162 300
163# we bless all objects into (empty) derived classes to force a method lookup 301# we bless all objects into (empty) derived classes to force a method lookup
164# within the Safe compartment. 302# within the Safe compartment.
165for my $pkg (qw( 303for my $pkg (qw(
166 cf::global cf::attachable 304 cf::global cf::attachable
167 cf::object cf::object::player 305 cf::object cf::object::player
168 cf::client cf::player 306 cf::client cf::player
169 cf::arch cf::living 307 cf::arch cf::living
308 cf::map cf::mapspace
170 cf::map cf::party cf::region 309 cf::party cf::region
171)) { 310)) {
172 no strict 'refs';
173 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 311 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
174} 312}
175 313
176$Event::DIED = sub { 314$EV::DIED = sub {
177 warn "error in event callback: @_"; 315 Carp::cluck "error in event callback: @_";
178}; 316};
317
318#############################################################################
179 319
180=head2 UTILITY FUNCTIONS 320=head2 UTILITY FUNCTIONS
181 321
182=over 4 322=over 4
183 323
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 342 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 343 $d
204 } || "[unable to dump $_[0]: '$@']"; 344 } || "[unable to dump $_[0]: '$@']";
205} 345}
206 346
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 347=item $ref = cf::decode_json $json
210 348
211Converts a JSON string into the corresponding perl data structure. 349Converts a JSON string into the corresponding perl data structure.
212 350
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 351=item $json = cf::encode_json $ref
221 352
222Converts a perl data structure into its JSON representation. 353Converts a perl data structure into its JSON representation.
223 354
224=cut 355=cut
225 356
226sub to_json($) { 357our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 358
228 JSON::Syck::Dump $_[0] 359sub encode_json($) { $json_coder->encode ($_[0]) }
360sub decode_json($) { $json_coder->decode ($_[0]) }
361
362=item cf::post_init { BLOCK }
363
364Execute the given codeblock, I<after> all extensions have been (re-)loaded,
365but I<before> the server starts ticking again.
366
367The cdoeblock will have a single boolean argument to indicate whether this
368is a reload or not.
369
370=cut
371
372sub post_init(&) {
373 push @POST_INIT, shift;
229} 374}
230 375
231=item cf::lock_wait $string 376=item cf::lock_wait $string
232 377
233Wait until the given lock is available. See cf::lock_acquire. 378Wait until the given lock is available. See cf::lock_acquire.
234 379
235=item my $lock = cf::lock_acquire $string 380=item my $lock = cf::lock_acquire $string
236 381
237Wait until the given lock is available and then acquires it and returns 382Wait until the given lock is available and then acquires it and returns
238a Coro::guard object. If the guard object gets destroyed (goes out of scope, 383a L<Guard> object. If the guard object gets destroyed (goes out of scope,
239for example when the coroutine gets canceled), the lock is automatically 384for example when the coroutine gets canceled), the lock is automatically
240returned. 385returned.
241 386
387Locks are *not* recursive, locking from the same coro twice results in a
388deadlocked coro.
389
242Lock names should begin with a unique identifier (for example, cf::map::find 390Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 391uses map_find and cf::map::load uses map_load).
244 392
245=cut 393=item $locked = cf::lock_active $string
246 394
247our %LOCK; 395Return true if the lock is currently active, i.e. somebody has locked it.
396
397=cut
398
399our $LOCKS = new Coro::SemaphoreSet;
248 400
249sub lock_wait($) { 401sub lock_wait($) {
250 my ($key) = @_; 402 $LOCKS->wait ($_[0]);
251
252 # wait for lock, if any
253 while ($LOCK{$key}) {
254 push @{ $LOCK{$key} }, $Coro::current;
255 Coro::schedule;
256 }
257} 403}
258 404
259sub lock_acquire($) { 405sub lock_acquire($) {
260 my ($key) = @_; 406 $LOCKS->guard ($_[0])
407}
261 408
262 # wait, to be sure we are not locked 409sub lock_active($) {
263 lock_wait $key; 410 $LOCKS->count ($_[0]) < 1
264
265 $LOCK{$key} = [];
266
267 Coro::guard {
268 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} };
270 }
271} 411}
272 412
273sub freeze_mainloop { 413sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 414 tick_inhibit_inc;
275 415
276 my $guard = Coro::guard { 416 &Guard::guard (\&tick_inhibit_dec);
277 $TICK_WATCHER->start; 417}
278 $WRITE_RUNTIME_WATCHER->start; 418
419=item cf::periodic $interval, $cb
420
421Like EV::periodic, but randomly selects a starting point so that the actions
422get spread over time.
423
424=cut
425
426sub periodic($$) {
427 my ($interval, $cb) = @_;
428
429 my $start = rand List::Util::min 180, $interval;
430
431 EV::periodic $start, $interval, 0, $cb
432}
433
434=item cf::get_slot $time[, $priority[, $name]]
435
436Allocate $time seconds of blocking CPU time at priority C<$priority>:
437This call blocks and returns only when you have at least C<$time> seconds
438of cpu time till the next tick. The slot is only valid till the next cede.
439
440The optional C<$name> can be used to identify the job to run. It might be
441used for statistical purposes and should identify the same time-class.
442
443Useful for short background jobs.
444
445=cut
446
447our @SLOT_QUEUE;
448our $SLOT_QUEUE;
449our $SLOT_DECAY = 0.9;
450
451$SLOT_QUEUE->cancel if $SLOT_QUEUE;
452$SLOT_QUEUE = Coro::async {
453 $Coro::current->desc ("timeslot manager");
454
455 my $signal = new Coro::Signal;
456 my $busy;
457
458 while () {
459 next_job:
460
461 my $avail = cf::till_tick;
462
463 for (0 .. $#SLOT_QUEUE) {
464 if ($SLOT_QUEUE[$_][0] <= $avail) {
465 $busy = 0;
466 my $job = splice @SLOT_QUEUE, $_, 1, ();
467 $job->[2]->send;
468 Coro::cede;
469 goto next_job;
470 } else {
471 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
472 }
473 }
474
475 if (@SLOT_QUEUE) {
476 # we do not use wait_for_tick() as it returns immediately when tick is inactive
477 push @cf::WAIT_FOR_TICK, $signal;
478 $signal->wait;
479 } else {
480 $busy = 0;
481 Coro::schedule;
482 }
279 }; 483 }
280 $WRITE_RUNTIME_WATCHER->stop; 484};
281 $TICK_WATCHER->stop; 485
282 $guard 486sub get_slot($;$$) {
487 return if tick_inhibit || $Coro::current == $Coro::main;
488
489 my ($time, $pri, $name) = @_;
490
491 $time = clamp $time, 0.01, $TICK * .6;
492
493 my $sig = new Coro::Signal;
494
495 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
496 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
497 $SLOT_QUEUE->ready;
498 $sig->wait;
283} 499}
284 500
285=item cf::async { BLOCK } 501=item cf::async { BLOCK }
286 502
287Currently the same as Coro::async_pool, meaning you cannot use 503Currently the same as Coro::async_pool, meaning you cannot use
292 508
293BEGIN { *async = \&Coro::async_pool } 509BEGIN { *async = \&Coro::async_pool }
294 510
295=item cf::sync_job { BLOCK } 511=item cf::sync_job { BLOCK }
296 512
297The design of crossfire+ requires that the main coro ($Coro::main) is 513The design of Deliantra requires that the main coroutine ($Coro::main)
298always able to handle events or runnable, as crossfire+ is only partly 514is always able to handle events or runnable, as Deliantra is only
299reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 515partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
516acceptable.
300 517
301If it must be done, put the blocking parts into C<sync_job>. This will run 518If it must be done, put the blocking parts into C<sync_job>. This will run
302the given BLOCK in another coroutine while waiting for the result. The 519the given BLOCK in another coroutine while waiting for the result. The
303server will be frozen during this time, so the block should either finish 520server will be frozen during this time, so the block should either finish
304fast or be very important. 521fast or be very important.
306=cut 523=cut
307 524
308sub sync_job(&) { 525sub sync_job(&) {
309 my ($job) = @_; 526 my ($job) = @_;
310 527
311 if ($Coro::current == $Coro::main) { 528 if (in_main) {
529 my $time = AE::time;
530
312 # this is the main coro, too bad, we have to block 531 # this is the main coro, too bad, we have to block
313 # till the operation succeeds, freezing the server :/ 532 # till the operation succeeds, freezing the server :/
314 533
315 # TODO: use suspend/resume instead 534 #LOG llevError, Carp::longmess "sync job";#d#
316 # (but this is cancel-safe) 535
317 my $freeze_guard = freeze_mainloop; 536 my $freeze_guard = freeze_mainloop;
318 537
319 my $busy = 1; 538 my $busy = 1;
320 my @res; 539 my @res;
321 540
322 (async { 541 (async {
542 $Coro::current->desc ("sync job coro");
323 @res = eval { $job->() }; 543 @res = eval { $job->() };
324 warn $@ if $@; 544 error $@ if $@;
325 undef $busy; 545 undef $busy;
326 })->prio (Coro::PRIO_MAX); 546 })->prio (Coro::PRIO_MAX);
327 547
328 while ($busy) { 548 while ($busy) {
329 Coro::cede or Event::one_event; 549 if (Coro::nready) {
550 Coro::cede_notself;
551 } else {
552 EV::loop EV::LOOP_ONESHOT;
330 } 553 }
554 }
555
556 my $time = AE::time - $time;
557
558 $TICK_START += $time; # do not account sync jobs to server load
331 559
332 wantarray ? @res : $res[0] 560 wantarray ? @res : $res[0]
333 } else { 561 } else {
334 # we are in another coroutine, how wonderful, everything just works 562 # we are in another coroutine, how wonderful, everything just works
335 563
355 $EXT_CORO{$coro+0} = $coro; 583 $EXT_CORO{$coro+0} = $coro;
356 584
357 $coro 585 $coro
358} 586}
359 587
360sub write_runtime { 588=item fork_call { }, $args
361 my $runtime = cf::localdir . "/runtime";
362 589
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 590Executes the given code block with the given arguments in a seperate
364 or return; 591process, returning the results. Everything must be serialisable with
592Coro::Storable. May, of course, block. Note that the executed sub may
593never block itself or use any form of event handling.
365 594
366 my $value = $cf::RUNTIME + 90 + 10; 595=cut
367 # 10 is the runtime save interval, for a monotonic clock
368 # 60 allows for the watchdog to kill the server.
369 596
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0 597sub fork_call(&@) {
371 and return; 598 my ($cb, @args) = @_;
372 599
373 # always fsync - this file is important 600 # we seemingly have to make a local copy of the whole thing,
374 aio_fsync $fh 601 # otherwise perl prematurely frees the stuff :/
375 and return; 602 # TODO: investigate and fix (likely this will be rather laborious)
376 603
377 close $fh 604 my @res = Coro::Util::fork_eval {
378 or return; 605 reset_signals;
606 &$cb
607 }, @args;
379 608
380 aio_rename "$runtime~", $runtime 609 wantarray ? @res : $res[-1]
381 and return; 610}
382 611
612sub objinfo {
383 1 613 (
614 "counter value" => cf::object::object_count,
615 "objects created" => cf::object::create_count,
616 "objects destroyed" => cf::object::destroy_count,
617 "freelist size" => cf::object::free_count,
618 "allocated objects" => cf::object::objects_size,
619 "active objects" => cf::object::actives_size,
620 )
621}
622
623=item $coin = coin_from_name $name
624
625=cut
626
627our %coin_alias = (
628 "silver" => "silvercoin",
629 "silvercoin" => "silvercoin",
630 "silvercoins" => "silvercoin",
631 "gold" => "goldcoin",
632 "goldcoin" => "goldcoin",
633 "goldcoins" => "goldcoin",
634 "platinum" => "platinacoin",
635 "platinumcoin" => "platinacoin",
636 "platinumcoins" => "platinacoin",
637 "platina" => "platinacoin",
638 "platinacoin" => "platinacoin",
639 "platinacoins" => "platinacoin",
640 "royalty" => "royalty",
641 "royalties" => "royalty",
642);
643
644sub coin_from_name($) {
645 $coin_alias{$_[0]}
646 ? cf::arch::find $coin_alias{$_[0]}
647 : undef
648}
649
650=item $value = cf::db_get $family => $key
651
652Returns a single value from the environment database.
653
654=item cf::db_put $family => $key => $value
655
656Stores the given C<$value> in the family. It can currently store binary
657data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
658
659=item $db = cf::db_table "name"
660
661Create and/or open a new database table. The string must not be "db" and must be unique
662within each server.
663
664=cut
665
666sub db_table($) {
667 cf::error "db_get called from main context"
668 if $Coro::current == $Coro::main;
669
670 my ($name) = @_;
671 my $db = BDB::db_create $DB_ENV;
672
673 eval {
674 $db->set_flags (BDB::CHKSUM);
675
676 utf8::encode $name;
677 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
678 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
679 cf::cleanup "db_open(db): $!" if $!;
680 };
681 cf::cleanup "db_open(db): $@" if $@;
682
683 $db
684}
685
686our $DB;
687
688sub db_init {
689 $DB ||= db_table "db";
690}
691
692sub db_get($$) {
693 my $key = "$_[0]/$_[1]";
694
695 cf::error "db_get called from main context"
696 if $Coro::current == $Coro::main;
697
698 BDB::db_get $DB, undef, $key, my $data;
699
700 $! ? ()
701 : $data
702}
703
704sub db_put($$$) {
705 BDB::dbreq_pri 4;
706 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
707}
708
709=item cf::cache $id => [$paths...], $processversion => $process
710
711Generic caching function that returns the value of the resource $id,
712caching and regenerating as required.
713
714This function can block.
715
716=cut
717
718sub cache {
719 my ($id, $src, $processversion, $process) = @_;
720
721 my $meta =
722 join "\x00",
723 $processversion,
724 map {
725 aio_stat $_
726 and Carp::croak "$_: $!";
727
728 ($_, (stat _)[7,9])
729 } @$src;
730
731 my $dbmeta = db_get cache => "$id/meta";
732 if ($dbmeta ne $meta) {
733 # changed, we may need to process
734
735 my @data;
736 my $md5;
737
738 for (0 .. $#$src) {
739 0 <= aio_load $src->[$_], $data[$_]
740 or Carp::croak "$src->[$_]: $!";
741 }
742
743 # if processing is expensive, check
744 # checksum first
745 if (1) {
746 $md5 =
747 join "\x00",
748 $processversion,
749 map {
750 cf::cede_to_tick;
751 ($src->[$_], Digest::MD5::md5_hex $data[$_])
752 } 0.. $#$src;
753
754
755 my $dbmd5 = db_get cache => "$id/md5";
756 if ($dbmd5 eq $md5) {
757 db_put cache => "$id/meta", $meta;
758
759 return db_get cache => "$id/data";
760 }
761 }
762
763 my $t1 = Time::HiRes::time;
764 my $data = $process->(\@data);
765 my $t2 = Time::HiRes::time;
766
767 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
768
769 db_put cache => "$id/data", $data;
770 db_put cache => "$id/md5" , $md5;
771 db_put cache => "$id/meta", $meta;
772
773 return $data;
774 }
775
776 db_get cache => "$id/data"
777}
778
779=item cf::datalog type => key => value, ...
780
781Log a datalog packet of the given type with the given key-value pairs.
782
783=cut
784
785sub datalog($@) {
786 my ($type, %kv) = @_;
787 info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 788}
385 789
386=back 790=back
387 791
388=cut 792=cut
389 793
390############################################################################# 794#############################################################################
391 795
392=head2 ATTACHABLE OBJECTS 796=head2 ATTACHABLE OBJECTS
393 797
394Many objects in crossfire are so-called attachable objects. That means you can 798Many objects in deliantra are so-called attachable objects. That means you can
395attach callbacks/event handlers (a collection of which is called an "attachment") 799attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 800to it. All such attachable objects support the following methods.
397 801
398In the following description, CLASS can be any of C<global>, C<object> 802In the following description, CLASS can be any of C<global>, C<object>
399C<player>, C<client> or C<map> (i.e. the attachable objects in 803C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 804Deliantra).
401 805
402=over 4 806=over 4
403 807
404=item $attachable->attach ($attachment, key => $value...) 808=item $attachable->attach ($attachment, key => $value...)
405 809
449=item cf::CLASS::attachment $name, ... 853=item cf::CLASS::attachment $name, ...
450 854
451Register an attachment by C<$name> through which attachable objects of the 855Register an attachment by C<$name> through which attachable objects of the
452given CLASS can refer to this attachment. 856given CLASS can refer to this attachment.
453 857
454Some classes such as crossfire maps and objects can specify attachments 858Some classes such as deliantra maps and objects can specify attachments
455that are attached at load/instantiate time, thus the need for a name. 859that are attached at load/instantiate time, thus the need for a name.
456 860
457These calls expect any number of the following handler/hook descriptions: 861These calls expect any number of the following handler/hook descriptions:
458 862
459=over 4 863=over 4
568 $registry = $CB_TYPE[$object_type] ||= []; 972 $registry = $CB_TYPE[$object_type] ||= [];
569 973
570 } elsif ($type eq "subtype") { 974 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 975 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 976 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 977 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 978
575 } elsif ($type eq "package") { 979 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 980 my $pkg = shift @arg;
577 981
578 while (my ($name, $id) = each %cb_id) { 982 while (my ($name, $id) = each %cb_id) {
583 987
584 } elsif (exists $cb_id{$type}) { 988 } elsif (exists $cb_id{$type}) {
585 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 989 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
586 990
587 } elsif (ref $type) { 991 } elsif (ref $type) {
588 warn "attaching objects not supported, ignoring.\n"; 992 error "attaching objects not supported, ignoring.\n";
589 993
590 } else { 994 } else {
591 shift @arg; 995 shift @arg;
592 warn "attach argument '$type' not supported, ignoring.\n"; 996 error "attach argument '$type' not supported, ignoring.\n";
593 } 997 }
594 } 998 }
595} 999}
596 1000
597sub _object_attach { 1001sub _object_attach {
607 _attach $registry, $klass, @attach; 1011 _attach $registry, $klass, @attach;
608 } 1012 }
609 1013
610 $obj->{$name} = \%arg; 1014 $obj->{$name} = \%arg;
611 } else { 1015 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 1016 info "object uses attachment '$name' which is not available, postponing.\n";
613 } 1017 }
614 1018
615 $obj->{_attachment}{$name} = undef; 1019 $obj->{_attachment}{$name} = undef;
616} 1020}
617 1021
619 if (ref $_[0]) { 1023 if (ref $_[0]) {
620 _object_attach @_; 1024 _object_attach @_;
621 } else { 1025 } else {
622 _attach shift->_attach_registry, @_; 1026 _attach shift->_attach_registry, @_;
623 } 1027 }
1028 _recalc_want;
624}; 1029};
625 1030
626# all those should be optimised 1031# all those should be optimised
627sub cf::attachable::detach { 1032sub cf::attachable::detach {
628 my ($obj, $name) = @_; 1033 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 1036 delete $obj->{_attachment}{$name};
632 reattach ($obj); 1037 reattach ($obj);
633 } else { 1038 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 1039 Carp::croak "cannot, currently, detach class attachments";
635 } 1040 }
1041 _recalc_want;
636}; 1042};
637 1043
638sub cf::attachable::attached { 1044sub cf::attachable::attached {
639 my ($obj, $name) = @_; 1045 my ($obj, $name) = @_;
640 1046
655 "; 1061 ";
656 die if $@; 1062 die if $@;
657} 1063}
658 1064
659our $override; 1065our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1066our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661 1067
662sub override { 1068sub override {
663 $override = 1; 1069 $override = 1;
664 @invoke_results = (); 1070 @INVOKE_RESULTS = (@_);
665} 1071}
666 1072
667sub do_invoke { 1073sub do_invoke {
668 my $event = shift; 1074 my $event = shift;
669 my $callbacks = shift; 1075 my $callbacks = shift;
670 1076
671 @invoke_results = (); 1077 @INVOKE_RESULTS = ();
672 1078
673 local $override; 1079 local $override;
674 1080
675 for (@$callbacks) { 1081 for (@$callbacks) {
676 eval { &{$_->[1]} }; 1082 eval { &{$_->[1]} };
677 1083
678 if ($@) { 1084 if ($@) {
679 warn "$@";
680 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1085 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
681 override; 1086 override;
682 } 1087 }
683 1088
684 return 1 if $override; 1089 return 1 if $override;
685 } 1090 }
686 1091
687 0 1092 0
688} 1093}
689 1094
690=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1095=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
691 1096
692=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1097=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
693 1098
694Generate an object-specific event with the given arguments. 1099Generate an object-specific event with the given arguments.
695 1100
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1101This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697removed in future versions), and there is no public API to access override 1102removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly). 1103results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 1104
700=back 1105=back
701 1106
702=cut 1107=cut
703 1108
704############################################################################# 1109#############################################################################
705# object support 1110# object support
1111
1112sub _object_equal($$);
1113sub _object_equal($$) {
1114 my ($a, $b) = @_;
1115
1116 return 0 unless (ref $a) eq (ref $b);
1117
1118 if ("HASH" eq ref $a) {
1119 my @ka = keys %$a;
1120 my @kb = keys %$b;
1121
1122 return 0 if @ka != @kb;
1123
1124 for (0 .. $#ka) {
1125 return 0 unless $ka[$_] eq $kb[$_];
1126 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1127 }
1128
1129 } elsif ("ARRAY" eq ref $a) {
1130
1131 return 0 if @$a != @$b;
1132
1133 for (0 .. $#$a) {
1134 return 0 unless _object_equal $a->[$_], $b->[$_];
1135 }
1136
1137 } elsif ($a ne $b) {
1138 return 0;
1139 }
1140
1141 1
1142}
1143
1144our $SLOW_MERGES;#d#
1145sub _can_merge {
1146 my ($ob1, $ob2) = @_;
1147
1148 ++$SLOW_MERGES;#d#
1149
1150 # we do the slow way here
1151 return _object_equal $ob1, $ob2
1152}
706 1153
707sub reattach { 1154sub reattach {
708 # basically do the same as instantiate, without calling instantiate 1155 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_; 1156 my ($obj) = @_;
710 1157
1158 # no longer needed after getting rid of delete_package?
711 bless $obj, ref $obj; # re-bless in case extensions have been reloaded 1159 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
712 1160
713 my $registry = $obj->registry; 1161 my $registry = $obj->registry;
714 1162
715 @$registry = (); 1163 @$registry = ();
716 1164
721 for (@$attach) { 1169 for (@$attach) {
722 my ($klass, @attach) = @$_; 1170 my ($klass, @attach) = @$_;
723 _attach $registry, $klass, @attach; 1171 _attach $registry, $klass, @attach;
724 } 1172 }
725 } else { 1173 } else {
726 warn "object uses attachment '$name' that is not available, postponing.\n"; 1174 info "object uses attachment '$name' that is not available, postponing.\n";
727 } 1175 }
728 } 1176 }
729} 1177}
730 1178
731cf::attachable->attach ( 1179cf::attachable->attach (
732 prio => -1000000, 1180 prio => -1000000,
733 on_instantiate => sub { 1181 on_instantiate => sub {
734 my ($obj, $data) = @_; 1182 my ($obj, $data) = @_;
735 1183
736 $data = from_json $data; 1184 $data = decode_json $data;
737 1185
738 for (@$data) { 1186 for (@$data) {
739 my ($name, $args) = @$_; 1187 my ($name, $args) = @$_;
740 1188
741 $obj->attach ($name, %{$args || {} }); 1189 $obj->attach ($name, %{$args || {} });
757sub object_freezer_save { 1205sub object_freezer_save {
758 my ($filename, $rdata, $objs) = @_; 1206 my ($filename, $rdata, $objs) = @_;
759 1207
760 sync_job { 1208 sync_job {
761 if (length $$rdata) { 1209 if (length $$rdata) {
1210 utf8::decode (my $decname = $filename);
762 warn sprintf "saving %s (%d,%d)\n", 1211 trace sprintf "saving %s (%d,%d)\n",
763 $filename, length $$rdata, scalar @$objs; 1212 $decname, length $$rdata, scalar @$objs
1213 if $VERBOSE_IO;
764 1214
765 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1215 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
766 chmod SAVE_MODE, $fh; 1216 aio_chmod $fh, SAVE_MODE;
767 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1217 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
768 aio_fsync $fh if $cf::USE_FSYNC; 1218 if ($cf::USE_FSYNC) {
1219 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1220 aio_fsync $fh;
1221 }
769 close $fh; 1222 aio_close $fh;
770 1223
771 if (@$objs) { 1224 if (@$objs) {
772 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1225 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
773 chmod SAVE_MODE, $fh; 1226 aio_chmod $fh, SAVE_MODE;
774 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1227 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
775 aio_write $fh, 0, (length $data), $data, 0; 1228 aio_write $fh, 0, (length $data), $data, 0;
776 aio_fsync $fh if $cf::USE_FSYNC; 1229 if ($cf::USE_FSYNC) {
1230 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1231 aio_fsync $fh;
1232 }
777 close $fh; 1233 aio_close $fh;
778 aio_rename "$filename.pst~", "$filename.pst"; 1234 aio_rename "$filename.pst~", "$filename.pst";
779 } 1235 }
780 } else { 1236 } else {
781 aio_unlink "$filename.pst"; 1237 aio_unlink "$filename.pst";
782 } 1238 }
783 1239
784 aio_rename "$filename~", $filename; 1240 aio_rename "$filename~", $filename;
1241
1242 $filename =~ s%/[^/]+$%%;
1243 aio_pathsync $filename if $cf::USE_FSYNC;
785 } else { 1244 } else {
786 warn "FATAL: $filename~: $!\n"; 1245 error "unable to save objects: $filename~: $!\n";
787 } 1246 }
788 } else { 1247 } else {
789 aio_unlink $filename; 1248 aio_unlink $filename;
790 aio_unlink "$filename.pst"; 1249 aio_unlink "$filename.pst";
791 } 1250 }
792
793 #d##TODO# nuke non .map-files if exist
794 if ($filename =~ s/\.map$//) {
795 aio_unlink $filename;
796 aio_unlink "$filename.pst";
797 }
798 } 1251 };
799} 1252}
800 1253
801sub object_freezer_as_string { 1254sub object_freezer_as_string {
802 my ($rdata, $objs) = @_; 1255 my ($rdata, $objs) = @_;
803 1256
808 1261
809sub object_thawer_load { 1262sub object_thawer_load {
810 my ($filename) = @_; 1263 my ($filename) = @_;
811 1264
812 my ($data, $av); 1265 my ($data, $av);
813
814 #d#TODO remove .map if file does not exist
815 aio_stat $filename and $filename =~ s/\.map$//;
816 1266
817 (aio_load $filename, $data) >= 0 1267 (aio_load $filename, $data) >= 0
818 or return; 1268 or return;
819 1269
820 unless (aio_stat "$filename.pst") { 1270 unless (aio_stat "$filename.pst") {
821 (aio_load "$filename.pst", $av) >= 0 1271 (aio_load "$filename.pst", $av) >= 0
822 or return; 1272 or return;
1273
823 $av = eval { (Storable::thaw $av)->{objs} }; 1274 my $st = eval { Coro::Storable::thaw $av };
1275 $av = $st->{objs};
824 } 1276 }
825 1277
1278 utf8::decode (my $decname = $filename);
826 warn sprintf "loading %s (%d)\n", 1279 trace sprintf "loading %s (%d,%d)\n",
827 $filename, length $data, scalar @{$av || []};#d# 1280 $decname, length $data, scalar @{$av || []}
1281 if $VERBOSE_IO;
1282
828 return ($data, $av); 1283 ($data, $av)
829} 1284}
1285
1286=head2 COMMAND CALLBACKS
1287
1288=over 4
1289
1290=cut
830 1291
831############################################################################# 1292#############################################################################
832# command handling &c 1293# command handling &c
833 1294
834=item cf::register_command $name => \&callback($ob,$args); 1295=item cf::register_command $name => \&callback($ob,$args);
847 push @{ $COMMAND{$name} }, [$caller, $cb]; 1308 push @{ $COMMAND{$name} }, [$caller, $cb];
848} 1309}
849 1310
850=item cf::register_extcmd $name => \&callback($pl,$packet); 1311=item cf::register_extcmd $name => \&callback($pl,$packet);
851 1312
852Register a callbackf ro execution when the client sends an extcmd packet. 1313Register a callback for execution when the client sends an (synchronous)
1314extcmd packet. Ext commands will be processed in the order they are
1315received by the server, like other user commands. The first argument is
1316the logged-in player. Ext commands can only be processed after a player
1317has logged in successfully.
853 1318
854If the callback returns something, it is sent back as if reply was being 1319If the callback returns something, it is sent back as if reply was being
855called. 1320called.
856 1321
1322=item cf::register_exticmd $name => \&callback($ns,$packet);
1323
1324Register a callback for execution when the client sends an (asynchronous)
1325exticmd packet. Exti commands are processed by the server as soon as they
1326are received, i.e. out of order w.r.t. other commands. The first argument
1327is a client socket. Exti commands can be received anytime, even before
1328log-in.
1329
1330If the callback returns something, it is sent back as if reply was being
1331called.
1332
857=cut 1333=cut
858 1334
859sub register_extcmd { 1335sub register_extcmd {
860 my ($name, $cb) = @_; 1336 my ($name, $cb) = @_;
861 1337
862 $EXTCMD{$name} = $cb; 1338 $EXTCMD{$name} = $cb;
863} 1339}
864 1340
1341sub register_exticmd {
1342 my ($name, $cb) = @_;
1343
1344 $EXTICMD{$name} = $cb;
1345}
1346
1347use File::Glob ();
1348
865cf::player->attach ( 1349cf::player->attach (
866 on_command => sub { 1350 on_unknown_command => sub {
867 my ($pl, $name, $params) = @_; 1351 my ($pl, $name, $params) = @_;
868 1352
869 my $cb = $COMMAND{$name} 1353 my $cb = $COMMAND{$name}
870 or return; 1354 or return;
871 1355
876 cf::override; 1360 cf::override;
877 }, 1361 },
878 on_extcmd => sub { 1362 on_extcmd => sub {
879 my ($pl, $buf) = @_; 1363 my ($pl, $buf) = @_;
880 1364
881 my $msg = eval { from_json $buf }; 1365 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882 1366
883 if (ref $msg) { 1367 if (ref $msg) {
1368 my ($type, $reply, @payload) =
1369 "ARRAY" eq ref $msg
1370 ? @$msg
1371 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1372
1373 my @reply;
1374
884 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1375 if (my $cb = $EXTCMD{$type}) {
885 if (my %reply = $cb->($pl, $msg)) { 1376 @reply = $cb->($pl, @payload);
886 $pl->ext_reply ($msg->{msgid}, %reply);
887 }
888 } 1377 }
1378
1379 $pl->ext_reply ($reply, @reply)
1380 if $reply;
1381
889 } else { 1382 } else {
890 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1383 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
891 } 1384 }
892 1385
893 cf::override; 1386 cf::override;
894 }, 1387 },
895); 1388);
896 1389
1390# "readahead" all extensions
897sub load_extension { 1391sub cache_extensions {
898 my ($path) = @_; 1392 my $grp = IO::AIO::aio_group;
899 1393
900 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1394 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
901 my $base = $1; 1395 for (grep /\.ext$/, @{$_[0]}) {
902 my $pkg = $1; 1396 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "ext::$pkg";
905
906 warn "... loading '$path' into '$pkg'\n";
907
908 open my $fh, "<:utf8", $path
909 or die "$path: $!";
910
911 my $source =
912 "package $pkg; use strict; use utf8;\n"
913 . "#line 1 \"$path\"\n{\n"
914 . (do { local $/; <$fh> })
915 . "\n};\n1";
916
917 unless (eval $source) {
918 my $msg = $@ ? "$path: $@\n"
919 : "extension disabled.\n";
920 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921 warn $@;
922 warn "mandatory extension failed to load, exiting.\n";
923 exit 1;
924 } 1397 }
925 die $@;
926 } 1398 };
927 1399
928 push @EXTS, $pkg; 1400 $grp
929} 1401}
930 1402
931sub load_extensions { 1403sub load_extensions {
1404 info "loading extensions...";
1405
1406 cf::sync_job {
1407 my %todo;
1408
932 for my $ext (<$LIBDIR/*.ext>) { 1409 for my $path (<$LIBDIR/*.ext>) {
933 next unless -r $ext; 1410 next unless -r $path;
934 eval { 1411
935 load_extension $ext; 1412 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1413 my $base = $1;
1414 my $pkg = $1;
1415 $pkg =~ s/[^[:word:]]/_/g;
1416 $pkg = "ext::$pkg";
1417
1418 open my $fh, "<:utf8", $path
1419 or die "$path: $!";
1420
1421 my $source = do { local $/; <$fh> };
1422
1423 my %ext = (
1424 path => $path,
1425 base => $base,
1426 pkg => $pkg,
1427 );
1428
1429 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1430 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1431
1432 $ext{source} =
1433 "package $pkg; use common::sense;\n"
1434 . "#line 1 \"$path\"\n{\n"
1435 . $source
1436 . "\n};\n1";
1437
1438 $todo{$base} = \%ext;
1439 }
1440
1441 my $pass = 0;
1442 my %done;
1443 while (%todo) {
1444 my $progress;
1445
1446 ++$pass;
1447
1448 ext:
1449 while (my ($k, $v) = each %todo) {
1450 for (split /,\s*/, $v->{meta}{depends}) {
1451 next ext
1452 unless exists $done{$_};
1453 }
1454
1455 trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
1456
1457 my $active = eval $v->{source};
1458
1459 if (length $@) {
1460 error "$v->{path}: $@\n";
1461
1462 cf::cleanup "mandatory extension '$k' failed to load, exiting."
1463 if exists $v->{meta}{mandatory};
1464
1465 warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
1466 delete $todo{$k};
1467 } else {
1468 $done{$k} = delete $todo{$k};
1469 push @EXTS, $v->{pkg};
1470 $progress = 1;
1471
1472 info "$v->{base}: extension inactive.\n"
1473 unless $active;
1474 }
936 1 1475 }
937 } or warn "$ext not loaded: $@"; 1476
1477 unless ($progress) {
1478 warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
1479
1480 while (my ($k, $v) = each %todo) {
1481 cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
1482 if exists $v->{meta}{mandatory};
1483 }
1484 }
1485 }
938 } 1486 };
939} 1487}
940 1488
941############################################################################# 1489#############################################################################
942 1490
1491=back
1492
943=head2 CORE EXTENSIONS 1493=head2 CORE EXTENSIONS
944 1494
945Functions and methods that extend core crossfire objects. 1495Functions and methods that extend core deliantra objects.
946 1496
947=cut 1497=cut
948 1498
949package cf::player; 1499package cf::player;
950 1500
952 1502
953=head3 cf::player 1503=head3 cf::player
954 1504
955=over 4 1505=over 4
956 1506
1507=item cf::player::num_playing
1508
1509Returns the official number of playing players, as per the Crossfire metaserver rules.
1510
1511=cut
1512
1513sub num_playing {
1514 scalar grep
1515 $_->ob->map
1516 && !$_->hidden
1517 && !$_->ob->flag (cf::FLAG_WIZ),
1518 cf::player::list
1519}
1520
957=item cf::player::find $login 1521=item cf::player::find $login
958 1522
959Returns the given player object, loading it if necessary (might block). 1523Returns the given player object, loading it if necessary (might block).
960 1524
961=cut 1525=cut
962 1526
963sub playerdir($) { 1527sub playerdir($) {
964 cf::localdir 1528 "$PLAYERDIR/"
965 . "/"
966 . cf::playerdir
967 . "/"
968 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1529 . (ref $_[0] ? $_[0]->ob->name : $_[0])
969} 1530}
970 1531
971sub path($) { 1532sub path($) {
972 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1533 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973 1534
974 (playerdir $login) . "/$login.pl" 1535 (playerdir $login) . "/playerdata"
975} 1536}
976 1537
977sub find_active($) { 1538sub find_active($) {
978 $cf::PLAYER{$_[0]} 1539 $cf::PLAYER{$_[0]}
979 and $cf::PLAYER{$_[0]}->active 1540 and $cf::PLAYER{$_[0]}->active
982 1543
983sub exists($) { 1544sub exists($) {
984 my ($login) = @_; 1545 my ($login) = @_;
985 1546
986 $cf::PLAYER{$login} 1547 $cf::PLAYER{$login}
987 or cf::sync_job { !aio_stat path $login } 1548 or !aio_stat path $login
988} 1549}
989 1550
990sub find($) { 1551sub find($) {
991 return $cf::PLAYER{$_[0]} || do { 1552 return $cf::PLAYER{$_[0]} || do {
992 my $login = $_[0]; 1553 my $login = $_[0];
993 1554
994 my $guard = cf::lock_acquire "user_find:$login"; 1555 my $guard = cf::lock_acquire "user_find:$login";
995 1556
996 $cf::PLAYER{$_[0]} || do { 1557 $cf::PLAYER{$_[0]} || do {
997 my $pl = load_pl path $login 1558 # rename old playerfiles to new ones
1559 #TODO: remove when no longer required
1560 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1561 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1562 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1563 aio_unlink +(playerdir $login) . "/$login.pl";
1564
1565 my $f = new_from_file cf::object::thawer path $login
998 or return; 1566 or return;
1567
1568 my $pl = cf::player::load_pl $f
1569 or return;
1570
1571 local $cf::PLAYER_LOADING{$login} = $pl;
1572 $f->resolve_delayed_derefs;
999 $cf::PLAYER{$login} = $pl 1573 $cf::PLAYER{$login} = $pl
1000 } 1574 }
1001 } 1575 }
1002} 1576}
1577
1578cf::player->attach (
1579 on_load => sub {
1580 my ($pl, $path) = @_;
1581
1582 # restore slots saved in save, below
1583 my $slots = delete $pl->{_slots};
1584
1585 $pl->ob->current_weapon ($slots->[0]);
1586 $pl->combat_ob ($slots->[1]);
1587 $pl->ranged_ob ($slots->[2]);
1588 },
1589);
1003 1590
1004sub save($) { 1591sub save($) {
1005 my ($pl) = @_; 1592 my ($pl) = @_;
1006 1593
1007 return if $pl->{deny_save}; 1594 return if $pl->{deny_save};
1012 return if $pl->{deny_save}; 1599 return if $pl->{deny_save};
1013 1600
1014 aio_mkdir playerdir $pl, 0770; 1601 aio_mkdir playerdir $pl, 0770;
1015 $pl->{last_save} = $cf::RUNTIME; 1602 $pl->{last_save} = $cf::RUNTIME;
1016 1603
1604 cf::get_slot 0.01;
1605
1606 # save slots, to be restored later
1607 local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
1608
1017 $pl->save_pl ($path); 1609 $pl->save_pl ($path);
1018 Coro::cede; 1610 cf::cede_to_tick;
1019} 1611}
1020 1612
1021sub new($) { 1613sub new($) {
1022 my ($login) = @_; 1614 my ($login) = @_;
1023 1615
1029 $cf::PLAYER{$login} = $self; 1621 $cf::PLAYER{$login} = $self;
1030 1622
1031 $self 1623 $self
1032} 1624}
1033 1625
1626=item $player->send_msg ($channel, $msg, $color, [extra...])
1627
1628=cut
1629
1630sub send_msg {
1631 my $ns = shift->ns
1632 or return;
1633 $ns->send_msg (@_);
1634}
1635
1034=item $pl->quit_character 1636=item $pl->quit_character
1035 1637
1036Nukes the player without looking back. If logged in, the connection will 1638Nukes the player without looking back. If logged in, the connection will
1037be destroyed. May block for a long time. 1639be destroyed. May block for a long time.
1038 1640
1039=cut 1641=cut
1040 1642
1041sub quit_character { 1643sub quit_character {
1042 my ($pl) = @_; 1644 my ($pl) = @_;
1043 1645
1646 my $name = $pl->ob->name;
1647
1044 $pl->{deny_save} = 1; 1648 $pl->{deny_save} = 1;
1045 $pl->password ("*"); # this should lock out the player until we nuked the dir 1649 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1046 1650
1047 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1651 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1048 $pl->deactivate; 1652 $pl->deactivate;
1653 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1049 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1654 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1050 $pl->ns->destroy if $pl->ns; 1655 $pl->ns->destroy if $pl->ns;
1051 1656
1052 my $path = playerdir $pl; 1657 my $path = playerdir $pl;
1053 my $temp = "$path~$cf::RUNTIME~deleting~"; 1658 my $temp = "$path~$cf::RUNTIME~deleting~";
1054 aio_rename $path, $temp; 1659 aio_rename $path, $temp;
1055 delete $cf::PLAYER{$pl->ob->name}; 1660 delete $cf::PLAYER{$pl->ob->name};
1056 $pl->destroy; 1661 $pl->destroy;
1662
1663 my $prefix = qr<^~\Q$name\E/>;
1664
1665 # nuke player maps
1666 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1667
1057 IO::AIO::aio_rmtree $temp; 1668 IO::AIO::aio_rmtree $temp;
1669}
1670
1671=item $pl->kick
1672
1673Kicks a player out of the game. This destroys the connection.
1674
1675=cut
1676
1677sub kick {
1678 my ($pl, $kicker) = @_;
1679
1680 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1681 $pl->killer ("kicked");
1682 $pl->ns->destroy;
1058} 1683}
1059 1684
1060=item cf::player::list_logins 1685=item cf::player::list_logins
1061 1686
1062Returns am arrayref of all valid playernames in the system, can take a 1687Returns am arrayref of all valid playernames in the system, can take a
1063while and may block, so not sync_job-capable, ever. 1688while and may block, so not sync_job-capable, ever.
1064 1689
1065=cut 1690=cut
1066 1691
1067sub list_logins { 1692sub list_logins {
1068 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1693 my $dirs = aio_readdir $PLAYERDIR
1069 or return []; 1694 or return [];
1070 1695
1071 my @logins; 1696 my @logins;
1072 1697
1073 for my $login (@$dirs) { 1698 for my $login (@$dirs) {
1699 my $path = path $login;
1700
1701 # a .pst is a dead give-away for a valid player
1702 # if no pst file found, open and chekc for blocked users
1703 if (aio_stat "$path.pst") {
1074 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1704 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1075 aio_read $fh, 0, 512, my $buf, 0 or next; 1705 aio_read $fh, 0, 512, my $buf, 0 or next;
1076 $buf !~ /^password -------------$/m or next; # official not-valid tag 1706 $buf !~ /^password -------------$/m or next; # official not-valid tag
1707 }
1077 1708
1078 utf8::decode $login; 1709 utf8::decode $login;
1079 push @logins, $login; 1710 push @logins, $login;
1080 } 1711 }
1081 1712
1082 \@logins 1713 \@logins
1083} 1714}
1084 1715
1085=item $player->maps 1716=item $player->maps
1717
1718=item cf::player::maps $login
1086 1719
1087Returns an arrayref of map paths that are private for this 1720Returns an arrayref of map paths that are private for this
1088player. May block. 1721player. May block.
1089 1722
1090=cut 1723=cut
1108 } 1741 }
1109 1742
1110 \@paths 1743 \@paths
1111} 1744}
1112 1745
1746=item $protocol_xml = $player->expand_cfpod ($cfpod)
1747
1748Expand deliantra pod fragments into protocol xml.
1749
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1750=item $player->ext_reply ($msgid, @msg)
1114 1751
1115Sends an ext reply to the player. 1752Sends an ext reply to the player.
1116 1753
1117=cut 1754=cut
1118 1755
1119sub ext_reply($$$%) { 1756sub ext_reply($$@) {
1120 my ($self, $id, %msg) = @_; 1757 my ($self, $id, @msg) = @_;
1121 1758
1122 $msg{msgid} = $id; 1759 $self->ns->ext_reply ($id, @msg)
1123
1124 $self->send ("ext " . cf::to_json \%msg);
1125} 1760}
1126 1761
1127package cf; 1762=item $player->ext_msg ($type, @msg)
1763
1764Sends an ext event to the client.
1765
1766=cut
1767
1768sub ext_msg($$@) {
1769 my ($self, $type, @msg) = @_;
1770
1771 $self->ns->ext_msg ($type, @msg);
1772}
1773
1774=head3 cf::region
1775
1776=over 4
1777
1778=cut
1779
1780package cf::region;
1781
1782=item cf::region::find_by_path $path
1783
1784Tries to decuce the likely region for a map knowing only its path.
1785
1786=cut
1787
1788sub find_by_path($) {
1789 my ($path) = @_;
1790
1791 $path =~ s/^~[^\/]*//; # skip ~login
1792
1793 my ($match, $specificity);
1794
1795 for my $region (list) {
1796 if ($region->{match} && $path =~ $region->{match}) {
1797 ($match, $specificity) = ($region, $region->specificity)
1798 if $region->specificity > $specificity;
1799 }
1800 }
1801
1802 $match
1803}
1128 1804
1129=back 1805=back
1130
1131 1806
1132=head3 cf::map 1807=head3 cf::map
1133 1808
1134=over 4 1809=over 4
1135 1810
1147our $MAX_RESET = 3600; 1822our $MAX_RESET = 3600;
1148our $DEFAULT_RESET = 3000; 1823our $DEFAULT_RESET = 3000;
1149 1824
1150sub generate_random_map { 1825sub generate_random_map {
1151 my ($self, $rmp) = @_; 1826 my ($self, $rmp) = @_;
1827
1828 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1829
1152 # mit "rum" bekleckern, nicht 1830 # mit "rum" bekleckern, nicht
1153 $self->_create_random_map ( 1831 $self->_create_random_map (
1154 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1832 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1155 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1833 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1156 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1834 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1157 $rmp->{exit_on_final_map}, 1835 $rmp->{exit_on_final_map},
1158 $rmp->{xsize}, $rmp->{ysize}, 1836 $rmp->{xsize}, $rmp->{ysize},
1159 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1837 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1160 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1838 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1175 1853
1176sub register { 1854sub register {
1177 my (undef, $regex, $prio) = @_; 1855 my (undef, $regex, $prio) = @_;
1178 my $pkg = caller; 1856 my $pkg = caller;
1179 1857
1180 no strict;
1181 push @{"$pkg\::ISA"}, __PACKAGE__; 1858 push @{"$pkg\::ISA"}, __PACKAGE__;
1182 1859
1183 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1860 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1184} 1861}
1185 1862
1186# also paths starting with '/' 1863# also paths starting with '/'
1187$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1864$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1188 1865
1189sub thawer_merge { 1866sub thawer_merge {
1190 my ($self, $merge) = @_; 1867 my ($self, $merge) = @_;
1191 1868
1192 # we have to keep some variables in memory intact 1869 # we have to keep some variables in memory intact
1193 local $self->{path}; 1870 local $self->{path};
1194 local $self->{load_path}; 1871 local $self->{load_path};
1195 local $self->{deny_save};
1196 local $self->{deny_reset};
1197 1872
1198 $self->SUPER::thawer_merge ($merge); 1873 $self->SUPER::thawer_merge ($merge);
1199} 1874}
1200 1875
1201sub normalise { 1876sub normalise {
1202 my ($path, $base) = @_; 1877 my ($path, $base) = @_;
1203 1878
1204 $path = "$path"; # make sure its a string 1879 $path = "$path"; # make sure it's a string
1205 1880
1206 $path =~ s/\.map$//; 1881 $path =~ s/\.map$//;
1207 1882
1208 # map plan: 1883 # map plan:
1209 # 1884 #
1248 $self->init; # pass $1 etc. 1923 $self->init; # pass $1 etc.
1249 return $self; 1924 return $self;
1250 } 1925 }
1251 } 1926 }
1252 1927
1253 Carp::carp "unable to resolve path '$path' (base '$base')."; 1928 Carp::cluck "unable to resolve path '$path' (base '$base')";
1254 () 1929 ()
1255} 1930}
1256 1931
1257sub init { 1932sub init {
1258 my ($self) = @_; 1933 my ($self) = @_;
1273 1948
1274# the original (read-only) location 1949# the original (read-only) location
1275sub load_path { 1950sub load_path {
1276 my ($self) = @_; 1951 my ($self) = @_;
1277 1952
1278 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1953 "$MAPDIR/$self->{path}.map"
1279} 1954}
1280 1955
1281# the temporary/swap location 1956# the temporary/swap location
1282sub save_path { 1957sub save_path {
1283 my ($self) = @_; 1958 my ($self) = @_;
1284 1959
1285 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1960 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1286 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1961 "$TMPDIR/$path.map"
1287} 1962}
1288 1963
1289# the unique path, undef == no special unique path 1964# the unique path, undef == no special unique path
1290sub uniq_path { 1965sub uniq_path {
1291 my ($self) = @_; 1966 my ($self) = @_;
1292 1967
1293 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1968 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1294 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1969 "$UNIQUEDIR/$path"
1295} 1970}
1296 1971
1297# and all this just because we cannot iterate over 1972sub decay_objects {
1298# all maps in C++...
1299sub change_all_map_light {
1300 my ($change) = @_; 1973 my ($self) = @_;
1301 1974
1302 $_->change_map_light ($change) 1975 return if $self->{deny_reset};
1303 for grep $_->outdoor, values %cf::MAP; 1976
1977 $self->do_decay_objects;
1304} 1978}
1305 1979
1306sub unlink_save { 1980sub unlink_save {
1307 my ($self) = @_; 1981 my ($self) = @_;
1308 1982
1309 utf8::encode (my $save = $self->save_path); 1983 utf8::encode (my $save = $self->save_path);
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1984 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1985 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313 #d#TODO remove .map and also nuke
1314 $save =~ s/\.map// or return;#d#
1315 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317} 1986}
1318 1987
1319sub load_header_from($) { 1988sub load_header_from($) {
1320 my ($self, $path) = @_; 1989 my ($self, $path) = @_;
1321 1990
1322 utf8::encode $path; 1991 utf8::encode $path;
1323 #aio_open $path, O_RDONLY, 0 1992 my $f = new_from_file cf::object::thawer $path
1324 # or return;
1325
1326 $self->_load_header ($path)
1327 or return; 1993 or return;
1994
1995 $self->_load_header ($f)
1996 or return;
1997
1998 local $MAP_LOADING{$self->{path}} = $self;
1999 $f->resolve_delayed_derefs;
1328 2000
1329 $self->{load_path} = $path; 2001 $self->{load_path} = $path;
1330 2002
1331 1 2003 1
1332} 2004}
1371 $self->load_header_orig 2043 $self->load_header_orig
1372 or return; 2044 or return;
1373 $self->prepare_orig; 2045 $self->prepare_orig;
1374 } 2046 }
1375 2047
2048 $self->{deny_reset} = 1
2049 if $self->no_reset;
2050
2051 $self->default_region (cf::region::find_by_path $self->{path})
2052 unless $self->default_region;
2053
1376 1 2054 1
1377} 2055}
1378 2056
1379sub find; 2057sub find;
1380sub find { 2058sub find {
1381 my ($path, $origin) = @_; 2059 my ($path, $origin) = @_;
1382 2060
2061 cf::cede_to_tick;
2062
1383 $path = normalise $path, $origin && $origin->path; 2063 $path = normalise $path, $origin && $origin->path;
1384 2064
2065 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1385 cf::lock_wait "map_find:$path"; 2066 my $guard2 = cf::lock_acquire "map_find:$path";
1386 2067
1387 $cf::MAP{$path} || do { 2068 $cf::MAP{$path} || do {
1388 my $guard = cf::lock_acquire "map_find:$path";
1389 my $map = new_from_path cf::map $path 2069 my $map = new_from_path cf::map $path
1390 or return; 2070 or return;
1391 2071
1392 $map->{last_save} = $cf::RUNTIME; 2072 $map->{last_save} = $cf::RUNTIME;
1393 2073
1394 $map->load_header 2074 $map->load_header
1395 or return; 2075 or return;
1396 2076
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2077 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 2078 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 2079 #$cf::WAIT_FOR_TICK->wait;
2080 undef $guard2;
2081 undef $guard1;
1400 $map->reset; 2082 $map->reset;
1401 undef $guard;
1402 return find $path; 2083 return find $path;
1403 } 2084 }
1404 2085
1405 $cf::MAP{$path} = $map 2086 $cf::MAP{$path} = $map
1406 } 2087 }
1407} 2088}
1408 2089
1409sub pre_load { } 2090sub pre_load { }
1410sub post_load { } 2091#sub post_load { } # XS
1411 2092
1412sub load { 2093sub load {
1413 my ($self) = @_; 2094 my ($self) = @_;
1414 2095
1415 local $self->{deny_reset} = 1; # loading can take a long time 2096 local $self->{deny_reset} = 1; # loading can take a long time
1416 2097
1417 my $path = $self->{path}; 2098 my $path = $self->{path};
2099
2100 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 2101 my $guard = cf::lock_acquire "map_data:$path";
1419 2102
2103 return unless $self->valid;
1420 return if $self->in_memory != cf::MAP_SWAPPED; 2104 return unless $self->in_memory == cf::MAP_SWAPPED;
1421 2105
1422 $self->in_memory (cf::MAP_LOADING); 2106 $self->in_memory (cf::MAP_LOADING);
1423 2107
1424 $self->alloc; 2108 $self->alloc;
1425 2109
1426 $self->pre_load; 2110 $self->pre_load;
2111 cf::cede_to_tick;
1427 2112
1428 $self->_load_objects ($self->{load_path}, 1) 2113 my $f = new_from_file cf::object::thawer $self->{load_path};
2114 $f->skip_block;
2115 $self->_load_objects ($f)
1429 or return; 2116 or return;
1430 2117
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2118 $self->post_load_original
1432 if delete $self->{load_original}; 2119 if delete $self->{load_original};
1433 2120
1434 if (my $uniq = $self->uniq_path) { 2121 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq; 2122 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) { 2123 unless (aio_stat $uniq) {
2124 if (my $f = new_from_file cf::object::thawer $uniq) {
1437 $self->clear_unique_items; 2125 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0); 2126 $self->_load_objects ($f);
2127 $f->resolve_delayed_derefs;
2128 }
1439 } 2129 }
1440 } 2130 }
1441 2131
1442 Coro::cede; 2132 $f->resolve_delayed_derefs;
1443 2133
2134 cf::cede_to_tick;
1444 # now do the right thing for maps 2135 # now do the right thing for maps
1445 $self->link_multipart_objects; 2136 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede;
1452 $self->set_darkness_map;
1453 $self->difficulty ($self->estimate_difficulty) 2137 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 2138 unless $self->difficulty;
1455 Coro::cede; 2139 cf::cede_to_tick;
2140
2141 unless ($self->{deny_activate}) {
2142 $self->decay_objects;
2143 $self->fix_auto_apply;
2144 $self->update_buttons;
2145 cf::cede_to_tick;
1456 $self->activate; 2146 $self->activate;
2147 }
2148
2149 $self->{last_save} = $cf::RUNTIME;
2150 $self->last_access ($cf::RUNTIME);
2151
2152 $self->in_memory (cf::MAP_ACTIVE);
1457 } 2153 }
1458 2154
1459 $self->post_load; 2155 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 2156}
1463 2157
2158# customize the map for a given player, i.e.
2159# return the _real_ map. used by e.g. per-player
2160# maps to change the path to ~playername/mappath
1464sub customise_for { 2161sub customise_for {
1465 my ($self, $ob) = @_; 2162 my ($self, $ob) = @_;
1466 2163
1467 return find "~" . $ob->name . "/" . $self->{path} 2164 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 2165 if $self->per_player;
1469 2166
2167# return find "?party/" . $ob->name . "/" . $self->{path}
2168# if $self->per_party;
2169
1470 $self 2170 $self
1471} 2171}
1472 2172
1473# find and load all maps in the 3x3 area around a map 2173# find and load all maps in the 3x3 area around a map
1474sub load_diag { 2174sub load_neighbours {
1475 my ($map) = @_; 2175 my ($map) = @_;
1476 2176
1477 my @diag; # diagonal neighbours 2177 my @neigh; # diagonal neighbours
1478 2178
1479 for (0 .. 3) { 2179 for (0 .. 3) {
1480 my $neigh = $map->tile_path ($_) 2180 my $neigh = $map->tile_path ($_)
1481 or next; 2181 or next;
1482 $neigh = find $neigh, $map 2182 $neigh = find $neigh, $map
1483 or next; 2183 or next;
1484 $neigh->load; 2184 $neigh->load;
1485 2185
2186 # now find the diagonal neighbours
2187 push @neigh,
1486 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2188 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1487 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2189 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1488 } 2190 }
1489 2191
1490 for (@diag) { 2192 for (grep defined $_->[0], @neigh) {
2193 my ($path, $origin) = @$_;
1491 my $neigh = find @$_ 2194 my $neigh = find $path, $origin
1492 or next; 2195 or next;
1493 $neigh->load; 2196 $neigh->load;
1494 } 2197 }
1495} 2198}
1496 2199
1497sub find_sync { 2200sub find_sync {
1498 my ($path, $origin) = @_; 2201 my ($path, $origin) = @_;
1499 2202
1500 cf::sync_job { find $path, $origin } 2203 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2204 if $Coro::current == $Coro::main;
2205
2206 find $path, $origin
1501} 2207}
1502 2208
1503sub do_load_sync { 2209sub do_load_sync {
1504 my ($map) = @_; 2210 my ($map) = @_;
1505 2211
1506 cf::sync_job { $map->load }; 2212 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2213 if $Coro::current == $Coro::main;
2214
2215 $map->load;
1507} 2216}
1508 2217
1509our %MAP_PREFETCH; 2218our %MAP_PREFETCH;
1510our $MAP_PREFETCHER = undef; 2219our $MAP_PREFETCHER = undef;
1511 2220
1512sub find_async { 2221sub find_async {
1513 my ($path, $origin) = @_; 2222 my ($path, $origin, $load) = @_;
1514 2223
1515 $path = normalise $path, $origin && $origin->{path}; 2224 $path = normalise $path, $origin && $origin->{path};
1516 2225
1517 if (my $map = $cf::MAP{$path}) { 2226 if (my $map = $cf::MAP{$path}) {
1518 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2227 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1519 } 2228 }
1520 2229
1521 undef $MAP_PREFETCH{$path}; 2230 $MAP_PREFETCH{$path} |= $load;
2231
1522 $MAP_PREFETCHER ||= cf::async { 2232 $MAP_PREFETCHER ||= cf::async {
2233 $Coro::current->{desc} = "map prefetcher";
2234
1523 while (%MAP_PREFETCH) { 2235 while (%MAP_PREFETCH) {
1524 for my $path (keys %MAP_PREFETCH) { 2236 while (my ($k, $v) = each %MAP_PREFETCH) {
1525 my $map = find $path 2237 if (my $map = find $k) {
1526 or next;
1527 $map->load; 2238 $map->load if $v;
2239 }
1528 2240
1529 delete $MAP_PREFETCH{$path}; 2241 delete $MAP_PREFETCH{$k};
1530 } 2242 }
1531 } 2243 }
1532 undef $MAP_PREFETCHER; 2244 undef $MAP_PREFETCHER;
1533 }; 2245 };
1534 $MAP_PREFETCHER->prio (6); 2246 $MAP_PREFETCHER->prio (6);
1535 2247
1536 () 2248 ()
1537} 2249}
1538 2250
2251# common code, used by both ->save and ->swapout
1539sub save { 2252sub _save {
1540 my ($self) = @_; 2253 my ($self) = @_;
1541
1542 my $lock = cf::lock_acquire "map_data:" . $self->path;
1543 2254
1544 $self->{last_save} = $cf::RUNTIME; 2255 $self->{last_save} = $cf::RUNTIME;
1545 2256
1546 return unless $self->dirty; 2257 return unless $self->dirty;
1547 2258
1553 return if $self->{deny_save}; 2264 return if $self->{deny_save};
1554 2265
1555 local $self->{last_access} = $self->last_access;#d# 2266 local $self->{last_access} = $self->last_access;#d#
1556 2267
1557 cf::async { 2268 cf::async {
2269 $Coro::current->{desc} = "map player save";
1558 $_->contr->save for $self->players; 2270 $_->contr->save for $self->players;
1559 }; 2271 };
2272
2273 cf::get_slot 0.02;
1560 2274
1561 if ($uniq) { 2275 if ($uniq) {
1562 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2276 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1563 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2277 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1564 } else { 2278 } else {
1565 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2279 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1566 } 2280 }
1567} 2281}
1568 2282
2283sub save {
2284 my ($self) = @_;
2285
2286 my $lock = cf::lock_acquire "map_data:$self->{path}";
2287
2288 $self->_save;
2289}
2290
1569sub swap_out { 2291sub swap_out {
1570 my ($self) = @_; 2292 my ($self) = @_;
1571 2293
1572 # save first because save cedes
1573 $self->save;
1574
1575 my $lock = cf::lock_acquire "map_data:" . $self->path; 2294 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2295
2296 return if $self->in_memory != cf::MAP_ACTIVE;
2297 return if $self->{deny_save};
1577 return if $self->players; 2298 return if $self->players;
1578 return if $self->in_memory != cf::MAP_IN_MEMORY;
1579 return if $self->{deny_save};
1580 2299
2300 # first deactivate the map and "unlink" it from the core
2301 $self->deactivate;
2302 $_->clear_links_to ($self) for values %cf::MAP;
2303 $self->in_memory (cf::MAP_SWAPPED);
2304
2305 # then atomically save
2306 $self->_save;
2307
2308 # then free the map
1581 $self->clear; 2309 $self->clear;
1582 $self->in_memory (cf::MAP_SWAPPED);
1583} 2310}
1584 2311
1585sub reset_at { 2312sub reset_at {
1586 my ($self) = @_; 2313 my ($self) = @_;
1587 2314
1588 # TODO: safety, remove and allow resettable per-player maps 2315 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 2316 return 1e99 if $self->{deny_reset};
1591 2317
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2318 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2319 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 2320
1605 my ($self) = @_; 2331 my ($self) = @_;
1606 2332
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2333 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 2334
1609 return if $self->players; 2335 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 2336
1612 warn "resetting map ", $self->path;#d# 2337 cf::trace "resetting map ", $self->path, "\n";
2338
2339 $self->in_memory (cf::MAP_SWAPPED);
2340
2341 # need to save uniques path
2342 unless ($self->{deny_save}) {
2343 my $uniq = $self->uniq_path; utf8::encode $uniq;
2344
2345 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2346 if $uniq;
2347 }
1613 2348
1614 delete $cf::MAP{$self->path}; 2349 delete $cf::MAP{$self->path};
1615 2350
1616 $self->in_memory (cf::MAP_SWAPPED); 2351 $self->deactivate;
2352 $_->clear_links_to ($self) for values %cf::MAP;
1617 $self->clear; 2353 $self->clear;
1618
1619 $_->clear_links_to ($self) for values %cf::MAP;
1620 2354
1621 $self->unlink_save; 2355 $self->unlink_save;
1622 $self->destroy; 2356 $self->destroy;
1623} 2357}
1624 2358
1625my $nuke_counter = "aaaa"; 2359my $nuke_counter = "aaaa";
1626 2360
1627sub nuke { 2361sub nuke {
1628 my ($self) = @_; 2362 my ($self) = @_;
1629 2363
2364 {
2365 my $lock = cf::lock_acquire "map_data:$self->{path}";
2366
1630 delete $cf::MAP{$self->path}; 2367 delete $cf::MAP{$self->path};
1631 2368
1632 $self->unlink_save; 2369 $self->unlink_save;
1633 2370
1634 bless $self, "cf::map"; 2371 bless $self, "cf::map::wrap";
1635 delete $self->{deny_reset}; 2372 delete $self->{deny_reset};
1636 $self->{deny_save} = 1; 2373 $self->{deny_save} = 1;
1637 $self->reset_timeout (1); 2374 $self->reset_timeout (1);
1638 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2375 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1639 2376
1640 $cf::MAP{$self->path} = $self; 2377 $cf::MAP{$self->path} = $self;
2378 }
1641 2379
1642 $self->reset; # polite request, might not happen 2380 $self->reset; # polite request, might not happen
2381}
2382
2383=item $maps = cf::map::tmp_maps
2384
2385Returns an arrayref with all map paths of currently instantiated and saved
2386maps. May block.
2387
2388=cut
2389
2390sub tmp_maps() {
2391 [
2392 map {
2393 utf8::decode $_;
2394 /\.map$/
2395 ? normalise $_
2396 : ()
2397 } @{ aio_readdir $TMPDIR or [] }
2398 ]
2399}
2400
2401=item $maps = cf::map::random_maps
2402
2403Returns an arrayref with all map paths of currently instantiated and saved
2404random maps. May block.
2405
2406=cut
2407
2408sub random_maps() {
2409 [
2410 map {
2411 utf8::decode $_;
2412 /\.map$/
2413 ? normalise "?random/$_"
2414 : ()
2415 } @{ aio_readdir $RANDOMDIR or [] }
2416 ]
1643} 2417}
1644 2418
1645=item cf::map::unique_maps 2419=item cf::map::unique_maps
1646 2420
1647Returns an arrayref of paths of all shared maps that have 2421Returns an arrayref of paths of all shared maps that have
1648instantiated unique items. May block. 2422instantiated unique items. May block.
1649 2423
1650=cut 2424=cut
1651 2425
1652sub unique_maps() { 2426sub unique_maps() {
1653 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2427 [
1654 or return; 2428 map {
1655
1656 my @paths;
1657
1658 for (@$files) {
1659 utf8::decode $_; 2429 utf8::decode $_;
1660 next if /\.pst$/; 2430 s/\.map$//; # TODO future compatibility hack
1661 next unless /^$PATH_SEP/o; 2431 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1662 2432 ? ()
1663 push @paths, cf::map::normalise $_; 2433 : normalise $_
2434 } @{ aio_readdir $UNIQUEDIR or [] }
1664 } 2435 ]
1665
1666 \@paths
1667} 2436}
1668 2437
1669package cf; 2438=item cf::map::static_maps
2439
2440Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2441file in the shared directory excluding F</styles> and F</editor>). May
2442block.
2443
2444=cut
2445
2446sub static_maps() {
2447 my @dirs = "";
2448 my @maps;
2449
2450 while (@dirs) {
2451 my $dir = shift @dirs;
2452
2453 next if $dir eq "/styles" || $dir eq "/editor";
2454
2455 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2456 or return;
2457
2458 for (@$files) {
2459 s/\.map$// or next;
2460 utf8::decode $_;
2461 push @maps, "$dir/$_";
2462 }
2463
2464 push @dirs, map "$dir/$_", @$dirs;
2465 }
2466
2467 \@maps
2468}
1670 2469
1671=back 2470=back
1672 2471
1673=head3 cf::object 2472=head3 cf::object
1674 2473
1678 2477
1679=over 4 2478=over 4
1680 2479
1681=item $ob->inv_recursive 2480=item $ob->inv_recursive
1682 2481
1683Returns the inventory of the object _and_ their inventories, recursively. 2482Returns the inventory of the object I<and> their inventories, recursively,
2483but I<not> the object itself.
1684 2484
1685=cut 2485=cut
1686 2486
1687sub inv_recursive_; 2487sub inv_recursive_;
1688sub inv_recursive_ { 2488sub inv_recursive_ {
1691 2491
1692sub inv_recursive { 2492sub inv_recursive {
1693 inv_recursive_ inv $_[0] 2493 inv_recursive_ inv $_[0]
1694} 2494}
1695 2495
2496=item $ref = $ob->ref
2497
2498Creates and returns a persistent reference to an object that can be stored as a string.
2499
2500=item $ob = cf::object::deref ($refstring)
2501
2502returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2503even if the object actually exists. May block.
2504
2505=cut
2506
2507sub deref {
2508 my ($ref) = @_;
2509
2510 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2511 my ($uuid, $name) = ($1, $2);
2512 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2513 or return;
2514 $pl->ob->uuid eq $uuid
2515 or return;
2516
2517 $pl->ob
2518 } else {
2519 warn "$ref: cannot resolve object reference\n";
2520 undef
2521 }
2522}
2523
1696package cf; 2524package cf;
1697 2525
1698=back 2526=back
1699 2527
1700=head3 cf::object::player 2528=head3 cf::object::player
1706Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2534Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1707can be C<undef>. Does the right thing when the player is currently in a 2535can be C<undef>. Does the right thing when the player is currently in a
1708dialogue with the given NPC character. 2536dialogue with the given NPC character.
1709 2537
1710=cut 2538=cut
2539
2540our $SAY_CHANNEL = {
2541 id => "say",
2542 title => "Map",
2543 reply => "say ",
2544 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2545};
2546
2547our $CHAT_CHANNEL = {
2548 id => "chat",
2549 title => "Chat",
2550 reply => "chat ",
2551 tooltip => "Player chat and shouts, global to the server.",
2552};
1711 2553
1712# rough implementation of a future "reply" method that works 2554# rough implementation of a future "reply" method that works
1713# with dialog boxes. 2555# with dialog boxes.
1714#TODO: the first argument must go, split into a $npc->reply_to ( method 2556#TODO: the first argument must go, split into a $npc->reply_to ( method
1715sub cf::object::player::reply($$$;$) { 2557sub cf::object::player::reply($$$;$) {
1717 2559
1718 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2560 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719 2561
1720 if ($self->{record_replies}) { 2562 if ($self->{record_replies}) {
1721 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2563 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2564
1722 } else { 2565 } else {
2566 my $pl = $self->contr;
2567
2568 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2569 my $dialog = $pl->{npc_dialog};
2570 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2571
2572 } else {
1723 $msg = $npc->name . " says: $msg" if $npc; 2573 $msg = $npc->name . " says: $msg" if $npc;
1724 $self->message ($msg, $flags); 2574 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2575 }
1725 } 2576 }
2577}
2578
2579=item $object->send_msg ($channel, $msg, $color, [extra...])
2580
2581=cut
2582
2583sub cf::object::send_msg {
2584 my $pl = shift->contr
2585 or return;
2586 $pl->send_msg (@_);
1726} 2587}
1727 2588
1728=item $player_object->may ("access") 2589=item $player_object->may ("access")
1729 2590
1730Returns wether the given player is authorized to access resource "access" 2591Returns wether the given player is authorized to access resource "access"
1743 2604
1744=item $player_object->enter_link 2605=item $player_object->enter_link
1745 2606
1746Freezes the player and moves him/her to a special map (C<{link}>). 2607Freezes the player and moves him/her to a special map (C<{link}>).
1747 2608
1748The player should be reasonably safe there for short amounts of time. You 2609The player should be reasonably safe there for short amounts of time (e.g.
1749I<MUST> call C<leave_link> as soon as possible, though. 2610for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2611though, as the player cannot control the character while it is on the link
2612map.
1750 2613
1751Will never block. 2614Will never block.
1752 2615
1753=item $player_object->leave_link ($map, $x, $y) 2616=item $player_object->leave_link ($map, $x, $y)
1754 2617
1774sub cf::object::player::enter_link { 2637sub cf::object::player::enter_link {
1775 my ($self) = @_; 2638 my ($self) = @_;
1776 2639
1777 $self->deactivate_recursive; 2640 $self->deactivate_recursive;
1778 2641
2642 ++$self->{_link_recursion};
2643
1779 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2644 return if UNIVERSAL::isa $self->map, "ext::map_link";
1780 2645
1781 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2646 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782 if $self->map; 2647 if $self->map && $self->map->{path} ne "{link}";
1783 2648
1784 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2649 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1785} 2650}
1786 2651
1787sub cf::object::player::leave_link { 2652sub cf::object::player::leave_link {
1788 my ($self, $map, $x, $y) = @_; 2653 my ($self, $map, $x, $y) = @_;
2654
2655 return unless $self->contr->active;
1789 2656
1790 my $link_pos = delete $self->{_link_pos}; 2657 my $link_pos = delete $self->{_link_pos};
1791 2658
1792 unless ($map) { 2659 unless ($map) {
1793 # restore original map position 2660 # restore original map position
1804 ($x, $y) = (-1, -1) 2671 ($x, $y) = (-1, -1)
1805 unless (defined $x) && (defined $y); 2672 unless (defined $x) && (defined $y);
1806 2673
1807 # use -1 or undef as default coordinates, not 0, 0 2674 # use -1 or undef as default coordinates, not 0, 0
1808 ($x, $y) = ($map->enter_x, $map->enter_y) 2675 ($x, $y) = ($map->enter_x, $map->enter_y)
1809 if $x <=0 && $y <= 0; 2676 if $x <= 0 && $y <= 0;
1810 2677
1811 $map->load; 2678 $map->load;
1812 $map->load_diag; 2679 $map->load_neighbours;
1813 2680
1814 return unless $self->contr->active; 2681 return unless $self->contr->active;
2682
2683 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2684 if ($self->enter_map ($map, $x, $y)) {
2685 # entering was successful
2686 delete $self->{_link_recursion};
2687 # only activate afterwards, to support waiting in hooks
1815 $self->activate_recursive; 2688 $self->activate_recursive;
1816 $self->enter_map ($map, $x, $y);
1817}
1818
1819cf::player->attach (
1820 on_logout => sub {
1821 my ($pl) = @_;
1822
1823 # abort map switching before logout
1824 if ($pl->ob->{_link_pos}) {
1825 cf::sync_job {
1826 $pl->ob->leave_link
1827 };
1828 }
1829 }, 2689 }
1830 on_login => sub {
1831 my ($pl) = @_;
1832 2690
1833 # try to abort aborted map switching on player login :) 2691}
1834 # should happen only on crashes
1835 if ($pl->ob->{_link_pos}) {
1836 $pl->ob->enter_link;
1837 (async {
1838 # we need this sleep as the login has a concurrent enter_exit running
1839 # and this sleep increases chances of the player not ending up in scorn
1840 $pl->ob->reply (undef,
1841 "There was an internal problem at your last logout, "
1842 . "the server will try to bring you to your intended destination in a second.",
1843 cf::NDI_RED);
1844 Coro::Timer::sleep 1;
1845 $pl->ob->leave_link;
1846 })->prio (2);
1847 }
1848 },
1849);
1850 2692
1851=item $player_object->goto ($path, $x, $y) 2693=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1852 2694
2695Moves the player to the given map-path and coordinates by first freezing
2696her, loading and preparing them map, calling the provided $check callback
2697that has to return the map if sucecssful, and then unfreezes the player on
2698the new (success) or old (failed) map position. In either case, $done will
2699be called at the end of this process.
2700
2701Note that $check will be called with a potentially non-loaded map, so if
2702it needs a loaded map it has to call C<< ->load >>.
2703
1853=cut 2704=cut
2705
2706our $GOTOGEN;
1854 2707
1855sub cf::object::player::goto { 2708sub cf::object::player::goto {
1856 my ($self, $path, $x, $y) = @_; 2709 my ($self, $path, $x, $y, $check, $done) = @_;
2710
2711 if ($self->{_link_recursion} >= $MAX_LINKS) {
2712 error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
2713 $self->failmsg ("Something went wrong inside the server - please contact an administrator!");
2714 ($path, $x, $y) = @$EMERGENCY_POSITION;
2715 }
2716
2717 # do generation counting so two concurrent goto's will be executed in-order
2718 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857 2719
1858 $self->enter_link; 2720 $self->enter_link;
1859 2721
1860 (async { 2722 (async {
2723 $Coro::current->{desc} = "player::goto $path $x $y";
2724
2725 # *tag paths override both path and x|y
2726 if ($path =~ /^\*(.*)$/) {
2727 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2728 my $ob = $obs[rand @obs];
2729
2730 # see if we actually can go there
2731 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2732 $ob = $obs[rand @obs];
2733 } else {
2734 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2735 }
2736 # else put us there anyways for now #d#
2737
2738 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2739 } else {
2740 ($path, $x, $y) = (undef, undef, undef);
2741 }
2742 }
2743
1861 my $map = eval { 2744 my $map = eval {
1862 my $map = cf::map::find $path; 2745 my $map = defined $path ? cf::map::find $path : undef;
2746
2747 if ($map) {
1863 $map = $map->customise_for ($self) if $map; 2748 $map = $map->customise_for ($self);
2749 $map = $check->($map, $x, $y, $self) if $check && $map;
2750 } else {
2751 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2752 }
2753
1864 $map 2754 $map
2755 };
2756
2757 if ($@) {
2758 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2759 LOG llevError | logBacktrace, Carp::longmess $@;
1865 } or 2760 }
1866 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867 2761
2762 if ($gen == $self->{_goto_generation}) {
2763 delete $self->{_goto_generation};
1868 $self->leave_link ($map, $x, $y); 2764 $self->leave_link ($map, $x, $y);
2765 }
2766
2767 $done->($self) if $done;
1869 })->prio (1); 2768 })->prio (1);
1870} 2769}
1871 2770
1872=item $player_object->enter_exit ($exit_object) 2771=item $player_object->enter_exit ($exit_object)
1873 2772
1893} 2792}
1894 2793
1895sub prepare_random_map { 2794sub prepare_random_map {
1896 my ($exit) = @_; 2795 my ($exit) = @_;
1897 2796
1898 my $guard = cf::lock_acquire "exit_prepare:$exit";
1899
1900 # all this does is basically replace the /! path by 2797 # all this does is basically replace the /! path by
1901 # a new random map path (?random/...) with a seed 2798 # a new random map path (?random/...) with a seed
1902 # that depends on the exit object 2799 # that depends on the exit object
1903 2800
1904 my $rmp = parse_random_map_params $exit->msg; 2801 my $rmp = parse_random_map_params $exit->msg;
1906 if ($exit->map) { 2803 if ($exit->map) {
1907 $rmp->{region} = $exit->region->name; 2804 $rmp->{region} = $exit->region->name;
1908 $rmp->{origin_map} = $exit->map->path; 2805 $rmp->{origin_map} = $exit->map->path;
1909 $rmp->{origin_x} = $exit->x; 2806 $rmp->{origin_x} = $exit->x;
1910 $rmp->{origin_y} = $exit->y; 2807 $rmp->{origin_y} = $exit->y;
2808
2809 $exit->map->touch;
1911 } 2810 }
1912 2811
1913 $rmp->{random_seed} ||= $exit->random_seed; 2812 $rmp->{random_seed} ||= $exit->random_seed;
1914 2813
1915 my $data = cf::to_json $rmp; 2814 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1916 my $md5 = Digest::MD5::md5_hex $data; 2815 my $md5 = Digest::MD5::md5_hex $data;
1917 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2816 my $meta = "$RANDOMDIR/$md5.meta";
1918 2817
1919 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2818 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920 aio_write $fh, 0, (length $data), $data, 0; 2819 aio_write $fh, 0, (length $data), $data, 0;
1921 undef $fh; 2820 undef $fh;
1922 aio_rename "$meta~", $meta; 2821 aio_rename "$meta~", $meta;
1923 2822
2823 my $slaying = "?random/$md5";
2824
2825 if ($exit->valid) {
1924 $exit->slaying ("?random/$md5"); 2826 $exit->slaying ("?random/$md5");
1925 $exit->msg (undef); 2827 $exit->msg (undef);
2828 }
1926 } 2829 }
1927} 2830}
1928 2831
1929sub cf::object::player::enter_exit { 2832sub cf::object::player::enter_exit {
1930 my ($self, $exit) = @_; 2833 my ($self, $exit) = @_;
1931 2834
1932 return unless $self->type == cf::PLAYER; 2835 return unless $self->type == cf::PLAYER;
1933 2836
1934 if ($exit->slaying eq "/!") {
1935 #TODO: this should de-fi-ni-te-ly not be a sync-job
1936 cf::sync_job { prepare_random_map $exit };
1937 }
1938
1939 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940 my $hp = $exit->stats->hp;
1941 my $sp = $exit->stats->sp;
1942
1943 $self->enter_link; 2837 $self->enter_link;
1944 2838
1945 (async { 2839 (async {
1946 $self->deactivate_recursive; # just to be sure 2840 $Coro::current->{desc} = "enter_exit";
2841
1947 unless (eval { 2842 unless (eval {
2843 $self->deactivate_recursive; # just to be sure
2844
2845 # random map handling
2846 {
2847 my $guard = cf::lock_acquire "exit_prepare:$exit";
2848
2849 prepare_random_map $exit
2850 if $exit->slaying eq "/!";
2851 }
2852
2853 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2854 my $x = $exit->stats->hp;
2855 my $y = $exit->stats->sp;
2856
1948 $self->goto ($slaying, $hp, $sp); 2857 $self->goto ($map, $x, $y);
1949 2858
2859 # if exit is damned, update players death & WoR home-position
2860 $self->contr->savebed ($map, $x, $y)
2861 if $exit->flag (cf::FLAG_DAMNED);
2862
1950 1; 2863 1
1951 }) { 2864 }) {
1952 $self->message ("Something went wrong deep within the crossfire server. " 2865 $self->message ("Something went wrong deep within the deliantra server. "
1953 . "I'll try to bring you back to the map you were before. " 2866 . "I'll try to bring you back to the map you were before. "
1954 . "Please report this to the dungeon master!", 2867 . "Please report this to the dungeon master!",
1955 cf::NDI_UNIQUE | cf::NDI_RED); 2868 cf::NDI_UNIQUE | cf::NDI_RED);
1956 2869
1957 warn "ERROR in enter_exit: $@"; 2870 error "ERROR in enter_exit: $@";
1958 $self->leave_link; 2871 $self->leave_link;
1959 } 2872 }
1960 })->prio (1); 2873 })->prio (1);
1961} 2874}
1962 2875
1973 2886
1974sub cf::client::send_drawinfo { 2887sub cf::client::send_drawinfo {
1975 my ($self, $text, $flags) = @_; 2888 my ($self, $text, $flags) = @_;
1976 2889
1977 utf8::encode $text; 2890 utf8::encode $text;
1978 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2891 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979} 2892}
1980 2893
2894=item $client->send_big_packet ($pkt)
2895
2896Like C<send_packet>, but tries to compress large packets, and fragments
2897them as required.
2898
2899=cut
2900
2901our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2902
2903sub cf::client::send_big_packet {
2904 my ($self, $pkt) = @_;
2905
2906 # try lzf for large packets
2907 $pkt = "lzf " . Compress::LZF::compress $pkt
2908 if 1024 <= length $pkt and $self->{can_lzf};
2909
2910 # split very large packets
2911 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2912 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2913 $pkt = "frag";
2914 }
2915
2916 $self->send_packet ($pkt);
2917}
2918
2919=item $client->send_msg ($channel, $msg, $color, [extra...])
2920
2921Send a drawinfo or msg packet to the client, formatting the msg for the
2922client if neccessary. C<$type> should be a string identifying the type of
2923the message, with C<log> being the default. If C<$color> is negative, suppress
2924the message unless the client supports the msg packet.
2925
2926=cut
2927
2928# non-persistent channels (usually the info channel)
2929our %CHANNEL = (
2930 "c/motd" => {
2931 id => "infobox",
2932 title => "MOTD",
2933 reply => undef,
2934 tooltip => "The message of the day",
2935 },
2936 "c/identify" => {
2937 id => "infobox",
2938 title => "Identify",
2939 reply => undef,
2940 tooltip => "Items recently identified",
2941 },
2942 "c/examine" => {
2943 id => "infobox",
2944 title => "Examine",
2945 reply => undef,
2946 tooltip => "Signs and other items you examined",
2947 },
2948 "c/shopinfo" => {
2949 id => "infobox",
2950 title => "Shop Info",
2951 reply => undef,
2952 tooltip => "What your bargaining skill tells you about the shop",
2953 },
2954 "c/book" => {
2955 id => "infobox",
2956 title => "Book",
2957 reply => undef,
2958 tooltip => "The contents of a note or book",
2959 },
2960 "c/lookat" => {
2961 id => "infobox",
2962 title => "Look",
2963 reply => undef,
2964 tooltip => "What you saw there",
2965 },
2966 "c/who" => {
2967 id => "infobox",
2968 title => "Players",
2969 reply => undef,
2970 tooltip => "Shows players who are currently online",
2971 },
2972 "c/body" => {
2973 id => "infobox",
2974 title => "Body Parts",
2975 reply => undef,
2976 tooltip => "Shows which body parts you posess and are available",
2977 },
2978 "c/statistics" => {
2979 id => "infobox",
2980 title => "Statistics",
2981 reply => undef,
2982 tooltip => "Shows your primary statistics",
2983 },
2984 "c/skills" => {
2985 id => "infobox",
2986 title => "Skills",
2987 reply => undef,
2988 tooltip => "Shows your experience per skill and item power",
2989 },
2990 "c/shopitems" => {
2991 id => "infobox",
2992 title => "Shop Items",
2993 reply => undef,
2994 tooltip => "Shows the items currently for sale in this shop",
2995 },
2996 "c/resistances" => {
2997 id => "infobox",
2998 title => "Resistances",
2999 reply => undef,
3000 tooltip => "Shows your resistances",
3001 },
3002 "c/pets" => {
3003 id => "infobox",
3004 title => "Pets",
3005 reply => undef,
3006 tooltip => "Shows information abotu your pets/a specific pet",
3007 },
3008 "c/perceiveself" => {
3009 id => "infobox",
3010 title => "Perceive Self",
3011 reply => undef,
3012 tooltip => "You gained detailed knowledge about yourself",
3013 },
3014 "c/uptime" => {
3015 id => "infobox",
3016 title => "Uptime",
3017 reply => undef,
3018 tooltip => "How long the server has been running since last restart",
3019 },
3020 "c/mapinfo" => {
3021 id => "infobox",
3022 title => "Map Info",
3023 reply => undef,
3024 tooltip => "Information related to the maps",
3025 },
3026 "c/party" => {
3027 id => "party",
3028 title => "Party",
3029 reply => "gsay ",
3030 tooltip => "Messages and chat related to your party",
3031 },
3032 "c/death" => {
3033 id => "death",
3034 title => "Death",
3035 reply => undef,
3036 tooltip => "Reason for and more info about your most recent death",
3037 },
3038 "c/say" => $SAY_CHANNEL,
3039 "c/chat" => $CHAT_CHANNEL,
3040);
3041
3042sub cf::client::send_msg {
3043 my ($self, $channel, $msg, $color, @extra) = @_;
3044
3045 $msg = $self->pl->expand_cfpod ($msg)
3046 unless $color & cf::NDI_VERBATIM;
3047
3048 $color &= cf::NDI_CLIENT_MASK; # just in case...
3049
3050 # check predefined channels, for the benefit of C
3051 if ($CHANNEL{$channel}) {
3052 $channel = $CHANNEL{$channel};
3053
3054 $self->ext_msg (channel_info => $channel);
3055 $channel = $channel->{id};
3056
3057 } elsif (ref $channel) {
3058 # send meta info to client, if not yet sent
3059 unless (exists $self->{channel}{$channel->{id}}) {
3060 $self->{channel}{$channel->{id}} = $channel;
3061 $self->ext_msg (channel_info => $channel);
3062 }
3063
3064 $channel = $channel->{id};
3065 }
3066
3067 return unless @extra || length $msg;
3068
3069 # default colour, mask it out
3070 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3071 if $color & cf::NDI_DEF;
3072
3073 my $pkt = "msg "
3074 . $self->{json_coder}->encode (
3075 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3076 );
3077
3078 $self->send_big_packet ($pkt);
3079}
3080
3081=item $client->ext_msg ($type, @msg)
3082
3083Sends an ext event to the client.
3084
3085=cut
3086
3087sub cf::client::ext_msg($$@) {
3088 my ($self, $type, @msg) = @_;
3089
3090 if ($self->extcmd == 2) {
3091 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
3092 } elsif ($self->extcmd == 1) { # TODO: remove
3093 push @msg, msgtype => "event_$type";
3094 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3095 }
3096}
3097
3098=item $client->ext_reply ($msgid, @msg)
3099
3100Sends an ext reply to the client.
3101
3102=cut
3103
3104sub cf::client::ext_reply($$@) {
3105 my ($self, $id, @msg) = @_;
3106
3107 if ($self->extcmd == 2) {
3108 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
3109 } elsif ($self->extcmd == 1) {
3110 #TODO: version 1, remove
3111 unshift @msg, msgtype => "reply", msgid => $id;
3112 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3113 }
3114}
1981 3115
1982=item $success = $client->query ($flags, "text", \&cb) 3116=item $success = $client->query ($flags, "text", \&cb)
1983 3117
1984Queues a query to the client, calling the given callback with 3118Queues a query to the client, calling the given callback with
1985the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3119the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1986C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3120C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1987 3121
1988Queries can fail, so check the return code. Or don't, as queries will become 3122Queries can fail, so check the return code. Or don't, as queries will
1989reliable at some point in the future. 3123become reliable at some point in the future.
1990 3124
1991=cut 3125=cut
1992 3126
1993sub cf::client::query { 3127sub cf::client::query {
1994 my ($self, $flags, $text, $cb) = @_; 3128 my ($self, $flags, $text, $cb) = @_;
2002 utf8::encode $text; 3136 utf8::encode $text;
2003 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3137 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2004 3138
2005 $self->send_packet ($self->{query_queue}[0][0]) 3139 $self->send_packet ($self->{query_queue}[0][0])
2006 if @{ $self->{query_queue} } == 1; 3140 if @{ $self->{query_queue} } == 1;
3141
3142 1
2007} 3143}
2008 3144
2009cf::client->attach ( 3145cf::client->attach (
3146 on_connect => sub {
3147 my ($ns) = @_;
3148
3149 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3150 },
2010 on_reply => sub { 3151 on_reply => sub {
2011 my ($ns, $msg) = @_; 3152 my ($ns, $msg) = @_;
2012 3153
2013 # this weird shuffling is so that direct followup queries 3154 # this weird shuffling is so that direct followup queries
2014 # get handled first 3155 # get handled first
2026 } else { 3167 } else {
2027 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3168 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2028 } 3169 }
2029 } 3170 }
2030 }, 3171 },
3172 on_exticmd => sub {
3173 my ($ns, $buf) = @_;
3174
3175 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3176
3177 if (ref $msg) {
3178 my ($type, $reply, @payload) =
3179 "ARRAY" eq ref $msg
3180 ? @$msg
3181 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3182
3183 my @reply;
3184
3185 if (my $cb = $EXTICMD{$type}) {
3186 @reply = $cb->($ns, @payload);
3187 }
3188
3189 $ns->ext_reply ($reply, @reply)
3190 if $reply;
3191
3192 } else {
3193 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3194 }
3195
3196 cf::override;
3197 },
2031); 3198);
2032 3199
2033=item $client->async (\&cb) 3200=item $client->async (\&cb)
2034 3201
2035Create a new coroutine, running the specified callback. The coroutine will 3202Create a new coroutine, running the specified callback. The coroutine will
2051 3218
2052 $coro 3219 $coro
2053} 3220}
2054 3221
2055cf::client->attach ( 3222cf::client->attach (
2056 on_destroy => sub { 3223 on_client_destroy => sub {
2057 my ($ns) = @_; 3224 my ($ns) = @_;
2058 3225
2059 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3226 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2060 }, 3227 },
2061); 3228);
2076our $safe = new Safe "safe"; 3243our $safe = new Safe "safe";
2077our $safe_hole = new Safe::Hole; 3244our $safe_hole = new Safe::Hole;
2078 3245
2079$SIG{FPE} = 'IGNORE'; 3246$SIG{FPE} = 'IGNORE';
2080 3247
2081$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3248$safe->permit_only (Opcode::opset qw(
3249 :base_core :base_mem :base_orig :base_math :base_loop
3250 grepstart grepwhile mapstart mapwhile
3251 sort time
3252));
2082 3253
2083# here we export the classes and methods available to script code 3254# here we export the classes and methods available to script code
2084 3255
2085=pod 3256=pod
2086 3257
2087The following fucntions and emthods are available within a safe environment: 3258The following functions and methods are available within a safe environment:
2088 3259
2089 cf::object contr pay_amount pay_player map 3260 cf::object
3261 contr pay_amount pay_player map x y force_find force_add destroy
3262 insert remove name archname title slaying race decrease split
3263 value
3264
2090 cf::object::player player 3265 cf::object::player
2091 cf::player peaceful 3266 player
2092 cf::map trigger 3267
3268 cf::player
3269 peaceful
3270
3271 cf::map
3272 trigger
2093 3273
2094=cut 3274=cut
2095 3275
2096for ( 3276for (
2097 ["cf::object" => qw(contr pay_amount pay_player map)], 3277 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3278 insert remove inv nrof name archname title slaying race
3279 decrease split destroy change_exp value msg lore send_msg)],
2098 ["cf::object::player" => qw(player)], 3280 ["cf::object::player" => qw(player)],
2099 ["cf::player" => qw(peaceful)], 3281 ["cf::player" => qw(peaceful send_msg)],
2100 ["cf::map" => qw(trigger)], 3282 ["cf::map" => qw(trigger)],
2101) { 3283) {
2102 no strict 'refs';
2103 my ($pkg, @funs) = @$_; 3284 my ($pkg, @funs) = @$_;
2104 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3285 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2105 for @funs; 3286 for @funs;
2106} 3287}
2107 3288
2122 3303
2123 my $qcode = $code; 3304 my $qcode = $code;
2124 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3305 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2125 $qcode =~ s/\n/\\n/g; 3306 $qcode =~ s/\n/\\n/g;
2126 3307
3308 %vars = (_dummy => 0) unless %vars;
3309
3310 my @res;
2127 local $_; 3311 local $_;
2128 local @safe::cf::_safe_eval_args = values %vars;
2129 3312
2130 my $eval = 3313 my $eval =
2131 "do {\n" 3314 "do {\n"
2132 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3315 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2133 . "#line 0 \"{$qcode}\"\n" 3316 . "#line 0 \"{$qcode}\"\n"
2134 . $code 3317 . $code
2135 . "\n}" 3318 . "\n}"
2136 ; 3319 ;
2137 3320
3321 if ($CFG{safe_eval}) {
2138 sub_generation_inc; 3322 sub_generation_inc;
3323 local @safe::cf::_safe_eval_args = values %vars;
2139 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3324 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2140 sub_generation_inc; 3325 sub_generation_inc;
3326 } else {
3327 local @cf::_safe_eval_args = values %vars;
3328 @res = wantarray ? eval eval : scalar eval $eval;
3329 }
2141 3330
2142 if ($@) { 3331 if ($@) {
2143 warn "$@"; 3332 warn "$@",
2144 warn "while executing safe code '$code'\n"; 3333 "while executing safe code '$code'\n",
2145 warn "with arguments " . (join " ", %vars) . "\n"; 3334 "with arguments " . (join " ", %vars) . "\n";
2146 } 3335 }
2147 3336
2148 wantarray ? @res : $res[0] 3337 wantarray ? @res : $res[0]
2149} 3338}
2150 3339
2164=cut 3353=cut
2165 3354
2166sub register_script_function { 3355sub register_script_function {
2167 my ($fun, $cb) = @_; 3356 my ($fun, $cb) = @_;
2168 3357
2169 no strict 'refs'; 3358 $fun = "safe::$fun" if $CFG{safe_eval};
2170 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3359 *$fun = $safe_hole->wrap ($cb);
2171} 3360}
2172 3361
2173=back 3362=back
2174 3363
2175=cut 3364=cut
2176
2177#############################################################################
2178
2179=head2 EXTENSION DATABASE SUPPORT
2180
2181Crossfire maintains a very simple database for extension use. It can
2182currently store anything that can be serialised using Storable, which
2183excludes objects.
2184
2185The parameter C<$family> should best start with the name of the extension
2186using it, it should be unique.
2187
2188=over 4
2189
2190=item $value = cf::db_get $family => $key
2191
2192Returns a single value from the database.
2193
2194=item cf::db_put $family => $key => $value
2195
2196Stores the given C<$value> in the family.
2197
2198=cut
2199
2200our $DB;
2201
2202unless ($DB) {
2203 $DB = BDB::db_create $DB_ENV;
2204
2205 cf::sync_job {
2206 eval {
2207 $DB->set_flags (BDB::CHKSUM);
2208
2209 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2210 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2211 cf::cleanup "db_open(db): $!" if $!;
2212 };
2213 cf::cleanup "db_open(db): $@" if $@;
2214 };
2215
2216 my $path = cf::localdir . "/database.pst";
2217 if (stat $path) {
2218 cf::sync_job {
2219 my $pst = Storable::retrieve $path;
2220
2221 cf::db_put (board => data => $pst->{board});
2222 cf::db_put (guildrules => data => $pst->{guildrules});
2223 cf::db_put (rent => balance => $pst->{rent}{balance});
2224 BDB::db_env_txn_checkpoint $DB_ENV;
2225
2226 unlink $path;
2227 };
2228 }
2229}
2230
2231sub db_get($$) {
2232 my $key = "$_[0]/$_[1]";
2233
2234 cf::sync_job {
2235 BDB::db_get $DB, undef, $key, my $data;
2236
2237 $! ? ()
2238 : Compress::LZF::sthaw $data
2239 }
2240}
2241
2242sub db_put($$$) {
2243 BDB::dbreq_pri 4;
2244 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2245}
2246 3365
2247############################################################################# 3366#############################################################################
2248# the server's init and main functions 3367# the server's init and main functions
2249 3368
3369sub load_facedata($) {
3370 my ($path) = @_;
3371
3372 # HACK to clear player env face cache, we need some signal framework
3373 # for this (global event?)
3374 %ext::player_env::MUSIC_FACE_CACHE = ();
3375
3376 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3377
3378 trace "loading facedata from $path\n";
3379
3380 0 < aio_load $path, my $facedata
3381 or die "$path: $!";
3382
3383 $facedata = Coro::Storable::thaw $facedata;
3384
3385 $facedata->{version} == 2
3386 or cf::cleanup "$path: version mismatch, cannot proceed.";
3387
3388 # patch in the exptable
3389 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3390 $facedata->{resource}{"res/exp_table"} = {
3391 type => FT_RSRC,
3392 data => $exp_table,
3393 hash => (Digest::MD5::md5 $exp_table),
3394 };
3395 cf::cede_to_tick;
3396
3397 {
3398 my $faces = $facedata->{faceinfo};
3399
3400 while (my ($face, $info) = each %$faces) {
3401 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3402
3403 cf::face::set_visibility $idx, $info->{visibility};
3404 cf::face::set_magicmap $idx, $info->{magicmap};
3405 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
3406 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
3407
3408 cf::cede_to_tick;
3409 }
3410
3411 while (my ($face, $info) = each %$faces) {
3412 next unless $info->{smooth};
3413
3414 my $idx = cf::face::find $face
3415 or next;
3416
3417 if (my $smooth = cf::face::find $info->{smooth}) {
3418 cf::face::set_smooth $idx, $smooth;
3419 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3420 } else {
3421 error "smooth face '$info->{smooth}' not found for face '$face'";
3422 }
3423
3424 cf::cede_to_tick;
3425 }
3426 }
3427
3428 {
3429 my $anims = $facedata->{animinfo};
3430
3431 while (my ($anim, $info) = each %$anims) {
3432 cf::anim::set $anim, $info->{frames}, $info->{facings};
3433 cf::cede_to_tick;
3434 }
3435
3436 cf::anim::invalidate_all; # d'oh
3437 }
3438
3439 {
3440 my $res = $facedata->{resource};
3441
3442 while (my ($name, $info) = each %$res) {
3443 if (defined $info->{type}) {
3444 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3445
3446 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3447 cf::face::set_type $idx, $info->{type};
3448 } else {
3449 $RESOURCE{$name} = $info; # unused
3450 }
3451
3452 cf::cede_to_tick;
3453 }
3454 }
3455
3456 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3457
3458 1
3459}
3460
3461register_exticmd fx_want => sub {
3462 my ($ns, $want) = @_;
3463
3464 while (my ($k, $v) = each %$want) {
3465 $ns->fx_want ($k, $v);
3466 }
3467};
3468
2250sub load_resources { 3469sub load_resource_file($) {
2251 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3470 my $guard = lock_acquire "load_resource_file";
3471
3472 my $status = load_resource_file_ $_[0];
3473 get_slot 0.1, 100;
3474 cf::arch::commit_load;
3475
3476 $status
3477}
3478
3479sub reload_regions {
3480 # HACK to clear player env face cache, we need some signal framework
3481 # for this (global event?)
3482 %ext::player_env::MUSIC_FACE_CACHE = ();
3483
3484 load_resource_file "$MAPDIR/regions"
2252 or die "unable to load regions file\n";#d# 3485 or die "unable to load regions file\n";
2253}
2254 3486
2255sub cfg_load { 3487 for (cf::region::list) {
2256 open my $fh, "<:utf8", cf::confdir . "/config" 3488 $_->{match} = qr/$_->{match}/
2257 or return; 3489 if exists $_->{match};
3490 }
3491}
2258 3492
2259 local $/; 3493sub reload_facedata {
3494 load_facedata "$DATADIR/facedata"
3495 or die "unable to load facedata\n";
3496}
3497
3498sub reload_archetypes {
3499 load_resource_file "$DATADIR/archetypes"
3500 or die "unable to load archetypes\n";
3501}
3502
3503sub reload_treasures {
3504 load_resource_file "$DATADIR/treasures"
3505 or die "unable to load treasurelists\n";
3506}
3507
3508sub reload_sound {
3509 trace "loading sound config from $DATADIR/sound\n";
3510
3511 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3512 or die "$DATADIR/sound $!";
3513
3514 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3515
3516 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3517 my $sound = $soundconf->{compat}[$_]
3518 or next;
3519
3520 my $face = cf::face::find "sound/$sound->[1]";
3521 cf::sound::set $sound->[0] => $face;
3522 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3523 }
3524
3525 while (my ($k, $v) = each %{$soundconf->{event}}) {
3526 my $face = cf::face::find "sound/$v";
3527 cf::sound::set $k => $face;
3528 }
3529}
3530
3531sub reload_resources {
3532 trace "reloading resource files...\n";
3533
3534 reload_exp_table;
3535 reload_materials;
3536 reload_facedata;
3537 reload_sound;
3538 reload_archetypes;
3539 reload_regions;
3540 reload_treasures;
3541
3542 trace "finished reloading resource files\n";
3543}
3544
3545sub reload_config {
3546 trace "reloading config file...\n";
3547
3548 0 < aio_load "$CONFDIR/config", my $config
3549 or die "$CONFDIR/config: $!";
3550
3551 utf8::decode $config;
3552
3553 cf::get_slot 0.1, 10, "reload_config"; # yaml might be slow...
2260 *CFG = YAML::Syck::Load <$fh>; 3554 *CFG = YAML::XS::Load $config;
2261 3555
2262 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3556 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2263 3557
2264 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3558 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2265 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3559 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2266 3560
2267 if (exists $CFG{mlockall}) { 3561 if (exists $CFG{mlockall}) {
2271 }; 3565 };
2272 warn $@ if $@; 3566 warn $@ if $@;
2273 } 3567 }
2274} 3568}
2275 3569
2276sub init { 3570sub pidfile() {
2277 load_resources; 3571 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3572 or die "$PIDFILE: $!";
3573 flock $fh, &Fcntl::LOCK_EX
3574 or die "$PIDFILE: flock: $!";
3575 $fh
3576}
3577
3578# make sure only one server instance is running at any one time
3579sub atomic {
3580 my $fh = pidfile;
3581
3582 my $pid = <$fh>;
3583 kill 9, $pid if $pid > 0;
3584
3585 seek $fh, 0, 0;
3586 print $fh $$;
3587}
3588
3589sub main_loop {
3590 trace "EV::loop starting\n";
3591 if (1) {
3592 EV::loop;
3593 }
3594 trace "EV::loop returned\n";
3595 goto &main_loop unless $REALLY_UNLOOP;
2278} 3596}
2279 3597
2280sub main { 3598sub main {
3599 cf::init_globals; # initialise logging
3600
3601 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3602 LOG llevInfo, "Copyright (C) 2005-2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3603 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3604 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3605
3606 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3607
2281 # we must not ever block the main coroutine 3608 # we must not ever block the main coroutine
2282 local $Coro::idle = sub { 3609 local $Coro::idle = sub {
2283 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3610 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2284 (async { 3611 (async {
2285 Event::one_event; 3612 $Coro::current->{desc} = "IDLE BUG HANDLER";
3613 EV::loop EV::LOOP_ONESHOT;
2286 })->prio (Coro::PRIO_MAX); 3614 })->prio (Coro::PRIO_MAX);
2287 }; 3615 };
2288 3616
2289 cfg_load; 3617 evthread_start IO::AIO::poll_fileno;
3618
3619 cf::sync_job {
3620 cf::incloader::init ();
3621
3622 cf::init_anim;
3623 cf::init_attackmess;
3624 cf::init_dynamic;
3625
3626 cf::load_settings;
3627
3628 reload_resources;
3629 reload_config;
3630 db_init;
3631
3632 cf::init_uuid;
3633 cf::init_signals;
3634 cf::init_skills;
3635
3636 cf::init_beforeplay;
3637
3638 atomic;
3639
2290 load_extensions; 3640 load_extensions;
2291 3641
2292 $TICK_WATCHER->start; 3642 utime time, time, $RUNTIMEFILE;
2293 Event::loop; 3643
3644 # no (long-running) fork's whatsoever before this point(!)
3645 use POSIX ();
3646 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3647
3648 (pop @POST_INIT)->(0) while @POST_INIT;
3649 };
3650
3651 cf::object::thawer::errors_are_fatal 0;
3652 info "parse errors in files are no longer fatal from this point on.\n";
3653
3654 my $free_main; $free_main = EV::idle sub {
3655 undef $free_main;
3656 undef &main; # free gobs of memory :)
3657 };
3658
3659 goto &main_loop;
2294} 3660}
2295 3661
2296############################################################################# 3662#############################################################################
2297# initialisation and cleanup 3663# initialisation and cleanup
2298 3664
2299# install some emergency cleanup handlers 3665# install some emergency cleanup handlers
2300BEGIN { 3666BEGIN {
3667 our %SIGWATCHER = ();
2301 for my $signal (qw(INT HUP TERM)) { 3668 for my $signal (qw(INT HUP TERM)) {
2302 Event->signal ( 3669 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2303 reentrant => 0,
2304 data => WF_AUTOCANCEL,
2305 signal => $signal,
2306 prio => 0,
2307 cb => sub {
2308 cf::cleanup "SIG$signal"; 3670 cf::cleanup "SIG$signal";
2309 },
2310 ); 3671 };
3672 }
3673}
3674
3675sub write_runtime_sync {
3676 my $t0 = AE::time;
3677
3678 # first touch the runtime file to show we are still running:
3679 # the fsync below can take a very very long time.
3680
3681 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3682
3683 my $guard = cf::lock_acquire "write_runtime";
3684
3685 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3686 or return;
3687
3688 my $value = $cf::RUNTIME + 90 + 10;
3689 # 10 is the runtime save interval, for a monotonic clock
3690 # 60 allows for the watchdog to kill the server.
3691
3692 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3693 and return;
3694
3695 # always fsync - this file is important
3696 aio_fsync $fh
3697 and return;
3698
3699 # touch it again to show we are up-to-date
3700 aio_utime $fh, undef, undef;
3701
3702 close $fh
3703 or return;
3704
3705 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3706 and return;
3707
3708 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3709
2311 } 3710 1
3711}
3712
3713our $uuid_lock;
3714our $uuid_skip;
3715
3716sub write_uuid_sync($) {
3717 $uuid_skip ||= $_[0];
3718
3719 return if $uuid_lock;
3720 local $uuid_lock = 1;
3721
3722 my $uuid = "$LOCALDIR/uuid";
3723
3724 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3725 or return;
3726
3727 my $value = uuid_seq uuid_cur;
3728
3729 unless ($value) {
3730 info "cowardly refusing to write zero uuid value!\n";
3731 return;
3732 }
3733
3734 my $value = uuid_str $value + $uuid_skip;
3735 $uuid_skip = 0;
3736
3737 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3738 and return;
3739
3740 # always fsync - this file is important
3741 aio_fsync $fh
3742 and return;
3743
3744 close $fh
3745 or return;
3746
3747 aio_rename "$uuid~", $uuid
3748 and return;
3749
3750 trace "uuid file written ($value).\n";
3751
3752 1
3753
3754}
3755
3756sub write_uuid($$) {
3757 my ($skip, $sync) = @_;
3758
3759 $sync ? write_uuid_sync $skip
3760 : async { write_uuid_sync $skip };
2312} 3761}
2313 3762
2314sub emergency_save() { 3763sub emergency_save() {
2315 my $freeze_guard = cf::freeze_mainloop; 3764 my $freeze_guard = cf::freeze_mainloop;
2316 3765
2317 warn "enter emergency perl save\n"; 3766 info "emergency_perl_save: enter\n";
3767
3768 # this is a trade-off: we want to be very quick here, so
3769 # save all maps without fsync, and later call a global sync
3770 # (which in turn might be very very slow)
3771 local $USE_FSYNC = 0;
2318 3772
2319 cf::sync_job { 3773 cf::sync_job {
3774 cf::write_runtime_sync; # external watchdog should not bark
3775
2320 # use a peculiar iteration method to avoid tripping on perl 3776 # use a peculiar iteration method to avoid tripping on perl
2321 # refcount bugs in for. also avoids problems with players 3777 # refcount bugs in for. also avoids problems with players
2322 # and maps saved/destroyed asynchronously. 3778 # and maps saved/destroyed asynchronously.
2323 warn "begin emergency player save\n"; 3779 info "emergency_perl_save: begin player save\n";
2324 for my $login (keys %cf::PLAYER) { 3780 for my $login (keys %cf::PLAYER) {
2325 my $pl = $cf::PLAYER{$login} or next; 3781 my $pl = $cf::PLAYER{$login} or next;
2326 $pl->valid or next; 3782 $pl->valid or next;
3783 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2327 $pl->save; 3784 $pl->save;
2328 } 3785 }
2329 warn "end emergency player save\n"; 3786 info "emergency_perl_save: end player save\n";
2330 3787
2331 warn "begin emergency map save\n"; 3788 cf::write_runtime_sync; # external watchdog should not bark
3789
3790 info "emergency_perl_save: begin map save\n";
2332 for my $path (keys %cf::MAP) { 3791 for my $path (keys %cf::MAP) {
2333 my $map = $cf::MAP{$path} or next; 3792 my $map = $cf::MAP{$path} or next;
2334 $map->valid or next; 3793 $map->valid or next;
2335 $map->save; 3794 $map->save;
2336 } 3795 }
2337 warn "end emergency map save\n"; 3796 info "emergency_perl_save: end map save\n";
2338 3797
2339 warn "begin emergency database checkpoint\n"; 3798 cf::write_runtime_sync; # external watchdog should not bark
3799
3800 info "emergency_perl_save: begin database checkpoint\n";
2340 BDB::db_env_txn_checkpoint $DB_ENV; 3801 BDB::db_env_txn_checkpoint $DB_ENV;
2341 warn "end emergency database checkpoint\n"; 3802 info "emergency_perl_save: end database checkpoint\n";
3803
3804 info "emergency_perl_save: begin write uuid\n";
3805 write_uuid_sync 1;
3806 info "emergency_perl_save: end write uuid\n";
3807
3808 cf::write_runtime_sync; # external watchdog should not bark
3809
3810 trace "emergency_perl_save: syncing database to disk";
3811 BDB::db_env_txn_checkpoint $DB_ENV;
3812
3813 info "emergency_perl_save: starting sync\n";
3814 IO::AIO::aio_sync sub {
3815 info "emergency_perl_save: finished sync\n";
3816 };
3817
3818 cf::write_runtime_sync; # external watchdog should not bark
3819
3820 trace "emergency_perl_save: flushing outstanding aio requests";
3821 while (IO::AIO::nreqs || BDB::nreqs) {
3822 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3823 }
3824
3825 cf::write_runtime_sync; # external watchdog should not bark
2342 }; 3826 };
2343 3827
2344 warn "leave emergency perl save\n"; 3828 info "emergency_perl_save: leave\n";
2345} 3829}
2346 3830
3831sub post_cleanup {
3832 my ($make_core) = @_;
3833
3834 IO::AIO::flush;
3835
3836 error Carp::longmess "post_cleanup backtrace"
3837 if $make_core;
3838
3839 my $fh = pidfile;
3840 unlink $PIDFILE if <$fh> == $$;
3841}
3842
3843# a safer delete_package, copied from Symbol
3844sub clear_package($) {
3845 my $pkg = shift;
3846
3847 # expand to full symbol table name if needed
3848 unless ($pkg =~ /^main::.*::$/) {
3849 $pkg = "main$pkg" if $pkg =~ /^::/;
3850 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3851 $pkg .= '::' unless $pkg =~ /::$/;
3852 }
3853
3854 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3855 my $stem_symtab = *{$stem}{HASH};
3856
3857 defined $stem_symtab and exists $stem_symtab->{$leaf}
3858 or return;
3859
3860 # clear all symbols
3861 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3862 for my $name (keys %$leaf_symtab) {
3863 _gv_clear *{"$pkg$name"};
3864# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3865 }
3866}
3867
2347sub reload() { 3868sub do_reload_perl() {
2348 # can/must only be called in main 3869 # can/must only be called in main
2349 if ($Coro::current != $Coro::main) { 3870 unless (in_main) {
2350 warn "can only reload from main coroutine"; 3871 error "can only reload from main coroutine";
2351 return; 3872 return;
2352 } 3873 }
2353 3874
3875 return if $RELOAD++;
3876
3877 my $t1 = AE::time;
3878
3879 while ($RELOAD) {
3880 cf::get_slot 0.1, -1, "reload_perl";
2354 warn "reloading..."; 3881 info "reloading...";
2355 3882
2356 warn "cancelling server ticker"; 3883 trace "entering sync_job";
2357 $TICK_WATCHER->cancel;
2358 3884
3885 cf::sync_job {
2359 cf::emergency_save; 3886 #cf::emergency_save;
2360 3887
2361 eval {
2362 # if anything goes wrong in here, we should simply crash as we already saved
2363
2364 warn "cancelling all WF_AUTOCANCEL watchers";
2365 for (Event::all_watchers) {
2366 $_->cancel if $_->data & WF_AUTOCANCEL;
2367 }
2368
2369 warn "syncing database to disk";
2370 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2371
2372 warn "flushing outstanding aio requests";
2373 for (;;) {
2374 BDB::flush;
2375 IO::AIO::flush;
2376 Coro::cede;
2377 last unless IO::AIO::nreqs || BDB::nreqs;
2378 warn "iterate...";
2379 }
2380
2381 warn "cancelling all extension coros"; 3888 trace "cancelling all extension coros";
2382 $_->cancel for values %EXT_CORO; 3889 $_->cancel for values %EXT_CORO;
2383 %EXT_CORO = (); 3890 %EXT_CORO = ();
2384 3891
2385 warn "removing commands"; 3892 trace "removing commands";
2386 %COMMAND = (); 3893 %COMMAND = ();
2387 3894
2388 warn "removing ext commands"; 3895 trace "removing ext/exti commands";
2389 %EXTCMD = (); 3896 %EXTCMD = ();
3897 %EXTICMD = ();
2390 3898
2391 warn "unloading/nuking all extensions"; 3899 trace "unloading/nuking all extensions";
2392 for my $pkg (@EXTS) { 3900 for my $pkg (@EXTS) {
2393 warn "... unloading $pkg"; 3901 trace "... unloading $pkg";
2394 3902
2395 if (my $cb = $pkg->can ("unload")) { 3903 if (my $cb = $pkg->can ("unload")) {
2396 eval { 3904 eval {
2397 $cb->($pkg); 3905 $cb->($pkg);
2398 1 3906 1
2399 } or warn "$pkg unloaded, but with errors: $@"; 3907 } or error "$pkg unloaded, but with errors: $@";
3908 }
3909
3910 trace "... clearing $pkg";
3911 clear_package $pkg;
2400 } 3912 }
2401 3913
2402 warn "... nuking $pkg";
2403 Symbol::delete_package $pkg;
2404 }
2405
2406 warn "unloading all perl modules loaded from $LIBDIR"; 3914 trace "unloading all perl modules loaded from $LIBDIR";
2407 while (my ($k, $v) = each %INC) { 3915 while (my ($k, $v) = each %INC) {
2408 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3916 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2409 3917
2410 warn "... unloading $k"; 3918 trace "... unloading $k";
2411 delete $INC{$k}; 3919 delete $INC{$k};
2412 3920
2413 $k =~ s/\.pm$//; 3921 $k =~ s/\.pm$//;
2414 $k =~ s/\//::/g; 3922 $k =~ s/\//::/g;
2415 3923
2416 if (my $cb = $k->can ("unload_module")) { 3924 if (my $cb = $k->can ("unload_module")) {
2417 $cb->(); 3925 $cb->();
3926 }
3927
3928 clear_package $k;
2418 } 3929 }
2419 3930
2420 Symbol::delete_package $k;
2421 }
2422
2423 warn "getting rid of safe::, as good as possible"; 3931 trace "getting rid of safe::, as good as possible";
2424 Symbol::delete_package "safe::$_" 3932 clear_package "safe::$_"
2425 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3933 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2426 3934
2427 warn "unloading cf.pm \"a bit\""; 3935 trace "unloading cf.pm \"a bit\"";
2428 delete $INC{"cf.pm"}; 3936 delete $INC{"cf.pm"};
3937 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2429 3938
2430 # don't, removes xs symbols, too, 3939 # don't, removes xs symbols, too,
2431 # and global variables created in xs 3940 # and global variables created in xs
2432 #Symbol::delete_package __PACKAGE__; 3941 #clear_package __PACKAGE__;
2433 3942
2434 warn "unload completed, starting to reload now"; 3943 info "unload completed, starting to reload now";
2435 3944
2436 warn "reloading cf.pm"; 3945 trace "reloading cf.pm";
2437 require cf; 3946 require cf;
2438 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3947 cf::_connect_to_perl_1;
2439 3948
2440 warn "loading config and database again"; 3949 trace "loading config and database again";
2441 cf::cfg_load; 3950 cf::reload_config;
2442 3951
2443 warn "loading extensions"; 3952 trace "loading extensions";
2444 cf::load_extensions; 3953 cf::load_extensions;
2445 3954
3955 if ($REATTACH_ON_RELOAD) {
2446 warn "reattaching attachments to objects/players"; 3956 trace "reattaching attachments to objects/players";
2447 _global_reattach; 3957 _global_reattach; # objects, sockets
2448 warn "reattaching attachments to maps"; 3958 trace "reattaching attachments to maps";
2449 reattach $_ for values %MAP; 3959 reattach $_ for values %MAP;
3960 trace "reattaching attachments to players";
3961 reattach $_ for values %PLAYER;
3962 }
2450 3963
2451 warn "loading reloadable resources"; 3964 trace "running post_init jobs";
2452 load_resources; 3965 (pop @POST_INIT)->(1) while @POST_INIT;
2453 3966
2454 warn "restarting server ticker"; 3967 trace "leaving sync_job";
2455 3968
2456 $TICK_WATCHER->start; 3969 1
3970 } or do {
3971 error $@;
3972 cf::cleanup "error while reloading, exiting.";
3973 };
3974
3975 info "reloaded";
3976 --$RELOAD;
3977 }
3978
3979 $t1 = AE::time - $t1;
3980 info "reload completed in ${t1}s\n";
3981};
3982
3983our $RELOAD_WATCHER; # used only during reload
3984
3985sub reload_perl() {
3986 # doing reload synchronously and two reloads happen back-to-back,
3987 # coro crashes during coro_state_free->destroy here.
3988
3989 $RELOAD_WATCHER ||= cf::async {
3990 Coro::AIO::aio_wait cache_extensions;
3991
3992 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
3993 do_reload_perl;
3994 undef $RELOAD_WATCHER;
3995 };
2457 }; 3996 };
2458 3997}
2459 if ($@) {
2460 warn $@;
2461 warn "error while reloading, exiting.";
2462 exit 1;
2463 }
2464
2465 warn "reloaded";
2466};
2467
2468our $RELOAD_WATCHER; # used only during reload
2469 3998
2470register_command "reload" => sub { 3999register_command "reload" => sub {
2471 my ($who, $arg) = @_; 4000 my ($who, $arg) = @_;
2472 4001
2473 if ($who->flag (FLAG_WIZ)) { 4002 if ($who->flag (FLAG_WIZ)) {
2474 $who->message ("reloading server."); 4003 $who->message ("reloading server.");
2475 4004 async {
2476 # doing reload synchronously and two reloads happen back-to-back, 4005 $Coro::current->{desc} = "perl_reload";
2477 # coro crashes during coro_state_free->destroy here.
2478
2479 $RELOAD_WATCHER ||= Event->timer (
2480 reentrant => 0,
2481 after => 0,
2482 data => WF_AUTOCANCEL,
2483 cb => sub {
2484 reload; 4006 reload_perl;
2485 undef $RELOAD_WATCHER;
2486 },
2487 ); 4007 };
2488 } 4008 }
2489}; 4009};
2490 4010
2491unshift @INC, $LIBDIR; 4011#############################################################################
2492 4012
2493my $bug_warning = 0; 4013my $bug_warning = 0;
2494 4014
2495$TICK_WATCHER = Event->timer ( 4015our @WAIT_FOR_TICK;
2496 reentrant => 0, 4016our @WAIT_FOR_TICK_BEGIN;
2497 parked => 1, 4017
2498 prio => 0, 4018sub wait_for_tick() {
2499 at => $NEXT_TICK || $TICK, 4019 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2500 data => WF_AUTOCANCEL, 4020
2501 cb => sub { 4021 my $signal = new Coro::Signal;
4022 push @WAIT_FOR_TICK, $signal;
4023 $signal->wait;
4024}
4025
4026sub wait_for_tick_begin() {
4027 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4028
4029 my $signal = new Coro::Signal;
4030 push @WAIT_FOR_TICK_BEGIN, $signal;
4031 $signal->wait;
4032}
4033
4034sub tick {
2502 if ($Coro::current != $Coro::main) { 4035 if ($Coro::current != $Coro::main) {
2503 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 4036 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2504 unless ++$bug_warning > 10; 4037 unless ++$bug_warning > 10;
2505 return; 4038 return;
2506 } 4039 }
2507 4040
2508 $NOW = Event::time;
2509
2510 cf::server_tick; # one server iteration 4041 cf::server_tick; # one server iteration
2511 $RUNTIME += $TICK;
2512 $NEXT_TICK += $TICK;
2513 4042
2514 $WAIT_FOR_TICK->broadcast; 4043 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2515 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2516 4044
2517 Event::sweep; 4045 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2518 Coro::cede_notself; 4046 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
4047 Coro::async_pool {
4048 $Coro::current->{desc} = "runtime saver";
4049 write_runtime_sync
4050 or error "ERROR: unable to write runtime file: $!";
4051 };
4052 }
4053
4054 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4055 $sig->send;
4056 }
4057 while (my $sig = shift @WAIT_FOR_TICK) {
4058 $sig->send;
4059 }
4060
4061 $LOAD = ($NOW - $TICK_START) / $TICK;
4062 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4063
4064 if (0) {
4065 if ($NEXT_TICK) {
4066 my $jitter = $TICK_START - $NEXT_TICK;
4067 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4068 debug "jitter $JITTER\n";#d#
2519 4069 }
2520# my $AFTER = Event::time;
2521# warn $AFTER - $NOW;#d#
2522
2523 # if we are delayed by four ticks or more, skip them all
2524 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2525
2526 $TICK_WATCHER->at ($NEXT_TICK);
2527 $TICK_WATCHER->start;
2528 }, 4070 }
2529); 4071}
2530 4072
2531{ 4073{
2532 BDB::max_poll_time $TICK * 0.1; 4074 # configure BDB
2533 $BDB_POLL_WATCHER = Event->io ( 4075
2534 reentrant => 0,
2535 fd => BDB::poll_fileno,
2536 poll => 'r',
2537 prio => 0,
2538 data => WF_AUTOCANCEL,
2539 cb => \&BDB::poll_cb,
2540 );
2541 BDB::min_parallel 8; 4076 BDB::min_parallel 16;
2542 4077 BDB::max_poll_reqs $TICK * 0.1;
2543 BDB::set_sync_prepare { 4078 $AnyEvent::BDB::WATCHER->priority (1);
2544 my $status;
2545 my $current = $Coro::current;
2546 (
2547 sub {
2548 $status = $!;
2549 $current->ready; undef $current;
2550 },
2551 sub {
2552 Coro::schedule while defined $current;
2553 $! = $status;
2554 },
2555 )
2556 };
2557 4079
2558 unless ($DB_ENV) { 4080 unless ($DB_ENV) {
2559 $DB_ENV = BDB::db_env_create; 4081 $DB_ENV = BDB::db_env_create;
4082 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4083 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4084 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4085 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4086 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2560 4087
2561 cf::sync_job { 4088 cf::sync_job {
2562 eval { 4089 eval {
2563 BDB::db_env_open 4090 BDB::db_env_open
2564 $DB_ENV, 4091 $DB_ENV,
2565 $BDB_ENV_DIR, 4092 $BDBDIR,
2566 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 4093 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2567 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4094 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2568 0666; 4095 0666;
2569 4096
2570 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 4097 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2571
2572 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2573 $DB_ENV->set_lk_detect;
2574 }; 4098 };
2575 4099
2576 cf::cleanup "db_env_open(db): $@" if $@; 4100 cf::cleanup "db_env_open(db): $@" if $@;
2577 }; 4101 };
2578 } 4102 }
4103
4104 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4105 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4106 };
4107 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4108 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4109 };
4110 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4111 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4112 };
2579} 4113}
2580 4114
2581{ 4115{
4116 # configure IO::AIO
4117
2582 IO::AIO::min_parallel 8; 4118 IO::AIO::min_parallel 8;
2583
2584 undef $Coro::AIO::WATCHER;
2585 IO::AIO::max_poll_time $TICK * 0.1; 4119 IO::AIO::max_poll_time $TICK * 0.1;
2586 $AIO_POLL_WATCHER = Event->io ( 4120 undef $AnyEvent::AIO::WATCHER;
2587 reentrant => 0,
2588 fd => IO::AIO::poll_fileno,
2589 poll => 'r',
2590 prio => 6,
2591 data => WF_AUTOCANCEL,
2592 cb => \&IO::AIO::poll_cb,
2593 );
2594} 4121}
2595 4122
2596$WRITE_RUNTIME_WATCHER = Event->timer ( 4123my $_log_backtrace;
2597 reentrant => 0, 4124
2598 data => WF_AUTOCANCEL, 4125sub _log_backtrace {
2599 after => 1, 4126 my ($msg, @addr) = @_;
2600 interval => 10, 4127
2601 prio => 6, # keep it lowest so it acts like a watchdog 4128 $msg =~ s/\n//;
2602 cb => Coro::unblock_sub { 4129
2603 write_runtime 4130 # limit the # of concurrent backtraces
2604 or warn "ERROR: unable to write runtime file: $!"; 4131 if ($_log_backtrace < 2) {
4132 ++$_log_backtrace;
4133 my $perl_bt = Carp::longmess $msg;
4134 async {
4135 $Coro::current->{desc} = "abt $msg";
4136
4137 my @bt = fork_call {
4138 @addr = map { sprintf "%x", $_ } @addr;
4139 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4140 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4141 or die "addr2line: $!";
4142
4143 my @funcs;
4144 my @res = <$fh>;
4145 chomp for @res;
4146 while (@res) {
4147 my ($func, $line) = splice @res, 0, 2, ();
4148 push @funcs, "[$func] $line";
4149 }
4150
4151 @funcs
4152 };
4153
4154 LOG llevInfo, "[ABT] $perl_bt\n";
4155 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4156 LOG llevInfo, "[ABT] $_\n" for @bt;
4157 --$_log_backtrace;
4158 };
4159 } else {
4160 LOG llevInfo, "[ABT] $msg\n";
4161 LOG llevInfo, "[ABT] [suppressed]\n";
2605 }, 4162 }
2606); 4163}
4164
4165# load additional modules
4166require "cf/$_.pm" for @EXTRA_MODULES;
4167cf::_connect_to_perl_2;
2607 4168
2608END { cf::emergency_save } 4169END { cf::emergency_save }
2609 4170
26101 41711
2611 4172

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines