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.7 by root, Tue Mar 7 13:44:43 2006 UTC vs.
Revision 1.465 by root, Thu Jan 8 00:54:55 2009 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18#
19# The authors can be reached via e-mail to <support@deliantra.net>
20#
21
1package cf; 22package cf;
23
24use 5.10.0;
25use utf8;
26use strict "vars", "subs";
2 27
3use Symbol; 28use Symbol;
4use List::Util; 29use List::Util;
30use Socket;
31use EV;
32use Opcode;
33use Safe;
34use Safe::Hole;
5use Storable; 35use Storable ();
6 36
7use strict; 37use Guard ();
38use Coro ();
39use Coro::State;
40use Coro::Handle;
41use Coro::EV;
42use Coro::AnyEvent;
43use Coro::Timer;
44use Coro::Signal;
45use Coro::Semaphore;
46use Coro::SemaphoreSet;
47use Coro::AnyEvent;
48use Coro::AIO;
49use Coro::BDB 1.6;
50use Coro::Storable;
51use Coro::Util ();
8 52
9our %COMMAND; 53use JSON::XS 2.01 ();
54use BDB ();
55use Data::Dumper;
56use Digest::MD5;
57use Fcntl;
58use YAML ();
59use IO::AIO ();
60use Time::HiRes;
61use Compress::LZF;
62use Digest::MD5 ();
63
64AnyEvent::detect;
65
66# configure various modules to our taste
67#
68$Storable::canonical = 1; # reduce rsync transfers
69Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
70
71$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
72
73# make sure c-lzf reinitialises itself
74Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
75Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
76
77sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
78
79our %COMMAND = ();
80our %COMMAND_TIME = ();
81
82our @EXTS = (); # list of extension package names
83our %EXTCMD = ();
84our %EXTICMD = ();
85our %EXT_CORO = (); # coroutines bound to extensions
86our %EXT_MAP = (); # pluggable maps
87
88our $RELOAD; # number of reloads so far, non-zero while in reload
10our @EVENT; 89our @EVENT;
11our %PROP_TYPE; 90
12our %PROP_IDX; 91our $CONFDIR = confdir;
92our $DATADIR = datadir;
93our $LIBDIR = "$DATADIR/ext";
94our $PODDIR = "$DATADIR/pod";
95our $MAPDIR = "$DATADIR/" . mapdir;
96our $LOCALDIR = localdir;
97our $TMPDIR = "$LOCALDIR/" . tmpdir;
98our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
99our $PLAYERDIR = "$LOCALDIR/" . playerdir;
100our $RANDOMDIR = "$LOCALDIR/random";
101our $BDBDIR = "$LOCALDIR/db";
102our $PIDFILE = "$LOCALDIR/pid";
103our $RUNTIMEFILE = "$LOCALDIR/runtime";
104
105our %RESOURCE;
106
107our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
108our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
109our $NEXT_TICK;
110our $USE_FSYNC = 1; # use fsync to write maps - default off
111
112our $BDB_DEADLOCK_WATCHER;
113our $BDB_CHECKPOINT_WATCHER;
114our $BDB_TRICKLE_WATCHER;
115our $DB_ENV;
116
117our %CFG;
118
119our $UPTIME; $UPTIME ||= time;
120our $RUNTIME;
121our $NOW;
122
123our (%PLAYER, %PLAYER_LOADING); # all users
124our (%MAP, %MAP_LOADING ); # all maps
125our $LINK_MAP; # the special {link} map, which is always available
126
127# used to convert map paths into valid unix filenames by replacing / by ∕
128our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
129
130our $LOAD; # a number between 0 (idle) and 1 (too many objects)
131our $LOADAVG; # same thing, but with alpha-smoothing
132our $JITTER; # average jitter
133our $TICK_START; # for load detecting purposes
134
135our @POST_INIT;
136
137our $REATTACH_ON_RELOAD; # ste to true to force object reattach on reload (slow)
138
139binmode STDOUT;
140binmode STDERR;
141
142# read virtual server time, if available
143unless ($RUNTIME || !-e $RUNTIMEFILE) {
144 open my $fh, "<", $RUNTIMEFILE
145 or die "unable to read $RUNTIMEFILE file: $!";
146 $RUNTIME = <$fh> + 0.;
147}
148
149mkdir $_
150 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
151
152our $EMERGENCY_POSITION;
153
154sub cf::map::normalise;
155
156#############################################################################
157
158=head2 GLOBAL VARIABLES
159
160=over 4
161
162=item $cf::UPTIME
163
164The timestamp of the server start (so not actually an uptime).
165
166=item $cf::RUNTIME
167
168The time this server has run, starts at 0 and is increased by $cf::TICK on
169every server tick.
170
171=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
172$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
173$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
174
175Various directories - "/etc", read-only install directory, perl-library
176directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
177unique-items directory, player file directory, random maps directory and
178database environment.
179
180=item $cf::NOW
181
182The time of the last (current) server tick.
183
184=item $cf::TICK
185
186The interval between server ticks, in seconds.
187
188=item $cf::LOADAVG
189
190The current CPU load on the server (alpha-smoothed), as a value between 0
191(none) and 1 (overloaded), indicating how much time is spent on processing
192objects per tick. Healthy values are < 0.5.
193
194=item $cf::LOAD
195
196The raw value load value from the last tick.
197
198=item %cf::CFG
199
200Configuration for the server, loaded from C</etc/deliantra-server/config>, or
201from wherever your confdir points to.
202
203=item cf::wait_for_tick, cf::wait_for_tick_begin
204
205These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
206returns directly I<after> the tick processing (and consequently, can only wake one process
207per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
208
209=item @cf::INVOKE_RESULTS
210
211This array contains the results of the last C<invoke ()> call. When
212C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
213that call.
214
215=back
216
217=cut
13 218
14BEGIN { 219BEGIN {
15 @EVENT = map lc, @EVENT;
16
17 *CORE::GLOBAL::warn = sub { 220 *CORE::GLOBAL::warn = sub {
18 my $msg = join "", @_; 221 my $msg = join "", @_;
222
19 $msg .= "\n" 223 $msg .= "\n"
20 unless $msg =~ /\n$/; 224 unless $msg =~ /\n$/;
21 225
22 print STDERR "cfperl: $msg"; 226 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
227
23 LOG llevError, "cfperl: $msg"; 228 LOG llevError, $msg;
24 }; 229 };
25} 230}
26 231
27# generate property mutators 232$Coro::State::DIEHOOK = sub {
28sub prop_gen { 233 return unless $^S eq 0; # "eq", not "=="
234
235 if ($Coro::current == $Coro::main) {#d#
236 warn "DIEHOOK called in main context, Coro bug?\n";#d#
237 return;#d#
238 }#d#
239
240 # kill coroutine otherwise
241 warn Carp::longmess $_[0];
242 Coro::terminate
243};
244
245$SIG{__DIE__} = sub { }; #d#?
246
247@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
248@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
249@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
250@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
251@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
252@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
253@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
254
255# we bless all objects into (empty) derived classes to force a method lookup
256# within the Safe compartment.
257for my $pkg (qw(
258 cf::global cf::attachable
259 cf::object cf::object::player
260 cf::client cf::player
261 cf::arch cf::living
262 cf::map cf::mapspace
263 cf::party cf::region
264)) {
265 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
266}
267
268$EV::DIED = sub {
269 warn "error in event callback: @_";
270};
271
272#############################################################################
273
274=head2 UTILITY FUNCTIONS
275
276=over 4
277
278=item dumpval $ref
279
280=cut
281
282sub dumpval {
283 eval {
284 local $SIG{__DIE__};
285 my $d;
286 if (1) {
287 $d = new Data::Dumper([$_[0]], ["*var"]);
288 $d->Terse(1);
289 $d->Indent(2);
290 $d->Quotekeys(0);
291 $d->Useqq(1);
292 #$d->Bless(...);
293 $d->Seen($_[1]) if @_ > 1;
294 $d = $d->Dump();
295 }
296 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
297 $d
298 } || "[unable to dump $_[0]: '$@']";
299}
300
301=item $ref = cf::decode_json $json
302
303Converts a JSON string into the corresponding perl data structure.
304
305=item $json = cf::encode_json $ref
306
307Converts a perl data structure into its JSON representation.
308
309=cut
310
311our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
312
313sub encode_json($) { $json_coder->encode ($_[0]) }
314sub decode_json($) { $json_coder->decode ($_[0]) }
315
316=item cf::post_init { BLOCK }
317
318Execute the given codeblock, I<after> all extensions have been (re-)loaded,
319but I<before> the server starts ticking again.
320
321The cdoeblock will have a single boolean argument to indicate whether this
322is a reload or not.
323
324=cut
325
326sub post_init(&) {
327 push @POST_INIT, shift;
328}
329
330=item cf::lock_wait $string
331
332Wait until the given lock is available. See cf::lock_acquire.
333
334=item my $lock = cf::lock_acquire $string
335
336Wait until the given lock is available and then acquires it and returns
337a L<Guard> object. If the guard object gets destroyed (goes out of scope,
338for example when the coroutine gets canceled), the lock is automatically
339returned.
340
341Locks are *not* recursive, locking from the same coro twice results in a
342deadlocked coro.
343
344Lock names should begin with a unique identifier (for example, cf::map::find
345uses map_find and cf::map::load uses map_load).
346
347=item $locked = cf::lock_active $string
348
349Return true if the lock is currently active, i.e. somebody has locked it.
350
351=cut
352
353our $LOCKS = new Coro::SemaphoreSet;
354
355sub lock_wait($) {
356 $LOCKS->wait ($_[0]);
357}
358
359sub lock_acquire($) {
360 $LOCKS->guard ($_[0])
361}
362
363sub lock_active($) {
364 $LOCKS->count ($_[0]) < 1
365}
366
367sub freeze_mainloop {
368 tick_inhibit_inc;
369
370 &Guard::guard (\&tick_inhibit_dec);
371}
372
373=item cf::periodic $interval, $cb
374
375Like EV::periodic, but randomly selects a starting point so that the actions
376get spread over timer.
377
378=cut
379
380sub periodic($$) {
381 my ($interval, $cb) = @_;
382
383 my $start = rand List::Util::min 180, $interval;
384
385 EV::periodic $start, $interval, 0, $cb
386}
387
388=item cf::get_slot $time[, $priority[, $name]]
389
390Allocate $time seconds of blocking CPU time at priority C<$priority>:
391This call blocks and returns only when you have at least C<$time> seconds
392of cpu time till the next tick. The slot is only valid till the next cede.
393
394The optional C<$name> can be used to identify the job to run. It might be
395used for statistical purposes and should identify the same time-class.
396
397Useful for short background jobs.
398
399=cut
400
401our @SLOT_QUEUE;
402our $SLOT_QUEUE;
403
404$SLOT_QUEUE->cancel if $SLOT_QUEUE;
405$SLOT_QUEUE = Coro::async {
406 $Coro::current->desc ("timeslot manager");
407
408 my $signal = new Coro::Signal;
409
410 while () {
411 next_job:
412 my $avail = cf::till_tick;
413 if ($avail > 0.01) {
414 for (0 .. $#SLOT_QUEUE) {
415 if ($SLOT_QUEUE[$_][0] < $avail) {
416 my $job = splice @SLOT_QUEUE, $_, 1, ();
417 $job->[2]->send;
418 Coro::cede;
419 goto next_job;
420 }
421 }
422 }
423
424 if (@SLOT_QUEUE) {
425 # we do not use wait_for_tick() as it returns immediately when tick is inactive
426 push @cf::WAIT_FOR_TICK, $signal;
427 $signal->wait;
428 } else {
429 Coro::schedule;
430 }
431 }
432};
433
434sub get_slot($;$$) {
435 return if tick_inhibit || $Coro::current == $Coro::main;
436
437 my ($time, $pri, $name) = @_;
438
439 $time = $TICK * .6 if $time > $TICK * .6;
440 my $sig = new Coro::Signal;
441
442 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
443 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
444 $SLOT_QUEUE->ready;
445 $sig->wait;
446}
447
448=item cf::async { BLOCK }
449
450Currently the same as Coro::async_pool, meaning you cannot use
451C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
452thing you are allowed to do is call C<prio> on it.
453
454=cut
455
456BEGIN { *async = \&Coro::async_pool }
457
458=item cf::sync_job { BLOCK }
459
460The design of Deliantra requires that the main coroutine ($Coro::main)
461is always able to handle events or runnable, as Deliantra is only
462partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
463acceptable.
464
465If it must be done, put the blocking parts into C<sync_job>. This will run
466the given BLOCK in another coroutine while waiting for the result. The
467server will be frozen during this time, so the block should either finish
468fast or be very important.
469
470=cut
471
472sub sync_job(&) {
473 my ($job) = @_;
474
475 if ($Coro::current == $Coro::main) {
476 my $time = EV::time;
477
478 # this is the main coro, too bad, we have to block
479 # till the operation succeeds, freezing the server :/
480
481 LOG llevError, Carp::longmess "sync job";#d#
482
483 my $freeze_guard = freeze_mainloop;
484
485 my $busy = 1;
486 my @res;
487
488 (async {
489 $Coro::current->desc ("sync job coro");
490 @res = eval { $job->() };
491 warn $@ if $@;
492 undef $busy;
493 })->prio (Coro::PRIO_MAX);
494
495 while ($busy) {
496 if (Coro::nready) {
497 Coro::cede_notself;
498 } else {
499 EV::loop EV::LOOP_ONESHOT;
500 }
501 }
502
503 my $time = EV::time - $time;
504
505 $TICK_START += $time; # do not account sync jobs to server load
506
507 wantarray ? @res : $res[0]
508 } else {
509 # we are in another coroutine, how wonderful, everything just works
510
511 $job->()
512 }
513}
514
515=item $coro = cf::async_ext { BLOCK }
516
517Like async, but this coro is automatically being canceled when the
518extension calling this is being unloaded.
519
520=cut
521
522sub async_ext(&) {
523 my $cb = shift;
524
525 my $coro = &Coro::async ($cb);
526
527 $coro->on_destroy (sub {
528 delete $EXT_CORO{$coro+0};
529 });
530 $EXT_CORO{$coro+0} = $coro;
531
532 $coro
533}
534
535=item fork_call { }, $args
536
537Executes the given code block with the given arguments in a seperate
538process, returning the results. Everything must be serialisable with
539Coro::Storable. May, of course, block. Note that the executed sub may
540never block itself or use any form of event handling.
541
542=cut
543
544sub fork_call(&@) {
545 my ($cb, @args) = @_;
546
547 # we seemingly have to make a local copy of the whole thing,
548 # otherwise perl prematurely frees the stuff :/
549 # TODO: investigate and fix (likely this will be rather laborious)
550
551 my @res = Coro::Util::fork_eval {
552 reset_signals;
553 &$cb
554 }, @args;
555
556 wantarray ? @res : $res[-1]
557}
558
559=item $coin = coin_from_name $name
560
561=cut
562
563our %coin_alias = (
564 "silver" => "silvercoin",
565 "silvercoin" => "silvercoin",
566 "silvercoins" => "silvercoin",
567 "gold" => "goldcoin",
568 "goldcoin" => "goldcoin",
569 "goldcoins" => "goldcoin",
570 "platinum" => "platinacoin",
571 "platinumcoin" => "platinacoin",
572 "platinumcoins" => "platinacoin",
573 "platina" => "platinacoin",
574 "platinacoin" => "platinacoin",
575 "platinacoins" => "platinacoin",
576 "royalty" => "royalty",
577 "royalties" => "royalty",
578);
579
580sub coin_from_name($) {
581 $coin_alias{$_[0]}
582 ? cf::arch::find $coin_alias{$_[0]}
583 : undef
584}
585
586=item $value = cf::db_get $family => $key
587
588Returns a single value from the environment database.
589
590=item cf::db_put $family => $key => $value
591
592Stores the given C<$value> in the family. It can currently store binary
593data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
594
595=item $db = cf::db_table "name"
596
597Create and/or open a new database table. The string must not be "db" and must be unique
598within each server.
599
600=cut
601
602sub db_table($) {
603 my ($name) = @_;
604 my $db = BDB::db_create $DB_ENV;
605
606 eval {
607 $db->set_flags (BDB::CHKSUM);
608
609 utf8::encode $name;
610 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
611 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
612 cf::cleanup "db_open(db): $!" if $!;
613 };
614 cf::cleanup "db_open(db): $@" if $@;
615
616 $db
617}
618
619our $DB;
620
621sub db_init {
622 cf::sync_job {
623 $DB ||= db_table "db";
624 };
625}
626
627sub db_get($$) {
628 my $key = "$_[0]/$_[1]";
629
630 cf::sync_job {
631 BDB::db_get $DB, undef, $key, my $data;
632
633 $! ? ()
634 : $data
635 }
636}
637
638sub db_put($$$) {
639 BDB::dbreq_pri 4;
640 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
641}
642
643=item cf::cache $id => [$paths...], $processversion => $process
644
645Generic caching function that returns the value of the resource $id,
646caching and regenerating as required.
647
648This function can block.
649
650=cut
651
652sub cache {
653 my ($id, $src, $processversion, $process) = @_;
654
655 my $meta =
656 join "\x00",
657 $processversion,
658 map {
659 aio_stat $_
660 and Carp::croak "$_: $!";
661
662 ($_, (stat _)[7,9])
663 } @$src;
664
665 my $dbmeta = db_get cache => "$id/meta";
666 if ($dbmeta ne $meta) {
667 # changed, we may need to process
668
669 my @data;
670 my $md5;
671
672 for (0 .. $#$src) {
673 0 <= aio_load $src->[$_], $data[$_]
674 or Carp::croak "$src->[$_]: $!";
675 }
676
677 # if processing is expensive, check
678 # checksum first
679 if (1) {
680 $md5 =
681 join "\x00",
682 $processversion,
683 map {
684 cf::cede_to_tick;
685 ($src->[$_], Digest::MD5::md5_hex $data[$_])
686 } 0.. $#$src;
687
688
689 my $dbmd5 = db_get cache => "$id/md5";
690 if ($dbmd5 eq $md5) {
691 db_put cache => "$id/meta", $meta;
692
693 return db_get cache => "$id/data";
694 }
695 }
696
697 my $t1 = Time::HiRes::time;
698 my $data = $process->(\@data);
699 my $t2 = Time::HiRes::time;
700
701 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
702
703 db_put cache => "$id/data", $data;
704 db_put cache => "$id/md5" , $md5;
705 db_put cache => "$id/meta", $meta;
706
707 return $data;
708 }
709
710 db_get cache => "$id/data"
711}
712
713=item cf::datalog type => key => value, ...
714
715Log a datalog packet of the given type with the given key-value pairs.
716
717=cut
718
719sub datalog($@) {
720 my ($type, %kv) = @_;
721 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
722}
723
724=back
725
726=cut
727
728#############################################################################
729
730=head2 ATTACHABLE OBJECTS
731
732Many objects in deliantra are so-called attachable objects. That means you can
733attach callbacks/event handlers (a collection of which is called an "attachment")
734to it. All such attachable objects support the following methods.
735
736In the following description, CLASS can be any of C<global>, C<object>
737C<player>, C<client> or C<map> (i.e. the attachable objects in
738Deliantra).
739
740=over 4
741
742=item $attachable->attach ($attachment, key => $value...)
743
744=item $attachable->detach ($attachment)
745
746Attach/detach a pre-registered attachment to a specific object and give it
747the specified key/value pairs as arguments.
748
749Example, attach a minesweeper attachment to the given object, making it a
75010x10 minesweeper game:
751
752 $obj->attach (minesweeper => width => 10, height => 10);
753
754=item $bool = $attachable->attached ($name)
755
756Checks wether the named attachment is currently attached to the object.
757
758=item cf::CLASS->attach ...
759
760=item cf::CLASS->detach ...
761
762Define an anonymous attachment and attach it to all objects of the given
763CLASS. See the next function for an explanation of its arguments.
764
765You can attach to global events by using the C<cf::global> class.
766
767Example, log all player logins:
768
769 cf::player->attach (
770 on_login => sub {
771 my ($pl) = @_;
772 ...
773 },
774 );
775
776Example, attach to the jeweler skill:
777
778 cf::object->attach (
779 type => cf::SKILL,
780 subtype => cf::SK_JEWELER,
781 on_use_skill => sub {
782 my ($sk, $ob, $part, $dir, $msg) = @_;
783 ...
784 },
785 );
786
787=item cf::CLASS::attachment $name, ...
788
789Register an attachment by C<$name> through which attachable objects of the
790given CLASS can refer to this attachment.
791
792Some classes such as deliantra maps and objects can specify attachments
793that are attached at load/instantiate time, thus the need for a name.
794
795These calls expect any number of the following handler/hook descriptions:
796
797=over 4
798
799=item prio => $number
800
801Set the priority for all following handlers/hooks (unless overwritten
802by another C<prio> setting). Lower priority handlers get executed
803earlier. The default priority is C<0>, and many built-in handlers are
804registered at priority C<-1000>, so lower priorities should not be used
805unless you know what you are doing.
806
807=item type => $type
808
809(Only for C<< cf::object->attach >> calls), limits the attachment to the
810given type of objects only (the additional parameter C<subtype> can be
811used to further limit to the given subtype).
812
813=item on_I<event> => \&cb
814
815Call the given code reference whenever the named event happens (event is
816something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
817handlers are recognised generally depends on the type of object these
818handlers attach to).
819
820See F<include/eventinc.h> for the full list of events supported, and their
821class.
822
823=item package => package::
824
825Look for sub functions of the name C<< on_I<event> >> in the given
826package and register them. Only handlers for eevents supported by the
827object/class are recognised.
828
829=back
830
831Example, define an attachment called "sockpuppet" that calls the given
832event handler when a monster attacks:
833
834 cf::object::attachment sockpuppet =>
835 on_skill_attack => sub {
836 my ($self, $victim) = @_;
837 ...
838 }
839 }
840
841=item $attachable->valid
842
843Just because you have a perl object does not mean that the corresponding
844C-level object still exists. If you try to access an object that has no
845valid C counterpart anymore you get an exception at runtime. This method
846can be used to test for existence of the C object part without causing an
847exception.
848
849=cut
850
851# the following variables are defined in .xs and must not be re-created
852our @CB_GLOBAL = (); # registry for all global events
853our @CB_ATTACHABLE = (); # registry for all attachables
854our @CB_OBJECT = (); # all objects (should not be used except in emergency)
855our @CB_PLAYER = ();
856our @CB_CLIENT = ();
857our @CB_TYPE = (); # registry for type (cf-object class) based events
858our @CB_MAP = ();
859
860my %attachment;
861
862sub cf::attachable::thawer_merge {
863 # simply override everything except _meta
864 local $_[0]{_meta};
865 %{$_[0]} = %{$_[1]};
866}
867
868sub _attach_cb($$$$) {
869 my ($registry, $event, $prio, $cb) = @_;
870
871 use sort 'stable';
872
873 $cb = [$prio, $cb];
874
875 @{$registry->[$event]} = sort
876 { $a->[0] cmp $b->[0] }
877 @{$registry->[$event] || []}, $cb;
878}
879
880# hack
881my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
882
883# attach handles attaching event callbacks
884# the only thing the caller has to do is pass the correct
885# registry (== where the callback attaches to).
886sub _attach {
887 my ($registry, $klass, @arg) = @_;
888
889 my $object_type;
890 my $prio = 0;
891 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
892
893 #TODO: get rid of this hack
894 if ($attachable_klass{$klass}) {
895 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
896 }
897
898 while (@arg) {
899 my $type = shift @arg;
900
901 if ($type eq "prio") {
902 $prio = shift @arg;
903
904 } elsif ($type eq "type") {
905 $object_type = shift @arg;
906 $registry = $CB_TYPE[$object_type] ||= [];
907
908 } elsif ($type eq "subtype") {
909 defined $object_type or Carp::croak "subtype specified without type";
910 my $object_subtype = shift @arg;
911 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
912
913 } elsif ($type eq "package") {
914 my $pkg = shift @arg;
915
916 while (my ($name, $id) = each %cb_id) {
917 if (my $cb = $pkg->can ($name)) {
918 _attach_cb $registry, $id, $prio, $cb;
919 }
920 }
921
922 } elsif (exists $cb_id{$type}) {
923 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
924
925 } elsif (ref $type) {
926 warn "attaching objects not supported, ignoring.\n";
927
928 } else {
929 shift @arg;
930 warn "attach argument '$type' not supported, ignoring.\n";
931 }
932 }
933}
934
935sub _object_attach {
936 my ($obj, $name, %arg) = @_;
937
938 return if exists $obj->{_attachment}{$name};
939
940 if (my $attach = $attachment{$name}) {
941 my $registry = $obj->registry;
942
943 for (@$attach) {
944 my ($klass, @attach) = @$_;
945 _attach $registry, $klass, @attach;
946 }
947
948 $obj->{$name} = \%arg;
949 } else {
950 warn "object uses attachment '$name' which is not available, postponing.\n";
951 }
952
953 $obj->{_attachment}{$name} = undef;
954}
955
956sub cf::attachable::attach {
957 if (ref $_[0]) {
958 _object_attach @_;
959 } else {
960 _attach shift->_attach_registry, @_;
961 }
962 _recalc_want;
963};
964
965# all those should be optimised
966sub cf::attachable::detach {
967 my ($obj, $name) = @_;
968
969 if (ref $obj) {
970 delete $obj->{_attachment}{$name};
971 reattach ($obj);
972 } else {
973 Carp::croak "cannot, currently, detach class attachments";
974 }
975 _recalc_want;
976};
977
978sub cf::attachable::attached {
979 my ($obj, $name) = @_;
980
981 exists $obj->{_attachment}{$name}
982}
983
984for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
985 eval "#line " . __LINE__ . " 'cf.pm'
986 sub cf::\L$klass\E::_attach_registry {
987 (\\\@CB_$klass, KLASS_$klass)
988 }
989
990 sub cf::\L$klass\E::attachment {
991 my \$name = shift;
992
993 \$attachment{\$name} = [[KLASS_$klass, \@_]];
994 }
995 ";
996 die if $@;
997}
998
999our $override;
1000our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
1001
1002sub override {
1003 $override = 1;
1004 @INVOKE_RESULTS = (@_);
1005}
1006
1007sub do_invoke {
1008 my $event = shift;
1009 my $callbacks = shift;
1010
1011 @INVOKE_RESULTS = ();
1012
1013 local $override;
1014
1015 for (@$callbacks) {
1016 eval { &{$_->[1]} };
1017
1018 if ($@) {
1019 warn "$@";
1020 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
1021 override;
1022 }
1023
1024 return 1 if $override;
1025 }
1026
1027 0
1028}
1029
1030=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
1031
1032=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
1033
1034Generate an object-specific event with the given arguments.
1035
1036This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
1037removed in future versions), and there is no public API to access override
1038results (if you must, access C<@cf::INVOKE_RESULTS> directly).
1039
1040=back
1041
1042=cut
1043
1044#############################################################################
1045# object support
1046
1047sub _object_equal($$);
1048sub _object_equal($$) {
1049 my ($a, $b) = @_;
1050
1051 return 0 unless (ref $a) eq (ref $b);
1052
1053 if ("HASH" eq ref $a) {
1054 my @ka = keys %$a;
1055 my @kb = keys %$b;
1056
1057 return 0 if @ka != @kb;
1058
1059 for (0 .. $#ka) {
1060 return 0 unless $ka[$_] eq $kb[$_];
1061 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1062 }
1063
1064 } elsif ("ARRAY" eq ref $a) {
1065
1066 return 0 if @$a != @$b;
1067
1068 for (0 .. $#$a) {
1069 return 0 unless _object_equal $a->[$_], $b->[$_];
1070 }
1071
1072 } elsif ($a ne $b) {
1073 return 0;
1074 }
1075
1076 1
1077}
1078
1079our $SLOW_MERGES;#d#
1080sub _can_merge {
1081 my ($ob1, $ob2) = @_;
1082
1083 ++$SLOW_MERGES;#d#
1084
1085 # we do the slow way here
1086 return _object_equal $ob1, $ob2
1087}
1088
1089sub reattach {
1090 # basically do the same as instantiate, without calling instantiate
1091 my ($obj) = @_;
1092
1093 # no longer needed after getting rid of delete_package?
1094 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
1095
1096 my $registry = $obj->registry;
1097
1098 @$registry = ();
1099
1100 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
1101
1102 for my $name (keys %{ $obj->{_attachment} || {} }) {
1103 if (my $attach = $attachment{$name}) {
1104 for (@$attach) {
1105 my ($klass, @attach) = @$_;
1106 _attach $registry, $klass, @attach;
1107 }
1108 } else {
1109 warn "object uses attachment '$name' that is not available, postponing.\n";
1110 }
1111 }
1112}
1113
1114cf::attachable->attach (
1115 prio => -1000000,
1116 on_instantiate => sub {
1117 my ($obj, $data) = @_;
1118
1119 $data = decode_json $data;
1120
1121 for (@$data) {
1122 my ($name, $args) = @$_;
1123
1124 $obj->attach ($name, %{$args || {} });
1125 }
1126 },
1127 on_reattach => \&reattach,
1128 on_clone => sub {
1129 my ($src, $dst) = @_;
1130
1131 @{$dst->registry} = @{$src->registry};
1132
1133 %$dst = %$src;
1134
1135 %{$dst->{_attachment}} = %{$src->{_attachment}}
1136 if exists $src->{_attachment};
1137 },
1138);
1139
1140sub object_freezer_save {
1141 my ($filename, $rdata, $objs) = @_;
1142
1143 sync_job {
1144 if (length $$rdata) {
1145 utf8::decode (my $decname = $filename);
1146 warn sprintf "saving %s (%d,%d)\n",
1147 $decname, length $$rdata, scalar @$objs;
1148
1149 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
1150 aio_chmod $fh, SAVE_MODE;
1151 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1152 aio_fsync $fh if $cf::USE_FSYNC;
1153 aio_close $fh;
1154
1155 if (@$objs) {
1156 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
1157 aio_chmod $fh, SAVE_MODE;
1158 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
1159 aio_write $fh, 0, (length $data), $data, 0;
1160 aio_fsync $fh if $cf::USE_FSYNC;
1161 aio_close $fh;
1162 aio_rename "$filename.pst~", "$filename.pst";
1163 }
1164 } else {
1165 aio_unlink "$filename.pst";
1166 }
1167
1168 aio_rename "$filename~", $filename;
1169
1170 $filename =~ s%/[^/]+$%%;
1171 aio_pathsync $filename if $cf::USE_FSYNC;
1172 } else {
1173 warn "unable to save objects: $filename~: $!\n";
1174 }
1175 } else {
1176 aio_unlink $filename;
1177 aio_unlink "$filename.pst";
1178 }
1179 };
1180}
1181
1182sub object_freezer_as_string {
1183 my ($rdata, $objs) = @_;
1184
1185 use Data::Dumper;
1186
1187 $$rdata . Dumper $objs
1188}
1189
1190sub object_thawer_load {
1191 my ($filename) = @_;
1192
1193 my ($data, $av);
1194
1195 (aio_load $filename, $data) >= 0
1196 or return;
1197
1198 unless (aio_stat "$filename.pst") {
1199 (aio_load "$filename.pst", $av) >= 0
1200 or return;
1201
1202 my $st = eval { Coro::Storable::thaw $av };
1203 $av = $st->{objs};
1204 }
1205
1206 utf8::decode (my $decname = $filename);
1207 warn sprintf "loading %s (%d,%d)\n",
1208 $decname, length $data, scalar @{$av || []};
1209
1210 ($data, $av)
1211}
1212
1213=head2 COMMAND CALLBACKS
1214
1215=over 4
1216
1217=cut
1218
1219#############################################################################
1220# command handling &c
1221
1222=item cf::register_command $name => \&callback($ob,$args);
1223
1224Register a callback for execution when the client sends the user command
1225$name.
1226
1227=cut
1228
1229sub register_command {
1230 my ($name, $cb) = @_;
1231
1232 my $caller = caller;
1233 #warn "registering command '$name/$time' to '$caller'";
1234
1235 push @{ $COMMAND{$name} }, [$caller, $cb];
1236}
1237
1238=item cf::register_extcmd $name => \&callback($pl,$packet);
1239
1240Register a callback for execution when the client sends an (synchronous)
1241extcmd packet. Ext commands will be processed in the order they are
1242received by the server, like other user commands. The first argument is
1243the logged-in player. Ext commands can only be processed after a player
1244has logged in successfully.
1245
1246If the callback returns something, it is sent back as if reply was being
1247called.
1248
1249=item cf::register_exticmd $name => \&callback($ns,$packet);
1250
1251Register a callback for execution when the client sends an (asynchronous)
1252exticmd packet. Exti commands are processed by the server as soon as they
1253are received, i.e. out of order w.r.t. other commands. The first argument
1254is a client socket. Exti commands can be received anytime, even before
1255log-in.
1256
1257If the callback returns something, it is sent back as if reply was being
1258called.
1259
1260=cut
1261
1262sub register_extcmd {
1263 my ($name, $cb) = @_;
1264
1265 $EXTCMD{$name} = $cb;
1266}
1267
1268sub register_exticmd {
1269 my ($name, $cb) = @_;
1270
1271 $EXTICMD{$name} = $cb;
1272}
1273
1274use File::Glob ();
1275
1276cf::player->attach (
1277 on_command => sub {
1278 my ($pl, $name, $params) = @_;
1279
1280 my $cb = $COMMAND{$name}
1281 or return;
1282
1283 for my $cmd (@$cb) {
1284 $cmd->[1]->($pl->ob, $params);
1285 }
1286
1287 cf::override;
1288 },
1289 on_extcmd => sub {
1290 my ($pl, $buf) = @_;
1291
1292 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
1293
1294 if (ref $msg) {
1295 my ($type, $reply, @payload) =
1296 "ARRAY" eq ref $msg
1297 ? @$msg
1298 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1299
1300 my @reply;
1301
1302 if (my $cb = $EXTCMD{$type}) {
1303 @reply = $cb->($pl, @payload);
1304 }
1305
1306 $pl->ext_reply ($reply, @reply)
1307 if $reply;
1308
1309 } else {
1310 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1311 }
1312
1313 cf::override;
1314 },
1315);
1316
1317# "readahead" all extensions
1318sub cache_extensions {
1319 my $grp = IO::AIO::aio_group;
1320
1321 add $grp IO::AIO::aio_readdir $LIBDIR, sub {
1322 for (grep /\.ext$/, @{$_[0]}) {
1323 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
1324 }
1325 };
1326
1327 $grp
1328}
1329
1330sub load_extensions {
1331 cf::sync_job {
1332 my %todo;
1333
1334 for my $path (<$LIBDIR/*.ext>) {
1335 next unless -r $path;
1336
1337 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1338 my $base = $1;
1339 my $pkg = $1;
1340 $pkg =~ s/[^[:word:]]/_/g;
1341 $pkg = "ext::$pkg";
1342
1343 open my $fh, "<:utf8", $path
1344 or die "$path: $!";
1345
1346 my $source = do { local $/; <$fh> };
1347
1348 my %ext = (
1349 path => $path,
1350 base => $base,
1351 pkg => $pkg,
1352 );
1353
1354 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1355 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1356
1357 $ext{source} =
1358 "package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
1359 . "#line 1 \"$path\"\n{\n"
1360 . $source
1361 . "\n};\n1";
1362
1363 $todo{$base} = \%ext;
1364 }
1365
1366 my %done;
1367 while (%todo) {
1368 my $progress;
1369
1370 while (my ($k, $v) = each %todo) {
1371 for (split /,\s*/, $v->{meta}{depends}) {
1372 goto skip
1373 unless exists $done{$_};
1374 }
1375
1376 warn "... loading '$k' into '$v->{pkg}'\n";
1377
1378 unless (eval $v->{source}) {
1379 my $msg = $@ ? "$v->{path}: $@\n"
1380 : "$v->{base}: extension inactive.\n";
1381
1382 if (exists $v->{meta}{mandatory}) {
1383 warn $msg;
1384 cf::cleanup "mandatory extension failed to load, exiting.";
1385 }
1386
1387 warn $msg;
1388 }
1389
1390 $done{$k} = delete $todo{$k};
1391 push @EXTS, $v->{pkg};
1392 $progress = 1;
1393 }
1394
1395 skip:
1396 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1397 unless $progress;
1398 }
1399 };
1400}
1401
1402#############################################################################
1403
1404=back
1405
1406=head2 CORE EXTENSIONS
1407
1408Functions and methods that extend core deliantra objects.
1409
1410=cut
1411
1412package cf::player;
1413
1414use Coro::AIO;
1415
1416=head3 cf::player
1417
1418=over 4
1419
1420=item cf::player::num_playing
1421
1422Returns the official number of playing players, as per the Crossfire metaserver rules.
1423
1424=cut
1425
1426sub num_playing {
1427 scalar grep
1428 $_->ob->map
1429 && !$_->hidden
1430 && !$_->ob->flag (cf::FLAG_WIZ),
1431 cf::player::list
1432}
1433
1434=item cf::player::find $login
1435
1436Returns the given player object, loading it if necessary (might block).
1437
1438=cut
1439
1440sub playerdir($) {
1441 "$PLAYERDIR/"
1442 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1443}
1444
1445sub path($) {
1446 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1447
1448 (playerdir $login) . "/playerdata"
1449}
1450
1451sub find_active($) {
1452 $cf::PLAYER{$_[0]}
1453 and $cf::PLAYER{$_[0]}->active
1454 and $cf::PLAYER{$_[0]}
1455}
1456
1457sub exists($) {
1458 my ($login) = @_;
1459
1460 $cf::PLAYER{$login}
1461 or !aio_stat path $login
1462}
1463
1464sub find($) {
1465 return $cf::PLAYER{$_[0]} || do {
1466 my $login = $_[0];
1467
1468 my $guard = cf::lock_acquire "user_find:$login";
1469
1470 $cf::PLAYER{$_[0]} || do {
1471 # rename old playerfiles to new ones
1472 #TODO: remove when no longer required
1473 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1474 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1475 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1476 aio_unlink +(playerdir $login) . "/$login.pl";
1477
1478 my $f = new_from_file cf::object::thawer path $login
1479 or return;
1480
1481 my $pl = cf::player::load_pl $f
1482 or return;
1483
1484 local $cf::PLAYER_LOADING{$login} = $pl;
1485 $f->resolve_delayed_derefs;
1486 $cf::PLAYER{$login} = $pl
1487 }
1488 }
1489}
1490
1491sub save($) {
1492 my ($pl) = @_;
1493
1494 return if $pl->{deny_save};
1495
1496 my $path = path $pl;
1497 my $guard = cf::lock_acquire "user_save:$path";
1498
1499 return if $pl->{deny_save};
1500
1501 aio_mkdir playerdir $pl, 0770;
1502 $pl->{last_save} = $cf::RUNTIME;
1503
1504 cf::get_slot 0.01;
1505
1506 $pl->save_pl ($path);
1507 cf::cede_to_tick;
1508}
1509
1510sub new($) {
1511 my ($login) = @_;
1512
1513 my $self = create;
1514
1515 $self->ob->name ($login);
1516 $self->{deny_save} = 1;
1517
1518 $cf::PLAYER{$login} = $self;
1519
1520 $self
1521}
1522
1523=item $player->send_msg ($channel, $msg, $color, [extra...])
1524
1525=cut
1526
1527sub send_msg {
1528 my $ns = shift->ns
1529 or return;
1530 $ns->send_msg (@_);
1531}
1532
1533=item $pl->quit_character
1534
1535Nukes the player without looking back. If logged in, the connection will
1536be destroyed. May block for a long time.
1537
1538=cut
1539
1540sub quit_character {
1541 my ($pl) = @_;
1542
1543 my $name = $pl->ob->name;
1544
1545 $pl->{deny_save} = 1;
1546 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1547
1548 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1549 $pl->deactivate;
1550 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1551 $pl->ob->check_score;
1552 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1553 $pl->ns->destroy if $pl->ns;
1554
1555 my $path = playerdir $pl;
1556 my $temp = "$path~$cf::RUNTIME~deleting~";
1557 aio_rename $path, $temp;
1558 delete $cf::PLAYER{$pl->ob->name};
1559 $pl->destroy;
1560
1561 my $prefix = qr<^~\Q$name\E/>;
1562
1563 # nuke player maps
1564 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1565
1566 IO::AIO::aio_rmtree $temp;
1567}
1568
1569=item $pl->kick
1570
1571Kicks a player out of the game. This destroys the connection.
1572
1573=cut
1574
1575sub kick {
1576 my ($pl, $kicker) = @_;
1577
1578 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1579 $pl->killer ("kicked");
1580 $pl->ns->destroy;
1581}
1582
1583=item cf::player::list_logins
1584
1585Returns am arrayref of all valid playernames in the system, can take a
1586while and may block, so not sync_job-capable, ever.
1587
1588=cut
1589
1590sub list_logins {
1591 my $dirs = aio_readdir $PLAYERDIR
1592 or return [];
1593
1594 my @logins;
1595
1596 for my $login (@$dirs) {
1597 my $path = path $login;
1598
1599 # a .pst is a dead give-away for a valid player
1600 # if no pst file found, open and chekc for blocked users
1601 if (aio_stat "$path.pst") {
1602 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1603 aio_read $fh, 0, 512, my $buf, 0 or next;
1604 $buf !~ /^password -------------$/m or next; # official not-valid tag
1605 }
1606
1607 utf8::decode $login;
1608 push @logins, $login;
1609 }
1610
1611 \@logins
1612}
1613
1614=item $player->maps
1615
1616Returns an arrayref of map paths that are private for this
1617player. May block.
1618
1619=cut
1620
1621sub maps($) {
1622 my ($pl) = @_;
1623
1624 $pl = ref $pl ? $pl->ob->name : $pl;
1625
1626 my $files = aio_readdir playerdir $pl
1627 or return;
1628
1629 my @paths;
1630
1631 for (@$files) {
1632 utf8::decode $_;
1633 next if /\.(?:pl|pst)$/;
1634 next unless /^$PATH_SEP/o;
1635
1636 push @paths, cf::map::normalise "~$pl/$_";
1637 }
1638
1639 \@paths
1640}
1641
1642=item $protocol_xml = $player->expand_cfpod ($cfpod)
1643
1644Expand deliantra pod fragments into protocol xml.
1645
1646=item $player->ext_reply ($msgid, @msg)
1647
1648Sends an ext reply to the player.
1649
1650=cut
1651
1652sub ext_reply($$@) {
1653 my ($self, $id, @msg) = @_;
1654
1655 $self->ns->ext_reply ($id, @msg)
1656}
1657
1658=item $player->ext_msg ($type, @msg)
1659
1660Sends an ext event to the client.
1661
1662=cut
1663
1664sub ext_msg($$@) {
1665 my ($self, $type, @msg) = @_;
1666
1667 $self->ns->ext_msg ($type, @msg);
1668}
1669
1670=head3 cf::region
1671
1672=over 4
1673
1674=cut
1675
1676package cf::region;
1677
1678=item cf::region::find_by_path $path
1679
1680Tries to decuce the likely region for a map knowing only its path.
1681
1682=cut
1683
1684sub find_by_path($) {
1685 my ($path) = @_;
1686
1687 my ($match, $specificity);
1688
1689 for my $region (list) {
1690 if ($region->{match} && $path =~ $region->{match}) {
1691 ($match, $specificity) = ($region, $region->specificity)
1692 if $region->specificity > $specificity;
1693 }
1694 }
1695
1696 $match
1697}
1698
1699=back
1700
1701=head3 cf::map
1702
1703=over 4
1704
1705=cut
1706
1707package cf::map;
1708
1709use Fcntl;
1710use Coro::AIO;
1711
1712use overload
1713 '""' => \&as_string,
1714 fallback => 1;
1715
1716our $MAX_RESET = 3600;
1717our $DEFAULT_RESET = 3000;
1718
1719sub generate_random_map {
1720 my ($self, $rmp) = @_;
1721
1722 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1723
1724 # mit "rum" bekleckern, nicht
1725 $self->_create_random_map (
1726 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1727 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1728 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1729 $rmp->{exit_on_final_map},
1730 $rmp->{xsize}, $rmp->{ysize},
1731 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1732 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1733 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1734 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1735 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1736 (cf::region::find $rmp->{region}), $rmp->{custom}
1737 )
1738}
1739
1740=item cf::map->register ($regex, $prio)
1741
1742Register a handler for the map path matching the given regex at the
1743givne priority (higher is better, built-in handlers have priority 0, the
1744default).
1745
1746=cut
1747
1748sub register {
1749 my (undef, $regex, $prio) = @_;
1750 my $pkg = caller;
1751
1752 no strict;
1753 push @{"$pkg\::ISA"}, __PACKAGE__;
1754
1755 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1756}
1757
1758# also paths starting with '/'
1759$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1760
1761sub thawer_merge {
1762 my ($self, $merge) = @_;
1763
1764 # we have to keep some variables in memory intact
1765 local $self->{path};
1766 local $self->{load_path};
1767
1768 $self->SUPER::thawer_merge ($merge);
1769}
1770
1771sub normalise {
1772 my ($path, $base) = @_;
1773
1774 $path = "$path"; # make sure its a string
1775
1776 $path =~ s/\.map$//;
1777
1778 # map plan:
1779 #
1780 # /! non-realised random map exit (special hack!)
1781 # {... are special paths that are not being touched
1782 # ?xxx/... are special absolute paths
1783 # ?random/... random maps
1784 # /... normal maps
1785 # ~user/... per-player map of a specific user
1786
1787 $path =~ s/$PATH_SEP/\//go;
1788
1789 # treat it as relative path if it starts with
1790 # something that looks reasonable
1791 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1792 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1793
1794 $base =~ s{[^/]+/?$}{};
1795 $path = "$base/$path";
1796 }
1797
1798 for ($path) {
1799 redo if s{//}{/};
1800 redo if s{/\.?/}{/};
1801 redo if s{/[^/]+/\.\./}{/};
1802 }
1803
1804 $path
1805}
1806
1807sub new_from_path {
1808 my (undef, $path, $base) = @_;
1809
1810 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1811
1812 $path = normalise $path, $base;
1813
1814 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1815 if ($path =~ $EXT_MAP{$pkg}[1]) {
1816 my $self = bless cf::map::new, $pkg;
1817 $self->{path} = $path; $self->path ($path);
1818 $self->init; # pass $1 etc.
1819 return $self;
1820 }
1821 }
1822
1823 Carp::cluck "unable to resolve path '$path' (base '$base').";
1824 ()
1825}
1826
1827sub init {
1828 my ($self) = @_;
1829
1830 $self
1831}
1832
1833sub as_string {
1834 my ($self) = @_;
1835
1836 "$self->{path}"
1837}
1838
1839# the displayed name, this is a one way mapping
1840sub visible_name {
1841 &as_string
1842}
1843
1844# the original (read-only) location
1845sub load_path {
1846 my ($self) = @_;
1847
1848 "$MAPDIR/$self->{path}.map"
1849}
1850
1851# the temporary/swap location
1852sub save_path {
1853 my ($self) = @_;
1854
1855 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1856 "$TMPDIR/$path.map"
1857}
1858
1859# the unique path, undef == no special unique path
1860sub uniq_path {
1861 my ($self) = @_;
1862
1863 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1864 "$UNIQUEDIR/$path"
1865}
1866
1867sub decay_objects {
1868 my ($self) = @_;
1869
1870 return if $self->{deny_reset};
1871
1872 $self->do_decay_objects;
1873}
1874
1875sub unlink_save {
1876 my ($self) = @_;
1877
1878 utf8::encode (my $save = $self->save_path);
1879 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1880 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1881}
1882
1883sub load_header_from($) {
1884 my ($self, $path) = @_;
1885
1886 utf8::encode $path;
1887 my $f = new_from_file cf::object::thawer $path
1888 or return;
1889
1890 $self->_load_header ($f)
1891 or return;
1892
1893 local $MAP_LOADING{$self->{path}} = $self;
1894 $f->resolve_delayed_derefs;
1895
1896 $self->{load_path} = $path;
1897
1898 1
1899}
1900
1901sub load_header_orig {
1902 my ($self) = @_;
1903
1904 $self->load_header_from ($self->load_path)
1905}
1906
1907sub load_header_temp {
1908 my ($self) = @_;
1909
1910 $self->load_header_from ($self->save_path)
1911}
1912
1913sub prepare_temp {
1914 my ($self) = @_;
1915
1916 $self->last_access ((delete $self->{last_access})
1917 || $cf::RUNTIME); #d#
1918 # safety
1919 $self->{instantiate_time} = $cf::RUNTIME
1920 if $self->{instantiate_time} > $cf::RUNTIME;
1921}
1922
1923sub prepare_orig {
1924 my ($self) = @_;
1925
1926 $self->{load_original} = 1;
1927 $self->{instantiate_time} = $cf::RUNTIME;
1928 $self->last_access ($cf::RUNTIME);
1929 $self->instantiate;
1930}
1931
1932sub load_header {
1933 my ($self) = @_;
1934
1935 if ($self->load_header_temp) {
1936 $self->prepare_temp;
1937 } else {
1938 $self->load_header_orig
1939 or return;
1940 $self->prepare_orig;
1941 }
1942
1943 $self->{deny_reset} = 1
1944 if $self->no_reset;
1945
1946 $self->default_region (cf::region::find_by_path $self->{path})
1947 unless $self->default_region;
1948
1949 1
1950}
1951
1952sub find;
1953sub find {
1954 my ($path, $origin) = @_;
1955
1956 $path = normalise $path, $origin && $origin->path;
1957
1958 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1959 my $guard2 = cf::lock_acquire "map_find:$path";
1960
1961 $cf::MAP{$path} || do {
1962 my $map = new_from_path cf::map $path
1963 or return;
1964
1965 $map->{last_save} = $cf::RUNTIME;
1966
1967 $map->load_header
1968 or return;
1969
1970 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1971 # doing this can freeze the server in a sync job, obviously
1972 #$cf::WAIT_FOR_TICK->wait;
1973 undef $guard2;
1974 undef $guard1;
1975 $map->reset;
1976 return find $path;
1977 }
1978
1979 $cf::MAP{$path} = $map
1980 }
1981}
1982
1983sub pre_load { }
1984sub post_load { }
1985
1986sub load {
1987 my ($self) = @_;
1988
1989 local $self->{deny_reset} = 1; # loading can take a long time
1990
1991 my $path = $self->{path};
1992
1993 {
1994 my $guard = cf::lock_acquire "map_data:$path";
1995
1996 return unless $self->valid;
1997 return unless $self->in_memory == cf::MAP_SWAPPED;
1998
1999 $self->in_memory (cf::MAP_LOADING);
2000
2001 $self->alloc;
2002
2003 $self->pre_load;
2004 cf::cede_to_tick;
2005
2006 my $f = new_from_file cf::object::thawer $self->{load_path};
2007 $f->skip_block;
2008 $self->_load_objects ($f)
2009 or return;
2010
2011 $self->post_load_original
2012 if delete $self->{load_original};
2013
2014 if (my $uniq = $self->uniq_path) {
2015 utf8::encode $uniq;
2016 unless (aio_stat $uniq) {
2017 if (my $f = new_from_file cf::object::thawer $uniq) {
2018 $self->clear_unique_items;
2019 $self->_load_objects ($f);
2020 $f->resolve_delayed_derefs;
2021 }
2022 }
2023 }
2024
2025 $f->resolve_delayed_derefs;
2026
2027 cf::cede_to_tick;
2028 # now do the right thing for maps
2029 $self->link_multipart_objects;
2030 $self->difficulty ($self->estimate_difficulty)
2031 unless $self->difficulty;
2032 cf::cede_to_tick;
2033
2034 unless ($self->{deny_activate}) {
2035 $self->decay_objects;
2036 $self->fix_auto_apply;
2037 $self->update_buttons;
2038 cf::cede_to_tick;
2039 $self->activate;
2040 }
2041
2042 $self->{last_save} = $cf::RUNTIME;
2043 $self->last_access ($cf::RUNTIME);
2044
2045 $self->in_memory (cf::MAP_ACTIVE);
2046 }
2047
2048 $self->post_load;
2049}
2050
2051sub customise_for {
2052 my ($self, $ob) = @_;
2053
2054 return find "~" . $ob->name . "/" . $self->{path}
2055 if $self->per_player;
2056
2057# return find "?party/" . $ob->name . "/" . $self->{path}
2058# if $self->per_party;
2059
2060 $self
2061}
2062
2063# find and load all maps in the 3x3 area around a map
2064sub load_neighbours {
2065 my ($map) = @_;
2066
2067 my @neigh; # diagonal neighbours
2068
2069 for (0 .. 3) {
2070 my $neigh = $map->tile_path ($_)
2071 or next;
2072 $neigh = find $neigh, $map
2073 or next;
2074 $neigh->load;
2075
2076 push @neigh,
2077 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2078 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2079 }
2080
2081 for (grep defined $_->[0], @neigh) {
2082 my ($path, $origin) = @$_;
2083 my $neigh = find $path, $origin
2084 or next;
2085 $neigh->load;
2086 }
2087}
2088
2089sub find_sync {
2090 my ($path, $origin) = @_;
2091
2092 cf::sync_job { find $path, $origin }
2093}
2094
2095sub do_load_sync {
2096 my ($map) = @_;
2097
2098 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2099 if $Coro::current == $Coro::main;
2100
2101 cf::sync_job { $map->load };
2102}
2103
2104our %MAP_PREFETCH;
2105our $MAP_PREFETCHER = undef;
2106
2107sub find_async {
2108 my ($path, $origin, $load) = @_;
2109
2110 $path = normalise $path, $origin && $origin->{path};
2111
2112 if (my $map = $cf::MAP{$path}) {
2113 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2114 }
2115
2116 $MAP_PREFETCH{$path} |= $load;
2117
2118 $MAP_PREFETCHER ||= cf::async {
2119 $Coro::current->{desc} = "map prefetcher";
2120
2121 while (%MAP_PREFETCH) {
2122 while (my ($k, $v) = each %MAP_PREFETCH) {
2123 if (my $map = find $k) {
2124 $map->load if $v;
2125 }
2126
2127 delete $MAP_PREFETCH{$k};
2128 }
2129 }
2130 undef $MAP_PREFETCHER;
2131 };
2132 $MAP_PREFETCHER->prio (6);
2133
2134 ()
2135}
2136
2137sub save {
2138 my ($self) = @_;
2139
2140 my $lock = cf::lock_acquire "map_data:$self->{path}";
2141
2142 $self->{last_save} = $cf::RUNTIME;
2143
2144 return unless $self->dirty;
2145
2146 my $save = $self->save_path; utf8::encode $save;
2147 my $uniq = $self->uniq_path; utf8::encode $uniq;
2148
2149 $self->{load_path} = $save;
2150
2151 return if $self->{deny_save};
2152
2153 local $self->{last_access} = $self->last_access;#d#
2154
2155 cf::async {
2156 $Coro::current->{desc} = "map player save";
2157 $_->contr->save for $self->players;
2158 };
2159
2160 cf::get_slot 0.02;
2161
2162 if ($uniq) {
2163 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2164 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2165 } else {
2166 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
2167 }
2168}
2169
2170sub swap_out {
2171 my ($self) = @_;
2172
2173 # save first because save cedes
2174 $self->save;
2175
2176 my $lock = cf::lock_acquire "map_data:$self->{path}";
2177
2178 return if $self->players;
2179 return if $self->in_memory != cf::MAP_ACTIVE;
2180 return if $self->{deny_save};
2181
2182 $self->in_memory (cf::MAP_SWAPPED);
2183
2184 $self->deactivate;
2185 $_->clear_links_to ($self) for values %cf::MAP;
2186 $self->clear;
2187}
2188
2189sub reset_at {
2190 my ($self) = @_;
2191
2192 # TODO: safety, remove and allow resettable per-player maps
2193 return 1e99 if $self->{deny_reset};
2194
2195 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2196 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2197
2198 $time + $to
2199}
2200
2201sub should_reset {
2202 my ($self) = @_;
2203
2204 $self->reset_at <= $cf::RUNTIME
2205}
2206
2207sub reset {
2208 my ($self) = @_;
2209
2210 my $lock = cf::lock_acquire "map_data:$self->{path}";
2211
2212 return if $self->players;
2213
2214 warn "resetting map ", $self->path;
2215
2216 $self->in_memory (cf::MAP_SWAPPED);
2217
2218 # need to save uniques path
2219 unless ($self->{deny_save}) {
2220 my $uniq = $self->uniq_path; utf8::encode $uniq;
2221
2222 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2223 if $uniq;
2224 }
2225
2226 delete $cf::MAP{$self->path};
2227
2228 $self->deactivate;
2229 $_->clear_links_to ($self) for values %cf::MAP;
2230 $self->clear;
2231
2232 $self->unlink_save;
2233 $self->destroy;
2234}
2235
2236my $nuke_counter = "aaaa";
2237
2238sub nuke {
2239 my ($self) = @_;
2240
2241 {
2242 my $lock = cf::lock_acquire "map_data:$self->{path}";
2243
2244 delete $cf::MAP{$self->path};
2245
2246 $self->unlink_save;
2247
2248 bless $self, "cf::map";
2249 delete $self->{deny_reset};
2250 $self->{deny_save} = 1;
2251 $self->reset_timeout (1);
2252 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2253
2254 $cf::MAP{$self->path} = $self;
2255 }
2256
2257 $self->reset; # polite request, might not happen
2258}
2259
2260=item $maps = cf::map::tmp_maps
2261
2262Returns an arrayref with all map paths of currently instantiated and saved
2263maps. May block.
2264
2265=cut
2266
2267sub tmp_maps() {
2268 [
2269 map {
2270 utf8::decode $_;
2271 /\.map$/
2272 ? normalise $_
2273 : ()
2274 } @{ aio_readdir $TMPDIR or [] }
2275 ]
2276}
2277
2278=item $maps = cf::map::random_maps
2279
2280Returns an arrayref with all map paths of currently instantiated and saved
2281random maps. May block.
2282
2283=cut
2284
2285sub random_maps() {
2286 [
2287 map {
2288 utf8::decode $_;
2289 /\.map$/
2290 ? normalise "?random/$_"
2291 : ()
2292 } @{ aio_readdir $RANDOMDIR or [] }
2293 ]
2294}
2295
2296=item cf::map::unique_maps
2297
2298Returns an arrayref of paths of all shared maps that have
2299instantiated unique items. May block.
2300
2301=cut
2302
2303sub unique_maps() {
2304 [
2305 map {
2306 utf8::decode $_;
2307 s/\.map$//; # TODO future compatibility hack
2308 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2309 ? ()
2310 : normalise $_
2311 } @{ aio_readdir $UNIQUEDIR or [] }
2312 ]
2313}
2314
2315=back
2316
2317=head3 cf::object
2318
2319=cut
2320
2321package cf::object;
2322
2323=over 4
2324
2325=item $ob->inv_recursive
2326
2327Returns the inventory of the object I<and> their inventories, recursively,
2328but I<not> the object itself.
2329
2330=cut
2331
2332sub inv_recursive_;
2333sub inv_recursive_ {
2334 map { $_, inv_recursive_ $_->inv } @_
2335}
2336
2337sub inv_recursive {
2338 inv_recursive_ inv $_[0]
2339}
2340
2341=item $ref = $ob->ref
2342
2343Creates and returns a persistent reference to an object that can be stored as a string.
2344
2345=item $ob = cf::object::deref ($refstring)
2346
2347returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2348even if the object actually exists. May block.
2349
2350=cut
2351
2352sub deref {
2353 my ($ref) = @_;
2354
2355 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2356 my ($uuid, $name) = ($1, $2);
2357 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2358 or return;
2359 $pl->ob->uuid eq $uuid
2360 or return;
2361
2362 $pl->ob
2363 } else {
2364 warn "$ref: cannot resolve object reference\n";
2365 undef
2366 }
2367}
2368
2369package cf;
2370
2371=back
2372
2373=head3 cf::object::player
2374
2375=over 4
2376
2377=item $player_object->reply ($npc, $msg[, $flags])
2378
2379Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
2380can be C<undef>. Does the right thing when the player is currently in a
2381dialogue with the given NPC character.
2382
2383=cut
2384
2385our $SAY_CHANNEL = {
2386 id => "say",
2387 title => "Map",
2388 reply => "say ",
2389 tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
2390};
2391
2392our $CHAT_CHANNEL = {
2393 id => "chat",
2394 title => "Chat",
2395 reply => "chat ",
2396 tooltip => "Player chat and shouts, global to the server.",
2397};
2398
2399# rough implementation of a future "reply" method that works
2400# with dialog boxes.
2401#TODO: the first argument must go, split into a $npc->reply_to ( method
2402sub cf::object::player::reply($$$;$) {
2403 my ($self, $npc, $msg, $flags) = @_;
2404
2405 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
2406
2407 if ($self->{record_replies}) {
2408 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2409
2410 } else {
2411 my $pl = $self->contr;
2412
2413 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2414 my $dialog = $pl->{npc_dialog};
2415 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2416
2417 } else {
2418 $msg = $npc->name . " says: $msg" if $npc;
2419 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2420 }
2421 }
2422}
2423
2424=item $object->send_msg ($channel, $msg, $color, [extra...])
2425
2426=cut
2427
2428sub cf::object::send_msg {
2429 my $pl = shift->contr
2430 or return;
2431 $pl->send_msg (@_);
2432}
2433
2434=item $player_object->may ("access")
2435
2436Returns wether the given player is authorized to access resource "access"
2437(e.g. "command_wizcast").
2438
2439=cut
2440
2441sub cf::object::player::may {
29 my ($prefix, $class) = @_; 2442 my ($self, $access) = @_;
30 2443
2444 $self->flag (cf::FLAG_WIZ) ||
2445 (ref $cf::CFG{"may_$access"}
2446 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
2447 : $cf::CFG{"may_$access"})
2448}
2449
2450=item $player_object->enter_link
2451
2452Freezes the player and moves him/her to a special map (C<{link}>).
2453
2454The player should be reasonably safe there for short amounts of time (e.g.
2455for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2456though, as the palyer cannot control the character while it is on the link
2457map.
2458
2459Will never block.
2460
2461=item $player_object->leave_link ($map, $x, $y)
2462
2463Moves the player out of the special C<{link}> map onto the specified
2464map. If the map is not valid (or omitted), the player will be moved back
2465to the location he/she was before the call to C<enter_link>, or, if that
2466fails, to the emergency map position.
2467
2468Might block.
2469
2470=cut
2471
2472sub link_map {
2473 unless ($LINK_MAP) {
2474 $LINK_MAP = cf::map::find "{link}"
2475 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2476 $LINK_MAP->load;
2477 }
2478
2479 $LINK_MAP
2480}
2481
2482sub cf::object::player::enter_link {
2483 my ($self) = @_;
2484
2485 $self->deactivate_recursive;
2486
2487 return if UNIVERSAL::isa $self->map, "ext::map_link";
2488
2489 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2490 if $self->map && $self->map->{path} ne "{link}";
2491
2492 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2493}
2494
2495sub cf::object::player::leave_link {
2496 my ($self, $map, $x, $y) = @_;
2497
2498 return unless $self->contr->active;
2499
2500 my $link_pos = delete $self->{_link_pos};
2501
2502 unless ($map) {
2503 # restore original map position
2504 ($map, $x, $y) = @{ $link_pos || [] };
2505 $map = cf::map::find $map;
2506
2507 unless ($map) {
2508 ($map, $x, $y) = @$EMERGENCY_POSITION;
2509 $map = cf::map::find $map
2510 or die "FATAL: cannot load emergency map\n";
2511 }
2512 }
2513
2514 ($x, $y) = (-1, -1)
2515 unless (defined $x) && (defined $y);
2516
2517 # use -1 or undef as default coordinates, not 0, 0
2518 ($x, $y) = ($map->enter_x, $map->enter_y)
2519 if $x <=0 && $y <= 0;
2520
2521 $map->load;
2522 $map->load_neighbours;
2523
2524 return unless $self->contr->active;
2525 $self->flag (cf::FLAG_DEBUG, 0);#d# temp
2526 $self->activate_recursive;
2527
2528 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2529 $self->enter_map ($map, $x, $y);
2530}
2531
2532=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2533
2534Moves the player to the given map-path and coordinates by first freezing
2535her, loading and preparing them map, calling the provided $check callback
2536that has to return the map if sucecssful, and then unfreezes the player on
2537the new (success) or old (failed) map position. In either case, $done will
2538be called at the end of this process.
2539
2540Note that $check will be called with a potentially non-loaded map, so if
2541it needs a loaded map it has to call C<< ->load >>.
2542
2543=cut
2544
2545our $GOTOGEN;
2546
2547sub cf::object::player::goto {
2548 my ($self, $path, $x, $y, $check, $done) = @_;
2549
2550 # do generation counting so two concurrent goto's will be executed in-order
2551 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2552
2553 $self->enter_link;
2554
2555 (async {
2556 $Coro::current->{desc} = "player::goto $path $x $y";
2557
2558 # *tag paths override both path and x|y
2559 if ($path =~ /^\*(.*)$/) {
2560 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2561 my $ob = $obs[rand @obs];
2562
2563 # see if we actually can go there
2564 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2565 $ob = $obs[rand @obs];
2566 } else {
2567 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2568 }
2569 # else put us there anyways for now #d#
2570
2571 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2572 } else {
2573 ($path, $x, $y) = (undef, undef, undef);
2574 }
2575 }
2576
2577 my $map = eval {
2578 my $map = defined $path ? cf::map::find $path : undef;
2579
2580 if ($map) {
2581 $map = $map->customise_for ($self);
2582 $map = $check->($map) if $check && $map;
2583 } else {
2584 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2585 }
2586
2587 $map
2588 };
2589
2590 if ($@) {
2591 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2592 LOG llevError | logBacktrace, Carp::longmess $@;
2593 }
2594
2595 if ($gen == $self->{_goto_generation}) {
2596 delete $self->{_goto_generation};
2597 $self->leave_link ($map, $x, $y);
2598 }
2599
2600 $done->() if $done;
2601 })->prio (1);
2602}
2603
2604=item $player_object->enter_exit ($exit_object)
2605
2606=cut
2607
2608sub parse_random_map_params {
2609 my ($spec) = @_;
2610
2611 my $rmp = { # defaults
2612 xsize => (cf::rndm 15, 40),
2613 ysize => (cf::rndm 15, 40),
2614 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2615 #layout => string,
2616 };
2617
2618 for (split /\n/, $spec) {
2619 my ($k, $v) = split /\s+/, $_, 2;
2620
2621 $rmp->{lc $k} = $v if (length $k) && (length $v);
2622 }
2623
2624 $rmp
2625}
2626
2627sub prepare_random_map {
2628 my ($exit) = @_;
2629
2630 # all this does is basically replace the /! path by
2631 # a new random map path (?random/...) with a seed
2632 # that depends on the exit object
2633
2634 my $rmp = parse_random_map_params $exit->msg;
2635
2636 if ($exit->map) {
2637 $rmp->{region} = $exit->region->name;
2638 $rmp->{origin_map} = $exit->map->path;
2639 $rmp->{origin_x} = $exit->x;
2640 $rmp->{origin_y} = $exit->y;
2641
2642 $exit->map->touch;
2643 }
2644
2645 $rmp->{random_seed} ||= $exit->random_seed;
2646
2647 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2648 my $md5 = Digest::MD5::md5_hex $data;
2649 my $meta = "$RANDOMDIR/$md5.meta";
2650
2651 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2652 aio_write $fh, 0, (length $data), $data, 0;
2653 undef $fh;
2654 aio_rename "$meta~", $meta;
2655
2656 my $slaying = "?random/$md5";
2657
2658 if ($exit->valid) {
2659 $exit->slaying ("?random/$md5");
2660 $exit->msg (undef);
2661 }
2662 }
2663}
2664
2665sub cf::object::player::enter_exit {
2666 my ($self, $exit) = @_;
2667
2668 return unless $self->type == cf::PLAYER;
2669
2670 $self->enter_link;
2671
2672 (async {
2673 $Coro::current->{desc} = "enter_exit";
2674
2675 unless (eval {
2676 $self->deactivate_recursive; # just to be sure
2677
2678 # random map handling
2679 {
2680 my $guard = cf::lock_acquire "exit_prepare:$exit";
2681
2682 prepare_random_map $exit
2683 if $exit->slaying eq "/!";
2684 }
2685
2686 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2687 my $x = $exit->stats->hp;
2688 my $y = $exit->stats->sp;
2689
2690 $self->goto ($map, $x, $y);
2691
2692 # if exit is damned, update players death & WoR home-position
2693 $self->contr->savebed ($map, $x, $y)
2694 if $exit->flag (cf::FLAG_DAMNED);
2695
2696 1
2697 }) {
2698 $self->message ("Something went wrong deep within the deliantra server. "
2699 . "I'll try to bring you back to the map you were before. "
2700 . "Please report this to the dungeon master!",
2701 cf::NDI_UNIQUE | cf::NDI_RED);
2702
2703 warn "ERROR in enter_exit: $@";
2704 $self->leave_link;
2705 }
2706 })->prio (1);
2707}
2708
2709=head3 cf::client
2710
2711=over 4
2712
2713=item $client->send_drawinfo ($text, $flags)
2714
2715Sends a drawinfo packet to the client. Circumvents output buffering so
2716should not be used under normal circumstances.
2717
2718=cut
2719
2720sub cf::client::send_drawinfo {
2721 my ($self, $text, $flags) = @_;
2722
2723 utf8::encode $text;
2724 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2725}
2726
2727=item $client->send_msg ($channel, $msg, $color, [extra...])
2728
2729Send a drawinfo or msg packet to the client, formatting the msg for the
2730client if neccessary. C<$type> should be a string identifying the type of
2731the message, with C<log> being the default. If C<$color> is negative, suppress
2732the message unless the client supports the msg packet.
2733
2734=cut
2735
2736# non-persistent channels (usually the info channel)
2737our %CHANNEL = (
2738 "c/identify" => {
2739 id => "infobox",
2740 title => "Identify",
2741 reply => undef,
2742 tooltip => "Items recently identified",
2743 },
2744 "c/examine" => {
2745 id => "infobox",
2746 title => "Examine",
2747 reply => undef,
2748 tooltip => "Signs and other items you examined",
2749 },
2750 "c/book" => {
2751 id => "infobox",
2752 title => "Book",
2753 reply => undef,
2754 tooltip => "The contents of a note or book",
2755 },
2756 "c/lookat" => {
2757 id => "infobox",
2758 title => "Look",
2759 reply => undef,
2760 tooltip => "What you saw there",
2761 },
2762 "c/who" => {
2763 id => "infobox",
2764 title => "Players",
2765 reply => undef,
2766 tooltip => "Shows players who are currently online",
2767 },
2768 "c/body" => {
2769 id => "infobox",
2770 title => "Body Parts",
2771 reply => undef,
2772 tooltip => "Shows which body parts you posess and are available",
2773 },
2774 "c/statistics" => {
2775 id => "infobox",
2776 title => "Statistics",
2777 reply => undef,
2778 tooltip => "Shows your primary statistics",
2779 },
2780 "c/skills" => {
2781 id => "infobox",
2782 title => "Skills",
2783 reply => undef,
2784 tooltip => "Shows your experience per skill and item power",
2785 },
2786 "c/resistances" => {
2787 id => "infobox",
2788 title => "Resistances",
2789 reply => undef,
2790 tooltip => "Shows your resistances",
2791 },
2792 "c/pets" => {
2793 id => "infobox",
2794 title => "Pets",
2795 reply => undef,
2796 tooltip => "Shows information abotu your pets/a specific pet",
2797 },
2798 "c/uptime" => {
2799 id => "infobox",
2800 title => "Uptime",
2801 reply => undef,
2802 tooltip => "How long the server has been running since last restart",
2803 },
2804 "c/mapinfo" => {
2805 id => "infobox",
2806 title => "Map Info",
2807 reply => undef,
2808 tooltip => "Information related to the maps",
2809 },
2810 "c/party" => {
2811 id => "party",
2812 title => "Party",
2813 reply => "gsay ",
2814 tooltip => "Messages and chat related to your party",
2815 },
2816 "c/death" => {
2817 id => "death",
2818 title => "Death",
2819 reply => undef,
2820 tooltip => "Reason for and more info about your most recent death",
2821 },
2822 "c/say" => $SAY_CHANNEL,
2823 "c/chat" => $CHAT_CHANNEL,
2824);
2825
2826sub cf::client::send_msg {
2827 my ($self, $channel, $msg, $color, @extra) = @_;
2828
2829 $msg = $self->pl->expand_cfpod ($msg)
2830 unless $color & cf::NDI_VERBATIM;
2831
2832 $color &= cf::NDI_CLIENT_MASK; # just in case...
2833
2834 # check predefined channels, for the benefit of C
2835 if ($CHANNEL{$channel}) {
2836 $channel = $CHANNEL{$channel};
2837
2838 $self->ext_msg (channel_info => $channel);
2839 $channel = $channel->{id};
2840
2841 } elsif (ref $channel) {
2842 # send meta info to client, if not yet sent
2843 unless (exists $self->{channel}{$channel->{id}}) {
2844 $self->{channel}{$channel->{id}} = $channel;
2845 $self->ext_msg (channel_info => $channel);
2846 }
2847
2848 $channel = $channel->{id};
2849 }
2850
2851 return unless @extra || length $msg;
2852
2853 # default colour, mask it out
2854 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2855 if $color & cf::NDI_DEF;
2856
2857 my $pkt = "msg "
2858 . $self->{json_coder}->encode (
2859 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2860 );
2861
2862 # try lzf for large packets
2863 $pkt = "lzf " . Compress::LZF::compress $pkt
2864 if 1024 <= length $pkt and $self->{can_lzf};
2865
2866 # split very large packets
2867 if (8192 < length $pkt and $self->{can_lzf}) {
2868 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2869 $pkt = "frag";
2870 }
2871
2872 $self->send_packet ($pkt);
2873}
2874
2875=item $client->ext_msg ($type, @msg)
2876
2877Sends an ext event to the client.
2878
2879=cut
2880
2881sub cf::client::ext_msg($$@) {
2882 my ($self, $type, @msg) = @_;
2883
2884 if ($self->extcmd == 2) {
2885 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2886 } elsif ($self->extcmd == 1) { # TODO: remove
2887 push @msg, msgtype => "event_$type";
2888 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2889 }
2890}
2891
2892=item $client->ext_reply ($msgid, @msg)
2893
2894Sends an ext reply to the client.
2895
2896=cut
2897
2898sub cf::client::ext_reply($$@) {
2899 my ($self, $id, @msg) = @_;
2900
2901 if ($self->extcmd == 2) {
2902 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2903 } elsif ($self->extcmd == 1) {
2904 #TODO: version 1, remove
2905 unshift @msg, msgtype => "reply", msgid => $id;
2906 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2907 }
2908}
2909
2910=item $success = $client->query ($flags, "text", \&cb)
2911
2912Queues a query to the client, calling the given callback with
2913the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2914C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2915
2916Queries can fail, so check the return code. Or don't, as queries will
2917become reliable at some point in the future.
2918
2919=cut
2920
2921sub cf::client::query {
2922 my ($self, $flags, $text, $cb) = @_;
2923
2924 return unless $self->state == ST_PLAYING
2925 || $self->state == ST_SETUP
2926 || $self->state == ST_CUSTOM;
2927
2928 $self->state (ST_CUSTOM);
2929
2930 utf8::encode $text;
2931 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2932
2933 $self->send_packet ($self->{query_queue}[0][0])
2934 if @{ $self->{query_queue} } == 1;
2935
2936 1
2937}
2938
2939cf::client->attach (
2940 on_connect => sub {
2941 my ($ns) = @_;
2942
2943 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2944 },
2945 on_reply => sub {
2946 my ($ns, $msg) = @_;
2947
2948 # this weird shuffling is so that direct followup queries
2949 # get handled first
2950 my $queue = delete $ns->{query_queue}
2951 or return; # be conservative, not sure how that can happen, but we saw a crash here
2952
2953 (shift @$queue)->[1]->($msg);
2954 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2955
2956 push @{ $ns->{query_queue} }, @$queue;
2957
2958 if (@{ $ns->{query_queue} } == @$queue) {
2959 if (@$queue) {
2960 $ns->send_packet ($ns->{query_queue}[0][0]);
2961 } else {
2962 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2963 }
2964 }
2965 },
2966 on_exticmd => sub {
2967 my ($ns, $buf) = @_;
2968
2969 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2970
2971 if (ref $msg) {
2972 my ($type, $reply, @payload) =
2973 "ARRAY" eq ref $msg
2974 ? @$msg
2975 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2976
2977 my @reply;
2978
2979 if (my $cb = $EXTICMD{$type}) {
2980 @reply = $cb->($ns, @payload);
2981 }
2982
2983 $ns->ext_reply ($reply, @reply)
2984 if $reply;
2985
2986 } else {
2987 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2988 }
2989
2990 cf::override;
2991 },
2992);
2993
2994=item $client->async (\&cb)
2995
2996Create a new coroutine, running the specified callback. The coroutine will
2997be automatically cancelled when the client gets destroyed (e.g. on logout,
2998or loss of connection).
2999
3000=cut
3001
3002sub cf::client::async {
3003 my ($self, $cb) = @_;
3004
3005 my $coro = &Coro::async ($cb);
3006
3007 $coro->on_destroy (sub {
3008 delete $self->{_coro}{$coro+0};
3009 });
3010
3011 $self->{_coro}{$coro+0} = $coro;
3012
3013 $coro
3014}
3015
3016cf::client->attach (
3017 on_destroy => sub {
3018 my ($ns) = @_;
3019
3020 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
3021 },
3022);
3023
3024=back
3025
3026
3027=head2 SAFE SCRIPTING
3028
3029Functions that provide a safe environment to compile and execute
3030snippets of perl code without them endangering the safety of the server
3031itself. Looping constructs, I/O operators and other built-in functionality
3032is not available in the safe scripting environment, and the number of
3033functions and methods that can be called is greatly reduced.
3034
3035=cut
3036
3037our $safe = new Safe "safe";
3038our $safe_hole = new Safe::Hole;
3039
3040$SIG{FPE} = 'IGNORE';
3041
3042$safe->permit_only (Opcode::opset qw(
3043 :base_core :base_mem :base_orig :base_math
3044 grepstart grepwhile mapstart mapwhile
3045 sort time
3046));
3047
3048# here we export the classes and methods available to script code
3049
3050=pod
3051
3052The following functions and methods are available within a safe environment:
3053
3054 cf::object
3055 contr pay_amount pay_player map x y force_find force_add destroy
3056 insert remove name archname title slaying race decrease split
3057
3058 cf::object::player
3059 player
3060
3061 cf::player
3062 peaceful
3063
3064 cf::map
3065 trigger
3066
3067=cut
3068
3069for (
3070 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3071 insert remove inv nrof name archname title slaying race
3072 decrease split destroy change_exp)],
3073 ["cf::object::player" => qw(player)],
3074 ["cf::player" => qw(peaceful)],
3075 ["cf::map" => qw(trigger)],
3076) {
31 no strict 'refs'; 3077 no strict 'refs';
3078 my ($pkg, @funs) = @$_;
3079 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
3080 for @funs;
3081}
32 3082
33 for my $prop (keys %PROP_TYPE) { 3083=over 4
34 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
35 my $sub = lc $1;
36 3084
37 my $type = $PROP_TYPE{$prop}; 3085=item @retval = safe_eval $code, [var => value, ...]
38 my $idx = $PROP_IDX {$prop};
39 3086
40 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { 3087Compiled and executes the given perl code snippet. additional var/value
41 $_[0]->get_property ($type, $idx) 3088pairs result in temporary local (my) scalar variables of the given name
3089that are available in the code snippet. Example:
3090
3091 my $five = safe_eval '$first + $second', first => 1, second => 4;
3092
3093=cut
3094
3095sub safe_eval($;@) {
3096 my ($code, %vars) = @_;
3097
3098 my $qcode = $code;
3099 $qcode =~ s/"/‟/g; # not allowed in #line filenames
3100 $qcode =~ s/\n/\\n/g;
3101
3102 local $_;
3103 local @safe::cf::_safe_eval_args = values %vars;
3104
3105 my $eval =
3106 "do {\n"
3107 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
3108 . "#line 0 \"{$qcode}\"\n"
3109 . $code
3110 . "\n}"
3111 ;
3112
3113 sub_generation_inc;
3114 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
3115 sub_generation_inc;
3116
3117 if ($@) {
3118 warn "$@";
3119 warn "while executing safe code '$code'\n";
3120 warn "with arguments " . (join " ", %vars) . "\n";
3121 }
3122
3123 wantarray ? @res : $res[0]
3124}
3125
3126=item cf::register_script_function $function => $cb
3127
3128Register a function that can be called from within map/npc scripts. The
3129function should be reasonably secure and should be put into a package name
3130like the extension.
3131
3132Example: register a function that gets called whenever a map script calls
3133C<rent::overview>, as used by the C<rent> extension.
3134
3135 cf::register_script_function "rent::overview" => sub {
3136 ...
3137 };
3138
3139=cut
3140
3141sub register_script_function {
3142 my ($fun, $cb) = @_;
3143
3144 no strict 'refs';
3145 *{"safe::$fun"} = $safe_hole->wrap ($cb);
3146}
3147
3148=back
3149
3150=cut
3151
3152#############################################################################
3153# the server's init and main functions
3154
3155sub load_facedata($) {
3156 my ($path) = @_;
3157
3158 # HACK to clear player env face cache, we need some signal framework
3159 # for this (global event?)
3160 %ext::player_env::MUSIC_FACE_CACHE = ();
3161
3162 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3163
3164 warn "loading facedata from $path\n";
3165
3166 my $facedata;
3167 0 < aio_load $path, $facedata
3168 or die "$path: $!";
3169
3170 $facedata = Coro::Storable::thaw $facedata;
3171
3172 $facedata->{version} == 2
3173 or cf::cleanup "$path: version mismatch, cannot proceed.";
3174
3175 # patch in the exptable
3176 $facedata->{resource}{"res/exp_table"} = {
3177 type => FT_RSRC,
3178 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3179 };
3180 cf::cede_to_tick;
3181
3182 {
3183 my $faces = $facedata->{faceinfo};
3184
3185 while (my ($face, $info) = each %$faces) {
3186 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3187
3188 cf::face::set_visibility $idx, $info->{visibility};
3189 cf::face::set_magicmap $idx, $info->{magicmap};
3190 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3191 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
3192
3193 cf::cede_to_tick;
42 }; 3194 }
43 3195
44 *{"$class\::set_$sub"} = sub { 3196 while (my ($face, $info) = each %$faces) {
45 $_[0]->set_property ($type, $idx, $_[1]); 3197 next unless $info->{smooth};
3198
3199 my $idx = cf::face::find $face
3200 or next;
3201
3202 if (my $smooth = cf::face::find $info->{smooth}) {
3203 cf::face::set_smooth $idx, $smooth;
3204 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3205 } else {
3206 warn "smooth face '$info->{smooth}' not found for face '$face'";
3207 }
3208
3209 cf::cede_to_tick;
46 }; 3210 }
3211 }
3212
47 } 3213 {
48} 3214 my $anims = $facedata->{animinfo};
49 3215
50# auto-generate most of the API 3216 while (my ($anim, $info) = each %$anims) {
3217 cf::anim::set $anim, $info->{frames}, $info->{facings};
3218 cf::cede_to_tick;
3219 }
51 3220
52prop_gen OBJECT_PROP => "cf::object"; 3221 cf::anim::invalidate_all; # d'oh
53# CFAPI_OBJECT_ANIMATION? 3222 }
54prop_gen PLAYER_PROP => "cf::object::player";
55 3223
56prop_gen MAP_PROP => "cf::map"; 3224 {
57prop_gen ARCH_PROP => "cf::arch"; 3225 # TODO: for gcfclient pleasure, we should give resources
3226 # that gcfclient doesn't grok a >10000 face index.
3227 my $res = $facedata->{resource};
58 3228
59# guessed hierarchies 3229 while (my ($name, $info) = each %$res) {
3230 if (defined $info->{type}) {
3231 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3232 my $data;
60 3233
61@cf::object::player::ISA = 'cf::object'; 3234 if ($info->{type} & 1) {
62@cf::object::map::ISA = 'cf::object'; 3235 # prepend meta info
63 3236
64my %ext_pkg; 3237 my $meta = $enc->encode ({
65my @exts; 3238 name => $name,
66my @hook; 3239 %{ $info->{meta} || {} },
67my %command; 3240 });
68 3241
69sub inject_event { 3242 $data = pack "(w/a*)*", $meta, $info->{data};
3243 } else {
3244 $data = $info->{data};
3245 }
3246
3247 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3248 cf::face::set_type $idx, $info->{type};
3249 } else {
3250 $RESOURCE{$name} = $info;
3251 }
3252
3253 cf::cede_to_tick;
3254 }
3255 }
3256
3257 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3258
3259 1
3260}
3261
3262cf::global->attach (on_resource_update => sub {
3263 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3264 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3265
3266 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3267 my $sound = $soundconf->{compat}[$_]
3268 or next;
3269
3270 my $face = cf::face::find "sound/$sound->[1]";
3271 cf::sound::set $sound->[0] => $face;
3272 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3273 }
3274
3275 while (my ($k, $v) = each %{$soundconf->{event}}) {
3276 my $face = cf::face::find "sound/$v";
3277 cf::sound::set $k => $face;
3278 }
3279 }
3280});
3281
3282register_exticmd fx_want => sub {
70 my ($data) = @_; 3283 my ($ns, $want) = @_;
71 3284
72 my $cb = $hook[$data->{event_code}]{$data->{extension}} 3285 while (my ($k, $v) = each %$want) {
3286 $ns->fx_want ($k, $v);
3287 }
3288};
3289
3290sub load_resource_file($) {
3291 my $guard = lock_acquire "load_resource_file";
3292
3293 my $status = load_resource_file_ $_[0];
3294 get_slot 0.1, 100;
3295 cf::arch::commit_load;
3296
3297 $status
3298}
3299
3300sub reload_regions {
3301 # HACK to clear player env face cache, we need some signal framework
3302 # for this (global event?)
3303 %ext::player_env::MUSIC_FACE_CACHE = ();
3304
3305 load_resource_file "$MAPDIR/regions"
3306 or die "unable to load regions file\n";
3307
3308 for (cf::region::list) {
3309 $_->{match} = qr/$_->{match}/
3310 if exists $_->{match};
3311 }
3312}
3313
3314sub reload_facedata {
3315 load_facedata "$DATADIR/facedata"
3316 or die "unable to load facedata\n";
3317}
3318
3319sub reload_archetypes {
3320 load_resource_file "$DATADIR/archetypes"
3321 or die "unable to load archetypes\n";
3322}
3323
3324sub reload_treasures {
3325 load_resource_file "$DATADIR/treasures"
3326 or die "unable to load treasurelists\n";
3327}
3328
3329sub reload_resources {
3330 warn "reloading resource files...\n";
3331
3332 reload_facedata;
3333 reload_archetypes;
3334 reload_regions;
3335 reload_treasures;
3336
3337 warn "finished reloading resource files\n";
3338}
3339
3340sub reload_config {
3341 open my $fh, "<:utf8", "$CONFDIR/config"
73 or return; 3342 or return;
74 3343
75 $cb->($data) 3344 local $/;
76} 3345 *CFG = YAML::Load <$fh>;
77 3346
78sub inject_global_event { 3347 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
79 my ($data) = @_;
80 3348
81 my $cb = $hook[$data->{event_code}] 3349 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
82 or return; 3350 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
83 3351
84 $_->($data) for values %$cb; 3352 if (exists $CFG{mlockall}) {
85
86 ()
87}
88
89sub inject_command {
90 my ($name, $obj, $params) = @_;
91
92 for my $cmd (@{ $command{$name} }) {
93 $cmd->[1]->($obj, $params);
94 }
95
96 -1
97}
98
99sub register_command {
100 my ($name, $time, $cb) = @_;
101
102 my $caller = caller;
103
104 warn "registering command '$name/$time' to '$caller'";
105
106 push @{ $command{$name} }, [$time, $cb, $caller];
107 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
108}
109
110sub register {
111 my ($base, $pkg) = @_;
112
113 for my $idx (0 .. $#EVENT) {
114 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
115 warn "registering $EVENT[$idx] hook to '$pkg'\n";
116 $hook[$idx]{$base} = $ref;
117 }
118 }
119}
120
121sub load_extension {
122 my ($path) = @_;
123
124 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
125 my $base = $1;
126 my $pkg = $1;
127 $pkg =~ s/[^[:word:]]/_/g;
128 $pkg = "cf::ext::$pkg";
129
130 warn "loading '$path' into '$pkg'\n";
131
132 open my $fh, "<:utf8", $path
133 or die "$path: $!";
134
135 my $source =
136 "package $pkg; use strict; use utf8;\n"
137 . "#line 1 \"$path\"\n{\n"
138 . (do { local $/; <$fh> })
139 . "\n};\n1";
140
141 eval $source
142 or die "$path: $@";
143
144 push @exts, $pkg;
145 $ext_pkg{$base} = $pkg;
146
147# no strict 'refs';
148# @{"$pkg\::ISA"} = cf::ext::;
149
150 register $base, $pkg;
151}
152
153sub unload_extension {
154 my ($pkg) = @_;
155
156 warn "removing extension $pkg\n";
157
158 # remove hooks
159 for my $idx (0 .. $#EVENT) {
160 delete $hook[$idx]{$pkg};
161 }
162
163 # remove commands
164 for my $name (keys %command) {
165 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
166
167 if (@cb) {
168 $command{$name} = \@cb;
169 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
170 } else {
171 delete $command{$name};
172 delete $COMMAND{"$name\000"};
173 }
174 }
175
176 Symbol::delete_package $pkg;
177}
178
179sub load_extensions {
180 my $LIBDIR = maps_directory "perl";
181
182 for my $ext (<$LIBDIR/*.ext>) {
183 next unless -r $ext;
184 eval { 3353 eval {
185 load_extension $ext; 3354 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
186 1 3355 and die "WARNING: m(un)lockall failed: $!\n";
187 } or warn "$ext not loaded: $@";
188 }
189}
190
191register_command "perl-reload", 0, sub {
192 my ($who, $arg) = @_;
193
194 if ($who->flag (FLAG_WIZ)) {
195 $who->message ("reloading...");
196
197 warn "reloading...\n";
198 eval {
199 unload_extension $_ for @exts;
200 delete $INC{"cf.pm"};
201
202 # don't, removes xs symbols, too
203 #Symbol::delete_package $pkg;
204
205 require cf;
206 }; 3356 };
207 warn $@ if $@; 3357 warn $@ if $@;
208 $who->message ($@) if $@; 3358 }
3359}
3360
3361sub pidfile() {
3362 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3363 or die "$PIDFILE: $!";
3364 flock $fh, &Fcntl::LOCK_EX
3365 or die "$PIDFILE: flock: $!";
3366 $fh
3367}
3368
3369# make sure only one server instance is running at any one time
3370sub atomic {
3371 my $fh = pidfile;
3372
3373 my $pid = <$fh>;
3374 kill 9, $pid if $pid > 0;
3375
3376 seek $fh, 0, 0;
3377 print $fh $$;
3378}
3379
3380sub main {
3381 cf::init_globals; # initialise logging
3382
3383 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3384 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3385 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3386 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3387
3388 cf::init_experience;
3389 cf::init_anim;
3390 cf::init_attackmess;
3391 cf::init_dynamic;
3392
3393 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3394
3395 # we must not ever block the main coroutine
3396 local $Coro::idle = sub {
3397 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3398 (async {
3399 $Coro::current->{desc} = "IDLE BUG HANDLER";
3400 EV::loop EV::LOOP_ONESHOT;
3401 })->prio (Coro::PRIO_MAX);
3402 };
3403
3404 evthread_start IO::AIO::poll_fileno;
3405
3406 cf::sync_job {
3407 reload_resources;
3408 reload_config;
3409 db_init;
3410
3411 cf::load_settings;
3412 cf::load_materials;
3413 cf::init_uuid;
3414 cf::init_signals;
3415 cf::init_commands;
3416 cf::init_skills;
3417
3418 cf::init_beforeplay;
3419
3420 atomic;
3421
3422 load_extensions;
3423
3424 utime time, time, $RUNTIMEFILE;
3425
3426 # no (long-running) fork's whatsoever before this point(!)
3427 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3428
3429 (pop @POST_INIT)->(0) while @POST_INIT;
3430 };
3431
3432 EV::loop;
3433}
3434
3435#############################################################################
3436# initialisation and cleanup
3437
3438# install some emergency cleanup handlers
3439BEGIN {
3440 our %SIGWATCHER = ();
3441 for my $signal (qw(INT HUP TERM)) {
3442 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3443 cf::cleanup "SIG$signal";
3444 };
3445 }
3446}
3447
3448sub write_runtime_sync {
3449 # first touch the runtime file to show we are still running:
3450 # the fsync below can take a very very long time.
3451
3452 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3453
3454 my $guard = cf::lock_acquire "write_runtime";
3455
3456 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3457 or return;
3458
3459 my $value = $cf::RUNTIME + 90 + 10;
3460 # 10 is the runtime save interval, for a monotonic clock
3461 # 60 allows for the watchdog to kill the server.
3462
3463 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3464 and return;
3465
3466 # always fsync - this file is important
3467 aio_fsync $fh
3468 and return;
3469
3470 # touch it again to show we are up-to-date
3471 aio_utime $fh, undef, undef;
3472
3473 close $fh
3474 or return;
3475
3476 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3477 and return;
3478
3479 warn "runtime file written.\n";
3480
3481 1
3482}
3483
3484our $uuid_lock;
3485our $uuid_skip;
3486
3487sub write_uuid_sync($) {
3488 $uuid_skip ||= $_[0];
3489
3490 return if $uuid_lock;
3491 local $uuid_lock = 1;
3492
3493 my $uuid = "$LOCALDIR/uuid";
3494
3495 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3496 or return;
3497
3498 my $value = uuid_seq uuid_cur;
3499
3500 unless ($value) {
3501 warn "cowardly refusing to write zero uuid value!\n";
3502 return;
3503 }
3504
3505 my $value = uuid_str $value + $uuid_skip;
3506 $uuid_skip = 0;
3507
3508 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3509 and return;
3510
3511 # always fsync - this file is important
3512 aio_fsync $fh
3513 and return;
3514
3515 close $fh
3516 or return;
3517
3518 aio_rename "$uuid~", $uuid
3519 and return;
3520
3521 warn "uuid file written ($value).\n";
3522
3523 1
3524
3525}
3526
3527sub write_uuid($$) {
3528 my ($skip, $sync) = @_;
3529
3530 $sync ? write_uuid_sync $skip
3531 : async { write_uuid_sync $skip };
3532}
3533
3534sub emergency_save() {
3535 my $freeze_guard = cf::freeze_mainloop;
3536
3537 warn "emergency_perl_save: enter\n";
3538
3539 cf::sync_job {
3540 # this is a trade-off: we want to be very quick here, so
3541 # save all maps without fsync, and later call a global sync
3542 # (which in turn might be very very slow)
3543 local $USE_FSYNC = 0;
3544
3545 # use a peculiar iteration method to avoid tripping on perl
3546 # refcount bugs in for. also avoids problems with players
3547 # and maps saved/destroyed asynchronously.
3548 warn "emergency_perl_save: begin player save\n";
3549 for my $login (keys %cf::PLAYER) {
3550 my $pl = $cf::PLAYER{$login} or next;
3551 $pl->valid or next;
3552 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3553 $pl->save;
3554 }
3555 warn "emergency_perl_save: end player save\n";
3556
3557 warn "emergency_perl_save: begin map save\n";
3558 for my $path (keys %cf::MAP) {
3559 my $map = $cf::MAP{$path} or next;
3560 $map->valid or next;
3561 $map->save;
3562 }
3563 warn "emergency_perl_save: end map save\n";
3564
3565 warn "emergency_perl_save: begin database checkpoint\n";
3566 BDB::db_env_txn_checkpoint $DB_ENV;
3567 warn "emergency_perl_save: end database checkpoint\n";
3568
3569 warn "emergency_perl_save: begin write uuid\n";
3570 write_uuid_sync 1;
3571 warn "emergency_perl_save: end write uuid\n";
3572 };
3573
3574 warn "emergency_perl_save: starting sync()\n";
3575 IO::AIO::aio_sync sub {
3576 warn "emergency_perl_save: finished sync()\n";
3577 };
3578
3579 warn "emergency_perl_save: leave\n";
3580}
3581
3582sub post_cleanup {
3583 my ($make_core) = @_;
3584
3585 warn Carp::longmess "post_cleanup backtrace"
3586 if $make_core;
3587
3588 my $fh = pidfile;
3589 unlink $PIDFILE if <$fh> == $$;
3590}
3591
3592# a safer delete_package, copied from Symbol
3593sub clear_package($) {
3594 my $pkg = shift;
3595
3596 # expand to full symbol table name if needed
3597 unless ($pkg =~ /^main::.*::$/) {
3598 $pkg = "main$pkg" if $pkg =~ /^::/;
3599 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3600 $pkg .= '::' unless $pkg =~ /::$/;
3601 }
3602
3603 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3604 my $stem_symtab = *{$stem}{HASH};
3605
3606 defined $stem_symtab and exists $stem_symtab->{$leaf}
3607 or return;
3608
3609 # clear all symbols
3610 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3611 for my $name (keys %$leaf_symtab) {
3612 _gv_clear *{"$pkg$name"};
3613# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3614 }
3615 warn "cleared package $pkg\n";#d#
3616}
3617
3618sub do_reload_perl() {
3619 # can/must only be called in main
3620 if ($Coro::current != $Coro::main) {
3621 warn "can only reload from main coroutine";
3622 return;
3623 }
3624
3625 return if $RELOAD++;
3626
3627 my $t1 = EV::time;
3628
3629 while ($RELOAD) {
3630 warn "reloading...";
3631
3632 warn "entering sync_job";
3633
3634 cf::sync_job {
3635 cf::write_runtime_sync; # external watchdog should not bark
3636 cf::emergency_save;
3637 cf::write_runtime_sync; # external watchdog should not bark
3638
3639 warn "syncing database to disk";
3640 BDB::db_env_txn_checkpoint $DB_ENV;
3641
3642 # if anything goes wrong in here, we should simply crash as we already saved
3643
3644 warn "flushing outstanding aio requests";
3645 while (IO::AIO::nreqs || BDB::nreqs) {
3646 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3647 }
3648
3649 warn "cancelling all extension coros";
3650 $_->cancel for values %EXT_CORO;
3651 %EXT_CORO = ();
3652
3653 warn "removing commands";
3654 %COMMAND = ();
3655
3656 warn "removing ext/exti commands";
3657 %EXTCMD = ();
3658 %EXTICMD = ();
3659
3660 warn "unloading/nuking all extensions";
3661 for my $pkg (@EXTS) {
3662 warn "... unloading $pkg";
3663
3664 if (my $cb = $pkg->can ("unload")) {
3665 eval {
3666 $cb->($pkg);
3667 1
3668 } or warn "$pkg unloaded, but with errors: $@";
3669 }
3670
3671 warn "... clearing $pkg";
3672 clear_package $pkg;
3673 }
3674
3675 warn "unloading all perl modules loaded from $LIBDIR";
3676 while (my ($k, $v) = each %INC) {
3677 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3678
3679 warn "... unloading $k";
3680 delete $INC{$k};
3681
3682 $k =~ s/\.pm$//;
3683 $k =~ s/\//::/g;
3684
3685 if (my $cb = $k->can ("unload_module")) {
3686 $cb->();
3687 }
3688
3689 clear_package $k;
3690 }
3691
3692 warn "getting rid of safe::, as good as possible";
3693 clear_package "safe::$_"
3694 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3695
3696 warn "unloading cf.pm \"a bit\"";
3697 delete $INC{"cf.pm"};
3698 delete $INC{"cf/pod.pm"};
3699
3700 # don't, removes xs symbols, too,
3701 # and global variables created in xs
3702 #clear_package __PACKAGE__;
3703
3704 warn "unload completed, starting to reload now";
3705
3706 warn "reloading cf.pm";
3707 require cf;
3708 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
3709
3710 warn "loading config and database again";
3711 cf::reload_config;
3712
3713 warn "loading extensions";
3714 cf::load_extensions;
3715
3716 if ($REATTACH_ON_RELOAD) {
3717 warn "reattaching attachments to objects/players";
3718 _global_reattach; # objects, sockets
3719 warn "reattaching attachments to maps";
3720 reattach $_ for values %MAP;
3721 warn "reattaching attachments to players";
3722 reattach $_ for values %PLAYER;
3723 }
3724
3725 warn "running post_init jobs";
3726 (pop @POST_INIT)->(1) while @POST_INIT;
3727
3728 warn "leaving sync_job";
3729
3730 1
3731 } or do {
3732 warn $@;
3733 cf::cleanup "error while reloading, exiting.";
3734 };
3735
209 warn "reloaded\n"; 3736 warn "reloaded";
3737 --$RELOAD;
3738 }
210 3739
3740 $t1 = EV::time - $t1;
3741 warn "reload completed in ${t1}s\n";
3742};
3743
3744our $RELOAD_WATCHER; # used only during reload
3745
3746sub reload_perl() {
3747 # doing reload synchronously and two reloads happen back-to-back,
3748 # coro crashes during coro_state_free->destroy here.
3749
3750 $RELOAD_WATCHER ||= cf::async {
3751 Coro::AIO::aio_wait cache_extensions;
3752
3753 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3754 do_reload_perl;
3755 undef $RELOAD_WATCHER;
3756 };
3757 };
3758}
3759
3760register_command "reload" => sub {
3761 my ($who, $arg) = @_;
3762
3763 if ($who->flag (FLAG_WIZ)) {
211 $who->message ("reloaded"); 3764 $who->message ("reloading server.");
3765 async {
3766 $Coro::current->{desc} = "perl_reload";
3767 reload_perl;
3768 };
3769 }
3770};
3771
3772unshift @INC, $LIBDIR;
3773
3774my $bug_warning = 0;
3775
3776our @WAIT_FOR_TICK;
3777our @WAIT_FOR_TICK_BEGIN;
3778
3779sub wait_for_tick {
3780 return if tick_inhibit || $Coro::current == $Coro::main;
3781
3782 my $signal = new Coro::Signal;
3783 push @WAIT_FOR_TICK, $signal;
3784 $signal->wait;
3785}
3786
3787sub wait_for_tick_begin {
3788 return if tick_inhibit || $Coro::current == $Coro::main;
3789
3790 my $signal = new Coro::Signal;
3791 push @WAIT_FOR_TICK_BEGIN, $signal;
3792 $signal->wait;
3793}
3794
3795sub tick {
3796 if ($Coro::current != $Coro::main) {
3797 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3798 unless ++$bug_warning > 10;
3799 return;
3800 }
3801
3802 cf::server_tick; # one server iteration
3803
3804 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3805 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
3806 Coro::async_pool {
3807 $Coro::current->{desc} = "runtime saver";
3808 write_runtime_sync
3809 or warn "ERROR: unable to write runtime file: $!";
3810 };
3811 }
3812
3813 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3814 $sig->send;
3815 }
3816 while (my $sig = shift @WAIT_FOR_TICK) {
3817 $sig->send;
3818 }
3819
3820 $LOAD = ($NOW - $TICK_START) / $TICK;
3821 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3822
3823 if (0) {
3824 if ($NEXT_TICK) {
3825 my $jitter = $TICK_START - $NEXT_TICK;
3826 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3827 warn "jitter $JITTER\n";#d#
3828 }
3829 }
3830}
3831
3832{
3833 # configure BDB
3834
3835 BDB::min_parallel 8;
3836 BDB::max_poll_reqs $TICK * 0.1;
3837 $AnyEvent::BDB::WATCHER->priority (1);
3838
3839 unless ($DB_ENV) {
3840 $DB_ENV = BDB::db_env_create;
3841 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3842 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3843 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3844 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3845 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3846
3847 cf::sync_job {
3848 eval {
3849 BDB::db_env_open
3850 $DB_ENV,
3851 $BDBDIR,
3852 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3853 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3854 0666;
3855
3856 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3857 };
3858
3859 cf::cleanup "db_env_open(db): $@" if $@;
3860 };
3861 }
3862
3863 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3864 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3865 };
3866 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3867 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3868 };
3869 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3870 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3871 };
3872}
3873
3874{
3875 # configure IO::AIO
3876
3877 IO::AIO::min_parallel 8;
3878 IO::AIO::max_poll_time $TICK * 0.1;
3879 undef $AnyEvent::AIO::WATCHER;
3880}
3881
3882my $_log_backtrace;
3883
3884sub _log_backtrace {
3885 my ($msg, @addr) = @_;
3886
3887 $msg =~ s/\n//;
3888
3889 # limit the # of concurrent backtraces
3890 if ($_log_backtrace < 2) {
3891 ++$_log_backtrace;
3892 my $perl_bt = Carp::longmess $msg;
3893 async {
3894 $Coro::current->{desc} = "abt $msg";
3895
3896 my @bt = fork_call {
3897 @addr = map { sprintf "%x", $_ } @addr;
3898 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3899 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3900 or die "addr2line: $!";
3901
3902 my @funcs;
3903 my @res = <$fh>;
3904 chomp for @res;
3905 while (@res) {
3906 my ($func, $line) = splice @res, 0, 2, ();
3907 push @funcs, "[$func] $line";
3908 }
3909
3910 @funcs
3911 };
3912
3913 LOG llevInfo, "[ABT] $perl_bt\n";
3914 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3915 LOG llevInfo, "[ABT] $_\n" for @bt;
3916 --$_log_backtrace;
3917 };
212 } else { 3918 } else {
213 $who->message ("Intruder Alert!"); 3919 LOG llevInfo, "[ABT] $msg\n";
3920 LOG llevInfo, "[ABT] [suppressed]\n";
214 } 3921 }
215}; 3922}
216 3923
217*on_mapclean = sub { 3924# load additional modules
218 my $map = shift->{map}; 3925use cf::pod;
219 3926
220 my $path = $map->tmpname; 3927END { cf::emergency_save }
221 defined $path or return;
222
223 unlink "$path.cfperl";
224};
225
226*on_mapin =
227*on_mapload = sub {
228 my $map = shift->{map};
229
230 my $path = $map->tmpname;
231 $path = $map->path unless defined $path;
232
233 open my $fh, "<:raw", "$path.cfperl"
234 or return; # no perl data
235
236 my $data = Storable::thaw do { local $/; <$fh> };
237
238 $data->{version} <= 1
239 or return; # too new
240
241 $map->_set_obs ($data->{obs});
242};
243
244*on_mapout = sub {
245 my $map = shift->{map};
246
247 my $path = $map->tmpname;
248 $path = $map->path unless defined $path;
249
250 my $obs = $map->_get_obs;
251
252 if (defined $obs) {
253 open my $fh, ">:raw", "$path.cfperl"
254 or die "$path.cfperl: $!";
255
256 print $fh Storable::nfreeze {
257 version => 1,
258 obs => $obs,
259 };
260
261 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
262 } else {
263 unlink "$path.cfperl";
264 }
265};
266
267register "<global>", __PACKAGE__;
268
269load_extensions;
270 3928
2711 39291
272 3930

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines