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.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.308 by root, Mon Jul 16 14:09:40 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines