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.35 by root, Thu Aug 24 13:35:48 2006 UTC vs.
Revision 1.553 by root, Tue May 18 21:30:16 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
22our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
23our $TICK_WATCHER; 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";
110
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
24our $NEXT_TICK; 121our $NEXT_TICK;
122our $USE_FSYNC = 1; # use fsync to write maps - default on
25 123
26BEGIN { 124our $BDB_DEADLOCK_WATCHER;
27 @EVENT = map lc, @EVENT; 125our $BDB_CHECKPOINT_WATCHER;
126our $BDB_TRICKLE_WATCHER;
127our $DB_ENV;
28 128
29 *CORE::GLOBAL::warn = sub { 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 {
30 my $msg = join "", @_; 269 my $msg = join "", @_;
270
31 $msg .= "\n" 271 $msg .= "\n"
32 unless $msg =~ /\n$/; 272 unless $msg =~ /\n$/;
33 273
34 print STDERR "cfperl: $msg"; 274 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
35 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 $!;
36 }; 713 };
37} 714 cf::cleanup "db_open(db): $@" if $@;
38 715
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 716 $db
717}
40 718
41# generate property mutators 719our $DB;
42sub prop_gen {
43 my ($prefix, $class) = @_;
44 720
45 no strict 'refs'; 721sub db_init {
722 $DB ||= db_table "db";
723}
46 724
47 for my $prop (keys %PROP_TYPE) { 725sub db_get($$) {
48 $prop =~ /^\Q$prefix\E_(.*$)/ or next; 726 my $key = "$_[0]/$_[1]";
49 my $sub = lc $1;
50 727
51 my $type = $PROP_TYPE{$prop}; 728 cf::error "db_get called from main context"
52 my $idx = $PROP_IDX {$prop}; 729 if $Coro::current == $Coro::main;
53 730
54 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { 731 BDB::db_get $DB, undef, $key, my $data;
55 $_[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->[$_]: $!";
56 }; 774 }
57 775
58 *{"$class\::set_$sub"} = sub { 776 # if processing is expensive, check
59 $_[0]->set_property ($type, $idx, $_[1]); 777 # checksum first
60 } unless $ignore_set{$prop}; 778 if (1) {
61 } 779 $md5 =
62} 780 join "\x00",
781 $processversion,
782 map {
783 cf::cede_to_tick;
784 ($src->[$_], Digest::MD5::md5_hex $data[$_])
785 } 0.. $#$src;
786
63 787
64# 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;
65 791
66prop_gen OBJECT_PROP => "cf::object"; 792 return db_get cache => "$id/data";
67# CFAPI_OBJECT_ANIMATION? 793 }
68prop_gen PLAYER_PROP => "cf::object::player"; 794 }
69 795
70prop_gen MAP_PROP => "cf::map"; 796 my $t1 = Time::HiRes::time;
71prop_gen ARCH_PROP => "cf::arch"; 797 my $data = $process->(\@data);
798 my $t2 = Time::HiRes::time;
72 799
73# guessed hierarchies 800 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
74 801
75@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 802 db_put cache => "$id/data", $data;
76@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;
77 805
78# we bless all objects into derived classes to force a method lookup 806 return $data;
79# within the Safe compartment. 807 }
80for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
81 no strict 'refs';
82 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
83}
84 808
85$Event::DIED = sub { 809 db_get cache => "$id/data"
86 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;
87}; 1062};
88 1063
89my %ext_pkg; 1064# all those should be optimised
90my @exts; 1065sub cf::attachable::detach {
91my @hook; 1066 my ($obj, $name) = @_;
92my %command;
93my %extcmd;
94 1067
95sub inject_event { 1068 if (ref $obj) {
96 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 {
97 my $event_code = shift; 1107 my $event = shift;
1108 my $callbacks = shift;
98 1109
99 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
100 or return; 1301 or return;
101 1302
102 &$cb 1303 unless (aio_stat "$filename.pst") {
103} 1304 (aio_load "$filename.pst", $av) >= 0
104
105sub inject_global_event {
106 my $event = shift;
107
108 my $cb = $hook[$event]
109 or return; 1305 or return;
110 1306
111 List::Util::max map &$_, values %$cb 1307 my $st = eval { Coro::Storable::thaw $av };
112} 1308 $av = $st->{objs};
113
114sub inject_command {
115 my ($name, $obj, $params) = @_;
116
117 for my $cmd (@{ $command{$name} }) {
118 $cmd->[1]->($obj, $params);
119 } 1309 }
120 1310
121 -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)
122} 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
123 1334
124sub register_command { 1335sub register_command {
125 my ($name, $time, $cb) = @_; 1336 my ($name, $cb) = @_;
126 1337
127 my $caller = caller; 1338 my $caller = caller;
128 #warn "registering command '$name/$time' to '$caller'"; 1339 #warn "registering command '$name/$time' to '$caller'";
129 1340
130 push @{ $command{$name} }, [$time, $cb, $caller]; 1341 push @{ $COMMAND{$name} }, [$caller, $cb];
131 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
132} 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
133 1367
134sub register_extcmd { 1368sub register_extcmd {
135 my ($name, $cb) = @_; 1369 my ($name, $cb) = @_;
136 1370
137 my $caller = caller; 1371 $EXTCMD{$name} = $cb;
138 #warn "registering extcmd '$name' to '$caller'";
139
140 $extcmd{$name} = [$cb, $caller];
141} 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->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1869 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1870 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1871 $rmp->{exit_on_final_map},
1872 $rmp->{xsize}, $rmp->{ysize},
1873 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1874 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1875 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1876 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1877 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1878 (cf::region::find $rmp->{region}), $rmp->{custom}
1879 )
1880}
1881
1882=item cf::map->register ($regex, $prio)
1883
1884Register a handler for the map path matching the given regex at the
1885givne priority (higher is better, built-in handlers have priority 0, the
1886default).
1887
1888=cut
142 1889
143sub register { 1890sub register {
1891 my (undef, $regex, $prio) = @_;
1892 my $pkg = caller;
1893
1894 push @{"$pkg\::ISA"}, __PACKAGE__;
1895
1896 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1897}
1898
1899# also paths starting with '/'
1900$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1901
1902sub thawer_merge {
144 my ($base, $pkg) = @_; 1903 my ($self, $merge) = @_;
145 1904
146 for my $idx (0 .. $#EVENT) { 1905 # we have to keep some variables in memory intact
147 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { 1906 local $self->{path};
148 #warn "registering $EVENT[$idx] hook to '$pkg'\n"; 1907 local $self->{load_path};
149 $hook[$idx]{$base} = $ref;
150 }
151 }
152}
153 1908
154sub load_extension { 1909 $self->SUPER::thawer_merge ($merge);
1910}
1911
1912sub normalise {
155 my ($path) = @_; 1913 my ($path, $base) = @_;
156 1914
157 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1915 $path = "$path"; # make sure it's a string
158 my $base = $1;
159 my $pkg = $1;
160 $pkg =~ s/[^[:word:]]/_/g;
161 $pkg = "cf::ext::$pkg";
162 1916
163 warn "loading '$path' into '$pkg'\n"; 1917 $path =~ s/\.map$//;
164 1918
165 open my $fh, "<:utf8", $path 1919 # map plan:
166 or die "$path: $!"; 1920 #
1921 # /! non-realised random map exit (special hack!)
1922 # {... are special paths that are not being touched
1923 # ?xxx/... are special absolute paths
1924 # ?random/... random maps
1925 # /... normal maps
1926 # ~user/... per-player map of a specific user
167 1927
168 my $source = 1928 $path =~ s/$PATH_SEP/\//go;
169 "package $pkg; use strict; use utf8;\n"
170 . "#line 1 \"$path\"\n{\n"
171 . (do { local $/; <$fh> })
172 . "\n};\n1";
173 1929
174 eval $source 1930 # treat it as relative path if it starts with
175 or die "$path: $@"; 1931 # something that looks reasonable
1932 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1933 $base or Carp::carp "normalise called with relative path and no base: '$path'";
176 1934
177 push @exts, $pkg; 1935 $base =~ s{[^/]+/?$}{};
178 $ext_pkg{$base} = $pkg; 1936 $path = "$base/$path";
1937 }
179 1938
180# no strict 'refs'; 1939 for ($path) {
181# @{"$pkg\::ISA"} = ext::; 1940 redo if s{/\.?/}{/};
1941 redo if s{/[^/]+/\.\./}{/};
1942 }
182 1943
183 register $base, $pkg; 1944 $path
184} 1945}
185 1946
186sub unload_extension { 1947sub new_from_path {
1948 my (undef, $path, $base) = @_;
1949
1950 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1951
1952 $path = normalise $path, $base;
1953
1954 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1955 if ($path =~ $EXT_MAP{$pkg}[1]) {
1956 my $self = bless cf::map::new, $pkg;
1957 $self->{path} = $path; $self->path ($path);
1958 $self->init; # pass $1 etc.
1959 return $self;
1960 }
1961 }
1962
1963 Carp::cluck "unable to resolve path '$path' (base '$base')";
1964 ()
1965}
1966
1967sub init {
187 my ($pkg) = @_; 1968 my ($self) = @_;
188 1969
189 warn "removing extension $pkg\n"; 1970 $self
1971}
190 1972
191 # remove hooks 1973sub as_string {
192 for my $idx (0 .. $#EVENT) { 1974 my ($self) = @_;
193 delete $hook[$idx]{$pkg}; 1975
1976 "$self->{path}"
1977}
1978
1979# the displayed name, this is a one way mapping
1980sub visible_name {
1981 &as_string
1982}
1983
1984# the original (read-only) location
1985sub load_path {
1986 my ($self) = @_;
1987
1988 "$MAPDIR/$self->{path}.map"
1989}
1990
1991# the temporary/swap location
1992sub save_path {
1993 my ($self) = @_;
1994
1995 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1996 "$TMPDIR/$path.map"
1997}
1998
1999# the unique path, undef == no special unique path
2000sub uniq_path {
2001 my ($self) = @_;
2002
2003 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
2004 "$UNIQUEDIR/$path"
2005}
2006
2007sub decay_objects {
2008 my ($self) = @_;
2009
2010 return if $self->{deny_reset};
2011
2012 $self->do_decay_objects;
2013}
2014
2015sub unlink_save {
2016 my ($self) = @_;
2017
2018 utf8::encode (my $save = $self->save_path);
2019 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
2020 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
2021}
2022
2023sub load_header_from($) {
2024 my ($self, $path) = @_;
2025
2026 utf8::encode $path;
2027 my $f = new_from_file cf::object::thawer $path
2028 or return;
2029
2030 $self->_load_header ($f)
2031 or return;
2032
2033 local $MAP_LOADING{$self->{path}} = $self;
2034 $f->resolve_delayed_derefs;
2035
2036 $self->{load_path} = $path;
2037
194 } 2038 1
2039}
195 2040
196 # remove commands 2041sub load_header_orig {
197 for my $name (keys %command) { 2042 my ($self) = @_;
198 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
199 2043
200 if (@cb) { 2044 $self->load_header_from ($self->load_path)
201 $command{$name} = \@cb; 2045}
202 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; 2046
2047sub load_header_temp {
2048 my ($self) = @_;
2049
2050 $self->load_header_from ($self->save_path)
2051}
2052
2053sub prepare_temp {
2054 my ($self) = @_;
2055
2056 $self->last_access ((delete $self->{last_access})
2057 || $cf::RUNTIME); #d#
2058 # safety
2059 $self->{instantiate_time} = $cf::RUNTIME
2060 if $self->{instantiate_time} > $cf::RUNTIME;
2061}
2062
2063sub prepare_orig {
2064 my ($self) = @_;
2065
2066 $self->{load_original} = 1;
2067 $self->{instantiate_time} = $cf::RUNTIME;
2068 $self->last_access ($cf::RUNTIME);
2069 $self->instantiate;
2070}
2071
2072sub load_header {
2073 my ($self) = @_;
2074
2075 if ($self->load_header_temp) {
2076 $self->prepare_temp;
203 } else { 2077 } else {
204 delete $command{$name}; 2078 $self->load_header_orig
205 delete $COMMAND{"$name\000"}; 2079 or return;
206 } 2080 $self->prepare_orig;
2081 }
2082
2083 $self->{deny_reset} = 1
2084 if $self->no_reset;
2085
2086 $self->default_region (cf::region::find_by_path $self->{path})
2087 unless $self->default_region;
2088
207 } 2089 1
2090}
208 2091
209 # remove extcmds 2092sub find;
210 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 2093sub find {
211 delete $extcmd{$name}; 2094 my ($path, $origin) = @_;
2095
2096 cf::cede_to_tick;
2097
2098 $path = normalise $path, $origin && $origin->path;
2099
2100 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
2101 my $guard2 = cf::lock_acquire "map_find:$path";
2102
2103 $cf::MAP{$path} || do {
2104 my $map = new_from_path cf::map $path
2105 or return;
2106
2107 $map->{last_save} = $cf::RUNTIME;
2108
2109 $map->load_header
2110 or return;
2111
2112 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
2113 # doing this can freeze the server in a sync job, obviously
2114 #$cf::WAIT_FOR_TICK->wait;
2115 undef $guard2;
2116 undef $guard1;
2117 $map->reset;
2118 return find $path;
2119 }
2120
2121 $cf::MAP{$path} = $map
2122 }
2123}
2124
2125sub pre_load { }
2126#sub post_load { } # XS
2127
2128sub load {
2129 my ($self) = @_;
2130
2131 local $self->{deny_reset} = 1; # loading can take a long time
2132
2133 my $path = $self->{path};
2134
212 } 2135 {
2136 my $guard = cf::lock_acquire "map_data:$path";
213 2137
214 if (my $cb = $pkg->can ("on_unload")) { 2138 return unless $self->valid;
215 eval { 2139 return unless $self->in_memory == cf::MAP_SWAPPED;
216 $cb->($pkg); 2140
2141 $self->in_memory (cf::MAP_LOADING);
2142
2143 $self->alloc;
2144
2145 $self->pre_load;
2146 cf::cede_to_tick;
2147
2148 my $f = new_from_file cf::object::thawer $self->{load_path};
2149 $f->skip_block;
2150 $self->_load_objects ($f)
2151 or return;
2152
2153 $self->post_load_original
2154 if delete $self->{load_original};
2155
2156 if (my $uniq = $self->uniq_path) {
2157 utf8::encode $uniq;
2158 unless (aio_stat $uniq) {
2159 if (my $f = new_from_file cf::object::thawer $uniq) {
2160 $self->clear_unique_items;
2161 $self->_load_objects ($f);
2162 $f->resolve_delayed_derefs;
217 1 2163 }
218 } or warn "$pkg unloaded, but with errors: $@";
219 }
220
221 Symbol::delete_package $pkg;
222}
223
224sub load_extensions {
225 my $LIBDIR = maps_directory "perl";
226
227 for my $ext (<$LIBDIR/*.ext>) {
228 next unless -r $ext;
229 eval {
230 load_extension $ext;
231 1
232 } or warn "$ext not loaded: $@";
233 }
234}
235
236register_command "perl-reload", 0, sub {
237 my ($who, $arg) = @_;
238
239 if ($who->flag (FLAG_WIZ)) {
240 $who->message ("reloading...");
241
242 warn "reloading...\n";
243 eval {
244 # 1. cancel all watchers
245 $_->cancel for Event::all_watchers;
246
247 # 2. unload all extensions
248 for (@exts) {
249 $who->message ("unloading <$_>");
250 unload_extension $_;
251 } 2164 }
2165 }
252 2166
253 # 3. unload all modules loaded from $LIBDIR 2167 $f->resolve_delayed_derefs;
2168
2169 cf::cede_to_tick;
2170 # now do the right thing for maps
2171 $self->link_multipart_objects;
2172 $self->difficulty ($self->estimate_difficulty)
2173 unless $self->difficulty;
2174 cf::cede_to_tick;
2175
2176 unless ($self->{deny_activate}) {
2177 $self->decay_objects;
2178 $self->fix_auto_apply;
2179 $self->update_buttons;
2180 cf::cede_to_tick;
2181 $self->activate;
2182 }
2183
2184 $self->{last_save} = $cf::RUNTIME;
2185 $self->last_access ($cf::RUNTIME);
2186
2187 $self->in_memory (cf::MAP_ACTIVE);
2188 }
2189
2190 $self->post_load;
2191
2192 1
2193}
2194
2195# customize the map for a given player, i.e.
2196# return the _real_ map. used by e.g. per-player
2197# maps to change the path to ~playername/mappath
2198sub customise_for {
2199 my ($self, $ob) = @_;
2200
2201 return find "~" . $ob->name . "/" . $self->{path}
2202 if $self->per_player;
2203
2204# return find "?party/" . $ob->name . "/" . $self->{path}
2205# if $self->per_party;
2206
2207 $self
2208}
2209
2210# find and load all maps in the 3x3 area around a map
2211sub load_neighbours {
2212 my ($map) = @_;
2213
2214 my @neigh; # diagonal neighbours
2215
2216 for (0 .. 3) {
2217 my $neigh = $map->tile_path ($_)
2218 or next;
2219 $neigh = find $neigh, $map
2220 or next;
2221 $neigh->load;
2222
2223 # now find the diagonal neighbours
2224 push @neigh,
2225 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2226 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2227 }
2228
2229 for (grep defined $_->[0], @neigh) {
2230 my ($path, $origin) = @$_;
2231 my $neigh = find $path, $origin
2232 or next;
2233 $neigh->load;
2234 }
2235}
2236
2237sub find_sync {
2238 my ($path, $origin) = @_;
2239
2240 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2241 if $Coro::current == $Coro::main;
2242
2243 find $path, $origin
2244}
2245
2246sub do_load_sync {
2247 my ($map) = @_;
2248
2249 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2250 if $Coro::current == $Coro::main;
2251
2252 $map->load;
2253}
2254
2255our %MAP_PREFETCH;
2256our $MAP_PREFETCHER = undef;
2257
2258sub find_async {
2259 my ($path, $origin, $load) = @_;
2260
2261 $path = normalise $path, $origin && $origin->{path};
2262
2263 if (my $map = $cf::MAP{$path}) {
2264 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2265 }
2266
2267 $MAP_PREFETCH{$path} |= $load;
2268
2269 $MAP_PREFETCHER ||= cf::async {
2270 $Coro::current->{desc} = "map prefetcher";
2271
2272 while (%MAP_PREFETCH) {
254 while (my ($k, $v) = each %INC) { 2273 while (my ($k, $v) = each %MAP_PREFETCH) {
255 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2274 if (my $map = find $k) {
256 2275 $map->load if $v;
257 $who->message ("removing <$k>");
258 delete $INC{$k};
259
260 $k =~ s/\.pm$//;
261 $k =~ s/\//::/g;
262
263 if (my $cb = $k->can ("unload_module")) {
264 $cb->();
265 } 2276 }
266 2277
267 Symbol::delete_package $k; 2278 delete $MAP_PREFETCH{$k};
268 } 2279 }
269
270 # 4. get rid of ext::, as good as possible
271 Symbol::delete_package "ext::$_"
272 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
273
274 # 5. remove register_script_function callbacks
275 # TODO
276
277 # 6. unload cf.pm "a bit"
278 delete $INC{"cf.pm"};
279
280 # don't, removes xs symbols, too
281 #Symbol::delete_package __PACKAGE__;
282
283 # 7. reload cf.pm
284 $who->message ("reloading cf.pm");
285 require cf;
286 }; 2280 }
287 warn $@ if $@; 2281 undef $MAP_PREFETCHER;
288 $who->message ($@) if $@; 2282 };
289 warn "reloaded\n"; 2283 $MAP_PREFETCHER->prio (6);
290 2284
291 $who->message ("reloaded"); 2285 ()
2286}
2287
2288# common code, used by both ->save and ->swapout
2289sub _save {
2290 my ($self) = @_;
2291
2292 $self->{last_save} = $cf::RUNTIME;
2293
2294 return unless $self->dirty;
2295
2296 my $save = $self->save_path; utf8::encode $save;
2297 my $uniq = $self->uniq_path; utf8::encode $uniq;
2298
2299 $self->{load_path} = $save;
2300
2301 return if $self->{deny_save};
2302
2303 local $self->{last_access} = $self->last_access;#d#
2304
2305 cf::async {
2306 $Coro::current->{desc} = "map player save";
2307 $_->contr->save for $self->players;
2308 };
2309
2310 cf::get_slot 0.02;
2311
2312 if ($uniq) {
2313 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2314 $self->_save_objects ($uniq, cf::IO_UNIQUES);
292 } else { 2315 } else {
293 $who->message ("Intruder Alert!"); 2316 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
294 } 2317 }
295};
296
297#############################################################################
298# utility functions
299
300use JSON::Syck (); # TODO# replace by JSON::PC once working
301
302sub from_json($) {
303 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
304 JSON::Syck::Load $_[0]
305} 2318}
306 2319
307sub to_json($) { 2320sub save {
308 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
309 JSON::Syck::Dump $_[0]
310}
311
312#############################################################################
313# extcmd framework, basically convert ext <msg>
314# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
315
316sub on_extcmd {
317 my ($pl, $buf) = @_; 2321 my ($self) = @_;
318 2322
319 my $msg = eval { from_json $buf }; 2323 my $lock = cf::lock_acquire "map_data:$self->{path}";
320 2324
321 if (ref $msg) { 2325 $self->_save;
322 if (my $cb = $extcmd{$msg->{msgtype}}) { 2326}
323 if (my %reply = $cb->[0]->($pl, $msg)) { 2327
324 $pl->ext_reply ($msg->{msgid}, %reply); 2328sub swap_out {
2329 my ($self) = @_;
2330
2331 my $lock = cf::lock_acquire "map_data:$self->{path}";
2332
2333 return if $self->in_memory != cf::MAP_ACTIVE;
2334 return if $self->{deny_save};
2335 return if $self->players;
2336
2337 # first deactivate the map and "unlink" it from the core
2338 $self->deactivate;
2339 $_->clear_links_to ($self) for values %cf::MAP;
2340 $self->in_memory (cf::MAP_SWAPPED);
2341
2342 # then atomically save
2343 $self->_save;
2344
2345 # then free the map
2346 $self->clear;
2347}
2348
2349sub reset_at {
2350 my ($self) = @_;
2351
2352 # TODO: safety, remove and allow resettable per-player maps
2353 return 1e99 if $self->{deny_reset};
2354
2355 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2356 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2357
2358 $time + $to
2359}
2360
2361sub should_reset {
2362 my ($self) = @_;
2363
2364 $self->reset_at <= $cf::RUNTIME
2365}
2366
2367sub reset {
2368 my ($self) = @_;
2369
2370 my $lock = cf::lock_acquire "map_data:$self->{path}";
2371
2372 return if $self->players;
2373
2374 cf::trace "resetting map ", $self->path, "\n";
2375
2376 $self->in_memory (cf::MAP_SWAPPED);
2377
2378 # need to save uniques path
2379 unless ($self->{deny_save}) {
2380 my $uniq = $self->uniq_path; utf8::encode $uniq;
2381
2382 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2383 if $uniq;
2384 }
2385
2386 delete $cf::MAP{$self->path};
2387
2388 $self->deactivate;
2389 $_->clear_links_to ($self) for values %cf::MAP;
2390 $self->clear;
2391
2392 $self->unlink_save;
2393 $self->destroy;
2394}
2395
2396my $nuke_counter = "aaaa";
2397
2398sub nuke {
2399 my ($self) = @_;
2400
2401 {
2402 my $lock = cf::lock_acquire "map_data:$self->{path}";
2403
2404 delete $cf::MAP{$self->path};
2405
2406 $self->unlink_save;
2407
2408 bless $self, "cf::map::wrap";
2409 delete $self->{deny_reset};
2410 $self->{deny_save} = 1;
2411 $self->reset_timeout (1);
2412 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2413
2414 $cf::MAP{$self->path} = $self;
2415 }
2416
2417 $self->reset; # polite request, might not happen
2418}
2419
2420=item $maps = cf::map::tmp_maps
2421
2422Returns an arrayref with all map paths of currently instantiated and saved
2423maps. May block.
2424
2425=cut
2426
2427sub tmp_maps() {
2428 [
2429 map {
2430 utf8::decode $_;
2431 /\.map$/
2432 ? normalise $_
2433 : ()
2434 } @{ aio_readdir $TMPDIR or [] }
2435 ]
2436}
2437
2438=item $maps = cf::map::random_maps
2439
2440Returns an arrayref with all map paths of currently instantiated and saved
2441random maps. May block.
2442
2443=cut
2444
2445sub random_maps() {
2446 [
2447 map {
2448 utf8::decode $_;
2449 /\.map$/
2450 ? normalise "?random/$_"
2451 : ()
2452 } @{ aio_readdir $RANDOMDIR or [] }
2453 ]
2454}
2455
2456=item cf::map::unique_maps
2457
2458Returns an arrayref of paths of all shared maps that have
2459instantiated unique items. May block.
2460
2461=cut
2462
2463sub unique_maps() {
2464 [
2465 map {
2466 utf8::decode $_;
2467 s/\.map$//; # TODO future compatibility hack
2468 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2469 ? ()
2470 : normalise $_
2471 } @{ aio_readdir $UNIQUEDIR or [] }
2472 ]
2473}
2474
2475=item cf::map::static_maps
2476
2477Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2478file in the shared directory excluding F</styles> and F</editor>). May
2479block.
2480
2481=cut
2482
2483sub static_maps() {
2484 my @dirs = "";
2485 my @maps;
2486
2487 while (@dirs) {
2488 my $dir = shift @dirs;
2489
2490 next if $dir eq "/styles" || $dir eq "/editor";
2491
2492 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2493 or return;
2494
2495 for (@$files) {
2496 s/\.map$// or next;
2497 utf8::decode $_;
2498 push @maps, "$dir/$_";
325 } 2499 }
326 } 2500
2501 push @dirs, map "$dir/$_", @$dirs;
2502 }
2503
2504 \@maps
2505}
2506
2507=back
2508
2509=head3 cf::object
2510
2511=cut
2512
2513package cf::object;
2514
2515=over 4
2516
2517=item $ob->inv_recursive
2518
2519Returns the inventory of the object I<and> their inventories, recursively,
2520but I<not> the object itself.
2521
2522=cut
2523
2524sub inv_recursive_;
2525sub inv_recursive_ {
2526 map { $_, inv_recursive_ $_->inv } @_
2527}
2528
2529sub inv_recursive {
2530 inv_recursive_ inv $_[0]
2531}
2532
2533=item $ref = $ob->ref
2534
2535Creates and returns a persistent reference to an object that can be stored as a string.
2536
2537=item $ob = cf::object::deref ($refstring)
2538
2539returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2540even if the object actually exists. May block.
2541
2542=cut
2543
2544sub deref {
2545 my ($ref) = @_;
2546
2547 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2548 my ($uuid, $name) = ($1, $2);
2549 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2550 or return;
2551 $pl->ob->uuid eq $uuid
2552 or return;
2553
2554 $pl->ob
327 } else { 2555 } else {
328 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 2556 warn "$ref: cannot resolve object reference\n";
329 } 2557 undef
330
331 1 2558 }
332} 2559}
333 2560
334############################################################################# 2561package cf;
335# load/save/clean perl data associated with a map
336 2562
337*on_mapclean = sub { 2563=back
338 my ($map) = @_;
339 2564
340 my $path = $map->tmpname; 2565=head3 cf::object::player
341 defined $path or return;
342 2566
343 unlink "$path.cfperl"; 2567=over 4
344};
345 2568
346*on_mapin =
347*on_mapload = sub {
348 my ($map) = @_;
349
350 my $path = $map->tmpname;
351 $path = $map->path unless defined $path;
352
353 open my $fh, "<:raw", "$path.cfperl"
354 or return; # no perl data
355
356 my $data = Storable::thaw do { local $/; <$fh> };
357
358 $data->{version} <= 1
359 or return; # too new
360
361 $map->_set_obs ($data->{obs});
362};
363
364*on_mapout = sub {
365 my ($map) = @_;
366
367 my $path = $map->tmpname;
368 $path = $map->path unless defined $path;
369
370 my $obs = $map->_get_obs;
371
372 if (defined $obs) {
373 open my $fh, ">:raw", "$path.cfperl"
374 or die "$path.cfperl: $!";
375
376 stat $path;
377
378 print $fh Storable::nfreeze {
379 size => (stat _)[7],
380 time => (stat _)[9],
381 version => 1,
382 obs => $obs,
383 };
384
385 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
386 } else {
387 unlink "$path.cfperl";
388 }
389};
390
391#############################################################################
392# load/save perl data associated with player->ob objects
393
394sub all_objects(@) {
395 @_, map all_objects ($_->inv), @_
396}
397
398*on_player_load = sub {
399 my ($ob, $path) = @_;
400
401 for my $o (all_objects $ob) {
402 if (my $value = $o->get_ob_key_value ("_perl_data")) {
403 $o->set_ob_key_value ("_perl_data");
404
405 %$o = %{ Storable::thaw pack "H*", $value };
406 }
407 }
408};
409
410*on_player_save = sub {
411 my ($ob, $path) = @_;
412
413 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
414 for grep %$_, all_objects $ob;
415};
416
417#############################################################################
418# core extensions - in perl
419
420=item cf::player::exists $login
421
422Returns true when the given account exists.
423
424=cut
425
426sub cf::player::exists($) {
427 cf::player::find $_[0]
428 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
429}
430
431=item $player->reply ($npc, $msg[, $flags]) 2569=item $player_object->reply ($npc, $msg[, $flags])
432 2570
433Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2571Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
434can be C<undef>. Does the right thing when the player is currently in a 2572can be C<undef>. Does the right thing when the player is currently in a
435dialogue with the given NPC character. 2573dialogue with the given NPC character.
436 2574
437=cut 2575=cut
438 2576
2577our $SAY_CHANNEL = {
2578 id => "say",
2579 title => "Map",
2580 reply => "say ",
2581 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2582};
2583
2584our $CHAT_CHANNEL = {
2585 id => "chat",
2586 title => "Chat",
2587 reply => "chat ",
2588 tooltip => "Player chat and shouts, global to the server.",
2589};
2590
439# rough implementation of a future "reply" method that works 2591# rough implementation of a future "reply" method that works
440# with dialog boxes. 2592# with dialog boxes.
2593#TODO: the first argument must go, split into a $npc->reply_to ( method
441sub cf::object::player::reply($$$;$) { 2594sub cf::object::player::reply($$$;$) {
442 my ($self, $npc, $msg, $flags) = @_; 2595 my ($self, $npc, $msg, $flags) = @_;
443 2596
444 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2597 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
445 2598
446 if ($self->{record_replies}) { 2599 if ($self->{record_replies}) {
447 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2600 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2601
448 } else { 2602 } else {
2603 my $pl = $self->contr;
2604
2605 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2606 my $dialog = $pl->{npc_dialog};
2607 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2608
2609 } else {
449 $msg = $npc->name . " says: $msg" if $npc; 2610 $msg = $npc->name . " says: $msg" if $npc;
450 $self->message ($msg, $flags); 2611 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2612 }
2613 }
2614}
2615
2616=item $object->send_msg ($channel, $msg, $color, [extra...])
2617
2618=cut
2619
2620sub cf::object::send_msg {
2621 my $pl = shift->contr
2622 or return;
2623 $pl->send_msg (@_);
2624}
2625
2626=item $player_object->may ("access")
2627
2628Returns wether the given player is authorized to access resource "access"
2629(e.g. "command_wizcast").
2630
2631=cut
2632
2633sub cf::object::player::may {
2634 my ($self, $access) = @_;
2635
2636 $self->flag (cf::FLAG_WIZ) ||
2637 (ref $cf::CFG{"may_$access"}
2638 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
2639 : $cf::CFG{"may_$access"})
2640}
2641
2642=item $player_object->enter_link
2643
2644Freezes the player and moves him/her to a special map (C<{link}>).
2645
2646The player should be reasonably safe there for short amounts of time (e.g.
2647for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2648though, as the player cannot control the character while it is on the link
2649map.
2650
2651Will never block.
2652
2653=item $player_object->leave_link ($map, $x, $y)
2654
2655Moves the player out of the special C<{link}> map onto the specified
2656map. If the map is not valid (or omitted), the player will be moved back
2657to the location he/she was before the call to C<enter_link>, or, if that
2658fails, to the emergency map position.
2659
2660Might block.
2661
2662=cut
2663
2664sub link_map {
2665 unless ($LINK_MAP) {
2666 $LINK_MAP = cf::map::find "{link}"
2667 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2668 $LINK_MAP->load;
2669 }
2670
2671 $LINK_MAP
2672}
2673
2674sub cf::object::player::enter_link {
2675 my ($self) = @_;
2676
2677 $self->deactivate_recursive;
2678
2679 ++$self->{_link_recursion};
2680
2681 return if UNIVERSAL::isa $self->map, "ext::map_link";
2682
2683 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2684 if $self->map && $self->map->{path} ne "{link}";
2685
2686 $self->enter_map ($LINK_MAP || link_map, 3, 3);
2687}
2688
2689sub cf::object::player::leave_link {
2690 my ($self, $map, $x, $y) = @_;
2691
2692 return unless $self->contr->active;
2693
2694 my $link_pos = delete $self->{_link_pos};
2695
2696 unless ($map) {
2697 # restore original map position
2698 ($map, $x, $y) = @{ $link_pos || [] };
2699 $map = cf::map::find $map;
2700
2701 unless ($map) {
2702 ($map, $x, $y) = @$EMERGENCY_POSITION;
2703 $map = cf::map::find $map
2704 or die "FATAL: cannot load emergency map\n";
2705 }
2706 }
2707
2708 ($x, $y) = (-1, -1)
2709 unless (defined $x) && (defined $y);
2710
2711 # use -1 or undef as default coordinates, not 0, 0
2712 ($x, $y) = ($map->enter_x, $map->enter_y)
2713 if $x <= 0 && $y <= 0;
2714
2715 $map->load;
2716 $map->load_neighbours;
2717
2718 return unless $self->contr->active;
2719
2720 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2721 if ($self->enter_map ($map, $x, $y)) {
2722 # entering was successful
2723 delete $self->{_link_recursion};
2724 # only activate afterwards, to support waiting in hooks
2725 $self->activate_recursive;
2726 }
2727
2728}
2729
2730=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
2731
2732Moves the player to the given map-path and coordinates by first freezing
2733her, loading and preparing them map, calling the provided $check callback
2734that has to return the map if sucecssful, and then unfreezes the player on
2735the new (success) or old (failed) map position. In either case, $done will
2736be called at the end of this process.
2737
2738Note that $check will be called with a potentially non-loaded map, so if
2739it needs a loaded map it has to call C<< ->load >>.
2740
2741=cut
2742
2743our $GOTOGEN;
2744
2745sub cf::object::player::goto {
2746 my ($self, $path, $x, $y, $check, $done) = @_;
2747
2748 if ($self->{_link_recursion} >= $MAX_LINKS) {
2749 error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
2750 $self->failmsg ("Something went wrong inside the server - please contact an administrator!");
2751 ($path, $x, $y) = @$EMERGENCY_POSITION;
2752 }
2753
2754 # do generation counting so two concurrent goto's will be executed in-order
2755 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2756
2757 $self->enter_link;
2758
2759 (async {
2760 $Coro::current->{desc} = "player::goto $path $x $y";
2761
2762 # *tag paths override both path and x|y
2763 if ($path =~ /^\*(.*)$/) {
2764 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2765 my $ob = $obs[rand @obs];
2766
2767 # see if we actually can go there
2768 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2769 $ob = $obs[rand @obs];
2770 } else {
2771 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2772 }
2773 # else put us there anyways for now #d#
2774
2775 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2776 } else {
2777 ($path, $x, $y) = (undef, undef, undef);
2778 }
2779 }
2780
2781 my $map = eval {
2782 my $map = defined $path ? cf::map::find $path : undef;
2783
2784 if ($map) {
2785 $map = $map->customise_for ($self);
2786 $map = $check->($map, $x, $y, $self) if $check && $map;
2787 } else {
2788 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2789 }
2790
2791 $map
2792 };
2793
2794 if ($@) {
2795 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2796 LOG llevError | logBacktrace, Carp::longmess $@;
2797 }
2798
2799 if ($gen == $self->{_goto_generation}) {
2800 delete $self->{_goto_generation};
2801 $self->leave_link ($map, $x, $y);
2802 }
2803
2804 $done->($self) if $done;
2805 })->prio (1);
2806}
2807
2808=item $player_object->enter_exit ($exit_object)
2809
2810=cut
2811
2812sub parse_random_map_params {
2813 my ($spec) = @_;
2814
2815 my $rmp = { # defaults
2816 xsize => (cf::rndm 15, 40),
2817 ysize => (cf::rndm 15, 40),
2818 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2819 #layout => string,
451 } 2820 };
452}
453 2821
2822 for (split /\n/, $spec) {
2823 my ($k, $v) = split /\s+/, $_, 2;
2824
2825 $rmp->{lc $k} = $v if (length $k) && (length $v);
2826 }
2827
2828 $rmp
2829}
2830
2831sub prepare_random_map {
2832 my ($exit) = @_;
2833
2834 # all this does is basically replace the /! path by
2835 # a new random map path (?random/...) with a seed
2836 # that depends on the exit object
2837
2838 my $rmp = parse_random_map_params $exit->msg;
2839
2840 if ($exit->map) {
2841 $rmp->{region} = $exit->region->name;
2842 $rmp->{origin_map} = $exit->map->path;
2843 $rmp->{origin_x} = $exit->x;
2844 $rmp->{origin_y} = $exit->y;
2845
2846 $exit->map->touch;
2847 }
2848
2849 $rmp->{random_seed} ||= $exit->random_seed;
2850
2851 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2852 my $md5 = Digest::MD5::md5_hex $data;
2853 my $meta = "$RANDOMDIR/$md5.meta";
2854
2855 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2856 aio_write $fh, 0, (length $data), $data, 0;
2857 undef $fh;
2858 aio_rename "$meta~", $meta;
2859
2860 my $slaying = "?random/$md5";
2861
2862 if ($exit->valid) {
2863 $exit->slaying ("?random/$md5");
2864 $exit->msg (undef);
2865 }
2866 }
2867}
2868
2869sub cf::object::player::enter_exit {
2870 my ($self, $exit) = @_;
2871
2872 return unless $self->type == cf::PLAYER;
2873
2874 $self->enter_link;
2875
2876 (async {
2877 $Coro::current->{desc} = "enter_exit";
2878
2879 unless (eval {
2880 $self->deactivate_recursive; # just to be sure
2881
2882 # random map handling
2883 {
2884 my $guard = cf::lock_acquire "exit_prepare:$exit";
2885
2886 prepare_random_map $exit
2887 if $exit->slaying eq "/!";
2888 }
2889
2890 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2891 my $x = $exit->stats->hp;
2892 my $y = $exit->stats->sp;
2893
2894 $self->goto ($map, $x, $y);
2895
2896 # if exit is damned, update players death & WoR home-position
2897 $self->contr->savebed ($map, $x, $y)
2898 if $exit->flag (cf::FLAG_DAMNED);
2899
2900 1
2901 }) {
2902 $self->message ("Something went wrong deep within the deliantra server. "
2903 . "I'll try to bring you back to the map you were before. "
2904 . "Please report this to the dungeon master!",
2905 cf::NDI_UNIQUE | cf::NDI_RED);
2906
2907 error "ERROR in enter_exit: $@";
2908 $self->leave_link;
2909 }
2910 })->prio (1);
2911}
2912
2913=head3 cf::client
2914
2915=over 4
2916
2917=item $client->send_drawinfo ($text, $flags)
2918
2919Sends a drawinfo packet to the client. Circumvents output buffering so
2920should not be used under normal circumstances.
2921
2922=cut
2923
2924sub cf::client::send_drawinfo {
2925 my ($self, $text, $flags) = @_;
2926
2927 utf8::encode $text;
2928 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2929}
2930
2931=item $client->send_big_packet ($pkt)
2932
2933Like C<send_packet>, but tries to compress large packets, and fragments
2934them as required.
2935
2936=cut
2937
2938our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2939
2940sub cf::client::send_big_packet {
2941 my ($self, $pkt) = @_;
2942
2943 # try lzf for large packets
2944 $pkt = "lzf " . Compress::LZF::compress $pkt
2945 if 1024 <= length $pkt and $self->{can_lzf};
2946
2947 # split very large packets
2948 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2949 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2950 $pkt = "frag";
2951 }
2952
2953 $self->send_packet ($pkt);
2954}
2955
2956=item $client->send_msg ($channel, $msg, $color, [extra...])
2957
2958Send a drawinfo or msg packet to the client, formatting the msg for the
2959client if neccessary. C<$type> should be a string identifying the type of
2960the message, with C<log> being the default. If C<$color> is negative, suppress
2961the message unless the client supports the msg packet.
2962
2963=cut
2964
2965# non-persistent channels (usually the info channel)
2966our %CHANNEL = (
2967 "c/motd" => {
2968 id => "infobox",
2969 title => "MOTD",
2970 reply => undef,
2971 tooltip => "The message of the day",
2972 },
2973 "c/identify" => {
2974 id => "infobox",
2975 title => "Identify",
2976 reply => undef,
2977 tooltip => "Items recently identified",
2978 },
2979 "c/examine" => {
2980 id => "infobox",
2981 title => "Examine",
2982 reply => undef,
2983 tooltip => "Signs and other items you examined",
2984 },
2985 "c/shopinfo" => {
2986 id => "infobox",
2987 title => "Shop Info",
2988 reply => undef,
2989 tooltip => "What your bargaining skill tells you about the shop",
2990 },
2991 "c/book" => {
2992 id => "infobox",
2993 title => "Book",
2994 reply => undef,
2995 tooltip => "The contents of a note or book",
2996 },
2997 "c/lookat" => {
2998 id => "infobox",
2999 title => "Look",
3000 reply => undef,
3001 tooltip => "What you saw there",
3002 },
3003 "c/who" => {
3004 id => "infobox",
3005 title => "Players",
3006 reply => undef,
3007 tooltip => "Shows players who are currently online",
3008 },
3009 "c/body" => {
3010 id => "infobox",
3011 title => "Body Parts",
3012 reply => undef,
3013 tooltip => "Shows which body parts you posess and are available",
3014 },
3015 "c/statistics" => {
3016 id => "infobox",
3017 title => "Statistics",
3018 reply => undef,
3019 tooltip => "Shows your primary statistics",
3020 },
3021 "c/skills" => {
3022 id => "infobox",
3023 title => "Skills",
3024 reply => undef,
3025 tooltip => "Shows your experience per skill and item power",
3026 },
3027 "c/shopitems" => {
3028 id => "infobox",
3029 title => "Shop Items",
3030 reply => undef,
3031 tooltip => "Shows the items currently for sale in this shop",
3032 },
3033 "c/resistances" => {
3034 id => "infobox",
3035 title => "Resistances",
3036 reply => undef,
3037 tooltip => "Shows your resistances",
3038 },
3039 "c/pets" => {
3040 id => "infobox",
3041 title => "Pets",
3042 reply => undef,
3043 tooltip => "Shows information abotu your pets/a specific pet",
3044 },
3045 "c/perceiveself" => {
3046 id => "infobox",
3047 title => "Perceive Self",
3048 reply => undef,
3049 tooltip => "You gained detailed knowledge about yourself",
3050 },
3051 "c/uptime" => {
3052 id => "infobox",
3053 title => "Uptime",
3054 reply => undef,
3055 tooltip => "How long the server has been running since last restart",
3056 },
3057 "c/mapinfo" => {
3058 id => "infobox",
3059 title => "Map Info",
3060 reply => undef,
3061 tooltip => "Information related to the maps",
3062 },
3063 "c/party" => {
3064 id => "party",
3065 title => "Party",
3066 reply => "gsay ",
3067 tooltip => "Messages and chat related to your party",
3068 },
3069 "c/death" => {
3070 id => "death",
3071 title => "Death",
3072 reply => undef,
3073 tooltip => "Reason for and more info about your most recent death",
3074 },
3075 "c/say" => $SAY_CHANNEL,
3076 "c/chat" => $CHAT_CHANNEL,
3077);
3078
3079sub cf::client::send_msg {
3080 my ($self, $channel, $msg, $color, @extra) = @_;
3081
3082 $msg = $self->pl->expand_cfpod ($msg)
3083 unless $color & cf::NDI_VERBATIM;
3084
3085 $color &= cf::NDI_CLIENT_MASK; # just in case...
3086
3087 # check predefined channels, for the benefit of C
3088 if ($CHANNEL{$channel}) {
3089 $channel = $CHANNEL{$channel};
3090
3091 $self->ext_msg (channel_info => $channel);
3092 $channel = $channel->{id};
3093
3094 } elsif (ref $channel) {
3095 # send meta info to client, if not yet sent
3096 unless (exists $self->{channel}{$channel->{id}}) {
3097 $self->{channel}{$channel->{id}} = $channel;
3098 $self->ext_msg (channel_info => $channel);
3099 }
3100
3101 $channel = $channel->{id};
3102 }
3103
3104 return unless @extra || length $msg;
3105
3106 # default colour, mask it out
3107 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3108 if $color & cf::NDI_DEF;
3109
3110 my $pkt = "msg "
3111 . $self->{json_coder}->encode (
3112 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3113 );
3114
3115 $self->send_big_packet ($pkt);
3116}
3117
3118=item $client->ext_msg ($type, @msg)
3119
3120Sends an ext event to the client.
3121
3122=cut
3123
3124sub cf::client::ext_msg($$@) {
3125 my ($self, $type, @msg) = @_;
3126
3127 if ($self->extcmd == 2) {
3128 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
3129 } elsif ($self->extcmd == 1) { # TODO: remove
3130 push @msg, msgtype => "event_$type";
3131 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3132 }
3133}
3134
454=item $player->ext_reply ($msgid, $msgtype, %msg) 3135=item $client->ext_reply ($msgid, @msg)
455 3136
456Sends an ext reply to the player. 3137Sends an ext reply to the client.
457 3138
458=cut 3139=cut
459 3140
460sub cf::player::ext_reply($$$%) { 3141sub cf::client::ext_reply($$@) {
461 my ($self, $id, %msg) = @_; 3142 my ($self, $id, @msg) = @_;
462 3143
463 $msg{msgid} = $id; 3144 if ($self->extcmd == 2) {
464 3145 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
465 $self->send ("ext " . to_json \%msg); 3146 } elsif ($self->extcmd == 1) {
3147 #TODO: version 1, remove
3148 unshift @msg, msgtype => "reply", msgid => $id;
3149 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3150 }
466} 3151}
467 3152
468############################################################################# 3153=item $success = $client->query ($flags, "text", \&cb)
469# map scripting support
470 3154
3155Queues a query to the client, calling the given callback with
3156the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
3157C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
3158
3159Queries can fail, so check the return code. Or don't, as queries will
3160become reliable at some point in the future.
3161
3162=cut
3163
3164sub cf::client::query {
3165 my ($self, $flags, $text, $cb) = @_;
3166
3167 return unless $self->state == ST_PLAYING
3168 || $self->state == ST_SETUP
3169 || $self->state == ST_CUSTOM;
3170
3171 $self->state (ST_CUSTOM);
3172
3173 utf8::encode $text;
3174 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
3175
3176 $self->send_packet ($self->{query_queue}[0][0])
3177 if @{ $self->{query_queue} } == 1;
3178
3179 1
3180}
3181
3182cf::client->attach (
3183 on_connect => sub {
3184 my ($ns) = @_;
3185
3186 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3187 },
3188 on_reply => sub {
3189 my ($ns, $msg) = @_;
3190
3191 # this weird shuffling is so that direct followup queries
3192 # get handled first
3193 my $queue = delete $ns->{query_queue}
3194 or return; # be conservative, not sure how that can happen, but we saw a crash here
3195
3196 (shift @$queue)->[1]->($msg);
3197 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
3198
3199 push @{ $ns->{query_queue} }, @$queue;
3200
3201 if (@{ $ns->{query_queue} } == @$queue) {
3202 if (@$queue) {
3203 $ns->send_packet ($ns->{query_queue}[0][0]);
3204 } else {
3205 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
3206 }
3207 }
3208 },
3209 on_exticmd => sub {
3210 my ($ns, $buf) = @_;
3211
3212 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3213
3214 if (ref $msg) {
3215 my ($type, $reply, @payload) =
3216 "ARRAY" eq ref $msg
3217 ? @$msg
3218 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3219
3220 my @reply;
3221
3222 if (my $cb = $EXTICMD{$type}) {
3223 @reply = $cb->($ns, @payload);
3224 }
3225
3226 $ns->ext_reply ($reply, @reply)
3227 if $reply;
3228
3229 } else {
3230 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3231 }
3232
3233 cf::override;
3234 },
3235);
3236
3237=item $client->async (\&cb)
3238
3239Create a new coroutine, running the specified callback. The coroutine will
3240be automatically cancelled when the client gets destroyed (e.g. on logout,
3241or loss of connection).
3242
3243=cut
3244
3245sub cf::client::async {
3246 my ($self, $cb) = @_;
3247
3248 my $coro = &Coro::async ($cb);
3249
3250 $coro->on_destroy (sub {
3251 delete $self->{_coro}{$coro+0};
3252 });
3253
3254 $self->{_coro}{$coro+0} = $coro;
3255
3256 $coro
3257}
3258
3259cf::client->attach (
3260 on_client_destroy => sub {
3261 my ($ns) = @_;
3262
3263 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
3264 },
3265);
3266
3267=back
3268
3269
3270=head2 SAFE SCRIPTING
3271
3272Functions that provide a safe environment to compile and execute
3273snippets of perl code without them endangering the safety of the server
3274itself. Looping constructs, I/O operators and other built-in functionality
3275is not available in the safe scripting environment, and the number of
3276functions and methods that can be called is greatly reduced.
3277
3278=cut
3279
471our $safe = new Safe "ext"; 3280our $safe = new Safe "safe";
472our $safe_hole = new Safe::Hole; 3281our $safe_hole = new Safe::Hole;
473 3282
474$SIG{FPE} = 'IGNORE'; 3283$SIG{FPE} = 'IGNORE';
475 3284
476$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3285$safe->permit_only (Opcode::opset qw(
3286 :base_core :base_mem :base_orig :base_math :base_loop
3287 grepstart grepwhile mapstart mapwhile
3288 sort time
3289));
477 3290
478# here we export the classes and methods available to script code 3291# here we export the classes and methods available to script code
479 3292
3293=pod
3294
3295The following functions and methods are available within a safe environment:
3296
3297 cf::object
3298 contr pay_amount pay_player map x y force_find force_add destroy
3299 insert remove name archname title slaying race decrease split
3300 value
3301
3302 cf::object::player
3303 player
3304
3305 cf::player
3306 peaceful
3307
3308 cf::map
3309 trigger
3310
3311=cut
3312
480for ( 3313for (
481 ["cf::object" => qw(contr pay_amount pay_player)], 3314 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3315 insert remove inv nrof name archname title slaying race
3316 decrease split destroy change_exp value msg lore send_msg)],
482 ["cf::object::player" => qw(player)], 3317 ["cf::object::player" => qw(player)],
483 ["cf::player" => qw(peaceful)], 3318 ["cf::player" => qw(peaceful send_msg)],
3319 ["cf::map" => qw(trigger)],
484) { 3320) {
485 no strict 'refs';
486 my ($pkg, @funs) = @$_; 3321 my ($pkg, @funs) = @$_;
487 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3322 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
488 for @funs; 3323 for @funs;
489} 3324}
3325
3326=over 4
3327
3328=item @retval = safe_eval $code, [var => value, ...]
3329
3330Compiled and executes the given perl code snippet. additional var/value
3331pairs result in temporary local (my) scalar variables of the given name
3332that are available in the code snippet. Example:
3333
3334 my $five = safe_eval '$first + $second', first => 1, second => 4;
3335
3336=cut
490 3337
491sub safe_eval($;@) { 3338sub safe_eval($;@) {
492 my ($code, %vars) = @_; 3339 my ($code, %vars) = @_;
493 3340
494 my $qcode = $code; 3341 my $qcode = $code;
495 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3342 $qcode =~ s/"/‟/g; # not allowed in #line filenames
496 $qcode =~ s/\n/\\n/g; 3343 $qcode =~ s/\n/\\n/g;
497 3344
3345 %vars = (_dummy => 0) unless %vars;
3346
3347 my @res;
498 local $_; 3348 local $_;
499 local @ext::cf::_safe_eval_args = values %vars;
500 3349
501 $code = 3350 my $eval =
502 "do {\n" 3351 "do {\n"
503 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3352 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
504 . "#line 0 \"{$qcode}\"\n" 3353 . "#line 0 \"{$qcode}\"\n"
505 . $code 3354 . $code
506 . "\n}" 3355 . "\n}"
507 ; 3356 ;
508 3357
3358 if ($CFG{safe_eval}) {
509 sub_generation_inc; 3359 sub_generation_inc;
3360 local @safe::cf::_safe_eval_args = values %vars;
510 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 3361 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
511 sub_generation_inc; 3362 sub_generation_inc;
3363 } else {
3364 local @cf::_safe_eval_args = values %vars;
3365 @res = wantarray ? eval eval : scalar eval $eval;
3366 }
3367
3368 if ($@) {
3369 warn "$@",
3370 "while executing safe code '$code'\n",
3371 "with arguments " . (join " ", %vars) . "\n";
3372 }
512 3373
513 wantarray ? @res : $res[0] 3374 wantarray ? @res : $res[0]
514} 3375}
3376
3377=item cf::register_script_function $function => $cb
3378
3379Register a function that can be called from within map/npc scripts. The
3380function should be reasonably secure and should be put into a package name
3381like the extension.
3382
3383Example: register a function that gets called whenever a map script calls
3384C<rent::overview>, as used by the C<rent> extension.
3385
3386 cf::register_script_function "rent::overview" => sub {
3387 ...
3388 };
3389
3390=cut
515 3391
516sub register_script_function { 3392sub register_script_function {
517 my ($fun, $cb) = @_; 3393 my ($fun, $cb) = @_;
518 3394
519 no strict 'refs'; 3395 $fun = "safe::$fun" if $CFG{safe_eval};
520 *{"ext::$fun"} = $safe_hole->wrap ($cb); 3396 *$fun = $safe_hole->wrap ($cb);
521} 3397}
3398
3399=back
3400
3401=cut
522 3402
523############################################################################# 3403#############################################################################
524# the server's main() 3404# the server's init and main functions
525 3405
526sub run { 3406sub load_facedata($) {
527 Event::loop; 3407 my ($path) = @_;
3408
3409 # HACK to clear player env face cache, we need some signal framework
3410 # for this (global event?)
3411 %ext::player_env::MUSIC_FACE_CACHE = ();
3412
3413 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3414
3415 trace "loading facedata from $path\n";
3416
3417 0 < aio_load $path, my $facedata
3418 or die "$path: $!";
3419
3420 $facedata = Coro::Storable::thaw $facedata;
3421
3422 $facedata->{version} == 2
3423 or cf::cleanup "$path: version mismatch, cannot proceed.";
3424
3425 # patch in the exptable
3426 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3427 $facedata->{resource}{"res/exp_table"} = {
3428 type => FT_RSRC,
3429 data => $exp_table,
3430 hash => (Digest::MD5::md5 $exp_table),
3431 };
3432 cf::cede_to_tick;
3433
3434 {
3435 my $faces = $facedata->{faceinfo};
3436
3437 while (my ($face, $info) = each %$faces) {
3438 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3439
3440 cf::face::set_visibility $idx, $info->{visibility};
3441 cf::face::set_magicmap $idx, $info->{magicmap};
3442 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
3443 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
3444
3445 cf::cede_to_tick;
3446 }
3447
3448 while (my ($face, $info) = each %$faces) {
3449 next unless $info->{smooth};
3450
3451 my $idx = cf::face::find $face
3452 or next;
3453
3454 if (my $smooth = cf::face::find $info->{smooth}) {
3455 cf::face::set_smooth $idx, $smooth;
3456 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3457 } else {
3458 error "smooth face '$info->{smooth}' not found for face '$face'";
3459 }
3460
3461 cf::cede_to_tick;
3462 }
3463 }
3464
3465 {
3466 my $anims = $facedata->{animinfo};
3467
3468 while (my ($anim, $info) = each %$anims) {
3469 cf::anim::set $anim, $info->{frames}, $info->{facings};
3470 cf::cede_to_tick;
3471 }
3472
3473 cf::anim::invalidate_all; # d'oh
3474 }
3475
3476 {
3477 my $res = $facedata->{resource};
3478
3479 while (my ($name, $info) = each %$res) {
3480 if (defined $info->{type}) {
3481 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3482
3483 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3484 cf::face::set_type $idx, $info->{type};
3485 } else {
3486 $RESOURCE{$name} = $info; # unused
3487 }
3488
3489 cf::cede_to_tick;
3490 }
3491 }
3492
3493 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3494
3495 1
3496}
3497
3498register_exticmd fx_want => sub {
3499 my ($ns, $want) = @_;
3500
3501 while (my ($k, $v) = each %$want) {
3502 $ns->fx_want ($k, $v);
3503 }
3504};
3505
3506sub load_resource_file($) {
3507 my $guard = lock_acquire "load_resource_file";
3508
3509 my $status = load_resource_file_ $_[0];
3510 get_slot 0.1, 100;
3511 cf::arch::commit_load;
3512
3513 $status
3514}
3515
3516sub reload_regions {
3517 # HACK to clear player env face cache, we need some signal framework
3518 # for this (global event?)
3519 %ext::player_env::MUSIC_FACE_CACHE = ();
3520
3521 load_resource_file "$MAPDIR/regions"
3522 or die "unable to load regions file\n";
3523
3524 for (cf::region::list) {
3525 $_->{match} = qr/$_->{match}/
3526 if exists $_->{match};
3527 }
3528}
3529
3530sub reload_facedata {
3531 load_facedata "$DATADIR/facedata"
3532 or die "unable to load facedata\n";
3533}
3534
3535sub reload_archetypes {
3536 load_resource_file "$DATADIR/archetypes"
3537 or die "unable to load archetypes\n";
3538}
3539
3540sub reload_treasures {
3541 load_resource_file "$DATADIR/treasures"
3542 or die "unable to load treasurelists\n";
3543}
3544
3545sub reload_sound {
3546 trace "loading sound config from $DATADIR/sound\n";
3547
3548 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3549 or die "$DATADIR/sound $!";
3550
3551 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3552
3553 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3554 my $sound = $soundconf->{compat}[$_]
3555 or next;
3556
3557 my $face = cf::face::find "sound/$sound->[1]";
3558 cf::sound::set $sound->[0] => $face;
3559 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3560 }
3561
3562 while (my ($k, $v) = each %{$soundconf->{event}}) {
3563 my $face = cf::face::find "sound/$v";
3564 cf::sound::set $k => $face;
3565 }
3566}
3567
3568sub reload_resources {
3569 trace "reloading resource files...\n";
3570
3571 reload_exp_table;
3572 reload_materials;
3573 reload_facedata;
3574 reload_sound;
3575 reload_archetypes;
3576 reload_regions;
3577 reload_treasures;
3578
3579 trace "finished reloading resource files\n";
3580}
3581
3582sub reload_config {
3583 trace "reloading config file...\n";
3584
3585 0 < aio_load "$CONFDIR/config", my $config
3586 or die "$CONFDIR/config: $!";
3587
3588 utf8::decode $config;
3589 *CFG = yaml_load $config;
3590
3591 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
3592
3593 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3594 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3595
3596 if (exists $CFG{mlockall}) {
3597 eval {
3598 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3599 and die "WARNING: m(un)lockall failed: $!\n";
3600 };
3601 warn $@ if $@;
3602 }
3603}
3604
3605sub pidfile() {
3606 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3607 or die "$PIDFILE: $!";
3608 flock $fh, &Fcntl::LOCK_EX
3609 or die "$PIDFILE: flock: $!";
3610 $fh
3611}
3612
3613# make sure only one server instance is running at any one time
3614sub atomic {
3615 my $fh = pidfile;
3616
3617 my $pid = <$fh>;
3618 kill 9, $pid if $pid > 0;
3619
3620 seek $fh, 0, 0;
3621 print $fh $$;
3622}
3623
3624sub main_loop {
3625 trace "EV::loop starting\n";
3626 if (1) {
3627 EV::loop;
3628 }
3629 trace "EV::loop returned\n";
3630 goto &main_loop unless $REALLY_UNLOOP;
3631}
3632
3633sub main {
3634 cf::init_globals; # initialise logging
3635
3636 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3637 LOG llevInfo, "Copyright (C) 2005-2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3638 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3639 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3640
3641 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3642
3643 # we must not ever block the main coroutine
3644 local $Coro::idle = sub {
3645 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3646 (async {
3647 $Coro::current->{desc} = "IDLE BUG HANDLER";
3648 EV::loop EV::LOOP_ONESHOT;
3649 })->prio (Coro::PRIO_MAX);
3650 };
3651
3652 evthread_start IO::AIO::poll_fileno;
3653
3654 cf::sync_job {
3655 cf::incloader::init ();
3656
3657 cf::init_anim;
3658 cf::init_attackmess;
3659 cf::init_dynamic;
3660
3661 cf::load_settings;
3662
3663 reload_resources;
3664 reload_config;
3665 db_init;
3666
3667 cf::init_uuid;
3668 cf::init_signals;
3669 cf::init_skills;
3670
3671 cf::init_beforeplay;
3672
3673 atomic;
3674
3675 load_extensions;
3676
3677 utime time, time, $RUNTIMEFILE;
3678
3679 # no (long-running) fork's whatsoever before this point(!)
3680 use POSIX ();
3681 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3682
3683 cf::_post_init 0;
3684 };
3685
3686 cf::object::thawer::errors_are_fatal 0;
3687 info "parse errors in files are no longer fatal from this point on.\n";
3688
3689 my $free_main; $free_main = EV::idle sub {
3690 undef $free_main;
3691 undef &main; # free gobs of memory :)
3692 };
3693
3694 goto &main_loop;
528} 3695}
529 3696
530############################################################################# 3697#############################################################################
531# initialisation 3698# initialisation and cleanup
532 3699
533register "<global>", __PACKAGE__; 3700# install some emergency cleanup handlers
3701BEGIN {
3702 our %SIGWATCHER = ();
3703 for my $signal (qw(INT HUP TERM)) {
3704 $SIGWATCHER{$signal} = AE::signal $signal, sub {
3705 cf::cleanup "SIG$signal";
3706 };
3707 }
3708}
534 3709
535unshift @INC, $LIBDIR; 3710sub write_runtime_sync {
3711 my $t0 = AE::time;
536 3712
537load_extensions; 3713 # first touch the runtime file to show we are still running:
3714 # the fsync below can take a very very long time.
538 3715
539$TICK_WATCHER = Event->timer ( 3716 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
540 prio => 1, 3717
541 at => $NEXT_TICK || 1, 3718 my $guard = cf::lock_acquire "write_runtime";
542 cb => sub { 3719
3720 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3721 or return;
3722
3723 my $value = $cf::RUNTIME + 90 + 10;
3724 # 10 is the runtime save interval, for a monotonic clock
3725 # 60 allows for the watchdog to kill the server.
3726
3727 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3728 and return;
3729
3730 # always fsync - this file is important
3731 aio_fsync $fh
3732 and return;
3733
3734 # touch it again to show we are up-to-date
3735 aio_utime $fh, undef, undef;
3736
3737 close $fh
3738 or return;
3739
3740 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3741 and return;
3742
3743 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3744
3745 1
3746}
3747
3748our $uuid_lock;
3749our $uuid_skip;
3750
3751sub write_uuid_sync($) {
3752 $uuid_skip ||= $_[0];
3753
3754 return if $uuid_lock;
3755 local $uuid_lock = 1;
3756
3757 my $uuid = "$LOCALDIR/uuid";
3758
3759 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3760 or return;
3761
3762 my $value = uuid_seq uuid_cur;
3763
3764 unless ($value) {
3765 info "cowardly refusing to write zero uuid value!\n";
3766 return;
3767 }
3768
3769 my $value = uuid_str $value + $uuid_skip;
3770 $uuid_skip = 0;
3771
3772 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3773 and return;
3774
3775 # always fsync - this file is important
3776 aio_fsync $fh
3777 and return;
3778
3779 close $fh
3780 or return;
3781
3782 aio_rename "$uuid~", $uuid
3783 and return;
3784
3785 trace "uuid file written ($value).\n";
3786
3787 1
3788
3789}
3790
3791sub write_uuid($$) {
3792 my ($skip, $sync) = @_;
3793
3794 $sync ? write_uuid_sync $skip
3795 : async { write_uuid_sync $skip };
3796}
3797
3798sub emergency_save() {
3799 my $freeze_guard = cf::freeze_mainloop;
3800
3801 info "emergency_perl_save: enter\n";
3802
3803 # this is a trade-off: we want to be very quick here, so
3804 # save all maps without fsync, and later call a global sync
3805 # (which in turn might be very very slow)
3806 local $USE_FSYNC = 0;
3807
3808 cf::sync_job {
3809 cf::write_runtime_sync; # external watchdog should not bark
3810
3811 # use a peculiar iteration method to avoid tripping on perl
3812 # refcount bugs in for. also avoids problems with players
3813 # and maps saved/destroyed asynchronously.
3814 info "emergency_perl_save: begin player save\n";
3815 for my $login (keys %cf::PLAYER) {
3816 my $pl = $cf::PLAYER{$login} or next;
3817 $pl->valid or next;
3818 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3819 $pl->save;
3820 }
3821 info "emergency_perl_save: end player save\n";
3822
3823 cf::write_runtime_sync; # external watchdog should not bark
3824
3825 info "emergency_perl_save: begin map save\n";
3826 for my $path (keys %cf::MAP) {
3827 my $map = $cf::MAP{$path} or next;
3828 $map->valid or next;
3829 $map->save;
3830 }
3831 info "emergency_perl_save: end map save\n";
3832
3833 cf::write_runtime_sync; # external watchdog should not bark
3834
3835 info "emergency_perl_save: begin database checkpoint\n";
3836 BDB::db_env_txn_checkpoint $DB_ENV;
3837 info "emergency_perl_save: end database checkpoint\n";
3838
3839 info "emergency_perl_save: begin write uuid\n";
3840 write_uuid_sync 1;
3841 info "emergency_perl_save: end write uuid\n";
3842
3843 cf::write_runtime_sync; # external watchdog should not bark
3844
3845 trace "emergency_perl_save: syncing database to disk";
3846 BDB::db_env_txn_checkpoint $DB_ENV;
3847
3848 info "emergency_perl_save: starting sync\n";
3849 IO::AIO::aio_sync sub {
3850 info "emergency_perl_save: finished sync\n";
3851 };
3852
3853 cf::write_runtime_sync; # external watchdog should not bark
3854
3855 trace "emergency_perl_save: flushing outstanding aio requests";
3856 while (IO::AIO::nreqs || BDB::nreqs) {
3857 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3858 }
3859
3860 cf::write_runtime_sync; # external watchdog should not bark
3861 };
3862
3863 info "emergency_perl_save: leave\n";
3864}
3865
3866sub post_cleanup {
3867 my ($make_core) = @_;
3868
3869 IO::AIO::flush;
3870
3871 error Carp::longmess "post_cleanup backtrace"
3872 if $make_core;
3873
3874 my $fh = pidfile;
3875 unlink $PIDFILE if <$fh> == $$;
3876}
3877
3878# a safer delete_package, copied from Symbol
3879sub clear_package($) {
3880 my $pkg = shift;
3881
3882 # expand to full symbol table name if needed
3883 unless ($pkg =~ /^main::.*::$/) {
3884 $pkg = "main$pkg" if $pkg =~ /^::/;
3885 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3886 $pkg .= '::' unless $pkg =~ /::$/;
3887 }
3888
3889 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3890 my $stem_symtab = *{$stem}{HASH};
3891
3892 defined $stem_symtab and exists $stem_symtab->{$leaf}
3893 or return;
3894
3895 # clear all symbols
3896 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3897 for my $name (keys %$leaf_symtab) {
3898 _gv_clear *{"$pkg$name"};
3899# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3900 }
3901}
3902
3903sub do_reload_perl() {
3904 # can/must only be called in main
3905 unless (in_main) {
3906 error "can only reload from main coroutine";
3907 return;
3908 }
3909
3910 return if $RELOAD++;
3911
3912 my $t1 = AE::time;
3913
3914 while ($RELOAD) {
3915 cf::get_slot 0.1, -1, "reload_perl";
3916 info "perl_reload: reloading...";
3917
3918 trace "perl_reload: entering sync_job";
3919
3920 cf::sync_job {
3921 #cf::emergency_save;
3922
3923 trace "perl_reload: cancelling all extension coros";
3924 $_->cancel for values %EXT_CORO;
3925 %EXT_CORO = ();
3926
3927 trace "perl_reload: removing commands";
3928 %COMMAND = ();
3929
3930 trace "perl_reload: removing ext/exti commands";
3931 %EXTCMD = ();
3932 %EXTICMD = ();
3933
3934 trace "perl_reload: unloading/nuking all extensions";
3935 for my $pkg (@EXTS) {
3936 trace "... unloading $pkg";
3937
3938 if (my $cb = $pkg->can ("unload")) {
3939 eval {
3940 $cb->($pkg);
3941 1
3942 } or error "$pkg unloaded, but with errors: $@";
3943 }
3944
3945 trace "... clearing $pkg";
3946 clear_package $pkg;
3947 }
3948
3949 trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
3950 while (my ($k, $v) = each %INC) {
3951 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3952
3953 trace "... unloading $k";
3954 delete $INC{$k};
3955
3956 $k =~ s/\.pm$//;
3957 $k =~ s/\//::/g;
3958
3959 if (my $cb = $k->can ("unload_module")) {
3960 $cb->();
3961 }
3962
3963 clear_package $k;
3964 }
3965
3966 trace "perl_reload: getting rid of safe::, as good as possible";
3967 clear_package "safe::$_"
3968 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3969
3970 trace "perl_reload: unloading cf.pm \"a bit\"";
3971 delete $INC{"cf.pm"};
3972 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
3973
3974 # don't, removes xs symbols, too,
3975 # and global variables created in xs
3976 #clear_package __PACKAGE__;
3977
3978 info "perl_reload: unload completed, starting to reload now";
3979
3980 trace "perl_reload: reloading cf.pm";
3981 require cf;
3982 cf::_connect_to_perl_1;
3983
3984 trace "perl_reload: loading config and database again";
3985 cf::reload_config;
3986
3987 trace "perl_reload: loading extensions";
3988 cf::load_extensions;
3989
3990 if ($REATTACH_ON_RELOAD) {
3991 trace "perl_reload: reattaching attachments to objects/players";
3992 _global_reattach; # objects, sockets
3993 trace "perl_reload: reattaching attachments to maps";
3994 reattach $_ for values %MAP;
3995 trace "perl_reload: reattaching attachments to players";
3996 reattach $_ for values %PLAYER;
3997 }
3998
3999 cf::_post_init 1;
4000
4001 trace "perl_reload: leaving sync_job";
4002
4003 1
4004 } or do {
4005 error $@;
4006 cf::cleanup "perl_reload: error, exiting.";
4007 };
4008
4009 --$RELOAD;
4010 }
4011
4012 $t1 = AE::time - $t1;
4013 info "perl_reload: completed in ${t1}s\n";
4014};
4015
4016our $RELOAD_WATCHER; # used only during reload
4017
4018sub reload_perl() {
4019 # doing reload synchronously and two reloads happen back-to-back,
4020 # coro crashes during coro_state_free->destroy here.
4021
4022 $RELOAD_WATCHER ||= cf::async {
4023 Coro::AIO::aio_wait cache_extensions;
4024
4025 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
4026 do_reload_perl;
4027 undef $RELOAD_WATCHER;
4028 };
4029 };
4030}
4031
4032register_command "reload" => sub {
4033 my ($who, $arg) = @_;
4034
4035 if ($who->flag (FLAG_WIZ)) {
4036 $who->message ("reloading server.");
4037 async {
4038 $Coro::current->{desc} = "perl_reload";
4039 reload_perl;
4040 };
4041 }
4042};
4043
4044#############################################################################
4045
4046my $bug_warning = 0;
4047
4048our @WAIT_FOR_TICK;
4049our @WAIT_FOR_TICK_BEGIN;
4050
4051sub wait_for_tick() {
4052 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4053
4054 my $signal = new Coro::Signal;
4055 push @WAIT_FOR_TICK, $signal;
4056 $signal->wait;
4057}
4058
4059sub wait_for_tick_begin() {
4060 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4061
4062 my $signal = new Coro::Signal;
4063 push @WAIT_FOR_TICK_BEGIN, $signal;
4064 $signal->wait;
4065}
4066
4067sub tick {
4068 if ($Coro::current != $Coro::main) {
4069 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
4070 unless ++$bug_warning > 10;
4071 return;
4072 }
4073
543 cf::server_tick; # one server iteration 4074 cf::server_tick; # one server iteration
544 4075
545 my $NOW = Event::time; 4076 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
546 $NEXT_TICK += $TICK;
547 4077
548 # if we are delayed by > 0.25 second, skip ticks 4078 if ($NOW >= $NEXT_RUNTIME_WRITE) {
549 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + .25; 4079 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
550 4080 Coro::async_pool {
551 $TICK_WATCHER->at ($NEXT_TICK); 4081 $Coro::current->{desc} = "runtime saver";
552 $TICK_WATCHER->start; 4082 write_runtime_sync
4083 or error "ERROR: unable to write runtime file: $!";
4084 };
553 }, 4085 }
554); 4086
4087 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4088 $sig->send;
4089 }
4090 while (my $sig = shift @WAIT_FOR_TICK) {
4091 $sig->send;
4092 }
4093
4094 $LOAD = ($NOW - $TICK_START) / $TICK;
4095 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4096
4097 if (0) {
4098 if ($NEXT_TICK) {
4099 my $jitter = $TICK_START - $NEXT_TICK;
4100 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4101 debug "jitter $JITTER\n";#d#
4102 }
4103 }
4104}
4105
4106{
4107 # configure BDB
4108
4109 BDB::min_parallel 16;
4110 BDB::max_poll_reqs $TICK * 0.1;
4111 $AnyEvent::BDB::WATCHER->priority (1);
4112
4113 unless ($DB_ENV) {
4114 $DB_ENV = BDB::db_env_create;
4115 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4116 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4117 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4118 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4119 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4120
4121 cf::sync_job {
4122 eval {
4123 BDB::db_env_open
4124 $DB_ENV,
4125 $BDBDIR,
4126 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4127 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4128 0666;
4129
4130 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
4131 };
4132
4133 cf::cleanup "db_env_open(db): $@" if $@;
4134 };
4135 }
4136
4137 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4138 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4139 };
4140 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4141 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4142 };
4143 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4144 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4145 };
4146}
4147
4148{
4149 # configure IO::AIO
4150
4151 IO::AIO::min_parallel 8;
4152 IO::AIO::max_poll_time $TICK * 0.1;
4153 undef $AnyEvent::AIO::WATCHER;
4154}
4155
4156our $_log_backtrace;
4157our $_log_backtrace_last;
4158
4159sub _log_backtrace {
4160 my ($msg, @addr) = @_;
4161
4162 $msg =~ s/\n$//;
4163
4164 if ($_log_backtrace_last eq $msg) {
4165 LOG llevInfo, "[ABT] $msg\n";
4166 LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
4167 # limit the # of concurrent backtraces
4168 } elsif ($_log_backtrace < 2) {
4169 $_log_backtrace_last = $msg;
4170 ++$_log_backtrace;
4171 my $perl_bt = Carp::longmess $msg;
4172 async {
4173 $Coro::current->{desc} = "abt $msg";
4174
4175 my @bt = fork_call {
4176 @addr = map { sprintf "%x", $_ } @addr;
4177 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4178 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4179 or die "addr2line: $!";
4180
4181 my @funcs;
4182 my @res = <$fh>;
4183 chomp for @res;
4184 while (@res) {
4185 my ($func, $line) = splice @res, 0, 2, ();
4186 push @funcs, "[$func] $line";
4187 }
4188
4189 @funcs
4190 };
4191
4192 LOG llevInfo, "[ABT] $perl_bt\n";
4193 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4194 LOG llevInfo, "[ABT] $_\n" for @bt;
4195 --$_log_backtrace;
4196 };
4197 } else {
4198 LOG llevInfo, "[ABT] $msg\n";
4199 LOG llevInfo, "[ABT] [overload, suppressed]\n";
4200 }
4201}
4202
4203# load additional modules
4204require "cf/$_.pm" for @EXTRA_MODULES;
4205cf::_connect_to_perl_2;
4206
4207END { cf::emergency_save }
555 4208
5561 42091
557 4210

Diff Legend

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