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.273 by root, Mon Jun 4 12:19:08 2007 UTC vs.
Revision 1.292 by root, Tue Jul 3 00:54:57 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
49our %COMMAND = (); 50our %COMMAND = ();
50our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
51 52
52our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
56 58
57our $RELOAD; # number of reloads so far 59our $RELOAD; # number of reloads so far
58our @EVENT; 60our @EVENT;
206} 208}
207 209
208$Event::DIED = sub { 210$Event::DIED = sub {
209 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
210}; 212};
213
214#############################################################################
211 215
212=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
213 217
214=over 4 218=over 4
215 219
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 238 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 239 $d
236 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
237} 241}
238 242
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
242 244
243Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
244 246
245=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
246 248
247Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
250
251=cut
252
253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
254
255sub to_json ($) { $json_coder->encode ($_[0]) }
256sub from_json ($) { $json_coder->decode ($_[0]) }
248 257
249=item cf::lock_wait $string 258=item cf::lock_wait $string
250 259
251Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
252 261
318 327
319BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
320 329
321=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
322 331
323The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 333is always able to handle events or runnable, as Crossfire TRT is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
326 336
327If it must be done, put the blocking parts into C<sync_job>. This will run 337If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 339server will be frozen during this time, so the block should either finish
330fast or be very important. 340fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
391 401
392 $coro 402 $coro
393} 403}
394 404
395sub write_runtime { 405=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 406
398 # first touch the runtime file to show we are still running: 407Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 408process, returning the results. Everything must be serialisable with
409Coro::Storable. May, of course, block. Note that the executed sub may
410never block itself or use any form of Event handling.
400 411
401 IO::AIO::aio_utime $runtime, undef, undef; 412=cut
402 413
403 my $guard = cf::lock_acquire "write_runtime"; 414sub fork_call(&@) {
415 my ($cb, @args) = @_;
404 416
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
406 or return; 418# or die "socketpair: $!";
419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
407 421
408 my $value = $cf::RUNTIME + 90 + 10; 422 if (my $pid = fork) {
409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413 and return;
414
415 # always fsync - this file is important
416 aio_fsync $fh
417 and return;
418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
422 close $fh 423 close $fh2;
423 or return;
424 424
425 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
426 and return; 426 $res = Coro::Storable::thaw $res;
427 427
428 warn "runtime file written.\n";#d# 428 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
429 429
430 die $$res unless "ARRAY" eq ref $res;
431
432 return wantarray ? @$res : $res->[-1];
433 } else {
434 reset_signals;
435 local $SIG{__WARN__};
436 local $SIG{__DIE__};
437 eval {
438 close $fh1;
439
440 my @res = eval { $cb->(@args) };
441 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
442 };
443
444 warn $@ if $@;
445 _exit 0;
430 1 446 }
447}
448
449=item $value = cf::db_get $family => $key
450
451Returns a single value from the environment database.
452
453=item cf::db_put $family => $key => $value
454
455Stores the given C<$value> in the family. It can currently store binary
456data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
457
458=cut
459
460our $DB;
461
462sub db_init {
463 unless ($DB) {
464 $DB = BDB::db_create $DB_ENV;
465
466 cf::sync_job {
467 eval {
468 $DB->set_flags (BDB::CHKSUM);
469
470 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
471 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
472 cf::cleanup "db_open(db): $!" if $!;
473 };
474 cf::cleanup "db_open(db): $@" if $@;
475 };
476 }
477}
478
479sub db_get($$) {
480 my $key = "$_[0]/$_[1]";
481
482 cf::sync_job {
483 BDB::db_get $DB, undef, $key, my $data;
484
485 $! ? ()
486 : $data
487 }
488}
489
490sub db_put($$$) {
491 BDB::dbreq_pri 4;
492 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
493}
494
495=item cf::cache $id => [$paths...], $processversion => $process
496
497Generic caching function that returns the value of the resource $id,
498caching and regenerating as required.
499
500This function can block.
501
502=cut
503
504sub cache {
505 my ($id, $src, $processversion, $process) = @_;
506
507 my $meta =
508 join "\x00",
509 $processversion,
510 map {
511 aio_stat $_
512 and Carp::croak "$_: $!";
513
514 ($_, (stat _)[7,9])
515 } @$src;
516
517 my $dbmeta = db_get cache => "$id/meta";
518 if ($dbmeta ne $meta) {
519 # changed, we may need to process
520
521 my @data;
522 my $md5;
523
524 for (0 .. $#$src) {
525 0 <= aio_load $src->[$_], $data[$_]
526 or Carp::croak "$src->[$_]: $!";
527 }
528
529 # if processing is expensive, check
530 # checksum first
531 if (1) {
532 $md5 =
533 join "\x00",
534 $processversion,
535 map {
536 Coro::cede;
537 ($src->[$_], Digest::MD5::md5_hex $data[$_])
538 } 0.. $#$src;
539
540
541 my $dbmd5 = db_get cache => "$id/md5";
542 if ($dbmd5 eq $md5) {
543 db_put cache => "$id/meta", $meta;
544
545 return db_get cache => "$id/data";
546 }
547 }
548
549 my $t1 = Time::HiRes::time;
550 my $data = $process->(\@data);
551 my $t2 = Time::HiRes::time;
552
553 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
554
555 db_put cache => "$id/data", $data;
556 db_put cache => "$id/md5" , $md5;
557 db_put cache => "$id/meta", $meta;
558
559 return $data;
560 }
561
562 db_get cache => "$id/data"
431} 563}
432 564
433=item cf::datalog type => key => value, ... 565=item cf::datalog type => key => value, ...
434 566
435Log a datalog packet of the given type with the given key-value pairs. 567Log a datalog packet of the given type with the given key-value pairs.
453attach callbacks/event handlers (a collection of which is called an "attachment") 585attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 586to it. All such attachable objects support the following methods.
455 587
456In the following description, CLASS can be any of C<global>, C<object> 588In the following description, CLASS can be any of C<global>, C<object>
457C<player>, C<client> or C<map> (i.e. the attachable objects in 589C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 590Crossfire TRT).
459 591
460=over 4 592=over 4
461 593
462=item $attachable->attach ($attachment, key => $value...) 594=item $attachable->attach ($attachment, key => $value...)
463 595
665 _attach $registry, $klass, @attach; 797 _attach $registry, $klass, @attach;
666 } 798 }
667 799
668 $obj->{$name} = \%arg; 800 $obj->{$name} = \%arg;
669 } else { 801 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 802 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 803 }
672 804
673 $obj->{_attachment}{$name} = undef; 805 $obj->{_attachment}{$name} = undef;
674} 806}
675 807
873 or return; 1005 or return;
874 $av = eval { (Storable::thaw $av)->{objs} }; 1006 $av = eval { (Storable::thaw $av)->{objs} };
875 } 1007 }
876 1008
877 warn sprintf "loading %s (%d)\n", 1009 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []};#d# 1010 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1011 return ($data, $av);
880} 1012}
1013
1014=head2 COMMAND CALLBACKS
1015
1016=over 4
1017
1018=cut
881 1019
882############################################################################# 1020#############################################################################
883# command handling &c 1021# command handling &c
884 1022
885=item cf::register_command $name => \&callback($ob,$args); 1023=item cf::register_command $name => \&callback($ob,$args);
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1036 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1037}
900 1038
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1039=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1040
903Register a callbackf ro execution when the client sends an extcmd packet. 1041Register a callback for execution when the client sends an (synchronous)
1042extcmd packet. Ext commands will be processed in the order they are
1043received by the server, like other user commands. The first argument is
1044the logged-in player. Ext commands can only be processed after a player
1045has logged in successfully.
904 1046
905If the callback returns something, it is sent back as if reply was being 1047If the callback returns something, it is sent back as if reply was being
906called. 1048called.
907 1049
1050=item cf::register_exticmd $name => \&callback($ns,$packet);
1051
1052Register a callback for execution when the client sends an (asynchronous)
1053exticmd packet. Exti commands are processed by the server as soon as they
1054are received, i.e. out of order w.r.t. other commands. The first argument
1055is a client socket. Exti commands can be received anytime, even before
1056log-in.
1057
1058If the callback returns something, it is sent back as if reply was being
1059called.
1060
908=cut 1061=cut
909 1062
910sub register_extcmd { 1063sub register_extcmd {
911 my ($name, $cb) = @_; 1064 my ($name, $cb) = @_;
912 1065
913 $EXTCMD{$name} = $cb; 1066 $EXTCMD{$name} = $cb;
1067}
1068
1069sub register_exticmd {
1070 my ($name, $cb) = @_;
1071
1072 $EXTICMD{$name} = $cb;
914} 1073}
915 1074
916cf::player->attach ( 1075cf::player->attach (
917 on_command => sub { 1076 on_command => sub {
918 my ($pl, $name, $params) = @_; 1077 my ($pl, $name, $params) = @_;
927 cf::override; 1086 cf::override;
928 }, 1087 },
929 on_extcmd => sub { 1088 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1089 my ($pl, $buf) = @_;
931 1090
932 my $msg = eval { from_json $buf }; 1091 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1092
934 if (ref $msg) { 1093 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1094 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1095 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1096 $pl->ext_reply ($msg->{msgid}, %reply);
943 1102
944 cf::override; 1103 cf::override;
945 }, 1104 },
946); 1105);
947 1106
948sub load_extension {
949 my ($path) = @_;
950
951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 my $base = $1;
953 my $pkg = $1;
954 $pkg =~ s/[^[:word:]]/_/g;
955 $pkg = "ext::$pkg";
956
957 warn "... loading '$path' into '$pkg'\n";
958
959 open my $fh, "<:utf8", $path
960 or die "$path: $!";
961
962 my $source =
963 "package $pkg; use strict; use utf8;\n"
964 . "#line 1 \"$path\"\n{\n"
965 . (do { local $/; <$fh> })
966 . "\n};\n1";
967
968 unless (eval $source) {
969 my $msg = $@ ? "$path: $@\n"
970 : "extension disabled.\n";
971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972 warn $@;
973 warn "mandatory extension failed to load, exiting.\n";
974 exit 1;
975 }
976 die $@;
977 }
978
979 push @EXTS, $pkg;
980}
981
982sub load_extensions { 1107sub load_extensions {
1108 cf::sync_job {
1109 my %todo;
1110
983 for my $ext (<$LIBDIR/*.ext>) { 1111 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1112 next unless -r $path;
985 eval { 1113
986 load_extension $ext; 1114 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1115 my $base = $1;
1116 my $pkg = $1;
1117 $pkg =~ s/[^[:word:]]/_/g;
1118 $pkg = "ext::$pkg";
1119
1120 open my $fh, "<:utf8", $path
1121 or die "$path: $!";
1122
1123 my $source = do { local $/; <$fh> };
1124
1125 my %ext = (
1126 path => $path,
1127 base => $base,
1128 pkg => $pkg,
1129 );
1130
1131 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1132 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1133
1134 $ext{source} =
1135 "package $pkg; use strict; use utf8;\n"
1136 . "#line 1 \"$path\"\n{\n"
1137 . $source
1138 . "\n};\n1";
1139
1140 $todo{$base} = \%ext;
1141 }
1142
1143 my %done;
1144 while (%todo) {
1145 my $progress;
1146
1147 while (my ($k, $v) = each %todo) {
1148 for (split /,\s*/, $v->{meta}{depends}) {
1149 goto skip
1150 unless exists $done{$_};
1151 }
1152
1153 warn "... loading '$k' into '$v->{pkg}'\n";
1154
1155 unless (eval $v->{source}) {
1156 my $msg = $@ ? "$v->{path}: $@\n"
1157 : "$v->{base}: extension inactive.\n";
1158
1159 if (exists $v->{meta}{mandatory}) {
1160 warn $msg;
1161 warn "mandatory extension failed to load, exiting.\n";
1162 exit 1;
1163 }
1164
1165 warn $msg;
1166 }
1167
1168 $done{$k} = delete $todo{$k};
1169 push @EXTS, $v->{pkg};
1170 $progress = 1;
987 1 1171 }
988 } or warn "$ext not loaded: $@"; 1172
1173 skip:
1174 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1175 unless $progress;
1176 }
989 } 1177 };
990} 1178}
991 1179
992############################################################################# 1180#############################################################################
1181
1182=back
993 1183
994=head2 CORE EXTENSIONS 1184=head2 CORE EXTENSIONS
995 1185
996Functions and methods that extend core crossfire objects. 1186Functions and methods that extend core crossfire objects.
997 1187
1185 } 1375 }
1186 1376
1187 \@paths 1377 \@paths
1188} 1378}
1189 1379
1380=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1381
1382Expand crossfire pod fragments into protocol xml.
1383
1384=cut
1385
1386sub expand_cfpod {
1387 ((my $self), (local $_)) = @_;
1388
1389 # escape & and <
1390 s/&/&amp;/g;
1391 s/(?<![BIUGH])</&lt;/g;
1392
1393 # this is buggy, it needs to properly take care of nested <'s
1394
1395 1 while
1396 # replace B<>, I<>, U<> etc.
1397 s/B<([^\>]*)>/<b>$1<\/b>/
1398 || s/I<([^\>]*)>/<i>$1<\/i>/
1399 || s/U<([^\>]*)>/<u>$1<\/u>/
1400 # replace G<male|female> tags
1401 || s{G<([^>|]*)\|([^>]*)>}{
1402 $self->gender ? $2 : $1
1403 }ge
1404 # replace H<hint text>
1405 || s{H<([^\>]*)>}
1406 {
1407 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1408 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1409 "")
1410 [$self->{hintmode}]
1411 }ge;
1412
1413 # create single paragraphs (very hackish)
1414 s/(?<=\S)\n(?=\w)/ /g;
1415
1416 # compress some whitespace
1417 1 while s/\s*\n\s*\n\s*/\n/;
1418
1419 $_
1420}
1421
1422sub hintmode {
1423 $_[0]{hintmode} = $_[1] if @_ > 1;
1424 $_[0]{hintmode}
1425}
1426
1190=item $player->ext_reply ($msgid, %msg) 1427=item $player->ext_reply ($msgid, %msg)
1191 1428
1192Sends an ext reply to the player. 1429Sends an ext reply to the player.
1193 1430
1194=cut 1431=cut
1195 1432
1196sub ext_reply($$%) { 1433sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1434 my ($self, $id, %msg) = @_;
1198 1435
1199 $msg{msgid} = $id; 1436 $msg{msgid} = $id;
1200 1437 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1438}
1203 1439
1204=item $player->ext_event ($type, %msg) 1440=item $player->ext_event ($type, %msg)
1205 1441
1206Sends an ext event to the client. 1442Sends an ext event to the client.
1221 1457
1222package cf::region; 1458package cf::region;
1223 1459
1224=item cf::region::find_by_path $path 1460=item cf::region::find_by_path $path
1225 1461
1226Tries to decuce the probable region for a map knowing only its path. 1462Tries to decuce the likely region for a map knowing only its path.
1227 1463
1228=cut 1464=cut
1229 1465
1230sub find_by_path($) { 1466sub find_by_path($) {
1231 my ($path) = @_; 1467 my ($path) = @_;
1305 my ($self, $merge) = @_; 1541 my ($self, $merge) = @_;
1306 1542
1307 # we have to keep some variables in memory intact 1543 # we have to keep some variables in memory intact
1308 local $self->{path}; 1544 local $self->{path};
1309 local $self->{load_path}; 1545 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1546
1313 $self->SUPER::thawer_merge ($merge); 1547 $self->SUPER::thawer_merge ($merge);
1314} 1548}
1315 1549
1316sub normalise { 1550sub normalise {
1416 1650
1417 $_->change_map_light ($change) 1651 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1652 for grep $_->outdoor, values %cf::MAP;
1419} 1653}
1420 1654
1655sub decay_objects {
1656 my ($self) = @_;
1657
1658 return if $self->{deny_reset};
1659
1660 $self->do_decay_objects;
1661}
1662
1421sub unlink_save { 1663sub unlink_save {
1422 my ($self) = @_; 1664 my ($self) = @_;
1423 1665
1424 utf8::encode (my $save = $self->save_path); 1666 utf8::encode (my $save = $self->save_path);
1425 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1667 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1481 $self->load_header_orig 1723 $self->load_header_orig
1482 or return; 1724 or return;
1483 $self->prepare_orig; 1725 $self->prepare_orig;
1484 } 1726 }
1485 1727
1728 $self->{deny_reset} = 1
1729 if $self->no_reset;
1730
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1731 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1732 unless $self->default_region;
1488 1733
1489 1 1734 1
1490} 1735}
1505 $map->{last_save} = $cf::RUNTIME; 1750 $map->{last_save} = $cf::RUNTIME;
1506 1751
1507 $map->load_header 1752 $map->load_header
1508 or return; 1753 or return;
1509 1754
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1755 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1756 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1757 #$cf::WAIT_FOR_TICK->wait;
1513 $map->reset; 1758 $map->reset;
1514 undef $guard; 1759 undef $guard;
1515 return find $path; 1760 return find $path;
1582 my ($self, $ob) = @_; 1827 my ($self, $ob) = @_;
1583 1828
1584 return find "~" . $ob->name . "/" . $self->{path} 1829 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1830 if $self->per_player;
1586 1831
1832# return find "?party/" . $ob->name . "/" . $self->{path}
1833# if $self->per_party;
1834
1587 $self 1835 $self
1588} 1836}
1589 1837
1590# find and load all maps in the 3x3 area around a map 1838# find and load all maps in the 3x3 area around a map
1591sub load_diag { 1839sub load_diag {
1701 1949
1702sub reset_at { 1950sub reset_at {
1703 my ($self) = @_; 1951 my ($self) = @_;
1704 1952
1705 # TODO: safety, remove and allow resettable per-player maps 1953 # 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}; 1954 return 1e99 if $self->{deny_reset};
1708 1955
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1956 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1957 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 1958
1722 my ($self) = @_; 1969 my ($self) = @_;
1723 1970
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1971 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 1972
1726 return if $self->players; 1973 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 1974
1729 warn "resetting map ", $self->path;#d# 1975 warn "resetting map ", $self->path;
1730 1976
1731 $self->in_memory (cf::MAP_SWAPPED); 1977 $self->in_memory (cf::MAP_SWAPPED);
1732 1978
1733 # need to save uniques path 1979 # need to save uniques path
1734 unless ($self->{deny_save}) { 1980 unless ($self->{deny_save}) {
1766 $cf::MAP{$self->path} = $self; 2012 $cf::MAP{$self->path} = $self;
1767 2013
1768 $self->reset; # polite request, might not happen 2014 $self->reset; # polite request, might not happen
1769} 2015}
1770 2016
2017=item $maps = cf::map::tmp_maps
2018
2019Returns an arrayref with all map paths of currently instantiated and saved
2020maps. May block.
2021
2022=cut
2023
2024sub tmp_maps() {
2025 [
2026 map {
2027 utf8::decode $_;
2028 /\.map$/
2029 ? normalise $_
2030 : ()
2031 } @{ aio_readdir $TMPDIR or [] }
2032 ]
2033}
2034
2035=item $maps = cf::map::random_maps
2036
2037Returns an arrayref with all map paths of currently instantiated and saved
2038random maps. May block.
2039
2040=cut
2041
2042sub random_maps() {
2043 [
2044 map {
2045 utf8::decode $_;
2046 /\.map$/
2047 ? normalise "?random/$_"
2048 : ()
2049 } @{ aio_readdir $RANDOMDIR or [] }
2050 ]
2051}
2052
1771=item cf::map::unique_maps 2053=item cf::map::unique_maps
1772 2054
1773Returns an arrayref of paths of all shared maps that have 2055Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2056instantiated unique items. May block.
1775 2057
1776=cut 2058=cut
1777 2059
1778sub unique_maps() { 2060sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2061 [
1780 or return; 2062 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2063 utf8::decode $_;
1786 next if /\.pst$/; 2064 /\.map$/
1787 next unless /^$PATH_SEP/o; 2065 ? normalise $_
1788 2066 : ()
1789 push @paths, cf::map::normalise $_; 2067 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2068 ]
1791
1792 \@paths
1793} 2069}
1794 2070
1795package cf; 2071package cf;
1796 2072
1797=back 2073=back
1843 2119
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2120 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2121
1846 if ($self->{record_replies}) { 2122 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2123 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2124
1848 } else { 2125 } else {
2126 my $pl = $self->contr;
2127
2128 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2129 my $diag = $pl->{npc_dialog};
2130 $diag->{pl}->ext_reply (
2131 $diag->{id},
2132 msgtype => "reply",
2133 msg => $diag->{pl}->expand_cfpod ($msg),
2134 add_topics => []
2135 );
2136
2137 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2138 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2139 $self->message ($msg, $flags);
2140 }
1851 } 2141 }
1852} 2142}
1853 2143
1854=item $player_object->may ("access") 2144=item $player_object->may ("access")
1855 2145
2100 2390
2101 utf8::encode $text; 2391 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2392 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2393}
2104 2394
2395=item $client->send_msg ($color, $type, $msg, [extra...])
2396
2397Send a drawinfo or msg packet to the client, formatting the msg for the
2398client if neccessary. C<$type> should be a string identifying the type of
2399the message, with C<log> being the default. If C<$color> is negative, suppress
2400the message unless the client supports the msg packet.
2401
2402=cut
2403
2404sub cf::client::send_msg {
2405 my ($self, $color, $type, $msg, @extra) = @_;
2406
2407 $msg = $self->pl->expand_cfpod ($msg);
2408
2409 if ($self->can_msg) {
2410 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2411 } else {
2412 # replace some tags by gcfclient-compatible ones
2413 for ($msg) {
2414 1 while
2415 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2416 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2417 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2418 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2419 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2420 }
2421
2422 if ($color >= 0) {
2423 if (0 && $msg =~ /\[/) {
2424 $self->send_packet ("drawextinfo $color 4 0 $msg")
2425 } else {
2426 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2427 $self->send_packet ("drawinfo $color $msg")
2428 }
2429 }
2430 }
2431}
2432
2105=item $client->ext_event ($type, %msg) 2433=item $client->ext_event ($type, %msg)
2106 2434
2107Sends an exti event to the client. 2435Sends an ext event to the client.
2108 2436
2109=cut 2437=cut
2110 2438
2111sub cf::client::ext_event($$%) { 2439sub cf::client::ext_event($$%) {
2112 my ($self, $type, %msg) = @_; 2440 my ($self, $type, %msg) = @_;
2113 2441
2114 $msg{msgtype} = "event_$type"; 2442 $msg{msgtype} = "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2443 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2116} 2444}
2117 2445
2118=item $success = $client->query ($flags, "text", \&cb) 2446=item $success = $client->query ($flags, "text", \&cb)
2119 2447
2120Queues a query to the client, calling the given callback with 2448Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2449the 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>. 2450C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2451
2124Queries can fail, so check the return code. Or don't, as queries will become 2452Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2453become reliable at some point in the future.
2126 2454
2127=cut 2455=cut
2128 2456
2129sub cf::client::query { 2457sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2458 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2466 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2467 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2468
2141 $self->send_packet ($self->{query_queue}[0][0]) 2469 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2470 if @{ $self->{query_queue} } == 1;
2471
2472 1
2143} 2473}
2144 2474
2145cf::client->attach ( 2475cf::client->attach (
2476 on_connect => sub {
2477 my ($ns) = @_;
2478
2479 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2480 },
2146 on_reply => sub { 2481 on_reply => sub {
2147 my ($ns, $msg) = @_; 2482 my ($ns, $msg) = @_;
2148 2483
2149 # this weird shuffling is so that direct followup queries 2484 # this weird shuffling is so that direct followup queries
2150 # get handled first 2485 # get handled first
2161 $ns->send_packet ($ns->{query_queue}[0][0]); 2496 $ns->send_packet ($ns->{query_queue}[0][0]);
2162 } else { 2497 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2498 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2499 }
2165 } 2500 }
2501 },
2502 on_exticmd => sub {
2503 my ($ns, $buf) = @_;
2504
2505 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2506
2507 if (ref $msg) {
2508 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2509 if (my %reply = $cb->($ns, $msg)) {
2510 $reply{msgid} = $msg->{msgid};
2511 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2512 }
2513 }
2514 } else {
2515 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2516 }
2517
2518 cf::override;
2166 }, 2519 },
2167); 2520);
2168 2521
2169=item $client->async (\&cb) 2522=item $client->async (\&cb)
2170 2523
2309=back 2662=back
2310 2663
2311=cut 2664=cut
2312 2665
2313############################################################################# 2666#############################################################################
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
2485#############################################################################
2486# the server's init and main functions 2667# the server's init and main functions
2487 2668
2488sub load_facedata($) { 2669sub load_facedata($) {
2489 my ($path) = @_; 2670 my ($path) = @_;
2490 2671
2548} 2729}
2549 2730
2550sub reload_archetypes { 2731sub reload_archetypes {
2551 load_resource_file "$DATADIR/archetypes" 2732 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2733 or die "unable to load archetypes\n";
2734 #d# NEED to laod twice to resolve forward references
2735 # this really needs to be done in an extra post-pass
2736 # (which needs to be synchronous, so solve it differently)
2737 load_resource_file "$DATADIR/archetypes"
2738 or die "unable to load archetypes\n";
2553} 2739}
2554 2740
2555sub reload_treasures { 2741sub reload_treasures {
2556 load_resource_file "$DATADIR/treasures" 2742 load_resource_file "$DATADIR/treasures"
2557 or die "unable to load treasurelists\n"; 2743 or die "unable to load treasurelists\n";
2560sub reload_resources { 2746sub reload_resources {
2561 warn "reloading resource files...\n"; 2747 warn "reloading resource files...\n";
2562 2748
2563 reload_regions; 2749 reload_regions;
2564 reload_facedata; 2750 reload_facedata;
2751 #reload_archetypes;#d#
2565 reload_archetypes; 2752 reload_archetypes;
2566 reload_treasures; 2753 reload_treasures;
2567 2754
2568 warn "finished reloading resource files\n"; 2755 warn "finished reloading resource files\n";
2569} 2756}
2626 }, 2813 },
2627 ); 2814 );
2628 } 2815 }
2629} 2816}
2630 2817
2818sub write_runtime {
2819 my $runtime = "$LOCALDIR/runtime";
2820
2821 # first touch the runtime file to show we are still running:
2822 # the fsync below can take a very very long time.
2823
2824 IO::AIO::aio_utime $runtime, undef, undef;
2825
2826 my $guard = cf::lock_acquire "write_runtime";
2827
2828 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2829 or return;
2830
2831 my $value = $cf::RUNTIME + 90 + 10;
2832 # 10 is the runtime save interval, for a monotonic clock
2833 # 60 allows for the watchdog to kill the server.
2834
2835 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2836 and return;
2837
2838 # always fsync - this file is important
2839 aio_fsync $fh
2840 and return;
2841
2842 # touch it again to show we are up-to-date
2843 aio_utime $fh, undef, undef;
2844
2845 close $fh
2846 or return;
2847
2848 aio_rename "$runtime~", $runtime
2849 and return;
2850
2851 warn "runtime file written.\n";
2852
2853 1
2854}
2855
2631sub emergency_save() { 2856sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop; 2857 my $freeze_guard = cf::freeze_mainloop;
2633 2858
2634 warn "enter emergency perl save\n"; 2859 warn "enter emergency perl save\n";
2635 2860
2710 %EXT_CORO = (); 2935 %EXT_CORO = ();
2711 2936
2712 warn "removing commands"; 2937 warn "removing commands";
2713 %COMMAND = (); 2938 %COMMAND = ();
2714 2939
2715 warn "removing ext commands"; 2940 warn "removing ext/exti commands";
2716 %EXTCMD = (); 2941 %EXTCMD = ();
2942 %EXTICMD = ();
2717 2943
2718 warn "unloading/nuking all extensions"; 2944 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) { 2945 for my $pkg (@EXTS) {
2720 warn "... unloading $pkg"; 2946 warn "... unloading $pkg";
2721 2947

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines