ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.276 by root, Sun Jun 10 04:05:47 2007 UTC vs.
Revision 1.367 by root, Wed Sep 12 11:10:11 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines