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.269 by root, Tue May 22 21:35:26 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines