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.275 by root, Thu Jun 7 19:12:22 2007 UTC vs.
Revision 1.290 by root, Mon Jul 2 03:15:30 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<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
1406
1407 # create single paragraphs (very hackish)
1408 s/(?<=\S)\n(?=\w)/ /g;
1409
1410 $_
1411}
1412
1190=item $player->ext_reply ($msgid, %msg) 1413=item $player->ext_reply ($msgid, %msg)
1191 1414
1192Sends an ext reply to the player. 1415Sends an ext reply to the player.
1193 1416
1194=cut 1417=cut
1195 1418
1196sub ext_reply($$%) { 1419sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1420 my ($self, $id, %msg) = @_;
1198 1421
1199 $msg{msgid} = $id; 1422 $msg{msgid} = $id;
1200 1423 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1424}
1203 1425
1204=item $player->ext_event ($type, %msg) 1426=item $player->ext_event ($type, %msg)
1205 1427
1206Sends an ext event to the client. 1428Sends an ext event to the client.
1221 1443
1222package cf::region; 1444package cf::region;
1223 1445
1224=item cf::region::find_by_path $path 1446=item cf::region::find_by_path $path
1225 1447
1226Tries to decuce the probable region for a map knowing only its path. 1448Tries to decuce the likely region for a map knowing only its path.
1227 1449
1228=cut 1450=cut
1229 1451
1230sub find_by_path($) { 1452sub find_by_path($) {
1231 my ($path) = @_; 1453 my ($path) = @_;
1776 $cf::MAP{$self->path} = $self; 1998 $cf::MAP{$self->path} = $self;
1777 1999
1778 $self->reset; # polite request, might not happen 2000 $self->reset; # polite request, might not happen
1779} 2001}
1780 2002
2003=item $maps = cf::map::tmp_maps
2004
2005Returns an arrayref with all map paths of currently instantiated and saved
2006maps. May block.
2007
2008=cut
2009
2010sub tmp_maps() {
2011 [
2012 map {
2013 utf8::decode $_;
2014 /\.map$/
2015 ? normalise $_
2016 : ()
2017 } @{ aio_readdir $TMPDIR or [] }
2018 ]
2019}
2020
2021=item $maps = cf::map::random_maps
2022
2023Returns an arrayref with all map paths of currently instantiated and saved
2024random maps. May block.
2025
2026=cut
2027
2028sub random_maps() {
2029 [
2030 map {
2031 utf8::decode $_;
2032 /\.map$/
2033 ? normalise "?random/$_"
2034 : ()
2035 } @{ aio_readdir $RANDOMDIR or [] }
2036 ]
2037}
2038
1781=item cf::map::unique_maps 2039=item cf::map::unique_maps
1782 2040
1783Returns an arrayref of paths of all shared maps that have 2041Returns an arrayref of paths of all shared maps that have
1784instantiated unique items. May block. 2042instantiated unique items. May block.
1785 2043
1786=cut 2044=cut
1787 2045
1788sub unique_maps() { 2046sub unique_maps() {
1789 my $files = aio_readdir $UNIQUEDIR 2047 [
1790 or return; 2048 map {
1791
1792 my @paths;
1793
1794 for (@$files) {
1795 utf8::decode $_; 2049 utf8::decode $_;
1796 next if /\.pst$/; 2050 /\.map$/
1797 next unless /^$PATH_SEP/o; 2051 ? normalise $_
1798 2052 : ()
1799 push @paths, cf::map::normalise $_; 2053 } @{ aio_readdir $UNIQUEDIR or [] }
1800 } 2054 ]
1801
1802 \@paths
1803} 2055}
1804 2056
1805package cf; 2057package cf;
1806 2058
1807=back 2059=back
1853 2105
1854 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2106 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1855 2107
1856 if ($self->{record_replies}) { 2108 if ($self->{record_replies}) {
1857 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2109 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2110
1858 } else { 2111 } else {
2112 my $pl = $self->contr;
2113
2114 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2115 my $diag = $pl->{npc_dialog};
2116 $diag->{pl}->ext_reply (
2117 $diag->{id},
2118 msgtype => "reply",
2119 msg => $diag->{pl}->expand_cfpod ($msg),
2120 add_topics => []
2121 );
2122
2123 } else {
1859 $msg = $npc->name . " says: $msg" if $npc; 2124 $msg = $npc->name . " says: $msg" if $npc;
1860 $self->message ($msg, $flags); 2125 $self->message ($msg, $flags);
2126 }
1861 } 2127 }
1862} 2128}
1863 2129
1864=item $player_object->may ("access") 2130=item $player_object->may ("access")
1865 2131
2110 2376
2111 utf8::encode $text; 2377 utf8::encode $text;
2112 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2378 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2113} 2379}
2114 2380
2381=item $client->send_msg ($color, $type, $msg, [extra...])
2382
2383Send a drawinfo or msg packet to the client, formatting the msg for the
2384client if neccessary. C<$type> should be a string identifying the type of
2385the message, with C<log> being the default. If C<$color> is negative, suppress
2386the message unless the client supports the msg packet.
2387
2388=cut
2389
2390sub cf::client::send_msg {
2391 my ($self, $color, $type, $msg, @extra) = @_;
2392
2393 $msg = $self->pl->expand_cfpod ($msg);
2394
2395 if ($self->can_msg) {
2396 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2397 } else {
2398 # replace some tags by gcfclient-compatible ones
2399 for ($msg) {
2400 1 while
2401 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2402 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2403 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2404 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2405 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2406 }
2407
2408 if ($color >= 0) {
2409 if (0 && $msg =~ /\[/) {
2410 $self->send_packet ("drawextinfo $color 4 0 $msg")
2411 } else {
2412 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2413 $self->send_packet ("drawinfo $color $msg")
2414 }
2415 }
2416 }
2417}
2418
2115=item $client->ext_event ($type, %msg) 2419=item $client->ext_event ($type, %msg)
2116 2420
2117Sends an exti event to the client. 2421Sends an ext event to the client.
2118 2422
2119=cut 2423=cut
2120 2424
2121sub cf::client::ext_event($$%) { 2425sub cf::client::ext_event($$%) {
2122 my ($self, $type, %msg) = @_; 2426 my ($self, $type, %msg) = @_;
2123 2427
2124 $msg{msgtype} = "event_$type"; 2428 $msg{msgtype} = "event_$type";
2125 $self->send_packet ("ext " . cf::to_json \%msg); 2429 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2126} 2430}
2127 2431
2128=item $success = $client->query ($flags, "text", \&cb) 2432=item $success = $client->query ($flags, "text", \&cb)
2129 2433
2130Queues a query to the client, calling the given callback with 2434Queues a query to the client, calling the given callback with
2131the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2435the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2132C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2436C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2133 2437
2134Queries can fail, so check the return code. Or don't, as queries will become 2438Queries can fail, so check the return code. Or don't, as queries will
2135reliable at some point in the future. 2439become reliable at some point in the future.
2136 2440
2137=cut 2441=cut
2138 2442
2139sub cf::client::query { 2443sub cf::client::query {
2140 my ($self, $flags, $text, $cb) = @_; 2444 my ($self, $flags, $text, $cb) = @_;
2148 utf8::encode $text; 2452 utf8::encode $text;
2149 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2453 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2150 2454
2151 $self->send_packet ($self->{query_queue}[0][0]) 2455 $self->send_packet ($self->{query_queue}[0][0])
2152 if @{ $self->{query_queue} } == 1; 2456 if @{ $self->{query_queue} } == 1;
2457
2458 1
2153} 2459}
2154 2460
2155cf::client->attach ( 2461cf::client->attach (
2462 on_connect => sub {
2463 my ($ns) = @_;
2464
2465 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2466 },
2156 on_reply => sub { 2467 on_reply => sub {
2157 my ($ns, $msg) = @_; 2468 my ($ns, $msg) = @_;
2158 2469
2159 # this weird shuffling is so that direct followup queries 2470 # this weird shuffling is so that direct followup queries
2160 # get handled first 2471 # get handled first
2171 $ns->send_packet ($ns->{query_queue}[0][0]); 2482 $ns->send_packet ($ns->{query_queue}[0][0]);
2172 } else { 2483 } else {
2173 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2484 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2174 } 2485 }
2175 } 2486 }
2487 },
2488 on_exticmd => sub {
2489 my ($ns, $buf) = @_;
2490
2491 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2492
2493 if (ref $msg) {
2494 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2495 if (my %reply = $cb->($ns, $msg)) {
2496 $reply{msgid} = $msg->{msgid};
2497 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2498 }
2499 }
2500 } else {
2501 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2502 }
2503
2504 cf::override;
2176 }, 2505 },
2177); 2506);
2178 2507
2179=item $client->async (\&cb) 2508=item $client->async (\&cb)
2180 2509
2319=back 2648=back
2320 2649
2321=cut 2650=cut
2322 2651
2323############################################################################# 2652#############################################################################
2324
2325=head2 EXTENSION DATABASE SUPPORT
2326
2327Crossfire maintains a very simple database for extension use. It can
2328currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2329convert to/from binary).
2330
2331The parameter C<$family> should best start with the name of the extension
2332using it, it should be unique.
2333
2334=over 4
2335
2336=item $value = cf::db_get $family => $key
2337
2338Returns a single value from the database.
2339
2340=item cf::db_put $family => $key => $value
2341
2342Stores the given C<$value> in the family.
2343
2344=cut
2345
2346our $DB;
2347
2348sub db_init {
2349 unless ($DB) {
2350 $DB = BDB::db_create $DB_ENV;
2351
2352 cf::sync_job {
2353 eval {
2354 $DB->set_flags (BDB::CHKSUM);
2355
2356 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2357 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2358 cf::cleanup "db_open(db): $!" if $!;
2359 };
2360 cf::cleanup "db_open(db): $@" if $@;
2361 };
2362 }
2363}
2364
2365sub db_get($$) {
2366 my $key = "$_[0]/$_[1]";
2367
2368 cf::sync_job {
2369 BDB::db_get $DB, undef, $key, my $data;
2370
2371 $! ? ()
2372 : $data
2373 }
2374}
2375
2376sub db_put($$$) {
2377 BDB::dbreq_pri 4;
2378 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2379}
2380
2381=item cf::cache $id => [$paths...], $processversion => $process
2382
2383Generic caching function that returns the value of the resource $id,
2384caching and regenerating as required.
2385
2386This function can block.
2387
2388=cut
2389
2390sub cache {
2391 my ($id, $src, $processversion, $process) = @_;
2392
2393 my $meta =
2394 join "\x00",
2395 $processversion,
2396 map {
2397 aio_stat $_
2398 and Carp::croak "$_: $!";
2399
2400 ($_, (stat _)[7,9])
2401 } @$src;
2402
2403 my $dbmeta = db_get cache => "$id/meta";
2404 if ($dbmeta ne $meta) {
2405 # changed, we may need to process
2406
2407 my @data;
2408 my $md5;
2409
2410 for (0 .. $#$src) {
2411 0 <= aio_load $src->[$_], $data[$_]
2412 or Carp::croak "$src->[$_]: $!";
2413 }
2414
2415 # if processing is expensive, check
2416 # checksum first
2417 if (1) {
2418 $md5 =
2419 join "\x00",
2420 $processversion,
2421 map {
2422 Coro::cede;
2423 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2424 } 0.. $#$src;
2425
2426
2427 my $dbmd5 = db_get cache => "$id/md5";
2428 if ($dbmd5 eq $md5) {
2429 db_put cache => "$id/meta", $meta;
2430
2431 return db_get cache => "$id/data";
2432 }
2433 }
2434
2435 my $t1 = Time::HiRes::time;
2436 my $data = $process->(\@data);
2437 my $t2 = Time::HiRes::time;
2438
2439 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2440
2441 db_put cache => "$id/data", $data;
2442 db_put cache => "$id/md5" , $md5;
2443 db_put cache => "$id/meta", $meta;
2444
2445 return $data;
2446 }
2447
2448 db_get cache => "$id/data"
2449}
2450
2451=item fork_call { }, $args
2452
2453Executes the given code block with the given arguments in a seperate
2454process, returning the results. Everything must be serialisable with
2455Coro::Storable. May, of course, block. Note that the executed sub may
2456never block itself or use any form of Event handling.
2457
2458=cut
2459
2460sub fork_call(&@) {
2461 my ($cb, @args) = @_;
2462
2463# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2464# or die "socketpair: $!";
2465 pipe my $fh1, my $fh2
2466 or die "pipe: $!";
2467
2468 if (my $pid = fork) {
2469 close $fh2;
2470
2471 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2472 $res = Coro::Storable::thaw $res;
2473
2474 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2475
2476 die $$res unless "ARRAY" eq ref $res;
2477
2478 return wantarray ? @$res : $res->[-1];
2479 } else {
2480 reset_signals;
2481 local $SIG{__WARN__};
2482 local $SIG{__DIE__};
2483 eval {
2484 close $fh1;
2485
2486 my @res = eval { $cb->(@args) };
2487 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2488 };
2489
2490 warn $@ if $@;
2491 _exit 0;
2492 }
2493}
2494
2495#############################################################################
2496# the server's init and main functions 2653# the server's init and main functions
2497 2654
2498sub load_facedata($) { 2655sub load_facedata($) {
2499 my ($path) = @_; 2656 my ($path) = @_;
2500 2657
2556 load_facedata "$DATADIR/facedata" 2713 load_facedata "$DATADIR/facedata"
2557 or die "unable to load facedata\n"; 2714 or die "unable to load facedata\n";
2558} 2715}
2559 2716
2560sub reload_archetypes { 2717sub reload_archetypes {
2718 load_resource_file "$DATADIR/archetypes"
2719 or die "unable to load archetypes\n";
2720 #d# NEED to laod twice to resolve forward references
2721 # this really needs to be done in an extra post-pass
2722 # (which needs to be synchronous, so solve it differently)
2561 load_resource_file "$DATADIR/archetypes" 2723 load_resource_file "$DATADIR/archetypes"
2562 or die "unable to load archetypes\n"; 2724 or die "unable to load archetypes\n";
2563} 2725}
2564 2726
2565sub reload_treasures { 2727sub reload_treasures {
2637 }, 2799 },
2638 ); 2800 );
2639 } 2801 }
2640} 2802}
2641 2803
2804sub write_runtime {
2805 my $runtime = "$LOCALDIR/runtime";
2806
2807 # first touch the runtime file to show we are still running:
2808 # the fsync below can take a very very long time.
2809
2810 IO::AIO::aio_utime $runtime, undef, undef;
2811
2812 my $guard = cf::lock_acquire "write_runtime";
2813
2814 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2815 or return;
2816
2817 my $value = $cf::RUNTIME + 90 + 10;
2818 # 10 is the runtime save interval, for a monotonic clock
2819 # 60 allows for the watchdog to kill the server.
2820
2821 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2822 and return;
2823
2824 # always fsync - this file is important
2825 aio_fsync $fh
2826 and return;
2827
2828 # touch it again to show we are up-to-date
2829 aio_utime $fh, undef, undef;
2830
2831 close $fh
2832 or return;
2833
2834 aio_rename "$runtime~", $runtime
2835 and return;
2836
2837 warn "runtime file written.\n";
2838
2839 1
2840}
2841
2642sub emergency_save() { 2842sub emergency_save() {
2643 my $freeze_guard = cf::freeze_mainloop; 2843 my $freeze_guard = cf::freeze_mainloop;
2644 2844
2645 warn "enter emergency perl save\n"; 2845 warn "enter emergency perl save\n";
2646 2846
2721 %EXT_CORO = (); 2921 %EXT_CORO = ();
2722 2922
2723 warn "removing commands"; 2923 warn "removing commands";
2724 %COMMAND = (); 2924 %COMMAND = ();
2725 2925
2726 warn "removing ext commands"; 2926 warn "removing ext/exti commands";
2727 %EXTCMD = (); 2927 %EXTCMD = ();
2928 %EXTICMD = ();
2728 2929
2729 warn "unloading/nuking all extensions"; 2930 warn "unloading/nuking all extensions";
2730 for my $pkg (@EXTS) { 2931 for my $pkg (@EXTS) {
2731 warn "... unloading $pkg"; 2932 warn "... unloading $pkg";
2732 2933

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines