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.150 by root, Mon Jan 8 19:25:53 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines