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.256 by root, Sat Apr 21 16:56:32 2007 UTC vs.
Revision 1.623 by root, Wed Aug 30 14:18:51 2017 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines