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.311 by root, Fri Jul 20 16:11:10 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
317 334
318BEGIN { *async = \&Coro::async_pool } 335BEGIN { *async = \&Coro::async_pool }
319 336
320=item cf::sync_job { BLOCK } 337=item cf::sync_job { BLOCK }
321 338
322The design of crossfire+ requires that the main coro ($Coro::main) is 339The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323always able to handle events or runnable, as crossfire+ is only partly 340is 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. 341partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
342acceptable.
325 343
326If it must be done, put the blocking parts into C<sync_job>. This will run 344If 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 345the given BLOCK in another coroutine while waiting for the result. The
328server will be frozen during this time, so the block should either finish 346server will be frozen during this time, so the block should either finish
329fast or be very important. 347fast or be very important.
389 $EXT_CORO{$coro+0} = $coro; 407 $EXT_CORO{$coro+0} = $coro;
390 408
391 $coro 409 $coro
392} 410}
393 411
394sub write_runtime { 412=item fork_call { }, $args
395 my $runtime = "$LOCALDIR/runtime";
396 413
397 # first touch the runtime file to show we are still running: 414Executes the given code block with the given arguments in a seperate
398 # the fsync below can take a very very long time. 415process, returning the results. Everything must be serialisable with
416Coro::Storable. May, of course, block. Note that the executed sub may
417never block itself or use any form of Event handling.
399 418
400 if (my $fh = aio_open $runtime, O_WRONLY, 0) { 419=cut
401 utime undef, undef, $fh;
402 }
403 420
404 my $guard = cf::lock_acquire "write_runtime"; 421sub _store_scalar {
405 422 open my $fh, ">", \my $buf
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 423 or die "fork_call: cannot open fh-to-buf in child : $!";
407 or return; 424 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 425 close $fh;
424 or return;
425 426
426 aio_rename "$runtime~", $runtime 427 $buf
427 and return; 428}
428 429
429 warn "runtime file written.\n";#d# 430sub fork_call(&@) {
431 my ($cb, @args) = @_;
430 432
433# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
434# or die "socketpair: $!";
435 pipe my $fh1, my $fh2
436 or die "pipe: $!";
437
438 if (my $pid = fork) {
439 close $fh2;
440
441 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
442 warn "pst<$res>" unless $res =~ /^pst/;
443 $res = Coro::Storable::thaw $res;
444
445 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
446
447 Carp::confess $$res unless "ARRAY" eq ref $res;
448
449 return wantarray ? @$res : $res->[-1];
450 } else {
451 reset_signals;
452 local $SIG{__WARN__};
453 local $SIG{__DIE__};
454 # just in case, this hack effectively disables event
455 # in the child. cleaner and slower would be canceling all watchers,
456 # but this works for the time being.
457 local $Coro::idle;
458 $Coro::current->prio (Coro::PRIO_MAX);
459
460 eval {
461 close $fh1;
462
463 my @res = eval { $cb->(@args) };
464
465 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
466 close $fh2;
467 };
468
469 warn $@ if $@;
470 _exit 0;
431 1 471 }
472}
473
474=item $value = cf::db_get $family => $key
475
476Returns a single value from the environment database.
477
478=item cf::db_put $family => $key => $value
479
480Stores the given C<$value> in the family. It can currently store binary
481data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
482
483=cut
484
485our $DB;
486
487sub db_init {
488 unless ($DB) {
489 $DB = BDB::db_create $DB_ENV;
490
491 cf::sync_job {
492 eval {
493 $DB->set_flags (BDB::CHKSUM);
494
495 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
496 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
497 cf::cleanup "db_open(db): $!" if $!;
498 };
499 cf::cleanup "db_open(db): $@" if $@;
500 };
501 }
502}
503
504sub db_get($$) {
505 my $key = "$_[0]/$_[1]";
506
507 cf::sync_job {
508 BDB::db_get $DB, undef, $key, my $data;
509
510 $! ? ()
511 : $data
512 }
513}
514
515sub db_put($$$) {
516 BDB::dbreq_pri 4;
517 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
518}
519
520=item cf::cache $id => [$paths...], $processversion => $process
521
522Generic caching function that returns the value of the resource $id,
523caching and regenerating as required.
524
525This function can block.
526
527=cut
528
529sub cache {
530 my ($id, $src, $processversion, $process) = @_;
531
532 my $meta =
533 join "\x00",
534 $processversion,
535 map {
536 aio_stat $_
537 and Carp::croak "$_: $!";
538
539 ($_, (stat _)[7,9])
540 } @$src;
541
542 my $dbmeta = db_get cache => "$id/meta";
543 if ($dbmeta ne $meta) {
544 # changed, we may need to process
545
546 my @data;
547 my $md5;
548
549 for (0 .. $#$src) {
550 0 <= aio_load $src->[$_], $data[$_]
551 or Carp::croak "$src->[$_]: $!";
552 }
553
554 # if processing is expensive, check
555 # checksum first
556 if (1) {
557 $md5 =
558 join "\x00",
559 $processversion,
560 map {
561 Coro::cede;
562 ($src->[$_], Digest::MD5::md5_hex $data[$_])
563 } 0.. $#$src;
564
565
566 my $dbmd5 = db_get cache => "$id/md5";
567 if ($dbmd5 eq $md5) {
568 db_put cache => "$id/meta", $meta;
569
570 return db_get cache => "$id/data";
571 }
572 }
573
574 my $t1 = Time::HiRes::time;
575 my $data = $process->(\@data);
576 my $t2 = Time::HiRes::time;
577
578 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
579
580 db_put cache => "$id/data", $data;
581 db_put cache => "$id/md5" , $md5;
582 db_put cache => "$id/meta", $meta;
583
584 return $data;
585 }
586
587 db_get cache => "$id/data"
432} 588}
433 589
434=item cf::datalog type => key => value, ... 590=item cf::datalog type => key => value, ...
435 591
436Log a datalog packet of the given type with the given key-value pairs. 592Log 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") 610attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
456 612
457In the following description, CLASS can be any of C<global>, C<object> 613In 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 614C<player>, C<client> or C<map> (i.e. the attachable objects in
459crossfire+). 615Crossfire TRT).
460 616
461=over 4 617=over 4
462 618
463=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
464 620
627 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
628 784
629 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
630 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
631 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
632 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633 789
634 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
635 my $pkg = shift @arg; 791 my $pkg = shift @arg;
636 792
637 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
666 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
667 } 823 }
668 824
669 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
670 } else { 826 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 828 }
673 829
674 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
675} 831}
676 832
678 if (ref $_[0]) { 834 if (ref $_[0]) {
679 _object_attach @_; 835 _object_attach @_;
680 } else { 836 } else {
681 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
682 } 838 }
839 _recalc_want;
683}; 840};
684 841
685# all those should be optimised 842# all those should be optimised
686sub cf::attachable::detach { 843sub cf::attachable::detach {
687 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
690 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
691 reattach ($obj); 848 reattach ($obj);
692 } else { 849 } else {
693 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
694 } 851 }
852 _recalc_want;
695}; 853};
696 854
697sub cf::attachable::attached { 855sub cf::attachable::attached {
698 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
699 857
714 "; 872 ";
715 die if $@; 873 die if $@;
716} 874}
717 875
718our $override; 876our $override;
719our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 877our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
720 878
721sub override { 879sub override {
722 $override = 1; 880 $override = 1;
723 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
724} 882}
725 883
726sub do_invoke { 884sub do_invoke {
727 my $event = shift; 885 my $event = shift;
728 my $callbacks = shift; 886 my $callbacks = shift;
729 887
730 @invoke_results = (); 888 @INVOKE_RESULTS = ();
731 889
732 local $override; 890 local $override;
733 891
734 for (@$callbacks) { 892 for (@$callbacks) {
735 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
752 910
753Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
754 912
755This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 913This 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 914removed in future versions), and there is no public API to access override
757results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758 916
759=back 917=back
760 918
761=cut 919=cut
762 920
872 or return; 1030 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1032 }
875 1033
876 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1036 return ($data, $av);
879} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
880 1044
881############################################################################# 1045#############################################################################
882# command handling &c 1046# command handling &c
883 1047
884=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1062}
899 1063
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1065
902Register a callbackf ro execution when the client sends an extcmd packet. 1066Register a callback for execution when the client sends an (synchronous)
1067extcmd packet. Ext commands will be processed in the order they are
1068received by the server, like other user commands. The first argument is
1069the logged-in player. Ext commands can only be processed after a player
1070has logged in successfully.
903 1071
904If the callback returns something, it is sent back as if reply was being 1072If the callback returns something, it is sent back as if reply was being
905called. 1073called.
906 1074
1075=item cf::register_exticmd $name => \&callback($ns,$packet);
1076
1077Register a callback for execution when the client sends an (asynchronous)
1078exticmd packet. Exti commands are processed by the server as soon as they
1079are received, i.e. out of order w.r.t. other commands. The first argument
1080is a client socket. Exti commands can be received anytime, even before
1081log-in.
1082
1083If the callback returns something, it is sent back as if reply was being
1084called.
1085
907=cut 1086=cut
908 1087
909sub register_extcmd { 1088sub register_extcmd {
910 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
911 1090
912 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
913} 1098}
914 1099
915cf::player->attach ( 1100cf::player->attach (
916 on_command => sub { 1101 on_command => sub {
917 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
926 cf::override; 1111 cf::override;
927 }, 1112 },
928 on_extcmd => sub { 1113 on_extcmd => sub {
929 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
930 1115
931 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932 1117
933 if (ref $msg) { 1118 if (ref $msg) {
934 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
936 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
942 1127
943 cf::override; 1128 cf::override;
944 }, 1129 },
945); 1130);
946 1131
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 { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
982 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1137 next unless -r $path;
984 eval { 1138
985 load_extension $ext; 1139 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1140 my $base = $1;
1141 my $pkg = $1;
1142 $pkg =~ s/[^[:word:]]/_/g;
1143 $pkg = "ext::$pkg";
1144
1145 open my $fh, "<:utf8", $path
1146 or die "$path: $!";
1147
1148 my $source = do { local $/; <$fh> };
1149
1150 my %ext = (
1151 path => $path,
1152 base => $base,
1153 pkg => $pkg,
1154 );
1155
1156 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1157 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1158
1159 $ext{source} =
1160 "package $pkg; use strict; use utf8;\n"
1161 . "#line 1 \"$path\"\n{\n"
1162 . $source
1163 . "\n};\n1";
1164
1165 $todo{$base} = \%ext;
1166 }
1167
1168 my %done;
1169 while (%todo) {
1170 my $progress;
1171
1172 while (my ($k, $v) = each %todo) {
1173 for (split /,\s*/, $v->{meta}{depends}) {
1174 goto skip
1175 unless exists $done{$_};
1176 }
1177
1178 warn "... loading '$k' into '$v->{pkg}'\n";
1179
1180 unless (eval $v->{source}) {
1181 my $msg = $@ ? "$v->{path}: $@\n"
1182 : "$v->{base}: extension inactive.\n";
1183
1184 if (exists $v->{meta}{mandatory}) {
1185 warn $msg;
1186 warn "mandatory extension failed to load, exiting.\n";
1187 exit 1;
1188 }
1189
1190 warn $msg;
1191 }
1192
1193 $done{$k} = delete $todo{$k};
1194 push @EXTS, $v->{pkg};
1195 $progress = 1;
986 1 1196 }
987 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
988 } 1202 };
989} 1203}
990 1204
991############################################################################# 1205#############################################################################
1206
1207=back
992 1208
993=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
994 1210
995Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
996 1212
1184 } 1400 }
1185 1401
1186 \@paths 1402 \@paths
1187} 1403}
1188 1404
1405=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1406
1407Expand crossfire pod fragments into protocol xml.
1408
1409=cut
1410
1411sub expand_cfpod {
1412 ((my $self), (local $_)) = @_;
1413
1414 # escape & and <
1415 s/&/&amp;/g;
1416 s/(?<![BIUGH])</&lt;/g;
1417
1418 # this is buggy, it needs to properly take care of nested <'s
1419
1420 1 while
1421 # replace B<>, I<>, U<> etc.
1422 s/B<([^\>]*)>/<b>$1<\/b>/
1423 || s/I<([^\>]*)>/<i>$1<\/i>/
1424 || s/U<([^\>]*)>/<u>$1<\/u>/
1425 # replace G<male|female> tags
1426 || s{G<([^>|]*)\|([^>]*)>}{
1427 $self->gender ? $2 : $1
1428 }ge
1429 # replace H<hint text>
1430 || s{H<([^\>]*)>}
1431 {
1432 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1433 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1434 "")
1435 [$self->{hintmode}]
1436 }ge;
1437
1438 # create single paragraphs (very hackish)
1439 s/(?<=\S)\n(?=\w)/ /g;
1440
1441 # compress some whitespace
1442 s/\s+\n/\n/g; # ws line-ends
1443 s/\n\n+/\n/g; # double lines
1444 s/^\n+//; # beginning lines
1445 s/\n+$//; # ending lines
1446
1447 $_
1448}
1449
1450sub hintmode {
1451 $_[0]{hintmode} = $_[1] if @_ > 1;
1452 $_[0]{hintmode}
1453}
1454
1189=item $player->ext_reply ($msgid, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1190 1456
1191Sends an ext reply to the player. 1457Sends an ext reply to the player.
1192 1458
1193=cut 1459=cut
1194 1460
1195sub ext_reply($$%) { 1461sub ext_reply($$%) {
1196 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1197 1463
1198 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1199 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200 $self->send ("ext " . cf::to_json \%msg);
1201} 1466}
1202 1467
1203=item $player->ext_event ($type, %msg) 1468=item $player->ext_event ($type, %msg)
1204 1469
1205Sends an ext event to the client. 1470Sends an ext event to the client.
1220 1485
1221package cf::region; 1486package cf::region;
1222 1487
1223=item cf::region::find_by_path $path 1488=item cf::region::find_by_path $path
1224 1489
1225Tries to decuce the probable region for a map knowing only its path. 1490Tries to decuce the likely region for a map knowing only its path.
1226 1491
1227=cut 1492=cut
1228 1493
1229sub find_by_path($) { 1494sub find_by_path($) {
1230 my ($path) = @_; 1495 my ($path) = @_;
1231 1496
1232 my ($match, $specificity); 1497 my ($match, $specificity);
1233 1498
1234 for my $region (list) { 1499 for my $region (list) {
1235 if ($region->match && $path =~ $region->match) { 1500 if ($region->{match} && $path =~ $region->{match}) {
1236 ($match, $specificity) = ($region, $region->specificity) 1501 ($match, $specificity) = ($region, $region->specificity)
1237 if $region->specificity > $specificity; 1502 if $region->specificity > $specificity;
1238 } 1503 }
1239 } 1504 }
1240 1505
1304 my ($self, $merge) = @_; 1569 my ($self, $merge) = @_;
1305 1570
1306 # we have to keep some variables in memory intact 1571 # we have to keep some variables in memory intact
1307 local $self->{path}; 1572 local $self->{path};
1308 local $self->{load_path}; 1573 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1574
1312 $self->SUPER::thawer_merge ($merge); 1575 $self->SUPER::thawer_merge ($merge);
1313} 1576}
1314 1577
1315sub normalise { 1578sub normalise {
1362 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1363 return $self; 1626 return $self;
1364 } 1627 }
1365 } 1628 }
1366 1629
1367 Carp::carp "unable to resolve path '$path' (base '$base')."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1368 () 1631 ()
1369} 1632}
1370 1633
1371sub init { 1634sub init {
1372 my ($self) = @_; 1635 my ($self) = @_;
1413sub change_all_map_light { 1676sub change_all_map_light {
1414 my ($change) = @_; 1677 my ($change) = @_;
1415 1678
1416 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1680 for grep $_->outdoor, values %cf::MAP;
1681}
1682
1683sub decay_objects {
1684 my ($self) = @_;
1685
1686 return if $self->{deny_reset};
1687
1688 $self->do_decay_objects;
1418} 1689}
1419 1690
1420sub unlink_save { 1691sub unlink_save {
1421 my ($self) = @_; 1692 my ($self) = @_;
1422 1693
1480 $self->load_header_orig 1751 $self->load_header_orig
1481 or return; 1752 or return;
1482 $self->prepare_orig; 1753 $self->prepare_orig;
1483 } 1754 }
1484 1755
1756 $self->{deny_reset} = 1
1757 if $self->no_reset;
1758
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1759 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1760 unless $self->default_region;
1487 1761
1488 1 1762 1
1489} 1763}
1504 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1505 1779
1506 $map->load_header 1780 $map->load_header
1507 or return; 1781 or return;
1508 1782
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1783 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1784 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1785 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1786 $map->reset;
1513 undef $guard; 1787 undef $guard;
1514 return find $path; 1788 return find $path;
1581 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1582 1856
1583 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1858 if $self->per_player;
1585 1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1862
1586 $self 1863 $self
1587} 1864}
1588 1865
1589# find and load all maps in the 3x3 area around a map 1866# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1867sub load_diag {
1636 1913
1637 undef $MAP_PREFETCH{$path}; 1914 undef $MAP_PREFETCH{$path};
1638 $MAP_PREFETCHER ||= cf::async { 1915 $MAP_PREFETCHER ||= cf::async {
1639 while (%MAP_PREFETCH) { 1916 while (%MAP_PREFETCH) {
1640 for my $path (keys %MAP_PREFETCH) { 1917 for my $path (keys %MAP_PREFETCH) {
1641 my $map = find $path 1918 if (my $map = find $path) {
1642 or next;
1643 $map->load; 1919 $map->load;
1920 }
1644 1921
1645 delete $MAP_PREFETCH{$path}; 1922 delete $MAP_PREFETCH{$path};
1646 } 1923 }
1647 } 1924 }
1648 undef $MAP_PREFETCHER; 1925 undef $MAP_PREFETCHER;
1700 1977
1701sub reset_at { 1978sub reset_at {
1702 my ($self) = @_; 1979 my ($self) = @_;
1703 1980
1704 # TODO: safety, remove and allow resettable per-player maps 1981 # 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}; 1982 return 1e99 if $self->{deny_reset};
1707 1983
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1985 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 1986
1721 my ($self) = @_; 1997 my ($self) = @_;
1722 1998
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 2000
1725 return if $self->players; 2001 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 2002
1728 warn "resetting map ", $self->path;#d# 2003 warn "resetting map ", $self->path;
1729 2004
1730 $self->in_memory (cf::MAP_SWAPPED); 2005 $self->in_memory (cf::MAP_SWAPPED);
1731 2006
1732 # need to save uniques path 2007 # need to save uniques path
1733 unless ($self->{deny_save}) { 2008 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2040 $cf::MAP{$self->path} = $self;
1766 2041
1767 $self->reset; # polite request, might not happen 2042 $self->reset; # polite request, might not happen
1768} 2043}
1769 2044
2045=item $maps = cf::map::tmp_maps
2046
2047Returns an arrayref with all map paths of currently instantiated and saved
2048maps. May block.
2049
2050=cut
2051
2052sub tmp_maps() {
2053 [
2054 map {
2055 utf8::decode $_;
2056 /\.map$/
2057 ? normalise $_
2058 : ()
2059 } @{ aio_readdir $TMPDIR or [] }
2060 ]
2061}
2062
2063=item $maps = cf::map::random_maps
2064
2065Returns an arrayref with all map paths of currently instantiated and saved
2066random maps. May block.
2067
2068=cut
2069
2070sub random_maps() {
2071 [
2072 map {
2073 utf8::decode $_;
2074 /\.map$/
2075 ? normalise "?random/$_"
2076 : ()
2077 } @{ aio_readdir $RANDOMDIR or [] }
2078 ]
2079}
2080
1770=item cf::map::unique_maps 2081=item cf::map::unique_maps
1771 2082
1772Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2084instantiated unique items. May block.
1774 2085
1775=cut 2086=cut
1776 2087
1777sub unique_maps() { 2088sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2089 [
1779 or return; 2090 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2091 utf8::decode $_;
1785 next if /\.pst$/; 2092 /\.map$/
1786 next unless /^$PATH_SEP/o; 2093 ? normalise $_
1787 2094 : ()
1788 push @paths, cf::map::normalise $_; 2095 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2096 ]
1790
1791 \@paths
1792} 2097}
1793 2098
1794package cf; 2099package cf;
1795 2100
1796=back 2101=back
1842 2147
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2149
1845 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1847 } else { 2153 } else {
2154 my $pl = $self->contr;
2155
2156 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2157 my $diag = $pl->{npc_dialog};
2158 $diag->{pl}->ext_reply (
2159 $diag->{id},
2160 msgtype => "reply",
2161 msg => $diag->{pl}->expand_cfpod ($msg),
2162 add_topics => []
2163 );
2164
2165 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1850 } 2169 }
1851} 2170}
1852 2171
1853=item $player_object->may ("access") 2172=item $player_object->may ("access")
1854 2173
1902 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1903 2222
1904 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1905 2224
1906 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1907 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1908 2227
1909 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1910} 2229}
1911 2230
1912sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1913 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1914 2235
1915 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1916 2237
1917 unless ($map) { 2238 unless ($map) {
1918 # restore original map position 2239 # restore original map position
1941 2262
1942 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1943 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1944} 2265}
1945 2266
1946cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1947 on_logout => sub {
1948 my ($pl) = @_;
1949 2268
1950 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1951 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1952 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1953 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1954 }; 2273be called at the end of this process.
1955 }
1956 },
1957 on_login => sub {
1958 my ($pl) = @_;
1959 2274
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 2275=cut
2276
2277our $GOTOGEN;
1981 2278
1982sub cf::object::player::goto { 2279sub cf::object::player::goto {
1983 my ($self, $path, $x, $y) = @_; 2280 my ($self, $path, $x, $y, $check, $done) = @_;
2281
2282 # do generation counting so two concurrent goto's will be executed in-order
2283 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1984 2284
1985 $self->enter_link; 2285 $self->enter_link;
1986 2286
1987 (async { 2287 (async {
1988 my $map = eval { 2288 my $map = eval {
1989 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1990 $map = $map->customise_for ($self) if $map; 2292 $map = $map->customise_for ($self);
2293 $map = $check->($map) if $check && $map;
2294 } else {
2295 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2296 }
2297
1991 $map 2298 $map
2299 };
2300
2301 if ($@) {
2302 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2303 LOG llevError | logBacktrace, Carp::longmess $@;
1992 } or 2304 }
1993 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1994 2305
2306 if ($gen == $self->{_goto_generation}) {
2307 delete $self->{_goto_generation};
1995 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1996 })->prio (1); 2312 })->prio (1);
1997} 2313}
1998 2314
1999=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
2000 2316
2069 my $hp = $exit->stats->hp; 2385 my $hp = $exit->stats->hp;
2070 my $sp = $exit->stats->sp; 2386 my $sp = $exit->stats->sp;
2071 2387
2072 $self->enter_link; 2388 $self->enter_link;
2073 2389
2390 # if exit is damned, update players death & WoR home-position
2391 $self->contr->savebed ($slaying, $hp, $sp)
2392 if $exit->flag (FLAG_DAMNED);
2393
2074 (async { 2394 (async {
2075 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
2076 unless (eval { 2396 unless (eval {
2077 $self->goto ($slaying, $hp, $sp); 2397 $self->goto ($slaying, $hp, $sp);
2078 2398
2105 2425
2106 utf8::encode $text; 2426 utf8::encode $text;
2107 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2427 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2108} 2428}
2109 2429
2430=item $client->send_msg ($channel, $msg, $color, [extra...])
2431
2432Send a drawinfo or msg packet to the client, formatting the msg for the
2433client if neccessary. C<$type> should be a string identifying the type of
2434the message, with C<log> being the default. If C<$color> is negative, suppress
2435the message unless the client supports the msg packet.
2436
2437=cut
2438
2439sub cf::client::send_msg {
2440 my ($self, $channel, $msg, $color, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 $color &= ~cf::NDI_UNIQUE; # just in case...
2447
2448 if (ref $channel) {
2449 # send meta info to client, if not yet sent
2450 unless (exists $self->{channel}{$channel->{id}}) {
2451 $self->{channel}{$channel->{id}} = $channel;
2452 $self->ext_event (channel_info => %$channel);
2453 }
2454
2455 $channel = $channel->{id};
2456 }
2457
2458 if ($self->can_msg) {
2459 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2460 } else {
2461 # replace some tags by gcfclient-compatible ones
2462 for ($msg) {
2463 1 while
2464 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2465 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2466 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2467 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2468 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2469 }
2470
2471 if ($color >= 0) {
2472 if (0 && $msg =~ /\[/) {
2473 $self->send_packet ("drawextinfo $color 4 0 $msg")
2474 } else {
2475 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2476 $self->send_packet ("drawinfo $color $msg")
2477 }
2478 }
2479 }
2480}
2481
2110=item $client->ext_event ($type, %msg) 2482=item $client->ext_event ($type, %msg)
2111 2483
2112Sends an exti event to the client. 2484Sends an ext event to the client.
2113 2485
2114=cut 2486=cut
2115 2487
2116sub cf::client::ext_event($$%) { 2488sub cf::client::ext_event($$%) {
2117 my ($self, $type, %msg) = @_; 2489 my ($self, $type, %msg) = @_;
2118 2490
2491 return unless $self->extcmd;
2492
2119 $msg{msgtype} = "event_$type"; 2493 $msg{msgtype} = "event_$type";
2120 $self->send_packet ("ext " . cf::to_json \%msg); 2494 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2121} 2495}
2122 2496
2123=item $success = $client->query ($flags, "text", \&cb) 2497=item $success = $client->query ($flags, "text", \&cb)
2124 2498
2125Queues a query to the client, calling the given callback with 2499Queues a query to the client, calling the given callback with
2126the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2500the 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>. 2501C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2128 2502
2129Queries can fail, so check the return code. Or don't, as queries will become 2503Queries can fail, so check the return code. Or don't, as queries will
2130reliable at some point in the future. 2504become reliable at some point in the future.
2131 2505
2132=cut 2506=cut
2133 2507
2134sub cf::client::query { 2508sub cf::client::query {
2135 my ($self, $flags, $text, $cb) = @_; 2509 my ($self, $flags, $text, $cb) = @_;
2143 utf8::encode $text; 2517 utf8::encode $text;
2144 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2518 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2145 2519
2146 $self->send_packet ($self->{query_queue}[0][0]) 2520 $self->send_packet ($self->{query_queue}[0][0])
2147 if @{ $self->{query_queue} } == 1; 2521 if @{ $self->{query_queue} } == 1;
2522
2523 1
2148} 2524}
2149 2525
2150cf::client->attach ( 2526cf::client->attach (
2527 on_connect => sub {
2528 my ($ns) = @_;
2529
2530 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2531 },
2151 on_reply => sub { 2532 on_reply => sub {
2152 my ($ns, $msg) = @_; 2533 my ($ns, $msg) = @_;
2153 2534
2154 # this weird shuffling is so that direct followup queries 2535 # this weird shuffling is so that direct followup queries
2155 # get handled first 2536 # get handled first
2167 } else { 2548 } else {
2168 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2549 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2169 } 2550 }
2170 } 2551 }
2171 }, 2552 },
2553 on_exticmd => sub {
2554 my ($ns, $buf) = @_;
2555
2556 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2557
2558 if (ref $msg) {
2559 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2560 if (my %reply = $cb->($ns, $msg)) {
2561 $reply{msgid} = $msg->{msgid};
2562 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2563 }
2564 }
2565 } else {
2566 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2567 }
2568
2569 cf::override;
2570 },
2172); 2571);
2173 2572
2174=item $client->async (\&cb) 2573=item $client->async (\&cb)
2175 2574
2176Create a new coroutine, running the specified callback. The coroutine will 2575Create a new coroutine, running the specified callback. The coroutine will
2225 2624
2226=pod 2625=pod
2227 2626
2228The following functions and methods are available within a safe environment: 2627The following functions and methods are available within a safe environment:
2229 2628
2230 cf::object contr pay_amount pay_player map 2629 cf::object
2630 contr pay_amount pay_player map x y force_find force_add
2631 insert remove
2632
2231 cf::object::player player 2633 cf::object::player
2232 cf::player peaceful 2634 player
2233 cf::map trigger 2635
2636 cf::player
2637 peaceful
2638
2639 cf::map
2640 trigger
2234 2641
2235=cut 2642=cut
2236 2643
2237for ( 2644for (
2238 ["cf::object" => qw(contr pay_amount pay_player map)], 2645 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2646 insert remove)],
2239 ["cf::object::player" => qw(player)], 2647 ["cf::object::player" => qw(player)],
2240 ["cf::player" => qw(peaceful)], 2648 ["cf::player" => qw(peaceful)],
2241 ["cf::map" => qw(trigger)], 2649 ["cf::map" => qw(trigger)],
2242) { 2650) {
2243 no strict 'refs'; 2651 no strict 'refs';
2314=back 2722=back
2315 2723
2316=cut 2724=cut
2317 2725
2318############################################################################# 2726#############################################################################
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 2727# the server's init and main functions
2494 2728
2495sub load_facedata($) { 2729sub load_facedata($) {
2496 my ($path) = @_; 2730 my ($path) = @_;
2497 2731
2509 { 2743 {
2510 my $faces = $facedata->{faceinfo}; 2744 my $faces = $facedata->{faceinfo};
2511 2745
2512 while (my ($face, $info) = each %$faces) { 2746 while (my ($face, $info) = each %$faces) {
2513 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2747 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2514 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2748 cf::face::set_visibility $idx, $info->{visibility};
2749 cf::face::set_magicmap $idx, $info->{magicmap};
2515 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2750 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2516 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2751 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2517 Coro::cede; 2752
2753 cf::cede_to_tick;
2518 } 2754 }
2519 2755
2520 while (my ($face, $info) = each %$faces) { 2756 while (my ($face, $info) = each %$faces) {
2521 next unless $info->{smooth}; 2757 next unless $info->{smooth};
2522 my $idx = cf::face::find $face 2758 my $idx = cf::face::find $face
2523 or next; 2759 or next;
2524 if (my $smooth = cf::face::find $info->{smooth}) { 2760 if (my $smooth = cf::face::find $info->{smooth}) {
2761 cf::face::set_smooth $idx, $smooth;
2525 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2762 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2526 } else { 2763 } else {
2527 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2764 warn "smooth face '$info->{smooth}' not found for face '$face'";
2528 } 2765 }
2529 Coro::cede; 2766
2767 cf::cede_to_tick;
2530 } 2768 }
2531 } 2769 }
2532 2770
2533 { 2771 {
2534 my $anims = $facedata->{animinfo}; 2772 my $anims = $facedata->{animinfo};
2535 2773
2536 while (my ($anim, $info) = each %$anims) { 2774 while (my ($anim, $info) = each %$anims) {
2537 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2775 cf::anim::set $anim, $info->{frames}, $info->{facings};
2538 Coro::cede; 2776 cf::cede_to_tick;
2539 } 2777 }
2540 2778
2541 cf::anim::invalidate_all; # d'oh 2779 cf::anim::invalidate_all; # d'oh
2780 }
2781
2782 {
2783 # TODO: for gcfclient pleasure, we should give resources
2784 # that gcfclient doesn't grok a >10000 face index.
2785 my $res = $facedata->{resource};
2786 my $enc = JSON::XS->new->utf8->canonical;
2787
2788 while (my ($name, $info) = each %$res) {
2789 my $meta = $enc->encode ({
2790 name => $name,
2791 type => $info->{type},
2792 copyright => $info->{copyright}, #TODO#
2793 });
2794
2795 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2796
2797 if ($name =~ /\.jpg$/) {
2798 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2799 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2800 } else {
2801 my $data = pack "(w/a*)*", $meta, $info->{data};
2802 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2803
2804 cf::face::set_type $idx, 1;
2805 cf::face::set_data $idx, 0, $data, $chk;
2806 }
2807
2808 cf::cede_to_tick;
2809 }
2542 } 2810 }
2543 2811
2544 1 2812 1
2545} 2813}
2546 2814
2547sub reload_regions { 2815sub reload_regions {
2548 load_resource_file "$MAPDIR/regions" 2816 load_resource_file "$MAPDIR/regions"
2549 or die "unable to load regions file\n"; 2817 or die "unable to load regions file\n";
2818
2819 for (cf::region::list) {
2820 $_->{match} = qr/$_->{match}/
2821 if exists $_->{match};
2822 }
2550} 2823}
2551 2824
2552sub reload_facedata { 2825sub reload_facedata {
2553 load_facedata "$DATADIR/facedata" 2826 load_facedata "$DATADIR/facedata"
2554 or die "unable to load facedata\n"; 2827 or die "unable to load facedata\n";
2555} 2828}
2556 2829
2557sub reload_archetypes { 2830sub reload_archetypes {
2558 load_resource_file "$DATADIR/archetypes" 2831 load_resource_file "$DATADIR/archetypes"
2559 or die "unable to load archetypes\n"; 2832 or die "unable to load archetypes\n";
2833 #d# NEED to laod twice to resolve forward references
2834 # this really needs to be done in an extra post-pass
2835 # (which needs to be synchronous, so solve it differently)
2836 load_resource_file "$DATADIR/archetypes"
2837 or die "unable to load archetypes\n";
2560} 2838}
2561 2839
2562sub reload_treasures { 2840sub reload_treasures {
2563 load_resource_file "$DATADIR/treasures" 2841 load_resource_file "$DATADIR/treasures"
2564 or die "unable to load treasurelists\n"; 2842 or die "unable to load treasurelists\n";
2567sub reload_resources { 2845sub reload_resources {
2568 warn "reloading resource files...\n"; 2846 warn "reloading resource files...\n";
2569 2847
2570 reload_regions; 2848 reload_regions;
2571 reload_facedata; 2849 reload_facedata;
2850 #reload_archetypes;#d#
2572 reload_archetypes; 2851 reload_archetypes;
2573 reload_treasures; 2852 reload_treasures;
2574 2853
2575 warn "finished reloading resource files\n"; 2854 warn "finished reloading resource files\n";
2576} 2855}
2633 }, 2912 },
2634 ); 2913 );
2635 } 2914 }
2636} 2915}
2637 2916
2917sub write_runtime {
2918 my $runtime = "$LOCALDIR/runtime";
2919
2920 # first touch the runtime file to show we are still running:
2921 # the fsync below can take a very very long time.
2922
2923 IO::AIO::aio_utime $runtime, undef, undef;
2924
2925 my $guard = cf::lock_acquire "write_runtime";
2926
2927 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2928 or return;
2929
2930 my $value = $cf::RUNTIME + 90 + 10;
2931 # 10 is the runtime save interval, for a monotonic clock
2932 # 60 allows for the watchdog to kill the server.
2933
2934 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2935 and return;
2936
2937 # always fsync - this file is important
2938 aio_fsync $fh
2939 and return;
2940
2941 # touch it again to show we are up-to-date
2942 aio_utime $fh, undef, undef;
2943
2944 close $fh
2945 or return;
2946
2947 aio_rename "$runtime~", $runtime
2948 and return;
2949
2950 warn "runtime file written.\n";
2951
2952 1
2953}
2954
2638sub emergency_save() { 2955sub emergency_save() {
2639 my $freeze_guard = cf::freeze_mainloop; 2956 my $freeze_guard = cf::freeze_mainloop;
2640 2957
2641 warn "enter emergency perl save\n"; 2958 warn "enter emergency perl save\n";
2642 2959
2717 %EXT_CORO = (); 3034 %EXT_CORO = ();
2718 3035
2719 warn "removing commands"; 3036 warn "removing commands";
2720 %COMMAND = (); 3037 %COMMAND = ();
2721 3038
2722 warn "removing ext commands"; 3039 warn "removing ext/exti commands";
2723 %EXTCMD = (); 3040 %EXTCMD = ();
3041 %EXTICMD = ();
2724 3042
2725 warn "unloading/nuking all extensions"; 3043 warn "unloading/nuking all extensions";
2726 for my $pkg (@EXTS) { 3044 for my $pkg (@EXTS) {
2727 warn "... unloading $pkg"; 3045 warn "... unloading $pkg";
2728 3046
2846 my $signal = new Coro::Signal; 3164 my $signal = new Coro::Signal;
2847 push @WAIT_FOR_TICK_BEGIN, $signal; 3165 push @WAIT_FOR_TICK_BEGIN, $signal;
2848 $signal->wait; 3166 $signal->wait;
2849} 3167}
2850 3168
3169 my $min = 1e6;#d#
3170 my $avg = 10;
2851$TICK_WATCHER = Event->timer ( 3171$TICK_WATCHER = Event->timer (
2852 reentrant => 0, 3172 reentrant => 0,
2853 parked => 1, 3173 parked => 1,
2854 prio => 0, 3174 prio => 0,
2855 at => $NEXT_TICK || $TICK, 3175 at => $NEXT_TICK || $TICK,
2862 } 3182 }
2863 3183
2864 $NOW = $tick_start = Event::time; 3184 $NOW = $tick_start = Event::time;
2865 3185
2866 cf::server_tick; # one server iteration 3186 cf::server_tick; # one server iteration
3187
3188 0 && sync_job {#d#
3189 for(1..10) {
3190 my $t = Event::time;
3191 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3192 or die;
3193
3194 $map->width (50);
3195 $map->height (50);
3196 $map->alloc;
3197 $map->_load_objects ("/tmp/x.map", 1);
3198 my $t = Event::time - $t;
3199
3200 #next unless $t < 0.0013;#d#
3201 if ($t < $min) {
3202 $min = $t;
3203 }
3204 $avg = $avg * 0.99 + $t * 0.01;
3205 }
3206 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3207 exit 0;
3208 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3209 };
2867 3210
2868 $RUNTIME += $TICK; 3211 $RUNTIME += $TICK;
2869 $NEXT_TICK += $TICK; 3212 $NEXT_TICK += $TICK;
2870 3213
2871 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3214 if ($NOW >= $NEXT_RUNTIME_WRITE) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines