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.62 by root, Fri Sep 8 16:51:44 2006 UTC vs.
Revision 1.600 by root, Sun Nov 11 04:31:57 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines