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.264 by root, Sun May 6 05:44:48 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;
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 $runtime = "$LOCALDIR/runtime";
373 413
374 # first touch the runtime file to show we are still running: 414Executes the given code block with the given arguments in a seperate
375 # 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.
376 418
377 warn "touching runtime...\n";#d# 419=cut
378 if (my $fh = aio_open $runtime, O_WRONLY, 0) {
379 utime undef, undef, $fh;
380 }
381 420
382 my $guard = cf::lock_acquire "write_runtime"; 421sub _store_scalar {
383 422 open my $fh, ">", \my $buf
384 warn "starting to write runtime...\n";#d# 423 or die "fork_call: cannot open fh-to-buf in child : $!";
385 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 424 Storable::store_fd $_[0], $fh;
386 or return;
387
388 my $value = $cf::RUNTIME + 90 + 10;
389 # 10 is the runtime save interval, for a monotonic clock
390 # 60 allows for the watchdog to kill the server.
391
392 (aio_write $fh, 0, (length $value), $value, 0) <= 0
393 and return;
394
395 # always fsync - this file is important
396 aio_fsync $fh
397 and return;
398
399 # touch it again to show we are up-to-date
400 utime undef, undef, $fh;
401
402 close $fh 425 close $fh;
403 or return;
404 426
405 aio_rename "$runtime~", $runtime 427 $buf
406 and return; 428}
407 429
408 warn "... done writing runtime.\n";#d# 430sub fork_call(&@) {
431 my ($cb, @args) = @_;
409 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;
410 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"
411} 588}
412 589
413=item cf::datalog type => key => value, ... 590=item cf::datalog type => key => value, ...
414 591
415Log 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.
433attach callbacks/event handlers (a collection of which is called an "attachment") 610attach callbacks/event handlers (a collection of which is called an "attachment")
434to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
435 612
436In 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>
437C<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
438crossfire+). 615Crossfire TRT).
439 616
440=over 4 617=over 4
441 618
442=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
443 620
606 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
607 784
608 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
609 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
610 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
611 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
612 789
613 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
614 my $pkg = shift @arg; 791 my $pkg = shift @arg;
615 792
616 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
645 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
646 } 823 }
647 824
648 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
649 } else { 826 } else {
650 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
651 } 828 }
652 829
653 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
654} 831}
655 832
657 if (ref $_[0]) { 834 if (ref $_[0]) {
658 _object_attach @_; 835 _object_attach @_;
659 } else { 836 } else {
660 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
661 } 838 }
839 _recalc_want;
662}; 840};
663 841
664# all those should be optimised 842# all those should be optimised
665sub cf::attachable::detach { 843sub cf::attachable::detach {
666 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
669 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
670 reattach ($obj); 848 reattach ($obj);
671 } else { 849 } else {
672 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
673 } 851 }
852 _recalc_want;
674}; 853};
675 854
676sub cf::attachable::attached { 855sub cf::attachable::attached {
677 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
678 857
693 "; 872 ";
694 die if $@; 873 die if $@;
695} 874}
696 875
697our $override; 876our $override;
698our @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?
699 878
700sub override { 879sub override {
701 $override = 1; 880 $override = 1;
702 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
703} 882}
704 883
705sub do_invoke { 884sub do_invoke {
706 my $event = shift; 885 my $event = shift;
707 my $callbacks = shift; 886 my $callbacks = shift;
708 887
709 @invoke_results = (); 888 @INVOKE_RESULTS = ();
710 889
711 local $override; 890 local $override;
712 891
713 for (@$callbacks) { 892 for (@$callbacks) {
714 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
731 910
732Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
733 912
734This 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
735removed 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
736results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
737 916
738=back 917=back
739 918
740=cut 919=cut
741 920
851 or return; 1030 or return;
852 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
853 } 1032 }
854 1033
855 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
856 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
857 return ($data, $av); 1036 return ($data, $av);
858} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
859 1044
860############################################################################# 1045#############################################################################
861# command handling &c 1046# command handling &c
862 1047
863=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
876 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
877} 1062}
878 1063
879=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
880 1065
881Register 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.
882 1071
883If 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
884called. 1073called.
885 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
886=cut 1086=cut
887 1087
888sub register_extcmd { 1088sub register_extcmd {
889 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
890 1090
891 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
892} 1098}
893 1099
894cf::player->attach ( 1100cf::player->attach (
895 on_command => sub { 1101 on_command => sub {
896 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
905 cf::override; 1111 cf::override;
906 }, 1112 },
907 on_extcmd => sub { 1113 on_extcmd => sub {
908 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
909 1115
910 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
911 1117
912 if (ref $msg) { 1118 if (ref $msg) {
913 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
914 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
915 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
921 1127
922 cf::override; 1128 cf::override;
923 }, 1129 },
924); 1130);
925 1131
926sub load_extension {
927 my ($path) = @_;
928
929 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
930 my $base = $1;
931 my $pkg = $1;
932 $pkg =~ s/[^[:word:]]/_/g;
933 $pkg = "ext::$pkg";
934
935 warn "... loading '$path' into '$pkg'\n";
936
937 open my $fh, "<:utf8", $path
938 or die "$path: $!";
939
940 my $source =
941 "package $pkg; use strict; use utf8;\n"
942 . "#line 1 \"$path\"\n{\n"
943 . (do { local $/; <$fh> })
944 . "\n};\n1";
945
946 unless (eval $source) {
947 my $msg = $@ ? "$path: $@\n"
948 : "extension disabled.\n";
949 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
950 warn $@;
951 warn "mandatory extension failed to load, exiting.\n";
952 exit 1;
953 }
954 die $@;
955 }
956
957 push @EXTS, $pkg;
958}
959
960sub load_extensions { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
961 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
962 next unless -r $ext; 1137 next unless -r $path;
963 eval { 1138
964 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;
965 1 1196 }
966 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
967 } 1202 };
968} 1203}
969 1204
970############################################################################# 1205#############################################################################
1206
1207=back
971 1208
972=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
973 1210
974Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
975 1212
1163 } 1400 }
1164 1401
1165 \@paths 1402 \@paths
1166} 1403}
1167 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
1168=item $player->ext_reply ($msgid, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1169 1456
1170Sends an ext reply to the player. 1457Sends an ext reply to the player.
1171 1458
1172=cut 1459=cut
1173 1460
1174sub ext_reply($$%) { 1461sub ext_reply($$%) {
1175 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1176 1463
1177 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1178 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1179 $self->send ("ext " . cf::to_json \%msg);
1180} 1466}
1181 1467
1182=item $player->ext_event ($type, %msg) 1468=item $player->ext_event ($type, %msg)
1183 1469
1184Sends an ext event to the client. 1470Sends an ext event to the client.
1199 1485
1200package cf::region; 1486package cf::region;
1201 1487
1202=item cf::region::find_by_path $path 1488=item cf::region::find_by_path $path
1203 1489
1204Tries 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.
1205 1491
1206=cut 1492=cut
1207 1493
1208sub find_by_path($) { 1494sub find_by_path($) {
1209 my ($path) = @_; 1495 my ($path) = @_;
1210 1496
1211 my ($match, $specificity); 1497 my ($match, $specificity);
1212 1498
1213 for my $region (list) { 1499 for my $region (list) {
1214 if ($region->match && $path =~ $region->match) { 1500 if ($region->{match} && $path =~ $region->{match}) {
1215 ($match, $specificity) = ($region, $region->specificity) 1501 ($match, $specificity) = ($region, $region->specificity)
1216 if $region->specificity > $specificity; 1502 if $region->specificity > $specificity;
1217 } 1503 }
1218 } 1504 }
1219 1505
1283 my ($self, $merge) = @_; 1569 my ($self, $merge) = @_;
1284 1570
1285 # we have to keep some variables in memory intact 1571 # we have to keep some variables in memory intact
1286 local $self->{path}; 1572 local $self->{path};
1287 local $self->{load_path}; 1573 local $self->{load_path};
1288 local $self->{deny_save};
1289 local $self->{deny_reset};
1290 1574
1291 $self->SUPER::thawer_merge ($merge); 1575 $self->SUPER::thawer_merge ($merge);
1292} 1576}
1293 1577
1294sub normalise { 1578sub normalise {
1341 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1342 return $self; 1626 return $self;
1343 } 1627 }
1344 } 1628 }
1345 1629
1346 Carp::carp "unable to resolve path '$path' (base '$base')."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1347 () 1631 ()
1348} 1632}
1349 1633
1350sub init { 1634sub init {
1351 my ($self) = @_; 1635 my ($self) = @_;
1392sub change_all_map_light { 1676sub change_all_map_light {
1393 my ($change) = @_; 1677 my ($change) = @_;
1394 1678
1395 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1396 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;
1397} 1689}
1398 1690
1399sub unlink_save { 1691sub unlink_save {
1400 my ($self) = @_; 1692 my ($self) = @_;
1401 1693
1459 $self->load_header_orig 1751 $self->load_header_orig
1460 or return; 1752 or return;
1461 $self->prepare_orig; 1753 $self->prepare_orig;
1462 } 1754 }
1463 1755
1756 $self->{deny_reset} = 1
1757 if $self->no_reset;
1758
1464 $self->default_region (cf::region::find_by_path $self->{path}) 1759 $self->default_region (cf::region::find_by_path $self->{path})
1465 unless $self->default_region; 1760 unless $self->default_region;
1466 1761
1467 1 1762 1
1468} 1763}
1483 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1484 1779
1485 $map->load_header 1780 $map->load_header
1486 or return; 1781 or return;
1487 1782
1488 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1783 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1489 # doing this can freeze the server in a sync job, obviously 1784 # doing this can freeze the server in a sync job, obviously
1490 #$cf::WAIT_FOR_TICK->wait; 1785 #$cf::WAIT_FOR_TICK->wait;
1491 $map->reset; 1786 $map->reset;
1492 undef $guard; 1787 undef $guard;
1493 return find $path; 1788 return find $path;
1560 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1561 1856
1562 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1563 if $self->per_player; 1858 if $self->per_player;
1564 1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1862
1565 $self 1863 $self
1566} 1864}
1567 1865
1568# 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
1569sub load_diag { 1867sub load_diag {
1615 1913
1616 undef $MAP_PREFETCH{$path}; 1914 undef $MAP_PREFETCH{$path};
1617 $MAP_PREFETCHER ||= cf::async { 1915 $MAP_PREFETCHER ||= cf::async {
1618 while (%MAP_PREFETCH) { 1916 while (%MAP_PREFETCH) {
1619 for my $path (keys %MAP_PREFETCH) { 1917 for my $path (keys %MAP_PREFETCH) {
1620 my $map = find $path 1918 if (my $map = find $path) {
1621 or next;
1622 $map->load; 1919 $map->load;
1920 }
1623 1921
1624 delete $MAP_PREFETCH{$path}; 1922 delete $MAP_PREFETCH{$path};
1625 } 1923 }
1626 } 1924 }
1627 undef $MAP_PREFETCHER; 1925 undef $MAP_PREFETCHER;
1679 1977
1680sub reset_at { 1978sub reset_at {
1681 my ($self) = @_; 1979 my ($self) = @_;
1682 1980
1683 # TODO: safety, remove and allow resettable per-player maps 1981 # TODO: safety, remove and allow resettable per-player maps
1684 return 1e99 if $self->isa ("ext::map_per_player");#d#
1685 return 1e99 if $self->{deny_reset}; 1982 return 1e99 if $self->{deny_reset};
1686 1983
1687 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1688 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;
1689 1986
1700 my ($self) = @_; 1997 my ($self) = @_;
1701 1998
1702 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1703 2000
1704 return if $self->players; 2001 return if $self->players;
1705 return if $self->isa ("ext::map_per_player");#d#
1706 2002
1707 warn "resetting map ", $self->path;#d# 2003 warn "resetting map ", $self->path;
1708 2004
1709 $self->in_memory (cf::MAP_SWAPPED); 2005 $self->in_memory (cf::MAP_SWAPPED);
1710 2006
1711 # need to save uniques path 2007 # need to save uniques path
1712 unless ($self->{deny_save}) { 2008 unless ($self->{deny_save}) {
1744 $cf::MAP{$self->path} = $self; 2040 $cf::MAP{$self->path} = $self;
1745 2041
1746 $self->reset; # polite request, might not happen 2042 $self->reset; # polite request, might not happen
1747} 2043}
1748 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
1749=item cf::map::unique_maps 2081=item cf::map::unique_maps
1750 2082
1751Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1752instantiated unique items. May block. 2084instantiated unique items. May block.
1753 2085
1754=cut 2086=cut
1755 2087
1756sub unique_maps() { 2088sub unique_maps() {
1757 my $files = aio_readdir $UNIQUEDIR 2089 [
1758 or return; 2090 map {
1759
1760 my @paths;
1761
1762 for (@$files) {
1763 utf8::decode $_; 2091 utf8::decode $_;
1764 next if /\.pst$/; 2092 /\.map$/
1765 next unless /^$PATH_SEP/o; 2093 ? normalise $_
1766 2094 : ()
1767 push @paths, cf::map::normalise $_; 2095 } @{ aio_readdir $UNIQUEDIR or [] }
1768 } 2096 ]
1769
1770 \@paths
1771} 2097}
1772 2098
1773package cf; 2099package cf;
1774 2100
1775=back 2101=back
1821 2147
1822 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1823 2149
1824 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1825 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1826 } 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 {
1827 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1828 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1829 } 2169 }
1830} 2170}
1831 2171
1832=item $player_object->may ("access") 2172=item $player_object->may ("access")
1833 2173
1881 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1882 2222
1883 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1884 2224
1885 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1886 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1887 2227
1888 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1889} 2229}
1890 2230
1891sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1892 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1893 2235
1894 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1895 2237
1896 unless ($map) { 2238 unless ($map) {
1897 # restore original map position 2239 # restore original map position
1920 2262
1921 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1922 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1923} 2265}
1924 2266
1925cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1926 on_logout => sub {
1927 my ($pl) = @_;
1928 2268
1929 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1930 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1931 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1932 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1933 }; 2273be called at the end of this process.
1934 }
1935 },
1936 on_login => sub {
1937 my ($pl) = @_;
1938 2274
1939 # try to abort aborted map switching on player login :)
1940 # should happen only on crashes
1941 if ($pl->ob->{_link_pos}) {
1942 $pl->ob->enter_link;
1943 (async {
1944 $pl->ob->reply (undef,
1945 "There was an internal problem at your last logout, "
1946 . "the server will try to bring you to your intended destination in a second.",
1947 cf::NDI_RED);
1948 # we need this sleep as the login has a concurrent enter_exit running
1949 # and this sleep increases chances of the player not ending up in scorn
1950 Coro::Timer::sleep 1;
1951 $pl->ob->leave_link;
1952 })->prio (2);
1953 }
1954 },
1955);
1956
1957=item $player_object->goto ($path, $x, $y)
1958
1959=cut 2275=cut
2276
2277our $GOTOGEN;
1960 2278
1961sub cf::object::player::goto { 2279sub cf::object::player::goto {
1962 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;
1963 2284
1964 $self->enter_link; 2285 $self->enter_link;
1965 2286
1966 (async { 2287 (async {
1967 my $map = eval { 2288 my $map = eval {
1968 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1969 $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
1970 $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 $@;
1971 } or 2304 }
1972 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1973 2305
2306 if ($gen == $self->{_goto_generation}) {
2307 delete $self->{_goto_generation};
1974 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1975 })->prio (1); 2312 })->prio (1);
1976} 2313}
1977 2314
1978=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
1979 2316
2048 my $hp = $exit->stats->hp; 2385 my $hp = $exit->stats->hp;
2049 my $sp = $exit->stats->sp; 2386 my $sp = $exit->stats->sp;
2050 2387
2051 $self->enter_link; 2388 $self->enter_link;
2052 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
2053 (async { 2394 (async {
2054 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
2055 unless (eval { 2396 unless (eval {
2056 $self->goto ($slaying, $hp, $sp); 2397 $self->goto ($slaying, $hp, $sp);
2057 2398
2084 2425
2085 utf8::encode $text; 2426 utf8::encode $text;
2086 $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);
2087} 2428}
2088 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
2089=item $client->ext_event ($type, %msg) 2482=item $client->ext_event ($type, %msg)
2090 2483
2091Sends an exti event to the client. 2484Sends an ext event to the client.
2092 2485
2093=cut 2486=cut
2094 2487
2095sub cf::client::ext_event($$%) { 2488sub cf::client::ext_event($$%) {
2096 my ($self, $type, %msg) = @_; 2489 my ($self, $type, %msg) = @_;
2097 2490
2491 return unless $self->extcmd;
2492
2098 $msg{msgtype} = "event_$type"; 2493 $msg{msgtype} = "event_$type";
2099 $self->send_packet ("ext " . cf::to_json \%msg); 2494 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2100} 2495}
2101 2496
2102=item $success = $client->query ($flags, "text", \&cb) 2497=item $success = $client->query ($flags, "text", \&cb)
2103 2498
2104Queues a query to the client, calling the given callback with 2499Queues a query to the client, calling the given callback with
2105the 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>,
2106C<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>.
2107 2502
2108Queries 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
2109reliable at some point in the future. 2504become reliable at some point in the future.
2110 2505
2111=cut 2506=cut
2112 2507
2113sub cf::client::query { 2508sub cf::client::query {
2114 my ($self, $flags, $text, $cb) = @_; 2509 my ($self, $flags, $text, $cb) = @_;
2122 utf8::encode $text; 2517 utf8::encode $text;
2123 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2518 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2124 2519
2125 $self->send_packet ($self->{query_queue}[0][0]) 2520 $self->send_packet ($self->{query_queue}[0][0])
2126 if @{ $self->{query_queue} } == 1; 2521 if @{ $self->{query_queue} } == 1;
2522
2523 1
2127} 2524}
2128 2525
2129cf::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 },
2130 on_reply => sub { 2532 on_reply => sub {
2131 my ($ns, $msg) = @_; 2533 my ($ns, $msg) = @_;
2132 2534
2133 # this weird shuffling is so that direct followup queries 2535 # this weird shuffling is so that direct followup queries
2134 # get handled first 2536 # get handled first
2146 } else { 2548 } else {
2147 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2549 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2148 } 2550 }
2149 } 2551 }
2150 }, 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 },
2151); 2571);
2152 2572
2153=item $client->async (\&cb) 2573=item $client->async (\&cb)
2154 2574
2155Create a new coroutine, running the specified callback. The coroutine will 2575Create a new coroutine, running the specified callback. The coroutine will
2204 2624
2205=pod 2625=pod
2206 2626
2207The following functions and methods are available within a safe environment: 2627The following functions and methods are available within a safe environment:
2208 2628
2209 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
2210 cf::object::player player 2633 cf::object::player
2211 cf::player peaceful 2634 player
2212 cf::map trigger 2635
2636 cf::player
2637 peaceful
2638
2639 cf::map
2640 trigger
2213 2641
2214=cut 2642=cut
2215 2643
2216for ( 2644for (
2217 ["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)],
2218 ["cf::object::player" => qw(player)], 2647 ["cf::object::player" => qw(player)],
2219 ["cf::player" => qw(peaceful)], 2648 ["cf::player" => qw(peaceful)],
2220 ["cf::map" => qw(trigger)], 2649 ["cf::map" => qw(trigger)],
2221) { 2650) {
2222 no strict 'refs'; 2651 no strict 'refs';
2293=back 2722=back
2294 2723
2295=cut 2724=cut
2296 2725
2297############################################################################# 2726#############################################################################
2298
2299=head2 EXTENSION DATABASE SUPPORT
2300
2301Crossfire maintains a very simple database for extension use. It can
2302currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2303convert to/from binary).
2304
2305The parameter C<$family> should best start with the name of the extension
2306using it, it should be unique.
2307
2308=over 4
2309
2310=item $value = cf::db_get $family => $key
2311
2312Returns a single value from the database.
2313
2314=item cf::db_put $family => $key => $value
2315
2316Stores the given C<$value> in the family.
2317
2318=cut
2319
2320our $DB;
2321
2322sub db_init {
2323 unless ($DB) {
2324 $DB = BDB::db_create $DB_ENV;
2325
2326 cf::sync_job {
2327 eval {
2328 $DB->set_flags (BDB::CHKSUM);
2329
2330 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2331 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2332 cf::cleanup "db_open(db): $!" if $!;
2333 };
2334 cf::cleanup "db_open(db): $@" if $@;
2335 };
2336 }
2337}
2338
2339sub db_get($$) {
2340 my $key = "$_[0]/$_[1]";
2341
2342 cf::sync_job {
2343 BDB::db_get $DB, undef, $key, my $data;
2344
2345 $! ? ()
2346 : $data
2347 }
2348}
2349
2350sub db_put($$$) {
2351 BDB::dbreq_pri 4;
2352 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2353}
2354
2355=item cf::cache $id => [$paths...], $processversion => $process
2356
2357Generic caching function that returns the value of the resource $id,
2358caching and regenerating as required.
2359
2360This function can block.
2361
2362=cut
2363
2364sub cache {
2365 my ($id, $src, $processversion, $process) = @_;
2366
2367 my $meta =
2368 join "\x00",
2369 $processversion,
2370 map {
2371 aio_stat $_
2372 and Carp::croak "$_: $!";
2373
2374 ($_, (stat _)[7,9])
2375 } @$src;
2376
2377 my $dbmeta = db_get cache => "$id/meta";
2378 if ($dbmeta ne $meta) {
2379 # changed, we may need to process
2380
2381 my @data;
2382 my $md5;
2383
2384 for (0 .. $#$src) {
2385 0 <= aio_load $src->[$_], $data[$_]
2386 or Carp::croak "$src->[$_]: $!";
2387 }
2388
2389 # if processing is expensive, check
2390 # checksum first
2391 if (1) {
2392 $md5 =
2393 join "\x00",
2394 $processversion,
2395 map {
2396 Coro::cede;
2397 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2398 } 0.. $#$src;
2399
2400
2401 my $dbmd5 = db_get cache => "$id/md5";
2402 if ($dbmd5 eq $md5) {
2403 db_put cache => "$id/meta", $meta;
2404
2405 return db_get cache => "$id/data";
2406 }
2407 }
2408
2409 my $t1 = Time::HiRes::time;
2410 my $data = $process->(\@data);
2411 my $t2 = Time::HiRes::time;
2412
2413 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2414
2415 db_put cache => "$id/data", $data;
2416 db_put cache => "$id/md5" , $md5;
2417 db_put cache => "$id/meta", $meta;
2418
2419 return $data;
2420 }
2421
2422 db_get cache => "$id/data"
2423}
2424
2425=item fork_call { }, $args
2426
2427Executes the given code block with the given arguments in a seperate
2428process, returning the results. Everything must be serialisable with
2429Coro::Storable. May, of course, block. Note that the executed sub may
2430never block itself or use any form of Event handling.
2431
2432=cut
2433
2434sub fork_call(&@) {
2435 my ($cb, @args) = @_;
2436
2437# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2438# or die "socketpair: $!";
2439 pipe my $fh1, my $fh2
2440 or die "pipe: $!";
2441
2442 if (my $pid = fork) {
2443 close $fh2;
2444
2445 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2446 $res = Coro::Storable::thaw $res;
2447
2448 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2449
2450 die $$res unless "ARRAY" eq ref $res;
2451
2452 return wantarray ? @$res : $res->[-1];
2453 } else {
2454 reset_signals;
2455 local $SIG{__WARN__};
2456 local $SIG{__DIE__};
2457 eval {
2458 close $fh1;
2459
2460 my @res = eval { $cb->(@args) };
2461 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2462 };
2463
2464 warn $@ if $@;
2465 _exit 0;
2466 }
2467}
2468
2469
2470
2471#############################################################################
2472# the server's init and main functions 2727# the server's init and main functions
2473 2728
2474sub load_facedata($) { 2729sub load_facedata($) {
2475 my ($path) = @_; 2730 my ($path) = @_;
2476 2731
2488 { 2743 {
2489 my $faces = $facedata->{faceinfo}; 2744 my $faces = $facedata->{faceinfo};
2490 2745
2491 while (my ($face, $info) = each %$faces) { 2746 while (my ($face, $info) = each %$faces) {
2492 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2747 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2493 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2748 cf::face::set_visibility $idx, $info->{visibility};
2749 cf::face::set_magicmap $idx, $info->{magicmap};
2494 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2750 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2495 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2751 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2496 Coro::cede; 2752
2753 cf::cede_to_tick;
2497 } 2754 }
2498 2755
2499 while (my ($face, $info) = each %$faces) { 2756 while (my ($face, $info) = each %$faces) {
2500 next unless $info->{smooth}; 2757 next unless $info->{smooth};
2501 my $idx = cf::face::find $face 2758 my $idx = cf::face::find $face
2502 or next; 2759 or next;
2503 if (my $smooth = cf::face::find $info->{smooth}) { 2760 if (my $smooth = cf::face::find $info->{smooth}) {
2761 cf::face::set_smooth $idx, $smooth;
2504 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2762 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2505 } else { 2763 } else {
2506 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2764 warn "smooth face '$info->{smooth}' not found for face '$face'";
2507 } 2765 }
2508 Coro::cede; 2766
2767 cf::cede_to_tick;
2509 } 2768 }
2510 } 2769 }
2511 2770
2512 { 2771 {
2513 my $anims = $facedata->{animinfo}; 2772 my $anims = $facedata->{animinfo};
2514 2773
2515 while (my ($anim, $info) = each %$anims) { 2774 while (my ($anim, $info) = each %$anims) {
2516 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2775 cf::anim::set $anim, $info->{frames}, $info->{facings};
2517 Coro::cede; 2776 cf::cede_to_tick;
2518 } 2777 }
2519 2778
2520 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 }
2521 } 2810 }
2522 2811
2523 1 2812 1
2524} 2813}
2525 2814
2526sub reload_regions { 2815sub reload_regions {
2527 load_resource_file "$MAPDIR/regions" 2816 load_resource_file "$MAPDIR/regions"
2528 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 }
2529} 2823}
2530 2824
2531sub reload_facedata { 2825sub reload_facedata {
2532 load_facedata "$DATADIR/facedata" 2826 load_facedata "$DATADIR/facedata"
2533 or die "unable to load facedata\n"; 2827 or die "unable to load facedata\n";
2534} 2828}
2535 2829
2536sub reload_archetypes { 2830sub reload_archetypes {
2537 load_resource_file "$DATADIR/archetypes" 2831 load_resource_file "$DATADIR/archetypes"
2538 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";
2539} 2838}
2540 2839
2541sub reload_treasures { 2840sub reload_treasures {
2542 load_resource_file "$DATADIR/treasures" 2841 load_resource_file "$DATADIR/treasures"
2543 or die "unable to load treasurelists\n"; 2842 or die "unable to load treasurelists\n";
2546sub reload_resources { 2845sub reload_resources {
2547 warn "reloading resource files...\n"; 2846 warn "reloading resource files...\n";
2548 2847
2549 reload_regions; 2848 reload_regions;
2550 reload_facedata; 2849 reload_facedata;
2850 #reload_archetypes;#d#
2551 reload_archetypes; 2851 reload_archetypes;
2552 reload_treasures; 2852 reload_treasures;
2553 2853
2554 warn "finished reloading resource files\n"; 2854 warn "finished reloading resource files\n";
2555} 2855}
2612 }, 2912 },
2613 ); 2913 );
2614 } 2914 }
2615} 2915}
2616 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
2617sub emergency_save() { 2955sub emergency_save() {
2618 my $freeze_guard = cf::freeze_mainloop; 2956 my $freeze_guard = cf::freeze_mainloop;
2619 2957
2620 warn "enter emergency perl save\n"; 2958 warn "enter emergency perl save\n";
2621 2959
2696 %EXT_CORO = (); 3034 %EXT_CORO = ();
2697 3035
2698 warn "removing commands"; 3036 warn "removing commands";
2699 %COMMAND = (); 3037 %COMMAND = ();
2700 3038
2701 warn "removing ext commands"; 3039 warn "removing ext/exti commands";
2702 %EXTCMD = (); 3040 %EXTCMD = ();
3041 %EXTICMD = ();
2703 3042
2704 warn "unloading/nuking all extensions"; 3043 warn "unloading/nuking all extensions";
2705 for my $pkg (@EXTS) { 3044 for my $pkg (@EXTS) {
2706 warn "... unloading $pkg"; 3045 warn "... unloading $pkg";
2707 3046
2825 my $signal = new Coro::Signal; 3164 my $signal = new Coro::Signal;
2826 push @WAIT_FOR_TICK_BEGIN, $signal; 3165 push @WAIT_FOR_TICK_BEGIN, $signal;
2827 $signal->wait; 3166 $signal->wait;
2828} 3167}
2829 3168
3169 my $min = 1e6;#d#
3170 my $avg = 10;
2830$TICK_WATCHER = Event->timer ( 3171$TICK_WATCHER = Event->timer (
2831 reentrant => 0, 3172 reentrant => 0,
2832 parked => 1, 3173 parked => 1,
2833 prio => 0, 3174 prio => 0,
2834 at => $NEXT_TICK || $TICK, 3175 at => $NEXT_TICK || $TICK,
2838 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3179 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2839 unless ++$bug_warning > 10; 3180 unless ++$bug_warning > 10;
2840 return; 3181 return;
2841 } 3182 }
2842 3183
2843 $NOW = Event::time; 3184 $NOW = $tick_start = Event::time;
2844 3185
2845 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 };
2846 3210
2847 $RUNTIME += $TICK; 3211 $RUNTIME += $TICK;
2848 $NEXT_TICK += $TICK; 3212 $NEXT_TICK += $TICK;
2849 3213
2850 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3214 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2856 } 3220 }
2857 3221
2858# my $AFTER = Event::time; 3222# my $AFTER = Event::time;
2859# warn $AFTER - $NOW;#d# 3223# warn $AFTER - $NOW;#d#
2860 3224
3225 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3226 $sig->send;
3227 }
3228 while (my $sig = shift @WAIT_FOR_TICK) {
3229 $sig->send;
3230 }
3231
3232 $NOW = Event::time;
3233
2861 # if we are delayed by four ticks or more, skip them all 3234 # if we are delayed by four ticks or more, skip them all
2862 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3235 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2863 3236
2864 $TICK_WATCHER->at ($NEXT_TICK); 3237 $TICK_WATCHER->at ($NEXT_TICK);
2865 $TICK_WATCHER->start; 3238 $TICK_WATCHER->start;
2866 3239
2867 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3240 $LOAD = ($NOW - $tick_start) / $TICK;
2868 $sig->send; 3241 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2869 }
2870 while (my $sig = shift @WAIT_FOR_TICK) {
2871 $sig->send;
2872 }
2873 3242
2874 _post_tick; 3243 _post_tick;
3244
3245
2875 }, 3246 },
2876); 3247);
2877 3248
2878{ 3249{
2879 BDB::max_poll_time $TICK * 0.1; 3250 BDB::max_poll_time $TICK * 0.1;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines