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.301 by root, Tue Jul 10 07:01:51 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 _store_scalar {
380 # 10 is the runtime save interval, for a monotonic clock 415 open my $fh, ">", \my $buf
381 # 60 allows for the watchdog to kill the server. 416 or die "fork_call: cannot open fh-to-buf in child : $!";
382 417 Storable::store_fd $_[0], $fh;
383 (aio_write $fh, 0, (length $value), $value, 0) <= 0
384 and return;
385
386 # always fsync - this file is important
387 aio_fsync $fh
388 and return;
389
390 close $fh 418 close $fh;
391 or return;
392 419
393 aio_rename "$runtime~", $runtime 420 $buf
394 and return; 421}
395 422
423sub fork_call(&@) {
424 my ($cb, @args) = @_;
425
426# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
427# or die "socketpair: $!";
428 pipe my $fh1, my $fh2
429 or die "pipe: $!";
430
431 if (my $pid = fork) {
432 close $fh2;
433
434 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
435 warn "pst<$res>" unless $res =~ /^pst/;
436 $res = Coro::Storable::thaw $res;
437
438 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
439
440 Carp::confess $$res unless "ARRAY" eq ref $res;
441
442 return wantarray ? @$res : $res->[-1];
443 } else {
444 reset_signals;
445 local $SIG{__WARN__};
446 local $SIG{__DIE__};
447 # just in case, this hack effectively disables event
448 # in the child. cleaner and slower would be canceling all watchers,
449 # but this works for the time being.
450 local $Coro::idle;
451 $Coro::current->prio (Coro::PRIO_MAX);
452
453 eval {
454 close $fh1;
455
456 my @res = eval { $cb->(@args) };
457
458 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
459 close $fh2;
460 };
461
462 warn $@ if $@;
463 _exit 0;
396 1 464 }
465}
466
467=item $value = cf::db_get $family => $key
468
469Returns a single value from the environment database.
470
471=item cf::db_put $family => $key => $value
472
473Stores the given C<$value> in the family. It can currently store binary
474data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
475
476=cut
477
478our $DB;
479
480sub db_init {
481 unless ($DB) {
482 $DB = BDB::db_create $DB_ENV;
483
484 cf::sync_job {
485 eval {
486 $DB->set_flags (BDB::CHKSUM);
487
488 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
489 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
490 cf::cleanup "db_open(db): $!" if $!;
491 };
492 cf::cleanup "db_open(db): $@" if $@;
493 };
494 }
495}
496
497sub db_get($$) {
498 my $key = "$_[0]/$_[1]";
499
500 cf::sync_job {
501 BDB::db_get $DB, undef, $key, my $data;
502
503 $! ? ()
504 : $data
505 }
506}
507
508sub db_put($$$) {
509 BDB::dbreq_pri 4;
510 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
511}
512
513=item cf::cache $id => [$paths...], $processversion => $process
514
515Generic caching function that returns the value of the resource $id,
516caching and regenerating as required.
517
518This function can block.
519
520=cut
521
522sub cache {
523 my ($id, $src, $processversion, $process) = @_;
524
525 my $meta =
526 join "\x00",
527 $processversion,
528 map {
529 aio_stat $_
530 and Carp::croak "$_: $!";
531
532 ($_, (stat _)[7,9])
533 } @$src;
534
535 my $dbmeta = db_get cache => "$id/meta";
536 if ($dbmeta ne $meta) {
537 # changed, we may need to process
538
539 my @data;
540 my $md5;
541
542 for (0 .. $#$src) {
543 0 <= aio_load $src->[$_], $data[$_]
544 or Carp::croak "$src->[$_]: $!";
545 }
546
547 # if processing is expensive, check
548 # checksum first
549 if (1) {
550 $md5 =
551 join "\x00",
552 $processversion,
553 map {
554 Coro::cede;
555 ($src->[$_], Digest::MD5::md5_hex $data[$_])
556 } 0.. $#$src;
557
558
559 my $dbmd5 = db_get cache => "$id/md5";
560 if ($dbmd5 eq $md5) {
561 db_put cache => "$id/meta", $meta;
562
563 return db_get cache => "$id/data";
564 }
565 }
566
567 my $t1 = Time::HiRes::time;
568 my $data = $process->(\@data);
569 my $t2 = Time::HiRes::time;
570
571 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
572
573 db_put cache => "$id/data", $data;
574 db_put cache => "$id/md5" , $md5;
575 db_put cache => "$id/meta", $meta;
576
577 return $data;
578 }
579
580 db_get cache => "$id/data"
397} 581}
398 582
399=item cf::datalog type => key => value, ... 583=item cf::datalog type => key => value, ...
400 584
401Log a datalog packet of the given type with the given key-value pairs. 585Log 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") 603attach callbacks/event handlers (a collection of which is called an "attachment")
420to it. All such attachable objects support the following methods. 604to it. All such attachable objects support the following methods.
421 605
422In the following description, CLASS can be any of C<global>, C<object> 606In 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 607C<player>, C<client> or C<map> (i.e. the attachable objects in
424crossfire+). 608Crossfire TRT).
425 609
426=over 4 610=over 4
427 611
428=item $attachable->attach ($attachment, key => $value...) 612=item $attachable->attach ($attachment, key => $value...)
429 613
592 $registry = $CB_TYPE[$object_type] ||= []; 776 $registry = $CB_TYPE[$object_type] ||= [];
593 777
594 } elsif ($type eq "subtype") { 778 } elsif ($type eq "subtype") {
595 defined $object_type or Carp::croak "subtype specified without type"; 779 defined $object_type or Carp::croak "subtype specified without type";
596 my $object_subtype = shift @arg; 780 my $object_subtype = shift @arg;
597 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 781 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
598 782
599 } elsif ($type eq "package") { 783 } elsif ($type eq "package") {
600 my $pkg = shift @arg; 784 my $pkg = shift @arg;
601 785
602 while (my ($name, $id) = each %cb_id) { 786 while (my ($name, $id) = each %cb_id) {
631 _attach $registry, $klass, @attach; 815 _attach $registry, $klass, @attach;
632 } 816 }
633 817
634 $obj->{$name} = \%arg; 818 $obj->{$name} = \%arg;
635 } else { 819 } else {
636 warn "object uses attachment '$name' that is not available, postponing.\n"; 820 warn "object uses attachment '$name' which is not available, postponing.\n";
637 } 821 }
638 822
639 $obj->{_attachment}{$name} = undef; 823 $obj->{_attachment}{$name} = undef;
640} 824}
641 825
643 if (ref $_[0]) { 827 if (ref $_[0]) {
644 _object_attach @_; 828 _object_attach @_;
645 } else { 829 } else {
646 _attach shift->_attach_registry, @_; 830 _attach shift->_attach_registry, @_;
647 } 831 }
832 _recalc_want;
648}; 833};
649 834
650# all those should be optimised 835# all those should be optimised
651sub cf::attachable::detach { 836sub cf::attachable::detach {
652 my ($obj, $name) = @_; 837 my ($obj, $name) = @_;
655 delete $obj->{_attachment}{$name}; 840 delete $obj->{_attachment}{$name};
656 reattach ($obj); 841 reattach ($obj);
657 } else { 842 } else {
658 Carp::croak "cannot, currently, detach class attachments"; 843 Carp::croak "cannot, currently, detach class attachments";
659 } 844 }
845 _recalc_want;
660}; 846};
661 847
662sub cf::attachable::attached { 848sub cf::attachable::attached {
663 my ($obj, $name) = @_; 849 my ($obj, $name) = @_;
664 850
837 or return; 1023 or return;
838 $av = eval { (Storable::thaw $av)->{objs} }; 1024 $av = eval { (Storable::thaw $av)->{objs} };
839 } 1025 }
840 1026
841 warn sprintf "loading %s (%d)\n", 1027 warn sprintf "loading %s (%d)\n",
842 $filename, length $data, scalar @{$av || []};#d# 1028 $filename, length $data, scalar @{$av || []};
843 return ($data, $av); 1029 return ($data, $av);
844} 1030}
1031
1032=head2 COMMAND CALLBACKS
1033
1034=over 4
1035
1036=cut
845 1037
846############################################################################# 1038#############################################################################
847# command handling &c 1039# command handling &c
848 1040
849=item cf::register_command $name => \&callback($ob,$args); 1041=item cf::register_command $name => \&callback($ob,$args);
862 push @{ $COMMAND{$name} }, [$caller, $cb]; 1054 push @{ $COMMAND{$name} }, [$caller, $cb];
863} 1055}
864 1056
865=item cf::register_extcmd $name => \&callback($pl,$packet); 1057=item cf::register_extcmd $name => \&callback($pl,$packet);
866 1058
867Register a callbackf ro execution when the client sends an extcmd packet. 1059Register a callback for execution when the client sends an (synchronous)
1060extcmd packet. Ext commands will be processed in the order they are
1061received by the server, like other user commands. The first argument is
1062the logged-in player. Ext commands can only be processed after a player
1063has logged in successfully.
868 1064
869If the callback returns something, it is sent back as if reply was being 1065If the callback returns something, it is sent back as if reply was being
870called. 1066called.
871 1067
1068=item cf::register_exticmd $name => \&callback($ns,$packet);
1069
1070Register a callback for execution when the client sends an (asynchronous)
1071exticmd packet. Exti commands are processed by the server as soon as they
1072are received, i.e. out of order w.r.t. other commands. The first argument
1073is a client socket. Exti commands can be received anytime, even before
1074log-in.
1075
1076If the callback returns something, it is sent back as if reply was being
1077called.
1078
872=cut 1079=cut
873 1080
874sub register_extcmd { 1081sub register_extcmd {
875 my ($name, $cb) = @_; 1082 my ($name, $cb) = @_;
876 1083
877 $EXTCMD{$name} = $cb; 1084 $EXTCMD{$name} = $cb;
1085}
1086
1087sub register_exticmd {
1088 my ($name, $cb) = @_;
1089
1090 $EXTICMD{$name} = $cb;
878} 1091}
879 1092
880cf::player->attach ( 1093cf::player->attach (
881 on_command => sub { 1094 on_command => sub {
882 my ($pl, $name, $params) = @_; 1095 my ($pl, $name, $params) = @_;
891 cf::override; 1104 cf::override;
892 }, 1105 },
893 on_extcmd => sub { 1106 on_extcmd => sub {
894 my ($pl, $buf) = @_; 1107 my ($pl, $buf) = @_;
895 1108
896 my $msg = eval { from_json $buf }; 1109 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
897 1110
898 if (ref $msg) { 1111 if (ref $msg) {
899 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1112 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
900 if (my %reply = $cb->($pl, $msg)) { 1113 if (my %reply = $cb->($pl, $msg)) {
901 $pl->ext_reply ($msg->{msgid}, %reply); 1114 $pl->ext_reply ($msg->{msgid}, %reply);
907 1120
908 cf::override; 1121 cf::override;
909 }, 1122 },
910); 1123);
911 1124
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 { 1125sub load_extensions {
1126 cf::sync_job {
1127 my %todo;
1128
947 for my $ext (<$LIBDIR/*.ext>) { 1129 for my $path (<$LIBDIR/*.ext>) {
948 next unless -r $ext; 1130 next unless -r $path;
949 eval { 1131
950 load_extension $ext; 1132 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1133 my $base = $1;
1134 my $pkg = $1;
1135 $pkg =~ s/[^[:word:]]/_/g;
1136 $pkg = "ext::$pkg";
1137
1138 open my $fh, "<:utf8", $path
1139 or die "$path: $!";
1140
1141 my $source = do { local $/; <$fh> };
1142
1143 my %ext = (
1144 path => $path,
1145 base => $base,
1146 pkg => $pkg,
1147 );
1148
1149 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1150 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1151
1152 $ext{source} =
1153 "package $pkg; use strict; use utf8;\n"
1154 . "#line 1 \"$path\"\n{\n"
1155 . $source
1156 . "\n};\n1";
1157
1158 $todo{$base} = \%ext;
1159 }
1160
1161 my %done;
1162 while (%todo) {
1163 my $progress;
1164
1165 while (my ($k, $v) = each %todo) {
1166 for (split /,\s*/, $v->{meta}{depends}) {
1167 goto skip
1168 unless exists $done{$_};
1169 }
1170
1171 warn "... loading '$k' into '$v->{pkg}'\n";
1172
1173 unless (eval $v->{source}) {
1174 my $msg = $@ ? "$v->{path}: $@\n"
1175 : "$v->{base}: extension inactive.\n";
1176
1177 if (exists $v->{meta}{mandatory}) {
1178 warn $msg;
1179 warn "mandatory extension failed to load, exiting.\n";
1180 exit 1;
1181 }
1182
1183 warn $msg;
1184 }
1185
1186 $done{$k} = delete $todo{$k};
1187 push @EXTS, $v->{pkg};
1188 $progress = 1;
951 1 1189 }
952 } or warn "$ext not loaded: $@"; 1190
1191 skip:
1192 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1193 unless $progress;
1194 }
953 } 1195 };
954} 1196}
955 1197
956############################################################################# 1198#############################################################################
1199
1200=back
957 1201
958=head2 CORE EXTENSIONS 1202=head2 CORE EXTENSIONS
959 1203
960Functions and methods that extend core crossfire objects. 1204Functions and methods that extend core crossfire objects.
961 1205
1149 } 1393 }
1150 1394
1151 \@paths 1395 \@paths
1152} 1396}
1153 1397
1398=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1399
1400Expand crossfire pod fragments into protocol xml.
1401
1402=cut
1403
1404sub expand_cfpod {
1405 ((my $self), (local $_)) = @_;
1406
1407 # escape & and <
1408 s/&/&amp;/g;
1409 s/(?<![BIUGH])</&lt;/g;
1410
1411 # this is buggy, it needs to properly take care of nested <'s
1412
1413 1 while
1414 # replace B<>, I<>, U<> etc.
1415 s/B<([^\>]*)>/<b>$1<\/b>/
1416 || s/I<([^\>]*)>/<i>$1<\/i>/
1417 || s/U<([^\>]*)>/<u>$1<\/u>/
1418 # replace G<male|female> tags
1419 || s{G<([^>|]*)\|([^>]*)>}{
1420 $self->gender ? $2 : $1
1421 }ge
1422 # replace H<hint text>
1423 || s{H<([^\>]*)>}
1424 {
1425 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1426 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1427 "")
1428 [$self->{hintmode}]
1429 }ge;
1430
1431 # create single paragraphs (very hackish)
1432 s/(?<=\S)\n(?=\w)/ /g;
1433
1434 # compress some whitespace
1435 s/\s+\n/\n/g; # ws line-ends
1436 s/\n\n+/\n/g; # double lines
1437 s/^\n+//; # beginning lines
1438 s/\n+$//; # ending lines
1439
1440 $_
1441}
1442
1443sub hintmode {
1444 $_[0]{hintmode} = $_[1] if @_ > 1;
1445 $_[0]{hintmode}
1446}
1447
1154=item $player->ext_reply ($msgid, %msg) 1448=item $player->ext_reply ($msgid, %msg)
1155 1449
1156Sends an ext reply to the player. 1450Sends an ext reply to the player.
1157 1451
1158=cut 1452=cut
1159 1453
1160sub ext_reply($$%) { 1454sub ext_reply($$%) {
1161 my ($self, $id, %msg) = @_; 1455 my ($self, $id, %msg) = @_;
1162 1456
1163 $msg{msgid} = $id; 1457 $msg{msgid} = $id;
1164 1458 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1165 $self->send ("ext " . cf::to_json \%msg);
1166} 1459}
1167 1460
1168=item $player->ext_event ($type, %msg) 1461=item $player->ext_event ($type, %msg)
1169 1462
1170Sends an ext event to the client. 1463Sends an ext event to the client.
1185 1478
1186package cf::region; 1479package cf::region;
1187 1480
1188=item cf::region::find_by_path $path 1481=item cf::region::find_by_path $path
1189 1482
1190Tries to decuce the probable region for a map knowing only its path. 1483Tries to decuce the likely region for a map knowing only its path.
1191 1484
1192=cut 1485=cut
1193 1486
1194sub find_by_path($) { 1487sub find_by_path($) {
1195 my ($path) = @_; 1488 my ($path) = @_;
1269 my ($self, $merge) = @_; 1562 my ($self, $merge) = @_;
1270 1563
1271 # we have to keep some variables in memory intact 1564 # we have to keep some variables in memory intact
1272 local $self->{path}; 1565 local $self->{path};
1273 local $self->{load_path}; 1566 local $self->{load_path};
1274 local $self->{deny_save};
1275 local $self->{deny_reset};
1276 1567
1277 $self->SUPER::thawer_merge ($merge); 1568 $self->SUPER::thawer_merge ($merge);
1278} 1569}
1279 1570
1280sub normalise { 1571sub normalise {
1380 1671
1381 $_->change_map_light ($change) 1672 $_->change_map_light ($change)
1382 for grep $_->outdoor, values %cf::MAP; 1673 for grep $_->outdoor, values %cf::MAP;
1383} 1674}
1384 1675
1676sub decay_objects {
1677 my ($self) = @_;
1678
1679 return if $self->{deny_reset};
1680
1681 $self->do_decay_objects;
1682}
1683
1385sub unlink_save { 1684sub unlink_save {
1386 my ($self) = @_; 1685 my ($self) = @_;
1387 1686
1388 utf8::encode (my $save = $self->save_path); 1687 utf8::encode (my $save = $self->save_path);
1389 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1688 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1445 $self->load_header_orig 1744 $self->load_header_orig
1446 or return; 1745 or return;
1447 $self->prepare_orig; 1746 $self->prepare_orig;
1448 } 1747 }
1449 1748
1749 $self->{deny_reset} = 1
1750 if $self->no_reset;
1751
1450 $self->default_region (cf::region::find_by_path $self->{path}) 1752 $self->default_region (cf::region::find_by_path $self->{path})
1451 unless $self->default_region; 1753 unless $self->default_region;
1452 1754
1453 1 1755 1
1454} 1756}
1469 $map->{last_save} = $cf::RUNTIME; 1771 $map->{last_save} = $cf::RUNTIME;
1470 1772
1471 $map->load_header 1773 $map->load_header
1472 or return; 1774 or return;
1473 1775
1474 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1776 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1475 # doing this can freeze the server in a sync job, obviously 1777 # doing this can freeze the server in a sync job, obviously
1476 #$cf::WAIT_FOR_TICK->wait; 1778 #$cf::WAIT_FOR_TICK->wait;
1477 $map->reset; 1779 $map->reset;
1478 undef $guard; 1780 undef $guard;
1479 return find $path; 1781 return find $path;
1546 my ($self, $ob) = @_; 1848 my ($self, $ob) = @_;
1547 1849
1548 return find "~" . $ob->name . "/" . $self->{path} 1850 return find "~" . $ob->name . "/" . $self->{path}
1549 if $self->per_player; 1851 if $self->per_player;
1550 1852
1853# return find "?party/" . $ob->name . "/" . $self->{path}
1854# if $self->per_party;
1855
1551 $self 1856 $self
1552} 1857}
1553 1858
1554# find and load all maps in the 3x3 area around a map 1859# find and load all maps in the 3x3 area around a map
1555sub load_diag { 1860sub load_diag {
1665 1970
1666sub reset_at { 1971sub reset_at {
1667 my ($self) = @_; 1972 my ($self) = @_;
1668 1973
1669 # TODO: safety, remove and allow resettable per-player maps 1974 # 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}; 1975 return 1e99 if $self->{deny_reset};
1672 1976
1673 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1977 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1674 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1978 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1675 1979
1686 my ($self) = @_; 1990 my ($self) = @_;
1687 1991
1688 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1992 my $lock = cf::lock_acquire "map_data:$self->{path}";
1689 1993
1690 return if $self->players; 1994 return if $self->players;
1691 return if $self->isa ("ext::map_per_player");#d#
1692 1995
1693 warn "resetting map ", $self->path;#d# 1996 warn "resetting map ", $self->path;
1694 1997
1695 $self->in_memory (cf::MAP_SWAPPED); 1998 $self->in_memory (cf::MAP_SWAPPED);
1696 1999
1697 # need to save uniques path 2000 # need to save uniques path
1698 unless ($self->{deny_save}) { 2001 unless ($self->{deny_save}) {
1730 $cf::MAP{$self->path} = $self; 2033 $cf::MAP{$self->path} = $self;
1731 2034
1732 $self->reset; # polite request, might not happen 2035 $self->reset; # polite request, might not happen
1733} 2036}
1734 2037
2038=item $maps = cf::map::tmp_maps
2039
2040Returns an arrayref with all map paths of currently instantiated and saved
2041maps. May block.
2042
2043=cut
2044
2045sub tmp_maps() {
2046 [
2047 map {
2048 utf8::decode $_;
2049 /\.map$/
2050 ? normalise $_
2051 : ()
2052 } @{ aio_readdir $TMPDIR or [] }
2053 ]
2054}
2055
2056=item $maps = cf::map::random_maps
2057
2058Returns an arrayref with all map paths of currently instantiated and saved
2059random maps. May block.
2060
2061=cut
2062
2063sub random_maps() {
2064 [
2065 map {
2066 utf8::decode $_;
2067 /\.map$/
2068 ? normalise "?random/$_"
2069 : ()
2070 } @{ aio_readdir $RANDOMDIR or [] }
2071 ]
2072}
2073
1735=item cf::map::unique_maps 2074=item cf::map::unique_maps
1736 2075
1737Returns an arrayref of paths of all shared maps that have 2076Returns an arrayref of paths of all shared maps that have
1738instantiated unique items. May block. 2077instantiated unique items. May block.
1739 2078
1740=cut 2079=cut
1741 2080
1742sub unique_maps() { 2081sub unique_maps() {
1743 my $files = aio_readdir $UNIQUEDIR 2082 [
1744 or return; 2083 map {
1745
1746 my @paths;
1747
1748 for (@$files) {
1749 utf8::decode $_; 2084 utf8::decode $_;
1750 next if /\.pst$/; 2085 /\.map$/
1751 next unless /^$PATH_SEP/o; 2086 ? normalise $_
1752 2087 : ()
1753 push @paths, cf::map::normalise $_; 2088 } @{ aio_readdir $UNIQUEDIR or [] }
1754 } 2089 ]
1755
1756 \@paths
1757} 2090}
1758 2091
1759package cf; 2092package cf;
1760 2093
1761=back 2094=back
1807 2140
1808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2141 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1809 2142
1810 if ($self->{record_replies}) { 2143 if ($self->{record_replies}) {
1811 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2144 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2145
1812 } else { 2146 } else {
2147 my $pl = $self->contr;
2148
2149 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2150 my $diag = $pl->{npc_dialog};
2151 $diag->{pl}->ext_reply (
2152 $diag->{id},
2153 msgtype => "reply",
2154 msg => $diag->{pl}->expand_cfpod ($msg),
2155 add_topics => []
2156 );
2157
2158 } else {
1813 $msg = $npc->name . " says: $msg" if $npc; 2159 $msg = $npc->name . " says: $msg" if $npc;
1814 $self->message ($msg, $flags); 2160 $self->message ($msg, $flags);
2161 }
1815 } 2162 }
1816} 2163}
1817 2164
1818=item $player_object->may ("access") 2165=item $player_object->may ("access")
1819 2166
1862} 2209}
1863 2210
1864sub cf::object::player::enter_link { 2211sub cf::object::player::enter_link {
1865 my ($self) = @_; 2212 my ($self) = @_;
1866 2213
2214 $self->deactivate_recursive;
2215
1867 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2216 return if UNIVERSAL::isa $self->map, "ext::map_link";
1868 2217
1869 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2218 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1870 if $self->map; 2219 if $self->map && $self->map->{path} ne "{link}";
1871 2220
1872 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2221 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1873} 2222}
1874 2223
1875sub cf::object::player::leave_link { 2224sub cf::object::player::leave_link {
1876 my ($self, $map, $x, $y) = @_; 2225 my ($self, $map, $x, $y) = @_;
2226
2227 return unless $self->contr->active;
1877 2228
1878 my $link_pos = delete $self->{_link_pos}; 2229 my $link_pos = delete $self->{_link_pos};
1879 2230
1880 unless ($map) { 2231 unless ($map) {
1881 # restore original map position 2232 # restore original map position
1904 2255
1905 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2256 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1906 $self->enter_map ($map, $x, $y); 2257 $self->enter_map ($map, $x, $y);
1907} 2258}
1908 2259
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) 2260=item $player_object->goto ($path, $x, $y[, $check->($map)])
1942 2261
2262Moves the player to the given map-path and coordinates by first freezing
2263her, loading and preparing them map, calling the provided $check callback
2264that has to return the map if sucecssful, and then unfreezes the player on
2265the new (success) or old (failed) map position.
2266
1943=cut 2267=cut
2268
2269our $GOTOGEN;
1944 2270
1945sub cf::object::player::goto { 2271sub cf::object::player::goto {
1946 my ($self, $path, $x, $y) = @_; 2272 my ($self, $path, $x, $y, $check) = @_;
2273
2274 # do generation counting so two concurrent goto's will be executed in-order
2275 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1947 2276
1948 $self->enter_link; 2277 $self->enter_link;
1949 2278
1950 (async { 2279 (async {
1951 my $map = eval { 2280 my $map = eval {
1952 my $map = cf::map::find $path; 2281 my $map = cf::map::find $path;
2282
2283 if ($map) {
1953 $map = $map->customise_for ($self) if $map; 2284 $map = $map->customise_for ($self);
2285 $map = $check->($map) if $check && $map;
2286 } else {
2287 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2288 }
2289
1954 $map 2290 $map
2291 };
2292
2293 if ($@) {
2294 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2295 LOG llevError | logBacktrace, Carp::longmess $@;
1955 } or 2296 }
1956 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1957 2297
2298 if ($gen == $self->{_goto_generation}) {
2299 delete $self->{_goto_generation};
1958 $self->leave_link ($map, $x, $y); 2300 $self->leave_link ($map, $x, $y);
2301 }
1959 })->prio (1); 2302 })->prio (1);
1960} 2303}
1961 2304
1962=item $player_object->enter_exit ($exit_object) 2305=item $player_object->enter_exit ($exit_object)
1963 2306
2032 my $hp = $exit->stats->hp; 2375 my $hp = $exit->stats->hp;
2033 my $sp = $exit->stats->sp; 2376 my $sp = $exit->stats->sp;
2034 2377
2035 $self->enter_link; 2378 $self->enter_link;
2036 2379
2380 # if exit is damned, update players death & WoR home-position
2381 $self->contr->savebed ($slaying, $hp, $sp)
2382 if $exit->flag (FLAG_DAMNED);
2383
2037 (async { 2384 (async {
2038 $self->deactivate_recursive; # just to be sure 2385 $self->deactivate_recursive; # just to be sure
2039 unless (eval { 2386 unless (eval {
2040 $self->goto ($slaying, $hp, $sp); 2387 $self->goto ($slaying, $hp, $sp);
2041 2388
2068 2415
2069 utf8::encode $text; 2416 utf8::encode $text;
2070 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2417 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2071} 2418}
2072 2419
2420=item $client->send_msg ($color, $type, $msg, [extra...])
2421
2422Send a drawinfo or msg packet to the client, formatting the msg for the
2423client if neccessary. C<$type> should be a string identifying the type of
2424the message, with C<log> being the default. If C<$color> is negative, suppress
2425the message unless the client supports the msg packet.
2426
2427=cut
2428
2429sub cf::client::send_msg {
2430 my ($self, $color, $type, $msg, @extra) = @_;
2431
2432 $msg = $self->pl->expand_cfpod ($msg);
2433
2434 return unless @extra || length $msg;
2435
2436 if ($self->can_msg) {
2437 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2438 } else {
2439 # replace some tags by gcfclient-compatible ones
2440 for ($msg) {
2441 1 while
2442 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2443 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2444 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2445 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2446 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2447 }
2448
2449 if ($color >= 0) {
2450 if (0 && $msg =~ /\[/) {
2451 $self->send_packet ("drawextinfo $color 4 0 $msg")
2452 } else {
2453 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2454 $self->send_packet ("drawinfo $color $msg")
2455 }
2456 }
2457 }
2458}
2459
2073=item $client->ext_event ($type, %msg) 2460=item $client->ext_event ($type, %msg)
2074 2461
2075Sends an exti event to the client. 2462Sends an ext event to the client.
2076 2463
2077=cut 2464=cut
2078 2465
2079sub cf::client::ext_event($$%) { 2466sub cf::client::ext_event($$%) {
2080 my ($self, $type, %msg) = @_; 2467 my ($self, $type, %msg) = @_;
2081 2468
2082 $msg{msgtype} = "event_$type"; 2469 $msg{msgtype} = "event_$type";
2083 $self->send_packet ("ext " . cf::to_json \%msg); 2470 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2084} 2471}
2085 2472
2086=item $success = $client->query ($flags, "text", \&cb) 2473=item $success = $client->query ($flags, "text", \&cb)
2087 2474
2088Queues a query to the client, calling the given callback with 2475Queues a query to the client, calling the given callback with
2089the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2476the 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>. 2477C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2091 2478
2092Queries can fail, so check the return code. Or don't, as queries will become 2479Queries can fail, so check the return code. Or don't, as queries will
2093reliable at some point in the future. 2480become reliable at some point in the future.
2094 2481
2095=cut 2482=cut
2096 2483
2097sub cf::client::query { 2484sub cf::client::query {
2098 my ($self, $flags, $text, $cb) = @_; 2485 my ($self, $flags, $text, $cb) = @_;
2106 utf8::encode $text; 2493 utf8::encode $text;
2107 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2494 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2108 2495
2109 $self->send_packet ($self->{query_queue}[0][0]) 2496 $self->send_packet ($self->{query_queue}[0][0])
2110 if @{ $self->{query_queue} } == 1; 2497 if @{ $self->{query_queue} } == 1;
2498
2499 1
2111} 2500}
2112 2501
2113cf::client->attach ( 2502cf::client->attach (
2503 on_connect => sub {
2504 my ($ns) = @_;
2505
2506 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2507 },
2114 on_reply => sub { 2508 on_reply => sub {
2115 my ($ns, $msg) = @_; 2509 my ($ns, $msg) = @_;
2116 2510
2117 # this weird shuffling is so that direct followup queries 2511 # this weird shuffling is so that direct followup queries
2118 # get handled first 2512 # get handled first
2130 } else { 2524 } else {
2131 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2525 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2132 } 2526 }
2133 } 2527 }
2134 }, 2528 },
2529 on_exticmd => sub {
2530 my ($ns, $buf) = @_;
2531
2532 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2533
2534 if (ref $msg) {
2535 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2536 if (my %reply = $cb->($ns, $msg)) {
2537 $reply{msgid} = $msg->{msgid};
2538 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2539 }
2540 }
2541 } else {
2542 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2543 }
2544
2545 cf::override;
2546 },
2135); 2547);
2136 2548
2137=item $client->async (\&cb) 2549=item $client->async (\&cb)
2138 2550
2139Create a new coroutine, running the specified callback. The coroutine will 2551Create a new coroutine, running the specified callback. The coroutine will
2188 2600
2189=pod 2601=pod
2190 2602
2191The following functions and methods are available within a safe environment: 2603The following functions and methods are available within a safe environment:
2192 2604
2193 cf::object contr pay_amount pay_player map 2605 cf::object
2606 contr pay_amount pay_player map x y force_find force_add
2607 insert remove
2608
2194 cf::object::player player 2609 cf::object::player
2195 cf::player peaceful 2610 player
2196 cf::map trigger 2611
2612 cf::player
2613 peaceful
2614
2615 cf::map
2616 trigger
2197 2617
2198=cut 2618=cut
2199 2619
2200for ( 2620for (
2201 ["cf::object" => qw(contr pay_amount pay_player map)], 2621 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2622 insert remove)],
2202 ["cf::object::player" => qw(player)], 2623 ["cf::object::player" => qw(player)],
2203 ["cf::player" => qw(peaceful)], 2624 ["cf::player" => qw(peaceful)],
2204 ["cf::map" => qw(trigger)], 2625 ["cf::map" => qw(trigger)],
2205) { 2626) {
2206 no strict 'refs'; 2627 no strict 'refs';
2275} 2696}
2276 2697
2277=back 2698=back
2278 2699
2279=cut 2700=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 2701
2454############################################################################# 2702#############################################################################
2455# the server's init and main functions 2703# the server's init and main functions
2456 2704
2457sub load_facedata($) { 2705sub load_facedata($) {
2517} 2765}
2518 2766
2519sub reload_archetypes { 2767sub reload_archetypes {
2520 load_resource_file "$DATADIR/archetypes" 2768 load_resource_file "$DATADIR/archetypes"
2521 or die "unable to load archetypes\n"; 2769 or die "unable to load archetypes\n";
2770 #d# NEED to laod twice to resolve forward references
2771 # this really needs to be done in an extra post-pass
2772 # (which needs to be synchronous, so solve it differently)
2773 load_resource_file "$DATADIR/archetypes"
2774 or die "unable to load archetypes\n";
2522} 2775}
2523 2776
2524sub reload_treasures { 2777sub reload_treasures {
2525 load_resource_file "$DATADIR/treasures" 2778 load_resource_file "$DATADIR/treasures"
2526 or die "unable to load treasurelists\n"; 2779 or die "unable to load treasurelists\n";
2529sub reload_resources { 2782sub reload_resources {
2530 warn "reloading resource files...\n"; 2783 warn "reloading resource files...\n";
2531 2784
2532 reload_regions; 2785 reload_regions;
2533 reload_facedata; 2786 reload_facedata;
2787 #reload_archetypes;#d#
2534 reload_archetypes; 2788 reload_archetypes;
2535 reload_treasures; 2789 reload_treasures;
2536 2790
2537 warn "finished reloading resource files\n"; 2791 warn "finished reloading resource files\n";
2538} 2792}
2595 }, 2849 },
2596 ); 2850 );
2597 } 2851 }
2598} 2852}
2599 2853
2854sub write_runtime {
2855 my $runtime = "$LOCALDIR/runtime";
2856
2857 # first touch the runtime file to show we are still running:
2858 # the fsync below can take a very very long time.
2859
2860 IO::AIO::aio_utime $runtime, undef, undef;
2861
2862 my $guard = cf::lock_acquire "write_runtime";
2863
2864 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2865 or return;
2866
2867 my $value = $cf::RUNTIME + 90 + 10;
2868 # 10 is the runtime save interval, for a monotonic clock
2869 # 60 allows for the watchdog to kill the server.
2870
2871 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2872 and return;
2873
2874 # always fsync - this file is important
2875 aio_fsync $fh
2876 and return;
2877
2878 # touch it again to show we are up-to-date
2879 aio_utime $fh, undef, undef;
2880
2881 close $fh
2882 or return;
2883
2884 aio_rename "$runtime~", $runtime
2885 and return;
2886
2887 warn "runtime file written.\n";
2888
2889 1
2890}
2891
2600sub emergency_save() { 2892sub emergency_save() {
2601 my $freeze_guard = cf::freeze_mainloop; 2893 my $freeze_guard = cf::freeze_mainloop;
2602 2894
2603 warn "enter emergency perl save\n"; 2895 warn "enter emergency perl save\n";
2604 2896
2679 %EXT_CORO = (); 2971 %EXT_CORO = ();
2680 2972
2681 warn "removing commands"; 2973 warn "removing commands";
2682 %COMMAND = (); 2974 %COMMAND = ();
2683 2975
2684 warn "removing ext commands"; 2976 warn "removing ext/exti commands";
2685 %EXTCMD = (); 2977 %EXTCMD = ();
2978 %EXTICMD = ();
2686 2979
2687 warn "unloading/nuking all extensions"; 2980 warn "unloading/nuking all extensions";
2688 for my $pkg (@EXTS) { 2981 for my $pkg (@EXTS) {
2689 warn "... unloading $pkg"; 2982 warn "... unloading $pkg";
2690 2983
2808 my $signal = new Coro::Signal; 3101 my $signal = new Coro::Signal;
2809 push @WAIT_FOR_TICK_BEGIN, $signal; 3102 push @WAIT_FOR_TICK_BEGIN, $signal;
2810 $signal->wait; 3103 $signal->wait;
2811} 3104}
2812 3105
3106 my $min = 1e6;#d#
3107 my $avg = 10;
2813$TICK_WATCHER = Event->timer ( 3108$TICK_WATCHER = Event->timer (
2814 reentrant => 0, 3109 reentrant => 0,
2815 parked => 1, 3110 parked => 1,
2816 prio => 0, 3111 prio => 0,
2817 at => $NEXT_TICK || $TICK, 3112 at => $NEXT_TICK || $TICK,
2821 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3116 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2822 unless ++$bug_warning > 10; 3117 unless ++$bug_warning > 10;
2823 return; 3118 return;
2824 } 3119 }
2825 3120
2826 $NOW = Event::time; 3121 $NOW = $tick_start = Event::time;
2827 3122
2828 cf::server_tick; # one server iteration 3123 cf::server_tick; # one server iteration
3124
3125 0 && sync_job {#d#
3126 for(1..10) {
3127 my $t = Event::time;
3128 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3129 or die;
3130
3131 $map->width (50);
3132 $map->height (50);
3133 $map->alloc;
3134 $map->_load_objects ("/tmp/x.map", 1);
3135 my $t = Event::time - $t;
3136
3137 #next unless $t < 0.0013;#d#
3138 if ($t < $min) {
3139 $min = $t;
3140 }
3141 $avg = $avg * 0.99 + $t * 0.01;
3142 }
3143 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3144 exit 0;
3145 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3146 };
2829 3147
2830 $RUNTIME += $TICK; 3148 $RUNTIME += $TICK;
2831 $NEXT_TICK += $TICK; 3149 $NEXT_TICK += $TICK;
2832 3150
2833 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3151 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2839 } 3157 }
2840 3158
2841# my $AFTER = Event::time; 3159# my $AFTER = Event::time;
2842# warn $AFTER - $NOW;#d# 3160# warn $AFTER - $NOW;#d#
2843 3161
3162 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3163 $sig->send;
3164 }
3165 while (my $sig = shift @WAIT_FOR_TICK) {
3166 $sig->send;
3167 }
3168
3169 $NOW = Event::time;
3170
2844 # if we are delayed by four ticks or more, skip them all 3171 # if we are delayed by four ticks or more, skip them all
2845 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3172 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2846 3173
2847 $TICK_WATCHER->at ($NEXT_TICK); 3174 $TICK_WATCHER->at ($NEXT_TICK);
2848 $TICK_WATCHER->start; 3175 $TICK_WATCHER->start;
2849 3176
2850 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3177 $LOAD = ($NOW - $tick_start) / $TICK;
2851 $sig->send; 3178 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2852 }
2853 while (my $sig = shift @WAIT_FOR_TICK) {
2854 $sig->send;
2855 }
2856 3179
2857 _post_tick; 3180 _post_tick;
3181
3182
2858 }, 3183 },
2859); 3184);
2860 3185
2861{ 3186{
2862 BDB::max_poll_time $TICK * 0.1; 3187 BDB::max_poll_time $TICK * 0.1;
2921 prio => 6, 3246 prio => 6,
2922 cb => \&IO::AIO::poll_cb, 3247 cb => \&IO::AIO::poll_cb,
2923 ); 3248 );
2924} 3249}
2925 3250
3251my $_log_backtrace;
3252
3253sub _log_backtrace {
3254 my ($msg, @addr) = @_;
3255
3256 $msg =~ s/\n//;
3257
3258 # limit the # of concurrent backtraces
3259 if ($_log_backtrace < 2) {
3260 ++$_log_backtrace;
3261 async {
3262 my @bt = fork_call {
3263 @addr = map { sprintf "%x", $_ } @addr;
3264 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3265 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3266 or die "addr2line: $!";
3267
3268 my @funcs;
3269 my @res = <$fh>;
3270 chomp for @res;
3271 while (@res) {
3272 my ($func, $line) = splice @res, 0, 2, ();
3273 push @funcs, "[$func] $line";
3274 }
3275
3276 @funcs
3277 };
3278
3279 LOG llevInfo, "[ABT] $msg\n";
3280 LOG llevInfo, "[ABT] $_\n" for @bt;
3281 --$_log_backtrace;
3282 };
3283 } else {
3284 LOG llevInfo, "[ABT] $msg\n";
3285 LOG llevInfo, "[ABT] [suppressed]\n";
3286 }
3287}
3288
2926# load additional modules 3289# load additional modules
2927use cf::pod; 3290use cf::pod;
2928 3291
2929END { cf::emergency_save } 3292END { cf::emergency_save }
2930 3293

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines