ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.384
Committed: Fri Oct 12 18:17:16 2007 UTC (16 years, 7 months ago) by root
Branch: MAIN
Changes since 1.383: +1 -1 lines
Log Message:
use a blocking freeze once more. this is why (happened shortly after
leaving nimbus, when both map and palyer where saved):

   #0  0x00002b4cd6bd1635 in raise () from /lib/libc.so.6
   #1  0x00002b4cd6bd3090 in abort () from /lib/libc.so.6
   #2  0x00000000004f9dea in fork_abort (msg=0x64b26f "SIGSEGV received") at utils.C:466
   #3  0x000000000046f6e3 in cleanup (cause=0x64b26f "SIGSEGV received", make_core=191) at main.C:368
   #4  <signal handler called>
   #5  S_hv_fetch_common (hv=0x181db430, keysv=0xf1f0f90, key=0xad2a68 "ac", klen=2, flags=0, action=0, val=0x0, hash=1410644661) at hv.c:644
   #6  0x00000000005634e9 in Perl_hv_fetch_ent (hv=0x0, keysv=0x95d98c0, lval=<value optimized out>, hash=<value optimized out>) at hv.c:378
   #7  0x00002b4cd875e338 in store_hash (cxt=0xc78d60, hv=0x181db430) at Storable.xs:2377
   #8  0x00002b4cd875cfca in store (cxt=0x0, sv=0x181db430) at Storable.xs:3608
   #9  0x00002b4cd875cfca in store (cxt=0x0, sv=0x19d2fad0) at Storable.xs:3608
   #10 0x00002b4cd875e35e in store_hash (cxt=0xc78d60, hv=0x19d394e0) at Storable.xs:2411
   #11 0x00002b4cd875cfca in store (cxt=0x0, sv=0x19d394e0) at Storable.xs:3608
   #12 0x00002b4cd875cfca in store (cxt=0x0, sv=0x19d2ea80) at Storable.xs:3608
   #13 0x00002b4cd875e35e in store_hash (cxt=0xc78d60, hv=0x1ed0f530) at Storable.xs:2411
   #14 0x00002b4cd875b725 in store_blessed (cxt=0x2, sv=0x1ed0f530, type=3, pkg=0xaf0000) at Storable.xs:3372
   #15 0x00002b4cd875cfb1 in store (cxt=0xc78d60, sv=0x1ed0f530) at Storable.xs:3606
   #16 0x00002b4cd875cfca in store (cxt=0x0, sv=0x17c345a0) at Storable.xs:3608
   #17 0x00002b4cd875e912 in store_array (cxt=0xc78d60, av=0x17f8cba0) at Storable.xs:2220
   #18 0x00002b4cd875cfca in store (cxt=0x0, sv=0x17f8cba0) at Storable.xs:3608
   #19 0x00002b4cd875cfca in store (cxt=0x0, sv=0x1f365d40) at Storable.xs:3608
   #20 0x00002b4cd875e35e in store_hash (cxt=0xc78d60, hv=0x1ebf21a0) at Storable.xs:2411
   #21 0x00002b4cd875cfca in store (cxt=0x0, sv=0x1ebf21a0) at Storable.xs:3608
   #22 0x00002b4cd875f400 in do_store (f=0x90b9d8, sv=<value optimized out>, optype=<value optimized out>, network_order=1, res=0x0) at Storable.xs:3797
   #23 0x00002b4cd876417c in XS_Storable_net_pstore (cv=<value optimized out>) at Storable.xs:3858
   #24 0x000000000057a794 in Perl_pp_entersub () at pp_hot.c:2819
   #25 0x000000000056faee in Perl_runops_standard () at run.c:37
   #26 0x000000000056a6c7 in Perl_call_sv (sv=0xf5fa40, flags=134) at perl.c:2838
   #27 0x0000000000499779 in object_freezer::save (this=0x2aaaaed2bdd0, path=<value optimized out>) at freezethaw.C:61
   #28 0x00000000004eec40 in player::save_pl (this=0x935c330, path=0x17e13b40 "/var/cfserver/players/burzum/playerdata") at player.C:147
   #29 0x00000000004a78d1 in XS_cf__player_save_pl (cv=<value optimized out>) at ./cfperl.C:5929
   #30 0x000000000057a794 in Perl_pp_entersub () at pp_hot.c:2819
   #31 0x000000000056faee in Perl_runops_standard () at run.c:37
   #32 0x000000000056bd4d in perl_run (my_perl=<value optimized out>) at perl.c:2484
   #33 0x00002b4cd7d3a8e2 in cctx_run (arg=<value optimized out>) at State.xs:941
   #34 0x00002b4cd7d3c825 in coro_init () at libcoro/coro.c:84
   #35 0x00002b4cd7d3c7f0 in XS_Coro__State_new (cv=<value optimized out>) at State.c:1521
   #36 0x0000000000000000 in ?? ()
   (gdb) up
   #1  0x00002b4cd6bd3090 in abort () from /lib/libc.so.6
   (gdb)
   #2  0x00000000004f9dea in fork_abort (msg=0x64b26f "SIGSEGV received") at utils.C:466
   466           abort ();
   (gdb)
   #3  0x000000000046f6e3 in cleanup (cause=0x64b26f "SIGSEGV received", make_core=191) at main.C:368
   368         fork_abort (cause);
   (gdb) up
   #4  <signal handler called>
   (gdb)
   #5  S_hv_fetch_common (hv=0x181db430, keysv=0xf1f0f90, key=0xad2a68 "ac", klen=2, flags=0, action=0, val=0x0, hash=1410644661) at hv.c:644
   644     hv.c: No such file or directory.
           in hv.c
   Current language:  auto; currently c

File Contents

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