ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.202 by root, Mon Jan 29 20:16:28 2007 UTC vs.
Revision 1.446 by root, Tue Sep 16 16:03:02 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines