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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines