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.253 by root, Wed Apr 18 17:32:07 2007 UTC vs.
Revision 1.352 by root, Sun Sep 2 04:57:14 2007 UTC

10use Event; 10use Event;
11use Opcode; 11use Opcode;
12use Safe; 12use Safe;
13use Safe::Hole; 13use Safe::Hole;
14 14
15use Coro 3.61 (); 15use Coro 3.64 ();
16use Coro::State; 16use Coro::State;
17use Coro::Handle; 17use Coro::Handle;
18use Coro::Event; 18use Coro::Event;
19use Coro::Timer; 19use Coro::Timer;
20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
24 25
26use JSON::XS ();
25use BDB (); 27use BDB ();
26use Data::Dumper; 28use Data::Dumper;
27use Digest::MD5; 29use Digest::MD5;
28use Fcntl; 30use Fcntl;
29use YAML::Syck (); 31use YAML::Syck ();
30use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
31use Time::HiRes; 33use Time::HiRes;
32use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
33 36
34# configure various modules to our taste 37# configure various modules to our taste
35# 38#
36$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 52our %COMMAND = ();
50our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
51 54
52our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
56 60
57our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
58our @EVENT; 62our @EVENT;
90our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
91 95
92# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
95binmode STDOUT; 103binmode STDOUT;
96binmode STDERR; 104binmode STDERR;
97 105
98# read virtual server time, if available 106# read virtual server time, if available
99unless ($RUNTIME || !-e "$LOCALDIR/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
139 147
140=item $cf::TICK 148=item $cf::TICK
141 149
142The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
143 151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
161
144=item %cf::CFG 162=item %cf::CFG
145 163
146Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
147from wherever your confdir points to. 165from wherever your confdir points to.
148 166
150 168
151These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 169These 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 170returns 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. 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
154 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
178
155=back 179=back
156 180
157=cut 181=cut
158 182
159BEGIN { 183BEGIN {
161 my $msg = join "", @_; 185 my $msg = join "", @_;
162 186
163 $msg .= "\n" 187 $msg .= "\n"
164 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
165 189
166 $msg =~ s/([\x00-\x09\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge; 190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
167 191
168 utf8::encode $msg; 192 utf8::encode $msg;
169 LOG llevError, $msg; 193 LOG llevError, $msg;
170 }; 194 };
171} 195}
173@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
174@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
175@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
176@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
177@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
178@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
179 204
180# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
181# within the Safe compartment. 206# within the Safe compartment.
182for my $pkg (qw( 207for my $pkg (qw(
183 cf::global cf::attachable 208 cf::global cf::attachable
191} 216}
192 217
193$Event::DIED = sub { 218$Event::DIED = sub {
194 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
195}; 220};
221
222#############################################################################
196 223
197=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
198 225
199=over 4 226=over 4
200 227
219 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
220 $d 247 $d
221 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
222} 249}
223 250
224use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
225
226=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
227 252
228Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
229 254
230=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
231 256
232Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
258
259=cut
260
261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
262
263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
233 265
234=item cf::lock_wait $string 266=item cf::lock_wait $string
235 267
236Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
237 269
239 271
240Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
241a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
242for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
243returned. 275returned.
276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
244 279
245Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
246uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
247 282
248=item $locked = cf::lock_active $string 283=item $locked = cf::lock_active $string
291 }; 326 };
292 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
293 $guard 328 $guard
294} 329}
295 330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
385}
386
296=item cf::async { BLOCK } 387=item cf::async { BLOCK }
297 388
298Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
299C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 390C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
300thing you are allowed to do is call C<prio> on it. 391thing you are allowed to do is call C<prio> on it.
303 394
304BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
305 396
306=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
307 398
308The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
309always able to handle events or runnable, as crossfire+ is only partly 400is 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. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
311 403
312If it must be done, put the blocking parts into C<sync_job>. This will run 404If 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 405the given BLOCK in another coroutine while waiting for the result. The
314server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
315fast or be very important. 407fast or be very important.
318 410
319sub sync_job(&) { 411sub sync_job(&) {
320 my ($job) = @_; 412 my ($job) = @_;
321 413
322 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
323 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
324 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
325 419
326 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
327 # (but this is cancel-safe) 421 # (but this is cancel-safe)
338 432
339 while ($busy) { 433 while ($busy) {
340 Coro::cede or Event::one_event; 434 Coro::cede or Event::one_event;
341 } 435 }
342 436
437 $time = Event::time - $time;
438
439 LOG llevError | logBacktrace, Carp::longmess "long sync job"
440 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
441
442 $tick_start += $time; # do not account sync jobs to server load
443
343 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
344 } else { 445 } else {
345 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
346 447
347 $job->() 448 $job->()
366 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
367 468
368 $coro 469 $coro
369} 470}
370 471
371sub write_runtime { 472=item fork_call { }, $args
372 my $guard = cf::lock_acquire "write_runtime";
373 473
374 my $runtime = "$LOCALDIR/runtime"; 474Executes the given code block with the given arguments in a seperate
475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
375 478
376 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 479=cut
377 or return;
378 480
379 my $value = $cf::RUNTIME + 90 + 10; 481sub fork_call(&@) {
380 # 10 is the runtime save interval, for a monotonic clock 482 my ($cb, @args) = @_;
381 # 60 allows for the watchdog to kill the server.
382 483
383 (aio_write $fh, 0, (length $value), $value, 0) <= 0 484 # we seemingly have to make a local copy of the whole thing,
384 and return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
385 487
386 # always fsync - this file is important 488 my @res = Coro::Util::fork_eval {
387 aio_fsync $fh 489 reset_signals;
388 and return; 490 &$cb
491 }, @args;
389 492
390 close $fh 493 wantarray ? @res : $res[-1]
391 or return; 494}
392 495
393 aio_rename "$runtime~", $runtime 496=item $value = cf::db_get $family => $key
394 and return;
395 497
498Returns a single value from the environment database.
499
500=item cf::db_put $family => $key => $value
501
502Stores the given C<$value> in the family. It can currently store binary
503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
504
505=cut
506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
396 1 523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
397} 610}
398 611
399=item cf::datalog type => key => value, ... 612=item cf::datalog type => key => value, ...
400 613
401Log a datalog packet of the given type with the given key-value pairs. 614Log a datalog packet of the given type with the given key-value pairs.
419attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
420to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
421 634
422In the following description, CLASS can be any of C<global>, C<object> 635In the following description, CLASS can be any of C<global>, C<object>
423C<player>, C<client> or C<map> (i.e. the attachable objects in 636C<player>, C<client> or C<map> (i.e. the attachable objects in
424crossfire+). 637Crossfire TRT).
425 638
426=over 4 639=over 4
427 640
428=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
429 642
592 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
593 806
594 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
595 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
596 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
597 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
598 811
599 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
600 my $pkg = shift @arg; 813 my $pkg = shift @arg;
601 814
602 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
631 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
632 } 845 }
633 846
634 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
635 } else { 848 } else {
636 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
637 } 850 }
638 851
639 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
640} 853}
641 854
643 if (ref $_[0]) { 856 if (ref $_[0]) {
644 _object_attach @_; 857 _object_attach @_;
645 } else { 858 } else {
646 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
647 } 860 }
861 _recalc_want;
648}; 862};
649 863
650# all those should be optimised 864# all those should be optimised
651sub cf::attachable::detach { 865sub cf::attachable::detach {
652 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
655 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
656 reattach ($obj); 870 reattach ($obj);
657 } else { 871 } else {
658 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
659 } 873 }
874 _recalc_want;
660}; 875};
661 876
662sub cf::attachable::attached { 877sub cf::attachable::attached {
663 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
664 879
679 "; 894 ";
680 die if $@; 895 die if $@;
681} 896}
682 897
683our $override; 898our $override;
684our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
685 900
686sub override { 901sub override {
687 $override = 1; 902 $override = 1;
688 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
689} 904}
690 905
691sub do_invoke { 906sub do_invoke {
692 my $event = shift; 907 my $event = shift;
693 my $callbacks = shift; 908 my $callbacks = shift;
694 909
695 @invoke_results = (); 910 @INVOKE_RESULTS = ();
696 911
697 local $override; 912 local $override;
698 913
699 for (@$callbacks) { 914 for (@$callbacks) {
700 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
717 932
718Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
719 934
720This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
721removed in future versions), and there is no public API to access override 936removed in future versions), and there is no public API to access override
722results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
723 938
724=back 939=back
725 940
726=cut 941=cut
727 942
728############################################################################# 943#############################################################################
729# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
730 956
731sub reattach { 957sub reattach {
732 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
733 my ($obj) = @_; 959 my ($obj) = @_;
734 960
837 or return; 1063 or return;
838 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
839 } 1065 }
840 1066
841 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
842 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
843 return ($data, $av); 1069 return ($data, $av);
844} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
845 1077
846############################################################################# 1078#############################################################################
847# command handling &c 1079# command handling &c
848 1080
849=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
862 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
863} 1095}
864 1096
865=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
866 1098
867Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
868 1104
869If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
870called. 1106called.
871 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
872=cut 1119=cut
873 1120
874sub register_extcmd { 1121sub register_extcmd {
875 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
876 1123
877 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
878} 1131}
879 1132
880cf::player->attach ( 1133cf::player->attach (
881 on_command => sub { 1134 on_command => sub {
882 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
891 cf::override; 1144 cf::override;
892 }, 1145 },
893 on_extcmd => sub { 1146 on_extcmd => sub {
894 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
895 1148
896 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
897 1150
898 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
899 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
900 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
901 $pl->ext_reply ($msg->{msgid}, %reply);
902 }
903 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
904 } else { 1166 } else {
905 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
906 } 1168 }
907 1169
908 cf::override; 1170 cf::override;
909 }, 1171 },
910); 1172);
911 1173
912sub load_extension {
913 my ($path) = @_;
914
915 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
916 my $base = $1;
917 my $pkg = $1;
918 $pkg =~ s/[^[:word:]]/_/g;
919 $pkg = "ext::$pkg";
920
921 warn "... loading '$path' into '$pkg'\n";
922
923 open my $fh, "<:utf8", $path
924 or die "$path: $!";
925
926 my $source =
927 "package $pkg; use strict; use utf8;\n"
928 . "#line 1 \"$path\"\n{\n"
929 . (do { local $/; <$fh> })
930 . "\n};\n1";
931
932 unless (eval $source) {
933 my $msg = $@ ? "$path: $@\n"
934 : "extension disabled.\n";
935 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
936 warn $@;
937 warn "mandatory extension failed to load, exiting.\n";
938 exit 1;
939 }
940 die $@;
941 }
942
943 push @EXTS, $pkg;
944}
945
946sub load_extensions { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
947 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
948 next unless -r $ext; 1179 next unless -r $path;
949 eval { 1180
950 load_extension $ext; 1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
951 1 1238 }
952 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
953 } 1244 };
954} 1245}
955 1246
956############################################################################# 1247#############################################################################
1248
1249=back
957 1250
958=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
959 1252
960Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
961 1254
1032 1325
1033 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1034 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1035 1328
1036 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1037 Coro::cede; 1330 cf::cede_to_tick;
1038} 1331}
1039 1332
1040sub new($) { 1333sub new($) {
1041 my ($login) = @_; 1334 my ($login) = @_;
1042 1335
1046 $self->{deny_save} = 1; 1339 $self->{deny_save} = 1;
1047 1340
1048 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1049 1342
1050 $self 1343 $self
1344}
1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1051} 1354}
1052 1355
1053=item $pl->quit_character 1356=item $pl->quit_character
1054 1357
1055Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1149 } 1452 }
1150 1453
1151 \@paths 1454 \@paths
1152} 1455}
1153 1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGHT])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1478 # replace G<male|female> tags
1479 || s{G<([^>|]*)\|([^>]*)>}{
1480 $self->gender ? $2 : $1
1481 }ge
1482 # replace H<hint text>
1483 || s{H<([^\>]*)>}
1484 {
1485 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1486 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1487 "")
1488 [$self->{hintmode}]
1489 }ge;
1490
1491 # create single paragraphs (very hackish)
1492 s/(?<=\S)\n(?=\w)/ /g;
1493
1494 # compress some whitespace
1495 s/\s+\n/\n/g; # ws line-ends
1496 s/\n\n+/\n/g; # double lines
1497 s/^\n+//; # beginning lines
1498 s/\n+$//; # ending lines
1499
1500 $_
1501}
1502
1503sub hintmode {
1504 $_[0]{hintmode} = $_[1] if @_ > 1;
1505 $_[0]{hintmode}
1506}
1507
1154=item $player->ext_reply ($msgid, %msg) 1508=item $player->ext_reply ($msgid, @msg)
1155 1509
1156Sends an ext reply to the player. 1510Sends an ext reply to the player.
1157 1511
1158=cut 1512=cut
1159 1513
1160sub ext_reply($$%) { 1514sub ext_reply($$@) {
1161 my ($self, $id, %msg) = @_; 1515 my ($self, $id, @msg) = @_;
1162 1516
1163 $msg{msgid} = $id; 1517 $self->ns->ext_reply ($id, @msg)
1164
1165 $self->send ("ext " . cf::to_json \%msg);
1166} 1518}
1167 1519
1168=item $player->ext_event ($type, %msg) 1520=item $player->ext_msg ($type, @msg)
1169 1521
1170Sends an ext event to the client. 1522Sends an ext event to the client.
1171 1523
1172=cut 1524=cut
1173 1525
1174sub ext_event($$%) { 1526sub ext_msg($$@) {
1175 my ($self, $type, %msg) = @_; 1527 my ($self, $type, @msg) = @_;
1176 1528
1177 $self->ns->ext_event ($type, %msg); 1529 $self->ns->ext_msg ($type, @msg);
1178} 1530}
1179 1531
1180=head3 cf::region 1532=head3 cf::region
1181 1533
1182=over 4 1534=over 4
1185 1537
1186package cf::region; 1538package cf::region;
1187 1539
1188=item cf::region::find_by_path $path 1540=item cf::region::find_by_path $path
1189 1541
1190Tries to decuce the probable region for a map knowing only its path. 1542Tries to decuce the likely region for a map knowing only its path.
1191 1543
1192=cut 1544=cut
1193 1545
1194sub find_by_path($) { 1546sub find_by_path($) {
1195 my ($path) = @_; 1547 my ($path) = @_;
1196 1548
1197 my ($match, $specificity); 1549 my ($match, $specificity);
1198 1550
1199 for my $region (list) { 1551 for my $region (list) {
1200 if ($region->match && $path =~ $region->match) { 1552 if ($region->{match} && $path =~ $region->{match}) {
1201 ($match, $specificity) = ($region, $region->specificity) 1553 ($match, $specificity) = ($region, $region->specificity)
1202 if $region->specificity > $specificity; 1554 if $region->specificity > $specificity;
1203 } 1555 }
1204 } 1556 }
1205 1557
1269 my ($self, $merge) = @_; 1621 my ($self, $merge) = @_;
1270 1622
1271 # we have to keep some variables in memory intact 1623 # we have to keep some variables in memory intact
1272 local $self->{path}; 1624 local $self->{path};
1273 local $self->{load_path}; 1625 local $self->{load_path};
1274 local $self->{deny_save};
1275 local $self->{deny_reset};
1276 1626
1277 $self->SUPER::thawer_merge ($merge); 1627 $self->SUPER::thawer_merge ($merge);
1278} 1628}
1279 1629
1280sub normalise { 1630sub normalise {
1327 $self->init; # pass $1 etc. 1677 $self->init; # pass $1 etc.
1328 return $self; 1678 return $self;
1329 } 1679 }
1330 } 1680 }
1331 1681
1332 Carp::carp "unable to resolve path '$path' (base '$base')."; 1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1333 () 1683 ()
1334} 1684}
1335 1685
1336sub init { 1686sub init {
1337 my ($self) = @_; 1687 my ($self) = @_;
1352 1702
1353# the original (read-only) location 1703# the original (read-only) location
1354sub load_path { 1704sub load_path {
1355 my ($self) = @_; 1705 my ($self) = @_;
1356 1706
1357 "$MAPDIR($self->{path}" 1707 "$MAPDIR/$self->{path}.map"
1358} 1708}
1359 1709
1360# the temporary/swap location 1710# the temporary/swap location
1361sub save_path { 1711sub save_path {
1362 my ($self) = @_; 1712 my ($self) = @_;
1363 1713
1364 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1714 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1365 "$TMPDIR/$path" 1715 "$TMPDIR/$path.map"
1366} 1716}
1367 1717
1368# the unique path, undef == no special unique path 1718# the unique path, undef == no special unique path
1369sub uniq_path { 1719sub uniq_path {
1370 my ($self) = @_; 1720 my ($self) = @_;
1378sub change_all_map_light { 1728sub change_all_map_light {
1379 my ($change) = @_; 1729 my ($change) = @_;
1380 1730
1381 $_->change_map_light ($change) 1731 $_->change_map_light ($change)
1382 for grep $_->outdoor, values %cf::MAP; 1732 for grep $_->outdoor, values %cf::MAP;
1733}
1734
1735sub decay_objects {
1736 my ($self) = @_;
1737
1738 return if $self->{deny_reset};
1739
1740 $self->do_decay_objects;
1383} 1741}
1384 1742
1385sub unlink_save { 1743sub unlink_save {
1386 my ($self) = @_; 1744 my ($self) = @_;
1387 1745
1445 $self->load_header_orig 1803 $self->load_header_orig
1446 or return; 1804 or return;
1447 $self->prepare_orig; 1805 $self->prepare_orig;
1448 } 1806 }
1449 1807
1808 $self->{deny_reset} = 1
1809 if $self->no_reset;
1810
1450 $self->default_region (cf::region::find_by_path $self->{path}) 1811 $self->default_region (cf::region::find_by_path $self->{path})
1451 unless $self->default_region; 1812 unless $self->default_region;
1452 1813
1453 1 1814 1
1454} 1815}
1469 $map->{last_save} = $cf::RUNTIME; 1830 $map->{last_save} = $cf::RUNTIME;
1470 1831
1471 $map->load_header 1832 $map->load_header
1472 or return; 1833 or return;
1473 1834
1474 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1835 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1475 # doing this can freeze the server in a sync job, obviously 1836 # doing this can freeze the server in a sync job, obviously
1476 #$cf::WAIT_FOR_TICK->wait; 1837 #$cf::WAIT_FOR_TICK->wait;
1477 $map->reset; 1838 $map->reset;
1478 undef $guard; 1839 undef $guard;
1479 return find $path; 1840 return find $path;
1490 my ($self) = @_; 1851 my ($self) = @_;
1491 1852
1492 local $self->{deny_reset} = 1; # loading can take a long time 1853 local $self->{deny_reset} = 1; # loading can take a long time
1493 1854
1494 my $path = $self->{path}; 1855 my $path = $self->{path};
1856
1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1495 my $guard = cf::lock_acquire "map_load:$path"; 1859 my $guard2 = cf::lock_acquire "map_load:$path";
1496 1860
1497 return if $self->in_memory != cf::MAP_SWAPPED; 1861 return if $self->in_memory != cf::MAP_SWAPPED;
1498 1862
1499 $self->in_memory (cf::MAP_LOADING); 1863 $self->in_memory (cf::MAP_LOADING);
1500 1864
1501 $self->alloc; 1865 $self->alloc;
1502 1866
1503 $self->pre_load; 1867 $self->pre_load;
1504 Coro::cede; 1868 cf::cede_to_tick;
1505 1869
1506 $self->_load_objects ($self->{load_path}, 1) 1870 $self->_load_objects ($self->{load_path}, 1)
1507 or return; 1871 or return;
1508 1872
1509 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1510 if delete $self->{load_original}; 1874 if delete $self->{load_original};
1511 1875
1512 if (my $uniq = $self->uniq_path) { 1876 if (my $uniq = $self->uniq_path) {
1513 utf8::encode $uniq; 1877 utf8::encode $uniq;
1514 if (aio_open $uniq, O_RDONLY, 0) { 1878 if (aio_open $uniq, O_RDONLY, 0) {
1515 $self->clear_unique_items; 1879 $self->clear_unique_items;
1516 $self->_load_objects ($uniq, 0); 1880 $self->_load_objects ($uniq, 0);
1517 } 1881 }
1518 } 1882 }
1519 1883
1520 Coro::cede; 1884 cf::cede_to_tick;
1521 # now do the right thing for maps 1885 # now do the right thing for maps
1522 $self->link_multipart_objects; 1886 $self->link_multipart_objects;
1523 Coro::cede;
1524
1525 unless ($self->{deny_activate}) {
1526 $self->decay_objects;
1527 $self->fix_auto_apply;
1528 $self->update_buttons;
1529 Coro::cede;
1530 $self->set_darkness_map;
1531 $self->difficulty ($self->estimate_difficulty) 1887 $self->difficulty ($self->estimate_difficulty)
1532 unless $self->difficulty; 1888 unless $self->difficulty;
1533 Coro::cede; 1889 cf::cede_to_tick;
1890
1891 unless ($self->{deny_activate}) {
1892 $self->decay_objects;
1893 $self->fix_auto_apply;
1894 $self->update_buttons;
1895 cf::cede_to_tick;
1896 $self->set_darkness_map;
1897 cf::cede_to_tick;
1534 $self->activate; 1898 $self->activate;
1535 Coro::cede; 1899 }
1900
1901 $self->{last_save} = $cf::RUNTIME;
1902 $self->last_access ($cf::RUNTIME);
1903
1904 $self->in_memory (cf::MAP_IN_MEMORY);
1536 } 1905 }
1537 1906
1538 $self->post_load; 1907 $self->post_load;
1539 Coro::cede;
1540
1541 $self->in_memory (cf::MAP_IN_MEMORY);
1542} 1908}
1543 1909
1544sub customise_for { 1910sub customise_for {
1545 my ($self, $ob) = @_; 1911 my ($self, $ob) = @_;
1546 1912
1547 return find "~" . $ob->name . "/" . $self->{path} 1913 return find "~" . $ob->name . "/" . $self->{path}
1548 if $self->per_player; 1914 if $self->per_player;
1549 1915
1916# return find "?party/" . $ob->name . "/" . $self->{path}
1917# if $self->per_party;
1918
1550 $self 1919 $self
1551} 1920}
1552 1921
1553# find and load all maps in the 3x3 area around a map 1922# find and load all maps in the 3x3 area around a map
1554sub load_diag { 1923sub load_neighbours {
1555 my ($map) = @_; 1924 my ($map) = @_;
1556 1925
1557 my @diag; # diagonal neighbours 1926 my @neigh; # diagonal neighbours
1558 1927
1559 for (0 .. 3) { 1928 for (0 .. 3) {
1560 my $neigh = $map->tile_path ($_) 1929 my $neigh = $map->tile_path ($_)
1561 or next; 1930 or next;
1562 $neigh = find $neigh, $map 1931 $neigh = find $neigh, $map
1563 or next; 1932 or next;
1564 $neigh->load; 1933 $neigh->load;
1565 1934
1935 push @neigh,
1566 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1567 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1568 } 1938 }
1569 1939
1570 for (@diag) { 1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1571 my $neigh = find @$_ 1942 my $neigh = find $path, $origin
1572 or next; 1943 or next;
1573 $neigh->load; 1944 $neigh->load;
1574 } 1945 }
1575} 1946}
1576 1947
1581} 1952}
1582 1953
1583sub do_load_sync { 1954sub do_load_sync {
1584 my ($map) = @_; 1955 my ($map) = @_;
1585 1956
1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1958 if $Coro::current == $Coro::main;
1959
1586 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1587} 1961}
1588 1962
1589our %MAP_PREFETCH; 1963our %MAP_PREFETCH;
1590our $MAP_PREFETCHER = undef; 1964our $MAP_PREFETCHER = undef;
1591 1965
1592sub find_async { 1966sub find_async {
1593 my ($path, $origin) = @_; 1967 my ($path, $origin, $load) = @_;
1594 1968
1595 $path = normalise $path, $origin && $origin->{path}; 1969 $path = normalise $path, $origin && $origin->{path};
1596 1970
1597 if (my $map = $cf::MAP{$path}) { 1971 if (my $map = $cf::MAP{$path}) {
1598 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1599 } 1973 }
1600 1974
1601 undef $MAP_PREFETCH{$path}; 1975 $MAP_PREFETCH{$path} |= $load;
1976
1602 $MAP_PREFETCHER ||= cf::async { 1977 $MAP_PREFETCHER ||= cf::async {
1603 while (%MAP_PREFETCH) { 1978 while (%MAP_PREFETCH) {
1604 for my $path (keys %MAP_PREFETCH) { 1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1605 my $map = find $path 1980 if (my $map = find $k) {
1606 or next;
1607 $map->load; 1981 $map->load if $v;
1982 }
1608 1983
1609 delete $MAP_PREFETCH{$path}; 1984 delete $MAP_PREFETCH{$k};
1610 } 1985 }
1611 } 1986 }
1612 undef $MAP_PREFETCHER; 1987 undef $MAP_PREFETCHER;
1613 }; 1988 };
1614 $MAP_PREFETCHER->prio (6); 1989 $MAP_PREFETCHER->prio (6);
1617} 1992}
1618 1993
1619sub save { 1994sub save {
1620 my ($self) = @_; 1995 my ($self) = @_;
1621 1996
1622 my $lock = cf::lock_acquire "map_data:" . $self->path; 1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1623 1998
1624 $self->{last_save} = $cf::RUNTIME; 1999 $self->{last_save} = $cf::RUNTIME;
1625 2000
1626 return unless $self->dirty; 2001 return unless $self->dirty;
1627 2002
1650 my ($self) = @_; 2025 my ($self) = @_;
1651 2026
1652 # save first because save cedes 2027 # save first because save cedes
1653 $self->save; 2028 $self->save;
1654 2029
1655 my $lock = cf::lock_acquire "map_data:" . $self->path; 2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
1656 2031
1657 return if $self->players; 2032 return if $self->players;
1658 return if $self->in_memory != cf::MAP_IN_MEMORY; 2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
1659 return if $self->{deny_save}; 2034 return if $self->{deny_save};
1660 2035
1664 2039
1665sub reset_at { 2040sub reset_at {
1666 my ($self) = @_; 2041 my ($self) = @_;
1667 2042
1668 # TODO: safety, remove and allow resettable per-player maps 2043 # TODO: safety, remove and allow resettable per-player maps
1669 return 1e99 if $self->isa ("ext::map_per_player");#d#
1670 return 1e99 if $self->{deny_reset}; 2044 return 1e99 if $self->{deny_reset};
1671 2045
1672 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2046 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1673 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2047 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1674 2048
1685 my ($self) = @_; 2059 my ($self) = @_;
1686 2060
1687 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2061 my $lock = cf::lock_acquire "map_data:$self->{path}";
1688 2062
1689 return if $self->players; 2063 return if $self->players;
1690 return if $self->isa ("ext::map_per_player");#d#
1691 2064
1692 warn "resetting map ", $self->path;#d# 2065 warn "resetting map ", $self->path;
1693 2066
1694 $self->in_memory (cf::MAP_SWAPPED); 2067 $self->in_memory (cf::MAP_SWAPPED);
1695 2068
1696 # need to save uniques path 2069 # need to save uniques path
1697 unless ($self->{deny_save}) { 2070 unless ($self->{deny_save}) {
1714my $nuke_counter = "aaaa"; 2087my $nuke_counter = "aaaa";
1715 2088
1716sub nuke { 2089sub nuke {
1717 my ($self) = @_; 2090 my ($self) = @_;
1718 2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
1719 delete $cf::MAP{$self->path}; 2095 delete $cf::MAP{$self->path};
1720 2096
1721 $self->unlink_save; 2097 $self->unlink_save;
1722 2098
1723 bless $self, "cf::map"; 2099 bless $self, "cf::map";
1724 delete $self->{deny_reset}; 2100 delete $self->{deny_reset};
1725 $self->{deny_save} = 1; 2101 $self->{deny_save} = 1;
1726 $self->reset_timeout (1); 2102 $self->reset_timeout (1);
1727 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1728 2104
1729 $cf::MAP{$self->path} = $self; 2105 $cf::MAP{$self->path} = $self;
2106 }
1730 2107
1731 $self->reset; # polite request, might not happen 2108 $self->reset; # polite request, might not happen
2109}
2110
2111=item $maps = cf::map::tmp_maps
2112
2113Returns an arrayref with all map paths of currently instantiated and saved
2114maps. May block.
2115
2116=cut
2117
2118sub tmp_maps() {
2119 [
2120 map {
2121 utf8::decode $_;
2122 /\.map$/
2123 ? normalise $_
2124 : ()
2125 } @{ aio_readdir $TMPDIR or [] }
2126 ]
2127}
2128
2129=item $maps = cf::map::random_maps
2130
2131Returns an arrayref with all map paths of currently instantiated and saved
2132random maps. May block.
2133
2134=cut
2135
2136sub random_maps() {
2137 [
2138 map {
2139 utf8::decode $_;
2140 /\.map$/
2141 ? normalise "?random/$_"
2142 : ()
2143 } @{ aio_readdir $RANDOMDIR or [] }
2144 ]
1732} 2145}
1733 2146
1734=item cf::map::unique_maps 2147=item cf::map::unique_maps
1735 2148
1736Returns an arrayref of paths of all shared maps that have 2149Returns an arrayref of paths of all shared maps that have
1737instantiated unique items. May block. 2150instantiated unique items. May block.
1738 2151
1739=cut 2152=cut
1740 2153
1741sub unique_maps() { 2154sub unique_maps() {
1742 my $files = aio_readdir $UNIQUEDIR 2155 [
1743 or return; 2156 map {
1744
1745 my @paths;
1746
1747 for (@$files) {
1748 utf8::decode $_; 2157 utf8::decode $_;
1749 next if /\.pst$/; 2158 /\.map$/
1750 next unless /^$PATH_SEP/o; 2159 ? normalise $_
1751 2160 : ()
1752 push @paths, cf::map::normalise $_; 2161 } @{ aio_readdir $UNIQUEDIR or [] }
1753 } 2162 ]
1754
1755 \@paths
1756} 2163}
1757 2164
1758package cf; 2165package cf;
1759 2166
1760=back 2167=back
1806 2213
1807 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1808 2215
1809 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
1810 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
1811 } else { 2219 } else {
2220 my $pl = $self->contr;
2221
2222 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2223 my $dialog = $pl->{npc_dialog};
2224 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2225
2226 } else {
1812 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1813 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1814 } 2230 }
2231}
2232
2233=item $object->send_msg ($channel, $msg, $color, [extra...])
2234
2235=cut
2236
2237sub cf::object::send_msg {
2238 my $pl = shift->contr
2239 or return;
2240 $pl->send_msg (@_);
1815} 2241}
1816 2242
1817=item $player_object->may ("access") 2243=item $player_object->may ("access")
1818 2244
1819Returns wether the given player is authorized to access resource "access" 2245Returns wether the given player is authorized to access resource "access"
1866 $self->deactivate_recursive; 2292 $self->deactivate_recursive;
1867 2293
1868 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2294 return if UNIVERSAL::isa $self->map, "ext::map_link";
1869 2295
1870 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2296 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1871 if $self->map; 2297 if $self->map && $self->map->{path} ne "{link}";
1872 2298
1873 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2299 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1874} 2300}
1875 2301
1876sub cf::object::player::leave_link { 2302sub cf::object::player::leave_link {
1877 my ($self, $map, $x, $y) = @_; 2303 my ($self, $map, $x, $y) = @_;
2304
2305 return unless $self->contr->active;
1878 2306
1879 my $link_pos = delete $self->{_link_pos}; 2307 my $link_pos = delete $self->{_link_pos};
1880 2308
1881 unless ($map) { 2309 unless ($map) {
1882 # restore original map position 2310 # restore original map position
1896 # use -1 or undef as default coordinates, not 0, 0 2324 # use -1 or undef as default coordinates, not 0, 0
1897 ($x, $y) = ($map->enter_x, $map->enter_y) 2325 ($x, $y) = ($map->enter_x, $map->enter_y)
1898 if $x <=0 && $y <= 0; 2326 if $x <=0 && $y <= 0;
1899 2327
1900 $map->load; 2328 $map->load;
1901 $map->load_diag; 2329 $map->load_neighbours;
1902 2330
1903 return unless $self->contr->active; 2331 return unless $self->contr->active;
1904 $self->activate_recursive; 2332 $self->activate_recursive;
1905 2333
1906 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1907 $self->enter_map ($map, $x, $y); 2335 $self->enter_map ($map, $x, $y);
1908} 2336}
1909 2337
1910cf::player->attach ( 2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1911 on_logout => sub {
1912 my ($pl) = @_;
1913 2339
1914 # abort map switching before logout 2340Moves the player to the given map-path and coordinates by first freezing
1915 if ($pl->ob->{_link_pos}) { 2341her, loading and preparing them map, calling the provided $check callback
1916 cf::sync_job { 2342that has to return the map if sucecssful, and then unfreezes the player on
1917 $pl->ob->leave_link 2343the new (success) or old (failed) map position. In either case, $done will
1918 }; 2344be called at the end of this process.
1919 }
1920 },
1921 on_login => sub {
1922 my ($pl) = @_;
1923 2345
1924 # try to abort aborted map switching on player login :)
1925 # should happen only on crashes
1926 if ($pl->ob->{_link_pos}) {
1927 $pl->ob->enter_link;
1928 (async {
1929 $pl->ob->reply (undef,
1930 "There was an internal problem at your last logout, "
1931 . "the server will try to bring you to your intended destination in a second.",
1932 cf::NDI_RED);
1933 # we need this sleep as the login has a concurrent enter_exit running
1934 # and this sleep increases chances of the player not ending up in scorn
1935 Coro::Timer::sleep 1;
1936 $pl->ob->leave_link;
1937 })->prio (2);
1938 }
1939 },
1940);
1941
1942=item $player_object->goto ($path, $x, $y)
1943
1944=cut 2346=cut
2347
2348our $GOTOGEN;
1945 2349
1946sub cf::object::player::goto { 2350sub cf::object::player::goto {
1947 my ($self, $path, $x, $y) = @_; 2351 my ($self, $path, $x, $y, $check, $done) = @_;
2352
2353 # do generation counting so two concurrent goto's will be executed in-order
2354 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1948 2355
1949 $self->enter_link; 2356 $self->enter_link;
1950 2357
1951 (async { 2358 (async {
1952 my $map = eval { 2359 my $map = eval {
1953 my $map = cf::map::find $path; 2360 my $map = cf::map::find $path;
2361
2362 if ($map) {
1954 $map = $map->customise_for ($self) if $map; 2363 $map = $map->customise_for ($self);
2364 $map = $check->($map) if $check && $map;
2365 } else {
2366 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2367 }
2368
1955 $map 2369 $map
2370 };
2371
2372 if ($@) {
2373 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2374 LOG llevError | logBacktrace, Carp::longmess $@;
1956 } or 2375 }
1957 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1958 2376
2377 if ($gen == $self->{_goto_generation}) {
2378 delete $self->{_goto_generation};
1959 $self->leave_link ($map, $x, $y); 2379 $self->leave_link ($map, $x, $y);
2380 }
2381
2382 $done->() if $done;
1960 })->prio (1); 2383 })->prio (1);
1961} 2384}
1962 2385
1963=item $player_object->enter_exit ($exit_object) 2386=item $player_object->enter_exit ($exit_object)
1964 2387
2033 my $hp = $exit->stats->hp; 2456 my $hp = $exit->stats->hp;
2034 my $sp = $exit->stats->sp; 2457 my $sp = $exit->stats->sp;
2035 2458
2036 $self->enter_link; 2459 $self->enter_link;
2037 2460
2461 # if exit is damned, update players death & WoR home-position
2462 $self->contr->savebed ($slaying, $hp, $sp)
2463 if $exit->flag (FLAG_DAMNED);
2464
2038 (async { 2465 (async {
2039 $self->deactivate_recursive; # just to be sure 2466 $self->deactivate_recursive; # just to be sure
2040 unless (eval { 2467 unless (eval {
2041 $self->goto ($slaying, $hp, $sp); 2468 $self->goto ($slaying, $hp, $sp);
2042 2469
2069 2496
2070 utf8::encode $text; 2497 utf8::encode $text;
2071 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2072} 2499}
2073 2500
2501=item $client->send_msg ($channel, $msg, $color, [extra...])
2502
2503Send a drawinfo or msg packet to the client, formatting the msg for the
2504client if neccessary. C<$type> should be a string identifying the type of
2505the message, with C<log> being the default. If C<$color> is negative, suppress
2506the message unless the client supports the msg packet.
2507
2508=cut
2509
2510our %CHANNEL = (
2511 "c/identify" => {
2512 id => "identify",
2513 title => "Identify",
2514 reply => undef,
2515 tooltip => "Items recently identified",
2516 },
2517 "c/examine" => {
2518 id => "examine",
2519 title => "Examine",
2520 reply => undef,
2521 tooltip => "Signs and other items you examined",
2522 },
2523);
2524
2525sub cf::client::send_msg {
2526 my ($self, $channel, $msg, $color, @extra) = @_;
2527
2528 $msg = $self->pl->expand_cfpod ($msg);
2529
2530 $color &= cf::NDI_CLIENT_MASK; # just in case...
2531
2532 # check predefined channels, for the benefit of C
2533 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2534
2535 if (ref $channel) {
2536 # send meta info to client, if not yet sent
2537 unless (exists $self->{channel}{$channel->{id}}) {
2538 $self->{channel}{$channel->{id}} = $channel;
2539 $self->ext_msg (channel_info => $channel);
2540 }
2541
2542 $channel = $channel->{id};
2543 }
2544
2545 return unless @extra || length $msg;
2546
2547 if ($self->can_msg) {
2548 # default colour, mask it out
2549 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2550 if $color & cf::NDI_DEF;
2551
2552 $self->send_packet ("msg " . $self->{json_coder}->encode (
2553 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2554 } else {
2555 if ($color >= 0) {
2556 # replace some tags by gcfclient-compatible ones
2557 for ($msg) {
2558 1 while
2559 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2560 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2561 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2562 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2563 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2564 }
2565
2566 $color &= cf::NDI_COLOR_MASK;
2567
2568 utf8::encode $msg;
2569
2570 if (0 && $msg =~ /\[/) {
2571 # COMMAND/INFO
2572 $self->send_packet ("drawextinfo $color 10 8 $msg")
2573 } else {
2574 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2575 $self->send_packet ("drawinfo $color $msg")
2576 }
2577 }
2578 }
2579}
2580
2074=item $client->ext_event ($type, %msg) 2581=item $client->ext_msg ($type, @msg)
2075 2582
2076Sends an exti event to the client. 2583Sends an ext event to the client.
2077 2584
2078=cut 2585=cut
2079 2586
2080sub cf::client::ext_event($$%) { 2587sub cf::client::ext_msg($$@) {
2081 my ($self, $type, %msg) = @_; 2588 my ($self, $type, @msg) = @_;
2082 2589
2590 if ($self->extcmd == 2) {
2591 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2592 } elsif ($self->extcmd == 1) { # TODO: remove
2083 $msg{msgtype} = "event_$type"; 2593 push @msg, msgtype => "event_$type";
2084 $self->send_packet ("ext " . cf::to_json \%msg); 2594 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2595 }
2596}
2597
2598=item $client->ext_reply ($msgid, @msg)
2599
2600Sends an ext reply to the client.
2601
2602=cut
2603
2604sub cf::client::ext_reply($$@) {
2605 my ($self, $id, @msg) = @_;
2606
2607 if ($self->extcmd == 2) {
2608 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2609 } elsif ($self->extcmd == 1) {
2610 #TODO: version 1, remove
2611 unshift @msg, msgtype => "reply", msgid => $id;
2612 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2613 }
2085} 2614}
2086 2615
2087=item $success = $client->query ($flags, "text", \&cb) 2616=item $success = $client->query ($flags, "text", \&cb)
2088 2617
2089Queues a query to the client, calling the given callback with 2618Queues a query to the client, calling the given callback with
2090the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2619the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2091C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2620C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2092 2621
2093Queries can fail, so check the return code. Or don't, as queries will become 2622Queries can fail, so check the return code. Or don't, as queries will
2094reliable at some point in the future. 2623become reliable at some point in the future.
2095 2624
2096=cut 2625=cut
2097 2626
2098sub cf::client::query { 2627sub cf::client::query {
2099 my ($self, $flags, $text, $cb) = @_; 2628 my ($self, $flags, $text, $cb) = @_;
2107 utf8::encode $text; 2636 utf8::encode $text;
2108 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2637 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2109 2638
2110 $self->send_packet ($self->{query_queue}[0][0]) 2639 $self->send_packet ($self->{query_queue}[0][0])
2111 if @{ $self->{query_queue} } == 1; 2640 if @{ $self->{query_queue} } == 1;
2641
2642 1
2112} 2643}
2113 2644
2114cf::client->attach ( 2645cf::client->attach (
2646 on_connect => sub {
2647 my ($ns) = @_;
2648
2649 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2650 },
2115 on_reply => sub { 2651 on_reply => sub {
2116 my ($ns, $msg) = @_; 2652 my ($ns, $msg) = @_;
2117 2653
2118 # this weird shuffling is so that direct followup queries 2654 # this weird shuffling is so that direct followup queries
2119 # get handled first 2655 # get handled first
2131 } else { 2667 } else {
2132 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2668 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2133 } 2669 }
2134 } 2670 }
2135 }, 2671 },
2672 on_exticmd => sub {
2673 my ($ns, $buf) = @_;
2674
2675 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2676
2677 if (ref $msg) {
2678 my ($type, $reply, @payload) =
2679 "ARRAY" eq ref $msg
2680 ? @$msg
2681 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2682
2683 my @reply;
2684
2685 if (my $cb = $EXTICMD{$type}) {
2686 @reply = $cb->($ns, @payload);
2687 }
2688
2689 $ns->ext_reply ($reply, @reply)
2690 if $reply;
2691
2692 } else {
2693 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2694 }
2695
2696 cf::override;
2697 },
2136); 2698);
2137 2699
2138=item $client->async (\&cb) 2700=item $client->async (\&cb)
2139 2701
2140Create a new coroutine, running the specified callback. The coroutine will 2702Create a new coroutine, running the specified callback. The coroutine will
2181our $safe = new Safe "safe"; 2743our $safe = new Safe "safe";
2182our $safe_hole = new Safe::Hole; 2744our $safe_hole = new Safe::Hole;
2183 2745
2184$SIG{FPE} = 'IGNORE'; 2746$SIG{FPE} = 'IGNORE';
2185 2747
2186$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2748$safe->permit_only (Opcode::opset qw(
2749 :base_core :base_mem :base_orig :base_math
2750 grepstart grepwhile mapstart mapwhile
2751 sort time
2752));
2187 2753
2188# here we export the classes and methods available to script code 2754# here we export the classes and methods available to script code
2189 2755
2190=pod 2756=pod
2191 2757
2192The following functions and methods are available within a safe environment: 2758The following functions and methods are available within a safe environment:
2193 2759
2194 cf::object contr pay_amount pay_player map 2760 cf::object
2761 contr pay_amount pay_player map x y force_find force_add
2762 insert remove name archname title slaying race decrease_ob_nr
2763
2195 cf::object::player player 2764 cf::object::player
2196 cf::player peaceful 2765 player
2197 cf::map trigger 2766
2767 cf::player
2768 peaceful
2769
2770 cf::map
2771 trigger
2198 2772
2199=cut 2773=cut
2200 2774
2201for ( 2775for (
2202 ["cf::object" => qw(contr pay_amount pay_player map)], 2776 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2777 insert remove inv name archname title slaying race
2778 decrease_ob_nr)],
2203 ["cf::object::player" => qw(player)], 2779 ["cf::object::player" => qw(player)],
2204 ["cf::player" => qw(peaceful)], 2780 ["cf::player" => qw(peaceful)],
2205 ["cf::map" => qw(trigger)], 2781 ["cf::map" => qw(trigger)],
2206) { 2782) {
2207 no strict 'refs'; 2783 no strict 'refs';
2278=back 2854=back
2279 2855
2280=cut 2856=cut
2281 2857
2282############################################################################# 2858#############################################################################
2283
2284=head2 EXTENSION DATABASE SUPPORT
2285
2286Crossfire maintains a very simple database for extension use. It can
2287currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2288convert to/from binary).
2289
2290The parameter C<$family> should best start with the name of the extension
2291using it, it should be unique.
2292
2293=over 4
2294
2295=item $value = cf::db_get $family => $key
2296
2297Returns a single value from the database.
2298
2299=item cf::db_put $family => $key => $value
2300
2301Stores the given C<$value> in the family.
2302
2303=cut
2304
2305our $DB;
2306
2307sub db_init {
2308 unless ($DB) {
2309 $DB = BDB::db_create $DB_ENV;
2310
2311 cf::sync_job {
2312 eval {
2313 $DB->set_flags (BDB::CHKSUM);
2314
2315 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2316 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2317 cf::cleanup "db_open(db): $!" if $!;
2318 };
2319 cf::cleanup "db_open(db): $@" if $@;
2320 };
2321 }
2322}
2323
2324sub db_get($$) {
2325 my $key = "$_[0]/$_[1]";
2326
2327 cf::sync_job {
2328 BDB::db_get $DB, undef, $key, my $data;
2329
2330 $! ? ()
2331 : $data
2332 }
2333}
2334
2335sub db_put($$$) {
2336 BDB::dbreq_pri 4;
2337 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2338}
2339
2340=item cf::cache $id => [$paths...], $processversion => $process
2341
2342Generic caching function that returns the value of the resource $id,
2343caching and regenerating as required.
2344
2345This function can block.
2346
2347=cut
2348
2349sub cache {
2350 my ($id, $src, $processversion, $process) = @_;
2351
2352 my $meta =
2353 join "\x00",
2354 $processversion,
2355 map {
2356 aio_stat $_
2357 and Carp::croak "$_: $!";
2358
2359 ($_, (stat _)[7,9])
2360 } @$src;
2361
2362 my $dbmeta = db_get cache => "$id/meta";
2363 if ($dbmeta ne $meta) {
2364 # changed, we may need to process
2365
2366 my @data;
2367 my $md5;
2368
2369 for (0 .. $#$src) {
2370 0 <= aio_load $src->[$_], $data[$_]
2371 or Carp::croak "$src->[$_]: $!";
2372 }
2373
2374 # if processing is expensive, check
2375 # checksum first
2376 if (1) {
2377 $md5 =
2378 join "\x00",
2379 $processversion,
2380 map {
2381 Coro::cede;
2382 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2383 } 0.. $#$src;
2384
2385
2386 my $dbmd5 = db_get cache => "$id/md5";
2387 if ($dbmd5 eq $md5) {
2388 db_put cache => "$id/meta", $meta;
2389
2390 return db_get cache => "$id/data";
2391 }
2392 }
2393
2394 my $t1 = Time::HiRes::time;
2395 my $data = $process->(\@data);
2396 my $t2 = Time::HiRes::time;
2397
2398 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2399
2400 db_put cache => "$id/data", $data;
2401 db_put cache => "$id/md5" , $md5;
2402 db_put cache => "$id/meta", $meta;
2403
2404 return $data;
2405 }
2406
2407 db_get cache => "$id/data"
2408}
2409
2410=item fork_call { }, $args
2411
2412Executes the given code block with the given arguments in a seperate
2413process, returning the results. Everything must be serialisable with
2414Coro::Storable. May, of course, block. Note that the executed sub may
2415never block itself or use any form of Event handling.
2416
2417=cut
2418
2419sub fork_call(&@) {
2420 my ($cb, @args) = @_;
2421
2422# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2423# or die "socketpair: $!";
2424 pipe my $fh1, my $fh2
2425 or die "pipe: $!";
2426
2427 if (my $pid = fork) {
2428 close $fh2;
2429
2430 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2431 $res = Coro::Storable::thaw $res;
2432
2433 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2434
2435 die $$res unless "ARRAY" eq ref $res;
2436
2437 return wantarray ? @$res : $res->[-1];
2438 } else {
2439 local $SIG{__WARN__};
2440 eval {
2441 local $SIG{__DIE__};
2442 close $fh1;
2443
2444 my @res = eval { $cb->(@args) };
2445 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2446 };
2447
2448 warn $@ if $@;
2449 _exit 0;
2450 }
2451}
2452
2453
2454
2455#############################################################################
2456# the server's init and main functions 2859# the server's init and main functions
2457 2860
2458sub load_facedata($) { 2861sub load_facedata($) {
2459 my ($path) = @_; 2862 my ($path) = @_;
2863
2864 # HACK to clear player env face cache, we need some signal framework
2865 # for this (global event?)
2866 %ext::player_env::MUSIC_FACE_CACHE = ();
2867
2868 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2460 2869
2461 warn "loading facedata from $path\n"; 2870 warn "loading facedata from $path\n";
2462 2871
2463 my $facedata; 2872 my $facedata;
2464 0 < aio_load $path, $facedata 2873 0 < aio_load $path, $facedata
2467 $facedata = Coro::Storable::thaw $facedata; 2876 $facedata = Coro::Storable::thaw $facedata;
2468 2877
2469 $facedata->{version} == 2 2878 $facedata->{version} == 2
2470 or cf::cleanup "$path: version mismatch, cannot proceed."; 2879 or cf::cleanup "$path: version mismatch, cannot proceed.";
2471 2880
2881 # patch in the exptable
2882 $facedata->{resource}{"res/exp_table"} = {
2883 type => FT_RSRC,
2884 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2885 };
2886 cf::cede_to_tick;
2887
2472 { 2888 {
2473 my $faces = $facedata->{faceinfo}; 2889 my $faces = $facedata->{faceinfo};
2474 2890
2475 while (my ($face, $info) = each %$faces) { 2891 while (my ($face, $info) = each %$faces) {
2476 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2892 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2477 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2893 cf::face::set_visibility $idx, $info->{visibility};
2894 cf::face::set_magicmap $idx, $info->{magicmap};
2478 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2895 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2479 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2896 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2480 Coro::cede; 2897
2898 cf::cede_to_tick;
2481 } 2899 }
2482 2900
2483 while (my ($face, $info) = each %$faces) { 2901 while (my ($face, $info) = each %$faces) {
2484 next unless $info->{smooth}; 2902 next unless $info->{smooth};
2485 my $idx = cf::face::find $face 2903 my $idx = cf::face::find $face
2486 or next; 2904 or next;
2487 if (my $smooth = cf::face::find $info->{smooth}) { 2905 if (my $smooth = cf::face::find $info->{smooth}) {
2906 cf::face::set_smooth $idx, $smooth;
2488 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2907 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2489 } else { 2908 } else {
2490 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2909 warn "smooth face '$info->{smooth}' not found for face '$face'";
2491 } 2910 }
2492 Coro::cede; 2911
2912 cf::cede_to_tick;
2493 } 2913 }
2494 } 2914 }
2495 2915
2496 { 2916 {
2497 my $anims = $facedata->{animinfo}; 2917 my $anims = $facedata->{animinfo};
2498 2918
2499 while (my ($anim, $info) = each %$anims) { 2919 while (my ($anim, $info) = each %$anims) {
2500 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2920 cf::anim::set $anim, $info->{frames}, $info->{facings};
2501 Coro::cede; 2921 cf::cede_to_tick;
2502 } 2922 }
2503 2923
2504 cf::anim::invalidate_all; # d'oh 2924 cf::anim::invalidate_all; # d'oh
2505 } 2925 }
2506 2926
2927 {
2928 # TODO: for gcfclient pleasure, we should give resources
2929 # that gcfclient doesn't grok a >10000 face index.
2930 my $res = $facedata->{resource};
2931
2932 my $soundconf = delete $res->{"res/sound.conf"};
2933
2934 while (my ($name, $info) = each %$res) {
2935 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2936 my $data;
2937
2938 if ($info->{type} & 1) {
2939 # prepend meta info
2940
2941 my $meta = $enc->encode ({
2942 name => $name,
2943 %{ $info->{meta} || {} },
2944 });
2945
2946 $data = pack "(w/a*)*", $meta, $info->{data};
2947 } else {
2948 $data = $info->{data};
2949 }
2950
2951 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2952 cf::face::set_type $idx, $info->{type};
2953
2954 cf::cede_to_tick;
2955 }
2956
2957 if ($soundconf) {
2958 $soundconf = $enc->decode (delete $soundconf->{data});
2959
2960 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2961 my $sound = $soundconf->{compat}[$_]
2962 or next;
2963
2964 my $face = cf::face::find "sound/$sound->[1]";
2965 cf::sound::set $sound->[0] => $face;
2966 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2967 }
2968
2969 while (my ($k, $v) = each %{$soundconf->{event}}) {
2970 my $face = cf::face::find "sound/$v";
2971 cf::sound::set $k => $face;
2972 }
2973 }
2974 }
2975
2507 1 2976 1
2508} 2977}
2509 2978
2979register_exticmd fx_want => sub {
2980 my ($ns, $want) = @_;
2981
2982 while (my ($k, $v) = each %$want) {
2983 $ns->fx_want ($k, $v);
2984 }
2985};
2986
2510sub reload_regions { 2987sub reload_regions {
2988 # HACK to clear player env face cache, we need some signal framework
2989 # for this (global event?)
2990 %ext::player_env::MUSIC_FACE_CACHE = ();
2991
2511 load_resource_file "$MAPDIR/regions" 2992 load_resource_file "$MAPDIR/regions"
2512 or die "unable to load regions file\n"; 2993 or die "unable to load regions file\n";
2994
2995 for (cf::region::list) {
2996 $_->{match} = qr/$_->{match}/
2997 if exists $_->{match};
2998 }
2513} 2999}
2514 3000
2515sub reload_facedata { 3001sub reload_facedata {
2516 load_facedata "$DATADIR/facedata" 3002 load_facedata "$DATADIR/facedata"
2517 or die "unable to load facedata\n"; 3003 or die "unable to load facedata\n";
2518} 3004}
2519 3005
2520sub reload_archetypes { 3006sub reload_archetypes {
2521 load_resource_file "$DATADIR/archetypes" 3007 load_resource_file "$DATADIR/archetypes"
2522 or die "unable to load archetypes\n"; 3008 or die "unable to load archetypes\n";
3009 #d# NEED to laod twice to resolve forward references
3010 # this really needs to be done in an extra post-pass
3011 # (which needs to be synchronous, so solve it differently)
3012 load_resource_file "$DATADIR/archetypes"
3013 or die "unable to load archetypes\n";
2523} 3014}
2524 3015
2525sub reload_treasures { 3016sub reload_treasures {
2526 load_resource_file "$DATADIR/treasures" 3017 load_resource_file "$DATADIR/treasures"
2527 or die "unable to load treasurelists\n"; 3018 or die "unable to load treasurelists\n";
2530sub reload_resources { 3021sub reload_resources {
2531 warn "reloading resource files...\n"; 3022 warn "reloading resource files...\n";
2532 3023
2533 reload_regions; 3024 reload_regions;
2534 reload_facedata; 3025 reload_facedata;
3026 #reload_archetypes;#d#
2535 reload_archetypes; 3027 reload_archetypes;
2536 reload_treasures; 3028 reload_treasures;
2537 3029
2538 warn "finished reloading resource files\n"; 3030 warn "finished reloading resource files\n";
2539} 3031}
2540 3032
2541sub init { 3033sub init {
2542 reload_resources; 3034 reload_resources;
2543} 3035}
2544 3036
2545sub cfg_load { 3037sub reload_config {
2546 open my $fh, "<:utf8", "$CONFDIR/config" 3038 open my $fh, "<:utf8", "$CONFDIR/config"
2547 or return; 3039 or return;
2548 3040
2549 local $/; 3041 local $/;
2550 *CFG = YAML::Syck::Load <$fh>; 3042 *CFG = YAML::Syck::Load <$fh>;
2570 (async { 3062 (async {
2571 Event::one_event; 3063 Event::one_event;
2572 })->prio (Coro::PRIO_MAX); 3064 })->prio (Coro::PRIO_MAX);
2573 }; 3065 };
2574 3066
2575 cfg_load; 3067 reload_config;
2576 db_init; 3068 db_init;
2577 load_extensions; 3069 load_extensions;
2578 3070
2579 $TICK_WATCHER->start; 3071 $TICK_WATCHER->start;
2580 Event::loop; 3072 Event::loop;
2596 }, 3088 },
2597 ); 3089 );
2598 } 3090 }
2599} 3091}
2600 3092
3093sub write_runtime {
3094 my $runtime = "$LOCALDIR/runtime";
3095
3096 # first touch the runtime file to show we are still running:
3097 # the fsync below can take a very very long time.
3098
3099 IO::AIO::aio_utime $runtime, undef, undef;
3100
3101 my $guard = cf::lock_acquire "write_runtime";
3102
3103 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3104 or return;
3105
3106 my $value = $cf::RUNTIME + 90 + 10;
3107 # 10 is the runtime save interval, for a monotonic clock
3108 # 60 allows for the watchdog to kill the server.
3109
3110 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3111 and return;
3112
3113 # always fsync - this file is important
3114 aio_fsync $fh
3115 and return;
3116
3117 # touch it again to show we are up-to-date
3118 aio_utime $fh, undef, undef;
3119
3120 close $fh
3121 or return;
3122
3123 aio_rename "$runtime~", $runtime
3124 and return;
3125
3126 warn "runtime file written.\n";
3127
3128 1
3129}
3130
2601sub emergency_save() { 3131sub emergency_save() {
2602 my $freeze_guard = cf::freeze_mainloop; 3132 my $freeze_guard = cf::freeze_mainloop;
2603 3133
2604 warn "enter emergency perl save\n"; 3134 warn "enter emergency perl save\n";
2605 3135
2680 %EXT_CORO = (); 3210 %EXT_CORO = ();
2681 3211
2682 warn "removing commands"; 3212 warn "removing commands";
2683 %COMMAND = (); 3213 %COMMAND = ();
2684 3214
2685 warn "removing ext commands"; 3215 warn "removing ext/exti commands";
2686 %EXTCMD = (); 3216 %EXTCMD = ();
3217 %EXTICMD = ();
2687 3218
2688 warn "unloading/nuking all extensions"; 3219 warn "unloading/nuking all extensions";
2689 for my $pkg (@EXTS) { 3220 for my $pkg (@EXTS) {
2690 warn "... unloading $pkg"; 3221 warn "... unloading $pkg";
2691 3222
2734 warn "reloading cf.pm"; 3265 warn "reloading cf.pm";
2735 require cf; 3266 require cf;
2736 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3267 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2737 3268
2738 warn "loading config and database again"; 3269 warn "loading config and database again";
2739 cf::cfg_load; 3270 cf::reload_config;
2740 3271
2741 warn "loading extensions"; 3272 warn "loading extensions";
2742 cf::load_extensions; 3273 cf::load_extensions;
2743 3274
2744 warn "reattaching attachments to objects/players"; 3275 warn "reattaching attachments to objects/players";
2809 my $signal = new Coro::Signal; 3340 my $signal = new Coro::Signal;
2810 push @WAIT_FOR_TICK_BEGIN, $signal; 3341 push @WAIT_FOR_TICK_BEGIN, $signal;
2811 $signal->wait; 3342 $signal->wait;
2812} 3343}
2813 3344
3345 my $min = 1e6;#d#
3346 my $avg = 10;
2814$TICK_WATCHER = Event->timer ( 3347$TICK_WATCHER = Event->timer (
2815 reentrant => 0, 3348 reentrant => 0,
2816 parked => 1, 3349 parked => 1,
2817 prio => 0, 3350 prio => 0,
2818 at => $NEXT_TICK || $TICK, 3351 at => $NEXT_TICK || $TICK,
2822 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3355 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2823 unless ++$bug_warning > 10; 3356 unless ++$bug_warning > 10;
2824 return; 3357 return;
2825 } 3358 }
2826 3359
2827 $NOW = Event::time; 3360 $NOW = $tick_start = Event::time;
2828 3361
2829 cf::server_tick; # one server iteration 3362 cf::server_tick; # one server iteration
3363
3364 0 && sync_job {#d#
3365 for(1..10) {
3366 my $t = Event::time;
3367 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3368 or die;
3369
3370 $map->width (50);
3371 $map->height (50);
3372 $map->alloc;
3373 $map->_load_objects ("/tmp/x.map", 1);
3374 my $t = Event::time - $t;
3375
3376 #next unless $t < 0.0013;#d#
3377 if ($t < $min) {
3378 $min = $t;
3379 }
3380 $avg = $avg * 0.99 + $t * 0.01;
3381 }
3382 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3383 exit 0;
3384 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3385 };
2830 3386
2831 $RUNTIME += $TICK; 3387 $RUNTIME += $TICK;
2832 $NEXT_TICK += $TICK; 3388 $NEXT_TICK += $TICK;
2833 3389
2834 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3390 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2840 } 3396 }
2841 3397
2842# my $AFTER = Event::time; 3398# my $AFTER = Event::time;
2843# warn $AFTER - $NOW;#d# 3399# warn $AFTER - $NOW;#d#
2844 3400
3401 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3402 $sig->send;
3403 }
3404 while (my $sig = shift @WAIT_FOR_TICK) {
3405 $sig->send;
3406 }
3407
3408 $NOW = Event::time;
3409
2845 # if we are delayed by four ticks or more, skip them all 3410 # if we are delayed by four ticks or more, skip them all
2846 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3411 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2847 3412
2848 $TICK_WATCHER->at ($NEXT_TICK); 3413 $TICK_WATCHER->at ($NEXT_TICK);
2849 $TICK_WATCHER->start; 3414 $TICK_WATCHER->start;
2850 3415
2851 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3416 $LOAD = ($NOW - $tick_start) / $TICK;
2852 $sig->send; 3417 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2853 }
2854 while (my $sig = shift @WAIT_FOR_TICK) {
2855 $sig->send;
2856 }
2857 3418
2858 _post_tick; 3419 _post_tick;
3420
3421
2859 }, 3422 },
2860); 3423);
2861 3424
2862{ 3425{
2863 BDB::max_poll_time $TICK * 0.1; 3426 BDB::max_poll_time $TICK * 0.1;
2922 prio => 6, 3485 prio => 6,
2923 cb => \&IO::AIO::poll_cb, 3486 cb => \&IO::AIO::poll_cb,
2924 ); 3487 );
2925} 3488}
2926 3489
3490my $_log_backtrace;
3491
3492sub _log_backtrace {
3493 my ($msg, @addr) = @_;
3494
3495 $msg =~ s/\n//;
3496
3497 # limit the # of concurrent backtraces
3498 if ($_log_backtrace < 2) {
3499 ++$_log_backtrace;
3500 async {
3501 my @bt = fork_call {
3502 @addr = map { sprintf "%x", $_ } @addr;
3503 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3504 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3505 or die "addr2line: $!";
3506
3507 my @funcs;
3508 my @res = <$fh>;
3509 chomp for @res;
3510 while (@res) {
3511 my ($func, $line) = splice @res, 0, 2, ();
3512 push @funcs, "[$func] $line";
3513 }
3514
3515 @funcs
3516 };
3517
3518 LOG llevInfo, "[ABT] $msg\n";
3519 LOG llevInfo, "[ABT] $_\n" for @bt;
3520 --$_log_backtrace;
3521 };
3522 } else {
3523 LOG llevInfo, "[ABT] $msg\n";
3524 LOG llevInfo, "[ABT] [suppressed]\n";
3525 }
3526}
3527
2927# load additional modules 3528# load additional modules
2928use cf::pod; 3529use cf::pod;
2929 3530
2930END { cf::emergency_save } 3531END { cf::emergency_save }
2931 3532

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines