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.266 by root, Fri May 18 01:01:02 2007 UTC vs.
Revision 1.317 by root, Mon Jul 23 23:38:17 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
627 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
628 840
629 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
630 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
631 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
632 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633 845
634 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
635 my $pkg = shift @arg; 847 my $pkg = shift @arg;
636 848
637 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
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
678 if (ref $_[0]) { 890 if (ref $_[0]) {
679 _object_attach @_; 891 _object_attach @_;
680 } else { 892 } else {
681 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
682 } 894 }
895 _recalc_want;
683}; 896};
684 897
685# all those should be optimised 898# all those should be optimised
686sub cf::attachable::detach { 899sub cf::attachable::detach {
687 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
690 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
691 reattach ($obj); 904 reattach ($obj);
692 } else { 905 } else {
693 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
694 } 907 }
908 _recalc_want;
695}; 909};
696 910
697sub cf::attachable::attached { 911sub cf::attachable::attached {
698 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
699 913
714 "; 928 ";
715 die if $@; 929 die if $@;
716} 930}
717 931
718our $override; 932our $override;
719our @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?
720 934
721sub override { 935sub override {
722 $override = 1; 936 $override = 1;
723 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
724} 938}
725 939
726sub do_invoke { 940sub do_invoke {
727 my $event = shift; 941 my $event = shift;
728 my $callbacks = shift; 942 my $callbacks = shift;
729 943
730 @invoke_results = (); 944 @INVOKE_RESULTS = ();
731 945
732 local $override; 946 local $override;
733 947
734 for (@$callbacks) { 948 for (@$callbacks) {
735 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
752 966
753Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
754 968
755This 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
756removed 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
757results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758 972
759=back 973=back
760 974
761=cut 975=cut
762 976
763############################################################################# 977#############################################################################
764# 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}
765 990
766sub reattach { 991sub reattach {
767 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
768 my ($obj) = @_; 993 my ($obj) = @_;
769 994
872 or return; 1097 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1099 }
875 1100
876 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1103 return ($data, $av);
879} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
880 1111
881############################################################################# 1112#############################################################################
882# command handling &c 1113# command handling &c
883 1114
884=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1129}
899 1130
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1132
902Register 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.
903 1138
904If 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
905called. 1140called.
906 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
907=cut 1153=cut
908 1154
909sub register_extcmd { 1155sub register_extcmd {
910 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
911 1157
912 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
913} 1165}
914 1166
915cf::player->attach ( 1167cf::player->attach (
916 on_command => sub { 1168 on_command => sub {
917 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
926 cf::override; 1178 cf::override;
927 }, 1179 },
928 on_extcmd => sub { 1180 on_extcmd => sub {
929 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
930 1182
931 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932 1184
933 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
934 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
935 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
936 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
937 } 1195 if $reply;
938 } 1196 }
939 } else { 1197 } else {
940 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
941 } 1199 }
942 1200
943 cf::override; 1201 cf::override;
944 }, 1202 },
945); 1203);
946 1204
947sub load_extension {
948 my ($path) = @_;
949
950 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
951 my $base = $1;
952 my $pkg = $1;
953 $pkg =~ s/[^[:word:]]/_/g;
954 $pkg = "ext::$pkg";
955
956 warn "... loading '$path' into '$pkg'\n";
957
958 open my $fh, "<:utf8", $path
959 or die "$path: $!";
960
961 my $source =
962 "package $pkg; use strict; use utf8;\n"
963 . "#line 1 \"$path\"\n{\n"
964 . (do { local $/; <$fh> })
965 . "\n};\n1";
966
967 unless (eval $source) {
968 my $msg = $@ ? "$path: $@\n"
969 : "extension disabled.\n";
970 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
971 warn $@;
972 warn "mandatory extension failed to load, exiting.\n";
973 exit 1;
974 }
975 die $@;
976 }
977
978 push @EXTS, $pkg;
979}
980
981sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
982 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1210 next unless -r $path;
984 eval { 1211
985 load_extension $ext; 1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
986 1 1269 }
987 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
988 } 1275 };
989} 1276}
990 1277
991############################################################################# 1278#############################################################################
1279
1280=back
992 1281
993=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
994 1283
995Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
996 1285
1184 } 1473 }
1185 1474
1186 \@paths 1475 \@paths
1187} 1476}
1188 1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1189=item $player->ext_reply ($msgid, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1190 1529
1191Sends an ext reply to the player. 1530Sends an ext reply to the player.
1192 1531
1193=cut 1532=cut
1194 1533
1195sub ext_reply($$%) { 1534sub ext_reply($$@) {
1196 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1197 1536
1198 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1199 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1200 $self->send ("ext " . cf::to_json \%msg); 1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1201} 1544}
1202 1545
1203=item $player->ext_event ($type, %msg) 1546=item $player->ext_msg ($type, @msg)
1204 1547
1205Sends an ext event to the client. 1548Sends an ext event to the client.
1206 1549
1207=cut 1550=cut
1208 1551
1209sub ext_event($$%) { 1552sub ext_msg($$@) {
1210 my ($self, $type, %msg) = @_; 1553 my ($self, $type, @msg) = @_;
1211 1554
1212 $self->ns->ext_event ($type, %msg); 1555 $self->ns->ext_msg ($type, @msg);
1213} 1556}
1214 1557
1215=head3 cf::region 1558=head3 cf::region
1216 1559
1217=over 4 1560=over 4
1220 1563
1221package cf::region; 1564package cf::region;
1222 1565
1223=item cf::region::find_by_path $path 1566=item cf::region::find_by_path $path
1224 1567
1225Tries to decuce the probable region for a map knowing only its path. 1568Tries to decuce the likely region for a map knowing only its path.
1226 1569
1227=cut 1570=cut
1228 1571
1229sub find_by_path($) { 1572sub find_by_path($) {
1230 my ($path) = @_; 1573 my ($path) = @_;
1231 1574
1232 my ($match, $specificity); 1575 my ($match, $specificity);
1233 1576
1234 for my $region (list) { 1577 for my $region (list) {
1235 if ($region->match && $path =~ $region->match) { 1578 if ($region->{match} && $path =~ $region->{match}) {
1236 ($match, $specificity) = ($region, $region->specificity) 1579 ($match, $specificity) = ($region, $region->specificity)
1237 if $region->specificity > $specificity; 1580 if $region->specificity > $specificity;
1238 } 1581 }
1239 } 1582 }
1240 1583
1304 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1305 1648
1306 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1307 local $self->{path}; 1650 local $self->{path};
1308 local $self->{load_path}; 1651 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1652
1312 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1313} 1654}
1314 1655
1315sub normalise { 1656sub normalise {
1362 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1363 return $self; 1704 return $self;
1364 } 1705 }
1365 } 1706 }
1366 1707
1367 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1368 () 1709 ()
1369} 1710}
1370 1711
1371sub init { 1712sub init {
1372 my ($self) = @_; 1713 my ($self) = @_;
1413sub change_all_map_light { 1754sub change_all_map_light {
1414 my ($change) = @_; 1755 my ($change) = @_;
1415 1756
1416 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1759}
1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1418} 1767}
1419 1768
1420sub unlink_save { 1769sub unlink_save {
1421 my ($self) = @_; 1770 my ($self) = @_;
1422 1771
1480 $self->load_header_orig 1829 $self->load_header_orig
1481 or return; 1830 or return;
1482 $self->prepare_orig; 1831 $self->prepare_orig;
1483 } 1832 }
1484 1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1837 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1838 unless $self->default_region;
1487 1839
1488 1 1840 1
1489} 1841}
1504 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1505 1857
1506 $map->load_header 1858 $map->load_header
1507 or return; 1859 or return;
1508 1860
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1864 $map->reset;
1513 undef $guard; 1865 undef $guard;
1514 return find $path; 1866 return find $path;
1581 my ($self, $ob) = @_; 1933 my ($self, $ob) = @_;
1582 1934
1583 return find "~" . $ob->name . "/" . $self->{path} 1935 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1936 if $self->per_player;
1585 1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1940
1586 $self 1941 $self
1587} 1942}
1588 1943
1589# find and load all maps in the 3x3 area around a map 1944# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1945sub load_diag {
1636 1991
1637 undef $MAP_PREFETCH{$path}; 1992 undef $MAP_PREFETCH{$path};
1638 $MAP_PREFETCHER ||= cf::async { 1993 $MAP_PREFETCHER ||= cf::async {
1639 while (%MAP_PREFETCH) { 1994 while (%MAP_PREFETCH) {
1640 for my $path (keys %MAP_PREFETCH) { 1995 for my $path (keys %MAP_PREFETCH) {
1641 my $map = find $path 1996 if (my $map = find $path) {
1642 or next;
1643 $map->load; 1997 $map->load;
1998 }
1644 1999
1645 delete $MAP_PREFETCH{$path}; 2000 delete $MAP_PREFETCH{$path};
1646 } 2001 }
1647 } 2002 }
1648 undef $MAP_PREFETCHER; 2003 undef $MAP_PREFETCHER;
1700 2055
1701sub reset_at { 2056sub reset_at {
1702 my ($self) = @_; 2057 my ($self) = @_;
1703 2058
1704 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1705 return 1e99 if $self->isa ("ext::map_per_player");#d#
1706 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1707 2061
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 2064
1721 my ($self) = @_; 2075 my ($self) = @_;
1722 2076
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 2078
1725 return if $self->players; 2079 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 2080
1728 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
1729 2082
1730 $self->in_memory (cf::MAP_SWAPPED); 2083 $self->in_memory (cf::MAP_SWAPPED);
1731 2084
1732 # need to save uniques path 2085 # need to save uniques path
1733 unless ($self->{deny_save}) { 2086 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2118 $cf::MAP{$self->path} = $self;
1766 2119
1767 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1768} 2121}
1769 2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
1770=item cf::map::unique_maps 2159=item cf::map::unique_maps
1771 2160
1772Returns an arrayref of paths of all shared maps that have 2161Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2162instantiated unique items. May block.
1774 2163
1775=cut 2164=cut
1776 2165
1777sub unique_maps() { 2166sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2167 [
1779 or return; 2168 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2169 utf8::decode $_;
1785 next if /\.pst$/; 2170 /\.map$/
1786 next unless /^$PATH_SEP/o; 2171 ? normalise $_
1787 2172 : ()
1788 push @paths, cf::map::normalise $_; 2173 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2174 ]
1790
1791 \@paths
1792} 2175}
1793 2176
1794package cf; 2177package cf;
1795 2178
1796=back 2179=back
1842 2225
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2227
1845 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1847 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1850 } 2242 }
1851} 2243}
1852 2244
1853=item $player_object->may ("access") 2245=item $player_object->may ("access")
1854 2246
1902 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1903 2295
1904 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1905 2297
1906 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1907 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1908 2300
1909 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1910} 2302}
1911 2303
1912sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1913 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1914 2308
1915 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1916 2310
1917 unless ($map) { 2311 unless ($map) {
1918 # restore original map position 2312 # restore original map position
1941 2335
1942 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1943 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1944} 2338}
1945 2339
1946cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1947 on_logout => sub {
1948 my ($pl) = @_;
1949 2341
1950 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1951 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1952 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1953 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1954 }; 2346be called at the end of this process.
1955 }
1956 },
1957 on_login => sub {
1958 my ($pl) = @_;
1959 2347
1960 # try to abort aborted map switching on player login :)
1961 # should happen only on crashes
1962 if ($pl->ob->{_link_pos}) {
1963 $pl->ob->enter_link;
1964 (async {
1965 $pl->ob->reply (undef,
1966 "There was an internal problem at your last logout, "
1967 . "the server will try to bring you to your intended destination in a second.",
1968 cf::NDI_RED);
1969 # we need this sleep as the login has a concurrent enter_exit running
1970 # and this sleep increases chances of the player not ending up in scorn
1971 Coro::Timer::sleep 1;
1972 $pl->ob->leave_link;
1973 })->prio (2);
1974 }
1975 },
1976);
1977
1978=item $player_object->goto ($path, $x, $y)
1979
1980=cut 2348=cut
2349
2350our $GOTOGEN;
1981 2351
1982sub cf::object::player::goto { 2352sub cf::object::player::goto {
1983 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1984 2357
1985 $self->enter_link; 2358 $self->enter_link;
1986 2359
1987 (async { 2360 (async {
1988 my $map = eval { 2361 my $map = eval {
1989 my $map = cf::map::find $path; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1990 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
2366 $map = $check->($map) if $check && $map;
2367 } else {
2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
2370
1991 $map 2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
1992 } or 2377 }
1993 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1994 2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1995 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1996 })->prio (1); 2385 })->prio (1);
1997} 2386}
1998 2387
1999=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
2000 2389
2069 my $hp = $exit->stats->hp; 2458 my $hp = $exit->stats->hp;
2070 my $sp = $exit->stats->sp; 2459 my $sp = $exit->stats->sp;
2071 2460
2072 $self->enter_link; 2461 $self->enter_link;
2073 2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
2466
2074 (async { 2467 (async {
2075 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
2076 unless (eval { 2469 unless (eval {
2077 $self->goto ($slaying, $hp, $sp); 2470 $self->goto ($slaying, $hp, $sp);
2078 2471
2105 2498
2106 utf8::encode $text; 2499 utf8::encode $text;
2107 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2108} 2501}
2109 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => %$channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2110=item $client->ext_event ($type, %msg) 2555=item $client->ext_msg ($type, @msg)
2111 2556
2112Sends an exti event to the client. 2557Sends an ext event to the client.
2113 2558
2114=cut 2559=cut
2115 2560
2116sub cf::client::ext_event($$%) { 2561sub cf::client::ext_msg($$@) {
2117 my ($self, $type, %msg) = @_; 2562 my ($self, $type, @msg) = @_;
2118 2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2119 $msg{msgtype} = "event_$type"; 2569 push @msg, msgtype => "event_$type";
2120 $self->send_packet ("ext " . cf::to_json \%msg); 2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2121} 2572}
2122 2573
2123=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
2124 2575
2125Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
2126the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2127C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2128 2579
2129Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
2130reliable at some point in the future. 2581become reliable at some point in the future.
2131 2582
2132=cut 2583=cut
2133 2584
2134sub cf::client::query { 2585sub cf::client::query {
2135 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
2143 utf8::encode $text; 2594 utf8::encode $text;
2144 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2145 2596
2146 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
2147 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
2148} 2601}
2149 2602
2150cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
2151 on_reply => sub { 2609 on_reply => sub {
2152 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
2153 2611
2154 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
2155 # get handled first 2613 # get handled first
2167 } else { 2625 } else {
2168 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2169 } 2627 }
2170 } 2628 }
2171 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
2172); 2653);
2173 2654
2174=item $client->async (\&cb) 2655=item $client->async (\&cb)
2175 2656
2176Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
2225 2706
2226=pod 2707=pod
2227 2708
2228The following functions and methods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2229 2710
2230 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
2231 cf::object::player player 2715 cf::object::player
2232 cf::player peaceful 2716 player
2233 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2234 2723
2235=cut 2724=cut
2236 2725
2237for ( 2726for (
2238 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
2239 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2240 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2241 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2242) { 2732) {
2243 no strict 'refs'; 2733 no strict 'refs';
2314=back 2804=back
2315 2805
2316=cut 2806=cut
2317 2807
2318############################################################################# 2808#############################################################################
2319
2320=head2 EXTENSION DATABASE SUPPORT
2321
2322Crossfire maintains a very simple database for extension use. It can
2323currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2324convert to/from binary).
2325
2326The parameter C<$family> should best start with the name of the extension
2327using it, it should be unique.
2328
2329=over 4
2330
2331=item $value = cf::db_get $family => $key
2332
2333Returns a single value from the database.
2334
2335=item cf::db_put $family => $key => $value
2336
2337Stores the given C<$value> in the family.
2338
2339=cut
2340
2341our $DB;
2342
2343sub db_init {
2344 unless ($DB) {
2345 $DB = BDB::db_create $DB_ENV;
2346
2347 cf::sync_job {
2348 eval {
2349 $DB->set_flags (BDB::CHKSUM);
2350
2351 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2352 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2353 cf::cleanup "db_open(db): $!" if $!;
2354 };
2355 cf::cleanup "db_open(db): $@" if $@;
2356 };
2357 }
2358}
2359
2360sub db_get($$) {
2361 my $key = "$_[0]/$_[1]";
2362
2363 cf::sync_job {
2364 BDB::db_get $DB, undef, $key, my $data;
2365
2366 $! ? ()
2367 : $data
2368 }
2369}
2370
2371sub db_put($$$) {
2372 BDB::dbreq_pri 4;
2373 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2374}
2375
2376=item cf::cache $id => [$paths...], $processversion => $process
2377
2378Generic caching function that returns the value of the resource $id,
2379caching and regenerating as required.
2380
2381This function can block.
2382
2383=cut
2384
2385sub cache {
2386 my ($id, $src, $processversion, $process) = @_;
2387
2388 my $meta =
2389 join "\x00",
2390 $processversion,
2391 map {
2392 aio_stat $_
2393 and Carp::croak "$_: $!";
2394
2395 ($_, (stat _)[7,9])
2396 } @$src;
2397
2398 my $dbmeta = db_get cache => "$id/meta";
2399 if ($dbmeta ne $meta) {
2400 # changed, we may need to process
2401
2402 my @data;
2403 my $md5;
2404
2405 for (0 .. $#$src) {
2406 0 <= aio_load $src->[$_], $data[$_]
2407 or Carp::croak "$src->[$_]: $!";
2408 }
2409
2410 # if processing is expensive, check
2411 # checksum first
2412 if (1) {
2413 $md5 =
2414 join "\x00",
2415 $processversion,
2416 map {
2417 Coro::cede;
2418 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2419 } 0.. $#$src;
2420
2421
2422 my $dbmd5 = db_get cache => "$id/md5";
2423 if ($dbmd5 eq $md5) {
2424 db_put cache => "$id/meta", $meta;
2425
2426 return db_get cache => "$id/data";
2427 }
2428 }
2429
2430 my $t1 = Time::HiRes::time;
2431 my $data = $process->(\@data);
2432 my $t2 = Time::HiRes::time;
2433
2434 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2435
2436 db_put cache => "$id/data", $data;
2437 db_put cache => "$id/md5" , $md5;
2438 db_put cache => "$id/meta", $meta;
2439
2440 return $data;
2441 }
2442
2443 db_get cache => "$id/data"
2444}
2445
2446=item fork_call { }, $args
2447
2448Executes the given code block with the given arguments in a seperate
2449process, returning the results. Everything must be serialisable with
2450Coro::Storable. May, of course, block. Note that the executed sub may
2451never block itself or use any form of Event handling.
2452
2453=cut
2454
2455sub fork_call(&@) {
2456 my ($cb, @args) = @_;
2457
2458# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2459# or die "socketpair: $!";
2460 pipe my $fh1, my $fh2
2461 or die "pipe: $!";
2462
2463 if (my $pid = fork) {
2464 close $fh2;
2465
2466 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2467 $res = Coro::Storable::thaw $res;
2468
2469 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2470
2471 die $$res unless "ARRAY" eq ref $res;
2472
2473 return wantarray ? @$res : $res->[-1];
2474 } else {
2475 reset_signals;
2476 local $SIG{__WARN__};
2477 local $SIG{__DIE__};
2478 eval {
2479 close $fh1;
2480
2481 my @res = eval { $cb->(@args) };
2482 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2483 };
2484
2485 warn $@ if $@;
2486 _exit 0;
2487 }
2488}
2489
2490
2491
2492#############################################################################
2493# the server's init and main functions 2809# the server's init and main functions
2494 2810
2495sub load_facedata($) { 2811sub load_facedata($) {
2496 my ($path) = @_; 2812 my ($path) = @_;
2497 2813
2509 { 2825 {
2510 my $faces = $facedata->{faceinfo}; 2826 my $faces = $facedata->{faceinfo};
2511 2827
2512 while (my ($face, $info) = each %$faces) { 2828 while (my ($face, $info) = each %$faces) {
2513 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2514 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2515 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2516 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2517 Coro::cede; 2834
2835 cf::cede_to_tick;
2518 } 2836 }
2519 2837
2520 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2521 next unless $info->{smooth}; 2839 next unless $info->{smooth};
2522 my $idx = cf::face::find $face 2840 my $idx = cf::face::find $face
2523 or next; 2841 or next;
2524 if (my $smooth = cf::face::find $info->{smooth}) { 2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2525 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2526 } else { 2845 } else {
2527 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2528 } 2847 }
2529 Coro::cede; 2848
2849 cf::cede_to_tick;
2530 } 2850 }
2531 } 2851 }
2532 2852
2533 { 2853 {
2534 my $anims = $facedata->{animinfo}; 2854 my $anims = $facedata->{animinfo};
2535 2855
2536 while (my ($anim, $info) = each %$anims) { 2856 while (my ($anim, $info) = each %$anims) {
2537 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2538 Coro::cede; 2858 cf::cede_to_tick;
2539 } 2859 }
2540 2860
2541 cf::anim::invalidate_all; # d'oh 2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 while (my ($name, $info) = each %$res) {
2871 my $meta = $enc->encode ({
2872 name => $name,
2873 type => $info->{type},
2874 copyright => $info->{copyright}, #TODO#
2875 });
2876
2877 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2878
2879 if ($name =~ /\.(?:jpg|png)$/) {
2880 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2881 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2882 } else {
2883 my $data = pack "(w/a*)*", $meta, $info->{data};
2884 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2885
2886 cf::face::set_type $idx, 1;
2887 cf::face::set_data $idx, 0, $data, $chk;
2888 }
2889
2890 cf::cede_to_tick;
2891 }
2542 } 2892 }
2543 2893
2544 1 2894 1
2545} 2895}
2546 2896
2547sub reload_regions { 2897sub reload_regions {
2548 load_resource_file "$MAPDIR/regions" 2898 load_resource_file "$MAPDIR/regions"
2549 or die "unable to load regions file\n"; 2899 or die "unable to load regions file\n";
2900
2901 for (cf::region::list) {
2902 $_->{match} = qr/$_->{match}/
2903 if exists $_->{match};
2904 }
2550} 2905}
2551 2906
2552sub reload_facedata { 2907sub reload_facedata {
2553 load_facedata "$DATADIR/facedata" 2908 load_facedata "$DATADIR/facedata"
2554 or die "unable to load facedata\n"; 2909 or die "unable to load facedata\n";
2555} 2910}
2556 2911
2557sub reload_archetypes { 2912sub reload_archetypes {
2558 load_resource_file "$DATADIR/archetypes" 2913 load_resource_file "$DATADIR/archetypes"
2559 or die "unable to load archetypes\n"; 2914 or die "unable to load archetypes\n";
2915 #d# NEED to laod twice to resolve forward references
2916 # this really needs to be done in an extra post-pass
2917 # (which needs to be synchronous, so solve it differently)
2918 load_resource_file "$DATADIR/archetypes"
2919 or die "unable to load archetypes\n";
2560} 2920}
2561 2921
2562sub reload_treasures { 2922sub reload_treasures {
2563 load_resource_file "$DATADIR/treasures" 2923 load_resource_file "$DATADIR/treasures"
2564 or die "unable to load treasurelists\n"; 2924 or die "unable to load treasurelists\n";
2567sub reload_resources { 2927sub reload_resources {
2568 warn "reloading resource files...\n"; 2928 warn "reloading resource files...\n";
2569 2929
2570 reload_regions; 2930 reload_regions;
2571 reload_facedata; 2931 reload_facedata;
2932 #reload_archetypes;#d#
2572 reload_archetypes; 2933 reload_archetypes;
2573 reload_treasures; 2934 reload_treasures;
2574 2935
2575 warn "finished reloading resource files\n"; 2936 warn "finished reloading resource files\n";
2576} 2937}
2633 }, 2994 },
2634 ); 2995 );
2635 } 2996 }
2636} 2997}
2637 2998
2999sub write_runtime {
3000 my $runtime = "$LOCALDIR/runtime";
3001
3002 # first touch the runtime file to show we are still running:
3003 # the fsync below can take a very very long time.
3004
3005 IO::AIO::aio_utime $runtime, undef, undef;
3006
3007 my $guard = cf::lock_acquire "write_runtime";
3008
3009 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3010 or return;
3011
3012 my $value = $cf::RUNTIME + 90 + 10;
3013 # 10 is the runtime save interval, for a monotonic clock
3014 # 60 allows for the watchdog to kill the server.
3015
3016 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3017 and return;
3018
3019 # always fsync - this file is important
3020 aio_fsync $fh
3021 and return;
3022
3023 # touch it again to show we are up-to-date
3024 aio_utime $fh, undef, undef;
3025
3026 close $fh
3027 or return;
3028
3029 aio_rename "$runtime~", $runtime
3030 and return;
3031
3032 warn "runtime file written.\n";
3033
3034 1
3035}
3036
2638sub emergency_save() { 3037sub emergency_save() {
2639 my $freeze_guard = cf::freeze_mainloop; 3038 my $freeze_guard = cf::freeze_mainloop;
2640 3039
2641 warn "enter emergency perl save\n"; 3040 warn "enter emergency perl save\n";
2642 3041
2717 %EXT_CORO = (); 3116 %EXT_CORO = ();
2718 3117
2719 warn "removing commands"; 3118 warn "removing commands";
2720 %COMMAND = (); 3119 %COMMAND = ();
2721 3120
2722 warn "removing ext commands"; 3121 warn "removing ext/exti commands";
2723 %EXTCMD = (); 3122 %EXTCMD = ();
3123 %EXTICMD = ();
2724 3124
2725 warn "unloading/nuking all extensions"; 3125 warn "unloading/nuking all extensions";
2726 for my $pkg (@EXTS) { 3126 for my $pkg (@EXTS) {
2727 warn "... unloading $pkg"; 3127 warn "... unloading $pkg";
2728 3128
2846 my $signal = new Coro::Signal; 3246 my $signal = new Coro::Signal;
2847 push @WAIT_FOR_TICK_BEGIN, $signal; 3247 push @WAIT_FOR_TICK_BEGIN, $signal;
2848 $signal->wait; 3248 $signal->wait;
2849} 3249}
2850 3250
3251 my $min = 1e6;#d#
3252 my $avg = 10;
2851$TICK_WATCHER = Event->timer ( 3253$TICK_WATCHER = Event->timer (
2852 reentrant => 0, 3254 reentrant => 0,
2853 parked => 1, 3255 parked => 1,
2854 prio => 0, 3256 prio => 0,
2855 at => $NEXT_TICK || $TICK, 3257 at => $NEXT_TICK || $TICK,
2862 } 3264 }
2863 3265
2864 $NOW = $tick_start = Event::time; 3266 $NOW = $tick_start = Event::time;
2865 3267
2866 cf::server_tick; # one server iteration 3268 cf::server_tick; # one server iteration
3269
3270 0 && sync_job {#d#
3271 for(1..10) {
3272 my $t = Event::time;
3273 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3274 or die;
3275
3276 $map->width (50);
3277 $map->height (50);
3278 $map->alloc;
3279 $map->_load_objects ("/tmp/x.map", 1);
3280 my $t = Event::time - $t;
3281
3282 #next unless $t < 0.0013;#d#
3283 if ($t < $min) {
3284 $min = $t;
3285 }
3286 $avg = $avg * 0.99 + $t * 0.01;
3287 }
3288 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3289 exit 0;
3290 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3291 };
2867 3292
2868 $RUNTIME += $TICK; 3293 $RUNTIME += $TICK;
2869 $NEXT_TICK += $TICK; 3294 $NEXT_TICK += $TICK;
2870 3295
2871 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3296 if ($NOW >= $NEXT_RUNTIME_WRITE) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines