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.352 by root, Sun Sep 2 04:57:14 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/(?<![BIUGHT])</&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 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1478 # replace G<male|female> tags
1479 || s{G<([^>|]*)\|([^>]*)>}{
1480 $self->gender ? $2 : $1
1481 }ge
1482 # replace H<hint text>
1483 || s{H<([^\>]*)>}
1484 {
1485 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1486 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1487 "")
1488 [$self->{hintmode}]
1489 }ge;
1490
1491 # create single paragraphs (very hackish)
1492 s/(?<=\S)\n(?=\w)/ /g;
1493
1494 # compress some whitespace
1495 s/\s+\n/\n/g; # ws line-ends
1496 s/\n\n+/\n/g; # double lines
1497 s/^\n+//; # beginning lines
1498 s/\n+$//; # ending lines
1499
1500 $_
1501}
1502
1503sub hintmode {
1504 $_[0]{hintmode} = $_[1] if @_ > 1;
1505 $_[0]{hintmode}
1506}
1507
1218=item $player->ext_reply ($msgid, %msg) 1508=item $player->ext_reply ($msgid, @msg)
1219 1509
1220Sends an ext reply to the player. 1510Sends an ext reply to the player.
1221 1511
1222=cut 1512=cut
1223 1513
1224sub ext_reply($$%) { 1514sub ext_reply($$@) {
1225 my ($self, $id, %msg) = @_; 1515 my ($self, $id, @msg) = @_;
1226 1516
1227 $msg{msgid} = $id; 1517 $self->ns->ext_reply ($id, @msg)
1228
1229 $self->send ("ext " . cf::to_json \%msg);
1230} 1518}
1231 1519
1232=item $player->ext_event ($type, %msg) 1520=item $player->ext_msg ($type, @msg)
1233 1521
1234Sends an ext event to the client. 1522Sends an ext event to the client.
1235 1523
1236=cut 1524=cut
1237 1525
1238sub ext_event($$%) { 1526sub ext_msg($$@) {
1239 my ($self, $type, %msg) = @_; 1527 my ($self, $type, @msg) = @_;
1240 1528
1241 $self->ns->ext_event ($type, %msg); 1529 $self->ns->ext_msg ($type, @msg);
1242} 1530}
1243 1531
1244=head3 cf::region 1532=head3 cf::region
1245 1533
1246=over 4 1534=over 4
1249 1537
1250package cf::region; 1538package cf::region;
1251 1539
1252=item cf::region::find_by_path $path 1540=item cf::region::find_by_path $path
1253 1541
1254Tries to decuce the probable region for a map knowing only its path. 1542Tries to decuce the likely region for a map knowing only its path.
1255 1543
1256=cut 1544=cut
1257 1545
1258sub find_by_path($) { 1546sub find_by_path($) {
1259 my ($path) = @_; 1547 my ($path) = @_;
1260 1548
1261 my ($match, $specificity); 1549 my ($match, $specificity);
1262 1550
1263 for my $region (list) { 1551 for my $region (list) {
1264 if ($region->match && $path =~ $region->match) { 1552 if ($region->{match} && $path =~ $region->{match}) {
1265 ($match, $specificity) = ($region, $region->specificity) 1553 ($match, $specificity) = ($region, $region->specificity)
1266 if $region->specificity > $specificity; 1554 if $region->specificity > $specificity;
1267 } 1555 }
1268 } 1556 }
1269 1557
1389 $self->init; # pass $1 etc. 1677 $self->init; # pass $1 etc.
1390 return $self; 1678 return $self;
1391 } 1679 }
1392 } 1680 }
1393 1681
1394 Carp::carp "unable to resolve path '$path' (base '$base')."; 1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1395 () 1683 ()
1396} 1684}
1397 1685
1398sub init { 1686sub init {
1399 my ($self) = @_; 1687 my ($self) = @_;
1565 local $self->{deny_reset} = 1; # loading can take a long time 1853 local $self->{deny_reset} = 1; # loading can take a long time
1566 1854
1567 my $path = $self->{path}; 1855 my $path = $self->{path};
1568 1856
1569 { 1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1570 my $guard = cf::lock_acquire "map_load:$path"; 1859 my $guard2 = cf::lock_acquire "map_load:$path";
1571 1860
1572 return if $self->in_memory != cf::MAP_SWAPPED; 1861 return if $self->in_memory != cf::MAP_SWAPPED;
1573 1862
1574 $self->in_memory (cf::MAP_LOADING); 1863 $self->in_memory (cf::MAP_LOADING);
1575 1864
1576 $self->alloc; 1865 $self->alloc;
1577 1866
1578 $self->pre_load; 1867 $self->pre_load;
1579 Coro::cede; 1868 cf::cede_to_tick;
1580 1869
1581 $self->_load_objects ($self->{load_path}, 1) 1870 $self->_load_objects ($self->{load_path}, 1)
1582 or return; 1871 or return;
1583 1872
1584 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1590 $self->clear_unique_items; 1879 $self->clear_unique_items;
1591 $self->_load_objects ($uniq, 0); 1880 $self->_load_objects ($uniq, 0);
1592 } 1881 }
1593 } 1882 }
1594 1883
1595 Coro::cede; 1884 cf::cede_to_tick;
1596 # now do the right thing for maps 1885 # now do the right thing for maps
1597 $self->link_multipart_objects; 1886 $self->link_multipart_objects;
1598 $self->difficulty ($self->estimate_difficulty) 1887 $self->difficulty ($self->estimate_difficulty)
1599 unless $self->difficulty; 1888 unless $self->difficulty;
1600 Coro::cede; 1889 cf::cede_to_tick;
1601 1890
1602 unless ($self->{deny_activate}) { 1891 unless ($self->{deny_activate}) {
1603 $self->decay_objects; 1892 $self->decay_objects;
1604 $self->fix_auto_apply; 1893 $self->fix_auto_apply;
1605 $self->update_buttons; 1894 $self->update_buttons;
1606 Coro::cede; 1895 cf::cede_to_tick;
1607 $self->set_darkness_map; 1896 $self->set_darkness_map;
1608 Coro::cede; 1897 cf::cede_to_tick;
1609 $self->activate; 1898 $self->activate;
1610 } 1899 }
1900
1901 $self->{last_save} = $cf::RUNTIME;
1902 $self->last_access ($cf::RUNTIME);
1611 1903
1612 $self->in_memory (cf::MAP_IN_MEMORY); 1904 $self->in_memory (cf::MAP_IN_MEMORY);
1613 } 1905 }
1614 1906
1615 $self->post_load; 1907 $self->post_load;
1626 1918
1627 $self 1919 $self
1628} 1920}
1629 1921
1630# find and load all maps in the 3x3 area around a map 1922# find and load all maps in the 3x3 area around a map
1631sub load_diag { 1923sub load_neighbours {
1632 my ($map) = @_; 1924 my ($map) = @_;
1633 1925
1634 my @diag; # diagonal neighbours 1926 my @neigh; # diagonal neighbours
1635 1927
1636 for (0 .. 3) { 1928 for (0 .. 3) {
1637 my $neigh = $map->tile_path ($_) 1929 my $neigh = $map->tile_path ($_)
1638 or next; 1930 or next;
1639 $neigh = find $neigh, $map 1931 $neigh = find $neigh, $map
1640 or next; 1932 or next;
1641 $neigh->load; 1933 $neigh->load;
1642 1934
1935 push @neigh,
1643 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1644 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1645 } 1938 }
1646 1939
1647 for (@diag) { 1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1648 my $neigh = find @$_ 1942 my $neigh = find $path, $origin
1649 or next; 1943 or next;
1650 $neigh->load; 1944 $neigh->load;
1651 } 1945 }
1652} 1946}
1653 1947
1658} 1952}
1659 1953
1660sub do_load_sync { 1954sub do_load_sync {
1661 my ($map) = @_; 1955 my ($map) = @_;
1662 1956
1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1958 if $Coro::current == $Coro::main;
1959
1663 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1664} 1961}
1665 1962
1666our %MAP_PREFETCH; 1963our %MAP_PREFETCH;
1667our $MAP_PREFETCHER = undef; 1964our $MAP_PREFETCHER = undef;
1668 1965
1669sub find_async { 1966sub find_async {
1670 my ($path, $origin) = @_; 1967 my ($path, $origin, $load) = @_;
1671 1968
1672 $path = normalise $path, $origin && $origin->{path}; 1969 $path = normalise $path, $origin && $origin->{path};
1673 1970
1674 if (my $map = $cf::MAP{$path}) { 1971 if (my $map = $cf::MAP{$path}) {
1675 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676 } 1973 }
1677 1974
1678 undef $MAP_PREFETCH{$path}; 1975 $MAP_PREFETCH{$path} |= $load;
1976
1679 $MAP_PREFETCHER ||= cf::async { 1977 $MAP_PREFETCHER ||= cf::async {
1680 while (%MAP_PREFETCH) { 1978 while (%MAP_PREFETCH) {
1681 for my $path (keys %MAP_PREFETCH) { 1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1682 my $map = find $path 1980 if (my $map = find $k) {
1683 or next;
1684 $map->load; 1981 $map->load if $v;
1982 }
1685 1983
1686 delete $MAP_PREFETCH{$path}; 1984 delete $MAP_PREFETCH{$k};
1687 } 1985 }
1688 } 1986 }
1689 undef $MAP_PREFETCHER; 1987 undef $MAP_PREFETCHER;
1690 }; 1988 };
1691 $MAP_PREFETCHER->prio (6); 1989 $MAP_PREFETCHER->prio (6);
1694} 1992}
1695 1993
1696sub save { 1994sub save {
1697 my ($self) = @_; 1995 my ($self) = @_;
1698 1996
1699 my $lock = cf::lock_acquire "map_data:" . $self->path; 1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1700 1998
1701 $self->{last_save} = $cf::RUNTIME; 1999 $self->{last_save} = $cf::RUNTIME;
1702 2000
1703 return unless $self->dirty; 2001 return unless $self->dirty;
1704 2002
1727 my ($self) = @_; 2025 my ($self) = @_;
1728 2026
1729 # save first because save cedes 2027 # save first because save cedes
1730 $self->save; 2028 $self->save;
1731 2029
1732 my $lock = cf::lock_acquire "map_data:" . $self->path; 2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
1733 2031
1734 return if $self->players; 2032 return if $self->players;
1735 return if $self->in_memory != cf::MAP_IN_MEMORY; 2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
1736 return if $self->{deny_save}; 2034 return if $self->{deny_save};
1737 2035
1789my $nuke_counter = "aaaa"; 2087my $nuke_counter = "aaaa";
1790 2088
1791sub nuke { 2089sub nuke {
1792 my ($self) = @_; 2090 my ($self) = @_;
1793 2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
1794 delete $cf::MAP{$self->path}; 2095 delete $cf::MAP{$self->path};
1795 2096
1796 $self->unlink_save; 2097 $self->unlink_save;
1797 2098
1798 bless $self, "cf::map"; 2099 bless $self, "cf::map";
1799 delete $self->{deny_reset}; 2100 delete $self->{deny_reset};
1800 $self->{deny_save} = 1; 2101 $self->{deny_save} = 1;
1801 $self->reset_timeout (1); 2102 $self->reset_timeout (1);
1802 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1803 2104
1804 $cf::MAP{$self->path} = $self; 2105 $cf::MAP{$self->path} = $self;
2106 }
1805 2107
1806 $self->reset; # polite request, might not happen 2108 $self->reset; # polite request, might not happen
1807} 2109}
1808 2110
1809=item $maps = cf::map::tmp_maps 2111=item $maps = cf::map::tmp_maps
1911 2213
1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913 2215
1914 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
1915 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
1916 } else { 2219 } else {
2220 my $pl = $self->contr;
2221
2222 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2223 my $dialog = $pl->{npc_dialog};
2224 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2225
2226 } else {
1917 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1918 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1919 } 2230 }
2231}
2232
2233=item $object->send_msg ($channel, $msg, $color, [extra...])
2234
2235=cut
2236
2237sub cf::object::send_msg {
2238 my $pl = shift->contr
2239 or return;
2240 $pl->send_msg (@_);
1920} 2241}
1921 2242
1922=item $player_object->may ("access") 2243=item $player_object->may ("access")
1923 2244
1924Returns wether the given player is authorized to access resource "access" 2245Returns wether the given player is authorized to access resource "access"
2003 # use -1 or undef as default coordinates, not 0, 0 2324 # use -1 or undef as default coordinates, not 0, 0
2004 ($x, $y) = ($map->enter_x, $map->enter_y) 2325 ($x, $y) = ($map->enter_x, $map->enter_y)
2005 if $x <=0 && $y <= 0; 2326 if $x <=0 && $y <= 0;
2006 2327
2007 $map->load; 2328 $map->load;
2008 $map->load_diag; 2329 $map->load_neighbours;
2009 2330
2010 return unless $self->contr->active; 2331 return unless $self->contr->active;
2011 $self->activate_recursive; 2332 $self->activate_recursive;
2012 2333
2013 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014 $self->enter_map ($map, $x, $y); 2335 $self->enter_map ($map, $x, $y);
2015} 2336}
2016 2337
2017=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018 2339
2019Moves the player to the given map-path and coordinates by first freezing 2340Moves the player to the given map-path and coordinates by first freezing
2020her, loading and preparing them map, calling the provided $check callback 2341her, loading and preparing them map, calling the provided $check callback
2021that has to return the map if sucecssful, and then unfreezes the player on 2342that has to return the map if sucecssful, and then unfreezes the player on
2022the new (success) or old (failed) map position. 2343the new (success) or old (failed) map position. In either case, $done will
2344be called at the end of this process.
2023 2345
2024=cut 2346=cut
2025 2347
2026our $GOTOGEN; 2348our $GOTOGEN;
2027 2349
2028sub cf::object::player::goto { 2350sub cf::object::player::goto {
2029 my ($self, $path, $x, $y, $check) = @_; 2351 my ($self, $path, $x, $y, $check, $done) = @_;
2030 2352
2031 # do generation counting so two concurrent goto's will be executed in-order 2353 # do generation counting so two concurrent goto's will be executed in-order
2032 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2354 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033 2355
2034 $self->enter_link; 2356 $self->enter_link;
2054 2376
2055 if ($gen == $self->{_goto_generation}) { 2377 if ($gen == $self->{_goto_generation}) {
2056 delete $self->{_goto_generation}; 2378 delete $self->{_goto_generation};
2057 $self->leave_link ($map, $x, $y); 2379 $self->leave_link ($map, $x, $y);
2058 } 2380 }
2381
2382 $done->() if $done;
2059 })->prio (1); 2383 })->prio (1);
2060} 2384}
2061 2385
2062=item $player_object->enter_exit ($exit_object) 2386=item $player_object->enter_exit ($exit_object)
2063 2387
2132 my $hp = $exit->stats->hp; 2456 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp; 2457 my $sp = $exit->stats->sp;
2134 2458
2135 $self->enter_link; 2459 $self->enter_link;
2136 2460
2461 # if exit is damned, update players death & WoR home-position
2462 $self->contr->savebed ($slaying, $hp, $sp)
2463 if $exit->flag (FLAG_DAMNED);
2464
2137 (async { 2465 (async {
2138 $self->deactivate_recursive; # just to be sure 2466 $self->deactivate_recursive; # just to be sure
2139 unless (eval { 2467 unless (eval {
2140 $self->goto ($slaying, $hp, $sp); 2468 $self->goto ($slaying, $hp, $sp);
2141 2469
2168 2496
2169 utf8::encode $text; 2497 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171} 2499}
2172 2500
2501=item $client->send_msg ($channel, $msg, $color, [extra...])
2502
2503Send a drawinfo or msg packet to the client, formatting the msg for the
2504client if neccessary. C<$type> should be a string identifying the type of
2505the message, with C<log> being the default. If C<$color> is negative, suppress
2506the message unless the client supports the msg packet.
2507
2508=cut
2509
2510our %CHANNEL = (
2511 "c/identify" => {
2512 id => "identify",
2513 title => "Identify",
2514 reply => undef,
2515 tooltip => "Items recently identified",
2516 },
2517 "c/examine" => {
2518 id => "examine",
2519 title => "Examine",
2520 reply => undef,
2521 tooltip => "Signs and other items you examined",
2522 },
2523);
2524
2525sub cf::client::send_msg {
2526 my ($self, $channel, $msg, $color, @extra) = @_;
2527
2528 $msg = $self->pl->expand_cfpod ($msg);
2529
2530 $color &= cf::NDI_CLIENT_MASK; # just in case...
2531
2532 # check predefined channels, for the benefit of C
2533 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2534
2535 if (ref $channel) {
2536 # send meta info to client, if not yet sent
2537 unless (exists $self->{channel}{$channel->{id}}) {
2538 $self->{channel}{$channel->{id}} = $channel;
2539 $self->ext_msg (channel_info => $channel);
2540 }
2541
2542 $channel = $channel->{id};
2543 }
2544
2545 return unless @extra || length $msg;
2546
2547 if ($self->can_msg) {
2548 # default colour, mask it out
2549 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2550 if $color & cf::NDI_DEF;
2551
2552 $self->send_packet ("msg " . $self->{json_coder}->encode (
2553 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2554 } else {
2555 if ($color >= 0) {
2556 # replace some tags by gcfclient-compatible ones
2557 for ($msg) {
2558 1 while
2559 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2560 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2561 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2562 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2563 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2564 }
2565
2566 $color &= cf::NDI_COLOR_MASK;
2567
2568 utf8::encode $msg;
2569
2570 if (0 && $msg =~ /\[/) {
2571 # COMMAND/INFO
2572 $self->send_packet ("drawextinfo $color 10 8 $msg")
2573 } else {
2574 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2575 $self->send_packet ("drawinfo $color $msg")
2576 }
2577 }
2578 }
2579}
2580
2173=item $client->ext_event ($type, %msg) 2581=item $client->ext_msg ($type, @msg)
2174 2582
2175Sends an exti event to the client. 2583Sends an ext event to the client.
2176 2584
2177=cut 2585=cut
2178 2586
2179sub cf::client::ext_event($$%) { 2587sub cf::client::ext_msg($$@) {
2180 my ($self, $type, %msg) = @_; 2588 my ($self, $type, @msg) = @_;
2181 2589
2590 if ($self->extcmd == 2) {
2591 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2592 } elsif ($self->extcmd == 1) { # TODO: remove
2182 $msg{msgtype} = "event_$type"; 2593 push @msg, msgtype => "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg); 2594 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2595 }
2596}
2597
2598=item $client->ext_reply ($msgid, @msg)
2599
2600Sends an ext reply to the client.
2601
2602=cut
2603
2604sub cf::client::ext_reply($$@) {
2605 my ($self, $id, @msg) = @_;
2606
2607 if ($self->extcmd == 2) {
2608 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2609 } elsif ($self->extcmd == 1) {
2610 #TODO: version 1, remove
2611 unshift @msg, msgtype => "reply", msgid => $id;
2612 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2613 }
2184} 2614}
2185 2615
2186=item $success = $client->query ($flags, "text", \&cb) 2616=item $success = $client->query ($flags, "text", \&cb)
2187 2617
2188Queues a query to the client, calling the given callback with 2618Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2619the 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>. 2620C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191 2621
2192Queries can fail, so check the return code. Or don't, as queries will become 2622Queries can fail, so check the return code. Or don't, as queries will
2193reliable at some point in the future. 2623become reliable at some point in the future.
2194 2624
2195=cut 2625=cut
2196 2626
2197sub cf::client::query { 2627sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_; 2628 my ($self, $flags, $text, $cb) = @_;
2206 utf8::encode $text; 2636 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2637 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208 2638
2209 $self->send_packet ($self->{query_queue}[0][0]) 2639 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1; 2640 if @{ $self->{query_queue} } == 1;
2641
2642 1
2211} 2643}
2212 2644
2213cf::client->attach ( 2645cf::client->attach (
2646 on_connect => sub {
2647 my ($ns) = @_;
2648
2649 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2650 },
2214 on_reply => sub { 2651 on_reply => sub {
2215 my ($ns, $msg) = @_; 2652 my ($ns, $msg) = @_;
2216 2653
2217 # this weird shuffling is so that direct followup queries 2654 # this weird shuffling is so that direct followup queries
2218 # get handled first 2655 # get handled first
2230 } else { 2667 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2668 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 } 2669 }
2233 } 2670 }
2234 }, 2671 },
2672 on_exticmd => sub {
2673 my ($ns, $buf) = @_;
2674
2675 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2676
2677 if (ref $msg) {
2678 my ($type, $reply, @payload) =
2679 "ARRAY" eq ref $msg
2680 ? @$msg
2681 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2682
2683 my @reply;
2684
2685 if (my $cb = $EXTICMD{$type}) {
2686 @reply = $cb->($ns, @payload);
2687 }
2688
2689 $ns->ext_reply ($reply, @reply)
2690 if $reply;
2691
2692 } else {
2693 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2694 }
2695
2696 cf::override;
2697 },
2235); 2698);
2236 2699
2237=item $client->async (\&cb) 2700=item $client->async (\&cb)
2238 2701
2239Create a new coroutine, running the specified callback. The coroutine will 2702Create a new coroutine, running the specified callback. The coroutine will
2280our $safe = new Safe "safe"; 2743our $safe = new Safe "safe";
2281our $safe_hole = new Safe::Hole; 2744our $safe_hole = new Safe::Hole;
2282 2745
2283$SIG{FPE} = 'IGNORE'; 2746$SIG{FPE} = 'IGNORE';
2284 2747
2285$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2748$safe->permit_only (Opcode::opset qw(
2749 :base_core :base_mem :base_orig :base_math
2750 grepstart grepwhile mapstart mapwhile
2751 sort time
2752));
2286 2753
2287# here we export the classes and methods available to script code 2754# here we export the classes and methods available to script code
2288 2755
2289=pod 2756=pod
2290 2757
2291The following functions and methods are available within a safe environment: 2758The following functions and methods are available within a safe environment:
2292 2759
2293 cf::object contr pay_amount pay_player map 2760 cf::object
2761 contr pay_amount pay_player map x y force_find force_add
2762 insert remove name archname title slaying race decrease_ob_nr
2763
2294 cf::object::player player 2764 cf::object::player
2295 cf::player peaceful 2765 player
2296 cf::map trigger 2766
2767 cf::player
2768 peaceful
2769
2770 cf::map
2771 trigger
2297 2772
2298=cut 2773=cut
2299 2774
2300for ( 2775for (
2301 ["cf::object" => qw(contr pay_amount pay_player map)], 2776 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2777 insert remove inv name archname title slaying race
2778 decrease_ob_nr)],
2302 ["cf::object::player" => qw(player)], 2779 ["cf::object::player" => qw(player)],
2303 ["cf::player" => qw(peaceful)], 2780 ["cf::player" => qw(peaceful)],
2304 ["cf::map" => qw(trigger)], 2781 ["cf::map" => qw(trigger)],
2305) { 2782) {
2306 no strict 'refs'; 2783 no strict 'refs';
2377=back 2854=back
2378 2855
2379=cut 2856=cut
2380 2857
2381############################################################################# 2858#############################################################################
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 2859# the server's init and main functions
2555 2860
2556sub load_facedata($) { 2861sub load_facedata($) {
2557 my ($path) = @_; 2862 my ($path) = @_;
2863
2864 # HACK to clear player env face cache, we need some signal framework
2865 # for this (global event?)
2866 %ext::player_env::MUSIC_FACE_CACHE = ();
2867
2868 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2558 2869
2559 warn "loading facedata from $path\n"; 2870 warn "loading facedata from $path\n";
2560 2871
2561 my $facedata; 2872 my $facedata;
2562 0 < aio_load $path, $facedata 2873 0 < aio_load $path, $facedata
2565 $facedata = Coro::Storable::thaw $facedata; 2876 $facedata = Coro::Storable::thaw $facedata;
2566 2877
2567 $facedata->{version} == 2 2878 $facedata->{version} == 2
2568 or cf::cleanup "$path: version mismatch, cannot proceed."; 2879 or cf::cleanup "$path: version mismatch, cannot proceed.";
2569 2880
2881 # patch in the exptable
2882 $facedata->{resource}{"res/exp_table"} = {
2883 type => FT_RSRC,
2884 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2885 };
2886 cf::cede_to_tick;
2887
2570 { 2888 {
2571 my $faces = $facedata->{faceinfo}; 2889 my $faces = $facedata->{faceinfo};
2572 2890
2573 while (my ($face, $info) = each %$faces) { 2891 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2892 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2893 cf::face::set_visibility $idx, $info->{visibility};
2894 cf::face::set_magicmap $idx, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2895 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2896 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578 Coro::cede; 2897
2898 cf::cede_to_tick;
2579 } 2899 }
2580 2900
2581 while (my ($face, $info) = each %$faces) { 2901 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth}; 2902 next unless $info->{smooth};
2583 my $idx = cf::face::find $face 2903 my $idx = cf::face::find $face
2584 or next; 2904 or next;
2585 if (my $smooth = cf::face::find $info->{smooth}) { 2905 if (my $smooth = cf::face::find $info->{smooth}) {
2906 cf::face::set_smooth $idx, $smooth;
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2907 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587 } else { 2908 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2909 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 } 2910 }
2590 Coro::cede; 2911
2912 cf::cede_to_tick;
2591 } 2913 }
2592 } 2914 }
2593 2915
2594 { 2916 {
2595 my $anims = $facedata->{animinfo}; 2917 my $anims = $facedata->{animinfo};
2596 2918
2597 while (my ($anim, $info) = each %$anims) { 2919 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2920 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede; 2921 cf::cede_to_tick;
2600 } 2922 }
2601 2923
2602 cf::anim::invalidate_all; # d'oh 2924 cf::anim::invalidate_all; # d'oh
2603 } 2925 }
2604 2926
2927 {
2928 # TODO: for gcfclient pleasure, we should give resources
2929 # that gcfclient doesn't grok a >10000 face index.
2930 my $res = $facedata->{resource};
2931
2932 my $soundconf = delete $res->{"res/sound.conf"};
2933
2934 while (my ($name, $info) = each %$res) {
2935 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2936 my $data;
2937
2938 if ($info->{type} & 1) {
2939 # prepend meta info
2940
2941 my $meta = $enc->encode ({
2942 name => $name,
2943 %{ $info->{meta} || {} },
2944 });
2945
2946 $data = pack "(w/a*)*", $meta, $info->{data};
2947 } else {
2948 $data = $info->{data};
2949 }
2950
2951 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2952 cf::face::set_type $idx, $info->{type};
2953
2954 cf::cede_to_tick;
2955 }
2956
2957 if ($soundconf) {
2958 $soundconf = $enc->decode (delete $soundconf->{data});
2959
2960 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2961 my $sound = $soundconf->{compat}[$_]
2962 or next;
2963
2964 my $face = cf::face::find "sound/$sound->[1]";
2965 cf::sound::set $sound->[0] => $face;
2966 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2967 }
2968
2969 while (my ($k, $v) = each %{$soundconf->{event}}) {
2970 my $face = cf::face::find "sound/$v";
2971 cf::sound::set $k => $face;
2972 }
2973 }
2974 }
2975
2605 1 2976 1
2606} 2977}
2607 2978
2979register_exticmd fx_want => sub {
2980 my ($ns, $want) = @_;
2981
2982 while (my ($k, $v) = each %$want) {
2983 $ns->fx_want ($k, $v);
2984 }
2985};
2986
2608sub reload_regions { 2987sub reload_regions {
2988 # HACK to clear player env face cache, we need some signal framework
2989 # for this (global event?)
2990 %ext::player_env::MUSIC_FACE_CACHE = ();
2991
2609 load_resource_file "$MAPDIR/regions" 2992 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n"; 2993 or die "unable to load regions file\n";
2994
2995 for (cf::region::list) {
2996 $_->{match} = qr/$_->{match}/
2997 if exists $_->{match};
2998 }
2611} 2999}
2612 3000
2613sub reload_facedata { 3001sub reload_facedata {
2614 load_facedata "$DATADIR/facedata" 3002 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n"; 3003 or die "unable to load facedata\n";
2616} 3004}
2617 3005
2618sub reload_archetypes { 3006sub reload_archetypes {
3007 load_resource_file "$DATADIR/archetypes"
3008 or die "unable to load archetypes\n";
3009 #d# NEED to laod twice to resolve forward references
3010 # this really needs to be done in an extra post-pass
3011 # (which needs to be synchronous, so solve it differently)
2619 load_resource_file "$DATADIR/archetypes" 3012 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n"; 3013 or die "unable to load archetypes\n";
2621} 3014}
2622 3015
2623sub reload_treasures { 3016sub reload_treasures {
2639 3032
2640sub init { 3033sub init {
2641 reload_resources; 3034 reload_resources;
2642} 3035}
2643 3036
2644sub cfg_load { 3037sub reload_config {
2645 open my $fh, "<:utf8", "$CONFDIR/config" 3038 open my $fh, "<:utf8", "$CONFDIR/config"
2646 or return; 3039 or return;
2647 3040
2648 local $/; 3041 local $/;
2649 *CFG = YAML::Syck::Load <$fh>; 3042 *CFG = YAML::Syck::Load <$fh>;
2669 (async { 3062 (async {
2670 Event::one_event; 3063 Event::one_event;
2671 })->prio (Coro::PRIO_MAX); 3064 })->prio (Coro::PRIO_MAX);
2672 }; 3065 };
2673 3066
2674 cfg_load; 3067 reload_config;
2675 db_init; 3068 db_init;
2676 load_extensions; 3069 load_extensions;
2677 3070
2678 $TICK_WATCHER->start; 3071 $TICK_WATCHER->start;
2679 Event::loop; 3072 Event::loop;
2695 }, 3088 },
2696 ); 3089 );
2697 } 3090 }
2698} 3091}
2699 3092
3093sub write_runtime {
3094 my $runtime = "$LOCALDIR/runtime";
3095
3096 # first touch the runtime file to show we are still running:
3097 # the fsync below can take a very very long time.
3098
3099 IO::AIO::aio_utime $runtime, undef, undef;
3100
3101 my $guard = cf::lock_acquire "write_runtime";
3102
3103 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3104 or return;
3105
3106 my $value = $cf::RUNTIME + 90 + 10;
3107 # 10 is the runtime save interval, for a monotonic clock
3108 # 60 allows for the watchdog to kill the server.
3109
3110 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3111 and return;
3112
3113 # always fsync - this file is important
3114 aio_fsync $fh
3115 and return;
3116
3117 # touch it again to show we are up-to-date
3118 aio_utime $fh, undef, undef;
3119
3120 close $fh
3121 or return;
3122
3123 aio_rename "$runtime~", $runtime
3124 and return;
3125
3126 warn "runtime file written.\n";
3127
3128 1
3129}
3130
2700sub emergency_save() { 3131sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop; 3132 my $freeze_guard = cf::freeze_mainloop;
2702 3133
2703 warn "enter emergency perl save\n"; 3134 warn "enter emergency perl save\n";
2704 3135
2779 %EXT_CORO = (); 3210 %EXT_CORO = ();
2780 3211
2781 warn "removing commands"; 3212 warn "removing commands";
2782 %COMMAND = (); 3213 %COMMAND = ();
2783 3214
2784 warn "removing ext commands"; 3215 warn "removing ext/exti commands";
2785 %EXTCMD = (); 3216 %EXTCMD = ();
3217 %EXTICMD = ();
2786 3218
2787 warn "unloading/nuking all extensions"; 3219 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) { 3220 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg"; 3221 warn "... unloading $pkg";
2790 3222
2833 warn "reloading cf.pm"; 3265 warn "reloading cf.pm";
2834 require cf; 3266 require cf;
2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3267 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2836 3268
2837 warn "loading config and database again"; 3269 warn "loading config and database again";
2838 cf::cfg_load; 3270 cf::reload_config;
2839 3271
2840 warn "loading extensions"; 3272 warn "loading extensions";
2841 cf::load_extensions; 3273 cf::load_extensions;
2842 3274
2843 warn "reattaching attachments to objects/players"; 3275 warn "reattaching attachments to objects/players";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines