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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.364 by root, Tue Sep 11 08:41:11 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.64 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
24use Coro::Util ();
19 25
26use JSON::XS ();
27use BDB ();
28use Data::Dumper;
20use Digest::MD5; 29use Digest::MD5;
21use Fcntl; 30use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 31use YAML::Syck ();
32use IO::AIO 2.32 ();
24use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
25 36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
42
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
27 44
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 45# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
30 47
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 48$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 49
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 51
35our %COMMAND = (); 52our %COMMAND = ();
36our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
54
55our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
58our %EXT_CORO = (); # coroutines bound to extensions
59our %EXT_MAP = (); # pluggable maps
38 60
61our $RELOAD; # number of reloads so far
39our @EVENT; 62our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 63
42our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43our $TICK_WATCHER; 77our $TICK_WATCHER;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 80our $NEXT_TICK;
45our $NOW; 81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $BDB_CHECKPOINT_WATCHER;
86our $BDB_TRICKLE_WATCHER;
87our $DB_ENV;
46 88
47our %CFG; 89our %CFG;
48 90
49our $UPTIME; $UPTIME ||= time; 91our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 92our $RUNTIME;
51 93
52our %MAP; # all maps 94our (%PLAYER, %PLAYER_LOADING); # all users
53our $LINK_MAP; # the special {link} map 95our (%MAP, %MAP_LOADING ); # all maps
54our $RANDOM_MAPS = cf::localdir . "/random"; 96our $LINK_MAP; # the special {link} map, which is always available
55our %EXT_CORO; 97
98# used to convert map paths into valid unix filenames by replacing / by ∕
99our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
100
101our $LOAD; # a number between 0 (idle) and 1 (too many objects)
102our $LOADAVG; # same thing, but with alpha-smoothing
103our $tick_start; # for load detecting purposes
56 104
57binmode STDOUT; 105binmode STDOUT;
58binmode STDERR; 106binmode STDERR;
59 107
60# read virtual server time, if available 108# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 109unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62 open my $fh, "<", cf::localdir . "/runtime" 110 open my $fh, "<", "$LOCALDIR/runtime"
63 or die "unable to read runtime file: $!"; 111 or die "unable to read runtime file: $!";
64 $RUNTIME = <$fh> + 0.; 112 $RUNTIME = <$fh> + 0.;
65} 113}
66 114
67mkdir cf::localdir; 115mkdir $_
68mkdir cf::localdir . "/" . cf::playerdir; 116 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 117
73# a special map that is always available
74our $LINK_MAP;
75our $EMERGENCY_POSITION; 118our $EMERGENCY_POSITION;
119
120sub cf::map::normalise;
76 121
77############################################################################# 122#############################################################################
78 123
79=head2 GLOBAL VARIABLES 124=head2 GLOBAL VARIABLES
80 125
87=item $cf::RUNTIME 132=item $cf::RUNTIME
88 133
89The time this server has run, starts at 0 and is increased by $cf::TICK on 134The time this server has run, starts at 0 and is increased by $cf::TICK on
90every server tick. 135every server tick.
91 136
92=item $cf::LIBDIR 137=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
138$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
139$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
93 140
94The perl library directory, where extensions and cf-specific modules can 141Various directories - "/etc", read-only install directory, perl-library
95be found. It will be added to C<@INC> automatically. 142directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
143unique-items directory, player file directory, random maps directory and
144database environment.
96 145
97=item $cf::NOW 146=item $cf::NOW
98 147
99The time of the last (current) server tick. 148The time of the last (current) server tick.
100 149
101=item $cf::TICK 150=item $cf::TICK
102 151
103The interval between server ticks, in seconds. 152The interval between server ticks, in seconds.
153
154=item $cf::LOADAVG
155
156The current CPU load on the server (alpha-smoothed), as a value between 0
157(none) and 1 (overloaded), indicating how much time is spent on processing
158objects per tick. Healthy values are < 0.5.
159
160=item $cf::LOAD
161
162The raw value load value from the last tick.
104 163
105=item %cf::CFG 164=item %cf::CFG
106 165
107Configuration for the server, loaded from C</etc/crossfire/config>, or 166Configuration for the server, loaded from C</etc/crossfire/config>, or
108from wherever your confdir points to. 167from wherever your confdir points to.
168
169=item cf::wait_for_tick, cf::wait_for_tick_begin
170
171These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
172returns directly I<after> the tick processing (and consequently, can only wake one process
173per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
174
175=item @cf::INVOKE_RESULTS
176
177This array contains the results of the last C<invoke ()> call. When
178C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
179that call.
109 180
110=back 181=back
111 182
112=cut 183=cut
113 184
114BEGIN { 185BEGIN {
115 *CORE::GLOBAL::warn = sub { 186 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 187 my $msg = join "", @_;
117 utf8::encode $msg;
118 188
119 $msg .= "\n" 189 $msg .= "\n"
120 unless $msg =~ /\n$/; 190 unless $msg =~ /\n$/;
121 191
192 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
193
122 LOG llevError, "cfperl: $msg"; 194 LOG llevError, $msg;
123 }; 195 };
124} 196}
125 197
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 198@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 199@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 200@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 201@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 202@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
203@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
131@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 204@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
132 205
133# we bless all objects into (empty) derived classes to force a method lookup 206# we bless all objects into (empty) derived classes to force a method lookup
134# within the Safe compartment. 207# within the Safe compartment.
135for my $pkg (qw( 208for my $pkg (qw(
136 cf::global cf::attachable 209 cf::global cf::attachable
145 218
146$Event::DIED = sub { 219$Event::DIED = sub {
147 warn "error in event callback: @_"; 220 warn "error in event callback: @_";
148}; 221};
149 222
150my %ext_pkg; 223#############################################################################
151my @exts;
152my @hook;
153 224
154=head2 UTILITY FUNCTIONS 225=head2 UTILITY FUNCTIONS
155 226
156=over 4 227=over 4
157 228
158=cut 229=item dumpval $ref
159 230
160use JSON::Syck (); # TODO# replace by JSON::PC once working 231=cut
232
233sub dumpval {
234 eval {
235 local $SIG{__DIE__};
236 my $d;
237 if (1) {
238 $d = new Data::Dumper([$_[0]], ["*var"]);
239 $d->Terse(1);
240 $d->Indent(2);
241 $d->Quotekeys(0);
242 $d->Useqq(1);
243 #$d->Bless(...);
244 $d->Seen($_[1]) if @_ > 1;
245 $d = $d->Dump();
246 }
247 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
248 $d
249 } || "[unable to dump $_[0]: '$@']";
250}
161 251
162=item $ref = cf::from_json $json 252=item $ref = cf::from_json $json
163 253
164Converts a JSON string into the corresponding perl data structure. 254Converts a JSON string into the corresponding perl data structure.
165 255
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 256=item $json = cf::to_json $ref
174 257
175Converts a perl data structure into its JSON representation. 258Converts a perl data structure into its JSON representation.
176 259
177=cut 260=cut
178 261
179sub to_json($) { 262our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 263
181 JSON::Syck::Dump $_[0] 264sub to_json ($) { $json_coder->encode ($_[0]) }
182} 265sub from_json ($) { $json_coder->decode ($_[0]) }
183 266
184=item cf::lock_wait $string 267=item cf::lock_wait $string
185 268
186Wait until the given lock is available. See cf::lock_acquire. 269Wait until the given lock is available. See cf::lock_acquire.
187 270
190Wait until the given lock is available and then acquires it and returns 273Wait until the given lock is available and then acquires it and returns
191a Coro::guard object. If the guard object gets destroyed (goes out of scope, 274a Coro::guard object. If the guard object gets destroyed (goes out of scope,
192for example when the coroutine gets canceled), the lock is automatically 275for example when the coroutine gets canceled), the lock is automatically
193returned. 276returned.
194 277
278Locks are *not* recursive, locking from the same coro twice results in a
279deadlocked coro.
280
195Lock names should begin with a unique identifier (for example, cf::map::find 281Lock names should begin with a unique identifier (for example, cf::map::find
196uses map_find and cf::map::load uses map_load). 282uses map_find and cf::map::load uses map_load).
197 283
284=item $locked = cf::lock_active $string
285
286Return true if the lock is currently active, i.e. somebody has locked it.
287
198=cut 288=cut
199 289
200our %LOCK; 290our %LOCK;
291our %LOCKER;#d#
201 292
202sub lock_wait($) { 293sub lock_wait($) {
203 my ($key) = @_; 294 my ($key) = @_;
295
296 if ($LOCKER{$key} == $Coro::current) {#d#
297 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
298 return;#d#
299 }#d#
204 300
205 # wait for lock, if any 301 # wait for lock, if any
206 while ($LOCK{$key}) { 302 while ($LOCK{$key}) {
207 push @{ $LOCK{$key} }, $Coro::current; 303 push @{ $LOCK{$key} }, $Coro::current;
208 Coro::schedule; 304 Coro::schedule;
214 310
215 # wait, to be sure we are not locked 311 # wait, to be sure we are not locked
216 lock_wait $key; 312 lock_wait $key;
217 313
218 $LOCK{$key} = []; 314 $LOCK{$key} = [];
315 $LOCKER{$key} = $Coro::current;#d#
219 316
220 Coro::guard { 317 Coro::guard {
318 delete $LOCKER{$key};#d#
221 # wake up all waiters, to be on the safe side 319 # wake up all waiters, to be on the safe side
222 $_->ready for @{ delete $LOCK{$key} }; 320 $_->ready for @{ delete $LOCK{$key} };
223 } 321 }
224} 322}
225 323
226=item cf::async { BLOCK } 324sub lock_active($) {
227
228Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
229error instead of exiting the server in case of a problem.
230
231=cut
232
233sub async(&) {
234 my ($cb) = @_; 325 my ($key) = @_;
235 326
236 Coro::async { 327 ! ! $LOCK{$key}
237 eval { $cb->() };
238 warn $@ if $@;
239 }
240} 328}
241 329
242sub freeze_mainloop { 330sub freeze_mainloop {
243 return unless $TICK_WATCHER->is_active; 331 return unless $TICK_WATCHER->is_active;
244 332
245 my $guard = Coro::guard { $TICK_WATCHER->start }; 333 my $guard = Coro::guard {
334 $TICK_WATCHER->start;
335 };
246 $TICK_WATCHER->stop; 336 $TICK_WATCHER->stop;
247 $guard 337 $guard
248} 338}
249 339
340=item cf::get_slot $time[, $priority[, $name]]
341
342Allocate $time seconds of blocking CPU time at priority C<$priority>:
343This call blocks and returns only when you have at least C<$time> seconds
344of cpu time till the next tick. The slot is only valid till the next cede.
345
346The optional C<$name> can be used to identify the job to run. It might be
347used for statistical purposes and should identify the same time-class.
348
349Useful for short background jobs.
350
351=cut
352
353our @SLOT_QUEUE;
354our $SLOT_QUEUE;
355
356$SLOT_QUEUE->cancel if $SLOT_QUEUE;
357$SLOT_QUEUE = Coro::async {
358 my $signal = new Coro::Signal;
359
360 while () {
361 next_job:
362 my $avail = cf::till_tick;
363 if ($avail > 0.01) {
364 for (0 .. $#SLOT_QUEUE) {
365 if ($SLOT_QUEUE[$_][0] < $avail) {
366 my $job = splice @SLOT_QUEUE, $_, 1, ();
367 $job->[2]->send;
368 Coro::cede;
369 goto next_job;
370 }
371 }
372 }
373
374 if (@SLOT_QUEUE) {
375 # we do not use wait_For_tick() as it returns immediately when tick is inactive
376 push @cf::WAIT_FOR_TICK, $signal;
377 $signal->wait;
378 } else {
379 Coro::schedule;
380 }
381 }
382};
383
384sub get_slot($;$$) {
385 my ($time, $pri, $name) = @_;
386
387 $time = $TICK * .6 if $time > $TICK * .6;
388 my $sig = new Coro::Signal;
389
390 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
391 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
392 $SLOT_QUEUE->ready;
393 $sig->wait;
394}
395
396=item cf::async { BLOCK }
397
398Currently the same as Coro::async_pool, meaning you cannot use
399C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
400thing you are allowed to do is call C<prio> on it.
401
402=cut
403
404BEGIN { *async = \&Coro::async_pool }
405
250=item cf::sync_job { BLOCK } 406=item cf::sync_job { BLOCK }
251 407
252The design of crossfire+ requires that the main coro ($Coro::main) is 408The design of Crossfire TRT requires that the main coroutine ($Coro::main)
253always able to handle events or runnable, as crossfire+ is only partly 409is always able to handle events or runnable, as Crossfire TRT is only
254reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 410partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
411acceptable.
255 412
256If it must be done, put the blocking parts into C<sync_job>. This will run 413If it must be done, put the blocking parts into C<sync_job>. This will run
257the given BLOCK in another coroutine while waiting for the result. The 414the given BLOCK in another coroutine while waiting for the result. The
258server will be frozen during this time, so the block should either finish 415server will be frozen during this time, so the block should either finish
259fast or be very important. 416fast or be very important.
262 419
263sub sync_job(&) { 420sub sync_job(&) {
264 my ($job) = @_; 421 my ($job) = @_;
265 422
266 if ($Coro::current == $Coro::main) { 423 if ($Coro::current == $Coro::main) {
424 my $time = Event::time;
425
267 # this is the main coro, too bad, we have to block 426 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 427 # till the operation succeeds, freezing the server :/
269 428
270 # TODO: use suspend/resume instead 429 # TODO: use suspend/resume instead
271 # (but this is cancel-safe) 430 # (but this is cancel-safe)
272 my $freeze_guard = freeze_mainloop; 431 my $freeze_guard = freeze_mainloop;
273 432
274 my $busy = 1; 433 my $busy = 1;
275 my @res; 434 my @res;
276 435
277 (Coro::async { 436 (async {
278 @res = eval { $job->() }; 437 @res = eval { $job->() };
279 warn $@ if $@; 438 warn $@ if $@;
280 undef $busy; 439 undef $busy;
281 })->prio (Coro::PRIO_MAX); 440 })->prio (Coro::PRIO_MAX);
282 441
283 while ($busy) { 442 while ($busy) {
284 Coro::cede_notself; 443 Coro::cede or Event::one_event;
285 Event::one_event unless Coro::nready;
286 } 444 }
445
446 $time = Event::time - $time;
447
448 LOG llevError | logBacktrace, Carp::longmess "long sync job"
449 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
450
451 $tick_start += $time; # do not account sync jobs to server load
287 452
288 wantarray ? @res : $res[0] 453 wantarray ? @res : $res[0]
289 } else { 454 } else {
290 # we are in another coroutine, how wonderful, everything just works 455 # we are in another coroutine, how wonderful, everything just works
291 456
292 $job->() 457 $job->()
293 } 458 }
294} 459}
295 460
296=item $coro = cf::coro { BLOCK } 461=item $coro = cf::async_ext { BLOCK }
297 462
298Creates and returns a new coro. This coro is automcatially being canceled 463Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 464extension calling this is being unloaded.
300 465
301=cut 466=cut
302 467
303sub coro(&) { 468sub async_ext(&) {
304 my $cb = shift; 469 my $cb = shift;
305 470
306 my $coro = &cf::async ($cb); 471 my $coro = &Coro::async ($cb);
307 472
308 $coro->on_destroy (sub { 473 $coro->on_destroy (sub {
309 delete $EXT_CORO{$coro+0}; 474 delete $EXT_CORO{$coro+0};
310 }); 475 });
311 $EXT_CORO{$coro+0} = $coro; 476 $EXT_CORO{$coro+0} = $coro;
312 477
313 $coro 478 $coro
314} 479}
315 480
316sub write_runtime { 481=item fork_call { }, $args
317 my $runtime = cf::localdir . "/runtime";
318 482
319 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 483Executes the given code block with the given arguments in a seperate
320 or return; 484process, returning the results. Everything must be serialisable with
485Coro::Storable. May, of course, block. Note that the executed sub may
486never block itself or use any form of Event handling.
321 487
322 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 488=cut
323 (aio_write $fh, 0, (length $value), $value, 0) <= 0
324 and return;
325 489
326 aio_fsync $fh 490sub fork_call(&@) {
327 and return; 491 my ($cb, @args) = @_;
328 492
329 close $fh 493 # we seemingly have to make a local copy of the whole thing,
330 or return; 494 # otherwise perl prematurely frees the stuff :/
495 # TODO: investigate and fix (likely this will be rather laborious)
331 496
332 aio_rename "$runtime~", $runtime 497 my @res = Coro::Util::fork_eval {
333 and return; 498 reset_signals;
499 &$cb
500 }, @args;
334 501
502 wantarray ? @res : $res[-1]
503}
504
505=item $value = cf::db_get $family => $key
506
507Returns a single value from the environment database.
508
509=item cf::db_put $family => $key => $value
510
511Stores the given C<$value> in the family. It can currently store binary
512data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
513
514=item $db = cf::db_table "name"
515
516Create and/or open a new database table. The string must not be "db" and must be unique
517within each server.
518
519=cut
520
521sub db_table($) {
522 my ($name) = @_;
523 my $db = BDB::db_create $DB_ENV;
524
525 eval {
526 $db->set_flags (BDB::CHKSUM);
527
528 utf8::encode $name;
529 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
530 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
531 cf::cleanup "db_open(db): $!" if $!;
532 };
533 cf::cleanup "db_open(db): $@" if $@;
534
535 $db
536}
537
538our $DB;
539
540sub db_init {
541 cf::sync_job {
542 $DB ||= db_table "db";
543 };
544}
545
546sub db_get($$) {
547 my $key = "$_[0]/$_[1]";
548
549 cf::sync_job {
550 BDB::db_get $DB, undef, $key, my $data;
551
552 $! ? ()
553 : $data
335 1 554 }
555}
556
557sub db_put($$$) {
558 BDB::dbreq_pri 4;
559 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
560}
561
562=item cf::cache $id => [$paths...], $processversion => $process
563
564Generic caching function that returns the value of the resource $id,
565caching and regenerating as required.
566
567This function can block.
568
569=cut
570
571sub cache {
572 my ($id, $src, $processversion, $process) = @_;
573
574 my $meta =
575 join "\x00",
576 $processversion,
577 map {
578 aio_stat $_
579 and Carp::croak "$_: $!";
580
581 ($_, (stat _)[7,9])
582 } @$src;
583
584 my $dbmeta = db_get cache => "$id/meta";
585 if ($dbmeta ne $meta) {
586 # changed, we may need to process
587
588 my @data;
589 my $md5;
590
591 for (0 .. $#$src) {
592 0 <= aio_load $src->[$_], $data[$_]
593 or Carp::croak "$src->[$_]: $!";
594 }
595
596 # if processing is expensive, check
597 # checksum first
598 if (1) {
599 $md5 =
600 join "\x00",
601 $processversion,
602 map {
603 cf::cede_to_tick;
604 ($src->[$_], Digest::MD5::md5_hex $data[$_])
605 } 0.. $#$src;
606
607
608 my $dbmd5 = db_get cache => "$id/md5";
609 if ($dbmd5 eq $md5) {
610 db_put cache => "$id/meta", $meta;
611
612 return db_get cache => "$id/data";
613 }
614 }
615
616 my $t1 = Time::HiRes::time;
617 my $data = $process->(\@data);
618 my $t2 = Time::HiRes::time;
619
620 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
621
622 db_put cache => "$id/data", $data;
623 db_put cache => "$id/md5" , $md5;
624 db_put cache => "$id/meta", $meta;
625
626 return $data;
627 }
628
629 db_get cache => "$id/data"
630}
631
632=item cf::datalog type => key => value, ...
633
634Log a datalog packet of the given type with the given key-value pairs.
635
636=cut
637
638sub datalog($@) {
639 my ($type, %kv) = @_;
640 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
336} 641}
337 642
338=back 643=back
339 644
340=cut 645=cut
341
342#############################################################################
343
344package cf::path;
345
346sub new {
347 my ($class, $path, $base) = @_;
348
349 $path = $path->as_string if ref $path;
350
351 my $self = bless { }, $class;
352
353 # {... are special paths that are not touched
354 # ?xxx/... are special absolute paths
355 # ?random/... random maps
356 # /! non-realised random map exit
357 # /... normal maps
358 # ~/... per-player maps without a specific player (DO NOT USE)
359 # ~user/... per-player map of a specific user
360
361 if ($path =~ /^{/) {
362 # fine as it is
363 } elsif ($path =~ s{^\?random/}{}) {
364 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365 $self->{random} = cf::from_json $data;
366 } else {
367 if ($path =~ s{^~([^/]+)?}{}) {
368 $self->{user_rel} = 1;
369
370 if (defined $1) {
371 $self->{user} = $1;
372 } elsif ($base =~ m{^~([^/]+)/}) {
373 $self->{user} = $1;
374 } else {
375 warn "cannot resolve user-relative path without user <$path,$base>\n";
376 }
377 } elsif ($path =~ /^\//) {
378 # already absolute
379 } else {
380 $base =~ s{[^/]+/?$}{};
381 return $class->new ("$base/$path");
382 }
383
384 for ($path) {
385 redo if s{/\.?/}{/};
386 redo if s{/[^/]+/\.\./}{/};
387 }
388 }
389
390 $self->{path} = $path;
391
392 $self
393}
394
395# the name / primary key / in-game path
396sub as_string {
397 my ($self) = @_;
398
399 $self->{user_rel} ? "~$self->{user}$self->{path}"
400 : $self->{random} ? "?random/$self->{path}"
401 : $self->{path}
402}
403
404# the displayed name, this is a one way mapping
405sub visible_name {
406 my ($self) = @_;
407
408# if (my $rmp = $self->{random}) {
409# # todo: be more intelligent about this
410# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411# } else {
412 $self->as_string
413# }
414}
415
416# escape the /'s in the path
417sub _escaped_path {
418 # ∕ is U+2215
419 (my $path = $_[0]{path}) =~ s/\//∕/g;
420 $path
421}
422
423# the original (read-only) location
424sub load_path {
425 my ($self) = @_;
426
427 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428}
429
430# the temporary/swap location
431sub save_path {
432 my ($self) = @_;
433
434 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437}
438
439# the unique path, might be eq to save_path
440sub uniq_path {
441 my ($self) = @_;
442
443 $self->{user_rel} || $self->{random}
444 ? undef
445 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446}
447
448# return random map parameters, or undef
449sub random_map_params {
450 my ($self) = @_;
451
452 $self->{random}
453}
454
455# this is somewhat ugly, but style maps do need special treatment
456sub is_style_map {
457 $_[0]{path} =~ m{^/styles/}
458}
459
460package cf;
461 646
462############################################################################# 647#############################################################################
463 648
464=head2 ATTACHABLE OBJECTS 649=head2 ATTACHABLE OBJECTS
465 650
467attach callbacks/event handlers (a collection of which is called an "attachment") 652attach callbacks/event handlers (a collection of which is called an "attachment")
468to it. All such attachable objects support the following methods. 653to it. All such attachable objects support the following methods.
469 654
470In the following description, CLASS can be any of C<global>, C<object> 655In the following description, CLASS can be any of C<global>, C<object>
471C<player>, C<client> or C<map> (i.e. the attachable objects in 656C<player>, C<client> or C<map> (i.e. the attachable objects in
472crossfire+). 657Crossfire TRT).
473 658
474=over 4 659=over 4
475 660
476=item $attachable->attach ($attachment, key => $value...) 661=item $attachable->attach ($attachment, key => $value...)
477 662
591our @CB_TYPE = (); # registry for type (cf-object class) based events 776our @CB_TYPE = (); # registry for type (cf-object class) based events
592our @CB_MAP = (); 777our @CB_MAP = ();
593 778
594my %attachment; 779my %attachment;
595 780
781sub cf::attachable::thawer_merge {
782 # simply override everything except _meta
783 local $_[0]{_meta};
784 %{$_[0]} = %{$_[1]};
785}
786
596sub _attach_cb($$$$) { 787sub _attach_cb($$$$) {
597 my ($registry, $event, $prio, $cb) = @_; 788 my ($registry, $event, $prio, $cb) = @_;
598 789
599 use sort 'stable'; 790 use sort 'stable';
600 791
634 $registry = $CB_TYPE[$object_type] ||= []; 825 $registry = $CB_TYPE[$object_type] ||= [];
635 826
636 } elsif ($type eq "subtype") { 827 } elsif ($type eq "subtype") {
637 defined $object_type or Carp::croak "subtype specified without type"; 828 defined $object_type or Carp::croak "subtype specified without type";
638 my $object_subtype = shift @arg; 829 my $object_subtype = shift @arg;
639 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 830 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
640 831
641 } elsif ($type eq "package") { 832 } elsif ($type eq "package") {
642 my $pkg = shift @arg; 833 my $pkg = shift @arg;
643 834
644 while (my ($name, $id) = each %cb_id) { 835 while (my ($name, $id) = each %cb_id) {
673 _attach $registry, $klass, @attach; 864 _attach $registry, $klass, @attach;
674 } 865 }
675 866
676 $obj->{$name} = \%arg; 867 $obj->{$name} = \%arg;
677 } else { 868 } else {
678 warn "object uses attachment '$name' that is not available, postponing.\n"; 869 warn "object uses attachment '$name' which is not available, postponing.\n";
679 } 870 }
680 871
681 $obj->{_attachment}{$name} = undef; 872 $obj->{_attachment}{$name} = undef;
682} 873}
683 874
685 if (ref $_[0]) { 876 if (ref $_[0]) {
686 _object_attach @_; 877 _object_attach @_;
687 } else { 878 } else {
688 _attach shift->_attach_registry, @_; 879 _attach shift->_attach_registry, @_;
689 } 880 }
881 _recalc_want;
690}; 882};
691 883
692# all those should be optimised 884# all those should be optimised
693sub cf::attachable::detach { 885sub cf::attachable::detach {
694 my ($obj, $name) = @_; 886 my ($obj, $name) = @_;
697 delete $obj->{_attachment}{$name}; 889 delete $obj->{_attachment}{$name};
698 reattach ($obj); 890 reattach ($obj);
699 } else { 891 } else {
700 Carp::croak "cannot, currently, detach class attachments"; 892 Carp::croak "cannot, currently, detach class attachments";
701 } 893 }
894 _recalc_want;
702}; 895};
703 896
704sub cf::attachable::attached { 897sub cf::attachable::attached {
705 my ($obj, $name) = @_; 898 my ($obj, $name) = @_;
706 899
721 "; 914 ";
722 die if $@; 915 die if $@;
723} 916}
724 917
725our $override; 918our $override;
726our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 919our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
727 920
728sub override { 921sub override {
729 $override = 1; 922 $override = 1;
730 @invoke_results = (); 923 @INVOKE_RESULTS = (@_);
731} 924}
732 925
733sub do_invoke { 926sub do_invoke {
734 my $event = shift; 927 my $event = shift;
735 my $callbacks = shift; 928 my $callbacks = shift;
736 929
737 @invoke_results = (); 930 @INVOKE_RESULTS = ();
738 931
739 local $override; 932 local $override;
740 933
741 for (@$callbacks) { 934 for (@$callbacks) {
742 eval { &{$_->[1]} }; 935 eval { &{$_->[1]} };
759 952
760Generate an object-specific event with the given arguments. 953Generate an object-specific event with the given arguments.
761 954
762This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 955This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
763removed in future versions), and there is no public API to access override 956removed in future versions), and there is no public API to access override
764results (if you must, access C<@cf::invoke_results> directly). 957results (if you must, access C<@cf::INVOKE_RESULTS> directly).
765 958
766=back 959=back
767 960
768=cut 961=cut
769 962
770############################################################################# 963#############################################################################
771# object support 964# object support
965#
966
967sub _can_merge {
968 my ($ob1, $ob2) = @_;
969
970 local $Storable::canonical = 1;
971 my $fob1 = Storable::freeze $ob1;
972 my $fob2 = Storable::freeze $ob2;
973
974 $fob1 eq $fob2
975}
772 976
773sub reattach { 977sub reattach {
774 # basically do the same as instantiate, without calling instantiate 978 # basically do the same as instantiate, without calling instantiate
775 my ($obj) = @_; 979 my ($obj) = @_;
980
981 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
776 982
777 my $registry = $obj->registry; 983 my $registry = $obj->registry;
778 984
779 @$registry = (); 985 @$registry = ();
780 986
819); 1025);
820 1026
821sub object_freezer_save { 1027sub object_freezer_save {
822 my ($filename, $rdata, $objs) = @_; 1028 my ($filename, $rdata, $objs) = @_;
823 1029
1030 my $guard = cf::lock_acquire "io";
1031
824 sync_job { 1032 sync_job {
825 if (length $$rdata) { 1033 if (length $$rdata) {
1034 utf8::decode (my $decname = $filename);
826 warn sprintf "saving %s (%d,%d)\n", 1035 warn sprintf "saving %s (%d,%d)\n",
827 $filename, length $$rdata, scalar @$objs; 1036 $decname, length $$rdata, scalar @$objs;
828 1037
829 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1038 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830 chmod SAVE_MODE, $fh; 1039 chmod SAVE_MODE, $fh;
831 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1040 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
832 aio_fsync $fh; 1041 aio_fsync $fh if $cf::USE_FSYNC;
833 close $fh; 1042 close $fh;
834 1043
835 if (@$objs) { 1044 if (@$objs) {
836 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1045 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
837 chmod SAVE_MODE, $fh; 1046 chmod SAVE_MODE, $fh;
838 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1047 my $data = Storable::nfreeze { version => 1, objs => $objs };
839 aio_write $fh, 0, (length $data), $data, 0; 1048 aio_write $fh, 0, (length $data), $data, 0;
840 aio_fsync $fh; 1049 aio_fsync $fh if $cf::USE_FSYNC;
841 close $fh; 1050 close $fh;
842 aio_rename "$filename.pst~", "$filename.pst"; 1051 aio_rename "$filename.pst~", "$filename.pst";
843 } 1052 }
844 } else { 1053 } else {
845 aio_unlink "$filename.pst"; 1054 aio_unlink "$filename.pst";
851 } 1060 }
852 } else { 1061 } else {
853 aio_unlink $filename; 1062 aio_unlink $filename;
854 aio_unlink "$filename.pst"; 1063 aio_unlink "$filename.pst";
855 } 1064 }
856 } 1065 };
1066
1067 undef $guard;
857} 1068}
858 1069
859sub object_freezer_as_string { 1070sub object_freezer_as_string {
860 my ($rdata, $objs) = @_; 1071 my ($rdata, $objs) = @_;
861 1072
866 1077
867sub object_thawer_load { 1078sub object_thawer_load {
868 my ($filename) = @_; 1079 my ($filename) = @_;
869 1080
870 my ($data, $av); 1081 my ($data, $av);
1082
1083 my $guard = cf::lock_acquire "io";
871 1084
872 (aio_load $filename, $data) >= 0 1085 (aio_load $filename, $data) >= 0
873 or return; 1086 or return;
874 1087
875 unless (aio_stat "$filename.pst") { 1088 unless (aio_stat "$filename.pst") {
876 (aio_load "$filename.pst", $av) >= 0 1089 (aio_load "$filename.pst", $av) >= 0
877 or return; 1090 or return;
1091
1092 undef $guard;
878 $av = eval { (Storable::thaw $av)->{objs} }; 1093 $av = eval { (Storable::thaw $av)->{objs} };
879 } 1094 }
880 1095
1096 utf8::decode (my $decname = $filename);
881 warn sprintf "loading %s (%d)\n", 1097 warn sprintf "loading %s (%d,%d)\n",
882 $filename, length $data, scalar @{$av || []};#d# 1098 $decname, length $data, scalar @{$av || []};
1099
883 return ($data, $av); 1100 ($data, $av)
884} 1101}
1102
1103=head2 COMMAND CALLBACKS
1104
1105=over 4
1106
1107=cut
885 1108
886############################################################################# 1109#############################################################################
887# command handling &c 1110# command handling &c
888 1111
889=item cf::register_command $name => \&callback($ob,$args); 1112=item cf::register_command $name => \&callback($ob,$args);
902 push @{ $COMMAND{$name} }, [$caller, $cb]; 1125 push @{ $COMMAND{$name} }, [$caller, $cb];
903} 1126}
904 1127
905=item cf::register_extcmd $name => \&callback($pl,$packet); 1128=item cf::register_extcmd $name => \&callback($pl,$packet);
906 1129
907Register a callbackf ro execution when the client sends an extcmd packet. 1130Register a callback for execution when the client sends an (synchronous)
1131extcmd packet. Ext commands will be processed in the order they are
1132received by the server, like other user commands. The first argument is
1133the logged-in player. Ext commands can only be processed after a player
1134has logged in successfully.
908 1135
909If the callback returns something, it is sent back as if reply was being 1136If the callback returns something, it is sent back as if reply was being
910called. 1137called.
911 1138
1139=item cf::register_exticmd $name => \&callback($ns,$packet);
1140
1141Register a callback for execution when the client sends an (asynchronous)
1142exticmd packet. Exti commands are processed by the server as soon as they
1143are received, i.e. out of order w.r.t. other commands. The first argument
1144is a client socket. Exti commands can be received anytime, even before
1145log-in.
1146
1147If the callback returns something, it is sent back as if reply was being
1148called.
1149
912=cut 1150=cut
913 1151
914sub register_extcmd { 1152sub register_extcmd {
915 my ($name, $cb) = @_; 1153 my ($name, $cb) = @_;
916 1154
917 my $caller = caller;
918 #warn "registering extcmd '$name' to '$caller'";
919
920 $EXTCMD{$name} = [$cb, $caller]; 1155 $EXTCMD{$name} = $cb;
1156}
1157
1158sub register_exticmd {
1159 my ($name, $cb) = @_;
1160
1161 $EXTICMD{$name} = $cb;
921} 1162}
922 1163
923cf::player->attach ( 1164cf::player->attach (
924 on_command => sub { 1165 on_command => sub {
925 my ($pl, $name, $params) = @_; 1166 my ($pl, $name, $params) = @_;
934 cf::override; 1175 cf::override;
935 }, 1176 },
936 on_extcmd => sub { 1177 on_extcmd => sub {
937 my ($pl, $buf) = @_; 1178 my ($pl, $buf) = @_;
938 1179
939 my $msg = eval { from_json $buf }; 1180 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
940 1181
941 if (ref $msg) { 1182 if (ref $msg) {
1183 my ($type, $reply, @payload) =
1184 "ARRAY" eq ref $msg
1185 ? @$msg
1186 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1187
1188 my @reply;
1189
942 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1190 if (my $cb = $EXTCMD{$type}) {
943 if (my %reply = $cb->[0]->($pl, $msg)) { 1191 @reply = $cb->($pl, @payload);
944 $pl->ext_reply ($msg->{msgid}, %reply);
945 }
946 } 1192 }
1193
1194 $pl->ext_reply ($reply, @reply)
1195 if $reply;
1196
947 } else { 1197 } else {
948 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
949 } 1199 }
950 1200
951 cf::override; 1201 cf::override;
952 }, 1202 },
953); 1203);
954 1204
955sub register {
956 my ($base, $pkg) = @_;
957
958 #TODO
959}
960
961sub load_extension { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
1209 for my $path (<$LIBDIR/*.ext>) {
1210 next unless -r $path;
1211
1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
1269 }
1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
1275 };
1276}
1277
1278#############################################################################
1279
1280=back
1281
1282=head2 CORE EXTENSIONS
1283
1284Functions and methods that extend core crossfire objects.
1285
1286=cut
1287
1288package cf::player;
1289
1290use Coro::AIO;
1291
1292=head3 cf::player
1293
1294=over 4
1295
1296=item cf::player::num_playing
1297
1298Returns the official number of playing players, as per the Crossfire metaserver rules.
1299
1300=cut
1301
1302sub num_playing {
1303 scalar grep
1304 $_->ob->map
1305 && !$_->hidden
1306 && !$_->ob->flag (cf::FLAG_WIZ),
1307 cf::player::list
1308}
1309
1310=item cf::player::find $login
1311
1312Returns the given player object, loading it if necessary (might block).
1313
1314=cut
1315
1316sub playerdir($) {
1317 "$PLAYERDIR/"
1318 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1319}
1320
1321sub path($) {
1322 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1323
1324 (playerdir $login) . "/playerdata"
1325}
1326
1327sub find_active($) {
1328 $cf::PLAYER{$_[0]}
1329 and $cf::PLAYER{$_[0]}->active
1330 and $cf::PLAYER{$_[0]}
1331}
1332
1333sub exists($) {
1334 my ($login) = @_;
1335
1336 $cf::PLAYER{$login}
1337 or cf::sync_job { !aio_stat path $login }
1338}
1339
1340sub find($) {
1341 return $cf::PLAYER{$_[0]} || do {
1342 my $login = $_[0];
1343
1344 my $guard = cf::lock_acquire "user_find:$login";
1345
1346 $cf::PLAYER{$_[0]} || do {
1347 # rename old playerfiles to new ones
1348 #TODO: remove when no longer required
1349 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1350 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1351 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1352 aio_unlink +(playerdir $login) . "/$login.pl";
1353
1354 my $f = new_from_file cf::object::thawer path $login
1355 or return;
1356
1357 $f->next;
1358 my $pl = cf::player::load_pl $f
1359 or return;
1360 local $cf::PLAYER_LOADING{$login} = $pl;
1361 $f->resolve_delayed_derefs;
1362 $cf::PLAYER{$login} = $pl
1363 }
1364 }
1365}
1366
1367sub save($) {
1368 my ($pl) = @_;
1369
1370 return if $pl->{deny_save};
1371
1372 my $path = path $pl;
1373 my $guard = cf::lock_acquire "user_save:$path";
1374
1375 return if $pl->{deny_save};
1376
1377 aio_mkdir playerdir $pl, 0770;
1378 $pl->{last_save} = $cf::RUNTIME;
1379
1380 $pl->save_pl ($path);
1381 cf::cede_to_tick;
1382}
1383
1384sub new($) {
1385 my ($login) = @_;
1386
1387 my $self = create;
1388
1389 $self->ob->name ($login);
1390 $self->{deny_save} = 1;
1391
1392 $cf::PLAYER{$login} = $self;
1393
1394 $self
1395}
1396
1397=item $player->send_msg ($channel, $msg, $color, [extra...])
1398
1399=cut
1400
1401sub send_msg {
1402 my $ns = shift->ns
1403 or return;
1404 $ns->send_msg (@_);
1405}
1406
1407=item $pl->quit_character
1408
1409Nukes the player without looking back. If logged in, the connection will
1410be destroyed. May block for a long time.
1411
1412=cut
1413
1414sub quit_character {
1415 my ($pl) = @_;
1416
1417 my $name = $pl->ob->name;
1418
1419 $pl->{deny_save} = 1;
1420 $pl->password ("*"); # this should lock out the player until we nuked the dir
1421
1422 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1423 $pl->deactivate;
1424 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1425 $pl->ns->destroy if $pl->ns;
1426
1427 my $path = playerdir $pl;
1428 my $temp = "$path~$cf::RUNTIME~deleting~";
1429 aio_rename $path, $temp;
1430 delete $cf::PLAYER{$pl->ob->name};
1431 $pl->destroy;
1432
1433 my $prefix = qr<^~\Q$name\E/>;
1434
1435 # nuke player maps
1436 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1437
1438 IO::AIO::aio_rmtree $temp;
1439}
1440
1441=item $pl->kick
1442
1443Kicks a player out of the game. This destroys the connection.
1444
1445=cut
1446
1447sub kick {
1448 my ($pl, $kicker) = @_;
1449
1450 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1451 $pl->killer ("kicked");
1452 $pl->ns->destroy;
1453}
1454
1455=item cf::player::list_logins
1456
1457Returns am arrayref of all valid playernames in the system, can take a
1458while and may block, so not sync_job-capable, ever.
1459
1460=cut
1461
1462sub list_logins {
1463 my $dirs = aio_readdir $PLAYERDIR
1464 or return [];
1465
1466 my @logins;
1467
1468 for my $login (@$dirs) {
1469 my $path = path $login;
1470
1471 # a .pst is a dead give-away for a valid player
1472 unless (-e "$path.pst") {
1473 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1474 aio_read $fh, 0, 512, my $buf, 0 or next;
1475 $buf !~ /^password -------------$/m or next; # official not-valid tag
1476 }
1477
1478 utf8::decode $login;
1479 push @logins, $login;
1480 }
1481
1482 \@logins
1483}
1484
1485=item $player->maps
1486
1487Returns an arrayref of map paths that are private for this
1488player. May block.
1489
1490=cut
1491
1492sub maps($) {
1493 my ($pl) = @_;
1494
1495 $pl = ref $pl ? $pl->ob->name : $pl;
1496
1497 my $files = aio_readdir playerdir $pl
1498 or return;
1499
1500 my @paths;
1501
1502 for (@$files) {
1503 utf8::decode $_;
1504 next if /\.(?:pl|pst)$/;
1505 next unless /^$PATH_SEP/o;
1506
1507 push @paths, cf::map::normalise "~$pl/$_";
1508 }
1509
1510 \@paths
1511}
1512
1513=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1514
1515Expand crossfire pod fragments into protocol xml.
1516
1517=cut
1518
1519sub expand_cfpod {
1520 ((my $self), (local $_)) = @_;
1521
1522 # escape & and <
1523 s/&/&amp;/g;
1524 s/(?<![BIUGHT])</&lt;/g;
1525
1526 # this is buggy, it needs to properly take care of nested <'s
1527
1528 1 while
1529 # replace B<>, I<>, U<> etc.
1530 s/B<([^\>]*)>/<b>$1<\/b>/
1531 || s/I<([^\>]*)>/<i>$1<\/i>/
1532 || s/U<([^\>]*)>/<u>$1<\/u>/
1533 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1534 # replace G<male|female> tags
1535 || s{G<([^>|]*)\|([^>]*)>}{
1536 $self->gender ? $2 : $1
1537 }ge
1538 # replace H<hint text>
1539 || s{H<([^\>]*)>}
1540 {
1541 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1542 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1543 "")
1544 [$self->{hintmode}]
1545 }ge;
1546
1547 # create single paragraphs (very hackish)
1548 s/(?<=\S)\n(?=\w)/ /g;
1549
1550 # compress some whitespace
1551 s/\s+\n/\n/g; # ws line-ends
1552 s/\n\n+/\n/g; # double lines
1553 s/^\n+//; # beginning lines
1554 s/\n+$//; # ending lines
1555
1556 $_
1557}
1558
1559sub hintmode {
1560 $_[0]{hintmode} = $_[1] if @_ > 1;
1561 $_[0]{hintmode}
1562}
1563
1564=item $player->ext_reply ($msgid, @msg)
1565
1566Sends an ext reply to the player.
1567
1568=cut
1569
1570sub ext_reply($$@) {
1571 my ($self, $id, @msg) = @_;
1572
1573 $self->ns->ext_reply ($id, @msg)
1574}
1575
1576=item $player->ext_msg ($type, @msg)
1577
1578Sends an ext event to the client.
1579
1580=cut
1581
1582sub ext_msg($$@) {
1583 my ($self, $type, @msg) = @_;
1584
1585 $self->ns->ext_msg ($type, @msg);
1586}
1587
1588=head3 cf::region
1589
1590=over 4
1591
1592=cut
1593
1594package cf::region;
1595
1596=item cf::region::find_by_path $path
1597
1598Tries to decuce the likely region for a map knowing only its path.
1599
1600=cut
1601
1602sub find_by_path($) {
962 my ($path) = @_; 1603 my ($path) = @_;
963 1604
964 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1605 my ($match, $specificity);
965 my $base = $1;
966 my $pkg = $1;
967 $pkg =~ s/[^[:word:]]/_/g;
968 $pkg = "ext::$pkg";
969 1606
970 warn "loading '$path' into '$pkg'\n"; 1607 for my $region (list) {
971 1608 if ($region->{match} && $path =~ $region->{match}) {
972 open my $fh, "<:utf8", $path 1609 ($match, $specificity) = ($region, $region->specificity)
973 or die "$path: $!"; 1610 if $region->specificity > $specificity;
974 1611 }
975 my $source =
976 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n"
978 . (do { local $/; <$fh> })
979 . "\n};\n1";
980
981 eval $source
982 or die $@ ? "$path: $@\n"
983 : "extension disabled.\n";
984
985 push @exts, $pkg;
986 $ext_pkg{$base} = $pkg;
987
988# no strict 'refs';
989# @{"$pkg\::ISA"} = ext::;
990
991 register $base, $pkg;
992}
993
994sub unload_extension {
995 my ($pkg) = @_;
996
997 warn "removing extension $pkg\n";
998
999 # remove hooks
1000 #TODO
1001# for my $idx (0 .. $#PLUGIN_EVENT) {
1002# delete $hook[$idx]{$pkg};
1003# } 1612 }
1004 1613
1005 # remove commands 1614 $match
1006 for my $name (keys %COMMAND) {
1007 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1008
1009 if (@cb) {
1010 $COMMAND{$name} = \@cb;
1011 } else {
1012 delete $COMMAND{$name};
1013 }
1014 }
1015
1016 # remove extcmds
1017 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1018 delete $EXTCMD{$name};
1019 }
1020
1021 if (my $cb = $pkg->can ("unload")) {
1022 eval {
1023 $cb->($pkg);
1024 1
1025 } or warn "$pkg unloaded, but with errors: $@";
1026 }
1027
1028 Symbol::delete_package $pkg;
1029}
1030
1031sub load_extensions {
1032 for my $ext (<$LIBDIR/*.ext>) {
1033 next unless -r $ext;
1034 eval {
1035 load_extension $ext;
1036 1
1037 } or warn "$ext not loaded: $@";
1038 }
1039}
1040
1041#############################################################################
1042# load/save/clean perl data associated with a map
1043
1044*cf::mapsupport::on_clean = sub {
1045 my ($map) = @_;
1046
1047 my $path = $map->tmpname;
1048 defined $path or return;
1049
1050 unlink "$path.pst";
1051};
1052
1053cf::map->attach (prio => -10000, package => cf::mapsupport::);
1054
1055#############################################################################
1056# load/save perl data associated with player->ob objects
1057
1058sub all_objects(@) {
1059 @_, map all_objects ($_->inv), @_
1060}
1061
1062# TODO: compatibility cruft, remove when no longer needed
1063cf::player->attach (
1064 on_load => sub {
1065 my ($pl, $path) = @_;
1066
1067 for my $o (all_objects $pl->ob) {
1068 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1069 $o->set_ob_key_value ("_perl_data");
1070
1071 %$o = %{ Storable::thaw pack "H*", $value };
1072 }
1073 }
1074 },
1075);
1076
1077#############################################################################
1078
1079=head2 CORE EXTENSIONS
1080
1081Functions and methods that extend core crossfire objects.
1082
1083=head3 cf::player
1084
1085=over 4
1086
1087=item cf::player::exists $login
1088
1089Returns true when the given account exists.
1090
1091=cut
1092
1093sub cf::player::exists($) {
1094 cf::player::find $_[0]
1095 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1096}
1097
1098=item $player->ext_reply ($msgid, $msgtype, %msg)
1099
1100Sends an ext reply to the player.
1101
1102=cut
1103
1104sub cf::player::ext_reply($$$%) {
1105 my ($self, $id, %msg) = @_;
1106
1107 $msg{msgid} = $id;
1108
1109 $self->send ("ext " . to_json \%msg);
1110} 1615}
1111 1616
1112=back 1617=back
1113
1114 1618
1115=head3 cf::map 1619=head3 cf::map
1116 1620
1117=over 4 1621=over 4
1118 1622
1121package cf::map; 1625package cf::map;
1122 1626
1123use Fcntl; 1627use Fcntl;
1124use Coro::AIO; 1628use Coro::AIO;
1125 1629
1630use overload
1631 '""' => \&as_string,
1632 fallback => 1;
1633
1126our $MAX_RESET = 3600; 1634our $MAX_RESET = 3600;
1127our $DEFAULT_RESET = 3000; 1635our $DEFAULT_RESET = 3000;
1128 1636
1129sub generate_random_map { 1637sub generate_random_map {
1130 my ($path, $rmp) = @_; 1638 my ($self, $rmp) = @_;
1131
1132 # mit "rum" bekleckern, nicht 1639 # mit "rum" bekleckern, nicht
1133 cf::map::_create_random_map 1640 $self->_create_random_map (
1134 $path,
1135 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1641 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1642 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1137 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1643 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138 $rmp->{exit_on_final_map}, 1644 $rmp->{exit_on_final_map},
1139 $rmp->{xsize}, $rmp->{ysize}, 1645 $rmp->{xsize}, $rmp->{ysize},
1140 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1646 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1647 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1648 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1649 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1144 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1650 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145 (cf::region::find $rmp->{region}) 1651 (cf::region::find $rmp->{region}), $rmp->{custom}
1652 )
1653}
1654
1655=item cf::map->register ($regex, $prio)
1656
1657Register a handler for the map path matching the given regex at the
1658givne priority (higher is better, built-in handlers have priority 0, the
1659default).
1660
1661=cut
1662
1663sub register {
1664 my (undef, $regex, $prio) = @_;
1665 my $pkg = caller;
1666
1667 no strict;
1668 push @{"$pkg\::ISA"}, __PACKAGE__;
1669
1670 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1671}
1672
1673# also paths starting with '/'
1674$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1675
1676sub thawer_merge {
1677 my ($self, $merge) = @_;
1678
1679 # we have to keep some variables in memory intact
1680 local $self->{path};
1681 local $self->{load_path};
1682
1683 $self->SUPER::thawer_merge ($merge);
1684}
1685
1686sub normalise {
1687 my ($path, $base) = @_;
1688
1689 $path = "$path"; # make sure its a string
1690
1691 $path =~ s/\.map$//;
1692
1693 # map plan:
1694 #
1695 # /! non-realised random map exit (special hack!)
1696 # {... are special paths that are not being touched
1697 # ?xxx/... are special absolute paths
1698 # ?random/... random maps
1699 # /... normal maps
1700 # ~user/... per-player map of a specific user
1701
1702 $path =~ s/$PATH_SEP/\//go;
1703
1704 # treat it as relative path if it starts with
1705 # something that looks reasonable
1706 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1707 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1708
1709 $base =~ s{[^/]+/?$}{};
1710 $path = "$base/$path";
1711 }
1712
1713 for ($path) {
1714 redo if s{//}{/};
1715 redo if s{/\.?/}{/};
1716 redo if s{/[^/]+/\.\./}{/};
1717 }
1718
1719 $path
1720}
1721
1722sub new_from_path {
1723 my (undef, $path, $base) = @_;
1724
1725 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1726
1727 $path = normalise $path, $base;
1728
1729 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1730 if ($path =~ $EXT_MAP{$pkg}[1]) {
1731 my $self = bless cf::map::new, $pkg;
1732 $self->{path} = $path; $self->path ($path);
1733 $self->init; # pass $1 etc.
1734 return $self;
1735 }
1736 }
1737
1738 Carp::cluck "unable to resolve path '$path' (base '$base').";
1739 ()
1740}
1741
1742sub init {
1743 my ($self) = @_;
1744
1745 $self
1746}
1747
1748sub as_string {
1749 my ($self) = @_;
1750
1751 "$self->{path}"
1752}
1753
1754# the displayed name, this is a one way mapping
1755sub visible_name {
1756 &as_string
1757}
1758
1759# the original (read-only) location
1760sub load_path {
1761 my ($self) = @_;
1762
1763 "$MAPDIR/$self->{path}.map"
1764}
1765
1766# the temporary/swap location
1767sub save_path {
1768 my ($self) = @_;
1769
1770 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1771 "$TMPDIR/$path.map"
1772}
1773
1774# the unique path, undef == no special unique path
1775sub uniq_path {
1776 my ($self) = @_;
1777
1778 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1779 "$UNIQUEDIR/$path"
1146} 1780}
1147 1781
1148# and all this just because we cannot iterate over 1782# and all this just because we cannot iterate over
1149# all maps in C++... 1783# all maps in C++...
1150sub change_all_map_light { 1784sub change_all_map_light {
1152 1786
1153 $_->change_map_light ($change) 1787 $_->change_map_light ($change)
1154 for grep $_->outdoor, values %cf::MAP; 1788 for grep $_->outdoor, values %cf::MAP;
1155} 1789}
1156 1790
1791sub decay_objects {
1792 my ($self) = @_;
1793
1794 return if $self->{deny_reset};
1795
1796 $self->do_decay_objects;
1797}
1798
1799sub unlink_save {
1800 my ($self) = @_;
1801
1802 utf8::encode (my $save = $self->save_path);
1803 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1804 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1805}
1806
1157sub try_load_header($) { 1807sub load_header_from($) {
1158 my ($path) = @_; 1808 my ($self, $path) = @_;
1159 1809
1160 utf8::encode $path; 1810 utf8::encode $path;
1161 aio_open $path, O_RDONLY, 0 1811 my $f = new_from_file cf::object::thawer $path
1162 or return; 1812 or return;
1163 1813
1164 my $map = cf::map::new 1814 $self->_load_header ($f)
1165 or return; 1815 or return;
1166 1816
1167 # for better error messages only, will be overwritten 1817 local $MAP_LOADING{$self->{path}} = $self;
1168 $map->path ($path); 1818 $f->resolve_delayed_derefs;
1169 1819
1170 $map->load_header ($path) 1820 $self->{load_path} = $path;
1821
1822 1
1823}
1824
1825sub load_header_orig {
1826 my ($self) = @_;
1827
1828 $self->load_header_from ($self->load_path)
1829}
1830
1831sub load_header_temp {
1832 my ($self) = @_;
1833
1834 $self->load_header_from ($self->save_path)
1835}
1836
1837sub prepare_temp {
1838 my ($self) = @_;
1839
1840 $self->last_access ((delete $self->{last_access})
1841 || $cf::RUNTIME); #d#
1842 # safety
1843 $self->{instantiate_time} = $cf::RUNTIME
1844 if $self->{instantiate_time} > $cf::RUNTIME;
1845}
1846
1847sub prepare_orig {
1848 my ($self) = @_;
1849
1850 $self->{load_original} = 1;
1851 $self->{instantiate_time} = $cf::RUNTIME;
1852 $self->last_access ($cf::RUNTIME);
1853 $self->instantiate;
1854}
1855
1856sub load_header {
1857 my ($self) = @_;
1858
1859 if ($self->load_header_temp) {
1860 $self->prepare_temp;
1861 } else {
1862 $self->load_header_orig
1171 or return; 1863 or return;
1864 $self->prepare_orig;
1865 }
1172 1866
1173 $map->{load_path} = $path; 1867 $self->{deny_reset} = 1
1868 if $self->no_reset;
1174 1869
1175 $map 1870 $self->default_region (cf::region::find_by_path $self->{path})
1871 unless $self->default_region;
1872
1873 1
1176} 1874}
1177 1875
1178sub find; 1876sub find;
1179sub find { 1877sub find {
1180 my ($path, $origin) = @_; 1878 my ($path, $origin) = @_;
1181 1879
1182 #warn "find<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path; 1880 $path = normalise $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186 1881
1882 cf::lock_wait "map_data:$path";#d#remove
1187 cf::lock_wait "map_find:$key"; 1883 cf::lock_wait "map_find:$path";
1188 1884
1189 $cf::MAP{$key} || do { 1885 $cf::MAP{$path} || do {
1190 my $guard = cf::lock_acquire "map_find:$key"; 1886 my $guard1 = cf::lock_acquire "map_find:$path";
1887 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1191 1888
1192 # do it the slow way 1889 my $map = new_from_path cf::map $path
1193 my $map = try_load_header $path->save_path;
1194
1195 Coro::cede;
1196
1197 if ($map) {
1198 $map->last_access ((delete $map->{last_access})
1199 || $cf::RUNTIME); #d#
1200 # safety
1201 $map->{instantiate_time} = $cf::RUNTIME
1202 if $map->{instantiate_time} > $cf::RUNTIME;
1203 } else {
1204 if (my $rmp = $path->random_map_params) {
1205 $map = generate_random_map $key, $rmp;
1206 } else {
1207 $map = try_load_header $path->load_path;
1208 }
1209
1210 $map or return; 1890 or return;
1211 1891
1212 $map->{load_original} = 1;
1213 $map->{instantiate_time} = $cf::RUNTIME;
1214 $map->last_access ($cf::RUNTIME);
1215 $map->instantiate;
1216
1217 # per-player maps become, after loading, normal maps
1218 $map->per_player (0) if $path->{user_rel};
1219 }
1220
1221 $map->path ($key);
1222 $map->{path} = $path;
1223 $map->{last_save} = $cf::RUNTIME; 1892 $map->{last_save} = $cf::RUNTIME;
1224 1893
1225 Coro::cede; 1894 $map->load_header
1895 or return;
1226 1896
1227 if ($map->should_reset) { 1897 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1898 # doing this can freeze the server in a sync job, obviously
1899 #$cf::WAIT_FOR_TICK->wait;
1900 undef $guard1;
1901 undef $guard2;
1228 $map->reset; 1902 $map->reset;
1229 undef $guard;
1230 $map = find $path 1903 return find $path;
1231 or return;
1232 } 1904 }
1233 1905
1234 $cf::MAP{$key} = $map 1906 $cf::MAP{$path} = $map
1235 } 1907 }
1236} 1908}
1909
1910sub pre_load { }
1911sub post_load { }
1237 1912
1238sub load { 1913sub load {
1239 my ($self) = @_; 1914 my ($self) = @_;
1240 1915
1916 local $self->{deny_reset} = 1; # loading can take a long time
1917
1241 my $path = $self->{path}; 1918 my $path = $self->{path};
1919
1920 {
1242 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1921 my $guard = cf::lock_acquire "map_data:$path";
1243 1922
1923 return unless $self->valid;
1244 return if $self->in_memory != cf::MAP_SWAPPED; 1924 return unless $self->in_memory == cf::MAP_SWAPPED;
1245 1925
1246 $self->in_memory (cf::MAP_LOADING); 1926 $self->in_memory (cf::MAP_LOADING);
1247 1927
1248 $self->alloc; 1928 $self->alloc;
1249 $self->load_objects ($self->{load_path}, 1) 1929
1930 $self->pre_load;
1931 cf::cede_to_tick;
1932
1933 my $f = new_from_file cf::object::thawer $self->{load_path};
1934 $f->skip_block;
1935 $self->_load_objects ($f)
1250 or return; 1936 or return;
1251 1937
1252 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1938 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1253 if delete $self->{load_original}; 1939 if delete $self->{load_original};
1254 1940
1255 if (my $uniq = $path->uniq_path) { 1941 if (my $uniq = $self->uniq_path) {
1256 utf8::encode $uniq; 1942 utf8::encode $uniq;
1257 if (aio_open $uniq, O_RDONLY, 0) { 1943 unless (aio_stat $uniq) {
1944 if (my $f = new_from_file cf::object::thawer $uniq) {
1258 $self->clear_unique_items; 1945 $self->clear_unique_items;
1259 $self->load_objects ($uniq, 0); 1946 $self->_load_objects ($f);
1947 $f->resolve_delayed_derefs;
1948 }
1260 } 1949 }
1261 } 1950 }
1262 1951
1263 Coro::cede; 1952 $f->resolve_delayed_derefs;
1264 1953
1954 cf::cede_to_tick;
1265 # now do the right thing for maps 1955 # now do the right thing for maps
1266 $self->link_multipart_objects; 1956 $self->link_multipart_objects;
1267
1268 if ($self->{path}->is_style_map) {
1269 $self->{deny_save} = 1;
1270 $self->{deny_reset} = 1;
1271 } else {
1272 $self->fix_auto_apply;
1273 $self->decay_objects;
1274 $self->update_buttons;
1275 $self->set_darkness_map;
1276 $self->difficulty ($self->estimate_difficulty) 1957 $self->difficulty ($self->estimate_difficulty)
1277 unless $self->difficulty; 1958 unless $self->difficulty;
1959 cf::cede_to_tick;
1960
1961 unless ($self->{deny_activate}) {
1962 $self->decay_objects;
1963 $self->fix_auto_apply;
1964 $self->update_buttons;
1965 cf::cede_to_tick;
1966 $self->set_darkness_map;
1967 cf::cede_to_tick;
1278 $self->activate; 1968 $self->activate;
1279 } 1969 }
1280 1970
1281 Coro::cede; 1971 $self->{last_save} = $cf::RUNTIME;
1972 $self->last_access ($cf::RUNTIME);
1282 1973
1283 $self->in_memory (cf::MAP_IN_MEMORY); 1974 $self->in_memory (cf::MAP_IN_MEMORY);
1975 }
1976
1977 $self->post_load;
1978}
1979
1980sub customise_for {
1981 my ($self, $ob) = @_;
1982
1983 return find "~" . $ob->name . "/" . $self->{path}
1984 if $self->per_player;
1985
1986# return find "?party/" . $ob->name . "/" . $self->{path}
1987# if $self->per_party;
1988
1989 $self
1990}
1991
1992# find and load all maps in the 3x3 area around a map
1993sub load_neighbours {
1994 my ($map) = @_;
1995
1996 my @neigh; # diagonal neighbours
1997
1998 for (0 .. 3) {
1999 my $neigh = $map->tile_path ($_)
2000 or next;
2001 $neigh = find $neigh, $map
2002 or next;
2003 $neigh->load;
2004
2005 push @neigh,
2006 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2007 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2008 }
2009
2010 for (grep defined $_->[0], @neigh) {
2011 my ($path, $origin) = @$_;
2012 my $neigh = find $path, $origin
2013 or next;
2014 $neigh->load;
2015 }
1284} 2016}
1285 2017
1286sub find_sync { 2018sub find_sync {
1287 my ($path, $origin) = @_; 2019 my ($path, $origin) = @_;
1288 2020
1289 cf::sync_job { cf::map::find $path, $origin } 2021 cf::sync_job { find $path, $origin }
1290} 2022}
1291 2023
1292sub do_load_sync { 2024sub do_load_sync {
1293 my ($map) = @_; 2025 my ($map) = @_;
1294 2026
2027 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2028 if $Coro::current == $Coro::main;
2029
1295 cf::sync_job { $map->load }; 2030 cf::sync_job { $map->load };
2031}
2032
2033our %MAP_PREFETCH;
2034our $MAP_PREFETCHER = undef;
2035
2036sub find_async {
2037 my ($path, $origin, $load) = @_;
2038
2039 $path = normalise $path, $origin && $origin->{path};
2040
2041 if (my $map = $cf::MAP{$path}) {
2042 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
2043 }
2044
2045 $MAP_PREFETCH{$path} |= $load;
2046
2047 $MAP_PREFETCHER ||= cf::async {
2048 while (%MAP_PREFETCH) {
2049 while (my ($k, $v) = each %MAP_PREFETCH) {
2050 if (my $map = find $k) {
2051 $map->load if $v;
2052 }
2053
2054 delete $MAP_PREFETCH{$k};
2055 }
2056 }
2057 undef $MAP_PREFETCHER;
2058 };
2059 $MAP_PREFETCHER->prio (6);
2060
2061 ()
1296} 2062}
1297 2063
1298sub save { 2064sub save {
1299 my ($self) = @_; 2065 my ($self) = @_;
1300 2066
1301 my $lock = cf::lock_acquire "map_data:" . $self->path; 2067 my $lock = cf::lock_acquire "map_data:$self->{path}";
1302 2068
1303 $self->{last_save} = $cf::RUNTIME; 2069 $self->{last_save} = $cf::RUNTIME;
1304 2070
1305 return unless $self->dirty; 2071 return unless $self->dirty;
1306 2072
1307 my $save = $self->{path}->save_path; utf8::encode $save; 2073 my $save = $self->save_path; utf8::encode $save;
1308 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2074 my $uniq = $self->uniq_path; utf8::encode $uniq;
1309 2075
1310 $self->{load_path} = $save; 2076 $self->{load_path} = $save;
1311 2077
1312 return if $self->{deny_save}; 2078 return if $self->{deny_save};
1313 2079
1314 local $self->{last_access} = $self->last_access;#d# 2080 local $self->{last_access} = $self->last_access;#d#
1315 2081
2082 cf::async {
2083 $_->contr->save for $self->players;
2084 };
2085
1316 if ($uniq) { 2086 if ($uniq) {
1317 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2087 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318 $self->save_objects ($uniq, cf::IO_UNIQUES); 2088 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1319 } else { 2089 } else {
1320 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2090 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1321 } 2091 }
1322} 2092}
1323 2093
1324sub swap_out { 2094sub swap_out {
1325 my ($self) = @_; 2095 my ($self) = @_;
1326 2096
1327 # save first because save cedes 2097 # save first because save cedes
1328 $self->save; 2098 $self->save;
1329 2099
1330 my $lock = cf::lock_acquire "map_data:" . $self->path; 2100 my $lock = cf::lock_acquire "map_data:$self->{path}";
1331 2101
1332 return if $self->players; 2102 return if $self->players;
1333 return if $self->in_memory != cf::MAP_IN_MEMORY; 2103 return if $self->in_memory != cf::MAP_IN_MEMORY;
1334 return if $self->{deny_save}; 2104 return if $self->{deny_save};
1335 2105
2106 $self->in_memory (cf::MAP_SWAPPED);
2107
2108 $self->deactivate;
2109 $_->clear_links_to ($self) for values %cf::MAP;
1336 $self->clear; 2110 $self->clear;
1337 $self->in_memory (cf::MAP_SWAPPED);
1338} 2111}
1339 2112
1340sub reset_at { 2113sub reset_at {
1341 my ($self) = @_; 2114 my ($self) = @_;
1342 2115
1343 # TODO: safety, remove and allow resettable per-player maps 2116 # TODO: safety, remove and allow resettable per-player maps
1344 return 1e99 if $self->{path}{user_rel};
1345 return 1e99 if $self->{deny_reset}; 2117 return 1e99 if $self->{deny_reset};
1346 2118
1347 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2119 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1348 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2120 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1349 2121
1354 my ($self) = @_; 2126 my ($self) = @_;
1355 2127
1356 $self->reset_at <= $cf::RUNTIME 2128 $self->reset_at <= $cf::RUNTIME
1357} 2129}
1358 2130
1359sub unlink_save {
1360 my ($self) = @_;
1361
1362 utf8::encode (my $save = $self->{path}->save_path);
1363 aioreq_pri 3; IO::AIO::aio_unlink $save;
1364 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1365}
1366
1367sub rename {
1368 my ($self, $new_path) = @_;
1369
1370 $self->unlink_save;
1371
1372 delete $cf::MAP{$self->path};
1373 $self->{path} = new cf::path $new_path;
1374 $self->path ($self->{path}->as_string);
1375 $cf::MAP{$self->path} = $self;
1376
1377 $self->save;
1378}
1379
1380sub reset { 2131sub reset {
1381 my ($self) = @_; 2132 my ($self) = @_;
1382 2133
1383 my $lock = cf::lock_acquire "map_data:" . $self->path; 2134 my $lock = cf::lock_acquire "map_data:$self->{path}";
1384 2135
1385 return if $self->players; 2136 return if $self->players;
1386 return if $self->{path}{user_rel};#d#
1387 2137
1388 warn "resetting map ", $self->path;#d# 2138 warn "resetting map ", $self->path;
2139
2140 $self->in_memory (cf::MAP_SWAPPED);
2141
2142 # need to save uniques path
2143 unless ($self->{deny_save}) {
2144 my $uniq = $self->uniq_path; utf8::encode $uniq;
2145
2146 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2147 if $uniq;
2148 }
1389 2149
1390 delete $cf::MAP{$self->path}; 2150 delete $cf::MAP{$self->path};
1391 2151
2152 $self->deactivate;
1392 $_->clear_links_to ($self) for values %cf::MAP; 2153 $_->clear_links_to ($self) for values %cf::MAP;
2154 $self->clear;
1393 2155
1394 $self->unlink_save; 2156 $self->unlink_save;
1395 $self->destroy; 2157 $self->destroy;
1396} 2158}
1397 2159
1398my $nuke_counter = "aaaa"; 2160my $nuke_counter = "aaaa";
1399 2161
1400sub nuke { 2162sub nuke {
1401 my ($self) = @_; 2163 my ($self) = @_;
1402 2164
2165 {
2166 my $lock = cf::lock_acquire "map_data:$self->{path}";
2167
2168 delete $cf::MAP{$self->path};
2169
2170 $self->unlink_save;
2171
2172 bless $self, "cf::map";
2173 delete $self->{deny_reset};
1403 $self->{deny_save} = 1; 2174 $self->{deny_save} = 1;
1404 $self->reset_timeout (1); 2175 $self->reset_timeout (1);
1405 $self->rename ("{nuke}/" . ($nuke_counter++)); 2176 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2177
2178 $cf::MAP{$self->path} = $self;
2179 }
2180
1406 $self->reset; # polite request, might not happen 2181 $self->reset; # polite request, might not happen
1407} 2182}
1408 2183
1409sub customise_for { 2184=item $maps = cf::map::tmp_maps
1410 my ($map, $ob) = @_;
1411 2185
1412 if ($map->per_player) { 2186Returns an arrayref with all map paths of currently instantiated and saved
1413 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2187maps. May block.
2188
2189=cut
2190
2191sub tmp_maps() {
1414 } 2192 [
1415 2193 map {
1416 $map 2194 utf8::decode $_;
2195 /\.map$/
2196 ? normalise $_
2197 : ()
2198 } @{ aio_readdir $TMPDIR or [] }
2199 ]
1417} 2200}
1418 2201
1419sub emergency_save { 2202=item $maps = cf::map::random_maps
1420 my $freeze_guard = cf::freeze_mainloop;
1421 2203
1422 warn "enter emergency map save\n"; 2204Returns an arrayref with all map paths of currently instantiated and saved
2205random maps. May block.
1423 2206
1424 cf::sync_job { 2207=cut
1425 warn "begin emergency map save\n";
1426 $_->save for values %cf::MAP;
1427 };
1428 2208
1429 warn "end emergency map save\n"; 2209sub random_maps() {
2210 [
2211 map {
2212 utf8::decode $_;
2213 /\.map$/
2214 ? normalise "?random/$_"
2215 : ()
2216 } @{ aio_readdir $RANDOMDIR or [] }
2217 ]
2218}
2219
2220=item cf::map::unique_maps
2221
2222Returns an arrayref of paths of all shared maps that have
2223instantiated unique items. May block.
2224
2225=cut
2226
2227sub unique_maps() {
2228 [
2229 map {
2230 utf8::decode $_;
2231 /\.map$/
2232 ? normalise $_
2233 : ()
2234 } @{ aio_readdir $UNIQUEDIR or [] }
2235 ]
1430} 2236}
1431 2237
1432package cf; 2238package cf;
1433 2239
1434=back 2240=back
1435 2241
2242=head3 cf::object
2243
2244=cut
2245
2246package cf::object;
2247
2248=over 4
2249
2250=item $ob->inv_recursive
2251
2252Returns the inventory of the object _and_ their inventories, recursively.
2253
2254=cut
2255
2256sub inv_recursive_;
2257sub inv_recursive_ {
2258 map { $_, inv_recursive_ $_->inv } @_
2259}
2260
2261sub inv_recursive {
2262 inv_recursive_ inv $_[0]
2263}
2264
2265=item $ref = $ob->ref
2266
2267creates and returns a persistent reference to an objetc that can be stored as a string.
2268
2269=item $ob = cf::object::deref ($refstring)
2270
2271returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2272even if the object actually exists. May block.
2273
2274=cut
2275
2276sub deref {
2277 my ($ref) = @_;
2278
2279 # temporary compatibility#TODO#remove
2280 $ref =~ s{^<}{player/<};
2281
2282 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2283 my ($uuid, $name) = ($1, $2);
2284 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2285 or return;
2286 $pl->ob->uuid eq $uuid
2287 or return;
2288
2289 $pl->ob
2290 } else {
2291 warn "$ref: cannot resolve object reference\n";
2292 undef
2293 }
2294}
2295
2296package cf;
2297
2298=back
1436 2299
1437=head3 cf::object::player 2300=head3 cf::object::player
1438 2301
1439=over 4 2302=over 4
1440 2303
1454 2317
1455 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2318 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1456 2319
1457 if ($self->{record_replies}) { 2320 if ($self->{record_replies}) {
1458 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2321 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2322
1459 } else { 2323 } else {
2324 my $pl = $self->contr;
2325
2326 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2327 my $dialog = $pl->{npc_dialog};
2328 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2329
2330 } else {
1460 $msg = $npc->name . " says: $msg" if $npc; 2331 $msg = $npc->name . " says: $msg" if $npc;
1461 $self->message ($msg, $flags); 2332 $self->message ($msg, $flags);
2333 }
1462 } 2334 }
2335}
2336
2337=item $object->send_msg ($channel, $msg, $color, [extra...])
2338
2339=cut
2340
2341sub cf::object::send_msg {
2342 my $pl = shift->contr
2343 or return;
2344 $pl->send_msg (@_);
1463} 2345}
1464 2346
1465=item $player_object->may ("access") 2347=item $player_object->may ("access")
1466 2348
1467Returns wether the given player is authorized to access resource "access" 2349Returns wether the given player is authorized to access resource "access"
1480 2362
1481=item $player_object->enter_link 2363=item $player_object->enter_link
1482 2364
1483Freezes the player and moves him/her to a special map (C<{link}>). 2365Freezes the player and moves him/her to a special map (C<{link}>).
1484 2366
1485The player should be reaosnably safe there for short amounts of time. You 2367The player should be reasonably safe there for short amounts of time. You
1486I<MUST> call C<leave_link> as soon as possible, though. 2368I<MUST> call C<leave_link> as soon as possible, though.
1487 2369
2370Will never block.
2371
1488=item $player_object->leave_link ($map, $x, $y) 2372=item $player_object->leave_link ($map, $x, $y)
1489 2373
1490Moves the player out of the specila link map onto the given map. If the 2374Moves the player out of the special C<{link}> map onto the specified
1491map is not valid (or omitted), the player will be moved back to the 2375map. If the map is not valid (or omitted), the player will be moved back
1492location he/she was before the call to C<enter_link>, or, if that fails, 2376to the location he/she was before the call to C<enter_link>, or, if that
1493to the emergency map position. 2377fails, to the emergency map position.
1494 2378
1495Might block. 2379Might block.
1496 2380
1497=cut 2381=cut
2382
2383sub link_map {
2384 unless ($LINK_MAP) {
2385 $LINK_MAP = cf::map::find "{link}"
2386 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2387 $LINK_MAP->load;
2388 }
2389
2390 $LINK_MAP
2391}
1498 2392
1499sub cf::object::player::enter_link { 2393sub cf::object::player::enter_link {
1500 my ($self) = @_; 2394 my ($self) = @_;
1501 2395
1502 $self->deactivate_recursive; 2396 $self->deactivate_recursive;
1503 2397
1504 return if $self->map == $LINK_MAP; 2398 return if UNIVERSAL::isa $self->map, "ext::map_link";
1505 2399
1506 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2400 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1507 if $self->map; 2401 if $self->map && $self->map->{path} ne "{link}";
1508 2402
1509 $self->enter_map ($LINK_MAP, 20, 20); 2403 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1510} 2404}
1511 2405
1512sub cf::object::player::leave_link { 2406sub cf::object::player::leave_link {
1513 my ($self, $map, $x, $y) = @_; 2407 my ($self, $map, $x, $y) = @_;
2408
2409 return unless $self->contr->active;
1514 2410
1515 my $link_pos = delete $self->{_link_pos}; 2411 my $link_pos = delete $self->{_link_pos};
1516 2412
1517 unless ($map) { 2413 unless ($map) {
1518 # restore original map position 2414 # restore original map position
1532 # use -1 or undef as default coordinates, not 0, 0 2428 # use -1 or undef as default coordinates, not 0, 0
1533 ($x, $y) = ($map->enter_x, $map->enter_y) 2429 ($x, $y) = ($map->enter_x, $map->enter_y)
1534 if $x <=0 && $y <= 0; 2430 if $x <=0 && $y <= 0;
1535 2431
1536 $map->load; 2432 $map->load;
2433 $map->load_neighbours;
1537 2434
2435 return unless $self->contr->active;
1538 $self->activate_recursive; 2436 $self->activate_recursive;
2437
2438 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1539 $self->enter_map ($map, $x, $y); 2439 $self->enter_map ($map, $x, $y);
1540} 2440}
1541 2441
1542cf::player->attach ( 2442=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1543 on_logout => sub {
1544 my ($pl) = @_;
1545 2443
1546 # abort map switching before logout 2444Moves the player to the given map-path and coordinates by first freezing
1547 if ($pl->ob->{_link_pos}) { 2445her, loading and preparing them map, calling the provided $check callback
1548 cf::sync_job { 2446that has to return the map if sucecssful, and then unfreezes the player on
1549 $pl->ob->leave_link 2447the new (success) or old (failed) map position. In either case, $done will
1550 }; 2448be called at the end of this process.
1551 }
1552 },
1553 on_login => sub {
1554 my ($pl) = @_;
1555 2449
1556 # try to abort aborted map switching on player login :)
1557 # should happen only on crashes
1558 if ($pl->ob->{_link_pos}) {
1559 $pl->ob->enter_link;
1560 cf::async {
1561 # we need this sleep as the login has a concurrent enter_exit running
1562 # and this sleep increases chances of the player not ending up in scorn
1563 Coro::Timer::sleep 1;
1564 $pl->ob->leave_link;
1565 };
1566 }
1567 },
1568);
1569
1570=item $player_object->goto ($path, $x, $y)
1571
1572=cut 2450=cut
2451
2452our $GOTOGEN;
1573 2453
1574sub cf::object::player::goto { 2454sub cf::object::player::goto {
1575 my ($self, $path, $x, $y) = @_; 2455 my ($self, $path, $x, $y, $check, $done) = @_;
2456
2457 # do generation counting so two concurrent goto's will be executed in-order
2458 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1576 2459
1577 $self->enter_link; 2460 $self->enter_link;
1578 2461
1579 (cf::async { 2462 (async {
1580 $path = new cf::path $path; 2463 my $map = eval {
1581
1582 my $map = cf::map::find $path->as_string; 2464 my $map = cf::map::find $path;
2465
2466 if ($map) {
1583 $map = $map->customise_for ($self) if $map; 2467 $map = $map->customise_for ($self);
1584 2468 $map = $check->($map) if $check && $map;
1585# warn "entering ", $map->path, " at ($x, $y)\n" 2469 } else {
1586# if $map;
1587
1588 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2470 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2471 }
1589 2472
2473 $map
2474 };
2475
2476 if ($@) {
2477 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2478 LOG llevError | logBacktrace, Carp::longmess $@;
2479 }
2480
2481 if ($gen == $self->{_goto_generation}) {
2482 delete $self->{_goto_generation};
1590 $self->leave_link ($map, $x, $y); 2483 $self->leave_link ($map, $x, $y);
2484 }
2485
2486 $done->() if $done;
1591 })->prio (1); 2487 })->prio (1);
1592} 2488}
1593 2489
1594=item $player_object->enter_exit ($exit_object) 2490=item $player_object->enter_exit ($exit_object)
1595 2491
1597 2493
1598sub parse_random_map_params { 2494sub parse_random_map_params {
1599 my ($spec) = @_; 2495 my ($spec) = @_;
1600 2496
1601 my $rmp = { # defaults 2497 my $rmp = { # defaults
1602 xsize => 10, 2498 xsize => (cf::rndm 15, 40),
1603 ysize => 10, 2499 ysize => (cf::rndm 15, 40),
2500 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2501 #layout => string,
1604 }; 2502 };
1605 2503
1606 for (split /\n/, $spec) { 2504 for (split /\n/, $spec) {
1607 my ($k, $v) = split /\s+/, $_, 2; 2505 my ($k, $v) = split /\s+/, $_, 2;
1608 2506
1612 $rmp 2510 $rmp
1613} 2511}
1614 2512
1615sub prepare_random_map { 2513sub prepare_random_map {
1616 my ($exit) = @_; 2514 my ($exit) = @_;
2515
2516 my $guard = cf::lock_acquire "exit_prepare:$exit";
1617 2517
1618 # all this does is basically replace the /! path by 2518 # all this does is basically replace the /! path by
1619 # a new random map path (?random/...) with a seed 2519 # a new random map path (?random/...) with a seed
1620 # that depends on the exit object 2520 # that depends on the exit object
1621 2521
1622 my $rmp = parse_random_map_params $exit->msg; 2522 my $rmp = parse_random_map_params $exit->msg;
1623 2523
1624 if ($exit->map) { 2524 if ($exit->map) {
1625 $rmp->{region} = $exit->map->region_name; 2525 $rmp->{region} = $exit->region->name;
1626 $rmp->{origin_map} = $exit->map->path; 2526 $rmp->{origin_map} = $exit->map->path;
1627 $rmp->{origin_x} = $exit->x; 2527 $rmp->{origin_x} = $exit->x;
1628 $rmp->{origin_y} = $exit->y; 2528 $rmp->{origin_y} = $exit->y;
1629 } 2529 }
1630 2530
1631 $rmp->{random_seed} ||= $exit->random_seed; 2531 $rmp->{random_seed} ||= $exit->random_seed;
1632 2532
1633 my $data = cf::to_json $rmp; 2533 my $data = cf::to_json $rmp;
1634 my $md5 = Digest::MD5::md5_hex $data; 2534 my $md5 = Digest::MD5::md5_hex $data;
2535 my $meta = "$RANDOMDIR/$md5.meta";
1635 2536
1636 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2537 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1637 aio_write $fh, 0, (length $data), $data, 0; 2538 aio_write $fh, 0, (length $data), $data, 0;
2539 undef $fh;
2540 aio_rename "$meta~", $meta;
1638 2541
1639 $exit->slaying ("?random/$md5"); 2542 $exit->slaying ("?random/$md5");
1640 $exit->msg (undef); 2543 $exit->msg (undef);
1641 } 2544 }
1642} 2545}
1644sub cf::object::player::enter_exit { 2547sub cf::object::player::enter_exit {
1645 my ($self, $exit) = @_; 2548 my ($self, $exit) = @_;
1646 2549
1647 return unless $self->type == cf::PLAYER; 2550 return unless $self->type == cf::PLAYER;
1648 2551
2552 if ($exit->slaying eq "/!") {
2553 #TODO: this should de-fi-ni-te-ly not be a sync-job
2554 # the problem is that $exit might not survive long enough
2555 # so it needs to be done right now, right here
2556 cf::sync_job { prepare_random_map $exit };
2557 }
2558
2559 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2560 my $hp = $exit->stats->hp;
2561 my $sp = $exit->stats->sp;
2562
1649 $self->enter_link; 2563 $self->enter_link;
1650 2564
2565 # if exit is damned, update players death & WoR home-position
2566 $self->contr->savebed ($slaying, $hp, $sp)
2567 if $exit->flag (FLAG_DAMNED);
2568
1651 (cf::async { 2569 (async {
1652 $self->deactivate_recursive; # just to be sure 2570 $self->deactivate_recursive; # just to be sure
1653 unless (eval { 2571 unless (eval {
1654 prepare_random_map $exit 2572 $self->goto ($slaying, $hp, $sp);
1655 if $exit->slaying eq "/!";
1656
1657 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1658 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1659 2573
1660 1; 2574 1;
1661 }) { 2575 }) {
1662 $self->message ("Something went wrong deep within the crossfire server. " 2576 $self->message ("Something went wrong deep within the crossfire server. "
1663 . "I'll try to bring you back to the map you were before. " 2577 . "I'll try to bring you back to the map you were before. "
1664 . "Please report this to the dungeon master", 2578 . "Please report this to the dungeon master!",
1665 cf::NDI_UNIQUE | cf::NDI_RED); 2579 cf::NDI_UNIQUE | cf::NDI_RED);
1666 2580
1667 warn "ERROR in enter_exit: $@"; 2581 warn "ERROR in enter_exit: $@";
1668 $self->leave_link; 2582 $self->leave_link;
1669 } 2583 }
1670 })->prio (1); 2584 })->prio (1);
1683 2597
1684sub cf::client::send_drawinfo { 2598sub cf::client::send_drawinfo {
1685 my ($self, $text, $flags) = @_; 2599 my ($self, $text, $flags) = @_;
1686 2600
1687 utf8::encode $text; 2601 utf8::encode $text;
1688 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2602 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1689} 2603}
1690 2604
2605=item $client->send_msg ($channel, $msg, $color, [extra...])
2606
2607Send a drawinfo or msg packet to the client, formatting the msg for the
2608client if neccessary. C<$type> should be a string identifying the type of
2609the message, with C<log> being the default. If C<$color> is negative, suppress
2610the message unless the client supports the msg packet.
2611
2612=cut
2613
2614our %CHANNEL = (
2615 "c/identify" => {
2616 id => "identify",
2617 title => "Identify",
2618 reply => undef,
2619 tooltip => "Items recently identified",
2620 },
2621 "c/examine" => {
2622 id => "examine",
2623 title => "Examine",
2624 reply => undef,
2625 tooltip => "Signs and other items you examined",
2626 },
2627);
2628
2629sub cf::client::send_msg {
2630 my ($self, $channel, $msg, $color, @extra) = @_;
2631
2632 $msg = $self->pl->expand_cfpod ($msg);
2633
2634 $color &= cf::NDI_CLIENT_MASK; # just in case...
2635
2636 # check predefined channels, for the benefit of C
2637 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2638
2639 if (ref $channel) {
2640 # send meta info to client, if not yet sent
2641 unless (exists $self->{channel}{$channel->{id}}) {
2642 $self->{channel}{$channel->{id}} = $channel;
2643 $self->ext_msg (channel_info => $channel)
2644 if $self->can_msg;
2645 }
2646
2647 $channel = $channel->{id};
2648 }
2649
2650 return unless @extra || length $msg;
2651
2652 if ($self->can_msg) {
2653 # default colour, mask it out
2654 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2655 if $color & cf::NDI_DEF;
2656
2657 $self->send_packet ("msg " . $self->{json_coder}->encode (
2658 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2659 } else {
2660 if ($color >= 0) {
2661 # replace some tags by gcfclient-compatible ones
2662 for ($msg) {
2663 1 while
2664 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2665 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2666 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2667 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2668 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2669 }
2670
2671 $color &= cf::NDI_COLOR_MASK;
2672
2673 utf8::encode $msg;
2674
2675 if (0 && $msg =~ /\[/) {
2676 # COMMAND/INFO
2677 $self->send_packet ("drawextinfo $color 10 8 $msg")
2678 } else {
2679 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2680 $self->send_packet ("drawinfo $color $msg")
2681 }
2682 }
2683 }
2684}
2685
2686=item $client->ext_msg ($type, @msg)
2687
2688Sends an ext event to the client.
2689
2690=cut
2691
2692sub cf::client::ext_msg($$@) {
2693 my ($self, $type, @msg) = @_;
2694
2695 if ($self->extcmd == 2) {
2696 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2697 } elsif ($self->extcmd == 1) { # TODO: remove
2698 push @msg, msgtype => "event_$type";
2699 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2700 }
2701}
2702
2703=item $client->ext_reply ($msgid, @msg)
2704
2705Sends an ext reply to the client.
2706
2707=cut
2708
2709sub cf::client::ext_reply($$@) {
2710 my ($self, $id, @msg) = @_;
2711
2712 if ($self->extcmd == 2) {
2713 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2714 } elsif ($self->extcmd == 1) {
2715 #TODO: version 1, remove
2716 unshift @msg, msgtype => "reply", msgid => $id;
2717 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2718 }
2719}
1691 2720
1692=item $success = $client->query ($flags, "text", \&cb) 2721=item $success = $client->query ($flags, "text", \&cb)
1693 2722
1694Queues a query to the client, calling the given callback with 2723Queues a query to the client, calling the given callback with
1695the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2724the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1696C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2725C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1697 2726
1698Queries can fail, so check the return code. Or don't, as queries will become 2727Queries can fail, so check the return code. Or don't, as queries will
1699reliable at some point in the future. 2728become reliable at some point in the future.
1700 2729
1701=cut 2730=cut
1702 2731
1703sub cf::client::query { 2732sub cf::client::query {
1704 my ($self, $flags, $text, $cb) = @_; 2733 my ($self, $flags, $text, $cb) = @_;
1712 utf8::encode $text; 2741 utf8::encode $text;
1713 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2742 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1714 2743
1715 $self->send_packet ($self->{query_queue}[0][0]) 2744 $self->send_packet ($self->{query_queue}[0][0])
1716 if @{ $self->{query_queue} } == 1; 2745 if @{ $self->{query_queue} } == 1;
2746
2747 1
1717} 2748}
1718 2749
1719cf::client->attach ( 2750cf::client->attach (
2751 on_connect => sub {
2752 my ($ns) = @_;
2753
2754 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2755 },
1720 on_reply => sub { 2756 on_reply => sub {
1721 my ($ns, $msg) = @_; 2757 my ($ns, $msg) = @_;
1722 2758
1723 # this weird shuffling is so that direct followup queries 2759 # this weird shuffling is so that direct followup queries
1724 # get handled first 2760 # get handled first
1725 my $queue = delete $ns->{query_queue} 2761 my $queue = delete $ns->{query_queue}
1726 or return; # be conservative, not sure how that can happen, but we saw a crash here 2762 or return; # be conservative, not sure how that can happen, but we saw a crash here
1727 2763
1728 (shift @$queue)->[1]->($msg); 2764 (shift @$queue)->[1]->($msg);
2765 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1729 2766
1730 push @{ $ns->{query_queue} }, @$queue; 2767 push @{ $ns->{query_queue} }, @$queue;
1731 2768
1732 if (@{ $ns->{query_queue} } == @$queue) { 2769 if (@{ $ns->{query_queue} } == @$queue) {
1733 if (@$queue) { 2770 if (@$queue) {
1735 } else { 2772 } else {
1736 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2773 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1737 } 2774 }
1738 } 2775 }
1739 }, 2776 },
2777 on_exticmd => sub {
2778 my ($ns, $buf) = @_;
2779
2780 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2781
2782 if (ref $msg) {
2783 my ($type, $reply, @payload) =
2784 "ARRAY" eq ref $msg
2785 ? @$msg
2786 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2787
2788 my @reply;
2789
2790 if (my $cb = $EXTICMD{$type}) {
2791 @reply = $cb->($ns, @payload);
2792 }
2793
2794 $ns->ext_reply ($reply, @reply)
2795 if $reply;
2796
2797 } else {
2798 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2799 }
2800
2801 cf::override;
2802 },
1740); 2803);
1741 2804
1742=item $client->coro (\&cb) 2805=item $client->async (\&cb)
1743 2806
1744Create a new coroutine, running the specified callback. The coroutine will 2807Create a new coroutine, running the specified callback. The coroutine will
1745be automatically cancelled when the client gets destroyed (e.g. on logout, 2808be automatically cancelled when the client gets destroyed (e.g. on logout,
1746or loss of connection). 2809or loss of connection).
1747 2810
1748=cut 2811=cut
1749 2812
1750sub cf::client::coro { 2813sub cf::client::async {
1751 my ($self, $cb) = @_; 2814 my ($self, $cb) = @_;
1752 2815
1753 my $coro = &cf::async ($cb); 2816 my $coro = &Coro::async ($cb);
1754 2817
1755 $coro->on_destroy (sub { 2818 $coro->on_destroy (sub {
1756 delete $self->{_coro}{$coro+0}; 2819 delete $self->{_coro}{$coro+0};
1757 }); 2820 });
1758 2821
1785our $safe = new Safe "safe"; 2848our $safe = new Safe "safe";
1786our $safe_hole = new Safe::Hole; 2849our $safe_hole = new Safe::Hole;
1787 2850
1788$SIG{FPE} = 'IGNORE'; 2851$SIG{FPE} = 'IGNORE';
1789 2852
1790$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2853$safe->permit_only (Opcode::opset qw(
2854 :base_core :base_mem :base_orig :base_math
2855 grepstart grepwhile mapstart mapwhile
2856 sort time
2857));
1791 2858
1792# here we export the classes and methods available to script code 2859# here we export the classes and methods available to script code
1793 2860
1794=pod 2861=pod
1795 2862
1796The following fucntions and emthods are available within a safe environment: 2863The following functions and methods are available within a safe environment:
1797 2864
1798 cf::object contr pay_amount pay_player map 2865 cf::object
2866 contr pay_amount pay_player map x y force_find force_add
2867 insert remove name archname title slaying race decrease_ob_nr
2868
1799 cf::object::player player 2869 cf::object::player
1800 cf::player peaceful 2870 player
1801 cf::map trigger 2871
2872 cf::player
2873 peaceful
2874
2875 cf::map
2876 trigger
1802 2877
1803=cut 2878=cut
1804 2879
1805for ( 2880for (
1806 ["cf::object" => qw(contr pay_amount pay_player map)], 2881 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2882 insert remove inv name archname title slaying race
2883 decrease_ob_nr)],
1807 ["cf::object::player" => qw(player)], 2884 ["cf::object::player" => qw(player)],
1808 ["cf::player" => qw(peaceful)], 2885 ["cf::player" => qw(peaceful)],
1809 ["cf::map" => qw(trigger)], 2886 ["cf::map" => qw(trigger)],
1810) { 2887) {
1811 no strict 'refs'; 2888 no strict 'refs';
1882=back 2959=back
1883 2960
1884=cut 2961=cut
1885 2962
1886############################################################################# 2963#############################################################################
2964# the server's init and main functions
1887 2965
1888=head2 EXTENSION DATABASE SUPPORT 2966sub load_facedata($) {
2967 my ($path) = @_;
1889 2968
1890Crossfire maintains a very simple database for extension use. It can 2969 # HACK to clear player env face cache, we need some signal framework
1891currently store anything that can be serialised using Storable, which 2970 # for this (global event?)
1892excludes objects. 2971 %ext::player_env::MUSIC_FACE_CACHE = ();
1893 2972
1894The parameter C<$family> should best start with the name of the extension 2973 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1895using it, it should be unique.
1896 2974
1897=over 4 2975 warn "loading facedata from $path\n";
1898 2976
1899=item $hashref = cf::db_get $family 2977 my $facedata;
2978 0 < aio_load $path, $facedata
2979 or die "$path: $!";
1900 2980
1901Return a hashref for use by the extension C<$family>, which can be 2981 $facedata = Coro::Storable::thaw $facedata;
1902modified. After modifications, you have to call C<cf::db_dirty> or
1903C<cf::db_sync>.
1904 2982
1905=item $value = cf::db_get $family => $key 2983 $facedata->{version} == 2
2984 or cf::cleanup "$path: version mismatch, cannot proceed.";
1906 2985
1907Returns a single value from the database 2986 # patch in the exptable
1908 2987 $facedata->{resource}{"res/exp_table"} = {
1909=item cf::db_put $family => $hashref 2988 type => FT_RSRC,
1910 2989 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1911Stores the given family hashref into the database. Updates are delayed, if
1912you want the data to be synced to disk immediately, use C<cf::db_sync>.
1913
1914=item cf::db_put $family => $key => $value
1915
1916Stores the given C<$value> in the family hash. Updates are delayed, if you
1917want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919=item cf::db_dirty
1920
1921Marks the database as dirty, to be updated at a later time.
1922
1923=item cf::db_sync
1924
1925Immediately write the database to disk I<if it is dirty>.
1926
1927=cut
1928
1929our $DB;
1930
1931{
1932 my $path = cf::localdir . "/database.pst";
1933
1934 sub db_load() {
1935 $DB = stat $path ? Storable::retrieve $path : { };
1936 }
1937
1938 my $pid;
1939
1940 sub db_save() {
1941 waitpid $pid, 0 if $pid;
1942 if (0 == ($pid = fork)) {
1943 $DB->{_meta}{version} = 1;
1944 Storable::nstore $DB, "$path~";
1945 rename "$path~", $path;
1946 cf::_exit 0 if defined $pid;
1947 }
1948 }
1949
1950 my $dirty;
1951
1952 sub db_sync() {
1953 db_save if $dirty;
1954 undef $dirty;
1955 }
1956
1957 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1958 db_sync;
1959 }); 2990 };
2991 cf::cede_to_tick;
1960 2992
1961 sub db_dirty() {
1962 $dirty = 1;
1963 $idle->start;
1964 } 2993 {
2994 my $faces = $facedata->{faceinfo};
1965 2995
1966 sub db_get($;$) { 2996 while (my ($face, $info) = each %$faces) {
1967 @_ >= 2 2997 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1968 ? $DB->{$_[0]}{$_[1]} 2998 cf::face::set_visibility $idx, $info->{visibility};
1969 : ($DB->{$_[0]} ||= { }) 2999 cf::face::set_magicmap $idx, $info->{magicmap};
1970 } 3000 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3001 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1971 3002
1972 sub db_put($$;$) { 3003 cf::cede_to_tick;
1973 if (@_ >= 3) {
1974 $DB->{$_[0]}{$_[1]} = $_[2];
1975 } else {
1976 $DB->{$_[0]} = $_[1];
1977 }
1978 db_dirty;
1979 }
1980
1981 cf::global->attach (
1982 prio => 10000,
1983 on_cleanup => sub {
1984 db_sync;
1985 }, 3004 }
1986 );
1987}
1988 3005
1989############################################################################# 3006 while (my ($face, $info) = each %$faces) {
1990# the server's main() 3007 next unless $info->{smooth};
3008 my $idx = cf::face::find $face
3009 or next;
3010 if (my $smooth = cf::face::find $info->{smooth}) {
3011 cf::face::set_smooth $idx, $smooth;
3012 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3013 } else {
3014 warn "smooth face '$info->{smooth}' not found for face '$face'";
3015 }
1991 3016
1992sub cfg_load { 3017 cf::cede_to_tick;
3018 }
3019 }
3020
3021 {
3022 my $anims = $facedata->{animinfo};
3023
3024 while (my ($anim, $info) = each %$anims) {
3025 cf::anim::set $anim, $info->{frames}, $info->{facings};
3026 cf::cede_to_tick;
3027 }
3028
3029 cf::anim::invalidate_all; # d'oh
3030 }
3031
3032 {
3033 # TODO: for gcfclient pleasure, we should give resources
3034 # that gcfclient doesn't grok a >10000 face index.
3035 my $res = $facedata->{resource};
3036
3037 my $soundconf = delete $res->{"res/sound.conf"};
3038
3039 while (my ($name, $info) = each %$res) {
3040 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3041 my $data;
3042
3043 if ($info->{type} & 1) {
3044 # prepend meta info
3045
3046 my $meta = $enc->encode ({
3047 name => $name,
3048 %{ $info->{meta} || {} },
3049 });
3050
3051 $data = pack "(w/a*)*", $meta, $info->{data};
3052 } else {
3053 $data = $info->{data};
3054 }
3055
3056 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3057 cf::face::set_type $idx, $info->{type};
3058
3059 cf::cede_to_tick;
3060 }
3061
3062 if ($soundconf) {
3063 $soundconf = $enc->decode (delete $soundconf->{data});
3064
3065 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3066 my $sound = $soundconf->{compat}[$_]
3067 or next;
3068
3069 my $face = cf::face::find "sound/$sound->[1]";
3070 cf::sound::set $sound->[0] => $face;
3071 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3072 }
3073
3074 while (my ($k, $v) = each %{$soundconf->{event}}) {
3075 my $face = cf::face::find "sound/$v";
3076 cf::sound::set $k => $face;
3077 }
3078 }
3079 }
3080
3081 1
3082}
3083
3084register_exticmd fx_want => sub {
3085 my ($ns, $want) = @_;
3086
3087 while (my ($k, $v) = each %$want) {
3088 $ns->fx_want ($k, $v);
3089 }
3090};
3091
3092sub reload_regions {
3093 # HACK to clear player env face cache, we need some signal framework
3094 # for this (global event?)
3095 %ext::player_env::MUSIC_FACE_CACHE = ();
3096
3097 load_resource_file "$MAPDIR/regions"
3098 or die "unable to load regions file\n";
3099
3100 for (cf::region::list) {
3101 $_->{match} = qr/$_->{match}/
3102 if exists $_->{match};
3103 }
3104}
3105
3106sub reload_facedata {
3107 load_facedata "$DATADIR/facedata"
3108 or die "unable to load facedata\n";
3109}
3110
3111sub reload_archetypes {
3112 load_resource_file "$DATADIR/archetypes"
3113 or die "unable to load archetypes\n";
3114 #d# NEED to laod twice to resolve forward references
3115 # this really needs to be done in an extra post-pass
3116 # (which needs to be synchronous, so solve it differently)
3117 load_resource_file "$DATADIR/archetypes"
3118 or die "unable to load archetypes\n";
3119}
3120
3121sub reload_treasures {
3122 load_resource_file "$DATADIR/treasures"
3123 or die "unable to load treasurelists\n";
3124}
3125
3126sub reload_resources {
3127 warn "reloading resource files...\n";
3128
3129 reload_regions;
3130 reload_facedata;
3131 #reload_archetypes;#d#
3132 reload_archetypes;
3133 reload_treasures;
3134
3135 warn "finished reloading resource files\n";
3136}
3137
3138sub init {
3139 reload_resources;
3140}
3141
3142sub reload_config {
1993 open my $fh, "<:utf8", cf::confdir . "/config" 3143 open my $fh, "<:utf8", "$CONFDIR/config"
1994 or return; 3144 or return;
1995 3145
1996 local $/; 3146 local $/;
1997 *CFG = YAML::Syck::Load <$fh>; 3147 *CFG = YAML::Syck::Load <$fh>;
1998 3148
1999 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3149 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2000 3150
3151 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3152 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3153
2001 if (exists $CFG{mlockall}) { 3154 if (exists $CFG{mlockall}) {
2002 eval { 3155 eval {
2003 $CFG{mlockall} ? &mlockall : &munlockall 3156 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2004 and die "WARNING: m(un)lockall failed: $!\n"; 3157 and die "WARNING: m(un)lockall failed: $!\n";
2005 }; 3158 };
2006 warn $@ if $@; 3159 warn $@ if $@;
2007 } 3160 }
2008} 3161}
2009 3162
2010sub main { 3163sub main {
2011 # we must not ever block the main coroutine 3164 # we must not ever block the main coroutine
2012 local $Coro::idle = sub { 3165 local $Coro::idle = sub {
2013 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3166 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2014 (Coro::unblock_sub { 3167 (async {
2015 Event::one_event; 3168 Event::one_event;
2016 })->(); 3169 })->prio (Coro::PRIO_MAX);
2017 }; 3170 };
2018 3171
2019 cfg_load; 3172 reload_config;
2020 db_load; 3173 db_init;
2021 load_extensions; 3174 load_extensions;
3175
3176 $TICK_WATCHER->start;
2022 Event::loop; 3177 Event::loop;
2023} 3178}
2024 3179
2025############################################################################# 3180#############################################################################
2026# initialisation 3181# initialisation and cleanup
2027 3182
3183# install some emergency cleanup handlers
3184BEGIN {
3185 for my $signal (qw(INT HUP TERM)) {
3186 Event->signal (
3187 reentrant => 0,
3188 data => WF_AUTOCANCEL,
3189 signal => $signal,
3190 prio => 0,
3191 cb => sub {
3192 cf::cleanup "SIG$signal";
3193 },
3194 );
3195 }
3196}
3197
3198sub write_runtime {
3199 my $runtime = "$LOCALDIR/runtime";
3200
3201 # first touch the runtime file to show we are still running:
3202 # the fsync below can take a very very long time.
3203
3204 IO::AIO::aio_utime $runtime, undef, undef;
3205
3206 my $guard = cf::lock_acquire "write_runtime";
3207
3208 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3209 or return;
3210
3211 my $value = $cf::RUNTIME + 90 + 10;
3212 # 10 is the runtime save interval, for a monotonic clock
3213 # 60 allows for the watchdog to kill the server.
3214
3215 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3216 and return;
3217
3218 # always fsync - this file is important
3219 aio_fsync $fh
3220 and return;
3221
3222 # touch it again to show we are up-to-date
3223 aio_utime $fh, undef, undef;
3224
3225 close $fh
3226 or return;
3227
3228 aio_rename "$runtime~", $runtime
3229 and return;
3230
3231 warn "runtime file written.\n";
3232
3233 1
3234}
3235
3236sub emergency_save() {
3237 my $freeze_guard = cf::freeze_mainloop;
3238
3239 warn "enter emergency perl save\n";
3240
3241 cf::sync_job {
3242 # use a peculiar iteration method to avoid tripping on perl
3243 # refcount bugs in for. also avoids problems with players
3244 # and maps saved/destroyed asynchronously.
3245 warn "begin emergency player save\n";
3246 for my $login (keys %cf::PLAYER) {
3247 my $pl = $cf::PLAYER{$login} or next;
3248 $pl->valid or next;
3249 $pl->save;
3250 }
3251 warn "end emergency player save\n";
3252
3253 warn "begin emergency map save\n";
3254 for my $path (keys %cf::MAP) {
3255 my $map = $cf::MAP{$path} or next;
3256 $map->valid or next;
3257 $map->save;
3258 }
3259 warn "end emergency map save\n";
3260
3261 warn "begin emergency database checkpoint\n";
3262 BDB::db_env_txn_checkpoint $DB_ENV;
3263 warn "end emergency database checkpoint\n";
3264 };
3265
3266 warn "leave emergency perl save\n";
3267}
3268
3269sub post_cleanup {
3270 my ($make_core) = @_;
3271
3272 warn Carp::longmess "post_cleanup backtrace"
3273 if $make_core;
3274}
3275
2028sub reload() { 3276sub do_reload_perl() {
2029 # can/must only be called in main 3277 # can/must only be called in main
2030 if ($Coro::current != $Coro::main) { 3278 if ($Coro::current != $Coro::main) {
2031 warn "can only reload from main coroutine\n"; 3279 warn "can only reload from main coroutine";
2032 return; 3280 return;
2033 } 3281 }
2034 3282
2035 warn "reloading..."; 3283 warn "reloading...";
2036 3284
2037 my $guard = freeze_mainloop; 3285 warn "entering sync_job";
3286
3287 cf::sync_job {
3288 cf::write_runtime; # external watchdog should not bark
2038 cf::emergency_save; 3289 cf::emergency_save;
3290 cf::write_runtime; # external watchdog should not bark
2039 3291
2040 eval { 3292 warn "syncing database to disk";
3293 BDB::db_env_txn_checkpoint $DB_ENV;
3294
2041 # if anything goes wrong in here, we should simply crash as we already saved 3295 # if anything goes wrong in here, we should simply crash as we already saved
2042 3296
2043 # cancel all watchers 3297 warn "cancelling all WF_AUTOCANCEL watchers";
2044 for (Event::all_watchers) { 3298 for (Event::all_watchers) {
2045 $_->cancel if $_->data & WF_AUTOCANCEL; 3299 $_->cancel if $_->data & WF_AUTOCANCEL;
2046 } 3300 }
2047 3301
3302 warn "flushing outstanding aio requests";
3303 for (;;) {
3304 BDB::flush;
3305 IO::AIO::flush;
3306 Coro::cede;
3307 last unless IO::AIO::nreqs || BDB::nreqs;
3308 warn "iterate...";
3309 }
3310
3311 ++$RELOAD;
3312
2048 # cancel all extension coros 3313 warn "cancelling all extension coros";
2049 $_->cancel for values %EXT_CORO; 3314 $_->cancel for values %EXT_CORO;
2050 %EXT_CORO = (); 3315 %EXT_CORO = ();
2051 3316
2052 # unload all extensions 3317 warn "removing commands";
2053 for (@exts) { 3318 %COMMAND = ();
3319
3320 warn "removing ext/exti commands";
3321 %EXTCMD = ();
3322 %EXTICMD = ();
3323
3324 warn "unloading/nuking all extensions";
3325 for my $pkg (@EXTS) {
2054 warn "unloading <$_>"; 3326 warn "... unloading $pkg";
2055 unload_extension $_; 3327
3328 if (my $cb = $pkg->can ("unload")) {
3329 eval {
3330 $cb->($pkg);
3331 1
3332 } or warn "$pkg unloaded, but with errors: $@";
2056 } 3333 }
2057 3334
3335 warn "... nuking $pkg";
3336 Symbol::delete_package $pkg;
3337 }
3338
2058 # unload all modules loaded from $LIBDIR 3339 warn "unloading all perl modules loaded from $LIBDIR";
2059 while (my ($k, $v) = each %INC) { 3340 while (my ($k, $v) = each %INC) {
2060 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3341 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2061 3342
2062 warn "removing <$k>"; 3343 warn "... unloading $k";
2063 delete $INC{$k}; 3344 delete $INC{$k};
2064 3345
2065 $k =~ s/\.pm$//; 3346 $k =~ s/\.pm$//;
2066 $k =~ s/\//::/g; 3347 $k =~ s/\//::/g;
2067 3348
2070 } 3351 }
2071 3352
2072 Symbol::delete_package $k; 3353 Symbol::delete_package $k;
2073 } 3354 }
2074 3355
2075 # sync database to disk
2076 cf::db_sync;
2077 IO::AIO::flush;
2078
2079 # get rid of safe::, as good as possible 3356 warn "getting rid of safe::, as good as possible";
2080 Symbol::delete_package "safe::$_" 3357 Symbol::delete_package "safe::$_"
2081 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3358 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2082 3359
2083 # remove register_script_function callbacks
2084 # TODO
2085
2086 # unload cf.pm "a bit" 3360 warn "unloading cf.pm \"a bit\"";
2087 delete $INC{"cf.pm"}; 3361 delete $INC{"cf.pm"};
3362 delete $INC{"cf/pod.pm"};
2088 3363
2089 # don't, removes xs symbols, too, 3364 # don't, removes xs symbols, too,
2090 # and global variables created in xs 3365 # and global variables created in xs
2091 #Symbol::delete_package __PACKAGE__; 3366 #Symbol::delete_package __PACKAGE__;
2092 3367
2093 # reload cf.pm 3368 warn "unload completed, starting to reload now";
3369
2094 warn "reloading cf.pm"; 3370 warn "reloading cf.pm";
2095 require cf; 3371 require cf;
2096 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3372 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2097 3373
2098 # load config and database again 3374 warn "loading config and database again";
2099 cf::cfg_load; 3375 cf::reload_config;
2100 cf::db_load;
2101 3376
2102 # load extensions
2103 warn "load extensions"; 3377 warn "loading extensions";
2104 cf::load_extensions; 3378 cf::load_extensions;
2105 3379
2106 # reattach attachments to objects 3380 warn "reattaching attachments to objects/players";
2107 warn "reattach"; 3381 _global_reattach; # objects, sockets
2108 _global_reattach; 3382 warn "reattaching attachments to maps";
2109 }; 3383 reattach $_ for values %MAP;
3384 warn "reattaching attachments to players";
3385 reattach $_ for values %PLAYER;
2110 3386
2111 if ($@) { 3387 warn "leaving sync_job";
3388
3389 1
3390 } or do {
2112 warn $@; 3391 warn $@;
2113 warn "error while reloading, exiting."; 3392 warn "error while reloading, exiting.";
2114 exit 1; 3393 exit 1;
2115 } 3394 };
2116 3395
2117 warn "reloaded successfully"; 3396 warn "reloaded";
2118}; 3397};
2119 3398
2120############################################################################# 3399our $RELOAD_WATCHER; # used only during reload
2121 3400
2122unless ($LINK_MAP) { 3401sub reload_perl() {
2123 $LINK_MAP = cf::map::new; 3402 # doing reload synchronously and two reloads happen back-to-back,
3403 # coro crashes during coro_state_free->destroy here.
2124 3404
2125 $LINK_MAP->width (41); 3405 $RELOAD_WATCHER ||= Event->timer (
2126 $LINK_MAP->height (41); 3406 reentrant => 0,
2127 $LINK_MAP->alloc;
2128 $LINK_MAP->path ("{link}");
2129 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2130 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2131
2132 # dirty hack because... archetypes are not yet loaded
2133 Event->timer (
2134 after => 2, 3407 after => 0,
3408 data => WF_AUTOCANCEL,
2135 cb => sub { 3409 cb => sub {
2136 $_[0]->w->cancel; 3410 do_reload_perl;
2137 3411 undef $RELOAD_WATCHER;
2138 # provide some exits "home"
2139 my $exit = cf::object::new "exit";
2140
2141 $exit->slaying ($EMERGENCY_POSITION->[0]);
2142 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2143 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2144
2145 $LINK_MAP->insert ($exit->clone, 19, 19);
2146 $LINK_MAP->insert ($exit->clone, 19, 20);
2147 $LINK_MAP->insert ($exit->clone, 19, 21);
2148 $LINK_MAP->insert ($exit->clone, 20, 19);
2149 $LINK_MAP->insert ($exit->clone, 20, 21);
2150 $LINK_MAP->insert ($exit->clone, 21, 19);
2151 $LINK_MAP->insert ($exit->clone, 21, 20);
2152 $LINK_MAP->insert ($exit->clone, 21, 21);
2153
2154 $exit->destroy;
2155 }); 3412 },
2156 3413 );
2157 $LINK_MAP->{deny_save} = 1;
2158 $LINK_MAP->{deny_reset} = 1;
2159
2160 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2161} 3414}
2162
2163register "<global>", __PACKAGE__;
2164 3415
2165register_command "reload" => sub { 3416register_command "reload" => sub {
2166 my ($who, $arg) = @_; 3417 my ($who, $arg) = @_;
2167 3418
2168 if ($who->flag (FLAG_WIZ)) { 3419 if ($who->flag (FLAG_WIZ)) {
2169 $who->message ("start of reload.");
2170 reload;
2171 $who->message ("end of reload."); 3420 $who->message ("reloading server.");
3421 async { reload_perl };
2172 } 3422 }
2173}; 3423};
2174 3424
2175unshift @INC, $LIBDIR; 3425unshift @INC, $LIBDIR;
3426
3427my $bug_warning = 0;
3428
3429our @WAIT_FOR_TICK;
3430our @WAIT_FOR_TICK_BEGIN;
3431
3432sub wait_for_tick {
3433 return unless $TICK_WATCHER->is_active;
3434 return if $Coro::current == $Coro::main;
3435
3436 my $signal = new Coro::Signal;
3437 push @WAIT_FOR_TICK, $signal;
3438 $signal->wait;
3439}
3440
3441sub wait_for_tick_begin {
3442 return unless $TICK_WATCHER->is_active;
3443 return if $Coro::current == $Coro::main;
3444
3445 my $signal = new Coro::Signal;
3446 push @WAIT_FOR_TICK_BEGIN, $signal;
3447 $signal->wait;
3448}
3449
3450our $stat_fh;
3451sysopen $stat_fh, "/tmp/cfstats", Fcntl::O_APPEND | Fcntl::O_CREAT | Fcntl::O_WRONLY, 0600;#d#
2176 3452
2177$TICK_WATCHER = Event->timer ( 3453$TICK_WATCHER = Event->timer (
2178 reentrant => 0, 3454 reentrant => 0,
3455 parked => 1,
2179 prio => 0, 3456 prio => 0,
2180 at => $NEXT_TICK || $TICK, 3457 at => $NEXT_TICK || $TICK,
2181 data => WF_AUTOCANCEL, 3458 data => WF_AUTOCANCEL,
2182 cb => sub { 3459 cb => sub {
3460 if ($Coro::current != $Coro::main) {
3461 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3462 unless ++$bug_warning > 10;
3463 return;
3464 }
3465
3466 my @pl = cf::player::list; my $stats = sprintf "%.2f %d %d %d", $RUNTIME, (scalar @pl), cf::object::actives_size, cf::object::objects_size; #d#
3467
3468 $NOW = $tick_start = Event::time;
3469
2183 cf::server_tick; # one server iteration 3470 cf::server_tick; # one server iteration
3471
2184 $RUNTIME += $TICK; 3472 $RUNTIME += $TICK;
2185 $NEXT_TICK += $TICK; 3473 $NEXT_TICK += $TICK;
2186 3474
3475 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3476 $NEXT_RUNTIME_WRITE = $NOW + 10;
3477 Coro::async_pool {
3478 write_runtime
3479 or warn "ERROR: unable to write runtime file: $!";
3480 };
3481 }
3482
3483# my $AFTER = Event::time;
3484# warn $AFTER - $NOW;#d#
3485
3486 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3487 $sig->send;
3488 }
3489 while (my $sig = shift @WAIT_FOR_TICK) {
3490 $sig->send;
3491 }
3492
3493 $NOW = Event::time;
3494
2187 # if we are delayed by four ticks or more, skip them all 3495 # if we are delayed by four ticks or more, skip them all
2188 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3496 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2189 3497
2190 $TICK_WATCHER->at ($NEXT_TICK); 3498 $TICK_WATCHER->at ($NEXT_TICK);
2191 $TICK_WATCHER->start; 3499 $TICK_WATCHER->start;
3500
3501 $LOAD = ($NOW - $tick_start) / $TICK;
3502 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3503
3504 _post_tick;
3505
3506 # gather some statistics#d#
3507 $stats .= sprintf " %d\n", 10000 * ($NOW - $tick_start);#d#
3508 IO::AIO::aio_write $stat_fh, undef, undef, $stats, 0;#d#
2192 }, 3509 },
2193); 3510);
2194 3511
3512{
3513 BDB::min_parallel 8;
2195IO::AIO::max_poll_time $TICK * 0.2; 3514 BDB::max_poll_time $TICK * 0.1;
2196 3515 $BDB_POLL_WATCHER = Event->io (
2197Event->io ( 3516 reentrant => 0,
2198 fd => IO::AIO::poll_fileno, 3517 fd => BDB::poll_fileno,
2199 poll => 'r', 3518 poll => 'r',
2200 prio => 5, 3519 prio => 0,
2201 data => WF_AUTOCANCEL,
2202 cb => \&IO::AIO::poll_cb,
2203);
2204
2205Event->timer (
2206 data => WF_AUTOCANCEL, 3520 data => WF_AUTOCANCEL,
3521 cb => \&BDB::poll_cb,
3522 );
3523
3524 BDB::set_sync_prepare {
3525 my $status;
3526 my $current = $Coro::current;
3527 (
3528 sub {
3529 $status = $!;
3530 $current->ready; undef $current;
3531 },
3532 sub {
3533 Coro::schedule while defined $current;
3534 $! = $status;
3535 },
3536 )
3537 };
3538
3539 unless ($DB_ENV) {
3540 $DB_ENV = BDB::db_env_create;
3541
3542 cf::sync_job {
3543 eval {
3544 BDB::db_env_open
3545 $DB_ENV,
3546 $BDBDIR,
3547 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3548 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3549 0666;
3550
3551 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3552
3553 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3554 | BDB::LOG_AUTOREMOVE, 1);
3555 $DB_ENV->set_lk_detect;
3556 };
3557
3558 cf::cleanup "db_env_open(db): $@" if $@;
3559 };
3560 }
3561
3562 $BDB_CHECKPOINT_WATCHER = Event->timer (
2207 after => 0, 3563 after => 11,
2208 interval => 10, 3564 interval => 60,
3565 hard => 1,
3566 prio => 0,
3567 data => WF_AUTOCANCEL,
2209 cb => sub { 3568 cb => sub {
2210 (Coro::unblock_sub { 3569 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2211 write_runtime 3570 },
2212 or warn "ERROR: unable to write runtime file: $!"; 3571 );
3572 $BDB_TRICKLE_WATCHER = Event->timer (
3573 after => 5,
3574 interval => 10,
3575 hard => 1,
3576 prio => 0,
3577 data => WF_AUTOCANCEL,
3578 cb => sub {
3579 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3580 },
3581 );
3582}
3583
3584{
3585 IO::AIO::min_parallel 8;
3586
3587 undef $Coro::AIO::WATCHER;
3588 IO::AIO::max_poll_time $TICK * 0.1;
3589 $AIO_POLL_WATCHER = Event->io (
3590 reentrant => 0,
3591 data => WF_AUTOCANCEL,
3592 fd => IO::AIO::poll_fileno,
3593 poll => 'r',
3594 prio => 6,
3595 cb => \&IO::AIO::poll_cb,
3596 );
3597}
3598
3599my $_log_backtrace;
3600
3601sub _log_backtrace {
3602 my ($msg, @addr) = @_;
3603
3604 $msg =~ s/\n//;
3605
3606 # limit the # of concurrent backtraces
3607 if ($_log_backtrace < 2) {
3608 ++$_log_backtrace;
3609 async {
3610 my @bt = fork_call {
3611 @addr = map { sprintf "%x", $_ } @addr;
3612 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3613 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3614 or die "addr2line: $!";
3615
3616 my @funcs;
3617 my @res = <$fh>;
3618 chomp for @res;
3619 while (@res) {
3620 my ($func, $line) = splice @res, 0, 2, ();
3621 push @funcs, "[$func] $line";
3622 }
3623
3624 @funcs
3625 };
3626
3627 LOG llevInfo, "[ABT] $msg\n";
3628 LOG llevInfo, "[ABT] $_\n" for @bt;
3629 --$_log_backtrace;
2213 })->(); 3630 };
3631 } else {
3632 LOG llevInfo, "[ABT] $msg\n";
3633 LOG llevInfo, "[ABT] [suppressed]\n";
2214 }, 3634 }
2215); 3635}
3636
3637# load additional modules
3638use cf::pod;
2216 3639
2217END { cf::emergency_save } 3640END { cf::emergency_save }
2218 3641
22191 36421
2220 3643

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines