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.272 by root, Sun Jun 3 15:32:50 2007 UTC vs.
Revision 1.287 by root, Mon Jun 25 05:43:45 2007 UTC

49our %COMMAND = (); 49our %COMMAND = ();
50our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51 51
52our @EXTS = (); # list of extension package names 52our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 55our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 56our %EXT_MAP = (); # pluggable maps
56 57
57our $RELOAD; # number of reloads so far 58our $RELOAD; # number of reloads so far
58our @EVENT; 59our @EVENT;
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 188@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 189@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 190@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 191@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 192@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
193@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 194@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193 195
194# we bless all objects into (empty) derived classes to force a method lookup 196# we bless all objects into (empty) derived classes to force a method lookup
195# within the Safe compartment. 197# within the Safe compartment.
196for my $pkg (qw( 198for my $pkg (qw(
197 cf::global cf::attachable 199 cf::global cf::attachable
205} 207}
206 208
207$Event::DIED = sub { 209$Event::DIED = sub {
208 warn "error in event callback: @_"; 210 warn "error in event callback: @_";
209}; 211};
212
213#############################################################################
210 214
211=head2 UTILITY FUNCTIONS 215=head2 UTILITY FUNCTIONS
212 216
213=over 4 217=over 4
214 218
233 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 237 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234 $d 238 $d
235 } || "[unable to dump $_[0]: '$@']"; 239 } || "[unable to dump $_[0]: '$@']";
236} 240}
237 241
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working 242use JSON::XS ();
239 243
240=item $ref = cf::from_json $json 244=item $ref = cf::from_json $json
241 245
242Converts a JSON string into the corresponding perl data structure. 246Converts a JSON string into the corresponding perl data structure.
243 247
244=item $json = cf::to_json $ref 248=item $json = cf::to_json $ref
245 249
246Converts a perl data structure into its JSON representation. 250Converts a perl data structure into its JSON representation.
251
252=cut
253
254our $json_coder = JSON::XS->new->convert_blessed->utf8;
255
256sub to_json ($) { $json_coder->encode ($_[0]) }
257sub from_json ($) { $json_coder->decode ($_[0]) }
247 258
248=item cf::lock_wait $string 259=item cf::lock_wait $string
249 260
250Wait until the given lock is available. See cf::lock_acquire. 261Wait until the given lock is available. See cf::lock_acquire.
251 262
317 328
318BEGIN { *async = \&Coro::async_pool } 329BEGIN { *async = \&Coro::async_pool }
319 330
320=item cf::sync_job { BLOCK } 331=item cf::sync_job { BLOCK }
321 332
322The design of crossfire+ requires that the main coro ($Coro::main) is 333The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323always able to handle events or runnable, as crossfire+ is only partly 334is 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. 335partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
336acceptable.
325 337
326If it must be done, put the blocking parts into C<sync_job>. This will run 338If 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 339the given BLOCK in another coroutine while waiting for the result. The
328server will be frozen during this time, so the block should either finish 340server will be frozen during this time, so the block should either finish
329fast or be very important. 341fast or be very important.
389 $EXT_CORO{$coro+0} = $coro; 401 $EXT_CORO{$coro+0} = $coro;
390 402
391 $coro 403 $coro
392} 404}
393 405
394sub write_runtime { 406=item fork_call { }, $args
395 my $runtime = "$LOCALDIR/runtime";
396 407
397 # first touch the runtime file to show we are still running: 408Executes the given code block with the given arguments in a seperate
398 # the fsync below can take a very very long time. 409process, returning the results. Everything must be serialisable with
410Coro::Storable. May, of course, block. Note that the executed sub may
411never block itself or use any form of Event handling.
399 412
400 IO::AIO::aio_utime $runtime, undef, undef; 413=cut
401 414
402 my $guard = cf::lock_acquire "write_runtime"; 415sub fork_call(&@) {
416 my ($cb, @args) = @_;
403 417
404 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 418# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
405 or return; 419# or die "socketpair: $!";
420 pipe my $fh1, my $fh2
421 or die "pipe: $!";
406 422
407 my $value = $cf::RUNTIME + 90 + 10; 423 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 424 close $fh2;
422 or return;
423 425
424 aio_rename "$runtime~", $runtime 426 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
425 and return; 427 $res = Coro::Storable::thaw $res;
426 428
427 warn "runtime file written.\n";#d# 429 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
428 430
431 die $$res unless "ARRAY" eq ref $res;
432
433 return wantarray ? @$res : $res->[-1];
434 } else {
435 reset_signals;
436 local $SIG{__WARN__};
437 local $SIG{__DIE__};
438 eval {
439 close $fh1;
440
441 my @res = eval { $cb->(@args) };
442 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
443 };
444
445 warn $@ if $@;
446 _exit 0;
429 1 447 }
448}
449
450=item $value = cf::db_get $family => $key
451
452Returns a single value from the environment database.
453
454=item cf::db_put $family => $key => $value
455
456Stores the given C<$value> in the family. It can currently store binary
457data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
458
459=cut
460
461our $DB;
462
463sub db_init {
464 unless ($DB) {
465 $DB = BDB::db_create $DB_ENV;
466
467 cf::sync_job {
468 eval {
469 $DB->set_flags (BDB::CHKSUM);
470
471 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
472 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
473 cf::cleanup "db_open(db): $!" if $!;
474 };
475 cf::cleanup "db_open(db): $@" if $@;
476 };
477 }
478}
479
480sub db_get($$) {
481 my $key = "$_[0]/$_[1]";
482
483 cf::sync_job {
484 BDB::db_get $DB, undef, $key, my $data;
485
486 $! ? ()
487 : $data
488 }
489}
490
491sub db_put($$$) {
492 BDB::dbreq_pri 4;
493 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
494}
495
496=item cf::cache $id => [$paths...], $processversion => $process
497
498Generic caching function that returns the value of the resource $id,
499caching and regenerating as required.
500
501This function can block.
502
503=cut
504
505sub cache {
506 my ($id, $src, $processversion, $process) = @_;
507
508 my $meta =
509 join "\x00",
510 $processversion,
511 map {
512 aio_stat $_
513 and Carp::croak "$_: $!";
514
515 ($_, (stat _)[7,9])
516 } @$src;
517
518 my $dbmeta = db_get cache => "$id/meta";
519 if ($dbmeta ne $meta) {
520 # changed, we may need to process
521
522 my @data;
523 my $md5;
524
525 for (0 .. $#$src) {
526 0 <= aio_load $src->[$_], $data[$_]
527 or Carp::croak "$src->[$_]: $!";
528 }
529
530 # if processing is expensive, check
531 # checksum first
532 if (1) {
533 $md5 =
534 join "\x00",
535 $processversion,
536 map {
537 Coro::cede;
538 ($src->[$_], Digest::MD5::md5_hex $data[$_])
539 } 0.. $#$src;
540
541
542 my $dbmd5 = db_get cache => "$id/md5";
543 if ($dbmd5 eq $md5) {
544 db_put cache => "$id/meta", $meta;
545
546 return db_get cache => "$id/data";
547 }
548 }
549
550 my $t1 = Time::HiRes::time;
551 my $data = $process->(\@data);
552 my $t2 = Time::HiRes::time;
553
554 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
555
556 db_put cache => "$id/data", $data;
557 db_put cache => "$id/md5" , $md5;
558 db_put cache => "$id/meta", $meta;
559
560 return $data;
561 }
562
563 db_get cache => "$id/data"
430} 564}
431 565
432=item cf::datalog type => key => value, ... 566=item cf::datalog type => key => value, ...
433 567
434Log a datalog packet of the given type with the given key-value pairs. 568Log 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") 586attach callbacks/event handlers (a collection of which is called an "attachment")
453to it. All such attachable objects support the following methods. 587to it. All such attachable objects support the following methods.
454 588
455In the following description, CLASS can be any of C<global>, C<object> 589In 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 590C<player>, C<client> or C<map> (i.e. the attachable objects in
457crossfire+). 591Crossfire TRT).
458 592
459=over 4 593=over 4
460 594
461=item $attachable->attach ($attachment, key => $value...) 595=item $attachable->attach ($attachment, key => $value...)
462 596
664 _attach $registry, $klass, @attach; 798 _attach $registry, $klass, @attach;
665 } 799 }
666 800
667 $obj->{$name} = \%arg; 801 $obj->{$name} = \%arg;
668 } else { 802 } else {
669 warn "object uses attachment '$name' that is not available, postponing.\n"; 803 warn "object uses attachment '$name' which is not available, postponing.\n";
670 } 804 }
671 805
672 $obj->{_attachment}{$name} = undef; 806 $obj->{_attachment}{$name} = undef;
673} 807}
674 808
872 or return; 1006 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1007 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1008 }
875 1009
876 warn sprintf "loading %s (%d)\n", 1010 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1011 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1012 return ($data, $av);
879} 1013}
1014
1015=head2 COMMAND CALLBACKS
1016
1017=over 4
1018
1019=cut
880 1020
881############################################################################# 1021#############################################################################
882# command handling &c 1022# command handling &c
883 1023
884=item cf::register_command $name => \&callback($ob,$args); 1024=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1037 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1038}
899 1039
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1040=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1041
902Register a callbackf ro execution when the client sends an extcmd packet. 1042Register a callback for execution when the client sends an (synchronous)
1043extcmd packet. Ext commands will be processed in the order they are
1044received by the server, like other user commands. The first argument is
1045the logged-in player. Ext commands can only be processed after a player
1046has logged in successfully.
903 1047
904If the callback returns something, it is sent back as if reply was being 1048If the callback returns something, it is sent back as if reply was being
905called. 1049called.
906 1050
1051=item cf::register_exticmd $name => \&callback($ns,$packet);
1052
1053Register a callback for execution when the client sends an (asynchronous)
1054exticmd packet. Exti commands are processed by the server as soon as they
1055are received, i.e. out of order w.r.t. other commands. The first argument
1056is a client socket. Exti commands can be received anytime, even before
1057log-in.
1058
1059If the callback returns something, it is sent back as if reply was being
1060called.
1061
907=cut 1062=cut
908 1063
909sub register_extcmd { 1064sub register_extcmd {
910 my ($name, $cb) = @_; 1065 my ($name, $cb) = @_;
911 1066
912 $EXTCMD{$name} = $cb; 1067 $EXTCMD{$name} = $cb;
1068}
1069
1070sub register_exticmd {
1071 my ($name, $cb) = @_;
1072
1073 $EXTICMD{$name} = $cb;
913} 1074}
914 1075
915cf::player->attach ( 1076cf::player->attach (
916 on_command => sub { 1077 on_command => sub {
917 my ($pl, $name, $params) = @_; 1078 my ($pl, $name, $params) = @_;
942 1103
943 cf::override; 1104 cf::override;
944 }, 1105 },
945); 1106);
946 1107
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 { 1108sub load_extensions {
1109 cf::sync_job {
1110 my %todo;
1111
982 for my $ext (<$LIBDIR/*.ext>) { 1112 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1113 next unless -r $path;
984 eval { 1114
985 load_extension $ext; 1115 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1116 my $base = $1;
1117 my $pkg = $1;
1118 $pkg =~ s/[^[:word:]]/_/g;
1119 $pkg = "ext::$pkg";
1120
1121 open my $fh, "<:utf8", $path
1122 or die "$path: $!";
1123
1124 my $source = do { local $/; <$fh> };
1125
1126 my %ext = (
1127 path => $path,
1128 base => $base,
1129 pkg => $pkg,
1130 );
1131
1132 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1133 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1134
1135 $ext{source} =
1136 "package $pkg; use strict; use utf8;\n"
1137 . "#line 1 \"$path\"\n{\n"
1138 . $source
1139 . "\n};\n1";
1140
1141 $todo{$base} = \%ext;
1142 }
1143
1144 my %done;
1145 while (%todo) {
1146 my $progress;
1147
1148 while (my ($k, $v) = each %todo) {
1149 for (split /,\s*/, $v->{meta}{depends}) {
1150 goto skip
1151 unless exists $done{$_};
1152 }
1153
1154 warn "... loading '$k' into '$v->{pkg}'\n";
1155
1156 unless (eval $v->{source}) {
1157 my $msg = $@ ? "$v->{path}: $@\n"
1158 : "$v->{base}: extension inactive.\n";
1159
1160 if (exists $v->{meta}{mandatory}) {
1161 warn $msg;
1162 warn "mandatory extension failed to load, exiting.\n";
1163 exit 1;
1164 }
1165
1166 warn $msg;
1167 }
1168
1169 $done{$k} = delete $todo{$k};
1170 push @EXTS, $v->{pkg};
1171 $progress = 1;
986 1 1172 }
987 } or warn "$ext not loaded: $@"; 1173
1174 skip:
1175 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1176 unless $progress;
1177 }
988 } 1178 };
989} 1179}
990 1180
991############################################################################# 1181#############################################################################
1182
1183=back
992 1184
993=head2 CORE EXTENSIONS 1185=head2 CORE EXTENSIONS
994 1186
995Functions and methods that extend core crossfire objects. 1187Functions and methods that extend core crossfire objects.
996 1188
1184 } 1376 }
1185 1377
1186 \@paths 1378 \@paths
1187} 1379}
1188 1380
1381=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1382
1383Expand crossfire pod fragments into protocol xml.
1384
1385=cut
1386
1387sub expand_cfpod {
1388 ((my $self), (local $_)) = @_;
1389
1390 # escape & and <
1391 s/&/&amp;/g;
1392 s/(?<![BIUGH])</&lt;/g;
1393
1394 # this is buggy, it needs to properly take care of nested <'s
1395
1396 1 while
1397 # replace B<>, I<>, U<> etc.
1398 s/B<([^\>]*)>/<b>$1<\/b>/
1399 || s/I<([^\>]*)>/<i>$1<\/i>/
1400 || s/U<([^\>]*)>/<u>$1<\/u>/
1401 # replace G<male|female> tags
1402 || s{G<([^>|]*)\|([^>]*)>}{
1403 $self->gender ? $2 : $1
1404 }ge
1405 # replace H<hint text>
1406 || s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
1407
1408 # create single paragraphs (very hackish)
1409 s/(?<=\S)\n(?=\w)/ /g;
1410
1411 $_
1412}
1413
1189=item $player->ext_reply ($msgid, %msg) 1414=item $player->ext_reply ($msgid, %msg)
1190 1415
1191Sends an ext reply to the player. 1416Sends an ext reply to the player.
1192 1417
1193=cut 1418=cut
1194 1419
1195sub ext_reply($$%) { 1420sub ext_reply($$%) {
1196 my ($self, $id, %msg) = @_; 1421 my ($self, $id, %msg) = @_;
1197 1422
1198 $msg{msgid} = $id; 1423 $msg{msgid} = $id;
1199
1200 $self->send ("ext " . cf::to_json \%msg); 1424 $self->send ("ext " . cf::to_json \%msg);
1201} 1425}
1202 1426
1203=item $player->ext_event ($type, %msg) 1427=item $player->ext_event ($type, %msg)
1204 1428
1220 1444
1221package cf::region; 1445package cf::region;
1222 1446
1223=item cf::region::find_by_path $path 1447=item cf::region::find_by_path $path
1224 1448
1225Tries to decuce the probable region for a map knowing only its path. 1449Tries to decuce the likely region for a map knowing only its path.
1226 1450
1227=cut 1451=cut
1228 1452
1229sub find_by_path($) { 1453sub find_by_path($) {
1230 my ($path) = @_; 1454 my ($path) = @_;
1304 my ($self, $merge) = @_; 1528 my ($self, $merge) = @_;
1305 1529
1306 # we have to keep some variables in memory intact 1530 # we have to keep some variables in memory intact
1307 local $self->{path}; 1531 local $self->{path};
1308 local $self->{load_path}; 1532 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1533
1312 $self->SUPER::thawer_merge ($merge); 1534 $self->SUPER::thawer_merge ($merge);
1313} 1535}
1314 1536
1315sub normalise { 1537sub normalise {
1415 1637
1416 $_->change_map_light ($change) 1638 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1639 for grep $_->outdoor, values %cf::MAP;
1418} 1640}
1419 1641
1642sub decay_objects {
1643 my ($self) = @_;
1644
1645 return if $self->{deny_reset};
1646
1647 $self->do_decay_objects;
1648}
1649
1420sub unlink_save { 1650sub unlink_save {
1421 my ($self) = @_; 1651 my ($self) = @_;
1422 1652
1423 utf8::encode (my $save = $self->save_path); 1653 utf8::encode (my $save = $self->save_path);
1424 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1654 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1480 $self->load_header_orig 1710 $self->load_header_orig
1481 or return; 1711 or return;
1482 $self->prepare_orig; 1712 $self->prepare_orig;
1483 } 1713 }
1484 1714
1715 $self->{deny_reset} = 1
1716 if $self->no_reset;
1717
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1718 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1719 unless $self->default_region;
1487 1720
1488 1 1721 1
1489} 1722}
1504 $map->{last_save} = $cf::RUNTIME; 1737 $map->{last_save} = $cf::RUNTIME;
1505 1738
1506 $map->load_header 1739 $map->load_header
1507 or return; 1740 or return;
1508 1741
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1742 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1743 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1744 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1745 $map->reset;
1513 undef $guard; 1746 undef $guard;
1514 return find $path; 1747 return find $path;
1581 my ($self, $ob) = @_; 1814 my ($self, $ob) = @_;
1582 1815
1583 return find "~" . $ob->name . "/" . $self->{path} 1816 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1817 if $self->per_player;
1585 1818
1819# return find "?party/" . $ob->name . "/" . $self->{path}
1820# if $self->per_party;
1821
1586 $self 1822 $self
1587} 1823}
1588 1824
1589# find and load all maps in the 3x3 area around a map 1825# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1826sub load_diag {
1700 1936
1701sub reset_at { 1937sub reset_at {
1702 my ($self) = @_; 1938 my ($self) = @_;
1703 1939
1704 # TODO: safety, remove and allow resettable per-player maps 1940 # 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}; 1941 return 1e99 if $self->{deny_reset};
1707 1942
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1943 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1944 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 1945
1721 my ($self) = @_; 1956 my ($self) = @_;
1722 1957
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1958 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 1959
1725 return if $self->players; 1960 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 1961
1728 warn "resetting map ", $self->path;#d# 1962 warn "resetting map ", $self->path;
1729 1963
1730 $self->in_memory (cf::MAP_SWAPPED); 1964 $self->in_memory (cf::MAP_SWAPPED);
1731 1965
1732 # need to save uniques path 1966 # need to save uniques path
1733 unless ($self->{deny_save}) { 1967 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 1999 $cf::MAP{$self->path} = $self;
1766 2000
1767 $self->reset; # polite request, might not happen 2001 $self->reset; # polite request, might not happen
1768} 2002}
1769 2003
2004=item $maps = cf::map::tmp_maps
2005
2006Returns an arrayref with all map paths of currently instantiated and saved
2007maps. May block.
2008
2009=cut
2010
2011sub tmp_maps() {
2012 [
2013 map {
2014 utf8::decode $_;
2015 /\.map$/
2016 ? normalise $_
2017 : ()
2018 } @{ aio_readdir $TMPDIR or [] }
2019 ]
2020}
2021
2022=item $maps = cf::map::random_maps
2023
2024Returns an arrayref with all map paths of currently instantiated and saved
2025random maps. May block.
2026
2027=cut
2028
2029sub random_maps() {
2030 [
2031 map {
2032 utf8::decode $_;
2033 /\.map$/
2034 ? normalise "?random/$_"
2035 : ()
2036 } @{ aio_readdir $RANDOMDIR or [] }
2037 ]
2038}
2039
1770=item cf::map::unique_maps 2040=item cf::map::unique_maps
1771 2041
1772Returns an arrayref of paths of all shared maps that have 2042Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2043instantiated unique items. May block.
1774 2044
1775=cut 2045=cut
1776 2046
1777sub unique_maps() { 2047sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2048 [
1779 or return; 2049 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2050 utf8::decode $_;
1785 next if /\.pst$/; 2051 /\.map$/
1786 next unless /^$PATH_SEP/o; 2052 ? normalise $_
1787 2053 : ()
1788 push @paths, cf::map::normalise $_; 2054 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2055 ]
1790
1791 \@paths
1792} 2056}
1793 2057
1794package cf; 2058package cf;
1795 2059
1796=back 2060=back
1842 2106
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2107 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2108
1845 if ($self->{record_replies}) { 2109 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2110 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2111
1847 } else { 2112 } else {
2113 my $pl = $self->contr;
2114
2115 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2116 my $diag = $pl->{npc_dialog};
2117 $diag->{pl}->ext_reply (
2118 $diag->{id},
2119 msgtype => "reply",
2120 msg => $diag->{pl}->expand_cfpod ($msg),
2121 add_topics => []
2122 );
2123
2124 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2125 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2126 $self->message ($msg, $flags);
2127 }
1850 } 2128 }
1851} 2129}
1852 2130
1853=item $player_object->may ("access") 2131=item $player_object->may ("access")
1854 2132
2099 2377
2100 utf8::encode $text; 2378 utf8::encode $text;
2101 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2379 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102} 2380}
2103 2381
2382=item $client->send_msg ($color, $type, $msg, [extra...])
2383
2384Send a drawinfo or msg packet to the client, formatting the msg for the
2385client if neccessary. C<$type> should be a string identifying the type of
2386the message, with C<log> being the default. If C<$color> is negative, suppress
2387the message unless the client supports the msg packet.
2388
2389=cut
2390
2391sub cf::client::send_msg {
2392 my ($self, $color, $type, $msg, @extra) = @_;
2393
2394 $msg = $self->pl->expand_cfpod ($msg);
2395
2396 if ($self->can_msg) {
2397 $self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
2398 } else {
2399 # replace some tags by gcfclient-compatible ones
2400 for ($msg) {
2401 1 while
2402 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2403 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2404 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2405 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2406 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2407 }
2408
2409 if ($color >= 0) {
2410 if (0 && $msg =~ /\[/) {
2411 $self->send_packet ("drawextinfo $color 4 0 $msg")
2412 } else {
2413 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2414 $self->send_packet ("drawinfo $color $msg")
2415 }
2416 }
2417 }
2418}
2419
2104=item $client->ext_event ($type, %msg) 2420=item $client->ext_event ($type, %msg)
2105 2421
2106Sends an exti event to the client. 2422Sends an ext event to the client.
2107 2423
2108=cut 2424=cut
2109 2425
2110sub cf::client::ext_event($$%) { 2426sub cf::client::ext_event($$%) {
2111 my ($self, $type, %msg) = @_; 2427 my ($self, $type, %msg) = @_;
2118 2434
2119Queues a query to the client, calling the given callback with 2435Queues a query to the client, calling the given callback with
2120the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2436the 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>. 2437C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122 2438
2123Queries can fail, so check the return code. Or don't, as queries will become 2439Queries can fail, so check the return code. Or don't, as queries will
2124reliable at some point in the future. 2440become reliable at some point in the future.
2125 2441
2126=cut 2442=cut
2127 2443
2128sub cf::client::query { 2444sub cf::client::query {
2129 my ($self, $flags, $text, $cb) = @_; 2445 my ($self, $flags, $text, $cb) = @_;
2137 utf8::encode $text; 2453 utf8::encode $text;
2138 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2454 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139 2455
2140 $self->send_packet ($self->{query_queue}[0][0]) 2456 $self->send_packet ($self->{query_queue}[0][0])
2141 if @{ $self->{query_queue} } == 1; 2457 if @{ $self->{query_queue} } == 1;
2458
2459 1
2142} 2460}
2143 2461
2144cf::client->attach ( 2462cf::client->attach (
2145 on_reply => sub { 2463 on_reply => sub {
2146 my ($ns, $msg) = @_; 2464 my ($ns, $msg) = @_;
2160 $ns->send_packet ($ns->{query_queue}[0][0]); 2478 $ns->send_packet ($ns->{query_queue}[0][0]);
2161 } else { 2479 } else {
2162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2480 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163 } 2481 }
2164 } 2482 }
2483 },
2484 on_exticmd => sub {
2485 my ($ns, $buf) = @_;
2486
2487 my $msg = eval { from_json $buf };
2488
2489 if (ref $msg) {
2490 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2491 if (my %reply = $cb->($ns, $msg)) {
2492 $reply{msgid} = $msg->{msgid};
2493 $ns->send ("ext " . cf::to_json \%reply);
2494 }
2495 }
2496 } else {
2497 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2498 }
2499
2500 cf::override;
2165 }, 2501 },
2166); 2502);
2167 2503
2168=item $client->async (\&cb) 2504=item $client->async (\&cb)
2169 2505
2308=back 2644=back
2309 2645
2310=cut 2646=cut
2311 2647
2312############################################################################# 2648#############################################################################
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 2649# the server's init and main functions
2486 2650
2487sub load_facedata($) { 2651sub load_facedata($) {
2488 my ($path) = @_; 2652 my ($path) = @_;
2489 2653
2501 { 2665 {
2502 my $faces = $facedata->{faceinfo}; 2666 my $faces = $facedata->{faceinfo};
2503 2667
2504 while (my ($face, $info) = each %$faces) { 2668 while (my ($face, $info) = each %$faces) {
2505 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2669 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506 warn "$face $info->{magicmap}\n" if $face =~ /obol/;#d#
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2670 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2671 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2672 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510 Coro::cede; 2673 Coro::cede;
2511 } 2674 }
2560sub reload_resources { 2723sub reload_resources {
2561 warn "reloading resource files...\n"; 2724 warn "reloading resource files...\n";
2562 2725
2563 reload_regions; 2726 reload_regions;
2564 reload_facedata; 2727 reload_facedata;
2728 #reload_archetypes;#d#
2565 reload_archetypes; 2729 reload_archetypes;
2566 reload_treasures; 2730 reload_treasures;
2567 2731
2568 warn "finished reloading resource files\n"; 2732 warn "finished reloading resource files\n";
2569} 2733}
2626 }, 2790 },
2627 ); 2791 );
2628 } 2792 }
2629} 2793}
2630 2794
2795sub write_runtime {
2796 my $runtime = "$LOCALDIR/runtime";
2797
2798 # first touch the runtime file to show we are still running:
2799 # the fsync below can take a very very long time.
2800
2801 IO::AIO::aio_utime $runtime, undef, undef;
2802
2803 my $guard = cf::lock_acquire "write_runtime";
2804
2805 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2806 or return;
2807
2808 my $value = $cf::RUNTIME + 90 + 10;
2809 # 10 is the runtime save interval, for a monotonic clock
2810 # 60 allows for the watchdog to kill the server.
2811
2812 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2813 and return;
2814
2815 # always fsync - this file is important
2816 aio_fsync $fh
2817 and return;
2818
2819 # touch it again to show we are up-to-date
2820 aio_utime $fh, undef, undef;
2821
2822 close $fh
2823 or return;
2824
2825 aio_rename "$runtime~", $runtime
2826 and return;
2827
2828 warn "runtime file written.\n";
2829
2830 1
2831}
2832
2631sub emergency_save() { 2833sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop; 2834 my $freeze_guard = cf::freeze_mainloop;
2633 2835
2634 warn "enter emergency perl save\n"; 2836 warn "enter emergency perl save\n";
2635 2837
2710 %EXT_CORO = (); 2912 %EXT_CORO = ();
2711 2913
2712 warn "removing commands"; 2914 warn "removing commands";
2713 %COMMAND = (); 2915 %COMMAND = ();
2714 2916
2715 warn "removing ext commands"; 2917 warn "removing ext/exti commands";
2716 %EXTCMD = (); 2918 %EXTCMD = ();
2919 %EXTICMD = ();
2717 2920
2718 warn "unloading/nuking all extensions"; 2921 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) { 2922 for my $pkg (@EXTS) {
2720 warn "... unloading $pkg"; 2923 warn "... unloading $pkg";
2721 2924

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines