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.271 by root, Fri Jun 1 06:04:08 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;
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 189@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 190@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 191@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 192@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 193@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
194@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 195@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193 196
194# we bless all objects into (empty) derived classes to force a method lookup 197# we bless all objects into (empty) derived classes to force a method lookup
195# within the Safe compartment. 198# within the Safe compartment.
196for my $pkg (qw( 199for my $pkg (qw(
197 cf::global cf::attachable 200 cf::global cf::attachable
205} 208}
206 209
207$Event::DIED = sub { 210$Event::DIED = sub {
208 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
209}; 212};
213
214#############################################################################
210 215
211=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
212 217
213=over 4 218=over 4
214 219
233 $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;
234 $d 239 $d
235 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
236} 241}
237 242
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
241 244
242Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
243 246
244=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
245 248
246Converts 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]) }
247 257
248=item cf::lock_wait $string 258=item cf::lock_wait $string
249 259
250Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
251 261
317 327
318BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
319 329
320=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
321 331
322The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323always able to handle events or runnable, as crossfire+ is only partly 333is always able to handle events or runnable, as Crossfire TRT is only
324reentrant. 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.
325 336
326If 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
327the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
328server 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
329fast or be very important. 340fast or be very important.
389 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
390 401
391 $coro 402 $coro
392} 403}
393 404
394sub write_runtime { 405=item fork_call { }, $args
395 my $runtime = "$LOCALDIR/runtime";
396 406
397 # first touch the runtime file to show we are still running: 407Executes the given code block with the given arguments in a seperate
398 # 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.
399 411
400 IO::AIO::aio_utime $runtime, undef, undef; 412=cut
401 413
402 my $guard = cf::lock_acquire "write_runtime"; 414sub fork_call(&@) {
415 my ($cb, @args) = @_;
403 416
404 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
405 or return; 418# or die "socketpair: $!";
419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
406 421
407 my $value = $cf::RUNTIME + 90 + 10; 422 if (my $pid = fork) {
408 # 10 is the runtime save interval, for a monotonic clock
409 # 60 allows for the watchdog to kill the server.
410
411 (aio_write $fh, 0, (length $value), $value, 0) <= 0
412 and return;
413
414 # always fsync - this file is important
415 aio_fsync $fh
416 and return;
417
418 # touch it again to show we are up-to-date
419 aio_utime $fh, undef, undef;
420
421 close $fh 423 close $fh2;
422 or return;
423 424
424 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
425 and return; 426 warn "pst<$res>" unless $res =~ /^pst/;
427 $res = Coro::Storable::thaw $res;
426 428
427 warn "runtime file written.\n";#d# 429 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
428 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;
429 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"
430} 576}
431 577
432=item cf::datalog type => key => value, ... 578=item cf::datalog type => key => value, ...
433 579
434Log 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.
452attach callbacks/event handlers (a collection of which is called an "attachment") 598attach callbacks/event handlers (a collection of which is called an "attachment")
453to it. All such attachable objects support the following methods. 599to it. All such attachable objects support the following methods.
454 600
455In 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>
456C<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
457crossfire+). 603Crossfire TRT).
458 604
459=over 4 605=over 4
460 606
461=item $attachable->attach ($attachment, key => $value...) 607=item $attachable->attach ($attachment, key => $value...)
462 608
664 _attach $registry, $klass, @attach; 810 _attach $registry, $klass, @attach;
665 } 811 }
666 812
667 $obj->{$name} = \%arg; 813 $obj->{$name} = \%arg;
668 } else { 814 } else {
669 warn "object uses attachment '$name' that is not available, postponing.\n"; 815 warn "object uses attachment '$name' which is not available, postponing.\n";
670 } 816 }
671 817
672 $obj->{_attachment}{$name} = undef; 818 $obj->{_attachment}{$name} = undef;
673} 819}
674 820
872 or return; 1018 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1019 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1020 }
875 1021
876 warn sprintf "loading %s (%d)\n", 1022 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1023 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1024 return ($data, $av);
879} 1025}
1026
1027=head2 COMMAND CALLBACKS
1028
1029=over 4
1030
1031=cut
880 1032
881############################################################################# 1033#############################################################################
882# command handling &c 1034# command handling &c
883 1035
884=item cf::register_command $name => \&callback($ob,$args); 1036=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1049 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1050}
899 1051
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1052=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1053
902Register 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.
903 1059
904If 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
905called. 1061called.
906 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
907=cut 1074=cut
908 1075
909sub register_extcmd { 1076sub register_extcmd {
910 my ($name, $cb) = @_; 1077 my ($name, $cb) = @_;
911 1078
912 $EXTCMD{$name} = $cb; 1079 $EXTCMD{$name} = $cb;
1080}
1081
1082sub register_exticmd {
1083 my ($name, $cb) = @_;
1084
1085 $EXTICMD{$name} = $cb;
913} 1086}
914 1087
915cf::player->attach ( 1088cf::player->attach (
916 on_command => sub { 1089 on_command => sub {
917 my ($pl, $name, $params) = @_; 1090 my ($pl, $name, $params) = @_;
926 cf::override; 1099 cf::override;
927 }, 1100 },
928 on_extcmd => sub { 1101 on_extcmd => sub {
929 my ($pl, $buf) = @_; 1102 my ($pl, $buf) = @_;
930 1103
931 my $msg = eval { from_json $buf }; 1104 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932 1105
933 if (ref $msg) { 1106 if (ref $msg) {
934 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1107 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935 if (my %reply = $cb->($pl, $msg)) { 1108 if (my %reply = $cb->($pl, $msg)) {
936 $pl->ext_reply ($msg->{msgid}, %reply); 1109 $pl->ext_reply ($msg->{msgid}, %reply);
942 1115
943 cf::override; 1116 cf::override;
944 }, 1117 },
945); 1118);
946 1119
947sub load_extension {
948 my ($path) = @_;
949
950 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
951 my $base = $1;
952 my $pkg = $1;
953 $pkg =~ s/[^[:word:]]/_/g;
954 $pkg = "ext::$pkg";
955
956 warn "... loading '$path' into '$pkg'\n";
957
958 open my $fh, "<:utf8", $path
959 or die "$path: $!";
960
961 my $source =
962 "package $pkg; use strict; use utf8;\n"
963 . "#line 1 \"$path\"\n{\n"
964 . (do { local $/; <$fh> })
965 . "\n};\n1";
966
967 unless (eval $source) {
968 my $msg = $@ ? "$path: $@\n"
969 : "extension disabled.\n";
970 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
971 warn $@;
972 warn "mandatory extension failed to load, exiting.\n";
973 exit 1;
974 }
975 die $@;
976 }
977
978 push @EXTS, $pkg;
979}
980
981sub load_extensions { 1120sub load_extensions {
1121 cf::sync_job {
1122 my %todo;
1123
982 for my $ext (<$LIBDIR/*.ext>) { 1124 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1125 next unless -r $path;
984 eval { 1126
985 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;
986 1 1184 }
987 } or warn "$ext not loaded: $@"; 1185
1186 skip:
1187 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1188 unless $progress;
1189 }
988 } 1190 };
989} 1191}
990 1192
991############################################################################# 1193#############################################################################
1194
1195=back
992 1196
993=head2 CORE EXTENSIONS 1197=head2 CORE EXTENSIONS
994 1198
995Functions and methods that extend core crossfire objects. 1199Functions and methods that extend core crossfire objects.
996 1200
1184 } 1388 }
1185 1389
1186 \@paths 1390 \@paths
1187} 1391}
1188 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
1189=item $player->ext_reply ($msgid, %msg) 1443=item $player->ext_reply ($msgid, %msg)
1190 1444
1191Sends an ext reply to the player. 1445Sends an ext reply to the player.
1192 1446
1193=cut 1447=cut
1194 1448
1195sub ext_reply($$%) { 1449sub ext_reply($$%) {
1196 my ($self, $id, %msg) = @_; 1450 my ($self, $id, %msg) = @_;
1197 1451
1198 $msg{msgid} = $id; 1452 $msg{msgid} = $id;
1199 1453 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200 $self->send ("ext " . cf::to_json \%msg);
1201} 1454}
1202 1455
1203=item $player->ext_event ($type, %msg) 1456=item $player->ext_event ($type, %msg)
1204 1457
1205Sends an ext event to the client. 1458Sends an ext event to the client.
1220 1473
1221package cf::region; 1474package cf::region;
1222 1475
1223=item cf::region::find_by_path $path 1476=item cf::region::find_by_path $path
1224 1477
1225Tries 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.
1226 1479
1227=cut 1480=cut
1228 1481
1229sub find_by_path($) { 1482sub find_by_path($) {
1230 my ($path) = @_; 1483 my ($path) = @_;
1304 my ($self, $merge) = @_; 1557 my ($self, $merge) = @_;
1305 1558
1306 # we have to keep some variables in memory intact 1559 # we have to keep some variables in memory intact
1307 local $self->{path}; 1560 local $self->{path};
1308 local $self->{load_path}; 1561 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1562
1312 $self->SUPER::thawer_merge ($merge); 1563 $self->SUPER::thawer_merge ($merge);
1313} 1564}
1314 1565
1315sub normalise { 1566sub normalise {
1415 1666
1416 $_->change_map_light ($change) 1667 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1668 for grep $_->outdoor, values %cf::MAP;
1418} 1669}
1419 1670
1671sub decay_objects {
1672 my ($self) = @_;
1673
1674 return if $self->{deny_reset};
1675
1676 $self->do_decay_objects;
1677}
1678
1420sub unlink_save { 1679sub unlink_save {
1421 my ($self) = @_; 1680 my ($self) = @_;
1422 1681
1423 utf8::encode (my $save = $self->save_path); 1682 utf8::encode (my $save = $self->save_path);
1424 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1683 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1480 $self->load_header_orig 1739 $self->load_header_orig
1481 or return; 1740 or return;
1482 $self->prepare_orig; 1741 $self->prepare_orig;
1483 } 1742 }
1484 1743
1744 $self->{deny_reset} = 1
1745 if $self->no_reset;
1746
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1747 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1748 unless $self->default_region;
1487 1749
1488 1 1750 1
1489} 1751}
1504 $map->{last_save} = $cf::RUNTIME; 1766 $map->{last_save} = $cf::RUNTIME;
1505 1767
1506 $map->load_header 1768 $map->load_header
1507 or return; 1769 or return;
1508 1770
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1771 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1772 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1773 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1774 $map->reset;
1513 undef $guard; 1775 undef $guard;
1514 return find $path; 1776 return find $path;
1581 my ($self, $ob) = @_; 1843 my ($self, $ob) = @_;
1582 1844
1583 return find "~" . $ob->name . "/" . $self->{path} 1845 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1846 if $self->per_player;
1585 1847
1848# return find "?party/" . $ob->name . "/" . $self->{path}
1849# if $self->per_party;
1850
1586 $self 1851 $self
1587} 1852}
1588 1853
1589# 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
1590sub load_diag { 1855sub load_diag {
1700 1965
1701sub reset_at { 1966sub reset_at {
1702 my ($self) = @_; 1967 my ($self) = @_;
1703 1968
1704 # TODO: safety, remove and allow resettable per-player maps 1969 # TODO: safety, remove and allow resettable per-player maps
1705 return 1e99 if $self->isa ("ext::map_per_player");#d#
1706 return 1e99 if $self->{deny_reset}; 1970 return 1e99 if $self->{deny_reset};
1707 1971
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1972 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 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;
1710 1974
1721 my ($self) = @_; 1985 my ($self) = @_;
1722 1986
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1987 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 1988
1725 return if $self->players; 1989 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 1990
1728 warn "resetting map ", $self->path;#d# 1991 warn "resetting map ", $self->path;
1729 1992
1730 $self->in_memory (cf::MAP_SWAPPED); 1993 $self->in_memory (cf::MAP_SWAPPED);
1731 1994
1732 # need to save uniques path 1995 # need to save uniques path
1733 unless ($self->{deny_save}) { 1996 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2028 $cf::MAP{$self->path} = $self;
1766 2029
1767 $self->reset; # polite request, might not happen 2030 $self->reset; # polite request, might not happen
1768} 2031}
1769 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
1770=item cf::map::unique_maps 2069=item cf::map::unique_maps
1771 2070
1772Returns an arrayref of paths of all shared maps that have 2071Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2072instantiated unique items. May block.
1774 2073
1775=cut 2074=cut
1776 2075
1777sub unique_maps() { 2076sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2077 [
1779 or return; 2078 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2079 utf8::decode $_;
1785 next if /\.pst$/; 2080 /\.map$/
1786 next unless /^$PATH_SEP/o; 2081 ? normalise $_
1787 2082 : ()
1788 push @paths, cf::map::normalise $_; 2083 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2084 ]
1790
1791 \@paths
1792} 2085}
1793 2086
1794package cf; 2087package cf;
1795 2088
1796=back 2089=back
1842 2135
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2136 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2137
1845 if ($self->{record_replies}) { 2138 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2139 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2140
1847 } 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 {
1848 $msg = $npc->name . " says: $msg" if $npc; 2154 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2155 $self->message ($msg, $flags);
2156 }
1850 } 2157 }
1851} 2158}
1852 2159
1853=item $player_object->may ("access") 2160=item $player_object->may ("access")
1854 2161
2063 my $hp = $exit->stats->hp; 2370 my $hp = $exit->stats->hp;
2064 my $sp = $exit->stats->sp; 2371 my $sp = $exit->stats->sp;
2065 2372
2066 $self->enter_link; 2373 $self->enter_link;
2067 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
2068 (async { 2379 (async {
2069 $self->deactivate_recursive; # just to be sure 2380 $self->deactivate_recursive; # just to be sure
2070 unless (eval { 2381 unless (eval {
2071 $self->goto ($slaying, $hp, $sp); 2382 $self->goto ($slaying, $hp, $sp);
2072 2383
2099 2410
2100 utf8::encode $text; 2411 utf8::encode $text;
2101 $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);
2102} 2413}
2103 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
2104=item $client->ext_event ($type, %msg) 2455=item $client->ext_event ($type, %msg)
2105 2456
2106Sends an exti event to the client. 2457Sends an ext event to the client.
2107 2458
2108=cut 2459=cut
2109 2460
2110sub cf::client::ext_event($$%) { 2461sub cf::client::ext_event($$%) {
2111 my ($self, $type, %msg) = @_; 2462 my ($self, $type, %msg) = @_;
2112 2463
2113 $msg{msgtype} = "event_$type"; 2464 $msg{msgtype} = "event_$type";
2114 $self->send_packet ("ext " . cf::to_json \%msg); 2465 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2115} 2466}
2116 2467
2117=item $success = $client->query ($flags, "text", \&cb) 2468=item $success = $client->query ($flags, "text", \&cb)
2118 2469
2119Queues a query to the client, calling the given callback with 2470Queues a query to the client, calling the given callback with
2120the 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>,
2121C<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>.
2122 2473
2123Queries 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
2124reliable at some point in the future. 2475become reliable at some point in the future.
2125 2476
2126=cut 2477=cut
2127 2478
2128sub cf::client::query { 2479sub cf::client::query {
2129 my ($self, $flags, $text, $cb) = @_; 2480 my ($self, $flags, $text, $cb) = @_;
2137 utf8::encode $text; 2488 utf8::encode $text;
2138 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2489 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139 2490
2140 $self->send_packet ($self->{query_queue}[0][0]) 2491 $self->send_packet ($self->{query_queue}[0][0])
2141 if @{ $self->{query_queue} } == 1; 2492 if @{ $self->{query_queue} } == 1;
2493
2494 1
2142} 2495}
2143 2496
2144cf::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 },
2145 on_reply => sub { 2503 on_reply => sub {
2146 my ($ns, $msg) = @_; 2504 my ($ns, $msg) = @_;
2147 2505
2148 # this weird shuffling is so that direct followup queries 2506 # this weird shuffling is so that direct followup queries
2149 # get handled first 2507 # get handled first
2161 } else { 2519 } else {
2162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2520 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163 } 2521 }
2164 } 2522 }
2165 }, 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 },
2166); 2542);
2167 2543
2168=item $client->async (\&cb) 2544=item $client->async (\&cb)
2169 2545
2170Create a new coroutine, running the specified callback. The coroutine will 2546Create a new coroutine, running the specified callback. The coroutine will
2219 2595
2220=pod 2596=pod
2221 2597
2222The following functions and methods are available within a safe environment: 2598The following functions and methods are available within a safe environment:
2223 2599
2224 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
2225 cf::object::player player 2604 cf::object::player
2226 cf::player peaceful 2605 player
2227 cf::map trigger 2606
2607 cf::player
2608 peaceful
2609
2610 cf::map
2611 trigger
2228 2612
2229=cut 2613=cut
2230 2614
2231for ( 2615for (
2232 ["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)],
2233 ["cf::object::player" => qw(player)], 2618 ["cf::object::player" => qw(player)],
2234 ["cf::player" => qw(peaceful)], 2619 ["cf::player" => qw(peaceful)],
2235 ["cf::map" => qw(trigger)], 2620 ["cf::map" => qw(trigger)],
2236) { 2621) {
2237 no strict 'refs'; 2622 no strict 'refs';
2306} 2691}
2307 2692
2308=back 2693=back
2309 2694
2310=cut 2695=cut
2311
2312#############################################################################
2313
2314=head2 EXTENSION DATABASE SUPPORT
2315
2316Crossfire maintains a very simple database for extension use. It can
2317currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2318convert to/from binary).
2319
2320The parameter C<$family> should best start with the name of the extension
2321using it, it should be unique.
2322
2323=over 4
2324
2325=item $value = cf::db_get $family => $key
2326
2327Returns a single value from the database.
2328
2329=item cf::db_put $family => $key => $value
2330
2331Stores the given C<$value> in the family.
2332
2333=cut
2334
2335our $DB;
2336
2337sub db_init {
2338 unless ($DB) {
2339 $DB = BDB::db_create $DB_ENV;
2340
2341 cf::sync_job {
2342 eval {
2343 $DB->set_flags (BDB::CHKSUM);
2344
2345 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2346 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2347 cf::cleanup "db_open(db): $!" if $!;
2348 };
2349 cf::cleanup "db_open(db): $@" if $@;
2350 };
2351 }
2352}
2353
2354sub db_get($$) {
2355 my $key = "$_[0]/$_[1]";
2356
2357 cf::sync_job {
2358 BDB::db_get $DB, undef, $key, my $data;
2359
2360 $! ? ()
2361 : $data
2362 }
2363}
2364
2365sub db_put($$$) {
2366 BDB::dbreq_pri 4;
2367 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2368}
2369
2370=item cf::cache $id => [$paths...], $processversion => $process
2371
2372Generic caching function that returns the value of the resource $id,
2373caching and regenerating as required.
2374
2375This function can block.
2376
2377=cut
2378
2379sub cache {
2380 my ($id, $src, $processversion, $process) = @_;
2381
2382 my $meta =
2383 join "\x00",
2384 $processversion,
2385 map {
2386 aio_stat $_
2387 and Carp::croak "$_: $!";
2388
2389 ($_, (stat _)[7,9])
2390 } @$src;
2391
2392 my $dbmeta = db_get cache => "$id/meta";
2393 if ($dbmeta ne $meta) {
2394 # changed, we may need to process
2395
2396 my @data;
2397 my $md5;
2398
2399 for (0 .. $#$src) {
2400 0 <= aio_load $src->[$_], $data[$_]
2401 or Carp::croak "$src->[$_]: $!";
2402 }
2403
2404 # if processing is expensive, check
2405 # checksum first
2406 if (1) {
2407 $md5 =
2408 join "\x00",
2409 $processversion,
2410 map {
2411 Coro::cede;
2412 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2413 } 0.. $#$src;
2414
2415
2416 my $dbmd5 = db_get cache => "$id/md5";
2417 if ($dbmd5 eq $md5) {
2418 db_put cache => "$id/meta", $meta;
2419
2420 return db_get cache => "$id/data";
2421 }
2422 }
2423
2424 my $t1 = Time::HiRes::time;
2425 my $data = $process->(\@data);
2426 my $t2 = Time::HiRes::time;
2427
2428 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2429
2430 db_put cache => "$id/data", $data;
2431 db_put cache => "$id/md5" , $md5;
2432 db_put cache => "$id/meta", $meta;
2433
2434 return $data;
2435 }
2436
2437 db_get cache => "$id/data"
2438}
2439
2440=item fork_call { }, $args
2441
2442Executes the given code block with the given arguments in a seperate
2443process, returning the results. Everything must be serialisable with
2444Coro::Storable. May, of course, block. Note that the executed sub may
2445never block itself or use any form of Event handling.
2446
2447=cut
2448
2449sub fork_call(&@) {
2450 my ($cb, @args) = @_;
2451
2452# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2453# or die "socketpair: $!";
2454 pipe my $fh1, my $fh2
2455 or die "pipe: $!";
2456
2457 if (my $pid = fork) {
2458 close $fh2;
2459
2460 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2461 $res = Coro::Storable::thaw $res;
2462
2463 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2464
2465 die $$res unless "ARRAY" eq ref $res;
2466
2467 return wantarray ? @$res : $res->[-1];
2468 } else {
2469 reset_signals;
2470 local $SIG{__WARN__};
2471 local $SIG{__DIE__};
2472 eval {
2473 close $fh1;
2474
2475 my @res = eval { $cb->(@args) };
2476 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2477 };
2478
2479 warn $@ if $@;
2480 _exit 0;
2481 }
2482}
2483 2696
2484############################################################################# 2697#############################################################################
2485# the server's init and main functions 2698# the server's init and main functions
2486 2699
2487sub load_facedata($) { 2700sub load_facedata($) {
2547} 2760}
2548 2761
2549sub reload_archetypes { 2762sub reload_archetypes {
2550 load_resource_file "$DATADIR/archetypes" 2763 load_resource_file "$DATADIR/archetypes"
2551 or die "unable to load archetypes\n"; 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)
2768 load_resource_file "$DATADIR/archetypes"
2769 or die "unable to load archetypes\n";
2552} 2770}
2553 2771
2554sub reload_treasures { 2772sub reload_treasures {
2555 load_resource_file "$DATADIR/treasures" 2773 load_resource_file "$DATADIR/treasures"
2556 or die "unable to load treasurelists\n"; 2774 or die "unable to load treasurelists\n";
2559sub reload_resources { 2777sub reload_resources {
2560 warn "reloading resource files...\n"; 2778 warn "reloading resource files...\n";
2561 2779
2562 reload_regions; 2780 reload_regions;
2563 reload_facedata; 2781 reload_facedata;
2782 #reload_archetypes;#d#
2564 reload_archetypes; 2783 reload_archetypes;
2565 reload_treasures; 2784 reload_treasures;
2566 2785
2567 warn "finished reloading resource files\n"; 2786 warn "finished reloading resource files\n";
2568} 2787}
2625 }, 2844 },
2626 ); 2845 );
2627 } 2846 }
2628} 2847}
2629 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
2630sub emergency_save() { 2887sub emergency_save() {
2631 my $freeze_guard = cf::freeze_mainloop; 2888 my $freeze_guard = cf::freeze_mainloop;
2632 2889
2633 warn "enter emergency perl save\n"; 2890 warn "enter emergency perl save\n";
2634 2891
2709 %EXT_CORO = (); 2966 %EXT_CORO = ();
2710 2967
2711 warn "removing commands"; 2968 warn "removing commands";
2712 %COMMAND = (); 2969 %COMMAND = ();
2713 2970
2714 warn "removing ext commands"; 2971 warn "removing ext/exti commands";
2715 %EXTCMD = (); 2972 %EXTCMD = ();
2973 %EXTICMD = ();
2716 2974
2717 warn "unloading/nuking all extensions"; 2975 warn "unloading/nuking all extensions";
2718 for my $pkg (@EXTS) { 2976 for my $pkg (@EXTS) {
2719 warn "... unloading $pkg"; 2977 warn "... unloading $pkg";
2720 2978

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines