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.266 by root, Fri May 18 01:01:02 2007 UTC vs.
Revision 1.308 by root, Mon Jul 16 14:09:40 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 ();
30use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
31use Time::HiRes; 32use Time::HiRes;
32use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
33 35
34# configure various modules to our taste 36# configure various modules to our taste
35# 37#
36$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 51our %COMMAND = ();
50our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
51 53
52our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
56 59
57our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
58our @EVENT; 61our @EVENT;
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 190@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 191@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 192@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 193@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 194@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
195@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 196@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193 197
194# we bless all objects into (empty) derived classes to force a method lookup 198# we bless all objects into (empty) derived classes to force a method lookup
195# within the Safe compartment. 199# within the Safe compartment.
196for my $pkg (qw( 200for my $pkg (qw(
197 cf::global cf::attachable 201 cf::global cf::attachable
205} 209}
206 210
207$Event::DIED = sub { 211$Event::DIED = sub {
208 warn "error in event callback: @_"; 212 warn "error in event callback: @_";
209}; 213};
214
215#############################################################################
210 216
211=head2 UTILITY FUNCTIONS 217=head2 UTILITY FUNCTIONS
212 218
213=over 4 219=over 4
214 220
233 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 239 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234 $d 240 $d
235 } || "[unable to dump $_[0]: '$@']"; 241 } || "[unable to dump $_[0]: '$@']";
236} 242}
237 243
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
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->utf8->max_size (1e6); # accept ~1mb max
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 _store_scalar {
405 416 open my $fh, ">", \my $buf
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 417 or die "fork_call: cannot open fh-to-buf in child : $!";
407 or return; 418 Storable::store_fd $_[0], $fh;
408
409 my $value = $cf::RUNTIME + 90 + 10;
410 # 10 is the runtime save interval, for a monotonic clock
411 # 60 allows for the watchdog to kill the server.
412
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0
414 and return;
415
416 # always fsync - this file is important
417 aio_fsync $fh
418 and return;
419
420 # touch it again to show we are up-to-date
421 utime undef, undef, $fh;
422
423 close $fh 419 close $fh;
424 or return;
425 420
426 aio_rename "$runtime~", $runtime 421 $buf
427 and return; 422}
428 423
429 warn "runtime file written.\n";#d# 424sub fork_call(&@) {
425 my ($cb, @args) = @_;
430 426
427# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
428# or die "socketpair: $!";
429 pipe my $fh1, my $fh2
430 or die "pipe: $!";
431
432 if (my $pid = fork) {
433 close $fh2;
434
435 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
436 warn "pst<$res>" unless $res =~ /^pst/;
437 $res = Coro::Storable::thaw $res;
438
439 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
440
441 Carp::confess $$res unless "ARRAY" eq ref $res;
442
443 return wantarray ? @$res : $res->[-1];
444 } else {
445 reset_signals;
446 local $SIG{__WARN__};
447 local $SIG{__DIE__};
448 # just in case, this hack effectively disables event
449 # in the child. cleaner and slower would be canceling all watchers,
450 # but this works for the time being.
451 local $Coro::idle;
452 $Coro::current->prio (Coro::PRIO_MAX);
453
454 eval {
455 close $fh1;
456
457 my @res = eval { $cb->(@args) };
458
459 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
460 close $fh2;
461 };
462
463 warn $@ if $@;
464 _exit 0;
431 1 465 }
466}
467
468=item $value = cf::db_get $family => $key
469
470Returns a single value from the environment database.
471
472=item cf::db_put $family => $key => $value
473
474Stores the given C<$value> in the family. It can currently store binary
475data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
476
477=cut
478
479our $DB;
480
481sub db_init {
482 unless ($DB) {
483 $DB = BDB::db_create $DB_ENV;
484
485 cf::sync_job {
486 eval {
487 $DB->set_flags (BDB::CHKSUM);
488
489 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
490 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
491 cf::cleanup "db_open(db): $!" if $!;
492 };
493 cf::cleanup "db_open(db): $@" if $@;
494 };
495 }
496}
497
498sub db_get($$) {
499 my $key = "$_[0]/$_[1]";
500
501 cf::sync_job {
502 BDB::db_get $DB, undef, $key, my $data;
503
504 $! ? ()
505 : $data
506 }
507}
508
509sub db_put($$$) {
510 BDB::dbreq_pri 4;
511 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
512}
513
514=item cf::cache $id => [$paths...], $processversion => $process
515
516Generic caching function that returns the value of the resource $id,
517caching and regenerating as required.
518
519This function can block.
520
521=cut
522
523sub cache {
524 my ($id, $src, $processversion, $process) = @_;
525
526 my $meta =
527 join "\x00",
528 $processversion,
529 map {
530 aio_stat $_
531 and Carp::croak "$_: $!";
532
533 ($_, (stat _)[7,9])
534 } @$src;
535
536 my $dbmeta = db_get cache => "$id/meta";
537 if ($dbmeta ne $meta) {
538 # changed, we may need to process
539
540 my @data;
541 my $md5;
542
543 for (0 .. $#$src) {
544 0 <= aio_load $src->[$_], $data[$_]
545 or Carp::croak "$src->[$_]: $!";
546 }
547
548 # if processing is expensive, check
549 # checksum first
550 if (1) {
551 $md5 =
552 join "\x00",
553 $processversion,
554 map {
555 Coro::cede;
556 ($src->[$_], Digest::MD5::md5_hex $data[$_])
557 } 0.. $#$src;
558
559
560 my $dbmd5 = db_get cache => "$id/md5";
561 if ($dbmd5 eq $md5) {
562 db_put cache => "$id/meta", $meta;
563
564 return db_get cache => "$id/data";
565 }
566 }
567
568 my $t1 = Time::HiRes::time;
569 my $data = $process->(\@data);
570 my $t2 = Time::HiRes::time;
571
572 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
573
574 db_put cache => "$id/data", $data;
575 db_put cache => "$id/md5" , $md5;
576 db_put cache => "$id/meta", $meta;
577
578 return $data;
579 }
580
581 db_get cache => "$id/data"
432} 582}
433 583
434=item cf::datalog type => key => value, ... 584=item cf::datalog type => key => value, ...
435 585
436Log a datalog packet of the given type with the given key-value pairs. 586Log 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") 604attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 605to it. All such attachable objects support the following methods.
456 606
457In the following description, CLASS can be any of C<global>, C<object> 607In 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 608C<player>, C<client> or C<map> (i.e. the attachable objects in
459crossfire+). 609Crossfire TRT).
460 610
461=over 4 611=over 4
462 612
463=item $attachable->attach ($attachment, key => $value...) 613=item $attachable->attach ($attachment, key => $value...)
464 614
627 $registry = $CB_TYPE[$object_type] ||= []; 777 $registry = $CB_TYPE[$object_type] ||= [];
628 778
629 } elsif ($type eq "subtype") { 779 } elsif ($type eq "subtype") {
630 defined $object_type or Carp::croak "subtype specified without type"; 780 defined $object_type or Carp::croak "subtype specified without type";
631 my $object_subtype = shift @arg; 781 my $object_subtype = shift @arg;
632 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 782 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633 783
634 } elsif ($type eq "package") { 784 } elsif ($type eq "package") {
635 my $pkg = shift @arg; 785 my $pkg = shift @arg;
636 786
637 while (my ($name, $id) = each %cb_id) { 787 while (my ($name, $id) = each %cb_id) {
666 _attach $registry, $klass, @attach; 816 _attach $registry, $klass, @attach;
667 } 817 }
668 818
669 $obj->{$name} = \%arg; 819 $obj->{$name} = \%arg;
670 } else { 820 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 821 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 822 }
673 823
674 $obj->{_attachment}{$name} = undef; 824 $obj->{_attachment}{$name} = undef;
675} 825}
676 826
678 if (ref $_[0]) { 828 if (ref $_[0]) {
679 _object_attach @_; 829 _object_attach @_;
680 } else { 830 } else {
681 _attach shift->_attach_registry, @_; 831 _attach shift->_attach_registry, @_;
682 } 832 }
833 _recalc_want;
683}; 834};
684 835
685# all those should be optimised 836# all those should be optimised
686sub cf::attachable::detach { 837sub cf::attachable::detach {
687 my ($obj, $name) = @_; 838 my ($obj, $name) = @_;
690 delete $obj->{_attachment}{$name}; 841 delete $obj->{_attachment}{$name};
691 reattach ($obj); 842 reattach ($obj);
692 } else { 843 } else {
693 Carp::croak "cannot, currently, detach class attachments"; 844 Carp::croak "cannot, currently, detach class attachments";
694 } 845 }
846 _recalc_want;
695}; 847};
696 848
697sub cf::attachable::attached { 849sub cf::attachable::attached {
698 my ($obj, $name) = @_; 850 my ($obj, $name) = @_;
699 851
872 or return; 1024 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1025 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1026 }
875 1027
876 warn sprintf "loading %s (%d)\n", 1028 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1029 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1030 return ($data, $av);
879} 1031}
1032
1033=head2 COMMAND CALLBACKS
1034
1035=over 4
1036
1037=cut
880 1038
881############################################################################# 1039#############################################################################
882# command handling &c 1040# command handling &c
883 1041
884=item cf::register_command $name => \&callback($ob,$args); 1042=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1055 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1056}
899 1057
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1058=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1059
902Register a callbackf ro execution when the client sends an extcmd packet. 1060Register a callback for execution when the client sends an (synchronous)
1061extcmd packet. Ext commands will be processed in the order they are
1062received by the server, like other user commands. The first argument is
1063the logged-in player. Ext commands can only be processed after a player
1064has logged in successfully.
903 1065
904If the callback returns something, it is sent back as if reply was being 1066If the callback returns something, it is sent back as if reply was being
905called. 1067called.
906 1068
1069=item cf::register_exticmd $name => \&callback($ns,$packet);
1070
1071Register a callback for execution when the client sends an (asynchronous)
1072exticmd packet. Exti commands are processed by the server as soon as they
1073are received, i.e. out of order w.r.t. other commands. The first argument
1074is a client socket. Exti commands can be received anytime, even before
1075log-in.
1076
1077If the callback returns something, it is sent back as if reply was being
1078called.
1079
907=cut 1080=cut
908 1081
909sub register_extcmd { 1082sub register_extcmd {
910 my ($name, $cb) = @_; 1083 my ($name, $cb) = @_;
911 1084
912 $EXTCMD{$name} = $cb; 1085 $EXTCMD{$name} = $cb;
1086}
1087
1088sub register_exticmd {
1089 my ($name, $cb) = @_;
1090
1091 $EXTICMD{$name} = $cb;
913} 1092}
914 1093
915cf::player->attach ( 1094cf::player->attach (
916 on_command => sub { 1095 on_command => sub {
917 my ($pl, $name, $params) = @_; 1096 my ($pl, $name, $params) = @_;
926 cf::override; 1105 cf::override;
927 }, 1106 },
928 on_extcmd => sub { 1107 on_extcmd => sub {
929 my ($pl, $buf) = @_; 1108 my ($pl, $buf) = @_;
930 1109
931 my $msg = eval { from_json $buf }; 1110 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932 1111
933 if (ref $msg) { 1112 if (ref $msg) {
934 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1113 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935 if (my %reply = $cb->($pl, $msg)) { 1114 if (my %reply = $cb->($pl, $msg)) {
936 $pl->ext_reply ($msg->{msgid}, %reply); 1115 $pl->ext_reply ($msg->{msgid}, %reply);
942 1121
943 cf::override; 1122 cf::override;
944 }, 1123 },
945); 1124);
946 1125
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 { 1126sub load_extensions {
1127 cf::sync_job {
1128 my %todo;
1129
982 for my $ext (<$LIBDIR/*.ext>) { 1130 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1131 next unless -r $path;
984 eval { 1132
985 load_extension $ext; 1133 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1134 my $base = $1;
1135 my $pkg = $1;
1136 $pkg =~ s/[^[:word:]]/_/g;
1137 $pkg = "ext::$pkg";
1138
1139 open my $fh, "<:utf8", $path
1140 or die "$path: $!";
1141
1142 my $source = do { local $/; <$fh> };
1143
1144 my %ext = (
1145 path => $path,
1146 base => $base,
1147 pkg => $pkg,
1148 );
1149
1150 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1151 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1152
1153 $ext{source} =
1154 "package $pkg; use strict; use utf8;\n"
1155 . "#line 1 \"$path\"\n{\n"
1156 . $source
1157 . "\n};\n1";
1158
1159 $todo{$base} = \%ext;
1160 }
1161
1162 my %done;
1163 while (%todo) {
1164 my $progress;
1165
1166 while (my ($k, $v) = each %todo) {
1167 for (split /,\s*/, $v->{meta}{depends}) {
1168 goto skip
1169 unless exists $done{$_};
1170 }
1171
1172 warn "... loading '$k' into '$v->{pkg}'\n";
1173
1174 unless (eval $v->{source}) {
1175 my $msg = $@ ? "$v->{path}: $@\n"
1176 : "$v->{base}: extension inactive.\n";
1177
1178 if (exists $v->{meta}{mandatory}) {
1179 warn $msg;
1180 warn "mandatory extension failed to load, exiting.\n";
1181 exit 1;
1182 }
1183
1184 warn $msg;
1185 }
1186
1187 $done{$k} = delete $todo{$k};
1188 push @EXTS, $v->{pkg};
1189 $progress = 1;
986 1 1190 }
987 } or warn "$ext not loaded: $@"; 1191
1192 skip:
1193 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1194 unless $progress;
1195 }
988 } 1196 };
989} 1197}
990 1198
991############################################################################# 1199#############################################################################
1200
1201=back
992 1202
993=head2 CORE EXTENSIONS 1203=head2 CORE EXTENSIONS
994 1204
995Functions and methods that extend core crossfire objects. 1205Functions and methods that extend core crossfire objects.
996 1206
1184 } 1394 }
1185 1395
1186 \@paths 1396 \@paths
1187} 1397}
1188 1398
1399=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1400
1401Expand crossfire pod fragments into protocol xml.
1402
1403=cut
1404
1405sub expand_cfpod {
1406 ((my $self), (local $_)) = @_;
1407
1408 # escape & and <
1409 s/&/&amp;/g;
1410 s/(?<![BIUGH])</&lt;/g;
1411
1412 # this is buggy, it needs to properly take care of nested <'s
1413
1414 1 while
1415 # replace B<>, I<>, U<> etc.
1416 s/B<([^\>]*)>/<b>$1<\/b>/
1417 || s/I<([^\>]*)>/<i>$1<\/i>/
1418 || s/U<([^\>]*)>/<u>$1<\/u>/
1419 # replace G<male|female> tags
1420 || s{G<([^>|]*)\|([^>]*)>}{
1421 $self->gender ? $2 : $1
1422 }ge
1423 # replace H<hint text>
1424 || s{H<([^\>]*)>}
1425 {
1426 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1427 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1428 "")
1429 [$self->{hintmode}]
1430 }ge;
1431
1432 # create single paragraphs (very hackish)
1433 s/(?<=\S)\n(?=\w)/ /g;
1434
1435 # compress some whitespace
1436 s/\s+\n/\n/g; # ws line-ends
1437 s/\n\n+/\n/g; # double lines
1438 s/^\n+//; # beginning lines
1439 s/\n+$//; # ending lines
1440
1441 $_
1442}
1443
1444sub hintmode {
1445 $_[0]{hintmode} = $_[1] if @_ > 1;
1446 $_[0]{hintmode}
1447}
1448
1189=item $player->ext_reply ($msgid, %msg) 1449=item $player->ext_reply ($msgid, %msg)
1190 1450
1191Sends an ext reply to the player. 1451Sends an ext reply to the player.
1192 1452
1193=cut 1453=cut
1194 1454
1195sub ext_reply($$%) { 1455sub ext_reply($$%) {
1196 my ($self, $id, %msg) = @_; 1456 my ($self, $id, %msg) = @_;
1197 1457
1198 $msg{msgid} = $id; 1458 $msg{msgid} = $id;
1199 1459 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200 $self->send ("ext " . cf::to_json \%msg);
1201} 1460}
1202 1461
1203=item $player->ext_event ($type, %msg) 1462=item $player->ext_event ($type, %msg)
1204 1463
1205Sends an ext event to the client. 1464Sends an ext event to the client.
1220 1479
1221package cf::region; 1480package cf::region;
1222 1481
1223=item cf::region::find_by_path $path 1482=item cf::region::find_by_path $path
1224 1483
1225Tries to decuce the probable region for a map knowing only its path. 1484Tries to decuce the likely region for a map knowing only its path.
1226 1485
1227=cut 1486=cut
1228 1487
1229sub find_by_path($) { 1488sub find_by_path($) {
1230 my ($path) = @_; 1489 my ($path) = @_;
1231 1490
1232 my ($match, $specificity); 1491 my ($match, $specificity);
1233 1492
1234 for my $region (list) { 1493 for my $region (list) {
1235 if ($region->match && $path =~ $region->match) { 1494 if ($region->{match} && $path =~ $region->{match}) {
1236 ($match, $specificity) = ($region, $region->specificity) 1495 ($match, $specificity) = ($region, $region->specificity)
1237 if $region->specificity > $specificity; 1496 if $region->specificity > $specificity;
1238 } 1497 }
1239 } 1498 }
1240 1499
1304 my ($self, $merge) = @_; 1563 my ($self, $merge) = @_;
1305 1564
1306 # we have to keep some variables in memory intact 1565 # we have to keep some variables in memory intact
1307 local $self->{path}; 1566 local $self->{path};
1308 local $self->{load_path}; 1567 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1568
1312 $self->SUPER::thawer_merge ($merge); 1569 $self->SUPER::thawer_merge ($merge);
1313} 1570}
1314 1571
1315sub normalise { 1572sub normalise {
1362 $self->init; # pass $1 etc. 1619 $self->init; # pass $1 etc.
1363 return $self; 1620 return $self;
1364 } 1621 }
1365 } 1622 }
1366 1623
1367 Carp::carp "unable to resolve path '$path' (base '$base')."; 1624 Carp::cluck "unable to resolve path '$path' (base '$base').";
1368 () 1625 ()
1369} 1626}
1370 1627
1371sub init { 1628sub init {
1372 my ($self) = @_; 1629 my ($self) = @_;
1413sub change_all_map_light { 1670sub change_all_map_light {
1414 my ($change) = @_; 1671 my ($change) = @_;
1415 1672
1416 $_->change_map_light ($change) 1673 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1674 for grep $_->outdoor, values %cf::MAP;
1675}
1676
1677sub decay_objects {
1678 my ($self) = @_;
1679
1680 return if $self->{deny_reset};
1681
1682 $self->do_decay_objects;
1418} 1683}
1419 1684
1420sub unlink_save { 1685sub unlink_save {
1421 my ($self) = @_; 1686 my ($self) = @_;
1422 1687
1480 $self->load_header_orig 1745 $self->load_header_orig
1481 or return; 1746 or return;
1482 $self->prepare_orig; 1747 $self->prepare_orig;
1483 } 1748 }
1484 1749
1750 $self->{deny_reset} = 1
1751 if $self->no_reset;
1752
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1753 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1754 unless $self->default_region;
1487 1755
1488 1 1756 1
1489} 1757}
1504 $map->{last_save} = $cf::RUNTIME; 1772 $map->{last_save} = $cf::RUNTIME;
1505 1773
1506 $map->load_header 1774 $map->load_header
1507 or return; 1775 or return;
1508 1776
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1777 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1778 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1779 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1780 $map->reset;
1513 undef $guard; 1781 undef $guard;
1514 return find $path; 1782 return find $path;
1581 my ($self, $ob) = @_; 1849 my ($self, $ob) = @_;
1582 1850
1583 return find "~" . $ob->name . "/" . $self->{path} 1851 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1852 if $self->per_player;
1585 1853
1854# return find "?party/" . $ob->name . "/" . $self->{path}
1855# if $self->per_party;
1856
1586 $self 1857 $self
1587} 1858}
1588 1859
1589# find and load all maps in the 3x3 area around a map 1860# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1861sub load_diag {
1636 1907
1637 undef $MAP_PREFETCH{$path}; 1908 undef $MAP_PREFETCH{$path};
1638 $MAP_PREFETCHER ||= cf::async { 1909 $MAP_PREFETCHER ||= cf::async {
1639 while (%MAP_PREFETCH) { 1910 while (%MAP_PREFETCH) {
1640 for my $path (keys %MAP_PREFETCH) { 1911 for my $path (keys %MAP_PREFETCH) {
1641 my $map = find $path 1912 if (my $map = find $path) {
1642 or next;
1643 $map->load; 1913 $map->load;
1914 }
1644 1915
1645 delete $MAP_PREFETCH{$path}; 1916 delete $MAP_PREFETCH{$path};
1646 } 1917 }
1647 } 1918 }
1648 undef $MAP_PREFETCHER; 1919 undef $MAP_PREFETCHER;
1700 1971
1701sub reset_at { 1972sub reset_at {
1702 my ($self) = @_; 1973 my ($self) = @_;
1703 1974
1704 # TODO: safety, remove and allow resettable per-player maps 1975 # 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}; 1976 return 1e99 if $self->{deny_reset};
1707 1977
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1978 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1979 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 1980
1721 my ($self) = @_; 1991 my ($self) = @_;
1722 1992
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1993 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 1994
1725 return if $self->players; 1995 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 1996
1728 warn "resetting map ", $self->path;#d# 1997 warn "resetting map ", $self->path;
1729 1998
1730 $self->in_memory (cf::MAP_SWAPPED); 1999 $self->in_memory (cf::MAP_SWAPPED);
1731 2000
1732 # need to save uniques path 2001 # need to save uniques path
1733 unless ($self->{deny_save}) { 2002 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2034 $cf::MAP{$self->path} = $self;
1766 2035
1767 $self->reset; # polite request, might not happen 2036 $self->reset; # polite request, might not happen
1768} 2037}
1769 2038
2039=item $maps = cf::map::tmp_maps
2040
2041Returns an arrayref with all map paths of currently instantiated and saved
2042maps. May block.
2043
2044=cut
2045
2046sub tmp_maps() {
2047 [
2048 map {
2049 utf8::decode $_;
2050 /\.map$/
2051 ? normalise $_
2052 : ()
2053 } @{ aio_readdir $TMPDIR or [] }
2054 ]
2055}
2056
2057=item $maps = cf::map::random_maps
2058
2059Returns an arrayref with all map paths of currently instantiated and saved
2060random maps. May block.
2061
2062=cut
2063
2064sub random_maps() {
2065 [
2066 map {
2067 utf8::decode $_;
2068 /\.map$/
2069 ? normalise "?random/$_"
2070 : ()
2071 } @{ aio_readdir $RANDOMDIR or [] }
2072 ]
2073}
2074
1770=item cf::map::unique_maps 2075=item cf::map::unique_maps
1771 2076
1772Returns an arrayref of paths of all shared maps that have 2077Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2078instantiated unique items. May block.
1774 2079
1775=cut 2080=cut
1776 2081
1777sub unique_maps() { 2082sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2083 [
1779 or return; 2084 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2085 utf8::decode $_;
1785 next if /\.pst$/; 2086 /\.map$/
1786 next unless /^$PATH_SEP/o; 2087 ? normalise $_
1787 2088 : ()
1788 push @paths, cf::map::normalise $_; 2089 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2090 ]
1790
1791 \@paths
1792} 2091}
1793 2092
1794package cf; 2093package cf;
1795 2094
1796=back 2095=back
1842 2141
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2142 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2143
1845 if ($self->{record_replies}) { 2144 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2145 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2146
1847 } else { 2147 } else {
2148 my $pl = $self->contr;
2149
2150 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2151 my $diag = $pl->{npc_dialog};
2152 $diag->{pl}->ext_reply (
2153 $diag->{id},
2154 msgtype => "reply",
2155 msg => $diag->{pl}->expand_cfpod ($msg),
2156 add_topics => []
2157 );
2158
2159 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2160 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2161 $self->message ($msg, $flags);
2162 }
1850 } 2163 }
1851} 2164}
1852 2165
1853=item $player_object->may ("access") 2166=item $player_object->may ("access")
1854 2167
1902 $self->deactivate_recursive; 2215 $self->deactivate_recursive;
1903 2216
1904 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2217 return if UNIVERSAL::isa $self->map, "ext::map_link";
1905 2218
1906 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2219 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1907 if $self->map; 2220 if $self->map && $self->map->{path} ne "{link}";
1908 2221
1909 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2222 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1910} 2223}
1911 2224
1912sub cf::object::player::leave_link { 2225sub cf::object::player::leave_link {
1913 my ($self, $map, $x, $y) = @_; 2226 my ($self, $map, $x, $y) = @_;
2227
2228 return unless $self->contr->active;
1914 2229
1915 my $link_pos = delete $self->{_link_pos}; 2230 my $link_pos = delete $self->{_link_pos};
1916 2231
1917 unless ($map) { 2232 unless ($map) {
1918 # restore original map position 2233 # restore original map position
1941 2256
1942 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2257 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1943 $self->enter_map ($map, $x, $y); 2258 $self->enter_map ($map, $x, $y);
1944} 2259}
1945 2260
1946cf::player->attach ( 2261=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1947 on_logout => sub {
1948 my ($pl) = @_;
1949 2262
1950 # abort map switching before logout 2263Moves the player to the given map-path and coordinates by first freezing
1951 if ($pl->ob->{_link_pos}) { 2264her, loading and preparing them map, calling the provided $check callback
1952 cf::sync_job { 2265that has to return the map if sucecssful, and then unfreezes the player on
1953 $pl->ob->leave_link 2266the new (success) or old (failed) map position. In either case, $done will
1954 }; 2267be called at the end of this process.
1955 }
1956 },
1957 on_login => sub {
1958 my ($pl) = @_;
1959 2268
1960 # try to abort aborted map switching on player login :)
1961 # should happen only on crashes
1962 if ($pl->ob->{_link_pos}) {
1963 $pl->ob->enter_link;
1964 (async {
1965 $pl->ob->reply (undef,
1966 "There was an internal problem at your last logout, "
1967 . "the server will try to bring you to your intended destination in a second.",
1968 cf::NDI_RED);
1969 # we need this sleep as the login has a concurrent enter_exit running
1970 # and this sleep increases chances of the player not ending up in scorn
1971 Coro::Timer::sleep 1;
1972 $pl->ob->leave_link;
1973 })->prio (2);
1974 }
1975 },
1976);
1977
1978=item $player_object->goto ($path, $x, $y)
1979
1980=cut 2269=cut
2270
2271our $GOTOGEN;
1981 2272
1982sub cf::object::player::goto { 2273sub cf::object::player::goto {
1983 my ($self, $path, $x, $y) = @_; 2274 my ($self, $path, $x, $y, $check, $done) = @_;
2275
2276 # do generation counting so two concurrent goto's will be executed in-order
2277 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1984 2278
1985 $self->enter_link; 2279 $self->enter_link;
1986 2280
1987 (async { 2281 (async {
1988 my $map = eval { 2282 my $map = eval {
1989 my $map = cf::map::find $path; 2283 my $map = cf::map::find $path;
2284
2285 if ($map) {
1990 $map = $map->customise_for ($self) if $map; 2286 $map = $map->customise_for ($self);
2287 $map = $check->($map) if $check && $map;
2288 } else {
2289 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2290 }
2291
1991 $map 2292 $map
2293 };
2294
2295 if ($@) {
2296 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2297 LOG llevError | logBacktrace, Carp::longmess $@;
1992 } or 2298 }
1993 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1994 2299
2300 if ($gen == $self->{_goto_generation}) {
2301 delete $self->{_goto_generation};
1995 $self->leave_link ($map, $x, $y); 2302 $self->leave_link ($map, $x, $y);
2303 }
2304
2305 $done->() if $done;
1996 })->prio (1); 2306 })->prio (1);
1997} 2307}
1998 2308
1999=item $player_object->enter_exit ($exit_object) 2309=item $player_object->enter_exit ($exit_object)
2000 2310
2069 my $hp = $exit->stats->hp; 2379 my $hp = $exit->stats->hp;
2070 my $sp = $exit->stats->sp; 2380 my $sp = $exit->stats->sp;
2071 2381
2072 $self->enter_link; 2382 $self->enter_link;
2073 2383
2384 # if exit is damned, update players death & WoR home-position
2385 $self->contr->savebed ($slaying, $hp, $sp)
2386 if $exit->flag (FLAG_DAMNED);
2387
2074 (async { 2388 (async {
2075 $self->deactivate_recursive; # just to be sure 2389 $self->deactivate_recursive; # just to be sure
2076 unless (eval { 2390 unless (eval {
2077 $self->goto ($slaying, $hp, $sp); 2391 $self->goto ($slaying, $hp, $sp);
2078 2392
2105 2419
2106 utf8::encode $text; 2420 utf8::encode $text;
2107 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2421 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2108} 2422}
2109 2423
2424=item $client->send_msg ($color, $type, $msg, [extra...])
2425
2426Send a drawinfo or msg packet to the client, formatting the msg for the
2427client if neccessary. C<$type> should be a string identifying the type of
2428the message, with C<log> being the default. If C<$color> is negative, suppress
2429the message unless the client supports the msg packet.
2430
2431=cut
2432
2433sub cf::client::send_msg {
2434 my ($self, $color, $type, $msg, @extra) = @_;
2435
2436 $msg = $self->pl->expand_cfpod ($msg);
2437
2438 return unless @extra || length $msg;
2439
2440 if ($self->can_msg) {
2441 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2442 } else {
2443 # replace some tags by gcfclient-compatible ones
2444 for ($msg) {
2445 1 while
2446 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2447 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2448 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2449 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2450 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2451 }
2452
2453 if ($color >= 0) {
2454 if (0 && $msg =~ /\[/) {
2455 $self->send_packet ("drawextinfo $color 4 0 $msg")
2456 } else {
2457 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2458 $self->send_packet ("drawinfo $color $msg")
2459 }
2460 }
2461 }
2462}
2463
2110=item $client->ext_event ($type, %msg) 2464=item $client->ext_event ($type, %msg)
2111 2465
2112Sends an exti event to the client. 2466Sends an ext event to the client.
2113 2467
2114=cut 2468=cut
2115 2469
2116sub cf::client::ext_event($$%) { 2470sub cf::client::ext_event($$%) {
2117 my ($self, $type, %msg) = @_; 2471 my ($self, $type, %msg) = @_;
2118 2472
2473 return unless $self->extcmd;
2474
2119 $msg{msgtype} = "event_$type"; 2475 $msg{msgtype} = "event_$type";
2120 $self->send_packet ("ext " . cf::to_json \%msg); 2476 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2121} 2477}
2122 2478
2123=item $success = $client->query ($flags, "text", \&cb) 2479=item $success = $client->query ($flags, "text", \&cb)
2124 2480
2125Queues a query to the client, calling the given callback with 2481Queues a query to the client, calling the given callback with
2126the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2482the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2127C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2483C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2128 2484
2129Queries can fail, so check the return code. Or don't, as queries will become 2485Queries can fail, so check the return code. Or don't, as queries will
2130reliable at some point in the future. 2486become reliable at some point in the future.
2131 2487
2132=cut 2488=cut
2133 2489
2134sub cf::client::query { 2490sub cf::client::query {
2135 my ($self, $flags, $text, $cb) = @_; 2491 my ($self, $flags, $text, $cb) = @_;
2143 utf8::encode $text; 2499 utf8::encode $text;
2144 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2500 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2145 2501
2146 $self->send_packet ($self->{query_queue}[0][0]) 2502 $self->send_packet ($self->{query_queue}[0][0])
2147 if @{ $self->{query_queue} } == 1; 2503 if @{ $self->{query_queue} } == 1;
2504
2505 1
2148} 2506}
2149 2507
2150cf::client->attach ( 2508cf::client->attach (
2509 on_connect => sub {
2510 my ($ns) = @_;
2511
2512 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2513 },
2151 on_reply => sub { 2514 on_reply => sub {
2152 my ($ns, $msg) = @_; 2515 my ($ns, $msg) = @_;
2153 2516
2154 # this weird shuffling is so that direct followup queries 2517 # this weird shuffling is so that direct followup queries
2155 # get handled first 2518 # get handled first
2167 } else { 2530 } else {
2168 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2531 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2169 } 2532 }
2170 } 2533 }
2171 }, 2534 },
2535 on_exticmd => sub {
2536 my ($ns, $buf) = @_;
2537
2538 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2539
2540 if (ref $msg) {
2541 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2542 if (my %reply = $cb->($ns, $msg)) {
2543 $reply{msgid} = $msg->{msgid};
2544 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2545 }
2546 }
2547 } else {
2548 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2549 }
2550
2551 cf::override;
2552 },
2172); 2553);
2173 2554
2174=item $client->async (\&cb) 2555=item $client->async (\&cb)
2175 2556
2176Create a new coroutine, running the specified callback. The coroutine will 2557Create a new coroutine, running the specified callback. The coroutine will
2225 2606
2226=pod 2607=pod
2227 2608
2228The following functions and methods are available within a safe environment: 2609The following functions and methods are available within a safe environment:
2229 2610
2230 cf::object contr pay_amount pay_player map 2611 cf::object
2612 contr pay_amount pay_player map x y force_find force_add
2613 insert remove
2614
2231 cf::object::player player 2615 cf::object::player
2232 cf::player peaceful 2616 player
2233 cf::map trigger 2617
2618 cf::player
2619 peaceful
2620
2621 cf::map
2622 trigger
2234 2623
2235=cut 2624=cut
2236 2625
2237for ( 2626for (
2238 ["cf::object" => qw(contr pay_amount pay_player map)], 2627 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2628 insert remove)],
2239 ["cf::object::player" => qw(player)], 2629 ["cf::object::player" => qw(player)],
2240 ["cf::player" => qw(peaceful)], 2630 ["cf::player" => qw(peaceful)],
2241 ["cf::map" => qw(trigger)], 2631 ["cf::map" => qw(trigger)],
2242) { 2632) {
2243 no strict 'refs'; 2633 no strict 'refs';
2314=back 2704=back
2315 2705
2316=cut 2706=cut
2317 2707
2318############################################################################# 2708#############################################################################
2319
2320=head2 EXTENSION DATABASE SUPPORT
2321
2322Crossfire maintains a very simple database for extension use. It can
2323currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2324convert to/from binary).
2325
2326The parameter C<$family> should best start with the name of the extension
2327using it, it should be unique.
2328
2329=over 4
2330
2331=item $value = cf::db_get $family => $key
2332
2333Returns a single value from the database.
2334
2335=item cf::db_put $family => $key => $value
2336
2337Stores the given C<$value> in the family.
2338
2339=cut
2340
2341our $DB;
2342
2343sub db_init {
2344 unless ($DB) {
2345 $DB = BDB::db_create $DB_ENV;
2346
2347 cf::sync_job {
2348 eval {
2349 $DB->set_flags (BDB::CHKSUM);
2350
2351 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2352 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2353 cf::cleanup "db_open(db): $!" if $!;
2354 };
2355 cf::cleanup "db_open(db): $@" if $@;
2356 };
2357 }
2358}
2359
2360sub db_get($$) {
2361 my $key = "$_[0]/$_[1]";
2362
2363 cf::sync_job {
2364 BDB::db_get $DB, undef, $key, my $data;
2365
2366 $! ? ()
2367 : $data
2368 }
2369}
2370
2371sub db_put($$$) {
2372 BDB::dbreq_pri 4;
2373 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2374}
2375
2376=item cf::cache $id => [$paths...], $processversion => $process
2377
2378Generic caching function that returns the value of the resource $id,
2379caching and regenerating as required.
2380
2381This function can block.
2382
2383=cut
2384
2385sub cache {
2386 my ($id, $src, $processversion, $process) = @_;
2387
2388 my $meta =
2389 join "\x00",
2390 $processversion,
2391 map {
2392 aio_stat $_
2393 and Carp::croak "$_: $!";
2394
2395 ($_, (stat _)[7,9])
2396 } @$src;
2397
2398 my $dbmeta = db_get cache => "$id/meta";
2399 if ($dbmeta ne $meta) {
2400 # changed, we may need to process
2401
2402 my @data;
2403 my $md5;
2404
2405 for (0 .. $#$src) {
2406 0 <= aio_load $src->[$_], $data[$_]
2407 or Carp::croak "$src->[$_]: $!";
2408 }
2409
2410 # if processing is expensive, check
2411 # checksum first
2412 if (1) {
2413 $md5 =
2414 join "\x00",
2415 $processversion,
2416 map {
2417 Coro::cede;
2418 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2419 } 0.. $#$src;
2420
2421
2422 my $dbmd5 = db_get cache => "$id/md5";
2423 if ($dbmd5 eq $md5) {
2424 db_put cache => "$id/meta", $meta;
2425
2426 return db_get cache => "$id/data";
2427 }
2428 }
2429
2430 my $t1 = Time::HiRes::time;
2431 my $data = $process->(\@data);
2432 my $t2 = Time::HiRes::time;
2433
2434 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2435
2436 db_put cache => "$id/data", $data;
2437 db_put cache => "$id/md5" , $md5;
2438 db_put cache => "$id/meta", $meta;
2439
2440 return $data;
2441 }
2442
2443 db_get cache => "$id/data"
2444}
2445
2446=item fork_call { }, $args
2447
2448Executes the given code block with the given arguments in a seperate
2449process, returning the results. Everything must be serialisable with
2450Coro::Storable. May, of course, block. Note that the executed sub may
2451never block itself or use any form of Event handling.
2452
2453=cut
2454
2455sub fork_call(&@) {
2456 my ($cb, @args) = @_;
2457
2458# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2459# or die "socketpair: $!";
2460 pipe my $fh1, my $fh2
2461 or die "pipe: $!";
2462
2463 if (my $pid = fork) {
2464 close $fh2;
2465
2466 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2467 $res = Coro::Storable::thaw $res;
2468
2469 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2470
2471 die $$res unless "ARRAY" eq ref $res;
2472
2473 return wantarray ? @$res : $res->[-1];
2474 } else {
2475 reset_signals;
2476 local $SIG{__WARN__};
2477 local $SIG{__DIE__};
2478 eval {
2479 close $fh1;
2480
2481 my @res = eval { $cb->(@args) };
2482 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2483 };
2484
2485 warn $@ if $@;
2486 _exit 0;
2487 }
2488}
2489
2490
2491
2492#############################################################################
2493# the server's init and main functions 2709# the server's init and main functions
2494 2710
2495sub load_facedata($) { 2711sub load_facedata($) {
2496 my ($path) = @_; 2712 my ($path) = @_;
2497 2713
2509 { 2725 {
2510 my $faces = $facedata->{faceinfo}; 2726 my $faces = $facedata->{faceinfo};
2511 2727
2512 while (my ($face, $info) = each %$faces) { 2728 while (my ($face, $info) = each %$faces) {
2513 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2729 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2514 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2730 cf::face::set_visibility $idx, $info->{visibility};
2731 cf::face::set_magicmap $idx, $info->{magicmap};
2515 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2732 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2516 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2733 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2517 Coro::cede; 2734
2735 cf::cede_to_tick;
2518 } 2736 }
2519 2737
2520 while (my ($face, $info) = each %$faces) { 2738 while (my ($face, $info) = each %$faces) {
2521 next unless $info->{smooth}; 2739 next unless $info->{smooth};
2522 my $idx = cf::face::find $face 2740 my $idx = cf::face::find $face
2523 or next; 2741 or next;
2524 if (my $smooth = cf::face::find $info->{smooth}) { 2742 if (my $smooth = cf::face::find $info->{smooth}) {
2743 cf::face::set_smooth $idx, $smooth;
2525 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2744 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2526 } else { 2745 } else {
2527 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2746 warn "smooth face '$info->{smooth}' not found for face '$face'";
2528 } 2747 }
2529 Coro::cede; 2748
2749 cf::cede_to_tick;
2530 } 2750 }
2531 } 2751 }
2532 2752
2533 { 2753 {
2534 my $anims = $facedata->{animinfo}; 2754 my $anims = $facedata->{animinfo};
2535 2755
2536 while (my ($anim, $info) = each %$anims) { 2756 while (my ($anim, $info) = each %$anims) {
2537 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2757 cf::anim::set $anim, $info->{frames}, $info->{facings};
2538 Coro::cede; 2758 cf::cede_to_tick;
2539 } 2759 }
2540 2760
2541 cf::anim::invalidate_all; # d'oh 2761 cf::anim::invalidate_all; # d'oh
2762 }
2763
2764 {
2765 # TODO: for gcfclient pleasure, we should give resources
2766 # that gcfclient doesn't grok a >10000 face index.
2767 my $res = $facedata->{resource};
2768 my $enc = JSON::XS->new->utf8->canonical;
2769
2770 while (my ($name, $info) = each %$res) {
2771 my $meta = $enc->encode ({
2772 name => $name,
2773 type => $info->{type},
2774 copyright => $info->{copyright}, #TODO#
2775 });
2776
2777 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2778
2779 if ($name =~ /\.jpg$/) {
2780 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2781 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2782 } else {
2783 my $data = pack "(w/a*)*", $meta, $info->{data};
2784 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2785
2786 cf::face::set_type $idx, 1;
2787 cf::face::set_data $idx, 0, $data, $chk;
2788 }
2789
2790 cf::cede_to_tick;
2791 }
2542 } 2792 }
2543 2793
2544 1 2794 1
2545} 2795}
2546 2796
2547sub reload_regions { 2797sub reload_regions {
2548 load_resource_file "$MAPDIR/regions" 2798 load_resource_file "$MAPDIR/regions"
2549 or die "unable to load regions file\n"; 2799 or die "unable to load regions file\n";
2800
2801 for (cf::region::list) {
2802 $_->{match} = qr/$_->{match}/
2803 if exists $_->{match};
2804 }
2550} 2805}
2551 2806
2552sub reload_facedata { 2807sub reload_facedata {
2553 load_facedata "$DATADIR/facedata" 2808 load_facedata "$DATADIR/facedata"
2554 or die "unable to load facedata\n"; 2809 or die "unable to load facedata\n";
2555} 2810}
2556 2811
2557sub reload_archetypes { 2812sub reload_archetypes {
2558 load_resource_file "$DATADIR/archetypes" 2813 load_resource_file "$DATADIR/archetypes"
2559 or die "unable to load archetypes\n"; 2814 or die "unable to load archetypes\n";
2815 #d# NEED to laod twice to resolve forward references
2816 # this really needs to be done in an extra post-pass
2817 # (which needs to be synchronous, so solve it differently)
2818 load_resource_file "$DATADIR/archetypes"
2819 or die "unable to load archetypes\n";
2560} 2820}
2561 2821
2562sub reload_treasures { 2822sub reload_treasures {
2563 load_resource_file "$DATADIR/treasures" 2823 load_resource_file "$DATADIR/treasures"
2564 or die "unable to load treasurelists\n"; 2824 or die "unable to load treasurelists\n";
2567sub reload_resources { 2827sub reload_resources {
2568 warn "reloading resource files...\n"; 2828 warn "reloading resource files...\n";
2569 2829
2570 reload_regions; 2830 reload_regions;
2571 reload_facedata; 2831 reload_facedata;
2832 #reload_archetypes;#d#
2572 reload_archetypes; 2833 reload_archetypes;
2573 reload_treasures; 2834 reload_treasures;
2574 2835
2575 warn "finished reloading resource files\n"; 2836 warn "finished reloading resource files\n";
2576} 2837}
2633 }, 2894 },
2634 ); 2895 );
2635 } 2896 }
2636} 2897}
2637 2898
2899sub write_runtime {
2900 my $runtime = "$LOCALDIR/runtime";
2901
2902 # first touch the runtime file to show we are still running:
2903 # the fsync below can take a very very long time.
2904
2905 IO::AIO::aio_utime $runtime, undef, undef;
2906
2907 my $guard = cf::lock_acquire "write_runtime";
2908
2909 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2910 or return;
2911
2912 my $value = $cf::RUNTIME + 90 + 10;
2913 # 10 is the runtime save interval, for a monotonic clock
2914 # 60 allows for the watchdog to kill the server.
2915
2916 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2917 and return;
2918
2919 # always fsync - this file is important
2920 aio_fsync $fh
2921 and return;
2922
2923 # touch it again to show we are up-to-date
2924 aio_utime $fh, undef, undef;
2925
2926 close $fh
2927 or return;
2928
2929 aio_rename "$runtime~", $runtime
2930 and return;
2931
2932 warn "runtime file written.\n";
2933
2934 1
2935}
2936
2638sub emergency_save() { 2937sub emergency_save() {
2639 my $freeze_guard = cf::freeze_mainloop; 2938 my $freeze_guard = cf::freeze_mainloop;
2640 2939
2641 warn "enter emergency perl save\n"; 2940 warn "enter emergency perl save\n";
2642 2941
2717 %EXT_CORO = (); 3016 %EXT_CORO = ();
2718 3017
2719 warn "removing commands"; 3018 warn "removing commands";
2720 %COMMAND = (); 3019 %COMMAND = ();
2721 3020
2722 warn "removing ext commands"; 3021 warn "removing ext/exti commands";
2723 %EXTCMD = (); 3022 %EXTCMD = ();
3023 %EXTICMD = ();
2724 3024
2725 warn "unloading/nuking all extensions"; 3025 warn "unloading/nuking all extensions";
2726 for my $pkg (@EXTS) { 3026 for my $pkg (@EXTS) {
2727 warn "... unloading $pkg"; 3027 warn "... unloading $pkg";
2728 3028
2846 my $signal = new Coro::Signal; 3146 my $signal = new Coro::Signal;
2847 push @WAIT_FOR_TICK_BEGIN, $signal; 3147 push @WAIT_FOR_TICK_BEGIN, $signal;
2848 $signal->wait; 3148 $signal->wait;
2849} 3149}
2850 3150
3151 my $min = 1e6;#d#
3152 my $avg = 10;
2851$TICK_WATCHER = Event->timer ( 3153$TICK_WATCHER = Event->timer (
2852 reentrant => 0, 3154 reentrant => 0,
2853 parked => 1, 3155 parked => 1,
2854 prio => 0, 3156 prio => 0,
2855 at => $NEXT_TICK || $TICK, 3157 at => $NEXT_TICK || $TICK,
2862 } 3164 }
2863 3165
2864 $NOW = $tick_start = Event::time; 3166 $NOW = $tick_start = Event::time;
2865 3167
2866 cf::server_tick; # one server iteration 3168 cf::server_tick; # one server iteration
3169
3170 0 && sync_job {#d#
3171 for(1..10) {
3172 my $t = Event::time;
3173 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3174 or die;
3175
3176 $map->width (50);
3177 $map->height (50);
3178 $map->alloc;
3179 $map->_load_objects ("/tmp/x.map", 1);
3180 my $t = Event::time - $t;
3181
3182 #next unless $t < 0.0013;#d#
3183 if ($t < $min) {
3184 $min = $t;
3185 }
3186 $avg = $avg * 0.99 + $t * 0.01;
3187 }
3188 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3189 exit 0;
3190 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3191 };
2867 3192
2868 $RUNTIME += $TICK; 3193 $RUNTIME += $TICK;
2869 $NEXT_TICK += $TICK; 3194 $NEXT_TICK += $TICK;
2870 3195
2871 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3196 if ($NOW >= $NEXT_RUNTIME_WRITE) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines