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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.286 by root, Sun Jun 24 04:27:20 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines