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.304 by root, Wed Jul 11 16:55:18 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
30use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
31use Time::HiRes; 32use Time::HiRes;
32use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
33 35
34# configure various modules to our taste 36# configure various modules to our taste
35# 37#
36$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 51our %COMMAND = ();
50our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
51 53
52our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
56 59
57our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
58our @EVENT; 61our @EVENT;
206} 209}
207 210
208$Event::DIED = sub { 211$Event::DIED = sub {
209 warn "error in event callback: @_"; 212 warn "error in event callback: @_";
210}; 213};
214
215#############################################################################
211 216
212=head2 UTILITY FUNCTIONS 217=head2 UTILITY FUNCTIONS
213 218
214=over 4 219=over 4
215 220
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 239 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 240 $d
236 } || "[unable to dump $_[0]: '$@']"; 241 } || "[unable to dump $_[0]: '$@']";
237} 242}
238 243
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 244=item $ref = cf::from_json $json
242 245
243Converts a JSON string into the corresponding perl data structure. 246Converts a JSON string into the corresponding perl data structure.
244 247
245=item $json = cf::to_json $ref 248=item $json = cf::to_json $ref
246 249
247Converts a perl data structure into its JSON representation. 250Converts a perl data structure into its JSON representation.
251
252=cut
253
254our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
255
256sub to_json ($) { $json_coder->encode ($_[0]) }
257sub from_json ($) { $json_coder->decode ($_[0]) }
248 258
249=item cf::lock_wait $string 259=item cf::lock_wait $string
250 260
251Wait until the given lock is available. See cf::lock_acquire. 261Wait until the given lock is available. See cf::lock_acquire.
252 262
318 328
319BEGIN { *async = \&Coro::async_pool } 329BEGIN { *async = \&Coro::async_pool }
320 330
321=item cf::sync_job { BLOCK } 331=item cf::sync_job { BLOCK }
322 332
323The design of crossfire+ requires that the main coro ($Coro::main) is 333The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 334is 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. 335partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
336acceptable.
326 337
327If it must be done, put the blocking parts into C<sync_job>. This will run 338If 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 339the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 340server will be frozen during this time, so the block should either finish
330fast or be very important. 341fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 401 $EXT_CORO{$coro+0} = $coro;
391 402
392 $coro 403 $coro
393} 404}
394 405
395sub write_runtime { 406=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 407
398 # first touch the runtime file to show we are still running: 408Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 409process, returning the results. Everything must be serialisable with
410Coro::Storable. May, of course, block. Note that the executed sub may
411never block itself or use any form of Event handling.
400 412
401 IO::AIO::aio_utime $runtime, undef, undef; 413=cut
402 414
403 my $guard = cf::lock_acquire "write_runtime"; 415sub _store_scalar {
404 416 open my $fh, ">", \my $buf
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 417 or die "fork_call: cannot open fh-to-buf in child : $!";
406 or return; 418 Storable::store_fd $_[0], $fh;
407
408 my $value = $cf::RUNTIME + 90 + 10;
409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413 and return;
414
415 # always fsync - this file is important
416 aio_fsync $fh
417 and return;
418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
422 close $fh 419 close $fh;
423 or return;
424 420
425 aio_rename "$runtime~", $runtime 421 $buf
426 and return; 422}
427 423
428 warn "runtime file written.\n"; 424sub fork_call(&@) {
425 my ($cb, @args) = @_;
429 426
427# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
428# or die "socketpair: $!";
429 pipe my $fh1, my $fh2
430 or die "pipe: $!";
431
432 if (my $pid = fork) {
433 close $fh2;
434
435 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
436 warn "pst<$res>" unless $res =~ /^pst/;
437 $res = Coro::Storable::thaw $res;
438
439 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
440
441 Carp::confess $$res unless "ARRAY" eq ref $res;
442
443 return wantarray ? @$res : $res->[-1];
444 } else {
445 reset_signals;
446 local $SIG{__WARN__};
447 local $SIG{__DIE__};
448 # just in case, this hack effectively disables event
449 # in the child. cleaner and slower would be canceling all watchers,
450 # but this works for the time being.
451 local $Coro::idle;
452 $Coro::current->prio (Coro::PRIO_MAX);
453
454 eval {
455 close $fh1;
456
457 my @res = eval { $cb->(@args) };
458
459 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
460 close $fh2;
461 };
462
463 warn $@ if $@;
464 _exit 0;
430 1 465 }
466}
467
468=item $value = cf::db_get $family => $key
469
470Returns a single value from the environment database.
471
472=item cf::db_put $family => $key => $value
473
474Stores the given C<$value> in the family. It can currently store binary
475data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
476
477=cut
478
479our $DB;
480
481sub db_init {
482 unless ($DB) {
483 $DB = BDB::db_create $DB_ENV;
484
485 cf::sync_job {
486 eval {
487 $DB->set_flags (BDB::CHKSUM);
488
489 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
490 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
491 cf::cleanup "db_open(db): $!" if $!;
492 };
493 cf::cleanup "db_open(db): $@" if $@;
494 };
495 }
496}
497
498sub db_get($$) {
499 my $key = "$_[0]/$_[1]";
500
501 cf::sync_job {
502 BDB::db_get $DB, undef, $key, my $data;
503
504 $! ? ()
505 : $data
506 }
507}
508
509sub db_put($$$) {
510 BDB::dbreq_pri 4;
511 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
512}
513
514=item cf::cache $id => [$paths...], $processversion => $process
515
516Generic caching function that returns the value of the resource $id,
517caching and regenerating as required.
518
519This function can block.
520
521=cut
522
523sub cache {
524 my ($id, $src, $processversion, $process) = @_;
525
526 my $meta =
527 join "\x00",
528 $processversion,
529 map {
530 aio_stat $_
531 and Carp::croak "$_: $!";
532
533 ($_, (stat _)[7,9])
534 } @$src;
535
536 my $dbmeta = db_get cache => "$id/meta";
537 if ($dbmeta ne $meta) {
538 # changed, we may need to process
539
540 my @data;
541 my $md5;
542
543 for (0 .. $#$src) {
544 0 <= aio_load $src->[$_], $data[$_]
545 or Carp::croak "$src->[$_]: $!";
546 }
547
548 # if processing is expensive, check
549 # checksum first
550 if (1) {
551 $md5 =
552 join "\x00",
553 $processversion,
554 map {
555 Coro::cede;
556 ($src->[$_], Digest::MD5::md5_hex $data[$_])
557 } 0.. $#$src;
558
559
560 my $dbmd5 = db_get cache => "$id/md5";
561 if ($dbmd5 eq $md5) {
562 db_put cache => "$id/meta", $meta;
563
564 return db_get cache => "$id/data";
565 }
566 }
567
568 my $t1 = Time::HiRes::time;
569 my $data = $process->(\@data);
570 my $t2 = Time::HiRes::time;
571
572 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
573
574 db_put cache => "$id/data", $data;
575 db_put cache => "$id/md5" , $md5;
576 db_put cache => "$id/meta", $meta;
577
578 return $data;
579 }
580
581 db_get cache => "$id/data"
431} 582}
432 583
433=item cf::datalog type => key => value, ... 584=item cf::datalog type => key => value, ...
434 585
435Log a datalog packet of the given type with the given key-value pairs. 586Log 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") 604attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 605to it. All such attachable objects support the following methods.
455 606
456In the following description, CLASS can be any of C<global>, C<object> 607In 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 608C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 609Crossfire TRT).
459 610
460=over 4 611=over 4
461 612
462=item $attachable->attach ($attachment, key => $value...) 613=item $attachable->attach ($attachment, key => $value...)
463 614
665 _attach $registry, $klass, @attach; 816 _attach $registry, $klass, @attach;
666 } 817 }
667 818
668 $obj->{$name} = \%arg; 819 $obj->{$name} = \%arg;
669 } else { 820 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 821 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 822 }
672 823
673 $obj->{_attachment}{$name} = undef; 824 $obj->{_attachment}{$name} = undef;
674} 825}
675 826
877 warn sprintf "loading %s (%d)\n", 1028 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1029 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1030 return ($data, $av);
880} 1031}
881 1032
1033=head2 COMMAND CALLBACKS
1034
1035=over 4
1036
1037=cut
1038
882############################################################################# 1039#############################################################################
883# command handling &c 1040# command handling &c
884 1041
885=item cf::register_command $name => \&callback($ob,$args); 1042=item cf::register_command $name => \&callback($ob,$args);
886 1043
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1055 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1056}
900 1057
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1058=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1059
903Register a callbackf ro execution when the client sends an extcmd packet. 1060Register a callback for execution when the client sends an (synchronous)
1061extcmd packet. Ext commands will be processed in the order they are
1062received by the server, like other user commands. The first argument is
1063the logged-in player. Ext commands can only be processed after a player
1064has logged in successfully.
904 1065
905If the callback returns something, it is sent back as if reply was being 1066If the callback returns something, it is sent back as if reply was being
906called. 1067called.
907 1068
1069=item cf::register_exticmd $name => \&callback($ns,$packet);
1070
1071Register a callback for execution when the client sends an (asynchronous)
1072exticmd packet. Exti commands are processed by the server as soon as they
1073are received, i.e. out of order w.r.t. other commands. The first argument
1074is a client socket. Exti commands can be received anytime, even before
1075log-in.
1076
1077If the callback returns something, it is sent back as if reply was being
1078called.
1079
908=cut 1080=cut
909 1081
910sub register_extcmd { 1082sub register_extcmd {
911 my ($name, $cb) = @_; 1083 my ($name, $cb) = @_;
912 1084
913 $EXTCMD{$name} = $cb; 1085 $EXTCMD{$name} = $cb;
1086}
1087
1088sub register_exticmd {
1089 my ($name, $cb) = @_;
1090
1091 $EXTICMD{$name} = $cb;
914} 1092}
915 1093
916cf::player->attach ( 1094cf::player->attach (
917 on_command => sub { 1095 on_command => sub {
918 my ($pl, $name, $params) = @_; 1096 my ($pl, $name, $params) = @_;
927 cf::override; 1105 cf::override;
928 }, 1106 },
929 on_extcmd => sub { 1107 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1108 my ($pl, $buf) = @_;
931 1109
932 my $msg = eval { from_json $buf }; 1110 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1111
934 if (ref $msg) { 1112 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1113 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1114 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1115 $pl->ext_reply ($msg->{msgid}, %reply);
967 path => $path, 1145 path => $path,
968 base => $base, 1146 base => $base,
969 pkg => $pkg, 1147 pkg => $pkg,
970 ); 1148 );
971 1149
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 } 1150 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/; 1151 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974 1152
975 $ext{source} = 1153 $ext{source} =
976 "package $pkg; use strict; use utf8;\n" 1154 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n" 1155 . "#line 1 \"$path\"\n{\n"
978 . $source 1156 . $source
984 my %done; 1162 my %done;
985 while (%todo) { 1163 while (%todo) {
986 my $progress; 1164 my $progress;
987 1165
988 while (my ($k, $v) = each %todo) { 1166 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) { 1167 for (split /,\s*/, $v->{meta}{depends}) {
990 goto skip 1168 goto skip
991 unless exists $done{$_}; 1169 unless exists $done{$_};
992 } 1170 }
993 1171
994 warn "... loading '$k' into '$v->{pkg}'\n"; 1172 warn "... loading '$k' into '$v->{pkg}'\n";
995 1173
996 unless (eval $v->{source}) { 1174 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n" 1175 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n"; 1176 : "$v->{base}: extension inactive.\n";
999 1177
1000 if (exists $v->{meta}{mandatory}) { 1178 if (exists $v->{meta}{mandatory}) {
1001 warn $msg; 1179 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n"; 1180 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1; 1181 exit 1;
1004 } 1182 }
1005 1183
1006 die $msg; 1184 warn $msg;
1007 } 1185 }
1008 1186
1009 $done{$k} = delete $todo{$k}; 1187 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg}; 1188 push @EXTS, $v->{pkg};
1189 $progress = 1;
1011 } 1190 }
1012 1191
1013 skip: 1192 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n" 1193 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress; 1194 unless $progress;
1016 } 1195 }
1017 }; 1196 };
1018} 1197}
1019 1198
1020############################################################################# 1199#############################################################################
1200
1201=back
1021 1202
1022=head2 CORE EXTENSIONS 1203=head2 CORE EXTENSIONS
1023 1204
1024Functions and methods that extend core crossfire objects. 1205Functions and methods that extend core crossfire objects.
1025 1206
1213 } 1394 }
1214 1395
1215 \@paths 1396 \@paths
1216} 1397}
1217 1398
1399=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1400
1401Expand crossfire pod fragments into protocol xml.
1402
1403=cut
1404
1405sub expand_cfpod {
1406 ((my $self), (local $_)) = @_;
1407
1408 # escape & and <
1409 s/&/&amp;/g;
1410 s/(?<![BIUGH])</&lt;/g;
1411
1412 # this is buggy, it needs to properly take care of nested <'s
1413
1414 1 while
1415 # replace B<>, I<>, U<> etc.
1416 s/B<([^\>]*)>/<b>$1<\/b>/
1417 || s/I<([^\>]*)>/<i>$1<\/i>/
1418 || s/U<([^\>]*)>/<u>$1<\/u>/
1419 # replace G<male|female> tags
1420 || s{G<([^>|]*)\|([^>]*)>}{
1421 $self->gender ? $2 : $1
1422 }ge
1423 # replace H<hint text>
1424 || s{H<([^\>]*)>}
1425 {
1426 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1427 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1428 "")
1429 [$self->{hintmode}]
1430 }ge;
1431
1432 # create single paragraphs (very hackish)
1433 s/(?<=\S)\n(?=\w)/ /g;
1434
1435 # compress some whitespace
1436 s/\s+\n/\n/g; # ws line-ends
1437 s/\n\n+/\n/g; # double lines
1438 s/^\n+//; # beginning lines
1439 s/\n+$//; # ending lines
1440
1441 $_
1442}
1443
1444sub hintmode {
1445 $_[0]{hintmode} = $_[1] if @_ > 1;
1446 $_[0]{hintmode}
1447}
1448
1218=item $player->ext_reply ($msgid, %msg) 1449=item $player->ext_reply ($msgid, %msg)
1219 1450
1220Sends an ext reply to the player. 1451Sends an ext reply to the player.
1221 1452
1222=cut 1453=cut
1223 1454
1224sub ext_reply($$%) { 1455sub ext_reply($$%) {
1225 my ($self, $id, %msg) = @_; 1456 my ($self, $id, %msg) = @_;
1226 1457
1227 $msg{msgid} = $id; 1458 $msg{msgid} = $id;
1228 1459 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1229 $self->send ("ext " . cf::to_json \%msg);
1230} 1460}
1231 1461
1232=item $player->ext_event ($type, %msg) 1462=item $player->ext_event ($type, %msg)
1233 1463
1234Sends an ext event to the client. 1464Sends an ext event to the client.
1249 1479
1250package cf::region; 1480package cf::region;
1251 1481
1252=item cf::region::find_by_path $path 1482=item cf::region::find_by_path $path
1253 1483
1254Tries to decuce the probable region for a map knowing only its path. 1484Tries to decuce the likely region for a map knowing only its path.
1255 1485
1256=cut 1486=cut
1257 1487
1258sub find_by_path($) { 1488sub find_by_path($) {
1259 my ($path) = @_; 1489 my ($path) = @_;
1260 1490
1261 my ($match, $specificity); 1491 my ($match, $specificity);
1262 1492
1263 for my $region (list) { 1493 for my $region (list) {
1264 if ($region->match && $path =~ $region->match) { 1494 if ($region->{match} && $path =~ $region->{match}) {
1265 ($match, $specificity) = ($region, $region->specificity) 1495 ($match, $specificity) = ($region, $region->specificity)
1266 if $region->specificity > $specificity; 1496 if $region->specificity > $specificity;
1267 } 1497 }
1268 } 1498 }
1269 1499
1911 2141
1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2142 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913 2143
1914 if ($self->{record_replies}) { 2144 if ($self->{record_replies}) {
1915 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2145 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2146
1916 } else { 2147 } else {
2148 my $pl = $self->contr;
2149
2150 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2151 my $diag = $pl->{npc_dialog};
2152 $diag->{pl}->ext_reply (
2153 $diag->{id},
2154 msgtype => "reply",
2155 msg => $diag->{pl}->expand_cfpod ($msg),
2156 add_topics => []
2157 );
2158
2159 } else {
1917 $msg = $npc->name . " says: $msg" if $npc; 2160 $msg = $npc->name . " says: $msg" if $npc;
1918 $self->message ($msg, $flags); 2161 $self->message ($msg, $flags);
2162 }
1919 } 2163 }
1920} 2164}
1921 2165
1922=item $player_object->may ("access") 2166=item $player_object->may ("access")
1923 2167
2132 my $hp = $exit->stats->hp; 2376 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp; 2377 my $sp = $exit->stats->sp;
2134 2378
2135 $self->enter_link; 2379 $self->enter_link;
2136 2380
2381 # if exit is damned, update players death & WoR home-position
2382 $self->contr->savebed ($slaying, $hp, $sp)
2383 if $exit->flag (FLAG_DAMNED);
2384
2137 (async { 2385 (async {
2138 $self->deactivate_recursive; # just to be sure 2386 $self->deactivate_recursive; # just to be sure
2139 unless (eval { 2387 unless (eval {
2140 $self->goto ($slaying, $hp, $sp); 2388 $self->goto ($slaying, $hp, $sp);
2141 2389
2168 2416
2169 utf8::encode $text; 2417 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2418 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171} 2419}
2172 2420
2421=item $client->send_msg ($color, $type, $msg, [extra...])
2422
2423Send a drawinfo or msg packet to the client, formatting the msg for the
2424client if neccessary. C<$type> should be a string identifying the type of
2425the message, with C<log> being the default. If C<$color> is negative, suppress
2426the message unless the client supports the msg packet.
2427
2428=cut
2429
2430sub cf::client::send_msg {
2431 my ($self, $color, $type, $msg, @extra) = @_;
2432
2433 $msg = $self->pl->expand_cfpod ($msg);
2434
2435 return unless @extra || length $msg;
2436
2437 if ($self->can_msg) {
2438 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2439 } else {
2440 # replace some tags by gcfclient-compatible ones
2441 for ($msg) {
2442 1 while
2443 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2444 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2445 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2446 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2447 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2448 }
2449
2450 if ($color >= 0) {
2451 if (0 && $msg =~ /\[/) {
2452 $self->send_packet ("drawextinfo $color 4 0 $msg")
2453 } else {
2454 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2455 $self->send_packet ("drawinfo $color $msg")
2456 }
2457 }
2458 }
2459}
2460
2173=item $client->ext_event ($type, %msg) 2461=item $client->ext_event ($type, %msg)
2174 2462
2175Sends an exti event to the client. 2463Sends an ext event to the client.
2176 2464
2177=cut 2465=cut
2178 2466
2179sub cf::client::ext_event($$%) { 2467sub cf::client::ext_event($$%) {
2180 my ($self, $type, %msg) = @_; 2468 my ($self, $type, %msg) = @_;
2181 2469
2182 $msg{msgtype} = "event_$type"; 2470 $msg{msgtype} = "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg); 2471 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2184} 2472}
2185 2473
2186=item $success = $client->query ($flags, "text", \&cb) 2474=item $success = $client->query ($flags, "text", \&cb)
2187 2475
2188Queues a query to the client, calling the given callback with 2476Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2477the 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>. 2478C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191 2479
2192Queries can fail, so check the return code. Or don't, as queries will become 2480Queries can fail, so check the return code. Or don't, as queries will
2193reliable at some point in the future. 2481become reliable at some point in the future.
2194 2482
2195=cut 2483=cut
2196 2484
2197sub cf::client::query { 2485sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_; 2486 my ($self, $flags, $text, $cb) = @_;
2206 utf8::encode $text; 2494 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2495 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208 2496
2209 $self->send_packet ($self->{query_queue}[0][0]) 2497 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1; 2498 if @{ $self->{query_queue} } == 1;
2499
2500 1
2211} 2501}
2212 2502
2213cf::client->attach ( 2503cf::client->attach (
2504 on_connect => sub {
2505 my ($ns) = @_;
2506
2507 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2508 },
2214 on_reply => sub { 2509 on_reply => sub {
2215 my ($ns, $msg) = @_; 2510 my ($ns, $msg) = @_;
2216 2511
2217 # this weird shuffling is so that direct followup queries 2512 # this weird shuffling is so that direct followup queries
2218 # get handled first 2513 # get handled first
2230 } else { 2525 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2526 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 } 2527 }
2233 } 2528 }
2234 }, 2529 },
2530 on_exticmd => sub {
2531 my ($ns, $buf) = @_;
2532
2533 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2534
2535 if (ref $msg) {
2536 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2537 if (my %reply = $cb->($ns, $msg)) {
2538 $reply{msgid} = $msg->{msgid};
2539 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2540 }
2541 }
2542 } else {
2543 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2544 }
2545
2546 cf::override;
2547 },
2235); 2548);
2236 2549
2237=item $client->async (\&cb) 2550=item $client->async (\&cb)
2238 2551
2239Create a new coroutine, running the specified callback. The coroutine will 2552Create a new coroutine, running the specified callback. The coroutine will
2288 2601
2289=pod 2602=pod
2290 2603
2291The following functions and methods are available within a safe environment: 2604The following functions and methods are available within a safe environment:
2292 2605
2293 cf::object contr pay_amount pay_player map 2606 cf::object
2607 contr pay_amount pay_player map x y force_find force_add
2608 insert remove
2609
2294 cf::object::player player 2610 cf::object::player
2295 cf::player peaceful 2611 player
2296 cf::map trigger 2612
2613 cf::player
2614 peaceful
2615
2616 cf::map
2617 trigger
2297 2618
2298=cut 2619=cut
2299 2620
2300for ( 2621for (
2301 ["cf::object" => qw(contr pay_amount pay_player map)], 2622 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2623 insert remove)],
2302 ["cf::object::player" => qw(player)], 2624 ["cf::object::player" => qw(player)],
2303 ["cf::player" => qw(peaceful)], 2625 ["cf::player" => qw(peaceful)],
2304 ["cf::map" => qw(trigger)], 2626 ["cf::map" => qw(trigger)],
2305) { 2627) {
2306 no strict 'refs'; 2628 no strict 'refs';
2377=back 2699=back
2378 2700
2379=cut 2701=cut
2380 2702
2381############################################################################# 2703#############################################################################
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 2704# the server's init and main functions
2555 2705
2556sub load_facedata($) { 2706sub load_facedata($) {
2557 my ($path) = @_; 2707 my ($path) = @_;
2558 2708
2570 { 2720 {
2571 my $faces = $facedata->{faceinfo}; 2721 my $faces = $facedata->{faceinfo};
2572 2722
2573 while (my ($face, $info) = each %$faces) { 2723 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2724 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2725 cf::face::set_visibility $idx, $info->{visibility};
2726 cf::face::set_magicmap $idx, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2727 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2728 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2578 Coro::cede; 2729
2730 cf::cede_to_tick;
2579 } 2731 }
2580 2732
2581 while (my ($face, $info) = each %$faces) { 2733 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth}; 2734 next unless $info->{smooth};
2583 my $idx = cf::face::find $face 2735 my $idx = cf::face::find $face
2584 or next; 2736 or next;
2585 if (my $smooth = cf::face::find $info->{smooth}) { 2737 if (my $smooth = cf::face::find $info->{smooth}) {
2738 cf::face::set_smooth $idx, $smooth;
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2739 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587 } else { 2740 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2741 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 } 2742 }
2590 Coro::cede; 2743
2744 cf::cede_to_tick;
2591 } 2745 }
2592 } 2746 }
2593 2747
2594 { 2748 {
2595 my $anims = $facedata->{animinfo}; 2749 my $anims = $facedata->{animinfo};
2596 2750
2597 while (my ($anim, $info) = each %$anims) { 2751 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2752 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede; 2753 cf::cede_to_tick;
2600 } 2754 }
2601 2755
2602 cf::anim::invalidate_all; # d'oh 2756 cf::anim::invalidate_all; # d'oh
2757 }
2758
2759 {
2760 # TODO: for gcfclient pleasure, we should give resources
2761 # that gcfclient doesn't grok a >10000 face index.
2762 my $res = $facedata->{resource};
2763 my $enc = JSON::XS->new->utf8->canonical;
2764
2765 while (my ($name, $info) = each %$res) {
2766 my $meta = $enc->encode ({
2767 name => $name,
2768 type => $info->{type},
2769 copyright => $info->{copyright}, #TODO#
2770 });
2771 my $data = pack "(w/a*)*", $meta, $info->{data};
2772 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2773
2774 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2775 cf::face::set_type $idx, 1;
2776 cf::face::set_data $idx, 0, $data, $chk;
2777
2778 cf::cede_to_tick;
2779 }
2603 } 2780 }
2604 2781
2605 1 2782 1
2606} 2783}
2607 2784
2608sub reload_regions { 2785sub reload_regions {
2609 load_resource_file "$MAPDIR/regions" 2786 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n"; 2787 or die "unable to load regions file\n";
2788
2789 for (cf::region::list) {
2790 $_->{match} = qr/$_->{match}/
2791 if exists $_->{match};
2792 }
2611} 2793}
2612 2794
2613sub reload_facedata { 2795sub reload_facedata {
2614 load_facedata "$DATADIR/facedata" 2796 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n"; 2797 or die "unable to load facedata\n";
2616} 2798}
2617 2799
2618sub reload_archetypes { 2800sub reload_archetypes {
2801 load_resource_file "$DATADIR/archetypes"
2802 or die "unable to load archetypes\n";
2803 #d# NEED to laod twice to resolve forward references
2804 # this really needs to be done in an extra post-pass
2805 # (which needs to be synchronous, so solve it differently)
2619 load_resource_file "$DATADIR/archetypes" 2806 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n"; 2807 or die "unable to load archetypes\n";
2621} 2808}
2622 2809
2623sub reload_treasures { 2810sub reload_treasures {
2695 }, 2882 },
2696 ); 2883 );
2697 } 2884 }
2698} 2885}
2699 2886
2887sub write_runtime {
2888 my $runtime = "$LOCALDIR/runtime";
2889
2890 # first touch the runtime file to show we are still running:
2891 # the fsync below can take a very very long time.
2892
2893 IO::AIO::aio_utime $runtime, undef, undef;
2894
2895 my $guard = cf::lock_acquire "write_runtime";
2896
2897 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2898 or return;
2899
2900 my $value = $cf::RUNTIME + 90 + 10;
2901 # 10 is the runtime save interval, for a monotonic clock
2902 # 60 allows for the watchdog to kill the server.
2903
2904 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2905 and return;
2906
2907 # always fsync - this file is important
2908 aio_fsync $fh
2909 and return;
2910
2911 # touch it again to show we are up-to-date
2912 aio_utime $fh, undef, undef;
2913
2914 close $fh
2915 or return;
2916
2917 aio_rename "$runtime~", $runtime
2918 and return;
2919
2920 warn "runtime file written.\n";
2921
2922 1
2923}
2924
2700sub emergency_save() { 2925sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop; 2926 my $freeze_guard = cf::freeze_mainloop;
2702 2927
2703 warn "enter emergency perl save\n"; 2928 warn "enter emergency perl save\n";
2704 2929
2779 %EXT_CORO = (); 3004 %EXT_CORO = ();
2780 3005
2781 warn "removing commands"; 3006 warn "removing commands";
2782 %COMMAND = (); 3007 %COMMAND = ();
2783 3008
2784 warn "removing ext commands"; 3009 warn "removing ext/exti commands";
2785 %EXTCMD = (); 3010 %EXTCMD = ();
3011 %EXTICMD = ();
2786 3012
2787 warn "unloading/nuking all extensions"; 3013 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) { 3014 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg"; 3015 warn "... unloading $pkg";
2790 3016

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines