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.273 by root, Mon Jun 4 12:19:08 2007 UTC vs.
Revision 1.314 by root, Mon Jul 23 16:53:15 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]
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
333Useful for short background jobs.
334
335=cut
336
337our @SLOT_QUEUE;
338our $SLOT_QUEUE;
339
340$SLOT_QUEUE->cancel if $SLOT_QUEUE;
341$SLOT_QUEUE = Coro::async {
342 my $signal = new Coro::Signal;
343
344 while () {
345 next_job:
346 my $avail = cf::till_tick;
347 if ($avail > 0.01) {
348 for (0 .. $#SLOT_QUEUE) {
349 if ($SLOT_QUEUE[$_][0] < $avail) {
350 my $job = splice @SLOT_QUEUE, $_, 1, ();
351 $job->[2]->send;
352 Coro::cede;
353 goto next_job;
354 }
355 }
356 }
357
358 if (@SLOT_QUEUE) {
359 # we do not use wait_For_tick() as it returns immediately when tick is inactive
360 push @cf::WAIT_FOR_TICK, $signal;
361 $signal->wait;
362 } else {
363 Coro::schedule;
364 }
365 }
366};
367
368sub get_slot($;$) {
369 my ($time, $pri) = @_;
370
371 push @SLOT_QUEUE, [$time, $pri, my $sig = new Coro::Signal];
372 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
373 $SLOT_QUEUE->ready;
374 $sig->wait;
375}
376
311=item cf::async { BLOCK } 377=item cf::async { BLOCK }
312 378
313Currently the same as Coro::async_pool, meaning you cannot use 379Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 380C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 381thing you are allowed to do is call C<prio> on it.
318 384
319BEGIN { *async = \&Coro::async_pool } 385BEGIN { *async = \&Coro::async_pool }
320 386
321=item cf::sync_job { BLOCK } 387=item cf::sync_job { BLOCK }
322 388
323The design of crossfire+ requires that the main coro ($Coro::main) is 389The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 390is 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. 391partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
392acceptable.
326 393
327If it must be done, put the blocking parts into C<sync_job>. This will run 394If 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 395the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 396server will be frozen during this time, so the block should either finish
330fast or be very important. 397fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 457 $EXT_CORO{$coro+0} = $coro;
391 458
392 $coro 459 $coro
393} 460}
394 461
395sub write_runtime { 462=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 463
398 # first touch the runtime file to show we are still running: 464Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 465process, returning the results. Everything must be serialisable with
466Coro::Storable. May, of course, block. Note that the executed sub may
467never block itself or use any form of Event handling.
400 468
401 IO::AIO::aio_utime $runtime, undef, undef; 469=cut
402 470
403 my $guard = cf::lock_acquire "write_runtime"; 471sub _store_scalar {
404 472 open my $fh, ">", \my $buf
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 473 or die "fork_call: cannot open fh-to-buf in child : $!";
406 or return; 474 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 475 close $fh;
423 or return;
424 476
425 aio_rename "$runtime~", $runtime 477 $buf
426 and return; 478}
427 479
428 warn "runtime file written.\n";#d# 480sub fork_call(&@) {
481 my ($cb, @args) = @_;
429 482
483# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
484# or die "socketpair: $!";
485 pipe my $fh1, my $fh2
486 or die "pipe: $!";
487
488 if (my $pid = fork) {
489 close $fh2;
490
491 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
492 warn "pst<$res>" unless $res =~ /^pst/;
493 $res = Coro::Storable::thaw $res;
494
495 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
496
497 Carp::confess $$res unless "ARRAY" eq ref $res;
498
499 return wantarray ? @$res : $res->[-1];
500 } else {
501 reset_signals;
502 local $SIG{__WARN__};
503 local $SIG{__DIE__};
504 # just in case, this hack effectively disables event
505 # in the child. cleaner and slower would be canceling all watchers,
506 # but this works for the time being.
507 local $Coro::idle;
508 $Coro::current->prio (Coro::PRIO_MAX);
509
510 eval {
511 close $fh1;
512
513 my @res = eval { $cb->(@args) };
514
515 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
516 close $fh2;
517 };
518
519 warn $@ if $@;
520 _exit 0;
430 1 521 }
522}
523
524=item $value = cf::db_get $family => $key
525
526Returns a single value from the environment database.
527
528=item cf::db_put $family => $key => $value
529
530Stores the given C<$value> in the family. It can currently store binary
531data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
532
533=cut
534
535our $DB;
536
537sub db_init {
538 unless ($DB) {
539 $DB = BDB::db_create $DB_ENV;
540
541 cf::sync_job {
542 eval {
543 $DB->set_flags (BDB::CHKSUM);
544
545 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
546 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
547 cf::cleanup "db_open(db): $!" if $!;
548 };
549 cf::cleanup "db_open(db): $@" if $@;
550 };
551 }
552}
553
554sub db_get($$) {
555 my $key = "$_[0]/$_[1]";
556
557 cf::sync_job {
558 BDB::db_get $DB, undef, $key, my $data;
559
560 $! ? ()
561 : $data
562 }
563}
564
565sub db_put($$$) {
566 BDB::dbreq_pri 4;
567 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
568}
569
570=item cf::cache $id => [$paths...], $processversion => $process
571
572Generic caching function that returns the value of the resource $id,
573caching and regenerating as required.
574
575This function can block.
576
577=cut
578
579sub cache {
580 my ($id, $src, $processversion, $process) = @_;
581
582 my $meta =
583 join "\x00",
584 $processversion,
585 map {
586 aio_stat $_
587 and Carp::croak "$_: $!";
588
589 ($_, (stat _)[7,9])
590 } @$src;
591
592 my $dbmeta = db_get cache => "$id/meta";
593 if ($dbmeta ne $meta) {
594 # changed, we may need to process
595
596 my @data;
597 my $md5;
598
599 for (0 .. $#$src) {
600 0 <= aio_load $src->[$_], $data[$_]
601 or Carp::croak "$src->[$_]: $!";
602 }
603
604 # if processing is expensive, check
605 # checksum first
606 if (1) {
607 $md5 =
608 join "\x00",
609 $processversion,
610 map {
611 Coro::cede;
612 ($src->[$_], Digest::MD5::md5_hex $data[$_])
613 } 0.. $#$src;
614
615
616 my $dbmd5 = db_get cache => "$id/md5";
617 if ($dbmd5 eq $md5) {
618 db_put cache => "$id/meta", $meta;
619
620 return db_get cache => "$id/data";
621 }
622 }
623
624 my $t1 = Time::HiRes::time;
625 my $data = $process->(\@data);
626 my $t2 = Time::HiRes::time;
627
628 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
629
630 db_put cache => "$id/data", $data;
631 db_put cache => "$id/md5" , $md5;
632 db_put cache => "$id/meta", $meta;
633
634 return $data;
635 }
636
637 db_get cache => "$id/data"
431} 638}
432 639
433=item cf::datalog type => key => value, ... 640=item cf::datalog type => key => value, ...
434 641
435Log a datalog packet of the given type with the given key-value pairs. 642Log 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") 660attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 661to it. All such attachable objects support the following methods.
455 662
456In the following description, CLASS can be any of C<global>, C<object> 663In 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 664C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 665Crossfire TRT).
459 666
460=over 4 667=over 4
461 668
462=item $attachable->attach ($attachment, key => $value...) 669=item $attachable->attach ($attachment, key => $value...)
463 670
665 _attach $registry, $klass, @attach; 872 _attach $registry, $klass, @attach;
666 } 873 }
667 874
668 $obj->{$name} = \%arg; 875 $obj->{$name} = \%arg;
669 } else { 876 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 877 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 878 }
672 879
673 $obj->{_attachment}{$name} = undef; 880 $obj->{_attachment}{$name} = undef;
674} 881}
675 882
715 "; 922 ";
716 die if $@; 923 die if $@;
717} 924}
718 925
719our $override; 926our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 927our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 928
722sub override { 929sub override {
723 $override = 1; 930 $override = 1;
724 @invoke_results = (); 931 @INVOKE_RESULTS = (@_);
725} 932}
726 933
727sub do_invoke { 934sub do_invoke {
728 my $event = shift; 935 my $event = shift;
729 my $callbacks = shift; 936 my $callbacks = shift;
730 937
731 @invoke_results = (); 938 @INVOKE_RESULTS = ();
732 939
733 local $override; 940 local $override;
734 941
735 for (@$callbacks) { 942 for (@$callbacks) {
736 eval { &{$_->[1]} }; 943 eval { &{$_->[1]} };
753 960
754Generate an object-specific event with the given arguments. 961Generate an object-specific event with the given arguments.
755 962
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 963This 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 964removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 965results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 966
760=back 967=back
761 968
762=cut 969=cut
763 970
764############################################################################# 971#############################################################################
765# object support 972# object support
973#
974
975sub _can_merge {
976 my ($ob1, $ob2) = @_;
977
978 local $Storable::canonical = 1;
979 my $fob1 = Storable::freeze $ob1;
980 my $fob2 = Storable::freeze $ob2;
981
982 $fob1 eq $fob2
983}
766 984
767sub reattach { 985sub reattach {
768 # basically do the same as instantiate, without calling instantiate 986 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 987 my ($obj) = @_;
770 988
873 or return; 1091 or return;
874 $av = eval { (Storable::thaw $av)->{objs} }; 1092 $av = eval { (Storable::thaw $av)->{objs} };
875 } 1093 }
876 1094
877 warn sprintf "loading %s (%d)\n", 1095 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []};#d# 1096 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1097 return ($data, $av);
880} 1098}
1099
1100=head2 COMMAND CALLBACKS
1101
1102=over 4
1103
1104=cut
881 1105
882############################################################################# 1106#############################################################################
883# command handling &c 1107# command handling &c
884 1108
885=item cf::register_command $name => \&callback($ob,$args); 1109=item cf::register_command $name => \&callback($ob,$args);
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1122 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1123}
900 1124
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1125=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1126
903Register a callbackf ro execution when the client sends an extcmd packet. 1127Register a callback for execution when the client sends an (synchronous)
1128extcmd packet. Ext commands will be processed in the order they are
1129received by the server, like other user commands. The first argument is
1130the logged-in player. Ext commands can only be processed after a player
1131has logged in successfully.
904 1132
905If the callback returns something, it is sent back as if reply was being 1133If the callback returns something, it is sent back as if reply was being
906called. 1134called.
907 1135
1136=item cf::register_exticmd $name => \&callback($ns,$packet);
1137
1138Register a callback for execution when the client sends an (asynchronous)
1139exticmd packet. Exti commands are processed by the server as soon as they
1140are received, i.e. out of order w.r.t. other commands. The first argument
1141is a client socket. Exti commands can be received anytime, even before
1142log-in.
1143
1144If the callback returns something, it is sent back as if reply was being
1145called.
1146
908=cut 1147=cut
909 1148
910sub register_extcmd { 1149sub register_extcmd {
911 my ($name, $cb) = @_; 1150 my ($name, $cb) = @_;
912 1151
913 $EXTCMD{$name} = $cb; 1152 $EXTCMD{$name} = $cb;
1153}
1154
1155sub register_exticmd {
1156 my ($name, $cb) = @_;
1157
1158 $EXTICMD{$name} = $cb;
914} 1159}
915 1160
916cf::player->attach ( 1161cf::player->attach (
917 on_command => sub { 1162 on_command => sub {
918 my ($pl, $name, $params) = @_; 1163 my ($pl, $name, $params) = @_;
927 cf::override; 1172 cf::override;
928 }, 1173 },
929 on_extcmd => sub { 1174 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1175 my ($pl, $buf) = @_;
931 1176
932 my $msg = eval { from_json $buf }; 1177 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1178
934 if (ref $msg) { 1179 if (ref $msg) {
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1180 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 if (my %reply = $cb->($pl, $msg)) { 1181 if (my %reply = $cb->($pl, $msg)) {
937 $pl->ext_reply ($msg->{msgid}, %reply); 1182 $pl->ext_reply ($msg->{msgid}, %reply);
943 1188
944 cf::override; 1189 cf::override;
945 }, 1190 },
946); 1191);
947 1192
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 { 1193sub load_extensions {
1194 cf::sync_job {
1195 my %todo;
1196
983 for my $ext (<$LIBDIR/*.ext>) { 1197 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1198 next unless -r $path;
985 eval { 1199
986 load_extension $ext; 1200 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1201 my $base = $1;
1202 my $pkg = $1;
1203 $pkg =~ s/[^[:word:]]/_/g;
1204 $pkg = "ext::$pkg";
1205
1206 open my $fh, "<:utf8", $path
1207 or die "$path: $!";
1208
1209 my $source = do { local $/; <$fh> };
1210
1211 my %ext = (
1212 path => $path,
1213 base => $base,
1214 pkg => $pkg,
1215 );
1216
1217 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1218 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1219
1220 $ext{source} =
1221 "package $pkg; use strict; use utf8;\n"
1222 . "#line 1 \"$path\"\n{\n"
1223 . $source
1224 . "\n};\n1";
1225
1226 $todo{$base} = \%ext;
1227 }
1228
1229 my %done;
1230 while (%todo) {
1231 my $progress;
1232
1233 while (my ($k, $v) = each %todo) {
1234 for (split /,\s*/, $v->{meta}{depends}) {
1235 goto skip
1236 unless exists $done{$_};
1237 }
1238
1239 warn "... loading '$k' into '$v->{pkg}'\n";
1240
1241 unless (eval $v->{source}) {
1242 my $msg = $@ ? "$v->{path}: $@\n"
1243 : "$v->{base}: extension inactive.\n";
1244
1245 if (exists $v->{meta}{mandatory}) {
1246 warn $msg;
1247 warn "mandatory extension failed to load, exiting.\n";
1248 exit 1;
1249 }
1250
1251 warn $msg;
1252 }
1253
1254 $done{$k} = delete $todo{$k};
1255 push @EXTS, $v->{pkg};
1256 $progress = 1;
987 1 1257 }
988 } or warn "$ext not loaded: $@"; 1258
1259 skip:
1260 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1261 unless $progress;
1262 }
989 } 1263 };
990} 1264}
991 1265
992############################################################################# 1266#############################################################################
1267
1268=back
993 1269
994=head2 CORE EXTENSIONS 1270=head2 CORE EXTENSIONS
995 1271
996Functions and methods that extend core crossfire objects. 1272Functions and methods that extend core crossfire objects.
997 1273
1185 } 1461 }
1186 1462
1187 \@paths 1463 \@paths
1188} 1464}
1189 1465
1466=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1467
1468Expand crossfire pod fragments into protocol xml.
1469
1470=cut
1471
1472sub expand_cfpod {
1473 ((my $self), (local $_)) = @_;
1474
1475 # escape & and <
1476 s/&/&amp;/g;
1477 s/(?<![BIUGH])</&lt;/g;
1478
1479 # this is buggy, it needs to properly take care of nested <'s
1480
1481 1 while
1482 # replace B<>, I<>, U<> etc.
1483 s/B<([^\>]*)>/<b>$1<\/b>/
1484 || s/I<([^\>]*)>/<i>$1<\/i>/
1485 || s/U<([^\>]*)>/<u>$1<\/u>/
1486 # replace G<male|female> tags
1487 || s{G<([^>|]*)\|([^>]*)>}{
1488 $self->gender ? $2 : $1
1489 }ge
1490 # replace H<hint text>
1491 || s{H<([^\>]*)>}
1492 {
1493 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1494 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1495 "")
1496 [$self->{hintmode}]
1497 }ge;
1498
1499 # create single paragraphs (very hackish)
1500 s/(?<=\S)\n(?=\w)/ /g;
1501
1502 # compress some whitespace
1503 s/\s+\n/\n/g; # ws line-ends
1504 s/\n\n+/\n/g; # double lines
1505 s/^\n+//; # beginning lines
1506 s/\n+$//; # ending lines
1507
1508 $_
1509}
1510
1511sub hintmode {
1512 $_[0]{hintmode} = $_[1] if @_ > 1;
1513 $_[0]{hintmode}
1514}
1515
1190=item $player->ext_reply ($msgid, %msg) 1516=item $player->ext_reply ($msgid, %msg)
1191 1517
1192Sends an ext reply to the player. 1518Sends an ext reply to the player.
1193 1519
1194=cut 1520=cut
1195 1521
1196sub ext_reply($$%) { 1522sub ext_reply($$%) {
1197 my ($self, $id, %msg) = @_; 1523 my ($self, $id, %msg) = @_;
1198 1524
1199 $msg{msgid} = $id; 1525 $msg{msgid} = $id;
1200 1526 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1527}
1203 1528
1204=item $player->ext_event ($type, %msg) 1529=item $player->ext_event ($type, %msg)
1205 1530
1206Sends an ext event to the client. 1531Sends an ext event to the client.
1221 1546
1222package cf::region; 1547package cf::region;
1223 1548
1224=item cf::region::find_by_path $path 1549=item cf::region::find_by_path $path
1225 1550
1226Tries to decuce the probable region for a map knowing only its path. 1551Tries to decuce the likely region for a map knowing only its path.
1227 1552
1228=cut 1553=cut
1229 1554
1230sub find_by_path($) { 1555sub find_by_path($) {
1231 my ($path) = @_; 1556 my ($path) = @_;
1232 1557
1233 my ($match, $specificity); 1558 my ($match, $specificity);
1234 1559
1235 for my $region (list) { 1560 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1561 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1562 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1563 if $region->specificity > $specificity;
1239 } 1564 }
1240 } 1565 }
1241 1566
1305 my ($self, $merge) = @_; 1630 my ($self, $merge) = @_;
1306 1631
1307 # we have to keep some variables in memory intact 1632 # we have to keep some variables in memory intact
1308 local $self->{path}; 1633 local $self->{path};
1309 local $self->{load_path}; 1634 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1635
1313 $self->SUPER::thawer_merge ($merge); 1636 $self->SUPER::thawer_merge ($merge);
1314} 1637}
1315 1638
1316sub normalise { 1639sub normalise {
1363 $self->init; # pass $1 etc. 1686 $self->init; # pass $1 etc.
1364 return $self; 1687 return $self;
1365 } 1688 }
1366 } 1689 }
1367 1690
1368 Carp::carp "unable to resolve path '$path' (base '$base')."; 1691 Carp::cluck "unable to resolve path '$path' (base '$base').";
1369 () 1692 ()
1370} 1693}
1371 1694
1372sub init { 1695sub init {
1373 my ($self) = @_; 1696 my ($self) = @_;
1414sub change_all_map_light { 1737sub change_all_map_light {
1415 my ($change) = @_; 1738 my ($change) = @_;
1416 1739
1417 $_->change_map_light ($change) 1740 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1741 for grep $_->outdoor, values %cf::MAP;
1742}
1743
1744sub decay_objects {
1745 my ($self) = @_;
1746
1747 return if $self->{deny_reset};
1748
1749 $self->do_decay_objects;
1419} 1750}
1420 1751
1421sub unlink_save { 1752sub unlink_save {
1422 my ($self) = @_; 1753 my ($self) = @_;
1423 1754
1481 $self->load_header_orig 1812 $self->load_header_orig
1482 or return; 1813 or return;
1483 $self->prepare_orig; 1814 $self->prepare_orig;
1484 } 1815 }
1485 1816
1817 $self->{deny_reset} = 1
1818 if $self->no_reset;
1819
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1820 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1821 unless $self->default_region;
1488 1822
1489 1 1823 1
1490} 1824}
1505 $map->{last_save} = $cf::RUNTIME; 1839 $map->{last_save} = $cf::RUNTIME;
1506 1840
1507 $map->load_header 1841 $map->load_header
1508 or return; 1842 or return;
1509 1843
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1844 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1845 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1846 #$cf::WAIT_FOR_TICK->wait;
1513 $map->reset; 1847 $map->reset;
1514 undef $guard; 1848 undef $guard;
1515 return find $path; 1849 return find $path;
1582 my ($self, $ob) = @_; 1916 my ($self, $ob) = @_;
1583 1917
1584 return find "~" . $ob->name . "/" . $self->{path} 1918 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1919 if $self->per_player;
1586 1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1923
1587 $self 1924 $self
1588} 1925}
1589 1926
1590# find and load all maps in the 3x3 area around a map 1927# find and load all maps in the 3x3 area around a map
1591sub load_diag { 1928sub load_diag {
1637 1974
1638 undef $MAP_PREFETCH{$path}; 1975 undef $MAP_PREFETCH{$path};
1639 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1640 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1641 for my $path (keys %MAP_PREFETCH) { 1978 for my $path (keys %MAP_PREFETCH) {
1642 my $map = find $path 1979 if (my $map = find $path) {
1643 or next;
1644 $map->load; 1980 $map->load;
1981 }
1645 1982
1646 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$path};
1647 } 1984 }
1648 } 1985 }
1649 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1701 2038
1702sub reset_at { 2039sub reset_at {
1703 my ($self) = @_; 2040 my ($self) = @_;
1704 2041
1705 # TODO: safety, remove and allow resettable per-player maps 2042 # 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}; 2043 return 1e99 if $self->{deny_reset};
1708 2044
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 2047
1722 my ($self) = @_; 2058 my ($self) = @_;
1723 2059
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 2061
1726 return if $self->players; 2062 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 2063
1729 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
1730 2065
1731 $self->in_memory (cf::MAP_SWAPPED); 2066 $self->in_memory (cf::MAP_SWAPPED);
1732 2067
1733 # need to save uniques path 2068 # need to save uniques path
1734 unless ($self->{deny_save}) { 2069 unless ($self->{deny_save}) {
1766 $cf::MAP{$self->path} = $self; 2101 $cf::MAP{$self->path} = $self;
1767 2102
1768 $self->reset; # polite request, might not happen 2103 $self->reset; # polite request, might not happen
1769} 2104}
1770 2105
2106=item $maps = cf::map::tmp_maps
2107
2108Returns an arrayref with all map paths of currently instantiated and saved
2109maps. May block.
2110
2111=cut
2112
2113sub tmp_maps() {
2114 [
2115 map {
2116 utf8::decode $_;
2117 /\.map$/
2118 ? normalise $_
2119 : ()
2120 } @{ aio_readdir $TMPDIR or [] }
2121 ]
2122}
2123
2124=item $maps = cf::map::random_maps
2125
2126Returns an arrayref with all map paths of currently instantiated and saved
2127random maps. May block.
2128
2129=cut
2130
2131sub random_maps() {
2132 [
2133 map {
2134 utf8::decode $_;
2135 /\.map$/
2136 ? normalise "?random/$_"
2137 : ()
2138 } @{ aio_readdir $RANDOMDIR or [] }
2139 ]
2140}
2141
1771=item cf::map::unique_maps 2142=item cf::map::unique_maps
1772 2143
1773Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2145instantiated unique items. May block.
1775 2146
1776=cut 2147=cut
1777 2148
1778sub unique_maps() { 2149sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2150 [
1780 or return; 2151 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2152 utf8::decode $_;
1786 next if /\.pst$/; 2153 /\.map$/
1787 next unless /^$PATH_SEP/o; 2154 ? normalise $_
1788 2155 : ()
1789 push @paths, cf::map::normalise $_; 2156 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2157 ]
1791
1792 \@paths
1793} 2158}
1794 2159
1795package cf; 2160package cf;
1796 2161
1797=back 2162=back
1843 2208
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2210
1846 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1848 } else { 2214 } else {
2215 my $pl = $self->contr;
2216
2217 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2218 my $diag = $pl->{npc_dialog};
2219 $diag->{pl}->ext_reply (
2220 $diag->{id},
2221 msgtype => "reply",
2222 msg => $diag->{pl}->expand_cfpod ($msg),
2223 add_topics => []
2224 );
2225
2226 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1851 } 2230 }
1852} 2231}
1853 2232
1854=item $player_object->may ("access") 2233=item $player_object->may ("access")
1855 2234
1944 2323
1945 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1946 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1947} 2326}
1948 2327
1949=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1950 2329
1951Moves the player to the given map-path and coordinates by first freezing 2330Moves the player to the given map-path and coordinates by first freezing
1952her, loading and preparing them map, calling the provided $check callback 2331her, loading and preparing them map, calling the provided $check callback
1953that has to return the map if sucecssful, and then unfreezes the player on 2332that has to return the map if sucecssful, and then unfreezes the player on
1954the new (success) or old (failed) map position. 2333the new (success) or old (failed) map position. In either case, $done will
2334be called at the end of this process.
1955 2335
1956=cut 2336=cut
1957 2337
1958our $GOTOGEN; 2338our $GOTOGEN;
1959 2339
1960sub cf::object::player::goto { 2340sub cf::object::player::goto {
1961 my ($self, $path, $x, $y, $check) = @_; 2341 my ($self, $path, $x, $y, $check, $done) = @_;
1962 2342
1963 # do generation counting so two concurrent goto's will be executed in-order 2343 # do generation counting so two concurrent goto's will be executed in-order
1964 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2344 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1965 2345
1966 $self->enter_link; 2346 $self->enter_link;
1986 2366
1987 if ($gen == $self->{_goto_generation}) { 2367 if ($gen == $self->{_goto_generation}) {
1988 delete $self->{_goto_generation}; 2368 delete $self->{_goto_generation};
1989 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
1990 } 2370 }
2371
2372 $done->() if $done;
1991 })->prio (1); 2373 })->prio (1);
1992} 2374}
1993 2375
1994=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1995 2377
2064 my $hp = $exit->stats->hp; 2446 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp; 2447 my $sp = $exit->stats->sp;
2066 2448
2067 $self->enter_link; 2449 $self->enter_link;
2068 2450
2451 # if exit is damned, update players death & WoR home-position
2452 $self->contr->savebed ($slaying, $hp, $sp)
2453 if $exit->flag (FLAG_DAMNED);
2454
2069 (async { 2455 (async {
2070 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
2071 unless (eval { 2457 unless (eval {
2072 $self->goto ($slaying, $hp, $sp); 2458 $self->goto ($slaying, $hp, $sp);
2073 2459
2100 2486
2101 utf8::encode $text; 2487 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2489}
2104 2490
2491=item $client->send_msg ($channel, $msg, $color, [extra...])
2492
2493Send a drawinfo or msg packet to the client, formatting the msg for the
2494client if neccessary. C<$type> should be a string identifying the type of
2495the message, with C<log> being the default. If C<$color> is negative, suppress
2496the message unless the client supports the msg packet.
2497
2498=cut
2499
2500sub cf::client::send_msg {
2501 my ($self, $channel, $msg, $color, @extra) = @_;
2502
2503 $msg = $self->pl->expand_cfpod ($msg);
2504
2505 $color &= ~cf::NDI_UNIQUE; # just in case...
2506
2507 if (ref $channel) {
2508 # send meta info to client, if not yet sent
2509 unless (exists $self->{channel}{$channel->{id}}) {
2510 $self->{channel}{$channel->{id}} = $channel;
2511 $self->ext_event (channel_info => %$channel);
2512 }
2513
2514 $channel = $channel->{id};
2515 }
2516
2517 return unless @extra || length $msg;
2518
2519 if ($self->can_msg) {
2520 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2521 } else {
2522 # replace some tags by gcfclient-compatible ones
2523 for ($msg) {
2524 1 while
2525 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2526 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2527 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2528 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2529 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2530 }
2531
2532 if ($color >= 0) {
2533 if (0 && $msg =~ /\[/) {
2534 $self->send_packet ("drawextinfo $color 4 0 $msg")
2535 } else {
2536 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2537 $self->send_packet ("drawinfo $color $msg")
2538 }
2539 }
2540 }
2541}
2542
2105=item $client->ext_event ($type, %msg) 2543=item $client->ext_event ($type, %msg)
2106 2544
2107Sends an exti event to the client. 2545Sends an ext event to the client.
2108 2546
2109=cut 2547=cut
2110 2548
2111sub cf::client::ext_event($$%) { 2549sub cf::client::ext_event($$%) {
2112 my ($self, $type, %msg) = @_; 2550 my ($self, $type, %msg) = @_;
2113 2551
2552 return unless $self->extcmd;
2553
2114 $msg{msgtype} = "event_$type"; 2554 $msg{msgtype} = "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2555 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2116} 2556}
2117 2557
2118=item $success = $client->query ($flags, "text", \&cb) 2558=item $success = $client->query ($flags, "text", \&cb)
2119 2559
2120Queues a query to the client, calling the given callback with 2560Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2561the 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>. 2562C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2563
2124Queries can fail, so check the return code. Or don't, as queries will become 2564Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2565become reliable at some point in the future.
2126 2566
2127=cut 2567=cut
2128 2568
2129sub cf::client::query { 2569sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2570 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2578 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2579 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2580
2141 $self->send_packet ($self->{query_queue}[0][0]) 2581 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2582 if @{ $self->{query_queue} } == 1;
2583
2584 1
2143} 2585}
2144 2586
2145cf::client->attach ( 2587cf::client->attach (
2588 on_connect => sub {
2589 my ($ns) = @_;
2590
2591 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2592 },
2146 on_reply => sub { 2593 on_reply => sub {
2147 my ($ns, $msg) = @_; 2594 my ($ns, $msg) = @_;
2148 2595
2149 # this weird shuffling is so that direct followup queries 2596 # this weird shuffling is so that direct followup queries
2150 # get handled first 2597 # get handled first
2162 } else { 2609 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2610 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2611 }
2165 } 2612 }
2166 }, 2613 },
2614 on_exticmd => sub {
2615 my ($ns, $buf) = @_;
2616
2617 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2618
2619 if (ref $msg) {
2620 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2621 if (my %reply = $cb->($ns, $msg)) {
2622 $reply{msgid} = $msg->{msgid};
2623 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2624 }
2625 }
2626 } else {
2627 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2628 }
2629
2630 cf::override;
2631 },
2167); 2632);
2168 2633
2169=item $client->async (\&cb) 2634=item $client->async (\&cb)
2170 2635
2171Create a new coroutine, running the specified callback. The coroutine will 2636Create a new coroutine, running the specified callback. The coroutine will
2220 2685
2221=pod 2686=pod
2222 2687
2223The following functions and methods are available within a safe environment: 2688The following functions and methods are available within a safe environment:
2224 2689
2225 cf::object contr pay_amount pay_player map 2690 cf::object
2691 contr pay_amount pay_player map x y force_find force_add
2692 insert remove
2693
2226 cf::object::player player 2694 cf::object::player
2227 cf::player peaceful 2695 player
2228 cf::map trigger 2696
2697 cf::player
2698 peaceful
2699
2700 cf::map
2701 trigger
2229 2702
2230=cut 2703=cut
2231 2704
2232for ( 2705for (
2233 ["cf::object" => qw(contr pay_amount pay_player map)], 2706 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2707 insert remove)],
2234 ["cf::object::player" => qw(player)], 2708 ["cf::object::player" => qw(player)],
2235 ["cf::player" => qw(peaceful)], 2709 ["cf::player" => qw(peaceful)],
2236 ["cf::map" => qw(trigger)], 2710 ["cf::map" => qw(trigger)],
2237) { 2711) {
2238 no strict 'refs'; 2712 no strict 'refs';
2309=back 2783=back
2310 2784
2311=cut 2785=cut
2312 2786
2313############################################################################# 2787#############################################################################
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 2788# the server's init and main functions
2487 2789
2488sub load_facedata($) { 2790sub load_facedata($) {
2489 my ($path) = @_; 2791 my ($path) = @_;
2490 2792
2502 { 2804 {
2503 my $faces = $facedata->{faceinfo}; 2805 my $faces = $facedata->{faceinfo};
2504 2806
2505 while (my ($face, $info) = each %$faces) { 2807 while (my ($face, $info) = each %$faces) {
2506 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2808 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2809 cf::face::set_visibility $idx, $info->{visibility};
2810 cf::face::set_magicmap $idx, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2811 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2812 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510 Coro::cede; 2813
2814 cf::cede_to_tick;
2511 } 2815 }
2512 2816
2513 while (my ($face, $info) = each %$faces) { 2817 while (my ($face, $info) = each %$faces) {
2514 next unless $info->{smooth}; 2818 next unless $info->{smooth};
2515 my $idx = cf::face::find $face 2819 my $idx = cf::face::find $face
2516 or next; 2820 or next;
2517 if (my $smooth = cf::face::find $info->{smooth}) { 2821 if (my $smooth = cf::face::find $info->{smooth}) {
2822 cf::face::set_smooth $idx, $smooth;
2518 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2823 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519 } else { 2824 } else {
2520 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2825 warn "smooth face '$info->{smooth}' not found for face '$face'";
2521 } 2826 }
2522 Coro::cede; 2827
2828 cf::cede_to_tick;
2523 } 2829 }
2524 } 2830 }
2525 2831
2526 { 2832 {
2527 my $anims = $facedata->{animinfo}; 2833 my $anims = $facedata->{animinfo};
2528 2834
2529 while (my ($anim, $info) = each %$anims) { 2835 while (my ($anim, $info) = each %$anims) {
2530 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2836 cf::anim::set $anim, $info->{frames}, $info->{facings};
2531 Coro::cede; 2837 cf::cede_to_tick;
2532 } 2838 }
2533 2839
2534 cf::anim::invalidate_all; # d'oh 2840 cf::anim::invalidate_all; # d'oh
2841 }
2842
2843 {
2844 # TODO: for gcfclient pleasure, we should give resources
2845 # that gcfclient doesn't grok a >10000 face index.
2846 my $res = $facedata->{resource};
2847 my $enc = JSON::XS->new->utf8->canonical;
2848
2849 while (my ($name, $info) = each %$res) {
2850 my $meta = $enc->encode ({
2851 name => $name,
2852 type => $info->{type},
2853 copyright => $info->{copyright}, #TODO#
2854 });
2855
2856 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2857
2858 if ($name =~ /\.jpg$/) {
2859 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2860 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2861 } else {
2862 my $data = pack "(w/a*)*", $meta, $info->{data};
2863 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2864
2865 cf::face::set_type $idx, 1;
2866 cf::face::set_data $idx, 0, $data, $chk;
2867 }
2868
2869 cf::cede_to_tick;
2870 }
2535 } 2871 }
2536 2872
2537 1 2873 1
2538} 2874}
2539 2875
2540sub reload_regions { 2876sub reload_regions {
2541 load_resource_file "$MAPDIR/regions" 2877 load_resource_file "$MAPDIR/regions"
2542 or die "unable to load regions file\n"; 2878 or die "unable to load regions file\n";
2879
2880 for (cf::region::list) {
2881 $_->{match} = qr/$_->{match}/
2882 if exists $_->{match};
2883 }
2543} 2884}
2544 2885
2545sub reload_facedata { 2886sub reload_facedata {
2546 load_facedata "$DATADIR/facedata" 2887 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 2888 or die "unable to load facedata\n";
2548} 2889}
2549 2890
2550sub reload_archetypes { 2891sub reload_archetypes {
2551 load_resource_file "$DATADIR/archetypes" 2892 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2893 or die "unable to load archetypes\n";
2894 #d# NEED to laod twice to resolve forward references
2895 # this really needs to be done in an extra post-pass
2896 # (which needs to be synchronous, so solve it differently)
2897 load_resource_file "$DATADIR/archetypes"
2898 or die "unable to load archetypes\n";
2553} 2899}
2554 2900
2555sub reload_treasures { 2901sub reload_treasures {
2556 load_resource_file "$DATADIR/treasures" 2902 load_resource_file "$DATADIR/treasures"
2557 or die "unable to load treasurelists\n"; 2903 or die "unable to load treasurelists\n";
2560sub reload_resources { 2906sub reload_resources {
2561 warn "reloading resource files...\n"; 2907 warn "reloading resource files...\n";
2562 2908
2563 reload_regions; 2909 reload_regions;
2564 reload_facedata; 2910 reload_facedata;
2911 #reload_archetypes;#d#
2565 reload_archetypes; 2912 reload_archetypes;
2566 reload_treasures; 2913 reload_treasures;
2567 2914
2568 warn "finished reloading resource files\n"; 2915 warn "finished reloading resource files\n";
2569} 2916}
2626 }, 2973 },
2627 ); 2974 );
2628 } 2975 }
2629} 2976}
2630 2977
2978sub write_runtime {
2979 my $runtime = "$LOCALDIR/runtime";
2980
2981 # first touch the runtime file to show we are still running:
2982 # the fsync below can take a very very long time.
2983
2984 IO::AIO::aio_utime $runtime, undef, undef;
2985
2986 my $guard = cf::lock_acquire "write_runtime";
2987
2988 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2989 or return;
2990
2991 my $value = $cf::RUNTIME + 90 + 10;
2992 # 10 is the runtime save interval, for a monotonic clock
2993 # 60 allows for the watchdog to kill the server.
2994
2995 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2996 and return;
2997
2998 # always fsync - this file is important
2999 aio_fsync $fh
3000 and return;
3001
3002 # touch it again to show we are up-to-date
3003 aio_utime $fh, undef, undef;
3004
3005 close $fh
3006 or return;
3007
3008 aio_rename "$runtime~", $runtime
3009 and return;
3010
3011 warn "runtime file written.\n";
3012
3013 1
3014}
3015
2631sub emergency_save() { 3016sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop; 3017 my $freeze_guard = cf::freeze_mainloop;
2633 3018
2634 warn "enter emergency perl save\n"; 3019 warn "enter emergency perl save\n";
2635 3020
2710 %EXT_CORO = (); 3095 %EXT_CORO = ();
2711 3096
2712 warn "removing commands"; 3097 warn "removing commands";
2713 %COMMAND = (); 3098 %COMMAND = ();
2714 3099
2715 warn "removing ext commands"; 3100 warn "removing ext/exti commands";
2716 %EXTCMD = (); 3101 %EXTCMD = ();
3102 %EXTICMD = ();
2717 3103
2718 warn "unloading/nuking all extensions"; 3104 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) { 3105 for my $pkg (@EXTS) {
2720 warn "... unloading $pkg"; 3106 warn "... unloading $pkg";
2721 3107

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines