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.19 by root, Sun Jul 16 17:15:39 2006 UTC vs.
Revision 1.519 by root, Fri Apr 16 02:32:25 2010 UTC

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

Diff Legend

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