ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cf.schmorp.de/server/lib/cf.pm
(Generate patch)

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.146 by root, Sun Jan 7 23:10:43 2007 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use BDB ();
26use Data::Dumper;
20use Digest::MD5; 27use Digest::MD5;
21use Fcntl; 28use Fcntl;
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 IO::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 Coro::cede;
1142 $pl->save_pl ($path); 1234 $pl->save_pl ($path);
1143 Coro::cede; 1235 Coro::cede;
1144} 1236}
1145 1237
1146sub new($) { 1238sub new($) {
1154 $cf::PLAYER{$login} = $self; 1246 $cf::PLAYER{$login} = $self;
1155 1247
1156 $self 1248 $self
1157} 1249}
1158 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
1159sub quit_character { 1258sub quit_character {
1160 my ($pl) = @_; 1259 my ($pl) = @_;
1260
1261 my $name = $pl->ob->name;
1161 1262
1162 $pl->{deny_save} = 1; 1263 $pl->{deny_save} = 1;
1163 $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
1164 1265
1165 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1266 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1167 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1268 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1168 $pl->ns->destroy if $pl->ns; 1269 $pl->ns->destroy if $pl->ns;
1169 1270
1170 my $path = playerdir $pl; 1271 my $path = playerdir $pl;
1171 my $temp = "$path~$cf::RUNTIME~deleting~"; 1272 my $temp = "$path~$cf::RUNTIME~deleting~";
1172 IO::AIO::aio_rename $path, $temp, sub { 1273 aio_rename $path, $temp;
1173 delete $cf::PLAYER{$pl->ob->name}; 1274 delete $cf::PLAYER{$pl->ob->name};
1174 $pl->destroy; 1275 $pl->destroy;
1175 1276
1277 my $prefix = qr<^~\Q$name\E/>;
1278
1279 # nuke player maps
1280 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1281
1176 IO::AIO::aio_rmtree $temp; 1282 IO::AIO::aio_rmtree $temp;
1283}
1284
1285=item $pl->kick
1286
1287Kicks a player out of the game. This destroys the connection.
1288
1289=cut
1290
1291sub kick {
1292 my ($pl, $kicker) = @_;
1293
1294 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1295 $pl->killer ("kicked");
1296 $pl->ns->destroy;
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;
1177 }; 1319 }
1178}
1179 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
1180=item $player->ext_reply ($msgid, $msgtype, %msg) 1352=item $player->ext_reply ($msgid, %msg)
1181 1353
1182Sends an ext reply to the player. 1354Sends an ext reply to the player.
1183 1355
1184=cut 1356=cut
1185 1357
1186sub ext_reply($$$%) { 1358sub ext_reply($$%) {
1187 my ($self, $id, %msg) = @_; 1359 my ($self, $id, %msg) = @_;
1188 1360
1189 $msg{msgid} = $id; 1361 $msg{msgid} = $id;
1190 1362
1191 $self->send ("ext " . cf::to_json \%msg); 1363 $self->send ("ext " . cf::to_json \%msg);
1192} 1364}
1193 1365
1194package 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}
1195 1406
1196=back 1407=back
1197
1198 1408
1199=head3 cf::map 1409=head3 cf::map
1200 1410
1201=over 4 1411=over 4
1202 1412
1205package cf::map; 1415package cf::map;
1206 1416
1207use Fcntl; 1417use Fcntl;
1208use Coro::AIO; 1418use Coro::AIO;
1209 1419
1420use overload
1421 '""' => \&as_string,
1422 fallback => 1;
1423
1210our $MAX_RESET = 3600; 1424our $MAX_RESET = 3600;
1211our $DEFAULT_RESET = 3000; 1425our $DEFAULT_RESET = 3000;
1212 1426
1213sub generate_random_map { 1427sub generate_random_map {
1214 my ($path, $rmp) = @_; 1428 my ($self, $rmp) = @_;
1215
1216 # mit "rum" bekleckern, nicht 1429 # mit "rum" bekleckern, nicht
1217 cf::map::_create_random_map 1430 $self->_create_random_map (
1218 $path,
1219 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1431 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1220 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1432 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1221 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1433 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1222 $rmp->{exit_on_final_map}, 1434 $rmp->{exit_on_final_map},
1223 $rmp->{xsize}, $rmp->{ysize}, 1435 $rmp->{xsize}, $rmp->{ysize},
1224 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1436 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1225 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1437 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1226 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1438 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1227 $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},
1228 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1440 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1229 (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"
1230} 1570}
1231 1571
1232# and all this just because we cannot iterate over 1572# and all this just because we cannot iterate over
1233# all maps in C++... 1573# all maps in C++...
1234sub change_all_map_light { 1574sub change_all_map_light {
1236 1576
1237 $_->change_map_light ($change) 1577 $_->change_map_light ($change)
1238 for grep $_->outdoor, values %cf::MAP; 1578 for grep $_->outdoor, values %cf::MAP;
1239} 1579}
1240 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
1241sub try_load_header($) { 1597sub load_header_from($) {
1242 my ($path) = @_; 1598 my ($self, $path) = @_;
1243 1599
1244 utf8::encode $path; 1600 utf8::encode $path;
1245 aio_open $path, O_RDONLY, 0 1601 #aio_open $path, O_RDONLY, 0
1602 # or return;
1603
1604 $self->_load_header ($path)
1246 or return; 1605 or return;
1247 1606
1248 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
1249 or return; 1650 or return;
1651 $self->prepare_orig;
1652 }
1250 1653
1251 # for better error messages only, will be overwritten 1654 $self->{deny_reset} = 1
1252 $map->path ($path); 1655 if $self->no_reset;
1253 1656
1254 $map->load_header ($path) 1657 $self->default_region (cf::region::find_by_path $self->{path})
1255 or return; 1658 unless $self->default_region;
1256 1659
1257 $map->{load_path} = $path; 1660 1
1258
1259 $map
1260} 1661}
1261 1662
1262sub find; 1663sub find;
1263sub find { 1664sub find {
1264 my ($path, $origin) = @_; 1665 my ($path, $origin) = @_;
1265 1666
1266 #warn "find<$path,$origin>\n";#d#
1267
1268 $path = new cf::path $path, $origin && $origin->path; 1667 $path = normalise $path, $origin && $origin->path;
1269 my $key = $path->as_string;
1270 1668
1271 cf::lock_wait "map_find:$key"; 1669 cf::lock_wait "map_find:$path";
1272 1670
1273 $cf::MAP{$key} || do { 1671 $cf::MAP{$path} || do {
1274 my $guard = cf::lock_acquire "map_find:$key"; 1672 my $guard = cf::lock_acquire "map_find:$path";
1275 1673 my $map = new_from_path cf::map $path
1276 # do it the slow way
1277 my $map = try_load_header $path->save_path;
1278
1279 Coro::cede;
1280
1281 if ($map) {
1282 $map->last_access ((delete $map->{last_access})
1283 || $cf::RUNTIME); #d#
1284 # safety
1285 $map->{instantiate_time} = $cf::RUNTIME
1286 if $map->{instantiate_time} > $cf::RUNTIME;
1287 } else {
1288 if (my $rmp = $path->random_map_params) {
1289 $map = generate_random_map $key, $rmp;
1290 } else {
1291 $map = try_load_header $path->load_path;
1292 }
1293
1294 $map or return; 1674 or return;
1295 1675
1296 $map->{load_original} = 1;
1297 $map->{instantiate_time} = $cf::RUNTIME;
1298 $map->last_access ($cf::RUNTIME);
1299 $map->instantiate;
1300
1301 # per-player maps become, after loading, normal maps
1302 $map->per_player (0) if $path->{user_rel};
1303 }
1304
1305 $map->path ($key);
1306 $map->{path} = $path;
1307 $map->{last_save} = $cf::RUNTIME; 1676 $map->{last_save} = $cf::RUNTIME;
1308 1677
1309 Coro::cede; 1678 $map->load_header
1679 or return;
1310 1680
1311 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;
1312 $map->reset; 1684 $map->reset;
1313 undef $guard; 1685 undef $guard;
1314 $map = find $path 1686 return find $path;
1315 or return;
1316 } 1687 }
1317 1688
1318 $cf::MAP{$key} = $map 1689 $cf::MAP{$path} = $map
1319 } 1690 }
1320} 1691}
1692
1693sub pre_load { }
1694sub post_load { }
1321 1695
1322sub load { 1696sub load {
1323 my ($self) = @_; 1697 my ($self) = @_;
1324 1698
1699 local $self->{deny_reset} = 1; # loading can take a long time
1700
1325 my $path = $self->{path}; 1701 my $path = $self->{path};
1702
1703 {
1326 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1704 my $guard = cf::lock_acquire "map_load:$path";
1327 1705
1328 return if $self->in_memory != cf::MAP_SWAPPED; 1706 return if $self->in_memory != cf::MAP_SWAPPED;
1329 1707
1330 $self->in_memory (cf::MAP_LOADING); 1708 $self->in_memory (cf::MAP_LOADING);
1331 1709
1332 $self->alloc; 1710 $self->alloc;
1711
1712 $self->pre_load;
1713 Coro::cede;
1714
1333 $self->load_objects ($self->{load_path}, 1) 1715 $self->_load_objects ($self->{load_path}, 1)
1334 or return; 1716 or return;
1335 1717
1336 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1718 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1337 if delete $self->{load_original}; 1719 if delete $self->{load_original};
1338 1720
1339 if (my $uniq = $path->uniq_path) { 1721 if (my $uniq = $self->uniq_path) {
1340 utf8::encode $uniq; 1722 utf8::encode $uniq;
1341 if (aio_open $uniq, O_RDONLY, 0) { 1723 if (aio_open $uniq, O_RDONLY, 0) {
1342 $self->clear_unique_items; 1724 $self->clear_unique_items;
1343 $self->load_objects ($uniq, 0); 1725 $self->_load_objects ($uniq, 0);
1344 } 1726 }
1345 } 1727 }
1346 1728
1347 Coro::cede; 1729 Coro::cede;
1348
1349 # now do the right thing for maps 1730 # now do the right thing for maps
1350 $self->link_multipart_objects; 1731 $self->link_multipart_objects;
1351
1352 if ($self->{path}->is_style_map) {
1353 $self->{deny_save} = 1;
1354 $self->{deny_reset} = 1;
1355 } else {
1356 $self->fix_auto_apply;
1357 $self->decay_objects;
1358 $self->update_buttons;
1359 $self->set_darkness_map;
1360 $self->difficulty ($self->estimate_difficulty) 1732 $self->difficulty ($self->estimate_difficulty)
1361 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;
1362 $self->activate; 1743 $self->activate;
1363 } 1744 }
1364 1745
1365 Coro::cede;
1366
1367 $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 }
1368} 1786}
1369 1787
1370sub find_sync { 1788sub find_sync {
1371 my ($path, $origin) = @_; 1789 my ($path, $origin) = @_;
1372 1790
1373 cf::sync_job { cf::map::find $path, $origin } 1791 cf::sync_job { find $path, $origin }
1374} 1792}
1375 1793
1376sub do_load_sync { 1794sub do_load_sync {
1377 my ($map) = @_; 1795 my ($map) = @_;
1378 1796
1379 cf::sync_job { $map->load }; 1797 cf::sync_job { $map->load };
1380} 1798}
1381 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
1382sub save { 1830sub save {
1383 my ($self) = @_; 1831 my ($self) = @_;
1384 1832
1385 my $lock = cf::lock_acquire "map_data:" . $self->path; 1833 my $lock = cf::lock_acquire "map_data:" . $self->path;
1386 1834
1387 $self->{last_save} = $cf::RUNTIME; 1835 $self->{last_save} = $cf::RUNTIME;
1388 1836
1389 return unless $self->dirty; 1837 return unless $self->dirty;
1390 1838
1391 my $save = $self->{path}->save_path; utf8::encode $save; 1839 my $save = $self->save_path; utf8::encode $save;
1392 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1840 my $uniq = $self->uniq_path; utf8::encode $uniq;
1393 1841
1394 $self->{load_path} = $save; 1842 $self->{load_path} = $save;
1395 1843
1396 return if $self->{deny_save}; 1844 return if $self->{deny_save};
1397 1845
1400 cf::async { 1848 cf::async {
1401 $_->contr->save for $self->players; 1849 $_->contr->save for $self->players;
1402 }; 1850 };
1403 1851
1404 if ($uniq) { 1852 if ($uniq) {
1405 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1853 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1406 $self->save_objects ($uniq, cf::IO_UNIQUES); 1854 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1407 } else { 1855 } else {
1408 $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);
1409 } 1857 }
1410} 1858}
1411 1859
1412sub swap_out { 1860sub swap_out {
1413 my ($self) = @_; 1861 my ($self) = @_;
1427 1875
1428sub reset_at { 1876sub reset_at {
1429 my ($self) = @_; 1877 my ($self) = @_;
1430 1878
1431 # TODO: safety, remove and allow resettable per-player maps 1879 # TODO: safety, remove and allow resettable per-player maps
1432 return 1e99 if $self->{path}{user_rel};
1433 return 1e99 if $self->{deny_reset}; 1880 return 1e99 if $self->{deny_reset};
1434 1881
1435 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1882 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1436 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;
1437 1884
1442 my ($self) = @_; 1889 my ($self) = @_;
1443 1890
1444 $self->reset_at <= $cf::RUNTIME 1891 $self->reset_at <= $cf::RUNTIME
1445} 1892}
1446 1893
1447sub unlink_save {
1448 my ($self) = @_;
1449
1450 utf8::encode (my $save = $self->{path}->save_path);
1451 aioreq_pri 3; IO::AIO::aio_unlink $save;
1452 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1453}
1454
1455sub rename {
1456 my ($self, $new_path) = @_;
1457
1458 $self->unlink_save;
1459
1460 delete $cf::MAP{$self->path};
1461 $self->{path} = new cf::path $new_path;
1462 $self->path ($self->{path}->as_string);
1463 $cf::MAP{$self->path} = $self;
1464
1465 $self->save;
1466}
1467
1468sub reset { 1894sub reset {
1469 my ($self) = @_; 1895 my ($self) = @_;
1470 1896
1471 my $lock = cf::lock_acquire "map_data:" . $self->path; 1897 my $lock = cf::lock_acquire "map_data:$self->{path}";
1472 1898
1473 return if $self->players; 1899 return if $self->players;
1474 return if $self->{path}{user_rel};#d#
1475 1900
1476 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 }
1477 1912
1478 delete $cf::MAP{$self->path}; 1913 delete $cf::MAP{$self->path};
1914
1915 $self->clear;
1479 1916
1480 $_->clear_links_to ($self) for values %cf::MAP; 1917 $_->clear_links_to ($self) for values %cf::MAP;
1481 1918
1482 $self->unlink_save; 1919 $self->unlink_save;
1483 $self->destroy; 1920 $self->destroy;
1486my $nuke_counter = "aaaa"; 1923my $nuke_counter = "aaaa";
1487 1924
1488sub nuke { 1925sub nuke {
1489 my ($self) = @_; 1926 my ($self) = @_;
1490 1927
1928 delete $cf::MAP{$self->path};
1929
1930 $self->unlink_save;
1931
1932 bless $self, "cf::map";
1933 delete $self->{deny_reset};
1491 $self->{deny_save} = 1; 1934 $self->{deny_save} = 1;
1492 $self->reset_timeout (1); 1935 $self->reset_timeout (1);
1493 $self->rename ("{nuke}/" . ($nuke_counter++)); 1936 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1937
1938 $cf::MAP{$self->path} = $self;
1939
1494 $self->reset; # polite request, might not happen 1940 $self->reset; # polite request, might not happen
1495} 1941}
1496 1942
1497sub customise_for { 1943=item $maps = cf::map::tmp_maps
1498 my ($map, $ob) = @_;
1499 1944
1500 if ($map->per_player) { 1945Returns an arrayref with all map paths of currently instantiated and saved
1501 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 1946maps. May block.
1947
1948=cut
1949
1950sub tmp_maps() {
1502 } 1951 [
1503 1952 map {
1504 $map 1953 utf8::decode $_;
1954 /\.map$/
1955 ? normalise $_
1956 : ()
1957 } @{ aio_readdir $TMPDIR or [] }
1958 ]
1505} 1959}
1506 1960
1507sub emergency_save { 1961=item $maps = cf::map::random_maps
1508 my $freeze_guard = cf::freeze_mainloop;
1509 1962
1510 warn "enter emergency perl save\n"; 1963Returns an arrayref with all map paths of currently instantiated and saved
1964random maps. May block.
1511 1965
1512 cf::sync_job { 1966=cut
1513 warn "begin emergency player save\n";
1514 $_->save for values %cf::PLAYER;
1515 warn "end emergency player save\n";
1516 1967
1517 warn "begin emergency map save\n"; 1968sub random_maps() {
1518 $_->save for values %cf::MAP; 1969 [
1519 warn "end emergency map save\n"; 1970 map {
1520 }; 1971 utf8::decode $_;
1972 /\.map$/
1973 ? normalise "?random/$_"
1974 : ()
1975 } @{ aio_readdir $RANDOMDIR or [] }
1976 ]
1977}
1521 1978
1522 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 ]
1523} 1995}
1524 1996
1525package cf; 1997package cf;
1526 1998
1527=back 1999=back
1528 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
1529 2027
1530=head3 cf::object::player 2028=head3 cf::object::player
1531 2029
1532=over 4 2030=over 4
1533 2031
1573 2071
1574=item $player_object->enter_link 2072=item $player_object->enter_link
1575 2073
1576Freezes the player and moves him/her to a special map (C<{link}>). 2074Freezes the player and moves him/her to a special map (C<{link}>).
1577 2075
1578The player should be reaosnably safe there for short amounts of time. You 2076The player should be reasonably safe there for short amounts of time. You
1579I<MUST> call C<leave_link> as soon as possible, though. 2077I<MUST> call C<leave_link> as soon as possible, though.
1580 2078
2079Will never block.
2080
1581=item $player_object->leave_link ($map, $x, $y) 2081=item $player_object->leave_link ($map, $x, $y)
1582 2082
1583Moves the player out of the specila link map onto the given map. If the 2083Moves the player out of the special C<{link}> map onto the specified
1584map is not valid (or omitted), the player will be moved back to the 2084map. If the map is not valid (or omitted), the player will be moved back
1585location he/she was before the call to C<enter_link>, or, if that fails, 2085to the location he/she was before the call to C<enter_link>, or, if that
1586to the emergency map position. 2086fails, to the emergency map position.
1587 2087
1588Might block. 2088Might block.
1589 2089
1590=cut 2090=cut
2091
2092sub link_map {
2093 unless ($LINK_MAP) {
2094 $LINK_MAP = cf::map::find "{link}"
2095 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2096 $LINK_MAP->load;
2097 }
2098
2099 $LINK_MAP
2100}
1591 2101
1592sub cf::object::player::enter_link { 2102sub cf::object::player::enter_link {
1593 my ($self) = @_; 2103 my ($self) = @_;
1594 2104
1595 $self->deactivate_recursive; 2105 $self->deactivate_recursive;
1596 2106
1597 return if $self->map == $LINK_MAP; 2107 return if UNIVERSAL::isa $self->map, "ext::map_link";
1598 2108
1599 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2109 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1600 if $self->map; 2110 if $self->map && $self->map->{path} ne "{link}";
1601 2111
1602 $self->enter_map ($LINK_MAP, 20, 20); 2112 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1603} 2113}
1604 2114
1605sub cf::object::player::leave_link { 2115sub cf::object::player::leave_link {
1606 my ($self, $map, $x, $y) = @_; 2116 my ($self, $map, $x, $y) = @_;
2117
2118 return unless $self->contr->active;
1607 2119
1608 my $link_pos = delete $self->{_link_pos}; 2120 my $link_pos = delete $self->{_link_pos};
1609 2121
1610 unless ($map) { 2122 unless ($map) {
1611 # restore original map position 2123 # restore original map position
1625 # use -1 or undef as default coordinates, not 0, 0 2137 # use -1 or undef as default coordinates, not 0, 0
1626 ($x, $y) = ($map->enter_x, $map->enter_y) 2138 ($x, $y) = ($map->enter_x, $map->enter_y)
1627 if $x <=0 && $y <= 0; 2139 if $x <=0 && $y <= 0;
1628 2140
1629 $map->load; 2141 $map->load;
2142 $map->load_diag;
1630 2143
1631 return unless $self->contr->active; 2144 return unless $self->contr->active;
1632 $self->activate_recursive; 2145 $self->activate_recursive;
2146
2147 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1633 $self->enter_map ($map, $x, $y); 2148 $self->enter_map ($map, $x, $y);
1634} 2149}
1635 2150
1636cf::player->attach (
1637 on_logout => sub {
1638 my ($pl) = @_;
1639
1640 # abort map switching before logout
1641 if ($pl->ob->{_link_pos}) {
1642 cf::sync_job {
1643 $pl->ob->leave_link
1644 };
1645 }
1646 },
1647 on_login => sub {
1648 my ($pl) = @_;
1649
1650 # try to abort aborted map switching on player login :)
1651 # should happen only on crashes
1652 if ($pl->ob->{_link_pos}) {
1653 $pl->ob->enter_link;
1654 (async {
1655 # we need this sleep as the login has a concurrent enter_exit running
1656 # and this sleep increases chances of the player not ending up in scorn
1657 $pl->ob->reply (undef,
1658 "There was an internal problem at your last logout, "
1659 . "the server will try to bring you to your intended destination in a second.",
1660 cf::NDI_RED);
1661 Coro::Timer::sleep 1;
1662 $pl->ob->leave_link;
1663 })->prio (2);
1664 }
1665 },
1666);
1667
1668=item $player_object->goto ($path, $x, $y) 2151=item $player_object->goto ($path, $x, $y[, $check->($map)])
1669 2152
2153Moves the player to the given map-path and coordinates by first freezing
2154her, loading and preparing them map, calling the provided $check callback
2155that has to return the map if sucecssful, and then unfreezes the player on
2156the new (success) or old (failed) map position.
2157
1670=cut 2158=cut
2159
2160our $GOTOGEN;
1671 2161
1672sub cf::object::player::goto { 2162sub cf::object::player::goto {
1673 my ($self, $path, $x, $y) = @_; 2163 my ($self, $path, $x, $y, $check) = @_;
2164
2165 # do generation counting so two concurrent goto's will be executed in-order
2166 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1674 2167
1675 $self->enter_link; 2168 $self->enter_link;
1676 2169
1677 (async { 2170 (async {
1678 $path = new cf::path $path; 2171 my $map = eval {
1679
1680 my $map = cf::map::find $path->as_string; 2172 my $map = cf::map::find $path;
2173
2174 if ($map) {
1681 $map = $map->customise_for ($self) if $map; 2175 $map = $map->customise_for ($self);
1682 2176 $map = $check->($map) if $check && $map;
1683# warn "entering ", $map->path, " at ($x, $y)\n" 2177 } else {
1684# if $map;
1685
1686 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2178 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2179 }
1687 2180
2181 $map
2182 };
2183
2184 if ($@) {
2185 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2186 LOG llevError | logBacktrace, Carp::longmess $@;
2187 }
2188
2189 if ($gen == $self->{_goto_generation}) {
2190 delete $self->{_goto_generation};
1688 $self->leave_link ($map, $x, $y); 2191 $self->leave_link ($map, $x, $y);
2192 }
1689 })->prio (1); 2193 })->prio (1);
1690} 2194}
1691 2195
1692=item $player_object->enter_exit ($exit_object) 2196=item $player_object->enter_exit ($exit_object)
1693 2197
1695 2199
1696sub parse_random_map_params { 2200sub parse_random_map_params {
1697 my ($spec) = @_; 2201 my ($spec) = @_;
1698 2202
1699 my $rmp = { # defaults 2203 my $rmp = { # defaults
1700 xsize => 10, 2204 xsize => (cf::rndm 15, 40),
1701 ysize => 10, 2205 ysize => (cf::rndm 15, 40),
2206 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2207 #layout => string,
1702 }; 2208 };
1703 2209
1704 for (split /\n/, $spec) { 2210 for (split /\n/, $spec) {
1705 my ($k, $v) = split /\s+/, $_, 2; 2211 my ($k, $v) = split /\s+/, $_, 2;
1706 2212
1710 $rmp 2216 $rmp
1711} 2217}
1712 2218
1713sub prepare_random_map { 2219sub prepare_random_map {
1714 my ($exit) = @_; 2220 my ($exit) = @_;
2221
2222 my $guard = cf::lock_acquire "exit_prepare:$exit";
1715 2223
1716 # all this does is basically replace the /! path by 2224 # all this does is basically replace the /! path by
1717 # a new random map path (?random/...) with a seed 2225 # a new random map path (?random/...) with a seed
1718 # that depends on the exit object 2226 # that depends on the exit object
1719 2227
1720 my $rmp = parse_random_map_params $exit->msg; 2228 my $rmp = parse_random_map_params $exit->msg;
1721 2229
1722 if ($exit->map) { 2230 if ($exit->map) {
1723 $rmp->{region} = $exit->map->region_name; 2231 $rmp->{region} = $exit->region->name;
1724 $rmp->{origin_map} = $exit->map->path; 2232 $rmp->{origin_map} = $exit->map->path;
1725 $rmp->{origin_x} = $exit->x; 2233 $rmp->{origin_x} = $exit->x;
1726 $rmp->{origin_y} = $exit->y; 2234 $rmp->{origin_y} = $exit->y;
1727 } 2235 }
1728 2236
1729 $rmp->{random_seed} ||= $exit->random_seed; 2237 $rmp->{random_seed} ||= $exit->random_seed;
1730 2238
1731 my $data = cf::to_json $rmp; 2239 my $data = cf::to_json $rmp;
1732 my $md5 = Digest::MD5::md5_hex $data; 2240 my $md5 = Digest::MD5::md5_hex $data;
2241 my $meta = "$RANDOMDIR/$md5.meta";
1733 2242
1734 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2243 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1735 aio_write $fh, 0, (length $data), $data, 0; 2244 aio_write $fh, 0, (length $data), $data, 0;
2245 undef $fh;
2246 aio_rename "$meta~", $meta;
1736 2247
1737 $exit->slaying ("?random/$md5"); 2248 $exit->slaying ("?random/$md5");
1738 $exit->msg (undef); 2249 $exit->msg (undef);
1739 } 2250 }
1740} 2251}
1741 2252
1742sub cf::object::player::enter_exit { 2253sub cf::object::player::enter_exit {
1743 my ($self, $exit) = @_; 2254 my ($self, $exit) = @_;
1744 2255
1745 return unless $self->type == cf::PLAYER; 2256 return unless $self->type == cf::PLAYER;
2257
2258 if ($exit->slaying eq "/!") {
2259 #TODO: this should de-fi-ni-te-ly not be a sync-job
2260 # the problem is that $exit might not survive long enough
2261 # so it needs to be done right now, right here
2262 cf::sync_job { prepare_random_map $exit };
2263 }
2264
2265 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2266 my $hp = $exit->stats->hp;
2267 my $sp = $exit->stats->sp;
1746 2268
1747 $self->enter_link; 2269 $self->enter_link;
1748 2270
1749 (async { 2271 (async {
1750 $self->deactivate_recursive; # just to be sure 2272 $self->deactivate_recursive; # just to be sure
1751 unless (eval { 2273 unless (eval {
1752 prepare_random_map $exit 2274 $self->goto ($slaying, $hp, $sp);
1753 if $exit->slaying eq "/!";
1754
1755 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1756 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1757 2275
1758 1; 2276 1;
1759 }) { 2277 }) {
1760 $self->message ("Something went wrong deep within the crossfire server. " 2278 $self->message ("Something went wrong deep within the crossfire server. "
1761 . "I'll try to bring you back to the map you were before. " 2279 . "I'll try to bring you back to the map you were before. "
1762 . "Please report this to the dungeon master", 2280 . "Please report this to the dungeon master!",
1763 cf::NDI_UNIQUE | cf::NDI_RED); 2281 cf::NDI_UNIQUE | cf::NDI_RED);
1764 2282
1765 warn "ERROR in enter_exit: $@"; 2283 warn "ERROR in enter_exit: $@";
1766 $self->leave_link; 2284 $self->leave_link;
1767 } 2285 }
1768 })->prio (1); 2286 })->prio (1);
1781 2299
1782sub cf::client::send_drawinfo { 2300sub cf::client::send_drawinfo {
1783 my ($self, $text, $flags) = @_; 2301 my ($self, $text, $flags) = @_;
1784 2302
1785 utf8::encode $text; 2303 utf8::encode $text;
1786 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2304 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1787} 2305}
1788 2306
2307=item $client->ext_event ($type, %msg)
2308
2309Sends an exti event to the client.
2310
2311=cut
2312
2313sub cf::client::ext_event($$%) {
2314 my ($self, $type, %msg) = @_;
2315
2316 $msg{msgtype} = "event_$type";
2317 $self->send_packet ("ext " . cf::to_json \%msg);
2318}
1789 2319
1790=item $success = $client->query ($flags, "text", \&cb) 2320=item $success = $client->query ($flags, "text", \&cb)
1791 2321
1792Queues a query to the client, calling the given callback with 2322Queues a query to the client, calling the given callback with
1793the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2323the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1822 # get handled first 2352 # get handled first
1823 my $queue = delete $ns->{query_queue} 2353 my $queue = delete $ns->{query_queue}
1824 or return; # be conservative, not sure how that can happen, but we saw a crash here 2354 or return; # be conservative, not sure how that can happen, but we saw a crash here
1825 2355
1826 (shift @$queue)->[1]->($msg); 2356 (shift @$queue)->[1]->($msg);
2357 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1827 2358
1828 push @{ $ns->{query_queue} }, @$queue; 2359 push @{ $ns->{query_queue} }, @$queue;
1829 2360
1830 if (@{ $ns->{query_queue} } == @$queue) { 2361 if (@{ $ns->{query_queue} } == @$queue) {
1831 if (@$queue) { 2362 if (@$queue) {
1889 2420
1890# here we export the classes and methods available to script code 2421# here we export the classes and methods available to script code
1891 2422
1892=pod 2423=pod
1893 2424
1894The following fucntions and emthods are available within a safe environment: 2425The following functions and methods are available within a safe environment:
1895 2426
1896 cf::object contr pay_amount pay_player map 2427 cf::object contr pay_amount pay_player map
1897 cf::object::player player 2428 cf::object::player player
1898 cf::player peaceful 2429 cf::player peaceful
1899 cf::map trigger 2430 cf::map trigger
1980=back 2511=back
1981 2512
1982=cut 2513=cut
1983 2514
1984############################################################################# 2515#############################################################################
2516# the server's init and main functions
1985 2517
1986=head2 EXTENSION DATABASE SUPPORT 2518sub load_facedata($) {
2519 my ($path) = @_;
1987 2520
1988Crossfire maintains a very simple database for extension use. It can 2521 warn "loading facedata from $path\n";
1989currently store anything that can be serialised using Storable, which
1990excludes objects.
1991 2522
1992The parameter C<$family> should best start with the name of the extension 2523 my $facedata;
1993using it, it should be unique. 2524 0 < aio_load $path, $facedata
2525 or die "$path: $!";
1994 2526
1995=over 4 2527 $facedata = Coro::Storable::thaw $facedata;
1996 2528
1997=item $hashref = cf::db_get $family 2529 $facedata->{version} == 2
2530 or cf::cleanup "$path: version mismatch, cannot proceed.";
1998 2531
1999Return a hashref for use by the extension C<$family>, which can be
2000modified. After modifications, you have to call C<cf::db_dirty> or
2001C<cf::db_sync>.
2002
2003=item $value = cf::db_get $family => $key
2004
2005Returns a single value from the database
2006
2007=item cf::db_put $family => $hashref
2008
2009Stores the given family hashref into the database. Updates are delayed, if
2010you want the data to be synced to disk immediately, use C<cf::db_sync>.
2011
2012=item cf::db_put $family => $key => $value
2013
2014Stores the given C<$value> in the family hash. Updates are delayed, if you
2015want the data to be synced to disk immediately, use C<cf::db_sync>.
2016
2017=item cf::db_dirty
2018
2019Marks the database as dirty, to be updated at a later time.
2020
2021=item cf::db_sync
2022
2023Immediately write the database to disk I<if it is dirty>.
2024
2025=cut
2026
2027our $DB;
2028
2029{
2030 my $path = cf::localdir . "/database.pst";
2031
2032 sub db_load() {
2033 $DB = stat $path ? Storable::retrieve $path : { };
2034 } 2532 {
2533 my $faces = $facedata->{faceinfo};
2035 2534
2036 my $pid; 2535 while (my ($face, $info) = each %$faces) {
2037 2536 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2038 sub db_save() { 2537 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2039 waitpid $pid, 0 if $pid; 2538 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2040 if (0 == ($pid = fork)) { 2539 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2041 $DB->{_meta}{version} = 1; 2540 Coro::cede;
2042 Storable::nstore $DB, "$path~";
2043 rename "$path~", $path;
2044 cf::_exit 0 if defined $pid;
2045 }
2046 }
2047
2048 my $dirty;
2049
2050 sub db_sync() {
2051 db_save if $dirty;
2052 undef $dirty;
2053 }
2054
2055 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2056 db_sync;
2057 });
2058
2059 sub db_dirty() {
2060 $dirty = 1;
2061 $idle->start;
2062 }
2063
2064 sub db_get($;$) {
2065 @_ >= 2
2066 ? $DB->{$_[0]}{$_[1]}
2067 : ($DB->{$_[0]} ||= { })
2068 }
2069
2070 sub db_put($$;$) {
2071 if (@_ >= 3) {
2072 $DB->{$_[0]}{$_[1]} = $_[2];
2073 } else {
2074 $DB->{$_[0]} = $_[1];
2075 }
2076 db_dirty;
2077 }
2078
2079 cf::global->attach (
2080 prio => 10000,
2081 on_cleanup => sub {
2082 db_sync;
2083 }, 2541 }
2084 );
2085}
2086 2542
2087############################################################################# 2543 while (my ($face, $info) = each %$faces) {
2088# the server's main() 2544 next unless $info->{smooth};
2545 my $idx = cf::face::find $face
2546 or next;
2547 if (my $smooth = cf::face::find $info->{smooth}) {
2548 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2549 } else {
2550 warn "smooth face '$info->{smooth}' not found for face '$face'";
2551 }
2552 Coro::cede;
2553 }
2554 }
2555
2556 {
2557 my $anims = $facedata->{animinfo};
2558
2559 while (my ($anim, $info) = each %$anims) {
2560 cf::anim::set $anim, $info->{frames}, $info->{facings};
2561 Coro::cede;
2562 }
2563
2564 cf::anim::invalidate_all; # d'oh
2565 }
2566
2567 1
2568}
2569
2570sub reload_regions {
2571 load_resource_file "$MAPDIR/regions"
2572 or die "unable to load regions file\n";
2573}
2574
2575sub reload_facedata {
2576 load_facedata "$DATADIR/facedata"
2577 or die "unable to load facedata\n";
2578}
2579
2580sub reload_archetypes {
2581 load_resource_file "$DATADIR/archetypes"
2582 or die "unable to load archetypes\n";
2583}
2584
2585sub reload_treasures {
2586 load_resource_file "$DATADIR/treasures"
2587 or die "unable to load treasurelists\n";
2588}
2589
2590sub reload_resources {
2591 warn "reloading resource files...\n";
2592
2593 reload_regions;
2594 reload_facedata;
2595 #reload_archetypes;#d#
2596 reload_archetypes;
2597 reload_treasures;
2598
2599 warn "finished reloading resource files\n";
2600}
2601
2602sub init {
2603 reload_resources;
2604}
2089 2605
2090sub cfg_load { 2606sub cfg_load {
2091 open my $fh, "<:utf8", cf::confdir . "/config" 2607 open my $fh, "<:utf8", "$CONFDIR/config"
2092 or return; 2608 or return;
2093 2609
2094 local $/; 2610 local $/;
2095 *CFG = YAML::Syck::Load <$fh>; 2611 *CFG = YAML::Syck::Load <$fh>;
2096 2612
2099 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 2615 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2100 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 2616 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2101 2617
2102 if (exists $CFG{mlockall}) { 2618 if (exists $CFG{mlockall}) {
2103 eval { 2619 eval {
2104 $CFG{mlockall} ? &mlockall : &munlockall 2620 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2105 and die "WARNING: m(un)lockall failed: $!\n"; 2621 and die "WARNING: m(un)lockall failed: $!\n";
2106 }; 2622 };
2107 warn $@ if $@; 2623 warn $@ if $@;
2108 } 2624 }
2109} 2625}
2110 2626
2111sub main { 2627sub main {
2112 # we must not ever block the main coroutine 2628 # we must not ever block the main coroutine
2113 local $Coro::idle = sub { 2629 local $Coro::idle = sub {
2114 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2630 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2631 (async {
2115 async { Event::one_event }; 2632 Event::one_event;
2633 })->prio (Coro::PRIO_MAX);
2116 }; 2634 };
2117 2635
2118 cfg_load; 2636 cfg_load;
2119 db_load; 2637 db_init;
2120 load_extensions; 2638 load_extensions;
2639
2640 $TICK_WATCHER->start;
2121 Event::loop; 2641 Event::loop;
2122} 2642}
2123 2643
2124############################################################################# 2644#############################################################################
2125# initialisation 2645# initialisation and cleanup
2126 2646
2647# install some emergency cleanup handlers
2648BEGIN {
2649 for my $signal (qw(INT HUP TERM)) {
2650 Event->signal (
2651 reentrant => 0,
2652 data => WF_AUTOCANCEL,
2653 signal => $signal,
2654 prio => 0,
2655 cb => sub {
2656 cf::cleanup "SIG$signal";
2657 },
2658 );
2659 }
2660}
2661
2662sub write_runtime {
2663 my $runtime = "$LOCALDIR/runtime";
2664
2665 # first touch the runtime file to show we are still running:
2666 # the fsync below can take a very very long time.
2667
2668 IO::AIO::aio_utime $runtime, undef, undef;
2669
2670 my $guard = cf::lock_acquire "write_runtime";
2671
2672 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2673 or return;
2674
2675 my $value = $cf::RUNTIME + 90 + 10;
2676 # 10 is the runtime save interval, for a monotonic clock
2677 # 60 allows for the watchdog to kill the server.
2678
2679 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2680 and return;
2681
2682 # always fsync - this file is important
2683 aio_fsync $fh
2684 and return;
2685
2686 # touch it again to show we are up-to-date
2687 aio_utime $fh, undef, undef;
2688
2689 close $fh
2690 or return;
2691
2692 aio_rename "$runtime~", $runtime
2693 and return;
2694
2695 warn "runtime file written.\n";
2696
2697 1
2698}
2699
2700sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop;
2702
2703 warn "enter emergency perl save\n";
2704
2705 cf::sync_job {
2706 # use a peculiar iteration method to avoid tripping on perl
2707 # refcount bugs in for. also avoids problems with players
2708 # and maps saved/destroyed asynchronously.
2709 warn "begin emergency player save\n";
2710 for my $login (keys %cf::PLAYER) {
2711 my $pl = $cf::PLAYER{$login} or next;
2712 $pl->valid or next;
2713 $pl->save;
2714 }
2715 warn "end emergency player save\n";
2716
2717 warn "begin emergency map save\n";
2718 for my $path (keys %cf::MAP) {
2719 my $map = $cf::MAP{$path} or next;
2720 $map->valid or next;
2721 $map->save;
2722 }
2723 warn "end emergency map save\n";
2724
2725 warn "begin emergency database checkpoint\n";
2726 BDB::db_env_txn_checkpoint $DB_ENV;
2727 warn "end emergency database checkpoint\n";
2728 };
2729
2730 warn "leave emergency perl save\n";
2731}
2732
2733sub post_cleanup {
2734 my ($make_core) = @_;
2735
2736 warn Carp::longmess "post_cleanup backtrace"
2737 if $make_core;
2738}
2739
2127sub reload() { 2740sub do_reload_perl() {
2128 # can/must only be called in main 2741 # can/must only be called in main
2129 if ($Coro::current != $Coro::main) { 2742 if ($Coro::current != $Coro::main) {
2130 warn "can only reload from main coroutine\n"; 2743 warn "can only reload from main coroutine";
2131 return; 2744 return;
2132 } 2745 }
2133 2746
2134 warn "reloading..."; 2747 warn "reloading...";
2135 2748
2136 my $guard = freeze_mainloop; 2749 warn "entering sync_job";
2750
2751 cf::sync_job {
2752 cf::write_runtime; # external watchdog should not bark
2137 cf::emergency_save; 2753 cf::emergency_save;
2754 cf::write_runtime; # external watchdog should not bark
2138 2755
2139 eval { 2756 warn "syncing database to disk";
2757 BDB::db_env_txn_checkpoint $DB_ENV;
2758
2140 # if anything goes wrong in here, we should simply crash as we already saved 2759 # if anything goes wrong in here, we should simply crash as we already saved
2141 2760
2142 # cancel all watchers 2761 warn "cancelling all WF_AUTOCANCEL watchers";
2143 for (Event::all_watchers) { 2762 for (Event::all_watchers) {
2144 $_->cancel if $_->data & WF_AUTOCANCEL; 2763 $_->cancel if $_->data & WF_AUTOCANCEL;
2145 } 2764 }
2146 2765
2766 warn "flushing outstanding aio requests";
2767 for (;;) {
2768 BDB::flush;
2769 IO::AIO::flush;
2770 Coro::cede;
2771 last unless IO::AIO::nreqs || BDB::nreqs;
2772 warn "iterate...";
2773 }
2774
2775 ++$RELOAD;
2776
2147 # cancel all extension coros 2777 warn "cancelling all extension coros";
2148 $_->cancel for values %EXT_CORO; 2778 $_->cancel for values %EXT_CORO;
2149 %EXT_CORO = (); 2779 %EXT_CORO = ();
2150 2780
2151 # unload all extensions 2781 warn "removing commands";
2152 for (@exts) { 2782 %COMMAND = ();
2783
2784 warn "removing ext commands";
2785 %EXTCMD = ();
2786
2787 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) {
2153 warn "unloading <$_>"; 2789 warn "... unloading $pkg";
2154 unload_extension $_; 2790
2791 if (my $cb = $pkg->can ("unload")) {
2792 eval {
2793 $cb->($pkg);
2794 1
2795 } or warn "$pkg unloaded, but with errors: $@";
2155 } 2796 }
2156 2797
2798 warn "... nuking $pkg";
2799 Symbol::delete_package $pkg;
2800 }
2801
2157 # unload all modules loaded from $LIBDIR 2802 warn "unloading all perl modules loaded from $LIBDIR";
2158 while (my ($k, $v) = each %INC) { 2803 while (my ($k, $v) = each %INC) {
2159 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2804 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2160 2805
2161 warn "removing <$k>"; 2806 warn "... unloading $k";
2162 delete $INC{$k}; 2807 delete $INC{$k};
2163 2808
2164 $k =~ s/\.pm$//; 2809 $k =~ s/\.pm$//;
2165 $k =~ s/\//::/g; 2810 $k =~ s/\//::/g;
2166 2811
2169 } 2814 }
2170 2815
2171 Symbol::delete_package $k; 2816 Symbol::delete_package $k;
2172 } 2817 }
2173 2818
2174 # sync database to disk
2175 cf::db_sync;
2176 IO::AIO::flush;
2177
2178 # get rid of safe::, as good as possible 2819 warn "getting rid of safe::, as good as possible";
2179 Symbol::delete_package "safe::$_" 2820 Symbol::delete_package "safe::$_"
2180 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2821 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2181 2822
2182 # remove register_script_function callbacks
2183 # TODO
2184
2185 # unload cf.pm "a bit" 2823 warn "unloading cf.pm \"a bit\"";
2186 delete $INC{"cf.pm"}; 2824 delete $INC{"cf.pm"};
2825 delete $INC{"cf/pod.pm"};
2187 2826
2188 # don't, removes xs symbols, too, 2827 # don't, removes xs symbols, too,
2189 # and global variables created in xs 2828 # and global variables created in xs
2190 #Symbol::delete_package __PACKAGE__; 2829 #Symbol::delete_package __PACKAGE__;
2191 2830
2192 # reload cf.pm 2831 warn "unload completed, starting to reload now";
2832
2193 warn "reloading cf.pm"; 2833 warn "reloading cf.pm";
2194 require cf; 2834 require cf;
2195 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2196 2836
2197 # load config and database again 2837 warn "loading config and database again";
2198 cf::cfg_load; 2838 cf::cfg_load;
2199 cf::db_load;
2200 2839
2201 # load extensions
2202 warn "load extensions"; 2840 warn "loading extensions";
2203 cf::load_extensions; 2841 cf::load_extensions;
2204 2842
2205 # reattach attachments to objects 2843 warn "reattaching attachments to objects/players";
2206 warn "reattach"; 2844 _global_reattach; # objects, sockets
2207 _global_reattach; 2845 warn "reattaching attachments to maps";
2208 reattach $_ for values %MAP; 2846 reattach $_ for values %MAP;
2209 }; 2847 warn "reattaching attachments to players";
2848 reattach $_ for values %PLAYER;
2210 2849
2211 if ($@) { 2850 warn "leaving sync_job";
2851
2852 1
2853 } or do {
2212 warn $@; 2854 warn $@;
2213 warn "error while reloading, exiting."; 2855 warn "error while reloading, exiting.";
2214 exit 1; 2856 exit 1;
2215 } 2857 };
2216 2858
2217 warn "reloaded successfully"; 2859 warn "reloaded";
2218}; 2860};
2219 2861
2220############################################################################# 2862our $RELOAD_WATCHER; # used only during reload
2221 2863
2222unless ($LINK_MAP) { 2864sub reload_perl() {
2223 $LINK_MAP = cf::map::new; 2865 # doing reload synchronously and two reloads happen back-to-back,
2866 # coro crashes during coro_state_free->destroy here.
2224 2867
2225 $LINK_MAP->width (41); 2868 $RELOAD_WATCHER ||= Event->timer (
2226 $LINK_MAP->height (41); 2869 reentrant => 0,
2227 $LINK_MAP->alloc;
2228 $LINK_MAP->path ("{link}");
2229 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2230 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2231
2232 # dirty hack because... archetypes are not yet loaded
2233 Event->timer (
2234 after => 10, 2870 after => 0,
2871 data => WF_AUTOCANCEL,
2235 cb => sub { 2872 cb => sub {
2236 $_[0]->w->cancel; 2873 do_reload_perl;
2237 2874 undef $RELOAD_WATCHER;
2238 # provide some exits "home"
2239 my $exit = cf::object::new "exit";
2240
2241 $exit->slaying ($EMERGENCY_POSITION->[0]);
2242 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2243 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2244
2245 $LINK_MAP->insert ($exit->clone, 19, 19);
2246 $LINK_MAP->insert ($exit->clone, 19, 20);
2247 $LINK_MAP->insert ($exit->clone, 19, 21);
2248 $LINK_MAP->insert ($exit->clone, 20, 19);
2249 $LINK_MAP->insert ($exit->clone, 20, 21);
2250 $LINK_MAP->insert ($exit->clone, 21, 19);
2251 $LINK_MAP->insert ($exit->clone, 21, 20);
2252 $LINK_MAP->insert ($exit->clone, 21, 21);
2253
2254 $exit->destroy;
2255 }); 2875 },
2256 2876 );
2257 $LINK_MAP->{deny_save} = 1;
2258 $LINK_MAP->{deny_reset} = 1;
2259
2260 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2261} 2877}
2262
2263register "<global>", __PACKAGE__;
2264 2878
2265register_command "reload" => sub { 2879register_command "reload" => sub {
2266 my ($who, $arg) = @_; 2880 my ($who, $arg) = @_;
2267 2881
2268 if ($who->flag (FLAG_WIZ)) { 2882 if ($who->flag (FLAG_WIZ)) {
2269 $who->message ("start of reload.");
2270 reload;
2271 $who->message ("end of reload."); 2883 $who->message ("reloading server.");
2884 async { reload_perl };
2272 } 2885 }
2273}; 2886};
2274 2887
2275unshift @INC, $LIBDIR; 2888unshift @INC, $LIBDIR;
2276 2889
2890my $bug_warning = 0;
2891
2892our @WAIT_FOR_TICK;
2893our @WAIT_FOR_TICK_BEGIN;
2894
2895sub wait_for_tick {
2896 return unless $TICK_WATCHER->is_active;
2897 return if $Coro::current == $Coro::main;
2898
2899 my $signal = new Coro::Signal;
2900 push @WAIT_FOR_TICK, $signal;
2901 $signal->wait;
2902}
2903
2904sub wait_for_tick_begin {
2905 return unless $TICK_WATCHER->is_active;
2906 return if $Coro::current == $Coro::main;
2907
2908 my $signal = new Coro::Signal;
2909 push @WAIT_FOR_TICK_BEGIN, $signal;
2910 $signal->wait;
2911}
2912
2913 my $min = 1e6;#d#
2914 my $avg = 10;
2277$TICK_WATCHER = Event->timer ( 2915$TICK_WATCHER = Event->timer (
2278 reentrant => 0, 2916 reentrant => 0,
2917 parked => 1,
2279 prio => 0, 2918 prio => 0,
2280 at => $NEXT_TICK || $TICK, 2919 at => $NEXT_TICK || $TICK,
2281 data => WF_AUTOCANCEL, 2920 data => WF_AUTOCANCEL,
2282 cb => sub { 2921 cb => sub {
2922 if ($Coro::current != $Coro::main) {
2923 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2924 unless ++$bug_warning > 10;
2925 return;
2926 }
2927
2928 $NOW = $tick_start = Event::time;
2929
2283 cf::server_tick; # one server iteration 2930 cf::server_tick; # one server iteration
2931
2932 0 && sync_job {#d#
2933 for(1..10) {
2934 my $t = Event::time;
2935 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2936 or die;
2937
2938 $map->width (50);
2939 $map->height (50);
2940 $map->alloc;
2941 $map->_load_objects ("/tmp/x.map", 1);
2942 my $t = Event::time - $t;
2943
2944 #next unless $t < 0.0013;#d#
2945 if ($t < $min) {
2946 $min = $t;
2947 }
2948 $avg = $avg * 0.99 + $t * 0.01;
2949 }
2950 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2951 exit 0;
2952 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2953 };
2954
2284 $RUNTIME += $TICK; 2955 $RUNTIME += $TICK;
2285 $NEXT_TICK += $TICK; 2956 $NEXT_TICK += $TICK;
2286 2957
2958 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2959 $NEXT_RUNTIME_WRITE = $NOW + 10;
2960 Coro::async_pool {
2961 write_runtime
2962 or warn "ERROR: unable to write runtime file: $!";
2963 };
2964 }
2965
2966# my $AFTER = Event::time;
2967# warn $AFTER - $NOW;#d#
2968
2969 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2970 $sig->send;
2971 }
2972 while (my $sig = shift @WAIT_FOR_TICK) {
2973 $sig->send;
2974 }
2975
2976 $NOW = Event::time;
2977
2287 # if we are delayed by four ticks or more, skip them all 2978 # if we are delayed by four ticks or more, skip them all
2288 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2979 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2289 2980
2290 $TICK_WATCHER->at ($NEXT_TICK); 2981 $TICK_WATCHER->at ($NEXT_TICK);
2291 $TICK_WATCHER->start; 2982 $TICK_WATCHER->start;
2983
2984 $LOAD = ($NOW - $tick_start) / $TICK;
2985 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2986
2987 _post_tick;
2988
2989
2292 }, 2990 },
2293); 2991);
2294 2992
2993{
2295IO::AIO::max_poll_time $TICK * 0.2; 2994 BDB::max_poll_time $TICK * 0.1;
2296 2995 $BDB_POLL_WATCHER = Event->io (
2297Event->io ( 2996 reentrant => 0,
2298 fd => IO::AIO::poll_fileno, 2997 fd => BDB::poll_fileno,
2299 poll => 'r', 2998 poll => 'r',
2300 prio => 5, 2999 prio => 0,
2301 data => WF_AUTOCANCEL,
2302 cb => \&IO::AIO::poll_cb,
2303);
2304
2305Event->timer (
2306 data => WF_AUTOCANCEL, 3000 data => WF_AUTOCANCEL,
2307 after => 0, 3001 cb => \&BDB::poll_cb,
2308 interval => 10, 3002 );
2309 cb => sub { 3003 BDB::min_parallel 8;
2310 (Coro::unblock_sub { 3004
2311 write_runtime 3005 BDB::set_sync_prepare {
2312 or warn "ERROR: unable to write runtime file: $!"; 3006 my $status;
3007 my $current = $Coro::current;
3008 (
3009 sub {
3010 $status = $!;
3011 $current->ready; undef $current;
3012 },
3013 sub {
3014 Coro::schedule while defined $current;
3015 $! = $status;
3016 },
3017 )
3018 };
3019
3020 unless ($DB_ENV) {
3021 $DB_ENV = BDB::db_env_create;
3022
3023 cf::sync_job {
3024 eval {
3025 BDB::db_env_open
3026 $DB_ENV,
3027 $BDBDIR,
3028 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3029 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3030 0666;
3031
3032 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3033
3034 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3035 $DB_ENV->set_lk_detect;
3036 };
3037
3038 cf::cleanup "db_env_open(db): $@" if $@;
2313 })->(); 3039 };
2314 }, 3040 }
2315); 3041}
3042
3043{
3044 IO::AIO::min_parallel 8;
3045
3046 undef $Coro::AIO::WATCHER;
3047 IO::AIO::max_poll_time $TICK * 0.1;
3048 $AIO_POLL_WATCHER = Event->io (
3049 reentrant => 0,
3050 data => WF_AUTOCANCEL,
3051 fd => IO::AIO::poll_fileno,
3052 poll => 'r',
3053 prio => 6,
3054 cb => \&IO::AIO::poll_cb,
3055 );
3056}
3057
3058my $_log_backtrace;
3059
3060sub _log_backtrace {
3061 my ($msg, @addr) = @_;
3062
3063 $msg =~ s/\n//;
3064
3065 # limit the # of concurrent backtraces
3066 if ($_log_backtrace < 2) {
3067 ++$_log_backtrace;
3068 async {
3069 my @bt = fork_call {
3070 @addr = map { sprintf "%x", $_ } @addr;
3071 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3072 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3073 or die "addr2line: $!";
3074
3075 my @funcs;
3076 my @res = <$fh>;
3077 chomp for @res;
3078 while (@res) {
3079 my ($func, $line) = splice @res, 0, 2, ();
3080 push @funcs, "[$func] $line";
3081 }
3082
3083 @funcs
3084 };
3085
3086 LOG llevInfo, "[ABT] $msg\n";
3087 LOG llevInfo, "[ABT] $_\n" for @bt;
3088 --$_log_backtrace;
3089 };
3090 } else {
3091 LOG llevInfo, "[ABT] $msg\n";
3092 LOG llevInfo, "[ABT] [suppressed]\n";
3093 }
3094}
3095
3096# load additional modules
3097use cf::pod;
2316 3098
2317END { cf::emergency_save } 3099END { cf::emergency_save }
2318 3100
23191 31011
2320 3102

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines