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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines