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.40 by root, Fri Aug 25 15:21:57 2006 UTC vs.
Revision 1.506 by root, Wed Feb 3 20:48:22 2010 UTC

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

Diff Legend

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