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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines