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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines