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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines