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.164 by root, Thu Jan 11 01:24:25 2007 UTC vs.
Revision 1.617 by root, Mon Aug 10 18:46:04 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines