ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.418
Committed: Fri Apr 11 21:09:53 2008 UTC (16 years, 1 month ago) by root
Branch: MAIN
Changes since 1.417: +3 -0 lines
Log Message:
*** empty log message ***

File Contents

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