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.263 by root, Sat May 5 05:40:27 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 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;
90our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
91 94
92# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
95binmode STDOUT; 102binmode STDOUT;
96binmode STDERR; 103binmode STDERR;
97 104
98# read virtual server time, if available 105# read virtual server time, if available
99unless ($RUNTIME || !-e "$LOCALDIR/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
139 146
140=item $cf::TICK 147=item $cf::TICK
141 148
142The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
143 150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
160
144=item %cf::CFG 161=item %cf::CFG
145 162
146Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
147from wherever your confdir points to. 164from wherever your confdir points to.
148 165
149=item cf::wait_for_tick, cf::wait_for_tick_begin 166=item cf::wait_for_tick, cf::wait_for_tick_begin
150 167
151These 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
152returns 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
153per 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.
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.
154 177
155=back 178=back
156 179
157=cut 180=cut
158 181
173@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
174@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
175@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
176@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
177@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';
178@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)
179 203
180# 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
181# within the Safe compartment. 205# within the Safe compartment.
182for my $pkg (qw( 206for my $pkg (qw(
183 cf::global cf::attachable 207 cf::global cf::attachable
191} 215}
192 216
193$Event::DIED = sub { 217$Event::DIED = sub {
194 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
195}; 219};
220
221#############################################################################
196 222
197=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
198 224
199=over 4 225=over 4
200 226
219 $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;
220 $d 246 $d
221 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
222} 248}
223 249
224use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
225
226=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
227 251
228Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
229 253
230=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
231 255
232Converts 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]) }
233 264
234=item cf::lock_wait $string 265=item cf::lock_wait $string
235 266
236Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
237 268
303 334
304BEGIN { *async = \&Coro::async_pool } 335BEGIN { *async = \&Coro::async_pool }
305 336
306=item cf::sync_job { BLOCK } 337=item cf::sync_job { BLOCK }
307 338
308The design of crossfire+ requires that the main coro ($Coro::main) is 339The design of Crossfire TRT requires that the main coroutine ($Coro::main)
309always able to handle events or runnable, as crossfire+ is only partly 340is always able to handle events or runnable, as Crossfire TRT is only
310reentrant. 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.
311 343
312If 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
313the given BLOCK in another coroutine while waiting for the result. The 345the given BLOCK in another coroutine while waiting for the result. The
314server 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
315fast or be very important. 347fast or be very important.
318 350
319sub sync_job(&) { 351sub sync_job(&) {
320 my ($job) = @_; 352 my ($job) = @_;
321 353
322 if ($Coro::current == $Coro::main) { 354 if ($Coro::current == $Coro::main) {
355 my $time = Event::time;
356
323 # this is the main coro, too bad, we have to block 357 # this is the main coro, too bad, we have to block
324 # till the operation succeeds, freezing the server :/ 358 # till the operation succeeds, freezing the server :/
325 359
326 # TODO: use suspend/resume instead 360 # TODO: use suspend/resume instead
327 # (but this is cancel-safe) 361 # (but this is cancel-safe)
338 372
339 while ($busy) { 373 while ($busy) {
340 Coro::cede or Event::one_event; 374 Coro::cede or Event::one_event;
341 } 375 }
342 376
377 $time = Event::time - $time;
378
379 LOG llevError | logBacktrace, Carp::longmess "long sync job"
380 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
381
382 $tick_start += $time; # do not account sync jobs to server load
383
343 wantarray ? @res : $res[0] 384 wantarray ? @res : $res[0]
344 } else { 385 } else {
345 # we are in another coroutine, how wonderful, everything just works 386 # we are in another coroutine, how wonderful, everything just works
346 387
347 $job->() 388 $job->()
366 $EXT_CORO{$coro+0} = $coro; 407 $EXT_CORO{$coro+0} = $coro;
367 408
368 $coro 409 $coro
369} 410}
370 411
371sub write_runtime { 412=item fork_call { }, $args
372 my $guard = cf::lock_acquire "write_runtime";
373 413
374 my $runtime = "$LOCALDIR/runtime"; 414Executes the given code block with the given arguments in a seperate
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.
375 418
376 warn "starting to write runtime...\n";#d# 419=cut
377 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
378 or return;
379 420
380 my $value = $cf::RUNTIME + 90 + 10; 421sub _store_scalar {
381 # 10 is the runtime save interval, for a monotonic clock 422 open my $fh, ">", \my $buf
382 # 60 allows for the watchdog to kill the server. 423 or die "fork_call: cannot open fh-to-buf in child : $!";
383 424 Storable::store_fd $_[0], $fh;
384 (aio_write $fh, 0, (length $value), $value, 0) <= 0
385 and return;
386
387 # always fsync - this file is important
388 aio_fsync $fh
389 and return;
390
391 close $fh 425 close $fh;
392 or return;
393 426
394 aio_rename "$runtime~", $runtime 427 $buf
395 and return; 428}
396 429
397 warn "... done writing runtime.\n";#d# 430sub fork_call(&@) {
431 my ($cb, @args) = @_;
398 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;
399 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"
400} 588}
401 589
402=item cf::datalog type => key => value, ... 590=item cf::datalog type => key => value, ...
403 591
404Log 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.
422attach callbacks/event handlers (a collection of which is called an "attachment") 610attach callbacks/event handlers (a collection of which is called an "attachment")
423to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
424 612
425In 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>
426C<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
427crossfire+). 615Crossfire TRT).
428 616
429=over 4 617=over 4
430 618
431=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
432 620
595 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
596 784
597 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
598 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
599 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
600 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
601 789
602 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
603 my $pkg = shift @arg; 791 my $pkg = shift @arg;
604 792
605 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
634 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
635 } 823 }
636 824
637 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
638 } else { 826 } else {
639 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
640 } 828 }
641 829
642 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
643} 831}
644 832
646 if (ref $_[0]) { 834 if (ref $_[0]) {
647 _object_attach @_; 835 _object_attach @_;
648 } else { 836 } else {
649 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
650 } 838 }
839 _recalc_want;
651}; 840};
652 841
653# all those should be optimised 842# all those should be optimised
654sub cf::attachable::detach { 843sub cf::attachable::detach {
655 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
658 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
659 reattach ($obj); 848 reattach ($obj);
660 } else { 849 } else {
661 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
662 } 851 }
852 _recalc_want;
663}; 853};
664 854
665sub cf::attachable::attached { 855sub cf::attachable::attached {
666 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
667 857
682 "; 872 ";
683 die if $@; 873 die if $@;
684} 874}
685 875
686our $override; 876our $override;
687our @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?
688 878
689sub override { 879sub override {
690 $override = 1; 880 $override = 1;
691 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
692} 882}
693 883
694sub do_invoke { 884sub do_invoke {
695 my $event = shift; 885 my $event = shift;
696 my $callbacks = shift; 886 my $callbacks = shift;
697 887
698 @invoke_results = (); 888 @INVOKE_RESULTS = ();
699 889
700 local $override; 890 local $override;
701 891
702 for (@$callbacks) { 892 for (@$callbacks) {
703 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
720 910
721Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
722 912
723This 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
724removed 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
725results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
726 916
727=back 917=back
728 918
729=cut 919=cut
730 920
840 or return; 1030 or return;
841 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
842 } 1032 }
843 1033
844 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
845 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
846 return ($data, $av); 1036 return ($data, $av);
847} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
848 1044
849############################################################################# 1045#############################################################################
850# command handling &c 1046# command handling &c
851 1047
852=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
865 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
866} 1062}
867 1063
868=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
869 1065
870Register 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.
871 1071
872If 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
873called. 1073called.
874 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
875=cut 1086=cut
876 1087
877sub register_extcmd { 1088sub register_extcmd {
878 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
879 1090
880 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
881} 1098}
882 1099
883cf::player->attach ( 1100cf::player->attach (
884 on_command => sub { 1101 on_command => sub {
885 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
894 cf::override; 1111 cf::override;
895 }, 1112 },
896 on_extcmd => sub { 1113 on_extcmd => sub {
897 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
898 1115
899 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
900 1117
901 if (ref $msg) { 1118 if (ref $msg) {
902 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
903 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
904 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
910 1127
911 cf::override; 1128 cf::override;
912 }, 1129 },
913); 1130);
914 1131
915sub load_extension {
916 my ($path) = @_;
917
918 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
919 my $base = $1;
920 my $pkg = $1;
921 $pkg =~ s/[^[:word:]]/_/g;
922 $pkg = "ext::$pkg";
923
924 warn "... loading '$path' into '$pkg'\n";
925
926 open my $fh, "<:utf8", $path
927 or die "$path: $!";
928
929 my $source =
930 "package $pkg; use strict; use utf8;\n"
931 . "#line 1 \"$path\"\n{\n"
932 . (do { local $/; <$fh> })
933 . "\n};\n1";
934
935 unless (eval $source) {
936 my $msg = $@ ? "$path: $@\n"
937 : "extension disabled.\n";
938 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
939 warn $@;
940 warn "mandatory extension failed to load, exiting.\n";
941 exit 1;
942 }
943 die $@;
944 }
945
946 push @EXTS, $pkg;
947}
948
949sub load_extensions { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
950 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
951 next unless -r $ext; 1137 next unless -r $path;
952 eval { 1138
953 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;
954 1 1196 }
955 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
956 } 1202 };
957} 1203}
958 1204
959############################################################################# 1205#############################################################################
1206
1207=back
960 1208
961=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
962 1210
963Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
964 1212
1152 } 1400 }
1153 1401
1154 \@paths 1402 \@paths
1155} 1403}
1156 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
1157=item $player->ext_reply ($msgid, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1158 1456
1159Sends an ext reply to the player. 1457Sends an ext reply to the player.
1160 1458
1161=cut 1459=cut
1162 1460
1163sub ext_reply($$%) { 1461sub ext_reply($$%) {
1164 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1165 1463
1166 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1167 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1168 $self->send ("ext " . cf::to_json \%msg);
1169} 1466}
1170 1467
1171=item $player->ext_event ($type, %msg) 1468=item $player->ext_event ($type, %msg)
1172 1469
1173Sends an ext event to the client. 1470Sends an ext event to the client.
1188 1485
1189package cf::region; 1486package cf::region;
1190 1487
1191=item cf::region::find_by_path $path 1488=item cf::region::find_by_path $path
1192 1489
1193Tries 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.
1194 1491
1195=cut 1492=cut
1196 1493
1197sub find_by_path($) { 1494sub find_by_path($) {
1198 my ($path) = @_; 1495 my ($path) = @_;
1199 1496
1200 my ($match, $specificity); 1497 my ($match, $specificity);
1201 1498
1202 for my $region (list) { 1499 for my $region (list) {
1203 if ($region->match && $path =~ $region->match) { 1500 if ($region->{match} && $path =~ $region->{match}) {
1204 ($match, $specificity) = ($region, $region->specificity) 1501 ($match, $specificity) = ($region, $region->specificity)
1205 if $region->specificity > $specificity; 1502 if $region->specificity > $specificity;
1206 } 1503 }
1207 } 1504 }
1208 1505
1272 my ($self, $merge) = @_; 1569 my ($self, $merge) = @_;
1273 1570
1274 # we have to keep some variables in memory intact 1571 # we have to keep some variables in memory intact
1275 local $self->{path}; 1572 local $self->{path};
1276 local $self->{load_path}; 1573 local $self->{load_path};
1277 local $self->{deny_save};
1278 local $self->{deny_reset};
1279 1574
1280 $self->SUPER::thawer_merge ($merge); 1575 $self->SUPER::thawer_merge ($merge);
1281} 1576}
1282 1577
1283sub normalise { 1578sub normalise {
1330 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1331 return $self; 1626 return $self;
1332 } 1627 }
1333 } 1628 }
1334 1629
1335 Carp::carp "unable to resolve path '$path' (base '$base')."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1336 () 1631 ()
1337} 1632}
1338 1633
1339sub init { 1634sub init {
1340 my ($self) = @_; 1635 my ($self) = @_;
1381sub change_all_map_light { 1676sub change_all_map_light {
1382 my ($change) = @_; 1677 my ($change) = @_;
1383 1678
1384 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1385 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;
1386} 1689}
1387 1690
1388sub unlink_save { 1691sub unlink_save {
1389 my ($self) = @_; 1692 my ($self) = @_;
1390 1693
1448 $self->load_header_orig 1751 $self->load_header_orig
1449 or return; 1752 or return;
1450 $self->prepare_orig; 1753 $self->prepare_orig;
1451 } 1754 }
1452 1755
1756 $self->{deny_reset} = 1
1757 if $self->no_reset;
1758
1453 $self->default_region (cf::region::find_by_path $self->{path}) 1759 $self->default_region (cf::region::find_by_path $self->{path})
1454 unless $self->default_region; 1760 unless $self->default_region;
1455 1761
1456 1 1762 1
1457} 1763}
1472 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1473 1779
1474 $map->load_header 1780 $map->load_header
1475 or return; 1781 or return;
1476 1782
1477 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1783 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1478 # doing this can freeze the server in a sync job, obviously 1784 # doing this can freeze the server in a sync job, obviously
1479 #$cf::WAIT_FOR_TICK->wait; 1785 #$cf::WAIT_FOR_TICK->wait;
1480 $map->reset; 1786 $map->reset;
1481 undef $guard; 1787 undef $guard;
1482 return find $path; 1788 return find $path;
1549 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1550 1856
1551 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1552 if $self->per_player; 1858 if $self->per_player;
1553 1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1862
1554 $self 1863 $self
1555} 1864}
1556 1865
1557# 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
1558sub load_diag { 1867sub load_diag {
1604 1913
1605 undef $MAP_PREFETCH{$path}; 1914 undef $MAP_PREFETCH{$path};
1606 $MAP_PREFETCHER ||= cf::async { 1915 $MAP_PREFETCHER ||= cf::async {
1607 while (%MAP_PREFETCH) { 1916 while (%MAP_PREFETCH) {
1608 for my $path (keys %MAP_PREFETCH) { 1917 for my $path (keys %MAP_PREFETCH) {
1609 my $map = find $path 1918 if (my $map = find $path) {
1610 or next;
1611 $map->load; 1919 $map->load;
1920 }
1612 1921
1613 delete $MAP_PREFETCH{$path}; 1922 delete $MAP_PREFETCH{$path};
1614 } 1923 }
1615 } 1924 }
1616 undef $MAP_PREFETCHER; 1925 undef $MAP_PREFETCHER;
1668 1977
1669sub reset_at { 1978sub reset_at {
1670 my ($self) = @_; 1979 my ($self) = @_;
1671 1980
1672 # TODO: safety, remove and allow resettable per-player maps 1981 # TODO: safety, remove and allow resettable per-player maps
1673 return 1e99 if $self->isa ("ext::map_per_player");#d#
1674 return 1e99 if $self->{deny_reset}; 1982 return 1e99 if $self->{deny_reset};
1675 1983
1676 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1677 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;
1678 1986
1689 my ($self) = @_; 1997 my ($self) = @_;
1690 1998
1691 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1692 2000
1693 return if $self->players; 2001 return if $self->players;
1694 return if $self->isa ("ext::map_per_player");#d#
1695 2002
1696 warn "resetting map ", $self->path;#d# 2003 warn "resetting map ", $self->path;
1697 2004
1698 $self->in_memory (cf::MAP_SWAPPED); 2005 $self->in_memory (cf::MAP_SWAPPED);
1699 2006
1700 # need to save uniques path 2007 # need to save uniques path
1701 unless ($self->{deny_save}) { 2008 unless ($self->{deny_save}) {
1733 $cf::MAP{$self->path} = $self; 2040 $cf::MAP{$self->path} = $self;
1734 2041
1735 $self->reset; # polite request, might not happen 2042 $self->reset; # polite request, might not happen
1736} 2043}
1737 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
1738=item cf::map::unique_maps 2081=item cf::map::unique_maps
1739 2082
1740Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1741instantiated unique items. May block. 2084instantiated unique items. May block.
1742 2085
1743=cut 2086=cut
1744 2087
1745sub unique_maps() { 2088sub unique_maps() {
1746 my $files = aio_readdir $UNIQUEDIR 2089 [
1747 or return; 2090 map {
1748
1749 my @paths;
1750
1751 for (@$files) {
1752 utf8::decode $_; 2091 utf8::decode $_;
1753 next if /\.pst$/; 2092 /\.map$/
1754 next unless /^$PATH_SEP/o; 2093 ? normalise $_
1755 2094 : ()
1756 push @paths, cf::map::normalise $_; 2095 } @{ aio_readdir $UNIQUEDIR or [] }
1757 } 2096 ]
1758
1759 \@paths
1760} 2097}
1761 2098
1762package cf; 2099package cf;
1763 2100
1764=back 2101=back
1810 2147
1811 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1812 2149
1813 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1814 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1815 } 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 {
1816 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1817 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1818 } 2169 }
1819} 2170}
1820 2171
1821=item $player_object->may ("access") 2172=item $player_object->may ("access")
1822 2173
1870 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1871 2222
1872 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1873 2224
1874 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1875 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1876 2227
1877 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1878} 2229}
1879 2230
1880sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1881 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1882 2235
1883 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1884 2237
1885 unless ($map) { 2238 unless ($map) {
1886 # restore original map position 2239 # restore original map position
1909 2262
1910 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1911 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1912} 2265}
1913 2266
1914cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1915 on_logout => sub {
1916 my ($pl) = @_;
1917 2268
1918 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1919 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1920 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1921 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1922 }; 2273be called at the end of this process.
1923 }
1924 },
1925 on_login => sub {
1926 my ($pl) = @_;
1927 2274
1928 # try to abort aborted map switching on player login :)
1929 # should happen only on crashes
1930 if ($pl->ob->{_link_pos}) {
1931 $pl->ob->enter_link;
1932 (async {
1933 $pl->ob->reply (undef,
1934 "There was an internal problem at your last logout, "
1935 . "the server will try to bring you to your intended destination in a second.",
1936 cf::NDI_RED);
1937 # we need this sleep as the login has a concurrent enter_exit running
1938 # and this sleep increases chances of the player not ending up in scorn
1939 Coro::Timer::sleep 1;
1940 $pl->ob->leave_link;
1941 })->prio (2);
1942 }
1943 },
1944);
1945
1946=item $player_object->goto ($path, $x, $y)
1947
1948=cut 2275=cut
2276
2277our $GOTOGEN;
1949 2278
1950sub cf::object::player::goto { 2279sub cf::object::player::goto {
1951 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;
1952 2284
1953 $self->enter_link; 2285 $self->enter_link;
1954 2286
1955 (async { 2287 (async {
1956 my $map = eval { 2288 my $map = eval {
1957 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1958 $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
1959 $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 $@;
1960 } or 2304 }
1961 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1962 2305
2306 if ($gen == $self->{_goto_generation}) {
2307 delete $self->{_goto_generation};
1963 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1964 })->prio (1); 2312 })->prio (1);
1965} 2313}
1966 2314
1967=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
1968 2316
2037 my $hp = $exit->stats->hp; 2385 my $hp = $exit->stats->hp;
2038 my $sp = $exit->stats->sp; 2386 my $sp = $exit->stats->sp;
2039 2387
2040 $self->enter_link; 2388 $self->enter_link;
2041 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
2042 (async { 2394 (async {
2043 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
2044 unless (eval { 2396 unless (eval {
2045 $self->goto ($slaying, $hp, $sp); 2397 $self->goto ($slaying, $hp, $sp);
2046 2398
2073 2425
2074 utf8::encode $text; 2426 utf8::encode $text;
2075 $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);
2076} 2428}
2077 2429
2430=item $client->send_msg ($color, $type, $msg, [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, $color, $type, $msg, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 if ($self->can_msg) {
2447 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2448 } else {
2449 # replace some tags by gcfclient-compatible ones
2450 for ($msg) {
2451 1 while
2452 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2453 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2454 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2455 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2456 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2457 }
2458
2459 if ($color >= 0) {
2460 if (0 && $msg =~ /\[/) {
2461 $self->send_packet ("drawextinfo $color 4 0 $msg")
2462 } else {
2463 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2464 $self->send_packet ("drawinfo $color $msg")
2465 }
2466 }
2467 }
2468}
2469
2078=item $client->ext_event ($type, %msg) 2470=item $client->ext_event ($type, %msg)
2079 2471
2080Sends an exti event to the client. 2472Sends an ext event to the client.
2081 2473
2082=cut 2474=cut
2083 2475
2084sub cf::client::ext_event($$%) { 2476sub cf::client::ext_event($$%) {
2085 my ($self, $type, %msg) = @_; 2477 my ($self, $type, %msg) = @_;
2086 2478
2479 return unless $self->extcmd;
2480
2087 $msg{msgtype} = "event_$type"; 2481 $msg{msgtype} = "event_$type";
2088 $self->send_packet ("ext " . cf::to_json \%msg); 2482 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2089} 2483}
2090 2484
2091=item $success = $client->query ($flags, "text", \&cb) 2485=item $success = $client->query ($flags, "text", \&cb)
2092 2486
2093Queues a query to the client, calling the given callback with 2487Queues a query to the client, calling the given callback with
2094the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2488the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2095C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2489C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2096 2490
2097Queries can fail, so check the return code. Or don't, as queries will become 2491Queries can fail, so check the return code. Or don't, as queries will
2098reliable at some point in the future. 2492become reliable at some point in the future.
2099 2493
2100=cut 2494=cut
2101 2495
2102sub cf::client::query { 2496sub cf::client::query {
2103 my ($self, $flags, $text, $cb) = @_; 2497 my ($self, $flags, $text, $cb) = @_;
2111 utf8::encode $text; 2505 utf8::encode $text;
2112 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2506 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2113 2507
2114 $self->send_packet ($self->{query_queue}[0][0]) 2508 $self->send_packet ($self->{query_queue}[0][0])
2115 if @{ $self->{query_queue} } == 1; 2509 if @{ $self->{query_queue} } == 1;
2510
2511 1
2116} 2512}
2117 2513
2118cf::client->attach ( 2514cf::client->attach (
2515 on_connect => sub {
2516 my ($ns) = @_;
2517
2518 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2519 },
2119 on_reply => sub { 2520 on_reply => sub {
2120 my ($ns, $msg) = @_; 2521 my ($ns, $msg) = @_;
2121 2522
2122 # this weird shuffling is so that direct followup queries 2523 # this weird shuffling is so that direct followup queries
2123 # get handled first 2524 # get handled first
2135 } else { 2536 } else {
2136 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2537 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2137 } 2538 }
2138 } 2539 }
2139 }, 2540 },
2541 on_exticmd => sub {
2542 my ($ns, $buf) = @_;
2543
2544 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2545
2546 if (ref $msg) {
2547 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2548 if (my %reply = $cb->($ns, $msg)) {
2549 $reply{msgid} = $msg->{msgid};
2550 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2551 }
2552 }
2553 } else {
2554 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2555 }
2556
2557 cf::override;
2558 },
2140); 2559);
2141 2560
2142=item $client->async (\&cb) 2561=item $client->async (\&cb)
2143 2562
2144Create a new coroutine, running the specified callback. The coroutine will 2563Create a new coroutine, running the specified callback. The coroutine will
2193 2612
2194=pod 2613=pod
2195 2614
2196The following functions and methods are available within a safe environment: 2615The following functions and methods are available within a safe environment:
2197 2616
2198 cf::object contr pay_amount pay_player map 2617 cf::object
2618 contr pay_amount pay_player map x y force_find force_add
2619 insert remove
2620
2199 cf::object::player player 2621 cf::object::player
2200 cf::player peaceful 2622 player
2201 cf::map trigger 2623
2624 cf::player
2625 peaceful
2626
2627 cf::map
2628 trigger
2202 2629
2203=cut 2630=cut
2204 2631
2205for ( 2632for (
2206 ["cf::object" => qw(contr pay_amount pay_player map)], 2633 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2634 insert remove)],
2207 ["cf::object::player" => qw(player)], 2635 ["cf::object::player" => qw(player)],
2208 ["cf::player" => qw(peaceful)], 2636 ["cf::player" => qw(peaceful)],
2209 ["cf::map" => qw(trigger)], 2637 ["cf::map" => qw(trigger)],
2210) { 2638) {
2211 no strict 'refs'; 2639 no strict 'refs';
2282=back 2710=back
2283 2711
2284=cut 2712=cut
2285 2713
2286############################################################################# 2714#############################################################################
2287
2288=head2 EXTENSION DATABASE SUPPORT
2289
2290Crossfire maintains a very simple database for extension use. It can
2291currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2292convert to/from binary).
2293
2294The parameter C<$family> should best start with the name of the extension
2295using it, it should be unique.
2296
2297=over 4
2298
2299=item $value = cf::db_get $family => $key
2300
2301Returns a single value from the database.
2302
2303=item cf::db_put $family => $key => $value
2304
2305Stores the given C<$value> in the family.
2306
2307=cut
2308
2309our $DB;
2310
2311sub db_init {
2312 unless ($DB) {
2313 $DB = BDB::db_create $DB_ENV;
2314
2315 cf::sync_job {
2316 eval {
2317 $DB->set_flags (BDB::CHKSUM);
2318
2319 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2320 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2321 cf::cleanup "db_open(db): $!" if $!;
2322 };
2323 cf::cleanup "db_open(db): $@" if $@;
2324 };
2325 }
2326}
2327
2328sub db_get($$) {
2329 my $key = "$_[0]/$_[1]";
2330
2331 cf::sync_job {
2332 BDB::db_get $DB, undef, $key, my $data;
2333
2334 $! ? ()
2335 : $data
2336 }
2337}
2338
2339sub db_put($$$) {
2340 BDB::dbreq_pri 4;
2341 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2342}
2343
2344=item cf::cache $id => [$paths...], $processversion => $process
2345
2346Generic caching function that returns the value of the resource $id,
2347caching and regenerating as required.
2348
2349This function can block.
2350
2351=cut
2352
2353sub cache {
2354 my ($id, $src, $processversion, $process) = @_;
2355
2356 my $meta =
2357 join "\x00",
2358 $processversion,
2359 map {
2360 aio_stat $_
2361 and Carp::croak "$_: $!";
2362
2363 ($_, (stat _)[7,9])
2364 } @$src;
2365
2366 my $dbmeta = db_get cache => "$id/meta";
2367 if ($dbmeta ne $meta) {
2368 # changed, we may need to process
2369
2370 my @data;
2371 my $md5;
2372
2373 for (0 .. $#$src) {
2374 0 <= aio_load $src->[$_], $data[$_]
2375 or Carp::croak "$src->[$_]: $!";
2376 }
2377
2378 # if processing is expensive, check
2379 # checksum first
2380 if (1) {
2381 $md5 =
2382 join "\x00",
2383 $processversion,
2384 map {
2385 Coro::cede;
2386 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2387 } 0.. $#$src;
2388
2389
2390 my $dbmd5 = db_get cache => "$id/md5";
2391 if ($dbmd5 eq $md5) {
2392 db_put cache => "$id/meta", $meta;
2393
2394 return db_get cache => "$id/data";
2395 }
2396 }
2397
2398 my $t1 = Time::HiRes::time;
2399 my $data = $process->(\@data);
2400 my $t2 = Time::HiRes::time;
2401
2402 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2403
2404 db_put cache => "$id/data", $data;
2405 db_put cache => "$id/md5" , $md5;
2406 db_put cache => "$id/meta", $meta;
2407
2408 return $data;
2409 }
2410
2411 db_get cache => "$id/data"
2412}
2413
2414=item fork_call { }, $args
2415
2416Executes the given code block with the given arguments in a seperate
2417process, returning the results. Everything must be serialisable with
2418Coro::Storable. May, of course, block. Note that the executed sub may
2419never block itself or use any form of Event handling.
2420
2421=cut
2422
2423sub fork_call(&@) {
2424 my ($cb, @args) = @_;
2425
2426# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2427# or die "socketpair: $!";
2428 pipe my $fh1, my $fh2
2429 or die "pipe: $!";
2430
2431 if (my $pid = fork) {
2432 close $fh2;
2433
2434 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2435 $res = Coro::Storable::thaw $res;
2436
2437 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2438
2439 die $$res unless "ARRAY" eq ref $res;
2440
2441 return wantarray ? @$res : $res->[-1];
2442 } else {
2443 reset_signals;
2444 local $SIG{__WARN__};
2445 local $SIG{__DIE__};
2446 eval {
2447 close $fh1;
2448
2449 my @res = eval { $cb->(@args) };
2450 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2451 };
2452
2453 warn $@ if $@;
2454 _exit 0;
2455 }
2456}
2457
2458
2459
2460#############################################################################
2461# the server's init and main functions 2715# the server's init and main functions
2462 2716
2463sub load_facedata($) { 2717sub load_facedata($) {
2464 my ($path) = @_; 2718 my ($path) = @_;
2465 2719
2477 { 2731 {
2478 my $faces = $facedata->{faceinfo}; 2732 my $faces = $facedata->{faceinfo};
2479 2733
2480 while (my ($face, $info) = each %$faces) { 2734 while (my ($face, $info) = each %$faces) {
2481 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2735 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2482 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2736 cf::face::set_visibility $idx, $info->{visibility};
2737 cf::face::set_magicmap $idx, $info->{magicmap};
2483 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2738 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2484 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2739 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2485 Coro::cede; 2740
2741 cf::cede_to_tick;
2486 } 2742 }
2487 2743
2488 while (my ($face, $info) = each %$faces) { 2744 while (my ($face, $info) = each %$faces) {
2489 next unless $info->{smooth}; 2745 next unless $info->{smooth};
2490 my $idx = cf::face::find $face 2746 my $idx = cf::face::find $face
2491 or next; 2747 or next;
2492 if (my $smooth = cf::face::find $info->{smooth}) { 2748 if (my $smooth = cf::face::find $info->{smooth}) {
2749 cf::face::set_smooth $idx, $smooth;
2493 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2750 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2494 } else { 2751 } else {
2495 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2752 warn "smooth face '$info->{smooth}' not found for face '$face'";
2496 } 2753 }
2497 Coro::cede; 2754
2755 cf::cede_to_tick;
2498 } 2756 }
2499 } 2757 }
2500 2758
2501 { 2759 {
2502 my $anims = $facedata->{animinfo}; 2760 my $anims = $facedata->{animinfo};
2503 2761
2504 while (my ($anim, $info) = each %$anims) { 2762 while (my ($anim, $info) = each %$anims) {
2505 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2763 cf::anim::set $anim, $info->{frames}, $info->{facings};
2506 Coro::cede; 2764 cf::cede_to_tick;
2507 } 2765 }
2508 2766
2509 cf::anim::invalidate_all; # d'oh 2767 cf::anim::invalidate_all; # d'oh
2768 }
2769
2770 {
2771 # TODO: for gcfclient pleasure, we should give resources
2772 # that gcfclient doesn't grok a >10000 face index.
2773 my $res = $facedata->{resource};
2774 my $enc = JSON::XS->new->utf8->canonical;
2775
2776 while (my ($name, $info) = each %$res) {
2777 my $meta = $enc->encode ({
2778 name => $name,
2779 type => $info->{type},
2780 copyright => $info->{copyright}, #TODO#
2781 });
2782
2783 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2784
2785 if ($name =~ /\.jpg$/) {
2786 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2787 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2788 } else {
2789 my $data = pack "(w/a*)*", $meta, $info->{data};
2790 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2791
2792 cf::face::set_type $idx, 1;
2793 cf::face::set_data $idx, 0, $data, $chk;
2794 }
2795
2796 cf::cede_to_tick;
2797 }
2510 } 2798 }
2511 2799
2512 1 2800 1
2513} 2801}
2514 2802
2515sub reload_regions { 2803sub reload_regions {
2516 load_resource_file "$MAPDIR/regions" 2804 load_resource_file "$MAPDIR/regions"
2517 or die "unable to load regions file\n"; 2805 or die "unable to load regions file\n";
2806
2807 for (cf::region::list) {
2808 $_->{match} = qr/$_->{match}/
2809 if exists $_->{match};
2810 }
2518} 2811}
2519 2812
2520sub reload_facedata { 2813sub reload_facedata {
2521 load_facedata "$DATADIR/facedata" 2814 load_facedata "$DATADIR/facedata"
2522 or die "unable to load facedata\n"; 2815 or die "unable to load facedata\n";
2523} 2816}
2524 2817
2525sub reload_archetypes { 2818sub reload_archetypes {
2526 load_resource_file "$DATADIR/archetypes" 2819 load_resource_file "$DATADIR/archetypes"
2527 or die "unable to load archetypes\n"; 2820 or die "unable to load archetypes\n";
2821 #d# NEED to laod twice to resolve forward references
2822 # this really needs to be done in an extra post-pass
2823 # (which needs to be synchronous, so solve it differently)
2824 load_resource_file "$DATADIR/archetypes"
2825 or die "unable to load archetypes\n";
2528} 2826}
2529 2827
2530sub reload_treasures { 2828sub reload_treasures {
2531 load_resource_file "$DATADIR/treasures" 2829 load_resource_file "$DATADIR/treasures"
2532 or die "unable to load treasurelists\n"; 2830 or die "unable to load treasurelists\n";
2535sub reload_resources { 2833sub reload_resources {
2536 warn "reloading resource files...\n"; 2834 warn "reloading resource files...\n";
2537 2835
2538 reload_regions; 2836 reload_regions;
2539 reload_facedata; 2837 reload_facedata;
2838 #reload_archetypes;#d#
2540 reload_archetypes; 2839 reload_archetypes;
2541 reload_treasures; 2840 reload_treasures;
2542 2841
2543 warn "finished reloading resource files\n"; 2842 warn "finished reloading resource files\n";
2544} 2843}
2601 }, 2900 },
2602 ); 2901 );
2603 } 2902 }
2604} 2903}
2605 2904
2905sub write_runtime {
2906 my $runtime = "$LOCALDIR/runtime";
2907
2908 # first touch the runtime file to show we are still running:
2909 # the fsync below can take a very very long time.
2910
2911 IO::AIO::aio_utime $runtime, undef, undef;
2912
2913 my $guard = cf::lock_acquire "write_runtime";
2914
2915 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2916 or return;
2917
2918 my $value = $cf::RUNTIME + 90 + 10;
2919 # 10 is the runtime save interval, for a monotonic clock
2920 # 60 allows for the watchdog to kill the server.
2921
2922 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2923 and return;
2924
2925 # always fsync - this file is important
2926 aio_fsync $fh
2927 and return;
2928
2929 # touch it again to show we are up-to-date
2930 aio_utime $fh, undef, undef;
2931
2932 close $fh
2933 or return;
2934
2935 aio_rename "$runtime~", $runtime
2936 and return;
2937
2938 warn "runtime file written.\n";
2939
2940 1
2941}
2942
2606sub emergency_save() { 2943sub emergency_save() {
2607 my $freeze_guard = cf::freeze_mainloop; 2944 my $freeze_guard = cf::freeze_mainloop;
2608 2945
2609 warn "enter emergency perl save\n"; 2946 warn "enter emergency perl save\n";
2610 2947
2685 %EXT_CORO = (); 3022 %EXT_CORO = ();
2686 3023
2687 warn "removing commands"; 3024 warn "removing commands";
2688 %COMMAND = (); 3025 %COMMAND = ();
2689 3026
2690 warn "removing ext commands"; 3027 warn "removing ext/exti commands";
2691 %EXTCMD = (); 3028 %EXTCMD = ();
3029 %EXTICMD = ();
2692 3030
2693 warn "unloading/nuking all extensions"; 3031 warn "unloading/nuking all extensions";
2694 for my $pkg (@EXTS) { 3032 for my $pkg (@EXTS) {
2695 warn "... unloading $pkg"; 3033 warn "... unloading $pkg";
2696 3034
2814 my $signal = new Coro::Signal; 3152 my $signal = new Coro::Signal;
2815 push @WAIT_FOR_TICK_BEGIN, $signal; 3153 push @WAIT_FOR_TICK_BEGIN, $signal;
2816 $signal->wait; 3154 $signal->wait;
2817} 3155}
2818 3156
3157 my $min = 1e6;#d#
3158 my $avg = 10;
2819$TICK_WATCHER = Event->timer ( 3159$TICK_WATCHER = Event->timer (
2820 reentrant => 0, 3160 reentrant => 0,
2821 parked => 1, 3161 parked => 1,
2822 prio => 0, 3162 prio => 0,
2823 at => $NEXT_TICK || $TICK, 3163 at => $NEXT_TICK || $TICK,
2827 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3167 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2828 unless ++$bug_warning > 10; 3168 unless ++$bug_warning > 10;
2829 return; 3169 return;
2830 } 3170 }
2831 3171
2832 $NOW = Event::time; 3172 $NOW = $tick_start = Event::time;
2833 3173
2834 cf::server_tick; # one server iteration 3174 cf::server_tick; # one server iteration
3175
3176 0 && sync_job {#d#
3177 for(1..10) {
3178 my $t = Event::time;
3179 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3180 or die;
3181
3182 $map->width (50);
3183 $map->height (50);
3184 $map->alloc;
3185 $map->_load_objects ("/tmp/x.map", 1);
3186 my $t = Event::time - $t;
3187
3188 #next unless $t < 0.0013;#d#
3189 if ($t < $min) {
3190 $min = $t;
3191 }
3192 $avg = $avg * 0.99 + $t * 0.01;
3193 }
3194 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3195 exit 0;
3196 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3197 };
2835 3198
2836 $RUNTIME += $TICK; 3199 $RUNTIME += $TICK;
2837 $NEXT_TICK += $TICK; 3200 $NEXT_TICK += $TICK;
2838 3201
2839 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3202 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2845 } 3208 }
2846 3209
2847# my $AFTER = Event::time; 3210# my $AFTER = Event::time;
2848# warn $AFTER - $NOW;#d# 3211# warn $AFTER - $NOW;#d#
2849 3212
3213 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3214 $sig->send;
3215 }
3216 while (my $sig = shift @WAIT_FOR_TICK) {
3217 $sig->send;
3218 }
3219
3220 $NOW = Event::time;
3221
2850 # if we are delayed by four ticks or more, skip them all 3222 # if we are delayed by four ticks or more, skip them all
2851 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3223 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2852 3224
2853 $TICK_WATCHER->at ($NEXT_TICK); 3225 $TICK_WATCHER->at ($NEXT_TICK);
2854 $TICK_WATCHER->start; 3226 $TICK_WATCHER->start;
2855 3227
2856 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3228 $LOAD = ($NOW - $tick_start) / $TICK;
2857 $sig->send; 3229 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2858 }
2859 while (my $sig = shift @WAIT_FOR_TICK) {
2860 $sig->send;
2861 }
2862 3230
2863 _post_tick; 3231 _post_tick;
3232
3233
2864 }, 3234 },
2865); 3235);
2866 3236
2867{ 3237{
2868 BDB::max_poll_time $TICK * 0.1; 3238 BDB::max_poll_time $TICK * 0.1;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines