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.156 by root, Tue Jan 9 22:07:08 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines