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.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.358 by root, Fri Sep 7 18:10:52 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#############################################################################
1265
1266=back
992 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
1046 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1321 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1047 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1322 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1048 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1323 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1049 aio_unlink +(playerdir $login) . "/$login.pl"; 1324 aio_unlink +(playerdir $login) . "/$login.pl";
1050 1325
1051 my $pl = load_pl path $login 1326 my $f = new_from_file cf::object::thawer path $login
1052 or return; 1327 or return;
1328
1329 $f->next;
1330 my $pl = cf::player::load_pl $f
1331 or return;
1332 local $cf::PLAYER_LOADING{$login} = $pl;
1333 $f->resolve_delayed_derefs;
1053 $cf::PLAYER{$login} = $pl 1334 $cf::PLAYER{$login} = $pl
1054 } 1335 }
1055 } 1336 }
1056} 1337}
1057 1338
1067 1348
1068 aio_mkdir playerdir $pl, 0770; 1349 aio_mkdir playerdir $pl, 0770;
1069 $pl->{last_save} = $cf::RUNTIME; 1350 $pl->{last_save} = $cf::RUNTIME;
1070 1351
1071 $pl->save_pl ($path); 1352 $pl->save_pl ($path);
1072 Coro::cede; 1353 cf::cede_to_tick;
1073} 1354}
1074 1355
1075sub new($) { 1356sub new($) {
1076 my ($login) = @_; 1357 my ($login) = @_;
1077 1358
1081 $self->{deny_save} = 1; 1362 $self->{deny_save} = 1;
1082 1363
1083 $cf::PLAYER{$login} = $self; 1364 $cf::PLAYER{$login} = $self;
1084 1365
1085 $self 1366 $self
1367}
1368
1369=item $player->send_msg ($channel, $msg, $color, [extra...])
1370
1371=cut
1372
1373sub send_msg {
1374 my $ns = shift->ns
1375 or return;
1376 $ns->send_msg (@_);
1086} 1377}
1087 1378
1088=item $pl->quit_character 1379=item $pl->quit_character
1089 1380
1090Nukes the player without looking back. If logged in, the connection will 1381Nukes the player without looking back. If logged in, the connection will
1145 or return []; 1436 or return [];
1146 1437
1147 my @logins; 1438 my @logins;
1148 1439
1149 for my $login (@$dirs) { 1440 for my $login (@$dirs) {
1441 my $path = path $login;
1442
1443 # a .pst is a dead give-away for a valid player
1444 unless (-e "$path.pst") {
1150 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1445 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1151 aio_read $fh, 0, 512, my $buf, 0 or next; 1446 aio_read $fh, 0, 512, my $buf, 0 or next;
1152 $buf !~ /^password -------------$/m or next; # official not-valid tag 1447 $buf !~ /^password -------------$/m or next; # official not-valid tag
1448 }
1153 1449
1154 utf8::decode $login; 1450 utf8::decode $login;
1155 push @logins, $login; 1451 push @logins, $login;
1156 } 1452 }
1157 1453
1184 } 1480 }
1185 1481
1186 \@paths 1482 \@paths
1187} 1483}
1188 1484
1485=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1486
1487Expand crossfire pod fragments into protocol xml.
1488
1489=cut
1490
1491sub expand_cfpod {
1492 ((my $self), (local $_)) = @_;
1493
1494 # escape & and <
1495 s/&/&amp;/g;
1496 s/(?<![BIUGHT])</&lt;/g;
1497
1498 # this is buggy, it needs to properly take care of nested <'s
1499
1500 1 while
1501 # replace B<>, I<>, U<> etc.
1502 s/B<([^\>]*)>/<b>$1<\/b>/
1503 || s/I<([^\>]*)>/<i>$1<\/i>/
1504 || s/U<([^\>]*)>/<u>$1<\/u>/
1505 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1506 # replace G<male|female> tags
1507 || s{G<([^>|]*)\|([^>]*)>}{
1508 $self->gender ? $2 : $1
1509 }ge
1510 # replace H<hint text>
1511 || s{H<([^\>]*)>}
1512 {
1513 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1514 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1515 "")
1516 [$self->{hintmode}]
1517 }ge;
1518
1519 # create single paragraphs (very hackish)
1520 s/(?<=\S)\n(?=\w)/ /g;
1521
1522 # compress some whitespace
1523 s/\s+\n/\n/g; # ws line-ends
1524 s/\n\n+/\n/g; # double lines
1525 s/^\n+//; # beginning lines
1526 s/\n+$//; # ending lines
1527
1528 $_
1529}
1530
1531sub hintmode {
1532 $_[0]{hintmode} = $_[1] if @_ > 1;
1533 $_[0]{hintmode}
1534}
1535
1189=item $player->ext_reply ($msgid, %msg) 1536=item $player->ext_reply ($msgid, @msg)
1190 1537
1191Sends an ext reply to the player. 1538Sends an ext reply to the player.
1192 1539
1193=cut 1540=cut
1194 1541
1195sub ext_reply($$%) { 1542sub ext_reply($$@) {
1196 my ($self, $id, %msg) = @_; 1543 my ($self, $id, @msg) = @_;
1197 1544
1198 $msg{msgid} = $id; 1545 $self->ns->ext_reply ($id, @msg)
1199
1200 $self->send ("ext " . cf::to_json \%msg);
1201} 1546}
1202 1547
1203=item $player->ext_event ($type, %msg) 1548=item $player->ext_msg ($type, @msg)
1204 1549
1205Sends an ext event to the client. 1550Sends an ext event to the client.
1206 1551
1207=cut 1552=cut
1208 1553
1209sub ext_event($$%) { 1554sub ext_msg($$@) {
1210 my ($self, $type, %msg) = @_; 1555 my ($self, $type, @msg) = @_;
1211 1556
1212 $self->ns->ext_event ($type, %msg); 1557 $self->ns->ext_msg ($type, @msg);
1213} 1558}
1214 1559
1215=head3 cf::region 1560=head3 cf::region
1216 1561
1217=over 4 1562=over 4
1220 1565
1221package cf::region; 1566package cf::region;
1222 1567
1223=item cf::region::find_by_path $path 1568=item cf::region::find_by_path $path
1224 1569
1225Tries to decuce the probable region for a map knowing only its path. 1570Tries to decuce the likely region for a map knowing only its path.
1226 1571
1227=cut 1572=cut
1228 1573
1229sub find_by_path($) { 1574sub find_by_path($) {
1230 my ($path) = @_; 1575 my ($path) = @_;
1231 1576
1232 my ($match, $specificity); 1577 my ($match, $specificity);
1233 1578
1234 for my $region (list) { 1579 for my $region (list) {
1235 if ($region->match && $path =~ $region->match) { 1580 if ($region->{match} && $path =~ $region->{match}) {
1236 ($match, $specificity) = ($region, $region->specificity) 1581 ($match, $specificity) = ($region, $region->specificity)
1237 if $region->specificity > $specificity; 1582 if $region->specificity > $specificity;
1238 } 1583 }
1239 } 1584 }
1240 1585
1304 my ($self, $merge) = @_; 1649 my ($self, $merge) = @_;
1305 1650
1306 # we have to keep some variables in memory intact 1651 # we have to keep some variables in memory intact
1307 local $self->{path}; 1652 local $self->{path};
1308 local $self->{load_path}; 1653 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1654
1312 $self->SUPER::thawer_merge ($merge); 1655 $self->SUPER::thawer_merge ($merge);
1313} 1656}
1314 1657
1315sub normalise { 1658sub normalise {
1362 $self->init; # pass $1 etc. 1705 $self->init; # pass $1 etc.
1363 return $self; 1706 return $self;
1364 } 1707 }
1365 } 1708 }
1366 1709
1367 Carp::carp "unable to resolve path '$path' (base '$base')."; 1710 Carp::cluck "unable to resolve path '$path' (base '$base').";
1368 () 1711 ()
1369} 1712}
1370 1713
1371sub init { 1714sub init {
1372 my ($self) = @_; 1715 my ($self) = @_;
1415 1758
1416 $_->change_map_light ($change) 1759 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1760 for grep $_->outdoor, values %cf::MAP;
1418} 1761}
1419 1762
1763sub decay_objects {
1764 my ($self) = @_;
1765
1766 return if $self->{deny_reset};
1767
1768 $self->do_decay_objects;
1769}
1770
1420sub unlink_save { 1771sub unlink_save {
1421 my ($self) = @_; 1772 my ($self) = @_;
1422 1773
1423 utf8::encode (my $save = $self->save_path); 1774 utf8::encode (my $save = $self->save_path);
1424 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1775 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1427 1778
1428sub load_header_from($) { 1779sub load_header_from($) {
1429 my ($self, $path) = @_; 1780 my ($self, $path) = @_;
1430 1781
1431 utf8::encode $path; 1782 utf8::encode $path;
1432 #aio_open $path, O_RDONLY, 0 1783 my $f = new_from_file cf::object::thawer $path
1433 # or return;
1434
1435 $self->_load_header ($path)
1436 or return; 1784 or return;
1785
1786 $self->_load_header ($f)
1787 or return;
1788
1789 local $MAP_LOADING{$self->{path}} = $self;
1790 $f->resolve_delayed_derefs;
1437 1791
1438 $self->{load_path} = $path; 1792 $self->{load_path} = $path;
1439 1793
1440 1 1794 1
1441} 1795}
1480 $self->load_header_orig 1834 $self->load_header_orig
1481 or return; 1835 or return;
1482 $self->prepare_orig; 1836 $self->prepare_orig;
1483 } 1837 }
1484 1838
1839 $self->{deny_reset} = 1
1840 if $self->no_reset;
1841
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1842 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1843 unless $self->default_region;
1487 1844
1488 1 1845 1
1489} 1846}
1492sub find { 1849sub find {
1493 my ($path, $origin) = @_; 1850 my ($path, $origin) = @_;
1494 1851
1495 $path = normalise $path, $origin && $origin->path; 1852 $path = normalise $path, $origin && $origin->path;
1496 1853
1854 cf::lock_wait "map_data:$path";#d#remove
1497 cf::lock_wait "map_find:$path"; 1855 cf::lock_wait "map_find:$path";
1498 1856
1499 $cf::MAP{$path} || do { 1857 $cf::MAP{$path} || do {
1500 my $guard = cf::lock_acquire "map_find:$path"; 1858 my $guard1 = cf::lock_acquire "map_find:$path";
1859 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1860
1501 my $map = new_from_path cf::map $path 1861 my $map = new_from_path cf::map $path
1502 or return; 1862 or return;
1503 1863
1504 $map->{last_save} = $cf::RUNTIME; 1864 $map->{last_save} = $cf::RUNTIME;
1505 1865
1506 $map->load_header 1866 $map->load_header
1507 or return; 1867 or return;
1508 1868
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1869 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1870 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1871 #$cf::WAIT_FOR_TICK->wait;
1872 undef $guard1;
1873 undef $guard2;
1512 $map->reset; 1874 $map->reset;
1513 undef $guard;
1514 return find $path; 1875 return find $path;
1515 } 1876 }
1516 1877
1517 $cf::MAP{$path} = $map 1878 $cf::MAP{$path} = $map
1518 } 1879 }
1527 local $self->{deny_reset} = 1; # loading can take a long time 1888 local $self->{deny_reset} = 1; # loading can take a long time
1528 1889
1529 my $path = $self->{path}; 1890 my $path = $self->{path};
1530 1891
1531 { 1892 {
1532 my $guard = cf::lock_acquire "map_load:$path"; 1893 my $guard = cf::lock_acquire "map_data:$path";
1533 1894
1895 return unless $self->valid;
1534 return if $self->in_memory != cf::MAP_SWAPPED; 1896 return if $self->in_memory != cf::MAP_SWAPPED;
1535 1897
1536 $self->in_memory (cf::MAP_LOADING); 1898 $self->in_memory (cf::MAP_LOADING);
1537 1899
1538 $self->alloc; 1900 $self->alloc;
1539 1901
1540 $self->pre_load; 1902 $self->pre_load;
1541 Coro::cede; 1903 cf::cede_to_tick;
1542 1904
1905 my $f = new_from_file cf::object::thawer $self->{load_path};
1906 $f->skip_block;
1543 $self->_load_objects ($self->{load_path}, 1) 1907 $self->_load_objects ($f)
1544 or return; 1908 or return;
1545 1909
1546 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1910 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1547 if delete $self->{load_original}; 1911 if delete $self->{load_original};
1548 1912
1549 if (my $uniq = $self->uniq_path) { 1913 if (my $uniq = $self->uniq_path) {
1550 utf8::encode $uniq; 1914 utf8::encode $uniq;
1551 if (aio_open $uniq, O_RDONLY, 0) { 1915 unless (aio_stat $uniq) {
1916 if (my $f = new_from_file cf::object::thawer $uniq) {
1552 $self->clear_unique_items; 1917 $self->clear_unique_items;
1553 $self->_load_objects ($uniq, 0); 1918 $self->_load_objects ($f);
1919 $f->resolve_delayed_derefs;
1920 }
1554 } 1921 }
1555 } 1922 }
1556 1923
1557 Coro::cede; 1924 $f->resolve_delayed_derefs;
1925
1926 cf::cede_to_tick;
1558 # now do the right thing for maps 1927 # now do the right thing for maps
1559 $self->link_multipart_objects; 1928 $self->link_multipart_objects;
1560 $self->difficulty ($self->estimate_difficulty) 1929 $self->difficulty ($self->estimate_difficulty)
1561 unless $self->difficulty; 1930 unless $self->difficulty;
1562 Coro::cede; 1931 cf::cede_to_tick;
1563 1932
1564 unless ($self->{deny_activate}) { 1933 unless ($self->{deny_activate}) {
1565 $self->decay_objects; 1934 $self->decay_objects;
1566 $self->fix_auto_apply; 1935 $self->fix_auto_apply;
1567 $self->update_buttons; 1936 $self->update_buttons;
1568 Coro::cede; 1937 cf::cede_to_tick;
1569 $self->set_darkness_map; 1938 $self->set_darkness_map;
1570 Coro::cede; 1939 cf::cede_to_tick;
1571 $self->activate; 1940 $self->activate;
1572 } 1941 }
1942
1943 $self->{last_save} = $cf::RUNTIME;
1944 $self->last_access ($cf::RUNTIME);
1573 1945
1574 $self->in_memory (cf::MAP_IN_MEMORY); 1946 $self->in_memory (cf::MAP_IN_MEMORY);
1575 } 1947 }
1576 1948
1577 $self->post_load; 1949 $self->post_load;
1581 my ($self, $ob) = @_; 1953 my ($self, $ob) = @_;
1582 1954
1583 return find "~" . $ob->name . "/" . $self->{path} 1955 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1956 if $self->per_player;
1585 1957
1958# return find "?party/" . $ob->name . "/" . $self->{path}
1959# if $self->per_party;
1960
1586 $self 1961 $self
1587} 1962}
1588 1963
1589# find and load all maps in the 3x3 area around a map 1964# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1965sub load_neighbours {
1591 my ($map) = @_; 1966 my ($map) = @_;
1592 1967
1593 my @diag; # diagonal neighbours 1968 my @neigh; # diagonal neighbours
1594 1969
1595 for (0 .. 3) { 1970 for (0 .. 3) {
1596 my $neigh = $map->tile_path ($_) 1971 my $neigh = $map->tile_path ($_)
1597 or next; 1972 or next;
1598 $neigh = find $neigh, $map 1973 $neigh = find $neigh, $map
1599 or next; 1974 or next;
1600 $neigh->load; 1975 $neigh->load;
1601 1976
1977 push @neigh,
1602 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1978 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1603 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1979 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1604 } 1980 }
1605 1981
1606 for (@diag) { 1982 for (grep defined $_->[0], @neigh) {
1983 my ($path, $origin) = @$_;
1607 my $neigh = find @$_ 1984 my $neigh = find $path, $origin
1608 or next; 1985 or next;
1609 $neigh->load; 1986 $neigh->load;
1610 } 1987 }
1611} 1988}
1612 1989
1617} 1994}
1618 1995
1619sub do_load_sync { 1996sub do_load_sync {
1620 my ($map) = @_; 1997 my ($map) = @_;
1621 1998
1999 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2000 if $Coro::current == $Coro::main;
2001
1622 cf::sync_job { $map->load }; 2002 cf::sync_job { $map->load };
1623} 2003}
1624 2004
1625our %MAP_PREFETCH; 2005our %MAP_PREFETCH;
1626our $MAP_PREFETCHER = undef; 2006our $MAP_PREFETCHER = undef;
1627 2007
1628sub find_async { 2008sub find_async {
1629 my ($path, $origin) = @_; 2009 my ($path, $origin, $load) = @_;
1630 2010
1631 $path = normalise $path, $origin && $origin->{path}; 2011 $path = normalise $path, $origin && $origin->{path};
1632 2012
1633 if (my $map = $cf::MAP{$path}) { 2013 if (my $map = $cf::MAP{$path}) {
1634 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2014 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1635 } 2015 }
1636 2016
1637 undef $MAP_PREFETCH{$path}; 2017 $MAP_PREFETCH{$path} |= $load;
2018
1638 $MAP_PREFETCHER ||= cf::async { 2019 $MAP_PREFETCHER ||= cf::async {
1639 while (%MAP_PREFETCH) { 2020 while (%MAP_PREFETCH) {
1640 for my $path (keys %MAP_PREFETCH) { 2021 while (my ($k, $v) = each %MAP_PREFETCH) {
1641 my $map = find $path 2022 if (my $map = find $k) {
1642 or next;
1643 $map->load; 2023 $map->load if $v;
2024 }
1644 2025
1645 delete $MAP_PREFETCH{$path}; 2026 delete $MAP_PREFETCH{$k};
1646 } 2027 }
1647 } 2028 }
1648 undef $MAP_PREFETCHER; 2029 undef $MAP_PREFETCHER;
1649 }; 2030 };
1650 $MAP_PREFETCHER->prio (6); 2031 $MAP_PREFETCHER->prio (6);
1653} 2034}
1654 2035
1655sub save { 2036sub save {
1656 my ($self) = @_; 2037 my ($self) = @_;
1657 2038
1658 my $lock = cf::lock_acquire "map_data:" . $self->path; 2039 my $lock = cf::lock_acquire "map_data:$self->{path}";
1659 2040
1660 $self->{last_save} = $cf::RUNTIME; 2041 $self->{last_save} = $cf::RUNTIME;
1661 2042
1662 return unless $self->dirty; 2043 return unless $self->dirty;
1663 2044
1686 my ($self) = @_; 2067 my ($self) = @_;
1687 2068
1688 # save first because save cedes 2069 # save first because save cedes
1689 $self->save; 2070 $self->save;
1690 2071
1691 my $lock = cf::lock_acquire "map_data:" . $self->path; 2072 my $lock = cf::lock_acquire "map_data:$self->{path}";
1692 2073
1693 return if $self->players; 2074 return if $self->players;
1694 return if $self->in_memory != cf::MAP_IN_MEMORY; 2075 return if $self->in_memory != cf::MAP_IN_MEMORY;
1695 return if $self->{deny_save}; 2076 return if $self->{deny_save};
1696 2077
2078 $self->deactivate;
1697 $self->clear; 2079 $self->clear;
1698 $self->in_memory (cf::MAP_SWAPPED); 2080 $self->in_memory (cf::MAP_SWAPPED);
1699} 2081}
1700 2082
1701sub reset_at { 2083sub reset_at {
1702 my ($self) = @_; 2084 my ($self) = @_;
1703 2085
1704 # TODO: safety, remove and allow resettable per-player maps 2086 # 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}; 2087 return 1e99 if $self->{deny_reset};
1707 2088
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2089 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2090 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 2091
1721 my ($self) = @_; 2102 my ($self) = @_;
1722 2103
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2104 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 2105
1725 return if $self->players; 2106 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 2107
1728 warn "resetting map ", $self->path;#d# 2108 warn "resetting map ", $self->path;
1729 2109
1730 $self->in_memory (cf::MAP_SWAPPED); 2110 $self->in_memory (cf::MAP_SWAPPED);
1731 2111
1732 # need to save uniques path 2112 # need to save uniques path
1733 unless ($self->{deny_save}) { 2113 unless ($self->{deny_save}) {
1737 if $uniq; 2117 if $uniq;
1738 } 2118 }
1739 2119
1740 delete $cf::MAP{$self->path}; 2120 delete $cf::MAP{$self->path};
1741 2121
2122 $self->deactivate;
1742 $self->clear; 2123 $self->clear;
1743 2124
1744 $_->clear_links_to ($self) for values %cf::MAP; 2125 $_->clear_links_to ($self) for values %cf::MAP;
1745 2126
1746 $self->unlink_save; 2127 $self->unlink_save;
1750my $nuke_counter = "aaaa"; 2131my $nuke_counter = "aaaa";
1751 2132
1752sub nuke { 2133sub nuke {
1753 my ($self) = @_; 2134 my ($self) = @_;
1754 2135
2136 {
2137 my $lock = cf::lock_acquire "map_data:$self->{path}";
2138
1755 delete $cf::MAP{$self->path}; 2139 delete $cf::MAP{$self->path};
1756 2140
1757 $self->unlink_save; 2141 $self->unlink_save;
1758 2142
1759 bless $self, "cf::map"; 2143 bless $self, "cf::map";
1760 delete $self->{deny_reset}; 2144 delete $self->{deny_reset};
1761 $self->{deny_save} = 1; 2145 $self->{deny_save} = 1;
1762 $self->reset_timeout (1); 2146 $self->reset_timeout (1);
1763 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2147 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1764 2148
1765 $cf::MAP{$self->path} = $self; 2149 $cf::MAP{$self->path} = $self;
2150 }
1766 2151
1767 $self->reset; # polite request, might not happen 2152 $self->reset; # polite request, might not happen
2153}
2154
2155=item $maps = cf::map::tmp_maps
2156
2157Returns an arrayref with all map paths of currently instantiated and saved
2158maps. May block.
2159
2160=cut
2161
2162sub tmp_maps() {
2163 [
2164 map {
2165 utf8::decode $_;
2166 /\.map$/
2167 ? normalise $_
2168 : ()
2169 } @{ aio_readdir $TMPDIR or [] }
2170 ]
2171}
2172
2173=item $maps = cf::map::random_maps
2174
2175Returns an arrayref with all map paths of currently instantiated and saved
2176random maps. May block.
2177
2178=cut
2179
2180sub random_maps() {
2181 [
2182 map {
2183 utf8::decode $_;
2184 /\.map$/
2185 ? normalise "?random/$_"
2186 : ()
2187 } @{ aio_readdir $RANDOMDIR or [] }
2188 ]
1768} 2189}
1769 2190
1770=item cf::map::unique_maps 2191=item cf::map::unique_maps
1771 2192
1772Returns an arrayref of paths of all shared maps that have 2193Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2194instantiated unique items. May block.
1774 2195
1775=cut 2196=cut
1776 2197
1777sub unique_maps() { 2198sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2199 [
1779 or return; 2200 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2201 utf8::decode $_;
1785 next if /\.pst$/; 2202 /\.map$/
1786 next unless /^$PATH_SEP/o; 2203 ? normalise $_
1787 2204 : ()
1788 push @paths, cf::map::normalise $_; 2205 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2206 ]
1790
1791 \@paths
1792} 2207}
1793 2208
1794package cf; 2209package cf;
1795 2210
1796=back 2211=back
1814 map { $_, inv_recursive_ $_->inv } @_ 2229 map { $_, inv_recursive_ $_->inv } @_
1815} 2230}
1816 2231
1817sub inv_recursive { 2232sub inv_recursive {
1818 inv_recursive_ inv $_[0] 2233 inv_recursive_ inv $_[0]
2234}
2235
2236=item $ref = $ob->ref
2237
2238creates and returns a persistent reference to an objetc that can be stored as a string.
2239
2240=item $ob = cf::object::deref ($refstring)
2241
2242returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2243even if the object actually exists. May block.
2244
2245=cut
2246
2247sub deref {
2248 my ($ref) = @_;
2249
2250 # temporary compatibility#TODO#remove
2251 $ref =~ s{^<}{player/<};
2252
2253 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2254 my ($uuid, $name) = ($1, $2);
2255 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2256 or return;
2257 $pl->ob->uuid eq $uuid
2258 or return;
2259
2260 $pl->ob
2261 } else {
2262 warn "$ref: cannot resolve object reference\n";
2263 undef
2264 }
1819} 2265}
1820 2266
1821package cf; 2267package cf;
1822 2268
1823=back 2269=back
1842 2288
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2289 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2290
1845 if ($self->{record_replies}) { 2291 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2292 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2293
1847 } else { 2294 } else {
2295 my $pl = $self->contr;
2296
2297 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2298 my $dialog = $pl->{npc_dialog};
2299 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2300
2301 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2302 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2303 $self->message ($msg, $flags);
2304 }
1850 } 2305 }
2306}
2307
2308=item $object->send_msg ($channel, $msg, $color, [extra...])
2309
2310=cut
2311
2312sub cf::object::send_msg {
2313 my $pl = shift->contr
2314 or return;
2315 $pl->send_msg (@_);
1851} 2316}
1852 2317
1853=item $player_object->may ("access") 2318=item $player_object->may ("access")
1854 2319
1855Returns wether the given player is authorized to access resource "access" 2320Returns wether the given player is authorized to access resource "access"
1934 # use -1 or undef as default coordinates, not 0, 0 2399 # use -1 or undef as default coordinates, not 0, 0
1935 ($x, $y) = ($map->enter_x, $map->enter_y) 2400 ($x, $y) = ($map->enter_x, $map->enter_y)
1936 if $x <=0 && $y <= 0; 2401 if $x <=0 && $y <= 0;
1937 2402
1938 $map->load; 2403 $map->load;
1939 $map->load_diag; 2404 $map->load_neighbours;
1940 2405
1941 return unless $self->contr->active; 2406 return unless $self->contr->active;
1942 $self->activate_recursive; 2407 $self->activate_recursive;
1943 2408
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2409 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2410 $self->enter_map ($map, $x, $y);
1946} 2411}
1947 2412
1948=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2413=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949 2414
1950Moves the player to the given map-path and coordinates by first freezing 2415Moves the player to the given map-path and coordinates by first freezing
1951her, loading and preparing them map, calling the provided $check callback 2416her, loading and preparing them map, calling the provided $check callback
1952that has to return the map if sucecssful, and then unfreezes the player on 2417that has to return the map if sucecssful, and then unfreezes the player on
1953the new (success) or old (failed) map position. 2418the new (success) or old (failed) map position. In either case, $done will
2419be called at the end of this process.
1954 2420
1955=cut 2421=cut
1956 2422
1957our $GOTOGEN; 2423our $GOTOGEN;
1958 2424
1959sub cf::object::player::goto { 2425sub cf::object::player::goto {
1960 my ($self, $path, $x, $y, $check) = @_; 2426 my ($self, $path, $x, $y, $check, $done) = @_;
1961 2427
1962 # do generation counting so two concurrent goto's will be executed in-order 2428 # do generation counting so two concurrent goto's will be executed in-order
1963 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2429 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964 2430
1965 $self->enter_link; 2431 $self->enter_link;
1985 2451
1986 if ($gen == $self->{_goto_generation}) { 2452 if ($gen == $self->{_goto_generation}) {
1987 delete $self->{_goto_generation}; 2453 delete $self->{_goto_generation};
1988 $self->leave_link ($map, $x, $y); 2454 $self->leave_link ($map, $x, $y);
1989 } 2455 }
2456
2457 $done->() if $done;
1990 })->prio (1); 2458 })->prio (1);
1991} 2459}
1992 2460
1993=item $player_object->enter_exit ($exit_object) 2461=item $player_object->enter_exit ($exit_object)
1994 2462
2063 my $hp = $exit->stats->hp; 2531 my $hp = $exit->stats->hp;
2064 my $sp = $exit->stats->sp; 2532 my $sp = $exit->stats->sp;
2065 2533
2066 $self->enter_link; 2534 $self->enter_link;
2067 2535
2536 # if exit is damned, update players death & WoR home-position
2537 $self->contr->savebed ($slaying, $hp, $sp)
2538 if $exit->flag (FLAG_DAMNED);
2539
2068 (async { 2540 (async {
2069 $self->deactivate_recursive; # just to be sure 2541 $self->deactivate_recursive; # just to be sure
2070 unless (eval { 2542 unless (eval {
2071 $self->goto ($slaying, $hp, $sp); 2543 $self->goto ($slaying, $hp, $sp);
2072 2544
2099 2571
2100 utf8::encode $text; 2572 utf8::encode $text;
2101 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2573 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102} 2574}
2103 2575
2576=item $client->send_msg ($channel, $msg, $color, [extra...])
2577
2578Send a drawinfo or msg packet to the client, formatting the msg for the
2579client if neccessary. C<$type> should be a string identifying the type of
2580the message, with C<log> being the default. If C<$color> is negative, suppress
2581the message unless the client supports the msg packet.
2582
2583=cut
2584
2585our %CHANNEL = (
2586 "c/identify" => {
2587 id => "identify",
2588 title => "Identify",
2589 reply => undef,
2590 tooltip => "Items recently identified",
2591 },
2592 "c/examine" => {
2593 id => "examine",
2594 title => "Examine",
2595 reply => undef,
2596 tooltip => "Signs and other items you examined",
2597 },
2598);
2599
2600sub cf::client::send_msg {
2601 my ($self, $channel, $msg, $color, @extra) = @_;
2602
2603 $msg = $self->pl->expand_cfpod ($msg);
2604
2605 $color &= cf::NDI_CLIENT_MASK; # just in case...
2606
2607 # check predefined channels, for the benefit of C
2608 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2609
2610 if (ref $channel) {
2611 # send meta info to client, if not yet sent
2612 unless (exists $self->{channel}{$channel->{id}}) {
2613 $self->{channel}{$channel->{id}} = $channel;
2614 $self->ext_msg (channel_info => $channel)
2615 if $self->can_msg;
2616 }
2617
2618 $channel = $channel->{id};
2619 }
2620
2621 return unless @extra || length $msg;
2622
2623 if ($self->can_msg) {
2624 # default colour, mask it out
2625 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2626 if $color & cf::NDI_DEF;
2627
2628 $self->send_packet ("msg " . $self->{json_coder}->encode (
2629 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2630 } else {
2631 if ($color >= 0) {
2632 # replace some tags by gcfclient-compatible ones
2633 for ($msg) {
2634 1 while
2635 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2636 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2637 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2638 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2639 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2640 }
2641
2642 $color &= cf::NDI_COLOR_MASK;
2643
2644 utf8::encode $msg;
2645
2646 if (0 && $msg =~ /\[/) {
2647 # COMMAND/INFO
2648 $self->send_packet ("drawextinfo $color 10 8 $msg")
2649 } else {
2650 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2651 $self->send_packet ("drawinfo $color $msg")
2652 }
2653 }
2654 }
2655}
2656
2104=item $client->ext_event ($type, %msg) 2657=item $client->ext_msg ($type, @msg)
2105 2658
2106Sends an exti event to the client. 2659Sends an ext event to the client.
2107 2660
2108=cut 2661=cut
2109 2662
2110sub cf::client::ext_event($$%) { 2663sub cf::client::ext_msg($$@) {
2111 my ($self, $type, %msg) = @_; 2664 my ($self, $type, @msg) = @_;
2112 2665
2666 if ($self->extcmd == 2) {
2667 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2668 } elsif ($self->extcmd == 1) { # TODO: remove
2113 $msg{msgtype} = "event_$type"; 2669 push @msg, msgtype => "event_$type";
2114 $self->send_packet ("ext " . cf::to_json \%msg); 2670 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2671 }
2672}
2673
2674=item $client->ext_reply ($msgid, @msg)
2675
2676Sends an ext reply to the client.
2677
2678=cut
2679
2680sub cf::client::ext_reply($$@) {
2681 my ($self, $id, @msg) = @_;
2682
2683 if ($self->extcmd == 2) {
2684 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2685 } elsif ($self->extcmd == 1) {
2686 #TODO: version 1, remove
2687 unshift @msg, msgtype => "reply", msgid => $id;
2688 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2689 }
2115} 2690}
2116 2691
2117=item $success = $client->query ($flags, "text", \&cb) 2692=item $success = $client->query ($flags, "text", \&cb)
2118 2693
2119Queues a query to the client, calling the given callback with 2694Queues a query to the client, calling the given callback with
2120the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2695the 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>. 2696C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122 2697
2123Queries can fail, so check the return code. Or don't, as queries will become 2698Queries can fail, so check the return code. Or don't, as queries will
2124reliable at some point in the future. 2699become reliable at some point in the future.
2125 2700
2126=cut 2701=cut
2127 2702
2128sub cf::client::query { 2703sub cf::client::query {
2129 my ($self, $flags, $text, $cb) = @_; 2704 my ($self, $flags, $text, $cb) = @_;
2137 utf8::encode $text; 2712 utf8::encode $text;
2138 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2713 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139 2714
2140 $self->send_packet ($self->{query_queue}[0][0]) 2715 $self->send_packet ($self->{query_queue}[0][0])
2141 if @{ $self->{query_queue} } == 1; 2716 if @{ $self->{query_queue} } == 1;
2717
2718 1
2142} 2719}
2143 2720
2144cf::client->attach ( 2721cf::client->attach (
2722 on_connect => sub {
2723 my ($ns) = @_;
2724
2725 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2726 },
2145 on_reply => sub { 2727 on_reply => sub {
2146 my ($ns, $msg) = @_; 2728 my ($ns, $msg) = @_;
2147 2729
2148 # this weird shuffling is so that direct followup queries 2730 # this weird shuffling is so that direct followup queries
2149 # get handled first 2731 # get handled first
2161 } else { 2743 } else {
2162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2744 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163 } 2745 }
2164 } 2746 }
2165 }, 2747 },
2748 on_exticmd => sub {
2749 my ($ns, $buf) = @_;
2750
2751 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2752
2753 if (ref $msg) {
2754 my ($type, $reply, @payload) =
2755 "ARRAY" eq ref $msg
2756 ? @$msg
2757 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2758
2759 my @reply;
2760
2761 if (my $cb = $EXTICMD{$type}) {
2762 @reply = $cb->($ns, @payload);
2763 }
2764
2765 $ns->ext_reply ($reply, @reply)
2766 if $reply;
2767
2768 } else {
2769 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2770 }
2771
2772 cf::override;
2773 },
2166); 2774);
2167 2775
2168=item $client->async (\&cb) 2776=item $client->async (\&cb)
2169 2777
2170Create a new coroutine, running the specified callback. The coroutine will 2778Create a new coroutine, running the specified callback. The coroutine will
2211our $safe = new Safe "safe"; 2819our $safe = new Safe "safe";
2212our $safe_hole = new Safe::Hole; 2820our $safe_hole = new Safe::Hole;
2213 2821
2214$SIG{FPE} = 'IGNORE'; 2822$SIG{FPE} = 'IGNORE';
2215 2823
2216$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2824$safe->permit_only (Opcode::opset qw(
2825 :base_core :base_mem :base_orig :base_math
2826 grepstart grepwhile mapstart mapwhile
2827 sort time
2828));
2217 2829
2218# here we export the classes and methods available to script code 2830# here we export the classes and methods available to script code
2219 2831
2220=pod 2832=pod
2221 2833
2222The following functions and methods are available within a safe environment: 2834The following functions and methods are available within a safe environment:
2223 2835
2224 cf::object contr pay_amount pay_player map 2836 cf::object
2837 contr pay_amount pay_player map x y force_find force_add
2838 insert remove name archname title slaying race decrease_ob_nr
2839
2225 cf::object::player player 2840 cf::object::player
2226 cf::player peaceful 2841 player
2227 cf::map trigger 2842
2843 cf::player
2844 peaceful
2845
2846 cf::map
2847 trigger
2228 2848
2229=cut 2849=cut
2230 2850
2231for ( 2851for (
2232 ["cf::object" => qw(contr pay_amount pay_player map)], 2852 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2853 insert remove inv name archname title slaying race
2854 decrease_ob_nr)],
2233 ["cf::object::player" => qw(player)], 2855 ["cf::object::player" => qw(player)],
2234 ["cf::player" => qw(peaceful)], 2856 ["cf::player" => qw(peaceful)],
2235 ["cf::map" => qw(trigger)], 2857 ["cf::map" => qw(trigger)],
2236) { 2858) {
2237 no strict 'refs'; 2859 no strict 'refs';
2308=back 2930=back
2309 2931
2310=cut 2932=cut
2311 2933
2312############################################################################# 2934#############################################################################
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 2935# the server's init and main functions
2486 2936
2487sub load_facedata($) { 2937sub load_facedata($) {
2488 my ($path) = @_; 2938 my ($path) = @_;
2939
2940 # HACK to clear player env face cache, we need some signal framework
2941 # for this (global event?)
2942 %ext::player_env::MUSIC_FACE_CACHE = ();
2943
2944 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2489 2945
2490 warn "loading facedata from $path\n"; 2946 warn "loading facedata from $path\n";
2491 2947
2492 my $facedata; 2948 my $facedata;
2493 0 < aio_load $path, $facedata 2949 0 < aio_load $path, $facedata
2496 $facedata = Coro::Storable::thaw $facedata; 2952 $facedata = Coro::Storable::thaw $facedata;
2497 2953
2498 $facedata->{version} == 2 2954 $facedata->{version} == 2
2499 or cf::cleanup "$path: version mismatch, cannot proceed."; 2955 or cf::cleanup "$path: version mismatch, cannot proceed.";
2500 2956
2957 # patch in the exptable
2958 $facedata->{resource}{"res/exp_table"} = {
2959 type => FT_RSRC,
2960 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2961 };
2962 cf::cede_to_tick;
2963
2501 { 2964 {
2502 my $faces = $facedata->{faceinfo}; 2965 my $faces = $facedata->{faceinfo};
2503 2966
2504 while (my ($face, $info) = each %$faces) { 2967 while (my ($face, $info) = each %$faces) {
2505 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2968 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2969 cf::face::set_visibility $idx, $info->{visibility};
2970 cf::face::set_magicmap $idx, $info->{magicmap};
2507 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2971 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2508 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2972 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2509 Coro::cede; 2973
2974 cf::cede_to_tick;
2510 } 2975 }
2511 2976
2512 while (my ($face, $info) = each %$faces) { 2977 while (my ($face, $info) = each %$faces) {
2513 next unless $info->{smooth}; 2978 next unless $info->{smooth};
2514 my $idx = cf::face::find $face 2979 my $idx = cf::face::find $face
2515 or next; 2980 or next;
2516 if (my $smooth = cf::face::find $info->{smooth}) { 2981 if (my $smooth = cf::face::find $info->{smooth}) {
2982 cf::face::set_smooth $idx, $smooth;
2517 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2983 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2518 } else { 2984 } else {
2519 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2985 warn "smooth face '$info->{smooth}' not found for face '$face'";
2520 } 2986 }
2521 Coro::cede; 2987
2988 cf::cede_to_tick;
2522 } 2989 }
2523 } 2990 }
2524 2991
2525 { 2992 {
2526 my $anims = $facedata->{animinfo}; 2993 my $anims = $facedata->{animinfo};
2527 2994
2528 while (my ($anim, $info) = each %$anims) { 2995 while (my ($anim, $info) = each %$anims) {
2529 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2996 cf::anim::set $anim, $info->{frames}, $info->{facings};
2530 Coro::cede; 2997 cf::cede_to_tick;
2531 } 2998 }
2532 2999
2533 cf::anim::invalidate_all; # d'oh 3000 cf::anim::invalidate_all; # d'oh
2534 } 3001 }
2535 3002
3003 {
3004 # TODO: for gcfclient pleasure, we should give resources
3005 # that gcfclient doesn't grok a >10000 face index.
3006 my $res = $facedata->{resource};
3007
3008 my $soundconf = delete $res->{"res/sound.conf"};
3009
3010 while (my ($name, $info) = each %$res) {
3011 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3012 my $data;
3013
3014 if ($info->{type} & 1) {
3015 # prepend meta info
3016
3017 my $meta = $enc->encode ({
3018 name => $name,
3019 %{ $info->{meta} || {} },
3020 });
3021
3022 $data = pack "(w/a*)*", $meta, $info->{data};
3023 } else {
3024 $data = $info->{data};
3025 }
3026
3027 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3028 cf::face::set_type $idx, $info->{type};
3029
3030 cf::cede_to_tick;
3031 }
3032
3033 if ($soundconf) {
3034 $soundconf = $enc->decode (delete $soundconf->{data});
3035
3036 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3037 my $sound = $soundconf->{compat}[$_]
3038 or next;
3039
3040 my $face = cf::face::find "sound/$sound->[1]";
3041 cf::sound::set $sound->[0] => $face;
3042 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3043 }
3044
3045 while (my ($k, $v) = each %{$soundconf->{event}}) {
3046 my $face = cf::face::find "sound/$v";
3047 cf::sound::set $k => $face;
3048 }
3049 }
3050 }
3051
2536 1 3052 1
2537} 3053}
2538 3054
3055register_exticmd fx_want => sub {
3056 my ($ns, $want) = @_;
3057
3058 while (my ($k, $v) = each %$want) {
3059 $ns->fx_want ($k, $v);
3060 }
3061};
3062
2539sub reload_regions { 3063sub reload_regions {
3064 # HACK to clear player env face cache, we need some signal framework
3065 # for this (global event?)
3066 %ext::player_env::MUSIC_FACE_CACHE = ();
3067
2540 load_resource_file "$MAPDIR/regions" 3068 load_resource_file "$MAPDIR/regions"
2541 or die "unable to load regions file\n"; 3069 or die "unable to load regions file\n";
3070
3071 for (cf::region::list) {
3072 $_->{match} = qr/$_->{match}/
3073 if exists $_->{match};
3074 }
2542} 3075}
2543 3076
2544sub reload_facedata { 3077sub reload_facedata {
2545 load_facedata "$DATADIR/facedata" 3078 load_facedata "$DATADIR/facedata"
2546 or die "unable to load facedata\n"; 3079 or die "unable to load facedata\n";
2547} 3080}
2548 3081
2549sub reload_archetypes { 3082sub reload_archetypes {
2550 load_resource_file "$DATADIR/archetypes" 3083 load_resource_file "$DATADIR/archetypes"
2551 or die "unable to load archetypes\n"; 3084 or die "unable to load archetypes\n";
3085 #d# NEED to laod twice to resolve forward references
3086 # this really needs to be done in an extra post-pass
3087 # (which needs to be synchronous, so solve it differently)
3088 load_resource_file "$DATADIR/archetypes"
3089 or die "unable to load archetypes\n";
2552} 3090}
2553 3091
2554sub reload_treasures { 3092sub reload_treasures {
2555 load_resource_file "$DATADIR/treasures" 3093 load_resource_file "$DATADIR/treasures"
2556 or die "unable to load treasurelists\n"; 3094 or die "unable to load treasurelists\n";
2559sub reload_resources { 3097sub reload_resources {
2560 warn "reloading resource files...\n"; 3098 warn "reloading resource files...\n";
2561 3099
2562 reload_regions; 3100 reload_regions;
2563 reload_facedata; 3101 reload_facedata;
3102 #reload_archetypes;#d#
2564 reload_archetypes; 3103 reload_archetypes;
2565 reload_treasures; 3104 reload_treasures;
2566 3105
2567 warn "finished reloading resource files\n"; 3106 warn "finished reloading resource files\n";
2568} 3107}
2569 3108
2570sub init { 3109sub init {
2571 reload_resources; 3110 reload_resources;
2572} 3111}
2573 3112
2574sub cfg_load { 3113sub reload_config {
2575 open my $fh, "<:utf8", "$CONFDIR/config" 3114 open my $fh, "<:utf8", "$CONFDIR/config"
2576 or return; 3115 or return;
2577 3116
2578 local $/; 3117 local $/;
2579 *CFG = YAML::Syck::Load <$fh>; 3118 *CFG = YAML::Syck::Load <$fh>;
2599 (async { 3138 (async {
2600 Event::one_event; 3139 Event::one_event;
2601 })->prio (Coro::PRIO_MAX); 3140 })->prio (Coro::PRIO_MAX);
2602 }; 3141 };
2603 3142
2604 cfg_load; 3143 reload_config;
2605 db_init; 3144 db_init;
2606 load_extensions; 3145 load_extensions;
2607 3146
2608 $TICK_WATCHER->start; 3147 $TICK_WATCHER->start;
2609 Event::loop; 3148 Event::loop;
2625 }, 3164 },
2626 ); 3165 );
2627 } 3166 }
2628} 3167}
2629 3168
3169sub write_runtime {
3170 my $runtime = "$LOCALDIR/runtime";
3171
3172 # first touch the runtime file to show we are still running:
3173 # the fsync below can take a very very long time.
3174
3175 IO::AIO::aio_utime $runtime, undef, undef;
3176
3177 my $guard = cf::lock_acquire "write_runtime";
3178
3179 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3180 or return;
3181
3182 my $value = $cf::RUNTIME + 90 + 10;
3183 # 10 is the runtime save interval, for a monotonic clock
3184 # 60 allows for the watchdog to kill the server.
3185
3186 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3187 and return;
3188
3189 # always fsync - this file is important
3190 aio_fsync $fh
3191 and return;
3192
3193 # touch it again to show we are up-to-date
3194 aio_utime $fh, undef, undef;
3195
3196 close $fh
3197 or return;
3198
3199 aio_rename "$runtime~", $runtime
3200 and return;
3201
3202 warn "runtime file written.\n";
3203
3204 1
3205}
3206
2630sub emergency_save() { 3207sub emergency_save() {
2631 my $freeze_guard = cf::freeze_mainloop; 3208 my $freeze_guard = cf::freeze_mainloop;
2632 3209
2633 warn "enter emergency perl save\n"; 3210 warn "enter emergency perl save\n";
2634 3211
2709 %EXT_CORO = (); 3286 %EXT_CORO = ();
2710 3287
2711 warn "removing commands"; 3288 warn "removing commands";
2712 %COMMAND = (); 3289 %COMMAND = ();
2713 3290
2714 warn "removing ext commands"; 3291 warn "removing ext/exti commands";
2715 %EXTCMD = (); 3292 %EXTCMD = ();
3293 %EXTICMD = ();
2716 3294
2717 warn "unloading/nuking all extensions"; 3295 warn "unloading/nuking all extensions";
2718 for my $pkg (@EXTS) { 3296 for my $pkg (@EXTS) {
2719 warn "... unloading $pkg"; 3297 warn "... unloading $pkg";
2720 3298
2763 warn "reloading cf.pm"; 3341 warn "reloading cf.pm";
2764 require cf; 3342 require cf;
2765 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3343 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2766 3344
2767 warn "loading config and database again"; 3345 warn "loading config and database again";
2768 cf::cfg_load; 3346 cf::reload_config;
2769 3347
2770 warn "loading extensions"; 3348 warn "loading extensions";
2771 cf::load_extensions; 3349 cf::load_extensions;
2772 3350
2773 warn "reattaching attachments to objects/players"; 3351 warn "reattaching attachments to objects/players";
2866 or die; 3444 or die;
2867 3445
2868 $map->width (50); 3446 $map->width (50);
2869 $map->height (50); 3447 $map->height (50);
2870 $map->alloc; 3448 $map->alloc;
2871 $map->_load_objects ("/tmp/x.map", 1); 3449 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
2872 my $t = Event::time - $t; 3450 my $t = Event::time - $t;
2873 3451
2874 #next unless $t < 0.0013;#d# 3452 #next unless $t < 0.0013;#d#
2875 if ($t < $min) { 3453 if ($t < $min) {
2876 $min = $t; 3454 $min = $t;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines