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.277 by root, Sun Jun 10 04:24:50 2007 UTC vs.
Revision 1.291 by root, Tue Jul 3 00:54:44 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);
943 1102
944 cf::override; 1103 cf::override;
945 }, 1104 },
946); 1105);
947 1106
948sub load_extension {
949 my ($path) = @_;
950
951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 my $base = $1;
953 my $pkg = $1;
954 $pkg =~ s/[^[:word:]]/_/g;
955 $pkg = "ext::$pkg";
956
957 warn "... loading '$path' into '$pkg'\n";
958
959 open my $fh, "<:utf8", $path
960 or die "$path: $!";
961
962 my $source =
963 "package $pkg; use strict; use utf8;\n"
964 . "#line 1 \"$path\"\n{\n"
965 . (do { local $/; <$fh> })
966 . "\n};\n1";
967
968 unless (eval $source) {
969 my $msg = $@ ? "$path: $@\n"
970 : "extension disabled.\n";
971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972 warn $@;
973 warn "mandatory extension failed to load, exiting.\n";
974 exit 1;
975 }
976 die $@;
977 }
978
979 push @EXTS, $pkg;
980}
981
982sub load_extensions { 1107sub load_extensions {
1108 cf::sync_job {
1109 my %todo;
1110
983 for my $ext (<$LIBDIR/*.ext>) { 1111 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1112 next unless -r $path;
985 eval { 1113
986 load_extension $ext; 1114 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1115 my $base = $1;
1116 my $pkg = $1;
1117 $pkg =~ s/[^[:word:]]/_/g;
1118 $pkg = "ext::$pkg";
1119
1120 open my $fh, "<:utf8", $path
1121 or die "$path: $!";
1122
1123 my $source = do { local $/; <$fh> };
1124
1125 my %ext = (
1126 path => $path,
1127 base => $base,
1128 pkg => $pkg,
1129 );
1130
1131 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1132 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1133
1134 $ext{source} =
1135 "package $pkg; use strict; use utf8;\n"
1136 . "#line 1 \"$path\"\n{\n"
1137 . $source
1138 . "\n};\n1";
1139
1140 $todo{$base} = \%ext;
1141 }
1142
1143 my %done;
1144 while (%todo) {
1145 my $progress;
1146
1147 while (my ($k, $v) = each %todo) {
1148 for (split /,\s*/, $v->{meta}{depends}) {
1149 goto skip
1150 unless exists $done{$_};
1151 }
1152
1153 warn "... loading '$k' into '$v->{pkg}'\n";
1154
1155 unless (eval $v->{source}) {
1156 my $msg = $@ ? "$v->{path}: $@\n"
1157 : "$v->{base}: extension inactive.\n";
1158
1159 if (exists $v->{meta}{mandatory}) {
1160 warn $msg;
1161 warn "mandatory extension failed to load, exiting.\n";
1162 exit 1;
1163 }
1164
1165 warn $msg;
1166 }
1167
1168 $done{$k} = delete $todo{$k};
1169 push @EXTS, $v->{pkg};
1170 $progress = 1;
987 1 1171 }
988 } or warn "$ext not loaded: $@"; 1172
1173 skip:
1174 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1175 unless $progress;
1176 }
989 } 1177 };
990} 1178}
991 1179
992############################################################################# 1180#############################################################################
1181
1182=back
993 1183
994=head2 CORE EXTENSIONS 1184=head2 CORE EXTENSIONS
995 1185
996Functions and methods that extend core crossfire objects. 1186Functions and methods that extend core crossfire objects.
997 1187
1185 } 1375 }
1186 1376
1187 \@paths 1377 \@paths
1188} 1378}
1189 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 $_
1420}
1421
1422sub hintmode {
1423 warn "hm<$_[0] $_[1]>\n";#d#
1424 $_[0]{hintmode} = $_[1] if @_ > 1;
1425 $_[0]{hintmode}
1426}
1427
1190=item $player->ext_reply ($msgid, %msg) 1428=item $player->ext_reply ($msgid, %msg)
1191 1429
1192Sends an ext reply to the player. 1430Sends an ext reply to the player.
1193 1431
1194=cut 1432=cut
1195 1433
1196sub ext_reply($$%) { 1434sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1435 my ($self, $id, %msg) = @_;
1198 1436
1199 $msg{msgid} = $id; 1437 $msg{msgid} = $id;
1200 1438 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1439}
1203 1440
1204=item $player->ext_event ($type, %msg) 1441=item $player->ext_event ($type, %msg)
1205 1442
1206Sends an ext event to the client. 1443Sends an ext event to the client.
1221 1458
1222package cf::region; 1459package cf::region;
1223 1460
1224=item cf::region::find_by_path $path 1461=item cf::region::find_by_path $path
1225 1462
1226Tries to decuce the probable region for a map knowing only its path. 1463Tries to decuce the likely region for a map knowing only its path.
1227 1464
1228=cut 1465=cut
1229 1466
1230sub find_by_path($) { 1467sub find_by_path($) {
1231 my ($path) = @_; 1468 my ($path) = @_;
1883 2120
1884 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2121 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1885 2122
1886 if ($self->{record_replies}) { 2123 if ($self->{record_replies}) {
1887 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2124 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2125
1888 } else { 2126 } else {
2127 my $pl = $self->contr;
2128
2129 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2130 my $diag = $pl->{npc_dialog};
2131 $diag->{pl}->ext_reply (
2132 $diag->{id},
2133 msgtype => "reply",
2134 msg => $diag->{pl}->expand_cfpod ($msg),
2135 add_topics => []
2136 );
2137
2138 } else {
1889 $msg = $npc->name . " says: $msg" if $npc; 2139 $msg = $npc->name . " says: $msg" if $npc;
1890 $self->message ($msg, $flags); 2140 $self->message ($msg, $flags);
2141 }
1891 } 2142 }
1892} 2143}
1893 2144
1894=item $player_object->may ("access") 2145=item $player_object->may ("access")
1895 2146
2140 2391
2141 utf8::encode $text; 2392 utf8::encode $text;
2142 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2393 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2143} 2394}
2144 2395
2396=item $client->send_msg ($color, $type, $msg, [extra...])
2397
2398Send a drawinfo or msg packet to the client, formatting the msg for the
2399client if neccessary. C<$type> should be a string identifying the type of
2400the message, with C<log> being the default. If C<$color> is negative, suppress
2401the message unless the client supports the msg packet.
2402
2403=cut
2404
2405sub cf::client::send_msg {
2406 my ($self, $color, $type, $msg, @extra) = @_;
2407
2408 $msg = $self->pl->expand_cfpod ($msg);
2409
2410 if ($self->can_msg) {
2411 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2412 } else {
2413 # replace some tags by gcfclient-compatible ones
2414 for ($msg) {
2415 1 while
2416 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2417 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2418 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2419 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2420 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2421 }
2422
2423 if ($color >= 0) {
2424 if (0 && $msg =~ /\[/) {
2425 $self->send_packet ("drawextinfo $color 4 0 $msg")
2426 } else {
2427 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2428 $self->send_packet ("drawinfo $color $msg")
2429 }
2430 }
2431 }
2432}
2433
2145=item $client->ext_event ($type, %msg) 2434=item $client->ext_event ($type, %msg)
2146 2435
2147Sends an exti event to the client. 2436Sends an ext event to the client.
2148 2437
2149=cut 2438=cut
2150 2439
2151sub cf::client::ext_event($$%) { 2440sub cf::client::ext_event($$%) {
2152 my ($self, $type, %msg) = @_; 2441 my ($self, $type, %msg) = @_;
2153 2442
2154 $msg{msgtype} = "event_$type"; 2443 $msg{msgtype} = "event_$type";
2155 $self->send_packet ("ext " . cf::to_json \%msg); 2444 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2156} 2445}
2157 2446
2158=item $success = $client->query ($flags, "text", \&cb) 2447=item $success = $client->query ($flags, "text", \&cb)
2159 2448
2160Queues a query to the client, calling the given callback with 2449Queues a query to the client, calling the given callback with
2161the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2450the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2162C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2451C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2163 2452
2164Queries can fail, so check the return code. Or don't, as queries will become 2453Queries can fail, so check the return code. Or don't, as queries will
2165reliable at some point in the future. 2454become reliable at some point in the future.
2166 2455
2167=cut 2456=cut
2168 2457
2169sub cf::client::query { 2458sub cf::client::query {
2170 my ($self, $flags, $text, $cb) = @_; 2459 my ($self, $flags, $text, $cb) = @_;
2178 utf8::encode $text; 2467 utf8::encode $text;
2179 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2468 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2180 2469
2181 $self->send_packet ($self->{query_queue}[0][0]) 2470 $self->send_packet ($self->{query_queue}[0][0])
2182 if @{ $self->{query_queue} } == 1; 2471 if @{ $self->{query_queue} } == 1;
2472
2473 1
2183} 2474}
2184 2475
2185cf::client->attach ( 2476cf::client->attach (
2477 on_connect => sub {
2478 my ($ns) = @_;
2479
2480 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2481 },
2186 on_reply => sub { 2482 on_reply => sub {
2187 my ($ns, $msg) = @_; 2483 my ($ns, $msg) = @_;
2188 2484
2189 # this weird shuffling is so that direct followup queries 2485 # this weird shuffling is so that direct followup queries
2190 # get handled first 2486 # get handled first
2201 $ns->send_packet ($ns->{query_queue}[0][0]); 2497 $ns->send_packet ($ns->{query_queue}[0][0]);
2202 } else { 2498 } else {
2203 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2499 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2204 } 2500 }
2205 } 2501 }
2502 },
2503 on_exticmd => sub {
2504 my ($ns, $buf) = @_;
2505
2506 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2507
2508 if (ref $msg) {
2509 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2510 if (my %reply = $cb->($ns, $msg)) {
2511 $reply{msgid} = $msg->{msgid};
2512 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2513 }
2514 }
2515 } else {
2516 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2517 }
2518
2519 cf::override;
2206 }, 2520 },
2207); 2521);
2208 2522
2209=item $client->async (\&cb) 2523=item $client->async (\&cb)
2210 2524
2349=back 2663=back
2350 2664
2351=cut 2665=cut
2352 2666
2353############################################################################# 2667#############################################################################
2354
2355=head2 EXTENSION DATABASE SUPPORT
2356
2357Crossfire maintains a very simple database for extension use. It can
2358currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2359convert to/from binary).
2360
2361The parameter C<$family> should best start with the name of the extension
2362using it, it should be unique.
2363
2364=over 4
2365
2366=item $value = cf::db_get $family => $key
2367
2368Returns a single value from the database.
2369
2370=item cf::db_put $family => $key => $value
2371
2372Stores the given C<$value> in the family.
2373
2374=cut
2375
2376our $DB;
2377
2378sub db_init {
2379 unless ($DB) {
2380 $DB = BDB::db_create $DB_ENV;
2381
2382 cf::sync_job {
2383 eval {
2384 $DB->set_flags (BDB::CHKSUM);
2385
2386 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2387 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2388 cf::cleanup "db_open(db): $!" if $!;
2389 };
2390 cf::cleanup "db_open(db): $@" if $@;
2391 };
2392 }
2393}
2394
2395sub db_get($$) {
2396 my $key = "$_[0]/$_[1]";
2397
2398 cf::sync_job {
2399 BDB::db_get $DB, undef, $key, my $data;
2400
2401 $! ? ()
2402 : $data
2403 }
2404}
2405
2406sub db_put($$$) {
2407 BDB::dbreq_pri 4;
2408 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2409}
2410
2411=item cf::cache $id => [$paths...], $processversion => $process
2412
2413Generic caching function that returns the value of the resource $id,
2414caching and regenerating as required.
2415
2416This function can block.
2417
2418=cut
2419
2420sub cache {
2421 my ($id, $src, $processversion, $process) = @_;
2422
2423 my $meta =
2424 join "\x00",
2425 $processversion,
2426 map {
2427 aio_stat $_
2428 and Carp::croak "$_: $!";
2429
2430 ($_, (stat _)[7,9])
2431 } @$src;
2432
2433 my $dbmeta = db_get cache => "$id/meta";
2434 if ($dbmeta ne $meta) {
2435 # changed, we may need to process
2436
2437 my @data;
2438 my $md5;
2439
2440 for (0 .. $#$src) {
2441 0 <= aio_load $src->[$_], $data[$_]
2442 or Carp::croak "$src->[$_]: $!";
2443 }
2444
2445 # if processing is expensive, check
2446 # checksum first
2447 if (1) {
2448 $md5 =
2449 join "\x00",
2450 $processversion,
2451 map {
2452 Coro::cede;
2453 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2454 } 0.. $#$src;
2455
2456
2457 my $dbmd5 = db_get cache => "$id/md5";
2458 if ($dbmd5 eq $md5) {
2459 db_put cache => "$id/meta", $meta;
2460
2461 return db_get cache => "$id/data";
2462 }
2463 }
2464
2465 my $t1 = Time::HiRes::time;
2466 my $data = $process->(\@data);
2467 my $t2 = Time::HiRes::time;
2468
2469 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2470
2471 db_put cache => "$id/data", $data;
2472 db_put cache => "$id/md5" , $md5;
2473 db_put cache => "$id/meta", $meta;
2474
2475 return $data;
2476 }
2477
2478 db_get cache => "$id/data"
2479}
2480
2481=item fork_call { }, $args
2482
2483Executes the given code block with the given arguments in a seperate
2484process, returning the results. Everything must be serialisable with
2485Coro::Storable. May, of course, block. Note that the executed sub may
2486never block itself or use any form of Event handling.
2487
2488=cut
2489
2490sub fork_call(&@) {
2491 my ($cb, @args) = @_;
2492
2493# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2494# or die "socketpair: $!";
2495 pipe my $fh1, my $fh2
2496 or die "pipe: $!";
2497
2498 if (my $pid = fork) {
2499 close $fh2;
2500
2501 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2502 $res = Coro::Storable::thaw $res;
2503
2504 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2505
2506 die $$res unless "ARRAY" eq ref $res;
2507
2508 return wantarray ? @$res : $res->[-1];
2509 } else {
2510 reset_signals;
2511 local $SIG{__WARN__};
2512 local $SIG{__DIE__};
2513 eval {
2514 close $fh1;
2515
2516 my @res = eval { $cb->(@args) };
2517 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2518 };
2519
2520 warn $@ if $@;
2521 _exit 0;
2522 }
2523}
2524
2525#############################################################################
2526# the server's init and main functions 2668# the server's init and main functions
2527 2669
2528sub load_facedata($) { 2670sub load_facedata($) {
2529 my ($path) = @_; 2671 my ($path) = @_;
2530 2672
2586 load_facedata "$DATADIR/facedata" 2728 load_facedata "$DATADIR/facedata"
2587 or die "unable to load facedata\n"; 2729 or die "unable to load facedata\n";
2588} 2730}
2589 2731
2590sub reload_archetypes { 2732sub reload_archetypes {
2733 load_resource_file "$DATADIR/archetypes"
2734 or die "unable to load archetypes\n";
2735 #d# NEED to laod twice to resolve forward references
2736 # this really needs to be done in an extra post-pass
2737 # (which needs to be synchronous, so solve it differently)
2591 load_resource_file "$DATADIR/archetypes" 2738 load_resource_file "$DATADIR/archetypes"
2592 or die "unable to load archetypes\n"; 2739 or die "unable to load archetypes\n";
2593} 2740}
2594 2741
2595sub reload_treasures { 2742sub reload_treasures {
2667 }, 2814 },
2668 ); 2815 );
2669 } 2816 }
2670} 2817}
2671 2818
2819sub write_runtime {
2820 my $runtime = "$LOCALDIR/runtime";
2821
2822 # first touch the runtime file to show we are still running:
2823 # the fsync below can take a very very long time.
2824
2825 IO::AIO::aio_utime $runtime, undef, undef;
2826
2827 my $guard = cf::lock_acquire "write_runtime";
2828
2829 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2830 or return;
2831
2832 my $value = $cf::RUNTIME + 90 + 10;
2833 # 10 is the runtime save interval, for a monotonic clock
2834 # 60 allows for the watchdog to kill the server.
2835
2836 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2837 and return;
2838
2839 # always fsync - this file is important
2840 aio_fsync $fh
2841 and return;
2842
2843 # touch it again to show we are up-to-date
2844 aio_utime $fh, undef, undef;
2845
2846 close $fh
2847 or return;
2848
2849 aio_rename "$runtime~", $runtime
2850 and return;
2851
2852 warn "runtime file written.\n";
2853
2854 1
2855}
2856
2672sub emergency_save() { 2857sub emergency_save() {
2673 my $freeze_guard = cf::freeze_mainloop; 2858 my $freeze_guard = cf::freeze_mainloop;
2674 2859
2675 warn "enter emergency perl save\n"; 2860 warn "enter emergency perl save\n";
2676 2861
2751 %EXT_CORO = (); 2936 %EXT_CORO = ();
2752 2937
2753 warn "removing commands"; 2938 warn "removing commands";
2754 %COMMAND = (); 2939 %COMMAND = ();
2755 2940
2756 warn "removing ext commands"; 2941 warn "removing ext/exti commands";
2757 %EXTCMD = (); 2942 %EXTCMD = ();
2943 %EXTICMD = ();
2758 2944
2759 warn "unloading/nuking all extensions"; 2945 warn "unloading/nuking all extensions";
2760 for my $pkg (@EXTS) { 2946 for my $pkg (@EXTS) {
2761 warn "... unloading $pkg"; 2947 warn "... unloading $pkg";
2762 2948

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines