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.310 by elmex, Mon Jul 16 15:43:49 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
877 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1035 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1036 return ($data, $av);
880} 1037}
881 1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
1044
882############################################################################# 1045#############################################################################
883# command handling &c 1046# command handling &c
884 1047
885=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
886 1049
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1062}
900 1063
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1065
903Register a callbackf ro execution when the client sends an extcmd packet. 1066Register a callback for execution when the client sends an (synchronous)
1067extcmd packet. Ext commands will be processed in the order they are
1068received by the server, like other user commands. The first argument is
1069the logged-in player. Ext commands can only be processed after a player
1070has logged in successfully.
904 1071
905If the callback returns something, it is sent back as if reply was being 1072If the callback returns something, it is sent back as if reply was being
906called. 1073called.
907 1074
1075=item cf::register_exticmd $name => \&callback($ns,$packet);
1076
1077Register a callback for execution when the client sends an (asynchronous)
1078exticmd packet. Exti commands are processed by the server as soon as they
1079are received, i.e. out of order w.r.t. other commands. The first argument
1080is a client socket. Exti commands can be received anytime, even before
1081log-in.
1082
1083If the callback returns something, it is sent back as if reply was being
1084called.
1085
908=cut 1086=cut
909 1087
910sub register_extcmd { 1088sub register_extcmd {
911 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
912 1090
913 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
914} 1098}
915 1099
916cf::player->attach ( 1100cf::player->attach (
917 on_command => sub { 1101 on_command => sub {
918 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
927 cf::override; 1111 cf::override;
928 }, 1112 },
929 on_extcmd => sub { 1113 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
931 1115
932 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1117
934 if (ref $msg) { 1118 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
1018 }; 1202 };
1019} 1203}
1020 1204
1021############################################################################# 1205#############################################################################
1022 1206
1207=back
1208
1023=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
1024 1210
1025Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
1026 1212
1027=cut 1213=cut
1214 } 1400 }
1215 1401
1216 \@paths 1402 \@paths
1217} 1403}
1218 1404
1405=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1406
1407Expand crossfire pod fragments into protocol xml.
1408
1409=cut
1410
1411sub expand_cfpod {
1412 ((my $self), (local $_)) = @_;
1413
1414 # escape & and <
1415 s/&/&amp;/g;
1416 s/(?<![BIUGH])</&lt;/g;
1417
1418 # this is buggy, it needs to properly take care of nested <'s
1419
1420 1 while
1421 # replace B<>, I<>, U<> etc.
1422 s/B<([^\>]*)>/<b>$1<\/b>/
1423 || s/I<([^\>]*)>/<i>$1<\/i>/
1424 || s/U<([^\>]*)>/<u>$1<\/u>/
1425 # replace G<male|female> tags
1426 || s{G<([^>|]*)\|([^>]*)>}{
1427 $self->gender ? $2 : $1
1428 }ge
1429 # replace H<hint text>
1430 || s{H<([^\>]*)>}
1431 {
1432 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1433 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1434 "")
1435 [$self->{hintmode}]
1436 }ge;
1437
1438 # create single paragraphs (very hackish)
1439 s/(?<=\S)\n(?=\w)/ /g;
1440
1441 # compress some whitespace
1442 s/\s+\n/\n/g; # ws line-ends
1443 s/\n\n+/\n/g; # double lines
1444 s/^\n+//; # beginning lines
1445 s/\n+$//; # ending lines
1446
1447 $_
1448}
1449
1450sub hintmode {
1451 $_[0]{hintmode} = $_[1] if @_ > 1;
1452 $_[0]{hintmode}
1453}
1454
1219=item $player->ext_reply ($msgid, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1220 1456
1221Sends an ext reply to the player. 1457Sends an ext reply to the player.
1222 1458
1223=cut 1459=cut
1224 1460
1225sub ext_reply($$%) { 1461sub ext_reply($$%) {
1226 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1227 1463
1228 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1229 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1230 $self->send ("ext " . cf::to_json \%msg);
1231} 1466}
1232 1467
1233=item $player->ext_event ($type, %msg) 1468=item $player->ext_event ($type, %msg)
1234 1469
1235Sends an ext event to the client. 1470Sends an ext event to the client.
1250 1485
1251package cf::region; 1486package cf::region;
1252 1487
1253=item cf::region::find_by_path $path 1488=item cf::region::find_by_path $path
1254 1489
1255Tries to decuce the probable region for a map knowing only its path. 1490Tries to decuce the likely region for a map knowing only its path.
1256 1491
1257=cut 1492=cut
1258 1493
1259sub find_by_path($) { 1494sub find_by_path($) {
1260 my ($path) = @_; 1495 my ($path) = @_;
1261 1496
1262 my ($match, $specificity); 1497 my ($match, $specificity);
1263 1498
1264 for my $region (list) { 1499 for my $region (list) {
1265 if ($region->match && $path =~ $region->match) { 1500 if ($region->{match} && $path =~ $region->{match}) {
1266 ($match, $specificity) = ($region, $region->specificity) 1501 ($match, $specificity) = ($region, $region->specificity)
1267 if $region->specificity > $specificity; 1502 if $region->specificity > $specificity;
1268 } 1503 }
1269 } 1504 }
1270 1505
1390 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1391 return $self; 1626 return $self;
1392 } 1627 }
1393 } 1628 }
1394 1629
1395 Carp::carp "unable to resolve path '$path' (base '$base')."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1396 () 1631 ()
1397} 1632}
1398 1633
1399sub init { 1634sub init {
1400 my ($self) = @_; 1635 my ($self) = @_;
1678 1913
1679 undef $MAP_PREFETCH{$path}; 1914 undef $MAP_PREFETCH{$path};
1680 $MAP_PREFETCHER ||= cf::async { 1915 $MAP_PREFETCHER ||= cf::async {
1681 while (%MAP_PREFETCH) { 1916 while (%MAP_PREFETCH) {
1682 for my $path (keys %MAP_PREFETCH) { 1917 for my $path (keys %MAP_PREFETCH) {
1683 my $map = find $path 1918 if (my $map = find $path) {
1684 or next;
1685 $map->load; 1919 $map->load;
1920 }
1686 1921
1687 delete $MAP_PREFETCH{$path}; 1922 delete $MAP_PREFETCH{$path};
1688 } 1923 }
1689 } 1924 }
1690 undef $MAP_PREFETCHER; 1925 undef $MAP_PREFETCHER;
1912 2147
1913 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1914 2149
1915 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1916 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1917 } else { 2153 } else {
2154 my $pl = $self->contr;
2155
2156 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2157 my $diag = $pl->{npc_dialog};
2158 $diag->{pl}->ext_reply (
2159 $diag->{id},
2160 msgtype => "reply",
2161 msg => $diag->{pl}->expand_cfpod ($msg),
2162 add_topics => []
2163 );
2164
2165 } else {
1918 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1919 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1920 } 2169 }
1921} 2170}
1922 2171
1923=item $player_object->may ("access") 2172=item $player_object->may ("access")
1924 2173
2013 2262
2014 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2015 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
2016} 2265}
2017 2266
2018=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2019 2268
2020Moves the player to the given map-path and coordinates by first freezing 2269Moves the player to the given map-path and coordinates by first freezing
2021her, loading and preparing them map, calling the provided $check callback 2270her, loading and preparing them map, calling the provided $check callback
2022that has to return the map if sucecssful, and then unfreezes the player on 2271that has to return the map if sucecssful, and then unfreezes the player on
2023the new (success) or old (failed) map position. 2272the new (success) or old (failed) map position. In either case, $done will
2273be called at the end of this process.
2024 2274
2025=cut 2275=cut
2026 2276
2027our $GOTOGEN; 2277our $GOTOGEN;
2028 2278
2029sub cf::object::player::goto { 2279sub cf::object::player::goto {
2030 my ($self, $path, $x, $y, $check) = @_; 2280 my ($self, $path, $x, $y, $check, $done) = @_;
2031 2281
2032 # do generation counting so two concurrent goto's will be executed in-order 2282 # do generation counting so two concurrent goto's will be executed in-order
2033 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2283 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2034 2284
2035 $self->enter_link; 2285 $self->enter_link;
2055 2305
2056 if ($gen == $self->{_goto_generation}) { 2306 if ($gen == $self->{_goto_generation}) {
2057 delete $self->{_goto_generation}; 2307 delete $self->{_goto_generation};
2058 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2059 } 2309 }
2310
2311 $done->() if $done;
2060 })->prio (1); 2312 })->prio (1);
2061} 2313}
2062 2314
2063=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
2064 2316
2133 my $hp = $exit->stats->hp; 2385 my $hp = $exit->stats->hp;
2134 my $sp = $exit->stats->sp; 2386 my $sp = $exit->stats->sp;
2135 2387
2136 $self->enter_link; 2388 $self->enter_link;
2137 2389
2390 # if exit is damned, update players death & WoR home-position
2391 $self->contr->savebed ($slaying, $hp, $sp)
2392 if $exit->flag (FLAG_DAMNED);
2393
2138 (async { 2394 (async {
2139 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
2140 unless (eval { 2396 unless (eval {
2141 $self->goto ($slaying, $hp, $sp); 2397 $self->goto ($slaying, $hp, $sp);
2142 2398
2169 2425
2170 utf8::encode $text; 2426 utf8::encode $text;
2171 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2427 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2172} 2428}
2173 2429
2430=item $client->send_msg ($color, $type, $msg, [extra...])
2431
2432Send a drawinfo or msg packet to the client, formatting the msg for the
2433client if neccessary. C<$type> should be a string identifying the type of
2434the message, with C<log> being the default. If C<$color> is negative, suppress
2435the message unless the client supports the msg packet.
2436
2437=cut
2438
2439sub cf::client::send_msg {
2440 my ($self, $color, $type, $msg, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 if ($self->can_msg) {
2447 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2448 } else {
2449 # replace some tags by gcfclient-compatible ones
2450 for ($msg) {
2451 1 while
2452 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2453 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2454 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2455 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2456 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2457 }
2458
2459 if ($color >= 0) {
2460 if (0 && $msg =~ /\[/) {
2461 $self->send_packet ("drawextinfo $color 4 0 $msg")
2462 } else {
2463 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2464 $self->send_packet ("drawinfo $color $msg")
2465 }
2466 }
2467 }
2468}
2469
2174=item $client->ext_event ($type, %msg) 2470=item $client->ext_event ($type, %msg)
2175 2471
2176Sends an exti event to the client. 2472Sends an ext event to the client.
2177 2473
2178=cut 2474=cut
2179 2475
2180sub cf::client::ext_event($$%) { 2476sub cf::client::ext_event($$%) {
2181 my ($self, $type, %msg) = @_; 2477 my ($self, $type, %msg) = @_;
2182 2478
2479 return unless $self->extcmd;
2480
2183 $msg{msgtype} = "event_$type"; 2481 $msg{msgtype} = "event_$type";
2184 $self->send_packet ("ext " . cf::to_json \%msg); 2482 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2185} 2483}
2186 2484
2187=item $success = $client->query ($flags, "text", \&cb) 2485=item $success = $client->query ($flags, "text", \&cb)
2188 2486
2189Queues a query to the client, calling the given callback with 2487Queues a query to the client, calling the given callback with
2190the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2488the 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>. 2489C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2192 2490
2193Queries can fail, so check the return code. Or don't, as queries will become 2491Queries can fail, so check the return code. Or don't, as queries will
2194reliable at some point in the future. 2492become reliable at some point in the future.
2195 2493
2196=cut 2494=cut
2197 2495
2198sub cf::client::query { 2496sub cf::client::query {
2199 my ($self, $flags, $text, $cb) = @_; 2497 my ($self, $flags, $text, $cb) = @_;
2207 utf8::encode $text; 2505 utf8::encode $text;
2208 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2506 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2209 2507
2210 $self->send_packet ($self->{query_queue}[0][0]) 2508 $self->send_packet ($self->{query_queue}[0][0])
2211 if @{ $self->{query_queue} } == 1; 2509 if @{ $self->{query_queue} } == 1;
2510
2511 1
2212} 2512}
2213 2513
2214cf::client->attach ( 2514cf::client->attach (
2515 on_connect => sub {
2516 my ($ns) = @_;
2517
2518 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2519 },
2215 on_reply => sub { 2520 on_reply => sub {
2216 my ($ns, $msg) = @_; 2521 my ($ns, $msg) = @_;
2217 2522
2218 # this weird shuffling is so that direct followup queries 2523 # this weird shuffling is so that direct followup queries
2219 # get handled first 2524 # get handled first
2231 } else { 2536 } else {
2232 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2537 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2233 } 2538 }
2234 } 2539 }
2235 }, 2540 },
2541 on_exticmd => sub {
2542 my ($ns, $buf) = @_;
2543
2544 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2545
2546 if (ref $msg) {
2547 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2548 if (my %reply = $cb->($ns, $msg)) {
2549 $reply{msgid} = $msg->{msgid};
2550 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2551 }
2552 }
2553 } else {
2554 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2555 }
2556
2557 cf::override;
2558 },
2236); 2559);
2237 2560
2238=item $client->async (\&cb) 2561=item $client->async (\&cb)
2239 2562
2240Create a new coroutine, running the specified callback. The coroutine will 2563Create a new coroutine, running the specified callback. The coroutine will
2289 2612
2290=pod 2613=pod
2291 2614
2292The following functions and methods are available within a safe environment: 2615The following functions and methods are available within a safe environment:
2293 2616
2294 cf::object contr pay_amount pay_player map 2617 cf::object
2618 contr pay_amount pay_player map x y force_find force_add
2619 insert remove
2620
2295 cf::object::player player 2621 cf::object::player
2296 cf::player peaceful 2622 player
2297 cf::map trigger 2623
2624 cf::player
2625 peaceful
2626
2627 cf::map
2628 trigger
2298 2629
2299=cut 2630=cut
2300 2631
2301for ( 2632for (
2302 ["cf::object" => qw(contr pay_amount pay_player map)], 2633 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2634 insert remove)],
2303 ["cf::object::player" => qw(player)], 2635 ["cf::object::player" => qw(player)],
2304 ["cf::player" => qw(peaceful)], 2636 ["cf::player" => qw(peaceful)],
2305 ["cf::map" => qw(trigger)], 2637 ["cf::map" => qw(trigger)],
2306) { 2638) {
2307 no strict 'refs'; 2639 no strict 'refs';
2378=back 2710=back
2379 2711
2380=cut 2712=cut
2381 2713
2382############################################################################# 2714#############################################################################
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 2715# the server's init and main functions
2556 2716
2557sub load_facedata($) { 2717sub load_facedata($) {
2558 my ($path) = @_; 2718 my ($path) = @_;
2559 2719
2571 { 2731 {
2572 my $faces = $facedata->{faceinfo}; 2732 my $faces = $facedata->{faceinfo};
2573 2733
2574 while (my ($face, $info) = each %$faces) { 2734 while (my ($face, $info) = each %$faces) {
2575 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2735 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2576 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2736 cf::face::set_visibility $idx, $info->{visibility};
2737 cf::face::set_magicmap $idx, $info->{magicmap};
2577 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2738 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2578 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2739 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2579 Coro::cede; 2740
2741 cf::cede_to_tick;
2580 } 2742 }
2581 2743
2582 while (my ($face, $info) = each %$faces) { 2744 while (my ($face, $info) = each %$faces) {
2583 next unless $info->{smooth}; 2745 next unless $info->{smooth};
2584 my $idx = cf::face::find $face 2746 my $idx = cf::face::find $face
2585 or next; 2747 or next;
2586 if (my $smooth = cf::face::find $info->{smooth}) { 2748 if (my $smooth = cf::face::find $info->{smooth}) {
2749 cf::face::set_smooth $idx, $smooth;
2587 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2750 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2588 } else { 2751 } else {
2589 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2752 warn "smooth face '$info->{smooth}' not found for face '$face'";
2590 } 2753 }
2591 Coro::cede; 2754
2755 cf::cede_to_tick;
2592 } 2756 }
2593 } 2757 }
2594 2758
2595 { 2759 {
2596 my $anims = $facedata->{animinfo}; 2760 my $anims = $facedata->{animinfo};
2597 2761
2598 while (my ($anim, $info) = each %$anims) { 2762 while (my ($anim, $info) = each %$anims) {
2599 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2763 cf::anim::set $anim, $info->{frames}, $info->{facings};
2600 Coro::cede; 2764 cf::cede_to_tick;
2601 } 2765 }
2602 2766
2603 cf::anim::invalidate_all; # d'oh 2767 cf::anim::invalidate_all; # d'oh
2768 }
2769
2770 {
2771 # TODO: for gcfclient pleasure, we should give resources
2772 # that gcfclient doesn't grok a >10000 face index.
2773 my $res = $facedata->{resource};
2774 my $enc = JSON::XS->new->utf8->canonical;
2775
2776 while (my ($name, $info) = each %$res) {
2777 my $meta = $enc->encode ({
2778 name => $name,
2779 type => $info->{type},
2780 copyright => $info->{copyright}, #TODO#
2781 });
2782
2783 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2784
2785 if ($name =~ /\.jpg$/) {
2786 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2787 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2788 } else {
2789 my $data = pack "(w/a*)*", $meta, $info->{data};
2790 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2791
2792 cf::face::set_type $idx, 1;
2793 cf::face::set_data $idx, 0, $data, $chk;
2794 }
2795
2796 cf::cede_to_tick;
2797 }
2604 } 2798 }
2605 2799
2606 1 2800 1
2607} 2801}
2608 2802
2609sub reload_regions { 2803sub reload_regions {
2610 load_resource_file "$MAPDIR/regions" 2804 load_resource_file "$MAPDIR/regions"
2611 or die "unable to load regions file\n"; 2805 or die "unable to load regions file\n";
2806
2807 for (cf::region::list) {
2808 $_->{match} = qr/$_->{match}/
2809 if exists $_->{match};
2810 }
2612} 2811}
2613 2812
2614sub reload_facedata { 2813sub reload_facedata {
2615 load_facedata "$DATADIR/facedata" 2814 load_facedata "$DATADIR/facedata"
2616 or die "unable to load facedata\n"; 2815 or die "unable to load facedata\n";
2617} 2816}
2618 2817
2619sub reload_archetypes { 2818sub reload_archetypes {
2819 load_resource_file "$DATADIR/archetypes"
2820 or die "unable to load archetypes\n";
2821 #d# NEED to laod twice to resolve forward references
2822 # this really needs to be done in an extra post-pass
2823 # (which needs to be synchronous, so solve it differently)
2620 load_resource_file "$DATADIR/archetypes" 2824 load_resource_file "$DATADIR/archetypes"
2621 or die "unable to load archetypes\n"; 2825 or die "unable to load archetypes\n";
2622} 2826}
2623 2827
2624sub reload_treasures { 2828sub reload_treasures {
2696 }, 2900 },
2697 ); 2901 );
2698 } 2902 }
2699} 2903}
2700 2904
2905sub write_runtime {
2906 my $runtime = "$LOCALDIR/runtime";
2907
2908 # first touch the runtime file to show we are still running:
2909 # the fsync below can take a very very long time.
2910
2911 IO::AIO::aio_utime $runtime, undef, undef;
2912
2913 my $guard = cf::lock_acquire "write_runtime";
2914
2915 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2916 or return;
2917
2918 my $value = $cf::RUNTIME + 90 + 10;
2919 # 10 is the runtime save interval, for a monotonic clock
2920 # 60 allows for the watchdog to kill the server.
2921
2922 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2923 and return;
2924
2925 # always fsync - this file is important
2926 aio_fsync $fh
2927 and return;
2928
2929 # touch it again to show we are up-to-date
2930 aio_utime $fh, undef, undef;
2931
2932 close $fh
2933 or return;
2934
2935 aio_rename "$runtime~", $runtime
2936 and return;
2937
2938 warn "runtime file written.\n";
2939
2940 1
2941}
2942
2701sub emergency_save() { 2943sub emergency_save() {
2702 my $freeze_guard = cf::freeze_mainloop; 2944 my $freeze_guard = cf::freeze_mainloop;
2703 2945
2704 warn "enter emergency perl save\n"; 2946 warn "enter emergency perl save\n";
2705 2947
2780 %EXT_CORO = (); 3022 %EXT_CORO = ();
2781 3023
2782 warn "removing commands"; 3024 warn "removing commands";
2783 %COMMAND = (); 3025 %COMMAND = ();
2784 3026
2785 warn "removing ext commands"; 3027 warn "removing ext/exti commands";
2786 %EXTCMD = (); 3028 %EXTCMD = ();
3029 %EXTICMD = ();
2787 3030
2788 warn "unloading/nuking all extensions"; 3031 warn "unloading/nuking all extensions";
2789 for my $pkg (@EXTS) { 3032 for my $pkg (@EXTS) {
2790 warn "... unloading $pkg"; 3033 warn "... unloading $pkg";
2791 3034

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines