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.158 by root, Wed Jan 10 19:52:43 2007 UTC vs.
Revision 1.286 by root, Sun Jun 24 04:27:20 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use BDB ();
20use Data::Dumper; 26use Data::Dumper;
21use Digest::MD5; 27use Digest::MD5;
22use Fcntl; 28use Fcntl;
29use YAML::Syck ();
23use IO::AIO 2.32 (); 30use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
26 33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 41
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
33 44
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 46
47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
48
36our %COMMAND = (); 49our %COMMAND = ();
37our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
38our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
39 56
57our $RELOAD; # number of reloads so far
40our @EVENT; 58our @EVENT;
41our $LIBDIR = datadir . "/ext";
42 59
43our $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(!)
44our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
45our $NEXT_TICK; 76our $NEXT_TICK;
46our $NOW; 77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
47 82
48our %CFG; 83our %CFG;
49 84
50our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
51our $RUNTIME; 86our $RUNTIME;
52 87
53our %PLAYER; # all users 88our %PLAYER; # all users
54our %MAP; # all maps 89our %MAP; # all maps
55our $LINK_MAP; # the special {link} map 90our $LINK_MAP; # the special {link} map, which is always available
56our $RANDOM_MAPS = cf::localdir . "/random";
57our %EXT_CORO; # coroutines bound to extensions
58 91
59our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; 92# used to convert map paths into valid unix filenames by replacing / by ∕
60our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; 93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
61 98
62binmode STDOUT; 99binmode STDOUT;
63binmode STDERR; 100binmode STDERR;
64 101
65# read virtual server time, if available 102# read virtual server time, if available
66unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
67 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
68 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
69 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
70} 107}
71 108
72mkdir cf::localdir; 109mkdir $_
73mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
74mkdir cf::localdir . "/" . cf::tmpdir;
75mkdir cf::localdir . "/" . cf::uniquedir;
76mkdir $RANDOM_MAPS;
77 111
78# a special map that is always available
79our $LINK_MAP;
80our $EMERGENCY_POSITION; 112our $EMERGENCY_POSITION;
113
114sub cf::map::normalise;
81 115
82############################################################################# 116#############################################################################
83 117
84=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
85 119
92=item $cf::RUNTIME 126=item $cf::RUNTIME
93 127
94The 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
95every server tick. 129every server tick.
96 130
97=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
98 134
99The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
100be 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.
101 139
102=item $cf::NOW 140=item $cf::NOW
103 141
104The time of the last (current) server tick. 142The time of the last (current) server tick.
105 143
106=item $cf::TICK 144=item $cf::TICK
107 145
108The 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.
109 157
110=item %cf::CFG 158=item %cf::CFG
111 159
112Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
113from wherever your confdir points to. 161from wherever your confdir points to.
114 162
115=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 163=item cf::wait_for_tick, cf::wait_for_tick_begin
116 164
117These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
118or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 166returns directly I<after> the tick processing (and consequently, can only wake one process
119processing has been done. Call C<< ->wait >> on them to maximise the 167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
120window of cpu time available, or simply to synchronise to the server tick.
121 168
122=back 169=back
123 170
124=cut 171=cut
125 172
126BEGIN { 173BEGIN {
127 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
128 my $msg = join "", @_; 175 my $msg = join "", @_;
129 utf8::encode $msg;
130 176
131 $msg .= "\n" 177 $msg .= "\n"
132 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
133 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
134 LOG llevError, $msg; 183 LOG llevError, $msg;
135 }; 184 };
136} 185}
137 186
138@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
139@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
140@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
141@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
142@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';
143@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)
144 194
145# 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
146# within the Safe compartment. 196# within the Safe compartment.
147for my $pkg (qw( 197for my $pkg (qw(
148 cf::global cf::attachable 198 cf::global cf::attachable
157 207
158$Event::DIED = sub { 208$Event::DIED = sub {
159 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
160}; 210};
161 211
162my %ext_pkg; 212#############################################################################
163my @exts;
164my @hook;
165 213
166=head2 UTILITY FUNCTIONS 214=head2 UTILITY FUNCTIONS
167 215
168=over 4 216=over 4
169 217
188 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 236 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
189 $d 237 $d
190 } || "[unable to dump $_[0]: '$@']"; 238 } || "[unable to dump $_[0]: '$@']";
191} 239}
192 240
193use JSON::Syck (); # TODO# replace by JSON::PC once working 241use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
194 242
195=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
196 244
197Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
198 246
199=cut
200
201sub from_json($) {
202 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
203 JSON::Syck::Load $_[0]
204}
205
206=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
207 248
208Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
209
210=cut
211
212sub to_json($) {
213 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
214 JSON::Syck::Dump $_[0]
215}
216 250
217=item cf::lock_wait $string 251=item cf::lock_wait $string
218 252
219Wait until the given lock is available. See cf::lock_acquire. 253Wait until the given lock is available. See cf::lock_acquire.
220 254
226returned. 260returned.
227 261
228Lock 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
229uses map_find and cf::map::load uses map_load). 263uses map_find and cf::map::load uses map_load).
230 264
265=item $locked = cf::lock_active $string
266
267Return true if the lock is currently active, i.e. somebody has locked it.
268
231=cut 269=cut
232 270
233our %LOCK; 271our %LOCK;
234 272
235sub lock_wait($) { 273sub lock_wait($) {
254 # wake up all waiters, to be on the safe side 292 # wake up all waiters, to be on the safe side
255 $_->ready for @{ delete $LOCK{$key} }; 293 $_->ready for @{ delete $LOCK{$key} };
256 } 294 }
257} 295}
258 296
297sub lock_active($) {
298 my ($key) = @_;
299
300 ! ! $LOCK{$key}
301}
302
259sub freeze_mainloop { 303sub freeze_mainloop {
260 return unless $TICK_WATCHER->is_active; 304 return unless $TICK_WATCHER->is_active;
261 305
262 my $guard = Coro::guard { $TICK_WATCHER->start }; 306 my $guard = Coro::guard {
307 $TICK_WATCHER->start;
308 };
263 $TICK_WATCHER->stop; 309 $TICK_WATCHER->stop;
264 $guard 310 $guard
265} 311}
266 312
267=item cf::async { BLOCK } 313=item cf::async { BLOCK }
274 320
275BEGIN { *async = \&Coro::async_pool } 321BEGIN { *async = \&Coro::async_pool }
276 322
277=item cf::sync_job { BLOCK } 323=item cf::sync_job { BLOCK }
278 324
279The design of crossfire+ requires that the main coro ($Coro::main) is 325The design of Crossfire TRT requires that the main coroutine ($Coro::main)
280always able to handle events or runnable, as crossfire+ is only partly 326is always able to handle events or runnable, as Crossfire TRT is only
281reentrant. 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.
282 329
283If 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
284the given BLOCK in another coroutine while waiting for the result. The 331the given BLOCK in another coroutine while waiting for the result. The
285server 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
286fast or be very important. 333fast or be very important.
289 336
290sub sync_job(&) { 337sub sync_job(&) {
291 my ($job) = @_; 338 my ($job) = @_;
292 339
293 if ($Coro::current == $Coro::main) { 340 if ($Coro::current == $Coro::main) {
341 my $time = Event::time;
342
294 # this is the main coro, too bad, we have to block 343 # this is the main coro, too bad, we have to block
295 # till the operation succeeds, freezing the server :/ 344 # till the operation succeeds, freezing the server :/
296 345
297 # TODO: use suspend/resume instead 346 # TODO: use suspend/resume instead
298 # (but this is cancel-safe) 347 # (but this is cancel-safe)
309 358
310 while ($busy) { 359 while ($busy) {
311 Coro::cede or Event::one_event; 360 Coro::cede or Event::one_event;
312 } 361 }
313 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
314 wantarray ? @res : $res[0] 370 wantarray ? @res : $res[0]
315 } else { 371 } else {
316 # we are in another coroutine, how wonderful, everything just works 372 # we are in another coroutine, how wonderful, everything just works
317 373
318 $job->() 374 $job->()
319 } 375 }
320} 376}
321 377
322=item $coro = cf::async_ext { BLOCK } 378=item $coro = cf::async_ext { BLOCK }
323 379
324Like async, but this coro is automcatially being canceled when the 380Like async, but this coro is automatically being canceled when the
325extension calling this is being unloaded. 381extension calling this is being unloaded.
326 382
327=cut 383=cut
328 384
329sub async_ext(&) { 385sub async_ext(&) {
337 $EXT_CORO{$coro+0} = $coro; 393 $EXT_CORO{$coro+0} = $coro;
338 394
339 $coro 395 $coro
340} 396}
341 397
342sub write_runtime { 398=item fork_call { }, $args
343 my $runtime = cf::localdir . "/runtime";
344 399
345 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 400Executes the given code block with the given arguments in a seperate
346 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.
347 404
348 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 405=cut
349 (aio_write $fh, 0, (length $value), $value, 0) <= 0
350 and return;
351 406
352 aio_fsync $fh 407sub fork_call(&@) {
353 and return; 408 my ($cb, @args) = @_;
354 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) {
355 close $fh 416 close $fh2;
356 or return;
357 417
358 aio_rename "$runtime~", $runtime 418 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
359 and return; 419 $res = Coro::Storable::thaw $res;
360 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;
361 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 });
362} 567}
363 568
364=back 569=back
365 570
366=cut 571=cut
367
368#############################################################################
369
370package cf::path;
371
372use overload
373 '""' => \&as_string;
374
375# used to convert map paths into valid unix filenames by repalcing / by ∕
376our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
377
378sub new {
379 my ($class, $path, $base) = @_;
380
381 $path = $path->as_string if ref $path;
382
383 my $self = bless { }, $class;
384
385 # {... are special paths that are not touched
386 # ?xxx/... are special absolute paths
387 # ?random/... random maps
388 # /! non-realised random map exit
389 # /... normal maps
390 # ~/... per-player maps without a specific player (DO NOT USE)
391 # ~user/... per-player map of a specific user
392
393 $path =~ s/$PATH_SEP/\//go;
394
395 if ($path =~ /^{/) {
396 # fine as it is
397 } elsif ($path =~ s{^\?random/}{}) {
398 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
399 $self->{random} = cf::from_json $data;
400 } else {
401 if ($path =~ s{^~([^/]+)?}{}) {
402 $self->{user_rel} = 1;
403
404 if (defined $1) {
405 $self->{user} = $1;
406 } elsif ($base =~ m{^~([^/]+)/}) {
407 $self->{user} = $1;
408 } else {
409 warn "cannot resolve user-relative path without user <$path,$base>\n";
410 }
411 } elsif ($path =~ /^\//) {
412 # already absolute
413 } else {
414 $base =~ s{[^/]+/?$}{};
415 return $class->new ("$base/$path");
416 }
417
418 for ($path) {
419 redo if s{/\.?/}{/};
420 redo if s{/[^/]+/\.\./}{/};
421 }
422 }
423
424 $self->{path} = $path;
425
426 $self
427}
428
429# the name / primary key / in-game path
430sub as_string {
431 my ($self) = @_;
432
433 $self->{user_rel} ? "~$self->{user}$self->{path}"
434 : $self->{random} ? "?random/$self->{path}"
435 : $self->{path}
436}
437
438# the displayed name, this is a one way mapping
439sub visible_name {
440 my ($self) = @_;
441
442# if (my $rmp = $self->{random}) {
443# # todo: be more intelligent about this
444# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
445# } else {
446 $self->as_string
447# }
448}
449
450# escape the /'s in the path
451sub _escaped_path {
452 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
453 $path
454}
455
456# the original (read-only) location
457sub load_path {
458 my ($self) = @_;
459
460 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
461}
462
463# the temporary/swap location
464sub save_path {
465 my ($self) = @_;
466
467 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
468 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
469 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
470}
471
472# the unique path, might be eq to save_path
473sub uniq_path {
474 my ($self) = @_;
475
476 $self->{user_rel} || $self->{random}
477 ? undef
478 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
479}
480
481# return random map parameters, or undef
482sub random_map_params {
483 my ($self) = @_;
484
485 $self->{random}
486}
487
488# this is somewhat ugly, but style maps do need special treatment
489sub is_style_map {
490 $_[0]{path} =~ m{^/styles/}
491}
492
493package cf;
494 572
495############################################################################# 573#############################################################################
496 574
497=head2 ATTACHABLE OBJECTS 575=head2 ATTACHABLE OBJECTS
498 576
500attach callbacks/event handlers (a collection of which is called an "attachment") 578attach callbacks/event handlers (a collection of which is called an "attachment")
501to it. All such attachable objects support the following methods. 579to it. All such attachable objects support the following methods.
502 580
503In 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>
504C<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
505crossfire+). 583Crossfire TRT).
506 584
507=over 4 585=over 4
508 586
509=item $attachable->attach ($attachment, key => $value...) 587=item $attachable->attach ($attachment, key => $value...)
510 588
624our @CB_TYPE = (); # registry for type (cf-object class) based events 702our @CB_TYPE = (); # registry for type (cf-object class) based events
625our @CB_MAP = (); 703our @CB_MAP = ();
626 704
627my %attachment; 705my %attachment;
628 706
707sub cf::attachable::thawer_merge {
708 # simply override everything except _meta
709 local $_[0]{_meta};
710 %{$_[0]} = %{$_[1]};
711}
712
629sub _attach_cb($$$$) { 713sub _attach_cb($$$$) {
630 my ($registry, $event, $prio, $cb) = @_; 714 my ($registry, $event, $prio, $cb) = @_;
631 715
632 use sort 'stable'; 716 use sort 'stable';
633 717
667 $registry = $CB_TYPE[$object_type] ||= []; 751 $registry = $CB_TYPE[$object_type] ||= [];
668 752
669 } elsif ($type eq "subtype") { 753 } elsif ($type eq "subtype") {
670 defined $object_type or Carp::croak "subtype specified without type"; 754 defined $object_type or Carp::croak "subtype specified without type";
671 my $object_subtype = shift @arg; 755 my $object_subtype = shift @arg;
672 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 756 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
673 757
674 } elsif ($type eq "package") { 758 } elsif ($type eq "package") {
675 my $pkg = shift @arg; 759 my $pkg = shift @arg;
676 760
677 while (my ($name, $id) = each %cb_id) { 761 while (my ($name, $id) = each %cb_id) {
706 _attach $registry, $klass, @attach; 790 _attach $registry, $klass, @attach;
707 } 791 }
708 792
709 $obj->{$name} = \%arg; 793 $obj->{$name} = \%arg;
710 } else { 794 } else {
711 warn "object uses attachment '$name' that is not available, postponing.\n"; 795 warn "object uses attachment '$name' which is not available, postponing.\n";
712 } 796 }
713 797
714 $obj->{_attachment}{$name} = undef; 798 $obj->{_attachment}{$name} = undef;
715} 799}
716 800
718 if (ref $_[0]) { 802 if (ref $_[0]) {
719 _object_attach @_; 803 _object_attach @_;
720 } else { 804 } else {
721 _attach shift->_attach_registry, @_; 805 _attach shift->_attach_registry, @_;
722 } 806 }
807 _recalc_want;
723}; 808};
724 809
725# all those should be optimised 810# all those should be optimised
726sub cf::attachable::detach { 811sub cf::attachable::detach {
727 my ($obj, $name) = @_; 812 my ($obj, $name) = @_;
730 delete $obj->{_attachment}{$name}; 815 delete $obj->{_attachment}{$name};
731 reattach ($obj); 816 reattach ($obj);
732 } else { 817 } else {
733 Carp::croak "cannot, currently, detach class attachments"; 818 Carp::croak "cannot, currently, detach class attachments";
734 } 819 }
820 _recalc_want;
735}; 821};
736 822
737sub cf::attachable::attached { 823sub cf::attachable::attached {
738 my ($obj, $name) = @_; 824 my ($obj, $name) = @_;
739 825
804# object support 890# object support
805 891
806sub reattach { 892sub reattach {
807 # basically do the same as instantiate, without calling instantiate 893 # basically do the same as instantiate, without calling instantiate
808 my ($obj) = @_; 894 my ($obj) = @_;
895
896 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
809 897
810 my $registry = $obj->registry; 898 my $registry = $obj->registry;
811 899
812 @$registry = (); 900 @$registry = ();
813 901
860 $filename, length $$rdata, scalar @$objs; 948 $filename, length $$rdata, scalar @$objs;
861 949
862 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 950 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
863 chmod SAVE_MODE, $fh; 951 chmod SAVE_MODE, $fh;
864 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 952 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
865 aio_fsync $fh; 953 aio_fsync $fh if $cf::USE_FSYNC;
866 close $fh; 954 close $fh;
867 955
868 if (@$objs) { 956 if (@$objs) {
869 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) {
870 chmod SAVE_MODE, $fh; 958 chmod SAVE_MODE, $fh;
871 my $data = Storable::nfreeze { version => 1, objs => $objs }; 959 my $data = Storable::nfreeze { version => 1, objs => $objs };
872 aio_write $fh, 0, (length $data), $data, 0; 960 aio_write $fh, 0, (length $data), $data, 0;
873 aio_fsync $fh; 961 aio_fsync $fh if $cf::USE_FSYNC;
874 close $fh; 962 close $fh;
875 aio_rename "$filename.pst~", "$filename.pst"; 963 aio_rename "$filename.pst~", "$filename.pst";
876 } 964 }
877 } else { 965 } else {
878 aio_unlink "$filename.pst"; 966 aio_unlink "$filename.pst";
910 or return; 998 or return;
911 $av = eval { (Storable::thaw $av)->{objs} }; 999 $av = eval { (Storable::thaw $av)->{objs} };
912 } 1000 }
913 1001
914 warn sprintf "loading %s (%d)\n", 1002 warn sprintf "loading %s (%d)\n",
915 $filename, length $data, scalar @{$av || []};#d# 1003 $filename, length $data, scalar @{$av || []};
916 return ($data, $av); 1004 return ($data, $av);
917} 1005}
1006
1007=head2 COMMAND CALLBACKS
1008
1009=over 4
1010
1011=cut
918 1012
919############################################################################# 1013#############################################################################
920# command handling &c 1014# command handling &c
921 1015
922=item cf::register_command $name => \&callback($ob,$args); 1016=item cf::register_command $name => \&callback($ob,$args);
935 push @{ $COMMAND{$name} }, [$caller, $cb]; 1029 push @{ $COMMAND{$name} }, [$caller, $cb];
936} 1030}
937 1031
938=item cf::register_extcmd $name => \&callback($pl,$packet); 1032=item cf::register_extcmd $name => \&callback($pl,$packet);
939 1033
940Register a callbackf ro execution when the client sends an extcmd packet. 1034Register a callback fro execution when the client sends an extcmd packet.
941 1035
942If 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
943called. 1037called.
944 1038
945=cut 1039=cut
946 1040
947sub register_extcmd { 1041sub register_extcmd {
948 my ($name, $cb) = @_; 1042 my ($name, $cb) = @_;
949 1043
950 my $caller = caller;
951 #warn "registering extcmd '$name' to '$caller'";
952
953 $EXTCMD{$name} = [$cb, $caller]; 1044 $EXTCMD{$name} = $cb;
954} 1045}
955 1046
956cf::player->attach ( 1047cf::player->attach (
957 on_command => sub { 1048 on_command => sub {
958 my ($pl, $name, $params) = @_; 1049 my ($pl, $name, $params) = @_;
971 1062
972 my $msg = eval { from_json $buf }; 1063 my $msg = eval { from_json $buf };
973 1064
974 if (ref $msg) { 1065 if (ref $msg) {
975 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1066 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
976 if (my %reply = $cb->[0]->($pl, $msg)) { 1067 if (my %reply = $cb->($pl, $msg)) {
977 $pl->ext_reply ($msg->{msgid}, %reply); 1068 $pl->ext_reply ($msg->{msgid}, %reply);
978 } 1069 }
979 } 1070 }
980 } else { 1071 } else {
981 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1072 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
983 1074
984 cf::override; 1075 cf::override;
985 }, 1076 },
986); 1077);
987 1078
988sub register {
989 my ($base, $pkg) = @_;
990
991 #TODO
992}
993
994sub load_extension {
995 my ($path) = @_;
996
997 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
998 my $base = $1;
999 my $pkg = $1;
1000 $pkg =~ s/[^[:word:]]/_/g;
1001 $pkg = "ext::$pkg";
1002
1003 warn "loading '$path' into '$pkg'\n";
1004
1005 open my $fh, "<:utf8", $path
1006 or die "$path: $!";
1007
1008 my $source =
1009 "package $pkg; use strict; use utf8;\n"
1010 . "#line 1 \"$path\"\n{\n"
1011 . (do { local $/; <$fh> })
1012 . "\n};\n1";
1013
1014 eval $source
1015 or die $@ ? "$path: $@\n"
1016 : "extension disabled.\n";
1017
1018 push @exts, $pkg;
1019 $ext_pkg{$base} = $pkg;
1020
1021# no strict 'refs';
1022# @{"$pkg\::ISA"} = ext::;
1023
1024 register $base, $pkg;
1025}
1026
1027sub unload_extension {
1028 my ($pkg) = @_;
1029
1030 warn "removing extension $pkg\n";
1031
1032 # remove hooks
1033 #TODO
1034# for my $idx (0 .. $#PLUGIN_EVENT) {
1035# delete $hook[$idx]{$pkg};
1036# }
1037
1038 # remove commands
1039 for my $name (keys %COMMAND) {
1040 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1041
1042 if (@cb) {
1043 $COMMAND{$name} = \@cb;
1044 } else {
1045 delete $COMMAND{$name};
1046 }
1047 }
1048
1049 # remove extcmds
1050 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1051 delete $EXTCMD{$name};
1052 }
1053
1054 if (my $cb = $pkg->can ("unload")) {
1055 eval {
1056 $cb->($pkg);
1057 1
1058 } or warn "$pkg unloaded, but with errors: $@";
1059 }
1060
1061 Symbol::delete_package $pkg;
1062}
1063
1064sub load_extensions { 1079sub load_extensions {
1080 cf::sync_job {
1081 my %todo;
1082
1065 for my $ext (<$LIBDIR/*.ext>) { 1083 for my $path (<$LIBDIR/*.ext>) {
1066 next unless -r $ext; 1084 next unless -r $path;
1067 eval { 1085
1068 load_extension $ext; 1086 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1087 my $base = $1;
1088 my $pkg = $1;
1089 $pkg =~ s/[^[:word:]]/_/g;
1090 $pkg = "ext::$pkg";
1091
1092 open my $fh, "<:utf8", $path
1093 or die "$path: $!";
1094
1095 my $source = do { local $/; <$fh> };
1096
1097 my %ext = (
1098 path => $path,
1099 base => $base,
1100 pkg => $pkg,
1101 );
1102
1103 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1104 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1105
1106 $ext{source} =
1107 "package $pkg; use strict; use utf8;\n"
1108 . "#line 1 \"$path\"\n{\n"
1109 . $source
1110 . "\n};\n1";
1111
1112 $todo{$base} = \%ext;
1113 }
1114
1115 my %done;
1116 while (%todo) {
1117 my $progress;
1118
1119 while (my ($k, $v) = each %todo) {
1120 for (split /,\s*/, $v->{meta}{depends}) {
1121 goto skip
1122 unless exists $done{$_};
1123 }
1124
1125 warn "... loading '$k' into '$v->{pkg}'\n";
1126
1127 unless (eval $v->{source}) {
1128 my $msg = $@ ? "$v->{path}: $@\n"
1129 : "$v->{base}: extension inactive.\n";
1130
1131 if (exists $v->{meta}{mandatory}) {
1132 warn $msg;
1133 warn "mandatory extension failed to load, exiting.\n";
1134 exit 1;
1135 }
1136
1137 warn $msg;
1138 }
1139
1140 $done{$k} = delete $todo{$k};
1141 push @EXTS, $v->{pkg};
1142 $progress = 1;
1069 1 1143 }
1070 } or warn "$ext not loaded: $@"; 1144
1145 skip:
1146 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1147 unless $progress;
1148 }
1071 } 1149 };
1072} 1150}
1073 1151
1074############################################################################# 1152#############################################################################
1075# load/save/clean perl data associated with a map
1076 1153
1077*cf::mapsupport::on_clean = sub { 1154=back
1078 my ($map) = @_;
1079
1080 my $path = $map->tmpname;
1081 defined $path or return;
1082
1083 unlink "$path.pst";
1084};
1085
1086cf::map->attach (prio => -10000, package => cf::mapsupport::);
1087
1088#############################################################################
1089 1155
1090=head2 CORE EXTENSIONS 1156=head2 CORE EXTENSIONS
1091 1157
1092Functions and methods that extend core crossfire objects. 1158Functions and methods that extend core crossfire objects.
1093 1159
1106Returns the given player object, loading it if necessary (might block). 1172Returns the given player object, loading it if necessary (might block).
1107 1173
1108=cut 1174=cut
1109 1175
1110sub playerdir($) { 1176sub playerdir($) {
1111 cf::localdir 1177 "$PLAYERDIR/"
1112 . "/"
1113 . cf::playerdir
1114 . "/"
1115 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1178 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1116} 1179}
1117 1180
1118sub path($) { 1181sub path($) {
1119 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1182 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1120 1183
1121 (playerdir $login) . "/$login.pl" 1184 (playerdir $login) . "/playerdata"
1122} 1185}
1123 1186
1124sub find_active($) { 1187sub find_active($) {
1125 $cf::PLAYER{$_[0]} 1188 $cf::PLAYER{$_[0]}
1126 and $cf::PLAYER{$_[0]}->active 1189 and $cf::PLAYER{$_[0]}->active
1129 1192
1130sub exists($) { 1193sub exists($) {
1131 my ($login) = @_; 1194 my ($login) = @_;
1132 1195
1133 $cf::PLAYER{$login} 1196 $cf::PLAYER{$login}
1134 or cf::sync_job { !aio_stat $login } 1197 or cf::sync_job { !aio_stat path $login }
1135} 1198}
1136 1199
1137sub find($) { 1200sub find($) {
1138 return $cf::PLAYER{$_[0]} || do { 1201 return $cf::PLAYER{$_[0]} || do {
1139 my $login = $_[0]; 1202 my $login = $_[0];
1140 1203
1141 my $guard = cf::lock_acquire "user_find:$login"; 1204 my $guard = cf::lock_acquire "user_find:$login";
1142 1205
1143 $cf::PLAYER{$_[0]} || do { 1206 $cf::PLAYER{$_[0]} || do {
1207 # rename old playerfiles to new ones
1208 #TODO: remove when no longer required
1209 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1210 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1211 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1212 aio_unlink +(playerdir $login) . "/$login.pl";
1213
1144 my $pl = load_pl path $login 1214 my $pl = load_pl path $login
1145 or return; 1215 or return;
1146 $cf::PLAYER{$login} = $pl 1216 $cf::PLAYER{$login} = $pl
1147 } 1217 }
1148 } 1218 }
1185 1255
1186=cut 1256=cut
1187 1257
1188sub quit_character { 1258sub quit_character {
1189 my ($pl) = @_; 1259 my ($pl) = @_;
1260
1261 my $name = $pl->ob->name;
1190 1262
1191 $pl->{deny_save} = 1; 1263 $pl->{deny_save} = 1;
1192 $pl->password ("*"); # this should lock out the player until we nuked the dir 1264 $pl->password ("*"); # this should lock out the player until we nuked the dir
1193 1265
1194 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1266 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1199 my $path = playerdir $pl; 1271 my $path = playerdir $pl;
1200 my $temp = "$path~$cf::RUNTIME~deleting~"; 1272 my $temp = "$path~$cf::RUNTIME~deleting~";
1201 aio_rename $path, $temp; 1273 aio_rename $path, $temp;
1202 delete $cf::PLAYER{$pl->ob->name}; 1274 delete $cf::PLAYER{$pl->ob->name};
1203 $pl->destroy; 1275 $pl->destroy;
1276
1277 my $prefix = qr<^~\Q$name\E/>;
1278
1279 # nuke player maps
1280 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1281
1204 IO::AIO::aio_rmtree $temp; 1282 IO::AIO::aio_rmtree $temp;
1283}
1284
1285=item $pl->kick
1286
1287Kicks a player out of the game. This destroys the connection.
1288
1289=cut
1290
1291sub kick {
1292 my ($pl, $kicker) = @_;
1293
1294 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1295 $pl->killer ("kicked");
1296 $pl->ns->destroy;
1205} 1297}
1206 1298
1207=item cf::player::list_logins 1299=item cf::player::list_logins
1208 1300
1209Returns am arrayref of all valid playernames in the system, can take a 1301Returns am arrayref of all valid playernames in the system, can take a
1210while and may block, so not sync_job-capable, ever. 1302while and may block, so not sync_job-capable, ever.
1211 1303
1212=cut 1304=cut
1213 1305
1214sub list_logins { 1306sub list_logins {
1215 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1307 my $dirs = aio_readdir $PLAYERDIR
1216 or return []; 1308 or return [];
1217 1309
1218 my @logins; 1310 my @logins;
1219 1311
1220 for my $login (@$dirs) { 1312 for my $login (@$dirs) {
1229 \@logins 1321 \@logins
1230} 1322}
1231 1323
1232=item $player->maps 1324=item $player->maps
1233 1325
1234Returns an arrayref of cf::path's of all maps that are private for this 1326Returns an arrayref of map paths that are private for this
1235player. May block. 1327player. May block.
1236 1328
1237=cut 1329=cut
1238 1330
1239sub maps($) { 1331sub maps($) {
1240 my ($pl) = @_; 1332 my ($pl) = @_;
1333
1334 $pl = ref $pl ? $pl->ob->name : $pl;
1241 1335
1242 my $files = aio_readdir playerdir $pl 1336 my $files = aio_readdir playerdir $pl
1243 or return; 1337 or return;
1244 1338
1245 my @paths; 1339 my @paths;
1247 for (@$files) { 1341 for (@$files) {
1248 utf8::decode $_; 1342 utf8::decode $_;
1249 next if /\.(?:pl|pst)$/; 1343 next if /\.(?:pl|pst)$/;
1250 next unless /^$PATH_SEP/o; 1344 next unless /^$PATH_SEP/o;
1251 1345
1252 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_; 1346 push @paths, cf::map::normalise "~$pl/$_";
1253 } 1347 }
1254 1348
1255 \@paths 1349 \@paths
1256} 1350}
1257 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
1258=item $player->ext_reply ($msgid, $msgtype, %msg) 1385=item $player->ext_reply ($msgid, %msg)
1259 1386
1260Sends an ext reply to the player. 1387Sends an ext reply to the player.
1261 1388
1262=cut 1389=cut
1263 1390
1264sub ext_reply($$$%) { 1391sub ext_reply($$%) {
1265 my ($self, $id, %msg) = @_; 1392 my ($self, $id, %msg) = @_;
1266 1393
1267 $msg{msgid} = $id; 1394 $msg{msgid} = $id;
1268 1395
1269 $self->send ("ext " . cf::to_json \%msg); 1396 $self->send ("ext " . cf::to_json \%msg);
1270} 1397}
1271 1398
1272package cf; 1399=item $player->ext_event ($type, %msg)
1400
1401Sends an ext event to the client.
1402
1403=cut
1404
1405sub ext_event($$%) {
1406 my ($self, $type, %msg) = @_;
1407
1408 $self->ns->ext_event ($type, %msg);
1409}
1410
1411=head3 cf::region
1412
1413=over 4
1414
1415=cut
1416
1417package cf::region;
1418
1419=item cf::region::find_by_path $path
1420
1421Tries to decuce the likely region for a map knowing only its path.
1422
1423=cut
1424
1425sub find_by_path($) {
1426 my ($path) = @_;
1427
1428 my ($match, $specificity);
1429
1430 for my $region (list) {
1431 if ($region->match && $path =~ $region->match) {
1432 ($match, $specificity) = ($region, $region->specificity)
1433 if $region->specificity > $specificity;
1434 }
1435 }
1436
1437 $match
1438}
1273 1439
1274=back 1440=back
1275
1276 1441
1277=head3 cf::map 1442=head3 cf::map
1278 1443
1279=over 4 1444=over 4
1280 1445
1283package cf::map; 1448package cf::map;
1284 1449
1285use Fcntl; 1450use Fcntl;
1286use Coro::AIO; 1451use Coro::AIO;
1287 1452
1453use overload
1454 '""' => \&as_string,
1455 fallback => 1;
1456
1288our $MAX_RESET = 3600; 1457our $MAX_RESET = 3600;
1289our $DEFAULT_RESET = 3000; 1458our $DEFAULT_RESET = 3000;
1290 1459
1291sub generate_random_map { 1460sub generate_random_map {
1292 my ($path, $rmp) = @_; 1461 my ($self, $rmp) = @_;
1293
1294 # mit "rum" bekleckern, nicht 1462 # mit "rum" bekleckern, nicht
1295 cf::map::_create_random_map 1463 $self->_create_random_map (
1296 $path,
1297 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1464 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1298 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1465 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1299 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1466 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1300 $rmp->{exit_on_final_map}, 1467 $rmp->{exit_on_final_map},
1301 $rmp->{xsize}, $rmp->{ysize}, 1468 $rmp->{xsize}, $rmp->{ysize},
1302 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1469 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1303 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1470 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1304 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1471 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1305 $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},
1306 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1473 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1307 (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"
1308} 1603}
1309 1604
1310# and all this just because we cannot iterate over 1605# and all this just because we cannot iterate over
1311# all maps in C++... 1606# all maps in C++...
1312sub change_all_map_light { 1607sub change_all_map_light {
1314 1609
1315 $_->change_map_light ($change) 1610 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP; 1611 for grep $_->outdoor, values %cf::MAP;
1317} 1612}
1318 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
1319sub try_load_header($) { 1630sub load_header_from($) {
1320 my ($path) = @_; 1631 my ($self, $path) = @_;
1321 1632
1322 utf8::encode $path; 1633 utf8::encode $path;
1323 aio_open $path, O_RDONLY, 0 1634 #aio_open $path, O_RDONLY, 0
1635 # or return;
1636
1637 $self->_load_header ($path)
1324 or return; 1638 or return;
1325 1639
1326 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
1327 or return; 1683 or return;
1684 $self->prepare_orig;
1685 }
1328 1686
1329 # for better error messages only, will be overwritten 1687 $self->{deny_reset} = 1
1330 $map->path ($path); 1688 if $self->no_reset;
1331 1689
1332 $map->load_header ($path) 1690 $self->default_region (cf::region::find_by_path $self->{path})
1333 or return; 1691 unless $self->default_region;
1334 1692
1335 $map->{load_path} = $path; 1693 1
1336
1337 $map
1338} 1694}
1339 1695
1340sub find; 1696sub find;
1341sub find { 1697sub find {
1342 my ($path, $origin) = @_; 1698 my ($path, $origin) = @_;
1343 1699
1344 #warn "find<$path,$origin>\n";#d#
1345
1346 $path = new cf::path $path, $origin && $origin->path; 1700 $path = normalise $path, $origin && $origin->path;
1347 my $key = $path->as_string;
1348 1701
1349 cf::lock_wait "map_find:$key"; 1702 cf::lock_wait "map_find:$path";
1350 1703
1351 $cf::MAP{$key} || do { 1704 $cf::MAP{$path} || do {
1352 my $guard = cf::lock_acquire "map_find:$key"; 1705 my $guard = cf::lock_acquire "map_find:$path";
1353 1706 my $map = new_from_path cf::map $path
1354 # do it the slow way
1355 my $map = try_load_header $path->save_path;
1356
1357 Coro::cede;
1358
1359 if ($map) {
1360 $map->last_access ((delete $map->{last_access})
1361 || $cf::RUNTIME); #d#
1362 # safety
1363 $map->{instantiate_time} = $cf::RUNTIME
1364 if $map->{instantiate_time} > $cf::RUNTIME;
1365 } else {
1366 if (my $rmp = $path->random_map_params) {
1367 $map = generate_random_map $key, $rmp;
1368 } else {
1369 $map = try_load_header $path->load_path;
1370 }
1371
1372 $map or return; 1707 or return;
1373 1708
1374 $map->{load_original} = 1;
1375 $map->{instantiate_time} = $cf::RUNTIME;
1376 $map->last_access ($cf::RUNTIME);
1377 $map->instantiate;
1378
1379 # per-player maps become, after loading, normal maps
1380 $map->per_player (0) if $path->{user_rel};
1381 }
1382
1383 $map->path ($key);
1384 $map->{path} = $path;
1385 $map->{last_save} = $cf::RUNTIME; 1709 $map->{last_save} = $cf::RUNTIME;
1386 1710
1387 Coro::cede; 1711 $map->load_header
1712 or return;
1388 1713
1389 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;
1390 $map->reset; 1717 $map->reset;
1391 undef $guard; 1718 undef $guard;
1392 $map = find $path 1719 return find $path;
1393 or return;
1394 } 1720 }
1395 1721
1396 $cf::MAP{$key} = $map 1722 $cf::MAP{$path} = $map
1397 } 1723 }
1398} 1724}
1725
1726sub pre_load { }
1727sub post_load { }
1399 1728
1400sub load { 1729sub load {
1401 my ($self) = @_; 1730 my ($self) = @_;
1402 1731
1732 local $self->{deny_reset} = 1; # loading can take a long time
1733
1403 my $path = $self->{path}; 1734 my $path = $self->{path};
1735
1736 {
1404 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1737 my $guard = cf::lock_acquire "map_load:$path";
1405 1738
1406 return if $self->in_memory != cf::MAP_SWAPPED; 1739 return if $self->in_memory != cf::MAP_SWAPPED;
1407 1740
1408 $self->in_memory (cf::MAP_LOADING); 1741 $self->in_memory (cf::MAP_LOADING);
1409 1742
1410 $self->alloc; 1743 $self->alloc;
1744
1745 $self->pre_load;
1746 Coro::cede;
1747
1411 $self->load_objects ($self->{load_path}, 1) 1748 $self->_load_objects ($self->{load_path}, 1)
1412 or return; 1749 or return;
1413 1750
1414 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1751 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1415 if delete $self->{load_original}; 1752 if delete $self->{load_original};
1416 1753
1417 if (my $uniq = $path->uniq_path) { 1754 if (my $uniq = $self->uniq_path) {
1418 utf8::encode $uniq; 1755 utf8::encode $uniq;
1419 if (aio_open $uniq, O_RDONLY, 0) { 1756 if (aio_open $uniq, O_RDONLY, 0) {
1420 $self->clear_unique_items; 1757 $self->clear_unique_items;
1421 $self->load_objects ($uniq, 0); 1758 $self->_load_objects ($uniq, 0);
1422 } 1759 }
1423 } 1760 }
1424 1761
1425 Coro::cede; 1762 Coro::cede;
1426
1427 # now do the right thing for maps 1763 # now do the right thing for maps
1428 $self->link_multipart_objects; 1764 $self->link_multipart_objects;
1429
1430 if ($self->{path}->is_style_map) {
1431 $self->{deny_save} = 1;
1432 $self->{deny_reset} = 1;
1433 } else {
1434 $self->fix_auto_apply;
1435 $self->decay_objects;
1436 $self->update_buttons;
1437 $self->set_darkness_map;
1438 $self->difficulty ($self->estimate_difficulty) 1765 $self->difficulty ($self->estimate_difficulty)
1439 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;
1440 $self->activate; 1776 $self->activate;
1441 } 1777 }
1442 1778
1443 Coro::cede;
1444
1445 $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
1446} 1795}
1447 1796
1448# find and load all maps in the 3x3 area around a map 1797# find and load all maps in the 3x3 area around a map
1449sub load_diag { 1798sub load_diag {
1450 my ($map) = @_; 1799 my ($map) = @_;
1480 1829
1481 cf::sync_job { $map->load }; 1830 cf::sync_job { $map->load };
1482} 1831}
1483 1832
1484our %MAP_PREFETCH; 1833our %MAP_PREFETCH;
1485our $MAP_PREFETCHER = Coro::async { 1834our $MAP_PREFETCHER = undef;
1486 while () {
1487 while (%MAP_PREFETCH) {
1488 my $key = each %MAP_PREFETCH
1489 or next;
1490 my $path = delete $MAP_PREFETCH{$key};
1491
1492 my $map = find $path
1493 or next;
1494 $map->load;
1495 }
1496 Coro::schedule;
1497 }
1498};
1499 1835
1500sub find_async { 1836sub find_async {
1501 my ($path, $origin) = @_; 1837 my ($path, $origin) = @_;
1502 1838
1503 $path = new cf::path $path, $origin && $origin->path; 1839 $path = normalise $path, $origin && $origin->{path};
1504 my $key = $path->as_string;
1505 1840
1506 if (my $map = $cf::MAP{$key}) { 1841 if (my $map = $cf::MAP{$path}) {
1507 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1842 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1508 } 1843 }
1509 1844
1510 $MAP_PREFETCH{$key} = $path; 1845 undef $MAP_PREFETCH{$path};
1846 $MAP_PREFETCHER ||= cf::async {
1847 while (%MAP_PREFETCH) {
1848 for my $path (keys %MAP_PREFETCH) {
1849 my $map = find $path
1850 or next;
1851 $map->load;
1852
1853 delete $MAP_PREFETCH{$path};
1854 }
1855 }
1856 undef $MAP_PREFETCHER;
1857 };
1511 $MAP_PREFETCHER->ready; 1858 $MAP_PREFETCHER->prio (6);
1512 1859
1513 () 1860 ()
1514} 1861}
1515 1862
1516sub save { 1863sub save {
1520 1867
1521 $self->{last_save} = $cf::RUNTIME; 1868 $self->{last_save} = $cf::RUNTIME;
1522 1869
1523 return unless $self->dirty; 1870 return unless $self->dirty;
1524 1871
1525 my $save = $self->{path}->save_path; utf8::encode $save; 1872 my $save = $self->save_path; utf8::encode $save;
1526 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1873 my $uniq = $self->uniq_path; utf8::encode $uniq;
1527 1874
1528 $self->{load_path} = $save; 1875 $self->{load_path} = $save;
1529 1876
1530 return if $self->{deny_save}; 1877 return if $self->{deny_save};
1531 1878
1534 cf::async { 1881 cf::async {
1535 $_->contr->save for $self->players; 1882 $_->contr->save for $self->players;
1536 }; 1883 };
1537 1884
1538 if ($uniq) { 1885 if ($uniq) {
1539 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1886 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1540 $self->save_objects ($uniq, cf::IO_UNIQUES); 1887 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1541 } else { 1888 } else {
1542 $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);
1543 } 1890 }
1544} 1891}
1545 1892
1546sub swap_out { 1893sub swap_out {
1547 my ($self) = @_; 1894 my ($self) = @_;
1561 1908
1562sub reset_at { 1909sub reset_at {
1563 my ($self) = @_; 1910 my ($self) = @_;
1564 1911
1565 # TODO: safety, remove and allow resettable per-player maps 1912 # TODO: safety, remove and allow resettable per-player maps
1566 return 1e99 if $self->{path}{user_rel};
1567 return 1e99 if $self->{deny_reset}; 1913 return 1e99 if $self->{deny_reset};
1568 1914
1569 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1915 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1570 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;
1571 1917
1576 my ($self) = @_; 1922 my ($self) = @_;
1577 1923
1578 $self->reset_at <= $cf::RUNTIME 1924 $self->reset_at <= $cf::RUNTIME
1579} 1925}
1580 1926
1581sub unlink_save {
1582 my ($self) = @_;
1583
1584 utf8::encode (my $save = $self->{path}->save_path);
1585 aioreq_pri 3; IO::AIO::aio_unlink $save;
1586 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1587}
1588
1589sub rename {
1590 my ($self, $new_path) = @_;
1591
1592 $self->unlink_save;
1593
1594 delete $cf::MAP{$self->path};
1595 $self->{path} = new cf::path $new_path;
1596 $self->path ($self->{path}->as_string);
1597 $cf::MAP{$self->path} = $self;
1598
1599 $self->save;
1600}
1601
1602sub reset { 1927sub reset {
1603 my ($self) = @_; 1928 my ($self) = @_;
1604 1929
1605 my $lock = cf::lock_acquire "map_data:" . $self->path; 1930 my $lock = cf::lock_acquire "map_data:$self->{path}";
1606 1931
1607 return if $self->players; 1932 return if $self->players;
1608 return if $self->{path}{user_rel};#d#
1609 1933
1610 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 }
1611 1945
1612 delete $cf::MAP{$self->path}; 1946 delete $cf::MAP{$self->path};
1947
1948 $self->clear;
1613 1949
1614 $_->clear_links_to ($self) for values %cf::MAP; 1950 $_->clear_links_to ($self) for values %cf::MAP;
1615 1951
1616 $self->unlink_save; 1952 $self->unlink_save;
1617 $self->destroy; 1953 $self->destroy;
1620my $nuke_counter = "aaaa"; 1956my $nuke_counter = "aaaa";
1621 1957
1622sub nuke { 1958sub nuke {
1623 my ($self) = @_; 1959 my ($self) = @_;
1624 1960
1961 delete $cf::MAP{$self->path};
1962
1963 $self->unlink_save;
1964
1965 bless $self, "cf::map";
1966 delete $self->{deny_reset};
1625 $self->{deny_save} = 1; 1967 $self->{deny_save} = 1;
1626 $self->reset_timeout (1); 1968 $self->reset_timeout (1);
1627 $self->rename ("{nuke}/" . ($nuke_counter++)); 1969 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1970
1971 $cf::MAP{$self->path} = $self;
1972
1628 $self->reset; # polite request, might not happen 1973 $self->reset; # polite request, might not happen
1629} 1974}
1630 1975
1631sub customise_for { 1976=item $maps = cf::map::tmp_maps
1632 my ($map, $ob) = @_;
1633 1977
1634 if ($map->per_player) { 1978Returns an arrayref with all map paths of currently instantiated and saved
1635 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 1979maps. May block.
1980
1981=cut
1982
1983sub tmp_maps() {
1636 } 1984 [
1985 map {
1986 utf8::decode $_;
1987 /\.map$/
1988 ? normalise $_
1989 : ()
1990 } @{ aio_readdir $TMPDIR or [] }
1991 ]
1992}
1637 1993
1638 $map 1994=item $maps = cf::map::random_maps
1995
1996Returns an arrayref with all map paths of currently instantiated and saved
1997random maps. May block.
1998
1999=cut
2000
2001sub random_maps() {
2002 [
2003 map {
2004 utf8::decode $_;
2005 /\.map$/
2006 ? normalise "?random/$_"
2007 : ()
2008 } @{ aio_readdir $RANDOMDIR or [] }
2009 ]
1639} 2010}
1640 2011
1641=item cf::map::unique_maps 2012=item cf::map::unique_maps
1642 2013
1643Returns an arrayref of cf::path's of all shared maps that have 2014Returns an arrayref of paths of all shared maps that have
1644instantiated unique items. May block. 2015instantiated unique items. May block.
1645 2016
1646=cut 2017=cut
1647 2018
1648sub unique_maps() { 2019sub unique_maps() {
1649 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2020 [
1650 or return; 2021 map {
1651
1652 my @paths;
1653
1654 for (@$files) {
1655 utf8::decode $_; 2022 utf8::decode $_;
1656 next if /\.pst$/; 2023 /\.map$/
1657 next unless /^$PATH_SEP/o; 2024 ? normalise $_
1658 2025 : ()
1659 push @paths, new cf::path $_; 2026 } @{ aio_readdir $UNIQUEDIR or [] }
1660 } 2027 ]
1661
1662 \@paths
1663} 2028}
1664 2029
1665package cf; 2030package cf;
1666 2031
1667=back 2032=back
1713 2078
1714 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2079 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1715 2080
1716 if ($self->{record_replies}) { 2081 if ($self->{record_replies}) {
1717 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2082 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2083
1718 } 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 {
1719 $msg = $npc->name . " says: $msg" if $npc; 2097 $msg = $npc->name . " says: $msg" if $npc;
1720 $self->message ($msg, $flags); 2098 $self->message ($msg, $flags);
2099 }
1721 } 2100 }
1722} 2101}
1723 2102
1724=item $player_object->may ("access") 2103=item $player_object->may ("access")
1725 2104
1739 2118
1740=item $player_object->enter_link 2119=item $player_object->enter_link
1741 2120
1742Freezes 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}>).
1743 2122
1744The 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
1745I<MUST> call C<leave_link> as soon as possible, though. 2124I<MUST> call C<leave_link> as soon as possible, though.
1746 2125
2126Will never block.
2127
1747=item $player_object->leave_link ($map, $x, $y) 2128=item $player_object->leave_link ($map, $x, $y)
1748 2129
1749Moves 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
1750map 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
1751location 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
1752to the emergency map position. 2133fails, to the emergency map position.
1753 2134
1754Might block. 2135Might block.
1755 2136
1756=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}
1757 2148
1758sub cf::object::player::enter_link { 2149sub cf::object::player::enter_link {
1759 my ($self) = @_; 2150 my ($self) = @_;
1760 2151
1761 $self->deactivate_recursive; 2152 $self->deactivate_recursive;
1762 2153
1763 return if $self->map == $LINK_MAP; 2154 return if UNIVERSAL::isa $self->map, "ext::map_link";
1764 2155
1765 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2156 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1766 if $self->map; 2157 if $self->map && $self->map->{path} ne "{link}";
1767 2158
1768 $self->enter_map ($LINK_MAP, 20, 20); 2159 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1769} 2160}
1770 2161
1771sub cf::object::player::leave_link { 2162sub cf::object::player::leave_link {
1772 my ($self, $map, $x, $y) = @_; 2163 my ($self, $map, $x, $y) = @_;
2164
2165 return unless $self->contr->active;
1773 2166
1774 my $link_pos = delete $self->{_link_pos}; 2167 my $link_pos = delete $self->{_link_pos};
1775 2168
1776 unless ($map) { 2169 unless ($map) {
1777 # restore original map position 2170 # restore original map position
1795 $map->load; 2188 $map->load;
1796 $map->load_diag; 2189 $map->load_diag;
1797 2190
1798 return unless $self->contr->active; 2191 return unless $self->contr->active;
1799 $self->activate_recursive; 2192 $self->activate_recursive;
2193
2194 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1800 $self->enter_map ($map, $x, $y); 2195 $self->enter_map ($map, $x, $y);
1801} 2196}
1802 2197
1803cf::player->attach (
1804 on_logout => sub {
1805 my ($pl) = @_;
1806
1807 # abort map switching before logout
1808 if ($pl->ob->{_link_pos}) {
1809 cf::sync_job {
1810 $pl->ob->leave_link
1811 };
1812 }
1813 },
1814 on_login => sub {
1815 my ($pl) = @_;
1816
1817 # try to abort aborted map switching on player login :)
1818 # should happen only on crashes
1819 if ($pl->ob->{_link_pos}) {
1820 $pl->ob->enter_link;
1821 (async {
1822 # we need this sleep as the login has a concurrent enter_exit running
1823 # and this sleep increases chances of the player not ending up in scorn
1824 $pl->ob->reply (undef,
1825 "There was an internal problem at your last logout, "
1826 . "the server will try to bring you to your intended destination in a second.",
1827 cf::NDI_RED);
1828 Coro::Timer::sleep 1;
1829 $pl->ob->leave_link;
1830 })->prio (2);
1831 }
1832 },
1833);
1834
1835=item $player_object->goto ($path, $x, $y) 2198=item $player_object->goto ($path, $x, $y[, $check->($map)])
1836 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
1837=cut 2205=cut
2206
2207our $GOTOGEN;
1838 2208
1839sub cf::object::player::goto { 2209sub cf::object::player::goto {
1840 my ($self, $path, $x, $y) = @_; 2210 my ($self, $path, $x, $y, $check) = @_;
1841 2211
1842 $path = new cf::path $path; 2212 # do generation counting so two concurrent goto's will be executed in-order
2213 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1843 2214
1844 $self->enter_link; 2215 $self->enter_link;
1845 2216
1846 (async { 2217 (async {
2218 my $map = eval {
1847 my $map = cf::map::find $path->as_string; 2219 my $map = cf::map::find $path;
2220
2221 if ($map) {
1848 $map = $map->customise_for ($self) if $map; 2222 $map = $map->customise_for ($self);
1849 2223 $map = $check->($map) if $check && $map;
1850# warn "entering ", $map->path, " at ($x, $y)\n" 2224 } else {
1851# if $map;
1852
1853 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2225 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2226 }
1854 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};
1855 $self->leave_link ($map, $x, $y); 2238 $self->leave_link ($map, $x, $y);
2239 }
1856 })->prio (1); 2240 })->prio (1);
1857} 2241}
1858 2242
1859=item $player_object->enter_exit ($exit_object) 2243=item $player_object->enter_exit ($exit_object)
1860 2244
1862 2246
1863sub parse_random_map_params { 2247sub parse_random_map_params {
1864 my ($spec) = @_; 2248 my ($spec) = @_;
1865 2249
1866 my $rmp = { # defaults 2250 my $rmp = { # defaults
1867 xsize => 10, 2251 xsize => (cf::rndm 15, 40),
1868 ysize => 10, 2252 ysize => (cf::rndm 15, 40),
2253 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2254 #layout => string,
1869 }; 2255 };
1870 2256
1871 for (split /\n/, $spec) { 2257 for (split /\n/, $spec) {
1872 my ($k, $v) = split /\s+/, $_, 2; 2258 my ($k, $v) = split /\s+/, $_, 2;
1873 2259
1877 $rmp 2263 $rmp
1878} 2264}
1879 2265
1880sub prepare_random_map { 2266sub prepare_random_map {
1881 my ($exit) = @_; 2267 my ($exit) = @_;
2268
2269 my $guard = cf::lock_acquire "exit_prepare:$exit";
1882 2270
1883 # all this does is basically replace the /! path by 2271 # all this does is basically replace the /! path by
1884 # a new random map path (?random/...) with a seed 2272 # a new random map path (?random/...) with a seed
1885 # that depends on the exit object 2273 # that depends on the exit object
1886 2274
1887 my $rmp = parse_random_map_params $exit->msg; 2275 my $rmp = parse_random_map_params $exit->msg;
1888 2276
1889 if ($exit->map) { 2277 if ($exit->map) {
1890 $rmp->{region} = $exit->map->region_name; 2278 $rmp->{region} = $exit->region->name;
1891 $rmp->{origin_map} = $exit->map->path; 2279 $rmp->{origin_map} = $exit->map->path;
1892 $rmp->{origin_x} = $exit->x; 2280 $rmp->{origin_x} = $exit->x;
1893 $rmp->{origin_y} = $exit->y; 2281 $rmp->{origin_y} = $exit->y;
1894 } 2282 }
1895 2283
1896 $rmp->{random_seed} ||= $exit->random_seed; 2284 $rmp->{random_seed} ||= $exit->random_seed;
1897 2285
1898 my $data = cf::to_json $rmp; 2286 my $data = cf::to_json $rmp;
1899 my $md5 = Digest::MD5::md5_hex $data; 2287 my $md5 = Digest::MD5::md5_hex $data;
2288 my $meta = "$RANDOMDIR/$md5.meta";
1900 2289
1901 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) {
1902 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;
1903 2294
1904 $exit->slaying ("?random/$md5"); 2295 $exit->slaying ("?random/$md5");
1905 $exit->msg (undef); 2296 $exit->msg (undef);
1906 } 2297 }
1907} 2298}
1908 2299
1909sub cf::object::player::enter_exit { 2300sub cf::object::player::enter_exit {
1910 my ($self, $exit) = @_; 2301 my ($self, $exit) = @_;
1911 2302
1912 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;
1913 2315
1914 $self->enter_link; 2316 $self->enter_link;
1915 2317
1916 (async { 2318 (async {
1917 $self->deactivate_recursive; # just to be sure 2319 $self->deactivate_recursive; # just to be sure
1918 unless (eval { 2320 unless (eval {
1919 prepare_random_map $exit 2321 $self->goto ($slaying, $hp, $sp);
1920 if $exit->slaying eq "/!";
1921
1922 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1923 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1924 2322
1925 1; 2323 1;
1926 }) { 2324 }) {
1927 $self->message ("Something went wrong deep within the crossfire server. " 2325 $self->message ("Something went wrong deep within the crossfire server. "
1928 . "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. "
1929 . "Please report this to the dungeon master!", 2327 . "Please report this to the dungeon master!",
1930 cf::NDI_UNIQUE | cf::NDI_RED); 2328 cf::NDI_UNIQUE | cf::NDI_RED);
1931 2329
1932 warn "ERROR in enter_exit: $@"; 2330 warn "ERROR in enter_exit: $@";
1933 $self->leave_link; 2331 $self->leave_link;
1934 } 2332 }
1935 })->prio (1); 2333 })->prio (1);
1948 2346
1949sub cf::client::send_drawinfo { 2347sub cf::client::send_drawinfo {
1950 my ($self, $text, $flags) = @_; 2348 my ($self, $text, $flags) = @_;
1951 2349
1952 utf8::encode $text; 2350 utf8::encode $text;
1953 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2351 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1954} 2352}
1955 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}
1956 2404
1957=item $success = $client->query ($flags, "text", \&cb) 2405=item $success = $client->query ($flags, "text", \&cb)
1958 2406
1959Queues a query to the client, calling the given callback with 2407Queues a query to the client, calling the given callback with
1960the 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>,
1989 # get handled first 2437 # get handled first
1990 my $queue = delete $ns->{query_queue} 2438 my $queue = delete $ns->{query_queue}
1991 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
1992 2440
1993 (shift @$queue)->[1]->($msg); 2441 (shift @$queue)->[1]->($msg);
2442 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1994 2443
1995 push @{ $ns->{query_queue} }, @$queue; 2444 push @{ $ns->{query_queue} }, @$queue;
1996 2445
1997 if (@{ $ns->{query_queue} } == @$queue) { 2446 if (@{ $ns->{query_queue} } == @$queue) {
1998 if (@$queue) { 2447 if (@$queue) {
2056 2505
2057# here we export the classes and methods available to script code 2506# here we export the classes and methods available to script code
2058 2507
2059=pod 2508=pod
2060 2509
2061The following fucntions and emthods are available within a safe environment: 2510The following functions and methods are available within a safe environment:
2062 2511
2063 cf::object contr pay_amount pay_player map 2512 cf::object contr pay_amount pay_player map
2064 cf::object::player player 2513 cf::object::player player
2065 cf::player peaceful 2514 cf::player peaceful
2066 cf::map trigger 2515 cf::map trigger
2147=back 2596=back
2148 2597
2149=cut 2598=cut
2150 2599
2151############################################################################# 2600#############################################################################
2601# the server's init and main functions
2152 2602
2153=head2 EXTENSION DATABASE SUPPORT 2603sub load_facedata($) {
2604 my ($path) = @_;
2154 2605
2155Crossfire maintains a very simple database for extension use. It can 2606 warn "loading facedata from $path\n";
2156currently store anything that can be serialised using Storable, which
2157excludes objects.
2158 2607
2159The parameter C<$family> should best start with the name of the extension 2608 my $facedata;
2160using it, it should be unique. 2609 0 < aio_load $path, $facedata
2610 or die "$path: $!";
2161 2611
2162=over 4 2612 $facedata = Coro::Storable::thaw $facedata;
2163 2613
2164=item $hashref = cf::db_get $family 2614 $facedata->{version} == 2
2615 or cf::cleanup "$path: version mismatch, cannot proceed.";
2165 2616
2166Return a hashref for use by the extension C<$family>, which can be
2167modified. After modifications, you have to call C<cf::db_dirty> or
2168C<cf::db_sync>.
2169
2170=item $value = cf::db_get $family => $key
2171
2172Returns a single value from the database
2173
2174=item cf::db_put $family => $hashref
2175
2176Stores the given family hashref into the database. Updates are delayed, if
2177you want the data to be synced to disk immediately, use C<cf::db_sync>.
2178
2179=item cf::db_put $family => $key => $value
2180
2181Stores the given C<$value> in the family hash. Updates are delayed, if you
2182want the data to be synced to disk immediately, use C<cf::db_sync>.
2183
2184=item cf::db_dirty
2185
2186Marks the database as dirty, to be updated at a later time.
2187
2188=item cf::db_sync
2189
2190Immediately write the database to disk I<if it is dirty>.
2191
2192=cut
2193
2194our $DB;
2195
2196{
2197 my $path = cf::localdir . "/database.pst";
2198
2199 sub db_load() {
2200 $DB = stat $path ? Storable::retrieve $path : { };
2201 } 2617 {
2618 my $faces = $facedata->{faceinfo};
2202 2619
2203 my $pid; 2620 while (my ($face, $info) = each %$faces) {
2204 2621 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2205 sub db_save() { 2622 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2206 waitpid $pid, 0 if $pid; 2623 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2207 if (0 == ($pid = fork)) { 2624 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2208 $DB->{_meta}{version} = 1; 2625 Coro::cede;
2209 Storable::nstore $DB, "$path~";
2210 rename "$path~", $path;
2211 cf::_exit 0 if defined $pid;
2212 }
2213 }
2214
2215 my $dirty;
2216
2217 sub db_sync() {
2218 db_save if $dirty;
2219 undef $dirty;
2220 }
2221
2222 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2223 db_sync;
2224 });
2225
2226 sub db_dirty() {
2227 $dirty = 1;
2228 $idle->start;
2229 }
2230
2231 sub db_get($;$) {
2232 @_ >= 2
2233 ? $DB->{$_[0]}{$_[1]}
2234 : ($DB->{$_[0]} ||= { })
2235 }
2236
2237 sub db_put($$;$) {
2238 if (@_ >= 3) {
2239 $DB->{$_[0]}{$_[1]} = $_[2];
2240 } else {
2241 $DB->{$_[0]} = $_[1];
2242 }
2243 db_dirty;
2244 }
2245
2246 cf::global->attach (
2247 prio => 10000,
2248 on_cleanup => sub {
2249 db_sync;
2250 }, 2626 }
2251 );
2252}
2253 2627
2254############################################################################# 2628 while (my ($face, $info) = each %$faces) {
2255# 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}
2256 2690
2257sub cfg_load { 2691sub cfg_load {
2258 open my $fh, "<:utf8", cf::confdir . "/config" 2692 open my $fh, "<:utf8", "$CONFDIR/config"
2259 or return; 2693 or return;
2260 2694
2261 local $/; 2695 local $/;
2262 *CFG = YAML::Syck::Load <$fh>; 2696 *CFG = YAML::Syck::Load <$fh>;
2263 2697
2277 2711
2278sub main { 2712sub main {
2279 # we must not ever block the main coroutine 2713 # we must not ever block the main coroutine
2280 local $Coro::idle = sub { 2714 local $Coro::idle = sub {
2281 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 {
2282 async { Event::one_event }; 2717 Event::one_event;
2718 })->prio (Coro::PRIO_MAX);
2283 }; 2719 };
2284 2720
2285 cfg_load; 2721 cfg_load;
2286 db_load; 2722 db_init;
2287 load_extensions; 2723 load_extensions;
2724
2725 $TICK_WATCHER->start;
2288 Event::loop; 2726 Event::loop;
2289} 2727}
2290 2728
2291############################################################################# 2729#############################################################################
2292# initialisation and cleanup 2730# initialisation and cleanup
2293 2731
2294# install some emergency cleanup handlers 2732# install some emergency cleanup handlers
2295BEGIN { 2733BEGIN {
2296 for my $signal (qw(INT HUP TERM)) { 2734 for my $signal (qw(INT HUP TERM)) {
2297 Event->signal ( 2735 Event->signal (
2736 reentrant => 0,
2298 data => WF_AUTOCANCEL, 2737 data => WF_AUTOCANCEL,
2299 signal => $signal, 2738 signal => $signal,
2739 prio => 0,
2300 cb => sub { 2740 cb => sub {
2301 cf::cleanup "SIG$signal"; 2741 cf::cleanup "SIG$signal";
2302 }, 2742 },
2303 ); 2743 );
2304 } 2744 }
2305} 2745}
2306 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
2307sub emergency_save() { 2785sub emergency_save() {
2308 my $freeze_guard = cf::freeze_mainloop; 2786 my $freeze_guard = cf::freeze_mainloop;
2309 2787
2310 warn "enter emergency perl save\n"; 2788 warn "enter emergency perl save\n";
2311 2789
2312 cf::sync_job { 2790 cf::sync_job {
2313 # use a peculiar iteration method to avoid tripping on perl 2791 # use a peculiar iteration method to avoid tripping on perl
2314 # refcount bugs in for. also avoids problems with players 2792 # refcount bugs in for. also avoids problems with players
2315 # and maps saved/Destroyed asynchronously. 2793 # and maps saved/destroyed asynchronously.
2316 warn "begin emergency player save\n"; 2794 warn "begin emergency player save\n";
2317 for my $login (keys %cf::PLAYER) { 2795 for my $login (keys %cf::PLAYER) {
2318 my $pl = $cf::PLAYER{$login} or next; 2796 my $pl = $cf::PLAYER{$login} or next;
2319 $pl->valid or next; 2797 $pl->valid or next;
2320 $pl->save; 2798 $pl->save;
2326 my $map = $cf::MAP{$path} or next; 2804 my $map = $cf::MAP{$path} or next;
2327 $map->valid or next; 2805 $map->valid or next;
2328 $map->save; 2806 $map->save;
2329 } 2807 }
2330 warn "end emergency map save\n"; 2808 warn "end emergency map save\n";
2809
2810 warn "begin emergency database checkpoint\n";
2811 BDB::db_env_txn_checkpoint $DB_ENV;
2812 warn "end emergency database checkpoint\n";
2331 }; 2813 };
2332 2814
2333 warn "leave emergency perl save\n"; 2815 warn "leave emergency perl save\n";
2334} 2816}
2335 2817
2818sub post_cleanup {
2819 my ($make_core) = @_;
2820
2821 warn Carp::longmess "post_cleanup backtrace"
2822 if $make_core;
2823}
2824
2336sub reload() { 2825sub do_reload_perl() {
2337 # can/must only be called in main 2826 # can/must only be called in main
2338 if ($Coro::current != $Coro::main) { 2827 if ($Coro::current != $Coro::main) {
2339 warn "can only reload from main coroutine\n"; 2828 warn "can only reload from main coroutine";
2340 return; 2829 return;
2341 } 2830 }
2342 2831
2343 warn "reloading..."; 2832 warn "reloading...";
2344 2833
2345 my $guard = freeze_mainloop; 2834 warn "entering sync_job";
2835
2836 cf::sync_job {
2837 cf::write_runtime; # external watchdog should not bark
2346 cf::emergency_save; 2838 cf::emergency_save;
2839 cf::write_runtime; # external watchdog should not bark
2347 2840
2348 eval { 2841 warn "syncing database to disk";
2842 BDB::db_env_txn_checkpoint $DB_ENV;
2843
2349 # 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
2350 2845
2351 # cancel all watchers 2846 warn "cancelling all WF_AUTOCANCEL watchers";
2352 for (Event::all_watchers) { 2847 for (Event::all_watchers) {
2353 $_->cancel if $_->data & WF_AUTOCANCEL; 2848 $_->cancel if $_->data & WF_AUTOCANCEL;
2354 } 2849 }
2355 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
2356 # cancel all extension coros 2862 warn "cancelling all extension coros";
2357 $_->cancel for values %EXT_CORO; 2863 $_->cancel for values %EXT_CORO;
2358 %EXT_CORO = (); 2864 %EXT_CORO = ();
2359 2865
2360 # unload all extensions 2866 warn "removing commands";
2361 for (@exts) { 2867 %COMMAND = ();
2868
2869 warn "removing ext commands";
2870 %EXTCMD = ();
2871
2872 warn "unloading/nuking all extensions";
2873 for my $pkg (@EXTS) {
2362 warn "unloading <$_>"; 2874 warn "... unloading $pkg";
2363 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: $@";
2364 } 2881 }
2365 2882
2883 warn "... nuking $pkg";
2884 Symbol::delete_package $pkg;
2885 }
2886
2366 # unload all modules loaded from $LIBDIR 2887 warn "unloading all perl modules loaded from $LIBDIR";
2367 while (my ($k, $v) = each %INC) { 2888 while (my ($k, $v) = each %INC) {
2368 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2889 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2369 2890
2370 warn "removing <$k>"; 2891 warn "... unloading $k";
2371 delete $INC{$k}; 2892 delete $INC{$k};
2372 2893
2373 $k =~ s/\.pm$//; 2894 $k =~ s/\.pm$//;
2374 $k =~ s/\//::/g; 2895 $k =~ s/\//::/g;
2375 2896
2378 } 2899 }
2379 2900
2380 Symbol::delete_package $k; 2901 Symbol::delete_package $k;
2381 } 2902 }
2382 2903
2383 # sync database to disk
2384 cf::db_sync;
2385 IO::AIO::flush;
2386
2387 # get rid of safe::, as good as possible 2904 warn "getting rid of safe::, as good as possible";
2388 Symbol::delete_package "safe::$_" 2905 Symbol::delete_package "safe::$_"
2389 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);
2390 2907
2391 # remove register_script_function callbacks
2392 # TODO
2393
2394 # unload cf.pm "a bit" 2908 warn "unloading cf.pm \"a bit\"";
2395 delete $INC{"cf.pm"}; 2909 delete $INC{"cf.pm"};
2910 delete $INC{"cf/pod.pm"};
2396 2911
2397 # don't, removes xs symbols, too, 2912 # don't, removes xs symbols, too,
2398 # and global variables created in xs 2913 # and global variables created in xs
2399 #Symbol::delete_package __PACKAGE__; 2914 #Symbol::delete_package __PACKAGE__;
2400 2915
2401 # reload cf.pm 2916 warn "unload completed, starting to reload now";
2917
2402 warn "reloading cf.pm"; 2918 warn "reloading cf.pm";
2403 require cf; 2919 require cf;
2404 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2920 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2405 2921
2406 # load config and database again 2922 warn "loading config and database again";
2407 cf::cfg_load; 2923 cf::cfg_load;
2408 cf::db_load;
2409 2924
2410 # load extensions
2411 warn "load extensions"; 2925 warn "loading extensions";
2412 cf::load_extensions; 2926 cf::load_extensions;
2413 2927
2414 # reattach attachments to objects 2928 warn "reattaching attachments to objects/players";
2415 warn "reattach"; 2929 _global_reattach; # objects, sockets
2416 _global_reattach; 2930 warn "reattaching attachments to maps";
2417 reattach $_ for values %MAP; 2931 reattach $_ for values %MAP;
2418 }; 2932 warn "reattaching attachments to players";
2933 reattach $_ for values %PLAYER;
2419 2934
2420 if ($@) { 2935 warn "leaving sync_job";
2936
2937 1
2938 } or do {
2421 warn $@; 2939 warn $@;
2422 warn "error while reloading, exiting."; 2940 warn "error while reloading, exiting.";
2423 exit 1; 2941 exit 1;
2424 } 2942 };
2425 2943
2426 warn "reloaded successfully"; 2944 warn "reloaded";
2427}; 2945};
2428 2946
2429############################################################################# 2947our $RELOAD_WATCHER; # used only during reload
2430 2948
2431unless ($LINK_MAP) { 2949sub reload_perl() {
2432 $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.
2433 2952
2434 $LINK_MAP->width (41); 2953 $RELOAD_WATCHER ||= Event->timer (
2435 $LINK_MAP->height (41); 2954 reentrant => 0,
2436 $LINK_MAP->alloc;
2437 $LINK_MAP->path ("{link}");
2438 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2439 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2440
2441 # dirty hack because... archetypes are not yet loaded
2442 Event->timer (
2443 after => 10, 2955 after => 0,
2956 data => WF_AUTOCANCEL,
2444 cb => sub { 2957 cb => sub {
2445 $_[0]->w->cancel; 2958 do_reload_perl;
2446 2959 undef $RELOAD_WATCHER;
2447 # provide some exits "home"
2448 my $exit = cf::object::new "exit";
2449
2450 $exit->slaying ($EMERGENCY_POSITION->[0]);
2451 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2452 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2453
2454 $LINK_MAP->insert ($exit->clone, 19, 19);
2455 $LINK_MAP->insert ($exit->clone, 19, 20);
2456 $LINK_MAP->insert ($exit->clone, 19, 21);
2457 $LINK_MAP->insert ($exit->clone, 20, 19);
2458 $LINK_MAP->insert ($exit->clone, 20, 21);
2459 $LINK_MAP->insert ($exit->clone, 21, 19);
2460 $LINK_MAP->insert ($exit->clone, 21, 20);
2461 $LINK_MAP->insert ($exit->clone, 21, 21);
2462
2463 $exit->destroy;
2464 }); 2960 },
2465 2961 );
2466 $LINK_MAP->{deny_save} = 1;
2467 $LINK_MAP->{deny_reset} = 1;
2468
2469 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2470} 2962}
2471
2472register "<global>", __PACKAGE__;
2473 2963
2474register_command "reload" => sub { 2964register_command "reload" => sub {
2475 my ($who, $arg) = @_; 2965 my ($who, $arg) = @_;
2476 2966
2477 if ($who->flag (FLAG_WIZ)) { 2967 if ($who->flag (FLAG_WIZ)) {
2478 $who->message ("start of reload.");
2479 reload;
2480 $who->message ("end of reload."); 2968 $who->message ("reloading server.");
2969 async { reload_perl };
2481 } 2970 }
2482}; 2971};
2483 2972
2484unshift @INC, $LIBDIR; 2973unshift @INC, $LIBDIR;
2485 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;
2486$TICK_WATCHER = Event->timer ( 3000$TICK_WATCHER = Event->timer (
2487 reentrant => 0, 3001 reentrant => 0,
3002 parked => 1,
2488 prio => 0, 3003 prio => 0,
2489 at => $NEXT_TICK || $TICK, 3004 at => $NEXT_TICK || $TICK,
2490 data => WF_AUTOCANCEL, 3005 data => WF_AUTOCANCEL,
2491 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
2492 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
2493 $RUNTIME += $TICK; 3040 $RUNTIME += $TICK;
2494 $NEXT_TICK += $TICK; 3041 $NEXT_TICK += $TICK;
2495 3042
2496 $WAIT_FOR_TICK->broadcast; 3043 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2497 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3044 $NEXT_RUNTIME_WRITE = $NOW + 10;
3045 Coro::async_pool {
3046 write_runtime
3047 or warn "ERROR: unable to write runtime file: $!";
3048 };
3049 }
3050
3051# my $AFTER = Event::time;
3052# warn $AFTER - $NOW;#d#
3053
3054 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3055 $sig->send;
3056 }
3057 while (my $sig = shift @WAIT_FOR_TICK) {
3058 $sig->send;
3059 }
3060
3061 $NOW = Event::time;
2498 3062
2499 # 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
2500 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3064 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2501 3065
2502 $TICK_WATCHER->at ($NEXT_TICK); 3066 $TICK_WATCHER->at ($NEXT_TICK);
2503 $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
2504 }, 3075 },
2505); 3076);
2506 3077
3078{
2507IO::AIO::max_poll_time $TICK * 0.2; 3079 BDB::max_poll_time $TICK * 0.1;
2508 3080 $BDB_POLL_WATCHER = Event->io (
2509Event->io ( 3081 reentrant => 0,
2510 fd => IO::AIO::poll_fileno, 3082 fd => BDB::poll_fileno,
2511 poll => 'r', 3083 poll => 'r',
2512 prio => 5, 3084 prio => 0,
2513 data => WF_AUTOCANCEL,
2514 cb => \&IO::AIO::poll_cb,
2515);
2516
2517Event->timer (
2518 data => WF_AUTOCANCEL, 3085 data => WF_AUTOCANCEL,
2519 after => 0, 3086 cb => \&BDB::poll_cb,
2520 interval => 10, 3087 );
2521 cb => sub { 3088 BDB::min_parallel 8;
2522 (Coro::unblock_sub { 3089
2523 write_runtime 3090 BDB::set_sync_prepare {
2524 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 $@;
2525 })->(); 3124 };
2526 }, 3125 }
2527); 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;
2528 3183
2529END { cf::emergency_save } 3184END { cf::emergency_save }
2530 3185
25311 31861
2532 3187

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines