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.274 by root, Tue Jun 5 13:05:02 2007 UTC vs.
Revision 1.299 by root, Sun Jul 8 14:56:05 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 _store_scalar {
404 415 open my $fh, ">", \my $buf
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 416 or die "fork_call: cannot open fh-to-buf in child : $!";
406 or return; 417 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 418 close $fh;
423 or return;
424 419
425 aio_rename "$runtime~", $runtime 420 $buf
426 and return; 421}
427 422
428 warn "runtime file written.\n"; 423sub fork_call(&@) {
424 my ($cb, @args) = @_;
429 425
426# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
427# or die "socketpair: $!";
428 pipe my $fh1, my $fh2
429 or die "pipe: $!";
430
431 if (my $pid = fork) {
432 close $fh2;
433
434 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
435 warn "pst<$res>" unless $res =~ /^pst/;
436 $res = Coro::Storable::thaw $res;
437
438 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
439
440 Carp::confess $$res unless "ARRAY" eq ref $res;
441
442 return wantarray ? @$res : $res->[-1];
443 } else {
444 reset_signals;
445 local $SIG{__WARN__};
446 local $SIG{__DIE__};
447 # just in case, this hack effectively disables event
448 # in the child. cleaner and slower would be canceling all watchers,
449 # but this works for the time being.
450 local $Coro::idle;
451 $Coro::current->prio (Coro::PRIO_MAX);
452
453 eval {
454 close $fh1;
455
456 my @res = eval { $cb->(@args) };
457
458 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
459 close $fh2;
460 };
461
462 warn $@ if $@;
463 _exit 0;
430 1 464 }
465}
466
467=item $value = cf::db_get $family => $key
468
469Returns a single value from the environment database.
470
471=item cf::db_put $family => $key => $value
472
473Stores the given C<$value> in the family. It can currently store binary
474data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
475
476=cut
477
478our $DB;
479
480sub db_init {
481 unless ($DB) {
482 $DB = BDB::db_create $DB_ENV;
483
484 cf::sync_job {
485 eval {
486 $DB->set_flags (BDB::CHKSUM);
487
488 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
489 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
490 cf::cleanup "db_open(db): $!" if $!;
491 };
492 cf::cleanup "db_open(db): $@" if $@;
493 };
494 }
495}
496
497sub db_get($$) {
498 my $key = "$_[0]/$_[1]";
499
500 cf::sync_job {
501 BDB::db_get $DB, undef, $key, my $data;
502
503 $! ? ()
504 : $data
505 }
506}
507
508sub db_put($$$) {
509 BDB::dbreq_pri 4;
510 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
511}
512
513=item cf::cache $id => [$paths...], $processversion => $process
514
515Generic caching function that returns the value of the resource $id,
516caching and regenerating as required.
517
518This function can block.
519
520=cut
521
522sub cache {
523 my ($id, $src, $processversion, $process) = @_;
524
525 my $meta =
526 join "\x00",
527 $processversion,
528 map {
529 aio_stat $_
530 and Carp::croak "$_: $!";
531
532 ($_, (stat _)[7,9])
533 } @$src;
534
535 my $dbmeta = db_get cache => "$id/meta";
536 if ($dbmeta ne $meta) {
537 # changed, we may need to process
538
539 my @data;
540 my $md5;
541
542 for (0 .. $#$src) {
543 0 <= aio_load $src->[$_], $data[$_]
544 or Carp::croak "$src->[$_]: $!";
545 }
546
547 # if processing is expensive, check
548 # checksum first
549 if (1) {
550 $md5 =
551 join "\x00",
552 $processversion,
553 map {
554 Coro::cede;
555 ($src->[$_], Digest::MD5::md5_hex $data[$_])
556 } 0.. $#$src;
557
558
559 my $dbmd5 = db_get cache => "$id/md5";
560 if ($dbmd5 eq $md5) {
561 db_put cache => "$id/meta", $meta;
562
563 return db_get cache => "$id/data";
564 }
565 }
566
567 my $t1 = Time::HiRes::time;
568 my $data = $process->(\@data);
569 my $t2 = Time::HiRes::time;
570
571 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
572
573 db_put cache => "$id/data", $data;
574 db_put cache => "$id/md5" , $md5;
575 db_put cache => "$id/meta", $meta;
576
577 return $data;
578 }
579
580 db_get cache => "$id/data"
431} 581}
432 582
433=item cf::datalog type => key => value, ... 583=item cf::datalog type => key => value, ...
434 584
435Log a datalog packet of the given type with the given key-value pairs. 585Log 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") 603attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 604to it. All such attachable objects support the following methods.
455 605
456In the following description, CLASS can be any of C<global>, C<object> 606In 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 607C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 608Crossfire TRT).
459 609
460=over 4 610=over 4
461 611
462=item $attachable->attach ($attachment, key => $value...) 612=item $attachable->attach ($attachment, key => $value...)
463 613
665 _attach $registry, $klass, @attach; 815 _attach $registry, $klass, @attach;
666 } 816 }
667 817
668 $obj->{$name} = \%arg; 818 $obj->{$name} = \%arg;
669 } else { 819 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 820 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 821 }
672 822
673 $obj->{_attachment}{$name} = undef; 823 $obj->{_attachment}{$name} = undef;
674} 824}
675 825
877 warn sprintf "loading %s (%d)\n", 1027 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1028 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1029 return ($data, $av);
880} 1030}
881 1031
1032=head2 COMMAND CALLBACKS
1033
1034=over 4
1035
1036=cut
1037
882############################################################################# 1038#############################################################################
883# command handling &c 1039# command handling &c
884 1040
885=item cf::register_command $name => \&callback($ob,$args); 1041=item cf::register_command $name => \&callback($ob,$args);
886 1042
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1054 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1055}
900 1056
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1057=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1058
903Register a callbackf ro execution when the client sends an extcmd packet. 1059Register a callback for execution when the client sends an (synchronous)
1060extcmd packet. Ext commands will be processed in the order they are
1061received by the server, like other user commands. The first argument is
1062the logged-in player. Ext commands can only be processed after a player
1063has logged in successfully.
904 1064
905If the callback returns something, it is sent back as if reply was being 1065If the callback returns something, it is sent back as if reply was being
906called. 1066called.
907 1067
1068=item cf::register_exticmd $name => \&callback($ns,$packet);
1069
1070Register a callback for execution when the client sends an (asynchronous)
1071exticmd packet. Exti commands are processed by the server as soon as they
1072are received, i.e. out of order w.r.t. other commands. The first argument
1073is a client socket. Exti commands can be received anytime, even before
1074log-in.
1075
1076If the callback returns something, it is sent back as if reply was being
1077called.
1078
908=cut 1079=cut
909 1080
910sub register_extcmd { 1081sub register_extcmd {
911 my ($name, $cb) = @_; 1082 my ($name, $cb) = @_;
912 1083
913 $EXTCMD{$name} = $cb; 1084 $EXTCMD{$name} = $cb;
1085}
1086
1087sub register_exticmd {
1088 my ($name, $cb) = @_;
1089
1090 $EXTICMD{$name} = $cb;
914} 1091}
915 1092
916cf::player->attach ( 1093cf::player->attach (
917 on_command => sub { 1094 on_command => sub {
918 my ($pl, $name, $params) = @_; 1095 my ($pl, $name, $params) = @_;
927 cf::override; 1104 cf::override;
928 }, 1105 },
929 on_extcmd => sub { 1106 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1107 my ($pl, $buf) = @_;
931 1108
932 my $msg = eval { from_json $buf }; 1109 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1110
934 if (ref $msg) { 1111 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1112 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1113 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1114 $pl->ext_reply ($msg->{msgid}, %reply);
943 1120
944 cf::override; 1121 cf::override;
945 }, 1122 },
946); 1123);
947 1124
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 { 1125sub load_extensions {
1126 cf::sync_job {
1127 my %todo;
1128
983 for my $ext (<$LIBDIR/*.ext>) { 1129 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1130 next unless -r $path;
985 eval { 1131
986 load_extension $ext; 1132 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1133 my $base = $1;
1134 my $pkg = $1;
1135 $pkg =~ s/[^[:word:]]/_/g;
1136 $pkg = "ext::$pkg";
1137
1138 open my $fh, "<:utf8", $path
1139 or die "$path: $!";
1140
1141 my $source = do { local $/; <$fh> };
1142
1143 my %ext = (
1144 path => $path,
1145 base => $base,
1146 pkg => $pkg,
1147 );
1148
1149 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1150 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1151
1152 $ext{source} =
1153 "package $pkg; use strict; use utf8;\n"
1154 . "#line 1 \"$path\"\n{\n"
1155 . $source
1156 . "\n};\n1";
1157
1158 $todo{$base} = \%ext;
1159 }
1160
1161 my %done;
1162 while (%todo) {
1163 my $progress;
1164
1165 while (my ($k, $v) = each %todo) {
1166 for (split /,\s*/, $v->{meta}{depends}) {
1167 goto skip
1168 unless exists $done{$_};
1169 }
1170
1171 warn "... loading '$k' into '$v->{pkg}'\n";
1172
1173 unless (eval $v->{source}) {
1174 my $msg = $@ ? "$v->{path}: $@\n"
1175 : "$v->{base}: extension inactive.\n";
1176
1177 if (exists $v->{meta}{mandatory}) {
1178 warn $msg;
1179 warn "mandatory extension failed to load, exiting.\n";
1180 exit 1;
1181 }
1182
1183 warn $msg;
1184 }
1185
1186 $done{$k} = delete $todo{$k};
1187 push @EXTS, $v->{pkg};
1188 $progress = 1;
987 1 1189 }
988 } or warn "$ext not loaded: $@"; 1190
1191 skip:
1192 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1193 unless $progress;
1194 }
989 } 1195 };
990} 1196}
991 1197
992############################################################################# 1198#############################################################################
1199
1200=back
993 1201
994=head2 CORE EXTENSIONS 1202=head2 CORE EXTENSIONS
995 1203
996Functions and methods that extend core crossfire objects. 1204Functions and methods that extend core crossfire objects.
997 1205
1185 } 1393 }
1186 1394
1187 \@paths 1395 \@paths
1188} 1396}
1189 1397
1398=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1399
1400Expand crossfire pod fragments into protocol xml.
1401
1402=cut
1403
1404sub expand_cfpod {
1405 ((my $self), (local $_)) = @_;
1406
1407 # escape & and <
1408 s/&/&amp;/g;
1409 s/(?<![BIUGH])</&lt;/g;
1410
1411 # this is buggy, it needs to properly take care of nested <'s
1412
1413 1 while
1414 # replace B<>, I<>, U<> etc.
1415 s/B<([^\>]*)>/<b>$1<\/b>/
1416 || s/I<([^\>]*)>/<i>$1<\/i>/
1417 || s/U<([^\>]*)>/<u>$1<\/u>/
1418 # replace G<male|female> tags
1419 || s{G<([^>|]*)\|([^>]*)>}{
1420 $self->gender ? $2 : $1
1421 }ge
1422 # replace H<hint text>
1423 || s{H<([^\>]*)>}
1424 {
1425 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1426 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1427 "")
1428 [$self->{hintmode}]
1429 }ge;
1430
1431 # create single paragraphs (very hackish)
1432 s/(?<=\S)\n(?=\w)/ /g;
1433
1434 # compress some whitespace
1435 s/\s+\n/\n/g; # ws line-ends
1436 s/\n\n+/\n/g; # double lines
1437 s/^\n+//; # beginning lines
1438 s/\n+$//; # ending lines
1439
1440 $_
1441}
1442
1443sub hintmode {
1444 $_[0]{hintmode} = $_[1] if @_ > 1;
1445 $_[0]{hintmode}
1446}
1447
1190=item $player->ext_reply ($msgid, %msg) 1448=item $player->ext_reply ($msgid, %msg)
1191 1449
1192Sends an ext reply to the player. 1450Sends an ext reply to the player.
1193 1451
1194=cut 1452=cut
1195 1453
1196sub ext_reply($$%) { 1454sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1455 my ($self, $id, %msg) = @_;
1198 1456
1199 $msg{msgid} = $id; 1457 $msg{msgid} = $id;
1200 1458 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1459}
1203 1460
1204=item $player->ext_event ($type, %msg) 1461=item $player->ext_event ($type, %msg)
1205 1462
1206Sends an ext event to the client. 1463Sends an ext event to the client.
1221 1478
1222package cf::region; 1479package cf::region;
1223 1480
1224=item cf::region::find_by_path $path 1481=item cf::region::find_by_path $path
1225 1482
1226Tries to decuce the probable region for a map knowing only its path. 1483Tries to decuce the likely region for a map knowing only its path.
1227 1484
1228=cut 1485=cut
1229 1486
1230sub find_by_path($) { 1487sub find_by_path($) {
1231 my ($path) = @_; 1488 my ($path) = @_;
1305 my ($self, $merge) = @_; 1562 my ($self, $merge) = @_;
1306 1563
1307 # we have to keep some variables in memory intact 1564 # we have to keep some variables in memory intact
1308 local $self->{path}; 1565 local $self->{path};
1309 local $self->{load_path}; 1566 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1567
1313 $self->SUPER::thawer_merge ($merge); 1568 $self->SUPER::thawer_merge ($merge);
1314} 1569}
1315 1570
1316sub normalise { 1571sub normalise {
1416 1671
1417 $_->change_map_light ($change) 1672 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1673 for grep $_->outdoor, values %cf::MAP;
1419} 1674}
1420 1675
1676sub decay_objects {
1677 my ($self) = @_;
1678
1679 return if $self->{deny_reset};
1680
1681 $self->do_decay_objects;
1682}
1683
1421sub unlink_save { 1684sub unlink_save {
1422 my ($self) = @_; 1685 my ($self) = @_;
1423 1686
1424 utf8::encode (my $save = $self->save_path); 1687 utf8::encode (my $save = $self->save_path);
1425 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1688 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1481 $self->load_header_orig 1744 $self->load_header_orig
1482 or return; 1745 or return;
1483 $self->prepare_orig; 1746 $self->prepare_orig;
1484 } 1747 }
1485 1748
1749 $self->{deny_reset} = 1
1750 if $self->no_reset;
1751
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1752 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1753 unless $self->default_region;
1488 1754
1489 1 1755 1
1490} 1756}
1505 $map->{last_save} = $cf::RUNTIME; 1771 $map->{last_save} = $cf::RUNTIME;
1506 1772
1507 $map->load_header 1773 $map->load_header
1508 or return; 1774 or return;
1509 1775
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1776 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1777 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1778 #$cf::WAIT_FOR_TICK->wait;
1513 $map->reset; 1779 $map->reset;
1514 undef $guard; 1780 undef $guard;
1515 return find $path; 1781 return find $path;
1582 my ($self, $ob) = @_; 1848 my ($self, $ob) = @_;
1583 1849
1584 return find "~" . $ob->name . "/" . $self->{path} 1850 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1851 if $self->per_player;
1586 1852
1853# return find "?party/" . $ob->name . "/" . $self->{path}
1854# if $self->per_party;
1855
1587 $self 1856 $self
1588} 1857}
1589 1858
1590# find and load all maps in the 3x3 area around a map 1859# find and load all maps in the 3x3 area around a map
1591sub load_diag { 1860sub load_diag {
1701 1970
1702sub reset_at { 1971sub reset_at {
1703 my ($self) = @_; 1972 my ($self) = @_;
1704 1973
1705 # TODO: safety, remove and allow resettable per-player maps 1974 # TODO: safety, remove and allow resettable per-player maps
1706 return 1e99 if $self->isa ("ext::map_per_player");#d#
1707 return 1e99 if $self->{deny_reset}; 1975 return 1e99 if $self->{deny_reset};
1708 1976
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1977 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1978 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 1979
1722 my ($self) = @_; 1990 my ($self) = @_;
1723 1991
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1992 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 1993
1726 return if $self->players; 1994 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 1995
1729 warn "resetting map ", $self->path; 1996 warn "resetting map ", $self->path;
1730 1997
1731 $self->in_memory (cf::MAP_SWAPPED); 1998 $self->in_memory (cf::MAP_SWAPPED);
1732 1999
1766 $cf::MAP{$self->path} = $self; 2033 $cf::MAP{$self->path} = $self;
1767 2034
1768 $self->reset; # polite request, might not happen 2035 $self->reset; # polite request, might not happen
1769} 2036}
1770 2037
2038=item $maps = cf::map::tmp_maps
2039
2040Returns an arrayref with all map paths of currently instantiated and saved
2041maps. May block.
2042
2043=cut
2044
2045sub tmp_maps() {
2046 [
2047 map {
2048 utf8::decode $_;
2049 /\.map$/
2050 ? normalise $_
2051 : ()
2052 } @{ aio_readdir $TMPDIR or [] }
2053 ]
2054}
2055
2056=item $maps = cf::map::random_maps
2057
2058Returns an arrayref with all map paths of currently instantiated and saved
2059random maps. May block.
2060
2061=cut
2062
2063sub random_maps() {
2064 [
2065 map {
2066 utf8::decode $_;
2067 /\.map$/
2068 ? normalise "?random/$_"
2069 : ()
2070 } @{ aio_readdir $RANDOMDIR or [] }
2071 ]
2072}
2073
1771=item cf::map::unique_maps 2074=item cf::map::unique_maps
1772 2075
1773Returns an arrayref of paths of all shared maps that have 2076Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2077instantiated unique items. May block.
1775 2078
1776=cut 2079=cut
1777 2080
1778sub unique_maps() { 2081sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2082 [
1780 or return; 2083 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2084 utf8::decode $_;
1786 next if /\.pst$/; 2085 /\.map$/
1787 next unless /^$PATH_SEP/o; 2086 ? normalise $_
1788 2087 : ()
1789 push @paths, cf::map::normalise $_; 2088 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2089 ]
1791
1792 \@paths
1793} 2090}
1794 2091
1795package cf; 2092package cf;
1796 2093
1797=back 2094=back
1843 2140
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2141 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2142
1846 if ($self->{record_replies}) { 2143 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2144 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2145
1848 } else { 2146 } else {
2147 my $pl = $self->contr;
2148
2149 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2150 my $diag = $pl->{npc_dialog};
2151 $diag->{pl}->ext_reply (
2152 $diag->{id},
2153 msgtype => "reply",
2154 msg => $diag->{pl}->expand_cfpod ($msg),
2155 add_topics => []
2156 );
2157
2158 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2159 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2160 $self->message ($msg, $flags);
2161 }
1851 } 2162 }
1852} 2163}
1853 2164
1854=item $player_object->may ("access") 2165=item $player_object->may ("access")
1855 2166
2064 my $hp = $exit->stats->hp; 2375 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp; 2376 my $sp = $exit->stats->sp;
2066 2377
2067 $self->enter_link; 2378 $self->enter_link;
2068 2379
2380 # if exit is damned, update players death & WoR home-position
2381 $self->contr->savebed ($slaying, $hp, $sp)
2382 if $exit->flag (FLAG_DAMNED);
2383
2069 (async { 2384 (async {
2070 $self->deactivate_recursive; # just to be sure 2385 $self->deactivate_recursive; # just to be sure
2071 unless (eval { 2386 unless (eval {
2072 $self->goto ($slaying, $hp, $sp); 2387 $self->goto ($slaying, $hp, $sp);
2073 2388
2100 2415
2101 utf8::encode $text; 2416 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2417 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2418}
2104 2419
2420=item $client->send_msg ($color, $type, $msg, [extra...])
2421
2422Send a drawinfo or msg packet to the client, formatting the msg for the
2423client if neccessary. C<$type> should be a string identifying the type of
2424the message, with C<log> being the default. If C<$color> is negative, suppress
2425the message unless the client supports the msg packet.
2426
2427=cut
2428
2429sub cf::client::send_msg {
2430 my ($self, $color, $type, $msg, @extra) = @_;
2431
2432 $msg = $self->pl->expand_cfpod ($msg);
2433
2434 return unless @extra || length $msg;
2435
2436 if ($self->can_msg) {
2437 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2438 } else {
2439 # replace some tags by gcfclient-compatible ones
2440 for ($msg) {
2441 1 while
2442 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2443 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2444 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2445 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2446 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2447 }
2448
2449 if ($color >= 0) {
2450 if (0 && $msg =~ /\[/) {
2451 $self->send_packet ("drawextinfo $color 4 0 $msg")
2452 } else {
2453 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2454 $self->send_packet ("drawinfo $color $msg")
2455 }
2456 }
2457 }
2458}
2459
2105=item $client->ext_event ($type, %msg) 2460=item $client->ext_event ($type, %msg)
2106 2461
2107Sends an exti event to the client. 2462Sends an ext event to the client.
2108 2463
2109=cut 2464=cut
2110 2465
2111sub cf::client::ext_event($$%) { 2466sub cf::client::ext_event($$%) {
2112 my ($self, $type, %msg) = @_; 2467 my ($self, $type, %msg) = @_;
2113 2468
2114 $msg{msgtype} = "event_$type"; 2469 $msg{msgtype} = "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2470 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2116} 2471}
2117 2472
2118=item $success = $client->query ($flags, "text", \&cb) 2473=item $success = $client->query ($flags, "text", \&cb)
2119 2474
2120Queues a query to the client, calling the given callback with 2475Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2476the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2122C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2477C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2478
2124Queries can fail, so check the return code. Or don't, as queries will become 2479Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2480become reliable at some point in the future.
2126 2481
2127=cut 2482=cut
2128 2483
2129sub cf::client::query { 2484sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2485 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2493 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2494 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2495
2141 $self->send_packet ($self->{query_queue}[0][0]) 2496 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2497 if @{ $self->{query_queue} } == 1;
2498
2499 1
2143} 2500}
2144 2501
2145cf::client->attach ( 2502cf::client->attach (
2503 on_connect => sub {
2504 my ($ns) = @_;
2505
2506 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2507 },
2146 on_reply => sub { 2508 on_reply => sub {
2147 my ($ns, $msg) = @_; 2509 my ($ns, $msg) = @_;
2148 2510
2149 # this weird shuffling is so that direct followup queries 2511 # this weird shuffling is so that direct followup queries
2150 # get handled first 2512 # get handled first
2162 } else { 2524 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2525 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2526 }
2165 } 2527 }
2166 }, 2528 },
2529 on_exticmd => sub {
2530 my ($ns, $buf) = @_;
2531
2532 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2533
2534 if (ref $msg) {
2535 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2536 if (my %reply = $cb->($ns, $msg)) {
2537 $reply{msgid} = $msg->{msgid};
2538 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2539 }
2540 }
2541 } else {
2542 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2543 }
2544
2545 cf::override;
2546 },
2167); 2547);
2168 2548
2169=item $client->async (\&cb) 2549=item $client->async (\&cb)
2170 2550
2171Create a new coroutine, running the specified callback. The coroutine will 2551Create a new coroutine, running the specified callback. The coroutine will
2220 2600
2221=pod 2601=pod
2222 2602
2223The following functions and methods are available within a safe environment: 2603The following functions and methods are available within a safe environment:
2224 2604
2225 cf::object contr pay_amount pay_player map 2605 cf::object
2606 contr pay_amount pay_player map x y force_find force_add
2607 insert remove
2608
2226 cf::object::player player 2609 cf::object::player
2227 cf::player peaceful 2610 player
2228 cf::map trigger 2611
2612 cf::player
2613 peaceful
2614
2615 cf::map
2616 trigger
2229 2617
2230=cut 2618=cut
2231 2619
2232for ( 2620for (
2233 ["cf::object" => qw(contr pay_amount pay_player map)], 2621 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2622 insert remove)],
2234 ["cf::object::player" => qw(player)], 2623 ["cf::object::player" => qw(player)],
2235 ["cf::player" => qw(peaceful)], 2624 ["cf::player" => qw(peaceful)],
2236 ["cf::map" => qw(trigger)], 2625 ["cf::map" => qw(trigger)],
2237) { 2626) {
2238 no strict 'refs'; 2627 no strict 'refs';
2307} 2696}
2308 2697
2309=back 2698=back
2310 2699
2311=cut 2700=cut
2312
2313#############################################################################
2314
2315=head2 EXTENSION DATABASE SUPPORT
2316
2317Crossfire maintains a very simple database for extension use. It can
2318currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2319convert to/from binary).
2320
2321The parameter C<$family> should best start with the name of the extension
2322using it, it should be unique.
2323
2324=over 4
2325
2326=item $value = cf::db_get $family => $key
2327
2328Returns a single value from the database.
2329
2330=item cf::db_put $family => $key => $value
2331
2332Stores the given C<$value> in the family.
2333
2334=cut
2335
2336our $DB;
2337
2338sub db_init {
2339 unless ($DB) {
2340 $DB = BDB::db_create $DB_ENV;
2341
2342 cf::sync_job {
2343 eval {
2344 $DB->set_flags (BDB::CHKSUM);
2345
2346 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2347 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2348 cf::cleanup "db_open(db): $!" if $!;
2349 };
2350 cf::cleanup "db_open(db): $@" if $@;
2351 };
2352 }
2353}
2354
2355sub db_get($$) {
2356 my $key = "$_[0]/$_[1]";
2357
2358 cf::sync_job {
2359 BDB::db_get $DB, undef, $key, my $data;
2360
2361 $! ? ()
2362 : $data
2363 }
2364}
2365
2366sub db_put($$$) {
2367 BDB::dbreq_pri 4;
2368 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2369}
2370
2371=item cf::cache $id => [$paths...], $processversion => $process
2372
2373Generic caching function that returns the value of the resource $id,
2374caching and regenerating as required.
2375
2376This function can block.
2377
2378=cut
2379
2380sub cache {
2381 my ($id, $src, $processversion, $process) = @_;
2382
2383 my $meta =
2384 join "\x00",
2385 $processversion,
2386 map {
2387 aio_stat $_
2388 and Carp::croak "$_: $!";
2389
2390 ($_, (stat _)[7,9])
2391 } @$src;
2392
2393 my $dbmeta = db_get cache => "$id/meta";
2394 if ($dbmeta ne $meta) {
2395 # changed, we may need to process
2396
2397 my @data;
2398 my $md5;
2399
2400 for (0 .. $#$src) {
2401 0 <= aio_load $src->[$_], $data[$_]
2402 or Carp::croak "$src->[$_]: $!";
2403 }
2404
2405 # if processing is expensive, check
2406 # checksum first
2407 if (1) {
2408 $md5 =
2409 join "\x00",
2410 $processversion,
2411 map {
2412 Coro::cede;
2413 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2414 } 0.. $#$src;
2415
2416
2417 my $dbmd5 = db_get cache => "$id/md5";
2418 if ($dbmd5 eq $md5) {
2419 db_put cache => "$id/meta", $meta;
2420
2421 return db_get cache => "$id/data";
2422 }
2423 }
2424
2425 my $t1 = Time::HiRes::time;
2426 my $data = $process->(\@data);
2427 my $t2 = Time::HiRes::time;
2428
2429 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430
2431 db_put cache => "$id/data", $data;
2432 db_put cache => "$id/md5" , $md5;
2433 db_put cache => "$id/meta", $meta;
2434
2435 return $data;
2436 }
2437
2438 db_get cache => "$id/data"
2439}
2440
2441=item fork_call { }, $args
2442
2443Executes the given code block with the given arguments in a seperate
2444process, returning the results. Everything must be serialisable with
2445Coro::Storable. May, of course, block. Note that the executed sub may
2446never block itself or use any form of Event handling.
2447
2448=cut
2449
2450sub fork_call(&@) {
2451 my ($cb, @args) = @_;
2452
2453# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454# or die "socketpair: $!";
2455 pipe my $fh1, my $fh2
2456 or die "pipe: $!";
2457
2458 if (my $pid = fork) {
2459 close $fh2;
2460
2461 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462 $res = Coro::Storable::thaw $res;
2463
2464 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465
2466 die $$res unless "ARRAY" eq ref $res;
2467
2468 return wantarray ? @$res : $res->[-1];
2469 } else {
2470 reset_signals;
2471 local $SIG{__WARN__};
2472 local $SIG{__DIE__};
2473 eval {
2474 close $fh1;
2475
2476 my @res = eval { $cb->(@args) };
2477 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478 };
2479
2480 warn $@ if $@;
2481 _exit 0;
2482 }
2483}
2484 2701
2485############################################################################# 2702#############################################################################
2486# the server's init and main functions 2703# the server's init and main functions
2487 2704
2488sub load_facedata($) { 2705sub load_facedata($) {
2546 load_facedata "$DATADIR/facedata" 2763 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 2764 or die "unable to load facedata\n";
2548} 2765}
2549 2766
2550sub reload_archetypes { 2767sub reload_archetypes {
2768 load_resource_file "$DATADIR/archetypes"
2769 or die "unable to load archetypes\n";
2770 #d# NEED to laod twice to resolve forward references
2771 # this really needs to be done in an extra post-pass
2772 # (which needs to be synchronous, so solve it differently)
2551 load_resource_file "$DATADIR/archetypes" 2773 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2774 or die "unable to load archetypes\n";
2553} 2775}
2554 2776
2555sub reload_treasures { 2777sub reload_treasures {
2627 }, 2849 },
2628 ); 2850 );
2629 } 2851 }
2630} 2852}
2631 2853
2854sub write_runtime {
2855 my $runtime = "$LOCALDIR/runtime";
2856
2857 # first touch the runtime file to show we are still running:
2858 # the fsync below can take a very very long time.
2859
2860 IO::AIO::aio_utime $runtime, undef, undef;
2861
2862 my $guard = cf::lock_acquire "write_runtime";
2863
2864 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2865 or return;
2866
2867 my $value = $cf::RUNTIME + 90 + 10;
2868 # 10 is the runtime save interval, for a monotonic clock
2869 # 60 allows for the watchdog to kill the server.
2870
2871 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2872 and return;
2873
2874 # always fsync - this file is important
2875 aio_fsync $fh
2876 and return;
2877
2878 # touch it again to show we are up-to-date
2879 aio_utime $fh, undef, undef;
2880
2881 close $fh
2882 or return;
2883
2884 aio_rename "$runtime~", $runtime
2885 and return;
2886
2887 warn "runtime file written.\n";
2888
2889 1
2890}
2891
2632sub emergency_save() { 2892sub emergency_save() {
2633 my $freeze_guard = cf::freeze_mainloop; 2893 my $freeze_guard = cf::freeze_mainloop;
2634 2894
2635 warn "enter emergency perl save\n"; 2895 warn "enter emergency perl save\n";
2636 2896
2711 %EXT_CORO = (); 2971 %EXT_CORO = ();
2712 2972
2713 warn "removing commands"; 2973 warn "removing commands";
2714 %COMMAND = (); 2974 %COMMAND = ();
2715 2975
2716 warn "removing ext commands"; 2976 warn "removing ext/exti commands";
2717 %EXTCMD = (); 2977 %EXTCMD = ();
2978 %EXTICMD = ();
2718 2979
2719 warn "unloading/nuking all extensions"; 2980 warn "unloading/nuking all extensions";
2720 for my $pkg (@EXTS) { 2981 for my $pkg (@EXTS) {
2721 warn "... unloading $pkg"; 2982 warn "... unloading $pkg";
2722 2983

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines