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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.343 by root, Mon Aug 27 01:13:48 2007 UTC

… …
10use Event; 10use Event;
11use Opcode; 11use Opcode;
12use Safe; 12use Safe;
13use Safe::Hole; 13use Safe::Hole;
14 14
15use Coro 3.61 (); 15use Coro 3.64 ();
16use Coro::State; 16use Coro::State;
17use Coro::Handle; 17use Coro::Handle;
18use Coro::Event; 18use Coro::Event;
19use Coro::Timer; 19use Coro::Timer;
20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
24 25
26use JSON::XS 1.4 ();
25use BDB (); 27use BDB ();
26use Data::Dumper; 28use Data::Dumper;
27use Digest::MD5; 29use Digest::MD5;
28use Fcntl; 30use Fcntl;
29use YAML::Syck (); 31use YAML::Syck ();
30use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
31use Time::HiRes; 33use Time::HiRes;
32use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
33 36
34# configure various modules to our taste 37# configure various modules to our taste
35# 38#
36$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
… …
49our %COMMAND = (); 52our %COMMAND = ();
50our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
51 54
52our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
56 60
57our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
58our @EVENT; 62our @EVENT;
… …
164 168
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 169These 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 170returns 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. 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
178
169=back 179=back
170 180
171=cut 181=cut
172 182
173BEGIN { 183BEGIN {
… …
206} 216}
207 217
208$Event::DIED = sub { 218$Event::DIED = sub {
209 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
210}; 220};
221
222#############################################################################
211 223
212=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
213 225
214=over 4 226=over 4
215 227
… …
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 247 $d
236 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
237} 249}
238 250
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
242 252
243Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
244 254
245=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
246 256
247Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
258
259=cut
260
261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
262
263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
248 265
249=item cf::lock_wait $string 266=item cf::lock_wait $string
250 267
251Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
252 269
… …
306 }; 323 };
307 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
308 $guard 325 $guard
309} 326}
310 327
328=item cf::get_slot $time[, $priority[, $name]]
329
330Allocate $time seconds of blocking CPU time at priority C<$priority>:
331This call blocks and returns only when you have at least C<$time> seconds
332of cpu time till the next tick. The slot is only valid till the next cede.
333
334The optional C<$name> can be used to identify the job to run. It might be
335used for statistical purposes and should identify the same time-class.
336
337Useful for short background jobs.
338
339=cut
340
341our @SLOT_QUEUE;
342our $SLOT_QUEUE;
343
344$SLOT_QUEUE->cancel if $SLOT_QUEUE;
345$SLOT_QUEUE = Coro::async {
346 my $signal = new Coro::Signal;
347
348 while () {
349 next_job:
350 my $avail = cf::till_tick;
351 if ($avail > 0.01) {
352 for (0 .. $#SLOT_QUEUE) {
353 if ($SLOT_QUEUE[$_][0] < $avail) {
354 my $job = splice @SLOT_QUEUE, $_, 1, ();
355 $job->[2]->send;
356 Coro::cede;
357 goto next_job;
358 }
359 }
360 }
361
362 if (@SLOT_QUEUE) {
363 # we do not use wait_For_tick() as it returns immediately when tick is inactive
364 push @cf::WAIT_FOR_TICK, $signal;
365 $signal->wait;
366 } else {
367 Coro::schedule;
368 }
369 }
370};
371
372sub get_slot($;$$) {
373 my ($time, $pri, $name) = @_;
374
375 $time = $TICK * .6 if $time > $TICK * .6;
376 my $sig = new Coro::Signal;
377
378 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
379 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
380 $SLOT_QUEUE->ready;
381 $sig->wait;
382}
383
311=item cf::async { BLOCK } 384=item cf::async { BLOCK }
312 385
313Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 387C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
… …
318 391
319BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
320 393
321=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
322 395
323The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 397is 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. 398partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
399acceptable.
326 400
327If it must be done, put the blocking parts into C<sync_job>. This will run 401If 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 402the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 403server will be frozen during this time, so the block should either finish
330fast or be very important. 404fast or be very important.
… …
390 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
391 465
392 $coro 466 $coro
393} 467}
394 468
395sub write_runtime { 469=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 470
398 # first touch the runtime file to show we are still running: 471Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 472process, returning the results. Everything must be serialisable with
473Coro::Storable. May, of course, block. Note that the executed sub may
474never block itself or use any form of Event handling.
400 475
401 IO::AIO::aio_utime $runtime, undef, undef; 476=cut
402 477
403 my $guard = cf::lock_acquire "write_runtime"; 478sub fork_call(&@) {
479 my ($cb, @args) = @_;
404 480
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 481 # we seemingly have to make a local copy of the whole thing,
406 or return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
407 484
408 my $value = $cf::RUNTIME + 90 + 10; 485 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 486 reset_signals;
410 # 60 allows for the watchdog to kill the server. 487 &$cb
488 }, @args;
411 489
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 490 wantarray ? @res : $res[-1]
413 and return; 491}
414 492
415 # always fsync - this file is important 493=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 494
419 # touch it again to show we are up-to-date 495Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 496
422 close $fh 497=item cf::db_put $family => $key => $value
423 or return;
424 498
425 aio_rename "$runtime~", $runtime 499Stores the given C<$value> in the family. It can currently store binary
426 and return; 500data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 501
428 warn "runtime file written.\n"; 502=cut
429 503
504our $DB;
505
506sub db_init {
507 unless ($DB) {
508 $DB = BDB::db_create $DB_ENV;
509
510 cf::sync_job {
511 eval {
512 $DB->set_flags (BDB::CHKSUM);
513
514 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
515 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
516 cf::cleanup "db_open(db): $!" if $!;
517 };
518 cf::cleanup "db_open(db): $@" if $@;
519 };
430 1 520 }
521}
522
523sub db_get($$) {
524 my $key = "$_[0]/$_[1]";
525
526 cf::sync_job {
527 BDB::db_get $DB, undef, $key, my $data;
528
529 $! ? ()
530 : $data
531 }
532}
533
534sub db_put($$$) {
535 BDB::dbreq_pri 4;
536 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
537}
538
539=item cf::cache $id => [$paths...], $processversion => $process
540
541Generic caching function that returns the value of the resource $id,
542caching and regenerating as required.
543
544This function can block.
545
546=cut
547
548sub cache {
549 my ($id, $src, $processversion, $process) = @_;
550
551 my $meta =
552 join "\x00",
553 $processversion,
554 map {
555 aio_stat $_
556 and Carp::croak "$_: $!";
557
558 ($_, (stat _)[7,9])
559 } @$src;
560
561 my $dbmeta = db_get cache => "$id/meta";
562 if ($dbmeta ne $meta) {
563 # changed, we may need to process
564
565 my @data;
566 my $md5;
567
568 for (0 .. $#$src) {
569 0 <= aio_load $src->[$_], $data[$_]
570 or Carp::croak "$src->[$_]: $!";
571 }
572
573 # if processing is expensive, check
574 # checksum first
575 if (1) {
576 $md5 =
577 join "\x00",
578 $processversion,
579 map {
580 Coro::cede;
581 ($src->[$_], Digest::MD5::md5_hex $data[$_])
582 } 0.. $#$src;
583
584
585 my $dbmd5 = db_get cache => "$id/md5";
586 if ($dbmd5 eq $md5) {
587 db_put cache => "$id/meta", $meta;
588
589 return db_get cache => "$id/data";
590 }
591 }
592
593 my $t1 = Time::HiRes::time;
594 my $data = $process->(\@data);
595 my $t2 = Time::HiRes::time;
596
597 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
598
599 db_put cache => "$id/data", $data;
600 db_put cache => "$id/md5" , $md5;
601 db_put cache => "$id/meta", $meta;
602
603 return $data;
604 }
605
606 db_get cache => "$id/data"
431} 607}
432 608
433=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
434 610
435Log a datalog packet of the given type with the given key-value pairs. 611Log 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") 629attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
455 631
456In the following description, CLASS can be any of C<global>, C<object> 632In 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 633C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 634Crossfire TRT).
459 635
460=over 4 636=over 4
461 637
462=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
463 639
… …
665 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
666 } 842 }
667 843
668 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
669 } else { 845 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 847 }
672 848
673 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
674} 850}
675 851
… …
715 "; 891 ";
716 die if $@; 892 die if $@;
717} 893}
718 894
719our $override; 895our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 896our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 897
722sub override { 898sub override {
723 $override = 1; 899 $override = 1;
724 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
725} 901}
726 902
727sub do_invoke { 903sub do_invoke {
728 my $event = shift; 904 my $event = shift;
729 my $callbacks = shift; 905 my $callbacks = shift;
730 906
731 @invoke_results = (); 907 @INVOKE_RESULTS = ();
732 908
733 local $override; 909 local $override;
734 910
735 for (@$callbacks) { 911 for (@$callbacks) {
736 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
… …
753 929
754Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
755 931
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 932This 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 933removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 935
760=back 936=back
761 937
762=cut 938=cut
763 939
764############################################################################# 940#############################################################################
765# object support 941# object support
942#
943
944sub _can_merge {
945 my ($ob1, $ob2) = @_;
946
947 local $Storable::canonical = 1;
948 my $fob1 = Storable::freeze $ob1;
949 my $fob2 = Storable::freeze $ob2;
950
951 $fob1 eq $fob2
952}
766 953
767sub reattach { 954sub reattach {
768 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 956 my ($obj) = @_;
770 957
… …
877 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1065 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1066 return ($data, $av);
880} 1067}
881 1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
1074
882############################################################################# 1075#############################################################################
883# command handling &c 1076# command handling &c
884 1077
885=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
886 1079
… …
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1092}
900 1093
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1095
903Register a callbackf ro execution when the client sends an extcmd packet. 1096Register a callback for execution when the client sends an (synchronous)
1097extcmd packet. Ext commands will be processed in the order they are
1098received by the server, like other user commands. The first argument is
1099the logged-in player. Ext commands can only be processed after a player
1100has logged in successfully.
904 1101
905If the callback returns something, it is sent back as if reply was being 1102If the callback returns something, it is sent back as if reply was being
906called. 1103called.
907 1104
1105=item cf::register_exticmd $name => \&callback($ns,$packet);
1106
1107Register a callback for execution when the client sends an (asynchronous)
1108exticmd packet. Exti commands are processed by the server as soon as they
1109are received, i.e. out of order w.r.t. other commands. The first argument
1110is a client socket. Exti commands can be received anytime, even before
1111log-in.
1112
1113If the callback returns something, it is sent back as if reply was being
1114called.
1115
908=cut 1116=cut
909 1117
910sub register_extcmd { 1118sub register_extcmd {
911 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
912 1120
913 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
914} 1128}
915 1129
916cf::player->attach ( 1130cf::player->attach (
917 on_command => sub { 1131 on_command => sub {
918 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
… …
927 cf::override; 1141 cf::override;
928 }, 1142 },
929 on_extcmd => sub { 1143 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
931 1145
932 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1147
934 if (ref $msg) { 1148 if (ref $msg) {
1149 my ($type, $reply, @payload) =
1150 "ARRAY" eq ref $msg
1151 ? @$msg
1152 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1153
1154 my @reply;
1155
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1156 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1157 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1158 }
1159
1160 $pl->ext_reply ($reply, @reply)
1161 if $reply;
1162
940 } else { 1163 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1164 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1165 }
943 1166
944 cf::override; 1167 cf::override;
… …
967 path => $path, 1190 path => $path,
968 base => $base, 1191 base => $base,
969 pkg => $pkg, 1192 pkg => $pkg,
970 ); 1193 );
971 1194
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 } 1195 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/; 1196 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974 1197
975 $ext{source} = 1198 $ext{source} =
976 "package $pkg; use strict; use utf8;\n" 1199 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n" 1200 . "#line 1 \"$path\"\n{\n"
978 . $source 1201 . $source
… …
984 my %done; 1207 my %done;
985 while (%todo) { 1208 while (%todo) {
986 my $progress; 1209 my $progress;
987 1210
988 while (my ($k, $v) = each %todo) { 1211 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) { 1212 for (split /,\s*/, $v->{meta}{depends}) {
990 goto skip 1213 goto skip
991 unless exists $done{$_}; 1214 unless exists $done{$_};
992 } 1215 }
993 1216
994 warn "... loading '$k' into '$v->{pkg}'\n"; 1217 warn "... loading '$k' into '$v->{pkg}'\n";
995 1218
996 unless (eval $v->{source}) { 1219 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n" 1220 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n"; 1221 : "$v->{base}: extension inactive.\n";
999 1222
1000 if (exists $v->{meta}{mandatory}) { 1223 if (exists $v->{meta}{mandatory}) {
1001 warn $msg; 1224 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n"; 1225 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1; 1226 exit 1;
1004 } 1227 }
1005 1228
1006 die $msg; 1229 warn $msg;
1007 } 1230 }
1008 1231
1009 $done{$k} = delete $todo{$k}; 1232 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg}; 1233 push @EXTS, $v->{pkg};
1234 $progress = 1;
1011 } 1235 }
1012 1236
1013 skip: 1237 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n" 1238 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress; 1239 unless $progress;
1016 } 1240 }
1017 }; 1241 };
1018} 1242}
1019 1243
1020############################################################################# 1244#############################################################################
1245
1246=back
1021 1247
1022=head2 CORE EXTENSIONS 1248=head2 CORE EXTENSIONS
1023 1249
1024Functions and methods that extend core crossfire objects. 1250Functions and methods that extend core crossfire objects.
1025 1251
… …
1112 $cf::PLAYER{$login} = $self; 1338 $cf::PLAYER{$login} = $self;
1113 1339
1114 $self 1340 $self
1115} 1341}
1116 1342
1343=item $player->send_msg ($channel, $msg, $color, [extra...])
1344
1345=cut
1346
1347sub send_msg {
1348 my $ns = shift->ns
1349 or return;
1350 $ns->send_msg (@_);
1351}
1352
1117=item $pl->quit_character 1353=item $pl->quit_character
1118 1354
1119Nukes the player without looking back. If logged in, the connection will 1355Nukes the player without looking back. If logged in, the connection will
1120be destroyed. May block for a long time. 1356be destroyed. May block for a long time.
1121 1357
… …
1213 } 1449 }
1214 1450
1215 \@paths 1451 \@paths
1216} 1452}
1217 1453
1454=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1455
1456Expand crossfire pod fragments into protocol xml.
1457
1458=cut
1459
1460sub expand_cfpod {
1461 ((my $self), (local $_)) = @_;
1462
1463 # escape & and <
1464 s/&/&amp;/g;
1465 s/(?<![BIUGH])</&lt;/g;
1466
1467 # this is buggy, it needs to properly take care of nested <'s
1468
1469 1 while
1470 # replace B<>, I<>, U<> etc.
1471 s/B<([^\>]*)>/<b>$1<\/b>/
1472 || s/I<([^\>]*)>/<i>$1<\/i>/
1473 || s/U<([^\>]*)>/<u>$1<\/u>/
1474 # replace G<male|female> tags
1475 || s{G<([^>|]*)\|([^>]*)>}{
1476 $self->gender ? $2 : $1
1477 }ge
1478 # replace H<hint text>
1479 || s{H<([^\>]*)>}
1480 {
1481 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1482 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1483 "")
1484 [$self->{hintmode}]
1485 }ge;
1486
1487 # create single paragraphs (very hackish)
1488 s/(?<=\S)\n(?=\w)/ /g;
1489
1490 # compress some whitespace
1491 s/\s+\n/\n/g; # ws line-ends
1492 s/\n\n+/\n/g; # double lines
1493 s/^\n+//; # beginning lines
1494 s/\n+$//; # ending lines
1495
1496 $_
1497}
1498
1499sub hintmode {
1500 $_[0]{hintmode} = $_[1] if @_ > 1;
1501 $_[0]{hintmode}
1502}
1503
1218=item $player->ext_reply ($msgid, %msg) 1504=item $player->ext_reply ($msgid, @msg)
1219 1505
1220Sends an ext reply to the player. 1506Sends an ext reply to the player.
1221 1507
1222=cut 1508=cut
1223 1509
1224sub ext_reply($$%) { 1510sub ext_reply($$@) {
1225 my ($self, $id, %msg) = @_; 1511 my ($self, $id, @msg) = @_;
1226 1512
1227 $msg{msgid} = $id; 1513 $self->ns->ext_reply ($id, @msg)
1228
1229 $self->send ("ext " . cf::to_json \%msg);
1230} 1514}
1231 1515
1232=item $player->ext_event ($type, %msg) 1516=item $player->ext_msg ($type, @msg)
1233 1517
1234Sends an ext event to the client. 1518Sends an ext event to the client.
1235 1519
1236=cut 1520=cut
1237 1521
1238sub ext_event($$%) { 1522sub ext_msg($$@) {
1239 my ($self, $type, %msg) = @_; 1523 my ($self, $type, @msg) = @_;
1240 1524
1241 $self->ns->ext_event ($type, %msg); 1525 $self->ns->ext_msg ($type, @msg);
1242} 1526}
1243 1527
1244=head3 cf::region 1528=head3 cf::region
1245 1529
1246=over 4 1530=over 4
… …
1249 1533
1250package cf::region; 1534package cf::region;
1251 1535
1252=item cf::region::find_by_path $path 1536=item cf::region::find_by_path $path
1253 1537
1254Tries to decuce the probable region for a map knowing only its path. 1538Tries to decuce the likely region for a map knowing only its path.
1255 1539
1256=cut 1540=cut
1257 1541
1258sub find_by_path($) { 1542sub find_by_path($) {
1259 my ($path) = @_; 1543 my ($path) = @_;
1260 1544
1261 my ($match, $specificity); 1545 my ($match, $specificity);
1262 1546
1263 for my $region (list) { 1547 for my $region (list) {
1264 if ($region->match && $path =~ $region->match) { 1548 if ($region->{match} && $path =~ $region->{match}) {
1265 ($match, $specificity) = ($region, $region->specificity) 1549 ($match, $specificity) = ($region, $region->specificity)
1266 if $region->specificity > $specificity; 1550 if $region->specificity > $specificity;
1267 } 1551 }
1268 } 1552 }
1269 1553
… …
1389 $self->init; # pass $1 etc. 1673 $self->init; # pass $1 etc.
1390 return $self; 1674 return $self;
1391 } 1675 }
1392 } 1676 }
1393 1677
1394 Carp::carp "unable to resolve path '$path' (base '$base')."; 1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1395 () 1679 ()
1396} 1680}
1397 1681
1398sub init { 1682sub init {
1399 my ($self) = @_; 1683 my ($self) = @_;
… …
1607 $self->set_darkness_map; 1891 $self->set_darkness_map;
1608 Coro::cede; 1892 Coro::cede;
1609 $self->activate; 1893 $self->activate;
1610 } 1894 }
1611 1895
1896 $self->{last_save} = $cf::RUNTIME;
1897 $self->last_access ($cf::RUNTIME);
1898
1612 $self->in_memory (cf::MAP_IN_MEMORY); 1899 $self->in_memory (cf::MAP_IN_MEMORY);
1613 } 1900 }
1614 1901
1615 $self->post_load; 1902 $self->post_load;
1616} 1903}
… …
1626 1913
1627 $self 1914 $self
1628} 1915}
1629 1916
1630# find and load all maps in the 3x3 area around a map 1917# find and load all maps in the 3x3 area around a map
1631sub load_diag { 1918sub load_neighbours {
1632 my ($map) = @_; 1919 my ($map) = @_;
1633 1920
1634 my @diag; # diagonal neighbours 1921 my @neigh; # diagonal neighbours
1635 1922
1636 for (0 .. 3) { 1923 for (0 .. 3) {
1637 my $neigh = $map->tile_path ($_) 1924 my $neigh = $map->tile_path ($_)
1638 or next; 1925 or next;
1639 $neigh = find $neigh, $map 1926 $neigh = find $neigh, $map
1640 or next; 1927 or next;
1641 $neigh->load; 1928 $neigh->load;
1642 1929
1930 push @neigh,
1643 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1931 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1644 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1932 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1645 } 1933 }
1646 1934
1647 for (@diag) { 1935 for (grep defined $_->[0], @neigh) {
1936 my ($path, $origin) = @$_;
1648 my $neigh = find @$_ 1937 my $neigh = find $path, $origin
1649 or next; 1938 or next;
1650 $neigh->load; 1939 $neigh->load;
1651 } 1940 }
1652} 1941}
1653 1942
… …
1658} 1947}
1659 1948
1660sub do_load_sync { 1949sub do_load_sync {
1661 my ($map) = @_; 1950 my ($map) = @_;
1662 1951
1952 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1953 if $Coro::current == $Coro::main;
1954
1663 cf::sync_job { $map->load }; 1955 cf::sync_job { $map->load };
1664} 1956}
1665 1957
1666our %MAP_PREFETCH; 1958our %MAP_PREFETCH;
1667our $MAP_PREFETCHER = undef; 1959our $MAP_PREFETCHER = undef;
1668 1960
1669sub find_async { 1961sub find_async {
1670 my ($path, $origin) = @_; 1962 my ($path, $origin, $load) = @_;
1671 1963
1672 $path = normalise $path, $origin && $origin->{path}; 1964 $path = normalise $path, $origin && $origin->{path};
1673 1965
1674 if (my $map = $cf::MAP{$path}) { 1966 if (my $map = $cf::MAP{$path}) {
1675 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1967 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676 } 1968 }
1677 1969
1678 undef $MAP_PREFETCH{$path}; 1970 $MAP_PREFETCH{$path} |= $load;
1971
1679 $MAP_PREFETCHER ||= cf::async { 1972 $MAP_PREFETCHER ||= cf::async {
1680 while (%MAP_PREFETCH) { 1973 while (%MAP_PREFETCH) {
1681 for my $path (keys %MAP_PREFETCH) { 1974 while (my ($k, $v) = each %MAP_PREFETCH) {
1682 my $map = find $path 1975 if (my $map = find $k) {
1683 or next;
1684 $map->load; 1976 $map->load if $v;
1977 }
1685 1978
1686 delete $MAP_PREFETCH{$path}; 1979 delete $MAP_PREFETCH{$k};
1687 } 1980 }
1688 } 1981 }
1689 undef $MAP_PREFETCHER; 1982 undef $MAP_PREFETCHER;
1690 }; 1983 };
1691 $MAP_PREFETCHER->prio (6); 1984 $MAP_PREFETCHER->prio (6);
… …
1911 2204
1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2205 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913 2206
1914 if ($self->{record_replies}) { 2207 if ($self->{record_replies}) {
1915 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2208 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2209
1916 } else { 2210 } else {
2211 my $pl = $self->contr;
2212
2213 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2214 my $dialog = $pl->{npc_dialog};
2215 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2216
2217 } else {
1917 $msg = $npc->name . " says: $msg" if $npc; 2218 $msg = $npc->name . " says: $msg" if $npc;
1918 $self->message ($msg, $flags); 2219 $self->message ($msg, $flags);
2220 }
1919 } 2221 }
2222}
2223
2224=item $object->send_msg ($channel, $msg, $color, [extra...])
2225
2226=cut
2227
2228sub cf::object::send_msg {
2229 my $pl = shift->contr
2230 or return;
2231 $pl->send_msg (@_);
1920} 2232}
1921 2233
1922=item $player_object->may ("access") 2234=item $player_object->may ("access")
1923 2235
1924Returns wether the given player is authorized to access resource "access" 2236Returns wether the given player is authorized to access resource "access"
… …
2003 # use -1 or undef as default coordinates, not 0, 0 2315 # use -1 or undef as default coordinates, not 0, 0
2004 ($x, $y) = ($map->enter_x, $map->enter_y) 2316 ($x, $y) = ($map->enter_x, $map->enter_y)
2005 if $x <=0 && $y <= 0; 2317 if $x <=0 && $y <= 0;
2006 2318
2007 $map->load; 2319 $map->load;
2008 $map->load_diag; 2320 $map->load_neighbours;
2009 2321
2010 return unless $self->contr->active; 2322 return unless $self->contr->active;
2011 $self->activate_recursive; 2323 $self->activate_recursive;
2012 2324
2013 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2325 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014 $self->enter_map ($map, $x, $y); 2326 $self->enter_map ($map, $x, $y);
2015} 2327}
2016 2328
2017=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2329=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018 2330
2019Moves the player to the given map-path and coordinates by first freezing 2331Moves the player to the given map-path and coordinates by first freezing
2020her, loading and preparing them map, calling the provided $check callback 2332her, loading and preparing them map, calling the provided $check callback
2021that has to return the map if sucecssful, and then unfreezes the player on 2333that has to return the map if sucecssful, and then unfreezes the player on
2022the new (success) or old (failed) map position. 2334the new (success) or old (failed) map position. In either case, $done will
2335be called at the end of this process.
2023 2336
2024=cut 2337=cut
2025 2338
2026our $GOTOGEN; 2339our $GOTOGEN;
2027 2340
2028sub cf::object::player::goto { 2341sub cf::object::player::goto {
2029 my ($self, $path, $x, $y, $check) = @_; 2342 my ($self, $path, $x, $y, $check, $done) = @_;
2030 2343
2031 # do generation counting so two concurrent goto's will be executed in-order 2344 # do generation counting so two concurrent goto's will be executed in-order
2032 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2345 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033 2346
2034 $self->enter_link; 2347 $self->enter_link;
… …
2054 2367
2055 if ($gen == $self->{_goto_generation}) { 2368 if ($gen == $self->{_goto_generation}) {
2056 delete $self->{_goto_generation}; 2369 delete $self->{_goto_generation};
2057 $self->leave_link ($map, $x, $y); 2370 $self->leave_link ($map, $x, $y);
2058 } 2371 }
2372
2373 $done->() if $done;
2059 })->prio (1); 2374 })->prio (1);
2060} 2375}
2061 2376
2062=item $player_object->enter_exit ($exit_object) 2377=item $player_object->enter_exit ($exit_object)
2063 2378
… …
2132 my $hp = $exit->stats->hp; 2447 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp; 2448 my $sp = $exit->stats->sp;
2134 2449
2135 $self->enter_link; 2450 $self->enter_link;
2136 2451
2452 # if exit is damned, update players death & WoR home-position
2453 $self->contr->savebed ($slaying, $hp, $sp)
2454 if $exit->flag (FLAG_DAMNED);
2455
2137 (async { 2456 (async {
2138 $self->deactivate_recursive; # just to be sure 2457 $self->deactivate_recursive; # just to be sure
2139 unless (eval { 2458 unless (eval {
2140 $self->goto ($slaying, $hp, $sp); 2459 $self->goto ($slaying, $hp, $sp);
2141 2460
… …
2168 2487
2169 utf8::encode $text; 2488 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2489 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171} 2490}
2172 2491
2492=item $client->send_msg ($channel, $msg, $color, [extra...])
2493
2494Send a drawinfo or msg packet to the client, formatting the msg for the
2495client if neccessary. C<$type> should be a string identifying the type of
2496the message, with C<log> being the default. If C<$color> is negative, suppress
2497the message unless the client supports the msg packet.
2498
2499=cut
2500
2501sub cf::client::send_msg {
2502 my ($self, $channel, $msg, $color, @extra) = @_;
2503
2504 $msg = $self->pl->expand_cfpod ($msg);
2505
2506 $color &= cf::NDI_CLIENT_MASK; # just in case...
2507
2508 if (ref $channel) {
2509 # send meta info to client, if not yet sent
2510 unless (exists $self->{channel}{$channel->{id}}) {
2511 $self->{channel}{$channel->{id}} = $channel;
2512 $self->ext_msg (channel_info => $channel);
2513 }
2514
2515 $channel = $channel->{id};
2516 }
2517
2518 return unless @extra || length $msg;
2519
2520 if ($self->can_msg) {
2521 # default colour, mask it out
2522 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2523 if $color & cf::NDI_DEF;
2524
2525 $self->send_packet ("msg " . $self->{json_coder}->encode (
2526 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2527 } else {
2528 if ($color >= 0) {
2529 # replace some tags by gcfclient-compatible ones
2530 for ($msg) {
2531 1 while
2532 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2533 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2534 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2535 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2536 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2537 }
2538
2539 $color &= cf::NDI_COLOR_MASK;
2540
2541 utf8::encode $msg;
2542
2543 if (0 && $msg =~ /\[/) {
2544 # COMMAND/INFO
2545 $self->send_packet ("drawextinfo $color 10 8 $msg")
2546 } else {
2547 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2548 $self->send_packet ("drawinfo $color $msg")
2549 }
2550 }
2551 }
2552}
2553
2173=item $client->ext_event ($type, %msg) 2554=item $client->ext_msg ($type, @msg)
2174 2555
2175Sends an exti event to the client. 2556Sends an ext event to the client.
2176 2557
2177=cut 2558=cut
2178 2559
2179sub cf::client::ext_event($$%) { 2560sub cf::client::ext_msg($$@) {
2180 my ($self, $type, %msg) = @_; 2561 my ($self, $type, @msg) = @_;
2181 2562
2563 if ($self->extcmd == 2) {
2564 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2565 } elsif ($self->extcmd == 1) { # TODO: remove
2182 $msg{msgtype} = "event_$type"; 2566 push @msg, msgtype => "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg); 2567 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2568 }
2569}
2570
2571=item $client->ext_reply ($msgid, @msg)
2572
2573Sends an ext reply to the client.
2574
2575=cut
2576
2577sub cf::client::ext_reply($$@) {
2578 my ($self, $id, @msg) = @_;
2579
2580 if ($self->extcmd == 2) {
2581 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2582 } elsif ($self->extcmd == 1) {
2583 #TODO: version 1, remove
2584 unshift @msg, msgtype => "reply", msgid => $id;
2585 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2586 }
2184} 2587}
2185 2588
2186=item $success = $client->query ($flags, "text", \&cb) 2589=item $success = $client->query ($flags, "text", \&cb)
2187 2590
2188Queues a query to the client, calling the given callback with 2591Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2592the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2190C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2593C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191 2594
2192Queries can fail, so check the return code. Or don't, as queries will become 2595Queries can fail, so check the return code. Or don't, as queries will
2193reliable at some point in the future. 2596become reliable at some point in the future.
2194 2597
2195=cut 2598=cut
2196 2599
2197sub cf::client::query { 2600sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_; 2601 my ($self, $flags, $text, $cb) = @_;
… …
2206 utf8::encode $text; 2609 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2610 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208 2611
2209 $self->send_packet ($self->{query_queue}[0][0]) 2612 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1; 2613 if @{ $self->{query_queue} } == 1;
2614
2615 1
2211} 2616}
2212 2617
2213cf::client->attach ( 2618cf::client->attach (
2619 on_connect => sub {
2620 my ($ns) = @_;
2621
2622 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2623 },
2214 on_reply => sub { 2624 on_reply => sub {
2215 my ($ns, $msg) = @_; 2625 my ($ns, $msg) = @_;
2216 2626
2217 # this weird shuffling is so that direct followup queries 2627 # this weird shuffling is so that direct followup queries
2218 # get handled first 2628 # get handled first
… …
2230 } else { 2640 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2641 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 } 2642 }
2233 } 2643 }
2234 }, 2644 },
2645 on_exticmd => sub {
2646 my ($ns, $buf) = @_;
2647
2648 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2649
2650 if (ref $msg) {
2651 my ($type, $reply, @payload) =
2652 "ARRAY" eq ref $msg
2653 ? @$msg
2654 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2655
2656 my @reply;
2657
2658 if (my $cb = $EXTICMD{$type}) {
2659 @reply = $cb->($ns, @payload);
2660 }
2661
2662 $ns->ext_reply ($reply, @reply)
2663 if $reply;
2664
2665 } else {
2666 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2667 }
2668
2669 cf::override;
2670 },
2235); 2671);
2236 2672
2237=item $client->async (\&cb) 2673=item $client->async (\&cb)
2238 2674
2239Create a new coroutine, running the specified callback. The coroutine will 2675Create a new coroutine, running the specified callback. The coroutine will
… …
2280our $safe = new Safe "safe"; 2716our $safe = new Safe "safe";
2281our $safe_hole = new Safe::Hole; 2717our $safe_hole = new Safe::Hole;
2282 2718
2283$SIG{FPE} = 'IGNORE'; 2719$SIG{FPE} = 'IGNORE';
2284 2720
2285$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2721$safe->permit_only (Opcode::opset qw(
2722 :base_core :base_mem :base_orig :base_math
2723 grepstart grepwhile mapstart mapwhile
2724 sort time
2725));
2286 2726
2287# here we export the classes and methods available to script code 2727# here we export the classes and methods available to script code
2288 2728
2289=pod 2729=pod
2290 2730
2291The following functions and methods are available within a safe environment: 2731The following functions and methods are available within a safe environment:
2292 2732
2293 cf::object contr pay_amount pay_player map 2733 cf::object
2734 contr pay_amount pay_player map x y force_find force_add
2735 insert remove name archname title slaying race decrease_ob_nr
2736
2294 cf::object::player player 2737 cf::object::player
2295 cf::player peaceful 2738 player
2296 cf::map trigger 2739
2740 cf::player
2741 peaceful
2742
2743 cf::map
2744 trigger
2297 2745
2298=cut 2746=cut
2299 2747
2300for ( 2748for (
2301 ["cf::object" => qw(contr pay_amount pay_player map)], 2749 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2750 insert remove inv name archname title slaying race
2751 decrease_ob_nr)],
2302 ["cf::object::player" => qw(player)], 2752 ["cf::object::player" => qw(player)],
2303 ["cf::player" => qw(peaceful)], 2753 ["cf::player" => qw(peaceful)],
2304 ["cf::map" => qw(trigger)], 2754 ["cf::map" => qw(trigger)],
2305) { 2755) {
2306 no strict 'refs'; 2756 no strict 'refs';
… …
2377=back 2827=back
2378 2828
2379=cut 2829=cut
2380 2830
2381############################################################################# 2831#############################################################################
2382
2383=head2 EXTENSION DATABASE SUPPORT
2384
2385Crossfire maintains a very simple database for extension use. It can
2386currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2387convert to/from binary).
2388
2389The parameter C<$family> should best start with the name of the extension
2390using it, it should be unique.
2391
2392=over 4
2393
2394=item $value = cf::db_get $family => $key
2395
2396Returns a single value from the database.
2397
2398=item cf::db_put $family => $key => $value
2399
2400Stores the given C<$value> in the family.
2401
2402=cut
2403
2404our $DB;
2405
2406sub db_init {
2407 unless ($DB) {
2408 $DB = BDB::db_create $DB_ENV;
2409
2410 cf::sync_job {
2411 eval {
2412 $DB->set_flags (BDB::CHKSUM);
2413
2414 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2415 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2416 cf::cleanup "db_open(db): $!" if $!;
2417 };
2418 cf::cleanup "db_open(db): $@" if $@;
2419 };
2420 }
2421}
2422
2423sub db_get($$) {
2424 my $key = "$_[0]/$_[1]";
2425
2426 cf::sync_job {
2427 BDB::db_get $DB, undef, $key, my $data;
2428
2429 $! ? ()
2430 : $data
2431 }
2432}
2433
2434sub db_put($$$) {
2435 BDB::dbreq_pri 4;
2436 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2437}
2438
2439=item cf::cache $id => [$paths...], $processversion => $process
2440
2441Generic caching function that returns the value of the resource $id,
2442caching and regenerating as required.
2443
2444This function can block.
2445
2446=cut
2447
2448sub cache {
2449 my ($id, $src, $processversion, $process) = @_;
2450
2451 my $meta =
2452 join "\x00",
2453 $processversion,
2454 map {
2455 aio_stat $_
2456 and Carp::croak "$_: $!";
2457
2458 ($_, (stat _)[7,9])
2459 } @$src;
2460
2461 my $dbmeta = db_get cache => "$id/meta";
2462 if ($dbmeta ne $meta) {
2463 # changed, we may need to process
2464
2465 my @data;
2466 my $md5;
2467
2468 for (0 .. $#$src) {
2469 0 <= aio_load $src->[$_], $data[$_]
2470 or Carp::croak "$src->[$_]: $!";
2471 }
2472
2473 # if processing is expensive, check
2474 # checksum first
2475 if (1) {
2476 $md5 =
2477 join "\x00",
2478 $processversion,
2479 map {
2480 Coro::cede;
2481 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2482 } 0.. $#$src;
2483
2484
2485 my $dbmd5 = db_get cache => "$id/md5";
2486 if ($dbmd5 eq $md5) {
2487 db_put cache => "$id/meta", $meta;
2488
2489 return db_get cache => "$id/data";
2490 }
2491 }
2492
2493 my $t1 = Time::HiRes::time;
2494 my $data = $process->(\@data);
2495 my $t2 = Time::HiRes::time;
2496
2497 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499 db_put cache => "$id/data", $data;
2500 db_put cache => "$id/md5" , $md5;
2501 db_put cache => "$id/meta", $meta;
2502
2503 return $data;
2504 }
2505
2506 db_get cache => "$id/data"
2507}
2508
2509=item fork_call { }, $args
2510
2511Executes the given code block with the given arguments in a seperate
2512process, returning the results. Everything must be serialisable with
2513Coro::Storable. May, of course, block. Note that the executed sub may
2514never block itself or use any form of Event handling.
2515
2516=cut
2517
2518sub fork_call(&@) {
2519 my ($cb, @args) = @_;
2520
2521# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522# or die "socketpair: $!";
2523 pipe my $fh1, my $fh2
2524 or die "pipe: $!";
2525
2526 if (my $pid = fork) {
2527 close $fh2;
2528
2529 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530 $res = Coro::Storable::thaw $res;
2531
2532 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534 die $$res unless "ARRAY" eq ref $res;
2535
2536 return wantarray ? @$res : $res->[-1];
2537 } else {
2538 reset_signals;
2539 local $SIG{__WARN__};
2540 local $SIG{__DIE__};
2541 eval {
2542 close $fh1;
2543
2544 my @res = eval { $cb->(@args) };
2545 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546 };
2547
2548 warn $@ if $@;
2549 _exit 0;
2550 }
2551}
2552
2553#############################################################################
2554# the server's init and main functions 2832# the server's init and main functions
2555 2833
2556sub load_facedata($) { 2834sub load_facedata($) {
2557 my ($path) = @_; 2835 my ($path) = @_;
2836
2837 my $enc = JSON::XS->new->utf8->canonical;
2558 2838
2559 warn "loading facedata from $path\n"; 2839 warn "loading facedata from $path\n";
2560 2840
2561 my $facedata; 2841 my $facedata;
2562 0 < aio_load $path, $facedata 2842 0 < aio_load $path, $facedata
… …
2565 $facedata = Coro::Storable::thaw $facedata; 2845 $facedata = Coro::Storable::thaw $facedata;
2566 2846
2567 $facedata->{version} == 2 2847 $facedata->{version} == 2
2568 or cf::cleanup "$path: version mismatch, cannot proceed."; 2848 or cf::cleanup "$path: version mismatch, cannot proceed.";
2569 2849
2850 # patch in the exptable
2851 $facedata->{resource}{"res/exp_table"} = {
2852 type => FT_RSRC,
2853 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2854 };
2855 cf::cede_to_tick;
2856
2570 { 2857 {
2571 my $faces = $facedata->{faceinfo}; 2858 my $faces = $facedata->{faceinfo};
2572 2859
2573 while (my ($face, $info) = each %$faces) { 2860 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2861 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2862 cf::face::set_visibility $idx, $info->{visibility};
2863 cf::face::set_magicmap $idx, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2864 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2865 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578 Coro::cede; 2866
2867 cf::cede_to_tick;
2579 } 2868 }
2580 2869
2581 while (my ($face, $info) = each %$faces) { 2870 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth}; 2871 next unless $info->{smooth};
2583 my $idx = cf::face::find $face 2872 my $idx = cf::face::find $face
2584 or next; 2873 or next;
2585 if (my $smooth = cf::face::find $info->{smooth}) { 2874 if (my $smooth = cf::face::find $info->{smooth}) {
2875 cf::face::set_smooth $idx, $smooth;
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2876 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587 } else { 2877 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2878 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 } 2879 }
2590 Coro::cede; 2880
2881 cf::cede_to_tick;
2591 } 2882 }
2592 } 2883 }
2593 2884
2594 { 2885 {
2595 my $anims = $facedata->{animinfo}; 2886 my $anims = $facedata->{animinfo};
2596 2887
2597 while (my ($anim, $info) = each %$anims) { 2888 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2889 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede; 2890 cf::cede_to_tick;
2600 } 2891 }
2601 2892
2602 cf::anim::invalidate_all; # d'oh 2893 cf::anim::invalidate_all; # d'oh
2603 } 2894 }
2604 2895
2896 {
2897 # TODO: for gcfclient pleasure, we should give resources
2898 # that gcfclient doesn't grok a >10000 face index.
2899 my $res = $facedata->{resource};
2900
2901 my $soundconf = delete $res->{"res/sound.conf"};
2902
2903 while (my ($name, $info) = each %$res) {
2904 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2905 my $data;
2906
2907 if ($info->{type} & 1) {
2908 # prepend meta info
2909
2910 my $meta = $enc->encode ({
2911 name => $name,
2912 %{ $info->{meta} || {} },
2913 });
2914
2915 $data = pack "(w/a*)*", $meta, $info->{data};
2916 } else {
2917 $data = $info->{data};
2918 }
2919
2920 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2921 cf::face::set_type $idx, $info->{type};
2922
2923 cf::cede_to_tick;
2924 }
2925
2926 if ($soundconf) {
2927 $soundconf = $enc->decode (delete $soundconf->{data});
2928
2929 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2930 my $sound = $soundconf->{compat}[$_]
2931 or next;
2932
2933 my $face = cf::face::find "sound/$sound->[1]";
2934 cf::sound::set $sound->[0] => $face;
2935 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2936 }
2937
2938 while (my ($k, $v) = each %{$soundconf->{event}}) {
2939 my $face = cf::face::find "sound/$v";
2940 cf::sound::set $k => $face;
2941 }
2942 }
2943 }
2944
2605 1 2945 1
2606} 2946}
2947
2948register_exticmd fx_want => sub {
2949 my ($ns, $want) = @_;
2950
2951 while (my ($k, $v) = each %$want) {
2952 $ns->fx_want ($k, $v);
2953 }
2954};
2607 2955
2608sub reload_regions { 2956sub reload_regions {
2609 load_resource_file "$MAPDIR/regions" 2957 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n"; 2958 or die "unable to load regions file\n";
2959
2960 for (cf::region::list) {
2961 $_->{match} = qr/$_->{match}/
2962 if exists $_->{match};
2963 }
2611} 2964}
2612 2965
2613sub reload_facedata { 2966sub reload_facedata {
2614 load_facedata "$DATADIR/facedata" 2967 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n"; 2968 or die "unable to load facedata\n";
2616} 2969}
2617 2970
2618sub reload_archetypes { 2971sub reload_archetypes {
2972 load_resource_file "$DATADIR/archetypes"
2973 or die "unable to load archetypes\n";
2974 #d# NEED to laod twice to resolve forward references
2975 # this really needs to be done in an extra post-pass
2976 # (which needs to be synchronous, so solve it differently)
2619 load_resource_file "$DATADIR/archetypes" 2977 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n"; 2978 or die "unable to load archetypes\n";
2621} 2979}
2622 2980
2623sub reload_treasures { 2981sub reload_treasures {
… …
2695 }, 3053 },
2696 ); 3054 );
2697 } 3055 }
2698} 3056}
2699 3057
3058sub write_runtime {
3059 my $runtime = "$LOCALDIR/runtime";
3060
3061 # first touch the runtime file to show we are still running:
3062 # the fsync below can take a very very long time.
3063
3064 IO::AIO::aio_utime $runtime, undef, undef;
3065
3066 my $guard = cf::lock_acquire "write_runtime";
3067
3068 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3069 or return;
3070
3071 my $value = $cf::RUNTIME + 90 + 10;
3072 # 10 is the runtime save interval, for a monotonic clock
3073 # 60 allows for the watchdog to kill the server.
3074
3075 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3076 and return;
3077
3078 # always fsync - this file is important
3079 aio_fsync $fh
3080 and return;
3081
3082 # touch it again to show we are up-to-date
3083 aio_utime $fh, undef, undef;
3084
3085 close $fh
3086 or return;
3087
3088 aio_rename "$runtime~", $runtime
3089 and return;
3090
3091 warn "runtime file written.\n";
3092
3093 1
3094}
3095
2700sub emergency_save() { 3096sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop; 3097 my $freeze_guard = cf::freeze_mainloop;
2702 3098
2703 warn "enter emergency perl save\n"; 3099 warn "enter emergency perl save\n";
2704 3100
… …
2779 %EXT_CORO = (); 3175 %EXT_CORO = ();
2780 3176
2781 warn "removing commands"; 3177 warn "removing commands";
2782 %COMMAND = (); 3178 %COMMAND = ();
2783 3179
2784 warn "removing ext commands"; 3180 warn "removing ext/exti commands";
2785 %EXTCMD = (); 3181 %EXTCMD = ();
3182 %EXTICMD = ();
2786 3183
2787 warn "unloading/nuking all extensions"; 3184 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) { 3185 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg"; 3186 warn "... unloading $pkg";
2790 3187

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines