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.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.305 by root, Thu Jul 12 08:40:14 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines