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.158 by root, Wed Jan 10 19:52:43 2007 UTC vs.
Revision 1.616 by root, Mon Aug 10 03:05:30 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines