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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines