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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.16 by root, Mon Jun 12 13:25:27 2006 UTC vs.
Revision 1.444 by root, Mon Sep 8 11:27:25 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines