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.274 by root, Tue Jun 5 13:05:02 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
30use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
31use Time::HiRes; 32use Time::HiRes;
32use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
33 35
34# configure various modules to our taste 36# configure various modules to our taste
35# 37#
36$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 51our %COMMAND = ();
50our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
51 53
52our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
56 59
57our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
58our @EVENT; 61our @EVENT;
164 167
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process 169returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
177
169=back 178=back
170 179
171=cut 180=cut
172 181
173BEGIN { 182BEGIN {
206} 215}
207 216
208$Event::DIED = sub { 217$Event::DIED = sub {
209 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
210}; 219};
220
221#############################################################################
211 222
212=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
213 224
214=over 4 225=over 4
215 226
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 246 $d
236 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
237} 248}
238 249
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
242 251
243Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
244 253
245=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
246 255
247Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
248 264
249=item cf::lock_wait $string 265=item cf::lock_wait $string
250 266
251Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
252 268
306 }; 322 };
307 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
308 $guard 324 $guard
309} 325}
310 326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
311=item cf::async { BLOCK } 383=item cf::async { BLOCK }
312 384
313Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
318 390
319BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
320 392
321=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
322 394
323The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
326 399
327If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
330fast or be very important. 403fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
391 464
392 $coro 465 $coro
393} 466}
394 467
395sub write_runtime { 468=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 469
398 # first touch the runtime file to show we are still running: 470Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
400 474
401 IO::AIO::aio_utime $runtime, undef, undef; 475=cut
402 476
403 my $guard = cf::lock_acquire "write_runtime"; 477sub _store_scalar {
404 478 open my $fh, ">", \my $buf
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 479 or die "fork_call: cannot open fh-to-buf in child : $!";
406 or return; 480 Storable::store_fd $_[0], $fh;
407
408 my $value = $cf::RUNTIME + 90 + 10;
409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413 and return;
414
415 # always fsync - this file is important
416 aio_fsync $fh
417 and return;
418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
422 close $fh 481 close $fh;
423 or return;
424 482
425 aio_rename "$runtime~", $runtime 483 $buf
426 and return; 484}
427 485
428 warn "runtime file written.\n"; 486sub fork_call(&@) {
487 my ($cb, @args) = @_;
429 488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
430 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
431} 644}
432 645
433=item cf::datalog type => key => value, ... 646=item cf::datalog type => key => value, ...
434 647
435Log a datalog packet of the given type with the given key-value pairs. 648Log a datalog packet of the given type with the given key-value pairs.
453attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
455 668
456In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
457C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 671Crossfire TRT).
459 672
460=over 4 673=over 4
461 674
462=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
463 676
665 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
666 } 879 }
667 880
668 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
669 } else { 882 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 884 }
672 885
673 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
674} 887}
675 888
715 "; 928 ";
716 die if $@; 929 die if $@;
717} 930}
718 931
719our $override; 932our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 934
722sub override { 935sub override {
723 $override = 1; 936 $override = 1;
724 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
725} 938}
726 939
727sub do_invoke { 940sub do_invoke {
728 my $event = shift; 941 my $event = shift;
729 my $callbacks = shift; 942 my $callbacks = shift;
730 943
731 @invoke_results = (); 944 @INVOKE_RESULTS = ();
732 945
733 local $override; 946 local $override;
734 947
735 for (@$callbacks) { 948 for (@$callbacks) {
736 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
753 966
754Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
755 968
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 972
760=back 973=back
761 974
762=cut 975=cut
763 976
764############################################################################# 977#############################################################################
765# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
766 990
767sub reattach { 991sub reattach {
768 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 993 my ($obj) = @_;
770 994
877 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1102 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1103 return ($data, $av);
880} 1104}
881 1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
1111
882############################################################################# 1112#############################################################################
883# command handling &c 1113# command handling &c
884 1114
885=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
886 1116
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1129}
900 1130
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1132
903Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
904 1138
905If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
906called. 1140called.
907 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
908=cut 1153=cut
909 1154
910sub register_extcmd { 1155sub register_extcmd {
911 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
912 1157
913 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
914} 1165}
915 1166
916cf::player->attach ( 1167cf::player->attach (
917 on_command => sub { 1168 on_command => sub {
918 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
927 cf::override; 1178 cf::override;
928 }, 1179 },
929 on_extcmd => sub { 1180 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
931 1182
932 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1184
934 if (ref $msg) { 1185 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
943 1194
944 cf::override; 1195 cf::override;
945 }, 1196 },
946); 1197);
947 1198
948sub load_extension {
949 my ($path) = @_;
950
951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 my $base = $1;
953 my $pkg = $1;
954 $pkg =~ s/[^[:word:]]/_/g;
955 $pkg = "ext::$pkg";
956
957 warn "... loading '$path' into '$pkg'\n";
958
959 open my $fh, "<:utf8", $path
960 or die "$path: $!";
961
962 my $source =
963 "package $pkg; use strict; use utf8;\n"
964 . "#line 1 \"$path\"\n{\n"
965 . (do { local $/; <$fh> })
966 . "\n};\n1";
967
968 unless (eval $source) {
969 my $msg = $@ ? "$path: $@\n"
970 : "extension disabled.\n";
971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972 warn $@;
973 warn "mandatory extension failed to load, exiting.\n";
974 exit 1;
975 }
976 die $@;
977 }
978
979 push @EXTS, $pkg;
980}
981
982sub load_extensions { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
983 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1204 next unless -r $path;
985 eval { 1205
986 load_extension $ext; 1206 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1207 my $base = $1;
1208 my $pkg = $1;
1209 $pkg =~ s/[^[:word:]]/_/g;
1210 $pkg = "ext::$pkg";
1211
1212 open my $fh, "<:utf8", $path
1213 or die "$path: $!";
1214
1215 my $source = do { local $/; <$fh> };
1216
1217 my %ext = (
1218 path => $path,
1219 base => $base,
1220 pkg => $pkg,
1221 );
1222
1223 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1224 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1225
1226 $ext{source} =
1227 "package $pkg; use strict; use utf8;\n"
1228 . "#line 1 \"$path\"\n{\n"
1229 . $source
1230 . "\n};\n1";
1231
1232 $todo{$base} = \%ext;
1233 }
1234
1235 my %done;
1236 while (%todo) {
1237 my $progress;
1238
1239 while (my ($k, $v) = each %todo) {
1240 for (split /,\s*/, $v->{meta}{depends}) {
1241 goto skip
1242 unless exists $done{$_};
1243 }
1244
1245 warn "... loading '$k' into '$v->{pkg}'\n";
1246
1247 unless (eval $v->{source}) {
1248 my $msg = $@ ? "$v->{path}: $@\n"
1249 : "$v->{base}: extension inactive.\n";
1250
1251 if (exists $v->{meta}{mandatory}) {
1252 warn $msg;
1253 warn "mandatory extension failed to load, exiting.\n";
1254 exit 1;
1255 }
1256
1257 warn $msg;
1258 }
1259
1260 $done{$k} = delete $todo{$k};
1261 push @EXTS, $v->{pkg};
1262 $progress = 1;
987 1 1263 }
988 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
989 } 1269 };
990} 1270}
991 1271
992############################################################################# 1272#############################################################################
1273
1274=back
993 1275
994=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
995 1277
996Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
997 1279
1185 } 1467 }
1186 1468
1187 \@paths 1469 \@paths
1188} 1470}
1189 1471
1472=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1473
1474Expand crossfire pod fragments into protocol xml.
1475
1476=cut
1477
1478sub expand_cfpod {
1479 ((my $self), (local $_)) = @_;
1480
1481 # escape & and <
1482 s/&/&amp;/g;
1483 s/(?<![BIUGH])</&lt;/g;
1484
1485 # this is buggy, it needs to properly take care of nested <'s
1486
1487 1 while
1488 # replace B<>, I<>, U<> etc.
1489 s/B<([^\>]*)>/<b>$1<\/b>/
1490 || s/I<([^\>]*)>/<i>$1<\/i>/
1491 || s/U<([^\>]*)>/<u>$1<\/u>/
1492 # replace G<male|female> tags
1493 || s{G<([^>|]*)\|([^>]*)>}{
1494 $self->gender ? $2 : $1
1495 }ge
1496 # replace H<hint text>
1497 || s{H<([^\>]*)>}
1498 {
1499 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1500 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1501 "")
1502 [$self->{hintmode}]
1503 }ge;
1504
1505 # create single paragraphs (very hackish)
1506 s/(?<=\S)\n(?=\w)/ /g;
1507
1508 # compress some whitespace
1509 s/\s+\n/\n/g; # ws line-ends
1510 s/\n\n+/\n/g; # double lines
1511 s/^\n+//; # beginning lines
1512 s/\n+$//; # ending lines
1513
1514 $_
1515}
1516
1517sub hintmode {
1518 $_[0]{hintmode} = $_[1] if @_ > 1;
1519 $_[0]{hintmode}
1520}
1521
1190=item $player->ext_reply ($msgid, %msg) 1522=item $player->ext_reply ($msgid, %msg)
1191 1523
1192Sends an ext reply to the player. 1524Sends an ext reply to the player.
1193 1525
1194=cut 1526=cut
1195 1527
1196sub ext_reply($$%) { 1528sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1529 my ($self, $id, %msg) = @_;
1198 1530
1199 $msg{msgid} = $id; 1531 $msg{msgid} = $id;
1200 1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1533}
1203 1534
1204=item $player->ext_event ($type, %msg) 1535=item $player->ext_event ($type, %msg)
1205 1536
1206Sends an ext event to the client. 1537Sends an ext event to the client.
1221 1552
1222package cf::region; 1553package cf::region;
1223 1554
1224=item cf::region::find_by_path $path 1555=item cf::region::find_by_path $path
1225 1556
1226Tries to decuce the probable region for a map knowing only its path. 1557Tries to decuce the likely region for a map knowing only its path.
1227 1558
1228=cut 1559=cut
1229 1560
1230sub find_by_path($) { 1561sub find_by_path($) {
1231 my ($path) = @_; 1562 my ($path) = @_;
1232 1563
1233 my ($match, $specificity); 1564 my ($match, $specificity);
1234 1565
1235 for my $region (list) { 1566 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1567 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1568 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1569 if $region->specificity > $specificity;
1239 } 1570 }
1240 } 1571 }
1241 1572
1305 my ($self, $merge) = @_; 1636 my ($self, $merge) = @_;
1306 1637
1307 # we have to keep some variables in memory intact 1638 # we have to keep some variables in memory intact
1308 local $self->{path}; 1639 local $self->{path};
1309 local $self->{load_path}; 1640 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1641
1313 $self->SUPER::thawer_merge ($merge); 1642 $self->SUPER::thawer_merge ($merge);
1314} 1643}
1315 1644
1316sub normalise { 1645sub normalise {
1363 $self->init; # pass $1 etc. 1692 $self->init; # pass $1 etc.
1364 return $self; 1693 return $self;
1365 } 1694 }
1366 } 1695 }
1367 1696
1368 Carp::carp "unable to resolve path '$path' (base '$base')."; 1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1369 () 1698 ()
1370} 1699}
1371 1700
1372sub init { 1701sub init {
1373 my ($self) = @_; 1702 my ($self) = @_;
1414sub change_all_map_light { 1743sub change_all_map_light {
1415 my ($change) = @_; 1744 my ($change) = @_;
1416 1745
1417 $_->change_map_light ($change) 1746 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1747 for grep $_->outdoor, values %cf::MAP;
1748}
1749
1750sub decay_objects {
1751 my ($self) = @_;
1752
1753 return if $self->{deny_reset};
1754
1755 $self->do_decay_objects;
1419} 1756}
1420 1757
1421sub unlink_save { 1758sub unlink_save {
1422 my ($self) = @_; 1759 my ($self) = @_;
1423 1760
1481 $self->load_header_orig 1818 $self->load_header_orig
1482 or return; 1819 or return;
1483 $self->prepare_orig; 1820 $self->prepare_orig;
1484 } 1821 }
1485 1822
1823 $self->{deny_reset} = 1
1824 if $self->no_reset;
1825
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1826 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1827 unless $self->default_region;
1488 1828
1489 1 1829 1
1490} 1830}
1505 $map->{last_save} = $cf::RUNTIME; 1845 $map->{last_save} = $cf::RUNTIME;
1506 1846
1507 $map->load_header 1847 $map->load_header
1508 or return; 1848 or return;
1509 1849
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1851 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1852 #$cf::WAIT_FOR_TICK->wait;
1513 $map->reset; 1853 $map->reset;
1514 undef $guard; 1854 undef $guard;
1515 return find $path; 1855 return find $path;
1582 my ($self, $ob) = @_; 1922 my ($self, $ob) = @_;
1583 1923
1584 return find "~" . $ob->name . "/" . $self->{path} 1924 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1925 if $self->per_player;
1586 1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1929
1587 $self 1930 $self
1588} 1931}
1589 1932
1590# find and load all maps in the 3x3 area around a map 1933# find and load all maps in the 3x3 area around a map
1591sub load_diag { 1934sub load_diag {
1637 1980
1638 undef $MAP_PREFETCH{$path}; 1981 undef $MAP_PREFETCH{$path};
1639 $MAP_PREFETCHER ||= cf::async { 1982 $MAP_PREFETCHER ||= cf::async {
1640 while (%MAP_PREFETCH) { 1983 while (%MAP_PREFETCH) {
1641 for my $path (keys %MAP_PREFETCH) { 1984 for my $path (keys %MAP_PREFETCH) {
1642 my $map = find $path 1985 if (my $map = find $path) {
1643 or next;
1644 $map->load; 1986 $map->load;
1987 }
1645 1988
1646 delete $MAP_PREFETCH{$path}; 1989 delete $MAP_PREFETCH{$path};
1647 } 1990 }
1648 } 1991 }
1649 undef $MAP_PREFETCHER; 1992 undef $MAP_PREFETCHER;
1701 2044
1702sub reset_at { 2045sub reset_at {
1703 my ($self) = @_; 2046 my ($self) = @_;
1704 2047
1705 # TODO: safety, remove and allow resettable per-player maps 2048 # TODO: safety, remove and allow resettable per-player maps
1706 return 1e99 if $self->isa ("ext::map_per_player");#d#
1707 return 1e99 if $self->{deny_reset}; 2049 return 1e99 if $self->{deny_reset};
1708 2050
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 2053
1722 my ($self) = @_; 2064 my ($self) = @_;
1723 2065
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 2067
1726 return if $self->players; 2068 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 2069
1729 warn "resetting map ", $self->path; 2070 warn "resetting map ", $self->path;
1730 2071
1731 $self->in_memory (cf::MAP_SWAPPED); 2072 $self->in_memory (cf::MAP_SWAPPED);
1732 2073
1766 $cf::MAP{$self->path} = $self; 2107 $cf::MAP{$self->path} = $self;
1767 2108
1768 $self->reset; # polite request, might not happen 2109 $self->reset; # polite request, might not happen
1769} 2110}
1770 2111
2112=item $maps = cf::map::tmp_maps
2113
2114Returns an arrayref with all map paths of currently instantiated and saved
2115maps. May block.
2116
2117=cut
2118
2119sub tmp_maps() {
2120 [
2121 map {
2122 utf8::decode $_;
2123 /\.map$/
2124 ? normalise $_
2125 : ()
2126 } @{ aio_readdir $TMPDIR or [] }
2127 ]
2128}
2129
2130=item $maps = cf::map::random_maps
2131
2132Returns an arrayref with all map paths of currently instantiated and saved
2133random maps. May block.
2134
2135=cut
2136
2137sub random_maps() {
2138 [
2139 map {
2140 utf8::decode $_;
2141 /\.map$/
2142 ? normalise "?random/$_"
2143 : ()
2144 } @{ aio_readdir $RANDOMDIR or [] }
2145 ]
2146}
2147
1771=item cf::map::unique_maps 2148=item cf::map::unique_maps
1772 2149
1773Returns an arrayref of paths of all shared maps that have 2150Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2151instantiated unique items. May block.
1775 2152
1776=cut 2153=cut
1777 2154
1778sub unique_maps() { 2155sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2156 [
1780 or return; 2157 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2158 utf8::decode $_;
1786 next if /\.pst$/; 2159 /\.map$/
1787 next unless /^$PATH_SEP/o; 2160 ? normalise $_
1788 2161 : ()
1789 push @paths, cf::map::normalise $_; 2162 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2163 ]
1791
1792 \@paths
1793} 2164}
1794 2165
1795package cf; 2166package cf;
1796 2167
1797=back 2168=back
1843 2214
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2216
1846 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1848 } else { 2220 } else {
2221 my $pl = $self->contr;
2222
2223 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2224 my $diag = $pl->{npc_dialog};
2225 $diag->{pl}->ext_reply (
2226 $diag->{id},
2227 msgtype => "reply",
2228 msg => $diag->{pl}->expand_cfpod ($msg),
2229 add_topics => []
2230 );
2231
2232 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1851 } 2236 }
1852} 2237}
1853 2238
1854=item $player_object->may ("access") 2239=item $player_object->may ("access")
1855 2240
1944 2329
1945 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1946 $self->enter_map ($map, $x, $y); 2331 $self->enter_map ($map, $x, $y);
1947} 2332}
1948 2333
1949=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1950 2335
1951Moves the player to the given map-path and coordinates by first freezing 2336Moves the player to the given map-path and coordinates by first freezing
1952her, loading and preparing them map, calling the provided $check callback 2337her, loading and preparing them map, calling the provided $check callback
1953that has to return the map if sucecssful, and then unfreezes the player on 2338that has to return the map if sucecssful, and then unfreezes the player on
1954the new (success) or old (failed) map position. 2339the new (success) or old (failed) map position. In either case, $done will
2340be called at the end of this process.
1955 2341
1956=cut 2342=cut
1957 2343
1958our $GOTOGEN; 2344our $GOTOGEN;
1959 2345
1960sub cf::object::player::goto { 2346sub cf::object::player::goto {
1961 my ($self, $path, $x, $y, $check) = @_; 2347 my ($self, $path, $x, $y, $check, $done) = @_;
1962 2348
1963 # do generation counting so two concurrent goto's will be executed in-order 2349 # do generation counting so two concurrent goto's will be executed in-order
1964 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2350 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1965 2351
1966 $self->enter_link; 2352 $self->enter_link;
1986 2372
1987 if ($gen == $self->{_goto_generation}) { 2373 if ($gen == $self->{_goto_generation}) {
1988 delete $self->{_goto_generation}; 2374 delete $self->{_goto_generation};
1989 $self->leave_link ($map, $x, $y); 2375 $self->leave_link ($map, $x, $y);
1990 } 2376 }
2377
2378 $done->() if $done;
1991 })->prio (1); 2379 })->prio (1);
1992} 2380}
1993 2381
1994=item $player_object->enter_exit ($exit_object) 2382=item $player_object->enter_exit ($exit_object)
1995 2383
2064 my $hp = $exit->stats->hp; 2452 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp; 2453 my $sp = $exit->stats->sp;
2066 2454
2067 $self->enter_link; 2455 $self->enter_link;
2068 2456
2457 # if exit is damned, update players death & WoR home-position
2458 $self->contr->savebed ($slaying, $hp, $sp)
2459 if $exit->flag (FLAG_DAMNED);
2460
2069 (async { 2461 (async {
2070 $self->deactivate_recursive; # just to be sure 2462 $self->deactivate_recursive; # just to be sure
2071 unless (eval { 2463 unless (eval {
2072 $self->goto ($slaying, $hp, $sp); 2464 $self->goto ($slaying, $hp, $sp);
2073 2465
2100 2492
2101 utf8::encode $text; 2493 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2495}
2104 2496
2497=item $client->send_msg ($channel, $msg, $color, [extra...])
2498
2499Send a drawinfo or msg packet to the client, formatting the msg for the
2500client if neccessary. C<$type> should be a string identifying the type of
2501the message, with C<log> being the default. If C<$color> is negative, suppress
2502the message unless the client supports the msg packet.
2503
2504=cut
2505
2506sub cf::client::send_msg {
2507 my ($self, $channel, $msg, $color, @extra) = @_;
2508
2509 $msg = $self->pl->expand_cfpod ($msg);
2510
2511 $color &= ~cf::NDI_UNIQUE; # just in case...
2512
2513 if (ref $channel) {
2514 # send meta info to client, if not yet sent
2515 unless (exists $self->{channel}{$channel->{id}}) {
2516 $self->{channel}{$channel->{id}} = $channel;
2517 $self->ext_event (channel_info => %$channel);
2518 }
2519
2520 $channel = $channel->{id};
2521 }
2522
2523 return unless @extra || length $msg;
2524
2525 if ($self->can_msg) {
2526 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2527 } else {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 if ($color >= 0) {
2539 if (0 && $msg =~ /\[/) {
2540 $self->send_packet ("drawextinfo $color 4 0 $msg")
2541 } else {
2542 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2543 $self->send_packet ("drawinfo $color $msg")
2544 }
2545 }
2546 }
2547}
2548
2105=item $client->ext_event ($type, %msg) 2549=item $client->ext_event ($type, %msg)
2106 2550
2107Sends an exti event to the client. 2551Sends an ext event to the client.
2108 2552
2109=cut 2553=cut
2110 2554
2111sub cf::client::ext_event($$%) { 2555sub cf::client::ext_event($$%) {
2112 my ($self, $type, %msg) = @_; 2556 my ($self, $type, %msg) = @_;
2113 2557
2558 return unless $self->extcmd;
2559
2114 $msg{msgtype} = "event_$type"; 2560 $msg{msgtype} = "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2561 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2116} 2562}
2117 2563
2118=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
2119 2565
2120Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2567the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2122C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2568C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2569
2124Queries can fail, so check the return code. Or don't, as queries will become 2570Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2571become reliable at some point in the future.
2126 2572
2127=cut 2573=cut
2128 2574
2129sub cf::client::query { 2575sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2584 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2586
2141 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
2143} 2591}
2144 2592
2145cf::client->attach ( 2593cf::client->attach (
2594 on_connect => sub {
2595 my ($ns) = @_;
2596
2597 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2598 },
2146 on_reply => sub { 2599 on_reply => sub {
2147 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
2148 2601
2149 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
2150 # get handled first 2603 # get handled first
2162 } else { 2615 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2617 }
2165 } 2618 }
2166 }, 2619 },
2620 on_exticmd => sub {
2621 my ($ns, $buf) = @_;
2622
2623 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2624
2625 if (ref $msg) {
2626 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2627 if (my %reply = $cb->($ns, $msg)) {
2628 $reply{msgid} = $msg->{msgid};
2629 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2630 }
2631 }
2632 } else {
2633 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2634 }
2635
2636 cf::override;
2637 },
2167); 2638);
2168 2639
2169=item $client->async (\&cb) 2640=item $client->async (\&cb)
2170 2641
2171Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
2220 2691
2221=pod 2692=pod
2222 2693
2223The following functions and methods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
2224 2695
2225 cf::object contr pay_amount pay_player map 2696 cf::object
2697 contr pay_amount pay_player map x y force_find force_add
2698 insert remove
2699
2226 cf::object::player player 2700 cf::object::player
2227 cf::player peaceful 2701 player
2228 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
2229 2708
2230=cut 2709=cut
2231 2710
2232for ( 2711for (
2233 ["cf::object" => qw(contr pay_amount pay_player map)], 2712 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2713 insert remove)],
2234 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
2235 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
2236 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
2237) { 2717) {
2238 no strict 'refs'; 2718 no strict 'refs';
2309=back 2789=back
2310 2790
2311=cut 2791=cut
2312 2792
2313############################################################################# 2793#############################################################################
2314
2315=head2 EXTENSION DATABASE SUPPORT
2316
2317Crossfire maintains a very simple database for extension use. It can
2318currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2319convert to/from binary).
2320
2321The parameter C<$family> should best start with the name of the extension
2322using it, it should be unique.
2323
2324=over 4
2325
2326=item $value = cf::db_get $family => $key
2327
2328Returns a single value from the database.
2329
2330=item cf::db_put $family => $key => $value
2331
2332Stores the given C<$value> in the family.
2333
2334=cut
2335
2336our $DB;
2337
2338sub db_init {
2339 unless ($DB) {
2340 $DB = BDB::db_create $DB_ENV;
2341
2342 cf::sync_job {
2343 eval {
2344 $DB->set_flags (BDB::CHKSUM);
2345
2346 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2347 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2348 cf::cleanup "db_open(db): $!" if $!;
2349 };
2350 cf::cleanup "db_open(db): $@" if $@;
2351 };
2352 }
2353}
2354
2355sub db_get($$) {
2356 my $key = "$_[0]/$_[1]";
2357
2358 cf::sync_job {
2359 BDB::db_get $DB, undef, $key, my $data;
2360
2361 $! ? ()
2362 : $data
2363 }
2364}
2365
2366sub db_put($$$) {
2367 BDB::dbreq_pri 4;
2368 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2369}
2370
2371=item cf::cache $id => [$paths...], $processversion => $process
2372
2373Generic caching function that returns the value of the resource $id,
2374caching and regenerating as required.
2375
2376This function can block.
2377
2378=cut
2379
2380sub cache {
2381 my ($id, $src, $processversion, $process) = @_;
2382
2383 my $meta =
2384 join "\x00",
2385 $processversion,
2386 map {
2387 aio_stat $_
2388 and Carp::croak "$_: $!";
2389
2390 ($_, (stat _)[7,9])
2391 } @$src;
2392
2393 my $dbmeta = db_get cache => "$id/meta";
2394 if ($dbmeta ne $meta) {
2395 # changed, we may need to process
2396
2397 my @data;
2398 my $md5;
2399
2400 for (0 .. $#$src) {
2401 0 <= aio_load $src->[$_], $data[$_]
2402 or Carp::croak "$src->[$_]: $!";
2403 }
2404
2405 # if processing is expensive, check
2406 # checksum first
2407 if (1) {
2408 $md5 =
2409 join "\x00",
2410 $processversion,
2411 map {
2412 Coro::cede;
2413 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2414 } 0.. $#$src;
2415
2416
2417 my $dbmd5 = db_get cache => "$id/md5";
2418 if ($dbmd5 eq $md5) {
2419 db_put cache => "$id/meta", $meta;
2420
2421 return db_get cache => "$id/data";
2422 }
2423 }
2424
2425 my $t1 = Time::HiRes::time;
2426 my $data = $process->(\@data);
2427 my $t2 = Time::HiRes::time;
2428
2429 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430
2431 db_put cache => "$id/data", $data;
2432 db_put cache => "$id/md5" , $md5;
2433 db_put cache => "$id/meta", $meta;
2434
2435 return $data;
2436 }
2437
2438 db_get cache => "$id/data"
2439}
2440
2441=item fork_call { }, $args
2442
2443Executes the given code block with the given arguments in a seperate
2444process, returning the results. Everything must be serialisable with
2445Coro::Storable. May, of course, block. Note that the executed sub may
2446never block itself or use any form of Event handling.
2447
2448=cut
2449
2450sub fork_call(&@) {
2451 my ($cb, @args) = @_;
2452
2453# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454# or die "socketpair: $!";
2455 pipe my $fh1, my $fh2
2456 or die "pipe: $!";
2457
2458 if (my $pid = fork) {
2459 close $fh2;
2460
2461 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462 $res = Coro::Storable::thaw $res;
2463
2464 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465
2466 die $$res unless "ARRAY" eq ref $res;
2467
2468 return wantarray ? @$res : $res->[-1];
2469 } else {
2470 reset_signals;
2471 local $SIG{__WARN__};
2472 local $SIG{__DIE__};
2473 eval {
2474 close $fh1;
2475
2476 my @res = eval { $cb->(@args) };
2477 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478 };
2479
2480 warn $@ if $@;
2481 _exit 0;
2482 }
2483}
2484
2485#############################################################################
2486# the server's init and main functions 2794# the server's init and main functions
2487 2795
2488sub load_facedata($) { 2796sub load_facedata($) {
2489 my ($path) = @_; 2797 my ($path) = @_;
2490 2798
2502 { 2810 {
2503 my $faces = $facedata->{faceinfo}; 2811 my $faces = $facedata->{faceinfo};
2504 2812
2505 while (my ($face, $info) = each %$faces) { 2813 while (my ($face, $info) = each %$faces) {
2506 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2814 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2815 cf::face::set_visibility $idx, $info->{visibility};
2816 cf::face::set_magicmap $idx, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2817 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2818 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510 Coro::cede; 2819
2820 cf::cede_to_tick;
2511 } 2821 }
2512 2822
2513 while (my ($face, $info) = each %$faces) { 2823 while (my ($face, $info) = each %$faces) {
2514 next unless $info->{smooth}; 2824 next unless $info->{smooth};
2515 my $idx = cf::face::find $face 2825 my $idx = cf::face::find $face
2516 or next; 2826 or next;
2517 if (my $smooth = cf::face::find $info->{smooth}) { 2827 if (my $smooth = cf::face::find $info->{smooth}) {
2828 cf::face::set_smooth $idx, $smooth;
2518 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2829 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519 } else { 2830 } else {
2520 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2831 warn "smooth face '$info->{smooth}' not found for face '$face'";
2521 } 2832 }
2522 Coro::cede; 2833
2834 cf::cede_to_tick;
2523 } 2835 }
2524 } 2836 }
2525 2837
2526 { 2838 {
2527 my $anims = $facedata->{animinfo}; 2839 my $anims = $facedata->{animinfo};
2528 2840
2529 while (my ($anim, $info) = each %$anims) { 2841 while (my ($anim, $info) = each %$anims) {
2530 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2842 cf::anim::set $anim, $info->{frames}, $info->{facings};
2531 Coro::cede; 2843 cf::cede_to_tick;
2532 } 2844 }
2533 2845
2534 cf::anim::invalidate_all; # d'oh 2846 cf::anim::invalidate_all; # d'oh
2847 }
2848
2849 {
2850 # TODO: for gcfclient pleasure, we should give resources
2851 # that gcfclient doesn't grok a >10000 face index.
2852 my $res = $facedata->{resource};
2853 my $enc = JSON::XS->new->utf8->canonical;
2854
2855 while (my ($name, $info) = each %$res) {
2856 my $meta = $enc->encode ({
2857 name => $name,
2858 type => $info->{type},
2859 copyright => $info->{copyright}, #TODO#
2860 });
2861
2862 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2863
2864 if ($name =~ /\.jpg$/) {
2865 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2866 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2867 } else {
2868 my $data = pack "(w/a*)*", $meta, $info->{data};
2869 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2870
2871 cf::face::set_type $idx, 1;
2872 cf::face::set_data $idx, 0, $data, $chk;
2873 }
2874
2875 cf::cede_to_tick;
2876 }
2535 } 2877 }
2536 2878
2537 1 2879 1
2538} 2880}
2539 2881
2540sub reload_regions { 2882sub reload_regions {
2541 load_resource_file "$MAPDIR/regions" 2883 load_resource_file "$MAPDIR/regions"
2542 or die "unable to load regions file\n"; 2884 or die "unable to load regions file\n";
2885
2886 for (cf::region::list) {
2887 $_->{match} = qr/$_->{match}/
2888 if exists $_->{match};
2889 }
2543} 2890}
2544 2891
2545sub reload_facedata { 2892sub reload_facedata {
2546 load_facedata "$DATADIR/facedata" 2893 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 2894 or die "unable to load facedata\n";
2548} 2895}
2549 2896
2550sub reload_archetypes { 2897sub reload_archetypes {
2898 load_resource_file "$DATADIR/archetypes"
2899 or die "unable to load archetypes\n";
2900 #d# NEED to laod twice to resolve forward references
2901 # this really needs to be done in an extra post-pass
2902 # (which needs to be synchronous, so solve it differently)
2551 load_resource_file "$DATADIR/archetypes" 2903 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2904 or die "unable to load archetypes\n";
2553} 2905}
2554 2906
2555sub reload_treasures { 2907sub reload_treasures {
2627 }, 2979 },
2628 ); 2980 );
2629 } 2981 }
2630} 2982}
2631 2983
2984sub write_runtime {
2985 my $runtime = "$LOCALDIR/runtime";
2986
2987 # first touch the runtime file to show we are still running:
2988 # the fsync below can take a very very long time.
2989
2990 IO::AIO::aio_utime $runtime, undef, undef;
2991
2992 my $guard = cf::lock_acquire "write_runtime";
2993
2994 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2995 or return;
2996
2997 my $value = $cf::RUNTIME + 90 + 10;
2998 # 10 is the runtime save interval, for a monotonic clock
2999 # 60 allows for the watchdog to kill the server.
3000
3001 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3002 and return;
3003
3004 # always fsync - this file is important
3005 aio_fsync $fh
3006 and return;
3007
3008 # touch it again to show we are up-to-date
3009 aio_utime $fh, undef, undef;
3010
3011 close $fh
3012 or return;
3013
3014 aio_rename "$runtime~", $runtime
3015 and return;
3016
3017 warn "runtime file written.\n";
3018
3019 1
3020}
3021
2632sub emergency_save() { 3022sub emergency_save() {
2633 my $freeze_guard = cf::freeze_mainloop; 3023 my $freeze_guard = cf::freeze_mainloop;
2634 3024
2635 warn "enter emergency perl save\n"; 3025 warn "enter emergency perl save\n";
2636 3026
2711 %EXT_CORO = (); 3101 %EXT_CORO = ();
2712 3102
2713 warn "removing commands"; 3103 warn "removing commands";
2714 %COMMAND = (); 3104 %COMMAND = ();
2715 3105
2716 warn "removing ext commands"; 3106 warn "removing ext/exti commands";
2717 %EXTCMD = (); 3107 %EXTCMD = ();
3108 %EXTICMD = ();
2718 3109
2719 warn "unloading/nuking all extensions"; 3110 warn "unloading/nuking all extensions";
2720 for my $pkg (@EXTS) { 3111 for my $pkg (@EXTS) {
2721 warn "... unloading $pkg"; 3112 warn "... unloading $pkg";
2722 3113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines