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.273 by root, Mon Jun 4 12:19:08 2007 UTC vs.
Revision 1.362 by root, Mon Sep 10 12:44: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;
83our %CFG; 87our %CFG;
84 88
85our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
86our $RUNTIME; 90our $RUNTIME;
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
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}
186 195
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
206} 215}
207 216
208$Event::DIED = sub { 217$Event::DIED = sub {
209 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
210}; 219};
220
221#############################################################################
211 222
212=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
213 224
214=over 4 225=over 4
215 226
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 246 $d
236 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
237} 248}
238 249
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
242 251
243Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
244 253
245=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
246 255
247Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
248 264
249=item cf::lock_wait $string 265=item cf::lock_wait $string
250 266
251Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
252 268
255Wait until the given lock is available and then acquires it and returns 271Wait 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, 272a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257for example when the coroutine gets canceled), the lock is automatically 273for example when the coroutine gets canceled), the lock is automatically
258returned. 274returned.
259 275
276Locks are *not* recursive, locking from the same coro twice results in a
277deadlocked coro.
278
260Lock names should begin with a unique identifier (for example, cf::map::find 279Lock names should begin with a unique identifier (for example, cf::map::find
261uses map_find and cf::map::load uses map_load). 280uses map_find and cf::map::load uses map_load).
262 281
263=item $locked = cf::lock_active $string 282=item $locked = cf::lock_active $string
264 283
265Return true if the lock is currently active, i.e. somebody has locked it. 284Return true if the lock is currently active, i.e. somebody has locked it.
266 285
267=cut 286=cut
268 287
269our %LOCK; 288our %LOCK;
289our %LOCKER;#d#
270 290
271sub lock_wait($) { 291sub lock_wait($) {
272 my ($key) = @_; 292 my ($key) = @_;
293
294 if ($LOCKER{$key} == $Coro::current) {#d#
295 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
296 return;#d#
297 }#d#
273 298
274 # wait for lock, if any 299 # wait for lock, if any
275 while ($LOCK{$key}) { 300 while ($LOCK{$key}) {
276 push @{ $LOCK{$key} }, $Coro::current; 301 push @{ $LOCK{$key} }, $Coro::current;
277 Coro::schedule; 302 Coro::schedule;
283 308
284 # wait, to be sure we are not locked 309 # wait, to be sure we are not locked
285 lock_wait $key; 310 lock_wait $key;
286 311
287 $LOCK{$key} = []; 312 $LOCK{$key} = [];
313 $LOCKER{$key} = $Coro::current;#d#
288 314
289 Coro::guard { 315 Coro::guard {
316 delete $LOCKER{$key};#d#
290 # wake up all waiters, to be on the safe side 317 # wake up all waiters, to be on the safe side
291 $_->ready for @{ delete $LOCK{$key} }; 318 $_->ready for @{ delete $LOCK{$key} };
292 } 319 }
293} 320}
294 321
306 }; 333 };
307 $TICK_WATCHER->stop; 334 $TICK_WATCHER->stop;
308 $guard 335 $guard
309} 336}
310 337
338=item cf::get_slot $time[, $priority[, $name]]
339
340Allocate $time seconds of blocking CPU time at priority C<$priority>:
341This call blocks and returns only when you have at least C<$time> seconds
342of cpu time till the next tick. The slot is only valid till the next cede.
343
344The optional C<$name> can be used to identify the job to run. It might be
345used for statistical purposes and should identify the same time-class.
346
347Useful for short background jobs.
348
349=cut
350
351our @SLOT_QUEUE;
352our $SLOT_QUEUE;
353
354$SLOT_QUEUE->cancel if $SLOT_QUEUE;
355$SLOT_QUEUE = Coro::async {
356 my $signal = new Coro::Signal;
357
358 while () {
359 next_job:
360 my $avail = cf::till_tick;
361 if ($avail > 0.01) {
362 for (0 .. $#SLOT_QUEUE) {
363 if ($SLOT_QUEUE[$_][0] < $avail) {
364 my $job = splice @SLOT_QUEUE, $_, 1, ();
365 $job->[2]->send;
366 Coro::cede;
367 goto next_job;
368 }
369 }
370 }
371
372 if (@SLOT_QUEUE) {
373 # we do not use wait_For_tick() as it returns immediately when tick is inactive
374 push @cf::WAIT_FOR_TICK, $signal;
375 $signal->wait;
376 } else {
377 Coro::schedule;
378 }
379 }
380};
381
382sub get_slot($;$$) {
383 my ($time, $pri, $name) = @_;
384
385 $time = $TICK * .6 if $time > $TICK * .6;
386 my $sig = new Coro::Signal;
387
388 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
389 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
390 $SLOT_QUEUE->ready;
391 $sig->wait;
392}
393
311=item cf::async { BLOCK } 394=item cf::async { BLOCK }
312 395
313Currently the same as Coro::async_pool, meaning you cannot use 396Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 397C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 398thing you are allowed to do is call C<prio> on it.
318 401
319BEGIN { *async = \&Coro::async_pool } 402BEGIN { *async = \&Coro::async_pool }
320 403
321=item cf::sync_job { BLOCK } 404=item cf::sync_job { BLOCK }
322 405
323The design of crossfire+ requires that the main coro ($Coro::main) is 406The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 407is 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. 408partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
409acceptable.
326 410
327If it must be done, put the blocking parts into C<sync_job>. This will run 411If 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 412the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 413server will be frozen during this time, so the block should either finish
330fast or be very important. 414fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 474 $EXT_CORO{$coro+0} = $coro;
391 475
392 $coro 476 $coro
393} 477}
394 478
395sub write_runtime { 479=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 480
398 # first touch the runtime file to show we are still running: 481Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 482process, returning the results. Everything must be serialisable with
483Coro::Storable. May, of course, block. Note that the executed sub may
484never block itself or use any form of Event handling.
400 485
401 IO::AIO::aio_utime $runtime, undef, undef; 486=cut
402 487
403 my $guard = cf::lock_acquire "write_runtime"; 488sub fork_call(&@) {
489 my ($cb, @args) = @_;
404 490
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 491 # we seemingly have to make a local copy of the whole thing,
406 or return; 492 # otherwise perl prematurely frees the stuff :/
493 # TODO: investigate and fix (likely this will be rather laborious)
407 494
408 my $value = $cf::RUNTIME + 90 + 10; 495 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 496 reset_signals;
410 # 60 allows for the watchdog to kill the server. 497 &$cb
498 }, @args;
411 499
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 500 wantarray ? @res : $res[-1]
413 and return; 501}
414 502
415 # always fsync - this file is important 503=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 504
419 # touch it again to show we are up-to-date 505Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 506
422 close $fh 507=item cf::db_put $family => $key => $value
423 or return;
424 508
425 aio_rename "$runtime~", $runtime 509Stores the given C<$value> in the family. It can currently store binary
426 and return; 510data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 511
428 warn "runtime file written.\n";#d# 512=cut
429 513
514our $DB;
515
516sub db_init {
517 unless ($DB) {
518 $DB = BDB::db_create $DB_ENV;
519
520 cf::sync_job {
521 eval {
522 $DB->set_flags (BDB::CHKSUM);
523
524 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
525 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
526 cf::cleanup "db_open(db): $!" if $!;
527 };
528 cf::cleanup "db_open(db): $@" if $@;
529 };
430 1 530 }
531}
532
533sub db_get($$) {
534 my $key = "$_[0]/$_[1]";
535
536 cf::sync_job {
537 BDB::db_get $DB, undef, $key, my $data;
538
539 $! ? ()
540 : $data
541 }
542}
543
544sub db_put($$$) {
545 BDB::dbreq_pri 4;
546 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
547}
548
549=item cf::cache $id => [$paths...], $processversion => $process
550
551Generic caching function that returns the value of the resource $id,
552caching and regenerating as required.
553
554This function can block.
555
556=cut
557
558sub cache {
559 my ($id, $src, $processversion, $process) = @_;
560
561 my $meta =
562 join "\x00",
563 $processversion,
564 map {
565 aio_stat $_
566 and Carp::croak "$_: $!";
567
568 ($_, (stat _)[7,9])
569 } @$src;
570
571 my $dbmeta = db_get cache => "$id/meta";
572 if ($dbmeta ne $meta) {
573 # changed, we may need to process
574
575 my @data;
576 my $md5;
577
578 for (0 .. $#$src) {
579 0 <= aio_load $src->[$_], $data[$_]
580 or Carp::croak "$src->[$_]: $!";
581 }
582
583 # if processing is expensive, check
584 # checksum first
585 if (1) {
586 $md5 =
587 join "\x00",
588 $processversion,
589 map {
590 cf::cede_to_tick;
591 ($src->[$_], Digest::MD5::md5_hex $data[$_])
592 } 0.. $#$src;
593
594
595 my $dbmd5 = db_get cache => "$id/md5";
596 if ($dbmd5 eq $md5) {
597 db_put cache => "$id/meta", $meta;
598
599 return db_get cache => "$id/data";
600 }
601 }
602
603 my $t1 = Time::HiRes::time;
604 my $data = $process->(\@data);
605 my $t2 = Time::HiRes::time;
606
607 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
608
609 db_put cache => "$id/data", $data;
610 db_put cache => "$id/md5" , $md5;
611 db_put cache => "$id/meta", $meta;
612
613 return $data;
614 }
615
616 db_get cache => "$id/data"
431} 617}
432 618
433=item cf::datalog type => key => value, ... 619=item cf::datalog type => key => value, ...
434 620
435Log a datalog packet of the given type with the given key-value pairs. 621Log 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") 639attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 640to it. All such attachable objects support the following methods.
455 641
456In the following description, CLASS can be any of C<global>, C<object> 642In 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 643C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 644Crossfire TRT).
459 645
460=over 4 646=over 4
461 647
462=item $attachable->attach ($attachment, key => $value...) 648=item $attachable->attach ($attachment, key => $value...)
463 649
665 _attach $registry, $klass, @attach; 851 _attach $registry, $klass, @attach;
666 } 852 }
667 853
668 $obj->{$name} = \%arg; 854 $obj->{$name} = \%arg;
669 } else { 855 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 856 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 857 }
672 858
673 $obj->{_attachment}{$name} = undef; 859 $obj->{_attachment}{$name} = undef;
674} 860}
675 861
715 "; 901 ";
716 die if $@; 902 die if $@;
717} 903}
718 904
719our $override; 905our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 906our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 907
722sub override { 908sub override {
723 $override = 1; 909 $override = 1;
724 @invoke_results = (); 910 @INVOKE_RESULTS = (@_);
725} 911}
726 912
727sub do_invoke { 913sub do_invoke {
728 my $event = shift; 914 my $event = shift;
729 my $callbacks = shift; 915 my $callbacks = shift;
730 916
731 @invoke_results = (); 917 @INVOKE_RESULTS = ();
732 918
733 local $override; 919 local $override;
734 920
735 for (@$callbacks) { 921 for (@$callbacks) {
736 eval { &{$_->[1]} }; 922 eval { &{$_->[1]} };
753 939
754Generate an object-specific event with the given arguments. 940Generate an object-specific event with the given arguments.
755 941
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 942This 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 943removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 944results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 945
760=back 946=back
761 947
762=cut 948=cut
763 949
764############################################################################# 950#############################################################################
765# object support 951# object support
952#
953
954sub _can_merge {
955 my ($ob1, $ob2) = @_;
956
957 local $Storable::canonical = 1;
958 my $fob1 = Storable::freeze $ob1;
959 my $fob2 = Storable::freeze $ob2;
960
961 $fob1 eq $fob2
962}
766 963
767sub reattach { 964sub reattach {
768 # basically do the same as instantiate, without calling instantiate 965 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 966 my ($obj) = @_;
770 967
815); 1012);
816 1013
817sub object_freezer_save { 1014sub object_freezer_save {
818 my ($filename, $rdata, $objs) = @_; 1015 my ($filename, $rdata, $objs) = @_;
819 1016
1017 my $guard = cf::lock_acquire "io";
1018
820 sync_job { 1019 sync_job {
821 if (length $$rdata) { 1020 if (length $$rdata) {
1021 utf8::decode (my $decname = $filename);
822 warn sprintf "saving %s (%d,%d)\n", 1022 warn sprintf "saving %s (%d,%d)\n",
823 $filename, length $$rdata, scalar @$objs; 1023 $decname, length $$rdata, scalar @$objs;
824 1024
825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1025 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826 chmod SAVE_MODE, $fh; 1026 chmod SAVE_MODE, $fh;
827 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1027 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828 aio_fsync $fh if $cf::USE_FSYNC; 1028 aio_fsync $fh if $cf::USE_FSYNC;
847 } 1047 }
848 } else { 1048 } else {
849 aio_unlink $filename; 1049 aio_unlink $filename;
850 aio_unlink "$filename.pst"; 1050 aio_unlink "$filename.pst";
851 } 1051 }
852 } 1052 };
1053
1054 undef $guard;
853} 1055}
854 1056
855sub object_freezer_as_string { 1057sub object_freezer_as_string {
856 my ($rdata, $objs) = @_; 1058 my ($rdata, $objs) = @_;
857 1059
862 1064
863sub object_thawer_load { 1065sub object_thawer_load {
864 my ($filename) = @_; 1066 my ($filename) = @_;
865 1067
866 my ($data, $av); 1068 my ($data, $av);
1069
1070 my $guard = cf::lock_acquire "io";
867 1071
868 (aio_load $filename, $data) >= 0 1072 (aio_load $filename, $data) >= 0
869 or return; 1073 or return;
870 1074
871 unless (aio_stat "$filename.pst") { 1075 unless (aio_stat "$filename.pst") {
872 (aio_load "$filename.pst", $av) >= 0 1076 (aio_load "$filename.pst", $av) >= 0
873 or return; 1077 or return;
1078
1079 undef $guard;
874 $av = eval { (Storable::thaw $av)->{objs} }; 1080 $av = eval { (Storable::thaw $av)->{objs} };
875 } 1081 }
876 1082
1083 utf8::decode (my $decname = $filename);
877 warn sprintf "loading %s (%d)\n", 1084 warn sprintf "loading %s (%d,%d)\n",
878 $filename, length $data, scalar @{$av || []};#d# 1085 $decname, length $data, scalar @{$av || []};
1086
879 return ($data, $av); 1087 ($data, $av)
880} 1088}
1089
1090=head2 COMMAND CALLBACKS
1091
1092=over 4
1093
1094=cut
881 1095
882############################################################################# 1096#############################################################################
883# command handling &c 1097# command handling &c
884 1098
885=item cf::register_command $name => \&callback($ob,$args); 1099=item cf::register_command $name => \&callback($ob,$args);
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1112 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1113}
900 1114
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1115=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1116
903Register a callbackf ro execution when the client sends an extcmd packet. 1117Register a callback for execution when the client sends an (synchronous)
1118extcmd packet. Ext commands will be processed in the order they are
1119received by the server, like other user commands. The first argument is
1120the logged-in player. Ext commands can only be processed after a player
1121has logged in successfully.
904 1122
905If the callback returns something, it is sent back as if reply was being 1123If the callback returns something, it is sent back as if reply was being
906called. 1124called.
907 1125
1126=item cf::register_exticmd $name => \&callback($ns,$packet);
1127
1128Register a callback for execution when the client sends an (asynchronous)
1129exticmd packet. Exti commands are processed by the server as soon as they
1130are received, i.e. out of order w.r.t. other commands. The first argument
1131is a client socket. Exti commands can be received anytime, even before
1132log-in.
1133
1134If the callback returns something, it is sent back as if reply was being
1135called.
1136
908=cut 1137=cut
909 1138
910sub register_extcmd { 1139sub register_extcmd {
911 my ($name, $cb) = @_; 1140 my ($name, $cb) = @_;
912 1141
913 $EXTCMD{$name} = $cb; 1142 $EXTCMD{$name} = $cb;
1143}
1144
1145sub register_exticmd {
1146 my ($name, $cb) = @_;
1147
1148 $EXTICMD{$name} = $cb;
914} 1149}
915 1150
916cf::player->attach ( 1151cf::player->attach (
917 on_command => sub { 1152 on_command => sub {
918 my ($pl, $name, $params) = @_; 1153 my ($pl, $name, $params) = @_;
927 cf::override; 1162 cf::override;
928 }, 1163 },
929 on_extcmd => sub { 1164 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1165 my ($pl, $buf) = @_;
931 1166
932 my $msg = eval { from_json $buf }; 1167 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1168
934 if (ref $msg) { 1169 if (ref $msg) {
1170 my ($type, $reply, @payload) =
1171 "ARRAY" eq ref $msg
1172 ? @$msg
1173 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1174
1175 my @reply;
1176
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1177 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1178 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1179 }
1180
1181 $pl->ext_reply ($reply, @reply)
1182 if $reply;
1183
940 } else { 1184 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1185 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1186 }
943 1187
944 cf::override; 1188 cf::override;
945 }, 1189 },
946); 1190);
947 1191
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 { 1192sub load_extensions {
1193 cf::sync_job {
1194 my %todo;
1195
983 for my $ext (<$LIBDIR/*.ext>) { 1196 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1197 next unless -r $path;
985 eval { 1198
986 load_extension $ext; 1199 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1200 my $base = $1;
1201 my $pkg = $1;
1202 $pkg =~ s/[^[:word:]]/_/g;
1203 $pkg = "ext::$pkg";
1204
1205 open my $fh, "<:utf8", $path
1206 or die "$path: $!";
1207
1208 my $source = do { local $/; <$fh> };
1209
1210 my %ext = (
1211 path => $path,
1212 base => $base,
1213 pkg => $pkg,
1214 );
1215
1216 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1217 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1218
1219 $ext{source} =
1220 "package $pkg; use strict; use utf8;\n"
1221 . "#line 1 \"$path\"\n{\n"
1222 . $source
1223 . "\n};\n1";
1224
1225 $todo{$base} = \%ext;
1226 }
1227
1228 my %done;
1229 while (%todo) {
1230 my $progress;
1231
1232 while (my ($k, $v) = each %todo) {
1233 for (split /,\s*/, $v->{meta}{depends}) {
1234 goto skip
1235 unless exists $done{$_};
1236 }
1237
1238 warn "... loading '$k' into '$v->{pkg}'\n";
1239
1240 unless (eval $v->{source}) {
1241 my $msg = $@ ? "$v->{path}: $@\n"
1242 : "$v->{base}: extension inactive.\n";
1243
1244 if (exists $v->{meta}{mandatory}) {
1245 warn $msg;
1246 warn "mandatory extension failed to load, exiting.\n";
1247 exit 1;
1248 }
1249
1250 warn $msg;
1251 }
1252
1253 $done{$k} = delete $todo{$k};
1254 push @EXTS, $v->{pkg};
1255 $progress = 1;
987 1 1256 }
988 } or warn "$ext not loaded: $@"; 1257
1258 skip:
1259 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1260 unless $progress;
1261 }
989 } 1262 };
990} 1263}
991 1264
992############################################################################# 1265#############################################################################
993 1266
1267=back
1268
994=head2 CORE EXTENSIONS 1269=head2 CORE EXTENSIONS
995 1270
996Functions and methods that extend core crossfire objects. 1271Functions and methods that extend core crossfire objects.
997 1272
998=cut 1273=cut
1002use Coro::AIO; 1277use Coro::AIO;
1003 1278
1004=head3 cf::player 1279=head3 cf::player
1005 1280
1006=over 4 1281=over 4
1282
1283=item cf::player::num_playing
1284
1285Returns the official number of playing players, as per the Crossfire metaserver rules.
1286
1287=cut
1288
1289sub num_playing {
1290 scalar grep
1291 $_->ob->map
1292 && !$_->hidden
1293 && !$_->ob->flag (cf::FLAG_WIZ),
1294 cf::player::list
1295}
1007 1296
1008=item cf::player::find $login 1297=item cf::player::find $login
1009 1298
1010Returns the given player object, loading it if necessary (might block). 1299Returns the given player object, loading it if necessary (might block).
1011 1300
1047 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1336 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1048 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1337 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1049 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1338 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1050 aio_unlink +(playerdir $login) . "/$login.pl"; 1339 aio_unlink +(playerdir $login) . "/$login.pl";
1051 1340
1052 my $pl = load_pl path $login 1341 my $f = new_from_file cf::object::thawer path $login
1053 or return; 1342 or return;
1343
1344 $f->next;
1345 my $pl = cf::player::load_pl $f
1346 or return;
1347 local $cf::PLAYER_LOADING{$login} = $pl;
1348 $f->resolve_delayed_derefs;
1054 $cf::PLAYER{$login} = $pl 1349 $cf::PLAYER{$login} = $pl
1055 } 1350 }
1056 } 1351 }
1057} 1352}
1058 1353
1068 1363
1069 aio_mkdir playerdir $pl, 0770; 1364 aio_mkdir playerdir $pl, 0770;
1070 $pl->{last_save} = $cf::RUNTIME; 1365 $pl->{last_save} = $cf::RUNTIME;
1071 1366
1072 $pl->save_pl ($path); 1367 $pl->save_pl ($path);
1073 Coro::cede; 1368 cf::cede_to_tick;
1074} 1369}
1075 1370
1076sub new($) { 1371sub new($) {
1077 my ($login) = @_; 1372 my ($login) = @_;
1078 1373
1082 $self->{deny_save} = 1; 1377 $self->{deny_save} = 1;
1083 1378
1084 $cf::PLAYER{$login} = $self; 1379 $cf::PLAYER{$login} = $self;
1085 1380
1086 $self 1381 $self
1382}
1383
1384=item $player->send_msg ($channel, $msg, $color, [extra...])
1385
1386=cut
1387
1388sub send_msg {
1389 my $ns = shift->ns
1390 or return;
1391 $ns->send_msg (@_);
1087} 1392}
1088 1393
1089=item $pl->quit_character 1394=item $pl->quit_character
1090 1395
1091Nukes the player without looking back. If logged in, the connection will 1396Nukes the player without looking back. If logged in, the connection will
1146 or return []; 1451 or return [];
1147 1452
1148 my @logins; 1453 my @logins;
1149 1454
1150 for my $login (@$dirs) { 1455 for my $login (@$dirs) {
1456 my $path = path $login;
1457
1458 # a .pst is a dead give-away for a valid player
1459 unless (-e "$path.pst") {
1151 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1460 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1152 aio_read $fh, 0, 512, my $buf, 0 or next; 1461 aio_read $fh, 0, 512, my $buf, 0 or next;
1153 $buf !~ /^password -------------$/m or next; # official not-valid tag 1462 $buf !~ /^password -------------$/m or next; # official not-valid tag
1463 }
1154 1464
1155 utf8::decode $login; 1465 utf8::decode $login;
1156 push @logins, $login; 1466 push @logins, $login;
1157 } 1467 }
1158 1468
1185 } 1495 }
1186 1496
1187 \@paths 1497 \@paths
1188} 1498}
1189 1499
1500=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1501
1502Expand crossfire pod fragments into protocol xml.
1503
1504=cut
1505
1506sub expand_cfpod {
1507 ((my $self), (local $_)) = @_;
1508
1509 # escape & and <
1510 s/&/&amp;/g;
1511 s/(?<![BIUGHT])</&lt;/g;
1512
1513 # this is buggy, it needs to properly take care of nested <'s
1514
1515 1 while
1516 # replace B<>, I<>, U<> etc.
1517 s/B<([^\>]*)>/<b>$1<\/b>/
1518 || s/I<([^\>]*)>/<i>$1<\/i>/
1519 || s/U<([^\>]*)>/<u>$1<\/u>/
1520 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1521 # replace G<male|female> tags
1522 || s{G<([^>|]*)\|([^>]*)>}{
1523 $self->gender ? $2 : $1
1524 }ge
1525 # replace H<hint text>
1526 || s{H<([^\>]*)>}
1527 {
1528 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1529 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1530 "")
1531 [$self->{hintmode}]
1532 }ge;
1533
1534 # create single paragraphs (very hackish)
1535 s/(?<=\S)\n(?=\w)/ /g;
1536
1537 # compress some whitespace
1538 s/\s+\n/\n/g; # ws line-ends
1539 s/\n\n+/\n/g; # double lines
1540 s/^\n+//; # beginning lines
1541 s/\n+$//; # ending lines
1542
1543 $_
1544}
1545
1546sub hintmode {
1547 $_[0]{hintmode} = $_[1] if @_ > 1;
1548 $_[0]{hintmode}
1549}
1550
1190=item $player->ext_reply ($msgid, %msg) 1551=item $player->ext_reply ($msgid, @msg)
1191 1552
1192Sends an ext reply to the player. 1553Sends an ext reply to the player.
1193 1554
1194=cut 1555=cut
1195 1556
1196sub ext_reply($$%) { 1557sub ext_reply($$@) {
1197 my ($self, $id, %msg) = @_; 1558 my ($self, $id, @msg) = @_;
1198 1559
1199 $msg{msgid} = $id; 1560 $self->ns->ext_reply ($id, @msg)
1200
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1561}
1203 1562
1204=item $player->ext_event ($type, %msg) 1563=item $player->ext_msg ($type, @msg)
1205 1564
1206Sends an ext event to the client. 1565Sends an ext event to the client.
1207 1566
1208=cut 1567=cut
1209 1568
1210sub ext_event($$%) { 1569sub ext_msg($$@) {
1211 my ($self, $type, %msg) = @_; 1570 my ($self, $type, @msg) = @_;
1212 1571
1213 $self->ns->ext_event ($type, %msg); 1572 $self->ns->ext_msg ($type, @msg);
1214} 1573}
1215 1574
1216=head3 cf::region 1575=head3 cf::region
1217 1576
1218=over 4 1577=over 4
1221 1580
1222package cf::region; 1581package cf::region;
1223 1582
1224=item cf::region::find_by_path $path 1583=item cf::region::find_by_path $path
1225 1584
1226Tries to decuce the probable region for a map knowing only its path. 1585Tries to decuce the likely region for a map knowing only its path.
1227 1586
1228=cut 1587=cut
1229 1588
1230sub find_by_path($) { 1589sub find_by_path($) {
1231 my ($path) = @_; 1590 my ($path) = @_;
1232 1591
1233 my ($match, $specificity); 1592 my ($match, $specificity);
1234 1593
1235 for my $region (list) { 1594 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1595 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1596 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1597 if $region->specificity > $specificity;
1239 } 1598 }
1240 } 1599 }
1241 1600
1305 my ($self, $merge) = @_; 1664 my ($self, $merge) = @_;
1306 1665
1307 # we have to keep some variables in memory intact 1666 # we have to keep some variables in memory intact
1308 local $self->{path}; 1667 local $self->{path};
1309 local $self->{load_path}; 1668 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1669
1313 $self->SUPER::thawer_merge ($merge); 1670 $self->SUPER::thawer_merge ($merge);
1314} 1671}
1315 1672
1316sub normalise { 1673sub normalise {
1363 $self->init; # pass $1 etc. 1720 $self->init; # pass $1 etc.
1364 return $self; 1721 return $self;
1365 } 1722 }
1366 } 1723 }
1367 1724
1368 Carp::carp "unable to resolve path '$path' (base '$base')."; 1725 Carp::cluck "unable to resolve path '$path' (base '$base').";
1369 () 1726 ()
1370} 1727}
1371 1728
1372sub init { 1729sub init {
1373 my ($self) = @_; 1730 my ($self) = @_;
1416 1773
1417 $_->change_map_light ($change) 1774 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1775 for grep $_->outdoor, values %cf::MAP;
1419} 1776}
1420 1777
1778sub decay_objects {
1779 my ($self) = @_;
1780
1781 return if $self->{deny_reset};
1782
1783 $self->do_decay_objects;
1784}
1785
1421sub unlink_save { 1786sub unlink_save {
1422 my ($self) = @_; 1787 my ($self) = @_;
1423 1788
1424 utf8::encode (my $save = $self->save_path); 1789 utf8::encode (my $save = $self->save_path);
1425 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1790 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1428 1793
1429sub load_header_from($) { 1794sub load_header_from($) {
1430 my ($self, $path) = @_; 1795 my ($self, $path) = @_;
1431 1796
1432 utf8::encode $path; 1797 utf8::encode $path;
1433 #aio_open $path, O_RDONLY, 0 1798 my $f = new_from_file cf::object::thawer $path
1434 # or return;
1435
1436 $self->_load_header ($path)
1437 or return; 1799 or return;
1800
1801 $self->_load_header ($f)
1802 or return;
1803
1804 local $MAP_LOADING{$self->{path}} = $self;
1805 $f->resolve_delayed_derefs;
1438 1806
1439 $self->{load_path} = $path; 1807 $self->{load_path} = $path;
1440 1808
1441 1 1809 1
1442} 1810}
1481 $self->load_header_orig 1849 $self->load_header_orig
1482 or return; 1850 or return;
1483 $self->prepare_orig; 1851 $self->prepare_orig;
1484 } 1852 }
1485 1853
1854 $self->{deny_reset} = 1
1855 if $self->no_reset;
1856
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1857 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1858 unless $self->default_region;
1488 1859
1489 1 1860 1
1490} 1861}
1493sub find { 1864sub find {
1494 my ($path, $origin) = @_; 1865 my ($path, $origin) = @_;
1495 1866
1496 $path = normalise $path, $origin && $origin->path; 1867 $path = normalise $path, $origin && $origin->path;
1497 1868
1869 cf::lock_wait "map_data:$path";#d#remove
1498 cf::lock_wait "map_find:$path"; 1870 cf::lock_wait "map_find:$path";
1499 1871
1500 $cf::MAP{$path} || do { 1872 $cf::MAP{$path} || do {
1501 my $guard = cf::lock_acquire "map_find:$path"; 1873 my $guard1 = cf::lock_acquire "map_find:$path";
1874 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1875
1502 my $map = new_from_path cf::map $path 1876 my $map = new_from_path cf::map $path
1503 or return; 1877 or return;
1504 1878
1505 $map->{last_save} = $cf::RUNTIME; 1879 $map->{last_save} = $cf::RUNTIME;
1506 1880
1507 $map->load_header 1881 $map->load_header
1508 or return; 1882 or return;
1509 1883
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1884 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1885 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1886 #$cf::WAIT_FOR_TICK->wait;
1887 undef $guard1;
1888 undef $guard2;
1513 $map->reset; 1889 $map->reset;
1514 undef $guard;
1515 return find $path; 1890 return find $path;
1516 } 1891 }
1517 1892
1518 $cf::MAP{$path} = $map 1893 $cf::MAP{$path} = $map
1519 } 1894 }
1528 local $self->{deny_reset} = 1; # loading can take a long time 1903 local $self->{deny_reset} = 1; # loading can take a long time
1529 1904
1530 my $path = $self->{path}; 1905 my $path = $self->{path};
1531 1906
1532 { 1907 {
1533 my $guard = cf::lock_acquire "map_load:$path"; 1908 my $guard = cf::lock_acquire "map_data:$path";
1534 1909
1910 return unless $self->valid;
1535 return if $self->in_memory != cf::MAP_SWAPPED; 1911 return unless $self->in_memory == cf::MAP_SWAPPED;
1536 1912
1537 $self->in_memory (cf::MAP_LOADING); 1913 $self->in_memory (cf::MAP_LOADING);
1538 1914
1539 $self->alloc; 1915 $self->alloc;
1540 1916
1541 $self->pre_load; 1917 $self->pre_load;
1542 Coro::cede; 1918 cf::cede_to_tick;
1543 1919
1920 my $f = new_from_file cf::object::thawer $self->{load_path};
1921 $f->skip_block;
1544 $self->_load_objects ($self->{load_path}, 1) 1922 $self->_load_objects ($f)
1545 or return; 1923 or return;
1546 1924
1547 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1925 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1548 if delete $self->{load_original}; 1926 if delete $self->{load_original};
1549 1927
1550 if (my $uniq = $self->uniq_path) { 1928 if (my $uniq = $self->uniq_path) {
1551 utf8::encode $uniq; 1929 utf8::encode $uniq;
1552 if (aio_open $uniq, O_RDONLY, 0) { 1930 unless (aio_stat $uniq) {
1931 if (my $f = new_from_file cf::object::thawer $uniq) {
1553 $self->clear_unique_items; 1932 $self->clear_unique_items;
1554 $self->_load_objects ($uniq, 0); 1933 $self->_load_objects ($f);
1934 $f->resolve_delayed_derefs;
1935 }
1555 } 1936 }
1556 } 1937 }
1557 1938
1558 Coro::cede; 1939 $f->resolve_delayed_derefs;
1940
1941 cf::cede_to_tick;
1559 # now do the right thing for maps 1942 # now do the right thing for maps
1560 $self->link_multipart_objects; 1943 $self->link_multipart_objects;
1561 $self->difficulty ($self->estimate_difficulty) 1944 $self->difficulty ($self->estimate_difficulty)
1562 unless $self->difficulty; 1945 unless $self->difficulty;
1563 Coro::cede; 1946 cf::cede_to_tick;
1564 1947
1565 unless ($self->{deny_activate}) { 1948 unless ($self->{deny_activate}) {
1566 $self->decay_objects; 1949 $self->decay_objects;
1567 $self->fix_auto_apply; 1950 $self->fix_auto_apply;
1568 $self->update_buttons; 1951 $self->update_buttons;
1569 Coro::cede; 1952 cf::cede_to_tick;
1570 $self->set_darkness_map; 1953 $self->set_darkness_map;
1571 Coro::cede; 1954 cf::cede_to_tick;
1572 $self->activate; 1955 $self->activate;
1573 } 1956 }
1957
1958 $self->{last_save} = $cf::RUNTIME;
1959 $self->last_access ($cf::RUNTIME);
1574 1960
1575 $self->in_memory (cf::MAP_IN_MEMORY); 1961 $self->in_memory (cf::MAP_IN_MEMORY);
1576 } 1962 }
1577 1963
1578 $self->post_load; 1964 $self->post_load;
1582 my ($self, $ob) = @_; 1968 my ($self, $ob) = @_;
1583 1969
1584 return find "~" . $ob->name . "/" . $self->{path} 1970 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1971 if $self->per_player;
1586 1972
1973# return find "?party/" . $ob->name . "/" . $self->{path}
1974# if $self->per_party;
1975
1587 $self 1976 $self
1588} 1977}
1589 1978
1590# find and load all maps in the 3x3 area around a map 1979# find and load all maps in the 3x3 area around a map
1591sub load_diag { 1980sub load_neighbours {
1592 my ($map) = @_; 1981 my ($map) = @_;
1593 1982
1594 my @diag; # diagonal neighbours 1983 my @neigh; # diagonal neighbours
1595 1984
1596 for (0 .. 3) { 1985 for (0 .. 3) {
1597 my $neigh = $map->tile_path ($_) 1986 my $neigh = $map->tile_path ($_)
1598 or next; 1987 or next;
1599 $neigh = find $neigh, $map 1988 $neigh = find $neigh, $map
1600 or next; 1989 or next;
1601 $neigh->load; 1990 $neigh->load;
1602 1991
1992 push @neigh,
1603 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1993 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1604 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1994 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1605 } 1995 }
1606 1996
1607 for (@diag) { 1997 for (grep defined $_->[0], @neigh) {
1998 my ($path, $origin) = @$_;
1608 my $neigh = find @$_ 1999 my $neigh = find $path, $origin
1609 or next; 2000 or next;
1610 $neigh->load; 2001 $neigh->load;
1611 } 2002 }
1612} 2003}
1613 2004
1618} 2009}
1619 2010
1620sub do_load_sync { 2011sub do_load_sync {
1621 my ($map) = @_; 2012 my ($map) = @_;
1622 2013
2014 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2015 if $Coro::current == $Coro::main;
2016
1623 cf::sync_job { $map->load }; 2017 cf::sync_job { $map->load };
1624} 2018}
1625 2019
1626our %MAP_PREFETCH; 2020our %MAP_PREFETCH;
1627our $MAP_PREFETCHER = undef; 2021our $MAP_PREFETCHER = undef;
1628 2022
1629sub find_async { 2023sub find_async {
1630 my ($path, $origin) = @_; 2024 my ($path, $origin, $load) = @_;
1631 2025
1632 $path = normalise $path, $origin && $origin->{path}; 2026 $path = normalise $path, $origin && $origin->{path};
1633 2027
1634 if (my $map = $cf::MAP{$path}) { 2028 if (my $map = $cf::MAP{$path}) {
1635 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2029 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1636 } 2030 }
1637 2031
1638 undef $MAP_PREFETCH{$path}; 2032 $MAP_PREFETCH{$path} |= $load;
2033
1639 $MAP_PREFETCHER ||= cf::async { 2034 $MAP_PREFETCHER ||= cf::async {
1640 while (%MAP_PREFETCH) { 2035 while (%MAP_PREFETCH) {
1641 for my $path (keys %MAP_PREFETCH) { 2036 while (my ($k, $v) = each %MAP_PREFETCH) {
1642 my $map = find $path 2037 if (my $map = find $k) {
1643 or next;
1644 $map->load; 2038 $map->load if $v;
2039 }
1645 2040
1646 delete $MAP_PREFETCH{$path}; 2041 delete $MAP_PREFETCH{$k};
1647 } 2042 }
1648 } 2043 }
1649 undef $MAP_PREFETCHER; 2044 undef $MAP_PREFETCHER;
1650 }; 2045 };
1651 $MAP_PREFETCHER->prio (6); 2046 $MAP_PREFETCHER->prio (6);
1654} 2049}
1655 2050
1656sub save { 2051sub save {
1657 my ($self) = @_; 2052 my ($self) = @_;
1658 2053
1659 my $lock = cf::lock_acquire "map_data:" . $self->path; 2054 my $lock = cf::lock_acquire "map_data:$self->{path}";
1660 2055
1661 $self->{last_save} = $cf::RUNTIME; 2056 $self->{last_save} = $cf::RUNTIME;
1662 2057
1663 return unless $self->dirty; 2058 return unless $self->dirty;
1664 2059
1687 my ($self) = @_; 2082 my ($self) = @_;
1688 2083
1689 # save first because save cedes 2084 # save first because save cedes
1690 $self->save; 2085 $self->save;
1691 2086
1692 my $lock = cf::lock_acquire "map_data:" . $self->path; 2087 my $lock = cf::lock_acquire "map_data:$self->{path}";
1693 2088
1694 return if $self->players; 2089 return if $self->players;
1695 return if $self->in_memory != cf::MAP_IN_MEMORY; 2090 return if $self->in_memory != cf::MAP_IN_MEMORY;
1696 return if $self->{deny_save}; 2091 return if $self->{deny_save};
1697 2092
2093 $self->in_memory (cf::MAP_SWAPPED);
2094
2095 $self->deactivate;
2096 $_->clear_links_to ($self) for values %cf::MAP;
1698 $self->clear; 2097 $self->clear;
1699 $self->in_memory (cf::MAP_SWAPPED);
1700} 2098}
1701 2099
1702sub reset_at { 2100sub reset_at {
1703 my ($self) = @_; 2101 my ($self) = @_;
1704 2102
1705 # TODO: safety, remove and allow resettable per-player maps 2103 # TODO: safety, remove and allow resettable per-player maps
1706 return 1e99 if $self->isa ("ext::map_per_player");#d#
1707 return 1e99 if $self->{deny_reset}; 2104 return 1e99 if $self->{deny_reset};
1708 2105
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2106 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2107 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 2108
1722 my ($self) = @_; 2119 my ($self) = @_;
1723 2120
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2121 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 2122
1726 return if $self->players; 2123 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 2124
1729 warn "resetting map ", $self->path;#d# 2125 warn "resetting map ", $self->path;
1730 2126
1731 $self->in_memory (cf::MAP_SWAPPED); 2127 $self->in_memory (cf::MAP_SWAPPED);
1732 2128
1733 # need to save uniques path 2129 # need to save uniques path
1734 unless ($self->{deny_save}) { 2130 unless ($self->{deny_save}) {
1738 if $uniq; 2134 if $uniq;
1739 } 2135 }
1740 2136
1741 delete $cf::MAP{$self->path}; 2137 delete $cf::MAP{$self->path};
1742 2138
2139 $self->deactivate;
2140 $_->clear_links_to ($self) for values %cf::MAP;
1743 $self->clear; 2141 $self->clear;
1744
1745 $_->clear_links_to ($self) for values %cf::MAP;
1746 2142
1747 $self->unlink_save; 2143 $self->unlink_save;
1748 $self->destroy; 2144 $self->destroy;
1749} 2145}
1750 2146
1751my $nuke_counter = "aaaa"; 2147my $nuke_counter = "aaaa";
1752 2148
1753sub nuke { 2149sub nuke {
1754 my ($self) = @_; 2150 my ($self) = @_;
1755 2151
2152 {
2153 my $lock = cf::lock_acquire "map_data:$self->{path}";
2154
1756 delete $cf::MAP{$self->path}; 2155 delete $cf::MAP{$self->path};
1757 2156
1758 $self->unlink_save; 2157 $self->unlink_save;
1759 2158
1760 bless $self, "cf::map"; 2159 bless $self, "cf::map";
1761 delete $self->{deny_reset}; 2160 delete $self->{deny_reset};
1762 $self->{deny_save} = 1; 2161 $self->{deny_save} = 1;
1763 $self->reset_timeout (1); 2162 $self->reset_timeout (1);
1764 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2163 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1765 2164
1766 $cf::MAP{$self->path} = $self; 2165 $cf::MAP{$self->path} = $self;
2166 }
1767 2167
1768 $self->reset; # polite request, might not happen 2168 $self->reset; # polite request, might not happen
2169}
2170
2171=item $maps = cf::map::tmp_maps
2172
2173Returns an arrayref with all map paths of currently instantiated and saved
2174maps. May block.
2175
2176=cut
2177
2178sub tmp_maps() {
2179 [
2180 map {
2181 utf8::decode $_;
2182 /\.map$/
2183 ? normalise $_
2184 : ()
2185 } @{ aio_readdir $TMPDIR or [] }
2186 ]
2187}
2188
2189=item $maps = cf::map::random_maps
2190
2191Returns an arrayref with all map paths of currently instantiated and saved
2192random maps. May block.
2193
2194=cut
2195
2196sub random_maps() {
2197 [
2198 map {
2199 utf8::decode $_;
2200 /\.map$/
2201 ? normalise "?random/$_"
2202 : ()
2203 } @{ aio_readdir $RANDOMDIR or [] }
2204 ]
1769} 2205}
1770 2206
1771=item cf::map::unique_maps 2207=item cf::map::unique_maps
1772 2208
1773Returns an arrayref of paths of all shared maps that have 2209Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2210instantiated unique items. May block.
1775 2211
1776=cut 2212=cut
1777 2213
1778sub unique_maps() { 2214sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2215 [
1780 or return; 2216 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2217 utf8::decode $_;
1786 next if /\.pst$/; 2218 /\.map$/
1787 next unless /^$PATH_SEP/o; 2219 ? normalise $_
1788 2220 : ()
1789 push @paths, cf::map::normalise $_; 2221 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2222 ]
1791
1792 \@paths
1793} 2223}
1794 2224
1795package cf; 2225package cf;
1796 2226
1797=back 2227=back
1815 map { $_, inv_recursive_ $_->inv } @_ 2245 map { $_, inv_recursive_ $_->inv } @_
1816} 2246}
1817 2247
1818sub inv_recursive { 2248sub inv_recursive {
1819 inv_recursive_ inv $_[0] 2249 inv_recursive_ inv $_[0]
2250}
2251
2252=item $ref = $ob->ref
2253
2254creates and returns a persistent reference to an objetc that can be stored as a string.
2255
2256=item $ob = cf::object::deref ($refstring)
2257
2258returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2259even if the object actually exists. May block.
2260
2261=cut
2262
2263sub deref {
2264 my ($ref) = @_;
2265
2266 # temporary compatibility#TODO#remove
2267 $ref =~ s{^<}{player/<};
2268
2269 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2270 my ($uuid, $name) = ($1, $2);
2271 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2272 or return;
2273 $pl->ob->uuid eq $uuid
2274 or return;
2275
2276 $pl->ob
2277 } else {
2278 warn "$ref: cannot resolve object reference\n";
2279 undef
2280 }
1820} 2281}
1821 2282
1822package cf; 2283package cf;
1823 2284
1824=back 2285=back
1843 2304
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2305 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2306
1846 if ($self->{record_replies}) { 2307 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2308 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2309
1848 } else { 2310 } else {
2311 my $pl = $self->contr;
2312
2313 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2314 my $dialog = $pl->{npc_dialog};
2315 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2316
2317 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2318 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2319 $self->message ($msg, $flags);
2320 }
1851 } 2321 }
2322}
2323
2324=item $object->send_msg ($channel, $msg, $color, [extra...])
2325
2326=cut
2327
2328sub cf::object::send_msg {
2329 my $pl = shift->contr
2330 or return;
2331 $pl->send_msg (@_);
1852} 2332}
1853 2333
1854=item $player_object->may ("access") 2334=item $player_object->may ("access")
1855 2335
1856Returns wether the given player is authorized to access resource "access" 2336Returns wether the given player is authorized to access resource "access"
1935 # use -1 or undef as default coordinates, not 0, 0 2415 # use -1 or undef as default coordinates, not 0, 0
1936 ($x, $y) = ($map->enter_x, $map->enter_y) 2416 ($x, $y) = ($map->enter_x, $map->enter_y)
1937 if $x <=0 && $y <= 0; 2417 if $x <=0 && $y <= 0;
1938 2418
1939 $map->load; 2419 $map->load;
1940 $map->load_diag; 2420 $map->load_neighbours;
1941 2421
1942 return unless $self->contr->active; 2422 return unless $self->contr->active;
1943 $self->activate_recursive; 2423 $self->activate_recursive;
1944 2424
1945 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2425 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1946 $self->enter_map ($map, $x, $y); 2426 $self->enter_map ($map, $x, $y);
1947} 2427}
1948 2428
1949=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2429=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1950 2430
1951Moves the player to the given map-path and coordinates by first freezing 2431Moves the player to the given map-path and coordinates by first freezing
1952her, loading and preparing them map, calling the provided $check callback 2432her, loading and preparing them map, calling the provided $check callback
1953that has to return the map if sucecssful, and then unfreezes the player on 2433that has to return the map if sucecssful, and then unfreezes the player on
1954the new (success) or old (failed) map position. 2434the new (success) or old (failed) map position. In either case, $done will
2435be called at the end of this process.
1955 2436
1956=cut 2437=cut
1957 2438
1958our $GOTOGEN; 2439our $GOTOGEN;
1959 2440
1960sub cf::object::player::goto { 2441sub cf::object::player::goto {
1961 my ($self, $path, $x, $y, $check) = @_; 2442 my ($self, $path, $x, $y, $check, $done) = @_;
1962 2443
1963 # do generation counting so two concurrent goto's will be executed in-order 2444 # do generation counting so two concurrent goto's will be executed in-order
1964 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2445 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1965 2446
1966 $self->enter_link; 2447 $self->enter_link;
1986 2467
1987 if ($gen == $self->{_goto_generation}) { 2468 if ($gen == $self->{_goto_generation}) {
1988 delete $self->{_goto_generation}; 2469 delete $self->{_goto_generation};
1989 $self->leave_link ($map, $x, $y); 2470 $self->leave_link ($map, $x, $y);
1990 } 2471 }
2472
2473 $done->() if $done;
1991 })->prio (1); 2474 })->prio (1);
1992} 2475}
1993 2476
1994=item $player_object->enter_exit ($exit_object) 2477=item $player_object->enter_exit ($exit_object)
1995 2478
2064 my $hp = $exit->stats->hp; 2547 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp; 2548 my $sp = $exit->stats->sp;
2066 2549
2067 $self->enter_link; 2550 $self->enter_link;
2068 2551
2552 # if exit is damned, update players death & WoR home-position
2553 $self->contr->savebed ($slaying, $hp, $sp)
2554 if $exit->flag (FLAG_DAMNED);
2555
2069 (async { 2556 (async {
2070 $self->deactivate_recursive; # just to be sure 2557 $self->deactivate_recursive; # just to be sure
2071 unless (eval { 2558 unless (eval {
2072 $self->goto ($slaying, $hp, $sp); 2559 $self->goto ($slaying, $hp, $sp);
2073 2560
2100 2587
2101 utf8::encode $text; 2588 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2589 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2590}
2104 2591
2592=item $client->send_msg ($channel, $msg, $color, [extra...])
2593
2594Send a drawinfo or msg packet to the client, formatting the msg for the
2595client if neccessary. C<$type> should be a string identifying the type of
2596the message, with C<log> being the default. If C<$color> is negative, suppress
2597the message unless the client supports the msg packet.
2598
2599=cut
2600
2601our %CHANNEL = (
2602 "c/identify" => {
2603 id => "identify",
2604 title => "Identify",
2605 reply => undef,
2606 tooltip => "Items recently identified",
2607 },
2608 "c/examine" => {
2609 id => "examine",
2610 title => "Examine",
2611 reply => undef,
2612 tooltip => "Signs and other items you examined",
2613 },
2614);
2615
2616sub cf::client::send_msg {
2617 my ($self, $channel, $msg, $color, @extra) = @_;
2618
2619 $msg = $self->pl->expand_cfpod ($msg);
2620
2621 $color &= cf::NDI_CLIENT_MASK; # just in case...
2622
2623 # check predefined channels, for the benefit of C
2624 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2625
2626 if (ref $channel) {
2627 # send meta info to client, if not yet sent
2628 unless (exists $self->{channel}{$channel->{id}}) {
2629 $self->{channel}{$channel->{id}} = $channel;
2630 $self->ext_msg (channel_info => $channel)
2631 if $self->can_msg;
2632 }
2633
2634 $channel = $channel->{id};
2635 }
2636
2637 return unless @extra || length $msg;
2638
2639 if ($self->can_msg) {
2640 # default colour, mask it out
2641 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2642 if $color & cf::NDI_DEF;
2643
2644 $self->send_packet ("msg " . $self->{json_coder}->encode (
2645 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2646 } else {
2647 if ($color >= 0) {
2648 # replace some tags by gcfclient-compatible ones
2649 for ($msg) {
2650 1 while
2651 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2652 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2653 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2654 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2655 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2656 }
2657
2658 $color &= cf::NDI_COLOR_MASK;
2659
2660 utf8::encode $msg;
2661
2662 if (0 && $msg =~ /\[/) {
2663 # COMMAND/INFO
2664 $self->send_packet ("drawextinfo $color 10 8 $msg")
2665 } else {
2666 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2667 $self->send_packet ("drawinfo $color $msg")
2668 }
2669 }
2670 }
2671}
2672
2105=item $client->ext_event ($type, %msg) 2673=item $client->ext_msg ($type, @msg)
2106 2674
2107Sends an exti event to the client. 2675Sends an ext event to the client.
2108 2676
2109=cut 2677=cut
2110 2678
2111sub cf::client::ext_event($$%) { 2679sub cf::client::ext_msg($$@) {
2112 my ($self, $type, %msg) = @_; 2680 my ($self, $type, @msg) = @_;
2113 2681
2682 if ($self->extcmd == 2) {
2683 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2684 } elsif ($self->extcmd == 1) { # TODO: remove
2114 $msg{msgtype} = "event_$type"; 2685 push @msg, msgtype => "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2686 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2687 }
2688}
2689
2690=item $client->ext_reply ($msgid, @msg)
2691
2692Sends an ext reply to the client.
2693
2694=cut
2695
2696sub cf::client::ext_reply($$@) {
2697 my ($self, $id, @msg) = @_;
2698
2699 if ($self->extcmd == 2) {
2700 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2701 } elsif ($self->extcmd == 1) {
2702 #TODO: version 1, remove
2703 unshift @msg, msgtype => "reply", msgid => $id;
2704 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2705 }
2116} 2706}
2117 2707
2118=item $success = $client->query ($flags, "text", \&cb) 2708=item $success = $client->query ($flags, "text", \&cb)
2119 2709
2120Queues a query to the client, calling the given callback with 2710Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2711the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2122C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2712C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2713
2124Queries can fail, so check the return code. Or don't, as queries will become 2714Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2715become reliable at some point in the future.
2126 2716
2127=cut 2717=cut
2128 2718
2129sub cf::client::query { 2719sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2720 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2728 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2729 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2730
2141 $self->send_packet ($self->{query_queue}[0][0]) 2731 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2732 if @{ $self->{query_queue} } == 1;
2733
2734 1
2143} 2735}
2144 2736
2145cf::client->attach ( 2737cf::client->attach (
2738 on_connect => sub {
2739 my ($ns) = @_;
2740
2741 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2742 },
2146 on_reply => sub { 2743 on_reply => sub {
2147 my ($ns, $msg) = @_; 2744 my ($ns, $msg) = @_;
2148 2745
2149 # this weird shuffling is so that direct followup queries 2746 # this weird shuffling is so that direct followup queries
2150 # get handled first 2747 # get handled first
2162 } else { 2759 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2760 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2761 }
2165 } 2762 }
2166 }, 2763 },
2764 on_exticmd => sub {
2765 my ($ns, $buf) = @_;
2766
2767 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2768
2769 if (ref $msg) {
2770 my ($type, $reply, @payload) =
2771 "ARRAY" eq ref $msg
2772 ? @$msg
2773 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2774
2775 my @reply;
2776
2777 if (my $cb = $EXTICMD{$type}) {
2778 @reply = $cb->($ns, @payload);
2779 }
2780
2781 $ns->ext_reply ($reply, @reply)
2782 if $reply;
2783
2784 } else {
2785 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2786 }
2787
2788 cf::override;
2789 },
2167); 2790);
2168 2791
2169=item $client->async (\&cb) 2792=item $client->async (\&cb)
2170 2793
2171Create a new coroutine, running the specified callback. The coroutine will 2794Create a new coroutine, running the specified callback. The coroutine will
2212our $safe = new Safe "safe"; 2835our $safe = new Safe "safe";
2213our $safe_hole = new Safe::Hole; 2836our $safe_hole = new Safe::Hole;
2214 2837
2215$SIG{FPE} = 'IGNORE'; 2838$SIG{FPE} = 'IGNORE';
2216 2839
2217$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2840$safe->permit_only (Opcode::opset qw(
2841 :base_core :base_mem :base_orig :base_math
2842 grepstart grepwhile mapstart mapwhile
2843 sort time
2844));
2218 2845
2219# here we export the classes and methods available to script code 2846# here we export the classes and methods available to script code
2220 2847
2221=pod 2848=pod
2222 2849
2223The following functions and methods are available within a safe environment: 2850The following functions and methods are available within a safe environment:
2224 2851
2225 cf::object contr pay_amount pay_player map 2852 cf::object
2853 contr pay_amount pay_player map x y force_find force_add
2854 insert remove name archname title slaying race decrease_ob_nr
2855
2226 cf::object::player player 2856 cf::object::player
2227 cf::player peaceful 2857 player
2228 cf::map trigger 2858
2859 cf::player
2860 peaceful
2861
2862 cf::map
2863 trigger
2229 2864
2230=cut 2865=cut
2231 2866
2232for ( 2867for (
2233 ["cf::object" => qw(contr pay_amount pay_player map)], 2868 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2869 insert remove inv name archname title slaying race
2870 decrease_ob_nr)],
2234 ["cf::object::player" => qw(player)], 2871 ["cf::object::player" => qw(player)],
2235 ["cf::player" => qw(peaceful)], 2872 ["cf::player" => qw(peaceful)],
2236 ["cf::map" => qw(trigger)], 2873 ["cf::map" => qw(trigger)],
2237) { 2874) {
2238 no strict 'refs'; 2875 no strict 'refs';
2309=back 2946=back
2310 2947
2311=cut 2948=cut
2312 2949
2313############################################################################# 2950#############################################################################
2314
2315=head2 EXTENSION DATABASE SUPPORT
2316
2317Crossfire maintains a very simple database for extension use. It can
2318currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2319convert to/from binary).
2320
2321The parameter C<$family> should best start with the name of the extension
2322using it, it should be unique.
2323
2324=over 4
2325
2326=item $value = cf::db_get $family => $key
2327
2328Returns a single value from the database.
2329
2330=item cf::db_put $family => $key => $value
2331
2332Stores the given C<$value> in the family.
2333
2334=cut
2335
2336our $DB;
2337
2338sub db_init {
2339 unless ($DB) {
2340 $DB = BDB::db_create $DB_ENV;
2341
2342 cf::sync_job {
2343 eval {
2344 $DB->set_flags (BDB::CHKSUM);
2345
2346 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2347 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2348 cf::cleanup "db_open(db): $!" if $!;
2349 };
2350 cf::cleanup "db_open(db): $@" if $@;
2351 };
2352 }
2353}
2354
2355sub db_get($$) {
2356 my $key = "$_[0]/$_[1]";
2357
2358 cf::sync_job {
2359 BDB::db_get $DB, undef, $key, my $data;
2360
2361 $! ? ()
2362 : $data
2363 }
2364}
2365
2366sub db_put($$$) {
2367 BDB::dbreq_pri 4;
2368 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2369}
2370
2371=item cf::cache $id => [$paths...], $processversion => $process
2372
2373Generic caching function that returns the value of the resource $id,
2374caching and regenerating as required.
2375
2376This function can block.
2377
2378=cut
2379
2380sub cache {
2381 my ($id, $src, $processversion, $process) = @_;
2382
2383 my $meta =
2384 join "\x00",
2385 $processversion,
2386 map {
2387 aio_stat $_
2388 and Carp::croak "$_: $!";
2389
2390 ($_, (stat _)[7,9])
2391 } @$src;
2392
2393 my $dbmeta = db_get cache => "$id/meta";
2394 if ($dbmeta ne $meta) {
2395 # changed, we may need to process
2396
2397 my @data;
2398 my $md5;
2399
2400 for (0 .. $#$src) {
2401 0 <= aio_load $src->[$_], $data[$_]
2402 or Carp::croak "$src->[$_]: $!";
2403 }
2404
2405 # if processing is expensive, check
2406 # checksum first
2407 if (1) {
2408 $md5 =
2409 join "\x00",
2410 $processversion,
2411 map {
2412 Coro::cede;
2413 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2414 } 0.. $#$src;
2415
2416
2417 my $dbmd5 = db_get cache => "$id/md5";
2418 if ($dbmd5 eq $md5) {
2419 db_put cache => "$id/meta", $meta;
2420
2421 return db_get cache => "$id/data";
2422 }
2423 }
2424
2425 my $t1 = Time::HiRes::time;
2426 my $data = $process->(\@data);
2427 my $t2 = Time::HiRes::time;
2428
2429 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430
2431 db_put cache => "$id/data", $data;
2432 db_put cache => "$id/md5" , $md5;
2433 db_put cache => "$id/meta", $meta;
2434
2435 return $data;
2436 }
2437
2438 db_get cache => "$id/data"
2439}
2440
2441=item fork_call { }, $args
2442
2443Executes the given code block with the given arguments in a seperate
2444process, returning the results. Everything must be serialisable with
2445Coro::Storable. May, of course, block. Note that the executed sub may
2446never block itself or use any form of Event handling.
2447
2448=cut
2449
2450sub fork_call(&@) {
2451 my ($cb, @args) = @_;
2452
2453# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454# or die "socketpair: $!";
2455 pipe my $fh1, my $fh2
2456 or die "pipe: $!";
2457
2458 if (my $pid = fork) {
2459 close $fh2;
2460
2461 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462 $res = Coro::Storable::thaw $res;
2463
2464 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465
2466 die $$res unless "ARRAY" eq ref $res;
2467
2468 return wantarray ? @$res : $res->[-1];
2469 } else {
2470 reset_signals;
2471 local $SIG{__WARN__};
2472 local $SIG{__DIE__};
2473 eval {
2474 close $fh1;
2475
2476 my @res = eval { $cb->(@args) };
2477 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478 };
2479
2480 warn $@ if $@;
2481 _exit 0;
2482 }
2483}
2484
2485#############################################################################
2486# the server's init and main functions 2951# the server's init and main functions
2487 2952
2488sub load_facedata($) { 2953sub load_facedata($) {
2489 my ($path) = @_; 2954 my ($path) = @_;
2955
2956 # HACK to clear player env face cache, we need some signal framework
2957 # for this (global event?)
2958 %ext::player_env::MUSIC_FACE_CACHE = ();
2959
2960 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2490 2961
2491 warn "loading facedata from $path\n"; 2962 warn "loading facedata from $path\n";
2492 2963
2493 my $facedata; 2964 my $facedata;
2494 0 < aio_load $path, $facedata 2965 0 < aio_load $path, $facedata
2497 $facedata = Coro::Storable::thaw $facedata; 2968 $facedata = Coro::Storable::thaw $facedata;
2498 2969
2499 $facedata->{version} == 2 2970 $facedata->{version} == 2
2500 or cf::cleanup "$path: version mismatch, cannot proceed."; 2971 or cf::cleanup "$path: version mismatch, cannot proceed.";
2501 2972
2973 # patch in the exptable
2974 $facedata->{resource}{"res/exp_table"} = {
2975 type => FT_RSRC,
2976 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2977 };
2978 cf::cede_to_tick;
2979
2502 { 2980 {
2503 my $faces = $facedata->{faceinfo}; 2981 my $faces = $facedata->{faceinfo};
2504 2982
2505 while (my ($face, $info) = each %$faces) { 2983 while (my ($face, $info) = each %$faces) {
2506 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2984 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2985 cf::face::set_visibility $idx, $info->{visibility};
2986 cf::face::set_magicmap $idx, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2987 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2988 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2510 Coro::cede; 2989
2990 cf::cede_to_tick;
2511 } 2991 }
2512 2992
2513 while (my ($face, $info) = each %$faces) { 2993 while (my ($face, $info) = each %$faces) {
2514 next unless $info->{smooth}; 2994 next unless $info->{smooth};
2515 my $idx = cf::face::find $face 2995 my $idx = cf::face::find $face
2516 or next; 2996 or next;
2517 if (my $smooth = cf::face::find $info->{smooth}) { 2997 if (my $smooth = cf::face::find $info->{smooth}) {
2998 cf::face::set_smooth $idx, $smooth;
2518 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2999 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519 } else { 3000 } else {
2520 warn "smooth face '$info->{smooth}' not found for face '$face'"; 3001 warn "smooth face '$info->{smooth}' not found for face '$face'";
2521 } 3002 }
2522 Coro::cede; 3003
3004 cf::cede_to_tick;
2523 } 3005 }
2524 } 3006 }
2525 3007
2526 { 3008 {
2527 my $anims = $facedata->{animinfo}; 3009 my $anims = $facedata->{animinfo};
2528 3010
2529 while (my ($anim, $info) = each %$anims) { 3011 while (my ($anim, $info) = each %$anims) {
2530 cf::anim::set $anim, $info->{frames}, $info->{facings}; 3012 cf::anim::set $anim, $info->{frames}, $info->{facings};
2531 Coro::cede; 3013 cf::cede_to_tick;
2532 } 3014 }
2533 3015
2534 cf::anim::invalidate_all; # d'oh 3016 cf::anim::invalidate_all; # d'oh
2535 } 3017 }
2536 3018
3019 {
3020 # TODO: for gcfclient pleasure, we should give resources
3021 # that gcfclient doesn't grok a >10000 face index.
3022 my $res = $facedata->{resource};
3023
3024 my $soundconf = delete $res->{"res/sound.conf"};
3025
3026 while (my ($name, $info) = each %$res) {
3027 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3028 my $data;
3029
3030 if ($info->{type} & 1) {
3031 # prepend meta info
3032
3033 my $meta = $enc->encode ({
3034 name => $name,
3035 %{ $info->{meta} || {} },
3036 });
3037
3038 $data = pack "(w/a*)*", $meta, $info->{data};
3039 } else {
3040 $data = $info->{data};
3041 }
3042
3043 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3044 cf::face::set_type $idx, $info->{type};
3045
3046 cf::cede_to_tick;
3047 }
3048
3049 if ($soundconf) {
3050 $soundconf = $enc->decode (delete $soundconf->{data});
3051
3052 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3053 my $sound = $soundconf->{compat}[$_]
3054 or next;
3055
3056 my $face = cf::face::find "sound/$sound->[1]";
3057 cf::sound::set $sound->[0] => $face;
3058 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3059 }
3060
3061 while (my ($k, $v) = each %{$soundconf->{event}}) {
3062 my $face = cf::face::find "sound/$v";
3063 cf::sound::set $k => $face;
3064 }
3065 }
3066 }
3067
2537 1 3068 1
2538} 3069}
2539 3070
3071register_exticmd fx_want => sub {
3072 my ($ns, $want) = @_;
3073
3074 while (my ($k, $v) = each %$want) {
3075 $ns->fx_want ($k, $v);
3076 }
3077};
3078
2540sub reload_regions { 3079sub reload_regions {
3080 # HACK to clear player env face cache, we need some signal framework
3081 # for this (global event?)
3082 %ext::player_env::MUSIC_FACE_CACHE = ();
3083
2541 load_resource_file "$MAPDIR/regions" 3084 load_resource_file "$MAPDIR/regions"
2542 or die "unable to load regions file\n"; 3085 or die "unable to load regions file\n";
3086
3087 for (cf::region::list) {
3088 $_->{match} = qr/$_->{match}/
3089 if exists $_->{match};
3090 }
2543} 3091}
2544 3092
2545sub reload_facedata { 3093sub reload_facedata {
2546 load_facedata "$DATADIR/facedata" 3094 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 3095 or die "unable to load facedata\n";
2548} 3096}
2549 3097
2550sub reload_archetypes { 3098sub reload_archetypes {
2551 load_resource_file "$DATADIR/archetypes" 3099 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 3100 or die "unable to load archetypes\n";
3101 #d# NEED to laod twice to resolve forward references
3102 # this really needs to be done in an extra post-pass
3103 # (which needs to be synchronous, so solve it differently)
3104 load_resource_file "$DATADIR/archetypes"
3105 or die "unable to load archetypes\n";
2553} 3106}
2554 3107
2555sub reload_treasures { 3108sub reload_treasures {
2556 load_resource_file "$DATADIR/treasures" 3109 load_resource_file "$DATADIR/treasures"
2557 or die "unable to load treasurelists\n"; 3110 or die "unable to load treasurelists\n";
2560sub reload_resources { 3113sub reload_resources {
2561 warn "reloading resource files...\n"; 3114 warn "reloading resource files...\n";
2562 3115
2563 reload_regions; 3116 reload_regions;
2564 reload_facedata; 3117 reload_facedata;
3118 #reload_archetypes;#d#
2565 reload_archetypes; 3119 reload_archetypes;
2566 reload_treasures; 3120 reload_treasures;
2567 3121
2568 warn "finished reloading resource files\n"; 3122 warn "finished reloading resource files\n";
2569} 3123}
2570 3124
2571sub init { 3125sub init {
2572 reload_resources; 3126 reload_resources;
2573} 3127}
2574 3128
2575sub cfg_load { 3129sub reload_config {
2576 open my $fh, "<:utf8", "$CONFDIR/config" 3130 open my $fh, "<:utf8", "$CONFDIR/config"
2577 or return; 3131 or return;
2578 3132
2579 local $/; 3133 local $/;
2580 *CFG = YAML::Syck::Load <$fh>; 3134 *CFG = YAML::Syck::Load <$fh>;
2600 (async { 3154 (async {
2601 Event::one_event; 3155 Event::one_event;
2602 })->prio (Coro::PRIO_MAX); 3156 })->prio (Coro::PRIO_MAX);
2603 }; 3157 };
2604 3158
2605 cfg_load; 3159 reload_config;
2606 db_init; 3160 db_init;
2607 load_extensions; 3161 load_extensions;
2608 3162
2609 $TICK_WATCHER->start; 3163 $TICK_WATCHER->start;
2610 Event::loop; 3164 Event::loop;
2626 }, 3180 },
2627 ); 3181 );
2628 } 3182 }
2629} 3183}
2630 3184
3185sub write_runtime {
3186 my $runtime = "$LOCALDIR/runtime";
3187
3188 # first touch the runtime file to show we are still running:
3189 # the fsync below can take a very very long time.
3190
3191 IO::AIO::aio_utime $runtime, undef, undef;
3192
3193 my $guard = cf::lock_acquire "write_runtime";
3194
3195 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3196 or return;
3197
3198 my $value = $cf::RUNTIME + 90 + 10;
3199 # 10 is the runtime save interval, for a monotonic clock
3200 # 60 allows for the watchdog to kill the server.
3201
3202 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3203 and return;
3204
3205 # always fsync - this file is important
3206 aio_fsync $fh
3207 and return;
3208
3209 # touch it again to show we are up-to-date
3210 aio_utime $fh, undef, undef;
3211
3212 close $fh
3213 or return;
3214
3215 aio_rename "$runtime~", $runtime
3216 and return;
3217
3218 warn "runtime file written.\n";
3219
3220 1
3221}
3222
2631sub emergency_save() { 3223sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop; 3224 my $freeze_guard = cf::freeze_mainloop;
2633 3225
2634 warn "enter emergency perl save\n"; 3226 warn "enter emergency perl save\n";
2635 3227
2710 %EXT_CORO = (); 3302 %EXT_CORO = ();
2711 3303
2712 warn "removing commands"; 3304 warn "removing commands";
2713 %COMMAND = (); 3305 %COMMAND = ();
2714 3306
2715 warn "removing ext commands"; 3307 warn "removing ext/exti commands";
2716 %EXTCMD = (); 3308 %EXTCMD = ();
3309 %EXTICMD = ();
2717 3310
2718 warn "unloading/nuking all extensions"; 3311 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) { 3312 for my $pkg (@EXTS) {
2720 warn "... unloading $pkg"; 3313 warn "... unloading $pkg";
2721 3314
2764 warn "reloading cf.pm"; 3357 warn "reloading cf.pm";
2765 require cf; 3358 require cf;
2766 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3359 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2767 3360
2768 warn "loading config and database again"; 3361 warn "loading config and database again";
2769 cf::cfg_load; 3362 cf::reload_config;
2770 3363
2771 warn "loading extensions"; 3364 warn "loading extensions";
2772 cf::load_extensions; 3365 cf::load_extensions;
2773 3366
2774 warn "reattaching attachments to objects/players"; 3367 warn "reattaching attachments to objects/players";
2867 or die; 3460 or die;
2868 3461
2869 $map->width (50); 3462 $map->width (50);
2870 $map->height (50); 3463 $map->height (50);
2871 $map->alloc; 3464 $map->alloc;
2872 $map->_load_objects ("/tmp/x.map", 1); 3465 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
2873 my $t = Event::time - $t; 3466 my $t = Event::time - $t;
2874 3467
2875 #next unless $t < 0.0013;#d# 3468 #next unless $t < 0.0013;#d#
2876 if ($t < $min) { 3469 if ($t < $min) {
2877 $min = $t; 3470 $min = $t;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines