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.257 by root, Sat Apr 21 17:34:24 2007 UTC vs.
Revision 1.298 by root, Sun Jul 8 14:50:07 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
49our %COMMAND = (); 50our %COMMAND = ();
50our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
51 52
52our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
56 58
57our $RELOAD; # number of reloads so far 59our $RELOAD; # number of reloads so far
58our @EVENT; 60our @EVENT;
90our $LINK_MAP; # the special {link} map, which is always available 92our $LINK_MAP; # the special {link} map, which is always available
91 93
92# used to convert map paths into valid unix filenames by replacing / by ∕ 94# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 95our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94 96
97our $LOAD; # a number between 0 (idle) and 1 (too many objects)
98our $LOADAVG; # same thing, but with alpha-smoothing
99our $tick_start; # for load detecting purposes
100
95binmode STDOUT; 101binmode STDOUT;
96binmode STDERR; 102binmode STDERR;
97 103
98# read virtual server time, if available 104# read virtual server time, if available
99unless ($RUNTIME || !-e "$LOCALDIR/runtime") { 105unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
139 145
140=item $cf::TICK 146=item $cf::TICK
141 147
142The interval between server ticks, in seconds. 148The interval between server ticks, in seconds.
143 149
150=item $cf::LOADAVG
151
152The current CPU load on the server (alpha-smoothed), as a value between 0
153(none) and 1 (overloaded), indicating how much time is spent on processing
154objects per tick. Healthy values are < 0.5.
155
156=item $cf::LOAD
157
158The raw value load value from the last tick.
159
144=item %cf::CFG 160=item %cf::CFG
145 161
146Configuration for the server, loaded from C</etc/crossfire/config>, or 162Configuration for the server, loaded from C</etc/crossfire/config>, or
147from wherever your confdir points to. 163from wherever your confdir points to.
148 164
173@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 189@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
174@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 190@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
175@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 191@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
176@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 192@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
177@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 193@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
194@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
178@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 195@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
179 196
180# we bless all objects into (empty) derived classes to force a method lookup 197# we bless all objects into (empty) derived classes to force a method lookup
181# within the Safe compartment. 198# within the Safe compartment.
182for my $pkg (qw( 199for my $pkg (qw(
183 cf::global cf::attachable 200 cf::global cf::attachable
191} 208}
192 209
193$Event::DIED = sub { 210$Event::DIED = sub {
194 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
195}; 212};
213
214#############################################################################
196 215
197=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
198 217
199=over 4 218=over 4
200 219
219 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 238 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
220 $d 239 $d
221 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
222} 241}
223 242
224use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
225
226=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
227 244
228Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
229 246
230=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
231 248
232Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
250
251=cut
252
253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
254
255sub to_json ($) { $json_coder->encode ($_[0]) }
256sub from_json ($) { $json_coder->decode ($_[0]) }
233 257
234=item cf::lock_wait $string 258=item cf::lock_wait $string
235 259
236Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
237 261
303 327
304BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
305 329
306=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
307 331
308The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
309always able to handle events or runnable, as crossfire+ is only partly 333is always able to handle events or runnable, as Crossfire TRT is only
310reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
311 336
312If it must be done, put the blocking parts into C<sync_job>. This will run 337If it must be done, put the blocking parts into C<sync_job>. This will run
313the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
314server will be frozen during this time, so the block should either finish 339server will be frozen during this time, so the block should either finish
315fast or be very important. 340fast or be very important.
318 343
319sub sync_job(&) { 344sub sync_job(&) {
320 my ($job) = @_; 345 my ($job) = @_;
321 346
322 if ($Coro::current == $Coro::main) { 347 if ($Coro::current == $Coro::main) {
348 my $time = Event::time;
349
323 # this is the main coro, too bad, we have to block 350 # this is the main coro, too bad, we have to block
324 # till the operation succeeds, freezing the server :/ 351 # till the operation succeeds, freezing the server :/
325 352
326 # TODO: use suspend/resume instead 353 # TODO: use suspend/resume instead
327 # (but this is cancel-safe) 354 # (but this is cancel-safe)
338 365
339 while ($busy) { 366 while ($busy) {
340 Coro::cede or Event::one_event; 367 Coro::cede or Event::one_event;
341 } 368 }
342 369
370 $time = Event::time - $time;
371
372 LOG llevError | logBacktrace, Carp::longmess "long sync job"
373 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
374
375 $tick_start += $time; # do not account sync jobs to server load
376
343 wantarray ? @res : $res[0] 377 wantarray ? @res : $res[0]
344 } else { 378 } else {
345 # we are in another coroutine, how wonderful, everything just works 379 # we are in another coroutine, how wonderful, everything just works
346 380
347 $job->() 381 $job->()
366 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
367 401
368 $coro 402 $coro
369} 403}
370 404
371sub write_runtime { 405=item fork_call { }, $args
372 my $guard = cf::lock_acquire "write_runtime";
373 406
374 my $runtime = "$LOCALDIR/runtime"; 407Executes the given code block with the given arguments in a seperate
408process, returning the results. Everything must be serialisable with
409Coro::Storable. May, of course, block. Note that the executed sub may
410never block itself or use any form of Event handling.
375 411
376 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 412=cut
377 or return;
378 413
379 my $value = $cf::RUNTIME + 90 + 10; 414sub fork_call(&@) {
380 # 10 is the runtime save interval, for a monotonic clock 415 my ($cb, @args) = @_;
381 # 60 allows for the watchdog to kill the server.
382 416
383 (aio_write $fh, 0, (length $value), $value, 0) <= 0 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
384 and return; 418# or die "socketpair: $!";
419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
385 421
386 # always fsync - this file is important 422 if (my $pid = fork) {
387 aio_fsync $fh
388 and return;
389
390 close $fh 423 close $fh2;
391 or return;
392 424
393 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
394 and return; 426 warn "pst<$res>" unless $res =~ /^pst/;
427 $res = Coro::Storable::thaw $res;
395 428
429 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
430
431 Carp::confess $$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 local $Coro::idle;
439 $Coro::current->prio (Coro::PRIO_MAX);
440 eval {
441 close $fh1;
442
443 my @res = eval { $cb->(@args) };
444
445 open my $fh, ">", \my $buf
446 or die "fork_call: cannot open fh-to-buf in child : $!";
447 Storable::store_fd +($@ ? \"$@" : \@res), $fh;
448 close $fh;
449
450 warn "writing ", length $buf;
451 my $x;
452 (length $buf) == ($x = syswrite $fh2, $buf)
453 or warn "error writing ".(length $buf)." != $x\n";
454 close $fh2;
455 };
456
457 warn $@ if $@;
458 _exit 0;
396 1 459 }
460}
461
462=item $value = cf::db_get $family => $key
463
464Returns a single value from the environment database.
465
466=item cf::db_put $family => $key => $value
467
468Stores the given C<$value> in the family. It can currently store binary
469data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
470
471=cut
472
473our $DB;
474
475sub db_init {
476 unless ($DB) {
477 $DB = BDB::db_create $DB_ENV;
478
479 cf::sync_job {
480 eval {
481 $DB->set_flags (BDB::CHKSUM);
482
483 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
484 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
485 cf::cleanup "db_open(db): $!" if $!;
486 };
487 cf::cleanup "db_open(db): $@" if $@;
488 };
489 }
490}
491
492sub db_get($$) {
493 my $key = "$_[0]/$_[1]";
494
495 cf::sync_job {
496 BDB::db_get $DB, undef, $key, my $data;
497
498 $! ? ()
499 : $data
500 }
501}
502
503sub db_put($$$) {
504 BDB::dbreq_pri 4;
505 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
506}
507
508=item cf::cache $id => [$paths...], $processversion => $process
509
510Generic caching function that returns the value of the resource $id,
511caching and regenerating as required.
512
513This function can block.
514
515=cut
516
517sub cache {
518 my ($id, $src, $processversion, $process) = @_;
519
520 my $meta =
521 join "\x00",
522 $processversion,
523 map {
524 aio_stat $_
525 and Carp::croak "$_: $!";
526
527 ($_, (stat _)[7,9])
528 } @$src;
529
530 my $dbmeta = db_get cache => "$id/meta";
531 if ($dbmeta ne $meta) {
532 # changed, we may need to process
533
534 my @data;
535 my $md5;
536
537 for (0 .. $#$src) {
538 0 <= aio_load $src->[$_], $data[$_]
539 or Carp::croak "$src->[$_]: $!";
540 }
541
542 # if processing is expensive, check
543 # checksum first
544 if (1) {
545 $md5 =
546 join "\x00",
547 $processversion,
548 map {
549 Coro::cede;
550 ($src->[$_], Digest::MD5::md5_hex $data[$_])
551 } 0.. $#$src;
552
553
554 my $dbmd5 = db_get cache => "$id/md5";
555 if ($dbmd5 eq $md5) {
556 db_put cache => "$id/meta", $meta;
557
558 return db_get cache => "$id/data";
559 }
560 }
561
562 my $t1 = Time::HiRes::time;
563 my $data = $process->(\@data);
564 my $t2 = Time::HiRes::time;
565
566 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
567
568 db_put cache => "$id/data", $data;
569 db_put cache => "$id/md5" , $md5;
570 db_put cache => "$id/meta", $meta;
571
572 return $data;
573 }
574
575 db_get cache => "$id/data"
397} 576}
398 577
399=item cf::datalog type => key => value, ... 578=item cf::datalog type => key => value, ...
400 579
401Log a datalog packet of the given type with the given key-value pairs. 580Log a datalog packet of the given type with the given key-value pairs.
419attach callbacks/event handlers (a collection of which is called an "attachment") 598attach callbacks/event handlers (a collection of which is called an "attachment")
420to it. All such attachable objects support the following methods. 599to it. All such attachable objects support the following methods.
421 600
422In the following description, CLASS can be any of C<global>, C<object> 601In the following description, CLASS can be any of C<global>, C<object>
423C<player>, C<client> or C<map> (i.e. the attachable objects in 602C<player>, C<client> or C<map> (i.e. the attachable objects in
424crossfire+). 603Crossfire TRT).
425 604
426=over 4 605=over 4
427 606
428=item $attachable->attach ($attachment, key => $value...) 607=item $attachable->attach ($attachment, key => $value...)
429 608
592 $registry = $CB_TYPE[$object_type] ||= []; 771 $registry = $CB_TYPE[$object_type] ||= [];
593 772
594 } elsif ($type eq "subtype") { 773 } elsif ($type eq "subtype") {
595 defined $object_type or Carp::croak "subtype specified without type"; 774 defined $object_type or Carp::croak "subtype specified without type";
596 my $object_subtype = shift @arg; 775 my $object_subtype = shift @arg;
597 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 776 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
598 777
599 } elsif ($type eq "package") { 778 } elsif ($type eq "package") {
600 my $pkg = shift @arg; 779 my $pkg = shift @arg;
601 780
602 while (my ($name, $id) = each %cb_id) { 781 while (my ($name, $id) = each %cb_id) {
631 _attach $registry, $klass, @attach; 810 _attach $registry, $klass, @attach;
632 } 811 }
633 812
634 $obj->{$name} = \%arg; 813 $obj->{$name} = \%arg;
635 } else { 814 } else {
636 warn "object uses attachment '$name' that is not available, postponing.\n"; 815 warn "object uses attachment '$name' which is not available, postponing.\n";
637 } 816 }
638 817
639 $obj->{_attachment}{$name} = undef; 818 $obj->{_attachment}{$name} = undef;
640} 819}
641 820
643 if (ref $_[0]) { 822 if (ref $_[0]) {
644 _object_attach @_; 823 _object_attach @_;
645 } else { 824 } else {
646 _attach shift->_attach_registry, @_; 825 _attach shift->_attach_registry, @_;
647 } 826 }
827 _recalc_want;
648}; 828};
649 829
650# all those should be optimised 830# all those should be optimised
651sub cf::attachable::detach { 831sub cf::attachable::detach {
652 my ($obj, $name) = @_; 832 my ($obj, $name) = @_;
655 delete $obj->{_attachment}{$name}; 835 delete $obj->{_attachment}{$name};
656 reattach ($obj); 836 reattach ($obj);
657 } else { 837 } else {
658 Carp::croak "cannot, currently, detach class attachments"; 838 Carp::croak "cannot, currently, detach class attachments";
659 } 839 }
840 _recalc_want;
660}; 841};
661 842
662sub cf::attachable::attached { 843sub cf::attachable::attached {
663 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
664 845
837 or return; 1018 or return;
838 $av = eval { (Storable::thaw $av)->{objs} }; 1019 $av = eval { (Storable::thaw $av)->{objs} };
839 } 1020 }
840 1021
841 warn sprintf "loading %s (%d)\n", 1022 warn sprintf "loading %s (%d)\n",
842 $filename, length $data, scalar @{$av || []};#d# 1023 $filename, length $data, scalar @{$av || []};
843 return ($data, $av); 1024 return ($data, $av);
844} 1025}
1026
1027=head2 COMMAND CALLBACKS
1028
1029=over 4
1030
1031=cut
845 1032
846############################################################################# 1033#############################################################################
847# command handling &c 1034# command handling &c
848 1035
849=item cf::register_command $name => \&callback($ob,$args); 1036=item cf::register_command $name => \&callback($ob,$args);
862 push @{ $COMMAND{$name} }, [$caller, $cb]; 1049 push @{ $COMMAND{$name} }, [$caller, $cb];
863} 1050}
864 1051
865=item cf::register_extcmd $name => \&callback($pl,$packet); 1052=item cf::register_extcmd $name => \&callback($pl,$packet);
866 1053
867Register a callbackf ro execution when the client sends an extcmd packet. 1054Register a callback for execution when the client sends an (synchronous)
1055extcmd packet. Ext commands will be processed in the order they are
1056received by the server, like other user commands. The first argument is
1057the logged-in player. Ext commands can only be processed after a player
1058has logged in successfully.
868 1059
869If the callback returns something, it is sent back as if reply was being 1060If the callback returns something, it is sent back as if reply was being
870called. 1061called.
871 1062
1063=item cf::register_exticmd $name => \&callback($ns,$packet);
1064
1065Register a callback for execution when the client sends an (asynchronous)
1066exticmd packet. Exti commands are processed by the server as soon as they
1067are received, i.e. out of order w.r.t. other commands. The first argument
1068is a client socket. Exti commands can be received anytime, even before
1069log-in.
1070
1071If the callback returns something, it is sent back as if reply was being
1072called.
1073
872=cut 1074=cut
873 1075
874sub register_extcmd { 1076sub register_extcmd {
875 my ($name, $cb) = @_; 1077 my ($name, $cb) = @_;
876 1078
877 $EXTCMD{$name} = $cb; 1079 $EXTCMD{$name} = $cb;
1080}
1081
1082sub register_exticmd {
1083 my ($name, $cb) = @_;
1084
1085 $EXTICMD{$name} = $cb;
878} 1086}
879 1087
880cf::player->attach ( 1088cf::player->attach (
881 on_command => sub { 1089 on_command => sub {
882 my ($pl, $name, $params) = @_; 1090 my ($pl, $name, $params) = @_;
891 cf::override; 1099 cf::override;
892 }, 1100 },
893 on_extcmd => sub { 1101 on_extcmd => sub {
894 my ($pl, $buf) = @_; 1102 my ($pl, $buf) = @_;
895 1103
896 my $msg = eval { from_json $buf }; 1104 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
897 1105
898 if (ref $msg) { 1106 if (ref $msg) {
899 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1107 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
900 if (my %reply = $cb->($pl, $msg)) { 1108 if (my %reply = $cb->($pl, $msg)) {
901 $pl->ext_reply ($msg->{msgid}, %reply); 1109 $pl->ext_reply ($msg->{msgid}, %reply);
907 1115
908 cf::override; 1116 cf::override;
909 }, 1117 },
910); 1118);
911 1119
912sub load_extension {
913 my ($path) = @_;
914
915 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
916 my $base = $1;
917 my $pkg = $1;
918 $pkg =~ s/[^[:word:]]/_/g;
919 $pkg = "ext::$pkg";
920
921 warn "... loading '$path' into '$pkg'\n";
922
923 open my $fh, "<:utf8", $path
924 or die "$path: $!";
925
926 my $source =
927 "package $pkg; use strict; use utf8;\n"
928 . "#line 1 \"$path\"\n{\n"
929 . (do { local $/; <$fh> })
930 . "\n};\n1";
931
932 unless (eval $source) {
933 my $msg = $@ ? "$path: $@\n"
934 : "extension disabled.\n";
935 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
936 warn $@;
937 warn "mandatory extension failed to load, exiting.\n";
938 exit 1;
939 }
940 die $@;
941 }
942
943 push @EXTS, $pkg;
944}
945
946sub load_extensions { 1120sub load_extensions {
1121 cf::sync_job {
1122 my %todo;
1123
947 for my $ext (<$LIBDIR/*.ext>) { 1124 for my $path (<$LIBDIR/*.ext>) {
948 next unless -r $ext; 1125 next unless -r $path;
949 eval { 1126
950 load_extension $ext; 1127 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1128 my $base = $1;
1129 my $pkg = $1;
1130 $pkg =~ s/[^[:word:]]/_/g;
1131 $pkg = "ext::$pkg";
1132
1133 open my $fh, "<:utf8", $path
1134 or die "$path: $!";
1135
1136 my $source = do { local $/; <$fh> };
1137
1138 my %ext = (
1139 path => $path,
1140 base => $base,
1141 pkg => $pkg,
1142 );
1143
1144 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1145 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1146
1147 $ext{source} =
1148 "package $pkg; use strict; use utf8;\n"
1149 . "#line 1 \"$path\"\n{\n"
1150 . $source
1151 . "\n};\n1";
1152
1153 $todo{$base} = \%ext;
1154 }
1155
1156 my %done;
1157 while (%todo) {
1158 my $progress;
1159
1160 while (my ($k, $v) = each %todo) {
1161 for (split /,\s*/, $v->{meta}{depends}) {
1162 goto skip
1163 unless exists $done{$_};
1164 }
1165
1166 warn "... loading '$k' into '$v->{pkg}'\n";
1167
1168 unless (eval $v->{source}) {
1169 my $msg = $@ ? "$v->{path}: $@\n"
1170 : "$v->{base}: extension inactive.\n";
1171
1172 if (exists $v->{meta}{mandatory}) {
1173 warn $msg;
1174 warn "mandatory extension failed to load, exiting.\n";
1175 exit 1;
1176 }
1177
1178 warn $msg;
1179 }
1180
1181 $done{$k} = delete $todo{$k};
1182 push @EXTS, $v->{pkg};
1183 $progress = 1;
951 1 1184 }
952 } or warn "$ext not loaded: $@"; 1185
1186 skip:
1187 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1188 unless $progress;
1189 }
953 } 1190 };
954} 1191}
955 1192
956############################################################################# 1193#############################################################################
1194
1195=back
957 1196
958=head2 CORE EXTENSIONS 1197=head2 CORE EXTENSIONS
959 1198
960Functions and methods that extend core crossfire objects. 1199Functions and methods that extend core crossfire objects.
961 1200
1149 } 1388 }
1150 1389
1151 \@paths 1390 \@paths
1152} 1391}
1153 1392
1393=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1394
1395Expand crossfire pod fragments into protocol xml.
1396
1397=cut
1398
1399sub expand_cfpod {
1400 ((my $self), (local $_)) = @_;
1401
1402 # escape & and <
1403 s/&/&amp;/g;
1404 s/(?<![BIUGH])</&lt;/g;
1405
1406 # this is buggy, it needs to properly take care of nested <'s
1407
1408 1 while
1409 # replace B<>, I<>, U<> etc.
1410 s/B<([^\>]*)>/<b>$1<\/b>/
1411 || s/I<([^\>]*)>/<i>$1<\/i>/
1412 || s/U<([^\>]*)>/<u>$1<\/u>/
1413 # replace G<male|female> tags
1414 || s{G<([^>|]*)\|([^>]*)>}{
1415 $self->gender ? $2 : $1
1416 }ge
1417 # replace H<hint text>
1418 || s{H<([^\>]*)>}
1419 {
1420 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1421 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1422 "")
1423 [$self->{hintmode}]
1424 }ge;
1425
1426 # create single paragraphs (very hackish)
1427 s/(?<=\S)\n(?=\w)/ /g;
1428
1429 # compress some whitespace
1430 s/\s+\n/\n/g; # ws line-ends
1431 s/\n\n+/\n/g; # double lines
1432 s/^\n+//; # beginning lines
1433 s/\n+$//; # ending lines
1434
1435 $_
1436}
1437
1438sub hintmode {
1439 $_[0]{hintmode} = $_[1] if @_ > 1;
1440 $_[0]{hintmode}
1441}
1442
1154=item $player->ext_reply ($msgid, %msg) 1443=item $player->ext_reply ($msgid, %msg)
1155 1444
1156Sends an ext reply to the player. 1445Sends an ext reply to the player.
1157 1446
1158=cut 1447=cut
1159 1448
1160sub ext_reply($$%) { 1449sub ext_reply($$%) {
1161 my ($self, $id, %msg) = @_; 1450 my ($self, $id, %msg) = @_;
1162 1451
1163 $msg{msgid} = $id; 1452 $msg{msgid} = $id;
1164 1453 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1165 $self->send ("ext " . cf::to_json \%msg);
1166} 1454}
1167 1455
1168=item $player->ext_event ($type, %msg) 1456=item $player->ext_event ($type, %msg)
1169 1457
1170Sends an ext event to the client. 1458Sends an ext event to the client.
1185 1473
1186package cf::region; 1474package cf::region;
1187 1475
1188=item cf::region::find_by_path $path 1476=item cf::region::find_by_path $path
1189 1477
1190Tries to decuce the probable region for a map knowing only its path. 1478Tries to decuce the likely region for a map knowing only its path.
1191 1479
1192=cut 1480=cut
1193 1481
1194sub find_by_path($) { 1482sub find_by_path($) {
1195 my ($path) = @_; 1483 my ($path) = @_;
1269 my ($self, $merge) = @_; 1557 my ($self, $merge) = @_;
1270 1558
1271 # we have to keep some variables in memory intact 1559 # we have to keep some variables in memory intact
1272 local $self->{path}; 1560 local $self->{path};
1273 local $self->{load_path}; 1561 local $self->{load_path};
1274 local $self->{deny_save};
1275 local $self->{deny_reset};
1276 1562
1277 $self->SUPER::thawer_merge ($merge); 1563 $self->SUPER::thawer_merge ($merge);
1278} 1564}
1279 1565
1280sub normalise { 1566sub normalise {
1380 1666
1381 $_->change_map_light ($change) 1667 $_->change_map_light ($change)
1382 for grep $_->outdoor, values %cf::MAP; 1668 for grep $_->outdoor, values %cf::MAP;
1383} 1669}
1384 1670
1671sub decay_objects {
1672 my ($self) = @_;
1673
1674 return if $self->{deny_reset};
1675
1676 $self->do_decay_objects;
1677}
1678
1385sub unlink_save { 1679sub unlink_save {
1386 my ($self) = @_; 1680 my ($self) = @_;
1387 1681
1388 utf8::encode (my $save = $self->save_path); 1682 utf8::encode (my $save = $self->save_path);
1389 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1683 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1445 $self->load_header_orig 1739 $self->load_header_orig
1446 or return; 1740 or return;
1447 $self->prepare_orig; 1741 $self->prepare_orig;
1448 } 1742 }
1449 1743
1744 $self->{deny_reset} = 1
1745 if $self->no_reset;
1746
1450 $self->default_region (cf::region::find_by_path $self->{path}) 1747 $self->default_region (cf::region::find_by_path $self->{path})
1451 unless $self->default_region; 1748 unless $self->default_region;
1452 1749
1453 1 1750 1
1454} 1751}
1469 $map->{last_save} = $cf::RUNTIME; 1766 $map->{last_save} = $cf::RUNTIME;
1470 1767
1471 $map->load_header 1768 $map->load_header
1472 or return; 1769 or return;
1473 1770
1474 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1771 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1475 # doing this can freeze the server in a sync job, obviously 1772 # doing this can freeze the server in a sync job, obviously
1476 #$cf::WAIT_FOR_TICK->wait; 1773 #$cf::WAIT_FOR_TICK->wait;
1477 $map->reset; 1774 $map->reset;
1478 undef $guard; 1775 undef $guard;
1479 return find $path; 1776 return find $path;
1546 my ($self, $ob) = @_; 1843 my ($self, $ob) = @_;
1547 1844
1548 return find "~" . $ob->name . "/" . $self->{path} 1845 return find "~" . $ob->name . "/" . $self->{path}
1549 if $self->per_player; 1846 if $self->per_player;
1550 1847
1848# return find "?party/" . $ob->name . "/" . $self->{path}
1849# if $self->per_party;
1850
1551 $self 1851 $self
1552} 1852}
1553 1853
1554# find and load all maps in the 3x3 area around a map 1854# find and load all maps in the 3x3 area around a map
1555sub load_diag { 1855sub load_diag {
1665 1965
1666sub reset_at { 1966sub reset_at {
1667 my ($self) = @_; 1967 my ($self) = @_;
1668 1968
1669 # TODO: safety, remove and allow resettable per-player maps 1969 # TODO: safety, remove and allow resettable per-player maps
1670 return 1e99 if $self->isa ("ext::map_per_player");#d#
1671 return 1e99 if $self->{deny_reset}; 1970 return 1e99 if $self->{deny_reset};
1672 1971
1673 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1972 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1674 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1973 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1675 1974
1686 my ($self) = @_; 1985 my ($self) = @_;
1687 1986
1688 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1987 my $lock = cf::lock_acquire "map_data:$self->{path}";
1689 1988
1690 return if $self->players; 1989 return if $self->players;
1691 return if $self->isa ("ext::map_per_player");#d#
1692 1990
1693 warn "resetting map ", $self->path;#d# 1991 warn "resetting map ", $self->path;
1694 1992
1695 $self->in_memory (cf::MAP_SWAPPED); 1993 $self->in_memory (cf::MAP_SWAPPED);
1696 1994
1697 # need to save uniques path 1995 # need to save uniques path
1698 unless ($self->{deny_save}) { 1996 unless ($self->{deny_save}) {
1730 $cf::MAP{$self->path} = $self; 2028 $cf::MAP{$self->path} = $self;
1731 2029
1732 $self->reset; # polite request, might not happen 2030 $self->reset; # polite request, might not happen
1733} 2031}
1734 2032
2033=item $maps = cf::map::tmp_maps
2034
2035Returns an arrayref with all map paths of currently instantiated and saved
2036maps. May block.
2037
2038=cut
2039
2040sub tmp_maps() {
2041 [
2042 map {
2043 utf8::decode $_;
2044 /\.map$/
2045 ? normalise $_
2046 : ()
2047 } @{ aio_readdir $TMPDIR or [] }
2048 ]
2049}
2050
2051=item $maps = cf::map::random_maps
2052
2053Returns an arrayref with all map paths of currently instantiated and saved
2054random maps. May block.
2055
2056=cut
2057
2058sub random_maps() {
2059 [
2060 map {
2061 utf8::decode $_;
2062 /\.map$/
2063 ? normalise "?random/$_"
2064 : ()
2065 } @{ aio_readdir $RANDOMDIR or [] }
2066 ]
2067}
2068
1735=item cf::map::unique_maps 2069=item cf::map::unique_maps
1736 2070
1737Returns an arrayref of paths of all shared maps that have 2071Returns an arrayref of paths of all shared maps that have
1738instantiated unique items. May block. 2072instantiated unique items. May block.
1739 2073
1740=cut 2074=cut
1741 2075
1742sub unique_maps() { 2076sub unique_maps() {
1743 my $files = aio_readdir $UNIQUEDIR 2077 [
1744 or return; 2078 map {
1745
1746 my @paths;
1747
1748 for (@$files) {
1749 utf8::decode $_; 2079 utf8::decode $_;
1750 next if /\.pst$/; 2080 /\.map$/
1751 next unless /^$PATH_SEP/o; 2081 ? normalise $_
1752 2082 : ()
1753 push @paths, cf::map::normalise $_; 2083 } @{ aio_readdir $UNIQUEDIR or [] }
1754 } 2084 ]
1755
1756 \@paths
1757} 2085}
1758 2086
1759package cf; 2087package cf;
1760 2088
1761=back 2089=back
1807 2135
1808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2136 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1809 2137
1810 if ($self->{record_replies}) { 2138 if ($self->{record_replies}) {
1811 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2139 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2140
1812 } else { 2141 } else {
2142 my $pl = $self->contr;
2143
2144 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2145 my $diag = $pl->{npc_dialog};
2146 $diag->{pl}->ext_reply (
2147 $diag->{id},
2148 msgtype => "reply",
2149 msg => $diag->{pl}->expand_cfpod ($msg),
2150 add_topics => []
2151 );
2152
2153 } else {
1813 $msg = $npc->name . " says: $msg" if $npc; 2154 $msg = $npc->name . " says: $msg" if $npc;
1814 $self->message ($msg, $flags); 2155 $self->message ($msg, $flags);
2156 }
1815 } 2157 }
1816} 2158}
1817 2159
1818=item $player_object->may ("access") 2160=item $player_object->may ("access")
1819 2161
1862} 2204}
1863 2205
1864sub cf::object::player::enter_link { 2206sub cf::object::player::enter_link {
1865 my ($self) = @_; 2207 my ($self) = @_;
1866 2208
2209 $self->deactivate_recursive;
2210
1867 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2211 return if UNIVERSAL::isa $self->map, "ext::map_link";
1868 2212
1869 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2213 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1870 if $self->map; 2214 if $self->map && $self->map->{path} ne "{link}";
1871 2215
1872 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2216 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1873} 2217}
1874 2218
1875sub cf::object::player::leave_link { 2219sub cf::object::player::leave_link {
1876 my ($self, $map, $x, $y) = @_; 2220 my ($self, $map, $x, $y) = @_;
2221
2222 return unless $self->contr->active;
1877 2223
1878 my $link_pos = delete $self->{_link_pos}; 2224 my $link_pos = delete $self->{_link_pos};
1879 2225
1880 unless ($map) { 2226 unless ($map) {
1881 # restore original map position 2227 # restore original map position
1904 2250
1905 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2251 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1906 $self->enter_map ($map, $x, $y); 2252 $self->enter_map ($map, $x, $y);
1907} 2253}
1908 2254
1909cf::player->attach (
1910 on_logout => sub {
1911 my ($pl) = @_;
1912
1913 # abort map switching before logout
1914 if ($pl->ob->{_link_pos}) {
1915 cf::sync_job {
1916 $pl->ob->leave_link
1917 };
1918 }
1919 },
1920 on_login => sub {
1921 my ($pl) = @_;
1922
1923 # try to abort aborted map switching on player login :)
1924 # should happen only on crashes
1925 if ($pl->ob->{_link_pos}) {
1926 $pl->ob->enter_link;
1927 (async {
1928 $pl->ob->reply (undef,
1929 "There was an internal problem at your last logout, "
1930 . "the server will try to bring you to your intended destination in a second.",
1931 cf::NDI_RED);
1932 # we need this sleep as the login has a concurrent enter_exit running
1933 # and this sleep increases chances of the player not ending up in scorn
1934 Coro::Timer::sleep 1;
1935 $pl->ob->leave_link;
1936 })->prio (2);
1937 }
1938 },
1939);
1940
1941=item $player_object->goto ($path, $x, $y) 2255=item $player_object->goto ($path, $x, $y[, $check->($map)])
1942 2256
2257Moves the player to the given map-path and coordinates by first freezing
2258her, loading and preparing them map, calling the provided $check callback
2259that has to return the map if sucecssful, and then unfreezes the player on
2260the new (success) or old (failed) map position.
2261
1943=cut 2262=cut
2263
2264our $GOTOGEN;
1944 2265
1945sub cf::object::player::goto { 2266sub cf::object::player::goto {
1946 my ($self, $path, $x, $y) = @_; 2267 my ($self, $path, $x, $y, $check) = @_;
2268
2269 # do generation counting so two concurrent goto's will be executed in-order
2270 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1947 2271
1948 $self->enter_link; 2272 $self->enter_link;
1949 2273
1950 (async { 2274 (async {
1951 my $map = eval { 2275 my $map = eval {
1952 my $map = cf::map::find $path; 2276 my $map = cf::map::find $path;
2277
2278 if ($map) {
1953 $map = $map->customise_for ($self) if $map; 2279 $map = $map->customise_for ($self);
2280 $map = $check->($map) if $check && $map;
2281 } else {
2282 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2283 }
2284
1954 $map 2285 $map
2286 };
2287
2288 if ($@) {
2289 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2290 LOG llevError | logBacktrace, Carp::longmess $@;
1955 } or 2291 }
1956 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1957 2292
2293 if ($gen == $self->{_goto_generation}) {
2294 delete $self->{_goto_generation};
1958 $self->leave_link ($map, $x, $y); 2295 $self->leave_link ($map, $x, $y);
2296 }
1959 })->prio (1); 2297 })->prio (1);
1960} 2298}
1961 2299
1962=item $player_object->enter_exit ($exit_object) 2300=item $player_object->enter_exit ($exit_object)
1963 2301
2032 my $hp = $exit->stats->hp; 2370 my $hp = $exit->stats->hp;
2033 my $sp = $exit->stats->sp; 2371 my $sp = $exit->stats->sp;
2034 2372
2035 $self->enter_link; 2373 $self->enter_link;
2036 2374
2375 # if exit is damned, update players death & WoR home-position
2376 $self->contr->savebed ($slaying, $hp, $sp)
2377 if $exit->flag (FLAG_DAMNED);
2378
2037 (async { 2379 (async {
2038 $self->deactivate_recursive; # just to be sure 2380 $self->deactivate_recursive; # just to be sure
2039 unless (eval { 2381 unless (eval {
2040 $self->goto ($slaying, $hp, $sp); 2382 $self->goto ($slaying, $hp, $sp);
2041 2383
2068 2410
2069 utf8::encode $text; 2411 utf8::encode $text;
2070 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2412 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2071} 2413}
2072 2414
2415=item $client->send_msg ($color, $type, $msg, [extra...])
2416
2417Send a drawinfo or msg packet to the client, formatting the msg for the
2418client if neccessary. C<$type> should be a string identifying the type of
2419the message, with C<log> being the default. If C<$color> is negative, suppress
2420the message unless the client supports the msg packet.
2421
2422=cut
2423
2424sub cf::client::send_msg {
2425 my ($self, $color, $type, $msg, @extra) = @_;
2426
2427 $msg = $self->pl->expand_cfpod ($msg);
2428
2429 return unless @extra || length $msg;
2430
2431 if ($self->can_msg) {
2432 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2433 } else {
2434 # replace some tags by gcfclient-compatible ones
2435 for ($msg) {
2436 1 while
2437 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2438 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2439 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2440 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2441 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2442 }
2443
2444 if ($color >= 0) {
2445 if (0 && $msg =~ /\[/) {
2446 $self->send_packet ("drawextinfo $color 4 0 $msg")
2447 } else {
2448 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2449 $self->send_packet ("drawinfo $color $msg")
2450 }
2451 }
2452 }
2453}
2454
2073=item $client->ext_event ($type, %msg) 2455=item $client->ext_event ($type, %msg)
2074 2456
2075Sends an exti event to the client. 2457Sends an ext event to the client.
2076 2458
2077=cut 2459=cut
2078 2460
2079sub cf::client::ext_event($$%) { 2461sub cf::client::ext_event($$%) {
2080 my ($self, $type, %msg) = @_; 2462 my ($self, $type, %msg) = @_;
2081 2463
2082 $msg{msgtype} = "event_$type"; 2464 $msg{msgtype} = "event_$type";
2083 $self->send_packet ("ext " . cf::to_json \%msg); 2465 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2084} 2466}
2085 2467
2086=item $success = $client->query ($flags, "text", \&cb) 2468=item $success = $client->query ($flags, "text", \&cb)
2087 2469
2088Queues a query to the client, calling the given callback with 2470Queues a query to the client, calling the given callback with
2089the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2471the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2090C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2472C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2091 2473
2092Queries can fail, so check the return code. Or don't, as queries will become 2474Queries can fail, so check the return code. Or don't, as queries will
2093reliable at some point in the future. 2475become reliable at some point in the future.
2094 2476
2095=cut 2477=cut
2096 2478
2097sub cf::client::query { 2479sub cf::client::query {
2098 my ($self, $flags, $text, $cb) = @_; 2480 my ($self, $flags, $text, $cb) = @_;
2106 utf8::encode $text; 2488 utf8::encode $text;
2107 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2489 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2108 2490
2109 $self->send_packet ($self->{query_queue}[0][0]) 2491 $self->send_packet ($self->{query_queue}[0][0])
2110 if @{ $self->{query_queue} } == 1; 2492 if @{ $self->{query_queue} } == 1;
2493
2494 1
2111} 2495}
2112 2496
2113cf::client->attach ( 2497cf::client->attach (
2498 on_connect => sub {
2499 my ($ns) = @_;
2500
2501 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2502 },
2114 on_reply => sub { 2503 on_reply => sub {
2115 my ($ns, $msg) = @_; 2504 my ($ns, $msg) = @_;
2116 2505
2117 # this weird shuffling is so that direct followup queries 2506 # this weird shuffling is so that direct followup queries
2118 # get handled first 2507 # get handled first
2130 } else { 2519 } else {
2131 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2520 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2132 } 2521 }
2133 } 2522 }
2134 }, 2523 },
2524 on_exticmd => sub {
2525 my ($ns, $buf) = @_;
2526
2527 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2528
2529 if (ref $msg) {
2530 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2531 if (my %reply = $cb->($ns, $msg)) {
2532 $reply{msgid} = $msg->{msgid};
2533 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2534 }
2535 }
2536 } else {
2537 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2538 }
2539
2540 cf::override;
2541 },
2135); 2542);
2136 2543
2137=item $client->async (\&cb) 2544=item $client->async (\&cb)
2138 2545
2139Create a new coroutine, running the specified callback. The coroutine will 2546Create a new coroutine, running the specified callback. The coroutine will
2188 2595
2189=pod 2596=pod
2190 2597
2191The following functions and methods are available within a safe environment: 2598The following functions and methods are available within a safe environment:
2192 2599
2193 cf::object contr pay_amount pay_player map 2600 cf::object
2601 contr pay_amount pay_player map x y force_find force_add
2602 insert remove
2603
2194 cf::object::player player 2604 cf::object::player
2195 cf::player peaceful 2605 player
2196 cf::map trigger 2606
2607 cf::player
2608 peaceful
2609
2610 cf::map
2611 trigger
2197 2612
2198=cut 2613=cut
2199 2614
2200for ( 2615for (
2201 ["cf::object" => qw(contr pay_amount pay_player map)], 2616 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2617 insert remove)],
2202 ["cf::object::player" => qw(player)], 2618 ["cf::object::player" => qw(player)],
2203 ["cf::player" => qw(peaceful)], 2619 ["cf::player" => qw(peaceful)],
2204 ["cf::map" => qw(trigger)], 2620 ["cf::map" => qw(trigger)],
2205) { 2621) {
2206 no strict 'refs'; 2622 no strict 'refs';
2275} 2691}
2276 2692
2277=back 2693=back
2278 2694
2279=cut 2695=cut
2280
2281#############################################################################
2282
2283=head2 EXTENSION DATABASE SUPPORT
2284
2285Crossfire maintains a very simple database for extension use. It can
2286currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2287convert to/from binary).
2288
2289The parameter C<$family> should best start with the name of the extension
2290using it, it should be unique.
2291
2292=over 4
2293
2294=item $value = cf::db_get $family => $key
2295
2296Returns a single value from the database.
2297
2298=item cf::db_put $family => $key => $value
2299
2300Stores the given C<$value> in the family.
2301
2302=cut
2303
2304our $DB;
2305
2306sub db_init {
2307 unless ($DB) {
2308 $DB = BDB::db_create $DB_ENV;
2309
2310 cf::sync_job {
2311 eval {
2312 $DB->set_flags (BDB::CHKSUM);
2313
2314 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2315 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2316 cf::cleanup "db_open(db): $!" if $!;
2317 };
2318 cf::cleanup "db_open(db): $@" if $@;
2319 };
2320 }
2321}
2322
2323sub db_get($$) {
2324 my $key = "$_[0]/$_[1]";
2325
2326 cf::sync_job {
2327 BDB::db_get $DB, undef, $key, my $data;
2328
2329 $! ? ()
2330 : $data
2331 }
2332}
2333
2334sub db_put($$$) {
2335 BDB::dbreq_pri 4;
2336 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2337}
2338
2339=item cf::cache $id => [$paths...], $processversion => $process
2340
2341Generic caching function that returns the value of the resource $id,
2342caching and regenerating as required.
2343
2344This function can block.
2345
2346=cut
2347
2348sub cache {
2349 my ($id, $src, $processversion, $process) = @_;
2350
2351 my $meta =
2352 join "\x00",
2353 $processversion,
2354 map {
2355 aio_stat $_
2356 and Carp::croak "$_: $!";
2357
2358 ($_, (stat _)[7,9])
2359 } @$src;
2360
2361 my $dbmeta = db_get cache => "$id/meta";
2362 if ($dbmeta ne $meta) {
2363 # changed, we may need to process
2364
2365 my @data;
2366 my $md5;
2367
2368 for (0 .. $#$src) {
2369 0 <= aio_load $src->[$_], $data[$_]
2370 or Carp::croak "$src->[$_]: $!";
2371 }
2372
2373 # if processing is expensive, check
2374 # checksum first
2375 if (1) {
2376 $md5 =
2377 join "\x00",
2378 $processversion,
2379 map {
2380 Coro::cede;
2381 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2382 } 0.. $#$src;
2383
2384
2385 my $dbmd5 = db_get cache => "$id/md5";
2386 if ($dbmd5 eq $md5) {
2387 db_put cache => "$id/meta", $meta;
2388
2389 return db_get cache => "$id/data";
2390 }
2391 }
2392
2393 my $t1 = Time::HiRes::time;
2394 my $data = $process->(\@data);
2395 my $t2 = Time::HiRes::time;
2396
2397 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2398
2399 db_put cache => "$id/data", $data;
2400 db_put cache => "$id/md5" , $md5;
2401 db_put cache => "$id/meta", $meta;
2402
2403 return $data;
2404 }
2405
2406 db_get cache => "$id/data"
2407}
2408
2409=item fork_call { }, $args
2410
2411Executes the given code block with the given arguments in a seperate
2412process, returning the results. Everything must be serialisable with
2413Coro::Storable. May, of course, block. Note that the executed sub may
2414never block itself or use any form of Event handling.
2415
2416=cut
2417
2418sub fork_call(&@) {
2419 my ($cb, @args) = @_;
2420
2421# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2422# or die "socketpair: $!";
2423 pipe my $fh1, my $fh2
2424 or die "pipe: $!";
2425
2426 if (my $pid = fork) {
2427 close $fh2;
2428
2429 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2430 $res = Coro::Storable::thaw $res;
2431
2432 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2433
2434 die $$res unless "ARRAY" eq ref $res;
2435
2436 return wantarray ? @$res : $res->[-1];
2437 } else {
2438 local $SIG{__WARN__};
2439 eval {
2440 local $SIG{__DIE__};
2441 close $fh1;
2442
2443 my @res = eval { $cb->(@args) };
2444 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2445 };
2446
2447 warn $@ if $@;
2448 _exit 0;
2449 }
2450}
2451
2452
2453 2696
2454############################################################################# 2697#############################################################################
2455# the server's init and main functions 2698# the server's init and main functions
2456 2699
2457sub load_facedata($) { 2700sub load_facedata($) {
2517} 2760}
2518 2761
2519sub reload_archetypes { 2762sub reload_archetypes {
2520 load_resource_file "$DATADIR/archetypes" 2763 load_resource_file "$DATADIR/archetypes"
2521 or die "unable to load archetypes\n"; 2764 or die "unable to load archetypes\n";
2765 #d# NEED to laod twice to resolve forward references
2766 # this really needs to be done in an extra post-pass
2767 # (which needs to be synchronous, so solve it differently)
2768 load_resource_file "$DATADIR/archetypes"
2769 or die "unable to load archetypes\n";
2522} 2770}
2523 2771
2524sub reload_treasures { 2772sub reload_treasures {
2525 load_resource_file "$DATADIR/treasures" 2773 load_resource_file "$DATADIR/treasures"
2526 or die "unable to load treasurelists\n"; 2774 or die "unable to load treasurelists\n";
2529sub reload_resources { 2777sub reload_resources {
2530 warn "reloading resource files...\n"; 2778 warn "reloading resource files...\n";
2531 2779
2532 reload_regions; 2780 reload_regions;
2533 reload_facedata; 2781 reload_facedata;
2782 #reload_archetypes;#d#
2534 reload_archetypes; 2783 reload_archetypes;
2535 reload_treasures; 2784 reload_treasures;
2536 2785
2537 warn "finished reloading resource files\n"; 2786 warn "finished reloading resource files\n";
2538} 2787}
2595 }, 2844 },
2596 ); 2845 );
2597 } 2846 }
2598} 2847}
2599 2848
2849sub write_runtime {
2850 my $runtime = "$LOCALDIR/runtime";
2851
2852 # first touch the runtime file to show we are still running:
2853 # the fsync below can take a very very long time.
2854
2855 IO::AIO::aio_utime $runtime, undef, undef;
2856
2857 my $guard = cf::lock_acquire "write_runtime";
2858
2859 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2860 or return;
2861
2862 my $value = $cf::RUNTIME + 90 + 10;
2863 # 10 is the runtime save interval, for a monotonic clock
2864 # 60 allows for the watchdog to kill the server.
2865
2866 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2867 and return;
2868
2869 # always fsync - this file is important
2870 aio_fsync $fh
2871 and return;
2872
2873 # touch it again to show we are up-to-date
2874 aio_utime $fh, undef, undef;
2875
2876 close $fh
2877 or return;
2878
2879 aio_rename "$runtime~", $runtime
2880 and return;
2881
2882 warn "runtime file written.\n";
2883
2884 1
2885}
2886
2600sub emergency_save() { 2887sub emergency_save() {
2601 my $freeze_guard = cf::freeze_mainloop; 2888 my $freeze_guard = cf::freeze_mainloop;
2602 2889
2603 warn "enter emergency perl save\n"; 2890 warn "enter emergency perl save\n";
2604 2891
2679 %EXT_CORO = (); 2966 %EXT_CORO = ();
2680 2967
2681 warn "removing commands"; 2968 warn "removing commands";
2682 %COMMAND = (); 2969 %COMMAND = ();
2683 2970
2684 warn "removing ext commands"; 2971 warn "removing ext/exti commands";
2685 %EXTCMD = (); 2972 %EXTCMD = ();
2973 %EXTICMD = ();
2686 2974
2687 warn "unloading/nuking all extensions"; 2975 warn "unloading/nuking all extensions";
2688 for my $pkg (@EXTS) { 2976 for my $pkg (@EXTS) {
2689 warn "... unloading $pkg"; 2977 warn "... unloading $pkg";
2690 2978
2808 my $signal = new Coro::Signal; 3096 my $signal = new Coro::Signal;
2809 push @WAIT_FOR_TICK_BEGIN, $signal; 3097 push @WAIT_FOR_TICK_BEGIN, $signal;
2810 $signal->wait; 3098 $signal->wait;
2811} 3099}
2812 3100
3101 my $min = 1e6;#d#
3102 my $avg = 10;
2813$TICK_WATCHER = Event->timer ( 3103$TICK_WATCHER = Event->timer (
2814 reentrant => 0, 3104 reentrant => 0,
2815 parked => 1, 3105 parked => 1,
2816 prio => 0, 3106 prio => 0,
2817 at => $NEXT_TICK || $TICK, 3107 at => $NEXT_TICK || $TICK,
2821 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3111 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2822 unless ++$bug_warning > 10; 3112 unless ++$bug_warning > 10;
2823 return; 3113 return;
2824 } 3114 }
2825 3115
2826 $NOW = Event::time; 3116 $NOW = $tick_start = Event::time;
2827 3117
2828 cf::server_tick; # one server iteration 3118 cf::server_tick; # one server iteration
3119
3120 0 && sync_job {#d#
3121 for(1..10) {
3122 my $t = Event::time;
3123 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3124 or die;
3125
3126 $map->width (50);
3127 $map->height (50);
3128 $map->alloc;
3129 $map->_load_objects ("/tmp/x.map", 1);
3130 my $t = Event::time - $t;
3131
3132 #next unless $t < 0.0013;#d#
3133 if ($t < $min) {
3134 $min = $t;
3135 }
3136 $avg = $avg * 0.99 + $t * 0.01;
3137 }
3138 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3139 exit 0;
3140 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3141 };
2829 3142
2830 $RUNTIME += $TICK; 3143 $RUNTIME += $TICK;
2831 $NEXT_TICK += $TICK; 3144 $NEXT_TICK += $TICK;
2832 3145
2833 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3146 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2839 } 3152 }
2840 3153
2841# my $AFTER = Event::time; 3154# my $AFTER = Event::time;
2842# warn $AFTER - $NOW;#d# 3155# warn $AFTER - $NOW;#d#
2843 3156
3157 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3158 $sig->send;
3159 }
3160 while (my $sig = shift @WAIT_FOR_TICK) {
3161 $sig->send;
3162 }
3163
3164 $NOW = Event::time;
3165
2844 # if we are delayed by four ticks or more, skip them all 3166 # if we are delayed by four ticks or more, skip them all
2845 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3167 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2846 3168
2847 $TICK_WATCHER->at ($NEXT_TICK); 3169 $TICK_WATCHER->at ($NEXT_TICK);
2848 $TICK_WATCHER->start; 3170 $TICK_WATCHER->start;
2849 3171
2850 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3172 $LOAD = ($NOW - $tick_start) / $TICK;
2851 $sig->send; 3173 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2852 }
2853 while (my $sig = shift @WAIT_FOR_TICK) {
2854 $sig->send;
2855 }
2856 3174
2857 _post_tick; 3175 _post_tick;
3176
3177
2858 }, 3178 },
2859); 3179);
2860 3180
2861{ 3181{
2862 BDB::max_poll_time $TICK * 0.1; 3182 BDB::max_poll_time $TICK * 0.1;
2921 prio => 6, 3241 prio => 6,
2922 cb => \&IO::AIO::poll_cb, 3242 cb => \&IO::AIO::poll_cb,
2923 ); 3243 );
2924} 3244}
2925 3245
3246my $_log_backtrace;
3247
3248sub _log_backtrace {
3249 my ($msg, @addr) = @_;
3250
3251 $msg =~ s/\n//;
3252
3253 # limit the # of concurrent backtraces
3254 if ($_log_backtrace < 2) {
3255 ++$_log_backtrace;
3256 async {
3257 my @bt = fork_call {
3258 @addr = map { sprintf "%x", $_ } @addr;
3259 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3260 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3261 or die "addr2line: $!";
3262
3263 my @funcs;
3264 my @res = <$fh>;
3265 chomp for @res;
3266 while (@res) {
3267 my ($func, $line) = splice @res, 0, 2, ();
3268 push @funcs, "[$func] $line";
3269 }
3270
3271 @funcs
3272 };
3273
3274 LOG llevInfo, "[ABT] $msg\n";
3275 LOG llevInfo, "[ABT] $_\n" for @bt;
3276 --$_log_backtrace;
3277 };
3278 } else {
3279 LOG llevInfo, "[ABT] $msg\n";
3280 LOG llevInfo, "[ABT] [suppressed]\n";
3281 }
3282}
3283
2926# load additional modules 3284# load additional modules
2927use cf::pod; 3285use cf::pod;
2928 3286
2929END { cf::emergency_save } 3287END { cf::emergency_save }
2930 3288

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines