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

Diff Legend

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