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.48 by root, Sun Aug 27 15:24:22 2006 UTC vs.
Revision 1.624 by root, Sat Nov 17 23:40:02 2018 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines