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.298 by root, Sun Jul 8 14:50:07 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
49our %COMMAND = (); 50our %COMMAND = ();
50our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
51 52
52our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
56 58
57our $RELOAD; # number of reloads so far 59our $RELOAD; # number of reloads so far
58our @EVENT; 60our @EVENT;
206} 208}
207 209
208$Event::DIED = sub { 210$Event::DIED = sub {
209 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
210}; 212};
213
214#############################################################################
211 215
212=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
213 217
214=over 4 218=over 4
215 219
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 238 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 239 $d
236 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
237} 241}
238 242
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
242 244
243Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
244 246
245=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
246 248
247Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
250
251=cut
252
253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
254
255sub to_json ($) { $json_coder->encode ($_[0]) }
256sub from_json ($) { $json_coder->decode ($_[0]) }
248 257
249=item cf::lock_wait $string 258=item cf::lock_wait $string
250 259
251Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
252 261
318 327
319BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
320 329
321=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
322 331
323The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 333is always able to handle events or runnable, as Crossfire TRT is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
326 336
327If it must be done, put the blocking parts into C<sync_job>. This will run 337If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 339server will be frozen during this time, so the block should either finish
330fast or be very important. 340fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
391 401
392 $coro 402 $coro
393} 403}
394 404
395sub write_runtime { 405=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 406
398 # first touch the runtime file to show we are still running: 407Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 408process, returning the results. Everything must be serialisable with
409Coro::Storable. May, of course, block. Note that the executed sub may
410never block itself or use any form of Event handling.
400 411
401 IO::AIO::aio_utime $runtime, undef, undef; 412=cut
402 413
403 my $guard = cf::lock_acquire "write_runtime"; 414sub fork_call(&@) {
415 my ($cb, @args) = @_;
404 416
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
406 or return; 418# or die "socketpair: $!";
419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
407 421
408 my $value = $cf::RUNTIME + 90 + 10; 422 if (my $pid = fork) {
409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413 and return;
414
415 # always fsync - this file is important
416 aio_fsync $fh
417 and return;
418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
422 close $fh 423 close $fh2;
423 or return;
424 424
425 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
426 and return; 426 warn "pst<$res>" unless $res =~ /^pst/;
427 $res = Coro::Storable::thaw $res;
427 428
428 warn "runtime file written.\n"; 429 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
429 430
431 Carp::confess $$res unless "ARRAY" eq ref $res;
432
433 return wantarray ? @$res : $res->[-1];
434 } else {
435 reset_signals;
436 local $SIG{__WARN__};
437 local $SIG{__DIE__};
438 local $Coro::idle;
439 $Coro::current->prio (Coro::PRIO_MAX);
440 eval {
441 close $fh1;
442
443 my @res = eval { $cb->(@args) };
444
445 open my $fh, ">", \my $buf
446 or die "fork_call: cannot open fh-to-buf in child : $!";
447 Storable::store_fd +($@ ? \"$@" : \@res), $fh;
448 close $fh;
449
450 warn "writing ", length $buf;
451 my $x;
452 (length $buf) == ($x = syswrite $fh2, $buf)
453 or warn "error writing ".(length $buf)." != $x\n";
454 close $fh2;
455 };
456
457 warn $@ if $@;
458 _exit 0;
430 1 459 }
460}
461
462=item $value = cf::db_get $family => $key
463
464Returns a single value from the environment database.
465
466=item cf::db_put $family => $key => $value
467
468Stores the given C<$value> in the family. It can currently store binary
469data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
470
471=cut
472
473our $DB;
474
475sub db_init {
476 unless ($DB) {
477 $DB = BDB::db_create $DB_ENV;
478
479 cf::sync_job {
480 eval {
481 $DB->set_flags (BDB::CHKSUM);
482
483 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
484 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
485 cf::cleanup "db_open(db): $!" if $!;
486 };
487 cf::cleanup "db_open(db): $@" if $@;
488 };
489 }
490}
491
492sub db_get($$) {
493 my $key = "$_[0]/$_[1]";
494
495 cf::sync_job {
496 BDB::db_get $DB, undef, $key, my $data;
497
498 $! ? ()
499 : $data
500 }
501}
502
503sub db_put($$$) {
504 BDB::dbreq_pri 4;
505 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
506}
507
508=item cf::cache $id => [$paths...], $processversion => $process
509
510Generic caching function that returns the value of the resource $id,
511caching and regenerating as required.
512
513This function can block.
514
515=cut
516
517sub cache {
518 my ($id, $src, $processversion, $process) = @_;
519
520 my $meta =
521 join "\x00",
522 $processversion,
523 map {
524 aio_stat $_
525 and Carp::croak "$_: $!";
526
527 ($_, (stat _)[7,9])
528 } @$src;
529
530 my $dbmeta = db_get cache => "$id/meta";
531 if ($dbmeta ne $meta) {
532 # changed, we may need to process
533
534 my @data;
535 my $md5;
536
537 for (0 .. $#$src) {
538 0 <= aio_load $src->[$_], $data[$_]
539 or Carp::croak "$src->[$_]: $!";
540 }
541
542 # if processing is expensive, check
543 # checksum first
544 if (1) {
545 $md5 =
546 join "\x00",
547 $processversion,
548 map {
549 Coro::cede;
550 ($src->[$_], Digest::MD5::md5_hex $data[$_])
551 } 0.. $#$src;
552
553
554 my $dbmd5 = db_get cache => "$id/md5";
555 if ($dbmd5 eq $md5) {
556 db_put cache => "$id/meta", $meta;
557
558 return db_get cache => "$id/data";
559 }
560 }
561
562 my $t1 = Time::HiRes::time;
563 my $data = $process->(\@data);
564 my $t2 = Time::HiRes::time;
565
566 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
567
568 db_put cache => "$id/data", $data;
569 db_put cache => "$id/md5" , $md5;
570 db_put cache => "$id/meta", $meta;
571
572 return $data;
573 }
574
575 db_get cache => "$id/data"
431} 576}
432 577
433=item cf::datalog type => key => value, ... 578=item cf::datalog type => key => value, ...
434 579
435Log a datalog packet of the given type with the given key-value pairs. 580Log 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") 598attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 599to it. All such attachable objects support the following methods.
455 600
456In the following description, CLASS can be any of C<global>, C<object> 601In 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 602C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 603Crossfire TRT).
459 604
460=over 4 605=over 4
461 606
462=item $attachable->attach ($attachment, key => $value...) 607=item $attachable->attach ($attachment, key => $value...)
463 608
665 _attach $registry, $klass, @attach; 810 _attach $registry, $klass, @attach;
666 } 811 }
667 812
668 $obj->{$name} = \%arg; 813 $obj->{$name} = \%arg;
669 } else { 814 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 815 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 816 }
672 817
673 $obj->{_attachment}{$name} = undef; 818 $obj->{_attachment}{$name} = undef;
674} 819}
675 820
877 warn sprintf "loading %s (%d)\n", 1022 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1023 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1024 return ($data, $av);
880} 1025}
881 1026
1027=head2 COMMAND CALLBACKS
1028
1029=over 4
1030
1031=cut
1032
882############################################################################# 1033#############################################################################
883# command handling &c 1034# command handling &c
884 1035
885=item cf::register_command $name => \&callback($ob,$args); 1036=item cf::register_command $name => \&callback($ob,$args);
886 1037
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1049 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1050}
900 1051
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1052=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1053
903Register a callbackf ro execution when the client sends an extcmd packet. 1054Register a callback for execution when the client sends an (synchronous)
1055extcmd packet. Ext commands will be processed in the order they are
1056received by the server, like other user commands. The first argument is
1057the logged-in player. Ext commands can only be processed after a player
1058has logged in successfully.
904 1059
905If the callback returns something, it is sent back as if reply was being 1060If the callback returns something, it is sent back as if reply was being
906called. 1061called.
907 1062
1063=item cf::register_exticmd $name => \&callback($ns,$packet);
1064
1065Register a callback for execution when the client sends an (asynchronous)
1066exticmd packet. Exti commands are processed by the server as soon as they
1067are received, i.e. out of order w.r.t. other commands. The first argument
1068is a client socket. Exti commands can be received anytime, even before
1069log-in.
1070
1071If the callback returns something, it is sent back as if reply was being
1072called.
1073
908=cut 1074=cut
909 1075
910sub register_extcmd { 1076sub register_extcmd {
911 my ($name, $cb) = @_; 1077 my ($name, $cb) = @_;
912 1078
913 $EXTCMD{$name} = $cb; 1079 $EXTCMD{$name} = $cb;
1080}
1081
1082sub register_exticmd {
1083 my ($name, $cb) = @_;
1084
1085 $EXTICMD{$name} = $cb;
914} 1086}
915 1087
916cf::player->attach ( 1088cf::player->attach (
917 on_command => sub { 1089 on_command => sub {
918 my ($pl, $name, $params) = @_; 1090 my ($pl, $name, $params) = @_;
927 cf::override; 1099 cf::override;
928 }, 1100 },
929 on_extcmd => sub { 1101 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1102 my ($pl, $buf) = @_;
931 1103
932 my $msg = eval { from_json $buf }; 1104 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1105
934 if (ref $msg) { 1106 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1107 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1108 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1109 $pl->ext_reply ($msg->{msgid}, %reply);
943 1115
944 cf::override; 1116 cf::override;
945 }, 1117 },
946); 1118);
947 1119
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 { 1120sub load_extensions {
1121 cf::sync_job {
1122 my %todo;
1123
983 for my $ext (<$LIBDIR/*.ext>) { 1124 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1125 next unless -r $path;
985 eval { 1126
986 load_extension $ext; 1127 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1128 my $base = $1;
1129 my $pkg = $1;
1130 $pkg =~ s/[^[:word:]]/_/g;
1131 $pkg = "ext::$pkg";
1132
1133 open my $fh, "<:utf8", $path
1134 or die "$path: $!";
1135
1136 my $source = do { local $/; <$fh> };
1137
1138 my %ext = (
1139 path => $path,
1140 base => $base,
1141 pkg => $pkg,
1142 );
1143
1144 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1145 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1146
1147 $ext{source} =
1148 "package $pkg; use strict; use utf8;\n"
1149 . "#line 1 \"$path\"\n{\n"
1150 . $source
1151 . "\n};\n1";
1152
1153 $todo{$base} = \%ext;
1154 }
1155
1156 my %done;
1157 while (%todo) {
1158 my $progress;
1159
1160 while (my ($k, $v) = each %todo) {
1161 for (split /,\s*/, $v->{meta}{depends}) {
1162 goto skip
1163 unless exists $done{$_};
1164 }
1165
1166 warn "... loading '$k' into '$v->{pkg}'\n";
1167
1168 unless (eval $v->{source}) {
1169 my $msg = $@ ? "$v->{path}: $@\n"
1170 : "$v->{base}: extension inactive.\n";
1171
1172 if (exists $v->{meta}{mandatory}) {
1173 warn $msg;
1174 warn "mandatory extension failed to load, exiting.\n";
1175 exit 1;
1176 }
1177
1178 warn $msg;
1179 }
1180
1181 $done{$k} = delete $todo{$k};
1182 push @EXTS, $v->{pkg};
1183 $progress = 1;
987 1 1184 }
988 } or warn "$ext not loaded: $@"; 1185
1186 skip:
1187 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1188 unless $progress;
1189 }
989 } 1190 };
990} 1191}
991 1192
992############################################################################# 1193#############################################################################
1194
1195=back
993 1196
994=head2 CORE EXTENSIONS 1197=head2 CORE EXTENSIONS
995 1198
996Functions and methods that extend core crossfire objects. 1199Functions and methods that extend core crossfire objects.
997 1200
1185 } 1388 }
1186 1389
1187 \@paths 1390 \@paths
1188} 1391}
1189 1392
1393=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1394
1395Expand crossfire pod fragments into protocol xml.
1396
1397=cut
1398
1399sub expand_cfpod {
1400 ((my $self), (local $_)) = @_;
1401
1402 # escape & and <
1403 s/&/&amp;/g;
1404 s/(?<![BIUGH])</&lt;/g;
1405
1406 # this is buggy, it needs to properly take care of nested <'s
1407
1408 1 while
1409 # replace B<>, I<>, U<> etc.
1410 s/B<([^\>]*)>/<b>$1<\/b>/
1411 || s/I<([^\>]*)>/<i>$1<\/i>/
1412 || s/U<([^\>]*)>/<u>$1<\/u>/
1413 # replace G<male|female> tags
1414 || s{G<([^>|]*)\|([^>]*)>}{
1415 $self->gender ? $2 : $1
1416 }ge
1417 # replace H<hint text>
1418 || s{H<([^\>]*)>}
1419 {
1420 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1421 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1422 "")
1423 [$self->{hintmode}]
1424 }ge;
1425
1426 # create single paragraphs (very hackish)
1427 s/(?<=\S)\n(?=\w)/ /g;
1428
1429 # compress some whitespace
1430 s/\s+\n/\n/g; # ws line-ends
1431 s/\n\n+/\n/g; # double lines
1432 s/^\n+//; # beginning lines
1433 s/\n+$//; # ending lines
1434
1435 $_
1436}
1437
1438sub hintmode {
1439 $_[0]{hintmode} = $_[1] if @_ > 1;
1440 $_[0]{hintmode}
1441}
1442
1190=item $player->ext_reply ($msgid, %msg) 1443=item $player->ext_reply ($msgid, %msg)
1191 1444
1192Sends an ext reply to the player. 1445Sends an ext reply to the player.
1193 1446
1194=cut 1447=cut
1195 1448
1196sub ext_reply($$%) { 1449sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1450 my ($self, $id, %msg) = @_;
1198 1451
1199 $msg{msgid} = $id; 1452 $msg{msgid} = $id;
1200 1453 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1454}
1203 1455
1204=item $player->ext_event ($type, %msg) 1456=item $player->ext_event ($type, %msg)
1205 1457
1206Sends an ext event to the client. 1458Sends an ext event to the client.
1221 1473
1222package cf::region; 1474package cf::region;
1223 1475
1224=item cf::region::find_by_path $path 1476=item cf::region::find_by_path $path
1225 1477
1226Tries to decuce the probable region for a map knowing only its path. 1478Tries to decuce the likely region for a map knowing only its path.
1227 1479
1228=cut 1480=cut
1229 1481
1230sub find_by_path($) { 1482sub find_by_path($) {
1231 my ($path) = @_; 1483 my ($path) = @_;
1305 my ($self, $merge) = @_; 1557 my ($self, $merge) = @_;
1306 1558
1307 # we have to keep some variables in memory intact 1559 # we have to keep some variables in memory intact
1308 local $self->{path}; 1560 local $self->{path};
1309 local $self->{load_path}; 1561 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1562
1313 $self->SUPER::thawer_merge ($merge); 1563 $self->SUPER::thawer_merge ($merge);
1314} 1564}
1315 1565
1316sub normalise { 1566sub normalise {
1416 1666
1417 $_->change_map_light ($change) 1667 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1668 for grep $_->outdoor, values %cf::MAP;
1419} 1669}
1420 1670
1671sub decay_objects {
1672 my ($self) = @_;
1673
1674 return if $self->{deny_reset};
1675
1676 $self->do_decay_objects;
1677}
1678
1421sub unlink_save { 1679sub unlink_save {
1422 my ($self) = @_; 1680 my ($self) = @_;
1423 1681
1424 utf8::encode (my $save = $self->save_path); 1682 utf8::encode (my $save = $self->save_path);
1425 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1683 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1481 $self->load_header_orig 1739 $self->load_header_orig
1482 or return; 1740 or return;
1483 $self->prepare_orig; 1741 $self->prepare_orig;
1484 } 1742 }
1485 1743
1744 $self->{deny_reset} = 1
1745 if $self->no_reset;
1746
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1747 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1748 unless $self->default_region;
1488 1749
1489 1 1750 1
1490} 1751}
1505 $map->{last_save} = $cf::RUNTIME; 1766 $map->{last_save} = $cf::RUNTIME;
1506 1767
1507 $map->load_header 1768 $map->load_header
1508 or return; 1769 or return;
1509 1770
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1771 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1772 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1773 #$cf::WAIT_FOR_TICK->wait;
1513 $map->reset; 1774 $map->reset;
1514 undef $guard; 1775 undef $guard;
1515 return find $path; 1776 return find $path;
1582 my ($self, $ob) = @_; 1843 my ($self, $ob) = @_;
1583 1844
1584 return find "~" . $ob->name . "/" . $self->{path} 1845 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1846 if $self->per_player;
1586 1847
1848# return find "?party/" . $ob->name . "/" . $self->{path}
1849# if $self->per_party;
1850
1587 $self 1851 $self
1588} 1852}
1589 1853
1590# find and load all maps in the 3x3 area around a map 1854# find and load all maps in the 3x3 area around a map
1591sub load_diag { 1855sub load_diag {
1701 1965
1702sub reset_at { 1966sub reset_at {
1703 my ($self) = @_; 1967 my ($self) = @_;
1704 1968
1705 # TODO: safety, remove and allow resettable per-player maps 1969 # 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}; 1970 return 1e99 if $self->{deny_reset};
1708 1971
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1972 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1973 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 1974
1722 my ($self) = @_; 1985 my ($self) = @_;
1723 1986
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1987 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 1988
1726 return if $self->players; 1989 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 1990
1729 warn "resetting map ", $self->path; 1991 warn "resetting map ", $self->path;
1730 1992
1731 $self->in_memory (cf::MAP_SWAPPED); 1993 $self->in_memory (cf::MAP_SWAPPED);
1732 1994
1766 $cf::MAP{$self->path} = $self; 2028 $cf::MAP{$self->path} = $self;
1767 2029
1768 $self->reset; # polite request, might not happen 2030 $self->reset; # polite request, might not happen
1769} 2031}
1770 2032
2033=item $maps = cf::map::tmp_maps
2034
2035Returns an arrayref with all map paths of currently instantiated and saved
2036maps. May block.
2037
2038=cut
2039
2040sub tmp_maps() {
2041 [
2042 map {
2043 utf8::decode $_;
2044 /\.map$/
2045 ? normalise $_
2046 : ()
2047 } @{ aio_readdir $TMPDIR or [] }
2048 ]
2049}
2050
2051=item $maps = cf::map::random_maps
2052
2053Returns an arrayref with all map paths of currently instantiated and saved
2054random maps. May block.
2055
2056=cut
2057
2058sub random_maps() {
2059 [
2060 map {
2061 utf8::decode $_;
2062 /\.map$/
2063 ? normalise "?random/$_"
2064 : ()
2065 } @{ aio_readdir $RANDOMDIR or [] }
2066 ]
2067}
2068
1771=item cf::map::unique_maps 2069=item cf::map::unique_maps
1772 2070
1773Returns an arrayref of paths of all shared maps that have 2071Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2072instantiated unique items. May block.
1775 2073
1776=cut 2074=cut
1777 2075
1778sub unique_maps() { 2076sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2077 [
1780 or return; 2078 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2079 utf8::decode $_;
1786 next if /\.pst$/; 2080 /\.map$/
1787 next unless /^$PATH_SEP/o; 2081 ? normalise $_
1788 2082 : ()
1789 push @paths, cf::map::normalise $_; 2083 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2084 ]
1791
1792 \@paths
1793} 2085}
1794 2086
1795package cf; 2087package cf;
1796 2088
1797=back 2089=back
1843 2135
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2136 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2137
1846 if ($self->{record_replies}) { 2138 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2139 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2140
1848 } else { 2141 } else {
2142 my $pl = $self->contr;
2143
2144 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2145 my $diag = $pl->{npc_dialog};
2146 $diag->{pl}->ext_reply (
2147 $diag->{id},
2148 msgtype => "reply",
2149 msg => $diag->{pl}->expand_cfpod ($msg),
2150 add_topics => []
2151 );
2152
2153 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2154 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2155 $self->message ($msg, $flags);
2156 }
1851 } 2157 }
1852} 2158}
1853 2159
1854=item $player_object->may ("access") 2160=item $player_object->may ("access")
1855 2161
2064 my $hp = $exit->stats->hp; 2370 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp; 2371 my $sp = $exit->stats->sp;
2066 2372
2067 $self->enter_link; 2373 $self->enter_link;
2068 2374
2375 # if exit is damned, update players death & WoR home-position
2376 $self->contr->savebed ($slaying, $hp, $sp)
2377 if $exit->flag (FLAG_DAMNED);
2378
2069 (async { 2379 (async {
2070 $self->deactivate_recursive; # just to be sure 2380 $self->deactivate_recursive; # just to be sure
2071 unless (eval { 2381 unless (eval {
2072 $self->goto ($slaying, $hp, $sp); 2382 $self->goto ($slaying, $hp, $sp);
2073 2383
2100 2410
2101 utf8::encode $text; 2411 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2412 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2413}
2104 2414
2415=item $client->send_msg ($color, $type, $msg, [extra...])
2416
2417Send a drawinfo or msg packet to the client, formatting the msg for the
2418client if neccessary. C<$type> should be a string identifying the type of
2419the message, with C<log> being the default. If C<$color> is negative, suppress
2420the message unless the client supports the msg packet.
2421
2422=cut
2423
2424sub cf::client::send_msg {
2425 my ($self, $color, $type, $msg, @extra) = @_;
2426
2427 $msg = $self->pl->expand_cfpod ($msg);
2428
2429 return unless @extra || length $msg;
2430
2431 if ($self->can_msg) {
2432 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2433 } else {
2434 # replace some tags by gcfclient-compatible ones
2435 for ($msg) {
2436 1 while
2437 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2438 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2439 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2440 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2441 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2442 }
2443
2444 if ($color >= 0) {
2445 if (0 && $msg =~ /\[/) {
2446 $self->send_packet ("drawextinfo $color 4 0 $msg")
2447 } else {
2448 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2449 $self->send_packet ("drawinfo $color $msg")
2450 }
2451 }
2452 }
2453}
2454
2105=item $client->ext_event ($type, %msg) 2455=item $client->ext_event ($type, %msg)
2106 2456
2107Sends an exti event to the client. 2457Sends an ext event to the client.
2108 2458
2109=cut 2459=cut
2110 2460
2111sub cf::client::ext_event($$%) { 2461sub cf::client::ext_event($$%) {
2112 my ($self, $type, %msg) = @_; 2462 my ($self, $type, %msg) = @_;
2113 2463
2114 $msg{msgtype} = "event_$type"; 2464 $msg{msgtype} = "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2465 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2116} 2466}
2117 2467
2118=item $success = $client->query ($flags, "text", \&cb) 2468=item $success = $client->query ($flags, "text", \&cb)
2119 2469
2120Queues a query to the client, calling the given callback with 2470Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2471the 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>. 2472C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2473
2124Queries can fail, so check the return code. Or don't, as queries will become 2474Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2475become reliable at some point in the future.
2126 2476
2127=cut 2477=cut
2128 2478
2129sub cf::client::query { 2479sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2480 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2488 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2489 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2490
2141 $self->send_packet ($self->{query_queue}[0][0]) 2491 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2492 if @{ $self->{query_queue} } == 1;
2493
2494 1
2143} 2495}
2144 2496
2145cf::client->attach ( 2497cf::client->attach (
2498 on_connect => sub {
2499 my ($ns) = @_;
2500
2501 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2502 },
2146 on_reply => sub { 2503 on_reply => sub {
2147 my ($ns, $msg) = @_; 2504 my ($ns, $msg) = @_;
2148 2505
2149 # this weird shuffling is so that direct followup queries 2506 # this weird shuffling is so that direct followup queries
2150 # get handled first 2507 # get handled first
2162 } else { 2519 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2520 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2521 }
2165 } 2522 }
2166 }, 2523 },
2524 on_exticmd => sub {
2525 my ($ns, $buf) = @_;
2526
2527 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2528
2529 if (ref $msg) {
2530 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2531 if (my %reply = $cb->($ns, $msg)) {
2532 $reply{msgid} = $msg->{msgid};
2533 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2534 }
2535 }
2536 } else {
2537 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2538 }
2539
2540 cf::override;
2541 },
2167); 2542);
2168 2543
2169=item $client->async (\&cb) 2544=item $client->async (\&cb)
2170 2545
2171Create a new coroutine, running the specified callback. The coroutine will 2546Create a new coroutine, running the specified callback. The coroutine will
2220 2595
2221=pod 2596=pod
2222 2597
2223The following functions and methods are available within a safe environment: 2598The following functions and methods are available within a safe environment:
2224 2599
2225 cf::object contr pay_amount pay_player map 2600 cf::object
2601 contr pay_amount pay_player map x y force_find force_add
2602 insert remove
2603
2226 cf::object::player player 2604 cf::object::player
2227 cf::player peaceful 2605 player
2228 cf::map trigger 2606
2607 cf::player
2608 peaceful
2609
2610 cf::map
2611 trigger
2229 2612
2230=cut 2613=cut
2231 2614
2232for ( 2615for (
2233 ["cf::object" => qw(contr pay_amount pay_player map)], 2616 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2617 insert remove)],
2234 ["cf::object::player" => qw(player)], 2618 ["cf::object::player" => qw(player)],
2235 ["cf::player" => qw(peaceful)], 2619 ["cf::player" => qw(peaceful)],
2236 ["cf::map" => qw(trigger)], 2620 ["cf::map" => qw(trigger)],
2237) { 2621) {
2238 no strict 'refs'; 2622 no strict 'refs';
2307} 2691}
2308 2692
2309=back 2693=back
2310 2694
2311=cut 2695=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 2696
2485############################################################################# 2697#############################################################################
2486# the server's init and main functions 2698# the server's init and main functions
2487 2699
2488sub load_facedata($) { 2700sub load_facedata($) {
2546 load_facedata "$DATADIR/facedata" 2758 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 2759 or die "unable to load facedata\n";
2548} 2760}
2549 2761
2550sub reload_archetypes { 2762sub reload_archetypes {
2763 load_resource_file "$DATADIR/archetypes"
2764 or die "unable to load archetypes\n";
2765 #d# NEED to laod twice to resolve forward references
2766 # this really needs to be done in an extra post-pass
2767 # (which needs to be synchronous, so solve it differently)
2551 load_resource_file "$DATADIR/archetypes" 2768 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2769 or die "unable to load archetypes\n";
2553} 2770}
2554 2771
2555sub reload_treasures { 2772sub reload_treasures {
2627 }, 2844 },
2628 ); 2845 );
2629 } 2846 }
2630} 2847}
2631 2848
2849sub write_runtime {
2850 my $runtime = "$LOCALDIR/runtime";
2851
2852 # first touch the runtime file to show we are still running:
2853 # the fsync below can take a very very long time.
2854
2855 IO::AIO::aio_utime $runtime, undef, undef;
2856
2857 my $guard = cf::lock_acquire "write_runtime";
2858
2859 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2860 or return;
2861
2862 my $value = $cf::RUNTIME + 90 + 10;
2863 # 10 is the runtime save interval, for a monotonic clock
2864 # 60 allows for the watchdog to kill the server.
2865
2866 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2867 and return;
2868
2869 # always fsync - this file is important
2870 aio_fsync $fh
2871 and return;
2872
2873 # touch it again to show we are up-to-date
2874 aio_utime $fh, undef, undef;
2875
2876 close $fh
2877 or return;
2878
2879 aio_rename "$runtime~", $runtime
2880 and return;
2881
2882 warn "runtime file written.\n";
2883
2884 1
2885}
2886
2632sub emergency_save() { 2887sub emergency_save() {
2633 my $freeze_guard = cf::freeze_mainloop; 2888 my $freeze_guard = cf::freeze_mainloop;
2634 2889
2635 warn "enter emergency perl save\n"; 2890 warn "enter emergency perl save\n";
2636 2891
2711 %EXT_CORO = (); 2966 %EXT_CORO = ();
2712 2967
2713 warn "removing commands"; 2968 warn "removing commands";
2714 %COMMAND = (); 2969 %COMMAND = ();
2715 2970
2716 warn "removing ext commands"; 2971 warn "removing ext/exti commands";
2717 %EXTCMD = (); 2972 %EXTCMD = ();
2973 %EXTICMD = ();
2718 2974
2719 warn "unloading/nuking all extensions"; 2975 warn "unloading/nuking all extensions";
2720 for my $pkg (@EXTS) { 2976 for my $pkg (@EXTS) {
2721 warn "... unloading $pkg"; 2977 warn "... unloading $pkg";
2722 2978

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines