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.112 by root, Mon Jan 1 13:31:47 2007 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines