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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines