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.82 by root, Sun Dec 3 20:59:52 2006 UTC vs.
Revision 1.593 by root, Fri Nov 9 01:59:33 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines