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.267 by root, Sat May 19 00:08:11 2007 UTC vs.
Revision 1.624 by root, Sat Nov 17 23:40:02 2018 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines