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.111 by root, Mon Jan 1 12:28:47 2007 UTC vs.
Revision 1.285 by root, Sun Jun 24 04:21:42 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines