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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines