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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines