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.268 by root, Tue May 22 10:50:00 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 if (my $fh = aio_open $runtime, O_WRONLY, 0) { 413=cut
401 utime undef, undef, $fh;
402 }
403 414
404 my $guard = cf::lock_acquire "write_runtime"; 415sub fork_call(&@) {
416 my ($cb, @args) = @_;
405 417
406 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
407 or return; 419# or die "socketpair: $!";
420 pipe my $fh1, my $fh2
421 or die "pipe: $!";
408 422
409 my $value = $cf::RUNTIME + 90 + 10; 423 if (my $pid = fork) {
410 # 10 is the runtime save interval, for a monotonic clock
411 # 60 allows for the watchdog to kill the server.
412
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0
414 and return;
415
416 # always fsync - this file is important
417 aio_fsync $fh
418 and return;
419
420 # touch it again to show we are up-to-date
421 utime undef, undef, $fh;
422
423 close $fh 424 close $fh2;
424 or return;
425 425
426 aio_rename "$runtime~", $runtime 426 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
427 and return; 427 $res = Coro::Storable::thaw $res;
428 428
429 warn "runtime file written.\n";#d# 429 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
430 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;
431 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"
432} 564}
433 565
434=item cf::datalog type => key => value, ... 566=item cf::datalog type => key => value, ...
435 567
436Log 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.
454attach callbacks/event handlers (a collection of which is called an "attachment") 586attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 587to it. All such attachable objects support the following methods.
456 588
457In 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>
458C<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
459crossfire+). 591Crossfire TRT).
460 592
461=over 4 593=over 4
462 594
463=item $attachable->attach ($attachment, key => $value...) 595=item $attachable->attach ($attachment, key => $value...)
464 596
666 _attach $registry, $klass, @attach; 798 _attach $registry, $klass, @attach;
667 } 799 }
668 800
669 $obj->{$name} = \%arg; 801 $obj->{$name} = \%arg;
670 } else { 802 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 803 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 804 }
673 805
674 $obj->{_attachment}{$name} = undef; 806 $obj->{_attachment}{$name} = undef;
675} 807}
676 808
874 or return; 1006 or return;
875 $av = eval { (Storable::thaw $av)->{objs} }; 1007 $av = eval { (Storable::thaw $av)->{objs} };
876 } 1008 }
877 1009
878 warn sprintf "loading %s (%d)\n", 1010 warn sprintf "loading %s (%d)\n",
879 $filename, length $data, scalar @{$av || []};#d# 1011 $filename, length $data, scalar @{$av || []};
880 return ($data, $av); 1012 return ($data, $av);
881} 1013}
1014
1015=head2 COMMAND CALLBACKS
1016
1017=over 4
1018
1019=cut
882 1020
883############################################################################# 1021#############################################################################
884# command handling &c 1022# command handling &c
885 1023
886=item cf::register_command $name => \&callback($ob,$args); 1024=item cf::register_command $name => \&callback($ob,$args);
899 push @{ $COMMAND{$name} }, [$caller, $cb]; 1037 push @{ $COMMAND{$name} }, [$caller, $cb];
900} 1038}
901 1039
902=item cf::register_extcmd $name => \&callback($pl,$packet); 1040=item cf::register_extcmd $name => \&callback($pl,$packet);
903 1041
904Register 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.
905 1047
906If 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
907called. 1049called.
908 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
909=cut 1062=cut
910 1063
911sub register_extcmd { 1064sub register_extcmd {
912 my ($name, $cb) = @_; 1065 my ($name, $cb) = @_;
913 1066
914 $EXTCMD{$name} = $cb; 1067 $EXTCMD{$name} = $cb;
1068}
1069
1070sub register_exticmd {
1071 my ($name, $cb) = @_;
1072
1073 $EXTICMD{$name} = $cb;
915} 1074}
916 1075
917cf::player->attach ( 1076cf::player->attach (
918 on_command => sub { 1077 on_command => sub {
919 my ($pl, $name, $params) = @_; 1078 my ($pl, $name, $params) = @_;
944 1103
945 cf::override; 1104 cf::override;
946 }, 1105 },
947); 1106);
948 1107
949sub load_extension {
950 my ($path) = @_;
951
952 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
953 my $base = $1;
954 my $pkg = $1;
955 $pkg =~ s/[^[:word:]]/_/g;
956 $pkg = "ext::$pkg";
957
958 warn "... loading '$path' into '$pkg'\n";
959
960 open my $fh, "<:utf8", $path
961 or die "$path: $!";
962
963 my $source =
964 "package $pkg; use strict; use utf8;\n"
965 . "#line 1 \"$path\"\n{\n"
966 . (do { local $/; <$fh> })
967 . "\n};\n1";
968
969 unless (eval $source) {
970 my $msg = $@ ? "$path: $@\n"
971 : "extension disabled.\n";
972 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973 warn $@;
974 warn "mandatory extension failed to load, exiting.\n";
975 exit 1;
976 }
977 die $@;
978 }
979
980 push @EXTS, $pkg;
981}
982
983sub load_extensions { 1108sub load_extensions {
1109 cf::sync_job {
1110 my %todo;
1111
984 for my $ext (<$LIBDIR/*.ext>) { 1112 for my $path (<$LIBDIR/*.ext>) {
985 next unless -r $ext; 1113 next unless -r $path;
986 eval { 1114
987 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;
988 1 1172 }
989 } or warn "$ext not loaded: $@"; 1173
1174 skip:
1175 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1176 unless $progress;
1177 }
990 } 1178 };
991} 1179}
992 1180
993############################################################################# 1181#############################################################################
1182
1183=back
994 1184
995=head2 CORE EXTENSIONS 1185=head2 CORE EXTENSIONS
996 1186
997Functions and methods that extend core crossfire objects. 1187Functions and methods that extend core crossfire objects.
998 1188
1186 } 1376 }
1187 1377
1188 \@paths 1378 \@paths
1189} 1379}
1190 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
1191=item $player->ext_reply ($msgid, %msg) 1414=item $player->ext_reply ($msgid, %msg)
1192 1415
1193Sends an ext reply to the player. 1416Sends an ext reply to the player.
1194 1417
1195=cut 1418=cut
1196 1419
1197sub ext_reply($$%) { 1420sub ext_reply($$%) {
1198 my ($self, $id, %msg) = @_; 1421 my ($self, $id, %msg) = @_;
1199 1422
1200 $msg{msgid} = $id; 1423 $msg{msgid} = $id;
1201
1202 $self->send ("ext " . cf::to_json \%msg); 1424 $self->send ("ext " . cf::to_json \%msg);
1203} 1425}
1204 1426
1205=item $player->ext_event ($type, %msg) 1427=item $player->ext_event ($type, %msg)
1206 1428
1222 1444
1223package cf::region; 1445package cf::region;
1224 1446
1225=item cf::region::find_by_path $path 1447=item cf::region::find_by_path $path
1226 1448
1227Tries 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.
1228 1450
1229=cut 1451=cut
1230 1452
1231sub find_by_path($) { 1453sub find_by_path($) {
1232 my ($path) = @_; 1454 my ($path) = @_;
1306 my ($self, $merge) = @_; 1528 my ($self, $merge) = @_;
1307 1529
1308 # we have to keep some variables in memory intact 1530 # we have to keep some variables in memory intact
1309 local $self->{path}; 1531 local $self->{path};
1310 local $self->{load_path}; 1532 local $self->{load_path};
1311 local $self->{deny_save};
1312 local $self->{deny_reset};
1313 1533
1314 $self->SUPER::thawer_merge ($merge); 1534 $self->SUPER::thawer_merge ($merge);
1315} 1535}
1316 1536
1317sub normalise { 1537sub normalise {
1417 1637
1418 $_->change_map_light ($change) 1638 $_->change_map_light ($change)
1419 for grep $_->outdoor, values %cf::MAP; 1639 for grep $_->outdoor, values %cf::MAP;
1420} 1640}
1421 1641
1642sub decay_objects {
1643 my ($self) = @_;
1644
1645 return if $self->{deny_reset};
1646
1647 $self->do_decay_objects;
1648}
1649
1422sub unlink_save { 1650sub unlink_save {
1423 my ($self) = @_; 1651 my ($self) = @_;
1424 1652
1425 utf8::encode (my $save = $self->save_path); 1653 utf8::encode (my $save = $self->save_path);
1426 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1654 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1482 $self->load_header_orig 1710 $self->load_header_orig
1483 or return; 1711 or return;
1484 $self->prepare_orig; 1712 $self->prepare_orig;
1485 } 1713 }
1486 1714
1715 $self->{deny_reset} = 1
1716 if $self->no_reset;
1717
1487 $self->default_region (cf::region::find_by_path $self->{path}) 1718 $self->default_region (cf::region::find_by_path $self->{path})
1488 unless $self->default_region; 1719 unless $self->default_region;
1489 1720
1490 1 1721 1
1491} 1722}
1506 $map->{last_save} = $cf::RUNTIME; 1737 $map->{last_save} = $cf::RUNTIME;
1507 1738
1508 $map->load_header 1739 $map->load_header
1509 or return; 1740 or return;
1510 1741
1511 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1742 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512 # doing this can freeze the server in a sync job, obviously 1743 # doing this can freeze the server in a sync job, obviously
1513 #$cf::WAIT_FOR_TICK->wait; 1744 #$cf::WAIT_FOR_TICK->wait;
1514 $map->reset; 1745 $map->reset;
1515 undef $guard; 1746 undef $guard;
1516 return find $path; 1747 return find $path;
1583 my ($self, $ob) = @_; 1814 my ($self, $ob) = @_;
1584 1815
1585 return find "~" . $ob->name . "/" . $self->{path} 1816 return find "~" . $ob->name . "/" . $self->{path}
1586 if $self->per_player; 1817 if $self->per_player;
1587 1818
1819# return find "?party/" . $ob->name . "/" . $self->{path}
1820# if $self->per_party;
1821
1588 $self 1822 $self
1589} 1823}
1590 1824
1591# 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
1592sub load_diag { 1826sub load_diag {
1702 1936
1703sub reset_at { 1937sub reset_at {
1704 my ($self) = @_; 1938 my ($self) = @_;
1705 1939
1706 # TODO: safety, remove and allow resettable per-player maps 1940 # TODO: safety, remove and allow resettable per-player maps
1707 return 1e99 if $self->isa ("ext::map_per_player");#d#
1708 return 1e99 if $self->{deny_reset}; 1941 return 1e99 if $self->{deny_reset};
1709 1942
1710 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1943 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711 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;
1712 1945
1723 my ($self) = @_; 1956 my ($self) = @_;
1724 1957
1725 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1958 my $lock = cf::lock_acquire "map_data:$self->{path}";
1726 1959
1727 return if $self->players; 1960 return if $self->players;
1728 return if $self->isa ("ext::map_per_player");#d#
1729 1961
1730 warn "resetting map ", $self->path;#d# 1962 warn "resetting map ", $self->path;
1731 1963
1732 $self->in_memory (cf::MAP_SWAPPED); 1964 $self->in_memory (cf::MAP_SWAPPED);
1733 1965
1734 # need to save uniques path 1966 # need to save uniques path
1735 unless ($self->{deny_save}) { 1967 unless ($self->{deny_save}) {
1767 $cf::MAP{$self->path} = $self; 1999 $cf::MAP{$self->path} = $self;
1768 2000
1769 $self->reset; # polite request, might not happen 2001 $self->reset; # polite request, might not happen
1770} 2002}
1771 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
1772=item cf::map::unique_maps 2040=item cf::map::unique_maps
1773 2041
1774Returns an arrayref of paths of all shared maps that have 2042Returns an arrayref of paths of all shared maps that have
1775instantiated unique items. May block. 2043instantiated unique items. May block.
1776 2044
1777=cut 2045=cut
1778 2046
1779sub unique_maps() { 2047sub unique_maps() {
1780 my $files = aio_readdir $UNIQUEDIR 2048 [
1781 or return; 2049 map {
1782
1783 my @paths;
1784
1785 for (@$files) {
1786 utf8::decode $_; 2050 utf8::decode $_;
1787 next if /\.pst$/; 2051 /\.map$/
1788 next unless /^$PATH_SEP/o; 2052 ? normalise $_
1789 2053 : ()
1790 push @paths, cf::map::normalise $_; 2054 } @{ aio_readdir $UNIQUEDIR or [] }
1791 } 2055 ]
1792
1793 \@paths
1794} 2056}
1795 2057
1796package cf; 2058package cf;
1797 2059
1798=back 2060=back
1844 2106
1845 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2107 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846 2108
1847 if ($self->{record_replies}) { 2109 if ($self->{record_replies}) {
1848 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2110 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2111
1849 } 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 {
1850 $msg = $npc->name . " says: $msg" if $npc; 2125 $msg = $npc->name . " says: $msg" if $npc;
1851 $self->message ($msg, $flags); 2126 $self->message ($msg, $flags);
2127 }
1852 } 2128 }
1853} 2129}
1854 2130
1855=item $player_object->may ("access") 2131=item $player_object->may ("access")
1856 2132
1904 $self->deactivate_recursive; 2180 $self->deactivate_recursive;
1905 2181
1906 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2182 return if UNIVERSAL::isa $self->map, "ext::map_link";
1907 2183
1908 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2184 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909 if $self->map; 2185 if $self->map && $self->map->{path} ne "{link}";
1910 2186
1911 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2187 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1912} 2188}
1913 2189
1914sub cf::object::player::leave_link { 2190sub cf::object::player::leave_link {
1915 my ($self, $map, $x, $y) = @_; 2191 my ($self, $map, $x, $y) = @_;
2192
2193 return unless $self->contr->active;
1916 2194
1917 my $link_pos = delete $self->{_link_pos}; 2195 my $link_pos = delete $self->{_link_pos};
1918 2196
1919 unless ($map) { 2197 unless ($map) {
1920 # restore original map position 2198 # restore original map position
1943 2221
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2222 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2223 $self->enter_map ($map, $x, $y);
1946} 2224}
1947 2225
1948cf::player->attach (
1949 on_logout => sub {
1950 my ($pl) = @_;
1951
1952 # abort map switching before logout
1953 if ($pl->ob->{_link_pos}) {
1954 cf::sync_job {
1955 $pl->ob->leave_link
1956 };
1957 }
1958 },
1959 on_login => sub {
1960 my ($pl) = @_;
1961
1962 # try to abort aborted map switching on player login :)
1963 # should happen only on crashes
1964 if ($pl->ob->{_link_pos}) {
1965 $pl->ob->enter_link;
1966 (async {
1967 $pl->ob->reply (undef,
1968 "There was an internal problem at your last logout, "
1969 . "the server will try to bring you to your intended destination in a second.",
1970 cf::NDI_RED);
1971 # we need this sleep as the login has a concurrent enter_exit running
1972 # and this sleep increases chances of the player not ending up in scorn
1973 Coro::Timer::sleep 1;
1974 $pl->ob->leave_link;
1975 })->prio (2);
1976 }
1977 },
1978);
1979
1980=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2226=item $player_object->goto ($path, $x, $y[, $check->($map)])
1981 2227
1982Moves the player to the given map-path and coordinates by first freezing 2228Moves the player to the given map-path and coordinates by first freezing
1983her, loading and preparing them map, calling the provided $check callback 2229her, loading and preparing them map, calling the provided $check callback
1984that has to return the map if sucecssful, and then unfreezes the player on 2230that has to return the map if sucecssful, and then unfreezes the player on
1985the new (success) or old (failed) map position. 2231the new (success) or old (failed) map position.
1986 2232
1987=cut 2233=cut
1988 2234
2235our $GOTOGEN;
2236
1989sub cf::object::player::goto { 2237sub cf::object::player::goto {
1990 my ($self, $path, $x, $y, $check) = @_; 2238 my ($self, $path, $x, $y, $check) = @_;
1991 2239
1992 #d# #TODO# 2240 # do generation counting so two concurrent goto's will be executed in-order
1993 if ($check && !ref $check) { 2241 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1994 warn Carp::longmess "goto called with non-ref check argument";#d#
1995 undef $check;
1996 }
1997 2242
1998 $self->enter_link; 2243 $self->enter_link;
1999 2244
2000 (async { 2245 (async {
2001 my $map = eval { 2246 my $map = eval {
2014 if ($@) { 2259 if ($@) {
2015 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED); 2260 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2016 LOG llevError | logBacktrace, Carp::longmess $@; 2261 LOG llevError | logBacktrace, Carp::longmess $@;
2017 } 2262 }
2018 2263
2264 if ($gen == $self->{_goto_generation}) {
2265 delete $self->{_goto_generation};
2019 $self->leave_link ($map, $x, $y); 2266 $self->leave_link ($map, $x, $y);
2267 }
2020 })->prio (1); 2268 })->prio (1);
2021} 2269}
2022 2270
2023=item $player_object->enter_exit ($exit_object) 2271=item $player_object->enter_exit ($exit_object)
2024 2272
2129 2377
2130 utf8::encode $text; 2378 utf8::encode $text;
2131 $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);
2132} 2380}
2133 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
2134=item $client->ext_event ($type, %msg) 2420=item $client->ext_event ($type, %msg)
2135 2421
2136Sends an exti event to the client. 2422Sends an ext event to the client.
2137 2423
2138=cut 2424=cut
2139 2425
2140sub cf::client::ext_event($$%) { 2426sub cf::client::ext_event($$%) {
2141 my ($self, $type, %msg) = @_; 2427 my ($self, $type, %msg) = @_;
2148 2434
2149Queues a query to the client, calling the given callback with 2435Queues a query to the client, calling the given callback with
2150the 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>,
2151C<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>.
2152 2438
2153Queries 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
2154reliable at some point in the future. 2440become reliable at some point in the future.
2155 2441
2156=cut 2442=cut
2157 2443
2158sub cf::client::query { 2444sub cf::client::query {
2159 my ($self, $flags, $text, $cb) = @_; 2445 my ($self, $flags, $text, $cb) = @_;
2167 utf8::encode $text; 2453 utf8::encode $text;
2168 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2454 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2169 2455
2170 $self->send_packet ($self->{query_queue}[0][0]) 2456 $self->send_packet ($self->{query_queue}[0][0])
2171 if @{ $self->{query_queue} } == 1; 2457 if @{ $self->{query_queue} } == 1;
2458
2459 1
2172} 2460}
2173 2461
2174cf::client->attach ( 2462cf::client->attach (
2175 on_reply => sub { 2463 on_reply => sub {
2176 my ($ns, $msg) = @_; 2464 my ($ns, $msg) = @_;
2190 $ns->send_packet ($ns->{query_queue}[0][0]); 2478 $ns->send_packet ($ns->{query_queue}[0][0]);
2191 } else { 2479 } else {
2192 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2480 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2193 } 2481 }
2194 } 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;
2195 }, 2501 },
2196); 2502);
2197 2503
2198=item $client->async (\&cb) 2504=item $client->async (\&cb)
2199 2505
2338=back 2644=back
2339 2645
2340=cut 2646=cut
2341 2647
2342############################################################################# 2648#############################################################################
2343
2344=head2 EXTENSION DATABASE SUPPORT
2345
2346Crossfire maintains a very simple database for extension use. It can
2347currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2348convert to/from binary).
2349
2350The parameter C<$family> should best start with the name of the extension
2351using it, it should be unique.
2352
2353=over 4
2354
2355=item $value = cf::db_get $family => $key
2356
2357Returns a single value from the database.
2358
2359=item cf::db_put $family => $key => $value
2360
2361Stores the given C<$value> in the family.
2362
2363=cut
2364
2365our $DB;
2366
2367sub db_init {
2368 unless ($DB) {
2369 $DB = BDB::db_create $DB_ENV;
2370
2371 cf::sync_job {
2372 eval {
2373 $DB->set_flags (BDB::CHKSUM);
2374
2375 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2376 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2377 cf::cleanup "db_open(db): $!" if $!;
2378 };
2379 cf::cleanup "db_open(db): $@" if $@;
2380 };
2381 }
2382}
2383
2384sub db_get($$) {
2385 my $key = "$_[0]/$_[1]";
2386
2387 cf::sync_job {
2388 BDB::db_get $DB, undef, $key, my $data;
2389
2390 $! ? ()
2391 : $data
2392 }
2393}
2394
2395sub db_put($$$) {
2396 BDB::dbreq_pri 4;
2397 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2398}
2399
2400=item cf::cache $id => [$paths...], $processversion => $process
2401
2402Generic caching function that returns the value of the resource $id,
2403caching and regenerating as required.
2404
2405This function can block.
2406
2407=cut
2408
2409sub cache {
2410 my ($id, $src, $processversion, $process) = @_;
2411
2412 my $meta =
2413 join "\x00",
2414 $processversion,
2415 map {
2416 aio_stat $_
2417 and Carp::croak "$_: $!";
2418
2419 ($_, (stat _)[7,9])
2420 } @$src;
2421
2422 my $dbmeta = db_get cache => "$id/meta";
2423 if ($dbmeta ne $meta) {
2424 # changed, we may need to process
2425
2426 my @data;
2427 my $md5;
2428
2429 for (0 .. $#$src) {
2430 0 <= aio_load $src->[$_], $data[$_]
2431 or Carp::croak "$src->[$_]: $!";
2432 }
2433
2434 # if processing is expensive, check
2435 # checksum first
2436 if (1) {
2437 $md5 =
2438 join "\x00",
2439 $processversion,
2440 map {
2441 Coro::cede;
2442 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2443 } 0.. $#$src;
2444
2445
2446 my $dbmd5 = db_get cache => "$id/md5";
2447 if ($dbmd5 eq $md5) {
2448 db_put cache => "$id/meta", $meta;
2449
2450 return db_get cache => "$id/data";
2451 }
2452 }
2453
2454 my $t1 = Time::HiRes::time;
2455 my $data = $process->(\@data);
2456 my $t2 = Time::HiRes::time;
2457
2458 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2459
2460 db_put cache => "$id/data", $data;
2461 db_put cache => "$id/md5" , $md5;
2462 db_put cache => "$id/meta", $meta;
2463
2464 return $data;
2465 }
2466
2467 db_get cache => "$id/data"
2468}
2469
2470=item fork_call { }, $args
2471
2472Executes the given code block with the given arguments in a seperate
2473process, returning the results. Everything must be serialisable with
2474Coro::Storable. May, of course, block. Note that the executed sub may
2475never block itself or use any form of Event handling.
2476
2477=cut
2478
2479sub fork_call(&@) {
2480 my ($cb, @args) = @_;
2481
2482# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2483# or die "socketpair: $!";
2484 pipe my $fh1, my $fh2
2485 or die "pipe: $!";
2486
2487 if (my $pid = fork) {
2488 close $fh2;
2489
2490 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2491 $res = Coro::Storable::thaw $res;
2492
2493 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2494
2495 die $$res unless "ARRAY" eq ref $res;
2496
2497 return wantarray ? @$res : $res->[-1];
2498 } else {
2499 reset_signals;
2500 local $SIG{__WARN__};
2501 local $SIG{__DIE__};
2502 eval {
2503 close $fh1;
2504
2505 my @res = eval { $cb->(@args) };
2506 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2507 };
2508
2509 warn $@ if $@;
2510 _exit 0;
2511 }
2512}
2513
2514
2515
2516#############################################################################
2517# the server's init and main functions 2649# the server's init and main functions
2518 2650
2519sub load_facedata($) { 2651sub load_facedata($) {
2520 my ($path) = @_; 2652 my ($path) = @_;
2521 2653
2591sub reload_resources { 2723sub reload_resources {
2592 warn "reloading resource files...\n"; 2724 warn "reloading resource files...\n";
2593 2725
2594 reload_regions; 2726 reload_regions;
2595 reload_facedata; 2727 reload_facedata;
2728 #reload_archetypes;#d#
2596 reload_archetypes; 2729 reload_archetypes;
2597 reload_treasures; 2730 reload_treasures;
2598 2731
2599 warn "finished reloading resource files\n"; 2732 warn "finished reloading resource files\n";
2600} 2733}
2657 }, 2790 },
2658 ); 2791 );
2659 } 2792 }
2660} 2793}
2661 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
2662sub emergency_save() { 2833sub emergency_save() {
2663 my $freeze_guard = cf::freeze_mainloop; 2834 my $freeze_guard = cf::freeze_mainloop;
2664 2835
2665 warn "enter emergency perl save\n"; 2836 warn "enter emergency perl save\n";
2666 2837
2741 %EXT_CORO = (); 2912 %EXT_CORO = ();
2742 2913
2743 warn "removing commands"; 2914 warn "removing commands";
2744 %COMMAND = (); 2915 %COMMAND = ();
2745 2916
2746 warn "removing ext commands"; 2917 warn "removing ext/exti commands";
2747 %EXTCMD = (); 2918 %EXTCMD = ();
2919 %EXTICMD = ();
2748 2920
2749 warn "unloading/nuking all extensions"; 2921 warn "unloading/nuking all extensions";
2750 for my $pkg (@EXTS) { 2922 for my $pkg (@EXTS) {
2751 warn "... unloading $pkg"; 2923 warn "... unloading $pkg";
2752 2924

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines