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.276 by root, Sun Jun 10 04:05:47 2007 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 2007 UTC

10use Event; 10use Event;
11use Opcode; 11use Opcode;
12use Safe; 12use Safe;
13use Safe::Hole; 13use Safe::Hole;
14 14
15use Coro 3.61 (); 15use Coro 3.64 ();
16use Coro::State; 16use Coro::State;
17use Coro::Handle; 17use Coro::Handle;
18use Coro::Event; 18use Coro::Event;
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::Storable; 23use Coro::Storable;
24use Coro::Util ();
24 25
26use JSON::XS ();
25use BDB (); 27use BDB ();
26use Data::Dumper; 28use Data::Dumper;
27use Digest::MD5; 29use Digest::MD5;
28use Fcntl; 30use Fcntl;
29use YAML::Syck (); 31use YAML::Syck ();
30use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
31use Time::HiRes; 33use Time::HiRes;
32use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
33 36
34# configure various modules to our taste 37# configure various modules to our taste
35# 38#
36$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 52our %COMMAND = ();
50our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
51 54
52our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
56 60
57our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
58our @EVENT; 62our @EVENT;
76our $NEXT_TICK; 80our $NEXT_TICK;
77our $NOW; 81our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off 82our $USE_FSYNC = 1; # use fsync to write maps - default off
79 83
80our $BDB_POLL_WATCHER; 84our $BDB_POLL_WATCHER;
85our $BDB_DEADLOCK_WATCHER;
86our $BDB_CHECKPOINT_WATCHER;
87our $BDB_TRICKLE_WATCHER;
81our $DB_ENV; 88our $DB_ENV;
82 89
83our %CFG; 90our %CFG;
84 91
85our $UPTIME; $UPTIME ||= time; 92our $UPTIME; $UPTIME ||= time;
86our $RUNTIME; 93our $RUNTIME;
87 94
88our %PLAYER; # all users 95our (%PLAYER, %PLAYER_LOADING); # all users
89our %MAP; # all maps 96our (%MAP, %MAP_LOADING ); # all maps
90our $LINK_MAP; # the special {link} map, which is always available 97our $LINK_MAP; # the special {link} map, which is always available
91 98
92# used to convert map paths into valid unix filenames by replacing / by ∕ 99# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 100our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94 101
164 171
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 172These 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 173returns 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. 174per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 175
176=item @cf::INVOKE_RESULTS
177
178This array contains the results of the last C<invoke ()> call. When
179C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
180that call.
181
169=back 182=back
170 183
171=cut 184=cut
172 185
173BEGIN { 186BEGIN {
177 $msg .= "\n" 190 $msg .= "\n"
178 unless $msg =~ /\n$/; 191 unless $msg =~ /\n$/;
179 192
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge; 193 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181 194
182 utf8::encode $msg;
183 LOG llevError, $msg; 195 LOG llevError, $msg;
184 }; 196 };
185} 197}
186 198
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 199@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
206} 218}
207 219
208$Event::DIED = sub { 220$Event::DIED = sub {
209 warn "error in event callback: @_"; 221 warn "error in event callback: @_";
210}; 222};
223
224#############################################################################
211 225
212=head2 UTILITY FUNCTIONS 226=head2 UTILITY FUNCTIONS
213 227
214=over 4 228=over 4
215 229
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 248 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 249 $d
236 } || "[unable to dump $_[0]: '$@']"; 250 } || "[unable to dump $_[0]: '$@']";
237} 251}
238 252
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 253=item $ref = cf::from_json $json
242 254
243Converts a JSON string into the corresponding perl data structure. 255Converts a JSON string into the corresponding perl data structure.
244 256
245=item $json = cf::to_json $ref 257=item $json = cf::to_json $ref
246 258
247Converts a perl data structure into its JSON representation. 259Converts a perl data structure into its JSON representation.
260
261=cut
262
263our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
264
265sub to_json ($) { $json_coder->encode ($_[0]) }
266sub from_json ($) { $json_coder->decode ($_[0]) }
248 267
249=item cf::lock_wait $string 268=item cf::lock_wait $string
250 269
251Wait until the given lock is available. See cf::lock_acquire. 270Wait until the given lock is available. See cf::lock_acquire.
252 271
255Wait until the given lock is available and then acquires it and returns 274Wait 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, 275a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257for example when the coroutine gets canceled), the lock is automatically 276for example when the coroutine gets canceled), the lock is automatically
258returned. 277returned.
259 278
279Locks are *not* recursive, locking from the same coro twice results in a
280deadlocked coro.
281
260Lock names should begin with a unique identifier (for example, cf::map::find 282Lock names should begin with a unique identifier (for example, cf::map::find
261uses map_find and cf::map::load uses map_load). 283uses map_find and cf::map::load uses map_load).
262 284
263=item $locked = cf::lock_active $string 285=item $locked = cf::lock_active $string
264 286
265Return true if the lock is currently active, i.e. somebody has locked it. 287Return true if the lock is currently active, i.e. somebody has locked it.
266 288
267=cut 289=cut
268 290
269our %LOCK; 291our %LOCK;
292our %LOCKER;#d#
270 293
271sub lock_wait($) { 294sub lock_wait($) {
272 my ($key) = @_; 295 my ($key) = @_;
296
297 if ($LOCKER{$key} == $Coro::current) {#d#
298 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
299 return;#d#
300 }#d#
273 301
274 # wait for lock, if any 302 # wait for lock, if any
275 while ($LOCK{$key}) { 303 while ($LOCK{$key}) {
276 push @{ $LOCK{$key} }, $Coro::current; 304 push @{ $LOCK{$key} }, $Coro::current;
277 Coro::schedule; 305 Coro::schedule;
283 311
284 # wait, to be sure we are not locked 312 # wait, to be sure we are not locked
285 lock_wait $key; 313 lock_wait $key;
286 314
287 $LOCK{$key} = []; 315 $LOCK{$key} = [];
316 $LOCKER{$key} = $Coro::current;#d#
288 317
289 Coro::guard { 318 Coro::guard {
319 delete $LOCKER{$key};#d#
290 # wake up all waiters, to be on the safe side 320 # wake up all waiters, to be on the safe side
291 $_->ready for @{ delete $LOCK{$key} }; 321 $_->ready for @{ delete $LOCK{$key} };
292 } 322 }
293} 323}
294 324
306 }; 336 };
307 $TICK_WATCHER->stop; 337 $TICK_WATCHER->stop;
308 $guard 338 $guard
309} 339}
310 340
341=item cf::get_slot $time[, $priority[, $name]]
342
343Allocate $time seconds of blocking CPU time at priority C<$priority>:
344This call blocks and returns only when you have at least C<$time> seconds
345of cpu time till the next tick. The slot is only valid till the next cede.
346
347The optional C<$name> can be used to identify the job to run. It might be
348used for statistical purposes and should identify the same time-class.
349
350Useful for short background jobs.
351
352=cut
353
354our @SLOT_QUEUE;
355our $SLOT_QUEUE;
356
357$SLOT_QUEUE->cancel if $SLOT_QUEUE;
358$SLOT_QUEUE = Coro::async {
359 my $signal = new Coro::Signal;
360
361 while () {
362 next_job:
363 my $avail = cf::till_tick;
364 if ($avail > 0.01) {
365 for (0 .. $#SLOT_QUEUE) {
366 if ($SLOT_QUEUE[$_][0] < $avail) {
367 my $job = splice @SLOT_QUEUE, $_, 1, ();
368 $job->[2]->send;
369 Coro::cede;
370 goto next_job;
371 }
372 }
373 }
374
375 if (@SLOT_QUEUE) {
376 # we do not use wait_For_tick() as it returns immediately when tick is inactive
377 push @cf::WAIT_FOR_TICK, $signal;
378 $signal->wait;
379 } else {
380 Coro::schedule;
381 }
382 }
383};
384
385sub get_slot($;$$) {
386 my ($time, $pri, $name) = @_;
387
388 $time = $TICK * .6 if $time > $TICK * .6;
389 my $sig = new Coro::Signal;
390
391 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
392 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
393 $SLOT_QUEUE->ready;
394 $sig->wait;
395}
396
311=item cf::async { BLOCK } 397=item cf::async { BLOCK }
312 398
313Currently the same as Coro::async_pool, meaning you cannot use 399Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 400C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 401thing you are allowed to do is call C<prio> on it.
318 404
319BEGIN { *async = \&Coro::async_pool } 405BEGIN { *async = \&Coro::async_pool }
320 406
321=item cf::sync_job { BLOCK } 407=item cf::sync_job { BLOCK }
322 408
323The design of crossfire+ requires that the main coro ($Coro::main) is 409The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 410is always able to handle events or runnable, as Crossfire TRT is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 411partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
412acceptable.
326 413
327If it must be done, put the blocking parts into C<sync_job>. This will run 414If 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 415the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 416server will be frozen during this time, so the block should either finish
330fast or be very important. 417fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 477 $EXT_CORO{$coro+0} = $coro;
391 478
392 $coro 479 $coro
393} 480}
394 481
395sub write_runtime { 482=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 483
398 # first touch the runtime file to show we are still running: 484Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 485process, returning the results. Everything must be serialisable with
486Coro::Storable. May, of course, block. Note that the executed sub may
487never block itself or use any form of Event handling.
400 488
401 IO::AIO::aio_utime $runtime, undef, undef; 489=cut
402 490
403 my $guard = cf::lock_acquire "write_runtime"; 491sub fork_call(&@) {
492 my ($cb, @args) = @_;
404 493
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 494 # we seemingly have to make a local copy of the whole thing,
406 or return; 495 # otherwise perl prematurely frees the stuff :/
496 # TODO: investigate and fix (likely this will be rather laborious)
407 497
408 my $value = $cf::RUNTIME + 90 + 10; 498 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 499 reset_signals;
410 # 60 allows for the watchdog to kill the server. 500 &$cb
501 }, @args;
411 502
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 503 wantarray ? @res : $res[-1]
413 and return; 504}
414 505
415 # always fsync - this file is important 506=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 507
419 # touch it again to show we are up-to-date 508Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 509
422 close $fh 510=item cf::db_put $family => $key => $value
423 or return;
424 511
425 aio_rename "$runtime~", $runtime 512Stores the given C<$value> in the family. It can currently store binary
426 and return; 513data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 514
428 warn "runtime file written.\n"; 515=item $db = cf::db_table "name"
429 516
517Create and/or open a new database table. The string must not be "db" and must be unique
518within each server.
519
520=cut
521
522sub db_table($) {
523 my ($name) = @_;
524 my $db = BDB::db_create $DB_ENV;
525
526 eval {
527 $db->set_flags (BDB::CHKSUM);
528
529 utf8::encode $name;
530 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
531 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
532 cf::cleanup "db_open(db): $!" if $!;
533 };
534 cf::cleanup "db_open(db): $@" if $@;
535
536 $db
537}
538
539our $DB;
540
541sub db_init {
542 cf::sync_job {
543 $DB ||= db_table "db";
544 };
545}
546
547sub db_get($$) {
548 my $key = "$_[0]/$_[1]";
549
550 cf::sync_job {
551 BDB::db_get $DB, undef, $key, my $data;
552
553 $! ? ()
554 : $data
430 1 555 }
556}
557
558sub db_put($$$) {
559 BDB::dbreq_pri 4;
560 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
561}
562
563=item cf::cache $id => [$paths...], $processversion => $process
564
565Generic caching function that returns the value of the resource $id,
566caching and regenerating as required.
567
568This function can block.
569
570=cut
571
572sub cache {
573 my ($id, $src, $processversion, $process) = @_;
574
575 my $meta =
576 join "\x00",
577 $processversion,
578 map {
579 aio_stat $_
580 and Carp::croak "$_: $!";
581
582 ($_, (stat _)[7,9])
583 } @$src;
584
585 my $dbmeta = db_get cache => "$id/meta";
586 if ($dbmeta ne $meta) {
587 # changed, we may need to process
588
589 my @data;
590 my $md5;
591
592 for (0 .. $#$src) {
593 0 <= aio_load $src->[$_], $data[$_]
594 or Carp::croak "$src->[$_]: $!";
595 }
596
597 # if processing is expensive, check
598 # checksum first
599 if (1) {
600 $md5 =
601 join "\x00",
602 $processversion,
603 map {
604 cf::cede_to_tick;
605 ($src->[$_], Digest::MD5::md5_hex $data[$_])
606 } 0.. $#$src;
607
608
609 my $dbmd5 = db_get cache => "$id/md5";
610 if ($dbmd5 eq $md5) {
611 db_put cache => "$id/meta", $meta;
612
613 return db_get cache => "$id/data";
614 }
615 }
616
617 my $t1 = Time::HiRes::time;
618 my $data = $process->(\@data);
619 my $t2 = Time::HiRes::time;
620
621 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
622
623 db_put cache => "$id/data", $data;
624 db_put cache => "$id/md5" , $md5;
625 db_put cache => "$id/meta", $meta;
626
627 return $data;
628 }
629
630 db_get cache => "$id/data"
431} 631}
432 632
433=item cf::datalog type => key => value, ... 633=item cf::datalog type => key => value, ...
434 634
435Log a datalog packet of the given type with the given key-value pairs. 635Log 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") 653attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 654to it. All such attachable objects support the following methods.
455 655
456In the following description, CLASS can be any of C<global>, C<object> 656In 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 657C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 658Crossfire TRT).
459 659
460=over 4 660=over 4
461 661
462=item $attachable->attach ($attachment, key => $value...) 662=item $attachable->attach ($attachment, key => $value...)
463 663
665 _attach $registry, $klass, @attach; 865 _attach $registry, $klass, @attach;
666 } 866 }
667 867
668 $obj->{$name} = \%arg; 868 $obj->{$name} = \%arg;
669 } else { 869 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 870 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 871 }
672 872
673 $obj->{_attachment}{$name} = undef; 873 $obj->{_attachment}{$name} = undef;
674} 874}
675 875
715 "; 915 ";
716 die if $@; 916 die if $@;
717} 917}
718 918
719our $override; 919our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 920our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 921
722sub override { 922sub override {
723 $override = 1; 923 $override = 1;
724 @invoke_results = (); 924 @INVOKE_RESULTS = (@_);
725} 925}
726 926
727sub do_invoke { 927sub do_invoke {
728 my $event = shift; 928 my $event = shift;
729 my $callbacks = shift; 929 my $callbacks = shift;
730 930
731 @invoke_results = (); 931 @INVOKE_RESULTS = ();
732 932
733 local $override; 933 local $override;
734 934
735 for (@$callbacks) { 935 for (@$callbacks) {
736 eval { &{$_->[1]} }; 936 eval { &{$_->[1]} };
753 953
754Generate an object-specific event with the given arguments. 954Generate an object-specific event with the given arguments.
755 955
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 956This 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 957removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 958results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 959
760=back 960=back
761 961
762=cut 962=cut
763 963
764############################################################################# 964#############################################################################
765# object support 965# object support
966#
967
968sub _can_merge {
969 my ($ob1, $ob2) = @_;
970
971 local $Storable::canonical = 1;
972 my $fob1 = Storable::freeze $ob1;
973 my $fob2 = Storable::freeze $ob2;
974
975 $fob1 eq $fob2
976}
766 977
767sub reattach { 978sub reattach {
768 # basically do the same as instantiate, without calling instantiate 979 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 980 my ($obj) = @_;
770 981
817sub object_freezer_save { 1028sub object_freezer_save {
818 my ($filename, $rdata, $objs) = @_; 1029 my ($filename, $rdata, $objs) = @_;
819 1030
820 sync_job { 1031 sync_job {
821 if (length $$rdata) { 1032 if (length $$rdata) {
1033 utf8::decode (my $decname = $filename);
822 warn sprintf "saving %s (%d,%d)\n", 1034 warn sprintf "saving %s (%d,%d)\n",
823 $filename, length $$rdata, scalar @$objs; 1035 $decname, length $$rdata, scalar @$objs;
824 1036
825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1037 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826 chmod SAVE_MODE, $fh; 1038 chmod SAVE_MODE, $fh;
827 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1039 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828 aio_fsync $fh if $cf::USE_FSYNC; 1040 aio_fsync $fh if $cf::USE_FSYNC;
847 } 1059 }
848 } else { 1060 } else {
849 aio_unlink $filename; 1061 aio_unlink $filename;
850 aio_unlink "$filename.pst"; 1062 aio_unlink "$filename.pst";
851 } 1063 }
852 } 1064 };
853} 1065}
854 1066
855sub object_freezer_as_string { 1067sub object_freezer_as_string {
856 my ($rdata, $objs) = @_; 1068 my ($rdata, $objs) = @_;
857 1069
869 or return; 1081 or return;
870 1082
871 unless (aio_stat "$filename.pst") { 1083 unless (aio_stat "$filename.pst") {
872 (aio_load "$filename.pst", $av) >= 0 1084 (aio_load "$filename.pst", $av) >= 0
873 or return; 1085 or return;
1086
874 $av = eval { (Storable::thaw $av)->{objs} }; 1087 $av = eval { (Storable::thaw $av)->{objs} };
875 } 1088 }
876 1089
1090 utf8::decode (my $decname = $filename);
877 warn sprintf "loading %s (%d)\n", 1091 warn sprintf "loading %s (%d,%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1092 $decname, length $data, scalar @{$av || []};
1093
879 return ($data, $av); 1094 ($data, $av)
880} 1095}
1096
1097=head2 COMMAND CALLBACKS
1098
1099=over 4
1100
1101=cut
881 1102
882############################################################################# 1103#############################################################################
883# command handling &c 1104# command handling &c
884 1105
885=item cf::register_command $name => \&callback($ob,$args); 1106=item cf::register_command $name => \&callback($ob,$args);
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1119 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1120}
900 1121
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1122=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1123
903Register a callbackf ro execution when the client sends an extcmd packet. 1124Register a callback for execution when the client sends an (synchronous)
1125extcmd packet. Ext commands will be processed in the order they are
1126received by the server, like other user commands. The first argument is
1127the logged-in player. Ext commands can only be processed after a player
1128has logged in successfully.
904 1129
905If the callback returns something, it is sent back as if reply was being 1130If the callback returns something, it is sent back as if reply was being
906called. 1131called.
907 1132
1133=item cf::register_exticmd $name => \&callback($ns,$packet);
1134
1135Register a callback for execution when the client sends an (asynchronous)
1136exticmd packet. Exti commands are processed by the server as soon as they
1137are received, i.e. out of order w.r.t. other commands. The first argument
1138is a client socket. Exti commands can be received anytime, even before
1139log-in.
1140
1141If the callback returns something, it is sent back as if reply was being
1142called.
1143
908=cut 1144=cut
909 1145
910sub register_extcmd { 1146sub register_extcmd {
911 my ($name, $cb) = @_; 1147 my ($name, $cb) = @_;
912 1148
913 $EXTCMD{$name} = $cb; 1149 $EXTCMD{$name} = $cb;
1150}
1151
1152sub register_exticmd {
1153 my ($name, $cb) = @_;
1154
1155 $EXTICMD{$name} = $cb;
914} 1156}
915 1157
916cf::player->attach ( 1158cf::player->attach (
917 on_command => sub { 1159 on_command => sub {
918 my ($pl, $name, $params) = @_; 1160 my ($pl, $name, $params) = @_;
927 cf::override; 1169 cf::override;
928 }, 1170 },
929 on_extcmd => sub { 1171 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1172 my ($pl, $buf) = @_;
931 1173
932 my $msg = eval { from_json $buf }; 1174 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1175
934 if (ref $msg) { 1176 if (ref $msg) {
1177 my ($type, $reply, @payload) =
1178 "ARRAY" eq ref $msg
1179 ? @$msg
1180 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1181
1182 my @reply;
1183
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1184 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1185 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1186 }
1187
1188 $pl->ext_reply ($reply, @reply)
1189 if $reply;
1190
940 } else { 1191 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1192 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1193 }
943 1194
944 cf::override; 1195 cf::override;
945 }, 1196 },
946); 1197);
947 1198
948sub load_extension {
949 my ($path) = @_;
950
951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 my $base = $1;
953 my $pkg = $1;
954 $pkg =~ s/[^[:word:]]/_/g;
955 $pkg = "ext::$pkg";
956
957 warn "... loading '$path' into '$pkg'\n";
958
959 open my $fh, "<:utf8", $path
960 or die "$path: $!";
961
962 my $source =
963 "package $pkg; use strict; use utf8;\n"
964 . "#line 1 \"$path\"\n{\n"
965 . (do { local $/; <$fh> })
966 . "\n};\n1";
967
968 unless (eval $source) {
969 my $msg = $@ ? "$path: $@\n"
970 : "extension disabled.\n";
971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972 warn $@;
973 warn "mandatory extension failed to load, exiting.\n";
974 exit 1;
975 }
976 die $@;
977 }
978
979 push @EXTS, $pkg;
980}
981
982sub load_extensions { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
983 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1204 next unless -r $path;
985 eval { 1205
986 load_extension $ext; 1206 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1207 my $base = $1;
1208 my $pkg = $1;
1209 $pkg =~ s/[^[:word:]]/_/g;
1210 $pkg = "ext::$pkg";
1211
1212 open my $fh, "<:utf8", $path
1213 or die "$path: $!";
1214
1215 my $source = do { local $/; <$fh> };
1216
1217 my %ext = (
1218 path => $path,
1219 base => $base,
1220 pkg => $pkg,
1221 );
1222
1223 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1224 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1225
1226 $ext{source} =
1227 "package $pkg; use strict; use utf8;\n"
1228 . "#line 1 \"$path\"\n{\n"
1229 . $source
1230 . "\n};\n1";
1231
1232 $todo{$base} = \%ext;
1233 }
1234
1235 my %done;
1236 while (%todo) {
1237 my $progress;
1238
1239 while (my ($k, $v) = each %todo) {
1240 for (split /,\s*/, $v->{meta}{depends}) {
1241 goto skip
1242 unless exists $done{$_};
1243 }
1244
1245 warn "... loading '$k' into '$v->{pkg}'\n";
1246
1247 unless (eval $v->{source}) {
1248 my $msg = $@ ? "$v->{path}: $@\n"
1249 : "$v->{base}: extension inactive.\n";
1250
1251 if (exists $v->{meta}{mandatory}) {
1252 warn $msg;
1253 warn "mandatory extension failed to load, exiting.\n";
1254 exit 1;
1255 }
1256
1257 warn $msg;
1258 }
1259
1260 $done{$k} = delete $todo{$k};
1261 push @EXTS, $v->{pkg};
1262 $progress = 1;
987 1 1263 }
988 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
989 } 1269 };
990} 1270}
991 1271
992############################################################################# 1272#############################################################################
993 1273
1274=back
1275
994=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
995 1277
996Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
997 1279
998=cut 1280=cut
1002use Coro::AIO; 1284use Coro::AIO;
1003 1285
1004=head3 cf::player 1286=head3 cf::player
1005 1287
1006=over 4 1288=over 4
1289
1290=item cf::player::num_playing
1291
1292Returns the official number of playing players, as per the Crossfire metaserver rules.
1293
1294=cut
1295
1296sub num_playing {
1297 scalar grep
1298 $_->ob->map
1299 && !$_->hidden
1300 && !$_->ob->flag (cf::FLAG_WIZ),
1301 cf::player::list
1302}
1007 1303
1008=item cf::player::find $login 1304=item cf::player::find $login
1009 1305
1010Returns the given player object, loading it if necessary (might block). 1306Returns the given player object, loading it if necessary (might block).
1011 1307
1047 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1343 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1048 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1344 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1049 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1345 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1050 aio_unlink +(playerdir $login) . "/$login.pl"; 1346 aio_unlink +(playerdir $login) . "/$login.pl";
1051 1347
1052 my $pl = load_pl path $login 1348 my $f = new_from_file cf::object::thawer path $login
1053 or return; 1349 or return;
1350
1351 my $pl = cf::player::load_pl $f
1352 or return;
1353 local $cf::PLAYER_LOADING{$login} = $pl;
1354 $f->resolve_delayed_derefs;
1054 $cf::PLAYER{$login} = $pl 1355 $cf::PLAYER{$login} = $pl
1055 } 1356 }
1056 } 1357 }
1057} 1358}
1058 1359
1068 1369
1069 aio_mkdir playerdir $pl, 0770; 1370 aio_mkdir playerdir $pl, 0770;
1070 $pl->{last_save} = $cf::RUNTIME; 1371 $pl->{last_save} = $cf::RUNTIME;
1071 1372
1072 $pl->save_pl ($path); 1373 $pl->save_pl ($path);
1073 Coro::cede; 1374 cf::cede_to_tick;
1074} 1375}
1075 1376
1076sub new($) { 1377sub new($) {
1077 my ($login) = @_; 1378 my ($login) = @_;
1078 1379
1082 $self->{deny_save} = 1; 1383 $self->{deny_save} = 1;
1083 1384
1084 $cf::PLAYER{$login} = $self; 1385 $cf::PLAYER{$login} = $self;
1085 1386
1086 $self 1387 $self
1388}
1389
1390=item $player->send_msg ($channel, $msg, $color, [extra...])
1391
1392=cut
1393
1394sub send_msg {
1395 my $ns = shift->ns
1396 or return;
1397 $ns->send_msg (@_);
1087} 1398}
1088 1399
1089=item $pl->quit_character 1400=item $pl->quit_character
1090 1401
1091Nukes the player without looking back. If logged in, the connection will 1402Nukes the player without looking back. If logged in, the connection will
1146 or return []; 1457 or return [];
1147 1458
1148 my @logins; 1459 my @logins;
1149 1460
1150 for my $login (@$dirs) { 1461 for my $login (@$dirs) {
1462 my $path = path $login;
1463
1464 # a .pst is a dead give-away for a valid player
1465 unless (-e "$path.pst") {
1151 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1466 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1152 aio_read $fh, 0, 512, my $buf, 0 or next; 1467 aio_read $fh, 0, 512, my $buf, 0 or next;
1153 $buf !~ /^password -------------$/m or next; # official not-valid tag 1468 $buf !~ /^password -------------$/m or next; # official not-valid tag
1469 }
1154 1470
1155 utf8::decode $login; 1471 utf8::decode $login;
1156 push @logins, $login; 1472 push @logins, $login;
1157 } 1473 }
1158 1474
1185 } 1501 }
1186 1502
1187 \@paths 1503 \@paths
1188} 1504}
1189 1505
1506=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1507
1508Expand crossfire pod fragments into protocol xml.
1509
1510=cut
1511
1512sub expand_cfpod {
1513 ((my $self), (local $_)) = @_;
1514
1515 # escape & and <
1516 s/&/&amp;/g;
1517 s/(?<![BIUGHT])</&lt;/g;
1518
1519 # this is buggy, it needs to properly take care of nested <'s
1520
1521 1 while
1522 # replace B<>, I<>, U<> etc.
1523 s/B<([^\>]*)>/<b>$1<\/b>/
1524 || s/I<([^\>]*)>/<i>$1<\/i>/
1525 || s/U<([^\>]*)>/<u>$1<\/u>/
1526 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1527 # replace G<male|female> tags
1528 || s{G<([^>|]*)\|([^>]*)>}{
1529 $self->gender ? $2 : $1
1530 }ge
1531 # replace H<hint text>
1532 || s{H<([^\>]*)>}
1533 {
1534 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1535 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1536 "")
1537 [$self->{hintmode}]
1538 }ge;
1539
1540 # create single paragraphs (very hackish)
1541 s/(?<=\S)\n(?=\w)/ /g;
1542
1543 # compress some whitespace
1544 s/\s+\n/\n/g; # ws line-ends
1545 s/\n\n+/\n/g; # double lines
1546 s/^\n+//; # beginning lines
1547 s/\n+$//; # ending lines
1548
1549 $_
1550}
1551
1552sub hintmode {
1553 $_[0]{hintmode} = $_[1] if @_ > 1;
1554 $_[0]{hintmode}
1555}
1556
1190=item $player->ext_reply ($msgid, %msg) 1557=item $player->ext_reply ($msgid, @msg)
1191 1558
1192Sends an ext reply to the player. 1559Sends an ext reply to the player.
1193 1560
1194=cut 1561=cut
1195 1562
1196sub ext_reply($$%) { 1563sub ext_reply($$@) {
1197 my ($self, $id, %msg) = @_; 1564 my ($self, $id, @msg) = @_;
1198 1565
1199 $msg{msgid} = $id; 1566 $self->ns->ext_reply ($id, @msg)
1200
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1567}
1203 1568
1204=item $player->ext_event ($type, %msg) 1569=item $player->ext_msg ($type, @msg)
1205 1570
1206Sends an ext event to the client. 1571Sends an ext event to the client.
1207 1572
1208=cut 1573=cut
1209 1574
1210sub ext_event($$%) { 1575sub ext_msg($$@) {
1211 my ($self, $type, %msg) = @_; 1576 my ($self, $type, @msg) = @_;
1212 1577
1213 $self->ns->ext_event ($type, %msg); 1578 $self->ns->ext_msg ($type, @msg);
1214} 1579}
1215 1580
1216=head3 cf::region 1581=head3 cf::region
1217 1582
1218=over 4 1583=over 4
1221 1586
1222package cf::region; 1587package cf::region;
1223 1588
1224=item cf::region::find_by_path $path 1589=item cf::region::find_by_path $path
1225 1590
1226Tries to decuce the probable region for a map knowing only its path. 1591Tries to decuce the likely region for a map knowing only its path.
1227 1592
1228=cut 1593=cut
1229 1594
1230sub find_by_path($) { 1595sub find_by_path($) {
1231 my ($path) = @_; 1596 my ($path) = @_;
1232 1597
1233 my ($match, $specificity); 1598 my ($match, $specificity);
1234 1599
1235 for my $region (list) { 1600 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1601 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1602 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1603 if $region->specificity > $specificity;
1239 } 1604 }
1240 } 1605 }
1241 1606
1361 $self->init; # pass $1 etc. 1726 $self->init; # pass $1 etc.
1362 return $self; 1727 return $self;
1363 } 1728 }
1364 } 1729 }
1365 1730
1366 Carp::carp "unable to resolve path '$path' (base '$base')."; 1731 Carp::cluck "unable to resolve path '$path' (base '$base').";
1367 () 1732 ()
1368} 1733}
1369 1734
1370sub init { 1735sub init {
1371 my ($self) = @_; 1736 my ($self) = @_;
1434 1799
1435sub load_header_from($) { 1800sub load_header_from($) {
1436 my ($self, $path) = @_; 1801 my ($self, $path) = @_;
1437 1802
1438 utf8::encode $path; 1803 utf8::encode $path;
1439 #aio_open $path, O_RDONLY, 0 1804 my $f = new_from_file cf::object::thawer $path
1440 # or return;
1441
1442 $self->_load_header ($path)
1443 or return; 1805 or return;
1806
1807 $self->_load_header ($f)
1808 or return;
1809
1810 local $MAP_LOADING{$self->{path}} = $self;
1811 $f->resolve_delayed_derefs;
1444 1812
1445 $self->{load_path} = $path; 1813 $self->{load_path} = $path;
1446 1814
1447 1 1815 1
1448} 1816}
1502sub find { 1870sub find {
1503 my ($path, $origin) = @_; 1871 my ($path, $origin) = @_;
1504 1872
1505 $path = normalise $path, $origin && $origin->path; 1873 $path = normalise $path, $origin && $origin->path;
1506 1874
1875 cf::lock_wait "map_data:$path";#d#remove
1507 cf::lock_wait "map_find:$path"; 1876 cf::lock_wait "map_find:$path";
1508 1877
1509 $cf::MAP{$path} || do { 1878 $cf::MAP{$path} || do {
1510 my $guard = cf::lock_acquire "map_find:$path"; 1879 my $guard1 = cf::lock_acquire "map_find:$path";
1880 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1881
1511 my $map = new_from_path cf::map $path 1882 my $map = new_from_path cf::map $path
1512 or return; 1883 or return;
1513 1884
1514 $map->{last_save} = $cf::RUNTIME; 1885 $map->{last_save} = $cf::RUNTIME;
1515 1886
1517 or return; 1888 or return;
1518 1889
1519 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?) 1890 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1520 # doing this can freeze the server in a sync job, obviously 1891 # doing this can freeze the server in a sync job, obviously
1521 #$cf::WAIT_FOR_TICK->wait; 1892 #$cf::WAIT_FOR_TICK->wait;
1893 undef $guard1;
1894 undef $guard2;
1522 $map->reset; 1895 $map->reset;
1523 undef $guard;
1524 return find $path; 1896 return find $path;
1525 } 1897 }
1526 1898
1527 $cf::MAP{$path} = $map 1899 $cf::MAP{$path} = $map
1528 } 1900 }
1537 local $self->{deny_reset} = 1; # loading can take a long time 1909 local $self->{deny_reset} = 1; # loading can take a long time
1538 1910
1539 my $path = $self->{path}; 1911 my $path = $self->{path};
1540 1912
1541 { 1913 {
1542 my $guard = cf::lock_acquire "map_load:$path"; 1914 my $guard = cf::lock_acquire "map_data:$path";
1543 1915
1916 return unless $self->valid;
1544 return if $self->in_memory != cf::MAP_SWAPPED; 1917 return unless $self->in_memory == cf::MAP_SWAPPED;
1545 1918
1546 $self->in_memory (cf::MAP_LOADING); 1919 $self->in_memory (cf::MAP_LOADING);
1547 1920
1548 $self->alloc; 1921 $self->alloc;
1549 1922
1550 $self->pre_load; 1923 $self->pre_load;
1551 Coro::cede; 1924 cf::cede_to_tick;
1552 1925
1926 my $f = new_from_file cf::object::thawer $self->{load_path};
1927 $f->skip_block;
1553 $self->_load_objects ($self->{load_path}, 1) 1928 $self->_load_objects ($f)
1554 or return; 1929 or return;
1555 1930
1556 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1931 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1557 if delete $self->{load_original}; 1932 if delete $self->{load_original};
1558 1933
1559 if (my $uniq = $self->uniq_path) { 1934 if (my $uniq = $self->uniq_path) {
1560 utf8::encode $uniq; 1935 utf8::encode $uniq;
1561 if (aio_open $uniq, O_RDONLY, 0) { 1936 unless (aio_stat $uniq) {
1937 if (my $f = new_from_file cf::object::thawer $uniq) {
1562 $self->clear_unique_items; 1938 $self->clear_unique_items;
1563 $self->_load_objects ($uniq, 0); 1939 $self->_load_objects ($f);
1940 $f->resolve_delayed_derefs;
1941 }
1564 } 1942 }
1565 } 1943 }
1566 1944
1567 Coro::cede; 1945 $f->resolve_delayed_derefs;
1946
1947 cf::cede_to_tick;
1568 # now do the right thing for maps 1948 # now do the right thing for maps
1569 $self->link_multipart_objects; 1949 $self->link_multipart_objects;
1570 $self->difficulty ($self->estimate_difficulty) 1950 $self->difficulty ($self->estimate_difficulty)
1571 unless $self->difficulty; 1951 unless $self->difficulty;
1572 Coro::cede; 1952 cf::cede_to_tick;
1573 1953
1574 unless ($self->{deny_activate}) { 1954 unless ($self->{deny_activate}) {
1575 $self->decay_objects; 1955 $self->decay_objects;
1576 $self->fix_auto_apply; 1956 $self->fix_auto_apply;
1577 $self->update_buttons; 1957 $self->update_buttons;
1578 Coro::cede; 1958 cf::cede_to_tick;
1579 $self->set_darkness_map; 1959 $self->set_darkness_map;
1580 Coro::cede; 1960 cf::cede_to_tick;
1581 $self->activate; 1961 $self->activate;
1582 } 1962 }
1963
1964 $self->{last_save} = $cf::RUNTIME;
1965 $self->last_access ($cf::RUNTIME);
1583 1966
1584 $self->in_memory (cf::MAP_IN_MEMORY); 1967 $self->in_memory (cf::MAP_IN_MEMORY);
1585 } 1968 }
1586 1969
1587 $self->post_load; 1970 $self->post_load;
1598 1981
1599 $self 1982 $self
1600} 1983}
1601 1984
1602# find and load all maps in the 3x3 area around a map 1985# find and load all maps in the 3x3 area around a map
1603sub load_diag { 1986sub load_neighbours {
1604 my ($map) = @_; 1987 my ($map) = @_;
1605 1988
1606 my @diag; # diagonal neighbours 1989 my @neigh; # diagonal neighbours
1607 1990
1608 for (0 .. 3) { 1991 for (0 .. 3) {
1609 my $neigh = $map->tile_path ($_) 1992 my $neigh = $map->tile_path ($_)
1610 or next; 1993 or next;
1611 $neigh = find $neigh, $map 1994 $neigh = find $neigh, $map
1612 or next; 1995 or next;
1613 $neigh->load; 1996 $neigh->load;
1614 1997
1998 push @neigh,
1615 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1999 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1616 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2000 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1617 } 2001 }
1618 2002
1619 for (@diag) { 2003 for (grep defined $_->[0], @neigh) {
2004 my ($path, $origin) = @$_;
1620 my $neigh = find @$_ 2005 my $neigh = find $path, $origin
1621 or next; 2006 or next;
1622 $neigh->load; 2007 $neigh->load;
1623 } 2008 }
1624} 2009}
1625 2010
1630} 2015}
1631 2016
1632sub do_load_sync { 2017sub do_load_sync {
1633 my ($map) = @_; 2018 my ($map) = @_;
1634 2019
2020 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2021 if $Coro::current == $Coro::main;
2022
1635 cf::sync_job { $map->load }; 2023 cf::sync_job { $map->load };
1636} 2024}
1637 2025
1638our %MAP_PREFETCH; 2026our %MAP_PREFETCH;
1639our $MAP_PREFETCHER = undef; 2027our $MAP_PREFETCHER = undef;
1640 2028
1641sub find_async { 2029sub find_async {
1642 my ($path, $origin) = @_; 2030 my ($path, $origin, $load) = @_;
1643 2031
1644 $path = normalise $path, $origin && $origin->{path}; 2032 $path = normalise $path, $origin && $origin->{path};
1645 2033
1646 if (my $map = $cf::MAP{$path}) { 2034 if (my $map = $cf::MAP{$path}) {
1647 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2035 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1648 } 2036 }
1649 2037
1650 undef $MAP_PREFETCH{$path}; 2038 $MAP_PREFETCH{$path} |= $load;
2039
1651 $MAP_PREFETCHER ||= cf::async { 2040 $MAP_PREFETCHER ||= cf::async {
1652 while (%MAP_PREFETCH) { 2041 while (%MAP_PREFETCH) {
1653 for my $path (keys %MAP_PREFETCH) { 2042 while (my ($k, $v) = each %MAP_PREFETCH) {
1654 my $map = find $path 2043 if (my $map = find $k) {
1655 or next;
1656 $map->load; 2044 $map->load if $v;
2045 }
1657 2046
1658 delete $MAP_PREFETCH{$path}; 2047 delete $MAP_PREFETCH{$k};
1659 } 2048 }
1660 } 2049 }
1661 undef $MAP_PREFETCHER; 2050 undef $MAP_PREFETCHER;
1662 }; 2051 };
1663 $MAP_PREFETCHER->prio (6); 2052 $MAP_PREFETCHER->prio (6);
1666} 2055}
1667 2056
1668sub save { 2057sub save {
1669 my ($self) = @_; 2058 my ($self) = @_;
1670 2059
1671 my $lock = cf::lock_acquire "map_data:" . $self->path; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1672 2061
1673 $self->{last_save} = $cf::RUNTIME; 2062 $self->{last_save} = $cf::RUNTIME;
1674 2063
1675 return unless $self->dirty; 2064 return unless $self->dirty;
1676 2065
1699 my ($self) = @_; 2088 my ($self) = @_;
1700 2089
1701 # save first because save cedes 2090 # save first because save cedes
1702 $self->save; 2091 $self->save;
1703 2092
1704 my $lock = cf::lock_acquire "map_data:" . $self->path; 2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
1705 2094
1706 return if $self->players; 2095 return if $self->players;
1707 return if $self->in_memory != cf::MAP_IN_MEMORY; 2096 return if $self->in_memory != cf::MAP_IN_MEMORY;
1708 return if $self->{deny_save}; 2097 return if $self->{deny_save};
1709 2098
2099 $self->in_memory (cf::MAP_SWAPPED);
2100
2101 $self->deactivate;
2102 $_->clear_links_to ($self) for values %cf::MAP;
1710 $self->clear; 2103 $self->clear;
1711 $self->in_memory (cf::MAP_SWAPPED);
1712} 2104}
1713 2105
1714sub reset_at { 2106sub reset_at {
1715 my ($self) = @_; 2107 my ($self) = @_;
1716 2108
1748 if $uniq; 2140 if $uniq;
1749 } 2141 }
1750 2142
1751 delete $cf::MAP{$self->path}; 2143 delete $cf::MAP{$self->path};
1752 2144
2145 $self->deactivate;
2146 $_->clear_links_to ($self) for values %cf::MAP;
1753 $self->clear; 2147 $self->clear;
1754
1755 $_->clear_links_to ($self) for values %cf::MAP;
1756 2148
1757 $self->unlink_save; 2149 $self->unlink_save;
1758 $self->destroy; 2150 $self->destroy;
1759} 2151}
1760 2152
1761my $nuke_counter = "aaaa"; 2153my $nuke_counter = "aaaa";
1762 2154
1763sub nuke { 2155sub nuke {
1764 my ($self) = @_; 2156 my ($self) = @_;
1765 2157
2158 {
2159 my $lock = cf::lock_acquire "map_data:$self->{path}";
2160
1766 delete $cf::MAP{$self->path}; 2161 delete $cf::MAP{$self->path};
1767 2162
1768 $self->unlink_save; 2163 $self->unlink_save;
1769 2164
1770 bless $self, "cf::map"; 2165 bless $self, "cf::map";
1771 delete $self->{deny_reset}; 2166 delete $self->{deny_reset};
1772 $self->{deny_save} = 1; 2167 $self->{deny_save} = 1;
1773 $self->reset_timeout (1); 2168 $self->reset_timeout (1);
1774 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2169 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1775 2170
1776 $cf::MAP{$self->path} = $self; 2171 $cf::MAP{$self->path} = $self;
2172 }
1777 2173
1778 $self->reset; # polite request, might not happen 2174 $self->reset; # polite request, might not happen
1779} 2175}
1780 2176
1781=item $maps = cf::map::tmp_maps 2177=item $maps = cf::map::tmp_maps
1782 2178
1783Returns an arrayref with all map paths of currently instantiated and saved 2179Returns an arrayref with all map paths of currently instantiated and saved
1784maps. 2180maps. May block.
1785 2181
1786=cut 2182=cut
1787 2183
1788sub tmp_maps() { 2184sub tmp_maps() {
1789 [ 2185 [
1790 map { 2186 map {
1791 utf8::decode $_; 2187 utf8::decode $_;
1792 !/\.(?:pst|meta)$/ && /^$PATH_SEP/o 2188 /\.map$/
1793 ? normalise $_ 2189 ? normalise $_
1794 : () 2190 : ()
1795 } @{ aio_readdir $TMPDIR or [] } 2191 } @{ aio_readdir $TMPDIR or [] }
1796 ] 2192 ]
1797} 2193}
1798 2194
2195=item $maps = cf::map::random_maps
2196
2197Returns an arrayref with all map paths of currently instantiated and saved
2198random maps. May block.
2199
2200=cut
2201
2202sub random_maps() {
2203 [
2204 map {
2205 utf8::decode $_;
2206 /\.map$/
2207 ? normalise "?random/$_"
2208 : ()
2209 } @{ aio_readdir $RANDOMDIR or [] }
2210 ]
2211}
2212
1799=item cf::map::unique_maps 2213=item cf::map::unique_maps
1800 2214
1801Returns an arrayref of paths of all shared maps that have 2215Returns an arrayref of paths of all shared maps that have
1802instantiated unique items. May block. 2216instantiated unique items. May block.
1803 2217
1805 2219
1806sub unique_maps() { 2220sub unique_maps() {
1807 [ 2221 [
1808 map { 2222 map {
1809 utf8::decode $_; 2223 utf8::decode $_;
1810 !/\.(?:pst|meta)$/ && /^$PATH_SEP/o 2224 /\.map$/
1811 ? normalise $_ 2225 ? normalise $_
1812 : () 2226 : ()
1813 } @{ aio_readdir $UNIQUEDIR or [] } 2227 } @{ aio_readdir $UNIQUEDIR or [] }
1814 ] 2228 ]
1815} 2229}
1837 map { $_, inv_recursive_ $_->inv } @_ 2251 map { $_, inv_recursive_ $_->inv } @_
1838} 2252}
1839 2253
1840sub inv_recursive { 2254sub inv_recursive {
1841 inv_recursive_ inv $_[0] 2255 inv_recursive_ inv $_[0]
2256}
2257
2258=item $ref = $ob->ref
2259
2260creates and returns a persistent reference to an objetc that can be stored as a string.
2261
2262=item $ob = cf::object::deref ($refstring)
2263
2264returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2265even if the object actually exists. May block.
2266
2267=cut
2268
2269sub deref {
2270 my ($ref) = @_;
2271
2272 # temporary compatibility#TODO#remove
2273 $ref =~ s{^<}{player/<};
2274
2275 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2276 my ($uuid, $name) = ($1, $2);
2277 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2278 or return;
2279 $pl->ob->uuid eq $uuid
2280 or return;
2281
2282 $pl->ob
2283 } else {
2284 warn "$ref: cannot resolve object reference\n";
2285 undef
2286 }
1842} 2287}
1843 2288
1844package cf; 2289package cf;
1845 2290
1846=back 2291=back
1865 2310
1866 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2311 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1867 2312
1868 if ($self->{record_replies}) { 2313 if ($self->{record_replies}) {
1869 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2314 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2315
1870 } else { 2316 } else {
2317 my $pl = $self->contr;
2318
2319 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2320 my $dialog = $pl->{npc_dialog};
2321 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2322
2323 } else {
1871 $msg = $npc->name . " says: $msg" if $npc; 2324 $msg = $npc->name . " says: $msg" if $npc;
1872 $self->message ($msg, $flags); 2325 $self->message ($msg, $flags);
2326 }
1873 } 2327 }
2328}
2329
2330=item $object->send_msg ($channel, $msg, $color, [extra...])
2331
2332=cut
2333
2334sub cf::object::send_msg {
2335 my $pl = shift->contr
2336 or return;
2337 $pl->send_msg (@_);
1874} 2338}
1875 2339
1876=item $player_object->may ("access") 2340=item $player_object->may ("access")
1877 2341
1878Returns wether the given player is authorized to access resource "access" 2342Returns wether the given player is authorized to access resource "access"
1957 # use -1 or undef as default coordinates, not 0, 0 2421 # use -1 or undef as default coordinates, not 0, 0
1958 ($x, $y) = ($map->enter_x, $map->enter_y) 2422 ($x, $y) = ($map->enter_x, $map->enter_y)
1959 if $x <=0 && $y <= 0; 2423 if $x <=0 && $y <= 0;
1960 2424
1961 $map->load; 2425 $map->load;
1962 $map->load_diag; 2426 $map->load_neighbours;
1963 2427
1964 return unless $self->contr->active; 2428 return unless $self->contr->active;
1965 $self->activate_recursive; 2429 $self->activate_recursive;
1966 2430
1967 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2431 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1968 $self->enter_map ($map, $x, $y); 2432 $self->enter_map ($map, $x, $y);
1969} 2433}
1970 2434
1971=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2435=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1972 2436
1973Moves the player to the given map-path and coordinates by first freezing 2437Moves the player to the given map-path and coordinates by first freezing
1974her, loading and preparing them map, calling the provided $check callback 2438her, loading and preparing them map, calling the provided $check callback
1975that has to return the map if sucecssful, and then unfreezes the player on 2439that has to return the map if sucecssful, and then unfreezes the player on
1976the new (success) or old (failed) map position. 2440the new (success) or old (failed) map position. In either case, $done will
2441be called at the end of this process.
1977 2442
1978=cut 2443=cut
1979 2444
1980our $GOTOGEN; 2445our $GOTOGEN;
1981 2446
1982sub cf::object::player::goto { 2447sub cf::object::player::goto {
1983 my ($self, $path, $x, $y, $check) = @_; 2448 my ($self, $path, $x, $y, $check, $done) = @_;
1984 2449
1985 # do generation counting so two concurrent goto's will be executed in-order 2450 # do generation counting so two concurrent goto's will be executed in-order
1986 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2451 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1987 2452
1988 $self->enter_link; 2453 $self->enter_link;
1989 2454
1990 (async { 2455 (async {
2456 # *tag paths override both path and x|y
2457 if ($path =~ /^\*(.*)$/) {
2458 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2459 my $ob = $obs[rand @obs];
2460
2461 # see if we actually can go there
2462 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2463 $ob = $obs[rand @obs];
2464 } else {
2465 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2466 }
2467 # else put us there anyways for now #d#
2468
2469 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2470 } else {
2471 ($path, $x, $y) = (undef, undef, undef);
2472 }
2473 }
2474
1991 my $map = eval { 2475 my $map = eval {
1992 my $map = cf::map::find $path; 2476 my $map = defined $path ? cf::map::find $path : undef;
1993 2477
1994 if ($map) { 2478 if ($map) {
1995 $map = $map->customise_for ($self); 2479 $map = $map->customise_for ($self);
1996 $map = $check->($map) if $check && $map; 2480 $map = $check->($map) if $check && $map;
1997 } else { 2481 } else {
1998 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2482 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
1999 } 2483 }
2000 2484
2001 $map 2485 $map
2002 }; 2486 };
2003 2487
2008 2492
2009 if ($gen == $self->{_goto_generation}) { 2493 if ($gen == $self->{_goto_generation}) {
2010 delete $self->{_goto_generation}; 2494 delete $self->{_goto_generation};
2011 $self->leave_link ($map, $x, $y); 2495 $self->leave_link ($map, $x, $y);
2012 } 2496 }
2497
2498 $done->() if $done;
2013 })->prio (1); 2499 })->prio (1);
2014} 2500}
2015 2501
2016=item $player_object->enter_exit ($exit_object) 2502=item $player_object->enter_exit ($exit_object)
2017 2503
2086 my $hp = $exit->stats->hp; 2572 my $hp = $exit->stats->hp;
2087 my $sp = $exit->stats->sp; 2573 my $sp = $exit->stats->sp;
2088 2574
2089 $self->enter_link; 2575 $self->enter_link;
2090 2576
2577 # if exit is damned, update players death & WoR home-position
2578 $self->contr->savebed ($slaying, $hp, $sp)
2579 if $exit->flag (FLAG_DAMNED);
2580
2091 (async { 2581 (async {
2092 $self->deactivate_recursive; # just to be sure 2582 $self->deactivate_recursive; # just to be sure
2093 unless (eval { 2583 unless (eval {
2094 $self->goto ($slaying, $hp, $sp); 2584 $self->goto ($slaying, $hp, $sp);
2095 2585
2122 2612
2123 utf8::encode $text; 2613 utf8::encode $text;
2124 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2614 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2125} 2615}
2126 2616
2617=item $client->send_msg ($channel, $msg, $color, [extra...])
2618
2619Send a drawinfo or msg packet to the client, formatting the msg for the
2620client if neccessary. C<$type> should be a string identifying the type of
2621the message, with C<log> being the default. If C<$color> is negative, suppress
2622the message unless the client supports the msg packet.
2623
2624=cut
2625
2626our %CHANNEL = (
2627 "c/identify" => {
2628 id => "identify",
2629 title => "Identify",
2630 reply => undef,
2631 tooltip => "Items recently identified",
2632 },
2633 "c/examine" => {
2634 id => "examine",
2635 title => "Examine",
2636 reply => undef,
2637 tooltip => "Signs and other items you examined",
2638 },
2639);
2640
2641sub cf::client::send_msg {
2642 my ($self, $channel, $msg, $color, @extra) = @_;
2643
2644 $msg = $self->pl->expand_cfpod ($msg);
2645
2646 $color &= cf::NDI_CLIENT_MASK; # just in case...
2647
2648 # check predefined channels, for the benefit of C
2649 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2650
2651 if (ref $channel) {
2652 # send meta info to client, if not yet sent
2653 unless (exists $self->{channel}{$channel->{id}}) {
2654 $self->{channel}{$channel->{id}} = $channel;
2655 $self->ext_msg (channel_info => $channel)
2656 if $self->can_msg;
2657 }
2658
2659 $channel = $channel->{id};
2660 }
2661
2662 return unless @extra || length $msg;
2663
2664 if ($self->can_msg) {
2665 # default colour, mask it out
2666 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2667 if $color & cf::NDI_DEF;
2668
2669 $self->send_packet ("msg " . $self->{json_coder}->encode (
2670 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2671 } else {
2672 if ($color >= 0) {
2673 # replace some tags by gcfclient-compatible ones
2674 for ($msg) {
2675 1 while
2676 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2677 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2678 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2679 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2680 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2681 }
2682
2683 $color &= cf::NDI_COLOR_MASK;
2684
2685 utf8::encode $msg;
2686
2687 if (0 && $msg =~ /\[/) {
2688 # COMMAND/INFO
2689 $self->send_packet ("drawextinfo $color 10 8 $msg")
2690 } else {
2691 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2692 $self->send_packet ("drawinfo $color $msg")
2693 }
2694 }
2695 }
2696}
2697
2127=item $client->ext_event ($type, %msg) 2698=item $client->ext_msg ($type, @msg)
2128 2699
2129Sends an exti event to the client. 2700Sends an ext event to the client.
2130 2701
2131=cut 2702=cut
2132 2703
2133sub cf::client::ext_event($$%) { 2704sub cf::client::ext_msg($$@) {
2134 my ($self, $type, %msg) = @_; 2705 my ($self, $type, @msg) = @_;
2135 2706
2707 if ($self->extcmd == 2) {
2708 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2709 } elsif ($self->extcmd == 1) { # TODO: remove
2136 $msg{msgtype} = "event_$type"; 2710 push @msg, msgtype => "event_$type";
2137 $self->send_packet ("ext " . cf::to_json \%msg); 2711 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2712 }
2713}
2714
2715=item $client->ext_reply ($msgid, @msg)
2716
2717Sends an ext reply to the client.
2718
2719=cut
2720
2721sub cf::client::ext_reply($$@) {
2722 my ($self, $id, @msg) = @_;
2723
2724 if ($self->extcmd == 2) {
2725 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2726 } elsif ($self->extcmd == 1) {
2727 #TODO: version 1, remove
2728 unshift @msg, msgtype => "reply", msgid => $id;
2729 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2730 }
2138} 2731}
2139 2732
2140=item $success = $client->query ($flags, "text", \&cb) 2733=item $success = $client->query ($flags, "text", \&cb)
2141 2734
2142Queues a query to the client, calling the given callback with 2735Queues a query to the client, calling the given callback with
2143the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2736the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2144C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2737C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2145 2738
2146Queries can fail, so check the return code. Or don't, as queries will become 2739Queries can fail, so check the return code. Or don't, as queries will
2147reliable at some point in the future. 2740become reliable at some point in the future.
2148 2741
2149=cut 2742=cut
2150 2743
2151sub cf::client::query { 2744sub cf::client::query {
2152 my ($self, $flags, $text, $cb) = @_; 2745 my ($self, $flags, $text, $cb) = @_;
2160 utf8::encode $text; 2753 utf8::encode $text;
2161 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2754 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2162 2755
2163 $self->send_packet ($self->{query_queue}[0][0]) 2756 $self->send_packet ($self->{query_queue}[0][0])
2164 if @{ $self->{query_queue} } == 1; 2757 if @{ $self->{query_queue} } == 1;
2758
2759 1
2165} 2760}
2166 2761
2167cf::client->attach ( 2762cf::client->attach (
2763 on_connect => sub {
2764 my ($ns) = @_;
2765
2766 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2767 },
2168 on_reply => sub { 2768 on_reply => sub {
2169 my ($ns, $msg) = @_; 2769 my ($ns, $msg) = @_;
2170 2770
2171 # this weird shuffling is so that direct followup queries 2771 # this weird shuffling is so that direct followup queries
2172 # get handled first 2772 # get handled first
2184 } else { 2784 } else {
2185 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2785 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2186 } 2786 }
2187 } 2787 }
2188 }, 2788 },
2789 on_exticmd => sub {
2790 my ($ns, $buf) = @_;
2791
2792 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2793
2794 if (ref $msg) {
2795 my ($type, $reply, @payload) =
2796 "ARRAY" eq ref $msg
2797 ? @$msg
2798 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2799
2800 my @reply;
2801
2802 if (my $cb = $EXTICMD{$type}) {
2803 @reply = $cb->($ns, @payload);
2804 }
2805
2806 $ns->ext_reply ($reply, @reply)
2807 if $reply;
2808
2809 } else {
2810 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2811 }
2812
2813 cf::override;
2814 },
2189); 2815);
2190 2816
2191=item $client->async (\&cb) 2817=item $client->async (\&cb)
2192 2818
2193Create a new coroutine, running the specified callback. The coroutine will 2819Create a new coroutine, running the specified callback. The coroutine will
2234our $safe = new Safe "safe"; 2860our $safe = new Safe "safe";
2235our $safe_hole = new Safe::Hole; 2861our $safe_hole = new Safe::Hole;
2236 2862
2237$SIG{FPE} = 'IGNORE'; 2863$SIG{FPE} = 'IGNORE';
2238 2864
2239$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2865$safe->permit_only (Opcode::opset qw(
2866 :base_core :base_mem :base_orig :base_math
2867 grepstart grepwhile mapstart mapwhile
2868 sort time
2869));
2240 2870
2241# here we export the classes and methods available to script code 2871# here we export the classes and methods available to script code
2242 2872
2243=pod 2873=pod
2244 2874
2245The following functions and methods are available within a safe environment: 2875The following functions and methods are available within a safe environment:
2246 2876
2247 cf::object contr pay_amount pay_player map 2877 cf::object
2878 contr pay_amount pay_player map x y force_find force_add
2879 insert remove name archname title slaying race decrease_ob_nr
2880
2248 cf::object::player player 2881 cf::object::player
2249 cf::player peaceful 2882 player
2250 cf::map trigger 2883
2884 cf::player
2885 peaceful
2886
2887 cf::map
2888 trigger
2251 2889
2252=cut 2890=cut
2253 2891
2254for ( 2892for (
2255 ["cf::object" => qw(contr pay_amount pay_player map)], 2893 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2894 insert remove inv name archname title slaying race
2895 decrease_ob_nr)],
2256 ["cf::object::player" => qw(player)], 2896 ["cf::object::player" => qw(player)],
2257 ["cf::player" => qw(peaceful)], 2897 ["cf::player" => qw(peaceful)],
2258 ["cf::map" => qw(trigger)], 2898 ["cf::map" => qw(trigger)],
2259) { 2899) {
2260 no strict 'refs'; 2900 no strict 'refs';
2331=back 2971=back
2332 2972
2333=cut 2973=cut
2334 2974
2335############################################################################# 2975#############################################################################
2336
2337=head2 EXTENSION DATABASE SUPPORT
2338
2339Crossfire maintains a very simple database for extension use. It can
2340currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2341convert to/from binary).
2342
2343The parameter C<$family> should best start with the name of the extension
2344using it, it should be unique.
2345
2346=over 4
2347
2348=item $value = cf::db_get $family => $key
2349
2350Returns a single value from the database.
2351
2352=item cf::db_put $family => $key => $value
2353
2354Stores the given C<$value> in the family.
2355
2356=cut
2357
2358our $DB;
2359
2360sub db_init {
2361 unless ($DB) {
2362 $DB = BDB::db_create $DB_ENV;
2363
2364 cf::sync_job {
2365 eval {
2366 $DB->set_flags (BDB::CHKSUM);
2367
2368 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2369 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2370 cf::cleanup "db_open(db): $!" if $!;
2371 };
2372 cf::cleanup "db_open(db): $@" if $@;
2373 };
2374 }
2375}
2376
2377sub db_get($$) {
2378 my $key = "$_[0]/$_[1]";
2379
2380 cf::sync_job {
2381 BDB::db_get $DB, undef, $key, my $data;
2382
2383 $! ? ()
2384 : $data
2385 }
2386}
2387
2388sub db_put($$$) {
2389 BDB::dbreq_pri 4;
2390 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2391}
2392
2393=item cf::cache $id => [$paths...], $processversion => $process
2394
2395Generic caching function that returns the value of the resource $id,
2396caching and regenerating as required.
2397
2398This function can block.
2399
2400=cut
2401
2402sub cache {
2403 my ($id, $src, $processversion, $process) = @_;
2404
2405 my $meta =
2406 join "\x00",
2407 $processversion,
2408 map {
2409 aio_stat $_
2410 and Carp::croak "$_: $!";
2411
2412 ($_, (stat _)[7,9])
2413 } @$src;
2414
2415 my $dbmeta = db_get cache => "$id/meta";
2416 if ($dbmeta ne $meta) {
2417 # changed, we may need to process
2418
2419 my @data;
2420 my $md5;
2421
2422 for (0 .. $#$src) {
2423 0 <= aio_load $src->[$_], $data[$_]
2424 or Carp::croak "$src->[$_]: $!";
2425 }
2426
2427 # if processing is expensive, check
2428 # checksum first
2429 if (1) {
2430 $md5 =
2431 join "\x00",
2432 $processversion,
2433 map {
2434 Coro::cede;
2435 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2436 } 0.. $#$src;
2437
2438
2439 my $dbmd5 = db_get cache => "$id/md5";
2440 if ($dbmd5 eq $md5) {
2441 db_put cache => "$id/meta", $meta;
2442
2443 return db_get cache => "$id/data";
2444 }
2445 }
2446
2447 my $t1 = Time::HiRes::time;
2448 my $data = $process->(\@data);
2449 my $t2 = Time::HiRes::time;
2450
2451 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2452
2453 db_put cache => "$id/data", $data;
2454 db_put cache => "$id/md5" , $md5;
2455 db_put cache => "$id/meta", $meta;
2456
2457 return $data;
2458 }
2459
2460 db_get cache => "$id/data"
2461}
2462
2463=item fork_call { }, $args
2464
2465Executes the given code block with the given arguments in a seperate
2466process, returning the results. Everything must be serialisable with
2467Coro::Storable. May, of course, block. Note that the executed sub may
2468never block itself or use any form of Event handling.
2469
2470=cut
2471
2472sub fork_call(&@) {
2473 my ($cb, @args) = @_;
2474
2475# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2476# or die "socketpair: $!";
2477 pipe my $fh1, my $fh2
2478 or die "pipe: $!";
2479
2480 if (my $pid = fork) {
2481 close $fh2;
2482
2483 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2484 $res = Coro::Storable::thaw $res;
2485
2486 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2487
2488 die $$res unless "ARRAY" eq ref $res;
2489
2490 return wantarray ? @$res : $res->[-1];
2491 } else {
2492 reset_signals;
2493 local $SIG{__WARN__};
2494 local $SIG{__DIE__};
2495 eval {
2496 close $fh1;
2497
2498 my @res = eval { $cb->(@args) };
2499 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2500 };
2501
2502 warn $@ if $@;
2503 _exit 0;
2504 }
2505}
2506
2507#############################################################################
2508# the server's init and main functions 2976# the server's init and main functions
2509 2977
2510sub load_facedata($) { 2978sub load_facedata($) {
2511 my ($path) = @_; 2979 my ($path) = @_;
2980
2981 # HACK to clear player env face cache, we need some signal framework
2982 # for this (global event?)
2983 %ext::player_env::MUSIC_FACE_CACHE = ();
2984
2985 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2512 2986
2513 warn "loading facedata from $path\n"; 2987 warn "loading facedata from $path\n";
2514 2988
2515 my $facedata; 2989 my $facedata;
2516 0 < aio_load $path, $facedata 2990 0 < aio_load $path, $facedata
2519 $facedata = Coro::Storable::thaw $facedata; 2993 $facedata = Coro::Storable::thaw $facedata;
2520 2994
2521 $facedata->{version} == 2 2995 $facedata->{version} == 2
2522 or cf::cleanup "$path: version mismatch, cannot proceed."; 2996 or cf::cleanup "$path: version mismatch, cannot proceed.";
2523 2997
2998 # patch in the exptable
2999 $facedata->{resource}{"res/exp_table"} = {
3000 type => FT_RSRC,
3001 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3002 };
3003 cf::cede_to_tick;
3004
2524 { 3005 {
2525 my $faces = $facedata->{faceinfo}; 3006 my $faces = $facedata->{faceinfo};
2526 3007
2527 while (my ($face, $info) = each %$faces) { 3008 while (my ($face, $info) = each %$faces) {
2528 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3009 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2529 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 3010 cf::face::set_visibility $idx, $info->{visibility};
3011 cf::face::set_magicmap $idx, $info->{magicmap};
2530 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3012 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2531 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 3013 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2532 Coro::cede; 3014
3015 cf::cede_to_tick;
2533 } 3016 }
2534 3017
2535 while (my ($face, $info) = each %$faces) { 3018 while (my ($face, $info) = each %$faces) {
2536 next unless $info->{smooth}; 3019 next unless $info->{smooth};
2537 my $idx = cf::face::find $face 3020 my $idx = cf::face::find $face
2538 or next; 3021 or next;
2539 if (my $smooth = cf::face::find $info->{smooth}) { 3022 if (my $smooth = cf::face::find $info->{smooth}) {
3023 cf::face::set_smooth $idx, $smooth;
2540 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 3024 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2541 } else { 3025 } else {
2542 warn "smooth face '$info->{smooth}' not found for face '$face'"; 3026 warn "smooth face '$info->{smooth}' not found for face '$face'";
2543 } 3027 }
2544 Coro::cede; 3028
3029 cf::cede_to_tick;
2545 } 3030 }
2546 } 3031 }
2547 3032
2548 { 3033 {
2549 my $anims = $facedata->{animinfo}; 3034 my $anims = $facedata->{animinfo};
2550 3035
2551 while (my ($anim, $info) = each %$anims) { 3036 while (my ($anim, $info) = each %$anims) {
2552 cf::anim::set $anim, $info->{frames}, $info->{facings}; 3037 cf::anim::set $anim, $info->{frames}, $info->{facings};
2553 Coro::cede; 3038 cf::cede_to_tick;
2554 } 3039 }
2555 3040
2556 cf::anim::invalidate_all; # d'oh 3041 cf::anim::invalidate_all; # d'oh
2557 } 3042 }
2558 3043
3044 {
3045 # TODO: for gcfclient pleasure, we should give resources
3046 # that gcfclient doesn't grok a >10000 face index.
3047 my $res = $facedata->{resource};
3048
3049 my $soundconf = delete $res->{"res/sound.conf"};
3050
3051 while (my ($name, $info) = each %$res) {
3052 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3053 my $data;
3054
3055 if ($info->{type} & 1) {
3056 # prepend meta info
3057
3058 my $meta = $enc->encode ({
3059 name => $name,
3060 %{ $info->{meta} || {} },
3061 });
3062
3063 $data = pack "(w/a*)*", $meta, $info->{data};
3064 } else {
3065 $data = $info->{data};
3066 }
3067
3068 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3069 cf::face::set_type $idx, $info->{type};
3070
3071 cf::cede_to_tick;
3072 }
3073
3074 if ($soundconf) {
3075 $soundconf = $enc->decode (delete $soundconf->{data});
3076
3077 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3078 my $sound = $soundconf->{compat}[$_]
3079 or next;
3080
3081 my $face = cf::face::find "sound/$sound->[1]";
3082 cf::sound::set $sound->[0] => $face;
3083 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3084 }
3085
3086 while (my ($k, $v) = each %{$soundconf->{event}}) {
3087 my $face = cf::face::find "sound/$v";
3088 cf::sound::set $k => $face;
3089 }
3090 }
3091 }
3092
2559 1 3093 1
2560} 3094}
2561 3095
3096register_exticmd fx_want => sub {
3097 my ($ns, $want) = @_;
3098
3099 while (my ($k, $v) = each %$want) {
3100 $ns->fx_want ($k, $v);
3101 }
3102};
3103
2562sub reload_regions { 3104sub reload_regions {
3105 # HACK to clear player env face cache, we need some signal framework
3106 # for this (global event?)
3107 %ext::player_env::MUSIC_FACE_CACHE = ();
3108
2563 load_resource_file "$MAPDIR/regions" 3109 load_resource_file "$MAPDIR/regions"
2564 or die "unable to load regions file\n"; 3110 or die "unable to load regions file\n";
3111
3112 for (cf::region::list) {
3113 $_->{match} = qr/$_->{match}/
3114 if exists $_->{match};
3115 }
2565} 3116}
2566 3117
2567sub reload_facedata { 3118sub reload_facedata {
2568 load_facedata "$DATADIR/facedata" 3119 load_facedata "$DATADIR/facedata"
2569 or die "unable to load facedata\n"; 3120 or die "unable to load facedata\n";
2570} 3121}
2571 3122
2572sub reload_archetypes { 3123sub reload_archetypes {
3124 load_resource_file "$DATADIR/archetypes"
3125 or die "unable to load archetypes\n";
3126 #d# NEED to laod twice to resolve forward references
3127 # this really needs to be done in an extra post-pass
3128 # (which needs to be synchronous, so solve it differently)
2573 load_resource_file "$DATADIR/archetypes" 3129 load_resource_file "$DATADIR/archetypes"
2574 or die "unable to load archetypes\n"; 3130 or die "unable to load archetypes\n";
2575} 3131}
2576 3132
2577sub reload_treasures { 3133sub reload_treasures {
2593 3149
2594sub init { 3150sub init {
2595 reload_resources; 3151 reload_resources;
2596} 3152}
2597 3153
2598sub cfg_load { 3154sub reload_config {
2599 open my $fh, "<:utf8", "$CONFDIR/config" 3155 open my $fh, "<:utf8", "$CONFDIR/config"
2600 or return; 3156 or return;
2601 3157
2602 local $/; 3158 local $/;
2603 *CFG = YAML::Syck::Load <$fh>; 3159 *CFG = YAML::Syck::Load <$fh>;
2623 (async { 3179 (async {
2624 Event::one_event; 3180 Event::one_event;
2625 })->prio (Coro::PRIO_MAX); 3181 })->prio (Coro::PRIO_MAX);
2626 }; 3182 };
2627 3183
2628 cfg_load; 3184 reload_config;
2629 db_init; 3185 db_init;
2630 load_extensions; 3186 load_extensions;
2631 3187
2632 $TICK_WATCHER->start; 3188 $TICK_WATCHER->start;
2633 Event::loop; 3189 Event::loop;
2649 }, 3205 },
2650 ); 3206 );
2651 } 3207 }
2652} 3208}
2653 3209
3210sub write_runtime {
3211 my $runtime = "$LOCALDIR/runtime";
3212
3213 # first touch the runtime file to show we are still running:
3214 # the fsync below can take a very very long time.
3215
3216 IO::AIO::aio_utime $runtime, undef, undef;
3217
3218 my $guard = cf::lock_acquire "write_runtime";
3219
3220 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3221 or return;
3222
3223 my $value = $cf::RUNTIME + 90 + 10;
3224 # 10 is the runtime save interval, for a monotonic clock
3225 # 60 allows for the watchdog to kill the server.
3226
3227 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3228 and return;
3229
3230 # always fsync - this file is important
3231 aio_fsync $fh
3232 and return;
3233
3234 # touch it again to show we are up-to-date
3235 aio_utime $fh, undef, undef;
3236
3237 close $fh
3238 or return;
3239
3240 aio_rename "$runtime~", $runtime
3241 and return;
3242
3243 warn "runtime file written.\n";
3244
3245 1
3246}
3247
2654sub emergency_save() { 3248sub emergency_save() {
2655 my $freeze_guard = cf::freeze_mainloop; 3249 my $freeze_guard = cf::freeze_mainloop;
2656 3250
2657 warn "enter emergency perl save\n"; 3251 warn "enter emergency perl save\n";
2658 3252
2733 %EXT_CORO = (); 3327 %EXT_CORO = ();
2734 3328
2735 warn "removing commands"; 3329 warn "removing commands";
2736 %COMMAND = (); 3330 %COMMAND = ();
2737 3331
2738 warn "removing ext commands"; 3332 warn "removing ext/exti commands";
2739 %EXTCMD = (); 3333 %EXTCMD = ();
3334 %EXTICMD = ();
2740 3335
2741 warn "unloading/nuking all extensions"; 3336 warn "unloading/nuking all extensions";
2742 for my $pkg (@EXTS) { 3337 for my $pkg (@EXTS) {
2743 warn "... unloading $pkg"; 3338 warn "... unloading $pkg";
2744 3339
2787 warn "reloading cf.pm"; 3382 warn "reloading cf.pm";
2788 require cf; 3383 require cf;
2789 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3384 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2790 3385
2791 warn "loading config and database again"; 3386 warn "loading config and database again";
2792 cf::cfg_load; 3387 cf::reload_config;
2793 3388
2794 warn "loading extensions"; 3389 warn "loading extensions";
2795 cf::load_extensions; 3390 cf::load_extensions;
2796 3391
2797 warn "reattaching attachments to objects/players"; 3392 warn "reattaching attachments to objects/players";
2862 my $signal = new Coro::Signal; 3457 my $signal = new Coro::Signal;
2863 push @WAIT_FOR_TICK_BEGIN, $signal; 3458 push @WAIT_FOR_TICK_BEGIN, $signal;
2864 $signal->wait; 3459 $signal->wait;
2865} 3460}
2866 3461
2867 my $min = 1e6;#d#
2868 my $avg = 10;
2869$TICK_WATCHER = Event->timer ( 3462$TICK_WATCHER = Event->timer (
2870 reentrant => 0, 3463 reentrant => 0,
2871 parked => 1, 3464 parked => 1,
2872 prio => 0, 3465 prio => 0,
2873 at => $NEXT_TICK || $TICK, 3466 at => $NEXT_TICK || $TICK,
2881 3474
2882 $NOW = $tick_start = Event::time; 3475 $NOW = $tick_start = Event::time;
2883 3476
2884 cf::server_tick; # one server iteration 3477 cf::server_tick; # one server iteration
2885 3478
2886 0 && sync_job {#d#
2887 for(1..10) {
2888 my $t = Event::time;
2889 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2890 or die;
2891
2892 $map->width (50);
2893 $map->height (50);
2894 $map->alloc;
2895 $map->_load_objects ("/tmp/x.map", 1);
2896 my $t = Event::time - $t;
2897
2898 #next unless $t < 0.0013;#d#
2899 if ($t < $min) {
2900 $min = $t;
2901 }
2902 $avg = $avg * 0.99 + $t * 0.01;
2903 }
2904 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2905 exit 0;
2906 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2907 };
2908
2909 $RUNTIME += $TICK; 3479 $RUNTIME += $TICK;
2910 $NEXT_TICK += $TICK; 3480 $NEXT_TICK += $TICK;
2911 3481
2912 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3482 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2913 $NEXT_RUNTIME_WRITE = $NOW + 10; 3483 $NEXT_RUNTIME_WRITE = $NOW + 10;
2915 write_runtime 3485 write_runtime
2916 or warn "ERROR: unable to write runtime file: $!"; 3486 or warn "ERROR: unable to write runtime file: $!";
2917 }; 3487 };
2918 } 3488 }
2919 3489
2920# my $AFTER = Event::time;
2921# warn $AFTER - $NOW;#d#
2922
2923 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3490 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2924 $sig->send; 3491 $sig->send;
2925 } 3492 }
2926 while (my $sig = shift @WAIT_FOR_TICK) { 3493 while (my $sig = shift @WAIT_FOR_TICK) {
2927 $sig->send; 3494 $sig->send;
2937 3504
2938 $LOAD = ($NOW - $tick_start) / $TICK; 3505 $LOAD = ($NOW - $tick_start) / $TICK;
2939 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25; 3506 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2940 3507
2941 _post_tick; 3508 _post_tick;
2942
2943
2944 }, 3509 },
2945); 3510);
2946 3511
2947{ 3512{
3513 BDB::min_parallel 8;
2948 BDB::max_poll_time $TICK * 0.1; 3514 BDB::max_poll_time $TICK * 0.1;
2949 $BDB_POLL_WATCHER = Event->io ( 3515 $BDB_POLL_WATCHER = Event->io (
2950 reentrant => 0, 3516 reentrant => 0,
2951 fd => BDB::poll_fileno, 3517 fd => BDB::poll_fileno,
2952 poll => 'r', 3518 poll => 'r',
2953 prio => 0, 3519 prio => 0,
2954 data => WF_AUTOCANCEL, 3520 data => WF_AUTOCANCEL,
2955 cb => \&BDB::poll_cb, 3521 cb => \&BDB::poll_cb,
2956 ); 3522 );
2957 BDB::min_parallel 8;
2958 3523
2959 BDB::set_sync_prepare { 3524 BDB::set_sync_prepare {
2960 my $status; 3525 my $status;
2961 my $current = $Coro::current; 3526 my $current = $Coro::current;
2962 ( 3527 (
2971 ) 3536 )
2972 }; 3537 };
2973 3538
2974 unless ($DB_ENV) { 3539 unless ($DB_ENV) {
2975 $DB_ENV = BDB::db_env_create; 3540 $DB_ENV = BDB::db_env_create;
3541 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3542 | BDB::LOG_AUTOREMOVE, 1);
3543 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3544 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2976 3545
2977 cf::sync_job { 3546 cf::sync_job {
2978 eval { 3547 eval {
2979 BDB::db_env_open 3548 BDB::db_env_open
2980 $DB_ENV, 3549 $DB_ENV,
2982 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3551 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2983 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3552 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2984 0666; 3553 0666;
2985 3554
2986 cf::cleanup "db_env_open($BDBDIR): $!" if $!; 3555 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2987
2988 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2989 $DB_ENV->set_lk_detect;
2990 }; 3556 };
2991 3557
2992 cf::cleanup "db_env_open(db): $@" if $@; 3558 cf::cleanup "db_env_open(db): $@" if $@;
2993 }; 3559 };
2994 } 3560 }
3561
3562 $BDB_DEADLOCK_WATCHER = Event->timer (
3563 after => 3,
3564 interval => 1,
3565 hard => 1,
3566 prio => 0,
3567 data => WF_AUTOCANCEL,
3568 cb => sub {
3569 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3570 },
3571 );
3572 $BDB_CHECKPOINT_WATCHER = Event->timer (
3573 after => 11,
3574 interval => 60,
3575 hard => 1,
3576 prio => 0,
3577 data => WF_AUTOCANCEL,
3578 cb => sub {
3579 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3580 },
3581 );
3582 $BDB_TRICKLE_WATCHER = Event->timer (
3583 after => 5,
3584 interval => 10,
3585 hard => 1,
3586 prio => 0,
3587 data => WF_AUTOCANCEL,
3588 cb => sub {
3589 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3590 },
3591 );
2995} 3592}
2996 3593
2997{ 3594{
2998 IO::AIO::min_parallel 8; 3595 IO::AIO::min_parallel 8;
2999 3596

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines