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.157 by root, Wed Jan 10 01:16:54 2007 UTC vs.
Revision 1.624 by root, Sat Nov 17 23:40:02 2018 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines