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.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.320 by root, Tue Jul 24 22:49:40 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.61 ();
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;
19 24
25use JSON::XS 1.4 ();
26use BDB ();
20use Data::Dumper; 27use Data::Dumper;
21use Digest::MD5; 28use Digest::MD5;
22use Fcntl; 29use Fcntl;
30use YAML::Syck ();
23use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
26 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
41
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 43
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
33 46
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
36our %COMMAND = (); 51our %COMMAND = ();
37our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
38 53
39our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
43 59
60our $RELOAD; # number of reloads so far
44our @EVENT; 61our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 62
47our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48our $TICK_WATCHER; 76our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 79our $NEXT_TICK;
52our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
53 85
54our %CFG; 86our %CFG;
55 87
56our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 89our $RUNTIME;
58 90
59our %PLAYER; # all users 91our %PLAYER; # all users
60our %MAP; # all maps 92our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 94
67# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
70binmode STDOUT; 102binmode STDOUT;
71binmode STDERR; 103binmode STDERR;
72 104
73# read virtual server time, if available 105# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
78} 110}
79 111
80mkdir cf::localdir; 112mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 114
86our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
87 118
88############################################################################# 119#############################################################################
89 120
90=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
91 122
98=item $cf::RUNTIME 129=item $cf::RUNTIME
99 130
100The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
101every server tick. 132every server tick.
102 133
103=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104 137
105The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
106be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
107 142
108=item $cf::NOW 143=item $cf::NOW
109 144
110The time of the last (current) server tick. 145The time of the last (current) server tick.
111 146
112=item $cf::TICK 147=item $cf::TICK
113 148
114The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
115 160
116=item %cf::CFG 161=item %cf::CFG
117 162
118Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
119from wherever your confdir points to. 164from wherever your confdir points to.
120 165
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
122 167
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
125processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
127 177
128=back 178=back
129 179
130=cut 180=cut
131 181
132BEGIN { 182BEGIN {
133 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 184 my $msg = join "", @_;
135 utf8::encode $msg;
136 185
137 $msg .= "\n" 186 $msg .= "\n"
138 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
139 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
140 LOG llevError, $msg; 192 LOG llevError, $msg;
141 }; 193 };
142} 194}
143 195
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150 203
151# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
152# within the Safe compartment. 205# within the Safe compartment.
153for my $pkg (qw( 206for my $pkg (qw(
154 cf::global cf::attachable 207 cf::global cf::attachable
162} 215}
163 216
164$Event::DIED = sub { 217$Event::DIED = sub {
165 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
166}; 219};
220
221#############################################################################
167 222
168=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
169 224
170=over 4 225=over 4
171 226
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d 246 $d
192 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
193} 248}
194 249
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
198 251
199Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
200 253
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
209 255
210Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
211 257
212=cut 258=cut
213 259
214sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
216 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
217} 263sub from_json ($) { $json_coder->decode ($_[0]) }
218 264
219=item cf::lock_wait $string 265=item cf::lock_wait $string
220 266
221Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
222 268
228returned. 274returned.
229 275
230Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
231uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
232 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
233=cut 283=cut
234 284
235our %LOCK; 285our %LOCK;
236 286
237sub lock_wait($) { 287sub lock_wait($) {
256 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
258 } 308 }
259} 309}
260 310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
261sub freeze_mainloop { 317sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
263 319
264 my $guard = Coro::guard { 320 my $guard = Coro::guard {
265 $TICK_WATCHER->start; 321 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 }; 322 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
270 $guard 324 $guard
325}
326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
271} 381}
272 382
273=item cf::async { BLOCK } 383=item cf::async { BLOCK }
274 384
275Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
280 390
281BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
282 392
283=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
284 394
285The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
288 399
289If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
290the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
291server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
292fast or be very important. 403fast or be very important.
295 406
296sub sync_job(&) { 407sub sync_job(&) {
297 my ($job) = @_; 408 my ($job) = @_;
298 409
299 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
300 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
302 415
303 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 417 # (but this is cancel-safe)
315 428
316 while ($busy) { 429 while ($busy) {
317 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
318 } 431 }
319 432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
320 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
321 } else { 441 } else {
322 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
323 443
324 $job->() 444 $job->()
343 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
344 464
345 $coro 465 $coro
346} 466}
347 467
348sub write_runtime { 468=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 469
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
352 or return; 471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
353 474
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 475=cut
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357 476
358 aio_fsync $fh 477sub _store_scalar {
359 and return; 478 open my $fh, ">", \my $buf
360 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
361 close $fh 481 close $fh;
362 or return;
363 482
364 aio_rename "$runtime~", $runtime 483 $buf
365 and return; 484}
366 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
367 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
368} 655}
369 656
370=back 657=back
371 658
372=cut 659=cut
379attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
380to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
381 668
382In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
383C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
384crossfire+). 671Crossfire TRT).
385 672
386=over 4 673=over 4
387 674
388=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
389 676
503our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
504our @CB_MAP = (); 791our @CB_MAP = ();
505 792
506my %attachment; 793my %attachment;
507 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
508sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
509 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
510 803
511 use sort 'stable'; 804 use sort 'stable';
512 805
546 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
547 840
548 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
549 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
550 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
551 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
552 845
553 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
554 my $pkg = shift @arg; 847 my $pkg = shift @arg;
555 848
556 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
585 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
586 } 879 }
587 880
588 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
589 } else { 882 } else {
590 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
591 } 884 }
592 885
593 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
594} 887}
595 888
597 if (ref $_[0]) { 890 if (ref $_[0]) {
598 _object_attach @_; 891 _object_attach @_;
599 } else { 892 } else {
600 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
601 } 894 }
895 _recalc_want;
602}; 896};
603 897
604# all those should be optimised 898# all those should be optimised
605sub cf::attachable::detach { 899sub cf::attachable::detach {
606 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
609 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
610 reattach ($obj); 904 reattach ($obj);
611 } else { 905 } else {
612 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
613 } 907 }
908 _recalc_want;
614}; 909};
615 910
616sub cf::attachable::attached { 911sub cf::attachable::attached {
617 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
618 913
633 "; 928 ";
634 die if $@; 929 die if $@;
635} 930}
636 931
637our $override; 932our $override;
638our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
639 934
640sub override { 935sub override {
641 $override = 1; 936 $override = 1;
642 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
643} 938}
644 939
645sub do_invoke { 940sub do_invoke {
646 my $event = shift; 941 my $event = shift;
647 my $callbacks = shift; 942 my $callbacks = shift;
648 943
649 @invoke_results = (); 944 @INVOKE_RESULTS = ();
650 945
651 local $override; 946 local $override;
652 947
653 for (@$callbacks) { 948 for (@$callbacks) {
654 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
671 966
672Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
673 968
674This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
675removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
676results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
677 972
678=back 973=back
679 974
680=cut 975=cut
681 976
682############################################################################# 977#############################################################################
683# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
684 990
685sub reattach { 991sub reattach {
686 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
687 my ($obj) = @_; 993 my ($obj) = @_;
688 994
741 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
742 1048
743 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
744 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
745 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
746 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
747 close $fh; 1053 close $fh;
748 1054
749 if (@$objs) { 1055 if (@$objs) {
750 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1056 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
751 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
752 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
753 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
754 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
755 close $fh; 1061 close $fh;
756 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
757 } 1063 }
758 } else { 1064 } else {
759 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
791 or return; 1097 or return;
792 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
793 } 1099 }
794 1100
795 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
796 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
797 return ($data, $av); 1103 return ($data, $av);
798} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
799 1111
800############################################################################# 1112#############################################################################
801# command handling &c 1113# command handling &c
802 1114
803=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
816 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
817} 1129}
818 1130
819=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
820 1132
821Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
822 1138
823If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
824called. 1140called.
825 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
826=cut 1153=cut
827 1154
828sub register_extcmd { 1155sub register_extcmd {
829 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
830 1157
831 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
832} 1165}
833 1166
834cf::player->attach ( 1167cf::player->attach (
835 on_command => sub { 1168 on_command => sub {
836 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
845 cf::override; 1178 cf::override;
846 }, 1179 },
847 on_extcmd => sub { 1180 on_extcmd => sub {
848 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
849 1182
850 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
851 1184
852 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
853 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
854 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
855 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
856 } 1195 if $reply;
857 } 1196 }
858 } else { 1197 } else {
859 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
860 } 1199 }
861 1200
862 cf::override; 1201 cf::override;
863 }, 1202 },
864); 1203);
865 1204
866sub load_extension {
867 my ($path) = @_;
868
869 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
870 my $base = $1;
871 my $pkg = $1;
872 $pkg =~ s/[^[:word:]]/_/g;
873 $pkg = "ext::$pkg";
874
875 warn "... loading '$path' into '$pkg'\n";
876
877 open my $fh, "<:utf8", $path
878 or die "$path: $!";
879
880 my $source =
881 "package $pkg; use strict; use utf8;\n"
882 . "#line 1 \"$path\"\n{\n"
883 . (do { local $/; <$fh> })
884 . "\n};\n1";
885
886 unless (eval $source) {
887 my $msg = $@ ? "$path: $@\n"
888 : "extension disabled.\n";
889 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
890 warn $@;
891 warn "mandatory extension failed to load, exiting.\n";
892 exit 1;
893 }
894 die $@;
895 }
896
897 push @EXTS, $pkg;
898}
899
900sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
901 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
902 next unless -r $ext; 1210 next unless -r $path;
903 eval { 1211
904 load_extension $ext; 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;
905 1 1269 }
906 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
907 } 1275 };
908} 1276}
909 1277
910############################################################################# 1278#############################################################################
911 1279
1280=back
1281
912=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
913 1283
914Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
915 1285
916=cut 1286=cut
928Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
929 1299
930=cut 1300=cut
931 1301
932sub playerdir($) { 1302sub playerdir($) {
933 cf::localdir 1303 "$PLAYERDIR/"
934 . "/"
935 . cf::playerdir
936 . "/"
937 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
938} 1305}
939 1306
940sub path($) { 1307sub path($) {
941 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
942 1309
943 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
944} 1311}
945 1312
946sub find_active($) { 1313sub find_active($) {
947 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
948 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
951 1318
952sub exists($) { 1319sub exists($) {
953 my ($login) = @_; 1320 my ($login) = @_;
954 1321
955 $cf::PLAYER{$login} 1322 $cf::PLAYER{$login}
956 or cf::sync_job { !aio_stat $login } 1323 or cf::sync_job { !aio_stat path $login }
957} 1324}
958 1325
959sub find($) { 1326sub find($) {
960 return $cf::PLAYER{$_[0]} || do { 1327 return $cf::PLAYER{$_[0]} || do {
961 my $login = $_[0]; 1328 my $login = $_[0];
962 1329
963 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
964 1331
965 $cf::PLAYER{$_[0]} || do { 1332 $cf::PLAYER{$_[0]} || do {
1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
966 my $pl = load_pl path $login 1340 my $pl = load_pl path $login
967 or return; 1341 or return;
968 $cf::PLAYER{$login} = $pl 1342 $cf::PLAYER{$login} = $pl
969 } 1343 }
970 } 1344 }
1007 1381
1008=cut 1382=cut
1009 1383
1010sub quit_character { 1384sub quit_character {
1011 my ($pl) = @_; 1385 my ($pl) = @_;
1386
1387 my $name = $pl->ob->name;
1012 1388
1013 $pl->{deny_save} = 1; 1389 $pl->{deny_save} = 1;
1014 $pl->password ("*"); # this should lock out the player until we nuked the dir 1390 $pl->password ("*"); # this should lock out the player until we nuked the dir
1015 1391
1016 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1392 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1021 my $path = playerdir $pl; 1397 my $path = playerdir $pl;
1022 my $temp = "$path~$cf::RUNTIME~deleting~"; 1398 my $temp = "$path~$cf::RUNTIME~deleting~";
1023 aio_rename $path, $temp; 1399 aio_rename $path, $temp;
1024 delete $cf::PLAYER{$pl->ob->name}; 1400 delete $cf::PLAYER{$pl->ob->name};
1025 $pl->destroy; 1401 $pl->destroy;
1402
1403 my $prefix = qr<^~\Q$name\E/>;
1404
1405 # nuke player maps
1406 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1407
1026 IO::AIO::aio_rmtree $temp; 1408 IO::AIO::aio_rmtree $temp;
1409}
1410
1411=item $pl->kick
1412
1413Kicks a player out of the game. This destroys the connection.
1414
1415=cut
1416
1417sub kick {
1418 my ($pl, $kicker) = @_;
1419
1420 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1421 $pl->killer ("kicked");
1422 $pl->ns->destroy;
1027} 1423}
1028 1424
1029=item cf::player::list_logins 1425=item cf::player::list_logins
1030 1426
1031Returns am arrayref of all valid playernames in the system, can take a 1427Returns am arrayref of all valid playernames in the system, can take a
1032while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1033 1429
1034=cut 1430=cut
1035 1431
1036sub list_logins { 1432sub list_logins {
1037 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1038 or return []; 1434 or return [];
1039 1435
1040 my @logins; 1436 my @logins;
1041 1437
1042 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1059=cut 1455=cut
1060 1456
1061sub maps($) { 1457sub maps($) {
1062 my ($pl) = @_; 1458 my ($pl) = @_;
1063 1459
1460 $pl = ref $pl ? $pl->ob->name : $pl;
1461
1064 my $files = aio_readdir playerdir $pl 1462 my $files = aio_readdir playerdir $pl
1065 or return; 1463 or return;
1066 1464
1067 my @paths; 1465 my @paths;
1068 1466
1069 for (@$files) { 1467 for (@$files) {
1070 utf8::decode $_; 1468 utf8::decode $_;
1071 next if /\.(?:pl|pst)$/; 1469 next if /\.(?:pl|pst)$/;
1072 next unless /^$PATH_SEP/o; 1470 next unless /^$PATH_SEP/o;
1073 1471
1074 s/\.map$//; 1472 push @paths, cf::map::normalise "~$pl/$_";
1075 push @paths, "~" . $pl->ob->name . "/" . $_;
1076 } 1473 }
1077 1474
1078 \@paths 1475 \@paths
1079} 1476}
1080 1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1081=item $player->ext_reply ($msgid, $msgtype, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1082 1529
1083Sends an ext reply to the player. 1530Sends an ext reply to the player.
1084 1531
1085=cut 1532=cut
1086 1533
1087sub ext_reply($$$%) { 1534sub ext_reply($$@) {
1088 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1089 1536
1090 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1091 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1092 $self->send ("ext " . cf::to_json \%msg); 1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1093} 1544}
1094 1545
1095package cf; 1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1096 1586
1097=back 1587=back
1098
1099 1588
1100=head3 cf::map 1589=head3 cf::map
1101 1590
1102=over 4 1591=over 4
1103 1592
1107 1596
1108use Fcntl; 1597use Fcntl;
1109use Coro::AIO; 1598use Coro::AIO;
1110 1599
1111use overload 1600use overload
1112 '""' => \&as_string; 1601 '""' => \&as_string,
1602 fallback => 1;
1113 1603
1114our $MAX_RESET = 3600; 1604our $MAX_RESET = 3600;
1115our $DEFAULT_RESET = 3000; 1605our $DEFAULT_RESET = 3000;
1116 1606
1117sub generate_random_map { 1607sub generate_random_map {
1118 my ($self, $rmp) = @_; 1608 my ($self, $rmp) = @_;
1119
1120 # mit "rum" bekleckern, nicht 1609 # mit "rum" bekleckern, nicht
1121 $self->_create_random_map ( 1610 $self->_create_random_map (
1122 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1611 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1123 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1612 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1124 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1613 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1620 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1132 (cf::region::find $rmp->{region}), $rmp->{custom} 1621 (cf::region::find $rmp->{region}), $rmp->{custom}
1133 ) 1622 )
1134} 1623}
1135 1624
1625=item cf::map->register ($regex, $prio)
1626
1627Register a handler for the map path matching the given regex at the
1628givne priority (higher is better, built-in handlers have priority 0, the
1629default).
1630
1631=cut
1632
1136sub register { 1633sub register {
1137 my (undef, $regex) = @_; 1634 my (undef, $regex, $prio) = @_;
1138 my $pkg = caller; 1635 my $pkg = caller;
1139 1636
1140 no strict; 1637 no strict;
1141 push @{"$pkg\::ISA"}, __PACKAGE__; 1638 push @{"$pkg\::ISA"}, __PACKAGE__;
1142 1639
1143 $EXT_MAP{$pkg} = qr<$regex>; 1640 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1144} 1641}
1145 1642
1146# also paths starting with '/' 1643# also paths starting with '/'
1147$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1644$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1645
1646sub thawer_merge {
1647 my ($self, $merge) = @_;
1648
1649 # we have to keep some variables in memory intact
1650 local $self->{path};
1651 local $self->{load_path};
1652
1653 $self->SUPER::thawer_merge ($merge);
1654}
1148 1655
1149sub normalise { 1656sub normalise {
1150 my ($path, $base) = @_; 1657 my ($path, $base) = @_;
1658
1659 $path = "$path"; # make sure its a string
1660
1661 $path =~ s/\.map$//;
1151 1662
1152 # map plan: 1663 # map plan:
1153 # 1664 #
1154 # /! non-realised random map exit (special hack!) 1665 # /! non-realised random map exit (special hack!)
1155 # {... are special paths that are not being touched 1666 # {... are special paths that are not being touched
1183 1694
1184 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object 1695 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1185 1696
1186 $path = normalise $path, $base; 1697 $path = normalise $path, $base;
1187 1698
1188 for my $pkg (keys %EXT_MAP) { 1699 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1189 if ($path =~ $EXT_MAP{$pkg}) { 1700 if ($path =~ $EXT_MAP{$pkg}[1]) {
1190 my $self = bless cf::map::new, $pkg; 1701 my $self = bless cf::map::new, $pkg;
1191 $self->{path} = $path; $self->path ($path); 1702 $self->{path} = $path; $self->path ($path);
1192 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1193 return $self; 1704 return $self;
1194 } 1705 }
1195 } 1706 }
1196 1707
1197 Carp::carp "unable to resolve path '$path'."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1198 () 1709 ()
1199} 1710}
1200 1711
1201sub init { 1712sub init {
1202 my ($self) = @_; 1713 my ($self) = @_;
1217 1728
1218# the original (read-only) location 1729# the original (read-only) location
1219sub load_path { 1730sub load_path {
1220 my ($self) = @_; 1731 my ($self) = @_;
1221 1732
1222 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1223} 1734}
1224 1735
1225# the temporary/swap location 1736# the temporary/swap location
1226sub save_path { 1737sub save_path {
1227 my ($self) = @_; 1738 my ($self) = @_;
1228 1739
1229 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1230 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1231} 1742}
1232 1743
1233# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1234sub uniq_path { 1745sub uniq_path {
1235 my ($self) = @_; 1746 my ($self) = @_;
1236 1747
1237 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1238 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1239} 1750}
1240 1751
1241# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1242# all maps in C++... 1753# all maps in C++...
1243sub change_all_map_light { 1754sub change_all_map_light {
1245 1756
1246 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1247 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1248} 1759}
1249 1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1767}
1768
1250sub unlink_save { 1769sub unlink_save {
1251 my ($self) = @_; 1770 my ($self) = @_;
1252 1771
1253 utf8::encode (my $save = $self->save_path); 1772 utf8::encode (my $save = $self->save_path);
1254 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1773 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1255 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1774 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1256} 1775}
1257 1776
1258sub load_header_from($) { 1777sub load_header_from($) {
1259 my ($self, $path) = @_; 1778 my ($self, $path) = @_;
1260 1779
1261 utf8::encode $path; 1780 utf8::encode $path;
1262 aio_open $path, O_RDONLY, 0 1781 #aio_open $path, O_RDONLY, 0
1263 or return; 1782 # or return;
1264 1783
1265 $self->_load_header ($path) 1784 $self->_load_header ($path)
1266 or return; 1785 or return;
1267 1786
1268 $self->{load_path} = $path; 1787 $self->{load_path} = $path;
1269 1788
1270 1 1789 1
1271} 1790}
1272 1791
1273sub load_orig { 1792sub load_header_orig {
1274 my ($self) = @_; 1793 my ($self) = @_;
1275 1794
1276 $self->load_header_from ($self->load_path) 1795 $self->load_header_from ($self->load_path)
1277} 1796}
1278 1797
1279sub load_temp { 1798sub load_header_temp {
1280 my ($self) = @_; 1799 my ($self) = @_;
1281 1800
1282 $self->load_header_from ($self->save_path) 1801 $self->load_header_from ($self->save_path)
1802}
1803
1804sub prepare_temp {
1805 my ($self) = @_;
1806
1807 $self->last_access ((delete $self->{last_access})
1808 || $cf::RUNTIME); #d#
1809 # safety
1810 $self->{instantiate_time} = $cf::RUNTIME
1811 if $self->{instantiate_time} > $cf::RUNTIME;
1812}
1813
1814sub prepare_orig {
1815 my ($self) = @_;
1816
1817 $self->{load_original} = 1;
1818 $self->{instantiate_time} = $cf::RUNTIME;
1819 $self->last_access ($cf::RUNTIME);
1820 $self->instantiate;
1283} 1821}
1284 1822
1285sub load_header { 1823sub load_header {
1286 my ($self) = @_; 1824 my ($self) = @_;
1287 1825
1288 if ($self->load_temp) { 1826 if ($self->load_header_temp) {
1289 $self->last_access ((delete $self->{last_access}) 1827 $self->prepare_temp;
1290 || $cf::RUNTIME); #d#
1291 # safety
1292 $self->{instantiate_time} = $cf::RUNTIME
1293 if $self->{instantiate_time} > $cf::RUNTIME;
1294 } else { 1828 } else {
1295 $self->load_orig 1829 $self->load_header_orig
1296 or return; 1830 or return;
1297 1831 $self->prepare_orig;
1298 $self->{load_original} = 1;
1299 $self->{instantiate_time} = $cf::RUNTIME;
1300 $self->last_access ($cf::RUNTIME);
1301 $self->instantiate;
1302 } 1832 }
1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1303 1839
1304 1 1840 1
1305} 1841}
1306 1842
1307sub find; 1843sub find;
1320 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1321 1857
1322 $map->load_header 1858 $map->load_header
1323 or return; 1859 or return;
1324 1860
1325 if ($map->should_reset) { 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1862 # doing this can freeze the server in a sync job, obviously
1863 #$cf::WAIT_FOR_TICK->wait;
1326 $map->reset; 1864 $map->reset;
1327 undef $guard; 1865 undef $guard;
1328 $map = find $path 1866 return find $path;
1329 or return;
1330 } 1867 }
1331 1868
1332 $cf::MAP{$path} = $map 1869 $cf::MAP{$path} = $map
1333 } 1870 }
1334} 1871}
1872
1873sub pre_load { }
1874sub post_load { }
1335 1875
1336sub load { 1876sub load {
1337 my ($self) = @_; 1877 my ($self) = @_;
1338 1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1339 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1340 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1341 1885
1342 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1343 1887
1344 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1345 1889
1346 $self->alloc; 1890 $self->alloc;
1347 $self->_load_objects ($self->{load_path}, 1)
1348 or return;
1349 1891
1350 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1892 $self->pre_load;
1351 if delete $self->{load_original};
1352
1353 if (my $uniq = $self->uniq_path) {
1354 utf8::encode $uniq;
1355 if (aio_open $uniq, O_RDONLY, 0) {
1356 $self->clear_unique_items;
1357 $self->_load_objects ($uniq, 0);
1358 }
1359 }
1360
1361 Coro::cede;
1362
1363 # now do the right thing for maps
1364 $self->link_multipart_objects;
1365
1366 unless ($self->{deny_activate}) {
1367 $self->decay_objects;
1368 $self->fix_auto_apply;
1369 $self->update_buttons;
1370 Coro::cede; 1893 Coro::cede;
1371 $self->set_darkness_map; 1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
1906 }
1907 }
1908
1909 Coro::cede;
1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1372 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1373 unless $self->difficulty; 1913 unless $self->difficulty;
1374 Coro::cede; 1914 Coro::cede;
1915
1916 unless ($self->{deny_activate}) {
1917 $self->decay_objects;
1918 $self->fix_auto_apply;
1919 $self->update_buttons;
1920 Coro::cede;
1921 $self->set_darkness_map;
1922 Coro::cede;
1375 $self->activate; 1923 $self->activate;
1376 } 1924 }
1377 1925
1378 $self->in_memory (cf::MAP_IN_MEMORY); 1926 $self->in_memory (cf::MAP_IN_MEMORY);
1927 }
1928
1929 $self->post_load;
1379} 1930}
1380 1931
1381sub customise_for { 1932sub customise_for {
1382 my ($self, $ob) = @_; 1933 my ($self, $ob) = @_;
1383 1934
1384 return find "~" . $ob->name . "/" . $self->{path} 1935 return find "~" . $ob->name . "/" . $self->{path}
1385 if $self->per_player; 1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1386 1940
1387 $self 1941 $self
1388} 1942}
1389 1943
1390# find and load all maps in the 3x3 area around a map 1944# find and load all maps in the 3x3 area around a map
1422 1976
1423 cf::sync_job { $map->load }; 1977 cf::sync_job { $map->load };
1424} 1978}
1425 1979
1426our %MAP_PREFETCH; 1980our %MAP_PREFETCH;
1427our $MAP_PREFETCHER = Coro::async { 1981our $MAP_PREFETCHER = undef;
1428 while () {
1429 for my $path (keys %MAP_PREFETCH) {
1430 my $map = find $path
1431 or next;
1432 $map->load;
1433
1434 delete $MAP_PREFETCH{$path};
1435 }
1436 Coro::schedule;
1437 }
1438};
1439 1982
1440sub find_async { 1983sub find_async {
1441 my ($path, $origin) = @_; 1984 my ($path, $origin) = @_;
1442 1985
1443 $path = normalise $path, $origin && $origin->{path}; 1986 $path = normalise $path, $origin && $origin->{path};
1444 1987
1445 if (my $map = $cf::MAP{$path}) { 1988 if (my $map = $cf::MAP{$path}) {
1446 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1989 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1447 } 1990 }
1448 1991
1449 $MAP_PREFETCH{$path} = 0; 1992 undef $MAP_PREFETCH{$path};
1993 $MAP_PREFETCHER ||= cf::async {
1994 while (%MAP_PREFETCH) {
1995 for my $path (keys %MAP_PREFETCH) {
1996 if (my $map = find $path) {
1997 $map->load;
1998 }
1999
2000 delete $MAP_PREFETCH{$path};
2001 }
2002 }
2003 undef $MAP_PREFETCHER;
2004 };
1450 $MAP_PREFETCHER->ready; 2005 $MAP_PREFETCHER->prio (6);
1451 2006
1452 () 2007 ()
1453} 2008}
1454 2009
1455sub save { 2010sub save {
1500 2055
1501sub reset_at { 2056sub reset_at {
1502 my ($self) = @_; 2057 my ($self) = @_;
1503 2058
1504 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1505 return 1e99 if $self->isa ("ext::map_per_player");#d#
1506 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1507 2061
1508 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1509 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1510 2064
1515 my ($self) = @_; 2069 my ($self) = @_;
1516 2070
1517 $self->reset_at <= $cf::RUNTIME 2071 $self->reset_at <= $cf::RUNTIME
1518} 2072}
1519 2073
1520sub rename {
1521 my ($self, $new_path) = @_;
1522
1523 normalise $new_path;
1524
1525 $self->unlink_save;
1526
1527 delete $cf::MAP{$self->path};
1528 $self->{path} = $new_path; $self->path ($self->{path});
1529 $cf::MAP{$self->path} = $self;
1530
1531 $self->save;
1532}
1533
1534sub reset { 2074sub reset {
1535 my ($self) = @_; 2075 my ($self) = @_;
1536 2076
1537 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1538 2078
1539 return if $self->players; 2079 return if $self->players;
1540 return if $self->isa ("ext::map_per_player");#d#
1541 2080
1542 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
2082
2083 $self->in_memory (cf::MAP_SWAPPED);
2084
2085 # need to save uniques path
2086 unless ($self->{deny_save}) {
2087 my $uniq = $self->uniq_path; utf8::encode $uniq;
2088
2089 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2090 if $uniq;
2091 }
1543 2092
1544 delete $cf::MAP{$self->path}; 2093 delete $cf::MAP{$self->path};
1545 2094
1546 $self->in_memory (cf::MAP_SWAPPED);
1547 $self->clear; 2095 $self->clear;
1548 2096
1549 $_->clear_links_to ($self) for values %cf::MAP; 2097 $_->clear_links_to ($self) for values %cf::MAP;
1550 2098
1551 $self->unlink_save; 2099 $self->unlink_save;
1555my $nuke_counter = "aaaa"; 2103my $nuke_counter = "aaaa";
1556 2104
1557sub nuke { 2105sub nuke {
1558 my ($self) = @_; 2106 my ($self) = @_;
1559 2107
2108 delete $cf::MAP{$self->path};
2109
2110 $self->unlink_save;
2111
2112 bless $self, "cf::map";
2113 delete $self->{deny_reset};
1560 $self->{deny_save} = 1; 2114 $self->{deny_save} = 1;
1561 $self->reset_timeout (1); 2115 $self->reset_timeout (1);
1562 $self->rename ("{nuke}/" . ($nuke_counter++)); 2116 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2117
2118 $cf::MAP{$self->path} = $self;
2119
1563 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
2121}
2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
1564} 2157}
1565 2158
1566=item cf::map::unique_maps 2159=item cf::map::unique_maps
1567 2160
1568Returns an arrayref of paths of all shared maps that have 2161Returns an arrayref of paths of all shared maps that have
1569instantiated unique items. May block. 2162instantiated unique items. May block.
1570 2163
1571=cut 2164=cut
1572 2165
1573sub unique_maps() { 2166sub unique_maps() {
1574 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2167 [
1575 or return; 2168 map {
1576
1577 my @paths;
1578
1579 for (@$files) {
1580 utf8::decode $_; 2169 utf8::decode $_;
1581 next if /\.pst$/;
1582 next unless /^$PATH_SEP/o;
1583
1584 s/\.map$//; 2170 /\.map$/
1585 push @paths, $_; 2171 ? normalise $_
2172 : ()
2173 } @{ aio_readdir $UNIQUEDIR or [] }
1586 } 2174 ]
1587
1588 \@paths
1589} 2175}
1590 2176
1591package cf; 2177package cf;
1592 2178
1593=back 2179=back
1639 2225
1640 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1641 2227
1642 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1643 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1644 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1645 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1646 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1647 } 2242 }
1648} 2243}
1649 2244
1650=item $player_object->may ("access") 2245=item $player_object->may ("access")
1651 2246
1684=cut 2279=cut
1685 2280
1686sub link_map { 2281sub link_map {
1687 unless ($LINK_MAP) { 2282 unless ($LINK_MAP) {
1688 $LINK_MAP = cf::map::find "{link}" 2283 $LINK_MAP = cf::map::find "{link}"
1689 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2284 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1690 $LINK_MAP->load; 2285 $LINK_MAP->load;
1691 } 2286 }
1692 2287
1693 $LINK_MAP 2288 $LINK_MAP
1694} 2289}
1699 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1700 2295
1701 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1702 2297
1703 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1704 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1705 2300
1706 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1707} 2302}
1708 2303
1709sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1710 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1711 2308
1712 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1713 2310
1714 unless ($map) { 2311 unless ($map) {
1715 # restore original map position 2312 # restore original map position
1733 $map->load; 2330 $map->load;
1734 $map->load_diag; 2331 $map->load_diag;
1735 2332
1736 return unless $self->contr->active; 2333 return unless $self->contr->active;
1737 $self->activate_recursive; 2334 $self->activate_recursive;
2335
2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1738 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1739} 2338}
1740 2339
1741cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1742 on_logout => sub {
1743 my ($pl) = @_;
1744 2341
1745 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1746 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1747 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1748 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1749 }; 2346be called at the end of this process.
1750 }
1751 },
1752 on_login => sub {
1753 my ($pl) = @_;
1754 2347
1755 # try to abort aborted map switching on player login :)
1756 # should happen only on crashes
1757 if ($pl->ob->{_link_pos}) {
1758 $pl->ob->enter_link;
1759 (async {
1760 # we need this sleep as the login has a concurrent enter_exit running
1761 # and this sleep increases chances of the player not ending up in scorn
1762 $pl->ob->reply (undef,
1763 "There was an internal problem at your last logout, "
1764 . "the server will try to bring you to your intended destination in a second.",
1765 cf::NDI_RED);
1766 Coro::Timer::sleep 1;
1767 $pl->ob->leave_link;
1768 })->prio (2);
1769 }
1770 },
1771);
1772
1773=item $player_object->goto ($path, $x, $y)
1774
1775=cut 2348=cut
2349
2350our $GOTOGEN;
1776 2351
1777sub cf::object::player::goto { 2352sub cf::object::player::goto {
1778 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1779 2357
1780 $self->enter_link; 2358 $self->enter_link;
1781 2359
1782 (async { 2360 (async {
2361 my $map = eval {
1783 my $map = cf::map::find $path; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1784 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
1785 2366 $map = $check->($map) if $check && $map;
1786# warn "entering ", $map->path, " at ($x, $y)\n" 2367 } else {
1787# if $map;
1788
1789 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
1790 2370
2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
2377 }
2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1791 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1792 })->prio (1); 2385 })->prio (1);
1793} 2386}
1794 2387
1795=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1796 2389
1798 2391
1799sub parse_random_map_params { 2392sub parse_random_map_params {
1800 my ($spec) = @_; 2393 my ($spec) = @_;
1801 2394
1802 my $rmp = { # defaults 2395 my $rmp = { # defaults
1803 xsize => 10, 2396 xsize => (cf::rndm 15, 40),
1804 ysize => 10, 2397 ysize => (cf::rndm 15, 40),
2398 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2399 #layout => string,
1805 }; 2400 };
1806 2401
1807 for (split /\n/, $spec) { 2402 for (split /\n/, $spec) {
1808 my ($k, $v) = split /\s+/, $_, 2; 2403 my ($k, $v) = split /\s+/, $_, 2;
1809 2404
1813 $rmp 2408 $rmp
1814} 2409}
1815 2410
1816sub prepare_random_map { 2411sub prepare_random_map {
1817 my ($exit) = @_; 2412 my ($exit) = @_;
2413
2414 my $guard = cf::lock_acquire "exit_prepare:$exit";
1818 2415
1819 # all this does is basically replace the /! path by 2416 # all this does is basically replace the /! path by
1820 # a new random map path (?random/...) with a seed 2417 # a new random map path (?random/...) with a seed
1821 # that depends on the exit object 2418 # that depends on the exit object
1822 2419
1823 my $rmp = parse_random_map_params $exit->msg; 2420 my $rmp = parse_random_map_params $exit->msg;
1824 2421
1825 if ($exit->map) { 2422 if ($exit->map) {
1826 $rmp->{region} = $exit->map->region_name; 2423 $rmp->{region} = $exit->region->name;
1827 $rmp->{origin_map} = $exit->map->path; 2424 $rmp->{origin_map} = $exit->map->path;
1828 $rmp->{origin_x} = $exit->x; 2425 $rmp->{origin_x} = $exit->x;
1829 $rmp->{origin_y} = $exit->y; 2426 $rmp->{origin_y} = $exit->y;
1830 } 2427 }
1831 2428
1832 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1833 2430
1834 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1835 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
2433 my $meta = "$RANDOMDIR/$md5.meta";
1836 2434
1837 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1838 aio_write $fh, 0, (length $data), $data, 0; 2436 aio_write $fh, 0, (length $data), $data, 0;
2437 undef $fh;
2438 aio_rename "$meta~", $meta;
1839 2439
1840 $exit->slaying ("?random/$md5"); 2440 $exit->slaying ("?random/$md5");
1841 $exit->msg (undef); 2441 $exit->msg (undef);
1842 } 2442 }
1843} 2443}
1845sub cf::object::player::enter_exit { 2445sub cf::object::player::enter_exit {
1846 my ($self, $exit) = @_; 2446 my ($self, $exit) = @_;
1847 2447
1848 return unless $self->type == cf::PLAYER; 2448 return unless $self->type == cf::PLAYER;
1849 2449
2450 if ($exit->slaying eq "/!") {
2451 #TODO: this should de-fi-ni-te-ly not be a sync-job
2452 # the problem is that $exit might not survive long enough
2453 # so it needs to be done right now, right here
2454 cf::sync_job { prepare_random_map $exit };
2455 }
2456
2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2458 my $hp = $exit->stats->hp;
2459 my $sp = $exit->stats->sp;
2460
1850 $self->enter_link; 2461 $self->enter_link;
2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
1851 2466
1852 (async { 2467 (async {
1853 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1854 unless (eval { 2469 unless (eval {
1855 prepare_random_map $exit 2470 $self->goto ($slaying, $hp, $sp);
1856 if $exit->slaying eq "/!";
1857
1858 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1859 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1860 2471
1861 1; 2472 1;
1862 }) { 2473 }) {
1863 $self->message ("Something went wrong deep within the crossfire server. " 2474 $self->message ("Something went wrong deep within the crossfire server. "
1864 . "I'll try to bring you back to the map you were before. " 2475 . "I'll try to bring you back to the map you were before. "
1865 . "Please report this to the dungeon master!", 2476 . "Please report this to the dungeon master!",
1866 cf::NDI_UNIQUE | cf::NDI_RED); 2477 cf::NDI_UNIQUE | cf::NDI_RED);
1867 2478
1868 warn "ERROR in enter_exit: $@"; 2479 warn "ERROR in enter_exit: $@";
1869 $self->leave_link; 2480 $self->leave_link;
1870 } 2481 }
1871 })->prio (1); 2482 })->prio (1);
1884 2495
1885sub cf::client::send_drawinfo { 2496sub cf::client::send_drawinfo {
1886 my ($self, $text, $flags) = @_; 2497 my ($self, $text, $flags) = @_;
1887 2498
1888 utf8::encode $text; 2499 utf8::encode $text;
1889 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1890} 2501}
1891 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => $channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2569 push @msg, msgtype => "event_$type";
2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2572}
1892 2573
1893=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
1894 2575
1895Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
1896the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1897C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1898 2579
1899Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
1900reliable at some point in the future. 2581become reliable at some point in the future.
1901 2582
1902=cut 2583=cut
1903 2584
1904sub cf::client::query { 2585sub cf::client::query {
1905 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
1913 utf8::encode $text; 2594 utf8::encode $text;
1914 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1915 2596
1916 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
1917 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
1918} 2601}
1919 2602
1920cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
1921 on_reply => sub { 2609 on_reply => sub {
1922 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
1923 2611
1924 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
1925 # get handled first 2613 # get handled first
1926 my $queue = delete $ns->{query_queue} 2614 my $queue = delete $ns->{query_queue}
1927 or return; # be conservative, not sure how that can happen, but we saw a crash here 2615 or return; # be conservative, not sure how that can happen, but we saw a crash here
1928 2616
1929 (shift @$queue)->[1]->($msg); 2617 (shift @$queue)->[1]->($msg);
2618 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1930 2619
1931 push @{ $ns->{query_queue} }, @$queue; 2620 push @{ $ns->{query_queue} }, @$queue;
1932 2621
1933 if (@{ $ns->{query_queue} } == @$queue) { 2622 if (@{ $ns->{query_queue} } == @$queue) {
1934 if (@$queue) { 2623 if (@$queue) {
1936 } else { 2625 } else {
1937 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1938 } 2627 }
1939 } 2628 }
1940 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
1941); 2653);
1942 2654
1943=item $client->async (\&cb) 2655=item $client->async (\&cb)
1944 2656
1945Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
1992 2704
1993# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
1994 2706
1995=pod 2707=pod
1996 2708
1997The following fucntions and emthods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
1998 2710
1999 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
2000 cf::object::player player 2715 cf::object::player
2001 cf::player peaceful 2716 player
2002 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2003 2723
2004=cut 2724=cut
2005 2725
2006for ( 2726for (
2007 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
2008 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2009 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2010 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2011) { 2732) {
2012 no strict 'refs'; 2733 no strict 'refs';
2083=back 2804=back
2084 2805
2085=cut 2806=cut
2086 2807
2087############################################################################# 2808#############################################################################
2809# the server's init and main functions
2088 2810
2089=head2 EXTENSION DATABASE SUPPORT 2811sub load_facedata($) {
2812 my ($path) = @_;
2090 2813
2091Crossfire maintains a very simple database for extension use. It can 2814 warn "loading facedata from $path\n";
2092currently store anything that can be serialised using Storable, which
2093excludes objects.
2094 2815
2095The parameter C<$family> should best start with the name of the extension 2816 my $facedata;
2096using it, it should be unique. 2817 0 < aio_load $path, $facedata
2818 or die "$path: $!";
2097 2819
2098=over 4 2820 $facedata = Coro::Storable::thaw $facedata;
2099 2821
2100=item $hashref = cf::db_get $family 2822 $facedata->{version} == 2
2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
2101 2824
2102Return a hashref for use by the extension C<$family>, which can be
2103modified. After modifications, you have to call C<cf::db_dirty> or
2104C<cf::db_sync>.
2105
2106=item $value = cf::db_get $family => $key
2107
2108Returns a single value from the database
2109
2110=item cf::db_put $family => $hashref
2111
2112Stores the given family hashref into the database. Updates are delayed, if
2113you want the data to be synced to disk immediately, use C<cf::db_sync>.
2114
2115=item cf::db_put $family => $key => $value
2116
2117Stores the given C<$value> in the family hash. Updates are delayed, if you
2118want the data to be synced to disk immediately, use C<cf::db_sync>.
2119
2120=item cf::db_dirty
2121
2122Marks the database as dirty, to be updated at a later time.
2123
2124=item cf::db_sync
2125
2126Immediately write the database to disk I<if it is dirty>.
2127
2128=cut
2129
2130our $DB;
2131
2132{
2133 my $path = cf::localdir . "/database.pst";
2134
2135 sub db_load() {
2136 $DB = stat $path ? Storable::retrieve $path : { };
2137 } 2825 {
2826 my $faces = $facedata->{faceinfo};
2138 2827
2139 my $pid; 2828 while (my ($face, $info) = each %$faces) {
2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2140 2834
2141 sub db_save() { 2835 cf::cede_to_tick;
2142 waitpid $pid, 0 if $pid;
2143 if (0 == ($pid = fork)) {
2144 $DB->{_meta}{version} = 1;
2145 Storable::nstore $DB, "$path~";
2146 rename "$path~", $path;
2147 cf::_exit 0 if defined $pid;
2148 }
2149 }
2150
2151 my $dirty;
2152
2153 sub db_sync() {
2154 db_save if $dirty;
2155 undef $dirty;
2156 }
2157
2158 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2159 db_sync;
2160 });
2161
2162 sub db_dirty() {
2163 $dirty = 1;
2164 $idle->start;
2165 }
2166
2167 sub db_get($;$) {
2168 @_ >= 2
2169 ? $DB->{$_[0]}{$_[1]}
2170 : ($DB->{$_[0]} ||= { })
2171 }
2172
2173 sub db_put($$;$) {
2174 if (@_ >= 3) {
2175 $DB->{$_[0]}{$_[1]} = $_[2];
2176 } else {
2177 $DB->{$_[0]} = $_[1];
2178 }
2179 db_dirty;
2180 }
2181
2182 cf::global->attach (
2183 prio => 10000,
2184 on_cleanup => sub {
2185 db_sync;
2186 }, 2836 }
2187 );
2188}
2189 2837
2190############################################################################# 2838 while (my ($face, $info) = each %$faces) {
2191# the server's main() 2839 next unless $info->{smooth};
2840 my $idx = cf::face::find $face
2841 or next;
2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2845 } else {
2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2847 }
2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 if (my $soundconf = delete $res->{"res/sound.conf"}) {
2871 $soundconf = $enc->decode (delete $soundconf->{data});
2872 # todo
2873 }
2874
2875 while (my ($name, $info) = each %$res) {
2876 my $meta = $enc->encode ({
2877 name => $name,
2878 %{ $info->{meta} || {} },
2879 });
2880
2881 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2882
2883 if ($info->{type} & 1) {
2884 # prepend meta info
2885
2886 my $data = pack "(w/a*)*", $meta, $info->{data};
2887 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2888
2889 cf::face::set_data $idx, 0, $data, $chk;
2890 } else {
2891 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2892 }
2893
2894 cf::face::set_type $idx, $info->{type};
2895
2896 cf::cede_to_tick;
2897 }
2898 }
2899
2900 1
2901}
2902
2903register_exticmd fx_want => sub {
2904 my ($ns, $want) = @_;
2905
2906 while (my ($k, $v) = each %$want) {
2907 $ns->fx_want ($k, $v);
2908 }
2909};
2910
2911sub reload_regions {
2912 load_resource_file "$MAPDIR/regions"
2913 or die "unable to load regions file\n";
2914
2915 for (cf::region::list) {
2916 $_->{match} = qr/$_->{match}/
2917 if exists $_->{match};
2918 }
2919}
2920
2921sub reload_facedata {
2922 load_facedata "$DATADIR/facedata"
2923 or die "unable to load facedata\n";
2924}
2925
2926sub reload_archetypes {
2927 load_resource_file "$DATADIR/archetypes"
2928 or die "unable to load archetypes\n";
2929 #d# NEED to laod twice to resolve forward references
2930 # this really needs to be done in an extra post-pass
2931 # (which needs to be synchronous, so solve it differently)
2932 load_resource_file "$DATADIR/archetypes"
2933 or die "unable to load archetypes\n";
2934}
2935
2936sub reload_treasures {
2937 load_resource_file "$DATADIR/treasures"
2938 or die "unable to load treasurelists\n";
2939}
2940
2941sub reload_resources {
2942 warn "reloading resource files...\n";
2943
2944 reload_regions;
2945 reload_facedata;
2946 #reload_archetypes;#d#
2947 reload_archetypes;
2948 reload_treasures;
2949
2950 warn "finished reloading resource files\n";
2951}
2952
2953sub init {
2954 reload_resources;
2955}
2192 2956
2193sub cfg_load { 2957sub cfg_load {
2194 open my $fh, "<:utf8", cf::confdir . "/config" 2958 open my $fh, "<:utf8", "$CONFDIR/config"
2195 or return; 2959 or return;
2196 2960
2197 local $/; 2961 local $/;
2198 *CFG = YAML::Syck::Load <$fh>; 2962 *CFG = YAML::Syck::Load <$fh>;
2199 2963
2213 2977
2214sub main { 2978sub main {
2215 # we must not ever block the main coroutine 2979 # we must not ever block the main coroutine
2216 local $Coro::idle = sub { 2980 local $Coro::idle = sub {
2217 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2981 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2982 (async {
2218 async { Event::one_event }; 2983 Event::one_event;
2984 })->prio (Coro::PRIO_MAX);
2219 }; 2985 };
2220 2986
2221 cfg_load; 2987 cfg_load;
2222 db_load; 2988 db_init;
2223 load_extensions; 2989 load_extensions;
2990
2991 $TICK_WATCHER->start;
2224 Event::loop; 2992 Event::loop;
2225} 2993}
2226 2994
2227############################################################################# 2995#############################################################################
2228# initialisation and cleanup 2996# initialisation and cleanup
2229 2997
2230# install some emergency cleanup handlers 2998# install some emergency cleanup handlers
2231BEGIN { 2999BEGIN {
2232 for my $signal (qw(INT HUP TERM)) { 3000 for my $signal (qw(INT HUP TERM)) {
2233 Event->signal ( 3001 Event->signal (
3002 reentrant => 0,
2234 data => WF_AUTOCANCEL, 3003 data => WF_AUTOCANCEL,
2235 signal => $signal, 3004 signal => $signal,
3005 prio => 0,
2236 cb => sub { 3006 cb => sub {
2237 cf::cleanup "SIG$signal"; 3007 cf::cleanup "SIG$signal";
2238 }, 3008 },
2239 ); 3009 );
2240 } 3010 }
3011}
3012
3013sub write_runtime {
3014 my $runtime = "$LOCALDIR/runtime";
3015
3016 # first touch the runtime file to show we are still running:
3017 # the fsync below can take a very very long time.
3018
3019 IO::AIO::aio_utime $runtime, undef, undef;
3020
3021 my $guard = cf::lock_acquire "write_runtime";
3022
3023 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3024 or return;
3025
3026 my $value = $cf::RUNTIME + 90 + 10;
3027 # 10 is the runtime save interval, for a monotonic clock
3028 # 60 allows for the watchdog to kill the server.
3029
3030 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3031 and return;
3032
3033 # always fsync - this file is important
3034 aio_fsync $fh
3035 and return;
3036
3037 # touch it again to show we are up-to-date
3038 aio_utime $fh, undef, undef;
3039
3040 close $fh
3041 or return;
3042
3043 aio_rename "$runtime~", $runtime
3044 and return;
3045
3046 warn "runtime file written.\n";
3047
3048 1
2241} 3049}
2242 3050
2243sub emergency_save() { 3051sub emergency_save() {
2244 my $freeze_guard = cf::freeze_mainloop; 3052 my $freeze_guard = cf::freeze_mainloop;
2245 3053
2262 my $map = $cf::MAP{$path} or next; 3070 my $map = $cf::MAP{$path} or next;
2263 $map->valid or next; 3071 $map->valid or next;
2264 $map->save; 3072 $map->save;
2265 } 3073 }
2266 warn "end emergency map save\n"; 3074 warn "end emergency map save\n";
3075
3076 warn "begin emergency database checkpoint\n";
3077 BDB::db_env_txn_checkpoint $DB_ENV;
3078 warn "end emergency database checkpoint\n";
2267 }; 3079 };
2268 3080
2269 warn "leave emergency perl save\n"; 3081 warn "leave emergency perl save\n";
2270} 3082}
2271 3083
3084sub post_cleanup {
3085 my ($make_core) = @_;
3086
3087 warn Carp::longmess "post_cleanup backtrace"
3088 if $make_core;
3089}
3090
2272sub reload() { 3091sub do_reload_perl() {
2273 # can/must only be called in main 3092 # can/must only be called in main
2274 if ($Coro::current != $Coro::main) { 3093 if ($Coro::current != $Coro::main) {
2275 warn "can only reload from main coroutine\n"; 3094 warn "can only reload from main coroutine";
2276 return; 3095 return;
2277 } 3096 }
2278 3097
2279 warn "reloading..."; 3098 warn "reloading...";
2280 3099
2281 warn "freezing server"; 3100 warn "entering sync_job";
2282 my $guard = freeze_mainloop; 3101
3102 cf::sync_job {
3103 cf::write_runtime; # external watchdog should not bark
2283 cf::emergency_save; 3104 cf::emergency_save;
3105 cf::write_runtime; # external watchdog should not bark
2284 3106
2285 warn "sync database to disk"; 3107 warn "syncing database to disk";
2286 cf::db_sync; 3108 BDB::db_env_txn_checkpoint $DB_ENV;
2287 IO::AIO::flush;
2288 3109
2289 eval {
2290 # if anything goes wrong in here, we should simply crash as we already saved 3110 # if anything goes wrong in here, we should simply crash as we already saved
2291 3111
2292 warn "cancel all watchers"; 3112 warn "cancelling all WF_AUTOCANCEL watchers";
2293 for (Event::all_watchers) { 3113 for (Event::all_watchers) {
2294 $_->cancel if $_->data & WF_AUTOCANCEL; 3114 $_->cancel if $_->data & WF_AUTOCANCEL;
2295 } 3115 }
2296 3116
3117 warn "flushing outstanding aio requests";
3118 for (;;) {
3119 BDB::flush;
3120 IO::AIO::flush;
3121 Coro::cede;
3122 last unless IO::AIO::nreqs || BDB::nreqs;
3123 warn "iterate...";
3124 }
3125
3126 ++$RELOAD;
3127
2297 warn "cancel all extension coros"; 3128 warn "cancelling all extension coros";
2298 $_->cancel for values %EXT_CORO; 3129 $_->cancel for values %EXT_CORO;
2299 %EXT_CORO = (); 3130 %EXT_CORO = ();
2300 3131
2301 warn "remove commands"; 3132 warn "removing commands";
2302 %COMMAND = (); 3133 %COMMAND = ();
2303 3134
2304 warn "remove ext commands"; 3135 warn "removing ext/exti commands";
2305 %EXTCMD = (); 3136 %EXTCMD = ();
3137 %EXTICMD = ();
2306 3138
2307 warn "unload/nuke all extensions"; 3139 warn "unloading/nuking all extensions";
2308 for my $pkg (@EXTS) { 3140 for my $pkg (@EXTS) {
2309 warn "... unloading $pkg"; 3141 warn "... unloading $pkg";
2310 3142
2311 if (my $cb = $pkg->can ("unload")) { 3143 if (my $cb = $pkg->can ("unload")) {
2312 eval { 3144 eval {
2317 3149
2318 warn "... nuking $pkg"; 3150 warn "... nuking $pkg";
2319 Symbol::delete_package $pkg; 3151 Symbol::delete_package $pkg;
2320 } 3152 }
2321 3153
2322 warn "unload all perl modules loaded from $LIBDIR"; 3154 warn "unloading all perl modules loaded from $LIBDIR";
2323 while (my ($k, $v) = each %INC) { 3155 while (my ($k, $v) = each %INC) {
2324 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3156 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2325 3157
2326 warn "removing <$k>"; 3158 warn "... unloading $k";
2327 delete $INC{$k}; 3159 delete $INC{$k};
2328 3160
2329 $k =~ s/\.pm$//; 3161 $k =~ s/\.pm$//;
2330 $k =~ s/\//::/g; 3162 $k =~ s/\//::/g;
2331 3163
2334 } 3166 }
2335 3167
2336 Symbol::delete_package $k; 3168 Symbol::delete_package $k;
2337 } 3169 }
2338 3170
2339 warn "get rid of safe::, as good as possible"; 3171 warn "getting rid of safe::, as good as possible";
2340 Symbol::delete_package "safe::$_" 3172 Symbol::delete_package "safe::$_"
2341 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3173 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2342 3174
2343 warn "unload cf.pm \"a bit\""; 3175 warn "unloading cf.pm \"a bit\"";
2344 delete $INC{"cf.pm"}; 3176 delete $INC{"cf.pm"};
3177 delete $INC{"cf/pod.pm"};
2345 3178
2346 # don't, removes xs symbols, too, 3179 # don't, removes xs symbols, too,
2347 # and global variables created in xs 3180 # and global variables created in xs
2348 #Symbol::delete_package __PACKAGE__; 3181 #Symbol::delete_package __PACKAGE__;
2349 3182
3183 warn "unload completed, starting to reload now";
3184
2350 warn "reloading cf.pm"; 3185 warn "reloading cf.pm";
2351 require cf; 3186 require cf;
2352 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3187 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2353 3188
2354 warn "load config and database again"; 3189 warn "loading config and database again";
2355 cf::cfg_load; 3190 cf::cfg_load;
2356 cf::db_load;
2357 3191
2358 warn "load extensions"; 3192 warn "loading extensions";
2359 cf::load_extensions; 3193 cf::load_extensions;
2360 3194
2361 warn "reattach attachments to objects/players"; 3195 warn "reattaching attachments to objects/players";
2362 _global_reattach; 3196 _global_reattach; # objects, sockets
2363 warn "reattach attachments to maps"; 3197 warn "reattaching attachments to maps";
2364 reattach $_ for values %MAP; 3198 reattach $_ for values %MAP;
2365 }; 3199 warn "reattaching attachments to players";
3200 reattach $_ for values %PLAYER;
2366 3201
2367 if ($@) { 3202 warn "leaving sync_job";
3203
3204 1
3205 } or do {
2368 warn $@; 3206 warn $@;
2369 warn "error while reloading, exiting."; 3207 warn "error while reloading, exiting.";
2370 exit 1; 3208 exit 1;
2371 } 3209 };
2372 3210
2373 warn "reloaded"; 3211 warn "reloaded";
2374}; 3212};
2375 3213
3214our $RELOAD_WATCHER; # used only during reload
3215
3216sub reload_perl() {
3217 # doing reload synchronously and two reloads happen back-to-back,
3218 # coro crashes during coro_state_free->destroy here.
3219
3220 $RELOAD_WATCHER ||= Event->timer (
3221 reentrant => 0,
3222 after => 0,
3223 data => WF_AUTOCANCEL,
3224 cb => sub {
3225 do_reload_perl;
3226 undef $RELOAD_WATCHER;
3227 },
3228 );
3229}
3230
2376register_command "reload" => sub { 3231register_command "reload" => sub {
2377 my ($who, $arg) = @_; 3232 my ($who, $arg) = @_;
2378 3233
2379 if ($who->flag (FLAG_WIZ)) { 3234 if ($who->flag (FLAG_WIZ)) {
2380 $who->message ("start of reload.");
2381 reload;
2382 $who->message ("end of reload."); 3235 $who->message ("reloading server.");
3236 async { reload_perl };
2383 } 3237 }
2384}; 3238};
2385 3239
2386unshift @INC, $LIBDIR; 3240unshift @INC, $LIBDIR;
2387 3241
3242my $bug_warning = 0;
3243
3244our @WAIT_FOR_TICK;
3245our @WAIT_FOR_TICK_BEGIN;
3246
3247sub wait_for_tick {
3248 return unless $TICK_WATCHER->is_active;
3249 return if $Coro::current == $Coro::main;
3250
3251 my $signal = new Coro::Signal;
3252 push @WAIT_FOR_TICK, $signal;
3253 $signal->wait;
3254}
3255
3256sub wait_for_tick_begin {
3257 return unless $TICK_WATCHER->is_active;
3258 return if $Coro::current == $Coro::main;
3259
3260 my $signal = new Coro::Signal;
3261 push @WAIT_FOR_TICK_BEGIN, $signal;
3262 $signal->wait;
3263}
3264
3265 my $min = 1e6;#d#
3266 my $avg = 10;
2388$TICK_WATCHER = Event->timer ( 3267$TICK_WATCHER = Event->timer (
2389 reentrant => 0, 3268 reentrant => 0,
3269 parked => 1,
2390 prio => 0, 3270 prio => 0,
2391 at => $NEXT_TICK || $TICK, 3271 at => $NEXT_TICK || $TICK,
2392 data => WF_AUTOCANCEL, 3272 data => WF_AUTOCANCEL,
2393 cb => sub { 3273 cb => sub {
3274 if ($Coro::current != $Coro::main) {
3275 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3276 unless ++$bug_warning > 10;
3277 return;
3278 }
3279
2394 $NOW = Event::time; 3280 $NOW = $tick_start = Event::time;
2395 3281
2396 cf::server_tick; # one server iteration 3282 cf::server_tick; # one server iteration
3283
3284 0 && sync_job {#d#
3285 for(1..10) {
3286 my $t = Event::time;
3287 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3288 or die;
3289
3290 $map->width (50);
3291 $map->height (50);
3292 $map->alloc;
3293 $map->_load_objects ("/tmp/x.map", 1);
3294 my $t = Event::time - $t;
3295
3296 #next unless $t < 0.0013;#d#
3297 if ($t < $min) {
3298 $min = $t;
3299 }
3300 $avg = $avg * 0.99 + $t * 0.01;
3301 }
3302 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3303 exit 0;
3304 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3305 };
3306
2397 $RUNTIME += $TICK; 3307 $RUNTIME += $TICK;
2398 $NEXT_TICK += $TICK; 3308 $NEXT_TICK += $TICK;
2399 3309
2400 $WAIT_FOR_TICK->broadcast; 3310 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2401 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3311 $NEXT_RUNTIME_WRITE = $NOW + 10;
3312 Coro::async_pool {
3313 write_runtime
3314 or warn "ERROR: unable to write runtime file: $!";
3315 };
3316 }
3317
3318# my $AFTER = Event::time;
3319# warn $AFTER - $NOW;#d#
3320
3321 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3322 $sig->send;
3323 }
3324 while (my $sig = shift @WAIT_FOR_TICK) {
3325 $sig->send;
3326 }
3327
3328 $NOW = Event::time;
2402 3329
2403 # if we are delayed by four ticks or more, skip them all 3330 # if we are delayed by four ticks or more, skip them all
2404 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3331 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2405 3332
2406 $TICK_WATCHER->at ($NEXT_TICK); 3333 $TICK_WATCHER->at ($NEXT_TICK);
2407 $TICK_WATCHER->start; 3334 $TICK_WATCHER->start;
3335
3336 $LOAD = ($NOW - $tick_start) / $TICK;
3337 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3338
3339 _post_tick;
3340
3341
2408 }, 3342 },
2409); 3343);
2410 3344
3345{
3346 BDB::max_poll_time $TICK * 0.1;
3347 $BDB_POLL_WATCHER = Event->io (
3348 reentrant => 0,
3349 fd => BDB::poll_fileno,
3350 poll => 'r',
3351 prio => 0,
3352 data => WF_AUTOCANCEL,
3353 cb => \&BDB::poll_cb,
3354 );
3355 BDB::min_parallel 8;
3356
3357 BDB::set_sync_prepare {
3358 my $status;
3359 my $current = $Coro::current;
3360 (
3361 sub {
3362 $status = $!;
3363 $current->ready; undef $current;
3364 },
3365 sub {
3366 Coro::schedule while defined $current;
3367 $! = $status;
3368 },
3369 )
3370 };
3371
3372 unless ($DB_ENV) {
3373 $DB_ENV = BDB::db_env_create;
3374
3375 cf::sync_job {
3376 eval {
3377 BDB::db_env_open
3378 $DB_ENV,
3379 $BDBDIR,
3380 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3381 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3382 0666;
3383
3384 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3385
3386 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3387 $DB_ENV->set_lk_detect;
3388 };
3389
3390 cf::cleanup "db_env_open(db): $@" if $@;
3391 };
3392 }
3393}
3394
3395{
3396 IO::AIO::min_parallel 8;
3397
3398 undef $Coro::AIO::WATCHER;
2411IO::AIO::max_poll_time $TICK * 0.2; 3399 IO::AIO::max_poll_time $TICK * 0.1;
2412
2413$AIO_POLL_WATCHER = Event->io ( 3400 $AIO_POLL_WATCHER = Event->io (
2414 fd => IO::AIO::poll_fileno, 3401 reentrant => 0,
2415 poll => 'r',
2416 prio => 5,
2417 data => WF_AUTOCANCEL,
2418 cb => \&IO::AIO::poll_cb,
2419);
2420
2421$WRITE_RUNTIME_WATCHER = Event->timer (
2422 data => WF_AUTOCANCEL, 3402 data => WF_AUTOCANCEL,
2423 after => 0, 3403 fd => IO::AIO::poll_fileno,
2424 interval => 10, 3404 poll => 'r',
2425 cb => sub { 3405 prio => 6,
2426 (Coro::unblock_sub { 3406 cb => \&IO::AIO::poll_cb,
2427 write_runtime 3407 );
2428 or warn "ERROR: unable to write runtime file: $!"; 3408}
3409
3410my $_log_backtrace;
3411
3412sub _log_backtrace {
3413 my ($msg, @addr) = @_;
3414
3415 $msg =~ s/\n//;
3416
3417 # limit the # of concurrent backtraces
3418 if ($_log_backtrace < 2) {
3419 ++$_log_backtrace;
3420 async {
3421 my @bt = fork_call {
3422 @addr = map { sprintf "%x", $_ } @addr;
3423 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3424 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3425 or die "addr2line: $!";
3426
3427 my @funcs;
3428 my @res = <$fh>;
3429 chomp for @res;
3430 while (@res) {
3431 my ($func, $line) = splice @res, 0, 2, ();
3432 push @funcs, "[$func] $line";
3433 }
3434
3435 @funcs
3436 };
3437
3438 LOG llevInfo, "[ABT] $msg\n";
3439 LOG llevInfo, "[ABT] $_\n" for @bt;
3440 --$_log_backtrace;
2429 })->(); 3441 };
3442 } else {
3443 LOG llevInfo, "[ABT] $msg\n";
3444 LOG llevInfo, "[ABT] [suppressed]\n";
2430 }, 3445 }
2431); 3446}
3447
3448# load additional modules
3449use cf::pod;
2432 3450
2433END { cf::emergency_save } 3451END { cf::emergency_save }
2434 3452
24351 34531
2436 3454

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines