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.308 by root, Mon Jul 16 14:09:40 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);
943 1121
944 cf::override; 1122 cf::override;
945 }, 1123 },
946); 1124);
947 1125
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 { 1126sub load_extensions {
1127 cf::sync_job {
1128 my %todo;
1129
983 for my $ext (<$LIBDIR/*.ext>) { 1130 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1131 next unless -r $path;
985 eval { 1132
986 load_extension $ext; 1133 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1134 my $base = $1;
1135 my $pkg = $1;
1136 $pkg =~ s/[^[:word:]]/_/g;
1137 $pkg = "ext::$pkg";
1138
1139 open my $fh, "<:utf8", $path
1140 or die "$path: $!";
1141
1142 my $source = do { local $/; <$fh> };
1143
1144 my %ext = (
1145 path => $path,
1146 base => $base,
1147 pkg => $pkg,
1148 );
1149
1150 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1151 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1152
1153 $ext{source} =
1154 "package $pkg; use strict; use utf8;\n"
1155 . "#line 1 \"$path\"\n{\n"
1156 . $source
1157 . "\n};\n1";
1158
1159 $todo{$base} = \%ext;
1160 }
1161
1162 my %done;
1163 while (%todo) {
1164 my $progress;
1165
1166 while (my ($k, $v) = each %todo) {
1167 for (split /,\s*/, $v->{meta}{depends}) {
1168 goto skip
1169 unless exists $done{$_};
1170 }
1171
1172 warn "... loading '$k' into '$v->{pkg}'\n";
1173
1174 unless (eval $v->{source}) {
1175 my $msg = $@ ? "$v->{path}: $@\n"
1176 : "$v->{base}: extension inactive.\n";
1177
1178 if (exists $v->{meta}{mandatory}) {
1179 warn $msg;
1180 warn "mandatory extension failed to load, exiting.\n";
1181 exit 1;
1182 }
1183
1184 warn $msg;
1185 }
1186
1187 $done{$k} = delete $todo{$k};
1188 push @EXTS, $v->{pkg};
1189 $progress = 1;
987 1 1190 }
988 } or warn "$ext not loaded: $@"; 1191
1192 skip:
1193 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1194 unless $progress;
1195 }
989 } 1196 };
990} 1197}
991 1198
992############################################################################# 1199#############################################################################
1200
1201=back
993 1202
994=head2 CORE EXTENSIONS 1203=head2 CORE EXTENSIONS
995 1204
996Functions and methods that extend core crossfire objects. 1205Functions and methods that extend core crossfire objects.
997 1206
1185 } 1394 }
1186 1395
1187 \@paths 1396 \@paths
1188} 1397}
1189 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
1190=item $player->ext_reply ($msgid, %msg) 1449=item $player->ext_reply ($msgid, %msg)
1191 1450
1192Sends an ext reply to the player. 1451Sends an ext reply to the player.
1193 1452
1194=cut 1453=cut
1195 1454
1196sub ext_reply($$%) { 1455sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1456 my ($self, $id, %msg) = @_;
1198 1457
1199 $msg{msgid} = $id; 1458 $msg{msgid} = $id;
1200 1459 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1460}
1203 1461
1204=item $player->ext_event ($type, %msg) 1462=item $player->ext_event ($type, %msg)
1205 1463
1206Sends an ext event to the client. 1464Sends an ext event to the client.
1221 1479
1222package cf::region; 1480package cf::region;
1223 1481
1224=item cf::region::find_by_path $path 1482=item cf::region::find_by_path $path
1225 1483
1226Tries 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.
1227 1485
1228=cut 1486=cut
1229 1487
1230sub find_by_path($) { 1488sub find_by_path($) {
1231 my ($path) = @_; 1489 my ($path) = @_;
1232 1490
1233 my ($match, $specificity); 1491 my ($match, $specificity);
1234 1492
1235 for my $region (list) { 1493 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1494 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1495 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1496 if $region->specificity > $specificity;
1239 } 1497 }
1240 } 1498 }
1241 1499
1361 $self->init; # pass $1 etc. 1619 $self->init; # pass $1 etc.
1362 return $self; 1620 return $self;
1363 } 1621 }
1364 } 1622 }
1365 1623
1366 Carp::carp "unable to resolve path '$path' (base '$base')."; 1624 Carp::cluck "unable to resolve path '$path' (base '$base').";
1367 () 1625 ()
1368} 1626}
1369 1627
1370sub init { 1628sub init {
1371 my ($self) = @_; 1629 my ($self) = @_;
1649 1907
1650 undef $MAP_PREFETCH{$path}; 1908 undef $MAP_PREFETCH{$path};
1651 $MAP_PREFETCHER ||= cf::async { 1909 $MAP_PREFETCHER ||= cf::async {
1652 while (%MAP_PREFETCH) { 1910 while (%MAP_PREFETCH) {
1653 for my $path (keys %MAP_PREFETCH) { 1911 for my $path (keys %MAP_PREFETCH) {
1654 my $map = find $path 1912 if (my $map = find $path) {
1655 or next;
1656 $map->load; 1913 $map->load;
1914 }
1657 1915
1658 delete $MAP_PREFETCH{$path}; 1916 delete $MAP_PREFETCH{$path};
1659 } 1917 }
1660 } 1918 }
1661 undef $MAP_PREFETCHER; 1919 undef $MAP_PREFETCHER;
1883 2141
1884 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2142 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1885 2143
1886 if ($self->{record_replies}) { 2144 if ($self->{record_replies}) {
1887 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2145 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2146
1888 } 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 {
1889 $msg = $npc->name . " says: $msg" if $npc; 2160 $msg = $npc->name . " says: $msg" if $npc;
1890 $self->message ($msg, $flags); 2161 $self->message ($msg, $flags);
2162 }
1891 } 2163 }
1892} 2164}
1893 2165
1894=item $player_object->may ("access") 2166=item $player_object->may ("access")
1895 2167
1984 2256
1985 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2257 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1986 $self->enter_map ($map, $x, $y); 2258 $self->enter_map ($map, $x, $y);
1987} 2259}
1988 2260
1989=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2261=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1990 2262
1991Moves the player to the given map-path and coordinates by first freezing 2263Moves the player to the given map-path and coordinates by first freezing
1992her, loading and preparing them map, calling the provided $check callback 2264her, loading and preparing them map, calling the provided $check callback
1993that has to return the map if sucecssful, and then unfreezes the player on 2265that has to return the map if sucecssful, and then unfreezes the player on
1994the new (success) or old (failed) map position. 2266the new (success) or old (failed) map position. In either case, $done will
2267be called at the end of this process.
1995 2268
1996=cut 2269=cut
1997 2270
1998our $GOTOGEN; 2271our $GOTOGEN;
1999 2272
2000sub cf::object::player::goto { 2273sub cf::object::player::goto {
2001 my ($self, $path, $x, $y, $check) = @_; 2274 my ($self, $path, $x, $y, $check, $done) = @_;
2002 2275
2003 # do generation counting so two concurrent goto's will be executed in-order 2276 # do generation counting so two concurrent goto's will be executed in-order
2004 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2277 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2005 2278
2006 $self->enter_link; 2279 $self->enter_link;
2026 2299
2027 if ($gen == $self->{_goto_generation}) { 2300 if ($gen == $self->{_goto_generation}) {
2028 delete $self->{_goto_generation}; 2301 delete $self->{_goto_generation};
2029 $self->leave_link ($map, $x, $y); 2302 $self->leave_link ($map, $x, $y);
2030 } 2303 }
2304
2305 $done->() if $done;
2031 })->prio (1); 2306 })->prio (1);
2032} 2307}
2033 2308
2034=item $player_object->enter_exit ($exit_object) 2309=item $player_object->enter_exit ($exit_object)
2035 2310
2104 my $hp = $exit->stats->hp; 2379 my $hp = $exit->stats->hp;
2105 my $sp = $exit->stats->sp; 2380 my $sp = $exit->stats->sp;
2106 2381
2107 $self->enter_link; 2382 $self->enter_link;
2108 2383
2384 # if exit is damned, update players death & WoR home-position
2385 $self->contr->savebed ($slaying, $hp, $sp)
2386 if $exit->flag (FLAG_DAMNED);
2387
2109 (async { 2388 (async {
2110 $self->deactivate_recursive; # just to be sure 2389 $self->deactivate_recursive; # just to be sure
2111 unless (eval { 2390 unless (eval {
2112 $self->goto ($slaying, $hp, $sp); 2391 $self->goto ($slaying, $hp, $sp);
2113 2392
2140 2419
2141 utf8::encode $text; 2420 utf8::encode $text;
2142 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2421 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2143} 2422}
2144 2423
2424=item $client->send_msg ($color, $type, $msg, [extra...])
2425
2426Send a drawinfo or msg packet to the client, formatting the msg for the
2427client if neccessary. C<$type> should be a string identifying the type of
2428the message, with C<log> being the default. If C<$color> is negative, suppress
2429the message unless the client supports the msg packet.
2430
2431=cut
2432
2433sub cf::client::send_msg {
2434 my ($self, $color, $type, $msg, @extra) = @_;
2435
2436 $msg = $self->pl->expand_cfpod ($msg);
2437
2438 return unless @extra || length $msg;
2439
2440 if ($self->can_msg) {
2441 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2442 } else {
2443 # replace some tags by gcfclient-compatible ones
2444 for ($msg) {
2445 1 while
2446 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2447 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2448 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2449 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2450 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2451 }
2452
2453 if ($color >= 0) {
2454 if (0 && $msg =~ /\[/) {
2455 $self->send_packet ("drawextinfo $color 4 0 $msg")
2456 } else {
2457 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2458 $self->send_packet ("drawinfo $color $msg")
2459 }
2460 }
2461 }
2462}
2463
2145=item $client->ext_event ($type, %msg) 2464=item $client->ext_event ($type, %msg)
2146 2465
2147Sends an exti event to the client. 2466Sends an ext event to the client.
2148 2467
2149=cut 2468=cut
2150 2469
2151sub cf::client::ext_event($$%) { 2470sub cf::client::ext_event($$%) {
2152 my ($self, $type, %msg) = @_; 2471 my ($self, $type, %msg) = @_;
2153 2472
2473 return unless $self->extcmd;
2474
2154 $msg{msgtype} = "event_$type"; 2475 $msg{msgtype} = "event_$type";
2155 $self->send_packet ("ext " . cf::to_json \%msg); 2476 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2156} 2477}
2157 2478
2158=item $success = $client->query ($flags, "text", \&cb) 2479=item $success = $client->query ($flags, "text", \&cb)
2159 2480
2160Queues a query to the client, calling the given callback with 2481Queues a query to the client, calling the given callback with
2161the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2482the 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>. 2483C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2163 2484
2164Queries can fail, so check the return code. Or don't, as queries will become 2485Queries can fail, so check the return code. Or don't, as queries will
2165reliable at some point in the future. 2486become reliable at some point in the future.
2166 2487
2167=cut 2488=cut
2168 2489
2169sub cf::client::query { 2490sub cf::client::query {
2170 my ($self, $flags, $text, $cb) = @_; 2491 my ($self, $flags, $text, $cb) = @_;
2178 utf8::encode $text; 2499 utf8::encode $text;
2179 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2500 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2180 2501
2181 $self->send_packet ($self->{query_queue}[0][0]) 2502 $self->send_packet ($self->{query_queue}[0][0])
2182 if @{ $self->{query_queue} } == 1; 2503 if @{ $self->{query_queue} } == 1;
2504
2505 1
2183} 2506}
2184 2507
2185cf::client->attach ( 2508cf::client->attach (
2509 on_connect => sub {
2510 my ($ns) = @_;
2511
2512 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2513 },
2186 on_reply => sub { 2514 on_reply => sub {
2187 my ($ns, $msg) = @_; 2515 my ($ns, $msg) = @_;
2188 2516
2189 # this weird shuffling is so that direct followup queries 2517 # this weird shuffling is so that direct followup queries
2190 # get handled first 2518 # get handled first
2202 } else { 2530 } else {
2203 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2531 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2204 } 2532 }
2205 } 2533 }
2206 }, 2534 },
2535 on_exticmd => sub {
2536 my ($ns, $buf) = @_;
2537
2538 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2539
2540 if (ref $msg) {
2541 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2542 if (my %reply = $cb->($ns, $msg)) {
2543 $reply{msgid} = $msg->{msgid};
2544 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2545 }
2546 }
2547 } else {
2548 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2549 }
2550
2551 cf::override;
2552 },
2207); 2553);
2208 2554
2209=item $client->async (\&cb) 2555=item $client->async (\&cb)
2210 2556
2211Create a new coroutine, running the specified callback. The coroutine will 2557Create a new coroutine, running the specified callback. The coroutine will
2260 2606
2261=pod 2607=pod
2262 2608
2263The following functions and methods are available within a safe environment: 2609The following functions and methods are available within a safe environment:
2264 2610
2265 cf::object contr pay_amount pay_player map 2611 cf::object
2612 contr pay_amount pay_player map x y force_find force_add
2613 insert remove
2614
2266 cf::object::player player 2615 cf::object::player
2267 cf::player peaceful 2616 player
2268 cf::map trigger 2617
2618 cf::player
2619 peaceful
2620
2621 cf::map
2622 trigger
2269 2623
2270=cut 2624=cut
2271 2625
2272for ( 2626for (
2273 ["cf::object" => qw(contr pay_amount pay_player map)], 2627 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2628 insert remove)],
2274 ["cf::object::player" => qw(player)], 2629 ["cf::object::player" => qw(player)],
2275 ["cf::player" => qw(peaceful)], 2630 ["cf::player" => qw(peaceful)],
2276 ["cf::map" => qw(trigger)], 2631 ["cf::map" => qw(trigger)],
2277) { 2632) {
2278 no strict 'refs'; 2633 no strict 'refs';
2349=back 2704=back
2350 2705
2351=cut 2706=cut
2352 2707
2353############################################################################# 2708#############################################################################
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 2709# the server's init and main functions
2527 2710
2528sub load_facedata($) { 2711sub load_facedata($) {
2529 my ($path) = @_; 2712 my ($path) = @_;
2530 2713
2542 { 2725 {
2543 my $faces = $facedata->{faceinfo}; 2726 my $faces = $facedata->{faceinfo};
2544 2727
2545 while (my ($face, $info) = each %$faces) { 2728 while (my ($face, $info) = each %$faces) {
2546 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2729 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2547 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2730 cf::face::set_visibility $idx, $info->{visibility};
2731 cf::face::set_magicmap $idx, $info->{magicmap};
2548 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2732 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2549 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2733 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2550 Coro::cede; 2734
2735 cf::cede_to_tick;
2551 } 2736 }
2552 2737
2553 while (my ($face, $info) = each %$faces) { 2738 while (my ($face, $info) = each %$faces) {
2554 next unless $info->{smooth}; 2739 next unless $info->{smooth};
2555 my $idx = cf::face::find $face 2740 my $idx = cf::face::find $face
2556 or next; 2741 or next;
2557 if (my $smooth = cf::face::find $info->{smooth}) { 2742 if (my $smooth = cf::face::find $info->{smooth}) {
2743 cf::face::set_smooth $idx, $smooth;
2558 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2744 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2559 } else { 2745 } else {
2560 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2746 warn "smooth face '$info->{smooth}' not found for face '$face'";
2561 } 2747 }
2562 Coro::cede; 2748
2749 cf::cede_to_tick;
2563 } 2750 }
2564 } 2751 }
2565 2752
2566 { 2753 {
2567 my $anims = $facedata->{animinfo}; 2754 my $anims = $facedata->{animinfo};
2568 2755
2569 while (my ($anim, $info) = each %$anims) { 2756 while (my ($anim, $info) = each %$anims) {
2570 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2757 cf::anim::set $anim, $info->{frames}, $info->{facings};
2571 Coro::cede; 2758 cf::cede_to_tick;
2572 } 2759 }
2573 2760
2574 cf::anim::invalidate_all; # d'oh 2761 cf::anim::invalidate_all; # d'oh
2762 }
2763
2764 {
2765 # TODO: for gcfclient pleasure, we should give resources
2766 # that gcfclient doesn't grok a >10000 face index.
2767 my $res = $facedata->{resource};
2768 my $enc = JSON::XS->new->utf8->canonical;
2769
2770 while (my ($name, $info) = each %$res) {
2771 my $meta = $enc->encode ({
2772 name => $name,
2773 type => $info->{type},
2774 copyright => $info->{copyright}, #TODO#
2775 });
2776
2777 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2778
2779 if ($name =~ /\.jpg$/) {
2780 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2781 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2782 } else {
2783 my $data = pack "(w/a*)*", $meta, $info->{data};
2784 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2785
2786 cf::face::set_type $idx, 1;
2787 cf::face::set_data $idx, 0, $data, $chk;
2788 }
2789
2790 cf::cede_to_tick;
2791 }
2575 } 2792 }
2576 2793
2577 1 2794 1
2578} 2795}
2579 2796
2580sub reload_regions { 2797sub reload_regions {
2581 load_resource_file "$MAPDIR/regions" 2798 load_resource_file "$MAPDIR/regions"
2582 or die "unable to load regions file\n"; 2799 or die "unable to load regions file\n";
2800
2801 for (cf::region::list) {
2802 $_->{match} = qr/$_->{match}/
2803 if exists $_->{match};
2804 }
2583} 2805}
2584 2806
2585sub reload_facedata { 2807sub reload_facedata {
2586 load_facedata "$DATADIR/facedata" 2808 load_facedata "$DATADIR/facedata"
2587 or die "unable to load facedata\n"; 2809 or die "unable to load facedata\n";
2588} 2810}
2589 2811
2590sub reload_archetypes { 2812sub reload_archetypes {
2813 load_resource_file "$DATADIR/archetypes"
2814 or die "unable to load archetypes\n";
2815 #d# NEED to laod twice to resolve forward references
2816 # this really needs to be done in an extra post-pass
2817 # (which needs to be synchronous, so solve it differently)
2591 load_resource_file "$DATADIR/archetypes" 2818 load_resource_file "$DATADIR/archetypes"
2592 or die "unable to load archetypes\n"; 2819 or die "unable to load archetypes\n";
2593} 2820}
2594 2821
2595sub reload_treasures { 2822sub reload_treasures {
2667 }, 2894 },
2668 ); 2895 );
2669 } 2896 }
2670} 2897}
2671 2898
2899sub write_runtime {
2900 my $runtime = "$LOCALDIR/runtime";
2901
2902 # first touch the runtime file to show we are still running:
2903 # the fsync below can take a very very long time.
2904
2905 IO::AIO::aio_utime $runtime, undef, undef;
2906
2907 my $guard = cf::lock_acquire "write_runtime";
2908
2909 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2910 or return;
2911
2912 my $value = $cf::RUNTIME + 90 + 10;
2913 # 10 is the runtime save interval, for a monotonic clock
2914 # 60 allows for the watchdog to kill the server.
2915
2916 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2917 and return;
2918
2919 # always fsync - this file is important
2920 aio_fsync $fh
2921 and return;
2922
2923 # touch it again to show we are up-to-date
2924 aio_utime $fh, undef, undef;
2925
2926 close $fh
2927 or return;
2928
2929 aio_rename "$runtime~", $runtime
2930 and return;
2931
2932 warn "runtime file written.\n";
2933
2934 1
2935}
2936
2672sub emergency_save() { 2937sub emergency_save() {
2673 my $freeze_guard = cf::freeze_mainloop; 2938 my $freeze_guard = cf::freeze_mainloop;
2674 2939
2675 warn "enter emergency perl save\n"; 2940 warn "enter emergency perl save\n";
2676 2941
2751 %EXT_CORO = (); 3016 %EXT_CORO = ();
2752 3017
2753 warn "removing commands"; 3018 warn "removing commands";
2754 %COMMAND = (); 3019 %COMMAND = ();
2755 3020
2756 warn "removing ext commands"; 3021 warn "removing ext/exti commands";
2757 %EXTCMD = (); 3022 %EXTCMD = ();
3023 %EXTICMD = ();
2758 3024
2759 warn "unloading/nuking all extensions"; 3025 warn "unloading/nuking all extensions";
2760 for my $pkg (@EXTS) { 3026 for my $pkg (@EXTS) {
2761 warn "... unloading $pkg"; 3027 warn "... unloading $pkg";
2762 3028

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines