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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.293 by root, Tue Jul 3 05:14:15 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 ();
49our %COMMAND = (); 50our %COMMAND = ();
50our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
51 52
52our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
56 58
57our $RELOAD; # number of reloads so far 59our $RELOAD; # number of reloads so far
58our @EVENT; 60our @EVENT;
206} 208}
207 209
208$Event::DIED = sub { 210$Event::DIED = sub {
209 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
210}; 212};
213
214#############################################################################
211 215
212=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
213 217
214=over 4 218=over 4
215 219
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 238 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 239 $d
236 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
237} 241}
238 242
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
242 244
243Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
244 246
245=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
246 248
247Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
250
251=cut
252
253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
254
255sub to_json ($) { $json_coder->encode ($_[0]) }
256sub from_json ($) { $json_coder->decode ($_[0]) }
248 257
249=item cf::lock_wait $string 258=item cf::lock_wait $string
250 259
251Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
252 261
318 327
319BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
320 329
321=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
322 331
323The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 333is 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. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
326 336
327If it must be done, put the blocking parts into C<sync_job>. This will run 337If 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 338the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 339server will be frozen during this time, so the block should either finish
330fast or be very important. 340fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
391 401
392 $coro 402 $coro
393} 403}
394 404
395sub write_runtime { 405=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 406
398 # first touch the runtime file to show we are still running: 407Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 408process, returning the results. Everything must be serialisable with
409Coro::Storable. May, of course, block. Note that the executed sub may
410never block itself or use any form of Event handling.
400 411
401 IO::AIO::aio_utime $runtime, undef, undef; 412=cut
402 413
403 my $guard = cf::lock_acquire "write_runtime"; 414sub fork_call(&@) {
415 my ($cb, @args) = @_;
404 416
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
406 or return; 418# or die "socketpair: $!";
419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
407 421
408 my $value = $cf::RUNTIME + 90 + 10; 422 if (my $pid = fork) {
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 423 close $fh2;
423 or return;
424 424
425 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
426 and return; 426 $res = Coro::Storable::thaw $res;
427 427
428 warn "runtime file written.\n"; 428 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
429 429
430 die $$res unless "ARRAY" eq ref $res;
431
432 return wantarray ? @$res : $res->[-1];
433 } else {
434 reset_signals;
435 local $SIG{__WARN__};
436 local $SIG{__DIE__};
437 eval {
438 close $fh1;
439
440 my @res = eval { $cb->(@args) };
441 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
442 };
443
444 warn $@ if $@;
445 _exit 0;
430 1 446 }
447}
448
449=item $value = cf::db_get $family => $key
450
451Returns a single value from the environment database.
452
453=item cf::db_put $family => $key => $value
454
455Stores the given C<$value> in the family. It can currently store binary
456data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
457
458=cut
459
460our $DB;
461
462sub db_init {
463 unless ($DB) {
464 $DB = BDB::db_create $DB_ENV;
465
466 cf::sync_job {
467 eval {
468 $DB->set_flags (BDB::CHKSUM);
469
470 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
471 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
472 cf::cleanup "db_open(db): $!" if $!;
473 };
474 cf::cleanup "db_open(db): $@" if $@;
475 };
476 }
477}
478
479sub db_get($$) {
480 my $key = "$_[0]/$_[1]";
481
482 cf::sync_job {
483 BDB::db_get $DB, undef, $key, my $data;
484
485 $! ? ()
486 : $data
487 }
488}
489
490sub db_put($$$) {
491 BDB::dbreq_pri 4;
492 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
493}
494
495=item cf::cache $id => [$paths...], $processversion => $process
496
497Generic caching function that returns the value of the resource $id,
498caching and regenerating as required.
499
500This function can block.
501
502=cut
503
504sub cache {
505 my ($id, $src, $processversion, $process) = @_;
506
507 my $meta =
508 join "\x00",
509 $processversion,
510 map {
511 aio_stat $_
512 and Carp::croak "$_: $!";
513
514 ($_, (stat _)[7,9])
515 } @$src;
516
517 my $dbmeta = db_get cache => "$id/meta";
518 if ($dbmeta ne $meta) {
519 # changed, we may need to process
520
521 my @data;
522 my $md5;
523
524 for (0 .. $#$src) {
525 0 <= aio_load $src->[$_], $data[$_]
526 or Carp::croak "$src->[$_]: $!";
527 }
528
529 # if processing is expensive, check
530 # checksum first
531 if (1) {
532 $md5 =
533 join "\x00",
534 $processversion,
535 map {
536 Coro::cede;
537 ($src->[$_], Digest::MD5::md5_hex $data[$_])
538 } 0.. $#$src;
539
540
541 my $dbmd5 = db_get cache => "$id/md5";
542 if ($dbmd5 eq $md5) {
543 db_put cache => "$id/meta", $meta;
544
545 return db_get cache => "$id/data";
546 }
547 }
548
549 my $t1 = Time::HiRes::time;
550 my $data = $process->(\@data);
551 my $t2 = Time::HiRes::time;
552
553 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
554
555 db_put cache => "$id/data", $data;
556 db_put cache => "$id/md5" , $md5;
557 db_put cache => "$id/meta", $meta;
558
559 return $data;
560 }
561
562 db_get cache => "$id/data"
431} 563}
432 564
433=item cf::datalog type => key => value, ... 565=item cf::datalog type => key => value, ...
434 566
435Log a datalog packet of the given type with the given key-value pairs. 567Log 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") 585attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 586to it. All such attachable objects support the following methods.
455 587
456In the following description, CLASS can be any of C<global>, C<object> 588In 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 589C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 590Crossfire TRT).
459 591
460=over 4 592=over 4
461 593
462=item $attachable->attach ($attachment, key => $value...) 594=item $attachable->attach ($attachment, key => $value...)
463 595
665 _attach $registry, $klass, @attach; 797 _attach $registry, $klass, @attach;
666 } 798 }
667 799
668 $obj->{$name} = \%arg; 800 $obj->{$name} = \%arg;
669 } else { 801 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 802 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 803 }
672 804
673 $obj->{_attachment}{$name} = undef; 805 $obj->{_attachment}{$name} = undef;
674} 806}
675 807
877 warn sprintf "loading %s (%d)\n", 1009 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1010 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1011 return ($data, $av);
880} 1012}
881 1013
1014=head2 COMMAND CALLBACKS
1015
1016=over 4
1017
1018=cut
1019
882############################################################################# 1020#############################################################################
883# command handling &c 1021# command handling &c
884 1022
885=item cf::register_command $name => \&callback($ob,$args); 1023=item cf::register_command $name => \&callback($ob,$args);
886 1024
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1036 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1037}
900 1038
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1039=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1040
903Register a callbackf ro execution when the client sends an extcmd packet. 1041Register a callback for execution when the client sends an (synchronous)
1042extcmd packet. Ext commands will be processed in the order they are
1043received by the server, like other user commands. The first argument is
1044the logged-in player. Ext commands can only be processed after a player
1045has logged in successfully.
904 1046
905If the callback returns something, it is sent back as if reply was being 1047If the callback returns something, it is sent back as if reply was being
906called. 1048called.
907 1049
1050=item cf::register_exticmd $name => \&callback($ns,$packet);
1051
1052Register a callback for execution when the client sends an (asynchronous)
1053exticmd packet. Exti commands are processed by the server as soon as they
1054are received, i.e. out of order w.r.t. other commands. The first argument
1055is a client socket. Exti commands can be received anytime, even before
1056log-in.
1057
1058If the callback returns something, it is sent back as if reply was being
1059called.
1060
908=cut 1061=cut
909 1062
910sub register_extcmd { 1063sub register_extcmd {
911 my ($name, $cb) = @_; 1064 my ($name, $cb) = @_;
912 1065
913 $EXTCMD{$name} = $cb; 1066 $EXTCMD{$name} = $cb;
1067}
1068
1069sub register_exticmd {
1070 my ($name, $cb) = @_;
1071
1072 $EXTICMD{$name} = $cb;
914} 1073}
915 1074
916cf::player->attach ( 1075cf::player->attach (
917 on_command => sub { 1076 on_command => sub {
918 my ($pl, $name, $params) = @_; 1077 my ($pl, $name, $params) = @_;
927 cf::override; 1086 cf::override;
928 }, 1087 },
929 on_extcmd => sub { 1088 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1089 my ($pl, $buf) = @_;
931 1090
932 my $msg = eval { from_json $buf }; 1091 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1092
934 if (ref $msg) { 1093 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1094 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1095 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1096 $pl->ext_reply ($msg->{msgid}, %reply);
967 path => $path, 1126 path => $path,
968 base => $base, 1127 base => $base,
969 pkg => $pkg, 1128 pkg => $pkg,
970 ); 1129 );
971 1130
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 } 1131 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/; 1132 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974 1133
975 $ext{source} = 1134 $ext{source} =
976 "package $pkg; use strict; use utf8;\n" 1135 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n" 1136 . "#line 1 \"$path\"\n{\n"
978 . $source 1137 . $source
984 my %done; 1143 my %done;
985 while (%todo) { 1144 while (%todo) {
986 my $progress; 1145 my $progress;
987 1146
988 while (my ($k, $v) = each %todo) { 1147 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) { 1148 for (split /,\s*/, $v->{meta}{depends}) {
990 goto skip 1149 goto skip
991 unless exists $done{$_}; 1150 unless exists $done{$_};
992 } 1151 }
993 1152
994 warn "... loading '$k' into '$v->{pkg}'\n"; 1153 warn "... loading '$k' into '$v->{pkg}'\n";
995 1154
996 unless (eval $v->{source}) { 1155 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n" 1156 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n"; 1157 : "$v->{base}: extension inactive.\n";
999 1158
1000 if (exists $v->{meta}{mandatory}) { 1159 if (exists $v->{meta}{mandatory}) {
1001 warn $msg; 1160 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n"; 1161 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1; 1162 exit 1;
1004 } 1163 }
1005 1164
1006 die $msg; 1165 warn $msg;
1007 } 1166 }
1008 1167
1009 $done{$k} = delete $todo{$k}; 1168 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg}; 1169 push @EXTS, $v->{pkg};
1170 $progress = 1;
1011 } 1171 }
1012 1172
1013 skip: 1173 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n" 1174 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress; 1175 unless $progress;
1016 } 1176 }
1017 }; 1177 };
1018} 1178}
1019 1179
1020############################################################################# 1180#############################################################################
1181
1182=back
1021 1183
1022=head2 CORE EXTENSIONS 1184=head2 CORE EXTENSIONS
1023 1185
1024Functions and methods that extend core crossfire objects. 1186Functions and methods that extend core crossfire objects.
1025 1187
1213 } 1375 }
1214 1376
1215 \@paths 1377 \@paths
1216} 1378}
1217 1379
1380=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1381
1382Expand crossfire pod fragments into protocol xml.
1383
1384=cut
1385
1386sub expand_cfpod {
1387 ((my $self), (local $_)) = @_;
1388
1389 # escape & and <
1390 s/&/&amp;/g;
1391 s/(?<![BIUGH])</&lt;/g;
1392
1393 # this is buggy, it needs to properly take care of nested <'s
1394
1395 1 while
1396 # replace B<>, I<>, U<> etc.
1397 s/B<([^\>]*)>/<b>$1<\/b>/
1398 || s/I<([^\>]*)>/<i>$1<\/i>/
1399 || s/U<([^\>]*)>/<u>$1<\/u>/
1400 # replace G<male|female> tags
1401 || s{G<([^>|]*)\|([^>]*)>}{
1402 $self->gender ? $2 : $1
1403 }ge
1404 # replace H<hint text>
1405 || s{H<([^\>]*)>}
1406 {
1407 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1408 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1409 "")
1410 [$self->{hintmode}]
1411 }ge;
1412
1413 # create single paragraphs (very hackish)
1414 s/(?<=\S)\n(?=\w)/ /g;
1415
1416 # compress some whitespace
1417 1 while s/\s*\n\s*\n\s*/\n/;
1418
1419 s/^\s+//;
1420 s/\s+$//;
1421
1422 $_
1423}
1424
1425sub hintmode {
1426 $_[0]{hintmode} = $_[1] if @_ > 1;
1427 $_[0]{hintmode}
1428}
1429
1218=item $player->ext_reply ($msgid, %msg) 1430=item $player->ext_reply ($msgid, %msg)
1219 1431
1220Sends an ext reply to the player. 1432Sends an ext reply to the player.
1221 1433
1222=cut 1434=cut
1223 1435
1224sub ext_reply($$%) { 1436sub ext_reply($$%) {
1225 my ($self, $id, %msg) = @_; 1437 my ($self, $id, %msg) = @_;
1226 1438
1227 $msg{msgid} = $id; 1439 $msg{msgid} = $id;
1228 1440 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1229 $self->send ("ext " . cf::to_json \%msg);
1230} 1441}
1231 1442
1232=item $player->ext_event ($type, %msg) 1443=item $player->ext_event ($type, %msg)
1233 1444
1234Sends an ext event to the client. 1445Sends an ext event to the client.
1249 1460
1250package cf::region; 1461package cf::region;
1251 1462
1252=item cf::region::find_by_path $path 1463=item cf::region::find_by_path $path
1253 1464
1254Tries to decuce the probable region for a map knowing only its path. 1465Tries to decuce the likely region for a map knowing only its path.
1255 1466
1256=cut 1467=cut
1257 1468
1258sub find_by_path($) { 1469sub find_by_path($) {
1259 my ($path) = @_; 1470 my ($path) = @_;
1911 2122
1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2123 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913 2124
1914 if ($self->{record_replies}) { 2125 if ($self->{record_replies}) {
1915 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2126 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2127
1916 } else { 2128 } else {
2129 my $pl = $self->contr;
2130
2131 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2132 my $diag = $pl->{npc_dialog};
2133 $diag->{pl}->ext_reply (
2134 $diag->{id},
2135 msgtype => "reply",
2136 msg => $diag->{pl}->expand_cfpod ($msg),
2137 add_topics => []
2138 );
2139
2140 } else {
1917 $msg = $npc->name . " says: $msg" if $npc; 2141 $msg = $npc->name . " says: $msg" if $npc;
1918 $self->message ($msg, $flags); 2142 $self->message ($msg, $flags);
2143 }
1919 } 2144 }
1920} 2145}
1921 2146
1922=item $player_object->may ("access") 2147=item $player_object->may ("access")
1923 2148
2168 2393
2169 utf8::encode $text; 2394 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2395 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171} 2396}
2172 2397
2398=item $client->send_msg ($color, $type, $msg, [extra...])
2399
2400Send a drawinfo or msg packet to the client, formatting the msg for the
2401client if neccessary. C<$type> should be a string identifying the type of
2402the message, with C<log> being the default. If C<$color> is negative, suppress
2403the message unless the client supports the msg packet.
2404
2405=cut
2406
2407sub cf::client::send_msg {
2408 my ($self, $color, $type, $msg, @extra) = @_;
2409
2410 $msg = $self->pl->expand_cfpod ($msg);
2411
2412 if ($self->can_msg) {
2413 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2414 } else {
2415 # replace some tags by gcfclient-compatible ones
2416 for ($msg) {
2417 1 while
2418 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2419 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2420 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2421 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2422 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2423 }
2424
2425 if ($color >= 0) {
2426 if (0 && $msg =~ /\[/) {
2427 $self->send_packet ("drawextinfo $color 4 0 $msg")
2428 } else {
2429 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2430 $self->send_packet ("drawinfo $color $msg")
2431 }
2432 }
2433 }
2434}
2435
2173=item $client->ext_event ($type, %msg) 2436=item $client->ext_event ($type, %msg)
2174 2437
2175Sends an exti event to the client. 2438Sends an ext event to the client.
2176 2439
2177=cut 2440=cut
2178 2441
2179sub cf::client::ext_event($$%) { 2442sub cf::client::ext_event($$%) {
2180 my ($self, $type, %msg) = @_; 2443 my ($self, $type, %msg) = @_;
2181 2444
2182 $msg{msgtype} = "event_$type"; 2445 $msg{msgtype} = "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg); 2446 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2184} 2447}
2185 2448
2186=item $success = $client->query ($flags, "text", \&cb) 2449=item $success = $client->query ($flags, "text", \&cb)
2187 2450
2188Queues a query to the client, calling the given callback with 2451Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2452the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2190C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2453C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191 2454
2192Queries can fail, so check the return code. Or don't, as queries will become 2455Queries can fail, so check the return code. Or don't, as queries will
2193reliable at some point in the future. 2456become reliable at some point in the future.
2194 2457
2195=cut 2458=cut
2196 2459
2197sub cf::client::query { 2460sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_; 2461 my ($self, $flags, $text, $cb) = @_;
2206 utf8::encode $text; 2469 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2470 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208 2471
2209 $self->send_packet ($self->{query_queue}[0][0]) 2472 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1; 2473 if @{ $self->{query_queue} } == 1;
2474
2475 1
2211} 2476}
2212 2477
2213cf::client->attach ( 2478cf::client->attach (
2479 on_connect => sub {
2480 my ($ns) = @_;
2481
2482 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2483 },
2214 on_reply => sub { 2484 on_reply => sub {
2215 my ($ns, $msg) = @_; 2485 my ($ns, $msg) = @_;
2216 2486
2217 # this weird shuffling is so that direct followup queries 2487 # this weird shuffling is so that direct followup queries
2218 # get handled first 2488 # get handled first
2229 $ns->send_packet ($ns->{query_queue}[0][0]); 2499 $ns->send_packet ($ns->{query_queue}[0][0]);
2230 } else { 2500 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2501 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 } 2502 }
2233 } 2503 }
2504 },
2505 on_exticmd => sub {
2506 my ($ns, $buf) = @_;
2507
2508 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2509
2510 if (ref $msg) {
2511 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2512 if (my %reply = $cb->($ns, $msg)) {
2513 $reply{msgid} = $msg->{msgid};
2514 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2515 }
2516 }
2517 } else {
2518 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2519 }
2520
2521 cf::override;
2234 }, 2522 },
2235); 2523);
2236 2524
2237=item $client->async (\&cb) 2525=item $client->async (\&cb)
2238 2526
2377=back 2665=back
2378 2666
2379=cut 2667=cut
2380 2668
2381############################################################################# 2669#############################################################################
2382
2383=head2 EXTENSION DATABASE SUPPORT
2384
2385Crossfire maintains a very simple database for extension use. It can
2386currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2387convert to/from binary).
2388
2389The parameter C<$family> should best start with the name of the extension
2390using it, it should be unique.
2391
2392=over 4
2393
2394=item $value = cf::db_get $family => $key
2395
2396Returns a single value from the database.
2397
2398=item cf::db_put $family => $key => $value
2399
2400Stores the given C<$value> in the family.
2401
2402=cut
2403
2404our $DB;
2405
2406sub db_init {
2407 unless ($DB) {
2408 $DB = BDB::db_create $DB_ENV;
2409
2410 cf::sync_job {
2411 eval {
2412 $DB->set_flags (BDB::CHKSUM);
2413
2414 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2415 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2416 cf::cleanup "db_open(db): $!" if $!;
2417 };
2418 cf::cleanup "db_open(db): $@" if $@;
2419 };
2420 }
2421}
2422
2423sub db_get($$) {
2424 my $key = "$_[0]/$_[1]";
2425
2426 cf::sync_job {
2427 BDB::db_get $DB, undef, $key, my $data;
2428
2429 $! ? ()
2430 : $data
2431 }
2432}
2433
2434sub db_put($$$) {
2435 BDB::dbreq_pri 4;
2436 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2437}
2438
2439=item cf::cache $id => [$paths...], $processversion => $process
2440
2441Generic caching function that returns the value of the resource $id,
2442caching and regenerating as required.
2443
2444This function can block.
2445
2446=cut
2447
2448sub cache {
2449 my ($id, $src, $processversion, $process) = @_;
2450
2451 my $meta =
2452 join "\x00",
2453 $processversion,
2454 map {
2455 aio_stat $_
2456 and Carp::croak "$_: $!";
2457
2458 ($_, (stat _)[7,9])
2459 } @$src;
2460
2461 my $dbmeta = db_get cache => "$id/meta";
2462 if ($dbmeta ne $meta) {
2463 # changed, we may need to process
2464
2465 my @data;
2466 my $md5;
2467
2468 for (0 .. $#$src) {
2469 0 <= aio_load $src->[$_], $data[$_]
2470 or Carp::croak "$src->[$_]: $!";
2471 }
2472
2473 # if processing is expensive, check
2474 # checksum first
2475 if (1) {
2476 $md5 =
2477 join "\x00",
2478 $processversion,
2479 map {
2480 Coro::cede;
2481 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2482 } 0.. $#$src;
2483
2484
2485 my $dbmd5 = db_get cache => "$id/md5";
2486 if ($dbmd5 eq $md5) {
2487 db_put cache => "$id/meta", $meta;
2488
2489 return db_get cache => "$id/data";
2490 }
2491 }
2492
2493 my $t1 = Time::HiRes::time;
2494 my $data = $process->(\@data);
2495 my $t2 = Time::HiRes::time;
2496
2497 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499 db_put cache => "$id/data", $data;
2500 db_put cache => "$id/md5" , $md5;
2501 db_put cache => "$id/meta", $meta;
2502
2503 return $data;
2504 }
2505
2506 db_get cache => "$id/data"
2507}
2508
2509=item fork_call { }, $args
2510
2511Executes the given code block with the given arguments in a seperate
2512process, returning the results. Everything must be serialisable with
2513Coro::Storable. May, of course, block. Note that the executed sub may
2514never block itself or use any form of Event handling.
2515
2516=cut
2517
2518sub fork_call(&@) {
2519 my ($cb, @args) = @_;
2520
2521# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522# or die "socketpair: $!";
2523 pipe my $fh1, my $fh2
2524 or die "pipe: $!";
2525
2526 if (my $pid = fork) {
2527 close $fh2;
2528
2529 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530 $res = Coro::Storable::thaw $res;
2531
2532 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534 die $$res unless "ARRAY" eq ref $res;
2535
2536 return wantarray ? @$res : $res->[-1];
2537 } else {
2538 reset_signals;
2539 local $SIG{__WARN__};
2540 local $SIG{__DIE__};
2541 eval {
2542 close $fh1;
2543
2544 my @res = eval { $cb->(@args) };
2545 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546 };
2547
2548 warn $@ if $@;
2549 _exit 0;
2550 }
2551}
2552
2553#############################################################################
2554# the server's init and main functions 2670# the server's init and main functions
2555 2671
2556sub load_facedata($) { 2672sub load_facedata($) {
2557 my ($path) = @_; 2673 my ($path) = @_;
2558 2674
2614 load_facedata "$DATADIR/facedata" 2730 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n"; 2731 or die "unable to load facedata\n";
2616} 2732}
2617 2733
2618sub reload_archetypes { 2734sub reload_archetypes {
2735 load_resource_file "$DATADIR/archetypes"
2736 or die "unable to load archetypes\n";
2737 #d# NEED to laod twice to resolve forward references
2738 # this really needs to be done in an extra post-pass
2739 # (which needs to be synchronous, so solve it differently)
2619 load_resource_file "$DATADIR/archetypes" 2740 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n"; 2741 or die "unable to load archetypes\n";
2621} 2742}
2622 2743
2623sub reload_treasures { 2744sub reload_treasures {
2695 }, 2816 },
2696 ); 2817 );
2697 } 2818 }
2698} 2819}
2699 2820
2821sub write_runtime {
2822 my $runtime = "$LOCALDIR/runtime";
2823
2824 # first touch the runtime file to show we are still running:
2825 # the fsync below can take a very very long time.
2826
2827 IO::AIO::aio_utime $runtime, undef, undef;
2828
2829 my $guard = cf::lock_acquire "write_runtime";
2830
2831 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2832 or return;
2833
2834 my $value = $cf::RUNTIME + 90 + 10;
2835 # 10 is the runtime save interval, for a monotonic clock
2836 # 60 allows for the watchdog to kill the server.
2837
2838 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2839 and return;
2840
2841 # always fsync - this file is important
2842 aio_fsync $fh
2843 and return;
2844
2845 # touch it again to show we are up-to-date
2846 aio_utime $fh, undef, undef;
2847
2848 close $fh
2849 or return;
2850
2851 aio_rename "$runtime~", $runtime
2852 and return;
2853
2854 warn "runtime file written.\n";
2855
2856 1
2857}
2858
2700sub emergency_save() { 2859sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop; 2860 my $freeze_guard = cf::freeze_mainloop;
2702 2861
2703 warn "enter emergency perl save\n"; 2862 warn "enter emergency perl save\n";
2704 2863
2779 %EXT_CORO = (); 2938 %EXT_CORO = ();
2780 2939
2781 warn "removing commands"; 2940 warn "removing commands";
2782 %COMMAND = (); 2941 %COMMAND = ();
2783 2942
2784 warn "removing ext commands"; 2943 warn "removing ext/exti commands";
2785 %EXTCMD = (); 2944 %EXTCMD = ();
2945 %EXTICMD = ();
2786 2946
2787 warn "unloading/nuking all extensions"; 2947 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) { 2948 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg"; 2949 warn "... unloading $pkg";
2790 2950

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines