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.96 by root, Fri Dec 22 06:02:29 2006 UTC vs.
Revision 1.609 by root, Tue Nov 20 14:30:22 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines