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.349 by root, Fri Aug 31 04:10:43 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 ();
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
254 271
255Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
256a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
258returned. 275returned.
276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
259 279
260Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
261uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
262 282
263=item $locked = cf::lock_active $string 283=item $locked = cf::lock_active $string
306 }; 326 };
307 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
308 $guard 328 $guard
309} 329}
310 330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
385}
386
311=item cf::async { BLOCK } 387=item cf::async { BLOCK }
312 388
313Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 390C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 391thing you are allowed to do is call C<prio> on it.
318 394
319BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
320 396
321=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
322 398
323The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 400is 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. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
326 403
327If it must be done, put the blocking parts into C<sync_job>. This will run 404If 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 405the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
330fast or be very important. 407fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
391 468
392 $coro 469 $coro
393} 470}
394 471
395sub write_runtime { 472=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 473
398 # first touch the runtime file to show we are still running: 474Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
400 478
401 IO::AIO::aio_utime $runtime, undef, undef; 479=cut
402 480
403 my $guard = cf::lock_acquire "write_runtime"; 481sub fork_call(&@) {
482 my ($cb, @args) = @_;
404 483
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 484 # we seemingly have to make a local copy of the whole thing,
406 or return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
407 487
408 my $value = $cf::RUNTIME + 90 + 10; 488 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 489 reset_signals;
410 # 60 allows for the watchdog to kill the server. 490 &$cb
491 }, @args;
411 492
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 493 wantarray ? @res : $res[-1]
413 and return; 494}
414 495
415 # always fsync - this file is important 496=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 497
419 # touch it again to show we are up-to-date 498Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 499
422 close $fh 500=item cf::db_put $family => $key => $value
423 or return;
424 501
425 aio_rename "$runtime~", $runtime 502Stores the given C<$value> in the family. It can currently store binary
426 and return; 503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 504
428 warn "runtime file written.\n"; 505=cut
429 506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
430 1 523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
431} 610}
432 611
433=item cf::datalog type => key => value, ... 612=item cf::datalog type => key => value, ...
434 613
435Log a datalog packet of the given type with the given key-value pairs. 614Log 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") 632attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
455 634
456In the following description, CLASS can be any of C<global>, C<object> 635In 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 636C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 637Crossfire TRT).
459 638
460=over 4 639=over 4
461 640
462=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
463 642
665 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
666 } 845 }
667 846
668 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
669 } else { 848 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 850 }
672 851
673 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
674} 853}
675 854
715 "; 894 ";
716 die if $@; 895 die if $@;
717} 896}
718 897
719our $override; 898our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 900
722sub override { 901sub override {
723 $override = 1; 902 $override = 1;
724 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
725} 904}
726 905
727sub do_invoke { 906sub do_invoke {
728 my $event = shift; 907 my $event = shift;
729 my $callbacks = shift; 908 my $callbacks = shift;
730 909
731 @invoke_results = (); 910 @INVOKE_RESULTS = ();
732 911
733 local $override; 912 local $override;
734 913
735 for (@$callbacks) { 914 for (@$callbacks) {
736 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
753 932
754Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
755 934
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This 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 936removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 938
760=back 939=back
761 940
762=cut 941=cut
763 942
764############################################################################# 943#############################################################################
765# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
766 956
767sub reattach { 957sub reattach {
768 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 959 my ($obj) = @_;
770 960
877 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1068 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1069 return ($data, $av);
880} 1070}
881 1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
1077
882############################################################################# 1078#############################################################################
883# command handling &c 1079# command handling &c
884 1080
885=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
886 1082
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1095}
900 1096
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1098
903Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
904 1104
905If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
906called. 1106called.
907 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
908=cut 1119=cut
909 1120
910sub register_extcmd { 1121sub register_extcmd {
911 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
912 1123
913 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
914} 1131}
915 1132
916cf::player->attach ( 1133cf::player->attach (
917 on_command => sub { 1134 on_command => sub {
918 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
927 cf::override; 1144 cf::override;
928 }, 1145 },
929 on_extcmd => sub { 1146 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
931 1148
932 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1150
934 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
940 } else { 1166 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1168 }
943 1169
944 cf::override; 1170 cf::override;
967 path => $path, 1193 path => $path,
968 base => $base, 1194 base => $base,
969 pkg => $pkg, 1195 pkg => $pkg,
970 ); 1196 );
971 1197
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 } 1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/; 1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974 1200
975 $ext{source} = 1201 $ext{source} =
976 "package $pkg; use strict; use utf8;\n" 1202 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n" 1203 . "#line 1 \"$path\"\n{\n"
978 . $source 1204 . $source
984 my %done; 1210 my %done;
985 while (%todo) { 1211 while (%todo) {
986 my $progress; 1212 my $progress;
987 1213
988 while (my ($k, $v) = each %todo) { 1214 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) { 1215 for (split /,\s*/, $v->{meta}{depends}) {
990 goto skip 1216 goto skip
991 unless exists $done{$_}; 1217 unless exists $done{$_};
992 } 1218 }
993 1219
994 warn "... loading '$k' into '$v->{pkg}'\n"; 1220 warn "... loading '$k' into '$v->{pkg}'\n";
995 1221
996 unless (eval $v->{source}) { 1222 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n" 1223 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n"; 1224 : "$v->{base}: extension inactive.\n";
999 1225
1000 if (exists $v->{meta}{mandatory}) { 1226 if (exists $v->{meta}{mandatory}) {
1001 warn $msg; 1227 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n"; 1228 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1; 1229 exit 1;
1004 } 1230 }
1005 1231
1006 die $msg; 1232 warn $msg;
1007 } 1233 }
1008 1234
1009 $done{$k} = delete $todo{$k}; 1235 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg}; 1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
1011 } 1238 }
1012 1239
1013 skip: 1240 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n" 1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress; 1242 unless $progress;
1016 } 1243 }
1017 }; 1244 };
1018} 1245}
1019 1246
1020############################################################################# 1247#############################################################################
1248
1249=back
1021 1250
1022=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
1023 1252
1024Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
1025 1254
1096 1325
1097 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1098 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1099 1328
1100 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1101 Coro::cede; 1330 cf::cede_to_tick;
1102} 1331}
1103 1332
1104sub new($) { 1333sub new($) {
1105 my ($login) = @_; 1334 my ($login) = @_;
1106 1335
1110 $self->{deny_save} = 1; 1339 $self->{deny_save} = 1;
1111 1340
1112 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1113 1342
1114 $self 1343 $self
1344}
1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1115} 1354}
1116 1355
1117=item $pl->quit_character 1356=item $pl->quit_character
1118 1357
1119Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1213 } 1452 }
1214 1453
1215 \@paths 1454 \@paths
1216} 1455}
1217 1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1218=item $player->ext_reply ($msgid, %msg) 1507=item $player->ext_reply ($msgid, @msg)
1219 1508
1220Sends an ext reply to the player. 1509Sends an ext reply to the player.
1221 1510
1222=cut 1511=cut
1223 1512
1224sub ext_reply($$%) { 1513sub ext_reply($$@) {
1225 my ($self, $id, %msg) = @_; 1514 my ($self, $id, @msg) = @_;
1226 1515
1227 $msg{msgid} = $id; 1516 $self->ns->ext_reply ($id, @msg)
1228
1229 $self->send ("ext " . cf::to_json \%msg);
1230} 1517}
1231 1518
1232=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1233 1520
1234Sends an ext event to the client. 1521Sends an ext event to the client.
1235 1522
1236=cut 1523=cut
1237 1524
1238sub ext_event($$%) { 1525sub ext_msg($$@) {
1239 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1240 1527
1241 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1242} 1529}
1243 1530
1244=head3 cf::region 1531=head3 cf::region
1245 1532
1246=over 4 1533=over 4
1249 1536
1250package cf::region; 1537package cf::region;
1251 1538
1252=item cf::region::find_by_path $path 1539=item cf::region::find_by_path $path
1253 1540
1254Tries to decuce the probable region for a map knowing only its path. 1541Tries to decuce the likely region for a map knowing only its path.
1255 1542
1256=cut 1543=cut
1257 1544
1258sub find_by_path($) { 1545sub find_by_path($) {
1259 my ($path) = @_; 1546 my ($path) = @_;
1260 1547
1261 my ($match, $specificity); 1548 my ($match, $specificity);
1262 1549
1263 for my $region (list) { 1550 for my $region (list) {
1264 if ($region->match && $path =~ $region->match) { 1551 if ($region->{match} && $path =~ $region->{match}) {
1265 ($match, $specificity) = ($region, $region->specificity) 1552 ($match, $specificity) = ($region, $region->specificity)
1266 if $region->specificity > $specificity; 1553 if $region->specificity > $specificity;
1267 } 1554 }
1268 } 1555 }
1269 1556
1389 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1390 return $self; 1677 return $self;
1391 } 1678 }
1392 } 1679 }
1393 1680
1394 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1395 () 1682 ()
1396} 1683}
1397 1684
1398sub init { 1685sub init {
1399 my ($self) = @_; 1686 my ($self) = @_;
1565 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1566 1853
1567 my $path = $self->{path}; 1854 my $path = $self->{path};
1568 1855
1569 { 1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1570 my $guard = cf::lock_acquire "map_load:$path"; 1858 my $guard2 = cf::lock_acquire "map_load:$path";
1571 1859
1572 return if $self->in_memory != cf::MAP_SWAPPED; 1860 return if $self->in_memory != cf::MAP_SWAPPED;
1573 1861
1574 $self->in_memory (cf::MAP_LOADING); 1862 $self->in_memory (cf::MAP_LOADING);
1575 1863
1576 $self->alloc; 1864 $self->alloc;
1577 1865
1578 $self->pre_load; 1866 $self->pre_load;
1579 Coro::cede; 1867 cf::cede_to_tick;
1580 1868
1581 $self->_load_objects ($self->{load_path}, 1) 1869 $self->_load_objects ($self->{load_path}, 1)
1582 or return; 1870 or return;
1583 1871
1584 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1590 $self->clear_unique_items; 1878 $self->clear_unique_items;
1591 $self->_load_objects ($uniq, 0); 1879 $self->_load_objects ($uniq, 0);
1592 } 1880 }
1593 } 1881 }
1594 1882
1595 Coro::cede; 1883 cf::cede_to_tick;
1596 # now do the right thing for maps 1884 # now do the right thing for maps
1597 $self->link_multipart_objects; 1885 $self->link_multipart_objects;
1598 $self->difficulty ($self->estimate_difficulty) 1886 $self->difficulty ($self->estimate_difficulty)
1599 unless $self->difficulty; 1887 unless $self->difficulty;
1600 Coro::cede; 1888 cf::cede_to_tick;
1601 1889
1602 unless ($self->{deny_activate}) { 1890 unless ($self->{deny_activate}) {
1603 $self->decay_objects; 1891 $self->decay_objects;
1604 $self->fix_auto_apply; 1892 $self->fix_auto_apply;
1605 $self->update_buttons; 1893 $self->update_buttons;
1606 Coro::cede; 1894 cf::cede_to_tick;
1607 $self->set_darkness_map; 1895 $self->set_darkness_map;
1608 Coro::cede; 1896 cf::cede_to_tick;
1609 $self->activate; 1897 $self->activate;
1610 } 1898 }
1899
1900 $self->{last_save} = $cf::RUNTIME;
1901 $self->last_access ($cf::RUNTIME);
1611 1902
1612 $self->in_memory (cf::MAP_IN_MEMORY); 1903 $self->in_memory (cf::MAP_IN_MEMORY);
1613 } 1904 }
1614 1905
1615 $self->post_load; 1906 $self->post_load;
1626 1917
1627 $self 1918 $self
1628} 1919}
1629 1920
1630# find and load all maps in the 3x3 area around a map 1921# find and load all maps in the 3x3 area around a map
1631sub load_diag { 1922sub load_neighbours {
1632 my ($map) = @_; 1923 my ($map) = @_;
1633 1924
1634 my @diag; # diagonal neighbours 1925 my @neigh; # diagonal neighbours
1635 1926
1636 for (0 .. 3) { 1927 for (0 .. 3) {
1637 my $neigh = $map->tile_path ($_) 1928 my $neigh = $map->tile_path ($_)
1638 or next; 1929 or next;
1639 $neigh = find $neigh, $map 1930 $neigh = find $neigh, $map
1640 or next; 1931 or next;
1641 $neigh->load; 1932 $neigh->load;
1642 1933
1934 push @neigh,
1643 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1644 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1645 } 1937 }
1646 1938
1647 for (@diag) { 1939 for (grep defined $_->[0], @neigh) {
1940 my ($path, $origin) = @$_;
1648 my $neigh = find @$_ 1941 my $neigh = find $path, $origin
1649 or next; 1942 or next;
1650 $neigh->load; 1943 $neigh->load;
1651 } 1944 }
1652} 1945}
1653 1946
1658} 1951}
1659 1952
1660sub do_load_sync { 1953sub do_load_sync {
1661 my ($map) = @_; 1954 my ($map) = @_;
1662 1955
1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1957 if $Coro::current == $Coro::main;
1958
1663 cf::sync_job { $map->load }; 1959 cf::sync_job { $map->load };
1664} 1960}
1665 1961
1666our %MAP_PREFETCH; 1962our %MAP_PREFETCH;
1667our $MAP_PREFETCHER = undef; 1963our $MAP_PREFETCHER = undef;
1668 1964
1669sub find_async { 1965sub find_async {
1670 my ($path, $origin) = @_; 1966 my ($path, $origin, $load) = @_;
1671 1967
1672 $path = normalise $path, $origin && $origin->{path}; 1968 $path = normalise $path, $origin && $origin->{path};
1673 1969
1674 if (my $map = $cf::MAP{$path}) { 1970 if (my $map = $cf::MAP{$path}) {
1675 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676 } 1972 }
1677 1973
1678 undef $MAP_PREFETCH{$path}; 1974 $MAP_PREFETCH{$path} |= $load;
1975
1679 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1680 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1681 for my $path (keys %MAP_PREFETCH) { 1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1682 my $map = find $path 1979 if (my $map = find $k) {
1683 or next;
1684 $map->load; 1980 $map->load if $v;
1981 }
1685 1982
1686 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$k};
1687 } 1984 }
1688 } 1985 }
1689 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1690 }; 1987 };
1691 $MAP_PREFETCHER->prio (6); 1988 $MAP_PREFETCHER->prio (6);
1694} 1991}
1695 1992
1696sub save { 1993sub save {
1697 my ($self) = @_; 1994 my ($self) = @_;
1698 1995
1699 my $lock = cf::lock_acquire "map_data:" . $self->path; 1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1700 1997
1701 $self->{last_save} = $cf::RUNTIME; 1998 $self->{last_save} = $cf::RUNTIME;
1702 1999
1703 return unless $self->dirty; 2000 return unless $self->dirty;
1704 2001
1727 my ($self) = @_; 2024 my ($self) = @_;
1728 2025
1729 # save first because save cedes 2026 # save first because save cedes
1730 $self->save; 2027 $self->save;
1731 2028
1732 my $lock = cf::lock_acquire "map_data:" . $self->path; 2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
1733 2030
1734 return if $self->players; 2031 return if $self->players;
1735 return if $self->in_memory != cf::MAP_IN_MEMORY; 2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
1736 return if $self->{deny_save}; 2033 return if $self->{deny_save};
1737 2034
1789my $nuke_counter = "aaaa"; 2086my $nuke_counter = "aaaa";
1790 2087
1791sub nuke { 2088sub nuke {
1792 my ($self) = @_; 2089 my ($self) = @_;
1793 2090
2091 {
2092 my $lock = cf::lock_acquire "map_data:$self->{path}";
2093
1794 delete $cf::MAP{$self->path}; 2094 delete $cf::MAP{$self->path};
1795 2095
1796 $self->unlink_save;
1797
1798 bless $self, "cf::map"; 2096 bless $self, "cf::map";
1799 delete $self->{deny_reset}; 2097 delete $self->{deny_reset};
1800 $self->{deny_save} = 1; 2098 $self->{deny_save} = 1;
1801 $self->reset_timeout (1); 2099 $self->reset_timeout (1);
1802 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2100 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1803 2101
2102 $self->unlink_save;
2103
1804 $cf::MAP{$self->path} = $self; 2104 $cf::MAP{$self->path} = $self;
2105 }
1805 2106
1806 $self->reset; # polite request, might not happen 2107 $self->reset; # polite request, might not happen
1807} 2108}
1808 2109
1809=item $maps = cf::map::tmp_maps 2110=item $maps = cf::map::tmp_maps
1911 2212
1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2213 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913 2214
1914 if ($self->{record_replies}) { 2215 if ($self->{record_replies}) {
1915 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2216 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2217
1916 } else { 2218 } else {
2219 my $pl = $self->contr;
2220
2221 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2222 my $dialog = $pl->{npc_dialog};
2223 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2224
2225 } else {
1917 $msg = $npc->name . " says: $msg" if $npc; 2226 $msg = $npc->name . " says: $msg" if $npc;
1918 $self->message ($msg, $flags); 2227 $self->message ($msg, $flags);
2228 }
1919 } 2229 }
2230}
2231
2232=item $object->send_msg ($channel, $msg, $color, [extra...])
2233
2234=cut
2235
2236sub cf::object::send_msg {
2237 my $pl = shift->contr
2238 or return;
2239 $pl->send_msg (@_);
1920} 2240}
1921 2241
1922=item $player_object->may ("access") 2242=item $player_object->may ("access")
1923 2243
1924Returns wether the given player is authorized to access resource "access" 2244Returns wether the given player is authorized to access resource "access"
2003 # use -1 or undef as default coordinates, not 0, 0 2323 # use -1 or undef as default coordinates, not 0, 0
2004 ($x, $y) = ($map->enter_x, $map->enter_y) 2324 ($x, $y) = ($map->enter_x, $map->enter_y)
2005 if $x <=0 && $y <= 0; 2325 if $x <=0 && $y <= 0;
2006 2326
2007 $map->load; 2327 $map->load;
2008 $map->load_diag; 2328 $map->load_neighbours;
2009 2329
2010 return unless $self->contr->active; 2330 return unless $self->contr->active;
2011 $self->activate_recursive; 2331 $self->activate_recursive;
2012 2332
2013 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2333 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014 $self->enter_map ($map, $x, $y); 2334 $self->enter_map ($map, $x, $y);
2015} 2335}
2016 2336
2017=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2337=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018 2338
2019Moves the player to the given map-path and coordinates by first freezing 2339Moves the player to the given map-path and coordinates by first freezing
2020her, loading and preparing them map, calling the provided $check callback 2340her, loading and preparing them map, calling the provided $check callback
2021that has to return the map if sucecssful, and then unfreezes the player on 2341that has to return the map if sucecssful, and then unfreezes the player on
2022the new (success) or old (failed) map position. 2342the new (success) or old (failed) map position. In either case, $done will
2343be called at the end of this process.
2023 2344
2024=cut 2345=cut
2025 2346
2026our $GOTOGEN; 2347our $GOTOGEN;
2027 2348
2028sub cf::object::player::goto { 2349sub cf::object::player::goto {
2029 my ($self, $path, $x, $y, $check) = @_; 2350 my ($self, $path, $x, $y, $check, $done) = @_;
2030 2351
2031 # do generation counting so two concurrent goto's will be executed in-order 2352 # do generation counting so two concurrent goto's will be executed in-order
2032 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2353 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033 2354
2034 $self->enter_link; 2355 $self->enter_link;
2054 2375
2055 if ($gen == $self->{_goto_generation}) { 2376 if ($gen == $self->{_goto_generation}) {
2056 delete $self->{_goto_generation}; 2377 delete $self->{_goto_generation};
2057 $self->leave_link ($map, $x, $y); 2378 $self->leave_link ($map, $x, $y);
2058 } 2379 }
2380
2381 $done->() if $done;
2059 })->prio (1); 2382 })->prio (1);
2060} 2383}
2061 2384
2062=item $player_object->enter_exit ($exit_object) 2385=item $player_object->enter_exit ($exit_object)
2063 2386
2132 my $hp = $exit->stats->hp; 2455 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp; 2456 my $sp = $exit->stats->sp;
2134 2457
2135 $self->enter_link; 2458 $self->enter_link;
2136 2459
2460 # if exit is damned, update players death & WoR home-position
2461 $self->contr->savebed ($slaying, $hp, $sp)
2462 if $exit->flag (FLAG_DAMNED);
2463
2137 (async { 2464 (async {
2138 $self->deactivate_recursive; # just to be sure 2465 $self->deactivate_recursive; # just to be sure
2139 unless (eval { 2466 unless (eval {
2140 $self->goto ($slaying, $hp, $sp); 2467 $self->goto ($slaying, $hp, $sp);
2141 2468
2168 2495
2169 utf8::encode $text; 2496 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2497 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171} 2498}
2172 2499
2500=item $client->send_msg ($channel, $msg, $color, [extra...])
2501
2502Send a drawinfo or msg packet to the client, formatting the msg for the
2503client if neccessary. C<$type> should be a string identifying the type of
2504the message, with C<log> being the default. If C<$color> is negative, suppress
2505the message unless the client supports the msg packet.
2506
2507=cut
2508
2509sub cf::client::send_msg {
2510 my ($self, $channel, $msg, $color, @extra) = @_;
2511
2512 $msg = $self->pl->expand_cfpod ($msg);
2513
2514 $color &= cf::NDI_CLIENT_MASK; # just in case...
2515
2516 if (ref $channel) {
2517 # send meta info to client, if not yet sent
2518 unless (exists $self->{channel}{$channel->{id}}) {
2519 $self->{channel}{$channel->{id}} = $channel;
2520 $self->ext_msg (channel_info => $channel);
2521 }
2522
2523 $channel = $channel->{id};
2524 }
2525
2526 return unless @extra || length $msg;
2527
2528 if ($self->can_msg) {
2529 # default colour, mask it out
2530 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2531 if $color & cf::NDI_DEF;
2532
2533 $self->send_packet ("msg " . $self->{json_coder}->encode (
2534 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2535 } else {
2536 if ($color >= 0) {
2537 # replace some tags by gcfclient-compatible ones
2538 for ($msg) {
2539 1 while
2540 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2541 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2542 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2543 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2544 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2545 }
2546
2547 $color &= cf::NDI_COLOR_MASK;
2548
2549 utf8::encode $msg;
2550
2551 if (0 && $msg =~ /\[/) {
2552 # COMMAND/INFO
2553 $self->send_packet ("drawextinfo $color 10 8 $msg")
2554 } else {
2555 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2556 $self->send_packet ("drawinfo $color $msg")
2557 }
2558 }
2559 }
2560}
2561
2173=item $client->ext_event ($type, %msg) 2562=item $client->ext_msg ($type, @msg)
2174 2563
2175Sends an exti event to the client. 2564Sends an ext event to the client.
2176 2565
2177=cut 2566=cut
2178 2567
2179sub cf::client::ext_event($$%) { 2568sub cf::client::ext_msg($$@) {
2180 my ($self, $type, %msg) = @_; 2569 my ($self, $type, @msg) = @_;
2181 2570
2571 if ($self->extcmd == 2) {
2572 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2573 } elsif ($self->extcmd == 1) { # TODO: remove
2182 $msg{msgtype} = "event_$type"; 2574 push @msg, msgtype => "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg); 2575 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2576 }
2577}
2578
2579=item $client->ext_reply ($msgid, @msg)
2580
2581Sends an ext reply to the client.
2582
2583=cut
2584
2585sub cf::client::ext_reply($$@) {
2586 my ($self, $id, @msg) = @_;
2587
2588 if ($self->extcmd == 2) {
2589 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2590 } elsif ($self->extcmd == 1) {
2591 #TODO: version 1, remove
2592 unshift @msg, msgtype => "reply", msgid => $id;
2593 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2594 }
2184} 2595}
2185 2596
2186=item $success = $client->query ($flags, "text", \&cb) 2597=item $success = $client->query ($flags, "text", \&cb)
2187 2598
2188Queues a query to the client, calling the given callback with 2599Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2600the 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>. 2601C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191 2602
2192Queries can fail, so check the return code. Or don't, as queries will become 2603Queries can fail, so check the return code. Or don't, as queries will
2193reliable at some point in the future. 2604become reliable at some point in the future.
2194 2605
2195=cut 2606=cut
2196 2607
2197sub cf::client::query { 2608sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_; 2609 my ($self, $flags, $text, $cb) = @_;
2206 utf8::encode $text; 2617 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2618 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208 2619
2209 $self->send_packet ($self->{query_queue}[0][0]) 2620 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1; 2621 if @{ $self->{query_queue} } == 1;
2622
2623 1
2211} 2624}
2212 2625
2213cf::client->attach ( 2626cf::client->attach (
2627 on_connect => sub {
2628 my ($ns) = @_;
2629
2630 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2631 },
2214 on_reply => sub { 2632 on_reply => sub {
2215 my ($ns, $msg) = @_; 2633 my ($ns, $msg) = @_;
2216 2634
2217 # this weird shuffling is so that direct followup queries 2635 # this weird shuffling is so that direct followup queries
2218 # get handled first 2636 # get handled first
2230 } else { 2648 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2649 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 } 2650 }
2233 } 2651 }
2234 }, 2652 },
2653 on_exticmd => sub {
2654 my ($ns, $buf) = @_;
2655
2656 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2657
2658 if (ref $msg) {
2659 my ($type, $reply, @payload) =
2660 "ARRAY" eq ref $msg
2661 ? @$msg
2662 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2663
2664 my @reply;
2665
2666 if (my $cb = $EXTICMD{$type}) {
2667 @reply = $cb->($ns, @payload);
2668 }
2669
2670 $ns->ext_reply ($reply, @reply)
2671 if $reply;
2672
2673 } else {
2674 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2675 }
2676
2677 cf::override;
2678 },
2235); 2679);
2236 2680
2237=item $client->async (\&cb) 2681=item $client->async (\&cb)
2238 2682
2239Create a new coroutine, running the specified callback. The coroutine will 2683Create a new coroutine, running the specified callback. The coroutine will
2280our $safe = new Safe "safe"; 2724our $safe = new Safe "safe";
2281our $safe_hole = new Safe::Hole; 2725our $safe_hole = new Safe::Hole;
2282 2726
2283$SIG{FPE} = 'IGNORE'; 2727$SIG{FPE} = 'IGNORE';
2284 2728
2285$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2729$safe->permit_only (Opcode::opset qw(
2730 :base_core :base_mem :base_orig :base_math
2731 grepstart grepwhile mapstart mapwhile
2732 sort time
2733));
2286 2734
2287# here we export the classes and methods available to script code 2735# here we export the classes and methods available to script code
2288 2736
2289=pod 2737=pod
2290 2738
2291The following functions and methods are available within a safe environment: 2739The following functions and methods are available within a safe environment:
2292 2740
2293 cf::object contr pay_amount pay_player map 2741 cf::object
2742 contr pay_amount pay_player map x y force_find force_add
2743 insert remove name archname title slaying race decrease_ob_nr
2744
2294 cf::object::player player 2745 cf::object::player
2295 cf::player peaceful 2746 player
2296 cf::map trigger 2747
2748 cf::player
2749 peaceful
2750
2751 cf::map
2752 trigger
2297 2753
2298=cut 2754=cut
2299 2755
2300for ( 2756for (
2301 ["cf::object" => qw(contr pay_amount pay_player map)], 2757 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2758 insert remove inv name archname title slaying race
2759 decrease_ob_nr)],
2302 ["cf::object::player" => qw(player)], 2760 ["cf::object::player" => qw(player)],
2303 ["cf::player" => qw(peaceful)], 2761 ["cf::player" => qw(peaceful)],
2304 ["cf::map" => qw(trigger)], 2762 ["cf::map" => qw(trigger)],
2305) { 2763) {
2306 no strict 'refs'; 2764 no strict 'refs';
2377=back 2835=back
2378 2836
2379=cut 2837=cut
2380 2838
2381############################################################################# 2839#############################################################################
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 2840# the server's init and main functions
2555 2841
2556sub load_facedata($) { 2842sub load_facedata($) {
2557 my ($path) = @_; 2843 my ($path) = @_;
2844
2845 # HACK to clear player env face cache, we need some signal framework
2846 # for this (global event?)
2847 %ext::player_env::MUSIC_FACE_CACHE = ();
2848
2849 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2558 2850
2559 warn "loading facedata from $path\n"; 2851 warn "loading facedata from $path\n";
2560 2852
2561 my $facedata; 2853 my $facedata;
2562 0 < aio_load $path, $facedata 2854 0 < aio_load $path, $facedata
2565 $facedata = Coro::Storable::thaw $facedata; 2857 $facedata = Coro::Storable::thaw $facedata;
2566 2858
2567 $facedata->{version} == 2 2859 $facedata->{version} == 2
2568 or cf::cleanup "$path: version mismatch, cannot proceed."; 2860 or cf::cleanup "$path: version mismatch, cannot proceed.";
2569 2861
2862 # patch in the exptable
2863 $facedata->{resource}{"res/exp_table"} = {
2864 type => FT_RSRC,
2865 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2866 };
2867 cf::cede_to_tick;
2868
2570 { 2869 {
2571 my $faces = $facedata->{faceinfo}; 2870 my $faces = $facedata->{faceinfo};
2572 2871
2573 while (my ($face, $info) = each %$faces) { 2872 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2873 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2874 cf::face::set_visibility $idx, $info->{visibility};
2875 cf::face::set_magicmap $idx, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2876 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2877 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578 Coro::cede; 2878
2879 cf::cede_to_tick;
2579 } 2880 }
2580 2881
2581 while (my ($face, $info) = each %$faces) { 2882 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth}; 2883 next unless $info->{smooth};
2583 my $idx = cf::face::find $face 2884 my $idx = cf::face::find $face
2584 or next; 2885 or next;
2585 if (my $smooth = cf::face::find $info->{smooth}) { 2886 if (my $smooth = cf::face::find $info->{smooth}) {
2887 cf::face::set_smooth $idx, $smooth;
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2888 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587 } else { 2889 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2890 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 } 2891 }
2590 Coro::cede; 2892
2893 cf::cede_to_tick;
2591 } 2894 }
2592 } 2895 }
2593 2896
2594 { 2897 {
2595 my $anims = $facedata->{animinfo}; 2898 my $anims = $facedata->{animinfo};
2596 2899
2597 while (my ($anim, $info) = each %$anims) { 2900 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2901 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede; 2902 cf::cede_to_tick;
2600 } 2903 }
2601 2904
2602 cf::anim::invalidate_all; # d'oh 2905 cf::anim::invalidate_all; # d'oh
2603 } 2906 }
2604 2907
2908 {
2909 # TODO: for gcfclient pleasure, we should give resources
2910 # that gcfclient doesn't grok a >10000 face index.
2911 my $res = $facedata->{resource};
2912
2913 my $soundconf = delete $res->{"res/sound.conf"};
2914
2915 while (my ($name, $info) = each %$res) {
2916 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2917 my $data;
2918
2919 if ($info->{type} & 1) {
2920 # prepend meta info
2921
2922 my $meta = $enc->encode ({
2923 name => $name,
2924 %{ $info->{meta} || {} },
2925 });
2926
2927 $data = pack "(w/a*)*", $meta, $info->{data};
2928 } else {
2929 $data = $info->{data};
2930 }
2931
2932 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2933 cf::face::set_type $idx, $info->{type};
2934
2935 cf::cede_to_tick;
2936 }
2937
2938 if ($soundconf) {
2939 $soundconf = $enc->decode (delete $soundconf->{data});
2940
2941 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2942 my $sound = $soundconf->{compat}[$_]
2943 or next;
2944
2945 my $face = cf::face::find "sound/$sound->[1]";
2946 cf::sound::set $sound->[0] => $face;
2947 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2948 }
2949
2950 while (my ($k, $v) = each %{$soundconf->{event}}) {
2951 my $face = cf::face::find "sound/$v";
2952 cf::sound::set $k => $face;
2953 }
2954 }
2955 }
2956
2605 1 2957 1
2606} 2958}
2607 2959
2960register_exticmd fx_want => sub {
2961 my ($ns, $want) = @_;
2962
2963 while (my ($k, $v) = each %$want) {
2964 $ns->fx_want ($k, $v);
2965 }
2966};
2967
2608sub reload_regions { 2968sub reload_regions {
2969 # HACK to clear player env face cache, we need some signal framework
2970 # for this (global event?)
2971 %ext::player_env::MUSIC_FACE_CACHE = ();
2972
2609 load_resource_file "$MAPDIR/regions" 2973 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n"; 2974 or die "unable to load regions file\n";
2975
2976 for (cf::region::list) {
2977 $_->{match} = qr/$_->{match}/
2978 if exists $_->{match};
2979 }
2611} 2980}
2612 2981
2613sub reload_facedata { 2982sub reload_facedata {
2614 load_facedata "$DATADIR/facedata" 2983 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n"; 2984 or die "unable to load facedata\n";
2616} 2985}
2617 2986
2618sub reload_archetypes { 2987sub reload_archetypes {
2988 load_resource_file "$DATADIR/archetypes"
2989 or die "unable to load archetypes\n";
2990 #d# NEED to laod twice to resolve forward references
2991 # this really needs to be done in an extra post-pass
2992 # (which needs to be synchronous, so solve it differently)
2619 load_resource_file "$DATADIR/archetypes" 2993 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n"; 2994 or die "unable to load archetypes\n";
2621} 2995}
2622 2996
2623sub reload_treasures { 2997sub reload_treasures {
2639 3013
2640sub init { 3014sub init {
2641 reload_resources; 3015 reload_resources;
2642} 3016}
2643 3017
2644sub cfg_load { 3018sub reload_config {
2645 open my $fh, "<:utf8", "$CONFDIR/config" 3019 open my $fh, "<:utf8", "$CONFDIR/config"
2646 or return; 3020 or return;
2647 3021
2648 local $/; 3022 local $/;
2649 *CFG = YAML::Syck::Load <$fh>; 3023 *CFG = YAML::Syck::Load <$fh>;
2669 (async { 3043 (async {
2670 Event::one_event; 3044 Event::one_event;
2671 })->prio (Coro::PRIO_MAX); 3045 })->prio (Coro::PRIO_MAX);
2672 }; 3046 };
2673 3047
2674 cfg_load; 3048 reload_config;
2675 db_init; 3049 db_init;
2676 load_extensions; 3050 load_extensions;
2677 3051
2678 $TICK_WATCHER->start; 3052 $TICK_WATCHER->start;
2679 Event::loop; 3053 Event::loop;
2695 }, 3069 },
2696 ); 3070 );
2697 } 3071 }
2698} 3072}
2699 3073
3074sub write_runtime {
3075 my $runtime = "$LOCALDIR/runtime";
3076
3077 # first touch the runtime file to show we are still running:
3078 # the fsync below can take a very very long time.
3079
3080 IO::AIO::aio_utime $runtime, undef, undef;
3081
3082 my $guard = cf::lock_acquire "write_runtime";
3083
3084 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3085 or return;
3086
3087 my $value = $cf::RUNTIME + 90 + 10;
3088 # 10 is the runtime save interval, for a monotonic clock
3089 # 60 allows for the watchdog to kill the server.
3090
3091 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3092 and return;
3093
3094 # always fsync - this file is important
3095 aio_fsync $fh
3096 and return;
3097
3098 # touch it again to show we are up-to-date
3099 aio_utime $fh, undef, undef;
3100
3101 close $fh
3102 or return;
3103
3104 aio_rename "$runtime~", $runtime
3105 and return;
3106
3107 warn "runtime file written.\n";
3108
3109 1
3110}
3111
2700sub emergency_save() { 3112sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop; 3113 my $freeze_guard = cf::freeze_mainloop;
2702 3114
2703 warn "enter emergency perl save\n"; 3115 warn "enter emergency perl save\n";
2704 3116
2779 %EXT_CORO = (); 3191 %EXT_CORO = ();
2780 3192
2781 warn "removing commands"; 3193 warn "removing commands";
2782 %COMMAND = (); 3194 %COMMAND = ();
2783 3195
2784 warn "removing ext commands"; 3196 warn "removing ext/exti commands";
2785 %EXTCMD = (); 3197 %EXTCMD = ();
3198 %EXTICMD = ();
2786 3199
2787 warn "unloading/nuking all extensions"; 3200 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) { 3201 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg"; 3202 warn "... unloading $pkg";
2790 3203
2833 warn "reloading cf.pm"; 3246 warn "reloading cf.pm";
2834 require cf; 3247 require cf;
2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3248 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2836 3249
2837 warn "loading config and database again"; 3250 warn "loading config and database again";
2838 cf::cfg_load; 3251 cf::reload_config;
2839 3252
2840 warn "loading extensions"; 3253 warn "loading extensions";
2841 cf::load_extensions; 3254 cf::load_extensions;
2842 3255
2843 warn "reattaching attachments to objects/players"; 3256 warn "reattaching attachments to objects/players";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines