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.268 by root, Tue May 22 10:50:00 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 if (my $fh = aio_open $runtime, O_WRONLY, 0) { 487=cut
401 utime undef, undef, $fh;
402 }
403 488
404 my $guard = cf::lock_acquire "write_runtime"; 489sub fork_call(&@) {
490 my ($cb, @args) = @_;
405 491
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 492 # we seemingly have to make a local copy of the whole thing,
407 or return; 493 # otherwise perl prematurely frees the stuff :/
494 # TODO: investigate and fix (likely this will be rather laborious)
408 495
409 my $value = $cf::RUNTIME + 90 + 10; 496 my @res = Coro::Util::fork_eval {
410 # 10 is the runtime save interval, for a monotonic clock 497 reset_signals;
411 # 60 allows for the watchdog to kill the server. 498 &$cb
499 }, @args;
412 500
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0 501 wantarray ? @res : $res[-1]
414 and return; 502}
415 503
416 # always fsync - this file is important 504=item $value = cf::db_get $family => $key
417 aio_fsync $fh
418 and return;
419 505
420 # touch it again to show we are up-to-date 506Returns a single value from the environment database.
421 utime undef, undef, $fh;
422 507
423 close $fh 508=item cf::db_put $family => $key => $value
424 or return;
425 509
426 aio_rename "$runtime~", $runtime 510Stores the given C<$value> in the family. It can currently store binary
427 and return; 511data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
428 512
429 warn "runtime file written.\n";#d# 513=cut
430 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 };
431 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"
432} 618}
433 619
434=item cf::datalog type => key => value, ... 620=item cf::datalog type => key => value, ...
435 621
436Log 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.
454attach callbacks/event handlers (a collection of which is called an "attachment") 640attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 641to it. All such attachable objects support the following methods.
456 642
457In 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>
458C<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
459crossfire+). 645Crossfire TRT).
460 646
461=over 4 647=over 4
462 648
463=item $attachable->attach ($attachment, key => $value...) 649=item $attachable->attach ($attachment, key => $value...)
464 650
666 _attach $registry, $klass, @attach; 852 _attach $registry, $klass, @attach;
667 } 853 }
668 854
669 $obj->{$name} = \%arg; 855 $obj->{$name} = \%arg;
670 } else { 856 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 857 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 858 }
673 859
674 $obj->{_attachment}{$name} = undef; 860 $obj->{_attachment}{$name} = undef;
675} 861}
676 862
716 "; 902 ";
717 die if $@; 903 die if $@;
718} 904}
719 905
720our $override; 906our $override;
721our @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?
722 908
723sub override { 909sub override {
724 $override = 1; 910 $override = 1;
725 @invoke_results = (); 911 @INVOKE_RESULTS = (@_);
726} 912}
727 913
728sub do_invoke { 914sub do_invoke {
729 my $event = shift; 915 my $event = shift;
730 my $callbacks = shift; 916 my $callbacks = shift;
731 917
732 @invoke_results = (); 918 @INVOKE_RESULTS = ();
733 919
734 local $override; 920 local $override;
735 921
736 for (@$callbacks) { 922 for (@$callbacks) {
737 eval { &{$_->[1]} }; 923 eval { &{$_->[1]} };
754 940
755Generate an object-specific event with the given arguments. 941Generate an object-specific event with the given arguments.
756 942
757This 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
758removed 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
759results (if you must, access C<@cf::invoke_results> directly). 945results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760 946
761=back 947=back
762 948
763=cut 949=cut
764 950
765############################################################################# 951#############################################################################
766# 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}
767 964
768sub reattach { 965sub reattach {
769 # basically do the same as instantiate, without calling instantiate 966 # basically do the same as instantiate, without calling instantiate
770 my ($obj) = @_; 967 my ($obj) = @_;
771 968
815 }, 1012 },
816); 1013);
817 1014
818sub object_freezer_save { 1015sub object_freezer_save {
819 my ($filename, $rdata, $objs) = @_; 1016 my ($filename, $rdata, $objs) = @_;
1017
1018 my $guard = cf::lock_acquire "io";
820 1019
821 sync_job { 1020 sync_job {
822 if (length $$rdata) { 1021 if (length $$rdata) {
823 warn sprintf "saving %s (%d,%d)\n", 1022 warn sprintf "saving %s (%d,%d)\n",
824 $filename, length $$rdata, scalar @$objs; 1023 $filename, length $$rdata, scalar @$objs;
848 } 1047 }
849 } else { 1048 } else {
850 aio_unlink $filename; 1049 aio_unlink $filename;
851 aio_unlink "$filename.pst"; 1050 aio_unlink "$filename.pst";
852 } 1051 }
853 } 1052 };
1053
1054 undef $guard;
854} 1055}
855 1056
856sub object_freezer_as_string { 1057sub object_freezer_as_string {
857 my ($rdata, $objs) = @_; 1058 my ($rdata, $objs) = @_;
858 1059
863 1064
864sub object_thawer_load { 1065sub object_thawer_load {
865 my ($filename) = @_; 1066 my ($filename) = @_;
866 1067
867 my ($data, $av); 1068 my ($data, $av);
1069
1070 my $guard = cf::lock_acquire "io";
868 1071
869 (aio_load $filename, $data) >= 0 1072 (aio_load $filename, $data) >= 0
870 or return; 1073 or return;
871 1074
872 unless (aio_stat "$filename.pst") { 1075 unless (aio_stat "$filename.pst") {
873 (aio_load "$filename.pst", $av) >= 0 1076 (aio_load "$filename.pst", $av) >= 0
874 or return; 1077 or return;
1078
1079 undef $guard;
875 $av = eval { (Storable::thaw $av)->{objs} }; 1080 $av = eval { (Storable::thaw $av)->{objs} };
876 } 1081 }
877 1082
878 warn sprintf "loading %s (%d)\n", 1083 warn sprintf "loading %s (%d)\n",
879 $filename, length $data, scalar @{$av || []};#d# 1084 $filename, length $data, scalar @{$av || []};
1085
880 return ($data, $av); 1086 ($data, $av)
881} 1087}
1088
1089=head2 COMMAND CALLBACKS
1090
1091=over 4
1092
1093=cut
882 1094
883############################################################################# 1095#############################################################################
884# command handling &c 1096# command handling &c
885 1097
886=item cf::register_command $name => \&callback($ob,$args); 1098=item cf::register_command $name => \&callback($ob,$args);
899 push @{ $COMMAND{$name} }, [$caller, $cb]; 1111 push @{ $COMMAND{$name} }, [$caller, $cb];
900} 1112}
901 1113
902=item cf::register_extcmd $name => \&callback($pl,$packet); 1114=item cf::register_extcmd $name => \&callback($pl,$packet);
903 1115
904Register 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.
905 1121
906If 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
907called. 1123called.
908 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
909=cut 1136=cut
910 1137
911sub register_extcmd { 1138sub register_extcmd {
912 my ($name, $cb) = @_; 1139 my ($name, $cb) = @_;
913 1140
914 $EXTCMD{$name} = $cb; 1141 $EXTCMD{$name} = $cb;
1142}
1143
1144sub register_exticmd {
1145 my ($name, $cb) = @_;
1146
1147 $EXTICMD{$name} = $cb;
915} 1148}
916 1149
917cf::player->attach ( 1150cf::player->attach (
918 on_command => sub { 1151 on_command => sub {
919 my ($pl, $name, $params) = @_; 1152 my ($pl, $name, $params) = @_;
928 cf::override; 1161 cf::override;
929 }, 1162 },
930 on_extcmd => sub { 1163 on_extcmd => sub {
931 my ($pl, $buf) = @_; 1164 my ($pl, $buf) = @_;
932 1165
933 my $msg = eval { from_json $buf }; 1166 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934 1167
935 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
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1176 if (my $cb = $EXTCMD{$type}) {
937 if (my %reply = $cb->($pl, $msg)) { 1177 @reply = $cb->($pl, @payload);
938 $pl->ext_reply ($msg->{msgid}, %reply);
939 }
940 } 1178 }
1179
1180 $pl->ext_reply ($reply, @reply)
1181 if $reply;
1182
941 } else { 1183 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1184 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943 } 1185 }
944 1186
945 cf::override; 1187 cf::override;
946 }, 1188 },
947); 1189);
948 1190
949sub load_extension {
950 my ($path) = @_;
951
952 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
953 my $base = $1;
954 my $pkg = $1;
955 $pkg =~ s/[^[:word:]]/_/g;
956 $pkg = "ext::$pkg";
957
958 warn "... loading '$path' into '$pkg'\n";
959
960 open my $fh, "<:utf8", $path
961 or die "$path: $!";
962
963 my $source =
964 "package $pkg; use strict; use utf8;\n"
965 . "#line 1 \"$path\"\n{\n"
966 . (do { local $/; <$fh> })
967 . "\n};\n1";
968
969 unless (eval $source) {
970 my $msg = $@ ? "$path: $@\n"
971 : "extension disabled.\n";
972 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973 warn $@;
974 warn "mandatory extension failed to load, exiting.\n";
975 exit 1;
976 }
977 die $@;
978 }
979
980 push @EXTS, $pkg;
981}
982
983sub load_extensions { 1191sub load_extensions {
1192 cf::sync_job {
1193 my %todo;
1194
984 for my $ext (<$LIBDIR/*.ext>) { 1195 for my $path (<$LIBDIR/*.ext>) {
985 next unless -r $ext; 1196 next unless -r $path;
986 eval { 1197
987 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;
988 1 1255 }
989 } or warn "$ext not loaded: $@"; 1256
1257 skip:
1258 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1259 unless $progress;
1260 }
990 } 1261 };
991} 1262}
992 1263
993############################################################################# 1264#############################################################################
994 1265
1266=back
1267
995=head2 CORE EXTENSIONS 1268=head2 CORE EXTENSIONS
996 1269
997Functions and methods that extend core crossfire objects. 1270Functions and methods that extend core crossfire objects.
998 1271
999=cut 1272=cut
1003use Coro::AIO; 1276use Coro::AIO;
1004 1277
1005=head3 cf::player 1278=head3 cf::player
1006 1279
1007=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}
1008 1295
1009=item cf::player::find $login 1296=item cf::player::find $login
1010 1297
1011Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
1012 1299
1048 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1049 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1050 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1051 aio_unlink +(playerdir $login) . "/$login.pl"; 1338 aio_unlink +(playerdir $login) . "/$login.pl";
1052 1339
1053 my $pl = load_pl path $login 1340 my $f = new_from_file cf::object::thawer path $login
1054 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;
1055 $cf::PLAYER{$login} = $pl 1348 $cf::PLAYER{$login} = $pl
1056 } 1349 }
1057 } 1350 }
1058} 1351}
1059 1352
1069 1362
1070 aio_mkdir playerdir $pl, 0770; 1363 aio_mkdir playerdir $pl, 0770;
1071 $pl->{last_save} = $cf::RUNTIME; 1364 $pl->{last_save} = $cf::RUNTIME;
1072 1365
1073 $pl->save_pl ($path); 1366 $pl->save_pl ($path);
1074 Coro::cede; 1367 cf::cede_to_tick;
1075} 1368}
1076 1369
1077sub new($) { 1370sub new($) {
1078 my ($login) = @_; 1371 my ($login) = @_;
1079 1372
1083 $self->{deny_save} = 1; 1376 $self->{deny_save} = 1;
1084 1377
1085 $cf::PLAYER{$login} = $self; 1378 $cf::PLAYER{$login} = $self;
1086 1379
1087 $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 (@_);
1088} 1391}
1089 1392
1090=item $pl->quit_character 1393=item $pl->quit_character
1091 1394
1092Nukes the player without looking back. If logged in, the connection will 1395Nukes the player without looking back. If logged in, the connection will
1147 or return []; 1450 or return [];
1148 1451
1149 my @logins; 1452 my @logins;
1150 1453
1151 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") {
1152 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1459 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1153 aio_read $fh, 0, 512, my $buf, 0 or next; 1460 aio_read $fh, 0, 512, my $buf, 0 or next;
1154 $buf !~ /^password -------------$/m or next; # official not-valid tag 1461 $buf !~ /^password -------------$/m or next; # official not-valid tag
1462 }
1155 1463
1156 utf8::decode $login; 1464 utf8::decode $login;
1157 push @logins, $login; 1465 push @logins, $login;
1158 } 1466 }
1159 1467
1186 } 1494 }
1187 1495
1188 \@paths 1496 \@paths
1189} 1497}
1190 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
1191=item $player->ext_reply ($msgid, %msg) 1550=item $player->ext_reply ($msgid, @msg)
1192 1551
1193Sends an ext reply to the player. 1552Sends an ext reply to the player.
1194 1553
1195=cut 1554=cut
1196 1555
1197sub ext_reply($$%) { 1556sub ext_reply($$@) {
1198 my ($self, $id, %msg) = @_; 1557 my ($self, $id, @msg) = @_;
1199 1558
1200 $msg{msgid} = $id; 1559 $self->ns->ext_reply ($id, @msg)
1201
1202 $self->send ("ext " . cf::to_json \%msg);
1203} 1560}
1204 1561
1205=item $player->ext_event ($type, %msg) 1562=item $player->ext_msg ($type, @msg)
1206 1563
1207Sends an ext event to the client. 1564Sends an ext event to the client.
1208 1565
1209=cut 1566=cut
1210 1567
1211sub ext_event($$%) { 1568sub ext_msg($$@) {
1212 my ($self, $type, %msg) = @_; 1569 my ($self, $type, @msg) = @_;
1213 1570
1214 $self->ns->ext_event ($type, %msg); 1571 $self->ns->ext_msg ($type, @msg);
1215} 1572}
1216 1573
1217=head3 cf::region 1574=head3 cf::region
1218 1575
1219=over 4 1576=over 4
1222 1579
1223package cf::region; 1580package cf::region;
1224 1581
1225=item cf::region::find_by_path $path 1582=item cf::region::find_by_path $path
1226 1583
1227Tries 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.
1228 1585
1229=cut 1586=cut
1230 1587
1231sub find_by_path($) { 1588sub find_by_path($) {
1232 my ($path) = @_; 1589 my ($path) = @_;
1233 1590
1234 my ($match, $specificity); 1591 my ($match, $specificity);
1235 1592
1236 for my $region (list) { 1593 for my $region (list) {
1237 if ($region->match && $path =~ $region->match) { 1594 if ($region->{match} && $path =~ $region->{match}) {
1238 ($match, $specificity) = ($region, $region->specificity) 1595 ($match, $specificity) = ($region, $region->specificity)
1239 if $region->specificity > $specificity; 1596 if $region->specificity > $specificity;
1240 } 1597 }
1241 } 1598 }
1242 1599
1306 my ($self, $merge) = @_; 1663 my ($self, $merge) = @_;
1307 1664
1308 # we have to keep some variables in memory intact 1665 # we have to keep some variables in memory intact
1309 local $self->{path}; 1666 local $self->{path};
1310 local $self->{load_path}; 1667 local $self->{load_path};
1311 local $self->{deny_save};
1312 local $self->{deny_reset};
1313 1668
1314 $self->SUPER::thawer_merge ($merge); 1669 $self->SUPER::thawer_merge ($merge);
1315} 1670}
1316 1671
1317sub normalise { 1672sub normalise {
1364 $self->init; # pass $1 etc. 1719 $self->init; # pass $1 etc.
1365 return $self; 1720 return $self;
1366 } 1721 }
1367 } 1722 }
1368 1723
1369 Carp::carp "unable to resolve path '$path' (base '$base')."; 1724 Carp::cluck "unable to resolve path '$path' (base '$base').";
1370 () 1725 ()
1371} 1726}
1372 1727
1373sub init { 1728sub init {
1374 my ($self) = @_; 1729 my ($self) = @_;
1417 1772
1418 $_->change_map_light ($change) 1773 $_->change_map_light ($change)
1419 for grep $_->outdoor, values %cf::MAP; 1774 for grep $_->outdoor, values %cf::MAP;
1420} 1775}
1421 1776
1777sub decay_objects {
1778 my ($self) = @_;
1779
1780 return if $self->{deny_reset};
1781
1782 $self->do_decay_objects;
1783}
1784
1422sub unlink_save { 1785sub unlink_save {
1423 my ($self) = @_; 1786 my ($self) = @_;
1424 1787
1425 utf8::encode (my $save = $self->save_path); 1788 utf8::encode (my $save = $self->save_path);
1426 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1789 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1429 1792
1430sub load_header_from($) { 1793sub load_header_from($) {
1431 my ($self, $path) = @_; 1794 my ($self, $path) = @_;
1432 1795
1433 utf8::encode $path; 1796 utf8::encode $path;
1434 #aio_open $path, O_RDONLY, 0 1797 my $f = new_from_file cf::object::thawer $path
1435 # or return;
1436
1437 $self->_load_header ($path)
1438 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;
1439 1805
1440 $self->{load_path} = $path; 1806 $self->{load_path} = $path;
1441 1807
1442 1 1808 1
1443} 1809}
1482 $self->load_header_orig 1848 $self->load_header_orig
1483 or return; 1849 or return;
1484 $self->prepare_orig; 1850 $self->prepare_orig;
1485 } 1851 }
1486 1852
1853 $self->{deny_reset} = 1
1854 if $self->no_reset;
1855
1487 $self->default_region (cf::region::find_by_path $self->{path}) 1856 $self->default_region (cf::region::find_by_path $self->{path})
1488 unless $self->default_region; 1857 unless $self->default_region;
1489 1858
1490 1 1859 1
1491} 1860}
1494sub find { 1863sub find {
1495 my ($path, $origin) = @_; 1864 my ($path, $origin) = @_;
1496 1865
1497 $path = normalise $path, $origin && $origin->path; 1866 $path = normalise $path, $origin && $origin->path;
1498 1867
1868 cf::lock_wait "map_data:$path";#d#remove
1499 cf::lock_wait "map_find:$path"; 1869 cf::lock_wait "map_find:$path";
1500 1870
1501 $cf::MAP{$path} || do { 1871 $cf::MAP{$path} || do {
1502 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
1503 my $map = new_from_path cf::map $path 1875 my $map = new_from_path cf::map $path
1504 or return; 1876 or return;
1505 1877
1506 $map->{last_save} = $cf::RUNTIME; 1878 $map->{last_save} = $cf::RUNTIME;
1507 1879
1508 $map->load_header 1880 $map->load_header
1509 or return; 1881 or return;
1510 1882
1511 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1883 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512 # doing this can freeze the server in a sync job, obviously 1884 # doing this can freeze the server in a sync job, obviously
1513 #$cf::WAIT_FOR_TICK->wait; 1885 #$cf::WAIT_FOR_TICK->wait;
1886 undef $guard1;
1887 undef $guard2;
1514 $map->reset; 1888 $map->reset;
1515 undef $guard;
1516 return find $path; 1889 return find $path;
1517 } 1890 }
1518 1891
1519 $cf::MAP{$path} = $map 1892 $cf::MAP{$path} = $map
1520 } 1893 }
1529 local $self->{deny_reset} = 1; # loading can take a long time 1902 local $self->{deny_reset} = 1; # loading can take a long time
1530 1903
1531 my $path = $self->{path}; 1904 my $path = $self->{path};
1532 1905
1533 { 1906 {
1534 my $guard = cf::lock_acquire "map_load:$path"; 1907 my $guard = cf::lock_acquire "map_data:$path";
1535 1908
1909 return unless $self->valid;
1536 return if $self->in_memory != cf::MAP_SWAPPED; 1910 return unless $self->in_memory == cf::MAP_SWAPPED;
1537 1911
1538 $self->in_memory (cf::MAP_LOADING); 1912 $self->in_memory (cf::MAP_LOADING);
1539 1913
1540 $self->alloc; 1914 $self->alloc;
1541 1915
1542 $self->pre_load; 1916 $self->pre_load;
1543 Coro::cede; 1917 cf::cede_to_tick;
1544 1918
1919 my $f = new_from_file cf::object::thawer $self->{load_path};
1920 $f->skip_block;
1545 $self->_load_objects ($self->{load_path}, 1) 1921 $self->_load_objects ($f)
1546 or return; 1922 or return;
1547 1923
1548 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1924 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1549 if delete $self->{load_original}; 1925 if delete $self->{load_original};
1550 1926
1551 if (my $uniq = $self->uniq_path) { 1927 if (my $uniq = $self->uniq_path) {
1552 utf8::encode $uniq; 1928 utf8::encode $uniq;
1553 if (aio_open $uniq, O_RDONLY, 0) { 1929 unless (aio_stat $uniq) {
1930 if (my $f = new_from_file cf::object::thawer $uniq) {
1554 $self->clear_unique_items; 1931 $self->clear_unique_items;
1555 $self->_load_objects ($uniq, 0); 1932 $self->_load_objects ($f);
1933 $f->resolve_delayed_derefs;
1934 }
1556 } 1935 }
1557 } 1936 }
1558 1937
1559 Coro::cede; 1938 $f->resolve_delayed_derefs;
1939
1940 cf::cede_to_tick;
1560 # now do the right thing for maps 1941 # now do the right thing for maps
1561 $self->link_multipart_objects; 1942 $self->link_multipart_objects;
1562 $self->difficulty ($self->estimate_difficulty) 1943 $self->difficulty ($self->estimate_difficulty)
1563 unless $self->difficulty; 1944 unless $self->difficulty;
1564 Coro::cede; 1945 cf::cede_to_tick;
1565 1946
1566 unless ($self->{deny_activate}) { 1947 unless ($self->{deny_activate}) {
1567 $self->decay_objects; 1948 $self->decay_objects;
1568 $self->fix_auto_apply; 1949 $self->fix_auto_apply;
1569 $self->update_buttons; 1950 $self->update_buttons;
1570 Coro::cede; 1951 cf::cede_to_tick;
1571 $self->set_darkness_map; 1952 $self->set_darkness_map;
1572 Coro::cede; 1953 cf::cede_to_tick;
1573 $self->activate; 1954 $self->activate;
1574 } 1955 }
1956
1957 $self->{last_save} = $cf::RUNTIME;
1958 $self->last_access ($cf::RUNTIME);
1575 1959
1576 $self->in_memory (cf::MAP_IN_MEMORY); 1960 $self->in_memory (cf::MAP_IN_MEMORY);
1577 } 1961 }
1578 1962
1579 $self->post_load; 1963 $self->post_load;
1583 my ($self, $ob) = @_; 1967 my ($self, $ob) = @_;
1584 1968
1585 return find "~" . $ob->name . "/" . $self->{path} 1969 return find "~" . $ob->name . "/" . $self->{path}
1586 if $self->per_player; 1970 if $self->per_player;
1587 1971
1972# return find "?party/" . $ob->name . "/" . $self->{path}
1973# if $self->per_party;
1974
1588 $self 1975 $self
1589} 1976}
1590 1977
1591# 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
1592sub load_diag { 1979sub load_neighbours {
1593 my ($map) = @_; 1980 my ($map) = @_;
1594 1981
1595 my @diag; # diagonal neighbours 1982 my @neigh; # diagonal neighbours
1596 1983
1597 for (0 .. 3) { 1984 for (0 .. 3) {
1598 my $neigh = $map->tile_path ($_) 1985 my $neigh = $map->tile_path ($_)
1599 or next; 1986 or next;
1600 $neigh = find $neigh, $map 1987 $neigh = find $neigh, $map
1601 or next; 1988 or next;
1602 $neigh->load; 1989 $neigh->load;
1603 1990
1991 push @neigh,
1604 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1992 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1605 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1993 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1606 } 1994 }
1607 1995
1608 for (@diag) { 1996 for (grep defined $_->[0], @neigh) {
1997 my ($path, $origin) = @$_;
1609 my $neigh = find @$_ 1998 my $neigh = find $path, $origin
1610 or next; 1999 or next;
1611 $neigh->load; 2000 $neigh->load;
1612 } 2001 }
1613} 2002}
1614 2003
1619} 2008}
1620 2009
1621sub do_load_sync { 2010sub do_load_sync {
1622 my ($map) = @_; 2011 my ($map) = @_;
1623 2012
2013 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2014 if $Coro::current == $Coro::main;
2015
1624 cf::sync_job { $map->load }; 2016 cf::sync_job { $map->load };
1625} 2017}
1626 2018
1627our %MAP_PREFETCH; 2019our %MAP_PREFETCH;
1628our $MAP_PREFETCHER = undef; 2020our $MAP_PREFETCHER = undef;
1629 2021
1630sub find_async { 2022sub find_async {
1631 my ($path, $origin) = @_; 2023 my ($path, $origin, $load) = @_;
1632 2024
1633 $path = normalise $path, $origin && $origin->{path}; 2025 $path = normalise $path, $origin && $origin->{path};
1634 2026
1635 if (my $map = $cf::MAP{$path}) { 2027 if (my $map = $cf::MAP{$path}) {
1636 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2028 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1637 } 2029 }
1638 2030
1639 undef $MAP_PREFETCH{$path}; 2031 $MAP_PREFETCH{$path} |= $load;
2032
1640 $MAP_PREFETCHER ||= cf::async { 2033 $MAP_PREFETCHER ||= cf::async {
1641 while (%MAP_PREFETCH) { 2034 while (%MAP_PREFETCH) {
1642 for my $path (keys %MAP_PREFETCH) { 2035 while (my ($k, $v) = each %MAP_PREFETCH) {
1643 my $map = find $path 2036 if (my $map = find $k) {
1644 or next;
1645 $map->load; 2037 $map->load if $v;
2038 }
1646 2039
1647 delete $MAP_PREFETCH{$path}; 2040 delete $MAP_PREFETCH{$k};
1648 } 2041 }
1649 } 2042 }
1650 undef $MAP_PREFETCHER; 2043 undef $MAP_PREFETCHER;
1651 }; 2044 };
1652 $MAP_PREFETCHER->prio (6); 2045 $MAP_PREFETCHER->prio (6);
1655} 2048}
1656 2049
1657sub save { 2050sub save {
1658 my ($self) = @_; 2051 my ($self) = @_;
1659 2052
1660 my $lock = cf::lock_acquire "map_data:" . $self->path; 2053 my $lock = cf::lock_acquire "map_data:$self->{path}";
1661 2054
1662 $self->{last_save} = $cf::RUNTIME; 2055 $self->{last_save} = $cf::RUNTIME;
1663 2056
1664 return unless $self->dirty; 2057 return unless $self->dirty;
1665 2058
1688 my ($self) = @_; 2081 my ($self) = @_;
1689 2082
1690 # save first because save cedes 2083 # save first because save cedes
1691 $self->save; 2084 $self->save;
1692 2085
1693 my $lock = cf::lock_acquire "map_data:" . $self->path; 2086 my $lock = cf::lock_acquire "map_data:$self->{path}";
1694 2087
1695 return if $self->players; 2088 return if $self->players;
1696 return if $self->in_memory != cf::MAP_IN_MEMORY; 2089 return if $self->in_memory != cf::MAP_IN_MEMORY;
1697 return if $self->{deny_save}; 2090 return if $self->{deny_save};
1698 2091
2092 $self->in_memory (cf::MAP_SWAPPED);
2093
2094 $self->deactivate;
2095 $_->clear_links_to ($self) for values %cf::MAP;
1699 $self->clear; 2096 $self->clear;
1700 $self->in_memory (cf::MAP_SWAPPED);
1701} 2097}
1702 2098
1703sub reset_at { 2099sub reset_at {
1704 my ($self) = @_; 2100 my ($self) = @_;
1705 2101
1706 # TODO: safety, remove and allow resettable per-player maps 2102 # TODO: safety, remove and allow resettable per-player maps
1707 return 1e99 if $self->isa ("ext::map_per_player");#d#
1708 return 1e99 if $self->{deny_reset}; 2103 return 1e99 if $self->{deny_reset};
1709 2104
1710 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2105 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711 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;
1712 2107
1723 my ($self) = @_; 2118 my ($self) = @_;
1724 2119
1725 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2120 my $lock = cf::lock_acquire "map_data:$self->{path}";
1726 2121
1727 return if $self->players; 2122 return if $self->players;
1728 return if $self->isa ("ext::map_per_player");#d#
1729 2123
1730 warn "resetting map ", $self->path;#d# 2124 warn "resetting map ", $self->path;
1731 2125
1732 $self->in_memory (cf::MAP_SWAPPED); 2126 $self->in_memory (cf::MAP_SWAPPED);
1733 2127
1734 # need to save uniques path 2128 # need to save uniques path
1735 unless ($self->{deny_save}) { 2129 unless ($self->{deny_save}) {
1739 if $uniq; 2133 if $uniq;
1740 } 2134 }
1741 2135
1742 delete $cf::MAP{$self->path}; 2136 delete $cf::MAP{$self->path};
1743 2137
2138 $self->deactivate;
2139 $_->clear_links_to ($self) for values %cf::MAP;
1744 $self->clear; 2140 $self->clear;
1745
1746 $_->clear_links_to ($self) for values %cf::MAP;
1747 2141
1748 $self->unlink_save; 2142 $self->unlink_save;
1749 $self->destroy; 2143 $self->destroy;
1750} 2144}
1751 2145
1752my $nuke_counter = "aaaa"; 2146my $nuke_counter = "aaaa";
1753 2147
1754sub nuke { 2148sub nuke {
1755 my ($self) = @_; 2149 my ($self) = @_;
1756 2150
2151 {
2152 my $lock = cf::lock_acquire "map_data:$self->{path}";
2153
1757 delete $cf::MAP{$self->path}; 2154 delete $cf::MAP{$self->path};
1758 2155
1759 $self->unlink_save; 2156 $self->unlink_save;
1760 2157
1761 bless $self, "cf::map"; 2158 bless $self, "cf::map";
1762 delete $self->{deny_reset}; 2159 delete $self->{deny_reset};
1763 $self->{deny_save} = 1; 2160 $self->{deny_save} = 1;
1764 $self->reset_timeout (1); 2161 $self->reset_timeout (1);
1765 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2162 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1766 2163
1767 $cf::MAP{$self->path} = $self; 2164 $cf::MAP{$self->path} = $self;
2165 }
1768 2166
1769 $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 ]
1770} 2204}
1771 2205
1772=item cf::map::unique_maps 2206=item cf::map::unique_maps
1773 2207
1774Returns an arrayref of paths of all shared maps that have 2208Returns an arrayref of paths of all shared maps that have
1775instantiated unique items. May block. 2209instantiated unique items. May block.
1776 2210
1777=cut 2211=cut
1778 2212
1779sub unique_maps() { 2213sub unique_maps() {
1780 my $files = aio_readdir $UNIQUEDIR 2214 [
1781 or return; 2215 map {
1782
1783 my @paths;
1784
1785 for (@$files) {
1786 utf8::decode $_; 2216 utf8::decode $_;
1787 next if /\.pst$/; 2217 /\.map$/
1788 next unless /^$PATH_SEP/o; 2218 ? normalise $_
1789 2219 : ()
1790 push @paths, cf::map::normalise $_; 2220 } @{ aio_readdir $UNIQUEDIR or [] }
1791 } 2221 ]
1792
1793 \@paths
1794} 2222}
1795 2223
1796package cf; 2224package cf;
1797 2225
1798=back 2226=back
1816 map { $_, inv_recursive_ $_->inv } @_ 2244 map { $_, inv_recursive_ $_->inv } @_
1817} 2245}
1818 2246
1819sub inv_recursive { 2247sub inv_recursive {
1820 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 }
1821} 2280}
1822 2281
1823package cf; 2282package cf;
1824 2283
1825=back 2284=back
1844 2303
1845 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2304 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846 2305
1847 if ($self->{record_replies}) { 2306 if ($self->{record_replies}) {
1848 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2307 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2308
1849 } 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 {
1850 $msg = $npc->name . " says: $msg" if $npc; 2317 $msg = $npc->name . " says: $msg" if $npc;
1851 $self->message ($msg, $flags); 2318 $self->message ($msg, $flags);
2319 }
1852 } 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 (@_);
1853} 2331}
1854 2332
1855=item $player_object->may ("access") 2333=item $player_object->may ("access")
1856 2334
1857Returns wether the given player is authorized to access resource "access" 2335Returns wether the given player is authorized to access resource "access"
1904 $self->deactivate_recursive; 2382 $self->deactivate_recursive;
1905 2383
1906 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2384 return if UNIVERSAL::isa $self->map, "ext::map_link";
1907 2385
1908 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2386 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909 if $self->map; 2387 if $self->map && $self->map->{path} ne "{link}";
1910 2388
1911 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2389 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1912} 2390}
1913 2391
1914sub cf::object::player::leave_link { 2392sub cf::object::player::leave_link {
1915 my ($self, $map, $x, $y) = @_; 2393 my ($self, $map, $x, $y) = @_;
2394
2395 return unless $self->contr->active;
1916 2396
1917 my $link_pos = delete $self->{_link_pos}; 2397 my $link_pos = delete $self->{_link_pos};
1918 2398
1919 unless ($map) { 2399 unless ($map) {
1920 # restore original map position 2400 # restore original map position
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
1948cf::player->attach (
1949 on_logout => sub {
1950 my ($pl) = @_;
1951
1952 # abort map switching before logout
1953 if ($pl->ob->{_link_pos}) {
1954 cf::sync_job {
1955 $pl->ob->leave_link
1956 };
1957 }
1958 },
1959 on_login => sub {
1960 my ($pl) = @_;
1961
1962 # try to abort aborted map switching on player login :)
1963 # should happen only on crashes
1964 if ($pl->ob->{_link_pos}) {
1965 $pl->ob->enter_link;
1966 (async {
1967 $pl->ob->reply (undef,
1968 "There was an internal problem at your last logout, "
1969 . "the server will try to bring you to your intended destination in a second.",
1970 cf::NDI_RED);
1971 # we need this sleep as the login has a concurrent enter_exit running
1972 # and this sleep increases chances of the player not ending up in scorn
1973 Coro::Timer::sleep 1;
1974 $pl->ob->leave_link;
1975 })->prio (2);
1976 }
1977 },
1978);
1979
1980=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2428=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1981 2429
1982Moves 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
1983her, loading and preparing them map, calling the provided $check callback 2431her, loading and preparing them map, calling the provided $check callback
1984that 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
1985the 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.
1986 2435
1987=cut 2436=cut
2437
2438our $GOTOGEN;
1988 2439
1989sub cf::object::player::goto { 2440sub cf::object::player::goto {
1990 my ($self, $path, $x, $y, $check) = @_; 2441 my ($self, $path, $x, $y, $check, $done) = @_;
1991 2442
1992 #d# #TODO# 2443 # do generation counting so two concurrent goto's will be executed in-order
1993 if ($check && !ref $check) { 2444 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1994 warn Carp::longmess "goto called with non-ref check argument";#d#
1995 undef $check;
1996 }
1997 2445
1998 $self->enter_link; 2446 $self->enter_link;
1999 2447
2000 (async { 2448 (async {
2001 my $map = eval { 2449 my $map = eval {
2014 if ($@) { 2462 if ($@) {
2015 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED); 2463 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2016 LOG llevError | logBacktrace, Carp::longmess $@; 2464 LOG llevError | logBacktrace, Carp::longmess $@;
2017 } 2465 }
2018 2466
2467 if ($gen == $self->{_goto_generation}) {
2468 delete $self->{_goto_generation};
2019 $self->leave_link ($map, $x, $y); 2469 $self->leave_link ($map, $x, $y);
2470 }
2471
2472 $done->() if $done;
2020 })->prio (1); 2473 })->prio (1);
2021} 2474}
2022 2475
2023=item $player_object->enter_exit ($exit_object) 2476=item $player_object->enter_exit ($exit_object)
2024 2477
2093 my $hp = $exit->stats->hp; 2546 my $hp = $exit->stats->hp;
2094 my $sp = $exit->stats->sp; 2547 my $sp = $exit->stats->sp;
2095 2548
2096 $self->enter_link; 2549 $self->enter_link;
2097 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
2098 (async { 2555 (async {
2099 $self->deactivate_recursive; # just to be sure 2556 $self->deactivate_recursive; # just to be sure
2100 unless (eval { 2557 unless (eval {
2101 $self->goto ($slaying, $hp, $sp); 2558 $self->goto ($slaying, $hp, $sp);
2102 2559
2129 2586
2130 utf8::encode $text; 2587 utf8::encode $text;
2131 $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);
2132} 2589}
2133 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
2134=item $client->ext_event ($type, %msg) 2672=item $client->ext_msg ($type, @msg)
2135 2673
2136Sends an exti event to the client. 2674Sends an ext event to the client.
2137 2675
2138=cut 2676=cut
2139 2677
2140sub cf::client::ext_event($$%) { 2678sub cf::client::ext_msg($$@) {
2141 my ($self, $type, %msg) = @_; 2679 my ($self, $type, @msg) = @_;
2142 2680
2681 if ($self->extcmd == 2) {
2682 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2683 } elsif ($self->extcmd == 1) { # TODO: remove
2143 $msg{msgtype} = "event_$type"; 2684 push @msg, msgtype => "event_$type";
2144 $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 }
2145} 2705}
2146 2706
2147=item $success = $client->query ($flags, "text", \&cb) 2707=item $success = $client->query ($flags, "text", \&cb)
2148 2708
2149Queues a query to the client, calling the given callback with 2709Queues a query to the client, calling the given callback with
2150the 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>,
2151C<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>.
2152 2712
2153Queries 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
2154reliable at some point in the future. 2714become reliable at some point in the future.
2155 2715
2156=cut 2716=cut
2157 2717
2158sub cf::client::query { 2718sub cf::client::query {
2159 my ($self, $flags, $text, $cb) = @_; 2719 my ($self, $flags, $text, $cb) = @_;
2167 utf8::encode $text; 2727 utf8::encode $text;
2168 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2728 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2169 2729
2170 $self->send_packet ($self->{query_queue}[0][0]) 2730 $self->send_packet ($self->{query_queue}[0][0])
2171 if @{ $self->{query_queue} } == 1; 2731 if @{ $self->{query_queue} } == 1;
2732
2733 1
2172} 2734}
2173 2735
2174cf::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 },
2175 on_reply => sub { 2742 on_reply => sub {
2176 my ($ns, $msg) = @_; 2743 my ($ns, $msg) = @_;
2177 2744
2178 # this weird shuffling is so that direct followup queries 2745 # this weird shuffling is so that direct followup queries
2179 # get handled first 2746 # get handled first
2191 } else { 2758 } else {
2192 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2759 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2193 } 2760 }
2194 } 2761 }
2195 }, 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 },
2196); 2789);
2197 2790
2198=item $client->async (\&cb) 2791=item $client->async (\&cb)
2199 2792
2200Create a new coroutine, running the specified callback. The coroutine will 2793Create a new coroutine, running the specified callback. The coroutine will
2241our $safe = new Safe "safe"; 2834our $safe = new Safe "safe";
2242our $safe_hole = new Safe::Hole; 2835our $safe_hole = new Safe::Hole;
2243 2836
2244$SIG{FPE} = 'IGNORE'; 2837$SIG{FPE} = 'IGNORE';
2245 2838
2246$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));
2247 2844
2248# here we export the classes and methods available to script code 2845# here we export the classes and methods available to script code
2249 2846
2250=pod 2847=pod
2251 2848
2252The following functions and methods are available within a safe environment: 2849The following functions and methods are available within a safe environment:
2253 2850
2254 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
2255 cf::object::player player 2855 cf::object::player
2256 cf::player peaceful 2856 player
2257 cf::map trigger 2857
2858 cf::player
2859 peaceful
2860
2861 cf::map
2862 trigger
2258 2863
2259=cut 2864=cut
2260 2865
2261for ( 2866for (
2262 ["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)],
2263 ["cf::object::player" => qw(player)], 2870 ["cf::object::player" => qw(player)],
2264 ["cf::player" => qw(peaceful)], 2871 ["cf::player" => qw(peaceful)],
2265 ["cf::map" => qw(trigger)], 2872 ["cf::map" => qw(trigger)],
2266) { 2873) {
2267 no strict 'refs'; 2874 no strict 'refs';
2338=back 2945=back
2339 2946
2340=cut 2947=cut
2341 2948
2342############################################################################# 2949#############################################################################
2343
2344=head2 EXTENSION DATABASE SUPPORT
2345
2346Crossfire maintains a very simple database for extension use. It can
2347currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2348convert to/from binary).
2349
2350The parameter C<$family> should best start with the name of the extension
2351using it, it should be unique.
2352
2353=over 4
2354
2355=item $value = cf::db_get $family => $key
2356
2357Returns a single value from the database.
2358
2359=item cf::db_put $family => $key => $value
2360
2361Stores the given C<$value> in the family.
2362
2363=cut
2364
2365our $DB;
2366
2367sub db_init {
2368 unless ($DB) {
2369 $DB = BDB::db_create $DB_ENV;
2370
2371 cf::sync_job {
2372 eval {
2373 $DB->set_flags (BDB::CHKSUM);
2374
2375 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2376 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2377 cf::cleanup "db_open(db): $!" if $!;
2378 };
2379 cf::cleanup "db_open(db): $@" if $@;
2380 };
2381 }
2382}
2383
2384sub db_get($$) {
2385 my $key = "$_[0]/$_[1]";
2386
2387 cf::sync_job {
2388 BDB::db_get $DB, undef, $key, my $data;
2389
2390 $! ? ()
2391 : $data
2392 }
2393}
2394
2395sub db_put($$$) {
2396 BDB::dbreq_pri 4;
2397 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2398}
2399
2400=item cf::cache $id => [$paths...], $processversion => $process
2401
2402Generic caching function that returns the value of the resource $id,
2403caching and regenerating as required.
2404
2405This function can block.
2406
2407=cut
2408
2409sub cache {
2410 my ($id, $src, $processversion, $process) = @_;
2411
2412 my $meta =
2413 join "\x00",
2414 $processversion,
2415 map {
2416 aio_stat $_
2417 and Carp::croak "$_: $!";
2418
2419 ($_, (stat _)[7,9])
2420 } @$src;
2421
2422 my $dbmeta = db_get cache => "$id/meta";
2423 if ($dbmeta ne $meta) {
2424 # changed, we may need to process
2425
2426 my @data;
2427 my $md5;
2428
2429 for (0 .. $#$src) {
2430 0 <= aio_load $src->[$_], $data[$_]
2431 or Carp::croak "$src->[$_]: $!";
2432 }
2433
2434 # if processing is expensive, check
2435 # checksum first
2436 if (1) {
2437 $md5 =
2438 join "\x00",
2439 $processversion,
2440 map {
2441 Coro::cede;
2442 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2443 } 0.. $#$src;
2444
2445
2446 my $dbmd5 = db_get cache => "$id/md5";
2447 if ($dbmd5 eq $md5) {
2448 db_put cache => "$id/meta", $meta;
2449
2450 return db_get cache => "$id/data";
2451 }
2452 }
2453
2454 my $t1 = Time::HiRes::time;
2455 my $data = $process->(\@data);
2456 my $t2 = Time::HiRes::time;
2457
2458 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2459
2460 db_put cache => "$id/data", $data;
2461 db_put cache => "$id/md5" , $md5;
2462 db_put cache => "$id/meta", $meta;
2463
2464 return $data;
2465 }
2466
2467 db_get cache => "$id/data"
2468}
2469
2470=item fork_call { }, $args
2471
2472Executes the given code block with the given arguments in a seperate
2473process, returning the results. Everything must be serialisable with
2474Coro::Storable. May, of course, block. Note that the executed sub may
2475never block itself or use any form of Event handling.
2476
2477=cut
2478
2479sub fork_call(&@) {
2480 my ($cb, @args) = @_;
2481
2482# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2483# or die "socketpair: $!";
2484 pipe my $fh1, my $fh2
2485 or die "pipe: $!";
2486
2487 if (my $pid = fork) {
2488 close $fh2;
2489
2490 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2491 $res = Coro::Storable::thaw $res;
2492
2493 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2494
2495 die $$res unless "ARRAY" eq ref $res;
2496
2497 return wantarray ? @$res : $res->[-1];
2498 } else {
2499 reset_signals;
2500 local $SIG{__WARN__};
2501 local $SIG{__DIE__};
2502 eval {
2503 close $fh1;
2504
2505 my @res = eval { $cb->(@args) };
2506 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2507 };
2508
2509 warn $@ if $@;
2510 _exit 0;
2511 }
2512}
2513
2514
2515
2516#############################################################################
2517# the server's init and main functions 2950# the server's init and main functions
2518 2951
2519sub load_facedata($) { 2952sub load_facedata($) {
2520 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;
2521 2960
2522 warn "loading facedata from $path\n"; 2961 warn "loading facedata from $path\n";
2523 2962
2524 my $facedata; 2963 my $facedata;
2525 0 < aio_load $path, $facedata 2964 0 < aio_load $path, $facedata
2528 $facedata = Coro::Storable::thaw $facedata; 2967 $facedata = Coro::Storable::thaw $facedata;
2529 2968
2530 $facedata->{version} == 2 2969 $facedata->{version} == 2
2531 or cf::cleanup "$path: version mismatch, cannot proceed."; 2970 or cf::cleanup "$path: version mismatch, cannot proceed.";
2532 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
2533 { 2979 {
2534 my $faces = $facedata->{faceinfo}; 2980 my $faces = $facedata->{faceinfo};
2535 2981
2536 while (my ($face, $info) = each %$faces) { 2982 while (my ($face, $info) = each %$faces) {
2537 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2983 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2538 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2984 cf::face::set_visibility $idx, $info->{visibility};
2985 cf::face::set_magicmap $idx, $info->{magicmap};
2539 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2986 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2540 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2987 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2541 Coro::cede; 2988
2989 cf::cede_to_tick;
2542 } 2990 }
2543 2991
2544 while (my ($face, $info) = each %$faces) { 2992 while (my ($face, $info) = each %$faces) {
2545 next unless $info->{smooth}; 2993 next unless $info->{smooth};
2546 my $idx = cf::face::find $face 2994 my $idx = cf::face::find $face
2547 or next; 2995 or next;
2548 if (my $smooth = cf::face::find $info->{smooth}) { 2996 if (my $smooth = cf::face::find $info->{smooth}) {
2997 cf::face::set_smooth $idx, $smooth;
2549 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2998 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2550 } else { 2999 } else {
2551 warn "smooth face '$info->{smooth}' not found for face '$face'"; 3000 warn "smooth face '$info->{smooth}' not found for face '$face'";
2552 } 3001 }
2553 Coro::cede; 3002
3003 cf::cede_to_tick;
2554 } 3004 }
2555 } 3005 }
2556 3006
2557 { 3007 {
2558 my $anims = $facedata->{animinfo}; 3008 my $anims = $facedata->{animinfo};
2559 3009
2560 while (my ($anim, $info) = each %$anims) { 3010 while (my ($anim, $info) = each %$anims) {
2561 cf::anim::set $anim, $info->{frames}, $info->{facings}; 3011 cf::anim::set $anim, $info->{frames}, $info->{facings};
2562 Coro::cede; 3012 cf::cede_to_tick;
2563 } 3013 }
2564 3014
2565 cf::anim::invalidate_all; # d'oh 3015 cf::anim::invalidate_all; # d'oh
2566 } 3016 }
2567 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
2568 1 3067 1
2569} 3068}
2570 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
2571sub 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
2572 load_resource_file "$MAPDIR/regions" 3083 load_resource_file "$MAPDIR/regions"
2573 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 }
2574} 3090}
2575 3091
2576sub reload_facedata { 3092sub reload_facedata {
2577 load_facedata "$DATADIR/facedata" 3093 load_facedata "$DATADIR/facedata"
2578 or die "unable to load facedata\n"; 3094 or die "unable to load facedata\n";
2579} 3095}
2580 3096
2581sub reload_archetypes { 3097sub reload_archetypes {
2582 load_resource_file "$DATADIR/archetypes" 3098 load_resource_file "$DATADIR/archetypes"
2583 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";
2584} 3105}
2585 3106
2586sub reload_treasures { 3107sub reload_treasures {
2587 load_resource_file "$DATADIR/treasures" 3108 load_resource_file "$DATADIR/treasures"
2588 or die "unable to load treasurelists\n"; 3109 or die "unable to load treasurelists\n";
2591sub reload_resources { 3112sub reload_resources {
2592 warn "reloading resource files...\n"; 3113 warn "reloading resource files...\n";
2593 3114
2594 reload_regions; 3115 reload_regions;
2595 reload_facedata; 3116 reload_facedata;
3117 #reload_archetypes;#d#
2596 reload_archetypes; 3118 reload_archetypes;
2597 reload_treasures; 3119 reload_treasures;
2598 3120
2599 warn "finished reloading resource files\n"; 3121 warn "finished reloading resource files\n";
2600} 3122}
2601 3123
2602sub init { 3124sub init {
2603 reload_resources; 3125 reload_resources;
2604} 3126}
2605 3127
2606sub cfg_load { 3128sub reload_config {
2607 open my $fh, "<:utf8", "$CONFDIR/config" 3129 open my $fh, "<:utf8", "$CONFDIR/config"
2608 or return; 3130 or return;
2609 3131
2610 local $/; 3132 local $/;
2611 *CFG = YAML::Syck::Load <$fh>; 3133 *CFG = YAML::Syck::Load <$fh>;
2631 (async { 3153 (async {
2632 Event::one_event; 3154 Event::one_event;
2633 })->prio (Coro::PRIO_MAX); 3155 })->prio (Coro::PRIO_MAX);
2634 }; 3156 };
2635 3157
2636 cfg_load; 3158 reload_config;
2637 db_init; 3159 db_init;
2638 load_extensions; 3160 load_extensions;
2639 3161
2640 $TICK_WATCHER->start; 3162 $TICK_WATCHER->start;
2641 Event::loop; 3163 Event::loop;
2657 }, 3179 },
2658 ); 3180 );
2659 } 3181 }
2660} 3182}
2661 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
2662sub emergency_save() { 3222sub emergency_save() {
2663 my $freeze_guard = cf::freeze_mainloop; 3223 my $freeze_guard = cf::freeze_mainloop;
2664 3224
2665 warn "enter emergency perl save\n"; 3225 warn "enter emergency perl save\n";
2666 3226
2741 %EXT_CORO = (); 3301 %EXT_CORO = ();
2742 3302
2743 warn "removing commands"; 3303 warn "removing commands";
2744 %COMMAND = (); 3304 %COMMAND = ();
2745 3305
2746 warn "removing ext commands"; 3306 warn "removing ext/exti commands";
2747 %EXTCMD = (); 3307 %EXTCMD = ();
3308 %EXTICMD = ();
2748 3309
2749 warn "unloading/nuking all extensions"; 3310 warn "unloading/nuking all extensions";
2750 for my $pkg (@EXTS) { 3311 for my $pkg (@EXTS) {
2751 warn "... unloading $pkg"; 3312 warn "... unloading $pkg";
2752 3313
2795 warn "reloading cf.pm"; 3356 warn "reloading cf.pm";
2796 require cf; 3357 require cf;
2797 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3358 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2798 3359
2799 warn "loading config and database again"; 3360 warn "loading config and database again";
2800 cf::cfg_load; 3361 cf::reload_config;
2801 3362
2802 warn "loading extensions"; 3363 warn "loading extensions";
2803 cf::load_extensions; 3364 cf::load_extensions;
2804 3365
2805 warn "reattaching attachments to objects/players"; 3366 warn "reattaching attachments to objects/players";
2898 or die; 3459 or die;
2899 3460
2900 $map->width (50); 3461 $map->width (50);
2901 $map->height (50); 3462 $map->height (50);
2902 $map->alloc; 3463 $map->alloc;
2903 $map->_load_objects ("/tmp/x.map", 1); 3464 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
2904 my $t = Event::time - $t; 3465 my $t = Event::time - $t;
2905 3466
2906 #next unless $t < 0.0013;#d# 3467 #next unless $t < 0.0013;#d#
2907 if ($t < $min) { 3468 if ($t < $min) {
2908 $min = $t; 3469 $min = $t;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines