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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines