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.280 by root, Sat Jun 16 14:35:41 2007 UTC vs.
Revision 1.313 by root, Sun Jul 22 14:17:58 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
30use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
31use Time::HiRes; 32use Time::HiRes;
32use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
33 35
34# configure various modules to our taste 36# configure various modules to our taste
35# 37#
36$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 51our %COMMAND = ();
50our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
51 53
52our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
56 59
57our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
58our @EVENT; 61our @EVENT;
164 167
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 168These 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 169returns 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. 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
177
169=back 178=back
170 179
171=cut 180=cut
172 181
173BEGIN { 182BEGIN {
206} 215}
207 216
208$Event::DIED = sub { 217$Event::DIED = sub {
209 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
210}; 219};
220
221#############################################################################
211 222
212=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
213 224
214=over 4 225=over 4
215 226
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 246 $d
236 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
237} 248}
238 249
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
242 251
243Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
244 253
245=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
246 255
247Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
248 264
249=item cf::lock_wait $string 265=item cf::lock_wait $string
250 266
251Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
252 268
318 334
319BEGIN { *async = \&Coro::async_pool } 335BEGIN { *async = \&Coro::async_pool }
320 336
321=item cf::sync_job { BLOCK } 337=item cf::sync_job { BLOCK }
322 338
323The design of crossfire+ requires that the main coro ($Coro::main) is 339The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 340is 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. 341partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
342acceptable.
326 343
327If it must be done, put the blocking parts into C<sync_job>. This will run 344If 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 345the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 346server will be frozen during this time, so the block should either finish
330fast or be very important. 347fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 407 $EXT_CORO{$coro+0} = $coro;
391 408
392 $coro 409 $coro
393} 410}
394 411
395sub write_runtime { 412=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 413
398 # first touch the runtime file to show we are still running: 414Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 415process, returning the results. Everything must be serialisable with
416Coro::Storable. May, of course, block. Note that the executed sub may
417never block itself or use any form of Event handling.
400 418
401 IO::AIO::aio_utime $runtime, undef, undef; 419=cut
402 420
403 my $guard = cf::lock_acquire "write_runtime"; 421sub _store_scalar {
404 422 open my $fh, ">", \my $buf
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 423 or die "fork_call: cannot open fh-to-buf in child : $!";
406 or return; 424 Storable::store_fd $_[0], $fh;
407
408 my $value = $cf::RUNTIME + 90 + 10;
409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413 and return;
414
415 # always fsync - this file is important
416 aio_fsync $fh
417 and return;
418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
422 close $fh 425 close $fh;
423 or return;
424 426
425 aio_rename "$runtime~", $runtime 427 $buf
426 and return; 428}
427 429
428 warn "runtime file written.\n"; 430sub fork_call(&@) {
431 my ($cb, @args) = @_;
429 432
433# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
434# or die "socketpair: $!";
435 pipe my $fh1, my $fh2
436 or die "pipe: $!";
437
438 if (my $pid = fork) {
439 close $fh2;
440
441 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
442 warn "pst<$res>" unless $res =~ /^pst/;
443 $res = Coro::Storable::thaw $res;
444
445 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
446
447 Carp::confess $$res unless "ARRAY" eq ref $res;
448
449 return wantarray ? @$res : $res->[-1];
450 } else {
451 reset_signals;
452 local $SIG{__WARN__};
453 local $SIG{__DIE__};
454 # just in case, this hack effectively disables event
455 # in the child. cleaner and slower would be canceling all watchers,
456 # but this works for the time being.
457 local $Coro::idle;
458 $Coro::current->prio (Coro::PRIO_MAX);
459
460 eval {
461 close $fh1;
462
463 my @res = eval { $cb->(@args) };
464
465 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
466 close $fh2;
467 };
468
469 warn $@ if $@;
470 _exit 0;
430 1 471 }
472}
473
474=item $value = cf::db_get $family => $key
475
476Returns a single value from the environment database.
477
478=item cf::db_put $family => $key => $value
479
480Stores the given C<$value> in the family. It can currently store binary
481data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
482
483=cut
484
485our $DB;
486
487sub db_init {
488 unless ($DB) {
489 $DB = BDB::db_create $DB_ENV;
490
491 cf::sync_job {
492 eval {
493 $DB->set_flags (BDB::CHKSUM);
494
495 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
496 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
497 cf::cleanup "db_open(db): $!" if $!;
498 };
499 cf::cleanup "db_open(db): $@" if $@;
500 };
501 }
502}
503
504sub db_get($$) {
505 my $key = "$_[0]/$_[1]";
506
507 cf::sync_job {
508 BDB::db_get $DB, undef, $key, my $data;
509
510 $! ? ()
511 : $data
512 }
513}
514
515sub db_put($$$) {
516 BDB::dbreq_pri 4;
517 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
518}
519
520=item cf::cache $id => [$paths...], $processversion => $process
521
522Generic caching function that returns the value of the resource $id,
523caching and regenerating as required.
524
525This function can block.
526
527=cut
528
529sub cache {
530 my ($id, $src, $processversion, $process) = @_;
531
532 my $meta =
533 join "\x00",
534 $processversion,
535 map {
536 aio_stat $_
537 and Carp::croak "$_: $!";
538
539 ($_, (stat _)[7,9])
540 } @$src;
541
542 my $dbmeta = db_get cache => "$id/meta";
543 if ($dbmeta ne $meta) {
544 # changed, we may need to process
545
546 my @data;
547 my $md5;
548
549 for (0 .. $#$src) {
550 0 <= aio_load $src->[$_], $data[$_]
551 or Carp::croak "$src->[$_]: $!";
552 }
553
554 # if processing is expensive, check
555 # checksum first
556 if (1) {
557 $md5 =
558 join "\x00",
559 $processversion,
560 map {
561 Coro::cede;
562 ($src->[$_], Digest::MD5::md5_hex $data[$_])
563 } 0.. $#$src;
564
565
566 my $dbmd5 = db_get cache => "$id/md5";
567 if ($dbmd5 eq $md5) {
568 db_put cache => "$id/meta", $meta;
569
570 return db_get cache => "$id/data";
571 }
572 }
573
574 my $t1 = Time::HiRes::time;
575 my $data = $process->(\@data);
576 my $t2 = Time::HiRes::time;
577
578 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
579
580 db_put cache => "$id/data", $data;
581 db_put cache => "$id/md5" , $md5;
582 db_put cache => "$id/meta", $meta;
583
584 return $data;
585 }
586
587 db_get cache => "$id/data"
431} 588}
432 589
433=item cf::datalog type => key => value, ... 590=item cf::datalog type => key => value, ...
434 591
435Log a datalog packet of the given type with the given key-value pairs. 592Log 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") 610attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
455 612
456In the following description, CLASS can be any of C<global>, C<object> 613In 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 614C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 615Crossfire TRT).
459 616
460=over 4 617=over 4
461 618
462=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
463 620
715 "; 872 ";
716 die if $@; 873 die if $@;
717} 874}
718 875
719our $override; 876our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 877our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 878
722sub override { 879sub override {
723 $override = 1; 880 $override = 1;
724 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
725} 882}
726 883
727sub do_invoke { 884sub do_invoke {
728 my $event = shift; 885 my $event = shift;
729 my $callbacks = shift; 886 my $callbacks = shift;
730 887
731 @invoke_results = (); 888 @INVOKE_RESULTS = ();
732 889
733 local $override; 890 local $override;
734 891
735 for (@$callbacks) { 892 for (@$callbacks) {
736 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
753 910
754Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
755 912
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 913This 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 914removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 916
760=back 917=back
761 918
762=cut 919=cut
763 920
764############################################################################# 921#############################################################################
765# object support 922# object support
923#
924
925sub _can_merge {
926 my ($ob1, $ob2) = @_;
927
928 local $Storable::canonical = 1;
929 my $fob1 = Storable::freeze $ob1;
930 my $fob2 = Storable::freeze $ob2;
931
932 $fob1 eq $fob2
933}
766 934
767sub reattach { 935sub reattach {
768 # basically do the same as instantiate, without calling instantiate 936 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 937 my ($obj) = @_;
770 938
877 warn sprintf "loading %s (%d)\n", 1045 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1046 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1047 return ($data, $av);
880} 1048}
881 1049
1050=head2 COMMAND CALLBACKS
1051
1052=over 4
1053
1054=cut
1055
882############################################################################# 1056#############################################################################
883# command handling &c 1057# command handling &c
884 1058
885=item cf::register_command $name => \&callback($ob,$args); 1059=item cf::register_command $name => \&callback($ob,$args);
886 1060
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1072 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1073}
900 1074
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1075=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1076
903Register a callbackf ro execution when the client sends an extcmd packet. 1077Register a callback for execution when the client sends an (synchronous)
1078extcmd packet. Ext commands will be processed in the order they are
1079received by the server, like other user commands. The first argument is
1080the logged-in player. Ext commands can only be processed after a player
1081has logged in successfully.
904 1082
905If the callback returns something, it is sent back as if reply was being 1083If the callback returns something, it is sent back as if reply was being
906called. 1084called.
907 1085
1086=item cf::register_exticmd $name => \&callback($ns,$packet);
1087
1088Register a callback for execution when the client sends an (asynchronous)
1089exticmd packet. Exti commands are processed by the server as soon as they
1090are received, i.e. out of order w.r.t. other commands. The first argument
1091is a client socket. Exti commands can be received anytime, even before
1092log-in.
1093
1094If the callback returns something, it is sent back as if reply was being
1095called.
1096
908=cut 1097=cut
909 1098
910sub register_extcmd { 1099sub register_extcmd {
911 my ($name, $cb) = @_; 1100 my ($name, $cb) = @_;
912 1101
913 $EXTCMD{$name} = $cb; 1102 $EXTCMD{$name} = $cb;
1103}
1104
1105sub register_exticmd {
1106 my ($name, $cb) = @_;
1107
1108 $EXTICMD{$name} = $cb;
914} 1109}
915 1110
916cf::player->attach ( 1111cf::player->attach (
917 on_command => sub { 1112 on_command => sub {
918 my ($pl, $name, $params) = @_; 1113 my ($pl, $name, $params) = @_;
927 cf::override; 1122 cf::override;
928 }, 1123 },
929 on_extcmd => sub { 1124 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1125 my ($pl, $buf) = @_;
931 1126
932 my $msg = eval { from_json $buf }; 1127 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1128
934 if (ref $msg) { 1129 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1130 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1131 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1132 $pl->ext_reply ($msg->{msgid}, %reply);
1018 }; 1213 };
1019} 1214}
1020 1215
1021############################################################################# 1216#############################################################################
1022 1217
1218=back
1219
1023=head2 CORE EXTENSIONS 1220=head2 CORE EXTENSIONS
1024 1221
1025Functions and methods that extend core crossfire objects. 1222Functions and methods that extend core crossfire objects.
1026 1223
1027=cut 1224=cut
1214 } 1411 }
1215 1412
1216 \@paths 1413 \@paths
1217} 1414}
1218 1415
1416=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1417
1418Expand crossfire pod fragments into protocol xml.
1419
1420=cut
1421
1422sub expand_cfpod {
1423 ((my $self), (local $_)) = @_;
1424
1425 # escape & and <
1426 s/&/&amp;/g;
1427 s/(?<![BIUGH])</&lt;/g;
1428
1429 # this is buggy, it needs to properly take care of nested <'s
1430
1431 1 while
1432 # replace B<>, I<>, U<> etc.
1433 s/B<([^\>]*)>/<b>$1<\/b>/
1434 || s/I<([^\>]*)>/<i>$1<\/i>/
1435 || s/U<([^\>]*)>/<u>$1<\/u>/
1436 # replace G<male|female> tags
1437 || s{G<([^>|]*)\|([^>]*)>}{
1438 $self->gender ? $2 : $1
1439 }ge
1440 # replace H<hint text>
1441 || s{H<([^\>]*)>}
1442 {
1443 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1444 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1445 "")
1446 [$self->{hintmode}]
1447 }ge;
1448
1449 # create single paragraphs (very hackish)
1450 s/(?<=\S)\n(?=\w)/ /g;
1451
1452 # compress some whitespace
1453 s/\s+\n/\n/g; # ws line-ends
1454 s/\n\n+/\n/g; # double lines
1455 s/^\n+//; # beginning lines
1456 s/\n+$//; # ending lines
1457
1458 $_
1459}
1460
1461sub hintmode {
1462 $_[0]{hintmode} = $_[1] if @_ > 1;
1463 $_[0]{hintmode}
1464}
1465
1219=item $player->ext_reply ($msgid, %msg) 1466=item $player->ext_reply ($msgid, %msg)
1220 1467
1221Sends an ext reply to the player. 1468Sends an ext reply to the player.
1222 1469
1223=cut 1470=cut
1224 1471
1225sub ext_reply($$%) { 1472sub ext_reply($$%) {
1226 my ($self, $id, %msg) = @_; 1473 my ($self, $id, %msg) = @_;
1227 1474
1228 $msg{msgid} = $id; 1475 $msg{msgid} = $id;
1229 1476 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1230 $self->send ("ext " . cf::to_json \%msg);
1231} 1477}
1232 1478
1233=item $player->ext_event ($type, %msg) 1479=item $player->ext_event ($type, %msg)
1234 1480
1235Sends an ext event to the client. 1481Sends an ext event to the client.
1250 1496
1251package cf::region; 1497package cf::region;
1252 1498
1253=item cf::region::find_by_path $path 1499=item cf::region::find_by_path $path
1254 1500
1255Tries to decuce the probable region for a map knowing only its path. 1501Tries to decuce the likely region for a map knowing only its path.
1256 1502
1257=cut 1503=cut
1258 1504
1259sub find_by_path($) { 1505sub find_by_path($) {
1260 my ($path) = @_; 1506 my ($path) = @_;
1261 1507
1262 my ($match, $specificity); 1508 my ($match, $specificity);
1263 1509
1264 for my $region (list) { 1510 for my $region (list) {
1265 if ($region->match && $path =~ $region->match) { 1511 if ($region->{match} && $path =~ $region->{match}) {
1266 ($match, $specificity) = ($region, $region->specificity) 1512 ($match, $specificity) = ($region, $region->specificity)
1267 if $region->specificity > $specificity; 1513 if $region->specificity > $specificity;
1268 } 1514 }
1269 } 1515 }
1270 1516
1390 $self->init; # pass $1 etc. 1636 $self->init; # pass $1 etc.
1391 return $self; 1637 return $self;
1392 } 1638 }
1393 } 1639 }
1394 1640
1395 Carp::carp "unable to resolve path '$path' (base '$base')."; 1641 Carp::cluck "unable to resolve path '$path' (base '$base').";
1396 () 1642 ()
1397} 1643}
1398 1644
1399sub init { 1645sub init {
1400 my ($self) = @_; 1646 my ($self) = @_;
1678 1924
1679 undef $MAP_PREFETCH{$path}; 1925 undef $MAP_PREFETCH{$path};
1680 $MAP_PREFETCHER ||= cf::async { 1926 $MAP_PREFETCHER ||= cf::async {
1681 while (%MAP_PREFETCH) { 1927 while (%MAP_PREFETCH) {
1682 for my $path (keys %MAP_PREFETCH) { 1928 for my $path (keys %MAP_PREFETCH) {
1683 my $map = find $path 1929 if (my $map = find $path) {
1684 or next;
1685 $map->load; 1930 $map->load;
1931 }
1686 1932
1687 delete $MAP_PREFETCH{$path}; 1933 delete $MAP_PREFETCH{$path};
1688 } 1934 }
1689 } 1935 }
1690 undef $MAP_PREFETCHER; 1936 undef $MAP_PREFETCHER;
1912 2158
1913 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2159 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1914 2160
1915 if ($self->{record_replies}) { 2161 if ($self->{record_replies}) {
1916 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2162 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2163
1917 } else { 2164 } else {
2165 my $pl = $self->contr;
2166
2167 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2168 my $diag = $pl->{npc_dialog};
2169 $diag->{pl}->ext_reply (
2170 $diag->{id},
2171 msgtype => "reply",
2172 msg => $diag->{pl}->expand_cfpod ($msg),
2173 add_topics => []
2174 );
2175
2176 } else {
1918 $msg = $npc->name . " says: $msg" if $npc; 2177 $msg = $npc->name . " says: $msg" if $npc;
1919 $self->message ($msg, $flags); 2178 $self->message ($msg, $flags);
2179 }
1920 } 2180 }
1921} 2181}
1922 2182
1923=item $player_object->may ("access") 2183=item $player_object->may ("access")
1924 2184
2013 2273
2014 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2274 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2015 $self->enter_map ($map, $x, $y); 2275 $self->enter_map ($map, $x, $y);
2016} 2276}
2017 2277
2018=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2278=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2019 2279
2020Moves the player to the given map-path and coordinates by first freezing 2280Moves the player to the given map-path and coordinates by first freezing
2021her, loading and preparing them map, calling the provided $check callback 2281her, loading and preparing them map, calling the provided $check callback
2022that has to return the map if sucecssful, and then unfreezes the player on 2282that has to return the map if sucecssful, and then unfreezes the player on
2023the new (success) or old (failed) map position. 2283the new (success) or old (failed) map position. In either case, $done will
2284be called at the end of this process.
2024 2285
2025=cut 2286=cut
2026 2287
2027our $GOTOGEN; 2288our $GOTOGEN;
2028 2289
2029sub cf::object::player::goto { 2290sub cf::object::player::goto {
2030 my ($self, $path, $x, $y, $check) = @_; 2291 my ($self, $path, $x, $y, $check, $done) = @_;
2031 2292
2032 # do generation counting so two concurrent goto's will be executed in-order 2293 # do generation counting so two concurrent goto's will be executed in-order
2033 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2294 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2034 2295
2035 $self->enter_link; 2296 $self->enter_link;
2055 2316
2056 if ($gen == $self->{_goto_generation}) { 2317 if ($gen == $self->{_goto_generation}) {
2057 delete $self->{_goto_generation}; 2318 delete $self->{_goto_generation};
2058 $self->leave_link ($map, $x, $y); 2319 $self->leave_link ($map, $x, $y);
2059 } 2320 }
2321
2322 $done->() if $done;
2060 })->prio (1); 2323 })->prio (1);
2061} 2324}
2062 2325
2063=item $player_object->enter_exit ($exit_object) 2326=item $player_object->enter_exit ($exit_object)
2064 2327
2133 my $hp = $exit->stats->hp; 2396 my $hp = $exit->stats->hp;
2134 my $sp = $exit->stats->sp; 2397 my $sp = $exit->stats->sp;
2135 2398
2136 $self->enter_link; 2399 $self->enter_link;
2137 2400
2401 # if exit is damned, update players death & WoR home-position
2402 $self->contr->savebed ($slaying, $hp, $sp)
2403 if $exit->flag (FLAG_DAMNED);
2404
2138 (async { 2405 (async {
2139 $self->deactivate_recursive; # just to be sure 2406 $self->deactivate_recursive; # just to be sure
2140 unless (eval { 2407 unless (eval {
2141 $self->goto ($slaying, $hp, $sp); 2408 $self->goto ($slaying, $hp, $sp);
2142 2409
2169 2436
2170 utf8::encode $text; 2437 utf8::encode $text;
2171 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2438 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2172} 2439}
2173 2440
2441=item $client->send_msg ($channel, $msg, $color, [extra...])
2442
2443Send a drawinfo or msg packet to the client, formatting the msg for the
2444client if neccessary. C<$type> should be a string identifying the type of
2445the message, with C<log> being the default. If C<$color> is negative, suppress
2446the message unless the client supports the msg packet.
2447
2448=cut
2449
2450sub cf::client::send_msg {
2451 my ($self, $channel, $msg, $color, @extra) = @_;
2452
2453 $msg = $self->pl->expand_cfpod ($msg);
2454
2455 $color &= ~cf::NDI_UNIQUE; # just in case...
2456
2457 if (ref $channel) {
2458 # send meta info to client, if not yet sent
2459 unless (exists $self->{channel}{$channel->{id}}) {
2460 $self->{channel}{$channel->{id}} = $channel;
2461 $self->ext_event (channel_info => %$channel);
2462 }
2463
2464 $channel = $channel->{id};
2465 }
2466
2467 return unless @extra || length $msg;
2468
2469 if ($self->can_msg) {
2470 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2471 } else {
2472 # replace some tags by gcfclient-compatible ones
2473 for ($msg) {
2474 1 while
2475 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2476 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2477 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2478 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2479 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2480 }
2481
2482 if ($color >= 0) {
2483 if (0 && $msg =~ /\[/) {
2484 $self->send_packet ("drawextinfo $color 4 0 $msg")
2485 } else {
2486 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2487 $self->send_packet ("drawinfo $color $msg")
2488 }
2489 }
2490 }
2491}
2492
2174=item $client->ext_event ($type, %msg) 2493=item $client->ext_event ($type, %msg)
2175 2494
2176Sends an exti event to the client. 2495Sends an ext event to the client.
2177 2496
2178=cut 2497=cut
2179 2498
2180sub cf::client::ext_event($$%) { 2499sub cf::client::ext_event($$%) {
2181 my ($self, $type, %msg) = @_; 2500 my ($self, $type, %msg) = @_;
2182 2501
2502 return unless $self->extcmd;
2503
2183 $msg{msgtype} = "event_$type"; 2504 $msg{msgtype} = "event_$type";
2184 $self->send_packet ("ext " . cf::to_json \%msg); 2505 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2185} 2506}
2186 2507
2187=item $success = $client->query ($flags, "text", \&cb) 2508=item $success = $client->query ($flags, "text", \&cb)
2188 2509
2189Queues a query to the client, calling the given callback with 2510Queues a query to the client, calling the given callback with
2190the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2511the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2191C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2512C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2192 2513
2193Queries can fail, so check the return code. Or don't, as queries will become 2514Queries can fail, so check the return code. Or don't, as queries will
2194reliable at some point in the future. 2515become reliable at some point in the future.
2195 2516
2196=cut 2517=cut
2197 2518
2198sub cf::client::query { 2519sub cf::client::query {
2199 my ($self, $flags, $text, $cb) = @_; 2520 my ($self, $flags, $text, $cb) = @_;
2207 utf8::encode $text; 2528 utf8::encode $text;
2208 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2529 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2209 2530
2210 $self->send_packet ($self->{query_queue}[0][0]) 2531 $self->send_packet ($self->{query_queue}[0][0])
2211 if @{ $self->{query_queue} } == 1; 2532 if @{ $self->{query_queue} } == 1;
2533
2534 1
2212} 2535}
2213 2536
2214cf::client->attach ( 2537cf::client->attach (
2538 on_connect => sub {
2539 my ($ns) = @_;
2540
2541 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2542 },
2215 on_reply => sub { 2543 on_reply => sub {
2216 my ($ns, $msg) = @_; 2544 my ($ns, $msg) = @_;
2217 2545
2218 # this weird shuffling is so that direct followup queries 2546 # this weird shuffling is so that direct followup queries
2219 # get handled first 2547 # get handled first
2231 } else { 2559 } else {
2232 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2560 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2233 } 2561 }
2234 } 2562 }
2235 }, 2563 },
2564 on_exticmd => sub {
2565 my ($ns, $buf) = @_;
2566
2567 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2568
2569 if (ref $msg) {
2570 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2571 if (my %reply = $cb->($ns, $msg)) {
2572 $reply{msgid} = $msg->{msgid};
2573 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2574 }
2575 }
2576 } else {
2577 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2578 }
2579
2580 cf::override;
2581 },
2236); 2582);
2237 2583
2238=item $client->async (\&cb) 2584=item $client->async (\&cb)
2239 2585
2240Create a new coroutine, running the specified callback. The coroutine will 2586Create a new coroutine, running the specified callback. The coroutine will
2289 2635
2290=pod 2636=pod
2291 2637
2292The following functions and methods are available within a safe environment: 2638The following functions and methods are available within a safe environment:
2293 2639
2294 cf::object contr pay_amount pay_player map 2640 cf::object
2641 contr pay_amount pay_player map x y force_find force_add
2642 insert remove
2643
2295 cf::object::player player 2644 cf::object::player
2296 cf::player peaceful 2645 player
2297 cf::map trigger 2646
2647 cf::player
2648 peaceful
2649
2650 cf::map
2651 trigger
2298 2652
2299=cut 2653=cut
2300 2654
2301for ( 2655for (
2302 ["cf::object" => qw(contr pay_amount pay_player map)], 2656 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2657 insert remove)],
2303 ["cf::object::player" => qw(player)], 2658 ["cf::object::player" => qw(player)],
2304 ["cf::player" => qw(peaceful)], 2659 ["cf::player" => qw(peaceful)],
2305 ["cf::map" => qw(trigger)], 2660 ["cf::map" => qw(trigger)],
2306) { 2661) {
2307 no strict 'refs'; 2662 no strict 'refs';
2378=back 2733=back
2379 2734
2380=cut 2735=cut
2381 2736
2382############################################################################# 2737#############################################################################
2383
2384=head2 EXTENSION DATABASE SUPPORT
2385
2386Crossfire maintains a very simple database for extension use. It can
2387currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2388convert to/from binary).
2389
2390The parameter C<$family> should best start with the name of the extension
2391using it, it should be unique.
2392
2393=over 4
2394
2395=item $value = cf::db_get $family => $key
2396
2397Returns a single value from the database.
2398
2399=item cf::db_put $family => $key => $value
2400
2401Stores the given C<$value> in the family.
2402
2403=cut
2404
2405our $DB;
2406
2407sub db_init {
2408 unless ($DB) {
2409 $DB = BDB::db_create $DB_ENV;
2410
2411 cf::sync_job {
2412 eval {
2413 $DB->set_flags (BDB::CHKSUM);
2414
2415 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2416 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2417 cf::cleanup "db_open(db): $!" if $!;
2418 };
2419 cf::cleanup "db_open(db): $@" if $@;
2420 };
2421 }
2422}
2423
2424sub db_get($$) {
2425 my $key = "$_[0]/$_[1]";
2426
2427 cf::sync_job {
2428 BDB::db_get $DB, undef, $key, my $data;
2429
2430 $! ? ()
2431 : $data
2432 }
2433}
2434
2435sub db_put($$$) {
2436 BDB::dbreq_pri 4;
2437 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2438}
2439
2440=item cf::cache $id => [$paths...], $processversion => $process
2441
2442Generic caching function that returns the value of the resource $id,
2443caching and regenerating as required.
2444
2445This function can block.
2446
2447=cut
2448
2449sub cache {
2450 my ($id, $src, $processversion, $process) = @_;
2451
2452 my $meta =
2453 join "\x00",
2454 $processversion,
2455 map {
2456 aio_stat $_
2457 and Carp::croak "$_: $!";
2458
2459 ($_, (stat _)[7,9])
2460 } @$src;
2461
2462 my $dbmeta = db_get cache => "$id/meta";
2463 if ($dbmeta ne $meta) {
2464 # changed, we may need to process
2465
2466 my @data;
2467 my $md5;
2468
2469 for (0 .. $#$src) {
2470 0 <= aio_load $src->[$_], $data[$_]
2471 or Carp::croak "$src->[$_]: $!";
2472 }
2473
2474 # if processing is expensive, check
2475 # checksum first
2476 if (1) {
2477 $md5 =
2478 join "\x00",
2479 $processversion,
2480 map {
2481 Coro::cede;
2482 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2483 } 0.. $#$src;
2484
2485
2486 my $dbmd5 = db_get cache => "$id/md5";
2487 if ($dbmd5 eq $md5) {
2488 db_put cache => "$id/meta", $meta;
2489
2490 return db_get cache => "$id/data";
2491 }
2492 }
2493
2494 my $t1 = Time::HiRes::time;
2495 my $data = $process->(\@data);
2496 my $t2 = Time::HiRes::time;
2497
2498 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2499
2500 db_put cache => "$id/data", $data;
2501 db_put cache => "$id/md5" , $md5;
2502 db_put cache => "$id/meta", $meta;
2503
2504 return $data;
2505 }
2506
2507 db_get cache => "$id/data"
2508}
2509
2510=item fork_call { }, $args
2511
2512Executes the given code block with the given arguments in a seperate
2513process, returning the results. Everything must be serialisable with
2514Coro::Storable. May, of course, block. Note that the executed sub may
2515never block itself or use any form of Event handling.
2516
2517=cut
2518
2519sub fork_call(&@) {
2520 my ($cb, @args) = @_;
2521
2522# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2523# or die "socketpair: $!";
2524 pipe my $fh1, my $fh2
2525 or die "pipe: $!";
2526
2527 if (my $pid = fork) {
2528 close $fh2;
2529
2530 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2531 $res = Coro::Storable::thaw $res;
2532
2533 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2534
2535 die $$res unless "ARRAY" eq ref $res;
2536
2537 return wantarray ? @$res : $res->[-1];
2538 } else {
2539 reset_signals;
2540 local $SIG{__WARN__};
2541 local $SIG{__DIE__};
2542 eval {
2543 close $fh1;
2544
2545 my @res = eval { $cb->(@args) };
2546 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2547 };
2548
2549 warn $@ if $@;
2550 _exit 0;
2551 }
2552}
2553
2554#############################################################################
2555# the server's init and main functions 2738# the server's init and main functions
2556 2739
2557sub load_facedata($) { 2740sub load_facedata($) {
2558 my ($path) = @_; 2741 my ($path) = @_;
2559 2742
2571 { 2754 {
2572 my $faces = $facedata->{faceinfo}; 2755 my $faces = $facedata->{faceinfo};
2573 2756
2574 while (my ($face, $info) = each %$faces) { 2757 while (my ($face, $info) = each %$faces) {
2575 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2758 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2576 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2759 cf::face::set_visibility $idx, $info->{visibility};
2760 cf::face::set_magicmap $idx, $info->{magicmap};
2577 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2761 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2578 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2762 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2579 Coro::cede; 2763
2764 cf::cede_to_tick;
2580 } 2765 }
2581 2766
2582 while (my ($face, $info) = each %$faces) { 2767 while (my ($face, $info) = each %$faces) {
2583 next unless $info->{smooth}; 2768 next unless $info->{smooth};
2584 my $idx = cf::face::find $face 2769 my $idx = cf::face::find $face
2585 or next; 2770 or next;
2586 if (my $smooth = cf::face::find $info->{smooth}) { 2771 if (my $smooth = cf::face::find $info->{smooth}) {
2772 cf::face::set_smooth $idx, $smooth;
2587 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2773 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2588 } else { 2774 } else {
2589 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2775 warn "smooth face '$info->{smooth}' not found for face '$face'";
2590 } 2776 }
2591 Coro::cede; 2777
2778 cf::cede_to_tick;
2592 } 2779 }
2593 } 2780 }
2594 2781
2595 { 2782 {
2596 my $anims = $facedata->{animinfo}; 2783 my $anims = $facedata->{animinfo};
2597 2784
2598 while (my ($anim, $info) = each %$anims) { 2785 while (my ($anim, $info) = each %$anims) {
2599 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2786 cf::anim::set $anim, $info->{frames}, $info->{facings};
2600 Coro::cede; 2787 cf::cede_to_tick;
2601 } 2788 }
2602 2789
2603 cf::anim::invalidate_all; # d'oh 2790 cf::anim::invalidate_all; # d'oh
2791 }
2792
2793 {
2794 # TODO: for gcfclient pleasure, we should give resources
2795 # that gcfclient doesn't grok a >10000 face index.
2796 my $res = $facedata->{resource};
2797 my $enc = JSON::XS->new->utf8->canonical;
2798
2799 while (my ($name, $info) = each %$res) {
2800 my $meta = $enc->encode ({
2801 name => $name,
2802 type => $info->{type},
2803 copyright => $info->{copyright}, #TODO#
2804 });
2805
2806 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2807
2808 if ($name =~ /\.jpg$/) {
2809 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2810 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2811 } else {
2812 my $data = pack "(w/a*)*", $meta, $info->{data};
2813 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2814
2815 cf::face::set_type $idx, 1;
2816 cf::face::set_data $idx, 0, $data, $chk;
2817 }
2818
2819 cf::cede_to_tick;
2820 }
2604 } 2821 }
2605 2822
2606 1 2823 1
2607} 2824}
2608 2825
2609sub reload_regions { 2826sub reload_regions {
2610 load_resource_file "$MAPDIR/regions" 2827 load_resource_file "$MAPDIR/regions"
2611 or die "unable to load regions file\n"; 2828 or die "unable to load regions file\n";
2829
2830 for (cf::region::list) {
2831 $_->{match} = qr/$_->{match}/
2832 if exists $_->{match};
2833 }
2612} 2834}
2613 2835
2614sub reload_facedata { 2836sub reload_facedata {
2615 load_facedata "$DATADIR/facedata" 2837 load_facedata "$DATADIR/facedata"
2616 or die "unable to load facedata\n"; 2838 or die "unable to load facedata\n";
2617} 2839}
2618 2840
2619sub reload_archetypes { 2841sub reload_archetypes {
2842 load_resource_file "$DATADIR/archetypes"
2843 or die "unable to load archetypes\n";
2844 #d# NEED to laod twice to resolve forward references
2845 # this really needs to be done in an extra post-pass
2846 # (which needs to be synchronous, so solve it differently)
2620 load_resource_file "$DATADIR/archetypes" 2847 load_resource_file "$DATADIR/archetypes"
2621 or die "unable to load archetypes\n"; 2848 or die "unable to load archetypes\n";
2622} 2849}
2623 2850
2624sub reload_treasures { 2851sub reload_treasures {
2696 }, 2923 },
2697 ); 2924 );
2698 } 2925 }
2699} 2926}
2700 2927
2928sub write_runtime {
2929 my $runtime = "$LOCALDIR/runtime";
2930
2931 # first touch the runtime file to show we are still running:
2932 # the fsync below can take a very very long time.
2933
2934 IO::AIO::aio_utime $runtime, undef, undef;
2935
2936 my $guard = cf::lock_acquire "write_runtime";
2937
2938 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2939 or return;
2940
2941 my $value = $cf::RUNTIME + 90 + 10;
2942 # 10 is the runtime save interval, for a monotonic clock
2943 # 60 allows for the watchdog to kill the server.
2944
2945 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2946 and return;
2947
2948 # always fsync - this file is important
2949 aio_fsync $fh
2950 and return;
2951
2952 # touch it again to show we are up-to-date
2953 aio_utime $fh, undef, undef;
2954
2955 close $fh
2956 or return;
2957
2958 aio_rename "$runtime~", $runtime
2959 and return;
2960
2961 warn "runtime file written.\n";
2962
2963 1
2964}
2965
2701sub emergency_save() { 2966sub emergency_save() {
2702 my $freeze_guard = cf::freeze_mainloop; 2967 my $freeze_guard = cf::freeze_mainloop;
2703 2968
2704 warn "enter emergency perl save\n"; 2969 warn "enter emergency perl save\n";
2705 2970
2780 %EXT_CORO = (); 3045 %EXT_CORO = ();
2781 3046
2782 warn "removing commands"; 3047 warn "removing commands";
2783 %COMMAND = (); 3048 %COMMAND = ();
2784 3049
2785 warn "removing ext commands"; 3050 warn "removing ext/exti commands";
2786 %EXTCMD = (); 3051 %EXTCMD = ();
3052 %EXTICMD = ();
2787 3053
2788 warn "unloading/nuking all extensions"; 3054 warn "unloading/nuking all extensions";
2789 for my $pkg (@EXTS) { 3055 for my $pkg (@EXTS) {
2790 warn "... unloading $pkg"; 3056 warn "... unloading $pkg";
2791 3057

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines