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.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 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 BDB ();
26use Data::Dumper;
20use Digest::MD5; 27use Digest::MD5;
21use Fcntl; 28use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
24use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
25 33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
27 41
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
30 44
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 46
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 48
35our %COMMAND = (); 49our %COMMAND = ();
36our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
38 56
57our $RELOAD; # number of reloads so far
39our @EVENT; 58our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 59
42our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 76our $NEXT_TICK;
45our $NOW; 77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
46 82
47our %CFG; 83our %CFG;
48 84
49our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 86our $RUNTIME;
51 87
88our %PLAYER; # all users
52our %MAP; # all maps 89our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 90our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE; 91
55our $RANDOM_MAPS = cf::localdir . "/random"; 92# used to convert map paths into valid unix filenames by replacing / by ∕
56our %EXT_CORO; 93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
57 98
58binmode STDOUT; 99binmode STDOUT;
59binmode STDERR; 100binmode STDERR;
60 101
61# read virtual server time, if available 102# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
66} 107}
67 108
68mkdir cf::localdir; 109mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 111
74# a special map that is always available
75our $LINK_MAP;
76our $EMERGENCY_POSITION; 112our $EMERGENCY_POSITION;
113
114sub cf::map::normalise;
77 115
78############################################################################# 116#############################################################################
79 117
80=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
81 119
88=item $cf::RUNTIME 126=item $cf::RUNTIME
89 127
90The time this server has run, starts at 0 and is increased by $cf::TICK on 128The time this server has run, starts at 0 and is increased by $cf::TICK on
91every server tick. 129every server tick.
92 130
93=item $cf::LIBDIR 131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
94 134
95The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
96be found. It will be added to C<@INC> automatically. 136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
97 139
98=item $cf::NOW 140=item $cf::NOW
99 141
100The time of the last (current) server tick. 142The time of the last (current) server tick.
101 143
102=item $cf::TICK 144=item $cf::TICK
103 145
104The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
105 157
106=item %cf::CFG 158=item %cf::CFG
107 159
108Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
109from wherever your confdir points to. 161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
110 168
111=back 169=back
112 170
113=cut 171=cut
114 172
115BEGIN { 173BEGIN {
116 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
117 my $msg = join "", @_; 175 my $msg = join "", @_;
118 utf8::encode $msg;
119 176
120 $msg .= "\n" 177 $msg .= "\n"
121 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
122 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
123 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
124 }; 184 };
125} 185}
126 186
127@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
129@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
130@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
131@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
132@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 193@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
133 194
134# we bless all objects into (empty) derived classes to force a method lookup 195# we bless all objects into (empty) derived classes to force a method lookup
135# within the Safe compartment. 196# within the Safe compartment.
136for my $pkg (qw( 197for my $pkg (qw(
137 cf::global cf::attachable 198 cf::global cf::attachable
146 207
147$Event::DIED = sub { 208$Event::DIED = sub {
148 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
149}; 210};
150 211
151my %ext_pkg; 212#############################################################################
152my @exts;
153my @hook;
154 213
155=head2 UTILITY FUNCTIONS 214=head2 UTILITY FUNCTIONS
156 215
157=over 4 216=over 4
158 217
159=cut 218=item dumpval $ref
160 219
220=cut
221
222sub dumpval {
223 eval {
224 local $SIG{__DIE__};
225 my $d;
226 if (1) {
227 $d = new Data::Dumper([$_[0]], ["*var"]);
228 $d->Terse(1);
229 $d->Indent(2);
230 $d->Quotekeys(0);
231 $d->Useqq(1);
232 #$d->Bless(...);
233 $d->Seen($_[1]) if @_ > 1;
234 $d = $d->Dump();
235 }
236 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
237 $d
238 } || "[unable to dump $_[0]: '$@']";
239}
240
161use JSON::Syck (); # TODO# replace by JSON::PC once working 241use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
162 242
163=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
164 244
165Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
166 246
167=cut
168
169sub from_json($) {
170 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171 JSON::Syck::Load $_[0]
172}
173
174=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
175 248
176Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
177 250
178=cut
179
180sub to_json($) {
181 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
182 JSON::Syck::Dump $_[0]
183}
184
185=item my $guard = cf::guard { BLOCK }
186
187Run the given callback when the guard object gets destroyed (useful for
188coroutine cancellations).
189
190You can call C<< ->cancel >> on the guard object to stop the block from
191being executed.
192
193=cut
194
195sub guard(&) {
196 bless \(my $cb = $_[0]), cf::guard::;
197}
198
199sub cf::guard::cancel {
200 ${$_[0]} = sub { };
201}
202
203sub cf::guard::DESTROY {
204 ${$_[0]}->();
205}
206
207=item cf::lock_wait $string 251=item cf::lock_wait $string
208 252
209Wait until the given lock is available. See cf::lock_acquire. 253Wait until the given lock is available. See cf::lock_acquire.
210 254
211=item my $lock = cf::lock_acquire $string 255=item my $lock = cf::lock_acquire $string
212 256
213Wait until the given lock is available and then acquires it and returns 257Wait until the given lock is available and then acquires it and returns
214a guard object. If the guard object gets destroyed (goes out of scope, 258a Coro::guard object. If the guard object gets destroyed (goes out of scope,
215for example when the coroutine gets canceled), the lock is automatically 259for example when the coroutine gets canceled), the lock is automatically
216returned. 260returned.
217 261
218Lock names should begin with a unique identifier (for example, find_map 262Lock names should begin with a unique identifier (for example, cf::map::find
219uses map_find and load_map uses map_load). 263uses map_find and cf::map::load uses map_load).
264
265=item $locked = cf::lock_active $string
266
267Return true if the lock is currently active, i.e. somebody has locked it.
220 268
221=cut 269=cut
222 270
223our %LOCK; 271our %LOCK;
224 272
238 # wait, to be sure we are not locked 286 # wait, to be sure we are not locked
239 lock_wait $key; 287 lock_wait $key;
240 288
241 $LOCK{$key} = []; 289 $LOCK{$key} = [];
242 290
243 cf::guard { 291 Coro::guard {
244 # wake up all waiters, to be on the safe side 292 # wake up all waiters, to be on the safe side
245 $_->ready for @{ delete $LOCK{$key} }; 293 $_->ready for @{ delete $LOCK{$key} };
246 } 294 }
247} 295}
248 296
297sub lock_active($) {
298 my ($key) = @_;
299
300 ! ! $LOCK{$key}
301}
302
303sub freeze_mainloop {
304 return unless $TICK_WATCHER->is_active;
305
306 my $guard = Coro::guard {
307 $TICK_WATCHER->start;
308 };
309 $TICK_WATCHER->stop;
310 $guard
311}
312
249=item cf::async { BLOCK } 313=item cf::async { BLOCK }
250 314
251Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the 315Currently the same as Coro::async_pool, meaning you cannot use
252error instead of exiting the server in case of a problem. 316C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
317thing you are allowed to do is call C<prio> on it.
253 318
254=cut 319=cut
255 320
256sub async(&) { 321BEGIN { *async = \&Coro::async_pool }
257 my ($cb) = @_;
258
259 Coro::async {
260 eval { $cb->() };
261 warn $@ if $@;
262 }
263}
264 322
265=item cf::sync_job { BLOCK } 323=item cf::sync_job { BLOCK }
266 324
267The design of crossfire+ requires that the main coro ($Coro::main) is 325The design of Crossfire TRT requires that the main coroutine ($Coro::main)
268always able to handle events or runnable, as crossfire+ is only partly 326is always able to handle events or runnable, as Crossfire TRT is only
269reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 327partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
328acceptable.
270 329
271If it must be done, put the blocking parts into C<sync_job>. This will run 330If it must be done, put the blocking parts into C<sync_job>. This will run
272the given BLOCK in another coroutine while waiting for the result. The 331the given BLOCK in another coroutine while waiting for the result. The
273server will be frozen during this time, so the block should either finish 332server will be frozen during this time, so the block should either finish
274fast or be very important. 333fast or be very important.
277 336
278sub sync_job(&) { 337sub sync_job(&) {
279 my ($job) = @_; 338 my ($job) = @_;
280 339
281 if ($Coro::current == $Coro::main) { 340 if ($Coro::current == $Coro::main) {
341 my $time = Event::time;
342
282 # this is the main coro, too bad, we have to block 343 # this is the main coro, too bad, we have to block
283 # till the operation succeeds, freezing the server :/ 344 # till the operation succeeds, freezing the server :/
284 345
285 # TODO: use suspend/resume instead 346 # TODO: use suspend/resume instead
286 # (but this is cancel-safe) 347 # (but this is cancel-safe)
287 local $FREEZE = 1; 348 my $freeze_guard = freeze_mainloop;
288 349
289 my $busy = 1; 350 my $busy = 1;
290 my @res; 351 my @res;
291 352
292 (Coro::async { 353 (async {
293 @res = eval { $job->() }; 354 @res = eval { $job->() };
294 warn $@ if $@; 355 warn $@ if $@;
295 undef $busy; 356 undef $busy;
296 })->prio (Coro::PRIO_MAX); 357 })->prio (Coro::PRIO_MAX);
297 358
298 while ($busy) { 359 while ($busy) {
299 Coro::cede_notself; 360 Coro::cede or Event::one_event;
300 Event::one_event unless Coro::nready;
301 } 361 }
362
363 $time = Event::time - $time;
364
365 LOG llevError | logBacktrace, Carp::longmess "long sync job"
366 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
367
368 $tick_start += $time; # do not account sync jobs to server load
302 369
303 wantarray ? @res : $res[0] 370 wantarray ? @res : $res[0]
304 } else { 371 } else {
305 # we are in another coroutine, how wonderful, everything just works 372 # we are in another coroutine, how wonderful, everything just works
306 373
307 $job->() 374 $job->()
308 } 375 }
309} 376}
310 377
311=item $coro = cf::coro { BLOCK } 378=item $coro = cf::async_ext { BLOCK }
312 379
313Creates and returns a new coro. This coro is automcatially being canceled 380Like async, but this coro is automatically being canceled when the
314when the extension calling this is being unloaded. 381extension calling this is being unloaded.
315 382
316=cut 383=cut
317 384
318sub coro(&) { 385sub async_ext(&) {
319 my $cb = shift; 386 my $cb = shift;
320 387
321 my $coro = &cf::async ($cb); 388 my $coro = &Coro::async ($cb);
322 389
323 $coro->on_destroy (sub { 390 $coro->on_destroy (sub {
324 delete $EXT_CORO{$coro+0}; 391 delete $EXT_CORO{$coro+0};
325 }); 392 });
326 $EXT_CORO{$coro+0} = $coro; 393 $EXT_CORO{$coro+0} = $coro;
327 394
328 $coro 395 $coro
329} 396}
330 397
331sub write_runtime { 398=item fork_call { }, $args
332 my $runtime = cf::localdir . "/runtime";
333 399
334 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 400Executes the given code block with the given arguments in a seperate
335 or return; 401process, returning the results. Everything must be serialisable with
402Coro::Storable. May, of course, block. Note that the executed sub may
403never block itself or use any form of Event handling.
336 404
337 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 405=cut
338 (aio_write $fh, 0, (length $value), $value, 0) <= 0
339 and return;
340 406
341 aio_fsync $fh 407sub fork_call(&@) {
342 and return; 408 my ($cb, @args) = @_;
343 409
410# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
411# or die "socketpair: $!";
412 pipe my $fh1, my $fh2
413 or die "pipe: $!";
414
415 if (my $pid = fork) {
344 close $fh 416 close $fh2;
345 or return;
346 417
347 aio_rename "$runtime~", $runtime 418 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
348 and return; 419 $res = Coro::Storable::thaw $res;
349 420
421 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
422
423 die $$res unless "ARRAY" eq ref $res;
424
425 return wantarray ? @$res : $res->[-1];
426 } else {
427 reset_signals;
428 local $SIG{__WARN__};
429 local $SIG{__DIE__};
430 eval {
431 close $fh1;
432
433 my @res = eval { $cb->(@args) };
434 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
435 };
436
437 warn $@ if $@;
438 _exit 0;
350 1 439 }
440}
441
442=item $value = cf::db_get $family => $key
443
444Returns a single value from the environment database.
445
446=item cf::db_put $family => $key => $value
447
448Stores the given C<$value> in the family. It can currently store binary
449data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
450
451=cut
452
453our $DB;
454
455sub db_init {
456 unless ($DB) {
457 $DB = BDB::db_create $DB_ENV;
458
459 cf::sync_job {
460 eval {
461 $DB->set_flags (BDB::CHKSUM);
462
463 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
464 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
465 cf::cleanup "db_open(db): $!" if $!;
466 };
467 cf::cleanup "db_open(db): $@" if $@;
468 };
469 }
470}
471
472sub db_get($$) {
473 my $key = "$_[0]/$_[1]";
474
475 cf::sync_job {
476 BDB::db_get $DB, undef, $key, my $data;
477
478 $! ? ()
479 : $data
480 }
481}
482
483sub db_put($$$) {
484 BDB::dbreq_pri 4;
485 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
486}
487
488=item cf::cache $id => [$paths...], $processversion => $process
489
490Generic caching function that returns the value of the resource $id,
491caching and regenerating as required.
492
493This function can block.
494
495=cut
496
497sub cache {
498 my ($id, $src, $processversion, $process) = @_;
499
500 my $meta =
501 join "\x00",
502 $processversion,
503 map {
504 aio_stat $_
505 and Carp::croak "$_: $!";
506
507 ($_, (stat _)[7,9])
508 } @$src;
509
510 my $dbmeta = db_get cache => "$id/meta";
511 if ($dbmeta ne $meta) {
512 # changed, we may need to process
513
514 my @data;
515 my $md5;
516
517 for (0 .. $#$src) {
518 0 <= aio_load $src->[$_], $data[$_]
519 or Carp::croak "$src->[$_]: $!";
520 }
521
522 # if processing is expensive, check
523 # checksum first
524 if (1) {
525 $md5 =
526 join "\x00",
527 $processversion,
528 map {
529 Coro::cede;
530 ($src->[$_], Digest::MD5::md5_hex $data[$_])
531 } 0.. $#$src;
532
533
534 my $dbmd5 = db_get cache => "$id/md5";
535 if ($dbmd5 eq $md5) {
536 db_put cache => "$id/meta", $meta;
537
538 return db_get cache => "$id/data";
539 }
540 }
541
542 my $t1 = Time::HiRes::time;
543 my $data = $process->(\@data);
544 my $t2 = Time::HiRes::time;
545
546 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
547
548 db_put cache => "$id/data", $data;
549 db_put cache => "$id/md5" , $md5;
550 db_put cache => "$id/meta", $meta;
551
552 return $data;
553 }
554
555 db_get cache => "$id/data"
556}
557
558=item cf::datalog type => key => value, ...
559
560Log a datalog packet of the given type with the given key-value pairs.
561
562=cut
563
564sub datalog($@) {
565 my ($type, %kv) = @_;
566 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
351} 567}
352 568
353=back 569=back
354 570
355=cut 571=cut
356
357#############################################################################
358
359package cf::path;
360
361sub new {
362 my ($class, $path, $base) = @_;
363
364 $path = $path->as_string if ref $path;
365
366 my $self = bless { }, $class;
367
368 # {... are special paths that are not touched
369 # ?xxx/... are special absolute paths
370 # ?random/... random maps
371 # /! non-realised random map exit
372 # /... normal maps
373 # ~/... per-player maps without a specific player (DO NOT USE)
374 # ~user/... per-player map of a specific user
375
376 if ($path =~ /^{/) {
377 # fine as it is
378 } elsif ($path =~ s{^\?random/}{}) {
379 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
380 $self->{random} = cf::from_json $data;
381 } else {
382 if ($path =~ s{^~([^/]+)?}{}) {
383 $self->{user_rel} = 1;
384
385 if (defined $1) {
386 $self->{user} = $1;
387 } elsif ($base =~ m{^~([^/]+)/}) {
388 $self->{user} = $1;
389 } else {
390 warn "cannot resolve user-relative path without user <$path,$base>\n";
391 }
392 } elsif ($path =~ /^\//) {
393 # already absolute
394 } else {
395 $base =~ s{[^/]+/?$}{};
396 return $class->new ("$base/$path");
397 }
398
399 for ($path) {
400 redo if s{/\.?/}{/};
401 redo if s{/[^/]+/\.\./}{/};
402 }
403 }
404
405 $self->{path} = $path;
406
407 $self
408}
409
410# the name / primary key / in-game path
411sub as_string {
412 my ($self) = @_;
413
414 $self->{user_rel} ? "~$self->{user}$self->{path}"
415 : $self->{random} ? "?random/$self->{path}"
416 : $self->{path}
417}
418
419# the displayed name, this is a one way mapping
420sub visible_name {
421 my ($self) = @_;
422
423# if (my $rmp = $self->{random}) {
424# # todo: be more intelligent about this
425# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
426# } else {
427 $self->as_string
428# }
429}
430
431# escape the /'s in the path
432sub _escaped_path {
433 # ∕ is U+2215
434 (my $path = $_[0]{path}) =~ s/\//∕/g;
435 $path
436}
437
438# the original (read-only) location
439sub load_path {
440 my ($self) = @_;
441
442 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
443}
444
445# the temporary/swap location
446sub save_path {
447 my ($self) = @_;
448
449 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
450 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
451 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
452}
453
454# the unique path, might be eq to save_path
455sub uniq_path {
456 my ($self) = @_;
457
458 $self->{user_rel} || $self->{random}
459 ? undef
460 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
461}
462
463# return random map parameters, or undef
464sub random_map_params {
465 my ($self) = @_;
466
467 $self->{random}
468}
469
470# this is somewhat ugly, but style maps do need special treatment
471sub is_style_map {
472 $_[0]{path} =~ m{^/styles/}
473}
474
475package cf;
476 572
477############################################################################# 573#############################################################################
478 574
479=head2 ATTACHABLE OBJECTS 575=head2 ATTACHABLE OBJECTS
480 576
482attach callbacks/event handlers (a collection of which is called an "attachment") 578attach callbacks/event handlers (a collection of which is called an "attachment")
483to it. All such attachable objects support the following methods. 579to it. All such attachable objects support the following methods.
484 580
485In the following description, CLASS can be any of C<global>, C<object> 581In the following description, CLASS can be any of C<global>, C<object>
486C<player>, C<client> or C<map> (i.e. the attachable objects in 582C<player>, C<client> or C<map> (i.e. the attachable objects in
487crossfire+). 583Crossfire TRT).
488 584
489=over 4 585=over 4
490 586
491=item $attachable->attach ($attachment, key => $value...) 587=item $attachable->attach ($attachment, key => $value...)
492 588
606our @CB_TYPE = (); # registry for type (cf-object class) based events 702our @CB_TYPE = (); # registry for type (cf-object class) based events
607our @CB_MAP = (); 703our @CB_MAP = ();
608 704
609my %attachment; 705my %attachment;
610 706
707sub cf::attachable::thawer_merge {
708 # simply override everything except _meta
709 local $_[0]{_meta};
710 %{$_[0]} = %{$_[1]};
711}
712
611sub _attach_cb($$$$) { 713sub _attach_cb($$$$) {
612 my ($registry, $event, $prio, $cb) = @_; 714 my ($registry, $event, $prio, $cb) = @_;
613 715
614 use sort 'stable'; 716 use sort 'stable';
615 717
649 $registry = $CB_TYPE[$object_type] ||= []; 751 $registry = $CB_TYPE[$object_type] ||= [];
650 752
651 } elsif ($type eq "subtype") { 753 } elsif ($type eq "subtype") {
652 defined $object_type or Carp::croak "subtype specified without type"; 754 defined $object_type or Carp::croak "subtype specified without type";
653 my $object_subtype = shift @arg; 755 my $object_subtype = shift @arg;
654 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 756 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
655 757
656 } elsif ($type eq "package") { 758 } elsif ($type eq "package") {
657 my $pkg = shift @arg; 759 my $pkg = shift @arg;
658 760
659 while (my ($name, $id) = each %cb_id) { 761 while (my ($name, $id) = each %cb_id) {
688 _attach $registry, $klass, @attach; 790 _attach $registry, $klass, @attach;
689 } 791 }
690 792
691 $obj->{$name} = \%arg; 793 $obj->{$name} = \%arg;
692 } else { 794 } else {
693 warn "object uses attachment '$name' that is not available, postponing.\n"; 795 warn "object uses attachment '$name' which is not available, postponing.\n";
694 } 796 }
695 797
696 $obj->{_attachment}{$name} = undef; 798 $obj->{_attachment}{$name} = undef;
697} 799}
698 800
700 if (ref $_[0]) { 802 if (ref $_[0]) {
701 _object_attach @_; 803 _object_attach @_;
702 } else { 804 } else {
703 _attach shift->_attach_registry, @_; 805 _attach shift->_attach_registry, @_;
704 } 806 }
807 _recalc_want;
705}; 808};
706 809
707# all those should be optimised 810# all those should be optimised
708sub cf::attachable::detach { 811sub cf::attachable::detach {
709 my ($obj, $name) = @_; 812 my ($obj, $name) = @_;
712 delete $obj->{_attachment}{$name}; 815 delete $obj->{_attachment}{$name};
713 reattach ($obj); 816 reattach ($obj);
714 } else { 817 } else {
715 Carp::croak "cannot, currently, detach class attachments"; 818 Carp::croak "cannot, currently, detach class attachments";
716 } 819 }
820 _recalc_want;
717}; 821};
718 822
719sub cf::attachable::attached { 823sub cf::attachable::attached {
720 my ($obj, $name) = @_; 824 my ($obj, $name) = @_;
721 825
786# object support 890# object support
787 891
788sub reattach { 892sub reattach {
789 # basically do the same as instantiate, without calling instantiate 893 # basically do the same as instantiate, without calling instantiate
790 my ($obj) = @_; 894 my ($obj) = @_;
895
896 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
791 897
792 my $registry = $obj->registry; 898 my $registry = $obj->registry;
793 899
794 @$registry = (); 900 @$registry = ();
795 901
842 $filename, length $$rdata, scalar @$objs; 948 $filename, length $$rdata, scalar @$objs;
843 949
844 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 950 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
845 chmod SAVE_MODE, $fh; 951 chmod SAVE_MODE, $fh;
846 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 952 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
847 aio_fsync $fh; 953 aio_fsync $fh if $cf::USE_FSYNC;
848 close $fh; 954 close $fh;
849 955
850 if (@$objs) { 956 if (@$objs) {
851 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 957 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
852 chmod SAVE_MODE, $fh; 958 chmod SAVE_MODE, $fh;
853 my $data = Storable::nfreeze { version => 1, objs => $objs }; 959 my $data = Storable::nfreeze { version => 1, objs => $objs };
854 aio_write $fh, 0, (length $data), $data, 0; 960 aio_write $fh, 0, (length $data), $data, 0;
855 aio_fsync $fh; 961 aio_fsync $fh if $cf::USE_FSYNC;
856 close $fh; 962 close $fh;
857 aio_rename "$filename.pst~", "$filename.pst"; 963 aio_rename "$filename.pst~", "$filename.pst";
858 } 964 }
859 } else { 965 } else {
860 aio_unlink "$filename.pst"; 966 aio_unlink "$filename.pst";
892 or return; 998 or return;
893 $av = eval { (Storable::thaw $av)->{objs} }; 999 $av = eval { (Storable::thaw $av)->{objs} };
894 } 1000 }
895 1001
896 warn sprintf "loading %s (%d)\n", 1002 warn sprintf "loading %s (%d)\n",
897 $filename, length $data, scalar @{$av || []};#d# 1003 $filename, length $data, scalar @{$av || []};
898 return ($data, $av); 1004 return ($data, $av);
899} 1005}
1006
1007=head2 COMMAND CALLBACKS
1008
1009=over 4
1010
1011=cut
900 1012
901############################################################################# 1013#############################################################################
902# command handling &c 1014# command handling &c
903 1015
904=item cf::register_command $name => \&callback($ob,$args); 1016=item cf::register_command $name => \&callback($ob,$args);
917 push @{ $COMMAND{$name} }, [$caller, $cb]; 1029 push @{ $COMMAND{$name} }, [$caller, $cb];
918} 1030}
919 1031
920=item cf::register_extcmd $name => \&callback($pl,$packet); 1032=item cf::register_extcmd $name => \&callback($pl,$packet);
921 1033
922Register a callbackf ro execution when the client sends an extcmd packet. 1034Register a callback fro execution when the client sends an extcmd packet.
923 1035
924If the callback returns something, it is sent back as if reply was being 1036If the callback returns something, it is sent back as if reply was being
925called. 1037called.
926 1038
927=cut 1039=cut
928 1040
929sub register_extcmd { 1041sub register_extcmd {
930 my ($name, $cb) = @_; 1042 my ($name, $cb) = @_;
931 1043
932 my $caller = caller;
933 #warn "registering extcmd '$name' to '$caller'";
934
935 $EXTCMD{$name} = [$cb, $caller]; 1044 $EXTCMD{$name} = $cb;
936} 1045}
937 1046
938cf::player->attach ( 1047cf::player->attach (
939 on_command => sub { 1048 on_command => sub {
940 my ($pl, $name, $params) = @_; 1049 my ($pl, $name, $params) = @_;
953 1062
954 my $msg = eval { from_json $buf }; 1063 my $msg = eval { from_json $buf };
955 1064
956 if (ref $msg) { 1065 if (ref $msg) {
957 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1066 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
958 if (my %reply = $cb->[0]->($pl, $msg)) { 1067 if (my %reply = $cb->($pl, $msg)) {
959 $pl->ext_reply ($msg->{msgid}, %reply); 1068 $pl->ext_reply ($msg->{msgid}, %reply);
960 } 1069 }
961 } 1070 }
962 } else { 1071 } else {
963 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1072 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
965 1074
966 cf::override; 1075 cf::override;
967 }, 1076 },
968); 1077);
969 1078
970sub register {
971 my ($base, $pkg) = @_;
972
973 #TODO
974}
975
976sub load_extension { 1079sub load_extensions {
1080 cf::sync_job {
1081 my %todo;
1082
1083 for my $path (<$LIBDIR/*.ext>) {
1084 next unless -r $path;
1085
1086 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1087 my $base = $1;
1088 my $pkg = $1;
1089 $pkg =~ s/[^[:word:]]/_/g;
1090 $pkg = "ext::$pkg";
1091
1092 open my $fh, "<:utf8", $path
1093 or die "$path: $!";
1094
1095 my $source = do { local $/; <$fh> };
1096
1097 my %ext = (
1098 path => $path,
1099 base => $base,
1100 pkg => $pkg,
1101 );
1102
1103 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1104 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1105
1106 $ext{source} =
1107 "package $pkg; use strict; use utf8;\n"
1108 . "#line 1 \"$path\"\n{\n"
1109 . $source
1110 . "\n};\n1";
1111
1112 $todo{$base} = \%ext;
1113 }
1114
1115 my %done;
1116 while (%todo) {
1117 my $progress;
1118
1119 while (my ($k, $v) = each %todo) {
1120 for (split /,\s*/, $v->{meta}{depends}) {
1121 goto skip
1122 unless exists $done{$_};
1123 }
1124
1125 warn "... loading '$k' into '$v->{pkg}'\n";
1126
1127 unless (eval $v->{source}) {
1128 my $msg = $@ ? "$v->{path}: $@\n"
1129 : "$v->{base}: extension inactive.\n";
1130
1131 if (exists $v->{meta}{mandatory}) {
1132 warn $msg;
1133 warn "mandatory extension failed to load, exiting.\n";
1134 exit 1;
1135 }
1136
1137 warn $msg;
1138 }
1139
1140 $done{$k} = delete $todo{$k};
1141 push @EXTS, $v->{pkg};
1142 $progress = 1;
1143 }
1144
1145 skip:
1146 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1147 unless $progress;
1148 }
1149 };
1150}
1151
1152#############################################################################
1153
1154=back
1155
1156=head2 CORE EXTENSIONS
1157
1158Functions and methods that extend core crossfire objects.
1159
1160=cut
1161
1162package cf::player;
1163
1164use Coro::AIO;
1165
1166=head3 cf::player
1167
1168=over 4
1169
1170=item cf::player::find $login
1171
1172Returns the given player object, loading it if necessary (might block).
1173
1174=cut
1175
1176sub playerdir($) {
1177 "$PLAYERDIR/"
1178 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1179}
1180
1181sub path($) {
1182 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1183
1184 (playerdir $login) . "/playerdata"
1185}
1186
1187sub find_active($) {
1188 $cf::PLAYER{$_[0]}
1189 and $cf::PLAYER{$_[0]}->active
1190 and $cf::PLAYER{$_[0]}
1191}
1192
1193sub exists($) {
1194 my ($login) = @_;
1195
1196 $cf::PLAYER{$login}
1197 or cf::sync_job { !aio_stat path $login }
1198}
1199
1200sub find($) {
1201 return $cf::PLAYER{$_[0]} || do {
1202 my $login = $_[0];
1203
1204 my $guard = cf::lock_acquire "user_find:$login";
1205
1206 $cf::PLAYER{$_[0]} || do {
1207 # rename old playerfiles to new ones
1208 #TODO: remove when no longer required
1209 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1210 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1211 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1212 aio_unlink +(playerdir $login) . "/$login.pl";
1213
1214 my $pl = load_pl path $login
1215 or return;
1216 $cf::PLAYER{$login} = $pl
1217 }
1218 }
1219}
1220
1221sub save($) {
1222 my ($pl) = @_;
1223
1224 return if $pl->{deny_save};
1225
1226 my $path = path $pl;
1227 my $guard = cf::lock_acquire "user_save:$path";
1228
1229 return if $pl->{deny_save};
1230
1231 aio_mkdir playerdir $pl, 0770;
1232 $pl->{last_save} = $cf::RUNTIME;
1233
1234 $pl->save_pl ($path);
1235 Coro::cede;
1236}
1237
1238sub new($) {
1239 my ($login) = @_;
1240
1241 my $self = create;
1242
1243 $self->ob->name ($login);
1244 $self->{deny_save} = 1;
1245
1246 $cf::PLAYER{$login} = $self;
1247
1248 $self
1249}
1250
1251=item $pl->quit_character
1252
1253Nukes the player without looking back. If logged in, the connection will
1254be destroyed. May block for a long time.
1255
1256=cut
1257
1258sub quit_character {
1259 my ($pl) = @_;
1260
1261 my $name = $pl->ob->name;
1262
1263 $pl->{deny_save} = 1;
1264 $pl->password ("*"); # this should lock out the player until we nuked the dir
1265
1266 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1267 $pl->deactivate;
1268 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1269 $pl->ns->destroy if $pl->ns;
1270
1271 my $path = playerdir $pl;
1272 my $temp = "$path~$cf::RUNTIME~deleting~";
1273 aio_rename $path, $temp;
1274 delete $cf::PLAYER{$pl->ob->name};
1275 $pl->destroy;
1276
1277 my $prefix = qr<^~\Q$name\E/>;
1278
1279 # nuke player maps
1280 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1281
1282 IO::AIO::aio_rmtree $temp;
1283}
1284
1285=item $pl->kick
1286
1287Kicks a player out of the game. This destroys the connection.
1288
1289=cut
1290
1291sub kick {
1292 my ($pl, $kicker) = @_;
1293
1294 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1295 $pl->killer ("kicked");
1296 $pl->ns->destroy;
1297}
1298
1299=item cf::player::list_logins
1300
1301Returns am arrayref of all valid playernames in the system, can take a
1302while and may block, so not sync_job-capable, ever.
1303
1304=cut
1305
1306sub list_logins {
1307 my $dirs = aio_readdir $PLAYERDIR
1308 or return [];
1309
1310 my @logins;
1311
1312 for my $login (@$dirs) {
1313 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1314 aio_read $fh, 0, 512, my $buf, 0 or next;
1315 $buf !~ /^password -------------$/m or next; # official not-valid tag
1316
1317 utf8::decode $login;
1318 push @logins, $login;
1319 }
1320
1321 \@logins
1322}
1323
1324=item $player->maps
1325
1326Returns an arrayref of map paths that are private for this
1327player. May block.
1328
1329=cut
1330
1331sub maps($) {
1332 my ($pl) = @_;
1333
1334 $pl = ref $pl ? $pl->ob->name : $pl;
1335
1336 my $files = aio_readdir playerdir $pl
1337 or return;
1338
1339 my @paths;
1340
1341 for (@$files) {
1342 utf8::decode $_;
1343 next if /\.(?:pl|pst)$/;
1344 next unless /^$PATH_SEP/o;
1345
1346 push @paths, cf::map::normalise "~$pl/$_";
1347 }
1348
1349 \@paths
1350}
1351
1352=item $player->ext_reply ($msgid, %msg)
1353
1354Sends an ext reply to the player.
1355
1356=cut
1357
1358sub ext_reply($$%) {
1359 my ($self, $id, %msg) = @_;
1360
1361 $msg{msgid} = $id;
1362
1363 $self->send ("ext " . cf::to_json \%msg);
1364}
1365
1366=item $player->ext_event ($type, %msg)
1367
1368Sends an ext event to the client.
1369
1370=cut
1371
1372sub ext_event($$%) {
1373 my ($self, $type, %msg) = @_;
1374
1375 $self->ns->ext_event ($type, %msg);
1376}
1377
1378=head3 cf::region
1379
1380=over 4
1381
1382=cut
1383
1384package cf::region;
1385
1386=item cf::region::find_by_path $path
1387
1388Tries to decuce the likely region for a map knowing only its path.
1389
1390=cut
1391
1392sub find_by_path($) {
977 my ($path) = @_; 1393 my ($path) = @_;
978 1394
979 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1395 my ($match, $specificity);
980 my $base = $1;
981 my $pkg = $1;
982 $pkg =~ s/[^[:word:]]/_/g;
983 $pkg = "ext::$pkg";
984 1396
985 warn "loading '$path' into '$pkg'\n"; 1397 for my $region (list) {
986 1398 if ($region->match && $path =~ $region->match) {
987 open my $fh, "<:utf8", $path 1399 ($match, $specificity) = ($region, $region->specificity)
988 or die "$path: $!"; 1400 if $region->specificity > $specificity;
989 1401 }
990 my $source =
991 "package $pkg; use strict; use utf8;\n"
992 . "#line 1 \"$path\"\n{\n"
993 . (do { local $/; <$fh> })
994 . "\n};\n1";
995
996 eval $source
997 or die $@ ? "$path: $@\n"
998 : "extension disabled.\n";
999
1000 push @exts, $pkg;
1001 $ext_pkg{$base} = $pkg;
1002
1003# no strict 'refs';
1004# @{"$pkg\::ISA"} = ext::;
1005
1006 register $base, $pkg;
1007}
1008
1009sub unload_extension {
1010 my ($pkg) = @_;
1011
1012 warn "removing extension $pkg\n";
1013
1014 # remove hooks
1015 #TODO
1016# for my $idx (0 .. $#PLUGIN_EVENT) {
1017# delete $hook[$idx]{$pkg};
1018# } 1402 }
1019 1403
1020 # remove commands 1404 $match
1021 for my $name (keys %COMMAND) {
1022 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1023
1024 if (@cb) {
1025 $COMMAND{$name} = \@cb;
1026 } else {
1027 delete $COMMAND{$name};
1028 }
1029 }
1030
1031 # remove extcmds
1032 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1033 delete $EXTCMD{$name};
1034 }
1035
1036 if (my $cb = $pkg->can ("unload")) {
1037 eval {
1038 $cb->($pkg);
1039 1
1040 } or warn "$pkg unloaded, but with errors: $@";
1041 }
1042
1043 Symbol::delete_package $pkg;
1044}
1045
1046sub load_extensions {
1047 for my $ext (<$LIBDIR/*.ext>) {
1048 next unless -r $ext;
1049 eval {
1050 load_extension $ext;
1051 1
1052 } or warn "$ext not loaded: $@";
1053 }
1054}
1055
1056#############################################################################
1057# load/save/clean perl data associated with a map
1058
1059*cf::mapsupport::on_clean = sub {
1060 my ($map) = @_;
1061
1062 my $path = $map->tmpname;
1063 defined $path or return;
1064
1065 unlink "$path.pst";
1066};
1067
1068cf::map->attach (prio => -10000, package => cf::mapsupport::);
1069
1070#############################################################################
1071# load/save perl data associated with player->ob objects
1072
1073sub all_objects(@) {
1074 @_, map all_objects ($_->inv), @_
1075}
1076
1077# TODO: compatibility cruft, remove when no longer needed
1078cf::player->attach (
1079 on_load => sub {
1080 my ($pl, $path) = @_;
1081
1082 for my $o (all_objects $pl->ob) {
1083 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1084 $o->set_ob_key_value ("_perl_data");
1085
1086 %$o = %{ Storable::thaw pack "H*", $value };
1087 }
1088 }
1089 },
1090);
1091
1092#############################################################################
1093
1094=head2 CORE EXTENSIONS
1095
1096Functions and methods that extend core crossfire objects.
1097
1098=head3 cf::player
1099
1100=over 4
1101
1102=item cf::player::exists $login
1103
1104Returns true when the given account exists.
1105
1106=cut
1107
1108sub cf::player::exists($) {
1109 cf::player::find $_[0]
1110 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1111}
1112
1113=item $player->ext_reply ($msgid, $msgtype, %msg)
1114
1115Sends an ext reply to the player.
1116
1117=cut
1118
1119sub cf::player::ext_reply($$$%) {
1120 my ($self, $id, %msg) = @_;
1121
1122 $msg{msgid} = $id;
1123
1124 $self->send ("ext " . to_json \%msg);
1125} 1405}
1126 1406
1127=back 1407=back
1128
1129 1408
1130=head3 cf::map 1409=head3 cf::map
1131 1410
1132=over 4 1411=over 4
1133 1412
1136package cf::map; 1415package cf::map;
1137 1416
1138use Fcntl; 1417use Fcntl;
1139use Coro::AIO; 1418use Coro::AIO;
1140 1419
1420use overload
1421 '""' => \&as_string,
1422 fallback => 1;
1423
1141our $MAX_RESET = 7200; 1424our $MAX_RESET = 3600;
1142our $DEFAULT_RESET = 3600; 1425our $DEFAULT_RESET = 3000;
1143 1426
1144sub generate_random_map { 1427sub generate_random_map {
1145 my ($path, $rmp) = @_; 1428 my ($self, $rmp) = @_;
1146
1147 # mit "rum" bekleckern, nicht 1429 # mit "rum" bekleckern, nicht
1148 cf::map::_create_random_map 1430 $self->_create_random_map (
1149 $path,
1150 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1431 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1151 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1432 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1152 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1433 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1153 $rmp->{exit_on_final_map}, 1434 $rmp->{exit_on_final_map},
1154 $rmp->{xsize}, $rmp->{ysize}, 1435 $rmp->{xsize}, $rmp->{ysize},
1155 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1436 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1156 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1437 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1157 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1438 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1158 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1439 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1159 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1440 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1160 (cf::region::find $rmp->{region}) 1441 (cf::region::find $rmp->{region}), $rmp->{custom}
1442 )
1443}
1444
1445=item cf::map->register ($regex, $prio)
1446
1447Register a handler for the map path matching the given regex at the
1448givne priority (higher is better, built-in handlers have priority 0, the
1449default).
1450
1451=cut
1452
1453sub register {
1454 my (undef, $regex, $prio) = @_;
1455 my $pkg = caller;
1456
1457 no strict;
1458 push @{"$pkg\::ISA"}, __PACKAGE__;
1459
1460 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1461}
1462
1463# also paths starting with '/'
1464$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1465
1466sub thawer_merge {
1467 my ($self, $merge) = @_;
1468
1469 # we have to keep some variables in memory intact
1470 local $self->{path};
1471 local $self->{load_path};
1472
1473 $self->SUPER::thawer_merge ($merge);
1474}
1475
1476sub normalise {
1477 my ($path, $base) = @_;
1478
1479 $path = "$path"; # make sure its a string
1480
1481 $path =~ s/\.map$//;
1482
1483 # map plan:
1484 #
1485 # /! non-realised random map exit (special hack!)
1486 # {... are special paths that are not being touched
1487 # ?xxx/... are special absolute paths
1488 # ?random/... random maps
1489 # /... normal maps
1490 # ~user/... per-player map of a specific user
1491
1492 $path =~ s/$PATH_SEP/\//go;
1493
1494 # treat it as relative path if it starts with
1495 # something that looks reasonable
1496 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1497 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1498
1499 $base =~ s{[^/]+/?$}{};
1500 $path = "$base/$path";
1501 }
1502
1503 for ($path) {
1504 redo if s{//}{/};
1505 redo if s{/\.?/}{/};
1506 redo if s{/[^/]+/\.\./}{/};
1507 }
1508
1509 $path
1510}
1511
1512sub new_from_path {
1513 my (undef, $path, $base) = @_;
1514
1515 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1516
1517 $path = normalise $path, $base;
1518
1519 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1520 if ($path =~ $EXT_MAP{$pkg}[1]) {
1521 my $self = bless cf::map::new, $pkg;
1522 $self->{path} = $path; $self->path ($path);
1523 $self->init; # pass $1 etc.
1524 return $self;
1525 }
1526 }
1527
1528 Carp::carp "unable to resolve path '$path' (base '$base').";
1529 ()
1530}
1531
1532sub init {
1533 my ($self) = @_;
1534
1535 $self
1536}
1537
1538sub as_string {
1539 my ($self) = @_;
1540
1541 "$self->{path}"
1542}
1543
1544# the displayed name, this is a one way mapping
1545sub visible_name {
1546 &as_string
1547}
1548
1549# the original (read-only) location
1550sub load_path {
1551 my ($self) = @_;
1552
1553 "$MAPDIR/$self->{path}.map"
1554}
1555
1556# the temporary/swap location
1557sub save_path {
1558 my ($self) = @_;
1559
1560 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1561 "$TMPDIR/$path.map"
1562}
1563
1564# the unique path, undef == no special unique path
1565sub uniq_path {
1566 my ($self) = @_;
1567
1568 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1569 "$UNIQUEDIR/$path"
1161} 1570}
1162 1571
1163# and all this just because we cannot iterate over 1572# and all this just because we cannot iterate over
1164# all maps in C++... 1573# all maps in C++...
1165sub change_all_map_light { 1574sub change_all_map_light {
1167 1576
1168 $_->change_map_light ($change) 1577 $_->change_map_light ($change)
1169 for grep $_->outdoor, values %cf::MAP; 1578 for grep $_->outdoor, values %cf::MAP;
1170} 1579}
1171 1580
1581sub decay_objects {
1582 my ($self) = @_;
1583
1584 return if $self->{deny_reset};
1585
1586 $self->do_decay_objects;
1587}
1588
1589sub unlink_save {
1590 my ($self) = @_;
1591
1592 utf8::encode (my $save = $self->save_path);
1593 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1594 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1595}
1596
1172sub try_load_header($) { 1597sub load_header_from($) {
1173 my ($path) = @_; 1598 my ($self, $path) = @_;
1174 1599
1175 utf8::encode $path; 1600 utf8::encode $path;
1176 aio_open $path, O_RDONLY, 0 1601 #aio_open $path, O_RDONLY, 0
1602 # or return;
1603
1604 $self->_load_header ($path)
1177 or return; 1605 or return;
1178 1606
1179 my $map = cf::map::new 1607 $self->{load_path} = $path;
1608
1609 1
1610}
1611
1612sub load_header_orig {
1613 my ($self) = @_;
1614
1615 $self->load_header_from ($self->load_path)
1616}
1617
1618sub load_header_temp {
1619 my ($self) = @_;
1620
1621 $self->load_header_from ($self->save_path)
1622}
1623
1624sub prepare_temp {
1625 my ($self) = @_;
1626
1627 $self->last_access ((delete $self->{last_access})
1628 || $cf::RUNTIME); #d#
1629 # safety
1630 $self->{instantiate_time} = $cf::RUNTIME
1631 if $self->{instantiate_time} > $cf::RUNTIME;
1632}
1633
1634sub prepare_orig {
1635 my ($self) = @_;
1636
1637 $self->{load_original} = 1;
1638 $self->{instantiate_time} = $cf::RUNTIME;
1639 $self->last_access ($cf::RUNTIME);
1640 $self->instantiate;
1641}
1642
1643sub load_header {
1644 my ($self) = @_;
1645
1646 if ($self->load_header_temp) {
1647 $self->prepare_temp;
1648 } else {
1649 $self->load_header_orig
1180 or return; 1650 or return;
1651 $self->prepare_orig;
1652 }
1181 1653
1182 $map->load_header ($path) 1654 $self->{deny_reset} = 1
1183 or return; 1655 if $self->no_reset;
1184 1656
1185 $map->{load_path} = $path; 1657 $self->default_region (cf::region::find_by_path $self->{path})
1658 unless $self->default_region;
1186 1659
1187 $map 1660 1
1188} 1661}
1189 1662
1190sub find_map; 1663sub find;
1191sub find_map { 1664sub find {
1192 my ($path, $origin) = @_; 1665 my ($path, $origin) = @_;
1193 1666
1194 #warn "find_map<$path,$origin>\n";#d#
1195
1196 $path = new cf::path $path, $origin && $origin->path; 1667 $path = normalise $path, $origin && $origin->path;
1197 my $key = $path->as_string;
1198 1668
1199 cf::lock_wait "map_find:$key"; 1669 cf::lock_wait "map_find:$path";
1200 1670
1201 $cf::MAP{$key} || do { 1671 $cf::MAP{$path} || do {
1202 my $guard = cf::lock_acquire "map_find:$key"; 1672 my $guard = cf::lock_acquire "map_find:$path";
1203 1673 my $map = new_from_path cf::map $path
1204 # do it the slow way
1205 my $map = try_load_header $path->save_path;
1206
1207 if ($map) {
1208 # safety
1209 $map->{instantiate_time} = $cf::RUNTIME
1210 if $map->{instantiate_time} > $cf::RUNTIME;
1211 } else {
1212 if (my $rmp = $path->random_map_params) {
1213 $map = generate_random_map $key, $rmp;
1214 } else {
1215 $map = try_load_header $path->load_path;
1216 }
1217
1218 $map or return; 1674 or return;
1219 1675
1220 $map->{load_original} = 1;
1221 $map->{instantiate_time} = $cf::RUNTIME;
1222 $map->instantiate;
1223
1224 # per-player maps become, after loading, normal maps
1225 $map->per_player (0) if $path->{user_rel};
1226 }
1227
1228 $map->path ($key);
1229 $map->{path} = $path;
1230 $map->{last_save} = $cf::RUNTIME; 1676 $map->{last_save} = $cf::RUNTIME;
1231 $map->last_access ($cf::RUNTIME);
1232 1677
1233 if ($map->should_reset) { 1678 $map->load_header
1679 or return;
1680
1681 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1682 # doing this can freeze the server in a sync job, obviously
1683 #$cf::WAIT_FOR_TICK->wait;
1234 $map->reset; 1684 $map->reset;
1235 undef $guard; 1685 undef $guard;
1236 $map = find_map $path 1686 return find $path;
1237 or return;
1238 } 1687 }
1239 1688
1240 $cf::MAP{$key} = $map 1689 $cf::MAP{$path} = $map
1241 } 1690 }
1242} 1691}
1692
1693sub pre_load { }
1694sub post_load { }
1243 1695
1244sub load { 1696sub load {
1245 my ($self) = @_; 1697 my ($self) = @_;
1246 1698
1699 local $self->{deny_reset} = 1; # loading can take a long time
1700
1247 my $path = $self->{path}; 1701 my $path = $self->{path};
1702
1703 {
1248 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1704 my $guard = cf::lock_acquire "map_load:$path";
1249 1705
1250 return if $self->in_memory != cf::MAP_SWAPPED; 1706 return if $self->in_memory != cf::MAP_SWAPPED;
1251 1707
1252 $self->in_memory (cf::MAP_LOADING); 1708 $self->in_memory (cf::MAP_LOADING);
1253 1709
1254 $self->alloc; 1710 $self->alloc;
1711
1712 $self->pre_load;
1713 Coro::cede;
1714
1255 $self->load_objects ($self->{load_path}, 1) 1715 $self->_load_objects ($self->{load_path}, 1)
1256 or return; 1716 or return;
1257 1717
1258 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1718 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1259 if delete $self->{load_original}; 1719 if delete $self->{load_original};
1260 1720
1261 if (my $uniq = $path->uniq_path) { 1721 if (my $uniq = $self->uniq_path) {
1262 utf8::encode $uniq; 1722 utf8::encode $uniq;
1263 if (aio_open $uniq, O_RDONLY, 0) { 1723 if (aio_open $uniq, O_RDONLY, 0) {
1264 $self->clear_unique_items; 1724 $self->clear_unique_items;
1265 $self->load_objects ($uniq, 0); 1725 $self->_load_objects ($uniq, 0);
1266 } 1726 }
1267 } 1727 }
1268 1728
1729 Coro::cede;
1269 # now do the right thing for maps 1730 # now do the right thing for maps
1270 $self->link_multipart_objects; 1731 $self->link_multipart_objects;
1271
1272 if ($self->{path}->is_style_map) {
1273 $self->{deny_save} = 1;
1274 $self->{deny_reset} = 1;
1275 } else {
1276 $self->fix_auto_apply;
1277 $self->decay_objects;
1278 $self->update_buttons;
1279 $self->set_darkness_map;
1280 $self->difficulty ($self->estimate_difficulty) 1732 $self->difficulty ($self->estimate_difficulty)
1281 unless $self->difficulty; 1733 unless $self->difficulty;
1734 Coro::cede;
1735
1736 unless ($self->{deny_activate}) {
1737 $self->decay_objects;
1738 $self->fix_auto_apply;
1739 $self->update_buttons;
1740 Coro::cede;
1741 $self->set_darkness_map;
1742 Coro::cede;
1282 $self->activate; 1743 $self->activate;
1283 } 1744 }
1284 1745
1285 $self->in_memory (cf::MAP_IN_MEMORY); 1746 $self->in_memory (cf::MAP_IN_MEMORY);
1286} 1747 }
1287 1748
1288sub load_map_sync { 1749 $self->post_load;
1750}
1751
1752sub customise_for {
1753 my ($self, $ob) = @_;
1754
1755 return find "~" . $ob->name . "/" . $self->{path}
1756 if $self->per_player;
1757
1758# return find "?party/" . $ob->name . "/" . $self->{path}
1759# if $self->per_party;
1760
1761 $self
1762}
1763
1764# find and load all maps in the 3x3 area around a map
1765sub load_diag {
1766 my ($map) = @_;
1767
1768 my @diag; # diagonal neighbours
1769
1770 for (0 .. 3) {
1771 my $neigh = $map->tile_path ($_)
1772 or next;
1773 $neigh = find $neigh, $map
1774 or next;
1775 $neigh->load;
1776
1777 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1778 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1779 }
1780
1781 for (@diag) {
1782 my $neigh = find @$_
1783 or next;
1784 $neigh->load;
1785 }
1786}
1787
1788sub find_sync {
1289 my ($path, $origin) = @_; 1789 my ($path, $origin) = @_;
1290 1790
1291 #warn "load_map_sync<$path, $origin>\n";#d# 1791 cf::sync_job { find $path, $origin }
1792}
1292 1793
1293 cf::sync_job { 1794sub do_load_sync {
1294 my $map = cf::map::find_map $path, $origin 1795 my ($map) = @_;
1295 or return; 1796
1797 cf::sync_job { $map->load };
1798}
1799
1800our %MAP_PREFETCH;
1801our $MAP_PREFETCHER = undef;
1802
1803sub find_async {
1804 my ($path, $origin) = @_;
1805
1806 $path = normalise $path, $origin && $origin->{path};
1807
1808 if (my $map = $cf::MAP{$path}) {
1809 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1810 }
1811
1812 undef $MAP_PREFETCH{$path};
1813 $MAP_PREFETCHER ||= cf::async {
1814 while (%MAP_PREFETCH) {
1815 for my $path (keys %MAP_PREFETCH) {
1816 my $map = find $path
1817 or next;
1296 $map->load; 1818 $map->load;
1297 $map 1819
1820 delete $MAP_PREFETCH{$path};
1821 }
1822 }
1823 undef $MAP_PREFETCHER;
1298 } 1824 };
1825 $MAP_PREFETCHER->prio (6);
1826
1827 ()
1299} 1828}
1300 1829
1301sub save { 1830sub save {
1302 my ($self) = @_; 1831 my ($self) = @_;
1303 1832
1833 my $lock = cf::lock_acquire "map_data:" . $self->path;
1834
1304 $self->{last_save} = $cf::RUNTIME; 1835 $self->{last_save} = $cf::RUNTIME;
1305 1836
1306 return unless $self->dirty; 1837 return unless $self->dirty;
1307 1838
1308 my $save = $self->{path}->save_path; utf8::encode $save; 1839 my $save = $self->save_path; utf8::encode $save;
1309 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1840 my $uniq = $self->uniq_path; utf8::encode $uniq;
1310 1841
1311 $self->{load_path} = $save; 1842 $self->{load_path} = $save;
1312 1843
1313 return if $self->{deny_save}; 1844 return if $self->{deny_save};
1314 1845
1846 local $self->{last_access} = $self->last_access;#d#
1847
1848 cf::async {
1849 $_->contr->save for $self->players;
1850 };
1851
1315 if ($uniq) { 1852 if ($uniq) {
1316 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1853 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1317 $self->save_objects ($uniq, cf::IO_UNIQUES); 1854 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1318 } else { 1855 } else {
1319 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1856 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1320 } 1857 }
1321} 1858}
1322 1859
1323sub swap_out { 1860sub swap_out {
1324 my ($self) = @_; 1861 my ($self) = @_;
1325 1862
1326 # save first because save cedes 1863 # save first because save cedes
1327 $self->save; 1864 $self->save;
1865
1866 my $lock = cf::lock_acquire "map_data:" . $self->path;
1328 1867
1329 return if $self->players; 1868 return if $self->players;
1330 return if $self->in_memory != cf::MAP_IN_MEMORY; 1869 return if $self->in_memory != cf::MAP_IN_MEMORY;
1331 return if $self->{deny_save}; 1870 return if $self->{deny_save};
1332 1871
1336 1875
1337sub reset_at { 1876sub reset_at {
1338 my ($self) = @_; 1877 my ($self) = @_;
1339 1878
1340 # TODO: safety, remove and allow resettable per-player maps 1879 # TODO: safety, remove and allow resettable per-player maps
1341 return 1e99 if $self->{path}{user_rel};
1342 return 1e99 if $self->{deny_reset}; 1880 return 1e99 if $self->{deny_reset};
1343 1881
1344 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1882 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1345 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1883 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1346 1884
1351 my ($self) = @_; 1889 my ($self) = @_;
1352 1890
1353 $self->reset_at <= $cf::RUNTIME 1891 $self->reset_at <= $cf::RUNTIME
1354} 1892}
1355 1893
1356sub unlink_save {
1357 my ($self) = @_;
1358
1359 utf8::encode (my $save = $self->{path}->save_path);
1360 aioreq_pri 3; IO::AIO::aio_unlink $save;
1361 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1362}
1363
1364sub rename {
1365 my ($self, $new_path) = @_;
1366
1367 $self->unlink_save;
1368
1369 delete $cf::MAP{$self->path};
1370 $self->{path} = new cf::path $new_path;
1371 $self->path ($self->{path}->as_string);
1372 $cf::MAP{$self->path} = $self;
1373
1374 $self->save;
1375}
1376
1377sub reset { 1894sub reset {
1378 my ($self) = @_; 1895 my ($self) = @_;
1379 1896
1897 my $lock = cf::lock_acquire "map_data:$self->{path}";
1898
1380 return if $self->players; 1899 return if $self->players;
1381 return if $self->{path}{user_rel};#d#
1382 1900
1383 warn "resetting map ", $self->path;#d# 1901 warn "resetting map ", $self->path;
1902
1903 $self->in_memory (cf::MAP_SWAPPED);
1904
1905 # need to save uniques path
1906 unless ($self->{deny_save}) {
1907 my $uniq = $self->uniq_path; utf8::encode $uniq;
1908
1909 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1910 if $uniq;
1911 }
1384 1912
1385 delete $cf::MAP{$self->path}; 1913 delete $cf::MAP{$self->path};
1914
1915 $self->clear;
1386 1916
1387 $_->clear_links_to ($self) for values %cf::MAP; 1917 $_->clear_links_to ($self) for values %cf::MAP;
1388 1918
1389 $self->unlink_save; 1919 $self->unlink_save;
1390 $self->destroy; 1920 $self->destroy;
1393my $nuke_counter = "aaaa"; 1923my $nuke_counter = "aaaa";
1394 1924
1395sub nuke { 1925sub nuke {
1396 my ($self) = @_; 1926 my ($self) = @_;
1397 1927
1928 delete $cf::MAP{$self->path};
1929
1930 $self->unlink_save;
1931
1932 bless $self, "cf::map";
1933 delete $self->{deny_reset};
1398 $self->{deny_save} = 1; 1934 $self->{deny_save} = 1;
1399 $self->reset_timeout (1); 1935 $self->reset_timeout (1);
1400 $self->rename ("{nuke}/" . ($nuke_counter++)); 1936 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1937
1938 $cf::MAP{$self->path} = $self;
1939
1401 $self->reset; # polite request, might not happen 1940 $self->reset; # polite request, might not happen
1402} 1941}
1403 1942
1404sub customise_for { 1943=item $maps = cf::map::tmp_maps
1405 my ($map, $ob) = @_;
1406 1944
1407 if ($map->per_player) { 1945Returns an arrayref with all map paths of currently instantiated and saved
1408 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1946maps. May block.
1947
1948=cut
1949
1950sub tmp_maps() {
1409 } 1951 [
1410 1952 map {
1411 $map 1953 utf8::decode $_;
1954 /\.map$/
1955 ? normalise $_
1956 : ()
1957 } @{ aio_readdir $TMPDIR or [] }
1958 ]
1412} 1959}
1413 1960
1414sub emergency_save { 1961=item $maps = cf::map::random_maps
1415 local $cf::FREEZE = 1;
1416 1962
1417 warn "enter emergency map save\n"; 1963Returns an arrayref with all map paths of currently instantiated and saved
1964random maps. May block.
1418 1965
1419 cf::sync_job { 1966=cut
1420 warn "begin emergency map save\n";
1421 $_->save for values %cf::MAP;
1422 };
1423 1967
1424 warn "end emergency map save\n"; 1968sub random_maps() {
1969 [
1970 map {
1971 utf8::decode $_;
1972 /\.map$/
1973 ? normalise "?random/$_"
1974 : ()
1975 } @{ aio_readdir $RANDOMDIR or [] }
1976 ]
1977}
1978
1979=item cf::map::unique_maps
1980
1981Returns an arrayref of paths of all shared maps that have
1982instantiated unique items. May block.
1983
1984=cut
1985
1986sub unique_maps() {
1987 [
1988 map {
1989 utf8::decode $_;
1990 /\.map$/
1991 ? normalise $_
1992 : ()
1993 } @{ aio_readdir $UNIQUEDIR or [] }
1994 ]
1425} 1995}
1426 1996
1427package cf; 1997package cf;
1428 1998
1429=back 1999=back
1430 2000
2001=head3 cf::object
2002
2003=cut
2004
2005package cf::object;
2006
2007=over 4
2008
2009=item $ob->inv_recursive
2010
2011Returns the inventory of the object _and_ their inventories, recursively.
2012
2013=cut
2014
2015sub inv_recursive_;
2016sub inv_recursive_ {
2017 map { $_, inv_recursive_ $_->inv } @_
2018}
2019
2020sub inv_recursive {
2021 inv_recursive_ inv $_[0]
2022}
2023
2024package cf;
2025
2026=back
1431 2027
1432=head3 cf::object::player 2028=head3 cf::object::player
1433 2029
1434=over 4 2030=over 4
1435 2031
1449 2045
1450 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2046 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1451 2047
1452 if ($self->{record_replies}) { 2048 if ($self->{record_replies}) {
1453 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2049 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2050
1454 } else { 2051 } else {
2052 my $pl = $self->contr;
2053
2054 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2055 my $diag = $pl->{npc_dialog};
2056 $diag->{pl}->ext_reply (
2057 $diag->{id}, msgtype => "reply", msg => $msg, add_topics => []
2058 );
2059
2060 } else {
1455 $msg = $npc->name . " says: $msg" if $npc; 2061 $msg = $npc->name . " says: $msg" if $npc;
1456 $self->message ($msg, $flags); 2062 $self->message ($msg, $flags);
2063 }
1457 } 2064 }
1458} 2065}
1459 2066
1460=item $player_object->may ("access") 2067=item $player_object->may ("access")
1461 2068
1475 2082
1476=item $player_object->enter_link 2083=item $player_object->enter_link
1477 2084
1478Freezes the player and moves him/her to a special map (C<{link}>). 2085Freezes the player and moves him/her to a special map (C<{link}>).
1479 2086
1480The player should be reaosnably safe there for short amounts of time. You 2087The player should be reasonably safe there for short amounts of time. You
1481I<MUST> call C<leave_link> as soon as possible, though. 2088I<MUST> call C<leave_link> as soon as possible, though.
1482 2089
2090Will never block.
2091
1483=item $player_object->leave_link ($map, $x, $y) 2092=item $player_object->leave_link ($map, $x, $y)
1484 2093
1485Moves the player out of the specila link map onto the given map. If the 2094Moves the player out of the special C<{link}> map onto the specified
1486map is not valid (or omitted), the player will be moved back to the 2095map. If the map is not valid (or omitted), the player will be moved back
1487location he/she was before the call to C<enter_link>, or, if that fails, 2096to the location he/she was before the call to C<enter_link>, or, if that
1488to the emergency map position. 2097fails, to the emergency map position.
1489 2098
1490Might block. 2099Might block.
1491 2100
1492=cut 2101=cut
2102
2103sub link_map {
2104 unless ($LINK_MAP) {
2105 $LINK_MAP = cf::map::find "{link}"
2106 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2107 $LINK_MAP->load;
2108 }
2109
2110 $LINK_MAP
2111}
1493 2112
1494sub cf::object::player::enter_link { 2113sub cf::object::player::enter_link {
1495 my ($self) = @_; 2114 my ($self) = @_;
1496 2115
1497 $self->deactivate_recursive; 2116 $self->deactivate_recursive;
1498 2117
1499 return if $self->map == $LINK_MAP; 2118 return if UNIVERSAL::isa $self->map, "ext::map_link";
1500 2119
1501 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2120 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1502 if $self->map; 2121 if $self->map && $self->map->{path} ne "{link}";
1503 2122
1504 $self->enter_map ($LINK_MAP, 20, 20); 2123 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1505} 2124}
1506 2125
1507sub cf::object::player::leave_link { 2126sub cf::object::player::leave_link {
1508 my ($self, $map, $x, $y) = @_; 2127 my ($self, $map, $x, $y) = @_;
2128
2129 return unless $self->contr->active;
1509 2130
1510 my $link_pos = delete $self->{_link_pos}; 2131 my $link_pos = delete $self->{_link_pos};
1511 2132
1512 unless ($map) { 2133 unless ($map) {
1513 # restore original map position 2134 # restore original map position
1514 ($map, $x, $y) = @{ $link_pos || [] }; 2135 ($map, $x, $y) = @{ $link_pos || [] };
1515 $map = cf::map::find_map $map; 2136 $map = cf::map::find $map;
1516 2137
1517 unless ($map) { 2138 unless ($map) {
1518 ($map, $x, $y) = @$EMERGENCY_POSITION; 2139 ($map, $x, $y) = @$EMERGENCY_POSITION;
1519 $map = cf::map::find_map $map 2140 $map = cf::map::find $map
1520 or die "FATAL: cannot load emergency map\n"; 2141 or die "FATAL: cannot load emergency map\n";
1521 } 2142 }
1522 } 2143 }
1523 2144
1524 ($x, $y) = (-1, -1) 2145 ($x, $y) = (-1, -1)
1527 # use -1 or undef as default coordinates, not 0, 0 2148 # use -1 or undef as default coordinates, not 0, 0
1528 ($x, $y) = ($map->enter_x, $map->enter_y) 2149 ($x, $y) = ($map->enter_x, $map->enter_y)
1529 if $x <=0 && $y <= 0; 2150 if $x <=0 && $y <= 0;
1530 2151
1531 $map->load; 2152 $map->load;
2153 $map->load_diag;
1532 2154
2155 return unless $self->contr->active;
1533 $self->activate_recursive; 2156 $self->activate_recursive;
2157
2158 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1534 $self->enter_map ($map, $x, $y); 2159 $self->enter_map ($map, $x, $y);
1535} 2160}
1536 2161
1537cf::player->attach (
1538 on_logout => sub {
1539 my ($pl) = @_;
1540
1541 # abort map switching before logout
1542 if ($pl->ob->{_link_pos}) {
1543 cf::sync_job {
1544 $pl->ob->leave_link
1545 };
1546 }
1547 },
1548 on_login => sub {
1549 my ($pl) = @_;
1550
1551 # try to abort aborted map switching on player login :)
1552 # should happen only on crashes
1553 if ($pl->ob->{_link_pos}) {
1554 $pl->ob->enter_link;
1555 cf::async {
1556 # we need this sleep as the login has a concurrent enter_exit running
1557 # and this sleep increases chances of the player not ending up in scorn
1558 Coro::Timer::sleep 1;
1559 $pl->ob->leave_link;
1560 };
1561 }
1562 },
1563);
1564
1565=item $player_object->goto_map ($path, $x, $y) 2162=item $player_object->goto ($path, $x, $y[, $check->($map)])
1566 2163
1567=cut 2164Moves the player to the given map-path and coordinates by first freezing
2165her, loading and preparing them map, calling the provided $check callback
2166that has to return the map if sucecssful, and then unfreezes the player on
2167the new (success) or old (failed) map position.
1568 2168
2169=cut
2170
2171our $GOTOGEN;
2172
1569sub cf::object::player::goto_map { 2173sub cf::object::player::goto {
1570 my ($self, $path, $x, $y) = @_; 2174 my ($self, $path, $x, $y, $check) = @_;
2175
2176 # do generation counting so two concurrent goto's will be executed in-order
2177 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1571 2178
1572 $self->enter_link; 2179 $self->enter_link;
1573 2180
1574 (cf::async { 2181 (async {
1575 $path = new cf::path $path; 2182 my $map = eval {
1576
1577 my $map = cf::map::find_map $path->as_string; 2183 my $map = cf::map::find $path;
2184
2185 if ($map) {
1578 $map = $map->customise_for ($self) if $map; 2186 $map = $map->customise_for ($self);
1579 2187 $map = $check->($map) if $check && $map;
1580# warn "entering ", $map->path, " at ($x, $y)\n" 2188 } else {
1581# if $map;
1582
1583 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2189 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2190 }
1584 2191
2192 $map
2193 };
2194
2195 if ($@) {
2196 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2197 LOG llevError | logBacktrace, Carp::longmess $@;
2198 }
2199
2200 if ($gen == $self->{_goto_generation}) {
2201 delete $self->{_goto_generation};
1585 $self->leave_link ($map, $x, $y); 2202 $self->leave_link ($map, $x, $y);
2203 }
1586 })->prio (1); 2204 })->prio (1);
1587} 2205}
1588 2206
1589=item $player_object->enter_exit ($exit_object) 2207=item $player_object->enter_exit ($exit_object)
1590 2208
1592 2210
1593sub parse_random_map_params { 2211sub parse_random_map_params {
1594 my ($spec) = @_; 2212 my ($spec) = @_;
1595 2213
1596 my $rmp = { # defaults 2214 my $rmp = { # defaults
1597 xsize => 10, 2215 xsize => (cf::rndm 15, 40),
1598 ysize => 10, 2216 ysize => (cf::rndm 15, 40),
2217 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2218 #layout => string,
1599 }; 2219 };
1600 2220
1601 for (split /\n/, $spec) { 2221 for (split /\n/, $spec) {
1602 my ($k, $v) = split /\s+/, $_, 2; 2222 my ($k, $v) = split /\s+/, $_, 2;
1603 2223
1607 $rmp 2227 $rmp
1608} 2228}
1609 2229
1610sub prepare_random_map { 2230sub prepare_random_map {
1611 my ($exit) = @_; 2231 my ($exit) = @_;
2232
2233 my $guard = cf::lock_acquire "exit_prepare:$exit";
1612 2234
1613 # all this does is basically replace the /! path by 2235 # all this does is basically replace the /! path by
1614 # a new random map path (?random/...) with a seed 2236 # a new random map path (?random/...) with a seed
1615 # that depends on the exit object 2237 # that depends on the exit object
1616 2238
1617 my $rmp = parse_random_map_params $exit->msg; 2239 my $rmp = parse_random_map_params $exit->msg;
1618 2240
1619 if ($exit->map) { 2241 if ($exit->map) {
1620 $rmp->{region} = $exit->map->region_name; 2242 $rmp->{region} = $exit->region->name;
1621 $rmp->{origin_map} = $exit->map->path; 2243 $rmp->{origin_map} = $exit->map->path;
1622 $rmp->{origin_x} = $exit->x; 2244 $rmp->{origin_x} = $exit->x;
1623 $rmp->{origin_y} = $exit->y; 2245 $rmp->{origin_y} = $exit->y;
1624 } 2246 }
1625 2247
1626 $rmp->{random_seed} ||= $exit->random_seed; 2248 $rmp->{random_seed} ||= $exit->random_seed;
1627 2249
1628 my $data = cf::to_json $rmp; 2250 my $data = cf::to_json $rmp;
1629 my $md5 = Digest::MD5::md5_hex $data; 2251 my $md5 = Digest::MD5::md5_hex $data;
2252 my $meta = "$RANDOMDIR/$md5.meta";
1630 2253
1631 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2254 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1632 aio_write $fh, 0, (length $data), $data, 0; 2255 aio_write $fh, 0, (length $data), $data, 0;
2256 undef $fh;
2257 aio_rename "$meta~", $meta;
1633 2258
1634 $exit->slaying ("?random/$md5"); 2259 $exit->slaying ("?random/$md5");
1635 $exit->msg (undef); 2260 $exit->msg (undef);
1636 } 2261 }
1637} 2262}
1639sub cf::object::player::enter_exit { 2264sub cf::object::player::enter_exit {
1640 my ($self, $exit) = @_; 2265 my ($self, $exit) = @_;
1641 2266
1642 return unless $self->type == cf::PLAYER; 2267 return unless $self->type == cf::PLAYER;
1643 2268
2269 if ($exit->slaying eq "/!") {
2270 #TODO: this should de-fi-ni-te-ly not be a sync-job
2271 # the problem is that $exit might not survive long enough
2272 # so it needs to be done right now, right here
2273 cf::sync_job { prepare_random_map $exit };
2274 }
2275
2276 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2277 my $hp = $exit->stats->hp;
2278 my $sp = $exit->stats->sp;
2279
1644 $self->enter_link; 2280 $self->enter_link;
1645 2281
1646 (cf::async { 2282 (async {
2283 $self->deactivate_recursive; # just to be sure
1647 unless (eval { 2284 unless (eval {
1648 prepare_random_map $exit 2285 $self->goto ($slaying, $hp, $sp);
1649 if $exit->slaying eq "/!";
1650
1651 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1652 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1653 2286
1654 1; 2287 1;
1655 }) { 2288 }) {
1656 $self->message ("Something went wrong deep within the crossfire server. " 2289 $self->message ("Something went wrong deep within the crossfire server. "
1657 . "I'll try to bring you back to the map you were before. " 2290 . "I'll try to bring you back to the map you were before. "
1658 . "Please report this to the dungeon master", 2291 . "Please report this to the dungeon master!",
1659 cf::NDI_UNIQUE | cf::NDI_RED); 2292 cf::NDI_UNIQUE | cf::NDI_RED);
1660 2293
1661 warn "ERROR in enter_exit: $@"; 2294 warn "ERROR in enter_exit: $@";
1662 $self->leave_link; 2295 $self->leave_link;
1663 } 2296 }
1664 })->prio (1); 2297 })->prio (1);
1677 2310
1678sub cf::client::send_drawinfo { 2311sub cf::client::send_drawinfo {
1679 my ($self, $text, $flags) = @_; 2312 my ($self, $text, $flags) = @_;
1680 2313
1681 utf8::encode $text; 2314 utf8::encode $text;
1682 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2315 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1683} 2316}
1684 2317
2318=item $client->ext_event ($type, %msg)
2319
2320Sends an exti event to the client.
2321
2322=cut
2323
2324sub cf::client::ext_event($$%) {
2325 my ($self, $type, %msg) = @_;
2326
2327 $msg{msgtype} = "event_$type";
2328 $self->send_packet ("ext " . cf::to_json \%msg);
2329}
1685 2330
1686=item $success = $client->query ($flags, "text", \&cb) 2331=item $success = $client->query ($flags, "text", \&cb)
1687 2332
1688Queues a query to the client, calling the given callback with 2333Queues a query to the client, calling the given callback with
1689the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2334the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1718 # get handled first 2363 # get handled first
1719 my $queue = delete $ns->{query_queue} 2364 my $queue = delete $ns->{query_queue}
1720 or return; # be conservative, not sure how that can happen, but we saw a crash here 2365 or return; # be conservative, not sure how that can happen, but we saw a crash here
1721 2366
1722 (shift @$queue)->[1]->($msg); 2367 (shift @$queue)->[1]->($msg);
2368 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1723 2369
1724 push @{ $ns->{query_queue} }, @$queue; 2370 push @{ $ns->{query_queue} }, @$queue;
1725 2371
1726 if (@{ $ns->{query_queue} } == @$queue) { 2372 if (@{ $ns->{query_queue} } == @$queue) {
1727 if (@$queue) { 2373 if (@$queue) {
1731 } 2377 }
1732 } 2378 }
1733 }, 2379 },
1734); 2380);
1735 2381
1736=item $client->coro (\&cb) 2382=item $client->async (\&cb)
1737 2383
1738Create a new coroutine, running the specified callback. The coroutine will 2384Create a new coroutine, running the specified callback. The coroutine will
1739be automatically cancelled when the client gets destroyed (e.g. on logout, 2385be automatically cancelled when the client gets destroyed (e.g. on logout,
1740or loss of connection). 2386or loss of connection).
1741 2387
1742=cut 2388=cut
1743 2389
1744sub cf::client::coro { 2390sub cf::client::async {
1745 my ($self, $cb) = @_; 2391 my ($self, $cb) = @_;
1746 2392
1747 my $coro = &cf::async ($cb); 2393 my $coro = &Coro::async ($cb);
1748 2394
1749 $coro->on_destroy (sub { 2395 $coro->on_destroy (sub {
1750 delete $self->{_coro}{$coro+0}; 2396 delete $self->{_coro}{$coro+0};
1751 }); 2397 });
1752 2398
1785 2431
1786# here we export the classes and methods available to script code 2432# here we export the classes and methods available to script code
1787 2433
1788=pod 2434=pod
1789 2435
1790The following fucntions and emthods are available within a safe environment: 2436The following functions and methods are available within a safe environment:
1791 2437
1792 cf::object contr pay_amount pay_player map 2438 cf::object contr pay_amount pay_player map
1793 cf::object::player player 2439 cf::object::player player
1794 cf::player peaceful 2440 cf::player peaceful
1795 cf::map trigger 2441 cf::map trigger
1876=back 2522=back
1877 2523
1878=cut 2524=cut
1879 2525
1880############################################################################# 2526#############################################################################
2527# the server's init and main functions
1881 2528
1882=head2 EXTENSION DATABASE SUPPORT 2529sub load_facedata($) {
2530 my ($path) = @_;
1883 2531
1884Crossfire maintains a very simple database for extension use. It can 2532 warn "loading facedata from $path\n";
1885currently store anything that can be serialised using Storable, which
1886excludes objects.
1887 2533
1888The parameter C<$family> should best start with the name of the extension 2534 my $facedata;
1889using it, it should be unique. 2535 0 < aio_load $path, $facedata
2536 or die "$path: $!";
1890 2537
1891=over 4 2538 $facedata = Coro::Storable::thaw $facedata;
1892 2539
1893=item $hashref = cf::db_get $family 2540 $facedata->{version} == 2
2541 or cf::cleanup "$path: version mismatch, cannot proceed.";
1894 2542
1895Return a hashref for use by the extension C<$family>, which can be
1896modified. After modifications, you have to call C<cf::db_dirty> or
1897C<cf::db_sync>.
1898
1899=item $value = cf::db_get $family => $key
1900
1901Returns a single value from the database
1902
1903=item cf::db_put $family => $hashref
1904
1905Stores the given family hashref into the database. Updates are delayed, if
1906you want the data to be synced to disk immediately, use C<cf::db_sync>.
1907
1908=item cf::db_put $family => $key => $value
1909
1910Stores the given C<$value> in the family hash. Updates are delayed, if you
1911want the data to be synced to disk immediately, use C<cf::db_sync>.
1912
1913=item cf::db_dirty
1914
1915Marks the database as dirty, to be updated at a later time.
1916
1917=item cf::db_sync
1918
1919Immediately write the database to disk I<if it is dirty>.
1920
1921=cut
1922
1923our $DB;
1924
1925{
1926 my $path = cf::localdir . "/database.pst";
1927
1928 sub db_load() {
1929 $DB = stat $path ? Storable::retrieve $path : { };
1930 } 2543 {
2544 my $faces = $facedata->{faceinfo};
1931 2545
1932 my $pid; 2546 while (my ($face, $info) = each %$faces) {
1933 2547 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1934 sub db_save() { 2548 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
1935 waitpid $pid, 0 if $pid; 2549 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
1936 if (0 == ($pid = fork)) { 2550 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1937 $DB->{_meta}{version} = 1; 2551 Coro::cede;
1938 Storable::nstore $DB, "$path~";
1939 rename "$path~", $path;
1940 cf::_exit 0 if defined $pid;
1941 }
1942 }
1943
1944 my $dirty;
1945
1946 sub db_sync() {
1947 db_save if $dirty;
1948 undef $dirty;
1949 }
1950
1951 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1952 db_sync;
1953 });
1954
1955 sub db_dirty() {
1956 $dirty = 1;
1957 $idle->start;
1958 }
1959
1960 sub db_get($;$) {
1961 @_ >= 2
1962 ? $DB->{$_[0]}{$_[1]}
1963 : ($DB->{$_[0]} ||= { })
1964 }
1965
1966 sub db_put($$;$) {
1967 if (@_ >= 3) {
1968 $DB->{$_[0]}{$_[1]} = $_[2];
1969 } else {
1970 $DB->{$_[0]} = $_[1];
1971 }
1972 db_dirty;
1973 }
1974
1975 cf::global->attach (
1976 prio => 10000,
1977 on_cleanup => sub {
1978 db_sync;
1979 }, 2552 }
1980 );
1981}
1982 2553
1983############################################################################# 2554 while (my ($face, $info) = each %$faces) {
1984# the server's main() 2555 next unless $info->{smooth};
2556 my $idx = cf::face::find $face
2557 or next;
2558 if (my $smooth = cf::face::find $info->{smooth}) {
2559 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2560 } else {
2561 warn "smooth face '$info->{smooth}' not found for face '$face'";
2562 }
2563 Coro::cede;
2564 }
2565 }
2566
2567 {
2568 my $anims = $facedata->{animinfo};
2569
2570 while (my ($anim, $info) = each %$anims) {
2571 cf::anim::set $anim, $info->{frames}, $info->{facings};
2572 Coro::cede;
2573 }
2574
2575 cf::anim::invalidate_all; # d'oh
2576 }
2577
2578 1
2579}
2580
2581sub reload_regions {
2582 load_resource_file "$MAPDIR/regions"
2583 or die "unable to load regions file\n";
2584}
2585
2586sub reload_facedata {
2587 load_facedata "$DATADIR/facedata"
2588 or die "unable to load facedata\n";
2589}
2590
2591sub reload_archetypes {
2592 load_resource_file "$DATADIR/archetypes"
2593 or die "unable to load archetypes\n";
2594}
2595
2596sub reload_treasures {
2597 load_resource_file "$DATADIR/treasures"
2598 or die "unable to load treasurelists\n";
2599}
2600
2601sub reload_resources {
2602 warn "reloading resource files...\n";
2603
2604 reload_regions;
2605 reload_facedata;
2606 #reload_archetypes;#d#
2607 reload_archetypes;
2608 reload_treasures;
2609
2610 warn "finished reloading resource files\n";
2611}
2612
2613sub init {
2614 reload_resources;
2615}
1985 2616
1986sub cfg_load { 2617sub cfg_load {
1987 open my $fh, "<:utf8", cf::confdir . "/config" 2618 open my $fh, "<:utf8", "$CONFDIR/config"
1988 or return; 2619 or return;
1989 2620
1990 local $/; 2621 local $/;
1991 *CFG = YAML::Syck::Load <$fh>; 2622 *CFG = YAML::Syck::Load <$fh>;
1992 2623
1993 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2624 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994 2625
2626 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2627 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2628
1995 if (exists $CFG{mlockall}) { 2629 if (exists $CFG{mlockall}) {
1996 eval { 2630 eval {
1997 $CFG{mlockall} ? &mlockall : &munlockall 2631 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1998 and die "WARNING: m(un)lockall failed: $!\n"; 2632 and die "WARNING: m(un)lockall failed: $!\n";
1999 }; 2633 };
2000 warn $@ if $@; 2634 warn $@ if $@;
2001 } 2635 }
2002} 2636}
2003 2637
2004sub main { 2638sub main {
2005 # we must not ever block the main coroutine 2639 # we must not ever block the main coroutine
2006 local $Coro::idle = sub { 2640 local $Coro::idle = sub {
2007 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2641 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008 (Coro::unblock_sub { 2642 (async {
2009 Event::one_event; 2643 Event::one_event;
2010 })->(); 2644 })->prio (Coro::PRIO_MAX);
2011 }; 2645 };
2012 2646
2013 cfg_load; 2647 cfg_load;
2014 db_load; 2648 db_init;
2015 load_extensions; 2649 load_extensions;
2650
2651 $TICK_WATCHER->start;
2016 Event::loop; 2652 Event::loop;
2017} 2653}
2018 2654
2019############################################################################# 2655#############################################################################
2020# initialisation 2656# initialisation and cleanup
2021 2657
2658# install some emergency cleanup handlers
2659BEGIN {
2660 for my $signal (qw(INT HUP TERM)) {
2661 Event->signal (
2662 reentrant => 0,
2663 data => WF_AUTOCANCEL,
2664 signal => $signal,
2665 prio => 0,
2666 cb => sub {
2667 cf::cleanup "SIG$signal";
2668 },
2669 );
2670 }
2671}
2672
2673sub write_runtime {
2674 my $runtime = "$LOCALDIR/runtime";
2675
2676 # first touch the runtime file to show we are still running:
2677 # the fsync below can take a very very long time.
2678
2679 IO::AIO::aio_utime $runtime, undef, undef;
2680
2681 my $guard = cf::lock_acquire "write_runtime";
2682
2683 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2684 or return;
2685
2686 my $value = $cf::RUNTIME + 90 + 10;
2687 # 10 is the runtime save interval, for a monotonic clock
2688 # 60 allows for the watchdog to kill the server.
2689
2690 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2691 and return;
2692
2693 # always fsync - this file is important
2694 aio_fsync $fh
2695 and return;
2696
2697 # touch it again to show we are up-to-date
2698 aio_utime $fh, undef, undef;
2699
2700 close $fh
2701 or return;
2702
2703 aio_rename "$runtime~", $runtime
2704 and return;
2705
2706 warn "runtime file written.\n";
2707
2708 1
2709}
2710
2711sub emergency_save() {
2712 my $freeze_guard = cf::freeze_mainloop;
2713
2714 warn "enter emergency perl save\n";
2715
2716 cf::sync_job {
2717 # use a peculiar iteration method to avoid tripping on perl
2718 # refcount bugs in for. also avoids problems with players
2719 # and maps saved/destroyed asynchronously.
2720 warn "begin emergency player save\n";
2721 for my $login (keys %cf::PLAYER) {
2722 my $pl = $cf::PLAYER{$login} or next;
2723 $pl->valid or next;
2724 $pl->save;
2725 }
2726 warn "end emergency player save\n";
2727
2728 warn "begin emergency map save\n";
2729 for my $path (keys %cf::MAP) {
2730 my $map = $cf::MAP{$path} or next;
2731 $map->valid or next;
2732 $map->save;
2733 }
2734 warn "end emergency map save\n";
2735
2736 warn "begin emergency database checkpoint\n";
2737 BDB::db_env_txn_checkpoint $DB_ENV;
2738 warn "end emergency database checkpoint\n";
2739 };
2740
2741 warn "leave emergency perl save\n";
2742}
2743
2744sub post_cleanup {
2745 my ($make_core) = @_;
2746
2747 warn Carp::longmess "post_cleanup backtrace"
2748 if $make_core;
2749}
2750
2022sub reload() { 2751sub do_reload_perl() {
2023 # can/must only be called in main 2752 # can/must only be called in main
2024 if ($Coro::current != $Coro::main) { 2753 if ($Coro::current != $Coro::main) {
2025 warn "can only reload from main coroutine\n"; 2754 warn "can only reload from main coroutine";
2026 return; 2755 return;
2027 } 2756 }
2028 2757
2029 warn "reloading..."; 2758 warn "reloading...";
2030 2759
2031 local $FREEZE = 1; 2760 warn "entering sync_job";
2761
2762 cf::sync_job {
2763 cf::write_runtime; # external watchdog should not bark
2032 cf::emergency_save; 2764 cf::emergency_save;
2765 cf::write_runtime; # external watchdog should not bark
2033 2766
2034 eval { 2767 warn "syncing database to disk";
2768 BDB::db_env_txn_checkpoint $DB_ENV;
2769
2035 # if anything goes wrong in here, we should simply crash as we already saved 2770 # if anything goes wrong in here, we should simply crash as we already saved
2036 2771
2037 # cancel all watchers 2772 warn "cancelling all WF_AUTOCANCEL watchers";
2038 for (Event::all_watchers) { 2773 for (Event::all_watchers) {
2039 $_->cancel if $_->data & WF_AUTOCANCEL; 2774 $_->cancel if $_->data & WF_AUTOCANCEL;
2040 } 2775 }
2041 2776
2777 warn "flushing outstanding aio requests";
2778 for (;;) {
2779 BDB::flush;
2780 IO::AIO::flush;
2781 Coro::cede;
2782 last unless IO::AIO::nreqs || BDB::nreqs;
2783 warn "iterate...";
2784 }
2785
2786 ++$RELOAD;
2787
2042 # cancel all extension coros 2788 warn "cancelling all extension coros";
2043 $_->cancel for values %EXT_CORO; 2789 $_->cancel for values %EXT_CORO;
2044 %EXT_CORO = (); 2790 %EXT_CORO = ();
2045 2791
2046 # unload all extensions 2792 warn "removing commands";
2047 for (@exts) { 2793 %COMMAND = ();
2794
2795 warn "removing ext commands";
2796 %EXTCMD = ();
2797
2798 warn "unloading/nuking all extensions";
2799 for my $pkg (@EXTS) {
2048 warn "unloading <$_>"; 2800 warn "... unloading $pkg";
2049 unload_extension $_; 2801
2802 if (my $cb = $pkg->can ("unload")) {
2803 eval {
2804 $cb->($pkg);
2805 1
2806 } or warn "$pkg unloaded, but with errors: $@";
2050 } 2807 }
2051 2808
2809 warn "... nuking $pkg";
2810 Symbol::delete_package $pkg;
2811 }
2812
2052 # unload all modules loaded from $LIBDIR 2813 warn "unloading all perl modules loaded from $LIBDIR";
2053 while (my ($k, $v) = each %INC) { 2814 while (my ($k, $v) = each %INC) {
2054 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2815 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2055 2816
2056 warn "removing <$k>"; 2817 warn "... unloading $k";
2057 delete $INC{$k}; 2818 delete $INC{$k};
2058 2819
2059 $k =~ s/\.pm$//; 2820 $k =~ s/\.pm$//;
2060 $k =~ s/\//::/g; 2821 $k =~ s/\//::/g;
2061 2822
2064 } 2825 }
2065 2826
2066 Symbol::delete_package $k; 2827 Symbol::delete_package $k;
2067 } 2828 }
2068 2829
2069 # sync database to disk
2070 cf::db_sync;
2071 IO::AIO::flush;
2072
2073 # get rid of safe::, as good as possible 2830 warn "getting rid of safe::, as good as possible";
2074 Symbol::delete_package "safe::$_" 2831 Symbol::delete_package "safe::$_"
2075 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2832 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076 2833
2077 # remove register_script_function callbacks
2078 # TODO
2079
2080 # unload cf.pm "a bit" 2834 warn "unloading cf.pm \"a bit\"";
2081 delete $INC{"cf.pm"}; 2835 delete $INC{"cf.pm"};
2836 delete $INC{"cf/pod.pm"};
2082 2837
2083 # don't, removes xs symbols, too, 2838 # don't, removes xs symbols, too,
2084 # and global variables created in xs 2839 # and global variables created in xs
2085 #Symbol::delete_package __PACKAGE__; 2840 #Symbol::delete_package __PACKAGE__;
2086 2841
2087 # reload cf.pm 2842 warn "unload completed, starting to reload now";
2843
2088 warn "reloading cf.pm"; 2844 warn "reloading cf.pm";
2089 require cf; 2845 require cf;
2090 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2846 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2091 2847
2092 # load config and database again 2848 warn "loading config and database again";
2093 cf::cfg_load; 2849 cf::cfg_load;
2094 cf::db_load;
2095 2850
2096 # load extensions
2097 warn "load extensions"; 2851 warn "loading extensions";
2098 cf::load_extensions; 2852 cf::load_extensions;
2099 2853
2100 # reattach attachments to objects 2854 warn "reattaching attachments to objects/players";
2101 warn "reattach"; 2855 _global_reattach; # objects, sockets
2102 _global_reattach; 2856 warn "reattaching attachments to maps";
2103 }; 2857 reattach $_ for values %MAP;
2858 warn "reattaching attachments to players";
2859 reattach $_ for values %PLAYER;
2104 2860
2105 if ($@) { 2861 warn "leaving sync_job";
2862
2863 1
2864 } or do {
2106 warn $@; 2865 warn $@;
2107 warn "error while reloading, exiting."; 2866 warn "error while reloading, exiting.";
2108 exit 1; 2867 exit 1;
2109 } 2868 };
2110 2869
2111 warn "reloaded successfully"; 2870 warn "reloaded";
2112}; 2871};
2113 2872
2114############################################################################# 2873our $RELOAD_WATCHER; # used only during reload
2115 2874
2116unless ($LINK_MAP) { 2875sub reload_perl() {
2117 $LINK_MAP = cf::map::new; 2876 # doing reload synchronously and two reloads happen back-to-back,
2877 # coro crashes during coro_state_free->destroy here.
2118 2878
2119 $LINK_MAP->width (41); 2879 $RELOAD_WATCHER ||= Event->timer (
2120 $LINK_MAP->height (41); 2880 reentrant => 0,
2121 $LINK_MAP->alloc;
2122 $LINK_MAP->path ("{link}");
2123 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126 # dirty hack because... archetypes are not yet loaded
2127 Event->timer (
2128 after => 2, 2881 after => 0,
2882 data => WF_AUTOCANCEL,
2129 cb => sub { 2883 cb => sub {
2130 $_[0]->w->cancel; 2884 do_reload_perl;
2131 2885 undef $RELOAD_WATCHER;
2132 # provide some exits "home"
2133 my $exit = cf::object::new "exit";
2134
2135 $exit->slaying ($EMERGENCY_POSITION->[0]);
2136 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139 $LINK_MAP->insert ($exit->clone, 19, 19);
2140 $LINK_MAP->insert ($exit->clone, 19, 20);
2141 $LINK_MAP->insert ($exit->clone, 19, 21);
2142 $LINK_MAP->insert ($exit->clone, 20, 19);
2143 $LINK_MAP->insert ($exit->clone, 20, 21);
2144 $LINK_MAP->insert ($exit->clone, 21, 19);
2145 $LINK_MAP->insert ($exit->clone, 21, 20);
2146 $LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148 $exit->destroy;
2149 }); 2886 },
2150 2887 );
2151 $LINK_MAP->{deny_save} = 1;
2152 $LINK_MAP->{deny_reset} = 1;
2153
2154 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2155} 2888}
2156
2157register "<global>", __PACKAGE__;
2158 2889
2159register_command "reload" => sub { 2890register_command "reload" => sub {
2160 my ($who, $arg) = @_; 2891 my ($who, $arg) = @_;
2161 2892
2162 if ($who->flag (FLAG_WIZ)) { 2893 if ($who->flag (FLAG_WIZ)) {
2163 $who->message ("start of reload.");
2164 reload;
2165 $who->message ("end of reload."); 2894 $who->message ("reloading server.");
2895 async { reload_perl };
2166 } 2896 }
2167}; 2897};
2168 2898
2169unshift @INC, $LIBDIR; 2899unshift @INC, $LIBDIR;
2170 2900
2901my $bug_warning = 0;
2902
2903our @WAIT_FOR_TICK;
2904our @WAIT_FOR_TICK_BEGIN;
2905
2906sub wait_for_tick {
2907 return unless $TICK_WATCHER->is_active;
2908 return if $Coro::current == $Coro::main;
2909
2910 my $signal = new Coro::Signal;
2911 push @WAIT_FOR_TICK, $signal;
2912 $signal->wait;
2913}
2914
2915sub wait_for_tick_begin {
2916 return unless $TICK_WATCHER->is_active;
2917 return if $Coro::current == $Coro::main;
2918
2919 my $signal = new Coro::Signal;
2920 push @WAIT_FOR_TICK_BEGIN, $signal;
2921 $signal->wait;
2922}
2923
2924 my $min = 1e6;#d#
2925 my $avg = 10;
2171$TICK_WATCHER = Event->timer ( 2926$TICK_WATCHER = Event->timer (
2172 reentrant => 0, 2927 reentrant => 0,
2928 parked => 1,
2173 prio => 0, 2929 prio => 0,
2174 at => $NEXT_TICK || $TICK, 2930 at => $NEXT_TICK || $TICK,
2175 data => WF_AUTOCANCEL, 2931 data => WF_AUTOCANCEL,
2176 cb => sub { 2932 cb => sub {
2177 unless ($FREEZE) { 2933 if ($Coro::current != $Coro::main) {
2934 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2935 unless ++$bug_warning > 10;
2936 return;
2937 }
2938
2939 $NOW = $tick_start = Event::time;
2940
2178 cf::server_tick; # one server iteration 2941 cf::server_tick; # one server iteration
2179 $RUNTIME += $TICK; 2942
2943 0 && sync_job {#d#
2944 for(1..10) {
2945 my $t = Event::time;
2946 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2947 or die;
2948
2949 $map->width (50);
2950 $map->height (50);
2951 $map->alloc;
2952 $map->_load_objects ("/tmp/x.map", 1);
2953 my $t = Event::time - $t;
2954
2955 #next unless $t < 0.0013;#d#
2956 if ($t < $min) {
2957 $min = $t;
2958 }
2959 $avg = $avg * 0.99 + $t * 0.01;
2960 }
2961 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2962 exit 0;
2963 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2180 } 2964 };
2181 2965
2966 $RUNTIME += $TICK;
2182 $NEXT_TICK += $TICK; 2967 $NEXT_TICK += $TICK;
2183 2968
2969 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2970 $NEXT_RUNTIME_WRITE = $NOW + 10;
2971 Coro::async_pool {
2972 write_runtime
2973 or warn "ERROR: unable to write runtime file: $!";
2974 };
2975 }
2976
2977# my $AFTER = Event::time;
2978# warn $AFTER - $NOW;#d#
2979
2980 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2981 $sig->send;
2982 }
2983 while (my $sig = shift @WAIT_FOR_TICK) {
2984 $sig->send;
2985 }
2986
2987 $NOW = Event::time;
2988
2184 # if we are delayed by four ticks or more, skip them all 2989 # if we are delayed by four ticks or more, skip them all
2185 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2990 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2186 2991
2187 $TICK_WATCHER->at ($NEXT_TICK); 2992 $TICK_WATCHER->at ($NEXT_TICK);
2188 $TICK_WATCHER->start; 2993 $TICK_WATCHER->start;
2994
2995 $LOAD = ($NOW - $tick_start) / $TICK;
2996 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2997
2998 _post_tick;
2999
3000
2189 }, 3001 },
2190); 3002);
2191 3003
3004{
2192IO::AIO::max_poll_time $TICK * 0.2; 3005 BDB::max_poll_time $TICK * 0.1;
2193 3006 $BDB_POLL_WATCHER = Event->io (
2194Event->io ( 3007 reentrant => 0,
2195 fd => IO::AIO::poll_fileno, 3008 fd => BDB::poll_fileno,
2196 poll => 'r', 3009 poll => 'r',
2197 prio => 5, 3010 prio => 0,
2198 data => WF_AUTOCANCEL,
2199 cb => \&IO::AIO::poll_cb,
2200);
2201
2202Event->timer (
2203 data => WF_AUTOCANCEL, 3011 data => WF_AUTOCANCEL,
2204 after => 0, 3012 cb => \&BDB::poll_cb,
2205 interval => 10, 3013 );
2206 cb => sub { 3014 BDB::min_parallel 8;
2207 (Coro::unblock_sub { 3015
2208 write_runtime 3016 BDB::set_sync_prepare {
2209 or warn "ERROR: unable to write runtime file: $!"; 3017 my $status;
3018 my $current = $Coro::current;
3019 (
3020 sub {
3021 $status = $!;
3022 $current->ready; undef $current;
3023 },
3024 sub {
3025 Coro::schedule while defined $current;
3026 $! = $status;
3027 },
3028 )
3029 };
3030
3031 unless ($DB_ENV) {
3032 $DB_ENV = BDB::db_env_create;
3033
3034 cf::sync_job {
3035 eval {
3036 BDB::db_env_open
3037 $DB_ENV,
3038 $BDBDIR,
3039 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3040 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3041 0666;
3042
3043 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3044
3045 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3046 $DB_ENV->set_lk_detect;
3047 };
3048
3049 cf::cleanup "db_env_open(db): $@" if $@;
2210 })->(); 3050 };
2211 }, 3051 }
2212); 3052}
3053
3054{
3055 IO::AIO::min_parallel 8;
3056
3057 undef $Coro::AIO::WATCHER;
3058 IO::AIO::max_poll_time $TICK * 0.1;
3059 $AIO_POLL_WATCHER = Event->io (
3060 reentrant => 0,
3061 data => WF_AUTOCANCEL,
3062 fd => IO::AIO::poll_fileno,
3063 poll => 'r',
3064 prio => 6,
3065 cb => \&IO::AIO::poll_cb,
3066 );
3067}
3068
3069my $_log_backtrace;
3070
3071sub _log_backtrace {
3072 my ($msg, @addr) = @_;
3073
3074 $msg =~ s/\n//;
3075
3076 # limit the # of concurrent backtraces
3077 if ($_log_backtrace < 2) {
3078 ++$_log_backtrace;
3079 async {
3080 my @bt = fork_call {
3081 @addr = map { sprintf "%x", $_ } @addr;
3082 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3083 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3084 or die "addr2line: $!";
3085
3086 my @funcs;
3087 my @res = <$fh>;
3088 chomp for @res;
3089 while (@res) {
3090 my ($func, $line) = splice @res, 0, 2, ();
3091 push @funcs, "[$func] $line";
3092 }
3093
3094 @funcs
3095 };
3096
3097 LOG llevInfo, "[ABT] $msg\n";
3098 LOG llevInfo, "[ABT] $_\n" for @bt;
3099 --$_log_backtrace;
3100 };
3101 } else {
3102 LOG llevInfo, "[ABT] $msg\n";
3103 LOG llevInfo, "[ABT] [suppressed]\n";
3104 }
3105}
3106
3107# load additional modules
3108use cf::pod;
2213 3109
2214END { cf::emergency_save } 3110END { cf::emergency_save }
2215 3111
22161 31121
2217 3113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines