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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.165 by root, Fri Jan 12 22:09:22 2007 UTC vs.
Revision 1.286 by root, Sun Jun 24 04:27:20 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines