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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines