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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines