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.299 by root, Sun Jul 8 14:56:05 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
49our %COMMAND = (); 50our %COMMAND = ();
50our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
51 52
52our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
56 58
57our $RELOAD; # number of reloads so far 59our $RELOAD; # number of reloads so far
58our @EVENT; 60our @EVENT;
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 _store_scalar {
403 415 open my $fh, ">", \my $buf
404 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 416 or die "fork_call: cannot open fh-to-buf in child : $!";
405 or return; 417 Storable::store_fd $_[0], $fh;
406
407 my $value = $cf::RUNTIME + 90 + 10;
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 418 close $fh;
422 or return;
423 419
424 aio_rename "$runtime~", $runtime 420 $buf
425 and return; 421}
426 422
427 warn "runtime file written.\n";#d# 423sub fork_call(&@) {
424 my ($cb, @args) = @_;
428 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;
429 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"
430} 581}
431 582
432=item cf::datalog type => key => value, ... 583=item cf::datalog type => key => value, ...
433 584
434Log 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.
452attach callbacks/event handlers (a collection of which is called an "attachment") 603attach callbacks/event handlers (a collection of which is called an "attachment")
453to it. All such attachable objects support the following methods. 604to it. All such attachable objects support the following methods.
454 605
455In 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>
456C<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
457crossfire+). 608Crossfire TRT).
458 609
459=over 4 610=over 4
460 611
461=item $attachable->attach ($attachment, key => $value...) 612=item $attachable->attach ($attachment, key => $value...)
462 613
664 _attach $registry, $klass, @attach; 815 _attach $registry, $klass, @attach;
665 } 816 }
666 817
667 $obj->{$name} = \%arg; 818 $obj->{$name} = \%arg;
668 } else { 819 } else {
669 warn "object uses attachment '$name' that is not available, postponing.\n"; 820 warn "object uses attachment '$name' which is not available, postponing.\n";
670 } 821 }
671 822
672 $obj->{_attachment}{$name} = undef; 823 $obj->{_attachment}{$name} = undef;
673} 824}
674 825
872 or return; 1023 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1024 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1025 }
875 1026
876 warn sprintf "loading %s (%d)\n", 1027 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1028 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1029 return ($data, $av);
879} 1030}
1031
1032=head2 COMMAND CALLBACKS
1033
1034=over 4
1035
1036=cut
880 1037
881############################################################################# 1038#############################################################################
882# command handling &c 1039# command handling &c
883 1040
884=item cf::register_command $name => \&callback($ob,$args); 1041=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1054 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1055}
899 1056
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1057=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1058
902Register 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.
903 1064
904If 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
905called. 1066called.
906 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
907=cut 1079=cut
908 1080
909sub register_extcmd { 1081sub register_extcmd {
910 my ($name, $cb) = @_; 1082 my ($name, $cb) = @_;
911 1083
912 $EXTCMD{$name} = $cb; 1084 $EXTCMD{$name} = $cb;
1085}
1086
1087sub register_exticmd {
1088 my ($name, $cb) = @_;
1089
1090 $EXTICMD{$name} = $cb;
913} 1091}
914 1092
915cf::player->attach ( 1093cf::player->attach (
916 on_command => sub { 1094 on_command => sub {
917 my ($pl, $name, $params) = @_; 1095 my ($pl, $name, $params) = @_;
926 cf::override; 1104 cf::override;
927 }, 1105 },
928 on_extcmd => sub { 1106 on_extcmd => sub {
929 my ($pl, $buf) = @_; 1107 my ($pl, $buf) = @_;
930 1108
931 my $msg = eval { from_json $buf }; 1109 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932 1110
933 if (ref $msg) { 1111 if (ref $msg) {
934 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1112 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935 if (my %reply = $cb->($pl, $msg)) { 1113 if (my %reply = $cb->($pl, $msg)) {
936 $pl->ext_reply ($msg->{msgid}, %reply); 1114 $pl->ext_reply ($msg->{msgid}, %reply);
942 1120
943 cf::override; 1121 cf::override;
944 }, 1122 },
945); 1123);
946 1124
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 { 1125sub load_extensions {
1126 cf::sync_job {
1127 my %todo;
1128
982 for my $ext (<$LIBDIR/*.ext>) { 1129 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1130 next unless -r $path;
984 eval { 1131
985 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;
986 1 1189 }
987 } or warn "$ext not loaded: $@"; 1190
1191 skip:
1192 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1193 unless $progress;
1194 }
988 } 1195 };
989} 1196}
990 1197
991############################################################################# 1198#############################################################################
1199
1200=back
992 1201
993=head2 CORE EXTENSIONS 1202=head2 CORE EXTENSIONS
994 1203
995Functions and methods that extend core crossfire objects. 1204Functions and methods that extend core crossfire objects.
996 1205
1184 } 1393 }
1185 1394
1186 \@paths 1395 \@paths
1187} 1396}
1188 1397
1398=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1399
1400Expand crossfire pod fragments into protocol xml.
1401
1402=cut
1403
1404sub expand_cfpod {
1405 ((my $self), (local $_)) = @_;
1406
1407 # escape & and <
1408 s/&/&amp;/g;
1409 s/(?<![BIUGH])</&lt;/g;
1410
1411 # this is buggy, it needs to properly take care of nested <'s
1412
1413 1 while
1414 # replace B<>, I<>, U<> etc.
1415 s/B<([^\>]*)>/<b>$1<\/b>/
1416 || s/I<([^\>]*)>/<i>$1<\/i>/
1417 || s/U<([^\>]*)>/<u>$1<\/u>/
1418 # replace G<male|female> tags
1419 || s{G<([^>|]*)\|([^>]*)>}{
1420 $self->gender ? $2 : $1
1421 }ge
1422 # replace H<hint text>
1423 || s{H<([^\>]*)>}
1424 {
1425 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1426 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1427 "")
1428 [$self->{hintmode}]
1429 }ge;
1430
1431 # create single paragraphs (very hackish)
1432 s/(?<=\S)\n(?=\w)/ /g;
1433
1434 # compress some whitespace
1435 s/\s+\n/\n/g; # ws line-ends
1436 s/\n\n+/\n/g; # double lines
1437 s/^\n+//; # beginning lines
1438 s/\n+$//; # ending lines
1439
1440 $_
1441}
1442
1443sub hintmode {
1444 $_[0]{hintmode} = $_[1] if @_ > 1;
1445 $_[0]{hintmode}
1446}
1447
1189=item $player->ext_reply ($msgid, %msg) 1448=item $player->ext_reply ($msgid, %msg)
1190 1449
1191Sends an ext reply to the player. 1450Sends an ext reply to the player.
1192 1451
1193=cut 1452=cut
1194 1453
1195sub ext_reply($$%) { 1454sub ext_reply($$%) {
1196 my ($self, $id, %msg) = @_; 1455 my ($self, $id, %msg) = @_;
1197 1456
1198 $msg{msgid} = $id; 1457 $msg{msgid} = $id;
1199 1458 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200 $self->send ("ext " . cf::to_json \%msg);
1201} 1459}
1202 1460
1203=item $player->ext_event ($type, %msg) 1461=item $player->ext_event ($type, %msg)
1204 1462
1205Sends an ext event to the client. 1463Sends an ext event to the client.
1220 1478
1221package cf::region; 1479package cf::region;
1222 1480
1223=item cf::region::find_by_path $path 1481=item cf::region::find_by_path $path
1224 1482
1225Tries to decuce the probable region for a map knowing only its path. 1483Tries to decuce the likely region for a map knowing only its path.
1226 1484
1227=cut 1485=cut
1228 1486
1229sub find_by_path($) { 1487sub find_by_path($) {
1230 my ($path) = @_; 1488 my ($path) = @_;
1304 my ($self, $merge) = @_; 1562 my ($self, $merge) = @_;
1305 1563
1306 # we have to keep some variables in memory intact 1564 # we have to keep some variables in memory intact
1307 local $self->{path}; 1565 local $self->{path};
1308 local $self->{load_path}; 1566 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1567
1312 $self->SUPER::thawer_merge ($merge); 1568 $self->SUPER::thawer_merge ($merge);
1313} 1569}
1314 1570
1315sub normalise { 1571sub normalise {
1415 1671
1416 $_->change_map_light ($change) 1672 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1673 for grep $_->outdoor, values %cf::MAP;
1418} 1674}
1419 1675
1676sub decay_objects {
1677 my ($self) = @_;
1678
1679 return if $self->{deny_reset};
1680
1681 $self->do_decay_objects;
1682}
1683
1420sub unlink_save { 1684sub unlink_save {
1421 my ($self) = @_; 1685 my ($self) = @_;
1422 1686
1423 utf8::encode (my $save = $self->save_path); 1687 utf8::encode (my $save = $self->save_path);
1424 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1688 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1480 $self->load_header_orig 1744 $self->load_header_orig
1481 or return; 1745 or return;
1482 $self->prepare_orig; 1746 $self->prepare_orig;
1483 } 1747 }
1484 1748
1749 $self->{deny_reset} = 1
1750 if $self->no_reset;
1751
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1752 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1753 unless $self->default_region;
1487 1754
1488 1 1755 1
1489} 1756}
1504 $map->{last_save} = $cf::RUNTIME; 1771 $map->{last_save} = $cf::RUNTIME;
1505 1772
1506 $map->load_header 1773 $map->load_header
1507 or return; 1774 or return;
1508 1775
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1776 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1777 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1778 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1779 $map->reset;
1513 undef $guard; 1780 undef $guard;
1514 return find $path; 1781 return find $path;
1581 my ($self, $ob) = @_; 1848 my ($self, $ob) = @_;
1582 1849
1583 return find "~" . $ob->name . "/" . $self->{path} 1850 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1851 if $self->per_player;
1585 1852
1853# return find "?party/" . $ob->name . "/" . $self->{path}
1854# if $self->per_party;
1855
1586 $self 1856 $self
1587} 1857}
1588 1858
1589# find and load all maps in the 3x3 area around a map 1859# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1860sub load_diag {
1700 1970
1701sub reset_at { 1971sub reset_at {
1702 my ($self) = @_; 1972 my ($self) = @_;
1703 1973
1704 # TODO: safety, remove and allow resettable per-player maps 1974 # 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}; 1975 return 1e99 if $self->{deny_reset};
1707 1976
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1977 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1978 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 1979
1721 my ($self) = @_; 1990 my ($self) = @_;
1722 1991
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1992 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 1993
1725 return if $self->players; 1994 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 1995
1728 warn "resetting map ", $self->path;#d# 1996 warn "resetting map ", $self->path;
1729 1997
1730 $self->in_memory (cf::MAP_SWAPPED); 1998 $self->in_memory (cf::MAP_SWAPPED);
1731 1999
1732 # need to save uniques path 2000 # need to save uniques path
1733 unless ($self->{deny_save}) { 2001 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2033 $cf::MAP{$self->path} = $self;
1766 2034
1767 $self->reset; # polite request, might not happen 2035 $self->reset; # polite request, might not happen
1768} 2036}
1769 2037
2038=item $maps = cf::map::tmp_maps
2039
2040Returns an arrayref with all map paths of currently instantiated and saved
2041maps. May block.
2042
2043=cut
2044
2045sub tmp_maps() {
2046 [
2047 map {
2048 utf8::decode $_;
2049 /\.map$/
2050 ? normalise $_
2051 : ()
2052 } @{ aio_readdir $TMPDIR or [] }
2053 ]
2054}
2055
2056=item $maps = cf::map::random_maps
2057
2058Returns an arrayref with all map paths of currently instantiated and saved
2059random maps. May block.
2060
2061=cut
2062
2063sub random_maps() {
2064 [
2065 map {
2066 utf8::decode $_;
2067 /\.map$/
2068 ? normalise "?random/$_"
2069 : ()
2070 } @{ aio_readdir $RANDOMDIR or [] }
2071 ]
2072}
2073
1770=item cf::map::unique_maps 2074=item cf::map::unique_maps
1771 2075
1772Returns an arrayref of paths of all shared maps that have 2076Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2077instantiated unique items. May block.
1774 2078
1775=cut 2079=cut
1776 2080
1777sub unique_maps() { 2081sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2082 [
1779 or return; 2083 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2084 utf8::decode $_;
1785 next if /\.pst$/; 2085 /\.map$/
1786 next unless /^$PATH_SEP/o; 2086 ? normalise $_
1787 2087 : ()
1788 push @paths, cf::map::normalise $_; 2088 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2089 ]
1790
1791 \@paths
1792} 2090}
1793 2091
1794package cf; 2092package cf;
1795 2093
1796=back 2094=back
1842 2140
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2141 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2142
1845 if ($self->{record_replies}) { 2143 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2144 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2145
1847 } else { 2146 } else {
2147 my $pl = $self->contr;
2148
2149 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2150 my $diag = $pl->{npc_dialog};
2151 $diag->{pl}->ext_reply (
2152 $diag->{id},
2153 msgtype => "reply",
2154 msg => $diag->{pl}->expand_cfpod ($msg),
2155 add_topics => []
2156 );
2157
2158 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2159 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2160 $self->message ($msg, $flags);
2161 }
1850 } 2162 }
1851} 2163}
1852 2164
1853=item $player_object->may ("access") 2165=item $player_object->may ("access")
1854 2166
2063 my $hp = $exit->stats->hp; 2375 my $hp = $exit->stats->hp;
2064 my $sp = $exit->stats->sp; 2376 my $sp = $exit->stats->sp;
2065 2377
2066 $self->enter_link; 2378 $self->enter_link;
2067 2379
2380 # if exit is damned, update players death & WoR home-position
2381 $self->contr->savebed ($slaying, $hp, $sp)
2382 if $exit->flag (FLAG_DAMNED);
2383
2068 (async { 2384 (async {
2069 $self->deactivate_recursive; # just to be sure 2385 $self->deactivate_recursive; # just to be sure
2070 unless (eval { 2386 unless (eval {
2071 $self->goto ($slaying, $hp, $sp); 2387 $self->goto ($slaying, $hp, $sp);
2072 2388
2099 2415
2100 utf8::encode $text; 2416 utf8::encode $text;
2101 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2417 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102} 2418}
2103 2419
2420=item $client->send_msg ($color, $type, $msg, [extra...])
2421
2422Send a drawinfo or msg packet to the client, formatting the msg for the
2423client if neccessary. C<$type> should be a string identifying the type of
2424the message, with C<log> being the default. If C<$color> is negative, suppress
2425the message unless the client supports the msg packet.
2426
2427=cut
2428
2429sub cf::client::send_msg {
2430 my ($self, $color, $type, $msg, @extra) = @_;
2431
2432 $msg = $self->pl->expand_cfpod ($msg);
2433
2434 return unless @extra || length $msg;
2435
2436 if ($self->can_msg) {
2437 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2438 } else {
2439 # replace some tags by gcfclient-compatible ones
2440 for ($msg) {
2441 1 while
2442 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2443 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2444 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2445 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2446 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2447 }
2448
2449 if ($color >= 0) {
2450 if (0 && $msg =~ /\[/) {
2451 $self->send_packet ("drawextinfo $color 4 0 $msg")
2452 } else {
2453 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2454 $self->send_packet ("drawinfo $color $msg")
2455 }
2456 }
2457 }
2458}
2459
2104=item $client->ext_event ($type, %msg) 2460=item $client->ext_event ($type, %msg)
2105 2461
2106Sends an exti event to the client. 2462Sends an ext event to the client.
2107 2463
2108=cut 2464=cut
2109 2465
2110sub cf::client::ext_event($$%) { 2466sub cf::client::ext_event($$%) {
2111 my ($self, $type, %msg) = @_; 2467 my ($self, $type, %msg) = @_;
2112 2468
2113 $msg{msgtype} = "event_$type"; 2469 $msg{msgtype} = "event_$type";
2114 $self->send_packet ("ext " . cf::to_json \%msg); 2470 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2115} 2471}
2116 2472
2117=item $success = $client->query ($flags, "text", \&cb) 2473=item $success = $client->query ($flags, "text", \&cb)
2118 2474
2119Queues a query to the client, calling the given callback with 2475Queues a query to the client, calling the given callback with
2120the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2476the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2121C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2477C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122 2478
2123Queries can fail, so check the return code. Or don't, as queries will become 2479Queries can fail, so check the return code. Or don't, as queries will
2124reliable at some point in the future. 2480become reliable at some point in the future.
2125 2481
2126=cut 2482=cut
2127 2483
2128sub cf::client::query { 2484sub cf::client::query {
2129 my ($self, $flags, $text, $cb) = @_; 2485 my ($self, $flags, $text, $cb) = @_;
2137 utf8::encode $text; 2493 utf8::encode $text;
2138 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2494 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139 2495
2140 $self->send_packet ($self->{query_queue}[0][0]) 2496 $self->send_packet ($self->{query_queue}[0][0])
2141 if @{ $self->{query_queue} } == 1; 2497 if @{ $self->{query_queue} } == 1;
2498
2499 1
2142} 2500}
2143 2501
2144cf::client->attach ( 2502cf::client->attach (
2503 on_connect => sub {
2504 my ($ns) = @_;
2505
2506 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2507 },
2145 on_reply => sub { 2508 on_reply => sub {
2146 my ($ns, $msg) = @_; 2509 my ($ns, $msg) = @_;
2147 2510
2148 # this weird shuffling is so that direct followup queries 2511 # this weird shuffling is so that direct followup queries
2149 # get handled first 2512 # get handled first
2161 } else { 2524 } else {
2162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2525 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163 } 2526 }
2164 } 2527 }
2165 }, 2528 },
2529 on_exticmd => sub {
2530 my ($ns, $buf) = @_;
2531
2532 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2533
2534 if (ref $msg) {
2535 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2536 if (my %reply = $cb->($ns, $msg)) {
2537 $reply{msgid} = $msg->{msgid};
2538 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2539 }
2540 }
2541 } else {
2542 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2543 }
2544
2545 cf::override;
2546 },
2166); 2547);
2167 2548
2168=item $client->async (\&cb) 2549=item $client->async (\&cb)
2169 2550
2170Create a new coroutine, running the specified callback. The coroutine will 2551Create a new coroutine, running the specified callback. The coroutine will
2219 2600
2220=pod 2601=pod
2221 2602
2222The following functions and methods are available within a safe environment: 2603The following functions and methods are available within a safe environment:
2223 2604
2224 cf::object contr pay_amount pay_player map 2605 cf::object
2606 contr pay_amount pay_player map x y force_find force_add
2607 insert remove
2608
2225 cf::object::player player 2609 cf::object::player
2226 cf::player peaceful 2610 player
2227 cf::map trigger 2611
2612 cf::player
2613 peaceful
2614
2615 cf::map
2616 trigger
2228 2617
2229=cut 2618=cut
2230 2619
2231for ( 2620for (
2232 ["cf::object" => qw(contr pay_amount pay_player map)], 2621 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2622 insert remove)],
2233 ["cf::object::player" => qw(player)], 2623 ["cf::object::player" => qw(player)],
2234 ["cf::player" => qw(peaceful)], 2624 ["cf::player" => qw(peaceful)],
2235 ["cf::map" => qw(trigger)], 2625 ["cf::map" => qw(trigger)],
2236) { 2626) {
2237 no strict 'refs'; 2627 no strict 'refs';
2306} 2696}
2307 2697
2308=back 2698=back
2309 2699
2310=cut 2700=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 2701
2484############################################################################# 2702#############################################################################
2485# the server's init and main functions 2703# the server's init and main functions
2486 2704
2487sub load_facedata($) { 2705sub load_facedata($) {
2547} 2765}
2548 2766
2549sub reload_archetypes { 2767sub reload_archetypes {
2550 load_resource_file "$DATADIR/archetypes" 2768 load_resource_file "$DATADIR/archetypes"
2551 or die "unable to load archetypes\n"; 2769 or die "unable to load archetypes\n";
2770 #d# NEED to laod twice to resolve forward references
2771 # this really needs to be done in an extra post-pass
2772 # (which needs to be synchronous, so solve it differently)
2773 load_resource_file "$DATADIR/archetypes"
2774 or die "unable to load archetypes\n";
2552} 2775}
2553 2776
2554sub reload_treasures { 2777sub reload_treasures {
2555 load_resource_file "$DATADIR/treasures" 2778 load_resource_file "$DATADIR/treasures"
2556 or die "unable to load treasurelists\n"; 2779 or die "unable to load treasurelists\n";
2559sub reload_resources { 2782sub reload_resources {
2560 warn "reloading resource files...\n"; 2783 warn "reloading resource files...\n";
2561 2784
2562 reload_regions; 2785 reload_regions;
2563 reload_facedata; 2786 reload_facedata;
2787 #reload_archetypes;#d#
2564 reload_archetypes; 2788 reload_archetypes;
2565 reload_treasures; 2789 reload_treasures;
2566 2790
2567 warn "finished reloading resource files\n"; 2791 warn "finished reloading resource files\n";
2568} 2792}
2625 }, 2849 },
2626 ); 2850 );
2627 } 2851 }
2628} 2852}
2629 2853
2854sub write_runtime {
2855 my $runtime = "$LOCALDIR/runtime";
2856
2857 # first touch the runtime file to show we are still running:
2858 # the fsync below can take a very very long time.
2859
2860 IO::AIO::aio_utime $runtime, undef, undef;
2861
2862 my $guard = cf::lock_acquire "write_runtime";
2863
2864 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2865 or return;
2866
2867 my $value = $cf::RUNTIME + 90 + 10;
2868 # 10 is the runtime save interval, for a monotonic clock
2869 # 60 allows for the watchdog to kill the server.
2870
2871 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2872 and return;
2873
2874 # always fsync - this file is important
2875 aio_fsync $fh
2876 and return;
2877
2878 # touch it again to show we are up-to-date
2879 aio_utime $fh, undef, undef;
2880
2881 close $fh
2882 or return;
2883
2884 aio_rename "$runtime~", $runtime
2885 and return;
2886
2887 warn "runtime file written.\n";
2888
2889 1
2890}
2891
2630sub emergency_save() { 2892sub emergency_save() {
2631 my $freeze_guard = cf::freeze_mainloop; 2893 my $freeze_guard = cf::freeze_mainloop;
2632 2894
2633 warn "enter emergency perl save\n"; 2895 warn "enter emergency perl save\n";
2634 2896
2709 %EXT_CORO = (); 2971 %EXT_CORO = ();
2710 2972
2711 warn "removing commands"; 2973 warn "removing commands";
2712 %COMMAND = (); 2974 %COMMAND = ();
2713 2975
2714 warn "removing ext commands"; 2976 warn "removing ext/exti commands";
2715 %EXTCMD = (); 2977 %EXTCMD = ();
2978 %EXTICMD = ();
2716 2979
2717 warn "unloading/nuking all extensions"; 2980 warn "unloading/nuking all extensions";
2718 for my $pkg (@EXTS) { 2981 for my $pkg (@EXTS) {
2719 warn "... unloading $pkg"; 2982 warn "... unloading $pkg";
2720 2983

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines