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.199 by root, Mon Jan 29 14:46:01 2007 UTC vs.
Revision 1.292 by root, Tue Jul 3 00:54:57 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.5 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use JSON::XS 1.4 ();
26use BDB ();
20use Data::Dumper; 27use Data::Dumper;
21use Digest::MD5; 28use Digest::MD5;
22use Fcntl; 29use Fcntl;
30use YAML::Syck ();
23use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
26 34
35# configure various modules to our taste
36#
37$Storable::canonical = 1; # reduce rsync transfers
38Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
39Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
40
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 41$Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 42
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 43# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1; 44$YAML::Syck::ImplicitUnicode = 1;
33 45
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 46$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 47
48sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
49
36our %COMMAND = (); 50our %COMMAND = ();
37our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
38 52
39our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
43 58
59our $RELOAD; # number of reloads so far
44our @EVENT; 60our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 61
47our $TICK = MAX_TIME * 1e-6; 62our $CONFDIR = confdir;
63our $DATADIR = datadir;
64our $LIBDIR = "$DATADIR/ext";
65our $PODDIR = "$DATADIR/pod";
66our $MAPDIR = "$DATADIR/" . mapdir;
67our $LOCALDIR = localdir;
68our $TMPDIR = "$LOCALDIR/" . tmpdir;
69our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
70our $PLAYERDIR = "$LOCALDIR/" . playerdir;
71our $RANDOMDIR = "$LOCALDIR/random";
72our $BDBDIR = "$LOCALDIR/db";
73
74our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48our $TICK_WATCHER; 75our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 76our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 77our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 78our $NEXT_TICK;
52our $NOW; 79our $NOW;
80our $USE_FSYNC = 1; # use fsync to write maps - default off
81
82our $BDB_POLL_WATCHER;
83our $DB_ENV;
53 84
54our %CFG; 85our %CFG;
55 86
56our $UPTIME; $UPTIME ||= time; 87our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 88our $RUNTIME;
58 89
59our %PLAYER; # all users 90our %PLAYER; # all users
60our %MAP; # all maps 91our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 92our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 93
67# used to convert map paths into valid unix filenames by replacing / by ∕ 94# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 95our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 96
97our $LOAD; # a number between 0 (idle) and 1 (too many objects)
98our $LOADAVG; # same thing, but with alpha-smoothing
99our $tick_start; # for load detecting purposes
100
70binmode STDOUT; 101binmode STDOUT;
71binmode STDERR; 102binmode STDERR;
72 103
73# read virtual server time, if available 104# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 105unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 106 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 107 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 108 $RUNTIME = <$fh> + 0.;
78} 109}
79 110
80mkdir cf::localdir; 111mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 112 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 113
86our $EMERGENCY_POSITION; 114our $EMERGENCY_POSITION;
87 115
88sub cf::map::normalise; 116sub cf::map::normalise;
89 117
100=item $cf::RUNTIME 128=item $cf::RUNTIME
101 129
102The time this server has run, starts at 0 and is increased by $cf::TICK on 130The time this server has run, starts at 0 and is increased by $cf::TICK on
103every server tick. 131every server tick.
104 132
105=item $cf::LIBDIR 133=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
134$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
135$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
106 136
107The perl library directory, where extensions and cf-specific modules can 137Various directories - "/etc", read-only install directory, perl-library
108be found. It will be added to C<@INC> automatically. 138directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
139unique-items directory, player file directory, random maps directory and
140database environment.
109 141
110=item $cf::NOW 142=item $cf::NOW
111 143
112The time of the last (current) server tick. 144The time of the last (current) server tick.
113 145
114=item $cf::TICK 146=item $cf::TICK
115 147
116The interval between server ticks, in seconds. 148The interval between server ticks, in seconds.
149
150=item $cf::LOADAVG
151
152The current CPU load on the server (alpha-smoothed), as a value between 0
153(none) and 1 (overloaded), indicating how much time is spent on processing
154objects per tick. Healthy values are < 0.5.
155
156=item $cf::LOAD
157
158The raw value load value from the last tick.
117 159
118=item %cf::CFG 160=item %cf::CFG
119 161
120Configuration for the server, loaded from C</etc/crossfire/config>, or 162Configuration for the server, loaded from C</etc/crossfire/config>, or
121from wherever your confdir points to. 163from wherever your confdir points to.
122 164
123=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 165=item cf::wait_for_tick, cf::wait_for_tick_begin
124 166
125These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 167These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
126or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 168returns directly I<after> the tick processing (and consequently, can only wake one process
127processing has been done. Call C<< ->wait >> on them to maximise the 169per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
128window of cpu time available, or simply to synchronise to the server tick.
129 170
130=back 171=back
131 172
132=cut 173=cut
133 174
134BEGIN { 175BEGIN {
135 *CORE::GLOBAL::warn = sub { 176 *CORE::GLOBAL::warn = sub {
136 my $msg = join "", @_; 177 my $msg = join "", @_;
137 utf8::encode $msg;
138 178
139 $msg .= "\n" 179 $msg .= "\n"
140 unless $msg =~ /\n$/; 180 unless $msg =~ /\n$/;
141 181
182 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
183
184 utf8::encode $msg;
142 LOG llevError, $msg; 185 LOG llevError, $msg;
143 }; 186 };
144} 187}
145 188
146@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 189@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
147@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 190@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
148@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 191@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
149@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 192@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
150@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 193@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
194@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
151@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 195@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
152 196
153# we bless all objects into (empty) derived classes to force a method lookup 197# we bless all objects into (empty) derived classes to force a method lookup
154# within the Safe compartment. 198# within the Safe compartment.
155for my $pkg (qw( 199for my $pkg (qw(
156 cf::global cf::attachable 200 cf::global cf::attachable
164} 208}
165 209
166$Event::DIED = sub { 210$Event::DIED = sub {
167 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
168}; 212};
213
214#############################################################################
169 215
170=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
171 217
172=over 4 218=over 4
173 219
192 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 238 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
193 $d 239 $d
194 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
195} 241}
196 242
197use JSON::Syck (); # TODO# replace by JSON::PC once working
198
199=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
200 244
201Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
202 246
203=cut
204
205sub from_json($) {
206 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
207 JSON::Syck::Load $_[0]
208}
209
210=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
211 248
212Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
213 250
214=cut 251=cut
215 252
216sub to_json($) { 253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
217 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 254
218 JSON::Syck::Dump $_[0] 255sub to_json ($) { $json_coder->encode ($_[0]) }
219} 256sub from_json ($) { $json_coder->decode ($_[0]) }
220 257
221=item cf::lock_wait $string 258=item cf::lock_wait $string
222 259
223Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
224 261
230returned. 267returned.
231 268
232Lock names should begin with a unique identifier (for example, cf::map::find 269Lock names should begin with a unique identifier (for example, cf::map::find
233uses map_find and cf::map::load uses map_load). 270uses map_find and cf::map::load uses map_load).
234 271
272=item $locked = cf::lock_active $string
273
274Return true if the lock is currently active, i.e. somebody has locked it.
275
235=cut 276=cut
236 277
237our %LOCK; 278our %LOCK;
238 279
239sub lock_wait($) { 280sub lock_wait($) {
258 # wake up all waiters, to be on the safe side 299 # wake up all waiters, to be on the safe side
259 $_->ready for @{ delete $LOCK{$key} }; 300 $_->ready for @{ delete $LOCK{$key} };
260 } 301 }
261} 302}
262 303
304sub lock_active($) {
305 my ($key) = @_;
306
307 ! ! $LOCK{$key}
308}
309
263sub freeze_mainloop { 310sub freeze_mainloop {
264 return unless $TICK_WATCHER->is_active; 311 return unless $TICK_WATCHER->is_active;
265 312
266 my $guard = Coro::guard { 313 my $guard = Coro::guard {
267 $TICK_WATCHER->start; 314 $TICK_WATCHER->start;
268 $WRITE_RUNTIME_WATCHER->start;
269 }; 315 };
270 $WRITE_RUNTIME_WATCHER->stop;
271 $TICK_WATCHER->stop; 316 $TICK_WATCHER->stop;
272 $guard 317 $guard
273} 318}
274 319
275=item cf::async { BLOCK } 320=item cf::async { BLOCK }
282 327
283BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
284 329
285=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
286 331
287The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 333is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
290 336
291If it must be done, put the blocking parts into C<sync_job>. This will run 337If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 339server will be frozen during this time, so the block should either finish
294fast or be very important. 340fast or be very important.
297 343
298sub sync_job(&) { 344sub sync_job(&) {
299 my ($job) = @_; 345 my ($job) = @_;
300 346
301 if ($Coro::current == $Coro::main) { 347 if ($Coro::current == $Coro::main) {
348 my $time = Event::time;
349
302 # this is the main coro, too bad, we have to block 350 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 351 # till the operation succeeds, freezing the server :/
304 352
305 # TODO: use suspend/resume instead 353 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 354 # (but this is cancel-safe)
317 365
318 while ($busy) { 366 while ($busy) {
319 Coro::cede or Event::one_event; 367 Coro::cede or Event::one_event;
320 } 368 }
321 369
370 $time = Event::time - $time;
371
372 LOG llevError | logBacktrace, Carp::longmess "long sync job"
373 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
374
375 $tick_start += $time; # do not account sync jobs to server load
376
322 wantarray ? @res : $res[0] 377 wantarray ? @res : $res[0]
323 } else { 378 } else {
324 # we are in another coroutine, how wonderful, everything just works 379 # we are in another coroutine, how wonderful, everything just works
325 380
326 $job->() 381 $job->()
345 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
346 401
347 $coro 402 $coro
348} 403}
349 404
350sub write_runtime { 405=item fork_call { }, $args
351 my $runtime = cf::localdir . "/runtime";
352 406
353 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 407Executes the given code block with the given arguments in a seperate
354 or return; 408process, returning the results. Everything must be serialisable with
409Coro::Storable. May, of course, block. Note that the executed sub may
410never block itself or use any form of Event handling.
355 411
356 my $value = $cf::RUNTIME + 90 + 10; 412=cut
357 # 10 is the runtime save interval, for a monotonic clock
358 # 60 allows for the watchdog to kill the server.
359 413
360 (aio_write $fh, 0, (length $value), $value, 0) <= 0 414sub fork_call(&@) {
361 and return; 415 my ($cb, @args) = @_;
362 416
363 aio_fsync $fh 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
364 and return; 418# or die "socketpair: $!";
419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
365 421
422 if (my $pid = fork) {
366 close $fh 423 close $fh2;
367 or return;
368 424
369 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
370 and return; 426 $res = Coro::Storable::thaw $res;
371 427
428 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
429
430 die $$res unless "ARRAY" eq ref $res;
431
432 return wantarray ? @$res : $res->[-1];
433 } else {
434 reset_signals;
435 local $SIG{__WARN__};
436 local $SIG{__DIE__};
437 eval {
438 close $fh1;
439
440 my @res = eval { $cb->(@args) };
441 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
442 };
443
444 warn $@ if $@;
445 _exit 0;
372 1 446 }
447}
448
449=item $value = cf::db_get $family => $key
450
451Returns a single value from the environment database.
452
453=item cf::db_put $family => $key => $value
454
455Stores the given C<$value> in the family. It can currently store binary
456data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
457
458=cut
459
460our $DB;
461
462sub db_init {
463 unless ($DB) {
464 $DB = BDB::db_create $DB_ENV;
465
466 cf::sync_job {
467 eval {
468 $DB->set_flags (BDB::CHKSUM);
469
470 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
471 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
472 cf::cleanup "db_open(db): $!" if $!;
473 };
474 cf::cleanup "db_open(db): $@" if $@;
475 };
476 }
477}
478
479sub db_get($$) {
480 my $key = "$_[0]/$_[1]";
481
482 cf::sync_job {
483 BDB::db_get $DB, undef, $key, my $data;
484
485 $! ? ()
486 : $data
487 }
488}
489
490sub db_put($$$) {
491 BDB::dbreq_pri 4;
492 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
493}
494
495=item cf::cache $id => [$paths...], $processversion => $process
496
497Generic caching function that returns the value of the resource $id,
498caching and regenerating as required.
499
500This function can block.
501
502=cut
503
504sub cache {
505 my ($id, $src, $processversion, $process) = @_;
506
507 my $meta =
508 join "\x00",
509 $processversion,
510 map {
511 aio_stat $_
512 and Carp::croak "$_: $!";
513
514 ($_, (stat _)[7,9])
515 } @$src;
516
517 my $dbmeta = db_get cache => "$id/meta";
518 if ($dbmeta ne $meta) {
519 # changed, we may need to process
520
521 my @data;
522 my $md5;
523
524 for (0 .. $#$src) {
525 0 <= aio_load $src->[$_], $data[$_]
526 or Carp::croak "$src->[$_]: $!";
527 }
528
529 # if processing is expensive, check
530 # checksum first
531 if (1) {
532 $md5 =
533 join "\x00",
534 $processversion,
535 map {
536 Coro::cede;
537 ($src->[$_], Digest::MD5::md5_hex $data[$_])
538 } 0.. $#$src;
539
540
541 my $dbmd5 = db_get cache => "$id/md5";
542 if ($dbmd5 eq $md5) {
543 db_put cache => "$id/meta", $meta;
544
545 return db_get cache => "$id/data";
546 }
547 }
548
549 my $t1 = Time::HiRes::time;
550 my $data = $process->(\@data);
551 my $t2 = Time::HiRes::time;
552
553 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
554
555 db_put cache => "$id/data", $data;
556 db_put cache => "$id/md5" , $md5;
557 db_put cache => "$id/meta", $meta;
558
559 return $data;
560 }
561
562 db_get cache => "$id/data"
563}
564
565=item cf::datalog type => key => value, ...
566
567Log a datalog packet of the given type with the given key-value pairs.
568
569=cut
570
571sub datalog($@) {
572 my ($type, %kv) = @_;
573 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
373} 574}
374 575
375=back 576=back
376 577
377=cut 578=cut
384attach callbacks/event handlers (a collection of which is called an "attachment") 585attach callbacks/event handlers (a collection of which is called an "attachment")
385to it. All such attachable objects support the following methods. 586to it. All such attachable objects support the following methods.
386 587
387In the following description, CLASS can be any of C<global>, C<object> 588In the following description, CLASS can be any of C<global>, C<object>
388C<player>, C<client> or C<map> (i.e. the attachable objects in 589C<player>, C<client> or C<map> (i.e. the attachable objects in
389crossfire+). 590Crossfire TRT).
390 591
391=over 4 592=over 4
392 593
393=item $attachable->attach ($attachment, key => $value...) 594=item $attachable->attach ($attachment, key => $value...)
394 595
557 $registry = $CB_TYPE[$object_type] ||= []; 758 $registry = $CB_TYPE[$object_type] ||= [];
558 759
559 } elsif ($type eq "subtype") { 760 } elsif ($type eq "subtype") {
560 defined $object_type or Carp::croak "subtype specified without type"; 761 defined $object_type or Carp::croak "subtype specified without type";
561 my $object_subtype = shift @arg; 762 my $object_subtype = shift @arg;
562 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 763 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
563 764
564 } elsif ($type eq "package") { 765 } elsif ($type eq "package") {
565 my $pkg = shift @arg; 766 my $pkg = shift @arg;
566 767
567 while (my ($name, $id) = each %cb_id) { 768 while (my ($name, $id) = each %cb_id) {
596 _attach $registry, $klass, @attach; 797 _attach $registry, $klass, @attach;
597 } 798 }
598 799
599 $obj->{$name} = \%arg; 800 $obj->{$name} = \%arg;
600 } else { 801 } else {
601 warn "object uses attachment '$name' that is not available, postponing.\n"; 802 warn "object uses attachment '$name' which is not available, postponing.\n";
602 } 803 }
603 804
604 $obj->{_attachment}{$name} = undef; 805 $obj->{_attachment}{$name} = undef;
605} 806}
606 807
608 if (ref $_[0]) { 809 if (ref $_[0]) {
609 _object_attach @_; 810 _object_attach @_;
610 } else { 811 } else {
611 _attach shift->_attach_registry, @_; 812 _attach shift->_attach_registry, @_;
612 } 813 }
814 _recalc_want;
613}; 815};
614 816
615# all those should be optimised 817# all those should be optimised
616sub cf::attachable::detach { 818sub cf::attachable::detach {
617 my ($obj, $name) = @_; 819 my ($obj, $name) = @_;
620 delete $obj->{_attachment}{$name}; 822 delete $obj->{_attachment}{$name};
621 reattach ($obj); 823 reattach ($obj);
622 } else { 824 } else {
623 Carp::croak "cannot, currently, detach class attachments"; 825 Carp::croak "cannot, currently, detach class attachments";
624 } 826 }
827 _recalc_want;
625}; 828};
626 829
627sub cf::attachable::attached { 830sub cf::attachable::attached {
628 my ($obj, $name) = @_; 831 my ($obj, $name) = @_;
629 832
752 $filename, length $$rdata, scalar @$objs; 955 $filename, length $$rdata, scalar @$objs;
753 956
754 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 957 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755 chmod SAVE_MODE, $fh; 958 chmod SAVE_MODE, $fh;
756 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 959 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
757 aio_fsync $fh; 960 aio_fsync $fh if $cf::USE_FSYNC;
758 close $fh; 961 close $fh;
759 962
760 if (@$objs) { 963 if (@$objs) {
761 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 964 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
762 chmod SAVE_MODE, $fh; 965 chmod SAVE_MODE, $fh;
763 my $data = Storable::nfreeze { version => 1, objs => $objs }; 966 my $data = Storable::nfreeze { version => 1, objs => $objs };
764 aio_write $fh, 0, (length $data), $data, 0; 967 aio_write $fh, 0, (length $data), $data, 0;
765 aio_fsync $fh; 968 aio_fsync $fh if $cf::USE_FSYNC;
766 close $fh; 969 close $fh;
767 aio_rename "$filename.pst~", "$filename.pst"; 970 aio_rename "$filename.pst~", "$filename.pst";
768 } 971 }
769 } else { 972 } else {
770 aio_unlink "$filename.pst"; 973 aio_unlink "$filename.pst";
802 or return; 1005 or return;
803 $av = eval { (Storable::thaw $av)->{objs} }; 1006 $av = eval { (Storable::thaw $av)->{objs} };
804 } 1007 }
805 1008
806 warn sprintf "loading %s (%d)\n", 1009 warn sprintf "loading %s (%d)\n",
807 $filename, length $data, scalar @{$av || []};#d# 1010 $filename, length $data, scalar @{$av || []};
808 return ($data, $av); 1011 return ($data, $av);
809} 1012}
1013
1014=head2 COMMAND CALLBACKS
1015
1016=over 4
1017
1018=cut
810 1019
811############################################################################# 1020#############################################################################
812# command handling &c 1021# command handling &c
813 1022
814=item cf::register_command $name => \&callback($ob,$args); 1023=item cf::register_command $name => \&callback($ob,$args);
827 push @{ $COMMAND{$name} }, [$caller, $cb]; 1036 push @{ $COMMAND{$name} }, [$caller, $cb];
828} 1037}
829 1038
830=item cf::register_extcmd $name => \&callback($pl,$packet); 1039=item cf::register_extcmd $name => \&callback($pl,$packet);
831 1040
832Register a callbackf ro execution when the client sends an extcmd packet. 1041Register a callback for execution when the client sends an (synchronous)
1042extcmd packet. Ext commands will be processed in the order they are
1043received by the server, like other user commands. The first argument is
1044the logged-in player. Ext commands can only be processed after a player
1045has logged in successfully.
833 1046
834If the callback returns something, it is sent back as if reply was being 1047If the callback returns something, it is sent back as if reply was being
835called. 1048called.
836 1049
1050=item cf::register_exticmd $name => \&callback($ns,$packet);
1051
1052Register a callback for execution when the client sends an (asynchronous)
1053exticmd packet. Exti commands are processed by the server as soon as they
1054are received, i.e. out of order w.r.t. other commands. The first argument
1055is a client socket. Exti commands can be received anytime, even before
1056log-in.
1057
1058If the callback returns something, it is sent back as if reply was being
1059called.
1060
837=cut 1061=cut
838 1062
839sub register_extcmd { 1063sub register_extcmd {
840 my ($name, $cb) = @_; 1064 my ($name, $cb) = @_;
841 1065
842 $EXTCMD{$name} = $cb; 1066 $EXTCMD{$name} = $cb;
1067}
1068
1069sub register_exticmd {
1070 my ($name, $cb) = @_;
1071
1072 $EXTICMD{$name} = $cb;
843} 1073}
844 1074
845cf::player->attach ( 1075cf::player->attach (
846 on_command => sub { 1076 on_command => sub {
847 my ($pl, $name, $params) = @_; 1077 my ($pl, $name, $params) = @_;
856 cf::override; 1086 cf::override;
857 }, 1087 },
858 on_extcmd => sub { 1088 on_extcmd => sub {
859 my ($pl, $buf) = @_; 1089 my ($pl, $buf) = @_;
860 1090
861 my $msg = eval { from_json $buf }; 1091 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
862 1092
863 if (ref $msg) { 1093 if (ref $msg) {
864 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1094 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
865 if (my %reply = $cb->($pl, $msg)) { 1095 if (my %reply = $cb->($pl, $msg)) {
866 $pl->ext_reply ($msg->{msgid}, %reply); 1096 $pl->ext_reply ($msg->{msgid}, %reply);
872 1102
873 cf::override; 1103 cf::override;
874 }, 1104 },
875); 1105);
876 1106
877sub load_extension {
878 my ($path) = @_;
879
880 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
881 my $base = $1;
882 my $pkg = $1;
883 $pkg =~ s/[^[:word:]]/_/g;
884 $pkg = "ext::$pkg";
885
886 warn "... loading '$path' into '$pkg'\n";
887
888 open my $fh, "<:utf8", $path
889 or die "$path: $!";
890
891 my $source =
892 "package $pkg; use strict; use utf8;\n"
893 . "#line 1 \"$path\"\n{\n"
894 . (do { local $/; <$fh> })
895 . "\n};\n1";
896
897 unless (eval $source) {
898 my $msg = $@ ? "$path: $@\n"
899 : "extension disabled.\n";
900 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
901 warn $@;
902 warn "mandatory extension failed to load, exiting.\n";
903 exit 1;
904 }
905 die $@;
906 }
907
908 push @EXTS, $pkg;
909}
910
911sub load_extensions { 1107sub load_extensions {
1108 cf::sync_job {
1109 my %todo;
1110
912 for my $ext (<$LIBDIR/*.ext>) { 1111 for my $path (<$LIBDIR/*.ext>) {
913 next unless -r $ext; 1112 next unless -r $path;
914 eval { 1113
915 load_extension $ext; 1114 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1115 my $base = $1;
1116 my $pkg = $1;
1117 $pkg =~ s/[^[:word:]]/_/g;
1118 $pkg = "ext::$pkg";
1119
1120 open my $fh, "<:utf8", $path
1121 or die "$path: $!";
1122
1123 my $source = do { local $/; <$fh> };
1124
1125 my %ext = (
1126 path => $path,
1127 base => $base,
1128 pkg => $pkg,
1129 );
1130
1131 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1132 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1133
1134 $ext{source} =
1135 "package $pkg; use strict; use utf8;\n"
1136 . "#line 1 \"$path\"\n{\n"
1137 . $source
1138 . "\n};\n1";
1139
1140 $todo{$base} = \%ext;
1141 }
1142
1143 my %done;
1144 while (%todo) {
1145 my $progress;
1146
1147 while (my ($k, $v) = each %todo) {
1148 for (split /,\s*/, $v->{meta}{depends}) {
1149 goto skip
1150 unless exists $done{$_};
1151 }
1152
1153 warn "... loading '$k' into '$v->{pkg}'\n";
1154
1155 unless (eval $v->{source}) {
1156 my $msg = $@ ? "$v->{path}: $@\n"
1157 : "$v->{base}: extension inactive.\n";
1158
1159 if (exists $v->{meta}{mandatory}) {
1160 warn $msg;
1161 warn "mandatory extension failed to load, exiting.\n";
1162 exit 1;
1163 }
1164
1165 warn $msg;
1166 }
1167
1168 $done{$k} = delete $todo{$k};
1169 push @EXTS, $v->{pkg};
1170 $progress = 1;
916 1 1171 }
917 } or warn "$ext not loaded: $@"; 1172
1173 skip:
1174 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1175 unless $progress;
1176 }
918 } 1177 };
919} 1178}
920 1179
921############################################################################# 1180#############################################################################
922 1181
1182=back
1183
923=head2 CORE EXTENSIONS 1184=head2 CORE EXTENSIONS
924 1185
925Functions and methods that extend core crossfire objects. 1186Functions and methods that extend core crossfire objects.
926 1187
927=cut 1188=cut
939Returns the given player object, loading it if necessary (might block). 1200Returns the given player object, loading it if necessary (might block).
940 1201
941=cut 1202=cut
942 1203
943sub playerdir($) { 1204sub playerdir($) {
944 cf::localdir 1205 "$PLAYERDIR/"
945 . "/"
946 . cf::playerdir
947 . "/"
948 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1206 . (ref $_[0] ? $_[0]->ob->name : $_[0])
949} 1207}
950 1208
951sub path($) { 1209sub path($) {
952 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1210 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
953 1211
954 (playerdir $login) . "/$login.pl" 1212 (playerdir $login) . "/playerdata"
955} 1213}
956 1214
957sub find_active($) { 1215sub find_active($) {
958 $cf::PLAYER{$_[0]} 1216 $cf::PLAYER{$_[0]}
959 and $cf::PLAYER{$_[0]}->active 1217 and $cf::PLAYER{$_[0]}->active
972 my $login = $_[0]; 1230 my $login = $_[0];
973 1231
974 my $guard = cf::lock_acquire "user_find:$login"; 1232 my $guard = cf::lock_acquire "user_find:$login";
975 1233
976 $cf::PLAYER{$_[0]} || do { 1234 $cf::PLAYER{$_[0]} || do {
1235 # rename old playerfiles to new ones
1236 #TODO: remove when no longer required
1237 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1238 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1239 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1240 aio_unlink +(playerdir $login) . "/$login.pl";
1241
977 my $pl = load_pl path $login 1242 my $pl = load_pl path $login
978 or return; 1243 or return;
979 $cf::PLAYER{$login} = $pl 1244 $cf::PLAYER{$login} = $pl
980 } 1245 }
981 } 1246 }
1018 1283
1019=cut 1284=cut
1020 1285
1021sub quit_character { 1286sub quit_character {
1022 my ($pl) = @_; 1287 my ($pl) = @_;
1288
1289 my $name = $pl->ob->name;
1023 1290
1024 $pl->{deny_save} = 1; 1291 $pl->{deny_save} = 1;
1025 $pl->password ("*"); # this should lock out the player until we nuked the dir 1292 $pl->password ("*"); # this should lock out the player until we nuked the dir
1026 1293
1027 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1294 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1032 my $path = playerdir $pl; 1299 my $path = playerdir $pl;
1033 my $temp = "$path~$cf::RUNTIME~deleting~"; 1300 my $temp = "$path~$cf::RUNTIME~deleting~";
1034 aio_rename $path, $temp; 1301 aio_rename $path, $temp;
1035 delete $cf::PLAYER{$pl->ob->name}; 1302 delete $cf::PLAYER{$pl->ob->name};
1036 $pl->destroy; 1303 $pl->destroy;
1304
1305 my $prefix = qr<^~\Q$name\E/>;
1306
1307 # nuke player maps
1308 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1309
1037 IO::AIO::aio_rmtree $temp; 1310 IO::AIO::aio_rmtree $temp;
1311}
1312
1313=item $pl->kick
1314
1315Kicks a player out of the game. This destroys the connection.
1316
1317=cut
1318
1319sub kick {
1320 my ($pl, $kicker) = @_;
1321
1322 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1323 $pl->killer ("kicked");
1324 $pl->ns->destroy;
1038} 1325}
1039 1326
1040=item cf::player::list_logins 1327=item cf::player::list_logins
1041 1328
1042Returns am arrayref of all valid playernames in the system, can take a 1329Returns am arrayref of all valid playernames in the system, can take a
1043while and may block, so not sync_job-capable, ever. 1330while and may block, so not sync_job-capable, ever.
1044 1331
1045=cut 1332=cut
1046 1333
1047sub list_logins { 1334sub list_logins {
1048 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1335 my $dirs = aio_readdir $PLAYERDIR
1049 or return []; 1336 or return [];
1050 1337
1051 my @logins; 1338 my @logins;
1052 1339
1053 for my $login (@$dirs) { 1340 for my $login (@$dirs) {
1070=cut 1357=cut
1071 1358
1072sub maps($) { 1359sub maps($) {
1073 my ($pl) = @_; 1360 my ($pl) = @_;
1074 1361
1362 $pl = ref $pl ? $pl->ob->name : $pl;
1363
1075 my $files = aio_readdir playerdir $pl 1364 my $files = aio_readdir playerdir $pl
1076 or return; 1365 or return;
1077 1366
1078 my @paths; 1367 my @paths;
1079 1368
1080 for (@$files) { 1369 for (@$files) {
1081 utf8::decode $_; 1370 utf8::decode $_;
1082 next if /\.(?:pl|pst)$/; 1371 next if /\.(?:pl|pst)$/;
1083 next unless /^$PATH_SEP/o; 1372 next unless /^$PATH_SEP/o;
1084 1373
1085 push @paths, cf::map::normalise "~" . $pl->ob->name . "/" . $_; 1374 push @paths, cf::map::normalise "~$pl/$_";
1086 } 1375 }
1087 1376
1088 \@paths 1377 \@paths
1089} 1378}
1090 1379
1380=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1381
1382Expand crossfire pod fragments into protocol xml.
1383
1384=cut
1385
1386sub expand_cfpod {
1387 ((my $self), (local $_)) = @_;
1388
1389 # escape & and <
1390 s/&/&amp;/g;
1391 s/(?<![BIUGH])</&lt;/g;
1392
1393 # this is buggy, it needs to properly take care of nested <'s
1394
1395 1 while
1396 # replace B<>, I<>, U<> etc.
1397 s/B<([^\>]*)>/<b>$1<\/b>/
1398 || s/I<([^\>]*)>/<i>$1<\/i>/
1399 || s/U<([^\>]*)>/<u>$1<\/u>/
1400 # replace G<male|female> tags
1401 || s{G<([^>|]*)\|([^>]*)>}{
1402 $self->gender ? $2 : $1
1403 }ge
1404 # replace H<hint text>
1405 || s{H<([^\>]*)>}
1406 {
1407 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1408 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1409 "")
1410 [$self->{hintmode}]
1411 }ge;
1412
1413 # create single paragraphs (very hackish)
1414 s/(?<=\S)\n(?=\w)/ /g;
1415
1416 # compress some whitespace
1417 1 while s/\s*\n\s*\n\s*/\n/;
1418
1419 $_
1420}
1421
1422sub hintmode {
1423 $_[0]{hintmode} = $_[1] if @_ > 1;
1424 $_[0]{hintmode}
1425}
1426
1091=item $player->ext_reply ($msgid, $msgtype, %msg) 1427=item $player->ext_reply ($msgid, %msg)
1092 1428
1093Sends an ext reply to the player. 1429Sends an ext reply to the player.
1094 1430
1095=cut 1431=cut
1096 1432
1097sub ext_reply($$$%) { 1433sub ext_reply($$%) {
1098 my ($self, $id, %msg) = @_; 1434 my ($self, $id, %msg) = @_;
1099 1435
1100 $msg{msgid} = $id; 1436 $msg{msgid} = $id;
1101 1437 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1102 $self->send ("ext " . cf::to_json \%msg);
1103} 1438}
1104 1439
1105package cf; 1440=item $player->ext_event ($type, %msg)
1441
1442Sends an ext event to the client.
1443
1444=cut
1445
1446sub ext_event($$%) {
1447 my ($self, $type, %msg) = @_;
1448
1449 $self->ns->ext_event ($type, %msg);
1450}
1451
1452=head3 cf::region
1453
1454=over 4
1455
1456=cut
1457
1458package cf::region;
1459
1460=item cf::region::find_by_path $path
1461
1462Tries to decuce the likely region for a map knowing only its path.
1463
1464=cut
1465
1466sub find_by_path($) {
1467 my ($path) = @_;
1468
1469 my ($match, $specificity);
1470
1471 for my $region (list) {
1472 if ($region->match && $path =~ $region->match) {
1473 ($match, $specificity) = ($region, $region->specificity)
1474 if $region->specificity > $specificity;
1475 }
1476 }
1477
1478 $match
1479}
1106 1480
1107=back 1481=back
1108
1109 1482
1110=head3 cf::map 1483=head3 cf::map
1111 1484
1112=over 4 1485=over 4
1113 1486
1168 my ($self, $merge) = @_; 1541 my ($self, $merge) = @_;
1169 1542
1170 # we have to keep some variables in memory intact 1543 # we have to keep some variables in memory intact
1171 local $self->{path}; 1544 local $self->{path};
1172 local $self->{load_path}; 1545 local $self->{load_path};
1173 local $self->{deny_save};
1174 local $self->{deny_reset};
1175 1546
1176 $self->SUPER::thawer_merge ($merge); 1547 $self->SUPER::thawer_merge ($merge);
1177} 1548}
1178 1549
1179sub normalise { 1550sub normalise {
1251 1622
1252# the original (read-only) location 1623# the original (read-only) location
1253sub load_path { 1624sub load_path {
1254 my ($self) = @_; 1625 my ($self) = @_;
1255 1626
1256 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1627 "$MAPDIR/$self->{path}.map"
1257} 1628}
1258 1629
1259# the temporary/swap location 1630# the temporary/swap location
1260sub save_path { 1631sub save_path {
1261 my ($self) = @_; 1632 my ($self) = @_;
1262 1633
1263 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1634 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1264 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1635 "$TMPDIR/$path.map"
1265} 1636}
1266 1637
1267# the unique path, undef == no special unique path 1638# the unique path, undef == no special unique path
1268sub uniq_path { 1639sub uniq_path {
1269 my ($self) = @_; 1640 my ($self) = @_;
1270 1641
1271 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1642 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1272 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1643 "$UNIQUEDIR/$path"
1273} 1644}
1274 1645
1275# and all this just because we cannot iterate over 1646# and all this just because we cannot iterate over
1276# all maps in C++... 1647# all maps in C++...
1277sub change_all_map_light { 1648sub change_all_map_light {
1279 1650
1280 $_->change_map_light ($change) 1651 $_->change_map_light ($change)
1281 for grep $_->outdoor, values %cf::MAP; 1652 for grep $_->outdoor, values %cf::MAP;
1282} 1653}
1283 1654
1655sub decay_objects {
1656 my ($self) = @_;
1657
1658 return if $self->{deny_reset};
1659
1660 $self->do_decay_objects;
1661}
1662
1284sub unlink_save { 1663sub unlink_save {
1285 my ($self) = @_; 1664 my ($self) = @_;
1286 1665
1287 utf8::encode (my $save = $self->save_path); 1666 utf8::encode (my $save = $self->save_path);
1288 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1667 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1291 1670
1292sub load_header_from($) { 1671sub load_header_from($) {
1293 my ($self, $path) = @_; 1672 my ($self, $path) = @_;
1294 1673
1295 utf8::encode $path; 1674 utf8::encode $path;
1296 aio_open $path, O_RDONLY, 0 1675 #aio_open $path, O_RDONLY, 0
1297 or return; 1676 # or return;
1298 1677
1299 $self->_load_header ($path) 1678 $self->_load_header ($path)
1300 or return; 1679 or return;
1301 1680
1302 $self->{load_path} = $path; 1681 $self->{load_path} = $path;
1344 $self->load_header_orig 1723 $self->load_header_orig
1345 or return; 1724 or return;
1346 $self->prepare_orig; 1725 $self->prepare_orig;
1347 } 1726 }
1348 1727
1728 $self->{deny_reset} = 1
1729 if $self->no_reset;
1730
1731 $self->default_region (cf::region::find_by_path $self->{path})
1732 unless $self->default_region;
1733
1349 1 1734 1
1350} 1735}
1351 1736
1352sub find; 1737sub find;
1353sub find { 1738sub find {
1365 $map->{last_save} = $cf::RUNTIME; 1750 $map->{last_save} = $cf::RUNTIME;
1366 1751
1367 $map->load_header 1752 $map->load_header
1368 or return; 1753 or return;
1369 1754
1370 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1755 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1371 # doing this can freeze the server in a sync job, obviously 1756 # doing this can freeze the server in a sync job, obviously
1372 #$cf::WAIT_FOR_TICK->wait; 1757 #$cf::WAIT_FOR_TICK->wait;
1373 $map->reset; 1758 $map->reset;
1374 undef $guard; 1759 undef $guard;
1375 return find $path; 1760 return find $path;
1386 my ($self) = @_; 1771 my ($self) = @_;
1387 1772
1388 local $self->{deny_reset} = 1; # loading can take a long time 1773 local $self->{deny_reset} = 1; # loading can take a long time
1389 1774
1390 my $path = $self->{path}; 1775 my $path = $self->{path};
1776
1777 {
1391 my $guard = cf::lock_acquire "map_load:$path"; 1778 my $guard = cf::lock_acquire "map_load:$path";
1392 1779
1393 return if $self->in_memory != cf::MAP_SWAPPED; 1780 return if $self->in_memory != cf::MAP_SWAPPED;
1394 1781
1395 $self->in_memory (cf::MAP_LOADING); 1782 $self->in_memory (cf::MAP_LOADING);
1396 1783
1397 $self->alloc; 1784 $self->alloc;
1398 1785
1399 $self->pre_load; 1786 $self->pre_load;
1400
1401 $self->_load_objects ($self->{load_path}, 1)
1402 or return;
1403
1404 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1405 if delete $self->{load_original};
1406
1407 if (my $uniq = $self->uniq_path) {
1408 utf8::encode $uniq;
1409 if (aio_open $uniq, O_RDONLY, 0) {
1410 $self->clear_unique_items;
1411 $self->_load_objects ($uniq, 0);
1412 }
1413 }
1414
1415 Coro::cede;
1416
1417 # now do the right thing for maps
1418 $self->link_multipart_objects;
1419
1420 unless ($self->{deny_activate}) {
1421 $self->decay_objects;
1422 $self->fix_auto_apply;
1423 $self->update_buttons;
1424 Coro::cede; 1787 Coro::cede;
1425 $self->set_darkness_map; 1788
1789 $self->_load_objects ($self->{load_path}, 1)
1790 or return;
1791
1792 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1793 if delete $self->{load_original};
1794
1795 if (my $uniq = $self->uniq_path) {
1796 utf8::encode $uniq;
1797 if (aio_open $uniq, O_RDONLY, 0) {
1798 $self->clear_unique_items;
1799 $self->_load_objects ($uniq, 0);
1800 }
1801 }
1802
1803 Coro::cede;
1804 # now do the right thing for maps
1805 $self->link_multipart_objects;
1426 $self->difficulty ($self->estimate_difficulty) 1806 $self->difficulty ($self->estimate_difficulty)
1427 unless $self->difficulty; 1807 unless $self->difficulty;
1428 Coro::cede; 1808 Coro::cede;
1809
1810 unless ($self->{deny_activate}) {
1811 $self->decay_objects;
1812 $self->fix_auto_apply;
1813 $self->update_buttons;
1814 Coro::cede;
1815 $self->set_darkness_map;
1816 Coro::cede;
1429 $self->activate; 1817 $self->activate;
1818 }
1819
1820 $self->in_memory (cf::MAP_IN_MEMORY);
1430 } 1821 }
1431 1822
1432 $self->post_load; 1823 $self->post_load;
1433
1434 $self->in_memory (cf::MAP_IN_MEMORY);
1435} 1824}
1436 1825
1437sub customise_for { 1826sub customise_for {
1438 my ($self, $ob) = @_; 1827 my ($self, $ob) = @_;
1439 1828
1440 return find "~" . $ob->name . "/" . $self->{path} 1829 return find "~" . $ob->name . "/" . $self->{path}
1441 if $self->per_player; 1830 if $self->per_player;
1831
1832# return find "?party/" . $ob->name . "/" . $self->{path}
1833# if $self->per_party;
1442 1834
1443 $self 1835 $self
1444} 1836}
1445 1837
1446# find and load all maps in the 3x3 area around a map 1838# find and load all maps in the 3x3 area around a map
1557 1949
1558sub reset_at { 1950sub reset_at {
1559 my ($self) = @_; 1951 my ($self) = @_;
1560 1952
1561 # TODO: safety, remove and allow resettable per-player maps 1953 # TODO: safety, remove and allow resettable per-player maps
1562 return 1e99 if $self->isa ("ext::map_per_player");#d#
1563 return 1e99 if $self->{deny_reset}; 1954 return 1e99 if $self->{deny_reset};
1564 1955
1565 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1956 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1566 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1957 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1567 1958
1578 my ($self) = @_; 1969 my ($self) = @_;
1579 1970
1580 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1971 my $lock = cf::lock_acquire "map_data:$self->{path}";
1581 1972
1582 return if $self->players; 1973 return if $self->players;
1583 return if $self->isa ("ext::map_per_player");#d#
1584 1974
1585 warn "resetting map ", $self->path;#d# 1975 warn "resetting map ", $self->path;
1976
1977 $self->in_memory (cf::MAP_SWAPPED);
1978
1979 # need to save uniques path
1980 unless ($self->{deny_save}) {
1981 my $uniq = $self->uniq_path; utf8::encode $uniq;
1982
1983 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1984 if $uniq;
1985 }
1586 1986
1587 delete $cf::MAP{$self->path}; 1987 delete $cf::MAP{$self->path};
1588 1988
1589 $self->in_memory (cf::MAP_SWAPPED);
1590 $self->clear; 1989 $self->clear;
1591 1990
1592 $_->clear_links_to ($self) for values %cf::MAP; 1991 $_->clear_links_to ($self) for values %cf::MAP;
1593 1992
1594 $self->unlink_save; 1993 $self->unlink_save;
1613 $cf::MAP{$self->path} = $self; 2012 $cf::MAP{$self->path} = $self;
1614 2013
1615 $self->reset; # polite request, might not happen 2014 $self->reset; # polite request, might not happen
1616} 2015}
1617 2016
2017=item $maps = cf::map::tmp_maps
2018
2019Returns an arrayref with all map paths of currently instantiated and saved
2020maps. May block.
2021
2022=cut
2023
2024sub tmp_maps() {
2025 [
2026 map {
2027 utf8::decode $_;
2028 /\.map$/
2029 ? normalise $_
2030 : ()
2031 } @{ aio_readdir $TMPDIR or [] }
2032 ]
2033}
2034
2035=item $maps = cf::map::random_maps
2036
2037Returns an arrayref with all map paths of currently instantiated and saved
2038random maps. May block.
2039
2040=cut
2041
2042sub random_maps() {
2043 [
2044 map {
2045 utf8::decode $_;
2046 /\.map$/
2047 ? normalise "?random/$_"
2048 : ()
2049 } @{ aio_readdir $RANDOMDIR or [] }
2050 ]
2051}
2052
1618=item cf::map::unique_maps 2053=item cf::map::unique_maps
1619 2054
1620Returns an arrayref of paths of all shared maps that have 2055Returns an arrayref of paths of all shared maps that have
1621instantiated unique items. May block. 2056instantiated unique items. May block.
1622 2057
1623=cut 2058=cut
1624 2059
1625sub unique_maps() { 2060sub unique_maps() {
1626 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2061 [
1627 or return; 2062 map {
1628
1629 my @paths;
1630
1631 for (@$files) {
1632 utf8::decode $_; 2063 utf8::decode $_;
1633 next if /\.pst$/; 2064 /\.map$/
1634 next unless /^$PATH_SEP/o; 2065 ? normalise $_
1635 2066 : ()
1636 push @paths, cf::map::normalise $_; 2067 } @{ aio_readdir $UNIQUEDIR or [] }
1637 } 2068 ]
1638
1639 \@paths
1640} 2069}
1641 2070
1642package cf; 2071package cf;
1643 2072
1644=back 2073=back
1690 2119
1691 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2120 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1692 2121
1693 if ($self->{record_replies}) { 2122 if ($self->{record_replies}) {
1694 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2123 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2124
1695 } else { 2125 } else {
2126 my $pl = $self->contr;
2127
2128 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2129 my $diag = $pl->{npc_dialog};
2130 $diag->{pl}->ext_reply (
2131 $diag->{id},
2132 msgtype => "reply",
2133 msg => $diag->{pl}->expand_cfpod ($msg),
2134 add_topics => []
2135 );
2136
2137 } else {
1696 $msg = $npc->name . " says: $msg" if $npc; 2138 $msg = $npc->name . " says: $msg" if $npc;
1697 $self->message ($msg, $flags); 2139 $self->message ($msg, $flags);
2140 }
1698 } 2141 }
1699} 2142}
1700 2143
1701=item $player_object->may ("access") 2144=item $player_object->may ("access")
1702 2145
1750 $self->deactivate_recursive; 2193 $self->deactivate_recursive;
1751 2194
1752 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2195 return if UNIVERSAL::isa $self->map, "ext::map_link";
1753 2196
1754 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2197 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1755 if $self->map; 2198 if $self->map && $self->map->{path} ne "{link}";
1756 2199
1757 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2200 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1758} 2201}
1759 2202
1760sub cf::object::player::leave_link { 2203sub cf::object::player::leave_link {
1761 my ($self, $map, $x, $y) = @_; 2204 my ($self, $map, $x, $y) = @_;
2205
2206 return unless $self->contr->active;
1762 2207
1763 my $link_pos = delete $self->{_link_pos}; 2208 my $link_pos = delete $self->{_link_pos};
1764 2209
1765 unless ($map) { 2210 unless ($map) {
1766 # restore original map position 2211 # restore original map position
1784 $map->load; 2229 $map->load;
1785 $map->load_diag; 2230 $map->load_diag;
1786 2231
1787 return unless $self->contr->active; 2232 return unless $self->contr->active;
1788 $self->activate_recursive; 2233 $self->activate_recursive;
2234
2235 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1789 $self->enter_map ($map, $x, $y); 2236 $self->enter_map ($map, $x, $y);
1790} 2237}
1791 2238
1792cf::player->attach (
1793 on_logout => sub {
1794 my ($pl) = @_;
1795
1796 # abort map switching before logout
1797 if ($pl->ob->{_link_pos}) {
1798 cf::sync_job {
1799 $pl->ob->leave_link
1800 };
1801 }
1802 },
1803 on_login => sub {
1804 my ($pl) = @_;
1805
1806 # try to abort aborted map switching on player login :)
1807 # should happen only on crashes
1808 if ($pl->ob->{_link_pos}) {
1809 $pl->ob->enter_link;
1810 (async {
1811 # we need this sleep as the login has a concurrent enter_exit running
1812 # and this sleep increases chances of the player not ending up in scorn
1813 $pl->ob->reply (undef,
1814 "There was an internal problem at your last logout, "
1815 . "the server will try to bring you to your intended destination in a second.",
1816 cf::NDI_RED);
1817 Coro::Timer::sleep 1;
1818 $pl->ob->leave_link;
1819 })->prio (2);
1820 }
1821 },
1822);
1823
1824=item $player_object->goto ($path, $x, $y) 2239=item $player_object->goto ($path, $x, $y[, $check->($map)])
1825 2240
2241Moves the player to the given map-path and coordinates by first freezing
2242her, loading and preparing them map, calling the provided $check callback
2243that has to return the map if sucecssful, and then unfreezes the player on
2244the new (success) or old (failed) map position.
2245
1826=cut 2246=cut
2247
2248our $GOTOGEN;
1827 2249
1828sub cf::object::player::goto { 2250sub cf::object::player::goto {
1829 my ($self, $path, $x, $y) = @_; 2251 my ($self, $path, $x, $y, $check) = @_;
2252
2253 # do generation counting so two concurrent goto's will be executed in-order
2254 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1830 2255
1831 $self->enter_link; 2256 $self->enter_link;
1832 2257
1833 (async { 2258 (async {
1834 my $map = eval { 2259 my $map = eval {
1835 my $map = cf::map::find $path; 2260 my $map = cf::map::find $path;
2261
2262 if ($map) {
1836 $map = $map->customise_for ($self) if $map; 2263 $map = $map->customise_for ($self);
2264 $map = $check->($map) if $check && $map;
2265 } else {
2266 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2267 }
2268
1837 $map 2269 $map
2270 };
2271
2272 if ($@) {
2273 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2274 LOG llevError | logBacktrace, Carp::longmess $@;
1838 } or 2275 }
1839 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1840 2276
2277 if ($gen == $self->{_goto_generation}) {
2278 delete $self->{_goto_generation};
1841 $self->leave_link ($map, $x, $y); 2279 $self->leave_link ($map, $x, $y);
2280 }
1842 })->prio (1); 2281 })->prio (1);
1843} 2282}
1844 2283
1845=item $player_object->enter_exit ($exit_object) 2284=item $player_object->enter_exit ($exit_object)
1846 2285
1885 2324
1886 $rmp->{random_seed} ||= $exit->random_seed; 2325 $rmp->{random_seed} ||= $exit->random_seed;
1887 2326
1888 my $data = cf::to_json $rmp; 2327 my $data = cf::to_json $rmp;
1889 my $md5 = Digest::MD5::md5_hex $data; 2328 my $md5 = Digest::MD5::md5_hex $data;
1890 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2329 my $meta = "$RANDOMDIR/$md5.meta";
1891 2330
1892 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2331 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1893 aio_write $fh, 0, (length $data), $data, 0; 2332 aio_write $fh, 0, (length $data), $data, 0;
1894 undef $fh; 2333 undef $fh;
1895 aio_rename "$meta~", $meta; 2334 aio_rename "$meta~", $meta;
1904 2343
1905 return unless $self->type == cf::PLAYER; 2344 return unless $self->type == cf::PLAYER;
1906 2345
1907 if ($exit->slaying eq "/!") { 2346 if ($exit->slaying eq "/!") {
1908 #TODO: this should de-fi-ni-te-ly not be a sync-job 2347 #TODO: this should de-fi-ni-te-ly not be a sync-job
2348 # the problem is that $exit might not survive long enough
2349 # so it needs to be done right now, right here
1909 cf::sync_job { prepare_random_map $exit }; 2350 cf::sync_job { prepare_random_map $exit };
1910 } 2351 }
1911 2352
1912 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2353 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1913 my $hp = $exit->stats->hp; 2354 my $hp = $exit->stats->hp;
1921 $self->goto ($slaying, $hp, $sp); 2362 $self->goto ($slaying, $hp, $sp);
1922 2363
1923 1; 2364 1;
1924 }) { 2365 }) {
1925 $self->message ("Something went wrong deep within the crossfire server. " 2366 $self->message ("Something went wrong deep within the crossfire server. "
1926 . "I'll try to bring you back to the map you were before. " 2367 . "I'll try to bring you back to the map you were before. "
1927 . "Please report this to the dungeon master!", 2368 . "Please report this to the dungeon master!",
1928 cf::NDI_UNIQUE | cf::NDI_RED); 2369 cf::NDI_UNIQUE | cf::NDI_RED);
1929 2370
1930 warn "ERROR in enter_exit: $@"; 2371 warn "ERROR in enter_exit: $@";
1931 $self->leave_link; 2372 $self->leave_link;
1932 } 2373 }
1933 })->prio (1); 2374 })->prio (1);
1946 2387
1947sub cf::client::send_drawinfo { 2388sub cf::client::send_drawinfo {
1948 my ($self, $text, $flags) = @_; 2389 my ($self, $text, $flags) = @_;
1949 2390
1950 utf8::encode $text; 2391 utf8::encode $text;
1951 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2392 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1952} 2393}
1953 2394
2395=item $client->send_msg ($color, $type, $msg, [extra...])
2396
2397Send a drawinfo or msg packet to the client, formatting the msg for the
2398client if neccessary. C<$type> should be a string identifying the type of
2399the message, with C<log> being the default. If C<$color> is negative, suppress
2400the message unless the client supports the msg packet.
2401
2402=cut
2403
2404sub cf::client::send_msg {
2405 my ($self, $color, $type, $msg, @extra) = @_;
2406
2407 $msg = $self->pl->expand_cfpod ($msg);
2408
2409 if ($self->can_msg) {
2410 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2411 } else {
2412 # replace some tags by gcfclient-compatible ones
2413 for ($msg) {
2414 1 while
2415 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2416 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2417 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2418 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2419 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2420 }
2421
2422 if ($color >= 0) {
2423 if (0 && $msg =~ /\[/) {
2424 $self->send_packet ("drawextinfo $color 4 0 $msg")
2425 } else {
2426 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2427 $self->send_packet ("drawinfo $color $msg")
2428 }
2429 }
2430 }
2431}
2432
2433=item $client->ext_event ($type, %msg)
2434
2435Sends an ext event to the client.
2436
2437=cut
2438
2439sub cf::client::ext_event($$%) {
2440 my ($self, $type, %msg) = @_;
2441
2442 $msg{msgtype} = "event_$type";
2443 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2444}
1954 2445
1955=item $success = $client->query ($flags, "text", \&cb) 2446=item $success = $client->query ($flags, "text", \&cb)
1956 2447
1957Queues a query to the client, calling the given callback with 2448Queues a query to the client, calling the given callback with
1958the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2449the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1959C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2450C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1960 2451
1961Queries can fail, so check the return code. Or don't, as queries will become 2452Queries can fail, so check the return code. Or don't, as queries will
1962reliable at some point in the future. 2453become reliable at some point in the future.
1963 2454
1964=cut 2455=cut
1965 2456
1966sub cf::client::query { 2457sub cf::client::query {
1967 my ($self, $flags, $text, $cb) = @_; 2458 my ($self, $flags, $text, $cb) = @_;
1975 utf8::encode $text; 2466 utf8::encode $text;
1976 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2467 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1977 2468
1978 $self->send_packet ($self->{query_queue}[0][0]) 2469 $self->send_packet ($self->{query_queue}[0][0])
1979 if @{ $self->{query_queue} } == 1; 2470 if @{ $self->{query_queue} } == 1;
2471
2472 1
1980} 2473}
1981 2474
1982cf::client->attach ( 2475cf::client->attach (
2476 on_connect => sub {
2477 my ($ns) = @_;
2478
2479 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2480 },
1983 on_reply => sub { 2481 on_reply => sub {
1984 my ($ns, $msg) = @_; 2482 my ($ns, $msg) = @_;
1985 2483
1986 # this weird shuffling is so that direct followup queries 2484 # this weird shuffling is so that direct followup queries
1987 # get handled first 2485 # get handled first
1988 my $queue = delete $ns->{query_queue} 2486 my $queue = delete $ns->{query_queue}
1989 or return; # be conservative, not sure how that can happen, but we saw a crash here 2487 or return; # be conservative, not sure how that can happen, but we saw a crash here
1990 2488
1991 (shift @$queue)->[1]->($msg); 2489 (shift @$queue)->[1]->($msg);
2490 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1992 2491
1993 push @{ $ns->{query_queue} }, @$queue; 2492 push @{ $ns->{query_queue} }, @$queue;
1994 2493
1995 if (@{ $ns->{query_queue} } == @$queue) { 2494 if (@{ $ns->{query_queue} } == @$queue) {
1996 if (@$queue) { 2495 if (@$queue) {
1998 } else { 2497 } else {
1999 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2498 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2000 } 2499 }
2001 } 2500 }
2002 }, 2501 },
2502 on_exticmd => sub {
2503 my ($ns, $buf) = @_;
2504
2505 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2506
2507 if (ref $msg) {
2508 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2509 if (my %reply = $cb->($ns, $msg)) {
2510 $reply{msgid} = $msg->{msgid};
2511 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2512 }
2513 }
2514 } else {
2515 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2516 }
2517
2518 cf::override;
2519 },
2003); 2520);
2004 2521
2005=item $client->async (\&cb) 2522=item $client->async (\&cb)
2006 2523
2007Create a new coroutine, running the specified callback. The coroutine will 2524Create a new coroutine, running the specified callback. The coroutine will
2054 2571
2055# here we export the classes and methods available to script code 2572# here we export the classes and methods available to script code
2056 2573
2057=pod 2574=pod
2058 2575
2059The following fucntions and emthods are available within a safe environment: 2576The following functions and methods are available within a safe environment:
2060 2577
2061 cf::object contr pay_amount pay_player map 2578 cf::object contr pay_amount pay_player map
2062 cf::object::player player 2579 cf::object::player player
2063 cf::player peaceful 2580 cf::player peaceful
2064 cf::map trigger 2581 cf::map trigger
2145=back 2662=back
2146 2663
2147=cut 2664=cut
2148 2665
2149############################################################################# 2666#############################################################################
2667# the server's init and main functions
2150 2668
2151=head2 EXTENSION DATABASE SUPPORT 2669sub load_facedata($) {
2670 my ($path) = @_;
2152 2671
2153Crossfire maintains a very simple database for extension use. It can 2672 warn "loading facedata from $path\n";
2154currently store anything that can be serialised using Storable, which
2155excludes objects.
2156 2673
2157The parameter C<$family> should best start with the name of the extension 2674 my $facedata;
2158using it, it should be unique. 2675 0 < aio_load $path, $facedata
2676 or die "$path: $!";
2159 2677
2160=over 4 2678 $facedata = Coro::Storable::thaw $facedata;
2161 2679
2162=item $hashref = cf::db_get $family 2680 $facedata->{version} == 2
2681 or cf::cleanup "$path: version mismatch, cannot proceed.";
2163 2682
2164Return a hashref for use by the extension C<$family>, which can be
2165modified. After modifications, you have to call C<cf::db_dirty> or
2166C<cf::db_sync>.
2167
2168=item $value = cf::db_get $family => $key
2169
2170Returns a single value from the database
2171
2172=item cf::db_put $family => $hashref
2173
2174Stores the given family hashref into the database. Updates are delayed, if
2175you want the data to be synced to disk immediately, use C<cf::db_sync>.
2176
2177=item cf::db_put $family => $key => $value
2178
2179Stores the given C<$value> in the family hash. Updates are delayed, if you
2180want the data to be synced to disk immediately, use C<cf::db_sync>.
2181
2182=item cf::db_dirty
2183
2184Marks the database as dirty, to be updated at a later time.
2185
2186=item cf::db_sync
2187
2188Immediately write the database to disk I<if it is dirty>.
2189
2190=cut
2191
2192our $DB;
2193
2194{
2195 my $path = cf::localdir . "/database.pst";
2196
2197 sub db_load() {
2198 $DB = stat $path ? Storable::retrieve $path : { };
2199 } 2683 {
2684 my $faces = $facedata->{faceinfo};
2200 2685
2201 my $pid; 2686 while (my ($face, $info) = each %$faces) {
2202 2687 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2203 sub db_save() { 2688 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2204 waitpid $pid, 0 if $pid; 2689 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2205 if (0 == ($pid = fork)) { 2690 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2206 $DB->{_meta}{version} = 1; 2691 Coro::cede;
2207 Storable::nstore $DB, "$path~";
2208 rename "$path~", $path;
2209 cf::_exit 0 if defined $pid;
2210 }
2211 }
2212
2213 my $dirty;
2214
2215 sub db_sync() {
2216 db_save if $dirty;
2217 undef $dirty;
2218 }
2219
2220 my $idle = Event->idle (
2221 reentrant => 0,
2222 min => 10,
2223 max => 20,
2224 repeat => 0,
2225 data => WF_AUTOCANCEL,
2226 cb => \&db_sync,
2227 );
2228
2229 sub db_dirty() {
2230 $dirty = 1;
2231 $idle->start;
2232 }
2233
2234 sub db_get($;$) {
2235 @_ >= 2
2236 ? $DB->{$_[0]}{$_[1]}
2237 : ($DB->{$_[0]} ||= { })
2238 }
2239
2240 sub db_put($$;$) {
2241 if (@_ >= 3) {
2242 $DB->{$_[0]}{$_[1]} = $_[2];
2243 } else {
2244 $DB->{$_[0]} = $_[1];
2245 }
2246 db_dirty;
2247 }
2248
2249 cf::global->attach (
2250 prio => 10000,
2251 on_cleanup => sub {
2252 db_sync;
2253 }, 2692 }
2254 );
2255}
2256 2693
2257############################################################################# 2694 while (my ($face, $info) = each %$faces) {
2258# the server's main() 2695 next unless $info->{smooth};
2696 my $idx = cf::face::find $face
2697 or next;
2698 if (my $smooth = cf::face::find $info->{smooth}) {
2699 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2700 } else {
2701 warn "smooth face '$info->{smooth}' not found for face '$face'";
2702 }
2703 Coro::cede;
2704 }
2705 }
2706
2707 {
2708 my $anims = $facedata->{animinfo};
2709
2710 while (my ($anim, $info) = each %$anims) {
2711 cf::anim::set $anim, $info->{frames}, $info->{facings};
2712 Coro::cede;
2713 }
2714
2715 cf::anim::invalidate_all; # d'oh
2716 }
2717
2718 1
2719}
2720
2721sub reload_regions {
2722 load_resource_file "$MAPDIR/regions"
2723 or die "unable to load regions file\n";
2724}
2725
2726sub reload_facedata {
2727 load_facedata "$DATADIR/facedata"
2728 or die "unable to load facedata\n";
2729}
2730
2731sub reload_archetypes {
2732 load_resource_file "$DATADIR/archetypes"
2733 or die "unable to load archetypes\n";
2734 #d# NEED to laod twice to resolve forward references
2735 # this really needs to be done in an extra post-pass
2736 # (which needs to be synchronous, so solve it differently)
2737 load_resource_file "$DATADIR/archetypes"
2738 or die "unable to load archetypes\n";
2739}
2740
2741sub reload_treasures {
2742 load_resource_file "$DATADIR/treasures"
2743 or die "unable to load treasurelists\n";
2744}
2745
2746sub reload_resources {
2747 warn "reloading resource files...\n";
2748
2749 reload_regions;
2750 reload_facedata;
2751 #reload_archetypes;#d#
2752 reload_archetypes;
2753 reload_treasures;
2754
2755 warn "finished reloading resource files\n";
2756}
2757
2758sub init {
2759 reload_resources;
2760}
2259 2761
2260sub cfg_load { 2762sub cfg_load {
2261 open my $fh, "<:utf8", cf::confdir . "/config" 2763 open my $fh, "<:utf8", "$CONFDIR/config"
2262 or return; 2764 or return;
2263 2765
2264 local $/; 2766 local $/;
2265 *CFG = YAML::Syck::Load <$fh>; 2767 *CFG = YAML::Syck::Load <$fh>;
2266 2768
2286 Event::one_event; 2788 Event::one_event;
2287 })->prio (Coro::PRIO_MAX); 2789 })->prio (Coro::PRIO_MAX);
2288 }; 2790 };
2289 2791
2290 cfg_load; 2792 cfg_load;
2291 db_load; 2793 db_init;
2292 load_extensions; 2794 load_extensions;
2293 2795
2294 $TICK_WATCHER->start; 2796 $TICK_WATCHER->start;
2295 Event::loop; 2797 Event::loop;
2296} 2798}
2311 }, 2813 },
2312 ); 2814 );
2313 } 2815 }
2314} 2816}
2315 2817
2818sub write_runtime {
2819 my $runtime = "$LOCALDIR/runtime";
2820
2821 # first touch the runtime file to show we are still running:
2822 # the fsync below can take a very very long time.
2823
2824 IO::AIO::aio_utime $runtime, undef, undef;
2825
2826 my $guard = cf::lock_acquire "write_runtime";
2827
2828 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2829 or return;
2830
2831 my $value = $cf::RUNTIME + 90 + 10;
2832 # 10 is the runtime save interval, for a monotonic clock
2833 # 60 allows for the watchdog to kill the server.
2834
2835 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2836 and return;
2837
2838 # always fsync - this file is important
2839 aio_fsync $fh
2840 and return;
2841
2842 # touch it again to show we are up-to-date
2843 aio_utime $fh, undef, undef;
2844
2845 close $fh
2846 or return;
2847
2848 aio_rename "$runtime~", $runtime
2849 and return;
2850
2851 warn "runtime file written.\n";
2852
2853 1
2854}
2855
2316sub emergency_save() { 2856sub emergency_save() {
2317 my $freeze_guard = cf::freeze_mainloop; 2857 my $freeze_guard = cf::freeze_mainloop;
2318 2858
2319 warn "enter emergency perl save\n"; 2859 warn "enter emergency perl save\n";
2320 2860
2335 my $map = $cf::MAP{$path} or next; 2875 my $map = $cf::MAP{$path} or next;
2336 $map->valid or next; 2876 $map->valid or next;
2337 $map->save; 2877 $map->save;
2338 } 2878 }
2339 warn "end emergency map save\n"; 2879 warn "end emergency map save\n";
2880
2881 warn "begin emergency database checkpoint\n";
2882 BDB::db_env_txn_checkpoint $DB_ENV;
2883 warn "end emergency database checkpoint\n";
2340 }; 2884 };
2341 2885
2342 warn "leave emergency perl save\n"; 2886 warn "leave emergency perl save\n";
2343} 2887}
2344 2888
2889sub post_cleanup {
2890 my ($make_core) = @_;
2891
2892 warn Carp::longmess "post_cleanup backtrace"
2893 if $make_core;
2894}
2895
2345sub reload() { 2896sub do_reload_perl() {
2346 # can/must only be called in main 2897 # can/must only be called in main
2347 if ($Coro::current != $Coro::main) { 2898 if ($Coro::current != $Coro::main) {
2348 warn "can only reload from main coroutine"; 2899 warn "can only reload from main coroutine";
2349 return; 2900 return;
2350 } 2901 }
2351 2902
2352 warn "reloading..."; 2903 warn "reloading...";
2353 2904
2354 warn "cancelling server ticker"; 2905 warn "entering sync_job";
2355 $TICK_WATCHER->cancel;
2356 2906
2907 cf::sync_job {
2908 cf::write_runtime; # external watchdog should not bark
2357 cf::emergency_save; 2909 cf::emergency_save;
2910 cf::write_runtime; # external watchdog should not bark
2358 2911
2359 eval { 2912 warn "syncing database to disk";
2913 BDB::db_env_txn_checkpoint $DB_ENV;
2914
2360 # if anything goes wrong in here, we should simply crash as we already saved 2915 # if anything goes wrong in here, we should simply crash as we already saved
2361
2362 warn "syncing database to disk";
2363 cf::db_sync;
2364 2916
2365 warn "cancelling all WF_AUTOCANCEL watchers"; 2917 warn "cancelling all WF_AUTOCANCEL watchers";
2366 for (Event::all_watchers) { 2918 for (Event::all_watchers) {
2367 $_->cancel if $_->data & WF_AUTOCANCEL; 2919 $_->cancel if $_->data & WF_AUTOCANCEL;
2368 } 2920 }
2369 2921
2370 warn "flushing outstanding aio requests"; 2922 warn "flushing outstanding aio requests";
2371 for (;;) { 2923 for (;;) {
2924 BDB::flush;
2372 IO::AIO::flush; 2925 IO::AIO::flush;
2373 Coro::cede; 2926 Coro::cede;
2374 last unless IO::AIO::nreqs; 2927 last unless IO::AIO::nreqs || BDB::nreqs;
2375 warn "iterate..."; 2928 warn "iterate...";
2376 } 2929 }
2930
2931 ++$RELOAD;
2377 2932
2378 warn "cancelling all extension coros"; 2933 warn "cancelling all extension coros";
2379 $_->cancel for values %EXT_CORO; 2934 $_->cancel for values %EXT_CORO;
2380 %EXT_CORO = (); 2935 %EXT_CORO = ();
2381 2936
2382 warn "removing commands"; 2937 warn "removing commands";
2383 %COMMAND = (); 2938 %COMMAND = ();
2384 2939
2385 warn "removing ext commands"; 2940 warn "removing ext/exti commands";
2386 %EXTCMD = (); 2941 %EXTCMD = ();
2942 %EXTICMD = ();
2387 2943
2388 warn "unloading/nuking all extensions"; 2944 warn "unloading/nuking all extensions";
2389 for my $pkg (@EXTS) { 2945 for my $pkg (@EXTS) {
2390 warn "... unloading $pkg"; 2946 warn "... unloading $pkg";
2391 2947
2421 Symbol::delete_package "safe::$_" 2977 Symbol::delete_package "safe::$_"
2422 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2978 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2423 2979
2424 warn "unloading cf.pm \"a bit\""; 2980 warn "unloading cf.pm \"a bit\"";
2425 delete $INC{"cf.pm"}; 2981 delete $INC{"cf.pm"};
2982 delete $INC{"cf/pod.pm"};
2426 2983
2427 # don't, removes xs symbols, too, 2984 # don't, removes xs symbols, too,
2428 # and global variables created in xs 2985 # and global variables created in xs
2429 #Symbol::delete_package __PACKAGE__; 2986 #Symbol::delete_package __PACKAGE__;
2430 2987
2434 require cf; 2991 require cf;
2435 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2992 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2436 2993
2437 warn "loading config and database again"; 2994 warn "loading config and database again";
2438 cf::cfg_load; 2995 cf::cfg_load;
2439 cf::db_load;
2440 2996
2441 warn "loading extensions"; 2997 warn "loading extensions";
2442 cf::load_extensions; 2998 cf::load_extensions;
2443 2999
2444 warn "reattaching attachments to objects/players"; 3000 warn "reattaching attachments to objects/players";
2445 _global_reattach; 3001 _global_reattach; # objects, sockets
2446 warn "reattaching attachments to maps"; 3002 warn "reattaching attachments to maps";
2447 reattach $_ for values %MAP; 3003 reattach $_ for values %MAP;
3004 warn "reattaching attachments to players";
3005 reattach $_ for values %PLAYER;
2448 3006
2449 warn "restarting server ticker"; 3007 warn "leaving sync_job";
2450 3008
2451 $TICK_WATCHER->start; 3009 1
2452 }; 3010 } or do {
2453
2454 if ($@) {
2455 warn $@; 3011 warn $@;
2456 warn "error while reloading, exiting."; 3012 warn "error while reloading, exiting.";
2457 exit 1; 3013 exit 1;
2458 } 3014 };
2459 3015
2460 warn "reloaded"; 3016 warn "reloaded";
2461}; 3017};
2462 3018
2463our $RELOAD_WATCHER; # used only during reload 3019our $RELOAD_WATCHER; # used only during reload
2464 3020
3021sub reload_perl() {
3022 # doing reload synchronously and two reloads happen back-to-back,
3023 # coro crashes during coro_state_free->destroy here.
3024
3025 $RELOAD_WATCHER ||= Event->timer (
3026 reentrant => 0,
3027 after => 0,
3028 data => WF_AUTOCANCEL,
3029 cb => sub {
3030 do_reload_perl;
3031 undef $RELOAD_WATCHER;
3032 },
3033 );
3034}
3035
2465register_command "reload" => sub { 3036register_command "reload" => sub {
2466 my ($who, $arg) = @_; 3037 my ($who, $arg) = @_;
2467 3038
2468 if ($who->flag (FLAG_WIZ)) { 3039 if ($who->flag (FLAG_WIZ)) {
2469 $who->message ("reloading server."); 3040 $who->message ("reloading server.");
2470 3041 async { reload_perl };
2471 # doing reload synchronously and two reloads happen back-to-back,
2472 # coro crashes during coro_state_free->destroy here.
2473
2474 $RELOAD_WATCHER ||= Event->timer (
2475 reentrant => 0,
2476 after => 0,
2477 data => WF_AUTOCANCEL,
2478 cb => sub {
2479 reload;
2480 undef $RELOAD_WATCHER;
2481 },
2482 );
2483 } 3042 }
2484}; 3043};
2485 3044
2486unshift @INC, $LIBDIR; 3045unshift @INC, $LIBDIR;
2487 3046
2488my $bug_warning = 0; 3047my $bug_warning = 0;
2489 3048
3049our @WAIT_FOR_TICK;
3050our @WAIT_FOR_TICK_BEGIN;
3051
3052sub wait_for_tick {
3053 return unless $TICK_WATCHER->is_active;
3054 return if $Coro::current == $Coro::main;
3055
3056 my $signal = new Coro::Signal;
3057 push @WAIT_FOR_TICK, $signal;
3058 $signal->wait;
3059}
3060
3061sub wait_for_tick_begin {
3062 return unless $TICK_WATCHER->is_active;
3063 return if $Coro::current == $Coro::main;
3064
3065 my $signal = new Coro::Signal;
3066 push @WAIT_FOR_TICK_BEGIN, $signal;
3067 $signal->wait;
3068}
3069
3070 my $min = 1e6;#d#
3071 my $avg = 10;
2490$TICK_WATCHER = Event->timer ( 3072$TICK_WATCHER = Event->timer (
2491 reentrant => 0, 3073 reentrant => 0,
2492 parked => 1, 3074 parked => 1,
2493 prio => 0, 3075 prio => 0,
2494 at => $NEXT_TICK || $TICK, 3076 at => $NEXT_TICK || $TICK,
2498 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3080 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2499 unless ++$bug_warning > 10; 3081 unless ++$bug_warning > 10;
2500 return; 3082 return;
2501 } 3083 }
2502 3084
2503 $NOW = Event::time; 3085 $NOW = $tick_start = Event::time;
2504 3086
2505 cf::server_tick; # one server iteration 3087 cf::server_tick; # one server iteration
3088
3089 0 && sync_job {#d#
3090 for(1..10) {
3091 my $t = Event::time;
3092 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3093 or die;
3094
3095 $map->width (50);
3096 $map->height (50);
3097 $map->alloc;
3098 $map->_load_objects ("/tmp/x.map", 1);
3099 my $t = Event::time - $t;
3100
3101 #next unless $t < 0.0013;#d#
3102 if ($t < $min) {
3103 $min = $t;
3104 }
3105 $avg = $avg * 0.99 + $t * 0.01;
3106 }
3107 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3108 exit 0;
3109 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3110 };
3111
2506 $RUNTIME += $TICK; 3112 $RUNTIME += $TICK;
2507 $NEXT_TICK += $TICK; 3113 $NEXT_TICK += $TICK;
2508 3114
2509 $WAIT_FOR_TICK->broadcast; 3115 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2510 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3116 $NEXT_RUNTIME_WRITE = $NOW + 10;
2511 3117 Coro::async_pool {
2512 Event::sweep; 3118 write_runtime
2513 Coro::cede_notself; 3119 or warn "ERROR: unable to write runtime file: $!";
3120 };
2514 3121 }
3122
2515# my $AFTER = Event::time; 3123# my $AFTER = Event::time;
2516# warn $AFTER - $NOW;#d# 3124# warn $AFTER - $NOW;#d#
2517 3125
3126 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3127 $sig->send;
3128 }
3129 while (my $sig = shift @WAIT_FOR_TICK) {
3130 $sig->send;
3131 }
3132
3133 $NOW = Event::time;
3134
2518 # if we are delayed by four ticks or more, skip them all 3135 # if we are delayed by four ticks or more, skip them all
2519 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3136 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2520 3137
2521 $TICK_WATCHER->at ($NEXT_TICK); 3138 $TICK_WATCHER->at ($NEXT_TICK);
2522 $TICK_WATCHER->start; 3139 $TICK_WATCHER->start;
3140
3141 $LOAD = ($NOW - $tick_start) / $TICK;
3142 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3143
3144 _post_tick;
3145
3146
2523 }, 3147 },
2524); 3148);
2525 3149
3150{
3151 BDB::max_poll_time $TICK * 0.1;
3152 $BDB_POLL_WATCHER = Event->io (
3153 reentrant => 0,
3154 fd => BDB::poll_fileno,
3155 poll => 'r',
3156 prio => 0,
3157 data => WF_AUTOCANCEL,
3158 cb => \&BDB::poll_cb,
3159 );
3160 BDB::min_parallel 8;
3161
3162 BDB::set_sync_prepare {
3163 my $status;
3164 my $current = $Coro::current;
3165 (
3166 sub {
3167 $status = $!;
3168 $current->ready; undef $current;
3169 },
3170 sub {
3171 Coro::schedule while defined $current;
3172 $! = $status;
3173 },
3174 )
3175 };
3176
3177 unless ($DB_ENV) {
3178 $DB_ENV = BDB::db_env_create;
3179
3180 cf::sync_job {
3181 eval {
3182 BDB::db_env_open
3183 $DB_ENV,
3184 $BDBDIR,
3185 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3186 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3187 0666;
3188
3189 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3190
3191 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3192 $DB_ENV->set_lk_detect;
3193 };
3194
3195 cf::cleanup "db_env_open(db): $@" if $@;
3196 };
3197 }
3198}
3199
3200{
3201 IO::AIO::min_parallel 8;
3202
3203 undef $Coro::AIO::WATCHER;
2526IO::AIO::max_poll_time $TICK * 0.1; 3204 IO::AIO::max_poll_time $TICK * 0.1;
2527
2528undef $Coro::AIO::WATCHER;
2529$AIO_POLL_WATCHER = Event->io ( 3205 $AIO_POLL_WATCHER = Event->io (
2530 reentrant => 0, 3206 reentrant => 0,
3207 data => WF_AUTOCANCEL,
2531 fd => IO::AIO::poll_fileno, 3208 fd => IO::AIO::poll_fileno,
2532 poll => 'r', 3209 poll => 'r',
2533 prio => 6, 3210 prio => 6,
2534 data => WF_AUTOCANCEL,
2535 cb => \&IO::AIO::poll_cb, 3211 cb => \&IO::AIO::poll_cb,
2536); 3212 );
3213}
2537 3214
2538$WRITE_RUNTIME_WATCHER = Event->timer ( 3215my $_log_backtrace;
2539 reentrant => 0, 3216
2540 data => WF_AUTOCANCEL, 3217sub _log_backtrace {
2541 after => 1, 3218 my ($msg, @addr) = @_;
2542 interval => 10, 3219
2543 prio => 6, # keep it lowest so it acts like a watchdog 3220 $msg =~ s/\n//;
2544 cb => Coro::unblock_sub { 3221
2545 write_runtime 3222 # limit the # of concurrent backtraces
2546 or warn "ERROR: unable to write runtime file: $!"; 3223 if ($_log_backtrace < 2) {
3224 ++$_log_backtrace;
3225 async {
3226 my @bt = fork_call {
3227 @addr = map { sprintf "%x", $_ } @addr;
3228 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3229 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3230 or die "addr2line: $!";
3231
3232 my @funcs;
3233 my @res = <$fh>;
3234 chomp for @res;
3235 while (@res) {
3236 my ($func, $line) = splice @res, 0, 2, ();
3237 push @funcs, "[$func] $line";
3238 }
3239
3240 @funcs
3241 };
3242
3243 LOG llevInfo, "[ABT] $msg\n";
3244 LOG llevInfo, "[ABT] $_\n" for @bt;
3245 --$_log_backtrace;
3246 };
3247 } else {
3248 LOG llevInfo, "[ABT] $msg\n";
3249 LOG llevInfo, "[ABT] [suppressed]\n";
2547 }, 3250 }
2548); 3251}
3252
3253# load additional modules
3254use cf::pod;
2549 3255
2550END { cf::emergency_save } 3256END { cf::emergency_save }
2551 3257
25521 32581
2553 3259

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines