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.44 by root, Sat Aug 26 08:44:06 2006 UTC vs.
Revision 1.353 by root, Sun Sep 2 08:43:46 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
8use Socket;
5use Storable; 9use Storable;
10use Event;
6use Opcode; 11use Opcode;
7use Safe; 12use Safe;
8use Safe::Hole; 13use Safe::Hole;
9 14
15use Coro 3.64 ();
16use Coro::State;
17use Coro::Handle;
18use Coro::Event;
19use Coro::Timer;
20use Coro::Signal;
21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::Storable;
24use Coro::Util ();
25
26use JSON::XS ();
27use BDB ();
28use Data::Dumper;
29use Digest::MD5;
30use Fcntl;
31use YAML::Syck ();
32use IO::AIO 2.32 ();
10use Time::HiRes; 33use Time::HiRes;
11use Event; 34use Compress::LZF;
35use Digest::MD5 ();
36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
42
12$Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
13 44
14use strict; 45# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
46$YAML::Syck::ImplicitUnicode = 1;
15 47
48$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
16our %COMMAND = (); 52our %COMMAND = ();
53our %COMMAND_TIME = ();
54
55our @EXTS = (); # list of extension package names
56our %EXTCMD = ();
57our %EXTICMD = ();
58our %EXT_CORO = (); # coroutines bound to extensions
59our %EXT_MAP = (); # pluggable maps
60
61our $RELOAD; # number of reloads so far
17our @EVENT; 62our @EVENT;
18our @PLUGIN_EVENT;
19our %PROP_TYPE;
20our %PROP_IDX;
21our $LIBDIR = maps_directory "perl";
22 63
23our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
24our $TICK_WATCHER; 77our $TICK_WATCHER;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
25our $NEXT_TICK; 80our $NEXT_TICK;
81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $DB_ENV;
86
87our %CFG;
88
89our $UPTIME; $UPTIME ||= time;
90our $RUNTIME;
91
92our %PLAYER; # all users
93our %MAP; # all maps
94our $LINK_MAP; # the special {link} map, which is always available
95
96# used to convert map paths into valid unix filenames by replacing / by ∕
97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
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
103binmode STDOUT;
104binmode STDERR;
105
106# read virtual server time, if available
107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
108 open my $fh, "<", "$LOCALDIR/runtime"
109 or die "unable to read runtime file: $!";
110 $RUNTIME = <$fh> + 0.;
111}
112
113mkdir $_
114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
115
116our $EMERGENCY_POSITION;
117
118sub cf::map::normalise;
119
120#############################################################################
121
122=head2 GLOBAL VARIABLES
123
124=over 4
125
126=item $cf::UPTIME
127
128The timestamp of the server start (so not actually an uptime).
129
130=item $cf::RUNTIME
131
132The time this server has run, starts at 0 and is increased by $cf::TICK on
133every server tick.
134
135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
138
139Various directories - "/etc", read-only install directory, perl-library
140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
143
144=item $cf::NOW
145
146The time of the last (current) server tick.
147
148=item $cf::TICK
149
150The interval between server ticks, in seconds.
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
162=item %cf::CFG
163
164Configuration for the server, loaded from C</etc/crossfire/config>, or
165from wherever your confdir points to.
166
167=item cf::wait_for_tick, cf::wait_for_tick_begin
168
169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
170returns directly I<after> the tick processing (and consequently, can only wake one process
171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
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
179=back
180
181=cut
26 182
27BEGIN { 183BEGIN {
28 @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
31 my $msg = join "", @_; 185 my $msg = join "", @_;
186
32 $msg .= "\n" 187 $msg .= "\n"
33 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
34 189
35 print STDERR "cfperl: $msg"; 190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
36 LOG llevError, "cfperl: $msg"; 193 LOG llevError, $msg;
37 }; 194 };
38} 195}
39 196
40my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
41 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
42# generate property mutators 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
43sub prop_gen { 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
44 my ($prefix, $class) = @_; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
45 202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
46 no strict 'refs';
47
48 for my $prop (keys %PROP_TYPE) {
49 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
50 my $sub = lc $1;
51
52 my $type = $PROP_TYPE{$prop};
53 my $idx = $PROP_IDX {$prop};
54
55 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
56 $_[0]->get_property ($type, $idx)
57 };
58
59 *{"$class\::set_$sub"} = sub {
60 $_[0]->set_property ($type, $idx, $_[1]);
61 } unless $ignore_set{$prop};
62 }
63}
64
65# auto-generate most of the API
66
67prop_gen OBJECT_PROP => "cf::object";
68# CFAPI_OBJECT_ANIMATION?
69prop_gen PLAYER_PROP => "cf::object::player";
70
71prop_gen MAP_PROP => "cf::map";
72prop_gen ARCH_PROP => "cf::arch";
73
74# guessed hierarchies
75
76@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)
77@safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78 204
79# 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
80# within the Safe compartment. 206# within the Safe compartment.
81for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { 207for my $pkg (qw(
208 cf::global cf::attachable
209 cf::object cf::object::player
210 cf::client cf::player
211 cf::arch cf::living
212 cf::map cf::party cf::region
213)) {
82 no strict 'refs'; 214 no strict 'refs';
83 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 215 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84} 216}
85 217
86$Event::DIED = sub { 218$Event::DIED = sub {
87 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
88}; 220};
89 221
90my %ext_pkg;
91my @exts;
92my @hook;
93my %command;
94my %extcmd;
95
96############################################################################# 222#############################################################################
97# object support
98 223
99sub reattach { 224=head2 UTILITY FUNCTIONS
100 warn "reattach<@_>\n";
101}
102 225
103sub instantiate { 226=over 4
104 warn "instantiate<@_>\n";
105}
106 227
107sub clone { 228=item dumpval $ref
108 warn "clone<@_>\n"; 229
230=cut
231
232sub dumpval {
233 eval {
234 local $SIG{__DIE__};
235 my $d;
236 if (1) {
237 $d = new Data::Dumper([$_[0]], ["*var"]);
238 $d->Terse(1);
239 $d->Indent(2);
240 $d->Quotekeys(0);
241 $d->Useqq(1);
242 #$d->Bless(...);
243 $d->Seen($_[1]) if @_ > 1;
244 $d = $d->Dump();
245 }
246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
247 $d
248 } || "[unable to dump $_[0]: '$@']";
109} 249}
250
251=item $ref = cf::from_json $json
252
253Converts a JSON string into the corresponding perl data structure.
254
255=item $json = cf::to_json $ref
256
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]) }
265
266=item cf::lock_wait $string
267
268Wait until the given lock is available. See cf::lock_acquire.
269
270=item my $lock = cf::lock_acquire $string
271
272Wait until the given lock is available and then acquires it and returns
273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
274for example when the coroutine gets canceled), the lock is automatically
275returned.
276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
280Lock names should begin with a unique identifier (for example, cf::map::find
281uses map_find and cf::map::load uses map_load).
282
283=item $locked = cf::lock_active $string
284
285Return true if the lock is currently active, i.e. somebody has locked it.
286
287=cut
288
289our %LOCK;
290
291sub lock_wait($) {
292 my ($key) = @_;
293
294 # wait for lock, if any
295 while ($LOCK{$key}) {
296 push @{ $LOCK{$key} }, $Coro::current;
297 Coro::schedule;
298 }
299}
300
301sub lock_acquire($) {
302 my ($key) = @_;
303
304 # wait, to be sure we are not locked
305 lock_wait $key;
306
307 $LOCK{$key} = [];
308
309 Coro::guard {
310 # wake up all waiters, to be on the safe side
311 $_->ready for @{ delete $LOCK{$key} };
312 }
313}
314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
321sub freeze_mainloop {
322 return unless $TICK_WATCHER->is_active;
323
324 my $guard = Coro::guard {
325 $TICK_WATCHER->start;
326 };
327 $TICK_WATCHER->stop;
328 $guard
329}
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
387=item cf::async { BLOCK }
388
389Currently the same as Coro::async_pool, meaning you cannot use
390C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
391thing you are allowed to do is call C<prio> on it.
392
393=cut
394
395BEGIN { *async = \&Coro::async_pool }
396
397=item cf::sync_job { BLOCK }
398
399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
400is always able to handle events or runnable, as Crossfire TRT is only
401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
403
404If it must be done, put the blocking parts into C<sync_job>. This will run
405the given BLOCK in another coroutine while waiting for the result. The
406server will be frozen during this time, so the block should either finish
407fast or be very important.
408
409=cut
410
411sub sync_job(&) {
412 my ($job) = @_;
413
414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
417 # this is the main coro, too bad, we have to block
418 # till the operation succeeds, freezing the server :/
419
420 # TODO: use suspend/resume instead
421 # (but this is cancel-safe)
422 my $freeze_guard = freeze_mainloop;
423
424 my $busy = 1;
425 my @res;
426
427 (async {
428 @res = eval { $job->() };
429 warn $@ if $@;
430 undef $busy;
431 })->prio (Coro::PRIO_MAX);
432
433 while ($busy) {
434 Coro::cede or Event::one_event;
435 }
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
444 wantarray ? @res : $res[0]
445 } else {
446 # we are in another coroutine, how wonderful, everything just works
447
448 $job->()
449 }
450}
451
452=item $coro = cf::async_ext { BLOCK }
453
454Like async, but this coro is automatically being canceled when the
455extension calling this is being unloaded.
456
457=cut
458
459sub async_ext(&) {
460 my $cb = shift;
461
462 my $coro = &Coro::async ($cb);
463
464 $coro->on_destroy (sub {
465 delete $EXT_CORO{$coro+0};
466 });
467 $EXT_CORO{$coro+0} = $coro;
468
469 $coro
470}
471
472=item fork_call { }, $args
473
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.
478
479=cut
480
481sub fork_call(&@) {
482 my ($cb, @args) = @_;
483
484 # we seemingly have to make a local copy of the whole thing,
485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
487
488 my @res = Coro::Util::fork_eval {
489 reset_signals;
490 &$cb
491 }, @args;
492
493 wantarray ? @res : $res[-1]
494}
495
496=item $value = cf::db_get $family => $key
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 };
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"
610}
611
612=item cf::datalog type => key => value, ...
613
614Log a datalog packet of the given type with the given key-value pairs.
615
616=cut
617
618sub datalog($@) {
619 my ($type, %kv) = @_;
620 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
621}
622
623=back
624
625=cut
110 626
111############################################################################# 627#############################################################################
112# "new" plug-in system
113 628
114=item cf::object::attach ... # NYI 629=head2 ATTACHABLE OBJECTS
115 630
116=item cf::attach_global ... 631Many objects in crossfire are so-called attachable objects. That means you can
632attach callbacks/event handlers (a collection of which is called an "attachment")
633to it. All such attachable objects support the following methods.
117 634
118=item cf::attach_to_type ... 635In the following description, CLASS can be any of C<global>, C<object>
636C<player>, C<client> or C<map> (i.e. the attachable objects in
637Crossfire TRT).
119 638
120=item cf::attach_to_objects ... 639=over 4
121 640
122=item cf::attach_to_players ... 641=item $attachable->attach ($attachment, key => $value...)
123 642
124=item cf::attach_to_maps ... 643=item $attachable->detach ($attachment)
125 644
126 prio => $number, # lower is earlier 645Attach/detach a pre-registered attachment to a specific object and give it
127 on_xxx => \&cb, 646the specified key/value pairs as arguments.
647
648Example, attach a minesweeper attachment to the given object, making it a
64910x10 minesweeper game:
650
651 $obj->attach (minesweeper => width => 10, height => 10);
652
653=item $bool = $attachable->attached ($name)
654
655Checks wether the named attachment is currently attached to the object.
656
657=item cf::CLASS->attach ...
658
659=item cf::CLASS->detach ...
660
661Define an anonymous attachment and attach it to all objects of the given
662CLASS. See the next function for an explanation of its arguments.
663
664You can attach to global events by using the C<cf::global> class.
665
666Example, log all player logins:
667
668 cf::player->attach (
669 on_login => sub {
670 my ($pl) = @_;
671 ...
672 },
673 );
674
675Example, attach to the jeweler skill:
676
677 cf::object->attach (
678 type => cf::SKILL,
679 subtype => cf::SK_JEWELER,
680 on_use_skill => sub {
681 my ($sk, $ob, $part, $dir, $msg) = @_;
682 ...
683 },
684 );
685
686=item cf::CLASS::attachment $name, ...
687
688Register an attachment by C<$name> through which attachable objects of the
689given CLASS can refer to this attachment.
690
691Some classes such as crossfire maps and objects can specify attachments
692that are attached at load/instantiate time, thus the need for a name.
693
694These calls expect any number of the following handler/hook descriptions:
695
696=over 4
697
698=item prio => $number
699
700Set the priority for all following handlers/hooks (unless overwritten
701by another C<prio> setting). Lower priority handlers get executed
702earlier. The default priority is C<0>, and many built-in handlers are
703registered at priority C<-1000>, so lower priorities should not be used
704unless you know what you are doing.
705
706=item type => $type
707
708(Only for C<< cf::object->attach >> calls), limits the attachment to the
709given type of objects only (the additional parameter C<subtype> can be
710used to further limit to the given subtype).
711
712=item on_I<event> => \&cb
713
714Call the given code reference whenever the named event happens (event is
715something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
716handlers are recognised generally depends on the type of object these
717handlers attach to).
718
719See F<include/eventinc.h> for the full list of events supported, and their
720class.
721
128 package => package::, 722=item package => package::
723
724Look for sub functions of the name C<< on_I<event> >> in the given
725package and register them. Only handlers for eevents supported by the
726object/class are recognised.
727
728=back
729
730Example, define an attachment called "sockpuppet" that calls the given
731event handler when a monster attacks:
732
733 cf::object::attachment sockpuppet =>
734 on_skill_attack => sub {
735 my ($self, $victim) = @_;
736 ...
737 }
738 }
739
740=item $attachable->valid
741
742Just because you have a perl object does not mean that the corresponding
743C-level object still exists. If you try to access an object that has no
744valid C counterpart anymore you get an exception at runtime. This method
745can be used to test for existence of the C object part without causing an
746exception.
129 747
130=cut 748=cut
131 749
132# the following variables are defined in .xs and must not be re-created 750# the following variables are defined in .xs and must not be re-created
133our @CB_GLOBAL = (); # registry for all global events 751our @CB_GLOBAL = (); # registry for all global events
134our @CB_OBJECT = (); 752our @CB_ATTACHABLE = (); # registry for all attachables
753our @CB_OBJECT = (); # all objects (should not be used except in emergency)
135our @CB_PLAYER = (); 754our @CB_PLAYER = ();
755our @CB_CLIENT = ();
136our @CB_TYPE = (); # registry for type (cf-object class) based events 756our @CB_TYPE = (); # registry for type (cf-object class) based events
137our @CB_MAP = (); 757our @CB_MAP = ();
138 758
759my %attachment;
760
761sub cf::attachable::thawer_merge {
762 # simply override everything except _meta
763 local $_[0]{_meta};
764 %{$_[0]} = %{$_[1]};
765}
766
139sub _attach_cb($\%$$$) { 767sub _attach_cb($$$$) {
140 my ($registry, $undo, $event, $prio, $cb) = @_; 768 my ($registry, $event, $prio, $cb) = @_;
141 769
142 use sort 'stable'; 770 use sort 'stable';
143 771
144 $cb = [$prio, $cb]; 772 $cb = [$prio, $cb];
145 773
146 @{$registry->[$event]} = sort 774 @{$registry->[$event]} = sort
147 { $a->[0] cmp $b->[0] } 775 { $a->[0] cmp $b->[0] }
148 @{$registry->[$event] || []}, $cb; 776 @{$registry->[$event] || []}, $cb;
149
150 push @{$undo->{cb}}, [$event, $cb];
151} 777}
778
779# hack
780my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
152 781
153# attach handles attaching event callbacks 782# attach handles attaching event callbacks
154# the only thing the caller has to do is pass the correct 783# the only thing the caller has to do is pass the correct
155# registry (== where the callback attaches to). 784# registry (== where the callback attaches to).
156sub _attach(\@$\@) { 785sub _attach {
157 my ($registry, $klass, $arg) = @_; 786 my ($registry, $klass, @arg) = @_;
158 787
788 my $object_type;
159 my $prio = 0; 789 my $prio = 0;
160
161 my %undo = (
162 registry => $registry,
163 cb => [],
164 );
165
166 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 790 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
167 791
792 #TODO: get rid of this hack
793 if ($attachable_klass{$klass}) {
794 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
795 }
796
168 while (@$arg) { 797 while (@arg) {
169 my $type = shift @$arg; 798 my $type = shift @arg;
170 799
171 if ($type eq "prio") { 800 if ($type eq "prio") {
172 $prio = shift @$arg; 801 $prio = shift @arg;
802
803 } elsif ($type eq "type") {
804 $object_type = shift @arg;
805 $registry = $CB_TYPE[$object_type] ||= [];
806
807 } elsif ($type eq "subtype") {
808 defined $object_type or Carp::croak "subtype specified without type";
809 my $object_subtype = shift @arg;
810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
173 811
174 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
175 my $pkg = shift @$arg; 813 my $pkg = shift @arg;
176 814
177 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
178 if (my $cb = $pkg->can ($name)) { 816 if (my $cb = $pkg->can ($name)) {
179 _attach_cb $registry, %undo, $id, $prio, $cb; 817 _attach_cb $registry, $id, $prio, $cb;
180 } 818 }
181 } 819 }
182 820
183 } elsif (exists $cb_id{$type}) { 821 } elsif (exists $cb_id{$type}) {
184 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg; 822 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
185 823
186 } elsif (ref $type) { 824 } elsif (ref $type) {
187 warn "attaching objects not supported, ignoring.\n"; 825 warn "attaching objects not supported, ignoring.\n";
188 826
189 } else { 827 } else {
190 shift @$arg; 828 shift @arg;
191 warn "attach argument '$type' not supported, ignoring.\n"; 829 warn "attach argument '$type' not supported, ignoring.\n";
192 } 830 }
193 } 831 }
194
195 \%undo
196} 832}
197 833
198sub cf::object::attach { 834sub _object_attach {
199 die; 835 my ($obj, $name, %arg) = @_;
200}
201 836
202sub attach_global { 837 return if exists $obj->{_attachment}{$name};
203 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
204}
205 838
206sub attach_to_type { 839 if (my $attach = $attachment{$name}) {
207 my $type = shift; 840 my $registry = $obj->registry;
208 _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
209}
210 841
211sub attach_to_objects { 842 for (@$attach) {
212 _attach @CB_OBJECT, KLASS_OBJECT, @_ 843 my ($klass, @attach) = @$_;
213} 844 _attach $registry, $klass, @attach;
845 }
214 846
215sub attach_to_players { 847 $obj->{$name} = \%arg;
216 _attach @CB_PLAYER, KLASS_PLAYER, @_ 848 } else {
217} 849 warn "object uses attachment '$name' which is not available, postponing.\n";
850 }
218 851
219sub attach_to_maps { 852 $obj->{_attachment}{$name} = undef;
220 _attach @CB_MAP, KLASS_MAP, @_ 853}
854
855sub cf::attachable::attach {
856 if (ref $_[0]) {
857 _object_attach @_;
858 } else {
859 _attach shift->_attach_registry, @_;
860 }
861 _recalc_want;
862};
863
864# all those should be optimised
865sub cf::attachable::detach {
866 my ($obj, $name) = @_;
867
868 if (ref $obj) {
869 delete $obj->{_attachment}{$name};
870 reattach ($obj);
871 } else {
872 Carp::croak "cannot, currently, detach class attachments";
873 }
874 _recalc_want;
875};
876
877sub cf::attachable::attached {
878 my ($obj, $name) = @_;
879
880 exists $obj->{_attachment}{$name}
881}
882
883for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
884 eval "#line " . __LINE__ . " 'cf.pm'
885 sub cf::\L$klass\E::_attach_registry {
886 (\\\@CB_$klass, KLASS_$klass)
887 }
888
889 sub cf::\L$klass\E::attachment {
890 my \$name = shift;
891
892 \$attachment{\$name} = [[KLASS_$klass, \@_]];
893 }
894 ";
895 die if $@;
221} 896}
222 897
223our $override; 898our $override;
899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
224 900
225sub override() { 901sub override {
226 $override = 1 902 $override = 1;
903 @INVOKE_RESULTS = (@_);
227} 904}
228 905
229sub invoke { 906sub do_invoke {
230 my $event = shift; 907 my $event = shift;
231 my $callbacks = shift; 908 my $callbacks = shift;
232 909
910 @INVOKE_RESULTS = ();
911
233 local $override; 912 local $override;
234 913
235 for (@$callbacks) { 914 for (@$callbacks) {
236 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
237 916
238 if ($@) { 917 if ($@) {
239 warn "$@"; 918 warn "$@";
240 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 919 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
241 override; 920 override;
242 } 921 }
243 922
244 return 1 if $override; 923 return 1 if $override;
245 } 924 }
246 925
247 0 926 0
248} 927}
249 928
929=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
930
931=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
932
933Generate an object-specific event with the given arguments.
934
935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
936removed in future versions), and there is no public API to access override
937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
938
939=back
940
941=cut
942
250############################################################################# 943#############################################################################
251# old plug-in events 944# object support
945#
252 946
253sub inject_event { 947sub _can_merge {
254 my $extension = shift; 948 my ($ob1, $ob2) = @_;
255 my $event_code = shift;
256 949
257 my $cb = $hook[$event_code]{$extension} 950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
956
957sub reattach {
958 # basically do the same as instantiate, without calling instantiate
959 my ($obj) = @_;
960
961 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
962
963 my $registry = $obj->registry;
964
965 @$registry = ();
966
967 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
968
969 for my $name (keys %{ $obj->{_attachment} || {} }) {
970 if (my $attach = $attachment{$name}) {
971 for (@$attach) {
972 my ($klass, @attach) = @$_;
973 _attach $registry, $klass, @attach;
974 }
975 } else {
976 warn "object uses attachment '$name' that is not available, postponing.\n";
977 }
978 }
979}
980
981cf::attachable->attach (
982 prio => -1000000,
983 on_instantiate => sub {
984 my ($obj, $data) = @_;
985
986 $data = from_json $data;
987
988 for (@$data) {
989 my ($name, $args) = @$_;
990
991 $obj->attach ($name, %{$args || {} });
992 }
993 },
994 on_reattach => \&reattach,
995 on_clone => sub {
996 my ($src, $dst) = @_;
997
998 @{$dst->registry} = @{$src->registry};
999
1000 %$dst = %$src;
1001
1002 %{$dst->{_attachment}} = %{$src->{_attachment}}
1003 if exists $src->{_attachment};
1004 },
1005);
1006
1007sub object_freezer_save {
1008 my ($filename, $rdata, $objs) = @_;
1009
1010 sync_job {
1011 if (length $$rdata) {
1012 warn sprintf "saving %s (%d,%d)\n",
1013 $filename, length $$rdata, scalar @$objs;
1014
1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
1016 chmod SAVE_MODE, $fh;
1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1018 aio_fsync $fh if $cf::USE_FSYNC;
1019 close $fh;
1020
1021 if (@$objs) {
1022 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
1023 chmod SAVE_MODE, $fh;
1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
1025 aio_write $fh, 0, (length $data), $data, 0;
1026 aio_fsync $fh if $cf::USE_FSYNC;
1027 close $fh;
1028 aio_rename "$filename.pst~", "$filename.pst";
1029 }
1030 } else {
1031 aio_unlink "$filename.pst";
1032 }
1033
1034 aio_rename "$filename~", $filename;
1035 } else {
1036 warn "FATAL: $filename~: $!\n";
1037 }
1038 } else {
1039 aio_unlink $filename;
1040 aio_unlink "$filename.pst";
1041 }
1042 }
1043}
1044
1045sub object_freezer_as_string {
1046 my ($rdata, $objs) = @_;
1047
1048 use Data::Dumper;
1049
1050 $$rdata . Dumper $objs
1051}
1052
1053sub object_thawer_load {
1054 my ($filename) = @_;
1055
1056 my ($data, $av);
1057
1058 (aio_load $filename, $data) >= 0
258 or return; 1059 or return;
259 1060
260 &$cb 1061 unless (aio_stat "$filename.pst") {
261} 1062 (aio_load "$filename.pst", $av) >= 0
262
263sub inject_global_event {
264 my $event = shift;
265
266 my $cb = $hook[$event]
267 or return; 1063 or return;
268 1064 $av = eval { (Storable::thaw $av)->{objs} };
269 List::Util::max map &$_, values %$cb
270}
271
272sub inject_command {
273 my ($name, $obj, $params) = @_;
274
275 for my $cmd (@{ $command{$name} }) {
276 $cmd->[1]->($obj, $params);
277 } 1065 }
278 1066
279 -1 1067 warn sprintf "loading %s (%d)\n",
1068 $filename, length $data, scalar @{$av || []};
1069 return ($data, $av);
280} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
1077
1078#############################################################################
1079# command handling &c
1080
1081=item cf::register_command $name => \&callback($ob,$args);
1082
1083Register a callback for execution when the client sends the user command
1084$name.
1085
1086=cut
281 1087
282sub register_command { 1088sub register_command {
283 my ($name, $time, $cb) = @_; 1089 my ($name, $cb) = @_;
284 1090
285 my $caller = caller; 1091 my $caller = caller;
286 #warn "registering command '$name/$time' to '$caller'"; 1092 #warn "registering command '$name/$time' to '$caller'";
287 1093
288 push @{ $command{$name} }, [$time, $cb, $caller]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
289 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
290} 1095}
1096
1097=item cf::register_extcmd $name => \&callback($pl,$packet);
1098
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.
1104
1105If the callback returns something, it is sent back as if reply was being
1106called.
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
1119=cut
291 1120
292sub register_extcmd { 1121sub register_extcmd {
293 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
294 1123
295 my $caller = caller; 1124 $EXTCMD{$name} = $cb;
296 #warn "registering extcmd '$name' to '$caller'";
297
298 $extcmd{$name} = [$cb, $caller];
299} 1125}
300 1126
301sub register { 1127sub register_exticmd {
302 my ($base, $pkg) = @_; 1128 my ($name, $cb) = @_;
303 1129
304 for my $idx (0 .. $#PLUGIN_EVENT) { 1130 $EXTICMD{$name} = $cb;
305 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
306 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
307 $hook[$idx]{$base} = $ref;
308 }
309 }
310} 1131}
311 1132
312sub load_extension { 1133cf::player->attach (
313 my ($path) = @_; 1134 on_command => sub {
1135 my ($pl, $name, $params) = @_;
314 1136
315 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1137 my $cb = $COMMAND{$name}
316 my $base = $1; 1138 or return;
317 my $pkg = $1;
318 $pkg =~ s/[^[:word:]]/_/g;
319 $pkg = "ext::$pkg";
320 1139
321 warn "loading '$path' into '$pkg'\n"; 1140 for my $cmd (@$cb) {
322 1141 $cmd->[1]->($pl->ob, $params);
323 open my $fh, "<:utf8", $path
324 or die "$path: $!";
325
326 my $source =
327 "package $pkg; use strict; use utf8;\n"
328 . "#line 1 \"$path\"\n{\n"
329 . (do { local $/; <$fh> })
330 . "\n};\n1";
331
332 eval $source
333 or die "$path: $@";
334
335 push @exts, $pkg;
336 $ext_pkg{$base} = $pkg;
337
338# no strict 'refs';
339# @{"$pkg\::ISA"} = ext::;
340
341 register $base, $pkg;
342}
343
344sub unload_extension {
345 my ($pkg) = @_;
346
347 warn "removing extension $pkg\n";
348
349 # remove hooks
350 for my $idx (0 .. $#PLUGIN_EVENT) {
351 delete $hook[$idx]{$pkg};
352 }
353
354 # remove commands
355 for my $name (keys %command) {
356 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
357
358 if (@cb) {
359 $command{$name} = \@cb;
360 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
361 } else {
362 delete $command{$name};
363 delete $COMMAND{"$name\000"};
364 }
365 }
366
367 # remove extcmds
368 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
369 delete $extcmd{$name};
370 }
371
372 if (my $cb = $pkg->can ("unload")) {
373 eval {
374 $cb->($pkg);
375 1
376 } or warn "$pkg unloaded, but with errors: $@";
377 }
378
379 Symbol::delete_package $pkg;
380}
381
382sub load_extensions {
383 my $LIBDIR = maps_directory "perl";
384
385 for my $ext (<$LIBDIR/*.ext>) {
386 next unless -r $ext;
387 eval {
388 load_extension $ext;
389 1
390 } or warn "$ext not loaded: $@";
391 }
392}
393
394sub _perl_reload(&) {
395 my ($msg) = @_;
396
397 $msg->("reloading...");
398
399 eval {
400 # 1. cancel all watchers
401 $_->cancel for Event::all_watchers;
402
403 # 2. unload all extensions
404 for (@exts) {
405 $msg->("unloading <$_>");
406 unload_extension $_;
407 }
408
409 # 3. unload all modules loaded from $LIBDIR
410 while (my ($k, $v) = each %INC) {
411 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
412
413 $msg->("removing <$k>");
414 delete $INC{$k};
415
416 $k =~ s/\.pm$//;
417 $k =~ s/\//::/g;
418
419 if (my $cb = $k->can ("unload_module")) {
420 $cb->();
421 }
422
423 Symbol::delete_package $k;
424 }
425
426 # 4. get rid of safe::, as good as possible
427 Symbol::delete_package "safe::$_"
428 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
429
430 # 5. remove register_script_function callbacks
431 # TODO
432
433 # 6. unload cf.pm "a bit"
434 delete $INC{"cf.pm"};
435
436 # don't, removes xs symbols, too,
437 # and global variables created in xs
438 #Symbol::delete_package __PACKAGE__;
439
440 # 7. reload cf.pm
441 $msg->("reloading cf.pm");
442 require cf;
443 };
444 $msg->($@) if $@;
445
446 $msg->("reloaded");
447};
448
449sub perl_reload() {
450 _perl_reload {
451 warn $_[0];
452 print "$_[0]\n";
453 };
454}
455
456register_command "perl-reload", 0, sub {
457 my ($who, $arg) = @_;
458
459 if ($who->flag (FLAG_WIZ)) {
460 _perl_reload {
461 warn $_[0];
462 $who->message ($_[0]);
463 }; 1142 }
1143
1144 cf::override;
464 } 1145 },
465};
466
467#############################################################################
468# utility functions
469
470use JSON::Syck (); # TODO# replace by JSON::PC once working
471
472sub from_json($) {
473 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
474 JSON::Syck::Load $_[0]
475}
476
477sub to_json($) {
478 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
479 JSON::Syck::Dump $_[0]
480}
481
482#############################################################################
483# extcmd framework, basically convert ext <msg>
484# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
485
486attach_to_players
487 on_extcmd => sub { 1146 on_extcmd => sub {
488 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
489 1148
490 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
491 1150
492 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
493 if (my $cb = $extcmd{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
494 if (my %reply = $cb->[0]->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
495 $pl->ext_reply ($msg->{msgid}, %reply);
496 }
497 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
498 } else { 1166 } else {
499 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
500 } 1168 }
501 1169
502 cf::override; 1170 cf::override;
503 }, 1171 },
504; 1172);
1173
1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
1178 for my $path (<$LIBDIR/*.ext>) {
1179 next unless -r $path;
1180
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;
1238 }
1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
1244 };
1245}
505 1246
506############################################################################# 1247#############################################################################
507# load/save/clean perl data associated with a map
508 1248
509*cf::mapsupport::on_clean = sub { 1249=back
1250
1251=head2 CORE EXTENSIONS
1252
1253Functions and methods that extend core crossfire objects.
1254
1255=cut
1256
1257package cf::player;
1258
1259use Coro::AIO;
1260
1261=head3 cf::player
1262
1263=over 4
1264
1265=item cf::player::find $login
1266
1267Returns the given player object, loading it if necessary (might block).
1268
1269=cut
1270
1271sub playerdir($) {
1272 "$PLAYERDIR/"
1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1274}
1275
1276sub path($) {
1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1278
1279 (playerdir $login) . "/playerdata"
1280}
1281
1282sub find_active($) {
1283 $cf::PLAYER{$_[0]}
1284 and $cf::PLAYER{$_[0]}->active
1285 and $cf::PLAYER{$_[0]}
1286}
1287
1288sub exists($) {
1289 my ($login) = @_;
1290
1291 $cf::PLAYER{$login}
1292 or cf::sync_job { !aio_stat path $login }
1293}
1294
1295sub find($) {
1296 return $cf::PLAYER{$_[0]} || do {
1297 my $login = $_[0];
1298
1299 my $guard = cf::lock_acquire "user_find:$login";
1300
1301 $cf::PLAYER{$_[0]} || do {
1302 # rename old playerfiles to new ones
1303 #TODO: remove when no longer required
1304 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1305 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1306 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1307 aio_unlink +(playerdir $login) . "/$login.pl";
1308
1309 my $pl = load_pl path $login
1310 or return;
1311 $cf::PLAYER{$login} = $pl
1312 }
1313 }
1314}
1315
1316sub save($) {
1317 my ($pl) = @_;
1318
1319 return if $pl->{deny_save};
1320
1321 my $path = path $pl;
1322 my $guard = cf::lock_acquire "user_save:$path";
1323
1324 return if $pl->{deny_save};
1325
1326 aio_mkdir playerdir $pl, 0770;
1327 $pl->{last_save} = $cf::RUNTIME;
1328
1329 $pl->save_pl ($path);
1330 cf::cede_to_tick;
1331}
1332
1333sub new($) {
1334 my ($login) = @_;
1335
1336 my $self = create;
1337
1338 $self->ob->name ($login);
1339 $self->{deny_save} = 1;
1340
1341 $cf::PLAYER{$login} = $self;
1342
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 (@_);
1354}
1355
1356=item $pl->quit_character
1357
1358Nukes the player without looking back. If logged in, the connection will
1359be destroyed. May block for a long time.
1360
1361=cut
1362
1363sub quit_character {
1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1367
1368 $pl->{deny_save} = 1;
1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1370
1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1372 $pl->deactivate;
1373 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1374 $pl->ns->destroy if $pl->ns;
1375
1376 my $path = playerdir $pl;
1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1378 aio_rename $path, $temp;
1379 delete $cf::PLAYER{$pl->ob->name};
1380 $pl->destroy;
1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1387 IO::AIO::aio_rmtree $temp;
1388}
1389
1390=item $pl->kick
1391
1392Kicks a player out of the game. This destroys the connection.
1393
1394=cut
1395
1396sub kick {
1397 my ($pl, $kicker) = @_;
1398
1399 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1400 $pl->killer ("kicked");
1401 $pl->ns->destroy;
1402}
1403
1404=item cf::player::list_logins
1405
1406Returns am arrayref of all valid playernames in the system, can take a
1407while and may block, so not sync_job-capable, ever.
1408
1409=cut
1410
1411sub list_logins {
1412 my $dirs = aio_readdir $PLAYERDIR
1413 or return [];
1414
1415 my @logins;
1416
1417 for my $login (@$dirs) {
1418 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1419 aio_read $fh, 0, 512, my $buf, 0 or next;
1420 $buf !~ /^password -------------$/m or next; # official not-valid tag
1421
1422 utf8::decode $login;
1423 push @logins, $login;
1424 }
1425
1426 \@logins
1427}
1428
1429=item $player->maps
1430
1431Returns an arrayref of map paths that are private for this
1432player. May block.
1433
1434=cut
1435
1436sub maps($) {
1437 my ($pl) = @_;
1438
1439 $pl = ref $pl ? $pl->ob->name : $pl;
1440
1441 my $files = aio_readdir playerdir $pl
1442 or return;
1443
1444 my @paths;
1445
1446 for (@$files) {
1447 utf8::decode $_;
1448 next if /\.(?:pl|pst)$/;
1449 next unless /^$PATH_SEP/o;
1450
1451 push @paths, cf::map::normalise "~$pl/$_";
1452 }
1453
1454 \@paths
1455}
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
1508=item $player->ext_reply ($msgid, @msg)
1509
1510Sends an ext reply to the player.
1511
1512=cut
1513
1514sub ext_reply($$@) {
1515 my ($self, $id, @msg) = @_;
1516
1517 $self->ns->ext_reply ($id, @msg)
1518}
1519
1520=item $player->ext_msg ($type, @msg)
1521
1522Sends an ext event to the client.
1523
1524=cut
1525
1526sub ext_msg($$@) {
1527 my ($self, $type, @msg) = @_;
1528
1529 $self->ns->ext_msg ($type, @msg);
1530}
1531
1532=head3 cf::region
1533
1534=over 4
1535
1536=cut
1537
1538package cf::region;
1539
1540=item cf::region::find_by_path $path
1541
1542Tries to decuce the likely region for a map knowing only its path.
1543
1544=cut
1545
1546sub find_by_path($) {
1547 my ($path) = @_;
1548
1549 my ($match, $specificity);
1550
1551 for my $region (list) {
1552 if ($region->{match} && $path =~ $region->{match}) {
1553 ($match, $specificity) = ($region, $region->specificity)
1554 if $region->specificity > $specificity;
1555 }
1556 }
1557
1558 $match
1559}
1560
1561=back
1562
1563=head3 cf::map
1564
1565=over 4
1566
1567=cut
1568
1569package cf::map;
1570
1571use Fcntl;
1572use Coro::AIO;
1573
1574use overload
1575 '""' => \&as_string,
1576 fallback => 1;
1577
1578our $MAX_RESET = 3600;
1579our $DEFAULT_RESET = 3000;
1580
1581sub generate_random_map {
1582 my ($self, $rmp) = @_;
1583 # mit "rum" bekleckern, nicht
1584 $self->_create_random_map (
1585 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1586 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1587 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1588 $rmp->{exit_on_final_map},
1589 $rmp->{xsize}, $rmp->{ysize},
1590 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1591 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1592 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1593 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1594 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1595 (cf::region::find $rmp->{region}), $rmp->{custom}
1596 )
1597}
1598
1599=item cf::map->register ($regex, $prio)
1600
1601Register a handler for the map path matching the given regex at the
1602givne priority (higher is better, built-in handlers have priority 0, the
1603default).
1604
1605=cut
1606
1607sub register {
1608 my (undef, $regex, $prio) = @_;
1609 my $pkg = caller;
1610
1611 no strict;
1612 push @{"$pkg\::ISA"}, __PACKAGE__;
1613
1614 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1615}
1616
1617# also paths starting with '/'
1618$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1619
1620sub thawer_merge {
1621 my ($self, $merge) = @_;
1622
1623 # we have to keep some variables in memory intact
1624 local $self->{path};
1625 local $self->{load_path};
1626
1627 $self->SUPER::thawer_merge ($merge);
1628}
1629
1630sub normalise {
1631 my ($path, $base) = @_;
1632
1633 $path = "$path"; # make sure its a string
1634
1635 $path =~ s/\.map$//;
1636
1637 # map plan:
1638 #
1639 # /! non-realised random map exit (special hack!)
1640 # {... are special paths that are not being touched
1641 # ?xxx/... are special absolute paths
1642 # ?random/... random maps
1643 # /... normal maps
1644 # ~user/... per-player map of a specific user
1645
1646 $path =~ s/$PATH_SEP/\//go;
1647
1648 # treat it as relative path if it starts with
1649 # something that looks reasonable
1650 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1651 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1652
1653 $base =~ s{[^/]+/?$}{};
1654 $path = "$base/$path";
1655 }
1656
1657 for ($path) {
1658 redo if s{//}{/};
1659 redo if s{/\.?/}{/};
1660 redo if s{/[^/]+/\.\./}{/};
1661 }
1662
1663 $path
1664}
1665
1666sub new_from_path {
1667 my (undef, $path, $base) = @_;
1668
1669 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1670
1671 $path = normalise $path, $base;
1672
1673 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1674 if ($path =~ $EXT_MAP{$pkg}[1]) {
1675 my $self = bless cf::map::new, $pkg;
1676 $self->{path} = $path; $self->path ($path);
1677 $self->init; # pass $1 etc.
1678 return $self;
1679 }
1680 }
1681
1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1683 ()
1684}
1685
1686sub init {
1687 my ($self) = @_;
1688
1689 $self
1690}
1691
1692sub as_string {
1693 my ($self) = @_;
1694
1695 "$self->{path}"
1696}
1697
1698# the displayed name, this is a one way mapping
1699sub visible_name {
1700 &as_string
1701}
1702
1703# the original (read-only) location
1704sub load_path {
1705 my ($self) = @_;
1706
1707 "$MAPDIR/$self->{path}.map"
1708}
1709
1710# the temporary/swap location
1711sub save_path {
1712 my ($self) = @_;
1713
1714 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1715 "$TMPDIR/$path.map"
1716}
1717
1718# the unique path, undef == no special unique path
1719sub uniq_path {
1720 my ($self) = @_;
1721
1722 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1723 "$UNIQUEDIR/$path"
1724}
1725
1726# and all this just because we cannot iterate over
1727# all maps in C++...
1728sub change_all_map_light {
1729 my ($change) = @_;
1730
1731 $_->change_map_light ($change)
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;
1741}
1742
1743sub unlink_save {
1744 my ($self) = @_;
1745
1746 utf8::encode (my $save = $self->save_path);
1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1748 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1749}
1750
1751sub load_header_from($) {
1752 my ($self, $path) = @_;
1753
1754 utf8::encode $path;
1755 #aio_open $path, O_RDONLY, 0
1756 # or return;
1757
1758 $self->_load_header ($path)
1759 or return;
1760
1761 $self->{load_path} = $path;
1762
1763 1
1764}
1765
1766sub load_header_orig {
1767 my ($self) = @_;
1768
1769 $self->load_header_from ($self->load_path)
1770}
1771
1772sub load_header_temp {
1773 my ($self) = @_;
1774
1775 $self->load_header_from ($self->save_path)
1776}
1777
1778sub prepare_temp {
1779 my ($self) = @_;
1780
1781 $self->last_access ((delete $self->{last_access})
1782 || $cf::RUNTIME); #d#
1783 # safety
1784 $self->{instantiate_time} = $cf::RUNTIME
1785 if $self->{instantiate_time} > $cf::RUNTIME;
1786}
1787
1788sub prepare_orig {
1789 my ($self) = @_;
1790
1791 $self->{load_original} = 1;
1792 $self->{instantiate_time} = $cf::RUNTIME;
1793 $self->last_access ($cf::RUNTIME);
1794 $self->instantiate;
1795}
1796
1797sub load_header {
1798 my ($self) = @_;
1799
1800 if ($self->load_header_temp) {
1801 $self->prepare_temp;
1802 } else {
1803 $self->load_header_orig
1804 or return;
1805 $self->prepare_orig;
1806 }
1807
1808 $self->{deny_reset} = 1
1809 if $self->no_reset;
1810
1811 $self->default_region (cf::region::find_by_path $self->{path})
1812 unless $self->default_region;
1813
1814 1
1815}
1816
1817sub find;
1818sub find {
1819 my ($path, $origin) = @_;
1820
1821 $path = normalise $path, $origin && $origin->path;
1822
1823 cf::lock_wait "map_find:$path";
1824
1825 $cf::MAP{$path} || do {
1826 my $guard = cf::lock_acquire "map_find:$path";
1827 my $map = new_from_path cf::map $path
1828 or return;
1829
1830 $map->{last_save} = $cf::RUNTIME;
1831
1832 $map->load_header
1833 or return;
1834
1835 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1836 # doing this can freeze the server in a sync job, obviously
1837 #$cf::WAIT_FOR_TICK->wait;
1838 $map->reset;
1839 undef $guard;
1840 return find $path;
1841 }
1842
1843 $cf::MAP{$path} = $map
1844 }
1845}
1846
1847sub pre_load { }
1848sub post_load { }
1849
1850sub load {
1851 my ($self) = @_;
1852
1853 local $self->{deny_reset} = 1; # loading can take a long time
1854
1855 my $path = $self->{path};
1856
1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1859 my $guard2 = cf::lock_acquire "map_load:$path";
1860
1861 return if $self->in_memory != cf::MAP_SWAPPED;
1862
1863 $self->in_memory (cf::MAP_LOADING);
1864
1865 $self->alloc;
1866
1867 $self->pre_load;
1868 cf::cede_to_tick;
1869
1870 $self->_load_objects ($self->{load_path}, 1)
1871 or return;
1872
1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1874 if delete $self->{load_original};
1875
1876 if (my $uniq = $self->uniq_path) {
1877 utf8::encode $uniq;
1878 if (aio_open $uniq, O_RDONLY, 0) {
1879 $self->clear_unique_items;
1880 $self->_load_objects ($uniq, 0);
1881 }
1882 }
1883
1884 cf::cede_to_tick;
1885 # now do the right thing for maps
1886 $self->link_multipart_objects;
1887 $self->difficulty ($self->estimate_difficulty)
1888 unless $self->difficulty;
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;
1898 $self->activate;
1899 }
1900
1901 $self->{last_save} = $cf::RUNTIME;
1902 $self->last_access ($cf::RUNTIME);
1903
1904 $self->in_memory (cf::MAP_IN_MEMORY);
1905 }
1906
1907 $self->post_load;
1908}
1909
1910sub customise_for {
1911 my ($self, $ob) = @_;
1912
1913 return find "~" . $ob->name . "/" . $self->{path}
1914 if $self->per_player;
1915
1916# return find "?party/" . $ob->name . "/" . $self->{path}
1917# if $self->per_party;
1918
1919 $self
1920}
1921
1922# find and load all maps in the 3x3 area around a map
1923sub load_neighbours {
510 my ($map) = @_; 1924 my ($map) = @_;
511 1925
512 my $path = $map->tmpname; 1926 my @neigh; # diagonal neighbours
513 defined $path or return;
514 1927
515 unlink "$path.cfperl"; 1928 for (0 .. 3) {
516}; 1929 my $neigh = $map->tile_path ($_)
1930 or next;
1931 $neigh = find $neigh, $map
1932 or next;
1933 $neigh->load;
517 1934
518*cf::mapsupport::on_swapin = 1935 push @neigh,
519*cf::mapsupport::on_load = sub { 1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1938 }
1939
1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1942 my $neigh = find $path, $origin
1943 or next;
1944 $neigh->load;
1945 }
1946}
1947
1948sub find_sync {
1949 my ($path, $origin) = @_;
1950
1951 cf::sync_job { find $path, $origin }
1952}
1953
1954sub do_load_sync {
520 my ($map) = @_; 1955 my ($map) = @_;
521 1956
522 my $path = $map->tmpname; 1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
523 $path = $map->path unless defined $path; 1958 if $Coro::current == $Coro::main;
524 1959
525 open my $fh, "<:raw", "$path.cfperl" 1960 cf::sync_job { $map->load };
526 or return; # no perl data 1961}
527 1962
528 my $data = Storable::thaw do { local $/; <$fh> }; 1963our %MAP_PREFETCH;
1964our $MAP_PREFETCHER = undef;
529 1965
530 $data->{version} <= 1 1966sub find_async {
531 or return; # too new 1967 my ($path, $origin, $load) = @_;
532 1968
533 $map->_set_obs ($data->{obs}); 1969 $path = normalise $path, $origin && $origin->{path};
534};
535 1970
536*cf::mapsupport::on_swapout = sub { 1971 if (my $map = $cf::MAP{$path}) {
537 my ($map) = @_; 1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1973 }
538 1974
539 my $path = $map->tmpname; 1975 $MAP_PREFETCH{$path} |= $load;
540 $path = $map->path unless defined $path;
541 1976
542 my $obs = $map->_get_obs; 1977 $MAP_PREFETCHER ||= cf::async {
1978 while (%MAP_PREFETCH) {
1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1980 if (my $map = find $k) {
1981 $map->load if $v;
1982 }
543 1983
544 if (defined $obs) { 1984 delete $MAP_PREFETCH{$k};
545 open my $fh, ">:raw", "$path.cfperl" 1985 }
546 or die "$path.cfperl: $!";
547
548 stat $path;
549
550 print $fh Storable::nfreeze {
551 size => (stat _)[7],
552 time => (stat _)[9],
553 version => 1,
554 obs => $obs,
555 }; 1986 }
1987 undef $MAP_PREFETCHER;
1988 };
1989 $MAP_PREFETCHER->prio (6);
556 1990
557 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* 1991 ()
1992}
1993
1994sub save {
1995 my ($self) = @_;
1996
1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1998
1999 $self->{last_save} = $cf::RUNTIME;
2000
2001 return unless $self->dirty;
2002
2003 my $save = $self->save_path; utf8::encode $save;
2004 my $uniq = $self->uniq_path; utf8::encode $uniq;
2005
2006 $self->{load_path} = $save;
2007
2008 return if $self->{deny_save};
2009
2010 local $self->{last_access} = $self->last_access;#d#
2011
2012 cf::async {
2013 $_->contr->save for $self->players;
2014 };
2015
2016 if ($uniq) {
2017 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2018 $self->_save_objects ($uniq, cf::IO_UNIQUES);
558 } else { 2019 } else {
559 unlink "$path.cfperl"; 2020 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
560 }
561};
562
563attach_to_maps prio => -10000, package => cf::mapsupport::;
564
565#############################################################################
566# load/save perl data associated with player->ob objects
567
568sub all_objects(@) {
569 @_, map all_objects ($_->inv), @_
570}
571
572attach_to_players
573 on_load => sub {
574 my ($pl, $path) = @_;
575
576 for my $o (all_objects $pl->ob) {
577 if (my $value = $o->get_ob_key_value ("_perl_data")) {
578 $o->set_ob_key_value ("_perl_data");
579
580 %$o = %{ Storable::thaw pack "H*", $value };
581 }
582 }
583 }, 2021 }
584 on_save => sub { 2022}
585 my ($pl, $path) = @_;
586 2023
587 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) 2024sub swap_out {
588 for grep %$_, all_objects $pl->ob; 2025 my ($self) = @_;
2026
2027 # save first because save cedes
2028 $self->save;
2029
2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
2031
2032 return if $self->players;
2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
2034 return if $self->{deny_save};
2035
2036 $self->clear;
2037 $self->in_memory (cf::MAP_SWAPPED);
2038}
2039
2040sub reset_at {
2041 my ($self) = @_;
2042
2043 # TODO: safety, remove and allow resettable per-player maps
2044 return 1e99 if $self->{deny_reset};
2045
2046 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2047 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2048
2049 $time + $to
2050}
2051
2052sub should_reset {
2053 my ($self) = @_;
2054
2055 $self->reset_at <= $cf::RUNTIME
2056}
2057
2058sub reset {
2059 my ($self) = @_;
2060
2061 my $lock = cf::lock_acquire "map_data:$self->{path}";
2062
2063 return if $self->players;
2064
2065 warn "resetting map ", $self->path;
2066
2067 $self->in_memory (cf::MAP_SWAPPED);
2068
2069 # need to save uniques path
2070 unless ($self->{deny_save}) {
2071 my $uniq = $self->uniq_path; utf8::encode $uniq;
2072
2073 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2074 if $uniq;
589 }, 2075 }
590;
591 2076
592############################################################################# 2077 delete $cf::MAP{$self->path};
593# core extensions - in perl
594 2078
595=item cf::player::exists $login 2079 $self->clear;
596 2080
597Returns true when the given account exists. 2081 $_->clear_links_to ($self) for values %cf::MAP;
598 2082
599=cut 2083 $self->unlink_save;
600 2084 $self->destroy;
601sub cf::player::exists($) {
602 cf::player::find $_[0]
603 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
604} 2085}
605 2086
2087my $nuke_counter = "aaaa";
2088
2089sub nuke {
2090 my ($self) = @_;
2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
2095 delete $cf::MAP{$self->path};
2096
2097 $self->unlink_save;
2098
2099 bless $self, "cf::map";
2100 delete $self->{deny_reset};
2101 $self->{deny_save} = 1;
2102 $self->reset_timeout (1);
2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2104
2105 $cf::MAP{$self->path} = $self;
2106 }
2107
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 ]
2145}
2146
2147=item cf::map::unique_maps
2148
2149Returns an arrayref of paths of all shared maps that have
2150instantiated unique items. May block.
2151
2152=cut
2153
2154sub unique_maps() {
2155 [
2156 map {
2157 utf8::decode $_;
2158 /\.map$/
2159 ? normalise $_
2160 : ()
2161 } @{ aio_readdir $UNIQUEDIR or [] }
2162 ]
2163}
2164
2165package cf;
2166
2167=back
2168
2169=head3 cf::object
2170
2171=cut
2172
2173package cf::object;
2174
2175=over 4
2176
2177=item $ob->inv_recursive
2178
2179Returns the inventory of the object _and_ their inventories, recursively.
2180
2181=cut
2182
2183sub inv_recursive_;
2184sub inv_recursive_ {
2185 map { $_, inv_recursive_ $_->inv } @_
2186}
2187
2188sub inv_recursive {
2189 inv_recursive_ inv $_[0]
2190}
2191
2192package cf;
2193
2194=back
2195
2196=head3 cf::object::player
2197
2198=over 4
2199
606=item $player->reply ($npc, $msg[, $flags]) 2200=item $player_object->reply ($npc, $msg[, $flags])
607 2201
608Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2202Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
609can be C<undef>. Does the right thing when the player is currently in a 2203can be C<undef>. Does the right thing when the player is currently in a
610dialogue with the given NPC character. 2204dialogue with the given NPC character.
611 2205
612=cut 2206=cut
613 2207
614# rough implementation of a future "reply" method that works 2208# rough implementation of a future "reply" method that works
615# with dialog boxes. 2209# with dialog boxes.
2210#TODO: the first argument must go, split into a $npc->reply_to ( method
616sub cf::object::player::reply($$$;$) { 2211sub cf::object::player::reply($$$;$) {
617 my ($self, $npc, $msg, $flags) = @_; 2212 my ($self, $npc, $msg, $flags) = @_;
618 2213
619 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
620 2215
621 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
622 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
623 } 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 {
624 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
625 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
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 (@_);
2241}
2242
2243=item $player_object->may ("access")
2244
2245Returns wether the given player is authorized to access resource "access"
2246(e.g. "command_wizcast").
2247
2248=cut
2249
2250sub cf::object::player::may {
2251 my ($self, $access) = @_;
2252
2253 $self->flag (cf::FLAG_WIZ) ||
2254 (ref $cf::CFG{"may_$access"}
2255 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
2256 : $cf::CFG{"may_$access"})
2257}
2258
2259=item $player_object->enter_link
2260
2261Freezes the player and moves him/her to a special map (C<{link}>).
2262
2263The player should be reasonably safe there for short amounts of time. You
2264I<MUST> call C<leave_link> as soon as possible, though.
2265
2266Will never block.
2267
2268=item $player_object->leave_link ($map, $x, $y)
2269
2270Moves the player out of the special C<{link}> map onto the specified
2271map. If the map is not valid (or omitted), the player will be moved back
2272to the location he/she was before the call to C<enter_link>, or, if that
2273fails, to the emergency map position.
2274
2275Might block.
2276
2277=cut
2278
2279sub link_map {
2280 unless ($LINK_MAP) {
2281 $LINK_MAP = cf::map::find "{link}"
2282 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2283 $LINK_MAP->load;
2284 }
2285
2286 $LINK_MAP
2287}
2288
2289sub cf::object::player::enter_link {
2290 my ($self) = @_;
2291
2292 $self->deactivate_recursive;
2293
2294 return if UNIVERSAL::isa $self->map, "ext::map_link";
2295
2296 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2297 if $self->map && $self->map->{path} ne "{link}";
2298
2299 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2300}
2301
2302sub cf::object::player::leave_link {
2303 my ($self, $map, $x, $y) = @_;
2304
2305 return unless $self->contr->active;
2306
2307 my $link_pos = delete $self->{_link_pos};
2308
2309 unless ($map) {
2310 # restore original map position
2311 ($map, $x, $y) = @{ $link_pos || [] };
2312 $map = cf::map::find $map;
2313
2314 unless ($map) {
2315 ($map, $x, $y) = @$EMERGENCY_POSITION;
2316 $map = cf::map::find $map
2317 or die "FATAL: cannot load emergency map\n";
2318 }
2319 }
2320
2321 ($x, $y) = (-1, -1)
2322 unless (defined $x) && (defined $y);
2323
2324 # use -1 or undef as default coordinates, not 0, 0
2325 ($x, $y) = ($map->enter_x, $map->enter_y)
2326 if $x <=0 && $y <= 0;
2327
2328 $map->load;
2329 $map->load_neighbours;
2330
2331 return unless $self->contr->active;
2332 $self->activate_recursive;
2333
2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2335 $self->enter_map ($map, $x, $y);
2336}
2337
2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2339
2340Moves the player to the given map-path and coordinates by first freezing
2341her, loading and preparing them map, calling the provided $check callback
2342that has to return the map if sucecssful, and then unfreezes the player on
2343the new (success) or old (failed) map position. In either case, $done will
2344be called at the end of this process.
2345
2346=cut
2347
2348our $GOTOGEN;
2349
2350sub cf::object::player::goto {
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;
2355
2356 $self->enter_link;
2357
2358 (async {
2359 my $map = eval {
2360 my $map = cf::map::find $path;
2361
2362 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
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 $@;
2375 }
2376
2377 if ($gen == $self->{_goto_generation}) {
2378 delete $self->{_goto_generation};
2379 $self->leave_link ($map, $x, $y);
2380 }
2381
2382 $done->() if $done;
2383 })->prio (1);
2384}
2385
2386=item $player_object->enter_exit ($exit_object)
2387
2388=cut
2389
2390sub parse_random_map_params {
2391 my ($spec) = @_;
2392
2393 my $rmp = { # defaults
2394 xsize => (cf::rndm 15, 40),
2395 ysize => (cf::rndm 15, 40),
2396 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2397 #layout => string,
626 } 2398 };
627}
628 2399
2400 for (split /\n/, $spec) {
2401 my ($k, $v) = split /\s+/, $_, 2;
2402
2403 $rmp->{lc $k} = $v if (length $k) && (length $v);
2404 }
2405
2406 $rmp
2407}
2408
2409sub prepare_random_map {
2410 my ($exit) = @_;
2411
2412 my $guard = cf::lock_acquire "exit_prepare:$exit";
2413
2414 # all this does is basically replace the /! path by
2415 # a new random map path (?random/...) with a seed
2416 # that depends on the exit object
2417
2418 my $rmp = parse_random_map_params $exit->msg;
2419
2420 if ($exit->map) {
2421 $rmp->{region} = $exit->region->name;
2422 $rmp->{origin_map} = $exit->map->path;
2423 $rmp->{origin_x} = $exit->x;
2424 $rmp->{origin_y} = $exit->y;
2425 }
2426
2427 $rmp->{random_seed} ||= $exit->random_seed;
2428
2429 my $data = cf::to_json $rmp;
2430 my $md5 = Digest::MD5::md5_hex $data;
2431 my $meta = "$RANDOMDIR/$md5.meta";
2432
2433 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2434 aio_write $fh, 0, (length $data), $data, 0;
2435 undef $fh;
2436 aio_rename "$meta~", $meta;
2437
2438 $exit->slaying ("?random/$md5");
2439 $exit->msg (undef);
2440 }
2441}
2442
2443sub cf::object::player::enter_exit {
2444 my ($self, $exit) = @_;
2445
2446 return unless $self->type == cf::PLAYER;
2447
2448 if ($exit->slaying eq "/!") {
2449 #TODO: this should de-fi-ni-te-ly not be a sync-job
2450 # the problem is that $exit might not survive long enough
2451 # so it needs to be done right now, right here
2452 cf::sync_job { prepare_random_map $exit };
2453 }
2454
2455 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2456 my $hp = $exit->stats->hp;
2457 my $sp = $exit->stats->sp;
2458
2459 $self->enter_link;
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
2465 (async {
2466 $self->deactivate_recursive; # just to be sure
2467 unless (eval {
2468 $self->goto ($slaying, $hp, $sp);
2469
2470 1;
2471 }) {
2472 $self->message ("Something went wrong deep within the crossfire server. "
2473 . "I'll try to bring you back to the map you were before. "
2474 . "Please report this to the dungeon master!",
2475 cf::NDI_UNIQUE | cf::NDI_RED);
2476
2477 warn "ERROR in enter_exit: $@";
2478 $self->leave_link;
2479 }
2480 })->prio (1);
2481}
2482
2483=head3 cf::client
2484
2485=over 4
2486
2487=item $client->send_drawinfo ($text, $flags)
2488
2489Sends a drawinfo packet to the client. Circumvents output buffering so
2490should not be used under normal circumstances.
2491
2492=cut
2493
2494sub cf::client::send_drawinfo {
2495 my ($self, $text, $flags) = @_;
2496
2497 utf8::encode $text;
2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2499}
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 if $self->can_msg;
2541 }
2542
2543 $channel = $channel->{id};
2544 }
2545
2546 return unless @extra || length $msg;
2547
2548 if ($self->can_msg) {
2549 # default colour, mask it out
2550 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2551 if $color & cf::NDI_DEF;
2552
2553 $self->send_packet ("msg " . $self->{json_coder}->encode (
2554 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2555 } else {
2556 if ($color >= 0) {
2557 # replace some tags by gcfclient-compatible ones
2558 for ($msg) {
2559 1 while
2560 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2561 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2562 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2563 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2564 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2565 }
2566
2567 $color &= cf::NDI_COLOR_MASK;
2568
2569 utf8::encode $msg;
2570
2571 if (0 && $msg =~ /\[/) {
2572 # COMMAND/INFO
2573 $self->send_packet ("drawextinfo $color 10 8 $msg")
2574 } else {
2575 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2576 $self->send_packet ("drawinfo $color $msg")
2577 }
2578 }
2579 }
2580}
2581
2582=item $client->ext_msg ($type, @msg)
2583
2584Sends an ext event to the client.
2585
2586=cut
2587
2588sub cf::client::ext_msg($$@) {
2589 my ($self, $type, @msg) = @_;
2590
2591 if ($self->extcmd == 2) {
2592 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2593 } elsif ($self->extcmd == 1) { # TODO: remove
2594 push @msg, msgtype => "event_$type";
2595 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2596 }
2597}
2598
629=item $player->ext_reply ($msgid, $msgtype, %msg) 2599=item $client->ext_reply ($msgid, @msg)
630 2600
631Sends an ext reply to the player. 2601Sends an ext reply to the client.
632 2602
633=cut 2603=cut
634 2604
635sub cf::player::ext_reply($$$%) { 2605sub cf::client::ext_reply($$@) {
636 my ($self, $id, %msg) = @_; 2606 my ($self, $id, @msg) = @_;
637 2607
638 $msg{msgid} = $id; 2608 if ($self->extcmd == 2) {
639 2609 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
640 $self->send ("ext " . to_json \%msg); 2610 } elsif ($self->extcmd == 1) {
2611 #TODO: version 1, remove
2612 unshift @msg, msgtype => "reply", msgid => $id;
2613 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2614 }
641} 2615}
642 2616
643############################################################################# 2617=item $success = $client->query ($flags, "text", \&cb)
644# map scripting support 2618
2619Queues a query to the client, calling the given callback with
2620the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2621C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2622
2623Queries can fail, so check the return code. Or don't, as queries will
2624become reliable at some point in the future.
2625
2626=cut
2627
2628sub cf::client::query {
2629 my ($self, $flags, $text, $cb) = @_;
2630
2631 return unless $self->state == ST_PLAYING
2632 || $self->state == ST_SETUP
2633 || $self->state == ST_CUSTOM;
2634
2635 $self->state (ST_CUSTOM);
2636
2637 utf8::encode $text;
2638 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2639
2640 $self->send_packet ($self->{query_queue}[0][0])
2641 if @{ $self->{query_queue} } == 1;
2642
2643 1
2644}
2645
2646cf::client->attach (
2647 on_connect => sub {
2648 my ($ns) = @_;
2649
2650 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2651 },
2652 on_reply => sub {
2653 my ($ns, $msg) = @_;
2654
2655 # this weird shuffling is so that direct followup queries
2656 # get handled first
2657 my $queue = delete $ns->{query_queue}
2658 or return; # be conservative, not sure how that can happen, but we saw a crash here
2659
2660 (shift @$queue)->[1]->($msg);
2661 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2662
2663 push @{ $ns->{query_queue} }, @$queue;
2664
2665 if (@{ $ns->{query_queue} } == @$queue) {
2666 if (@$queue) {
2667 $ns->send_packet ($ns->{query_queue}[0][0]);
2668 } else {
2669 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2670 }
2671 }
2672 },
2673 on_exticmd => sub {
2674 my ($ns, $buf) = @_;
2675
2676 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2677
2678 if (ref $msg) {
2679 my ($type, $reply, @payload) =
2680 "ARRAY" eq ref $msg
2681 ? @$msg
2682 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2683
2684 my @reply;
2685
2686 if (my $cb = $EXTICMD{$type}) {
2687 @reply = $cb->($ns, @payload);
2688 }
2689
2690 $ns->ext_reply ($reply, @reply)
2691 if $reply;
2692
2693 } else {
2694 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2695 }
2696
2697 cf::override;
2698 },
2699);
2700
2701=item $client->async (\&cb)
2702
2703Create a new coroutine, running the specified callback. The coroutine will
2704be automatically cancelled when the client gets destroyed (e.g. on logout,
2705or loss of connection).
2706
2707=cut
2708
2709sub cf::client::async {
2710 my ($self, $cb) = @_;
2711
2712 my $coro = &Coro::async ($cb);
2713
2714 $coro->on_destroy (sub {
2715 delete $self->{_coro}{$coro+0};
2716 });
2717
2718 $self->{_coro}{$coro+0} = $coro;
2719
2720 $coro
2721}
2722
2723cf::client->attach (
2724 on_destroy => sub {
2725 my ($ns) = @_;
2726
2727 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2728 },
2729);
2730
2731=back
2732
2733
2734=head2 SAFE SCRIPTING
2735
2736Functions that provide a safe environment to compile and execute
2737snippets of perl code without them endangering the safety of the server
2738itself. Looping constructs, I/O operators and other built-in functionality
2739is not available in the safe scripting environment, and the number of
2740functions and methods that can be called is greatly reduced.
2741
2742=cut
645 2743
646our $safe = new Safe "safe"; 2744our $safe = new Safe "safe";
647our $safe_hole = new Safe::Hole; 2745our $safe_hole = new Safe::Hole;
648 2746
649$SIG{FPE} = 'IGNORE'; 2747$SIG{FPE} = 'IGNORE';
650 2748
651$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2749$safe->permit_only (Opcode::opset qw(
2750 :base_core :base_mem :base_orig :base_math
2751 grepstart grepwhile mapstart mapwhile
2752 sort time
2753));
652 2754
653# here we export the classes and methods available to script code 2755# here we export the classes and methods available to script code
654 2756
2757=pod
2758
2759The following functions and methods are available within a safe environment:
2760
2761 cf::object
2762 contr pay_amount pay_player map x y force_find force_add
2763 insert remove name archname title slaying race decrease_ob_nr
2764
2765 cf::object::player
2766 player
2767
2768 cf::player
2769 peaceful
2770
2771 cf::map
2772 trigger
2773
2774=cut
2775
655for ( 2776for (
656 ["cf::object" => qw(contr pay_amount pay_player)], 2777 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2778 insert remove inv name archname title slaying race
2779 decrease_ob_nr)],
657 ["cf::object::player" => qw(player)], 2780 ["cf::object::player" => qw(player)],
658 ["cf::player" => qw(peaceful)], 2781 ["cf::player" => qw(peaceful)],
2782 ["cf::map" => qw(trigger)],
659) { 2783) {
660 no strict 'refs'; 2784 no strict 'refs';
661 my ($pkg, @funs) = @$_; 2785 my ($pkg, @funs) = @$_;
662 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2786 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
663 for @funs; 2787 for @funs;
664} 2788}
2789
2790=over 4
2791
2792=item @retval = safe_eval $code, [var => value, ...]
2793
2794Compiled and executes the given perl code snippet. additional var/value
2795pairs result in temporary local (my) scalar variables of the given name
2796that are available in the code snippet. Example:
2797
2798 my $five = safe_eval '$first + $second', first => 1, second => 4;
2799
2800=cut
665 2801
666sub safe_eval($;@) { 2802sub safe_eval($;@) {
667 my ($code, %vars) = @_; 2803 my ($code, %vars) = @_;
668 2804
669 my $qcode = $code; 2805 my $qcode = $code;
… …
692 } 2828 }
693 2829
694 wantarray ? @res : $res[0] 2830 wantarray ? @res : $res[0]
695} 2831}
696 2832
2833=item cf::register_script_function $function => $cb
2834
2835Register a function that can be called from within map/npc scripts. The
2836function should be reasonably secure and should be put into a package name
2837like the extension.
2838
2839Example: register a function that gets called whenever a map script calls
2840C<rent::overview>, as used by the C<rent> extension.
2841
2842 cf::register_script_function "rent::overview" => sub {
2843 ...
2844 };
2845
2846=cut
2847
697sub register_script_function { 2848sub register_script_function {
698 my ($fun, $cb) = @_; 2849 my ($fun, $cb) = @_;
699 2850
700 no strict 'refs'; 2851 no strict 'refs';
701 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2852 *{"safe::$fun"} = $safe_hole->wrap ($cb);
702} 2853}
703 2854
2855=back
2856
2857=cut
2858
704############################################################################# 2859#############################################################################
705# the server's main() 2860# the server's init and main functions
2861
2862sub load_facedata($) {
2863 my ($path) = @_;
2864
2865 # HACK to clear player env face cache, we need some signal framework
2866 # for this (global event?)
2867 %ext::player_env::MUSIC_FACE_CACHE = ();
2868
2869 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2870
2871 warn "loading facedata from $path\n";
2872
2873 my $facedata;
2874 0 < aio_load $path, $facedata
2875 or die "$path: $!";
2876
2877 $facedata = Coro::Storable::thaw $facedata;
2878
2879 $facedata->{version} == 2
2880 or cf::cleanup "$path: version mismatch, cannot proceed.";
2881
2882 # patch in the exptable
2883 $facedata->{resource}{"res/exp_table"} = {
2884 type => FT_RSRC,
2885 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2886 };
2887 cf::cede_to_tick;
2888
2889 {
2890 my $faces = $facedata->{faceinfo};
2891
2892 while (my ($face, $info) = each %$faces) {
2893 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2894 cf::face::set_visibility $idx, $info->{visibility};
2895 cf::face::set_magicmap $idx, $info->{magicmap};
2896 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2897 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2898
2899 cf::cede_to_tick;
2900 }
2901
2902 while (my ($face, $info) = each %$faces) {
2903 next unless $info->{smooth};
2904 my $idx = cf::face::find $face
2905 or next;
2906 if (my $smooth = cf::face::find $info->{smooth}) {
2907 cf::face::set_smooth $idx, $smooth;
2908 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2909 } else {
2910 warn "smooth face '$info->{smooth}' not found for face '$face'";
2911 }
2912
2913 cf::cede_to_tick;
2914 }
2915 }
2916
2917 {
2918 my $anims = $facedata->{animinfo};
2919
2920 while (my ($anim, $info) = each %$anims) {
2921 cf::anim::set $anim, $info->{frames}, $info->{facings};
2922 cf::cede_to_tick;
2923 }
2924
2925 cf::anim::invalidate_all; # d'oh
2926 }
2927
2928 {
2929 # TODO: for gcfclient pleasure, we should give resources
2930 # that gcfclient doesn't grok a >10000 face index.
2931 my $res = $facedata->{resource};
2932
2933 my $soundconf = delete $res->{"res/sound.conf"};
2934
2935 while (my ($name, $info) = each %$res) {
2936 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2937 my $data;
2938
2939 if ($info->{type} & 1) {
2940 # prepend meta info
2941
2942 my $meta = $enc->encode ({
2943 name => $name,
2944 %{ $info->{meta} || {} },
2945 });
2946
2947 $data = pack "(w/a*)*", $meta, $info->{data};
2948 } else {
2949 $data = $info->{data};
2950 }
2951
2952 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2953 cf::face::set_type $idx, $info->{type};
2954
2955 cf::cede_to_tick;
2956 }
2957
2958 if ($soundconf) {
2959 $soundconf = $enc->decode (delete $soundconf->{data});
2960
2961 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2962 my $sound = $soundconf->{compat}[$_]
2963 or next;
2964
2965 my $face = cf::face::find "sound/$sound->[1]";
2966 cf::sound::set $sound->[0] => $face;
2967 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2968 }
2969
2970 while (my ($k, $v) = each %{$soundconf->{event}}) {
2971 my $face = cf::face::find "sound/$v";
2972 cf::sound::set $k => $face;
2973 }
2974 }
2975 }
2976
2977 1
2978}
2979
2980register_exticmd fx_want => sub {
2981 my ($ns, $want) = @_;
2982
2983 while (my ($k, $v) = each %$want) {
2984 $ns->fx_want ($k, $v);
2985 }
2986};
2987
2988sub reload_regions {
2989 # HACK to clear player env face cache, we need some signal framework
2990 # for this (global event?)
2991 %ext::player_env::MUSIC_FACE_CACHE = ();
2992
2993 load_resource_file "$MAPDIR/regions"
2994 or die "unable to load regions file\n";
2995
2996 for (cf::region::list) {
2997 $_->{match} = qr/$_->{match}/
2998 if exists $_->{match};
2999 }
3000}
3001
3002sub reload_facedata {
3003 load_facedata "$DATADIR/facedata"
3004 or die "unable to load facedata\n";
3005}
3006
3007sub reload_archetypes {
3008 load_resource_file "$DATADIR/archetypes"
3009 or die "unable to load archetypes\n";
3010 #d# NEED to laod twice to resolve forward references
3011 # this really needs to be done in an extra post-pass
3012 # (which needs to be synchronous, so solve it differently)
3013 load_resource_file "$DATADIR/archetypes"
3014 or die "unable to load archetypes\n";
3015}
3016
3017sub reload_treasures {
3018 load_resource_file "$DATADIR/treasures"
3019 or die "unable to load treasurelists\n";
3020}
3021
3022sub reload_resources {
3023 warn "reloading resource files...\n";
3024
3025 reload_regions;
3026 reload_facedata;
3027 #reload_archetypes;#d#
3028 reload_archetypes;
3029 reload_treasures;
3030
3031 warn "finished reloading resource files\n";
3032}
3033
3034sub init {
3035 reload_resources;
3036}
3037
3038sub reload_config {
3039 open my $fh, "<:utf8", "$CONFDIR/config"
3040 or return;
3041
3042 local $/;
3043 *CFG = YAML::Syck::Load <$fh>;
3044
3045 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3046
3047 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3048 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3049
3050 if (exists $CFG{mlockall}) {
3051 eval {
3052 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3053 and die "WARNING: m(un)lockall failed: $!\n";
3054 };
3055 warn $@ if $@;
3056 }
3057}
706 3058
707sub main { 3059sub main {
3060 # we must not ever block the main coroutine
3061 local $Coro::idle = sub {
3062 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3063 (async {
3064 Event::one_event;
3065 })->prio (Coro::PRIO_MAX);
3066 };
3067
3068 reload_config;
3069 db_init;
3070 load_extensions;
3071
3072 $TICK_WATCHER->start;
708 Event::loop; 3073 Event::loop;
709} 3074}
710 3075
711############################################################################# 3076#############################################################################
712# initialisation 3077# initialisation and cleanup
713 3078
714register "<global>", __PACKAGE__; 3079# install some emergency cleanup handlers
3080BEGIN {
3081 for my $signal (qw(INT HUP TERM)) {
3082 Event->signal (
3083 reentrant => 0,
3084 data => WF_AUTOCANCEL,
3085 signal => $signal,
3086 prio => 0,
3087 cb => sub {
3088 cf::cleanup "SIG$signal";
3089 },
3090 );
3091 }
3092}
3093
3094sub write_runtime {
3095 my $runtime = "$LOCALDIR/runtime";
3096
3097 # first touch the runtime file to show we are still running:
3098 # the fsync below can take a very very long time.
3099
3100 IO::AIO::aio_utime $runtime, undef, undef;
3101
3102 my $guard = cf::lock_acquire "write_runtime";
3103
3104 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3105 or return;
3106
3107 my $value = $cf::RUNTIME + 90 + 10;
3108 # 10 is the runtime save interval, for a monotonic clock
3109 # 60 allows for the watchdog to kill the server.
3110
3111 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3112 and return;
3113
3114 # always fsync - this file is important
3115 aio_fsync $fh
3116 and return;
3117
3118 # touch it again to show we are up-to-date
3119 aio_utime $fh, undef, undef;
3120
3121 close $fh
3122 or return;
3123
3124 aio_rename "$runtime~", $runtime
3125 and return;
3126
3127 warn "runtime file written.\n";
3128
3129 1
3130}
3131
3132sub emergency_save() {
3133 my $freeze_guard = cf::freeze_mainloop;
3134
3135 warn "enter emergency perl save\n";
3136
3137 cf::sync_job {
3138 # use a peculiar iteration method to avoid tripping on perl
3139 # refcount bugs in for. also avoids problems with players
3140 # and maps saved/destroyed asynchronously.
3141 warn "begin emergency player save\n";
3142 for my $login (keys %cf::PLAYER) {
3143 my $pl = $cf::PLAYER{$login} or next;
3144 $pl->valid or next;
3145 $pl->save;
3146 }
3147 warn "end emergency player save\n";
3148
3149 warn "begin emergency map save\n";
3150 for my $path (keys %cf::MAP) {
3151 my $map = $cf::MAP{$path} or next;
3152 $map->valid or next;
3153 $map->save;
3154 }
3155 warn "end emergency map save\n";
3156
3157 warn "begin emergency database checkpoint\n";
3158 BDB::db_env_txn_checkpoint $DB_ENV;
3159 warn "end emergency database checkpoint\n";
3160 };
3161
3162 warn "leave emergency perl save\n";
3163}
3164
3165sub post_cleanup {
3166 my ($make_core) = @_;
3167
3168 warn Carp::longmess "post_cleanup backtrace"
3169 if $make_core;
3170}
3171
3172sub do_reload_perl() {
3173 # can/must only be called in main
3174 if ($Coro::current != $Coro::main) {
3175 warn "can only reload from main coroutine";
3176 return;
3177 }
3178
3179 warn "reloading...";
3180
3181 warn "entering sync_job";
3182
3183 cf::sync_job {
3184 cf::write_runtime; # external watchdog should not bark
3185 cf::emergency_save;
3186 cf::write_runtime; # external watchdog should not bark
3187
3188 warn "syncing database to disk";
3189 BDB::db_env_txn_checkpoint $DB_ENV;
3190
3191 # if anything goes wrong in here, we should simply crash as we already saved
3192
3193 warn "cancelling all WF_AUTOCANCEL watchers";
3194 for (Event::all_watchers) {
3195 $_->cancel if $_->data & WF_AUTOCANCEL;
3196 }
3197
3198 warn "flushing outstanding aio requests";
3199 for (;;) {
3200 BDB::flush;
3201 IO::AIO::flush;
3202 Coro::cede;
3203 last unless IO::AIO::nreqs || BDB::nreqs;
3204 warn "iterate...";
3205 }
3206
3207 ++$RELOAD;
3208
3209 warn "cancelling all extension coros";
3210 $_->cancel for values %EXT_CORO;
3211 %EXT_CORO = ();
3212
3213 warn "removing commands";
3214 %COMMAND = ();
3215
3216 warn "removing ext/exti commands";
3217 %EXTCMD = ();
3218 %EXTICMD = ();
3219
3220 warn "unloading/nuking all extensions";
3221 for my $pkg (@EXTS) {
3222 warn "... unloading $pkg";
3223
3224 if (my $cb = $pkg->can ("unload")) {
3225 eval {
3226 $cb->($pkg);
3227 1
3228 } or warn "$pkg unloaded, but with errors: $@";
3229 }
3230
3231 warn "... nuking $pkg";
3232 Symbol::delete_package $pkg;
3233 }
3234
3235 warn "unloading all perl modules loaded from $LIBDIR";
3236 while (my ($k, $v) = each %INC) {
3237 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3238
3239 warn "... unloading $k";
3240 delete $INC{$k};
3241
3242 $k =~ s/\.pm$//;
3243 $k =~ s/\//::/g;
3244
3245 if (my $cb = $k->can ("unload_module")) {
3246 $cb->();
3247 }
3248
3249 Symbol::delete_package $k;
3250 }
3251
3252 warn "getting rid of safe::, as good as possible";
3253 Symbol::delete_package "safe::$_"
3254 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3255
3256 warn "unloading cf.pm \"a bit\"";
3257 delete $INC{"cf.pm"};
3258 delete $INC{"cf/pod.pm"};
3259
3260 # don't, removes xs symbols, too,
3261 # and global variables created in xs
3262 #Symbol::delete_package __PACKAGE__;
3263
3264 warn "unload completed, starting to reload now";
3265
3266 warn "reloading cf.pm";
3267 require cf;
3268 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
3269
3270 warn "loading config and database again";
3271 cf::reload_config;
3272
3273 warn "loading extensions";
3274 cf::load_extensions;
3275
3276 warn "reattaching attachments to objects/players";
3277 _global_reattach; # objects, sockets
3278 warn "reattaching attachments to maps";
3279 reattach $_ for values %MAP;
3280 warn "reattaching attachments to players";
3281 reattach $_ for values %PLAYER;
3282
3283 warn "leaving sync_job";
3284
3285 1
3286 } or do {
3287 warn $@;
3288 warn "error while reloading, exiting.";
3289 exit 1;
3290 };
3291
3292 warn "reloaded";
3293};
3294
3295our $RELOAD_WATCHER; # used only during reload
3296
3297sub reload_perl() {
3298 # doing reload synchronously and two reloads happen back-to-back,
3299 # coro crashes during coro_state_free->destroy here.
3300
3301 $RELOAD_WATCHER ||= Event->timer (
3302 reentrant => 0,
3303 after => 0,
3304 data => WF_AUTOCANCEL,
3305 cb => sub {
3306 do_reload_perl;
3307 undef $RELOAD_WATCHER;
3308 },
3309 );
3310}
3311
3312register_command "reload" => sub {
3313 my ($who, $arg) = @_;
3314
3315 if ($who->flag (FLAG_WIZ)) {
3316 $who->message ("reloading server.");
3317 async { reload_perl };
3318 }
3319};
715 3320
716unshift @INC, $LIBDIR; 3321unshift @INC, $LIBDIR;
717 3322
718load_extensions; 3323my $bug_warning = 0;
719 3324
3325our @WAIT_FOR_TICK;
3326our @WAIT_FOR_TICK_BEGIN;
3327
3328sub wait_for_tick {
3329 return unless $TICK_WATCHER->is_active;
3330 return if $Coro::current == $Coro::main;
3331
3332 my $signal = new Coro::Signal;
3333 push @WAIT_FOR_TICK, $signal;
3334 $signal->wait;
3335}
3336
3337sub wait_for_tick_begin {
3338 return unless $TICK_WATCHER->is_active;
3339 return if $Coro::current == $Coro::main;
3340
3341 my $signal = new Coro::Signal;
3342 push @WAIT_FOR_TICK_BEGIN, $signal;
3343 $signal->wait;
3344}
3345
3346 my $min = 1e6;#d#
3347 my $avg = 10;
720$TICK_WATCHER = Event->timer ( 3348$TICK_WATCHER = Event->timer (
3349 reentrant => 0,
3350 parked => 1,
721 prio => 1, 3351 prio => 0,
722 at => $NEXT_TICK || 1, 3352 at => $NEXT_TICK || $TICK,
3353 data => WF_AUTOCANCEL,
723 cb => sub { 3354 cb => sub {
3355 if ($Coro::current != $Coro::main) {
3356 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3357 unless ++$bug_warning > 10;
3358 return;
3359 }
3360
3361 $NOW = $tick_start = Event::time;
3362
724 cf::server_tick; # one server iteration 3363 cf::server_tick; # one server iteration
725 3364
3365 0 && sync_job {#d#
3366 for(1..10) {
726 my $NOW = Event::time; 3367 my $t = Event::time;
3368 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3369 or die;
3370
3371 $map->width (50);
3372 $map->height (50);
3373 $map->alloc;
3374 $map->_load_objects ("/tmp/x.map", 1);
3375 my $t = Event::time - $t;
3376
3377 #next unless $t < 0.0013;#d#
3378 if ($t < $min) {
3379 $min = $t;
3380 }
3381 $avg = $avg * 0.99 + $t * 0.01;
3382 }
3383 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3384 exit 0;
3385 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3386 };
3387
3388 $RUNTIME += $TICK;
727 $NEXT_TICK += $TICK; 3389 $NEXT_TICK += $TICK;
728 3390
3391 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3392 $NEXT_RUNTIME_WRITE = $NOW + 10;
3393 Coro::async_pool {
3394 write_runtime
3395 or warn "ERROR: unable to write runtime file: $!";
3396 };
3397 }
3398
3399# my $AFTER = Event::time;
3400# warn $AFTER - $NOW;#d#
3401
3402 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3403 $sig->send;
3404 }
3405 while (my $sig = shift @WAIT_FOR_TICK) {
3406 $sig->send;
3407 }
3408
3409 $NOW = Event::time;
3410
729 # if we are delayed by four ticks, skip them all 3411 # if we are delayed by four ticks or more, skip them all
730 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 3412 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
731 3413
732 $TICK_WATCHER->at ($NEXT_TICK); 3414 $TICK_WATCHER->at ($NEXT_TICK);
733 $TICK_WATCHER->start; 3415 $TICK_WATCHER->start;
3416
3417 $LOAD = ($NOW - $tick_start) / $TICK;
3418 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3419
3420 _post_tick;
3421
3422
734 }, 3423 },
735); 3424);
736 3425
3426{
3427 BDB::max_poll_time $TICK * 0.1;
3428 $BDB_POLL_WATCHER = Event->io (
3429 reentrant => 0,
3430 fd => BDB::poll_fileno,
3431 poll => 'r',
3432 prio => 0,
3433 data => WF_AUTOCANCEL,
3434 cb => \&BDB::poll_cb,
3435 );
3436 BDB::min_parallel 8;
3437
3438 BDB::set_sync_prepare {
3439 my $status;
3440 my $current = $Coro::current;
3441 (
3442 sub {
3443 $status = $!;
3444 $current->ready; undef $current;
3445 },
3446 sub {
3447 Coro::schedule while defined $current;
3448 $! = $status;
3449 },
3450 )
3451 };
3452
3453 unless ($DB_ENV) {
3454 $DB_ENV = BDB::db_env_create;
3455
3456 cf::sync_job {
3457 eval {
3458 BDB::db_env_open
3459 $DB_ENV,
3460 $BDBDIR,
3461 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3462 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3463 0666;
3464
3465 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3466
3467 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3468 $DB_ENV->set_lk_detect;
3469 };
3470
3471 cf::cleanup "db_env_open(db): $@" if $@;
3472 };
3473 }
3474}
3475
3476{
3477 IO::AIO::min_parallel 8;
3478
3479 undef $Coro::AIO::WATCHER;
3480 IO::AIO::max_poll_time $TICK * 0.1;
3481 $AIO_POLL_WATCHER = Event->io (
3482 reentrant => 0,
3483 data => WF_AUTOCANCEL,
3484 fd => IO::AIO::poll_fileno,
3485 poll => 'r',
3486 prio => 6,
3487 cb => \&IO::AIO::poll_cb,
3488 );
3489}
3490
3491my $_log_backtrace;
3492
3493sub _log_backtrace {
3494 my ($msg, @addr) = @_;
3495
3496 $msg =~ s/\n//;
3497
3498 # limit the # of concurrent backtraces
3499 if ($_log_backtrace < 2) {
3500 ++$_log_backtrace;
3501 async {
3502 my @bt = fork_call {
3503 @addr = map { sprintf "%x", $_ } @addr;
3504 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3505 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3506 or die "addr2line: $!";
3507
3508 my @funcs;
3509 my @res = <$fh>;
3510 chomp for @res;
3511 while (@res) {
3512 my ($func, $line) = splice @res, 0, 2, ();
3513 push @funcs, "[$func] $line";
3514 }
3515
3516 @funcs
3517 };
3518
3519 LOG llevInfo, "[ABT] $msg\n";
3520 LOG llevInfo, "[ABT] $_\n" for @bt;
3521 --$_log_backtrace;
3522 };
3523 } else {
3524 LOG llevInfo, "[ABT] $msg\n";
3525 LOG llevInfo, "[ABT] [suppressed]\n";
3526 }
3527}
3528
3529# load additional modules
3530use cf::pod;
3531
3532END { cf::emergency_save }
3533
7371 35341
738 3535

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines