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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.411 by root, Fri Feb 1 15:54:07 2008 UTC

4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket; 8use Socket;
9use Storable; 9use EV 1.86;
10use Event;
11use Opcode; 10use Opcode;
12use Safe; 11use Safe;
13use Safe::Hole; 12use Safe::Hole;
13use Storable ();
14 14
15use Coro 3.61 (); 15use Coro 4.32 ();
16use Coro::State; 16use Coro::State;
17use Coro::Handle; 17use Coro::Handle;
18use Coro::Event; 18use Coro::EV;
19use Coro::Timer; 19use Coro::Timer;
20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::BDB;
23use Coro::Storable; 24use Coro::Storable;
25use Coro::Util ();
24 26
27use JSON::XS 2.01 ();
25use BDB (); 28use BDB ();
26use Data::Dumper; 29use Data::Dumper;
27use Digest::MD5; 30use Digest::MD5;
28use Fcntl; 31use Fcntl;
29use YAML::Syck (); 32use YAML ();
30use IO::AIO 2.32 (); 33use IO::AIO 2.51 ();
31use Time::HiRes; 34use Time::HiRes;
32use Compress::LZF; 35use Compress::LZF;
36use Digest::MD5 ();
33 37
34# configure various modules to our taste 38# configure various modules to our taste
35# 39#
36$Storable::canonical = 1; # reduce rsync transfers 40$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 41Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 42Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39 43
40$Event::Eval = 1; # no idea why this is required, but it is
41
42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
43$YAML::Syck::ImplicitUnicode = 1;
44
45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 44$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
46 45
47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 46sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
48 47
49our %COMMAND = (); 48our %COMMAND = ();
50our %COMMAND_TIME = (); 49our %COMMAND_TIME = ();
51 50
52our @EXTS = (); # list of extension package names 51our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 52our %EXTCMD = ();
53our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 55our %EXT_MAP = (); # pluggable maps
56 56
57our $RELOAD; # number of reloads so far 57our $RELOAD; # number of reloads so far
58our @EVENT; 58our @EVENT;
66our $TMPDIR = "$LOCALDIR/" . tmpdir; 66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir; 67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir; 68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random"; 69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db"; 70our $BDBDIR = "$LOCALDIR/db";
71our %RESOURCE;
71 72
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!) 73our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
73our $TICK_WATCHER; 74our $TICK_WATCHER;
74our $AIO_POLL_WATCHER; 75our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 76our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
76our $NEXT_TICK; 77our $NEXT_TICK;
77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off 78our $USE_FSYNC = 1; # use fsync to write maps - default off
79 79
80our $BDB_POLL_WATCHER; 80our $BDB_POLL_WATCHER;
81our $BDB_DEADLOCK_WATCHER;
82our $BDB_CHECKPOINT_WATCHER;
83our $BDB_TRICKLE_WATCHER;
81our $DB_ENV; 84our $DB_ENV;
82 85
83our %CFG; 86our %CFG;
84 87
85our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
86our $RUNTIME; 89our $RUNTIME;
90our $NOW;
87 91
88our %PLAYER; # all users 92our (%PLAYER, %PLAYER_LOADING); # all users
89our %MAP; # all maps 93our (%MAP, %MAP_LOADING ); # all maps
90our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
91 95
92# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94 98
155 159
156The raw value load value from the last tick. 160The raw value load value from the last tick.
157 161
158=item %cf::CFG 162=item %cf::CFG
159 163
160Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/deliantra-server/config>, or
161from wherever your confdir points to. 165from wherever your confdir points to.
162 166
163=item cf::wait_for_tick, cf::wait_for_tick_begin 167=item cf::wait_for_tick, cf::wait_for_tick_begin
164 168
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process 170returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
178
169=back 179=back
170 180
171=cut 181=cut
172 182
173BEGIN { 183BEGIN {
177 $msg .= "\n" 187 $msg .= "\n"
178 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
179 189
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge; 190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181 191
182 utf8::encode $msg;
183 LOG llevError, $msg; 192 LOG llevError, $msg;
184 }; 193 };
185} 194}
195
196$Coro::State::DIEHOOK = sub {
197 return unless $^S eq 0; # "eq", not "=="
198
199 if ($Coro::current == $Coro::main) {#d#
200 warn "DIEHOOK called in main context, Coro bug?\n";#d#
201 return;#d#
202 }#d#
203
204 # kill coroutine otherwise
205 warn Carp::longmess $_[0];
206 Coro::terminate
207};
208
209$SIG{__DIE__} = sub { }; #d#?
186 210
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 211@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 212@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 213@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 214@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
203)) { 227)) {
204 no strict 'refs'; 228 no strict 'refs';
205 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 229 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
206} 230}
207 231
208$Event::DIED = sub { 232$EV::DIED = sub {
209 warn "error in event callback: @_"; 233 warn "error in event callback: @_";
210}; 234};
235
236#############################################################################
211 237
212=head2 UTILITY FUNCTIONS 238=head2 UTILITY FUNCTIONS
213 239
214=over 4 240=over 4
215 241
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 260 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 261 $d
236 } || "[unable to dump $_[0]: '$@']"; 262 } || "[unable to dump $_[0]: '$@']";
237} 263}
238 264
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 265=item $ref = cf::decode_json $json
242 266
243Converts a JSON string into the corresponding perl data structure. 267Converts a JSON string into the corresponding perl data structure.
244 268
245=item $json = cf::to_json $ref 269=item $json = cf::encode_json $ref
246 270
247Converts a perl data structure into its JSON representation. 271Converts a perl data structure into its JSON representation.
272
273=cut
274
275our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
276
277sub encode_json($) { $json_coder->encode ($_[0]) }
278sub decode_json($) { $json_coder->decode ($_[0]) }
248 279
249=item cf::lock_wait $string 280=item cf::lock_wait $string
250 281
251Wait until the given lock is available. See cf::lock_acquire. 282Wait until the given lock is available. See cf::lock_acquire.
252 283
255Wait until the given lock is available and then acquires it and returns 286Wait until the given lock is available and then acquires it and returns
256a Coro::guard object. If the guard object gets destroyed (goes out of scope, 287a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257for example when the coroutine gets canceled), the lock is automatically 288for example when the coroutine gets canceled), the lock is automatically
258returned. 289returned.
259 290
291Locks are *not* recursive, locking from the same coro twice results in a
292deadlocked coro.
293
260Lock names should begin with a unique identifier (for example, cf::map::find 294Lock names should begin with a unique identifier (for example, cf::map::find
261uses map_find and cf::map::load uses map_load). 295uses map_find and cf::map::load uses map_load).
262 296
263=item $locked = cf::lock_active $string 297=item $locked = cf::lock_active $string
264 298
265Return true if the lock is currently active, i.e. somebody has locked it. 299Return true if the lock is currently active, i.e. somebody has locked it.
266 300
267=cut 301=cut
268 302
269our %LOCK; 303our %LOCK;
304our %LOCKER;#d#
270 305
271sub lock_wait($) { 306sub lock_wait($) {
272 my ($key) = @_; 307 my ($key) = @_;
308
309 if ($LOCKER{$key} == $Coro::current) {#d#
310 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
311 return;#d#
312 }#d#
273 313
274 # wait for lock, if any 314 # wait for lock, if any
275 while ($LOCK{$key}) { 315 while ($LOCK{$key}) {
276 push @{ $LOCK{$key} }, $Coro::current; 316 push @{ $LOCK{$key} }, $Coro::current;
277 Coro::schedule; 317 Coro::schedule;
283 323
284 # wait, to be sure we are not locked 324 # wait, to be sure we are not locked
285 lock_wait $key; 325 lock_wait $key;
286 326
287 $LOCK{$key} = []; 327 $LOCK{$key} = [];
328 $LOCKER{$key} = $Coro::current;#d#
288 329
289 Coro::guard { 330 Coro::guard {
331 delete $LOCKER{$key};#d#
290 # wake up all waiters, to be on the safe side 332 # wake up all waiters, to be on the safe side
291 $_->ready for @{ delete $LOCK{$key} }; 333 $_->ready for @{ delete $LOCK{$key} };
292 } 334 }
293} 335}
294 336
306 }; 348 };
307 $TICK_WATCHER->stop; 349 $TICK_WATCHER->stop;
308 $guard 350 $guard
309} 351}
310 352
353=item cf::periodic $interval, $cb
354
355Like EV::periodic, but randomly selects a starting point so that the actions
356get spread over timer.
357
358=cut
359
360sub periodic($$) {
361 my ($interval, $cb) = @_;
362
363 my $start = rand List::Util::min 180, $interval;
364
365 EV::periodic $start, $interval, 0, $cb
366}
367
368=item cf::get_slot $time[, $priority[, $name]]
369
370Allocate $time seconds of blocking CPU time at priority C<$priority>:
371This call blocks and returns only when you have at least C<$time> seconds
372of cpu time till the next tick. The slot is only valid till the next cede.
373
374The optional C<$name> can be used to identify the job to run. It might be
375used for statistical purposes and should identify the same time-class.
376
377Useful for short background jobs.
378
379=cut
380
381our @SLOT_QUEUE;
382our $SLOT_QUEUE;
383
384$SLOT_QUEUE->cancel if $SLOT_QUEUE;
385$SLOT_QUEUE = Coro::async {
386 $Coro::current->desc ("timeslot manager");
387
388 my $signal = new Coro::Signal;
389
390 while () {
391 next_job:
392 my $avail = cf::till_tick;
393 if ($avail > 0.01) {
394 for (0 .. $#SLOT_QUEUE) {
395 if ($SLOT_QUEUE[$_][0] < $avail) {
396 my $job = splice @SLOT_QUEUE, $_, 1, ();
397 $job->[2]->send;
398 Coro::cede;
399 goto next_job;
400 }
401 }
402 }
403
404 if (@SLOT_QUEUE) {
405 # we do not use wait_for_tick() as it returns immediately when tick is inactive
406 push @cf::WAIT_FOR_TICK, $signal;
407 $signal->wait;
408 } else {
409 Coro::schedule;
410 }
411 }
412};
413
414sub get_slot($;$$) {
415 my ($time, $pri, $name) = @_;
416
417 $time = $TICK * .6 if $time > $TICK * .6;
418 my $sig = new Coro::Signal;
419
420 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
421 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
422 $SLOT_QUEUE->ready;
423 $sig->wait;
424}
425
311=item cf::async { BLOCK } 426=item cf::async { BLOCK }
312 427
313Currently the same as Coro::async_pool, meaning you cannot use 428Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 429C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 430thing you are allowed to do is call C<prio> on it.
318 433
319BEGIN { *async = \&Coro::async_pool } 434BEGIN { *async = \&Coro::async_pool }
320 435
321=item cf::sync_job { BLOCK } 436=item cf::sync_job { BLOCK }
322 437
323The design of crossfire+ requires that the main coro ($Coro::main) is 438The design of Deliantra requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 439is always able to handle events or runnable, as Deliantra is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 440partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
441acceptable.
326 442
327If it must be done, put the blocking parts into C<sync_job>. This will run 443If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The 444the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 445server will be frozen during this time, so the block should either finish
330fast or be very important. 446fast or be very important.
333 449
334sub sync_job(&) { 450sub sync_job(&) {
335 my ($job) = @_; 451 my ($job) = @_;
336 452
337 if ($Coro::current == $Coro::main) { 453 if ($Coro::current == $Coro::main) {
338 my $time = Event::time; 454 my $time = EV::time;
339 455
340 # this is the main coro, too bad, we have to block 456 # this is the main coro, too bad, we have to block
341 # till the operation succeeds, freezing the server :/ 457 # till the operation succeeds, freezing the server :/
342 458
459 LOG llevError, Carp::longmess "sync job";#d#
460
343 # TODO: use suspend/resume instead 461 # TODO: use suspend/resume instead
344 # (but this is cancel-safe) 462 # (but this is cancel-safe)
345 my $freeze_guard = freeze_mainloop; 463 my $freeze_guard = freeze_mainloop;
346 464
347 my $busy = 1; 465 my $busy = 1;
348 my @res; 466 my @res;
349 467
350 (async { 468 (async {
469 $Coro::current->desc ("sync job coro");
351 @res = eval { $job->() }; 470 @res = eval { $job->() };
352 warn $@ if $@; 471 warn $@ if $@;
353 undef $busy; 472 undef $busy;
354 })->prio (Coro::PRIO_MAX); 473 })->prio (Coro::PRIO_MAX);
355 474
356 while ($busy) { 475 while ($busy) {
357 Coro::cede or Event::one_event; 476 if (Coro::nready) {
477 Coro::cede_notself;
478 } else {
479 EV::loop EV::LOOP_ONESHOT;
358 } 480 }
481 }
359 482
360 $time = Event::time - $time; 483 $time = EV::time - $time;
361 484
362 LOG llevError | logBacktrace, Carp::longmess "long sync job" 485 LOG llevError | logBacktrace, Carp::longmess "long sync job"
363 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active; 486 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
364 487
365 $tick_start += $time; # do not account sync jobs to server load 488 $tick_start += $time; # do not account sync jobs to server load
390 $EXT_CORO{$coro+0} = $coro; 513 $EXT_CORO{$coro+0} = $coro;
391 514
392 $coro 515 $coro
393} 516}
394 517
395sub write_runtime { 518=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 519
398 # first touch the runtime file to show we are still running: 520Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 521process, returning the results. Everything must be serialisable with
522Coro::Storable. May, of course, block. Note that the executed sub may
523never block itself or use any form of event handling.
400 524
401 IO::AIO::aio_utime $runtime, undef, undef; 525=cut
402 526
403 my $guard = cf::lock_acquire "write_runtime"; 527sub fork_call(&@) {
528 my ($cb, @args) = @_;
404 529
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 530 # we seemingly have to make a local copy of the whole thing,
406 or return; 531 # otherwise perl prematurely frees the stuff :/
532 # TODO: investigate and fix (likely this will be rather laborious)
407 533
408 my $value = $cf::RUNTIME + 90 + 10; 534 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 535 reset_signals;
410 # 60 allows for the watchdog to kill the server. 536 &$cb
537 }, @args;
411 538
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 539 wantarray ? @res : $res[-1]
413 and return; 540}
414 541
415 # always fsync - this file is important 542=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 543
419 # touch it again to show we are up-to-date 544Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 545
422 close $fh 546=item cf::db_put $family => $key => $value
423 or return;
424 547
425 aio_rename "$runtime~", $runtime 548Stores the given C<$value> in the family. It can currently store binary
426 and return; 549data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 550
428 warn "runtime file written.\n"; 551=item $db = cf::db_table "name"
429 552
553Create and/or open a new database table. The string must not be "db" and must be unique
554within each server.
555
556=cut
557
558sub db_table($) {
559 my ($name) = @_;
560 my $db = BDB::db_create $DB_ENV;
561
562 eval {
563 $db->set_flags (BDB::CHKSUM);
564
565 utf8::encode $name;
566 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
567 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
568 cf::cleanup "db_open(db): $!" if $!;
569 };
570 cf::cleanup "db_open(db): $@" if $@;
571
572 $db
573}
574
575our $DB;
576
577sub db_init {
578 cf::sync_job {
579 $DB ||= db_table "db";
580 };
581}
582
583sub db_get($$) {
584 my $key = "$_[0]/$_[1]";
585
586 cf::sync_job {
587 BDB::db_get $DB, undef, $key, my $data;
588
589 $! ? ()
590 : $data
430 1 591 }
592}
593
594sub db_put($$$) {
595 BDB::dbreq_pri 4;
596 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
597}
598
599=item cf::cache $id => [$paths...], $processversion => $process
600
601Generic caching function that returns the value of the resource $id,
602caching and regenerating as required.
603
604This function can block.
605
606=cut
607
608sub cache {
609 my ($id, $src, $processversion, $process) = @_;
610
611 my $meta =
612 join "\x00",
613 $processversion,
614 map {
615 aio_stat $_
616 and Carp::croak "$_: $!";
617
618 ($_, (stat _)[7,9])
619 } @$src;
620
621 my $dbmeta = db_get cache => "$id/meta";
622 if ($dbmeta ne $meta) {
623 # changed, we may need to process
624
625 my @data;
626 my $md5;
627
628 for (0 .. $#$src) {
629 0 <= aio_load $src->[$_], $data[$_]
630 or Carp::croak "$src->[$_]: $!";
631 }
632
633 # if processing is expensive, check
634 # checksum first
635 if (1) {
636 $md5 =
637 join "\x00",
638 $processversion,
639 map {
640 cf::cede_to_tick;
641 ($src->[$_], Digest::MD5::md5_hex $data[$_])
642 } 0.. $#$src;
643
644
645 my $dbmd5 = db_get cache => "$id/md5";
646 if ($dbmd5 eq $md5) {
647 db_put cache => "$id/meta", $meta;
648
649 return db_get cache => "$id/data";
650 }
651 }
652
653 my $t1 = Time::HiRes::time;
654 my $data = $process->(\@data);
655 my $t2 = Time::HiRes::time;
656
657 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
658
659 db_put cache => "$id/data", $data;
660 db_put cache => "$id/md5" , $md5;
661 db_put cache => "$id/meta", $meta;
662
663 return $data;
664 }
665
666 db_get cache => "$id/data"
431} 667}
432 668
433=item cf::datalog type => key => value, ... 669=item cf::datalog type => key => value, ...
434 670
435Log a datalog packet of the given type with the given key-value pairs. 671Log a datalog packet of the given type with the given key-value pairs.
453attach callbacks/event handlers (a collection of which is called an "attachment") 689attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 690to it. All such attachable objects support the following methods.
455 691
456In the following description, CLASS can be any of C<global>, C<object> 692In the following description, CLASS can be any of C<global>, C<object>
457C<player>, C<client> or C<map> (i.e. the attachable objects in 693C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 694Deliantra).
459 695
460=over 4 696=over 4
461 697
462=item $attachable->attach ($attachment, key => $value...) 698=item $attachable->attach ($attachment, key => $value...)
463 699
665 _attach $registry, $klass, @attach; 901 _attach $registry, $klass, @attach;
666 } 902 }
667 903
668 $obj->{$name} = \%arg; 904 $obj->{$name} = \%arg;
669 } else { 905 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 906 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 907 }
672 908
673 $obj->{_attachment}{$name} = undef; 909 $obj->{_attachment}{$name} = undef;
674} 910}
675 911
715 "; 951 ";
716 die if $@; 952 die if $@;
717} 953}
718 954
719our $override; 955our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 956our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 957
722sub override { 958sub override {
723 $override = 1; 959 $override = 1;
724 @invoke_results = (); 960 @INVOKE_RESULTS = (@_);
725} 961}
726 962
727sub do_invoke { 963sub do_invoke {
728 my $event = shift; 964 my $event = shift;
729 my $callbacks = shift; 965 my $callbacks = shift;
730 966
731 @invoke_results = (); 967 @INVOKE_RESULTS = ();
732 968
733 local $override; 969 local $override;
734 970
735 for (@$callbacks) { 971 for (@$callbacks) {
736 eval { &{$_->[1]} }; 972 eval { &{$_->[1]} };
745 } 981 }
746 982
747 0 983 0
748} 984}
749 985
750=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 986=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
751 987
752=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 988=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
753 989
754Generate an object-specific event with the given arguments. 990Generate an object-specific event with the given arguments.
755 991
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 992This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757removed in future versions), and there is no public API to access override 993removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 994results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 995
760=back 996=back
761 997
762=cut 998=cut
763 999
764############################################################################# 1000#############################################################################
765# object support 1001# object support
1002
1003sub _object_equal($$);
1004sub _object_equal($$) {
1005 my ($a, $b) = @_;
1006
1007 return 0 unless (ref $a) eq (ref $b);
1008
1009 if ("HASH" eq ref $a) {
1010 my @ka = keys %$a;
1011 my @kb = keys %$b;
1012
1013 return 0 if @ka != @kb;
1014
1015 for (0 .. $#ka) {
1016 return 0 unless $ka[$_] eq $kb[$_];
1017 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1018 }
1019
1020 } elsif ("ARRAY" eq ref $a) {
1021
1022 return 0 if @$a != @$b;
1023
1024 for (0 .. $#$a) {
1025 return 0 unless _object_equal $a->[$_], $b->[$_];
1026 }
1027
1028 } elsif ($a ne $b) {
1029 return 0;
1030 }
1031
1032 1
1033}
1034
1035our $SLOW_MERGES;#d#
1036sub _can_merge {
1037 my ($ob1, $ob2) = @_;
1038
1039 ++$SLOW_MERGES;#d#
1040
1041 # we do the slow way here
1042 return _object_equal $ob1, $ob2
1043}
766 1044
767sub reattach { 1045sub reattach {
768 # basically do the same as instantiate, without calling instantiate 1046 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 1047 my ($obj) = @_;
770 1048
791cf::attachable->attach ( 1069cf::attachable->attach (
792 prio => -1000000, 1070 prio => -1000000,
793 on_instantiate => sub { 1071 on_instantiate => sub {
794 my ($obj, $data) = @_; 1072 my ($obj, $data) = @_;
795 1073
796 $data = from_json $data; 1074 $data = decode_json $data;
797 1075
798 for (@$data) { 1076 for (@$data) {
799 my ($name, $args) = @$_; 1077 my ($name, $args) = @$_;
800 1078
801 $obj->attach ($name, %{$args || {} }); 1079 $obj->attach ($name, %{$args || {} });
817sub object_freezer_save { 1095sub object_freezer_save {
818 my ($filename, $rdata, $objs) = @_; 1096 my ($filename, $rdata, $objs) = @_;
819 1097
820 sync_job { 1098 sync_job {
821 if (length $$rdata) { 1099 if (length $$rdata) {
1100 utf8::decode (my $decname = $filename);
822 warn sprintf "saving %s (%d,%d)\n", 1101 warn sprintf "saving %s (%d,%d)\n",
823 $filename, length $$rdata, scalar @$objs; 1102 $decname, length $$rdata, scalar @$objs;
824 1103
825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1104 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826 chmod SAVE_MODE, $fh; 1105 chmod SAVE_MODE, $fh;
827 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1106 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828 aio_fsync $fh if $cf::USE_FSYNC; 1107 aio_fsync $fh if $cf::USE_FSYNC;
829 close $fh; 1108 close $fh;
830 1109
831 if (@$objs) { 1110 if (@$objs) {
832 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1111 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
833 chmod SAVE_MODE, $fh; 1112 chmod SAVE_MODE, $fh;
834 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1113 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
835 aio_write $fh, 0, (length $data), $data, 0; 1114 aio_write $fh, 0, (length $data), $data, 0;
836 aio_fsync $fh if $cf::USE_FSYNC; 1115 aio_fsync $fh if $cf::USE_FSYNC;
837 close $fh; 1116 close $fh;
838 aio_rename "$filename.pst~", "$filename.pst"; 1117 aio_rename "$filename.pst~", "$filename.pst";
839 } 1118 }
847 } 1126 }
848 } else { 1127 } else {
849 aio_unlink $filename; 1128 aio_unlink $filename;
850 aio_unlink "$filename.pst"; 1129 aio_unlink "$filename.pst";
851 } 1130 }
852 } 1131 };
853} 1132}
854 1133
855sub object_freezer_as_string { 1134sub object_freezer_as_string {
856 my ($rdata, $objs) = @_; 1135 my ($rdata, $objs) = @_;
857 1136
869 or return; 1148 or return;
870 1149
871 unless (aio_stat "$filename.pst") { 1150 unless (aio_stat "$filename.pst") {
872 (aio_load "$filename.pst", $av) >= 0 1151 (aio_load "$filename.pst", $av) >= 0
873 or return; 1152 or return;
1153
874 $av = eval { (Storable::thaw $av)->{objs} }; 1154 my $st = eval { Coro::Storable::thaw $av };
1155 $av = $st->{objs};
875 } 1156 }
876 1157
1158 utf8::decode (my $decname = $filename);
877 warn sprintf "loading %s (%d)\n", 1159 warn sprintf "loading %s (%d,%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1160 $decname, length $data, scalar @{$av || []};
1161
879 return ($data, $av); 1162 ($data, $av)
880} 1163}
1164
1165=head2 COMMAND CALLBACKS
1166
1167=over 4
1168
1169=cut
881 1170
882############################################################################# 1171#############################################################################
883# command handling &c 1172# command handling &c
884 1173
885=item cf::register_command $name => \&callback($ob,$args); 1174=item cf::register_command $name => \&callback($ob,$args);
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1187 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1188}
900 1189
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1190=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1191
903Register a callbackf ro execution when the client sends an extcmd packet. 1192Register a callback for execution when the client sends an (synchronous)
1193extcmd packet. Ext commands will be processed in the order they are
1194received by the server, like other user commands. The first argument is
1195the logged-in player. Ext commands can only be processed after a player
1196has logged in successfully.
904 1197
905If the callback returns something, it is sent back as if reply was being 1198If the callback returns something, it is sent back as if reply was being
906called. 1199called.
907 1200
1201=item cf::register_exticmd $name => \&callback($ns,$packet);
1202
1203Register a callback for execution when the client sends an (asynchronous)
1204exticmd packet. Exti commands are processed by the server as soon as they
1205are received, i.e. out of order w.r.t. other commands. The first argument
1206is a client socket. Exti commands can be received anytime, even before
1207log-in.
1208
1209If the callback returns something, it is sent back as if reply was being
1210called.
1211
908=cut 1212=cut
909 1213
910sub register_extcmd { 1214sub register_extcmd {
911 my ($name, $cb) = @_; 1215 my ($name, $cb) = @_;
912 1216
913 $EXTCMD{$name} = $cb; 1217 $EXTCMD{$name} = $cb;
1218}
1219
1220sub register_exticmd {
1221 my ($name, $cb) = @_;
1222
1223 $EXTICMD{$name} = $cb;
914} 1224}
915 1225
916cf::player->attach ( 1226cf::player->attach (
917 on_command => sub { 1227 on_command => sub {
918 my ($pl, $name, $params) = @_; 1228 my ($pl, $name, $params) = @_;
927 cf::override; 1237 cf::override;
928 }, 1238 },
929 on_extcmd => sub { 1239 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1240 my ($pl, $buf) = @_;
931 1241
932 my $msg = eval { from_json $buf }; 1242 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1243
934 if (ref $msg) { 1244 if (ref $msg) {
1245 my ($type, $reply, @payload) =
1246 "ARRAY" eq ref $msg
1247 ? @$msg
1248 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1249
1250 my @reply;
1251
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1252 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1253 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1254 }
1255
1256 $pl->ext_reply ($reply, @reply)
1257 if $reply;
1258
940 } else { 1259 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1260 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1261 }
943 1262
944 cf::override; 1263 cf::override;
967 path => $path, 1286 path => $path,
968 base => $base, 1287 base => $base,
969 pkg => $pkg, 1288 pkg => $pkg,
970 ); 1289 );
971 1290
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 } 1291 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/; 1292 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974 1293
975 $ext{source} = 1294 $ext{source} =
976 "package $pkg; use strict; use utf8;\n" 1295 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n" 1296 . "#line 1 \"$path\"\n{\n"
978 . $source 1297 . $source
984 my %done; 1303 my %done;
985 while (%todo) { 1304 while (%todo) {
986 my $progress; 1305 my $progress;
987 1306
988 while (my ($k, $v) = each %todo) { 1307 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) { 1308 for (split /,\s*/, $v->{meta}{depends}) {
990 goto skip 1309 goto skip
991 unless exists $done{$_}; 1310 unless exists $done{$_};
992 } 1311 }
993 1312
994 warn "... loading '$k' into '$v->{pkg}'\n"; 1313 warn "... loading '$k' into '$v->{pkg}'\n";
995 1314
996 unless (eval $v->{source}) { 1315 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n" 1316 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n"; 1317 : "$v->{base}: extension inactive.\n";
999 1318
1000 if (exists $v->{meta}{mandatory}) { 1319 if (exists $v->{meta}{mandatory}) {
1001 warn $msg; 1320 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n"; 1321 cf::cleanup "mandatory extension failed to load, exiting.";
1003 exit 1;
1004 } 1322 }
1005 1323
1006 die $msg; 1324 warn $msg;
1007 } 1325 }
1008 1326
1009 $done{$k} = delete $todo{$k}; 1327 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg}; 1328 push @EXTS, $v->{pkg};
1329 $progress = 1;
1011 } 1330 }
1012 1331
1013 skip: 1332 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n" 1333 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress; 1334 unless $progress;
1017 }; 1336 };
1018} 1337}
1019 1338
1020############################################################################# 1339#############################################################################
1021 1340
1341=back
1342
1022=head2 CORE EXTENSIONS 1343=head2 CORE EXTENSIONS
1023 1344
1024Functions and methods that extend core crossfire objects. 1345Functions and methods that extend core crossfire objects.
1025 1346
1026=cut 1347=cut
1030use Coro::AIO; 1351use Coro::AIO;
1031 1352
1032=head3 cf::player 1353=head3 cf::player
1033 1354
1034=over 4 1355=over 4
1356
1357=item cf::player::num_playing
1358
1359Returns the official number of playing players, as per the Crossfire metaserver rules.
1360
1361=cut
1362
1363sub num_playing {
1364 scalar grep
1365 $_->ob->map
1366 && !$_->hidden
1367 && !$_->ob->flag (cf::FLAG_WIZ),
1368 cf::player::list
1369}
1035 1370
1036=item cf::player::find $login 1371=item cf::player::find $login
1037 1372
1038Returns the given player object, loading it if necessary (might block). 1373Returns the given player object, loading it if necessary (might block).
1039 1374
1075 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1410 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1076 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1411 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1077 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1412 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1078 aio_unlink +(playerdir $login) . "/$login.pl"; 1413 aio_unlink +(playerdir $login) . "/$login.pl";
1079 1414
1080 my $pl = load_pl path $login 1415 my $f = new_from_file cf::object::thawer path $login
1081 or return; 1416 or return;
1417
1418 my $pl = cf::player::load_pl $f
1419 or return;
1420 local $cf::PLAYER_LOADING{$login} = $pl;
1421 $f->resolve_delayed_derefs;
1082 $cf::PLAYER{$login} = $pl 1422 $cf::PLAYER{$login} = $pl
1083 } 1423 }
1084 } 1424 }
1085} 1425}
1086 1426
1096 1436
1097 aio_mkdir playerdir $pl, 0770; 1437 aio_mkdir playerdir $pl, 0770;
1098 $pl->{last_save} = $cf::RUNTIME; 1438 $pl->{last_save} = $cf::RUNTIME;
1099 1439
1100 $pl->save_pl ($path); 1440 $pl->save_pl ($path);
1101 Coro::cede; 1441 cf::cede_to_tick;
1102} 1442}
1103 1443
1104sub new($) { 1444sub new($) {
1105 my ($login) = @_; 1445 my ($login) = @_;
1106 1446
1110 $self->{deny_save} = 1; 1450 $self->{deny_save} = 1;
1111 1451
1112 $cf::PLAYER{$login} = $self; 1452 $cf::PLAYER{$login} = $self;
1113 1453
1114 $self 1454 $self
1455}
1456
1457=item $player->send_msg ($channel, $msg, $color, [extra...])
1458
1459=cut
1460
1461sub send_msg {
1462 my $ns = shift->ns
1463 or return;
1464 $ns->send_msg (@_);
1115} 1465}
1116 1466
1117=item $pl->quit_character 1467=item $pl->quit_character
1118 1468
1119Nukes the player without looking back. If logged in, the connection will 1469Nukes the player without looking back. If logged in, the connection will
1174 or return []; 1524 or return [];
1175 1525
1176 my @logins; 1526 my @logins;
1177 1527
1178 for my $login (@$dirs) { 1528 for my $login (@$dirs) {
1529 my $path = path $login;
1530
1531 # a .pst is a dead give-away for a valid player
1532 unless (-e "$path.pst") {
1179 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1533 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1180 aio_read $fh, 0, 512, my $buf, 0 or next; 1534 aio_read $fh, 0, 512, my $buf, 0 or next;
1181 $buf !~ /^password -------------$/m or next; # official not-valid tag 1535 $buf !~ /^password -------------$/m or next; # official not-valid tag
1536 }
1182 1537
1183 utf8::decode $login; 1538 utf8::decode $login;
1184 push @logins, $login; 1539 push @logins, $login;
1185 } 1540 }
1186 1541
1213 } 1568 }
1214 1569
1215 \@paths 1570 \@paths
1216} 1571}
1217 1572
1573=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1574
1575Expand crossfire pod fragments into protocol xml.
1576
1577=cut
1578
1579use re 'eval';
1580
1581my $group;
1582my $interior; $interior = qr{
1583 # match a pod interior sequence sans C<< >>
1584 (?:
1585 \ (.*?)\ (?{ $group = $^N })
1586 | < (??{$interior}) >
1587 )
1588}x;
1589
1590sub expand_cfpod {
1591 my ($self, $pod) = @_;
1592
1593 my $xml;
1594
1595 while () {
1596 if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
1597 $group = $1;
1598
1599 $group =~ s/&/&amp;/g;
1600 $group =~ s/</&lt;/g;
1601
1602 $xml .= $group;
1603 } elsif ($pod =~ m%\G
1604 ([BCGHITU])
1605 <
1606 (?:
1607 ([^<>]*) (?{ $group = $^N })
1608 | < $interior >
1609 )
1610 >
1611 %gcsx
1612 ) {
1613 my ($code, $data) = ($1, $group);
1614
1615 if ($code eq "B") {
1616 $xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
1617 } elsif ($code eq "I") {
1618 $xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
1619 } elsif ($code eq "U") {
1620 $xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
1621 } elsif ($code eq "C") {
1622 $xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
1623 } elsif ($code eq "T") {
1624 $xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
1625 } elsif ($code eq "G") {
1626 my ($male, $female) = split /\|/, $data;
1627 $data = $self->gender ? $female : $male;
1628 $xml .= expand_cfpod ($self, $data);
1629 } elsif ($code eq "H") {
1630 $xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
1631 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1632 "")
1633 [$self->{hintmode}];
1634 } else {
1635 $xml .= "error processing '$code($data)' directive";
1636 }
1637 } else {
1638 if ($pod =~ /\G(.+)/) {
1639 warn "parse error while expanding $pod (at $1)";
1640 }
1641 last;
1642 }
1643 }
1644
1645 for ($xml) {
1646 # create single paragraphs (very hackish)
1647 s/(?<=\S)\n(?=\w)/ /g;
1648
1649 # compress some whitespace
1650 s/\s+\n/\n/g; # ws line-ends
1651 s/\n\n+/\n/g; # double lines
1652 s/^\n+//; # beginning lines
1653 s/\n+$//; # ending lines
1654 }
1655
1656 $xml
1657}
1658
1659no re 'eval';
1660
1661sub hintmode {
1662 $_[0]{hintmode} = $_[1] if @_ > 1;
1663 $_[0]{hintmode}
1664}
1665
1218=item $player->ext_reply ($msgid, %msg) 1666=item $player->ext_reply ($msgid, @msg)
1219 1667
1220Sends an ext reply to the player. 1668Sends an ext reply to the player.
1221 1669
1222=cut 1670=cut
1223 1671
1224sub ext_reply($$%) { 1672sub ext_reply($$@) {
1225 my ($self, $id, %msg) = @_; 1673 my ($self, $id, @msg) = @_;
1226 1674
1227 $msg{msgid} = $id; 1675 $self->ns->ext_reply ($id, @msg)
1228
1229 $self->send ("ext " . cf::to_json \%msg);
1230} 1676}
1231 1677
1232=item $player->ext_event ($type, %msg) 1678=item $player->ext_msg ($type, @msg)
1233 1679
1234Sends an ext event to the client. 1680Sends an ext event to the client.
1235 1681
1236=cut 1682=cut
1237 1683
1238sub ext_event($$%) { 1684sub ext_msg($$@) {
1239 my ($self, $type, %msg) = @_; 1685 my ($self, $type, @msg) = @_;
1240 1686
1241 $self->ns->ext_event ($type, %msg); 1687 $self->ns->ext_msg ($type, @msg);
1242} 1688}
1243 1689
1244=head3 cf::region 1690=head3 cf::region
1245 1691
1246=over 4 1692=over 4
1249 1695
1250package cf::region; 1696package cf::region;
1251 1697
1252=item cf::region::find_by_path $path 1698=item cf::region::find_by_path $path
1253 1699
1254Tries to decuce the probable region for a map knowing only its path. 1700Tries to decuce the likely region for a map knowing only its path.
1255 1701
1256=cut 1702=cut
1257 1703
1258sub find_by_path($) { 1704sub find_by_path($) {
1259 my ($path) = @_; 1705 my ($path) = @_;
1260 1706
1261 my ($match, $specificity); 1707 my ($match, $specificity);
1262 1708
1263 for my $region (list) { 1709 for my $region (list) {
1264 if ($region->match && $path =~ $region->match) { 1710 if ($region->{match} && $path =~ $region->{match}) {
1265 ($match, $specificity) = ($region, $region->specificity) 1711 ($match, $specificity) = ($region, $region->specificity)
1266 if $region->specificity > $specificity; 1712 if $region->specificity > $specificity;
1267 } 1713 }
1268 } 1714 }
1269 1715
1389 $self->init; # pass $1 etc. 1835 $self->init; # pass $1 etc.
1390 return $self; 1836 return $self;
1391 } 1837 }
1392 } 1838 }
1393 1839
1394 Carp::carp "unable to resolve path '$path' (base '$base')."; 1840 Carp::cluck "unable to resolve path '$path' (base '$base').";
1395 () 1841 ()
1396} 1842}
1397 1843
1398sub init { 1844sub init {
1399 my ($self) = @_; 1845 my ($self) = @_;
1462 1908
1463sub load_header_from($) { 1909sub load_header_from($) {
1464 my ($self, $path) = @_; 1910 my ($self, $path) = @_;
1465 1911
1466 utf8::encode $path; 1912 utf8::encode $path;
1467 #aio_open $path, O_RDONLY, 0 1913 my $f = new_from_file cf::object::thawer $path
1468 # or return;
1469
1470 $self->_load_header ($path)
1471 or return; 1914 or return;
1915
1916 $self->_load_header ($f)
1917 or return;
1918
1919 local $MAP_LOADING{$self->{path}} = $self;
1920 $f->resolve_delayed_derefs;
1472 1921
1473 $self->{load_path} = $path; 1922 $self->{load_path} = $path;
1474 1923
1475 1 1924 1
1476} 1925}
1530sub find { 1979sub find {
1531 my ($path, $origin) = @_; 1980 my ($path, $origin) = @_;
1532 1981
1533 $path = normalise $path, $origin && $origin->path; 1982 $path = normalise $path, $origin && $origin->path;
1534 1983
1984 cf::lock_wait "map_data:$path";#d#remove
1535 cf::lock_wait "map_find:$path"; 1985 cf::lock_wait "map_find:$path";
1536 1986
1537 $cf::MAP{$path} || do { 1987 $cf::MAP{$path} || do {
1538 my $guard = cf::lock_acquire "map_find:$path"; 1988 my $guard1 = cf::lock_acquire "map_find:$path";
1989 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1990
1539 my $map = new_from_path cf::map $path 1991 my $map = new_from_path cf::map $path
1540 or return; 1992 or return;
1541 1993
1542 $map->{last_save} = $cf::RUNTIME; 1994 $map->{last_save} = $cf::RUNTIME;
1543 1995
1545 or return; 1997 or return;
1546 1998
1547 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?) 1999 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1548 # doing this can freeze the server in a sync job, obviously 2000 # doing this can freeze the server in a sync job, obviously
1549 #$cf::WAIT_FOR_TICK->wait; 2001 #$cf::WAIT_FOR_TICK->wait;
2002 undef $guard1;
2003 undef $guard2;
1550 $map->reset; 2004 $map->reset;
1551 undef $guard;
1552 return find $path; 2005 return find $path;
1553 } 2006 }
1554 2007
1555 $cf::MAP{$path} = $map 2008 $cf::MAP{$path} = $map
1556 } 2009 }
1565 local $self->{deny_reset} = 1; # loading can take a long time 2018 local $self->{deny_reset} = 1; # loading can take a long time
1566 2019
1567 my $path = $self->{path}; 2020 my $path = $self->{path};
1568 2021
1569 { 2022 {
1570 my $guard = cf::lock_acquire "map_load:$path"; 2023 my $guard = cf::lock_acquire "map_data:$path";
1571 2024
2025 return unless $self->valid;
1572 return if $self->in_memory != cf::MAP_SWAPPED; 2026 return unless $self->in_memory == cf::MAP_SWAPPED;
1573 2027
1574 $self->in_memory (cf::MAP_LOADING); 2028 $self->in_memory (cf::MAP_LOADING);
1575 2029
1576 $self->alloc; 2030 $self->alloc;
1577 2031
1578 $self->pre_load; 2032 $self->pre_load;
1579 Coro::cede; 2033 cf::cede_to_tick;
1580 2034
2035 my $f = new_from_file cf::object::thawer $self->{load_path};
2036 $f->skip_block;
1581 $self->_load_objects ($self->{load_path}, 1) 2037 $self->_load_objects ($f)
1582 or return; 2038 or return;
1583 2039
1584 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2040 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1585 if delete $self->{load_original}; 2041 if delete $self->{load_original};
1586 2042
1587 if (my $uniq = $self->uniq_path) { 2043 if (my $uniq = $self->uniq_path) {
1588 utf8::encode $uniq; 2044 utf8::encode $uniq;
1589 if (aio_open $uniq, O_RDONLY, 0) { 2045 unless (aio_stat $uniq) {
2046 if (my $f = new_from_file cf::object::thawer $uniq) {
1590 $self->clear_unique_items; 2047 $self->clear_unique_items;
1591 $self->_load_objects ($uniq, 0); 2048 $self->_load_objects ($f);
2049 $f->resolve_delayed_derefs;
2050 }
1592 } 2051 }
1593 } 2052 }
1594 2053
1595 Coro::cede; 2054 $f->resolve_delayed_derefs;
2055
2056 cf::cede_to_tick;
1596 # now do the right thing for maps 2057 # now do the right thing for maps
1597 $self->link_multipart_objects; 2058 $self->link_multipart_objects;
1598 $self->difficulty ($self->estimate_difficulty) 2059 $self->difficulty ($self->estimate_difficulty)
1599 unless $self->difficulty; 2060 unless $self->difficulty;
1600 Coro::cede; 2061 cf::cede_to_tick;
1601 2062
1602 unless ($self->{deny_activate}) { 2063 unless ($self->{deny_activate}) {
1603 $self->decay_objects; 2064 $self->decay_objects;
1604 $self->fix_auto_apply; 2065 $self->fix_auto_apply;
1605 $self->update_buttons; 2066 $self->update_buttons;
1606 Coro::cede; 2067 cf::cede_to_tick;
1607 $self->set_darkness_map; 2068 $self->set_darkness_map;
1608 Coro::cede; 2069 cf::cede_to_tick;
1609 $self->activate; 2070 $self->activate;
1610 } 2071 }
2072
2073 $self->{last_save} = $cf::RUNTIME;
2074 $self->last_access ($cf::RUNTIME);
1611 2075
1612 $self->in_memory (cf::MAP_IN_MEMORY); 2076 $self->in_memory (cf::MAP_IN_MEMORY);
1613 } 2077 }
1614 2078
1615 $self->post_load; 2079 $self->post_load;
1626 2090
1627 $self 2091 $self
1628} 2092}
1629 2093
1630# find and load all maps in the 3x3 area around a map 2094# find and load all maps in the 3x3 area around a map
1631sub load_diag { 2095sub load_neighbours {
1632 my ($map) = @_; 2096 my ($map) = @_;
1633 2097
1634 my @diag; # diagonal neighbours 2098 my @neigh; # diagonal neighbours
1635 2099
1636 for (0 .. 3) { 2100 for (0 .. 3) {
1637 my $neigh = $map->tile_path ($_) 2101 my $neigh = $map->tile_path ($_)
1638 or next; 2102 or next;
1639 $neigh = find $neigh, $map 2103 $neigh = find $neigh, $map
1640 or next; 2104 or next;
1641 $neigh->load; 2105 $neigh->load;
1642 2106
2107 push @neigh,
1643 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2108 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1644 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2109 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1645 } 2110 }
1646 2111
1647 for (@diag) { 2112 for (grep defined $_->[0], @neigh) {
2113 my ($path, $origin) = @$_;
1648 my $neigh = find @$_ 2114 my $neigh = find $path, $origin
1649 or next; 2115 or next;
1650 $neigh->load; 2116 $neigh->load;
1651 } 2117 }
1652} 2118}
1653 2119
1658} 2124}
1659 2125
1660sub do_load_sync { 2126sub do_load_sync {
1661 my ($map) = @_; 2127 my ($map) = @_;
1662 2128
2129 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2130 if $Coro::current == $Coro::main;
2131
1663 cf::sync_job { $map->load }; 2132 cf::sync_job { $map->load };
1664} 2133}
1665 2134
1666our %MAP_PREFETCH; 2135our %MAP_PREFETCH;
1667our $MAP_PREFETCHER = undef; 2136our $MAP_PREFETCHER = undef;
1668 2137
1669sub find_async { 2138sub find_async {
1670 my ($path, $origin) = @_; 2139 my ($path, $origin, $load) = @_;
1671 2140
1672 $path = normalise $path, $origin && $origin->{path}; 2141 $path = normalise $path, $origin && $origin->{path};
1673 2142
1674 if (my $map = $cf::MAP{$path}) { 2143 if (my $map = $cf::MAP{$path}) {
1675 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2144 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676 } 2145 }
1677 2146
1678 undef $MAP_PREFETCH{$path}; 2147 $MAP_PREFETCH{$path} |= $load;
2148
1679 $MAP_PREFETCHER ||= cf::async { 2149 $MAP_PREFETCHER ||= cf::async {
2150 $Coro::current->{desc} = "map prefetcher";
2151
1680 while (%MAP_PREFETCH) { 2152 while (%MAP_PREFETCH) {
1681 for my $path (keys %MAP_PREFETCH) { 2153 while (my ($k, $v) = each %MAP_PREFETCH) {
1682 my $map = find $path 2154 if (my $map = find $k) {
1683 or next;
1684 $map->load; 2155 $map->load if $v;
2156 }
1685 2157
1686 delete $MAP_PREFETCH{$path}; 2158 delete $MAP_PREFETCH{$k};
1687 } 2159 }
1688 } 2160 }
1689 undef $MAP_PREFETCHER; 2161 undef $MAP_PREFETCHER;
1690 }; 2162 };
1691 $MAP_PREFETCHER->prio (6); 2163 $MAP_PREFETCHER->prio (6);
1694} 2166}
1695 2167
1696sub save { 2168sub save {
1697 my ($self) = @_; 2169 my ($self) = @_;
1698 2170
1699 my $lock = cf::lock_acquire "map_data:" . $self->path; 2171 my $lock = cf::lock_acquire "map_data:$self->{path}";
1700 2172
1701 $self->{last_save} = $cf::RUNTIME; 2173 $self->{last_save} = $cf::RUNTIME;
1702 2174
1703 return unless $self->dirty; 2175 return unless $self->dirty;
1704 2176
1710 return if $self->{deny_save}; 2182 return if $self->{deny_save};
1711 2183
1712 local $self->{last_access} = $self->last_access;#d# 2184 local $self->{last_access} = $self->last_access;#d#
1713 2185
1714 cf::async { 2186 cf::async {
2187 $Coro::current->{desc} = "map player save";
1715 $_->contr->save for $self->players; 2188 $_->contr->save for $self->players;
1716 }; 2189 };
1717 2190
1718 if ($uniq) { 2191 if ($uniq) {
1719 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2192 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1727 my ($self) = @_; 2200 my ($self) = @_;
1728 2201
1729 # save first because save cedes 2202 # save first because save cedes
1730 $self->save; 2203 $self->save;
1731 2204
1732 my $lock = cf::lock_acquire "map_data:" . $self->path; 2205 my $lock = cf::lock_acquire "map_data:$self->{path}";
1733 2206
1734 return if $self->players; 2207 return if $self->players;
1735 return if $self->in_memory != cf::MAP_IN_MEMORY; 2208 return if $self->in_memory != cf::MAP_IN_MEMORY;
1736 return if $self->{deny_save}; 2209 return if $self->{deny_save};
1737 2210
2211 $self->in_memory (cf::MAP_SWAPPED);
2212
2213 $self->deactivate;
2214 $_->clear_links_to ($self) for values %cf::MAP;
1738 $self->clear; 2215 $self->clear;
1739 $self->in_memory (cf::MAP_SWAPPED);
1740} 2216}
1741 2217
1742sub reset_at { 2218sub reset_at {
1743 my ($self) = @_; 2219 my ($self) = @_;
1744 2220
1776 if $uniq; 2252 if $uniq;
1777 } 2253 }
1778 2254
1779 delete $cf::MAP{$self->path}; 2255 delete $cf::MAP{$self->path};
1780 2256
2257 $self->deactivate;
2258 $_->clear_links_to ($self) for values %cf::MAP;
1781 $self->clear; 2259 $self->clear;
1782
1783 $_->clear_links_to ($self) for values %cf::MAP;
1784 2260
1785 $self->unlink_save; 2261 $self->unlink_save;
1786 $self->destroy; 2262 $self->destroy;
1787} 2263}
1788 2264
1789my $nuke_counter = "aaaa"; 2265my $nuke_counter = "aaaa";
1790 2266
1791sub nuke { 2267sub nuke {
1792 my ($self) = @_; 2268 my ($self) = @_;
1793 2269
2270 {
2271 my $lock = cf::lock_acquire "map_data:$self->{path}";
2272
1794 delete $cf::MAP{$self->path}; 2273 delete $cf::MAP{$self->path};
1795 2274
1796 $self->unlink_save; 2275 $self->unlink_save;
1797 2276
1798 bless $self, "cf::map"; 2277 bless $self, "cf::map";
1799 delete $self->{deny_reset}; 2278 delete $self->{deny_reset};
1800 $self->{deny_save} = 1; 2279 $self->{deny_save} = 1;
1801 $self->reset_timeout (1); 2280 $self->reset_timeout (1);
1802 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2281 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1803 2282
1804 $cf::MAP{$self->path} = $self; 2283 $cf::MAP{$self->path} = $self;
2284 }
1805 2285
1806 $self->reset; # polite request, might not happen 2286 $self->reset; # polite request, might not happen
1807} 2287}
1808 2288
1809=item $maps = cf::map::tmp_maps 2289=item $maps = cf::map::tmp_maps
1885 2365
1886sub inv_recursive { 2366sub inv_recursive {
1887 inv_recursive_ inv $_[0] 2367 inv_recursive_ inv $_[0]
1888} 2368}
1889 2369
2370=item $ref = $ob->ref
2371
2372creates and returns a persistent reference to an objetc that can be stored as a string.
2373
2374=item $ob = cf::object::deref ($refstring)
2375
2376returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2377even if the object actually exists. May block.
2378
2379=cut
2380
2381sub deref {
2382 my ($ref) = @_;
2383
2384 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2385 my ($uuid, $name) = ($1, $2);
2386 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2387 or return;
2388 $pl->ob->uuid eq $uuid
2389 or return;
2390
2391 $pl->ob
2392 } else {
2393 warn "$ref: cannot resolve object reference\n";
2394 undef
2395 }
2396}
2397
1890package cf; 2398package cf;
1891 2399
1892=back 2400=back
1893 2401
1894=head3 cf::object::player 2402=head3 cf::object::player
1911 2419
1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2420 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913 2421
1914 if ($self->{record_replies}) { 2422 if ($self->{record_replies}) {
1915 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2423 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2424
1916 } else { 2425 } else {
2426 my $pl = $self->contr;
2427
2428 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2429 my $dialog = $pl->{npc_dialog};
2430 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2431
2432 } else {
1917 $msg = $npc->name . " says: $msg" if $npc; 2433 $msg = $npc->name . " says: $msg" if $npc;
1918 $self->message ($msg, $flags); 2434 $self->message ($msg, $flags);
2435 }
1919 } 2436 }
2437}
2438
2439=item $object->send_msg ($channel, $msg, $color, [extra...])
2440
2441=cut
2442
2443sub cf::object::send_msg {
2444 my $pl = shift->contr
2445 or return;
2446 $pl->send_msg (@_);
1920} 2447}
1921 2448
1922=item $player_object->may ("access") 2449=item $player_object->may ("access")
1923 2450
1924Returns wether the given player is authorized to access resource "access" 2451Returns wether the given player is authorized to access resource "access"
2003 # use -1 or undef as default coordinates, not 0, 0 2530 # use -1 or undef as default coordinates, not 0, 0
2004 ($x, $y) = ($map->enter_x, $map->enter_y) 2531 ($x, $y) = ($map->enter_x, $map->enter_y)
2005 if $x <=0 && $y <= 0; 2532 if $x <=0 && $y <= 0;
2006 2533
2007 $map->load; 2534 $map->load;
2008 $map->load_diag; 2535 $map->load_neighbours;
2009 2536
2010 return unless $self->contr->active; 2537 return unless $self->contr->active;
2011 $self->activate_recursive; 2538 $self->activate_recursive;
2012 2539
2013 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2540 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014 $self->enter_map ($map, $x, $y); 2541 $self->enter_map ($map, $x, $y);
2015} 2542}
2016 2543
2017=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2544=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018 2545
2019Moves the player to the given map-path and coordinates by first freezing 2546Moves the player to the given map-path and coordinates by first freezing
2020her, loading and preparing them map, calling the provided $check callback 2547her, loading and preparing them map, calling the provided $check callback
2021that has to return the map if sucecssful, and then unfreezes the player on 2548that has to return the map if sucecssful, and then unfreezes the player on
2022the new (success) or old (failed) map position. 2549the new (success) or old (failed) map position. In either case, $done will
2550be called at the end of this process.
2023 2551
2024=cut 2552=cut
2025 2553
2026our $GOTOGEN; 2554our $GOTOGEN;
2027 2555
2028sub cf::object::player::goto { 2556sub cf::object::player::goto {
2029 my ($self, $path, $x, $y, $check) = @_; 2557 my ($self, $path, $x, $y, $check, $done) = @_;
2030 2558
2031 # do generation counting so two concurrent goto's will be executed in-order 2559 # do generation counting so two concurrent goto's will be executed in-order
2032 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2560 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033 2561
2034 $self->enter_link; 2562 $self->enter_link;
2035 2563
2036 (async { 2564 (async {
2565 $Coro::current->{desc} = "player::goto $path $x $y";
2566
2567 # *tag paths override both path and x|y
2568 if ($path =~ /^\*(.*)$/) {
2569 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2570 my $ob = $obs[rand @obs];
2571
2572 # see if we actually can go there
2573 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2574 $ob = $obs[rand @obs];
2575 } else {
2576 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2577 }
2578 # else put us there anyways for now #d#
2579
2580 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2581 } else {
2582 ($path, $x, $y) = (undef, undef, undef);
2583 }
2584 }
2585
2037 my $map = eval { 2586 my $map = eval {
2038 my $map = cf::map::find $path; 2587 my $map = defined $path ? cf::map::find $path : undef;
2039 2588
2040 if ($map) { 2589 if ($map) {
2041 $map = $map->customise_for ($self); 2590 $map = $map->customise_for ($self);
2042 $map = $check->($map) if $check && $map; 2591 $map = $check->($map) if $check && $map;
2043 } else { 2592 } else {
2044 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2593 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2045 } 2594 }
2046 2595
2047 $map 2596 $map
2048 }; 2597 };
2049 2598
2054 2603
2055 if ($gen == $self->{_goto_generation}) { 2604 if ($gen == $self->{_goto_generation}) {
2056 delete $self->{_goto_generation}; 2605 delete $self->{_goto_generation};
2057 $self->leave_link ($map, $x, $y); 2606 $self->leave_link ($map, $x, $y);
2058 } 2607 }
2608
2609 $done->() if $done;
2059 })->prio (1); 2610 })->prio (1);
2060} 2611}
2061 2612
2062=item $player_object->enter_exit ($exit_object) 2613=item $player_object->enter_exit ($exit_object)
2063 2614
2100 $rmp->{origin_y} = $exit->y; 2651 $rmp->{origin_y} = $exit->y;
2101 } 2652 }
2102 2653
2103 $rmp->{random_seed} ||= $exit->random_seed; 2654 $rmp->{random_seed} ||= $exit->random_seed;
2104 2655
2105 my $data = cf::to_json $rmp; 2656 my $data = cf::encode_json $rmp;
2106 my $md5 = Digest::MD5::md5_hex $data; 2657 my $md5 = Digest::MD5::md5_hex $data;
2107 my $meta = "$RANDOMDIR/$md5.meta"; 2658 my $meta = "$RANDOMDIR/$md5.meta";
2108 2659
2109 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2660 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2110 aio_write $fh, 0, (length $data), $data, 0; 2661 aio_write $fh, 0, (length $data), $data, 0;
2132 my $hp = $exit->stats->hp; 2683 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp; 2684 my $sp = $exit->stats->sp;
2134 2685
2135 $self->enter_link; 2686 $self->enter_link;
2136 2687
2688 # if exit is damned, update players death & WoR home-position
2689 $self->contr->savebed ($slaying, $hp, $sp)
2690 if $exit->flag (FLAG_DAMNED);
2691
2137 (async { 2692 (async {
2693 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2694
2138 $self->deactivate_recursive; # just to be sure 2695 $self->deactivate_recursive; # just to be sure
2139 unless (eval { 2696 unless (eval {
2140 $self->goto ($slaying, $hp, $sp); 2697 $self->goto ($slaying, $hp, $sp);
2141 2698
2142 1; 2699 1;
2168 2725
2169 utf8::encode $text; 2726 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2727 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171} 2728}
2172 2729
2730=item $client->send_msg ($channel, $msg, $color, [extra...])
2731
2732Send a drawinfo or msg packet to the client, formatting the msg for the
2733client if neccessary. C<$type> should be a string identifying the type of
2734the message, with C<log> being the default. If C<$color> is negative, suppress
2735the message unless the client supports the msg packet.
2736
2737=cut
2738
2739# non-persistent channels (usually the info channel)
2740our %CHANNEL = (
2741 "c/identify" => {
2742 id => "infobox",
2743 title => "Identify",
2744 reply => undef,
2745 tooltip => "Items recently identified",
2746 },
2747 "c/examine" => {
2748 id => "infobox",
2749 title => "Examine",
2750 reply => undef,
2751 tooltip => "Signs and other items you examined",
2752 },
2753 "c/book" => {
2754 id => "infobox",
2755 title => "Book",
2756 reply => undef,
2757 tooltip => "The contents of a note or book",
2758 },
2759 "c/lookat" => {
2760 id => "infobox",
2761 title => "Look",
2762 reply => undef,
2763 tooltip => "What you saw there",
2764 },
2765 "c/who" => {
2766 id => "infobox",
2767 title => "Players",
2768 reply => undef,
2769 tooltip => "Shows players who are currently online",
2770 },
2771 "c/body" => {
2772 id => "infobox",
2773 title => "Body Parts",
2774 reply => undef,
2775 tooltip => "Shows which body parts you posess and are available",
2776 },
2777 "c/uptime" => {
2778 id => "infobox",
2779 title => "Uptime",
2780 reply => undef,
2781 tooltip => "How long the server has been running since last restart",
2782 },
2783 "c/mapinfo" => {
2784 id => "infobox",
2785 title => "Map Info",
2786 reply => undef,
2787 tooltip => "Information related to the maps",
2788 },
2789);
2790
2791sub cf::client::send_msg {
2792 my ($self, $channel, $msg, $color, @extra) = @_;
2793
2794 $msg = $self->pl->expand_cfpod ($msg);
2795
2796 $color &= cf::NDI_CLIENT_MASK; # just in case...
2797
2798 # check predefined channels, for the benefit of C
2799 if ($CHANNEL{$channel}) {
2800 $channel = $CHANNEL{$channel};
2801
2802 $self->ext_msg (channel_info => $channel)
2803 if $self->can_msg;
2804
2805 $channel = $channel->{id};
2806
2807 } elsif (ref $channel) {
2808 # send meta info to client, if not yet sent
2809 unless (exists $self->{channel}{$channel->{id}}) {
2810 $self->{channel}{$channel->{id}} = $channel;
2811 $self->ext_msg (channel_info => $channel)
2812 if $self->can_msg;
2813 }
2814
2815 $channel = $channel->{id};
2816 }
2817
2818 return unless @extra || length $msg;
2819
2820 if ($self->can_msg) {
2821 # default colour, mask it out
2822 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2823 if $color & cf::NDI_DEF;
2824
2825 $self->send_packet ("msg " . $self->{json_coder}->encode (
2826 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2827 } else {
2828 if ($color >= 0) {
2829 # replace some tags by gcfclient-compatible ones
2830 for ($msg) {
2831 1 while
2832 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2833 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2834 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2835 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2836 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2837 }
2838
2839 $color &= cf::NDI_COLOR_MASK;
2840
2841 utf8::encode $msg;
2842
2843 if (0 && $msg =~ /\[/) {
2844 # COMMAND/INFO
2845 $self->send_packet ("drawextinfo $color 10 8 $msg")
2846 } else {
2847 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2848 $self->send_packet ("drawinfo $color $msg")
2849 }
2850 }
2851 }
2852}
2853
2173=item $client->ext_event ($type, %msg) 2854=item $client->ext_msg ($type, @msg)
2174 2855
2175Sends an exti event to the client. 2856Sends an ext event to the client.
2176 2857
2177=cut 2858=cut
2178 2859
2179sub cf::client::ext_event($$%) { 2860sub cf::client::ext_msg($$@) {
2180 my ($self, $type, %msg) = @_; 2861 my ($self, $type, @msg) = @_;
2181 2862
2863 if ($self->extcmd == 2) {
2864 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2865 } elsif ($self->extcmd == 1) { # TODO: remove
2182 $msg{msgtype} = "event_$type"; 2866 push @msg, msgtype => "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg); 2867 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2868 }
2869}
2870
2871=item $client->ext_reply ($msgid, @msg)
2872
2873Sends an ext reply to the client.
2874
2875=cut
2876
2877sub cf::client::ext_reply($$@) {
2878 my ($self, $id, @msg) = @_;
2879
2880 if ($self->extcmd == 2) {
2881 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2882 } elsif ($self->extcmd == 1) {
2883 #TODO: version 1, remove
2884 unshift @msg, msgtype => "reply", msgid => $id;
2885 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2886 }
2184} 2887}
2185 2888
2186=item $success = $client->query ($flags, "text", \&cb) 2889=item $success = $client->query ($flags, "text", \&cb)
2187 2890
2188Queues a query to the client, calling the given callback with 2891Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2892the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2190C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2893C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191 2894
2192Queries can fail, so check the return code. Or don't, as queries will become 2895Queries can fail, so check the return code. Or don't, as queries will
2193reliable at some point in the future. 2896become reliable at some point in the future.
2194 2897
2195=cut 2898=cut
2196 2899
2197sub cf::client::query { 2900sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_; 2901 my ($self, $flags, $text, $cb) = @_;
2206 utf8::encode $text; 2909 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2910 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208 2911
2209 $self->send_packet ($self->{query_queue}[0][0]) 2912 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1; 2913 if @{ $self->{query_queue} } == 1;
2914
2915 1
2211} 2916}
2212 2917
2213cf::client->attach ( 2918cf::client->attach (
2919 on_connect => sub {
2920 my ($ns) = @_;
2921
2922 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2923 },
2214 on_reply => sub { 2924 on_reply => sub {
2215 my ($ns, $msg) = @_; 2925 my ($ns, $msg) = @_;
2216 2926
2217 # this weird shuffling is so that direct followup queries 2927 # this weird shuffling is so that direct followup queries
2218 # get handled first 2928 # get handled first
2230 } else { 2940 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2941 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 } 2942 }
2233 } 2943 }
2234 }, 2944 },
2945 on_exticmd => sub {
2946 my ($ns, $buf) = @_;
2947
2948 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2949
2950 if (ref $msg) {
2951 my ($type, $reply, @payload) =
2952 "ARRAY" eq ref $msg
2953 ? @$msg
2954 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2955
2956 my @reply;
2957
2958 if (my $cb = $EXTICMD{$type}) {
2959 @reply = $cb->($ns, @payload);
2960 }
2961
2962 $ns->ext_reply ($reply, @reply)
2963 if $reply;
2964
2965 } else {
2966 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2967 }
2968
2969 cf::override;
2970 },
2235); 2971);
2236 2972
2237=item $client->async (\&cb) 2973=item $client->async (\&cb)
2238 2974
2239Create a new coroutine, running the specified callback. The coroutine will 2975Create a new coroutine, running the specified callback. The coroutine will
2280our $safe = new Safe "safe"; 3016our $safe = new Safe "safe";
2281our $safe_hole = new Safe::Hole; 3017our $safe_hole = new Safe::Hole;
2282 3018
2283$SIG{FPE} = 'IGNORE'; 3019$SIG{FPE} = 'IGNORE';
2284 3020
2285$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3021$safe->permit_only (Opcode::opset qw(
3022 :base_core :base_mem :base_orig :base_math
3023 grepstart grepwhile mapstart mapwhile
3024 sort time
3025));
2286 3026
2287# here we export the classes and methods available to script code 3027# here we export the classes and methods available to script code
2288 3028
2289=pod 3029=pod
2290 3030
2291The following functions and methods are available within a safe environment: 3031The following functions and methods are available within a safe environment:
2292 3032
2293 cf::object contr pay_amount pay_player map 3033 cf::object
3034 contr pay_amount pay_player map x y force_find force_add destroy
3035 insert remove name archname title slaying race decrease_ob_nr
3036
2294 cf::object::player player 3037 cf::object::player
2295 cf::player peaceful 3038 player
2296 cf::map trigger 3039
3040 cf::player
3041 peaceful
3042
3043 cf::map
3044 trigger
2297 3045
2298=cut 3046=cut
2299 3047
2300for ( 3048for (
2301 ["cf::object" => qw(contr pay_amount pay_player map)], 3049 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3050 insert remove inv name archname title slaying race
3051 decrease_ob_nr destroy)],
2302 ["cf::object::player" => qw(player)], 3052 ["cf::object::player" => qw(player)],
2303 ["cf::player" => qw(peaceful)], 3053 ["cf::player" => qw(peaceful)],
2304 ["cf::map" => qw(trigger)], 3054 ["cf::map" => qw(trigger)],
2305) { 3055) {
2306 no strict 'refs'; 3056 no strict 'refs';
2377=back 3127=back
2378 3128
2379=cut 3129=cut
2380 3130
2381############################################################################# 3131#############################################################################
2382
2383=head2 EXTENSION DATABASE SUPPORT
2384
2385Crossfire maintains a very simple database for extension use. It can
2386currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2387convert to/from binary).
2388
2389The parameter C<$family> should best start with the name of the extension
2390using it, it should be unique.
2391
2392=over 4
2393
2394=item $value = cf::db_get $family => $key
2395
2396Returns a single value from the database.
2397
2398=item cf::db_put $family => $key => $value
2399
2400Stores the given C<$value> in the family.
2401
2402=cut
2403
2404our $DB;
2405
2406sub db_init {
2407 unless ($DB) {
2408 $DB = BDB::db_create $DB_ENV;
2409
2410 cf::sync_job {
2411 eval {
2412 $DB->set_flags (BDB::CHKSUM);
2413
2414 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2415 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2416 cf::cleanup "db_open(db): $!" if $!;
2417 };
2418 cf::cleanup "db_open(db): $@" if $@;
2419 };
2420 }
2421}
2422
2423sub db_get($$) {
2424 my $key = "$_[0]/$_[1]";
2425
2426 cf::sync_job {
2427 BDB::db_get $DB, undef, $key, my $data;
2428
2429 $! ? ()
2430 : $data
2431 }
2432}
2433
2434sub db_put($$$) {
2435 BDB::dbreq_pri 4;
2436 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2437}
2438
2439=item cf::cache $id => [$paths...], $processversion => $process
2440
2441Generic caching function that returns the value of the resource $id,
2442caching and regenerating as required.
2443
2444This function can block.
2445
2446=cut
2447
2448sub cache {
2449 my ($id, $src, $processversion, $process) = @_;
2450
2451 my $meta =
2452 join "\x00",
2453 $processversion,
2454 map {
2455 aio_stat $_
2456 and Carp::croak "$_: $!";
2457
2458 ($_, (stat _)[7,9])
2459 } @$src;
2460
2461 my $dbmeta = db_get cache => "$id/meta";
2462 if ($dbmeta ne $meta) {
2463 # changed, we may need to process
2464
2465 my @data;
2466 my $md5;
2467
2468 for (0 .. $#$src) {
2469 0 <= aio_load $src->[$_], $data[$_]
2470 or Carp::croak "$src->[$_]: $!";
2471 }
2472
2473 # if processing is expensive, check
2474 # checksum first
2475 if (1) {
2476 $md5 =
2477 join "\x00",
2478 $processversion,
2479 map {
2480 Coro::cede;
2481 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2482 } 0.. $#$src;
2483
2484
2485 my $dbmd5 = db_get cache => "$id/md5";
2486 if ($dbmd5 eq $md5) {
2487 db_put cache => "$id/meta", $meta;
2488
2489 return db_get cache => "$id/data";
2490 }
2491 }
2492
2493 my $t1 = Time::HiRes::time;
2494 my $data = $process->(\@data);
2495 my $t2 = Time::HiRes::time;
2496
2497 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499 db_put cache => "$id/data", $data;
2500 db_put cache => "$id/md5" , $md5;
2501 db_put cache => "$id/meta", $meta;
2502
2503 return $data;
2504 }
2505
2506 db_get cache => "$id/data"
2507}
2508
2509=item fork_call { }, $args
2510
2511Executes the given code block with the given arguments in a seperate
2512process, returning the results. Everything must be serialisable with
2513Coro::Storable. May, of course, block. Note that the executed sub may
2514never block itself or use any form of Event handling.
2515
2516=cut
2517
2518sub fork_call(&@) {
2519 my ($cb, @args) = @_;
2520
2521# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522# or die "socketpair: $!";
2523 pipe my $fh1, my $fh2
2524 or die "pipe: $!";
2525
2526 if (my $pid = fork) {
2527 close $fh2;
2528
2529 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530 $res = Coro::Storable::thaw $res;
2531
2532 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534 die $$res unless "ARRAY" eq ref $res;
2535
2536 return wantarray ? @$res : $res->[-1];
2537 } else {
2538 reset_signals;
2539 local $SIG{__WARN__};
2540 local $SIG{__DIE__};
2541 eval {
2542 close $fh1;
2543
2544 my @res = eval { $cb->(@args) };
2545 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546 };
2547
2548 warn $@ if $@;
2549 _exit 0;
2550 }
2551}
2552
2553#############################################################################
2554# the server's init and main functions 3132# the server's init and main functions
2555 3133
2556sub load_facedata($) { 3134sub load_facedata($) {
2557 my ($path) = @_; 3135 my ($path) = @_;
3136
3137 # HACK to clear player env face cache, we need some signal framework
3138 # for this (global event?)
3139 %ext::player_env::MUSIC_FACE_CACHE = ();
3140
3141 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2558 3142
2559 warn "loading facedata from $path\n"; 3143 warn "loading facedata from $path\n";
2560 3144
2561 my $facedata; 3145 my $facedata;
2562 0 < aio_load $path, $facedata 3146 0 < aio_load $path, $facedata
2565 $facedata = Coro::Storable::thaw $facedata; 3149 $facedata = Coro::Storable::thaw $facedata;
2566 3150
2567 $facedata->{version} == 2 3151 $facedata->{version} == 2
2568 or cf::cleanup "$path: version mismatch, cannot proceed."; 3152 or cf::cleanup "$path: version mismatch, cannot proceed.";
2569 3153
3154 # patch in the exptable
3155 $facedata->{resource}{"res/exp_table"} = {
3156 type => FT_RSRC,
3157 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3158 };
3159 cf::cede_to_tick;
3160
2570 { 3161 {
2571 my $faces = $facedata->{faceinfo}; 3162 my $faces = $facedata->{faceinfo};
2572 3163
2573 while (my ($face, $info) = each %$faces) { 3164 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3165 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3166
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 3167 cf::face::set_visibility $idx, $info->{visibility};
3168 cf::face::set_magicmap $idx, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3169 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 3170 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578 Coro::cede; 3171
3172 cf::cede_to_tick;
2579 } 3173 }
2580 3174
2581 while (my ($face, $info) = each %$faces) { 3175 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth}; 3176 next unless $info->{smooth};
3177
2583 my $idx = cf::face::find $face 3178 my $idx = cf::face::find $face
2584 or next; 3179 or next;
3180
2585 if (my $smooth = cf::face::find $info->{smooth}) { 3181 if (my $smooth = cf::face::find $info->{smooth}) {
3182 cf::face::set_smooth $idx, $smooth;
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 3183 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587 } else { 3184 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'"; 3185 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 } 3186 }
2590 Coro::cede; 3187
3188 cf::cede_to_tick;
2591 } 3189 }
2592 } 3190 }
2593 3191
2594 { 3192 {
2595 my $anims = $facedata->{animinfo}; 3193 my $anims = $facedata->{animinfo};
2596 3194
2597 while (my ($anim, $info) = each %$anims) { 3195 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings}; 3196 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede; 3197 cf::cede_to_tick;
2600 } 3198 }
2601 3199
2602 cf::anim::invalidate_all; # d'oh 3200 cf::anim::invalidate_all; # d'oh
2603 } 3201 }
2604 3202
3203 {
3204 # TODO: for gcfclient pleasure, we should give resources
3205 # that gcfclient doesn't grok a >10000 face index.
3206 my $res = $facedata->{resource};
3207
3208 while (my ($name, $info) = each %$res) {
3209 if (defined $info->{type}) {
3210 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3211 my $data;
3212
3213 if ($info->{type} & 1) {
3214 # prepend meta info
3215
3216 my $meta = $enc->encode ({
3217 name => $name,
3218 %{ $info->{meta} || {} },
3219 });
3220
3221 $data = pack "(w/a*)*", $meta, $info->{data};
3222 } else {
3223 $data = $info->{data};
3224 }
3225
3226 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3227 cf::face::set_type $idx, $info->{type};
3228 } else {
3229 $RESOURCE{$name} = $info;
3230 }
3231
3232 cf::cede_to_tick;
3233 }
3234 }
3235
3236 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3237
2605 1 3238 1
2606} 3239}
2607 3240
3241cf::global->attach (on_resource_update => sub {
3242 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3243 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3244
3245 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3246 my $sound = $soundconf->{compat}[$_]
3247 or next;
3248
3249 my $face = cf::face::find "sound/$sound->[1]";
3250 cf::sound::set $sound->[0] => $face;
3251 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3252 }
3253
3254 while (my ($k, $v) = each %{$soundconf->{event}}) {
3255 my $face = cf::face::find "sound/$v";
3256 cf::sound::set $k => $face;
3257 }
3258 }
3259});
3260
3261register_exticmd fx_want => sub {
3262 my ($ns, $want) = @_;
3263
3264 while (my ($k, $v) = each %$want) {
3265 $ns->fx_want ($k, $v);
3266 }
3267};
3268
2608sub reload_regions { 3269sub reload_regions {
3270 # HACK to clear player env face cache, we need some signal framework
3271 # for this (global event?)
3272 %ext::player_env::MUSIC_FACE_CACHE = ();
3273
2609 load_resource_file "$MAPDIR/regions" 3274 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n"; 3275 or die "unable to load regions file\n";
3276
3277 for (cf::region::list) {
3278 $_->{match} = qr/$_->{match}/
3279 if exists $_->{match};
3280 }
2611} 3281}
2612 3282
2613sub reload_facedata { 3283sub reload_facedata {
2614 load_facedata "$DATADIR/facedata" 3284 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n"; 3285 or die "unable to load facedata\n";
2616} 3286}
2617 3287
2618sub reload_archetypes { 3288sub reload_archetypes {
3289 load_resource_file "$DATADIR/archetypes"
3290 or die "unable to load archetypes\n";
3291 #d# NEED to laod twice to resolve forward references
3292 # this really needs to be done in an extra post-pass
3293 # (which needs to be synchronous, so solve it differently)
2619 load_resource_file "$DATADIR/archetypes" 3294 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n"; 3295 or die "unable to load archetypes\n";
2621} 3296}
2622 3297
2623sub reload_treasures { 3298sub reload_treasures {
2639 3314
2640sub init { 3315sub init {
2641 reload_resources; 3316 reload_resources;
2642} 3317}
2643 3318
2644sub cfg_load { 3319sub reload_config {
2645 open my $fh, "<:utf8", "$CONFDIR/config" 3320 open my $fh, "<:utf8", "$CONFDIR/config"
2646 or return; 3321 or return;
2647 3322
2648 local $/; 3323 local $/;
2649 *CFG = YAML::Syck::Load <$fh>; 3324 *CFG = YAML::Load <$fh>;
2650 3325
2651 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3326 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2652 3327
2653 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3328 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2654 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3329 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2665sub main { 3340sub main {
2666 # we must not ever block the main coroutine 3341 # we must not ever block the main coroutine
2667 local $Coro::idle = sub { 3342 local $Coro::idle = sub {
2668 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3343 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2669 (async { 3344 (async {
2670 Event::one_event; 3345 $Coro::current->{desc} = "IDLE BUG HANDLER";
3346 EV::loop EV::LOOP_ONESHOT;
2671 })->prio (Coro::PRIO_MAX); 3347 })->prio (Coro::PRIO_MAX);
2672 }; 3348 };
2673 3349
2674 cfg_load; 3350 reload_config;
2675 db_init; 3351 db_init;
2676 load_extensions; 3352 load_extensions;
2677 3353
2678 $TICK_WATCHER->start; 3354 $TICK_WATCHER->start;
3355 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2679 Event::loop; 3356 EV::loop;
2680} 3357}
2681 3358
2682############################################################################# 3359#############################################################################
2683# initialisation and cleanup 3360# initialisation and cleanup
2684 3361
2685# install some emergency cleanup handlers 3362# install some emergency cleanup handlers
2686BEGIN { 3363BEGIN {
3364 our %SIGWATCHER = ();
2687 for my $signal (qw(INT HUP TERM)) { 3365 for my $signal (qw(INT HUP TERM)) {
2688 Event->signal ( 3366 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2689 reentrant => 0,
2690 data => WF_AUTOCANCEL,
2691 signal => $signal,
2692 prio => 0,
2693 cb => sub {
2694 cf::cleanup "SIG$signal"; 3367 cf::cleanup "SIG$signal";
2695 },
2696 ); 3368 };
3369 }
3370}
3371
3372sub write_runtime {
3373 my $runtime = "$LOCALDIR/runtime";
3374
3375 # first touch the runtime file to show we are still running:
3376 # the fsync below can take a very very long time.
3377
3378 IO::AIO::aio_utime $runtime, undef, undef;
3379
3380 my $guard = cf::lock_acquire "write_runtime";
3381
3382 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3383 or return;
3384
3385 my $value = $cf::RUNTIME + 90 + 10;
3386 # 10 is the runtime save interval, for a monotonic clock
3387 # 60 allows for the watchdog to kill the server.
3388
3389 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3390 and return;
3391
3392 # always fsync - this file is important
3393 aio_fsync $fh
3394 and return;
3395
3396 # touch it again to show we are up-to-date
3397 aio_utime $fh, undef, undef;
3398
3399 close $fh
3400 or return;
3401
3402 aio_rename "$runtime~", $runtime
3403 and return;
3404
3405 warn "runtime file written.\n";
3406
2697 } 3407 1
2698} 3408}
2699 3409
2700sub emergency_save() { 3410sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop; 3411 my $freeze_guard = cf::freeze_mainloop;
2702 3412
2708 # and maps saved/destroyed asynchronously. 3418 # and maps saved/destroyed asynchronously.
2709 warn "begin emergency player save\n"; 3419 warn "begin emergency player save\n";
2710 for my $login (keys %cf::PLAYER) { 3420 for my $login (keys %cf::PLAYER) {
2711 my $pl = $cf::PLAYER{$login} or next; 3421 my $pl = $cf::PLAYER{$login} or next;
2712 $pl->valid or next; 3422 $pl->valid or next;
3423 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2713 $pl->save; 3424 $pl->save;
2714 } 3425 }
2715 warn "end emergency player save\n"; 3426 warn "end emergency player save\n";
2716 3427
2717 warn "begin emergency map save\n"; 3428 warn "begin emergency map save\n";
2756 warn "syncing database to disk"; 3467 warn "syncing database to disk";
2757 BDB::db_env_txn_checkpoint $DB_ENV; 3468 BDB::db_env_txn_checkpoint $DB_ENV;
2758 3469
2759 # if anything goes wrong in here, we should simply crash as we already saved 3470 # if anything goes wrong in here, we should simply crash as we already saved
2760 3471
2761 warn "cancelling all WF_AUTOCANCEL watchers";
2762 for (Event::all_watchers) {
2763 $_->cancel if $_->data & WF_AUTOCANCEL;
2764 }
2765
2766 warn "flushing outstanding aio requests"; 3472 warn "flushing outstanding aio requests";
2767 for (;;) { 3473 for (;;) {
2768 BDB::flush; 3474 BDB::flush;
2769 IO::AIO::flush; 3475 IO::AIO::flush;
2770 Coro::cede; 3476 Coro::cede_notself;
2771 last unless IO::AIO::nreqs || BDB::nreqs; 3477 last unless IO::AIO::nreqs || BDB::nreqs;
2772 warn "iterate..."; 3478 warn "iterate...";
2773 } 3479 }
2774 3480
2775 ++$RELOAD; 3481 ++$RELOAD;
2779 %EXT_CORO = (); 3485 %EXT_CORO = ();
2780 3486
2781 warn "removing commands"; 3487 warn "removing commands";
2782 %COMMAND = (); 3488 %COMMAND = ();
2783 3489
2784 warn "removing ext commands"; 3490 warn "removing ext/exti commands";
2785 %EXTCMD = (); 3491 %EXTCMD = ();
3492 %EXTICMD = ();
2786 3493
2787 warn "unloading/nuking all extensions"; 3494 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) { 3495 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg"; 3496 warn "... unloading $pkg";
2790 3497
2833 warn "reloading cf.pm"; 3540 warn "reloading cf.pm";
2834 require cf; 3541 require cf;
2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3542 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2836 3543
2837 warn "loading config and database again"; 3544 warn "loading config and database again";
2838 cf::cfg_load; 3545 cf::reload_config;
2839 3546
2840 warn "loading extensions"; 3547 warn "loading extensions";
2841 cf::load_extensions; 3548 cf::load_extensions;
2842 3549
2843 warn "reattaching attachments to objects/players"; 3550 warn "reattaching attachments to objects/players";
2850 warn "leaving sync_job"; 3557 warn "leaving sync_job";
2851 3558
2852 1 3559 1
2853 } or do { 3560 } or do {
2854 warn $@; 3561 warn $@;
2855 warn "error while reloading, exiting."; 3562 cf::cleanup "error while reloading, exiting.";
2856 exit 1;
2857 }; 3563 };
2858 3564
2859 warn "reloaded"; 3565 warn "reloaded";
2860}; 3566};
2861 3567
2863 3569
2864sub reload_perl() { 3570sub reload_perl() {
2865 # doing reload synchronously and two reloads happen back-to-back, 3571 # doing reload synchronously and two reloads happen back-to-back,
2866 # coro crashes during coro_state_free->destroy here. 3572 # coro crashes during coro_state_free->destroy here.
2867 3573
2868 $RELOAD_WATCHER ||= Event->timer ( 3574 $RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2869 reentrant => 0,
2870 after => 0,
2871 data => WF_AUTOCANCEL,
2872 cb => sub {
2873 do_reload_perl; 3575 do_reload_perl;
2874 undef $RELOAD_WATCHER; 3576 undef $RELOAD_WATCHER;
2875 },
2876 ); 3577 };
2877} 3578}
2878 3579
2879register_command "reload" => sub { 3580register_command "reload" => sub {
2880 my ($who, $arg) = @_; 3581 my ($who, $arg) = @_;
2881 3582
2882 if ($who->flag (FLAG_WIZ)) { 3583 if ($who->flag (FLAG_WIZ)) {
2883 $who->message ("reloading server."); 3584 $who->message ("reloading server.");
3585 async {
3586 $Coro::current->{desc} = "perl_reload";
2884 async { reload_perl }; 3587 reload_perl;
3588 };
2885 } 3589 }
2886}; 3590};
2887 3591
2888unshift @INC, $LIBDIR; 3592unshift @INC, $LIBDIR;
2889 3593
2908 my $signal = new Coro::Signal; 3612 my $signal = new Coro::Signal;
2909 push @WAIT_FOR_TICK_BEGIN, $signal; 3613 push @WAIT_FOR_TICK_BEGIN, $signal;
2910 $signal->wait; 3614 $signal->wait;
2911} 3615}
2912 3616
2913 my $min = 1e6;#d# 3617$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
2914 my $avg = 10;
2915$TICK_WATCHER = Event->timer (
2916 reentrant => 0,
2917 parked => 1,
2918 prio => 0,
2919 at => $NEXT_TICK || $TICK,
2920 data => WF_AUTOCANCEL,
2921 cb => sub {
2922 if ($Coro::current != $Coro::main) { 3618 if ($Coro::current != $Coro::main) {
2923 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3619 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2924 unless ++$bug_warning > 10; 3620 unless ++$bug_warning > 10;
2925 return; 3621 return;
2926 } 3622 }
2927 3623
2928 $NOW = $tick_start = Event::time; 3624 $NOW = $tick_start = EV::now;
2929 3625
2930 cf::server_tick; # one server iteration 3626 cf::server_tick; # one server iteration
2931 3627
2932 0 && sync_job {#d# 3628 $RUNTIME += $TICK;
2933 for(1..10) { 3629 $NEXT_TICK = $_[0]->at;
2934 my $t = Event::time;
2935 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2936 or die;
2937 3630
2938 $map->width (50); 3631 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2939 $map->height (50); 3632 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2940 $map->alloc; 3633 Coro::async_pool {
2941 $map->_load_objects ("/tmp/x.map", 1); 3634 $Coro::current->{desc} = "runtime saver";
2942 my $t = Event::time - $t; 3635 write_runtime
2943 3636 or warn "ERROR: unable to write runtime file: $!";
2944 #next unless $t < 0.0013;#d#
2945 if ($t < $min) {
2946 $min = $t;
2947 }
2948 $avg = $avg * 0.99 + $t * 0.01;
2949 }
2950 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2951 exit 0;
2952 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2953 }; 3637 };
3638 }
2954 3639
2955 $RUNTIME += $TICK;
2956 $NEXT_TICK += $TICK;
2957
2958 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2959 $NEXT_RUNTIME_WRITE = $NOW + 10;
2960 Coro::async_pool {
2961 write_runtime
2962 or warn "ERROR: unable to write runtime file: $!";
2963 };
2964 }
2965
2966# my $AFTER = Event::time;
2967# warn $AFTER - $NOW;#d#
2968
2969 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3640 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2970 $sig->send; 3641 $sig->send;
2971 } 3642 }
2972 while (my $sig = shift @WAIT_FOR_TICK) { 3643 while (my $sig = shift @WAIT_FOR_TICK) {
2973 $sig->send; 3644 $sig->send;
2974 } 3645 }
2975 3646
2976 $NOW = Event::time;
2977
2978 # if we are delayed by four ticks or more, skip them all
2979 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2980
2981 $TICK_WATCHER->at ($NEXT_TICK);
2982 $TICK_WATCHER->start;
2983
2984 $LOAD = ($NOW - $tick_start) / $TICK; 3647 $LOAD = ($NOW - $tick_start) / $TICK;
2985 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25; 3648 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2986 3649
2987 _post_tick; 3650 _post_tick;
2988 3651};
2989 3652$TICK_WATCHER->priority (EV::MAXPRI);
2990 },
2991);
2992 3653
2993{ 3654{
2994 BDB::max_poll_time $TICK * 0.1; 3655 # configure BDB
2995 $BDB_POLL_WATCHER = Event->io ( 3656
2996 reentrant => 0,
2997 fd => BDB::poll_fileno,
2998 poll => 'r',
2999 prio => 0,
3000 data => WF_AUTOCANCEL,
3001 cb => \&BDB::poll_cb,
3002 );
3003 BDB::min_parallel 8; 3657 BDB::min_parallel 8;
3004 3658 BDB::max_poll_reqs $TICK * 0.1;
3005 BDB::set_sync_prepare { 3659 $Coro::BDB::WATCHER->priority (1);
3006 my $status;
3007 my $current = $Coro::current;
3008 (
3009 sub {
3010 $status = $!;
3011 $current->ready; undef $current;
3012 },
3013 sub {
3014 Coro::schedule while defined $current;
3015 $! = $status;
3016 },
3017 )
3018 };
3019 3660
3020 unless ($DB_ENV) { 3661 unless ($DB_ENV) {
3021 $DB_ENV = BDB::db_env_create; 3662 $DB_ENV = BDB::db_env_create;
3663 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3664 | BDB::LOG_AUTOREMOVE, 1);
3665 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3666 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3022 3667
3023 cf::sync_job { 3668 cf::sync_job {
3024 eval { 3669 eval {
3025 BDB::db_env_open 3670 BDB::db_env_open
3026 $DB_ENV, 3671 $DB_ENV,
3028 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3673 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3029 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3674 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3030 0666; 3675 0666;
3031 3676
3032 cf::cleanup "db_env_open($BDBDIR): $!" if $!; 3677 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3033
3034 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3035 $DB_ENV->set_lk_detect;
3036 }; 3678 };
3037 3679
3038 cf::cleanup "db_env_open(db): $@" if $@; 3680 cf::cleanup "db_env_open(db): $@" if $@;
3039 }; 3681 };
3040 } 3682 }
3683
3684 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3685 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3686 };
3687 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3688 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3689 };
3690 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3691 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3692 };
3041} 3693}
3042 3694
3043{ 3695{
3696 # configure IO::AIO
3697
3044 IO::AIO::min_parallel 8; 3698 IO::AIO::min_parallel 8;
3045
3046 undef $Coro::AIO::WATCHER;
3047 IO::AIO::max_poll_time $TICK * 0.1; 3699 IO::AIO::max_poll_time $TICK * 0.1;
3048 $AIO_POLL_WATCHER = Event->io ( 3700 $Coro::AIO::WATCHER->priority (1);
3049 reentrant => 0,
3050 data => WF_AUTOCANCEL,
3051 fd => IO::AIO::poll_fileno,
3052 poll => 'r',
3053 prio => 6,
3054 cb => \&IO::AIO::poll_cb,
3055 );
3056} 3701}
3057 3702
3058my $_log_backtrace; 3703my $_log_backtrace;
3059 3704
3060sub _log_backtrace { 3705sub _log_backtrace {
3064 3709
3065 # limit the # of concurrent backtraces 3710 # limit the # of concurrent backtraces
3066 if ($_log_backtrace < 2) { 3711 if ($_log_backtrace < 2) {
3067 ++$_log_backtrace; 3712 ++$_log_backtrace;
3068 async { 3713 async {
3714 $Coro::current->{desc} = "abt $msg";
3715
3069 my @bt = fork_call { 3716 my @bt = fork_call {
3070 @addr = map { sprintf "%x", $_ } @addr; 3717 @addr = map { sprintf "%x", $_ } @addr;
3071 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X; 3718 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3072 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |" 3719 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3073 or die "addr2line: $!"; 3720 or die "addr2line: $!";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines