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.292 by root, Tue Jul 3 00:54:57 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines