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.123 by root, Tue Jan 2 19:18:33 2007 UTC vs.
Revision 1.225 by root, Wed Mar 14 00:04:58 2007 UTC

4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Storable; 8use Storable;
9use Event;
9use Opcode; 10use Opcode;
10use Safe; 11use Safe;
11use Safe::Hole; 12use Safe::Hole;
12 13
13use Coro 3.3; 14use Coro 3.52 ();
15use Coro::State;
14use Coro::Event; 16use Coro::Event;
15use Coro::Timer; 17use Coro::Timer;
16use Coro::Signal; 18use Coro::Signal;
17use Coro::Semaphore; 19use Coro::Semaphore;
18use Coro::AIO; 20use Coro::AIO;
19 21
22use BDB ();
23use Data::Dumper;
20use Digest::MD5; 24use Digest::MD5;
21use Fcntl; 25use Fcntl;
22use IO::AIO 2.31 (); 26use IO::AIO 2.32 ();
23use YAML::Syck (); 27use YAML::Syck ();
24use Time::HiRes; 28use Time::HiRes;
29use Compress::LZF;
25 30
31Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
32Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 33$Event::Eval = 1; # no idea why this is required, but it is
34
35sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
27 36
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 37# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 38$YAML::Syck::ImplicitUnicode = 1;
30 39
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 40$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 41
35our %COMMAND = (); 42our %COMMAND = ();
36our %COMMAND_TIME = (); 43our %COMMAND_TIME = ();
44
45our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 46our %EXTCMD = ();
47our %EXT_CORO = (); # coroutines bound to extensions
48our %EXT_MAP = (); # pluggable maps
38 49
50our $RELOAD; # number of reloads so far
39our @EVENT; 51our @EVENT;
40our $LIBDIR = datadir . "/ext"; 52our $LIBDIR = datadir . "/ext";
41 53
42our $TICK = MAX_TIME * 1e-6; 54our $TICK = MAX_TIME * 1e-6;
43our $TICK_WATCHER; 55our $TICK_WATCHER;
56our $AIO_POLL_WATCHER;
57our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 58our $NEXT_TICK;
45our $NOW; 59our $NOW;
60our $USE_FSYNC = 1; # use fsync to write maps - default off
61
62our $BDB_POLL_WATCHER;
63our $DB_ENV;
46 64
47our %CFG; 65our %CFG;
48 66
49our $UPTIME; $UPTIME ||= time; 67our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 68our $RUNTIME;
51 69
70our %PLAYER; # all users
52our %MAP; # all maps 71our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 72our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random"; 73our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO; 74our $BDB_ENV_DIR = cf::localdir . "/db";
75
76our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
77our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
78
79# used to convert map paths into valid unix filenames by replacing / by ∕
80our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57 81
58binmode STDOUT; 82binmode STDOUT;
59binmode STDERR; 83binmode STDERR;
60 84
61# read virtual server time, if available 85# read virtual server time, if available
68mkdir cf::localdir; 92mkdir cf::localdir;
69mkdir cf::localdir . "/" . cf::playerdir; 93mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir; 94mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir; 95mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS; 96mkdir $RANDOM_MAPS;
97mkdir $BDB_ENV_DIR;
73 98
74# a special map that is always available 99our $EMERGENCY_POSITION;
75our $LINK_MAP;
76 100
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 101sub cf::map::normalise;
78 102
79############################################################################# 103#############################################################################
80 104
81=head2 GLOBAL VARIABLES 105=head2 GLOBAL VARIABLES
82 106
106 130
107=item %cf::CFG 131=item %cf::CFG
108 132
109Configuration for the server, loaded from C</etc/crossfire/config>, or 133Configuration for the server, loaded from C</etc/crossfire/config>, or
110from wherever your confdir points to. 134from wherever your confdir points to.
135
136=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
137
138These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
139or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
140processing has been done. Call C<< ->wait >> on them to maximise the
141window of cpu time available, or simply to synchronise to the server tick.
111 142
112=back 143=back
113 144
114=cut 145=cut
115 146
119 utf8::encode $msg; 150 utf8::encode $msg;
120 151
121 $msg .= "\n" 152 $msg .= "\n"
122 unless $msg =~ /\n$/; 153 unless $msg =~ /\n$/;
123 154
124 LOG llevError, "cfperl: $msg"; 155 LOG llevError, $msg;
125 }; 156 };
126} 157}
127 158
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 159@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 160@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
147 178
148$Event::DIED = sub { 179$Event::DIED = sub {
149 warn "error in event callback: @_"; 180 warn "error in event callback: @_";
150}; 181};
151 182
152my %ext_pkg;
153my @exts;
154my @hook;
155
156=head2 UTILITY FUNCTIONS 183=head2 UTILITY FUNCTIONS
157 184
158=over 4 185=over 4
159 186
187=item dumpval $ref
188
160=cut 189=cut
190
191sub dumpval {
192 eval {
193 local $SIG{__DIE__};
194 my $d;
195 if (1) {
196 $d = new Data::Dumper([$_[0]], ["*var"]);
197 $d->Terse(1);
198 $d->Indent(2);
199 $d->Quotekeys(0);
200 $d->Useqq(1);
201 #$d->Bless(...);
202 $d->Seen($_[1]) if @_ > 1;
203 $d = $d->Dump();
204 }
205 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
206 $d
207 } || "[unable to dump $_[0]: '$@']";
208}
161 209
162use JSON::Syck (); # TODO# replace by JSON::PC once working 210use JSON::Syck (); # TODO# replace by JSON::PC once working
163 211
164=item $ref = cf::from_json $json 212=item $ref = cf::from_json $json
165 213
181sub to_json($) { 229sub to_json($) {
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 230 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183 JSON::Syck::Dump $_[0] 231 JSON::Syck::Dump $_[0]
184} 232}
185 233
186=item my $guard = cf::guard { BLOCK }
187
188Run the given callback when the guard object gets destroyed (useful for
189coroutine cancellations).
190
191You can call C<< ->cancel >> on the guard object to stop the block from
192being executed.
193
194=cut
195
196sub guard(&) {
197 bless \(my $cb = $_[0]), cf::guard::;
198}
199
200sub cf::guard::cancel {
201 ${$_[0]} = sub { };
202}
203
204sub cf::guard::DESTROY {
205 ${$_[0]}->();
206}
207
208=item cf::lock_wait $string 234=item cf::lock_wait $string
209 235
210Wait until the given lock is available. See cf::lock_acquire. 236Wait until the given lock is available. See cf::lock_acquire.
211 237
212=item my $lock = cf::lock_acquire $string 238=item my $lock = cf::lock_acquire $string
213 239
214Wait until the given lock is available and then acquires it and returns 240Wait until the given lock is available and then acquires it and returns
215a guard object. If the guard object gets destroyed (goes out of scope, 241a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216for example when the coroutine gets canceled), the lock is automatically 242for example when the coroutine gets canceled), the lock is automatically
217returned. 243returned.
218 244
219Lock names should begin with a unique identifier (for example, find_map 245Lock names should begin with a unique identifier (for example, cf::map::find
220uses map_find and load_map uses map_load). 246uses map_find and cf::map::load uses map_load).
221 247
222=cut 248=cut
223 249
224our %LOCK; 250our %LOCK;
225 251
239 # wait, to be sure we are not locked 265 # wait, to be sure we are not locked
240 lock_wait $key; 266 lock_wait $key;
241 267
242 $LOCK{$key} = []; 268 $LOCK{$key} = [];
243 269
244 cf::guard { 270 Coro::guard {
245 # wake up all waiters, to be on the safe side 271 # wake up all waiters, to be on the safe side
246 $_->ready for @{ delete $LOCK{$key} }; 272 $_->ready for @{ delete $LOCK{$key} };
247 } 273 }
248} 274}
275
276sub freeze_mainloop {
277 return unless $TICK_WATCHER->is_active;
278
279 my $guard = Coro::guard {
280 $TICK_WATCHER->start;
281 };
282 $TICK_WATCHER->stop;
283 $guard
284}
285
286=item cf::async { BLOCK }
287
288Currently the same as Coro::async_pool, meaning you cannot use
289C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
290thing you are allowed to do is call C<prio> on it.
291
292=cut
293
294BEGIN { *async = \&Coro::async_pool }
249 295
250=item cf::sync_job { BLOCK } 296=item cf::sync_job { BLOCK }
251 297
252The design of crossfire+ requires that the main coro ($Coro::main) is 298The design of crossfire+ requires that the main coro ($Coro::main) is
253always able to handle events or runnable, as crossfire+ is only partly 299always able to handle events or runnable, as crossfire+ is only partly
267 # this is the main coro, too bad, we have to block 313 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 314 # till the operation succeeds, freezing the server :/
269 315
270 # TODO: use suspend/resume instead 316 # TODO: use suspend/resume instead
271 # (but this is cancel-safe) 317 # (but this is cancel-safe)
272 local $FREEZE = 1; 318 my $freeze_guard = freeze_mainloop;
273 319
274 my $busy = 1; 320 my $busy = 1;
275 my @res; 321 my @res;
276 322
277 (Coro::async { 323 (async {
278 @res = eval { $job->() }; 324 @res = eval { $job->() };
279 warn $@ if $@; 325 warn $@ if $@;
280 undef $busy; 326 undef $busy;
281 })->prio (Coro::PRIO_MAX); 327 })->prio (Coro::PRIO_MAX);
282 328
283 while ($busy) { 329 while ($busy) {
284 Coro::cede_notself; 330 Coro::cede or Event::one_event;
285 Event::one_event unless Coro::nready;
286 } 331 }
287 332
288 wantarray ? @res : $res[0] 333 wantarray ? @res : $res[0]
289 } else { 334 } else {
290 # we are in another coroutine, how wonderful, everything just works 335 # we are in another coroutine, how wonderful, everything just works
291 336
292 $job->() 337 $job->()
293 } 338 }
294} 339}
295 340
296=item $coro = cf::coro { BLOCK } 341=item $coro = cf::async_ext { BLOCK }
297 342
298Creates and returns a new coro. This coro is automcatially being canceled 343Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 344extension calling this is being unloaded.
300 345
301=cut 346=cut
302 347
303sub coro(&) { 348sub async_ext(&) {
304 my $cb = shift; 349 my $cb = shift;
305 350
306 my $coro; $coro = async { 351 my $coro = &Coro::async ($cb);
307 eval {
308 $cb->();
309 };
310 warn $@ if $@;
311 };
312 352
313 $coro->on_destroy (sub { 353 $coro->on_destroy (sub {
314 delete $EXT_CORO{$coro+0}; 354 delete $EXT_CORO{$coro+0};
315 }); 355 });
316 $EXT_CORO{$coro+0} = $coro; 356 $EXT_CORO{$coro+0} = $coro;
317 357
318 $coro 358 $coro
319} 359}
320 360
321sub write_runtime { 361sub write_runtime {
362 my $guard = cf::lock_acquire "write_runtime";
363
322 my $runtime = cf::localdir . "/runtime"; 364 my $runtime = cf::localdir . "/runtime";
323 365
324 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 366 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
325 or return; 367 or return;
326 368
369 my $value = $cf::RUNTIME + 90 + 10;
327 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 370 # 10 is the runtime save interval, for a monotonic clock
371 # 60 allows for the watchdog to kill the server.
372
328 (aio_write $fh, 0, (length $value), $value, 0) <= 0 373 (aio_write $fh, 0, (length $value), $value, 0) <= 0
329 and return; 374 and return;
330 375
376 # always fsync - this file is important
331 aio_fsync $fh 377 aio_fsync $fh
332 and return; 378 and return;
333 379
334 close $fh 380 close $fh
335 or return; 381 or return;
341} 387}
342 388
343=back 389=back
344 390
345=cut 391=cut
346
347#############################################################################
348
349package cf::path;
350
351sub new {
352 my ($class, $path, $base) = @_;
353
354 $path = $path->as_string if ref $path;
355
356 my $self = bless { }, $class;
357
358 # {... are special paths that are not touched
359 # ?xxx/... are special absolute paths
360 # ?random/... random maps
361 # /! non-realised random map exit
362 # /... normal maps
363 # ~/... per-player maps without a specific player (DO NOT USE)
364 # ~user/... per-player map of a specific user
365
366 if ($path =~ /^{/) {
367 # fine as it is
368 } elsif ($path =~ s{^\?random/}{}) {
369 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370 $self->{random} = cf::from_json $data;
371 } else {
372 if ($path =~ s{^~([^/]+)?}{}) {
373 $self->{user_rel} = 1;
374
375 if (defined $1) {
376 $self->{user} = $1;
377 } elsif ($base =~ m{^~([^/]+)/}) {
378 $self->{user} = $1;
379 } else {
380 warn "cannot resolve user-relative path without user <$path,$base>\n";
381 }
382 } elsif ($path =~ /^\//) {
383 # already absolute
384 } else {
385 $base =~ s{[^/]+/?$}{};
386 return $class->new ("$base/$path");
387 }
388
389 for ($path) {
390 redo if s{/\.?/}{/};
391 redo if s{/[^/]+/\.\./}{/};
392 }
393 }
394
395 $self->{path} = $path;
396
397 $self
398}
399
400# the name / primary key / in-game path
401sub as_string {
402 my ($self) = @_;
403
404 $self->{user_rel} ? "~$self->{user}$self->{path}"
405 : $self->{random} ? "?random/$self->{path}"
406 : $self->{path}
407}
408
409# the displayed name, this is a one way mapping
410sub visible_name {
411 my ($self) = @_;
412
413# if (my $rmp = $self->{random}) {
414# # todo: be more intelligent about this
415# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416# } else {
417 $self->as_string
418# }
419}
420
421# escape the /'s in the path
422sub _escaped_path {
423 # ∕ is U+2215
424 (my $path = $_[0]{path}) =~ s/\//∕/g;
425 $path
426}
427
428# the original (read-only) location
429sub load_path {
430 my ($self) = @_;
431
432 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433}
434
435# the temporary/swap location
436sub save_path {
437 my ($self) = @_;
438
439 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442}
443
444# the unique path, might be eq to save_path
445sub uniq_path {
446 my ($self) = @_;
447
448 $self->{user_rel} || $self->{random}
449 ? undef
450 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451}
452
453# return random map parameters, or undef
454sub random_map_params {
455 my ($self) = @_;
456
457 $self->{random}
458}
459
460# this is somewhat ugly, but style maps do need special treatment
461sub is_style_map {
462 $_[0]{path} =~ m{^/styles/}
463}
464
465package cf;
466 392
467############################################################################# 393#############################################################################
468 394
469=head2 ATTACHABLE OBJECTS 395=head2 ATTACHABLE OBJECTS
470 396
596our @CB_TYPE = (); # registry for type (cf-object class) based events 522our @CB_TYPE = (); # registry for type (cf-object class) based events
597our @CB_MAP = (); 523our @CB_MAP = ();
598 524
599my %attachment; 525my %attachment;
600 526
527sub cf::attachable::thawer_merge {
528 # simply override everything except _meta
529 local $_[0]{_meta};
530 %{$_[0]} = %{$_[1]};
531}
532
601sub _attach_cb($$$$) { 533sub _attach_cb($$$$) {
602 my ($registry, $event, $prio, $cb) = @_; 534 my ($registry, $event, $prio, $cb) = @_;
603 535
604 use sort 'stable'; 536 use sort 'stable';
605 537
776# object support 708# object support
777 709
778sub reattach { 710sub reattach {
779 # basically do the same as instantiate, without calling instantiate 711 # basically do the same as instantiate, without calling instantiate
780 my ($obj) = @_; 712 my ($obj) = @_;
713
714 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
781 715
782 my $registry = $obj->registry; 716 my $registry = $obj->registry;
783 717
784 @$registry = (); 718 @$registry = ();
785 719
832 $filename, length $$rdata, scalar @$objs; 766 $filename, length $$rdata, scalar @$objs;
833 767
834 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 768 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835 chmod SAVE_MODE, $fh; 769 chmod SAVE_MODE, $fh;
836 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 770 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
837 aio_fsync $fh; 771 aio_fsync $fh if $cf::USE_FSYNC;
838 close $fh; 772 close $fh;
839 773
840 if (@$objs) { 774 if (@$objs) {
841 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 775 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
842 chmod SAVE_MODE, $fh; 776 chmod SAVE_MODE, $fh;
843 my $data = Storable::nfreeze { version => 1, objs => $objs }; 777 my $data = Storable::nfreeze { version => 1, objs => $objs };
844 aio_write $fh, 0, (length $data), $data, 0; 778 aio_write $fh, 0, (length $data), $data, 0;
845 aio_fsync $fh; 779 aio_fsync $fh if $cf::USE_FSYNC;
846 close $fh; 780 close $fh;
847 aio_rename "$filename.pst~", "$filename.pst"; 781 aio_rename "$filename.pst~", "$filename.pst";
848 } 782 }
849 } else { 783 } else {
850 aio_unlink "$filename.pst"; 784 aio_unlink "$filename.pst";
917=cut 851=cut
918 852
919sub register_extcmd { 853sub register_extcmd {
920 my ($name, $cb) = @_; 854 my ($name, $cb) = @_;
921 855
922 my $caller = caller;
923 #warn "registering extcmd '$name' to '$caller'";
924
925 $EXTCMD{$name} = [$cb, $caller]; 856 $EXTCMD{$name} = $cb;
926} 857}
927 858
928cf::player->attach ( 859cf::player->attach (
929 on_command => sub { 860 on_command => sub {
930 my ($pl, $name, $params) = @_; 861 my ($pl, $name, $params) = @_;
943 874
944 my $msg = eval { from_json $buf }; 875 my $msg = eval { from_json $buf };
945 876
946 if (ref $msg) { 877 if (ref $msg) {
947 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 878 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
948 if (my %reply = $cb->[0]->($pl, $msg)) { 879 if (my %reply = $cb->($pl, $msg)) {
949 $pl->ext_reply ($msg->{msgid}, %reply); 880 $pl->ext_reply ($msg->{msgid}, %reply);
950 } 881 }
951 } 882 }
952 } else { 883 } else {
953 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 884 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
955 886
956 cf::override; 887 cf::override;
957 }, 888 },
958); 889);
959 890
960sub register {
961 my ($base, $pkg) = @_;
962
963 #TODO
964}
965
966sub load_extension { 891sub load_extension {
967 my ($path) = @_; 892 my ($path) = @_;
968 893
969 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 894 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
970 my $base = $1; 895 my $base = $1;
971 my $pkg = $1; 896 my $pkg = $1;
972 $pkg =~ s/[^[:word:]]/_/g; 897 $pkg =~ s/[^[:word:]]/_/g;
973 $pkg = "ext::$pkg"; 898 $pkg = "ext::$pkg";
974 899
975 warn "loading '$path' into '$pkg'\n"; 900 warn "... loading '$path' into '$pkg'\n";
976 901
977 open my $fh, "<:utf8", $path 902 open my $fh, "<:utf8", $path
978 or die "$path: $!"; 903 or die "$path: $!";
979 904
980 my $source = 905 my $source =
981 "package $pkg; use strict; use utf8;\n" 906 "package $pkg; use strict; use utf8;\n"
982 . "#line 1 \"$path\"\n{\n" 907 . "#line 1 \"$path\"\n{\n"
983 . (do { local $/; <$fh> }) 908 . (do { local $/; <$fh> })
984 . "\n};\n1"; 909 . "\n};\n1";
985 910
986 eval $source 911 unless (eval $source) {
987 or die $@ ? "$path: $@\n" 912 my $msg = $@ ? "$path: $@\n"
988 : "extension disabled.\n"; 913 : "extension disabled.\n";
989 914 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
990 push @exts, $pkg; 915 warn $@;
991 $ext_pkg{$base} = $pkg; 916 warn "mandatory extension failed to load, exiting.\n";
992 917 exit 1;
993# no strict 'refs'; 918 }
994# @{"$pkg\::ISA"} = ext::; 919 die $@;
995
996 register $base, $pkg;
997}
998
999sub unload_extension {
1000 my ($pkg) = @_;
1001
1002 warn "removing extension $pkg\n";
1003
1004 # remove hooks
1005 #TODO
1006# for my $idx (0 .. $#PLUGIN_EVENT) {
1007# delete $hook[$idx]{$pkg};
1008# } 920 }
1009 921
1010 # remove commands 922 push @EXTS, $pkg;
1011 for my $name (keys %COMMAND) {
1012 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014 if (@cb) {
1015 $COMMAND{$name} = \@cb;
1016 } else {
1017 delete $COMMAND{$name};
1018 }
1019 }
1020
1021 # remove extcmds
1022 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1023 delete $EXTCMD{$name};
1024 }
1025
1026 if (my $cb = $pkg->can ("unload")) {
1027 eval {
1028 $cb->($pkg);
1029 1
1030 } or warn "$pkg unloaded, but with errors: $@";
1031 }
1032
1033 Symbol::delete_package $pkg;
1034} 923}
1035 924
1036sub load_extensions { 925sub load_extensions {
1037 for my $ext (<$LIBDIR/*.ext>) { 926 for my $ext (<$LIBDIR/*.ext>) {
1038 next unless -r $ext; 927 next unless -r $ext;
1042 } or warn "$ext not loaded: $@"; 931 } or warn "$ext not loaded: $@";
1043 } 932 }
1044} 933}
1045 934
1046############################################################################# 935#############################################################################
1047# load/save/clean perl data associated with a map
1048
1049*cf::mapsupport::on_clean = sub {
1050 my ($map) = @_;
1051
1052 my $path = $map->tmpname;
1053 defined $path or return;
1054
1055 unlink "$path.pst";
1056};
1057
1058cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060#############################################################################
1061# load/save perl data associated with player->ob objects
1062
1063sub all_objects(@) {
1064 @_, map all_objects ($_->inv), @_
1065}
1066
1067# TODO: compatibility cruft, remove when no longer needed
1068cf::player->attach (
1069 on_load => sub {
1070 my ($pl, $path) = @_;
1071
1072 for my $o (all_objects $pl->ob) {
1073 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1074 $o->set_ob_key_value ("_perl_data");
1075
1076 %$o = %{ Storable::thaw pack "H*", $value };
1077 }
1078 }
1079 },
1080);
1081
1082#############################################################################
1083 936
1084=head2 CORE EXTENSIONS 937=head2 CORE EXTENSIONS
1085 938
1086Functions and methods that extend core crossfire objects. 939Functions and methods that extend core crossfire objects.
1087 940
941=cut
942
943package cf::player;
944
945use Coro::AIO;
946
1088=head3 cf::player 947=head3 cf::player
1089 948
1090=over 4 949=over 4
1091 950
1092=item cf::player::exists $login 951=item cf::player::find $login
1093 952
1094Returns true when the given account exists. 953Returns the given player object, loading it if necessary (might block).
1095 954
1096=cut 955=cut
1097 956
1098sub cf::player::exists($) { 957sub playerdir($) {
1099 cf::player::find $_[0] 958 cf::localdir
1100 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963}
964
965sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
967
968 (playerdir $login) . "/$login.pl"
969}
970
971sub find_active($) {
972 $cf::PLAYER{$_[0]}
973 and $cf::PLAYER{$_[0]}->active
974 and $cf::PLAYER{$_[0]}
975}
976
977sub exists($) {
978 my ($login) = @_;
979
980 $cf::PLAYER{$login}
981 or cf::sync_job { !aio_stat path $login }
982}
983
984sub find($) {
985 return $cf::PLAYER{$_[0]} || do {
986 my $login = $_[0];
987
988 my $guard = cf::lock_acquire "user_find:$login";
989
990 $cf::PLAYER{$_[0]} || do {
991 my $pl = load_pl path $login
992 or return;
993 $cf::PLAYER{$login} = $pl
994 }
995 }
996}
997
998sub save($) {
999 my ($pl) = @_;
1000
1001 return if $pl->{deny_save};
1002
1003 my $path = path $pl;
1004 my $guard = cf::lock_acquire "user_save:$path";
1005
1006 return if $pl->{deny_save};
1007
1008 aio_mkdir playerdir $pl, 0770;
1009 $pl->{last_save} = $cf::RUNTIME;
1010
1011 $pl->save_pl ($path);
1012 Coro::cede;
1013}
1014
1015sub new($) {
1016 my ($login) = @_;
1017
1018 my $self = create;
1019
1020 $self->ob->name ($login);
1021 $self->{deny_save} = 1;
1022
1023 $cf::PLAYER{$login} = $self;
1024
1025 $self
1026}
1027
1028=item $pl->quit_character
1029
1030Nukes the player without looking back. If logged in, the connection will
1031be destroyed. May block for a long time.
1032
1033=cut
1034
1035sub quit_character {
1036 my ($pl) = @_;
1037
1038 my $name = $pl->ob->name;
1039
1040 $pl->{deny_save} = 1;
1041 $pl->password ("*"); # this should lock out the player until we nuked the dir
1042
1043 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1044 $pl->deactivate;
1045 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1046 $pl->ns->destroy if $pl->ns;
1047
1048 my $path = playerdir $pl;
1049 my $temp = "$path~$cf::RUNTIME~deleting~";
1050 aio_rename $path, $temp;
1051 delete $cf::PLAYER{$pl->ob->name};
1052 $pl->destroy;
1053
1054 my $prefix = qr<^~\Q$name\E/>;
1055
1056 # nuke player maps
1057 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1058
1059 IO::AIO::aio_rmtree $temp;
1060}
1061
1062=item $pl->kick
1063
1064Kicks a player out of the game. This destroys the connection.
1065
1066=cut
1067
1068sub kick {
1069 my ($pl, $kicker) = @_;
1070
1071 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1072 $pl->killer ("kicked");
1073 $pl->ns->destroy;
1074}
1075
1076=item cf::player::list_logins
1077
1078Returns am arrayref of all valid playernames in the system, can take a
1079while and may block, so not sync_job-capable, ever.
1080
1081=cut
1082
1083sub list_logins {
1084 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1085 or return [];
1086
1087 my @logins;
1088
1089 for my $login (@$dirs) {
1090 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1091 aio_read $fh, 0, 512, my $buf, 0 or next;
1092 $buf !~ /^password -------------$/m or next; # official not-valid tag
1093
1094 utf8::decode $login;
1095 push @logins, $login;
1096 }
1097
1098 \@logins
1099}
1100
1101=item $player->maps
1102
1103Returns an arrayref of map paths that are private for this
1104player. May block.
1105
1106=cut
1107
1108sub maps($) {
1109 my ($pl) = @_;
1110
1111 $pl = ref $pl ? $pl->ob->name : $pl;
1112
1113 my $files = aio_readdir playerdir $pl
1114 or return;
1115
1116 my @paths;
1117
1118 for (@$files) {
1119 utf8::decode $_;
1120 next if /\.(?:pl|pst)$/;
1121 next unless /^$PATH_SEP/o;
1122
1123 push @paths, cf::map::normalise "~$pl/$_";
1124 }
1125
1126 \@paths
1101} 1127}
1102 1128
1103=item $player->ext_reply ($msgid, $msgtype, %msg) 1129=item $player->ext_reply ($msgid, $msgtype, %msg)
1104 1130
1105Sends an ext reply to the player. 1131Sends an ext reply to the player.
1106 1132
1107=cut 1133=cut
1108 1134
1109sub cf::player::ext_reply($$$%) { 1135sub ext_reply($$$%) {
1110 my ($self, $id, %msg) = @_; 1136 my ($self, $id, %msg) = @_;
1111 1137
1112 $msg{msgid} = $id; 1138 $msg{msgid} = $id;
1113 1139
1114 $self->send ("ext " . to_json \%msg); 1140 $self->send ("ext " . cf::to_json \%msg);
1115} 1141}
1142
1143package cf;
1116 1144
1117=back 1145=back
1118 1146
1119 1147
1120=head3 cf::map 1148=head3 cf::map
1126package cf::map; 1154package cf::map;
1127 1155
1128use Fcntl; 1156use Fcntl;
1129use Coro::AIO; 1157use Coro::AIO;
1130 1158
1159use overload
1160 '""' => \&as_string,
1161 fallback => 1;
1162
1131our $MAX_RESET = 7200; 1163our $MAX_RESET = 3600;
1132our $DEFAULT_RESET = 3600; 1164our $DEFAULT_RESET = 3000;
1133 1165
1134sub generate_random_map { 1166sub generate_random_map {
1135 my ($path, $rmp) = @_; 1167 my ($self, $rmp) = @_;
1136
1137 # mit "rum" bekleckern, nicht 1168 # mit "rum" bekleckern, nicht
1138 cf::map::_create_random_map 1169 $self->_create_random_map (
1139 $path,
1140 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1170 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1171 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1172 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143 $rmp->{exit_on_final_map}, 1173 $rmp->{exit_on_final_map},
1144 $rmp->{xsize}, $rmp->{ysize}, 1174 $rmp->{xsize}, $rmp->{ysize},
1145 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1175 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1176 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1177 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1178 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1149 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1179 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150 (cf::region::find $rmp->{region}) 1180 (cf::region::find $rmp->{region}), $rmp->{custom}
1181 )
1182}
1183
1184=item cf::map->register ($regex, $prio)
1185
1186Register a handler for the map path matching the given regex at the
1187givne priority (higher is better, built-in handlers have priority 0, the
1188default).
1189
1190=cut
1191
1192sub register {
1193 my (undef, $regex, $prio) = @_;
1194 my $pkg = caller;
1195
1196 no strict;
1197 push @{"$pkg\::ISA"}, __PACKAGE__;
1198
1199 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1200}
1201
1202# also paths starting with '/'
1203$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1204
1205sub thawer_merge {
1206 my ($self, $merge) = @_;
1207
1208 # we have to keep some variables in memory intact
1209 local $self->{path};
1210 local $self->{load_path};
1211 local $self->{deny_save};
1212 local $self->{deny_reset};
1213
1214 $self->SUPER::thawer_merge ($merge);
1215}
1216
1217sub normalise {
1218 my ($path, $base) = @_;
1219
1220 $path = "$path"; # make sure its a string
1221
1222 $path =~ s/\.map$//;
1223
1224 # map plan:
1225 #
1226 # /! non-realised random map exit (special hack!)
1227 # {... are special paths that are not being touched
1228 # ?xxx/... are special absolute paths
1229 # ?random/... random maps
1230 # /... normal maps
1231 # ~user/... per-player map of a specific user
1232
1233 $path =~ s/$PATH_SEP/\//go;
1234
1235 # treat it as relative path if it starts with
1236 # something that looks reasonable
1237 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1238 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1239
1240 $base =~ s{[^/]+/?$}{};
1241 $path = "$base/$path";
1242 }
1243
1244 for ($path) {
1245 redo if s{//}{/};
1246 redo if s{/\.?/}{/};
1247 redo if s{/[^/]+/\.\./}{/};
1248 }
1249
1250 $path
1251}
1252
1253sub new_from_path {
1254 my (undef, $path, $base) = @_;
1255
1256 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1257
1258 $path = normalise $path, $base;
1259
1260 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1261 if ($path =~ $EXT_MAP{$pkg}[1]) {
1262 my $self = bless cf::map::new, $pkg;
1263 $self->{path} = $path; $self->path ($path);
1264 $self->init; # pass $1 etc.
1265 return $self;
1266 }
1267 }
1268
1269 Carp::carp "unable to resolve path '$path' (base '$base').";
1270 ()
1271}
1272
1273sub init {
1274 my ($self) = @_;
1275
1276 $self
1277}
1278
1279sub as_string {
1280 my ($self) = @_;
1281
1282 "$self->{path}"
1283}
1284
1285# the displayed name, this is a one way mapping
1286sub visible_name {
1287 &as_string
1288}
1289
1290# the original (read-only) location
1291sub load_path {
1292 my ($self) = @_;
1293
1294 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
1295}
1296
1297# the temporary/swap location
1298sub save_path {
1299 my ($self) = @_;
1300
1301 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1302 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
1303}
1304
1305# the unique path, undef == no special unique path
1306sub uniq_path {
1307 my ($self) = @_;
1308
1309 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1310 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1151} 1311}
1152 1312
1153# and all this just because we cannot iterate over 1313# and all this just because we cannot iterate over
1154# all maps in C++... 1314# all maps in C++...
1155sub change_all_map_light { 1315sub change_all_map_light {
1157 1317
1158 $_->change_map_light ($change) 1318 $_->change_map_light ($change)
1159 for grep $_->outdoor, values %cf::MAP; 1319 for grep $_->outdoor, values %cf::MAP;
1160} 1320}
1161 1321
1322sub unlink_save {
1323 my ($self) = @_;
1324
1325 utf8::encode (my $save = $self->save_path);
1326 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1327 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1328}
1329
1162sub try_load_header($) { 1330sub load_header_from($) {
1163 my ($path) = @_; 1331 my ($self, $path) = @_;
1164 1332
1165 utf8::encode $path; 1333 utf8::encode $path;
1166 aio_open $path, O_RDONLY, 0 1334 #aio_open $path, O_RDONLY, 0
1335 # or return;
1336
1337 $self->_load_header ($path)
1167 or return; 1338 or return;
1168 1339
1169 my $map = cf::map::new 1340 $self->{load_path} = $path;
1341
1342 1
1343}
1344
1345sub load_header_orig {
1346 my ($self) = @_;
1347
1348 $self->load_header_from ($self->load_path)
1349}
1350
1351sub load_header_temp {
1352 my ($self) = @_;
1353
1354 $self->load_header_from ($self->save_path)
1355}
1356
1357sub prepare_temp {
1358 my ($self) = @_;
1359
1360 $self->last_access ((delete $self->{last_access})
1361 || $cf::RUNTIME); #d#
1362 # safety
1363 $self->{instantiate_time} = $cf::RUNTIME
1364 if $self->{instantiate_time} > $cf::RUNTIME;
1365}
1366
1367sub prepare_orig {
1368 my ($self) = @_;
1369
1370 $self->{load_original} = 1;
1371 $self->{instantiate_time} = $cf::RUNTIME;
1372 $self->last_access ($cf::RUNTIME);
1373 $self->instantiate;
1374}
1375
1376sub load_header {
1377 my ($self) = @_;
1378
1379 if ($self->load_header_temp) {
1380 $self->prepare_temp;
1381 } else {
1382 $self->load_header_orig
1170 or return; 1383 or return;
1384 $self->prepare_orig;
1385 }
1171 1386
1172 $map->load_header ($path) 1387 1
1173 or return;
1174
1175 $map->{load_path} = $path;
1176
1177 $map
1178} 1388}
1179 1389
1390sub find;
1180sub find_map { 1391sub find {
1181 my ($path, $origin) = @_; 1392 my ($path, $origin) = @_;
1182 1393
1183 #warn "find_map<$path,$origin>\n";#d#
1184
1185 $path = new cf::path $path, $origin && $origin->path; 1394 $path = normalise $path, $origin && $origin->path;
1186 my $key = $path->as_string;
1187 1395
1188 cf::lock_wait "map_find:$key"; 1396 cf::lock_wait "map_find:$path";
1189 1397
1190 $cf::MAP{$key} || do { 1398 $cf::MAP{$path} || do {
1191 my $guard = cf::lock_acquire "map_find:$key"; 1399 my $guard = cf::lock_acquire "map_find:$path";
1192 1400 my $map = new_from_path cf::map $path
1193 # do it the slow way
1194 my $map = try_load_header $path->save_path;
1195
1196 if ($map) {
1197 # safety
1198 $map->{instantiate_time} = $cf::RUNTIME
1199 if $map->{instantiate_time} > $cf::RUNTIME;
1200 } else {
1201 if (my $rmp = $path->random_map_params) {
1202 $map = generate_random_map $key, $rmp;
1203 } else {
1204 $map = try_load_header $path->load_path;
1205 }
1206
1207 $map or return; 1401 or return;
1208 1402
1209 $map->{load_original} = 1;
1210 $map->{instantiate_time} = $cf::RUNTIME;
1211 $map->instantiate;
1212
1213 # per-player maps become, after loading, normal maps
1214 $map->per_player (0) if $path->{user_rel};
1215 }
1216
1217 $map->path ($key);
1218 $map->{path} = $path;
1219 $map->{last_save} = $cf::RUNTIME; 1403 $map->{last_save} = $cf::RUNTIME;
1220 $map->last_access ($cf::RUNTIME);
1221 1404
1222 if ($map->should_reset) { 1405 $map->load_header
1406 or return;
1407
1408 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1409 # doing this can freeze the server in a sync job, obviously
1410 #$cf::WAIT_FOR_TICK->wait;
1223 $map->reset; 1411 $map->reset;
1224 undef $guard; 1412 undef $guard;
1225 $map = find_map $path; 1413 return find $path;
1226 } 1414 }
1227 1415
1228 $cf::MAP{$key} = $map 1416 $cf::MAP{$path} = $map
1229 } 1417 }
1230} 1418}
1419
1420sub pre_load { }
1421sub post_load { }
1231 1422
1232sub load { 1423sub load {
1233 my ($self) = @_; 1424 my ($self) = @_;
1234 1425
1426 local $self->{deny_reset} = 1; # loading can take a long time
1427
1235 my $path = $self->{path}; 1428 my $path = $self->{path};
1236 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1429 my $guard = cf::lock_acquire "map_load:$path";
1237 1430
1238 return if $self->in_memory != cf::MAP_SWAPPED; 1431 return if $self->in_memory != cf::MAP_SWAPPED;
1239 1432
1240 $self->in_memory (cf::MAP_LOADING); 1433 $self->in_memory (cf::MAP_LOADING);
1241 1434
1242 $self->alloc; 1435 $self->alloc;
1436
1437 $self->pre_load;
1438
1243 $self->load_objects ($self->{load_path}, 1) 1439 $self->_load_objects ($self->{load_path}, 1)
1244 or return; 1440 or return;
1245 1441
1246 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1442 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1247 if delete $self->{load_original}; 1443 if delete $self->{load_original};
1248 1444
1249 if (my $uniq = $path->uniq_path) { 1445 if (my $uniq = $self->uniq_path) {
1250 utf8::encode $uniq; 1446 utf8::encode $uniq;
1251 if (aio_open $uniq, O_RDONLY, 0) { 1447 if (aio_open $uniq, O_RDONLY, 0) {
1252 $self->clear_unique_items; 1448 $self->clear_unique_items;
1253 $self->load_objects ($uniq, 0); 1449 $self->_load_objects ($uniq, 0);
1254 } 1450 }
1255 } 1451 }
1452
1453 Coro::cede;
1256 1454
1257 # now do the right thing for maps 1455 # now do the right thing for maps
1258 $self->link_multipart_objects; 1456 $self->link_multipart_objects;
1259 1457
1260 if ($self->{path}->is_style_map) { 1458 unless ($self->{deny_activate}) {
1261 $self->{deny_save} = 1; 1459 $self->decay_objects;
1262 $self->{deny_reset} = 1;
1263 } else {
1264 $self->fix_auto_apply; 1460 $self->fix_auto_apply;
1265 $self->decay_objects;
1266 $self->update_buttons; 1461 $self->update_buttons;
1462 Coro::cede;
1267 $self->set_darkness_map; 1463 $self->set_darkness_map;
1268 $self->difficulty ($self->estimate_difficulty) 1464 $self->difficulty ($self->estimate_difficulty)
1269 unless $self->difficulty; 1465 unless $self->difficulty;
1466 Coro::cede;
1270 $self->activate; 1467 $self->activate;
1271 } 1468 }
1272 1469
1470 $self->post_load;
1471
1273 $self->in_memory (cf::MAP_IN_MEMORY); 1472 $self->in_memory (cf::MAP_IN_MEMORY);
1274} 1473}
1275 1474
1276sub load_map_sync { 1475sub customise_for {
1476 my ($self, $ob) = @_;
1477
1478 return find "~" . $ob->name . "/" . $self->{path}
1479 if $self->per_player;
1480
1481 $self
1482}
1483
1484# find and load all maps in the 3x3 area around a map
1485sub load_diag {
1486 my ($map) = @_;
1487
1488 my @diag; # diagonal neighbours
1489
1490 for (0 .. 3) {
1491 my $neigh = $map->tile_path ($_)
1492 or next;
1493 $neigh = find $neigh, $map
1494 or next;
1495 $neigh->load;
1496
1497 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1498 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1499 }
1500
1501 for (@diag) {
1502 my $neigh = find @$_
1503 or next;
1504 $neigh->load;
1505 }
1506}
1507
1508sub find_sync {
1277 my ($path, $origin) = @_; 1509 my ($path, $origin) = @_;
1278 1510
1279 #warn "load_map_sync<$path, $origin>\n";#d# 1511 cf::sync_job { find $path, $origin }
1512}
1280 1513
1281 cf::sync_job { 1514sub do_load_sync {
1282 my $map = cf::map::find_map $path, $origin 1515 my ($map) = @_;
1283 or return; 1516
1517 cf::sync_job { $map->load };
1518}
1519
1520our %MAP_PREFETCH;
1521our $MAP_PREFETCHER = undef;
1522
1523sub find_async {
1524 my ($path, $origin) = @_;
1525
1526 $path = normalise $path, $origin && $origin->{path};
1527
1528 if (my $map = $cf::MAP{$path}) {
1529 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1530 }
1531
1532 undef $MAP_PREFETCH{$path};
1533 $MAP_PREFETCHER ||= cf::async {
1534 while (%MAP_PREFETCH) {
1535 for my $path (keys %MAP_PREFETCH) {
1536 my $map = find $path
1537 or next;
1284 $map->load; 1538 $map->load;
1285 $map 1539
1540 delete $MAP_PREFETCH{$path};
1541 }
1542 }
1543 undef $MAP_PREFETCHER;
1286 } 1544 };
1545 $MAP_PREFETCHER->prio (6);
1546
1547 ()
1287} 1548}
1288 1549
1289sub save { 1550sub save {
1290 my ($self) = @_; 1551 my ($self) = @_;
1291 1552
1553 my $lock = cf::lock_acquire "map_data:" . $self->path;
1554
1292 $self->{last_save} = $cf::RUNTIME; 1555 $self->{last_save} = $cf::RUNTIME;
1293 1556
1294 return unless $self->dirty; 1557 return unless $self->dirty;
1295 1558
1296 my $save = $self->{path}->save_path; utf8::encode $save; 1559 my $save = $self->save_path; utf8::encode $save;
1297 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1560 my $uniq = $self->uniq_path; utf8::encode $uniq;
1298 1561
1299 $self->{load_path} = $save; 1562 $self->{load_path} = $save;
1300 1563
1301 return if $self->{deny_save}; 1564 return if $self->{deny_save};
1302 1565
1566 local $self->{last_access} = $self->last_access;#d#
1567
1568 cf::async {
1569 $_->contr->save for $self->players;
1570 };
1571
1303 if ($uniq) { 1572 if ($uniq) {
1304 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1573 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1305 $self->save_objects ($uniq, cf::IO_UNIQUES); 1574 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1306 } else { 1575 } else {
1307 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1576 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1308 } 1577 }
1309} 1578}
1310 1579
1311sub swap_out { 1580sub swap_out {
1312 my ($self) = @_; 1581 my ($self) = @_;
1582
1583 # save first because save cedes
1584 $self->save;
1585
1586 my $lock = cf::lock_acquire "map_data:" . $self->path;
1313 1587
1314 return if $self->players; 1588 return if $self->players;
1315 return if $self->in_memory != cf::MAP_IN_MEMORY; 1589 return if $self->in_memory != cf::MAP_IN_MEMORY;
1316 return if $self->{deny_save}; 1590 return if $self->{deny_save};
1317 1591
1318 $self->save;
1319 $self->clear; 1592 $self->clear;
1320 $self->in_memory (cf::MAP_SWAPPED); 1593 $self->in_memory (cf::MAP_SWAPPED);
1321} 1594}
1322 1595
1323sub reset_at { 1596sub reset_at {
1324 my ($self) = @_; 1597 my ($self) = @_;
1325 1598
1326 # TODO: safety, remove and allow resettable per-player maps 1599 # TODO: safety, remove and allow resettable per-player maps
1327 return 1e99 if $self->{path}{user_rel}; 1600 return 1e99 if $self->isa ("ext::map_per_player");#d#
1328 return 1e99 if $self->{deny_reset}; 1601 return 1e99 if $self->{deny_reset};
1329 1602
1330 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1603 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1331 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1604 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1332 1605
1337 my ($self) = @_; 1610 my ($self) = @_;
1338 1611
1339 $self->reset_at <= $cf::RUNTIME 1612 $self->reset_at <= $cf::RUNTIME
1340} 1613}
1341 1614
1342sub unlink_save {
1343 my ($self) = @_;
1344
1345 utf8::encode (my $save = $self->{path}->save_path);
1346 aioreq_pri 3; IO::AIO::aio_unlink $save;
1347 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1348}
1349
1350sub rename {
1351 my ($self, $new_path) = @_;
1352
1353 $self->unlink_save;
1354
1355 delete $cf::MAP{$self->path};
1356 $self->{path} = new cf::path $new_path;
1357 $self->path ($self->{path}->as_string);
1358 $cf::MAP{$self->path} = $self;
1359
1360 $self->save;
1361}
1362
1363sub reset { 1615sub reset {
1364 my ($self) = @_; 1616 my ($self) = @_;
1365 1617
1618 my $lock = cf::lock_acquire "map_data:$self->{path}";
1619
1366 return if $self->players; 1620 return if $self->players;
1367 return if $self->{path}{user_rel};#d# 1621 return if $self->isa ("ext::map_per_player");#d#
1368 1622
1369 warn "resetting map ", $self->path;#d# 1623 warn "resetting map ", $self->path;#d#
1370 1624
1625 $self->in_memory (cf::MAP_SWAPPED);
1626
1627 # need to save uniques path
1628 unless ($self->{deny_save}) {
1629 my $uniq = $self->uniq_path; utf8::encode $uniq;
1630
1631 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1632 if $uniq;
1633 }
1634
1371 delete $cf::MAP{$self->path}; 1635 delete $cf::MAP{$self->path};
1636
1637 $self->clear;
1372 1638
1373 $_->clear_links_to ($self) for values %cf::MAP; 1639 $_->clear_links_to ($self) for values %cf::MAP;
1374 1640
1375 $self->unlink_save; 1641 $self->unlink_save;
1376 $self->destroy; 1642 $self->destroy;
1379my $nuke_counter = "aaaa"; 1645my $nuke_counter = "aaaa";
1380 1646
1381sub nuke { 1647sub nuke {
1382 my ($self) = @_; 1648 my ($self) = @_;
1383 1649
1650 delete $cf::MAP{$self->path};
1651
1652 $self->unlink_save;
1653
1654 bless $self, "cf::map";
1655 delete $self->{deny_reset};
1384 $self->{deny_save} = 1; 1656 $self->{deny_save} = 1;
1385 $self->reset_timeout (1); 1657 $self->reset_timeout (1);
1386 $self->rename ("{nuke}/" . ($nuke_counter++)); 1658 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1659
1660 $cf::MAP{$self->path} = $self;
1661
1387 $self->reset; # polite request, might not happen 1662 $self->reset; # polite request, might not happen
1388} 1663}
1389 1664
1390sub customise_for { 1665=item cf::map::unique_maps
1391 my ($map, $ob) = @_;
1392 1666
1393 if ($map->per_player) { 1667Returns an arrayref of paths of all shared maps that have
1394 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1668instantiated unique items. May block.
1395 }
1396 1669
1397 $map 1670=cut
1398}
1399 1671
1400sub emergency_save { 1672sub unique_maps() {
1401 local $cf::FREEZE = 1; 1673 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1674 or return;
1402 1675
1403 warn "enter emergency map save\n"; 1676 my @paths;
1404 1677
1405 cf::sync_job { 1678 for (@$files) {
1406 warn "begin emergency map save\n"; 1679 utf8::decode $_;
1407 $_->save for values %cf::MAP; 1680 next if /\.pst$/;
1681 next unless /^$PATH_SEP/o;
1682
1683 push @paths, cf::map::normalise $_;
1408 }; 1684 }
1409 1685
1410 warn "end emergency map save\n"; 1686 \@paths
1411} 1687}
1412 1688
1413package cf; 1689package cf;
1414 1690
1415=back 1691=back
1416 1692
1693=head3 cf::object
1694
1695=cut
1696
1697package cf::object;
1698
1699=over 4
1700
1701=item $ob->inv_recursive
1702
1703Returns the inventory of the object _and_ their inventories, recursively.
1704
1705=cut
1706
1707sub inv_recursive_;
1708sub inv_recursive_ {
1709 map { $_, inv_recursive_ $_->inv } @_
1710}
1711
1712sub inv_recursive {
1713 inv_recursive_ inv $_[0]
1714}
1715
1716package cf;
1717
1718=back
1417 1719
1418=head3 cf::object::player 1720=head3 cf::object::player
1419 1721
1420=over 4 1722=over 4
1421 1723
1461 1763
1462=item $player_object->enter_link 1764=item $player_object->enter_link
1463 1765
1464Freezes the player and moves him/her to a special map (C<{link}>). 1766Freezes the player and moves him/her to a special map (C<{link}>).
1465 1767
1466The player should be reaosnably safe there for short amounts of time. You 1768The player should be reasonably safe there for short amounts of time. You
1467I<MUST> call C<leave_link> as soon as possible, though. 1769I<MUST> call C<leave_link> as soon as possible, though.
1468 1770
1771Will never block.
1772
1469=item $player_object->leave_link ($map, $x, $y) 1773=item $player_object->leave_link ($map, $x, $y)
1470 1774
1471Moves the player out of the specila link map onto the given map. If the 1775Moves the player out of the special C<{link}> map onto the specified
1472map is not valid (or omitted), the player will be moved back to the 1776map. If the map is not valid (or omitted), the player will be moved back
1473location he/she was before the call to C<enter_link>, or, if that fails, 1777to the location he/she was before the call to C<enter_link>, or, if that
1474to the emergency map position. 1778fails, to the emergency map position.
1475 1779
1476Might block. 1780Might block.
1477 1781
1478=cut 1782=cut
1783
1784sub link_map {
1785 unless ($LINK_MAP) {
1786 $LINK_MAP = cf::map::find "{link}"
1787 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1788 $LINK_MAP->load;
1789 }
1790
1791 $LINK_MAP
1792}
1479 1793
1480sub cf::object::player::enter_link { 1794sub cf::object::player::enter_link {
1481 my ($self) = @_; 1795 my ($self) = @_;
1482 1796
1483 $self->deactivate_recursive; 1797 $self->deactivate_recursive;
1484 1798
1485 return if $self->map == $LINK_MAP; 1799 return if UNIVERSAL::isa $self->map, "ext::map_link";
1486 1800
1487 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1801 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1488 if $self->map; 1802 if $self->map;
1489 1803
1490 $self->enter_map ($LINK_MAP, 20, 20); 1804 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1491} 1805}
1492 1806
1493sub cf::object::player::leave_link { 1807sub cf::object::player::leave_link {
1494 my ($self, $map, $x, $y) = @_; 1808 my ($self, $map, $x, $y) = @_;
1495 1809
1496 my $link_pos = delete $self->{_link_pos}; 1810 my $link_pos = delete $self->{_link_pos};
1497 1811
1498 unless ($map) { 1812 unless ($map) {
1499 # restore original map position 1813 # restore original map position
1500 ($map, $x, $y) = @{ $link_pos || [] }; 1814 ($map, $x, $y) = @{ $link_pos || [] };
1501 $map = cf::map::find_map $map; 1815 $map = cf::map::find $map;
1502 1816
1503 unless ($map) { 1817 unless ($map) {
1504 ($map, $x, $y) = @$EMERGENCY_POSITION; 1818 ($map, $x, $y) = @$EMERGENCY_POSITION;
1505 $map = cf::map::find_map $map 1819 $map = cf::map::find $map
1506 or die "FATAL: cannot load emergency map\n"; 1820 or die "FATAL: cannot load emergency map\n";
1507 } 1821 }
1508 } 1822 }
1509 1823
1510 ($x, $y) = (-1, -1) 1824 ($x, $y) = (-1, -1)
1513 # use -1 or undef as default coordinates, not 0, 0 1827 # use -1 or undef as default coordinates, not 0, 0
1514 ($x, $y) = ($map->enter_x, $map->enter_y) 1828 ($x, $y) = ($map->enter_x, $map->enter_y)
1515 if $x <=0 && $y <= 0; 1829 if $x <=0 && $y <= 0;
1516 1830
1517 $map->load; 1831 $map->load;
1832 $map->load_diag;
1518 1833
1834 return unless $self->contr->active;
1519 $self->activate_recursive; 1835 $self->activate_recursive;
1836
1837 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1520 $self->enter_map ($map, $x, $y); 1838 $self->enter_map ($map, $x, $y);
1521} 1839}
1522 1840
1523cf::player->attach ( 1841cf::player->attach (
1524 on_logout => sub { 1842 on_logout => sub {
1536 1854
1537 # try to abort aborted map switching on player login :) 1855 # try to abort aborted map switching on player login :)
1538 # should happen only on crashes 1856 # should happen only on crashes
1539 if ($pl->ob->{_link_pos}) { 1857 if ($pl->ob->{_link_pos}) {
1540 $pl->ob->enter_link; 1858 $pl->ob->enter_link;
1541 Coro::async { 1859 (async {
1860 $pl->ob->reply (undef,
1861 "There was an internal problem at your last logout, "
1862 . "the server will try to bring you to your intended destination in a second.",
1863 cf::NDI_RED);
1542 # we need this sleep as the login has a concurrent enter_exit running 1864 # we need this sleep as the login has a concurrent enter_exit running
1543 # and this sleep increases chances of the player not ending up in scorn 1865 # and this sleep increases chances of the player not ending up in scorn
1544 Coro::Timer::sleep 1; 1866 Coro::Timer::sleep 1;
1545 $pl->ob->leave_link; 1867 $pl->ob->leave_link;
1546 }; 1868 })->prio (2);
1547 } 1869 }
1548 }, 1870 },
1549); 1871);
1550 1872
1551=item $player_object->goto_map ($path, $x, $y) 1873=item $player_object->goto ($path, $x, $y)
1552 1874
1553=cut 1875=cut
1554 1876
1555sub cf::object::player::goto_map { 1877sub cf::object::player::goto {
1556 my ($self, $path, $x, $y) = @_; 1878 my ($self, $path, $x, $y) = @_;
1557 1879
1558 $self->enter_link; 1880 $self->enter_link;
1559 1881
1560 (Coro::async { 1882 (async {
1561 $path = new cf::path $path; 1883 my $map = eval {
1562
1563 my $map = cf::map::find_map $path->as_string; 1884 my $map = cf::map::find $path;
1564 $map = $map->customise_for ($self) if $map; 1885 $map = $map->customise_for ($self) if $map;
1565 1886 $map
1566# warn "entering ", $map->path, " at ($x, $y)\n" 1887 } or
1567# if $map;
1568
1569 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 1888 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1570 1889
1571 $self->leave_link ($map, $x, $y); 1890 $self->leave_link ($map, $x, $y);
1572 })->prio (1); 1891 })->prio (1);
1573} 1892}
1574 1893
1578 1897
1579sub parse_random_map_params { 1898sub parse_random_map_params {
1580 my ($spec) = @_; 1899 my ($spec) = @_;
1581 1900
1582 my $rmp = { # defaults 1901 my $rmp = { # defaults
1583 xsize => 10, 1902 xsize => (cf::rndm 15, 40),
1584 ysize => 10, 1903 ysize => (cf::rndm 15, 40),
1904 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1905 #layout => string,
1585 }; 1906 };
1586 1907
1587 for (split /\n/, $spec) { 1908 for (split /\n/, $spec) {
1588 my ($k, $v) = split /\s+/, $_, 2; 1909 my ($k, $v) = split /\s+/, $_, 2;
1589 1910
1593 $rmp 1914 $rmp
1594} 1915}
1595 1916
1596sub prepare_random_map { 1917sub prepare_random_map {
1597 my ($exit) = @_; 1918 my ($exit) = @_;
1919
1920 my $guard = cf::lock_acquire "exit_prepare:$exit";
1598 1921
1599 # all this does is basically replace the /! path by 1922 # all this does is basically replace the /! path by
1600 # a new random map path (?random/...) with a seed 1923 # a new random map path (?random/...) with a seed
1601 # that depends on the exit object 1924 # that depends on the exit object
1602 1925
1603 my $rmp = parse_random_map_params $exit->msg; 1926 my $rmp = parse_random_map_params $exit->msg;
1604 1927
1605 if ($exit->map) { 1928 if ($exit->map) {
1606 $rmp->{region} = $exit->map->region_name; 1929 $rmp->{region} = $exit->region->name;
1607 $rmp->{origin_map} = $exit->map->path; 1930 $rmp->{origin_map} = $exit->map->path;
1608 $rmp->{origin_x} = $exit->x; 1931 $rmp->{origin_x} = $exit->x;
1609 $rmp->{origin_y} = $exit->y; 1932 $rmp->{origin_y} = $exit->y;
1610 } 1933 }
1611 1934
1612 $rmp->{random_seed} ||= $exit->random_seed; 1935 $rmp->{random_seed} ||= $exit->random_seed;
1613 1936
1614 my $data = cf::to_json $rmp; 1937 my $data = cf::to_json $rmp;
1615 my $md5 = Digest::MD5::md5_hex $data; 1938 my $md5 = Digest::MD5::md5_hex $data;
1939 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1616 1940
1617 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 1941 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1618 aio_write $fh, 0, (length $data), $data, 0; 1942 aio_write $fh, 0, (length $data), $data, 0;
1943 undef $fh;
1944 aio_rename "$meta~", $meta;
1619 1945
1620 $exit->slaying ("?random/$md5"); 1946 $exit->slaying ("?random/$md5");
1621 $exit->msg (undef); 1947 $exit->msg (undef);
1622 } 1948 }
1623} 1949}
1625sub cf::object::player::enter_exit { 1951sub cf::object::player::enter_exit {
1626 my ($self, $exit) = @_; 1952 my ($self, $exit) = @_;
1627 1953
1628 return unless $self->type == cf::PLAYER; 1954 return unless $self->type == cf::PLAYER;
1629 1955
1956 if ($exit->slaying eq "/!") {
1957 #TODO: this should de-fi-ni-te-ly not be a sync-job
1958 cf::sync_job { prepare_random_map $exit };
1959 }
1960
1961 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1962 my $hp = $exit->stats->hp;
1963 my $sp = $exit->stats->sp;
1964
1630 $self->enter_link; 1965 $self->enter_link;
1631 1966
1632 (Coro::async { 1967 (async {
1968 $self->deactivate_recursive; # just to be sure
1633 unless (eval { 1969 unless (eval {
1634 1970 $self->goto ($slaying, $hp, $sp);
1635 prepare_random_map $exit
1636 if $exit->slaying eq "/!";
1637
1638 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1639 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1640 1971
1641 1; 1972 1;
1642 }) { 1973 }) {
1643 $self->message ("Something went wrong deep within the crossfire server. " 1974 $self->message ("Something went wrong deep within the crossfire server. "
1644 . "I'll try to bring you back to the map you were before. " 1975 . "I'll try to bring you back to the map you were before. "
1645 . "Please report this to the dungeon master", 1976 . "Please report this to the dungeon master!",
1646 cf::NDI_UNIQUE | cf::NDI_RED); 1977 cf::NDI_UNIQUE | cf::NDI_RED);
1647 1978
1648 warn "ERROR in enter_exit: $@"; 1979 warn "ERROR in enter_exit: $@";
1649 $self->leave_link; 1980 $self->leave_link;
1650 } 1981 }
1664 1995
1665sub cf::client::send_drawinfo { 1996sub cf::client::send_drawinfo {
1666 my ($self, $text, $flags) = @_; 1997 my ($self, $text, $flags) = @_;
1667 1998
1668 utf8::encode $text; 1999 utf8::encode $text;
1669 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2000 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1670} 2001}
1671 2002
1672 2003
1673=item $success = $client->query ($flags, "text", \&cb) 2004=item $success = $client->query ($flags, "text", \&cb)
1674 2005
1701 on_reply => sub { 2032 on_reply => sub {
1702 my ($ns, $msg) = @_; 2033 my ($ns, $msg) = @_;
1703 2034
1704 # this weird shuffling is so that direct followup queries 2035 # this weird shuffling is so that direct followup queries
1705 # get handled first 2036 # get handled first
1706 my $queue = delete $ns->{query_queue}; 2037 my $queue = delete $ns->{query_queue}
2038 or return; # be conservative, not sure how that can happen, but we saw a crash here
1707 2039
1708 (shift @$queue)->[1]->($msg); 2040 (shift @$queue)->[1]->($msg);
2041 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1709 2042
1710 push @{ $ns->{query_queue} }, @$queue; 2043 push @{ $ns->{query_queue} }, @$queue;
1711 2044
1712 if (@{ $ns->{query_queue} } == @$queue) { 2045 if (@{ $ns->{query_queue} } == @$queue) {
1713 if (@$queue) { 2046 if (@$queue) {
1717 } 2050 }
1718 } 2051 }
1719 }, 2052 },
1720); 2053);
1721 2054
1722=item $client->coro (\&cb) 2055=item $client->async (\&cb)
1723 2056
1724Create a new coroutine, running the specified callback. The coroutine will 2057Create a new coroutine, running the specified callback. The coroutine will
1725be automatically cancelled when the client gets destroyed (e.g. on logout, 2058be automatically cancelled when the client gets destroyed (e.g. on logout,
1726or loss of connection). 2059or loss of connection).
1727 2060
1728=cut 2061=cut
1729 2062
1730sub cf::client::coro { 2063sub cf::client::async {
1731 my ($self, $cb) = @_; 2064 my ($self, $cb) = @_;
1732 2065
1733 my $coro; $coro = async { 2066 my $coro = &Coro::async ($cb);
1734 eval {
1735 $cb->();
1736 };
1737 warn $@ if $@;
1738 };
1739 2067
1740 $coro->on_destroy (sub { 2068 $coro->on_destroy (sub {
1741 delete $self->{_coro}{$coro+0}; 2069 delete $self->{_coro}{$coro+0};
1742 }); 2070 });
1743 2071
1879The parameter C<$family> should best start with the name of the extension 2207The parameter C<$family> should best start with the name of the extension
1880using it, it should be unique. 2208using it, it should be unique.
1881 2209
1882=over 4 2210=over 4
1883 2211
1884=item $hashref = cf::db_get $family
1885
1886Return a hashref for use by the extension C<$family>, which can be
1887modified. After modifications, you have to call C<cf::db_dirty> or
1888C<cf::db_sync>.
1889
1890=item $value = cf::db_get $family => $key 2212=item $value = cf::db_get $family => $key
1891 2213
1892Returns a single value from the database 2214Returns a single value from the database.
1893
1894=item cf::db_put $family => $hashref
1895
1896Stores the given family hashref into the database. Updates are delayed, if
1897you want the data to be synced to disk immediately, use C<cf::db_sync>.
1898 2215
1899=item cf::db_put $family => $key => $value 2216=item cf::db_put $family => $key => $value
1900 2217
1901Stores the given C<$value> in the family hash. Updates are delayed, if you 2218Stores the given C<$value> in the family.
1902want the data to be synced to disk immediately, use C<cf::db_sync>.
1903
1904=item cf::db_dirty
1905
1906Marks the database as dirty, to be updated at a later time.
1907
1908=item cf::db_sync
1909
1910Immediately write the database to disk I<if it is dirty>.
1911 2219
1912=cut 2220=cut
1913 2221
1914our $DB; 2222our $DB;
1915 2223
1916{ 2224sub db_init {
2225 unless ($DB) {
2226 $DB = BDB::db_create $DB_ENV;
2227
2228 cf::sync_job {
2229 eval {
2230 $DB->set_flags (BDB::CHKSUM);
2231
2232 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2233 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2234 cf::cleanup "db_open(db): $!" if $!;
2235 };
2236 cf::cleanup "db_open(db): $@" if $@;
2237 };
2238
1917 my $path = cf::localdir . "/database.pst"; 2239 my $path = cf::localdir . "/database.pst";
2240 if (stat $path) {
2241 cf::sync_job {
2242 my $pst = Storable::retrieve $path;
1918 2243
1919 sub db_load() { 2244 cf::db_put (board => data => $pst->{board});
1920 $DB = stat $path ? Storable::retrieve $path : { }; 2245 cf::db_put (guildrules => data => $pst->{guildrules});
1921 } 2246 cf::db_put (rent => balance => $pst->{rent}{balance});
2247 BDB::db_env_txn_checkpoint $DB_ENV;
1922 2248
1923 my $pid; 2249 unlink $path;
1924
1925 sub db_save() {
1926 waitpid $pid, 0 if $pid;
1927 if (0 == ($pid = fork)) {
1928 $DB->{_meta}{version} = 1;
1929 Storable::nstore $DB, "$path~";
1930 rename "$path~", $path;
1931 cf::_exit 0 if defined $pid;
1932 } 2250 };
1933 } 2251 }
1934
1935 my $dirty;
1936
1937 sub db_sync() {
1938 db_save if $dirty;
1939 undef $dirty;
1940 }
1941
1942 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1943 db_sync;
1944 }); 2252 }
2253}
1945 2254
1946 sub db_dirty() {
1947 $dirty = 1;
1948 $idle->start;
1949 }
1950
1951 sub db_get($;$) { 2255sub db_get($$) {
1952 @_ >= 2 2256 my $key = "$_[0]/$_[1]";
1953 ? $DB->{$_[0]}{$_[1]}
1954 : ($DB->{$_[0]} ||= { })
1955 }
1956 2257
2258 cf::sync_job {
2259 BDB::db_get $DB, undef, $key, my $data;
2260
2261 $! ? ()
2262 : Compress::LZF::sthaw $data
2263 }
2264}
2265
1957 sub db_put($$;$) { 2266sub db_put($$$) {
1958 if (@_ >= 3) { 2267 BDB::dbreq_pri 4;
1959 $DB->{$_[0]}{$_[1]} = $_[2]; 2268 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2269}
2270
2271#############################################################################
2272# the server's init and main functions
2273
2274sub load_faces {
2275 my $path = sprintf "%s/faces", cf::datadir;
2276
2277 warn "loading faces from $path\n";
2278
2279 my $faces;
2280 0 < aio_load $path, $faces
2281 or die "$path: $!";
2282
2283 Coro::cede;
2284 $faces = Storable::thaw $faces;
2285 Coro::cede;
2286
2287 while (my ($face, $info) = each %$faces) {
2288 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2289 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2290 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2291 Coro::cede;
2292 }
2293
2294 while (my ($face, $info) = each %$faces) {
2295 next unless $info->{smooth};
2296 my $idx = cf::face::find $face
2297 or next;
2298 if (my $smooth = cf::face::find $info->{smooth}) {
2299 cf::face::set_smooth $idx, $smooth;
2300 warn "smooth $idx,$smooth ($face,$info->{smooth})\n";#d#
1960 } else { 2301 } else {
1961 $DB->{$_[0]} = $_[1]; 2302 warn "smooth face '$info->{smooth}' not found for face '$face'";
1962 }
1963 db_dirty;
1964 }
1965
1966 cf::global->attach (
1967 prio => 10000,
1968 on_cleanup => sub {
1969 db_sync;
1970 }, 2303 }
1971 ); 2304 Coro::cede;
1972} 2305 }
1973 2306
1974############################################################################# 2307 1
1975# the server's main() 2308}
2309
2310sub reload_resources {
2311 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2312 or die "unable to load regions file\n";#d#
2313 load_faces
2314 or die "unable to load faces\n";#d#
2315}
2316
2317sub init {
2318 reload_resources;
2319}
1976 2320
1977sub cfg_load { 2321sub cfg_load {
1978 open my $fh, "<:utf8", cf::confdir . "/config" 2322 open my $fh, "<:utf8", cf::confdir . "/config"
1979 or return; 2323 or return;
1980 2324
1981 local $/; 2325 local $/;
1982 *CFG = YAML::Syck::Load <$fh>; 2326 *CFG = YAML::Syck::Load <$fh>;
2327
2328 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2329
2330 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2331 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2332
2333 if (exists $CFG{mlockall}) {
2334 eval {
2335 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2336 and die "WARNING: m(un)lockall failed: $!\n";
2337 };
2338 warn $@ if $@;
2339 }
1983} 2340}
1984 2341
1985sub main { 2342sub main {
1986 # we must not ever block the main coroutine 2343 # we must not ever block the main coroutine
1987 local $Coro::idle = sub { 2344 local $Coro::idle = sub {
1988 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2345 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1989 (Coro::unblock_sub { 2346 (async {
1990 Event::one_event; 2347 Event::one_event;
1991 })->(); 2348 })->prio (Coro::PRIO_MAX);
1992 }; 2349 };
1993 2350
1994 cfg_load; 2351 cfg_load;
1995 db_load; 2352 db_init;
1996 load_extensions; 2353 load_extensions;
2354
2355 $TICK_WATCHER->start;
1997 Event::loop; 2356 Event::loop;
1998} 2357}
1999 2358
2000############################################################################# 2359#############################################################################
2001# initialisation 2360# initialisation and cleanup
2361
2362# install some emergency cleanup handlers
2363BEGIN {
2364 for my $signal (qw(INT HUP TERM)) {
2365 Event->signal (
2366 reentrant => 0,
2367 data => WF_AUTOCANCEL,
2368 signal => $signal,
2369 prio => 0,
2370 cb => sub {
2371 cf::cleanup "SIG$signal";
2372 },
2373 );
2374 }
2375}
2376
2377sub emergency_save() {
2378 my $freeze_guard = cf::freeze_mainloop;
2379
2380 warn "enter emergency perl save\n";
2381
2382 cf::sync_job {
2383 # use a peculiar iteration method to avoid tripping on perl
2384 # refcount bugs in for. also avoids problems with players
2385 # and maps saved/destroyed asynchronously.
2386 warn "begin emergency player save\n";
2387 for my $login (keys %cf::PLAYER) {
2388 my $pl = $cf::PLAYER{$login} or next;
2389 $pl->valid or next;
2390 $pl->save;
2391 }
2392 warn "end emergency player save\n";
2393
2394 warn "begin emergency map save\n";
2395 for my $path (keys %cf::MAP) {
2396 my $map = $cf::MAP{$path} or next;
2397 $map->valid or next;
2398 $map->save;
2399 }
2400 warn "end emergency map save\n";
2401
2402 warn "begin emergency database checkpoint\n";
2403 BDB::db_env_txn_checkpoint $DB_ENV;
2404 warn "end emergency database checkpoint\n";
2405 };
2406
2407 warn "leave emergency perl save\n";
2408}
2409
2410sub post_cleanup {
2411 my ($make_core) = @_;
2412
2413 warn Carp::longmess "post_cleanup backtrace"
2414 if $make_core;
2415}
2002 2416
2003sub reload() { 2417sub reload() {
2004 # can/must only be called in main 2418 # can/must only be called in main
2005 if ($Coro::current != $Coro::main) { 2419 if ($Coro::current != $Coro::main) {
2006 warn "can only reload from main coroutine\n"; 2420 warn "can only reload from main coroutine";
2007 return; 2421 return;
2008 } 2422 }
2009 2423
2010 warn "reloading..."; 2424 warn "reloading...";
2011 2425
2012 local $FREEZE = 1; 2426 warn "entering sync_job";
2427
2428 cf::sync_job {
2429 cf::write_runtime; # external watchdog should not bark
2013 cf::emergency_save; 2430 cf::emergency_save;
2431 cf::write_runtime; # external watchdog should not bark
2014 2432
2015 eval { 2433 warn "syncing database to disk";
2434 BDB::db_env_txn_checkpoint $DB_ENV;
2435
2016 # if anything goes wrong in here, we should simply crash as we already saved 2436 # if anything goes wrong in here, we should simply crash as we already saved
2017 2437
2018 # cancel all watchers 2438 warn "cancelling all WF_AUTOCANCEL watchers";
2019 for (Event::all_watchers) { 2439 for (Event::all_watchers) {
2020 $_->cancel if $_->data & WF_AUTOCANCEL; 2440 $_->cancel if $_->data & WF_AUTOCANCEL;
2021 } 2441 }
2022 2442
2443 warn "flushing outstanding aio requests";
2444 for (;;) {
2445 BDB::flush;
2446 IO::AIO::flush;
2447 Coro::cede;
2448 last unless IO::AIO::nreqs || BDB::nreqs;
2449 warn "iterate...";
2450 }
2451
2452 ++$RELOAD;
2453
2023 # cancel all extension coros 2454 warn "cancelling all extension coros";
2024 $_->cancel for values %EXT_CORO; 2455 $_->cancel for values %EXT_CORO;
2025 %EXT_CORO = (); 2456 %EXT_CORO = ();
2026 2457
2027 # unload all extensions 2458 warn "removing commands";
2028 for (@exts) { 2459 %COMMAND = ();
2460
2461 warn "removing ext commands";
2462 %EXTCMD = ();
2463
2464 warn "unloading/nuking all extensions";
2465 for my $pkg (@EXTS) {
2029 warn "unloading <$_>"; 2466 warn "... unloading $pkg";
2030 unload_extension $_; 2467
2468 if (my $cb = $pkg->can ("unload")) {
2469 eval {
2470 $cb->($pkg);
2471 1
2472 } or warn "$pkg unloaded, but with errors: $@";
2031 } 2473 }
2032 2474
2475 warn "... nuking $pkg";
2476 Symbol::delete_package $pkg;
2477 }
2478
2033 # unload all modules loaded from $LIBDIR 2479 warn "unloading all perl modules loaded from $LIBDIR";
2034 while (my ($k, $v) = each %INC) { 2480 while (my ($k, $v) = each %INC) {
2035 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2481 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2036 2482
2037 warn "removing <$k>"; 2483 warn "... unloading $k";
2038 delete $INC{$k}; 2484 delete $INC{$k};
2039 2485
2040 $k =~ s/\.pm$//; 2486 $k =~ s/\.pm$//;
2041 $k =~ s/\//::/g; 2487 $k =~ s/\//::/g;
2042 2488
2045 } 2491 }
2046 2492
2047 Symbol::delete_package $k; 2493 Symbol::delete_package $k;
2048 } 2494 }
2049 2495
2050 # sync database to disk
2051 cf::db_sync;
2052 IO::AIO::flush;
2053
2054 # get rid of safe::, as good as possible 2496 warn "getting rid of safe::, as good as possible";
2055 Symbol::delete_package "safe::$_" 2497 Symbol::delete_package "safe::$_"
2056 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2498 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2057 2499
2058 # remove register_script_function callbacks
2059 # TODO
2060
2061 # unload cf.pm "a bit" 2500 warn "unloading cf.pm \"a bit\"";
2062 delete $INC{"cf.pm"}; 2501 delete $INC{"cf.pm"};
2063 2502
2064 # don't, removes xs symbols, too, 2503 # don't, removes xs symbols, too,
2065 # and global variables created in xs 2504 # and global variables created in xs
2066 #Symbol::delete_package __PACKAGE__; 2505 #Symbol::delete_package __PACKAGE__;
2067 2506
2068 # reload cf.pm 2507 warn "unload completed, starting to reload now";
2508
2069 warn "reloading cf.pm"; 2509 warn "reloading cf.pm";
2070 require cf; 2510 require cf;
2071 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2511 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2072 2512
2073 # load config and database again 2513 warn "loading config and database again";
2074 cf::cfg_load; 2514 cf::cfg_load;
2075 cf::db_load;
2076 2515
2077 # load extensions
2078 warn "load extensions"; 2516 warn "loading extensions";
2079 cf::load_extensions; 2517 cf::load_extensions;
2080 2518
2081 # reattach attachments to objects 2519 warn "reattaching attachments to objects/players";
2082 warn "reattach"; 2520 _global_reattach; # objects, sockets
2083 _global_reattach; 2521 warn "reattaching attachments to maps";
2084 }; 2522 reattach $_ for values %MAP;
2523 warn "reattaching attachments to players";
2524 reattach $_ for values %PLAYER;
2085 2525
2086 if ($@) { 2526 warn "loading reloadable resources";
2527 reload_resources;
2528
2529 warn "leaving sync_job";
2530
2531 1
2532 } or do {
2087 warn $@; 2533 warn $@;
2088 warn "error while reloading, exiting."; 2534 warn "error while reloading, exiting.";
2089 exit 1; 2535 exit 1;
2090 } 2536 };
2091 2537
2092 warn "reloaded successfully"; 2538 warn "reloaded";
2093}; 2539};
2094 2540
2095############################################################################# 2541our $RELOAD_WATCHER; # used only during reload
2096
2097unless ($LINK_MAP) {
2098 $LINK_MAP = cf::map::new;
2099
2100 $LINK_MAP->width (41);
2101 $LINK_MAP->height (41);
2102 $LINK_MAP->alloc;
2103 $LINK_MAP->path ("{link}");
2104 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2105 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2106
2107 # dirty hack because... archetypes are not yet loaded
2108 Event->timer (
2109 after => 2,
2110 cb => sub {
2111 $_[0]->w->cancel;
2112
2113 # provide some exits "home"
2114 my $exit = cf::object::new "exit";
2115
2116 $exit->slaying ($EMERGENCY_POSITION->[0]);
2117 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2118 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2119
2120 $LINK_MAP->insert ($exit->clone, 19, 19);
2121 $LINK_MAP->insert ($exit->clone, 19, 20);
2122 $LINK_MAP->insert ($exit->clone, 19, 21);
2123 $LINK_MAP->insert ($exit->clone, 20, 19);
2124 $LINK_MAP->insert ($exit->clone, 20, 21);
2125 $LINK_MAP->insert ($exit->clone, 21, 19);
2126 $LINK_MAP->insert ($exit->clone, 21, 20);
2127 $LINK_MAP->insert ($exit->clone, 21, 21);
2128
2129 $exit->destroy;
2130 });
2131
2132 $LINK_MAP->{deny_save} = 1;
2133 $LINK_MAP->{deny_reset} = 1;
2134
2135 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2136}
2137
2138register "<global>", __PACKAGE__;
2139 2542
2140register_command "reload" => sub { 2543register_command "reload" => sub {
2141 my ($who, $arg) = @_; 2544 my ($who, $arg) = @_;
2142 2545
2143 if ($who->flag (FLAG_WIZ)) { 2546 if ($who->flag (FLAG_WIZ)) {
2144 $who->message ("start of reload."); 2547 $who->message ("reloading server.");
2548
2549 # doing reload synchronously and two reloads happen back-to-back,
2550 # coro crashes during coro_state_free->destroy here.
2551
2552 $RELOAD_WATCHER ||= Event->timer (
2553 reentrant => 0,
2554 after => 0,
2555 data => WF_AUTOCANCEL,
2556 cb => sub {
2145 reload; 2557 reload;
2146 $who->message ("end of reload."); 2558 undef $RELOAD_WATCHER;
2559 },
2560 );
2147 } 2561 }
2148}; 2562};
2149 2563
2150unshift @INC, $LIBDIR; 2564unshift @INC, $LIBDIR;
2565
2566my $bug_warning = 0;
2151 2567
2152$TICK_WATCHER = Event->timer ( 2568$TICK_WATCHER = Event->timer (
2153 reentrant => 0, 2569 reentrant => 0,
2570 parked => 1,
2154 prio => 0, 2571 prio => 0,
2155 at => $NEXT_TICK || $TICK, 2572 at => $NEXT_TICK || $TICK,
2156 data => WF_AUTOCANCEL, 2573 data => WF_AUTOCANCEL,
2157 cb => sub { 2574 cb => sub {
2158 unless ($FREEZE) { 2575 if ($Coro::current != $Coro::main) {
2576 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2577 unless ++$bug_warning > 10;
2578 return;
2579 }
2580
2581 $NOW = Event::time;
2582
2159 cf::server_tick; # one server iteration 2583 cf::server_tick; # one server iteration
2160 $RUNTIME += $TICK; 2584 $RUNTIME += $TICK;
2161 }
2162
2163 $NEXT_TICK += $TICK; 2585 $NEXT_TICK += $TICK;
2586
2587 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2588 $NEXT_RUNTIME_WRITE = $NOW + 10;
2589 Coro::async_pool {
2590 write_runtime
2591 or warn "ERROR: unable to write runtime file: $!";
2592 };
2593 }
2594
2595 $WAIT_FOR_TICK->broadcast;
2596 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2597
2598# my $AFTER = Event::time;
2599# warn $AFTER - $NOW;#d#
2164 2600
2165 # if we are delayed by four ticks or more, skip them all 2601 # if we are delayed by four ticks or more, skip them all
2166 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2602 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2167 2603
2168 $TICK_WATCHER->at ($NEXT_TICK); 2604 $TICK_WATCHER->at ($NEXT_TICK);
2169 $TICK_WATCHER->start; 2605 $TICK_WATCHER->start;
2170 }, 2606 },
2171); 2607);
2172 2608
2609{
2173IO::AIO::max_poll_time $TICK * 0.2; 2610 BDB::max_poll_time $TICK * 0.1;
2174 2611 $BDB_POLL_WATCHER = Event->io (
2175Event->io ( 2612 reentrant => 0,
2176 fd => IO::AIO::poll_fileno, 2613 fd => BDB::poll_fileno,
2177 poll => 'r', 2614 poll => 'r',
2178 prio => 5, 2615 prio => 0,
2179 data => WF_AUTOCANCEL,
2180 cb => \&IO::AIO::poll_cb,
2181);
2182
2183Event->timer (
2184 data => WF_AUTOCANCEL, 2616 data => WF_AUTOCANCEL,
2185 after => 0, 2617 cb => \&BDB::poll_cb,
2186 interval => 10, 2618 );
2187 cb => sub { 2619 BDB::min_parallel 8;
2188 (Coro::unblock_sub { 2620
2189 write_runtime 2621 BDB::set_sync_prepare {
2190 or warn "ERROR: unable to write runtime file: $!"; 2622 my $status;
2623 my $current = $Coro::current;
2624 (
2625 sub {
2626 $status = $!;
2627 $current->ready; undef $current;
2628 },
2629 sub {
2630 Coro::schedule while defined $current;
2631 $! = $status;
2632 },
2633 )
2634 };
2635
2636 unless ($DB_ENV) {
2637 $DB_ENV = BDB::db_env_create;
2638
2639 cf::sync_job {
2640 eval {
2641 BDB::db_env_open
2642 $DB_ENV,
2643 $BDB_ENV_DIR,
2644 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2645 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2646 0666;
2647
2648 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
2649
2650 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2651 $DB_ENV->set_lk_detect;
2652 };
2653
2654 cf::cleanup "db_env_open(db): $@" if $@;
2191 })->(); 2655 };
2192 }, 2656 }
2193); 2657}
2658
2659{
2660 IO::AIO::min_parallel 8;
2661
2662 undef $Coro::AIO::WATCHER;
2663 IO::AIO::max_poll_time $TICK * 0.1;
2664 $AIO_POLL_WATCHER = Event->io (
2665 reentrant => 0,
2666 data => WF_AUTOCANCEL,
2667 fd => IO::AIO::poll_fileno,
2668 poll => 'r',
2669 prio => 6,
2670 cb => \&IO::AIO::poll_cb,
2671 );
2672}
2673
2674END { cf::emergency_save }
2194 2675
21951 26761
2196 2677

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines