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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.511 by root, Wed Apr 7 18:35:56 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines