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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.554 by root, Sat Jun 26 22:10:18 2010 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines