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.43 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.503 by root, Sat Jan 30 23:46:39 2010 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
24
25use 5.10.0;
26use utf8;
27use strict qw(vars subs);
2 28
3use Symbol; 29use Symbol;
4use List::Util; 30use List::Util;
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;
37 }; 256};
38}
39 257
40my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 258$Coro::State::DIEHOOK = sub {
259 return unless $^S eq 0; # "eq", not "=="
41 260
42# generate property mutators 261 warn Carp::longmess $_[0];
43sub prop_gen {
44 my ($prefix, $class) = @_;
45 262
46 no strict 'refs'; 263 if ($Coro::current == $Coro::main) {#d#
264 warn "DIEHOOK called in main context, Coro bug?\n";#d#
265 return;#d#
266 }#d#
47 267
48 for my $prop (keys %PROP_TYPE) { 268 # kill coroutine otherwise
49 $prop =~ /^\Q$prefix\E_(.*$)/ or next; 269 Coro::terminate
50 my $sub = lc $1; 270};
51 271
52 my $type = $PROP_TYPE{$prop}; 272@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
53 my $idx = $PROP_IDX {$prop}; 273@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
54 274@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
55 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { 275@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
56 $_[0]->get_property ($type, $idx) 276@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
57 }; 277@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
58
59 *{"$class\::set_$sub"} = sub {
60 $_[0]->set_property ($type, $idx, $_[1]);
61 } unless $ignore_set{$prop};
62 }
63}
64
65# auto-generate most of the API
66
67prop_gen OBJECT_PROP => "cf::object";
68# CFAPI_OBJECT_ANIMATION?
69prop_gen PLAYER_PROP => "cf::object::player";
70
71prop_gen MAP_PROP => "cf::map";
72prop_gen ARCH_PROP => "cf::arch";
73
74# guessed hierarchies
75
76@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 278@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
77@safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78 279
79# we bless all objects into (empty) derived classes to force a method lookup 280# we bless all objects into (empty) derived classes to force a method lookup
80# within the Safe compartment. 281# within the Safe compartment.
81for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { 282for my $pkg (qw(
82 no strict 'refs'; 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)) {
83 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 290 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84} 291}
85 292
86$Event::DIED = sub { 293$EV::DIED = sub {
87 warn "error in event callback: @_"; 294 Carp::cluck "error in event callback: @_";
88}; 295};
89 296
90my %ext_pkg;
91my @exts;
92my @hook;
93my %command;
94my %extcmd;
95
96############################################################################# 297#############################################################################
97# "new" plug-in system
98 298
99=item cf::object::attach ... # NYI 299=head2 UTILITY FUNCTIONS
100 300
101=item cf::attach_global ... 301=over 4
102 302
103=item cf::attach_to_type ... 303=item dumpval $ref
104 304
105=item cf::attach_to_objects ... 305=cut
106 306
107=item cf::attach_to_players ... 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}
108 325
109=item cf::attach_to_maps ... 326=item $ref = cf::decode_json $json
110 327
111 prio => $number, # lower is earlier 328Converts a JSON string into the corresponding perl data structure.
112 on_xxx => \&cb, 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 $!;
645 };
646 cf::cleanup "db_open(db): $@" if $@;
647
648 $db
649}
650
651our $DB;
652
653sub db_init {
654 cf::sync_job {
655 $DB ||= db_table "db";
656 };
657}
658
659sub db_get($$) {
660 my $key = "$_[0]/$_[1]";
661
662 cf::sync_job {
663 BDB::db_get $DB, undef, $key, my $data;
664
665 $! ? ()
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->[$_]: $!";
707 }
708
709 # if processing is expensive, check
710 # checksum first
711 if (1) {
712 $md5 =
713 join "\x00",
714 $processversion,
715 map {
716 cf::cede_to_tick;
717 ($src->[$_], Digest::MD5::md5_hex $data[$_])
718 } 0.. $#$src;
719
720
721 my $dbmd5 = db_get cache => "$id/md5";
722 if ($dbmd5 eq $md5) {
723 db_put cache => "$id/meta", $meta;
724
725 return db_get cache => "$id/data";
726 }
727 }
728
729 my $t1 = Time::HiRes::time;
730 my $data = $process->(\@data);
731 my $t2 = Time::HiRes::time;
732
733 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
734
735 db_put cache => "$id/data", $data;
736 db_put cache => "$id/md5" , $md5;
737 db_put cache => "$id/meta", $meta;
738
739 return $data;
740 }
741
742 db_get cache => "$id/data"
743}
744
745=item cf::datalog type => key => value, ...
746
747Log a datalog packet of the given type with the given key-value pairs.
748
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
759
760#############################################################################
761
762=head2 ATTACHABLE OBJECTS
763
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.
767
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).
771
772=over 4
773
774=item $attachable->attach ($attachment, key => $value...)
775
776=item $attachable->detach ($attachment)
777
778Attach/detach a pre-registered attachment to a specific object and give it
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}
285 1305
286sub register { 1306sub register_exticmd {
287 my ($base, $pkg) = @_; 1307 my ($name, $cb) = @_;
288 1308
289 for my $idx (0 .. $#PLUGIN_EVENT) { 1309 $EXTICMD{$name} = $cb;
290 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
291 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
292 $hook[$idx]{$base} = $ref;
293 }
294 }
295} 1310}
296 1311
297sub load_extension { 1312use File::Glob ();
298 my ($path) = @_;
299 1313
300 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1314cf::player->attach (
301 my $base = $1; 1315 on_command => sub {
302 my $pkg = $1; 1316 my ($pl, $name, $params) = @_;
303 $pkg =~ s/[^[:word:]]/_/g;
304 $pkg = "ext::$pkg";
305 1317
306 warn "loading '$path' into '$pkg'\n"; 1318 my $cb = $COMMAND{$name}
1319 or return;
307 1320
308 open my $fh, "<:utf8", $path 1321 for my $cmd (@$cb) {
309 or die "$path: $!"; 1322 $cmd->[1]->($pl->ob, $params);
310
311 my $source =
312 "package $pkg; use strict; use utf8;\n"
313 . "#line 1 \"$path\"\n{\n"
314 . (do { local $/; <$fh> })
315 . "\n};\n1";
316
317 eval $source
318 or die "$path: $@";
319
320 push @exts, $pkg;
321 $ext_pkg{$base} = $pkg;
322
323# no strict 'refs';
324# @{"$pkg\::ISA"} = ext::;
325
326 register $base, $pkg;
327}
328
329sub unload_extension {
330 my ($pkg) = @_;
331
332 warn "removing extension $pkg\n";
333
334 # remove hooks
335 for my $idx (0 .. $#PLUGIN_EVENT) {
336 delete $hook[$idx]{$pkg};
337 }
338
339 # remove commands
340 for my $name (keys %command) {
341 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
342
343 if (@cb) {
344 $command{$name} = \@cb;
345 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
346 } else {
347 delete $command{$name};
348 delete $COMMAND{"$name\000"};
349 }
350 }
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 ("unload")) {
358 eval {
359 $cb->($pkg);
360 1
361 } or warn "$pkg unloaded, but with errors: $@";
362 }
363
364 Symbol::delete_package $pkg;
365}
366
367sub load_extensions {
368 my $LIBDIR = maps_directory "perl";
369
370 for my $ext (<$LIBDIR/*.ext>) {
371 next unless -r $ext;
372 eval {
373 load_extension $ext;
374 1
375 } or warn "$ext not loaded: $@";
376 }
377}
378
379sub _perl_reload(&) {
380 my ($msg) = @_;
381
382 $msg->("reloading...");
383
384 eval {
385 # 1. cancel all watchers
386 $_->cancel for Event::all_watchers;
387
388 # 2. unload all extensions
389 for (@exts) {
390 $msg->("unloading <$_>");
391 unload_extension $_;
392 }
393
394 # 3. unload all modules loaded from $LIBDIR
395 while (my ($k, $v) = each %INC) {
396 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
397
398 $msg->("removing <$k>");
399 delete $INC{$k};
400
401 $k =~ s/\.pm$//;
402 $k =~ s/\//::/g;
403
404 if (my $cb = $k->can ("unload_module")) {
405 $cb->();
406 }
407
408 Symbol::delete_package $k;
409 }
410
411 # 4. get rid of safe::, as good as possible
412 Symbol::delete_package "safe::$_"
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
418 # 6. unload cf.pm "a bit"
419 delete $INC{"cf.pm"};
420
421 # don't, removes xs symbols, too,
422 # and global variables created in xs
423 #Symbol::delete_package __PACKAGE__;
424
425 # 7. reload cf.pm
426 $msg->("reloading cf.pm");
427 require cf;
428 };
429 $msg->($@) if $@;
430
431 $msg->("reloaded");
432};
433
434sub perl_reload() {
435 _perl_reload {
436 warn $_[0];
437 print "$_[0]\n";
438 };
439}
440
441register_command "perl-reload", 0, sub {
442 my ($who, $arg) = @_;
443
444 if ($who->flag (FLAG_WIZ)) {
445 _perl_reload {
446 warn $_[0];
447 $who->message ($_[0]);
448 }; 1323 }
1324
1325 cf::override;
449 } 1326 },
450};
451
452#############################################################################
453# utility functions
454
455use JSON::Syck (); # TODO# replace by JSON::PC once working
456
457sub from_json($) {
458 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
459 JSON::Syck::Load $_[0]
460}
461
462sub to_json($) {
463 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
464 JSON::Syck::Dump $_[0]
465}
466
467#############################################################################
468# extcmd framework, basically convert ext <msg>
469# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
470
471attach_global
472 on_extcmd => sub { 1327 on_extcmd => sub {
473 my ($pl, $buf) = @_; 1328 my ($pl, $buf) = @_;
474 1329
475 my $msg = eval { from_json $buf }; 1330 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
476 1331
477 if (ref $msg) { 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
478 if (my $cb = $extcmd{$msg->{msgtype}}) { 1340 if (my $cb = $EXTCMD{$type}) {
479 if (my %reply = $cb->[0]->($pl, $msg)) { 1341 @reply = $cb->($pl, @payload);
480 $pl->ext_reply ($msg->{msgid}, %reply); 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 %done;
1405 while (%todo) {
1406 my $progress;
1407
1408 while (my ($k, $v) = each %todo) {
1409 for (split /,\s*/, $v->{meta}{depends}) {
1410 goto skip
1411 unless exists $done{$_};
1412 }
1413
1414 warn "... loading '$k' into '$v->{pkg}'\n";
1415
1416 unless (eval $v->{source}) {
1417 my $msg = $@ ? "$v->{path}: $@\n"
1418 : "$v->{base}: extension inactive.\n";
1419
1420 if (exists $v->{meta}{mandatory}) {
1421 warn $msg;
1422 cf::cleanup "mandatory extension failed to load, exiting.";
1423 }
1424
1425 warn $msg;
1426 }
1427
1428 $done{$k} = delete $todo{$k};
1429 push @EXTS, $v->{pkg};
1430 $progress = 1;
1431 }
1432
1433 skip:
1434 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1435 unless $progress;
1436 }
1437 };
1438}
1439
1440#############################################################################
1441
1442=back
1443
1444=head2 CORE EXTENSIONS
1445
1446Functions and methods that extend core deliantra objects.
1447
1448=cut
1449
1450package cf::player;
1451
1452use Coro::AIO;
1453
1454=head3 cf::player
1455
1456=over 4
1457
1458=item cf::player::num_playing
1459
1460Returns the official number of playing players, as per the Crossfire metaserver rules.
1461
1462=cut
1463
1464sub num_playing {
1465 scalar grep
1466 $_->ob->map
1467 && !$_->hidden
1468 && !$_->ob->flag (cf::FLAG_WIZ),
1469 cf::player::list
1470}
1471
1472=item cf::player::find $login
1473
1474Returns the given player object, loading it if necessary (might block).
1475
1476=cut
1477
1478sub playerdir($) {
1479 "$PLAYERDIR/"
1480 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1481}
1482
1483sub path($) {
1484 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1485
1486 (playerdir $login) . "/playerdata"
1487}
1488
1489sub find_active($) {
1490 $cf::PLAYER{$_[0]}
1491 and $cf::PLAYER{$_[0]}->active
1492 and $cf::PLAYER{$_[0]}
1493}
1494
1495sub exists($) {
1496 my ($login) = @_;
1497
1498 $cf::PLAYER{$login}
1499 or !aio_stat path $login
1500}
1501
1502sub find($) {
1503 return $cf::PLAYER{$_[0]} || do {
1504 my $login = $_[0];
1505
1506 my $guard = cf::lock_acquire "user_find:$login";
1507
1508 $cf::PLAYER{$_[0]} || do {
1509 # rename old playerfiles to new ones
1510 #TODO: remove when no longer required
1511 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1512 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1513 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1514 aio_unlink +(playerdir $login) . "/$login.pl";
1515
1516 my $f = new_from_file cf::object::thawer path $login
1517 or return;
1518
1519 my $pl = cf::player::load_pl $f
1520 or return;
1521
1522 local $cf::PLAYER_LOADING{$login} = $pl;
1523 $f->resolve_delayed_derefs;
1524 $cf::PLAYER{$login} = $pl
1525 }
1526 }
1527}
1528
1529sub save($) {
1530 my ($pl) = @_;
1531
1532 return if $pl->{deny_save};
1533
1534 my $path = path $pl;
1535 my $guard = cf::lock_acquire "user_save:$path";
1536
1537 return if $pl->{deny_save};
1538
1539 aio_mkdir playerdir $pl, 0770;
1540 $pl->{last_save} = $cf::RUNTIME;
1541
1542 cf::get_slot 0.01;
1543
1544 $pl->save_pl ($path);
1545 cf::cede_to_tick;
1546}
1547
1548sub new($) {
1549 my ($login) = @_;
1550
1551 my $self = create;
1552
1553 $self->ob->name ($login);
1554 $self->{deny_save} = 1;
1555
1556 $cf::PLAYER{$login} = $self;
1557
1558 $self
1559}
1560
1561=item $player->send_msg ($channel, $msg, $color, [extra...])
1562
1563=cut
1564
1565sub send_msg {
1566 my $ns = shift->ns
1567 or return;
1568 $ns->send_msg (@_);
1569}
1570
1571=item $pl->quit_character
1572
1573Nukes the player without looking back. If logged in, the connection will
1574be destroyed. May block for a long time.
1575
1576=cut
1577
1578sub quit_character {
1579 my ($pl) = @_;
1580
1581 my $name = $pl->ob->name;
1582
1583 $pl->{deny_save} = 1;
1584 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1585
1586 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1587 $pl->deactivate;
1588 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1589 $pl->ob->check_score;
1590 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1591 $pl->ns->destroy if $pl->ns;
1592
1593 my $path = playerdir $pl;
1594 my $temp = "$path~$cf::RUNTIME~deleting~";
1595 aio_rename $path, $temp;
1596 delete $cf::PLAYER{$pl->ob->name};
1597 $pl->destroy;
1598
1599 my $prefix = qr<^~\Q$name\E/>;
1600
1601 # nuke player maps
1602 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1603
1604 IO::AIO::aio_rmtree $temp;
1605}
1606
1607=item $pl->kick
1608
1609Kicks a player out of the game. This destroys the connection.
1610
1611=cut
1612
1613sub kick {
1614 my ($pl, $kicker) = @_;
1615
1616 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1617 $pl->killer ("kicked");
1618 $pl->ns->destroy;
1619}
1620
1621=item cf::player::list_logins
1622
1623Returns am arrayref of all valid playernames in the system, can take a
1624while and may block, so not sync_job-capable, ever.
1625
1626=cut
1627
1628sub list_logins {
1629 my $dirs = aio_readdir $PLAYERDIR
1630 or return [];
1631
1632 my @logins;
1633
1634 for my $login (@$dirs) {
1635 my $path = path $login;
1636
1637 # a .pst is a dead give-away for a valid player
1638 # if no pst file found, open and chekc for blocked users
1639 if (aio_stat "$path.pst") {
1640 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1641 aio_read $fh, 0, 512, my $buf, 0 or next;
1642 $buf !~ /^password -------------$/m or next; # official not-valid tag
1643 }
1644
1645 utf8::decode $login;
1646 push @logins, $login;
1647 }
1648
1649 \@logins
1650}
1651
1652=item $player->maps
1653
1654Returns an arrayref of map paths that are private for this
1655player. May block.
1656
1657=cut
1658
1659sub maps($) {
1660 my ($pl) = @_;
1661
1662 $pl = ref $pl ? $pl->ob->name : $pl;
1663
1664 my $files = aio_readdir playerdir $pl
1665 or return;
1666
1667 my @paths;
1668
1669 for (@$files) {
1670 utf8::decode $_;
1671 next if /\.(?:pl|pst)$/;
1672 next unless /^$PATH_SEP/o;
1673
1674 push @paths, cf::map::normalise "~$pl/$_";
1675 }
1676
1677 \@paths
1678}
1679
1680=item $protocol_xml = $player->expand_cfpod ($cfpod)
1681
1682Expand deliantra pod fragments into protocol xml.
1683
1684=item $player->ext_reply ($msgid, @msg)
1685
1686Sends an ext reply to the player.
1687
1688=cut
1689
1690sub ext_reply($$@) {
1691 my ($self, $id, @msg) = @_;
1692
1693 $self->ns->ext_reply ($id, @msg)
1694}
1695
1696=item $player->ext_msg ($type, @msg)
1697
1698Sends an ext event to the client.
1699
1700=cut
1701
1702sub ext_msg($$@) {
1703 my ($self, $type, @msg) = @_;
1704
1705 $self->ns->ext_msg ($type, @msg);
1706}
1707
1708=head3 cf::region
1709
1710=over 4
1711
1712=cut
1713
1714package cf::region;
1715
1716=item cf::region::find_by_path $path
1717
1718Tries to decuce the likely region for a map knowing only its path.
1719
1720=cut
1721
1722sub find_by_path($) {
1723 my ($path) = @_;
1724
1725 my ($match, $specificity);
1726
1727 for my $region (list) {
1728 if ($region->{match} && $path =~ $region->{match}) {
1729 ($match, $specificity) = ($region, $region->specificity)
1730 if $region->specificity > $specificity;
1731 }
1732 }
1733
1734 $match
1735}
1736
1737=back
1738
1739=head3 cf::map
1740
1741=over 4
1742
1743=cut
1744
1745package cf::map;
1746
1747use Fcntl;
1748use Coro::AIO;
1749
1750use overload
1751 '""' => \&as_string,
1752 fallback => 1;
1753
1754our $MAX_RESET = 3600;
1755our $DEFAULT_RESET = 3000;
1756
1757sub generate_random_map {
1758 my ($self, $rmp) = @_;
1759
1760 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1761
1762 # mit "rum" bekleckern, nicht
1763 $self->_create_random_map (
1764 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1765 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1766 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1767 $rmp->{exit_on_final_map},
1768 $rmp->{xsize}, $rmp->{ysize},
1769 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1770 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1771 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1772 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1773 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1774 (cf::region::find $rmp->{region}), $rmp->{custom}
1775 )
1776}
1777
1778=item cf::map->register ($regex, $prio)
1779
1780Register a handler for the map path matching the given regex at the
1781givne priority (higher is better, built-in handlers have priority 0, the
1782default).
1783
1784=cut
1785
1786sub register {
1787 my (undef, $regex, $prio) = @_;
1788 my $pkg = caller;
1789
1790 no strict;
1791 push @{"$pkg\::ISA"}, __PACKAGE__;
1792
1793 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1794}
1795
1796# also paths starting with '/'
1797$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1798
1799sub thawer_merge {
1800 my ($self, $merge) = @_;
1801
1802 # we have to keep some variables in memory intact
1803 local $self->{path};
1804 local $self->{load_path};
1805
1806 $self->SUPER::thawer_merge ($merge);
1807}
1808
1809sub normalise {
1810 my ($path, $base) = @_;
1811
1812 $path = "$path"; # make sure its a string
1813
1814 $path =~ s/\.map$//;
1815
1816 # map plan:
1817 #
1818 # /! non-realised random map exit (special hack!)
1819 # {... are special paths that are not being touched
1820 # ?xxx/... are special absolute paths
1821 # ?random/... random maps
1822 # /... normal maps
1823 # ~user/... per-player map of a specific user
1824
1825 $path =~ s/$PATH_SEP/\//go;
1826
1827 # treat it as relative path if it starts with
1828 # something that looks reasonable
1829 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1830 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1831
1832 $base =~ s{[^/]+/?$}{};
1833 $path = "$base/$path";
1834 }
1835
1836 for ($path) {
1837 redo if s{//}{/};
1838 redo if s{/\.?/}{/};
1839 redo if s{/[^/]+/\.\./}{/};
1840 }
1841
1842 $path
1843}
1844
1845sub new_from_path {
1846 my (undef, $path, $base) = @_;
1847
1848 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1849
1850 $path = normalise $path, $base;
1851
1852 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1853 if ($path =~ $EXT_MAP{$pkg}[1]) {
1854 my $self = bless cf::map::new, $pkg;
1855 $self->{path} = $path; $self->path ($path);
1856 $self->init; # pass $1 etc.
1857 return $self;
1858 }
1859 }
1860
1861 Carp::cluck "unable to resolve path '$path' (base '$base').";
1862 ()
1863}
1864
1865sub init {
1866 my ($self) = @_;
1867
1868 $self
1869}
1870
1871sub as_string {
1872 my ($self) = @_;
1873
1874 "$self->{path}"
1875}
1876
1877# the displayed name, this is a one way mapping
1878sub visible_name {
1879 &as_string
1880}
1881
1882# the original (read-only) location
1883sub load_path {
1884 my ($self) = @_;
1885
1886 "$MAPDIR/$self->{path}.map"
1887}
1888
1889# the temporary/swap location
1890sub save_path {
1891 my ($self) = @_;
1892
1893 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1894 "$TMPDIR/$path.map"
1895}
1896
1897# the unique path, undef == no special unique path
1898sub uniq_path {
1899 my ($self) = @_;
1900
1901 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1902 "$UNIQUEDIR/$path"
1903}
1904
1905sub decay_objects {
1906 my ($self) = @_;
1907
1908 return if $self->{deny_reset};
1909
1910 $self->do_decay_objects;
1911}
1912
1913sub unlink_save {
1914 my ($self) = @_;
1915
1916 utf8::encode (my $save = $self->save_path);
1917 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1918 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1919}
1920
1921sub load_header_from($) {
1922 my ($self, $path) = @_;
1923
1924 utf8::encode $path;
1925 my $f = new_from_file cf::object::thawer $path
1926 or return;
1927
1928 $self->_load_header ($f)
1929 or return;
1930
1931 local $MAP_LOADING{$self->{path}} = $self;
1932 $f->resolve_delayed_derefs;
1933
1934 $self->{load_path} = $path;
1935
1936 1
1937}
1938
1939sub load_header_orig {
1940 my ($self) = @_;
1941
1942 $self->load_header_from ($self->load_path)
1943}
1944
1945sub load_header_temp {
1946 my ($self) = @_;
1947
1948 $self->load_header_from ($self->save_path)
1949}
1950
1951sub prepare_temp {
1952 my ($self) = @_;
1953
1954 $self->last_access ((delete $self->{last_access})
1955 || $cf::RUNTIME); #d#
1956 # safety
1957 $self->{instantiate_time} = $cf::RUNTIME
1958 if $self->{instantiate_time} > $cf::RUNTIME;
1959}
1960
1961sub prepare_orig {
1962 my ($self) = @_;
1963
1964 $self->{load_original} = 1;
1965 $self->{instantiate_time} = $cf::RUNTIME;
1966 $self->last_access ($cf::RUNTIME);
1967 $self->instantiate;
1968}
1969
1970sub load_header {
1971 my ($self) = @_;
1972
1973 if ($self->load_header_temp) {
1974 $self->prepare_temp;
1975 } else {
1976 $self->load_header_orig
1977 or return;
1978 $self->prepare_orig;
1979 }
1980
1981 $self->{deny_reset} = 1
1982 if $self->no_reset;
1983
1984 $self->default_region (cf::region::find_by_path $self->{path})
1985 unless $self->default_region;
1986
1987 1
1988}
1989
1990sub find;
1991sub find {
1992 my ($path, $origin) = @_;
1993
1994 $path = normalise $path, $origin && $origin->path;
1995
1996 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1997 my $guard2 = cf::lock_acquire "map_find:$path";
1998
1999 $cf::MAP{$path} || do {
2000 my $map = new_from_path cf::map $path
2001 or return;
2002
2003 $map->{last_save} = $cf::RUNTIME;
2004
2005 $map->load_header
2006 or return;
2007
2008 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
2009 # doing this can freeze the server in a sync job, obviously
2010 #$cf::WAIT_FOR_TICK->wait;
2011 undef $guard2;
2012 undef $guard1;
2013 $map->reset;
2014 return find $path;
2015 }
2016
2017 $cf::MAP{$path} = $map
2018 }
2019}
2020
2021sub pre_load { }
2022#sub post_load { } # XS
2023
2024sub load {
2025 my ($self) = @_;
2026
2027 local $self->{deny_reset} = 1; # loading can take a long time
2028
2029 my $path = $self->{path};
2030
2031 {
2032 my $guard = cf::lock_acquire "map_data:$path";
2033
2034 return unless $self->valid;
2035 return unless $self->in_memory == cf::MAP_SWAPPED;
2036
2037 $self->in_memory (cf::MAP_LOADING);
2038
2039 $self->alloc;
2040
2041 $self->pre_load;
2042 cf::cede_to_tick;
2043
2044 my $f = new_from_file cf::object::thawer $self->{load_path};
2045 $f->skip_block;
2046 $self->_load_objects ($f)
2047 or return;
2048
2049 $self->post_load_original
2050 if delete $self->{load_original};
2051
2052 if (my $uniq = $self->uniq_path) {
2053 utf8::encode $uniq;
2054 unless (aio_stat $uniq) {
2055 if (my $f = new_from_file cf::object::thawer $uniq) {
2056 $self->clear_unique_items;
2057 $self->_load_objects ($f);
2058 $f->resolve_delayed_derefs;
481 } 2059 }
482 } 2060 }
483 } else {
484 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
485 } 2061 }
486 2062
487 cf::override; 2063 $f->resolve_delayed_derefs;
2064
2065 cf::cede_to_tick;
2066 # now do the right thing for maps
2067 $self->link_multipart_objects;
2068 $self->difficulty ($self->estimate_difficulty)
2069 unless $self->difficulty;
2070 cf::cede_to_tick;
2071
2072 unless ($self->{deny_activate}) {
2073 $self->decay_objects;
2074 $self->fix_auto_apply;
2075 $self->update_buttons;
2076 cf::cede_to_tick;
2077 $self->activate;
2078 }
2079
2080 $self->{last_save} = $cf::RUNTIME;
2081 $self->last_access ($cf::RUNTIME);
2082
2083 $self->in_memory (cf::MAP_ACTIVE);
488 }, 2084 }
489;
490 2085
491############################################################################# 2086 $self->post_load;
492# load/save/clean perl data associated with a map 2087}
493 2088
494*cf::mapsupport::on_clean = sub { 2089sub customise_for {
2090 my ($self, $ob) = @_;
2091
2092 return find "~" . $ob->name . "/" . $self->{path}
2093 if $self->per_player;
2094
2095# return find "?party/" . $ob->name . "/" . $self->{path}
2096# if $self->per_party;
2097
2098 $self
2099}
2100
2101# find and load all maps in the 3x3 area around a map
2102sub load_neighbours {
495 my ($map) = @_; 2103 my ($map) = @_;
496 2104
497 my $path = $map->tmpname; 2105 my @neigh; # diagonal neighbours
498 defined $path or return;
499 2106
500 unlink "$path.cfperl"; 2107 for (0 .. 3) {
501}; 2108 my $neigh = $map->tile_path ($_)
2109 or next;
2110 $neigh = find $neigh, $map
2111 or next;
2112 $neigh->load;
502 2113
503*cf::mapsupport::on_swapin = 2114 push @neigh,
504*cf::mapsupport::on_load = sub { 2115 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2116 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2117 }
2118
2119 for (grep defined $_->[0], @neigh) {
2120 my ($path, $origin) = @$_;
2121 my $neigh = find $path, $origin
2122 or next;
2123 $neigh->load;
2124 }
2125}
2126
2127sub find_sync {
2128 my ($path, $origin) = @_;
2129
2130 cf::sync_job { find $path, $origin }
2131}
2132
2133sub do_load_sync {
505 my ($map) = @_; 2134 my ($map) = @_;
506 2135
507 my $path = $map->tmpname; 2136 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
508 $path = $map->path unless defined $path; 2137 if $Coro::current == $Coro::main;
509 2138
510 open my $fh, "<:raw", "$path.cfperl" 2139 cf::sync_job { $map->load };
511 or return; # no perl data 2140}
512 2141
513 my $data = Storable::thaw do { local $/; <$fh> }; 2142our %MAP_PREFETCH;
2143our $MAP_PREFETCHER = undef;
514 2144
515 $data->{version} <= 1 2145sub find_async {
516 or return; # too new 2146 my ($path, $origin, $load) = @_;
517 2147
518 $map->_set_obs ($data->{obs}); 2148 $path = normalise $path, $origin && $origin->{path};
519};
520 2149
521*cf::mapsupport::on_swapout = sub { 2150 if (my $map = $cf::MAP{$path}) {
522 my ($map) = @_; 2151 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2152 }
523 2153
524 my $path = $map->tmpname; 2154 $MAP_PREFETCH{$path} |= $load;
525 $path = $map->path unless defined $path;
526 2155
527 my $obs = $map->_get_obs; 2156 $MAP_PREFETCHER ||= cf::async {
2157 $Coro::current->{desc} = "map prefetcher";
528 2158
529 if (defined $obs) { 2159 while (%MAP_PREFETCH) {
530 open my $fh, ">:raw", "$path.cfperl" 2160 while (my ($k, $v) = each %MAP_PREFETCH) {
531 or die "$path.cfperl: $!"; 2161 if (my $map = find $k) {
2162 $map->load if $v;
2163 }
532 2164
533 stat $path; 2165 delete $MAP_PREFETCH{$k};
534 2166 }
535 print $fh Storable::nfreeze {
536 size => (stat _)[7],
537 time => (stat _)[9],
538 version => 1,
539 obs => $obs,
540 }; 2167 }
2168 undef $MAP_PREFETCHER;
2169 };
2170 $MAP_PREFETCHER->prio (6);
541 2171
542 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* 2172 ()
2173}
2174
2175sub save {
2176 my ($self) = @_;
2177
2178 my $lock = cf::lock_acquire "map_data:$self->{path}";
2179
2180 $self->{last_save} = $cf::RUNTIME;
2181
2182 return unless $self->dirty;
2183
2184 my $save = $self->save_path; utf8::encode $save;
2185 my $uniq = $self->uniq_path; utf8::encode $uniq;
2186
2187 $self->{load_path} = $save;
2188
2189 return if $self->{deny_save};
2190
2191 local $self->{last_access} = $self->last_access;#d#
2192
2193 cf::async {
2194 $Coro::current->{desc} = "map player save";
2195 $_->contr->save for $self->players;
2196 };
2197
2198 cf::get_slot 0.02;
2199
2200 if ($uniq) {
2201 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2202 $self->_save_objects ($uniq, cf::IO_UNIQUES);
543 } else { 2203 } else {
544 unlink "$path.cfperl"; 2204 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
545 }
546};
547
548attach_to_maps prio => -10000, package => cf::mapsupport::;
549
550#############################################################################
551# load/save perl data associated with player->ob objects
552
553sub all_objects(@) {
554 @_, map all_objects ($_->inv), @_
555}
556
557attach_to_players
558 on_load => sub {
559 my ($pl, $path) = @_;
560
561 for my $o (all_objects $pl->ob) {
562 if (my $value = $o->get_ob_key_value ("_perl_data")) {
563 $o->set_ob_key_value ("_perl_data");
564
565 %$o = %{ Storable::thaw pack "H*", $value };
566 }
567 }
568 }, 2205 }
569 on_save => sub { 2206}
570 my ($pl, $path) = @_;
571 2207
572 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) 2208sub swap_out {
573 for grep %$_, all_objects $pl->ob; 2209 my ($self) = @_;
2210
2211 # save first because save cedes
2212 $self->save;
2213
2214 my $lock = cf::lock_acquire "map_data:$self->{path}";
2215
2216 return if $self->players;
2217 return if $self->in_memory != cf::MAP_ACTIVE;
2218 return if $self->{deny_save};
2219
2220 $self->in_memory (cf::MAP_SWAPPED);
2221
2222 $self->deactivate;
2223 $_->clear_links_to ($self) for values %cf::MAP;
2224 $self->clear;
2225}
2226
2227sub reset_at {
2228 my ($self) = @_;
2229
2230 # TODO: safety, remove and allow resettable per-player maps
2231 return 1e99 if $self->{deny_reset};
2232
2233 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2234 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2235
2236 $time + $to
2237}
2238
2239sub should_reset {
2240 my ($self) = @_;
2241
2242 $self->reset_at <= $cf::RUNTIME
2243}
2244
2245sub reset {
2246 my ($self) = @_;
2247
2248 my $lock = cf::lock_acquire "map_data:$self->{path}";
2249
2250 return if $self->players;
2251
2252 warn "resetting map ", $self->path, "\n";
2253
2254 $self->in_memory (cf::MAP_SWAPPED);
2255
2256 # need to save uniques path
2257 unless ($self->{deny_save}) {
2258 my $uniq = $self->uniq_path; utf8::encode $uniq;
2259
2260 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2261 if $uniq;
574 }, 2262 }
575;
576 2263
577############################################################################# 2264 delete $cf::MAP{$self->path};
578# core extensions - in perl
579 2265
580=item cf::player::exists $login 2266 $self->deactivate;
2267 $_->clear_links_to ($self) for values %cf::MAP;
2268 $self->clear;
581 2269
582Returns true when the given account exists. 2270 $self->unlink_save;
583 2271 $self->destroy;
584=cut
585
586sub cf::player::exists($) {
587 cf::player::find $_[0]
588 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
589} 2272}
590 2273
2274my $nuke_counter = "aaaa";
2275
2276sub nuke {
2277 my ($self) = @_;
2278
2279 {
2280 my $lock = cf::lock_acquire "map_data:$self->{path}";
2281
2282 delete $cf::MAP{$self->path};
2283
2284 $self->unlink_save;
2285
2286 bless $self, "cf::map";
2287 delete $self->{deny_reset};
2288 $self->{deny_save} = 1;
2289 $self->reset_timeout (1);
2290 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2291
2292 $cf::MAP{$self->path} = $self;
2293 }
2294
2295 $self->reset; # polite request, might not happen
2296}
2297
2298=item $maps = cf::map::tmp_maps
2299
2300Returns an arrayref with all map paths of currently instantiated and saved
2301maps. May block.
2302
2303=cut
2304
2305sub tmp_maps() {
2306 [
2307 map {
2308 utf8::decode $_;
2309 /\.map$/
2310 ? normalise $_
2311 : ()
2312 } @{ aio_readdir $TMPDIR or [] }
2313 ]
2314}
2315
2316=item $maps = cf::map::random_maps
2317
2318Returns an arrayref with all map paths of currently instantiated and saved
2319random maps. May block.
2320
2321=cut
2322
2323sub random_maps() {
2324 [
2325 map {
2326 utf8::decode $_;
2327 /\.map$/
2328 ? normalise "?random/$_"
2329 : ()
2330 } @{ aio_readdir $RANDOMDIR or [] }
2331 ]
2332}
2333
2334=item cf::map::unique_maps
2335
2336Returns an arrayref of paths of all shared maps that have
2337instantiated unique items. May block.
2338
2339=cut
2340
2341sub unique_maps() {
2342 [
2343 map {
2344 utf8::decode $_;
2345 s/\.map$//; # TODO future compatibility hack
2346 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2347 ? ()
2348 : normalise $_
2349 } @{ aio_readdir $UNIQUEDIR or [] }
2350 ]
2351}
2352
2353=item cf::map::static_maps
2354
2355Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2356file in the shared directory excluding F</styles> and F</editor>). May
2357block.
2358
2359=cut
2360
2361sub static_maps() {
2362 my @dirs = "";
2363 my @maps;
2364
2365 while (@dirs) {
2366 my $dir = shift @dirs;
2367
2368 next if $dir eq "/styles" || $dir eq "/editor";
2369
2370 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2371 or return;
2372
2373 for (@$files) {
2374 s/\.map$// or next;
2375 utf8::decode $_;
2376 push @maps, "$dir/$_";
2377 }
2378
2379 push @dirs, map "$dir/$_", @$dirs;
2380 }
2381
2382 \@maps
2383}
2384
2385=back
2386
2387=head3 cf::object
2388
2389=cut
2390
2391package cf::object;
2392
2393=over 4
2394
2395=item $ob->inv_recursive
2396
2397Returns the inventory of the object I<and> their inventories, recursively,
2398but I<not> the object itself.
2399
2400=cut
2401
2402sub inv_recursive_;
2403sub inv_recursive_ {
2404 map { $_, inv_recursive_ $_->inv } @_
2405}
2406
2407sub inv_recursive {
2408 inv_recursive_ inv $_[0]
2409}
2410
2411=item $ref = $ob->ref
2412
2413Creates and returns a persistent reference to an object that can be stored as a string.
2414
2415=item $ob = cf::object::deref ($refstring)
2416
2417returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2418even if the object actually exists. May block.
2419
2420=cut
2421
2422sub deref {
2423 my ($ref) = @_;
2424
2425 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2426 my ($uuid, $name) = ($1, $2);
2427 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2428 or return;
2429 $pl->ob->uuid eq $uuid
2430 or return;
2431
2432 $pl->ob
2433 } else {
2434 warn "$ref: cannot resolve object reference\n";
2435 undef
2436 }
2437}
2438
2439package cf;
2440
2441=back
2442
2443=head3 cf::object::player
2444
2445=over 4
2446
591=item $player->reply ($npc, $msg[, $flags]) 2447=item $player_object->reply ($npc, $msg[, $flags])
592 2448
593Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2449Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
594can be C<undef>. Does the right thing when the player is currently in a 2450can be C<undef>. Does the right thing when the player is currently in a
595dialogue with the given NPC character. 2451dialogue with the given NPC character.
596 2452
597=cut 2453=cut
598 2454
2455our $SAY_CHANNEL = {
2456 id => "say",
2457 title => "Map",
2458 reply => "say ",
2459 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2460};
2461
2462our $CHAT_CHANNEL = {
2463 id => "chat",
2464 title => "Chat",
2465 reply => "chat ",
2466 tooltip => "Player chat and shouts, global to the server.",
2467};
2468
599# rough implementation of a future "reply" method that works 2469# rough implementation of a future "reply" method that works
600# with dialog boxes. 2470# with dialog boxes.
2471#TODO: the first argument must go, split into a $npc->reply_to ( method
601sub cf::object::player::reply($$$;$) { 2472sub cf::object::player::reply($$$;$) {
602 my ($self, $npc, $msg, $flags) = @_; 2473 my ($self, $npc, $msg, $flags) = @_;
603 2474
604 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2475 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
605 2476
606 if ($self->{record_replies}) { 2477 if ($self->{record_replies}) {
607 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2478 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2479
608 } else { 2480 } else {
2481 my $pl = $self->contr;
2482
2483 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2484 my $dialog = $pl->{npc_dialog};
2485 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2486
2487 } else {
609 $msg = $npc->name . " says: $msg" if $npc; 2488 $msg = $npc->name . " says: $msg" if $npc;
610 $self->message ($msg, $flags); 2489 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2490 }
2491 }
2492}
2493
2494=item $object->send_msg ($channel, $msg, $color, [extra...])
2495
2496=cut
2497
2498sub cf::object::send_msg {
2499 my $pl = shift->contr
2500 or return;
2501 $pl->send_msg (@_);
2502}
2503
2504=item $player_object->may ("access")
2505
2506Returns wether the given player is authorized to access resource "access"
2507(e.g. "command_wizcast").
2508
2509=cut
2510
2511sub cf::object::player::may {
2512 my ($self, $access) = @_;
2513
2514 $self->flag (cf::FLAG_WIZ) ||
2515 (ref $cf::CFG{"may_$access"}
2516 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
2517 : $cf::CFG{"may_$access"})
2518}
2519
2520=item $player_object->enter_link
2521
2522Freezes the player and moves him/her to a special map (C<{link}>).
2523
2524The player should be reasonably safe there for short amounts of time (e.g.
2525for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2526though, as the palyer cannot control the character while it is on the link
2527map.
2528
2529Will never block.
2530
2531=item $player_object->leave_link ($map, $x, $y)
2532
2533Moves the player out of the special C<{link}> map onto the specified
2534map. If the map is not valid (or omitted), the player will be moved back
2535to the location he/she was before the call to C<enter_link>, or, if that
2536fails, to the emergency map position.
2537
2538Might block.
2539
2540=cut
2541
2542sub link_map {
2543 unless ($LINK_MAP) {
2544 $LINK_MAP = cf::map::find "{link}"
2545 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2546 $LINK_MAP->load;
2547 }
2548
2549 $LINK_MAP
2550}
2551
2552sub cf::object::player::enter_link {
2553 my ($self) = @_;
2554
2555 $self->deactivate_recursive;
2556
2557 return if UNIVERSAL::isa $self->map, "ext::map_link";
2558
2559 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2560 if $self->map && $self->map->{path} ne "{link}";
2561
2562 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2563}
2564
2565sub cf::object::player::leave_link {
2566 my ($self, $map, $x, $y) = @_;
2567
2568 return unless $self->contr->active;
2569
2570 my $link_pos = delete $self->{_link_pos};
2571
2572 unless ($map) {
2573 # restore original map position
2574 ($map, $x, $y) = @{ $link_pos || [] };
2575 $map = cf::map::find $map;
2576
2577 unless ($map) {
2578 ($map, $x, $y) = @$EMERGENCY_POSITION;
2579 $map = cf::map::find $map
2580 or die "FATAL: cannot load emergency map\n";
2581 }
2582 }
2583
2584 ($x, $y) = (-1, -1)
2585 unless (defined $x) && (defined $y);
2586
2587 # use -1 or undef as default coordinates, not 0, 0
2588 ($x, $y) = ($map->enter_x, $map->enter_y)
2589 if $x <= 0 && $y <= 0;
2590
2591 $map->load;
2592 $map->load_neighbours;
2593
2594 return unless $self->contr->active;
2595
2596 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2597 $self->enter_map ($map, $x, $y);
2598
2599 # only activate afterwards, to support waiting in hooks
2600 $self->activate_recursive;
2601}
2602
2603=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2604
2605Moves the player to the given map-path and coordinates by first freezing
2606her, loading and preparing them map, calling the provided $check callback
2607that has to return the map if sucecssful, and then unfreezes the player on
2608the new (success) or old (failed) map position. In either case, $done will
2609be called at the end of this process.
2610
2611Note that $check will be called with a potentially non-loaded map, so if
2612it needs a loaded map it has to call C<< ->load >>.
2613
2614=cut
2615
2616our $GOTOGEN;
2617
2618sub cf::object::player::goto {
2619 my ($self, $path, $x, $y, $check, $done) = @_;
2620
2621 # do generation counting so two concurrent goto's will be executed in-order
2622 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2623
2624 $self->enter_link;
2625
2626 (async {
2627 $Coro::current->{desc} = "player::goto $path $x $y";
2628
2629 # *tag paths override both path and x|y
2630 if ($path =~ /^\*(.*)$/) {
2631 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2632 my $ob = $obs[rand @obs];
2633
2634 # see if we actually can go there
2635 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2636 $ob = $obs[rand @obs];
2637 } else {
2638 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2639 }
2640 # else put us there anyways for now #d#
2641
2642 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2643 } else {
2644 ($path, $x, $y) = (undef, undef, undef);
2645 }
2646 }
2647
2648 my $map = eval {
2649 my $map = defined $path ? cf::map::find $path : undef;
2650
2651 if ($map) {
2652 $map = $map->customise_for ($self);
2653 $map = $check->($map) if $check && $map;
2654 } else {
2655 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2656 }
2657
2658 $map
2659 };
2660
2661 if ($@) {
2662 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2663 LOG llevError | logBacktrace, Carp::longmess $@;
2664 }
2665
2666 if ($gen == $self->{_goto_generation}) {
2667 delete $self->{_goto_generation};
2668 $self->leave_link ($map, $x, $y);
2669 }
2670
2671 $done->() if $done;
2672 })->prio (1);
2673}
2674
2675=item $player_object->enter_exit ($exit_object)
2676
2677=cut
2678
2679sub parse_random_map_params {
2680 my ($spec) = @_;
2681
2682 my $rmp = { # defaults
2683 xsize => (cf::rndm 15, 40),
2684 ysize => (cf::rndm 15, 40),
2685 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2686 #layout => string,
611 } 2687 };
612}
613 2688
2689 for (split /\n/, $spec) {
2690 my ($k, $v) = split /\s+/, $_, 2;
2691
2692 $rmp->{lc $k} = $v if (length $k) && (length $v);
2693 }
2694
2695 $rmp
2696}
2697
2698sub prepare_random_map {
2699 my ($exit) = @_;
2700
2701 # all this does is basically replace the /! path by
2702 # a new random map path (?random/...) with a seed
2703 # that depends on the exit object
2704
2705 my $rmp = parse_random_map_params $exit->msg;
2706
2707 if ($exit->map) {
2708 $rmp->{region} = $exit->region->name;
2709 $rmp->{origin_map} = $exit->map->path;
2710 $rmp->{origin_x} = $exit->x;
2711 $rmp->{origin_y} = $exit->y;
2712
2713 $exit->map->touch;
2714 }
2715
2716 $rmp->{random_seed} ||= $exit->random_seed;
2717
2718 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2719 my $md5 = Digest::MD5::md5_hex $data;
2720 my $meta = "$RANDOMDIR/$md5.meta";
2721
2722 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2723 aio_write $fh, 0, (length $data), $data, 0;
2724 undef $fh;
2725 aio_rename "$meta~", $meta;
2726
2727 my $slaying = "?random/$md5";
2728
2729 if ($exit->valid) {
2730 $exit->slaying ("?random/$md5");
2731 $exit->msg (undef);
2732 }
2733 }
2734}
2735
2736sub cf::object::player::enter_exit {
2737 my ($self, $exit) = @_;
2738
2739 return unless $self->type == cf::PLAYER;
2740
2741 $self->enter_link;
2742
2743 (async {
2744 $Coro::current->{desc} = "enter_exit";
2745
2746 unless (eval {
2747 $self->deactivate_recursive; # just to be sure
2748
2749 # random map handling
2750 {
2751 my $guard = cf::lock_acquire "exit_prepare:$exit";
2752
2753 prepare_random_map $exit
2754 if $exit->slaying eq "/!";
2755 }
2756
2757 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2758 my $x = $exit->stats->hp;
2759 my $y = $exit->stats->sp;
2760
2761 $self->goto ($map, $x, $y);
2762
2763 # if exit is damned, update players death & WoR home-position
2764 $self->contr->savebed ($map, $x, $y)
2765 if $exit->flag (cf::FLAG_DAMNED);
2766
2767 1
2768 }) {
2769 $self->message ("Something went wrong deep within the deliantra server. "
2770 . "I'll try to bring you back to the map you were before. "
2771 . "Please report this to the dungeon master!",
2772 cf::NDI_UNIQUE | cf::NDI_RED);
2773
2774 warn "ERROR in enter_exit: $@";
2775 $self->leave_link;
2776 }
2777 })->prio (1);
2778}
2779
2780=head3 cf::client
2781
2782=over 4
2783
2784=item $client->send_drawinfo ($text, $flags)
2785
2786Sends a drawinfo packet to the client. Circumvents output buffering so
2787should not be used under normal circumstances.
2788
2789=cut
2790
2791sub cf::client::send_drawinfo {
2792 my ($self, $text, $flags) = @_;
2793
2794 utf8::encode $text;
2795 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2796}
2797
2798=item $client->send_big_packet ($pkt)
2799
2800Like C<send_packet>, but tries to compress large packets, and fragments
2801them as required.
2802
2803=cut
2804
2805our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2806
2807sub cf::client::send_big_packet {
2808 my ($self, $pkt) = @_;
2809
2810 # try lzf for large packets
2811 $pkt = "lzf " . Compress::LZF::compress $pkt
2812 if 1024 <= length $pkt and $self->{can_lzf};
2813
2814 # split very large packets
2815 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2816 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2817 $pkt = "frag";
2818 }
2819
2820 $self->send_packet ($pkt);
2821}
2822
2823=item $client->send_msg ($channel, $msg, $color, [extra...])
2824
2825Send a drawinfo or msg packet to the client, formatting the msg for the
2826client if neccessary. C<$type> should be a string identifying the type of
2827the message, with C<log> being the default. If C<$color> is negative, suppress
2828the message unless the client supports the msg packet.
2829
2830=cut
2831
2832# non-persistent channels (usually the info channel)
2833our %CHANNEL = (
2834 "c/motd" => {
2835 id => "infobox",
2836 title => "MOTD",
2837 reply => undef,
2838 tooltip => "The message of the day",
2839 },
2840 "c/identify" => {
2841 id => "infobox",
2842 title => "Identify",
2843 reply => undef,
2844 tooltip => "Items recently identified",
2845 },
2846 "c/examine" => {
2847 id => "infobox",
2848 title => "Examine",
2849 reply => undef,
2850 tooltip => "Signs and other items you examined",
2851 },
2852 "c/shopinfo" => {
2853 id => "infobox",
2854 title => "Shop Info",
2855 reply => undef,
2856 tooltip => "What your bargaining skill tells you about the shop",
2857 },
2858 "c/book" => {
2859 id => "infobox",
2860 title => "Book",
2861 reply => undef,
2862 tooltip => "The contents of a note or book",
2863 },
2864 "c/lookat" => {
2865 id => "infobox",
2866 title => "Look",
2867 reply => undef,
2868 tooltip => "What you saw there",
2869 },
2870 "c/who" => {
2871 id => "infobox",
2872 title => "Players",
2873 reply => undef,
2874 tooltip => "Shows players who are currently online",
2875 },
2876 "c/body" => {
2877 id => "infobox",
2878 title => "Body Parts",
2879 reply => undef,
2880 tooltip => "Shows which body parts you posess and are available",
2881 },
2882 "c/statistics" => {
2883 id => "infobox",
2884 title => "Statistics",
2885 reply => undef,
2886 tooltip => "Shows your primary statistics",
2887 },
2888 "c/skills" => {
2889 id => "infobox",
2890 title => "Skills",
2891 reply => undef,
2892 tooltip => "Shows your experience per skill and item power",
2893 },
2894 "c/shopitems" => {
2895 id => "infobox",
2896 title => "Shop Items",
2897 reply => undef,
2898 tooltip => "Shows the items currently for sale in this shop",
2899 },
2900 "c/resistances" => {
2901 id => "infobox",
2902 title => "Resistances",
2903 reply => undef,
2904 tooltip => "Shows your resistances",
2905 },
2906 "c/pets" => {
2907 id => "infobox",
2908 title => "Pets",
2909 reply => undef,
2910 tooltip => "Shows information abotu your pets/a specific pet",
2911 },
2912 "c/perceiveself" => {
2913 id => "infobox",
2914 title => "Perceive Self",
2915 reply => undef,
2916 tooltip => "You gained detailed knowledge about yourself",
2917 },
2918 "c/uptime" => {
2919 id => "infobox",
2920 title => "Uptime",
2921 reply => undef,
2922 tooltip => "How long the server has been running since last restart",
2923 },
2924 "c/mapinfo" => {
2925 id => "infobox",
2926 title => "Map Info",
2927 reply => undef,
2928 tooltip => "Information related to the maps",
2929 },
2930 "c/party" => {
2931 id => "party",
2932 title => "Party",
2933 reply => "gsay ",
2934 tooltip => "Messages and chat related to your party",
2935 },
2936 "c/death" => {
2937 id => "death",
2938 title => "Death",
2939 reply => undef,
2940 tooltip => "Reason for and more info about your most recent death",
2941 },
2942 "c/say" => $SAY_CHANNEL,
2943 "c/chat" => $CHAT_CHANNEL,
2944);
2945
2946sub cf::client::send_msg {
2947 my ($self, $channel, $msg, $color, @extra) = @_;
2948
2949 $msg = $self->pl->expand_cfpod ($msg)
2950 unless $color & cf::NDI_VERBATIM;
2951
2952 $color &= cf::NDI_CLIENT_MASK; # just in case...
2953
2954 # check predefined channels, for the benefit of C
2955 if ($CHANNEL{$channel}) {
2956 $channel = $CHANNEL{$channel};
2957
2958 $self->ext_msg (channel_info => $channel);
2959 $channel = $channel->{id};
2960
2961 } elsif (ref $channel) {
2962 # send meta info to client, if not yet sent
2963 unless (exists $self->{channel}{$channel->{id}}) {
2964 $self->{channel}{$channel->{id}} = $channel;
2965 $self->ext_msg (channel_info => $channel);
2966 }
2967
2968 $channel = $channel->{id};
2969 }
2970
2971 return unless @extra || length $msg;
2972
2973 # default colour, mask it out
2974 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2975 if $color & cf::NDI_DEF;
2976
2977 my $pkt = "msg "
2978 . $self->{json_coder}->encode (
2979 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2980 );
2981
2982 $self->send_big_packet ($pkt);
2983}
2984
2985=item $client->ext_msg ($type, @msg)
2986
2987Sends an ext event to the client.
2988
2989=cut
2990
2991sub cf::client::ext_msg($$@) {
2992 my ($self, $type, @msg) = @_;
2993
2994 if ($self->extcmd == 2) {
2995 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2996 } elsif ($self->extcmd == 1) { # TODO: remove
2997 push @msg, msgtype => "event_$type";
2998 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2999 }
3000}
3001
614=item $player->ext_reply ($msgid, $msgtype, %msg) 3002=item $client->ext_reply ($msgid, @msg)
615 3003
616Sends an ext reply to the player. 3004Sends an ext reply to the client.
617 3005
618=cut 3006=cut
619 3007
620sub cf::player::ext_reply($$$%) { 3008sub cf::client::ext_reply($$@) {
621 my ($self, $id, %msg) = @_; 3009 my ($self, $id, @msg) = @_;
622 3010
623 $msg{msgid} = $id; 3011 if ($self->extcmd == 2) {
624 3012 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
625 $self->send ("ext " . to_json \%msg); 3013 } elsif ($self->extcmd == 1) {
3014 #TODO: version 1, remove
3015 unshift @msg, msgtype => "reply", msgid => $id;
3016 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3017 }
626} 3018}
627 3019
628############################################################################# 3020=item $success = $client->query ($flags, "text", \&cb)
629# map scripting support 3021
3022Queues a query to the client, calling the given callback with
3023the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
3024C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
3025
3026Queries can fail, so check the return code. Or don't, as queries will
3027become reliable at some point in the future.
3028
3029=cut
3030
3031sub cf::client::query {
3032 my ($self, $flags, $text, $cb) = @_;
3033
3034 return unless $self->state == ST_PLAYING
3035 || $self->state == ST_SETUP
3036 || $self->state == ST_CUSTOM;
3037
3038 $self->state (ST_CUSTOM);
3039
3040 utf8::encode $text;
3041 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
3042
3043 $self->send_packet ($self->{query_queue}[0][0])
3044 if @{ $self->{query_queue} } == 1;
3045
3046 1
3047}
3048
3049cf::client->attach (
3050 on_connect => sub {
3051 my ($ns) = @_;
3052
3053 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3054 },
3055 on_reply => sub {
3056 my ($ns, $msg) = @_;
3057
3058 # this weird shuffling is so that direct followup queries
3059 # get handled first
3060 my $queue = delete $ns->{query_queue}
3061 or return; # be conservative, not sure how that can happen, but we saw a crash here
3062
3063 (shift @$queue)->[1]->($msg);
3064 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
3065
3066 push @{ $ns->{query_queue} }, @$queue;
3067
3068 if (@{ $ns->{query_queue} } == @$queue) {
3069 if (@$queue) {
3070 $ns->send_packet ($ns->{query_queue}[0][0]);
3071 } else {
3072 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
3073 }
3074 }
3075 },
3076 on_exticmd => sub {
3077 my ($ns, $buf) = @_;
3078
3079 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3080
3081 if (ref $msg) {
3082 my ($type, $reply, @payload) =
3083 "ARRAY" eq ref $msg
3084 ? @$msg
3085 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3086
3087 my @reply;
3088
3089 if (my $cb = $EXTICMD{$type}) {
3090 @reply = $cb->($ns, @payload);
3091 }
3092
3093 $ns->ext_reply ($reply, @reply)
3094 if $reply;
3095
3096 } else {
3097 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3098 }
3099
3100 cf::override;
3101 },
3102);
3103
3104=item $client->async (\&cb)
3105
3106Create a new coroutine, running the specified callback. The coroutine will
3107be automatically cancelled when the client gets destroyed (e.g. on logout,
3108or loss of connection).
3109
3110=cut
3111
3112sub cf::client::async {
3113 my ($self, $cb) = @_;
3114
3115 my $coro = &Coro::async ($cb);
3116
3117 $coro->on_destroy (sub {
3118 delete $self->{_coro}{$coro+0};
3119 });
3120
3121 $self->{_coro}{$coro+0} = $coro;
3122
3123 $coro
3124}
3125
3126cf::client->attach (
3127 on_destroy => sub {
3128 my ($ns) = @_;
3129
3130 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
3131 },
3132);
3133
3134=back
3135
3136
3137=head2 SAFE SCRIPTING
3138
3139Functions that provide a safe environment to compile and execute
3140snippets of perl code without them endangering the safety of the server
3141itself. Looping constructs, I/O operators and other built-in functionality
3142is not available in the safe scripting environment, and the number of
3143functions and methods that can be called is greatly reduced.
3144
3145=cut
630 3146
631our $safe = new Safe "safe"; 3147our $safe = new Safe "safe";
632our $safe_hole = new Safe::Hole; 3148our $safe_hole = new Safe::Hole;
633 3149
634$SIG{FPE} = 'IGNORE'; 3150$SIG{FPE} = 'IGNORE';
635 3151
636$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3152$safe->permit_only (Opcode::opset qw(
3153 :base_core :base_mem :base_orig :base_math :base_loop
3154 grepstart grepwhile mapstart mapwhile
3155 sort time
3156));
637 3157
638# here we export the classes and methods available to script code 3158# here we export the classes and methods available to script code
639 3159
3160=pod
3161
3162The following functions and methods are available within a safe environment:
3163
3164 cf::object
3165 contr pay_amount pay_player map x y force_find force_add destroy
3166 insert remove name archname title slaying race decrease split
3167 value
3168
3169 cf::object::player
3170 player
3171
3172 cf::player
3173 peaceful
3174
3175 cf::map
3176 trigger
3177
3178=cut
3179
640for ( 3180for (
641 ["cf::object" => qw(contr pay_amount pay_player)], 3181 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3182 insert remove inv nrof name archname title slaying race
3183 decrease split destroy change_exp value msg lore send_msg)],
642 ["cf::object::player" => qw(player)], 3184 ["cf::object::player" => qw(player)],
643 ["cf::player" => qw(peaceful)], 3185 ["cf::player" => qw(peaceful send_msg)],
3186 ["cf::map" => qw(trigger)],
644) { 3187) {
645 no strict 'refs'; 3188 no strict 'refs';
646 my ($pkg, @funs) = @$_; 3189 my ($pkg, @funs) = @$_;
647 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3190 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
648 for @funs; 3191 for @funs;
649} 3192}
650 3193
3194=over 4
3195
3196=item @retval = safe_eval $code, [var => value, ...]
3197
3198Compiled and executes the given perl code snippet. additional var/value
3199pairs result in temporary local (my) scalar variables of the given name
3200that are available in the code snippet. Example:
3201
3202 my $five = safe_eval '$first + $second', first => 1, second => 4;
3203
3204=cut
3205
651sub safe_eval($;@) { 3206sub safe_eval($;@) {
652 my ($code, %vars) = @_; 3207 my ($code, %vars) = @_;
653 3208
654 my $qcode = $code; 3209 my $qcode = $code;
655 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3210 $qcode =~ s/"/‟/g; # not allowed in #line filenames
656 $qcode =~ s/\n/\\n/g; 3211 $qcode =~ s/\n/\\n/g;
657 3212
3213 %vars = (_dummy => 0) unless %vars;
3214
3215 my @res;
658 local $_; 3216 local $_;
659 local @safe::cf::_safe_eval_args = values %vars;
660 3217
661 my $eval = 3218 my $eval =
662 "do {\n" 3219 "do {\n"
663 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3220 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
664 . "#line 0 \"{$qcode}\"\n" 3221 . "#line 0 \"{$qcode}\"\n"
665 . $code 3222 . $code
666 . "\n}" 3223 . "\n}"
667 ; 3224 ;
668 3225
3226 if ($CFG{safe_eval}) {
669 sub_generation_inc; 3227 sub_generation_inc;
3228 local @safe::cf::_safe_eval_args = values %vars;
670 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3229 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
671 sub_generation_inc; 3230 sub_generation_inc;
3231 } else {
3232 local @cf::_safe_eval_args = values %vars;
3233 @res = wantarray ? eval eval : scalar eval $eval;
3234 }
672 3235
673 if ($@) { 3236 if ($@) {
674 warn "$@"; 3237 warn "$@";
675 warn "while executing safe code '$code'\n"; 3238 warn "while executing safe code '$code'\n";
676 warn "with arguments " . (join " ", %vars) . "\n"; 3239 warn "with arguments " . (join " ", %vars) . "\n";
677 } 3240 }
678 3241
679 wantarray ? @res : $res[0] 3242 wantarray ? @res : $res[0]
680} 3243}
681 3244
3245=item cf::register_script_function $function => $cb
3246
3247Register a function that can be called from within map/npc scripts. The
3248function should be reasonably secure and should be put into a package name
3249like the extension.
3250
3251Example: register a function that gets called whenever a map script calls
3252C<rent::overview>, as used by the C<rent> extension.
3253
3254 cf::register_script_function "rent::overview" => sub {
3255 ...
3256 };
3257
3258=cut
3259
682sub register_script_function { 3260sub register_script_function {
683 my ($fun, $cb) = @_; 3261 my ($fun, $cb) = @_;
684 3262
685 no strict 'refs'; 3263 $fun = "safe::$fun" if $CFG{safe_eval};
686 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3264 *$fun = $safe_hole->wrap ($cb);
687} 3265}
3266
3267=back
3268
3269=cut
688 3270
689############################################################################# 3271#############################################################################
690# the server's main() 3272# the server's init and main functions
3273
3274sub load_facedata($) {
3275 my ($path) = @_;
3276
3277 # HACK to clear player env face cache, we need some signal framework
3278 # for this (global event?)
3279 %ext::player_env::MUSIC_FACE_CACHE = ();
3280
3281 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3282
3283 warn "loading facedata from $path\n";
3284
3285 my $facedata;
3286 0 < aio_load $path, $facedata
3287 or die "$path: $!";
3288
3289 $facedata = Coro::Storable::thaw $facedata;
3290
3291 $facedata->{version} == 2
3292 or cf::cleanup "$path: version mismatch, cannot proceed.";
3293
3294 # patch in the exptable
3295 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3296 $facedata->{resource}{"res/exp_table"} = {
3297 type => FT_RSRC,
3298 data => $exp_table,
3299 hash => (Digest::MD5::md5 $exp_table),
3300 };
3301 cf::cede_to_tick;
3302
3303 {
3304 my $faces = $facedata->{faceinfo};
3305
3306 while (my ($face, $info) = each %$faces) {
3307 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3308
3309 cf::face::set_visibility $idx, $info->{visibility};
3310 cf::face::set_magicmap $idx, $info->{magicmap};
3311 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
3312 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
3313
3314 cf::cede_to_tick;
3315 }
3316
3317 while (my ($face, $info) = each %$faces) {
3318 next unless $info->{smooth};
3319
3320 my $idx = cf::face::find $face
3321 or next;
3322
3323 if (my $smooth = cf::face::find $info->{smooth}) {
3324 cf::face::set_smooth $idx, $smooth;
3325 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3326 } else {
3327 warn "smooth face '$info->{smooth}' not found for face '$face'";
3328 }
3329
3330 cf::cede_to_tick;
3331 }
3332 }
3333
3334 {
3335 my $anims = $facedata->{animinfo};
3336
3337 while (my ($anim, $info) = each %$anims) {
3338 cf::anim::set $anim, $info->{frames}, $info->{facings};
3339 cf::cede_to_tick;
3340 }
3341
3342 cf::anim::invalidate_all; # d'oh
3343 }
3344
3345 {
3346 my $res = $facedata->{resource};
3347
3348 while (my ($name, $info) = each %$res) {
3349 if (defined $info->{type}) {
3350 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3351
3352 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3353 cf::face::set_type $idx, $info->{type};
3354 } else {
3355 $RESOURCE{$name} = $info;
3356 }
3357
3358 cf::cede_to_tick;
3359 }
3360 }
3361
3362 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3363
3364 1
3365}
3366
3367cf::global->attach (on_resource_update => sub {
3368 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3369 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3370
3371 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3372 my $sound = $soundconf->{compat}[$_]
3373 or next;
3374
3375 my $face = cf::face::find "sound/$sound->[1]";
3376 cf::sound::set $sound->[0] => $face;
3377 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3378 }
3379
3380 while (my ($k, $v) = each %{$soundconf->{event}}) {
3381 my $face = cf::face::find "sound/$v";
3382 cf::sound::set $k => $face;
3383 }
3384 }
3385});
3386
3387register_exticmd fx_want => sub {
3388 my ($ns, $want) = @_;
3389
3390 while (my ($k, $v) = each %$want) {
3391 $ns->fx_want ($k, $v);
3392 }
3393};
3394
3395sub load_resource_file($) {
3396 my $guard = lock_acquire "load_resource_file";
3397
3398 my $status = load_resource_file_ $_[0];
3399 get_slot 0.1, 100;
3400 cf::arch::commit_load;
3401
3402 $status
3403}
3404
3405sub reload_regions {
3406 # HACK to clear player env face cache, we need some signal framework
3407 # for this (global event?)
3408 %ext::player_env::MUSIC_FACE_CACHE = ();
3409
3410 load_resource_file "$MAPDIR/regions"
3411 or die "unable to load regions file\n";
3412
3413 for (cf::region::list) {
3414 $_->{match} = qr/$_->{match}/
3415 if exists $_->{match};
3416 }
3417}
3418
3419sub reload_facedata {
3420 load_facedata "$DATADIR/facedata"
3421 or die "unable to load facedata\n";
3422}
3423
3424sub reload_archetypes {
3425 load_resource_file "$DATADIR/archetypes"
3426 or die "unable to load archetypes\n";
3427}
3428
3429sub reload_treasures {
3430 load_resource_file "$DATADIR/treasures"
3431 or die "unable to load treasurelists\n";
3432}
3433
3434sub reload_resources {
3435 warn "reloading resource files...\n";
3436
3437 reload_facedata;
3438 reload_archetypes;
3439 reload_regions;
3440 reload_treasures;
3441
3442 warn "finished reloading resource files\n";
3443}
3444
3445sub reload_config {
3446 warn "reloading config file...\n";
3447
3448 open my $fh, "<:utf8", "$CONFDIR/config"
3449 or return;
3450
3451 local $/;
3452 *CFG = YAML::XS::Load scalar <$fh>;
3453
3454 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3455
3456 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3457 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3458
3459 if (exists $CFG{mlockall}) {
3460 eval {
3461 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3462 and die "WARNING: m(un)lockall failed: $!\n";
3463 };
3464 warn $@ if $@;
3465 }
3466
3467 warn "finished reloading resource files\n";
3468}
3469
3470sub pidfile() {
3471 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3472 or die "$PIDFILE: $!";
3473 flock $fh, &Fcntl::LOCK_EX
3474 or die "$PIDFILE: flock: $!";
3475 $fh
3476}
3477
3478# make sure only one server instance is running at any one time
3479sub atomic {
3480 my $fh = pidfile;
3481
3482 my $pid = <$fh>;
3483 kill 9, $pid if $pid > 0;
3484
3485 seek $fh, 0, 0;
3486 print $fh $$;
3487}
3488
3489sub main_loop {
3490 warn "EV::loop starting\n";
3491 if (1) {
3492 EV::loop;
3493 }
3494 warn "EV::loop returned\n";
3495 goto &main_loop unless $REALLY_UNLOOP;
3496}
691 3497
692sub main { 3498sub main {
693 Event::loop; 3499 cf::init_globals; # initialise logging
3500
3501 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3502 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3503 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3504 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3505
3506 cf::init_experience;
3507 cf::init_anim;
3508 cf::init_attackmess;
3509 cf::init_dynamic;
3510
3511 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3512
3513 # we must not ever block the main coroutine
3514 local $Coro::idle = sub {
3515 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3516 (async {
3517 $Coro::current->{desc} = "IDLE BUG HANDLER";
3518 EV::loop EV::LOOP_ONESHOT;
3519 })->prio (Coro::PRIO_MAX);
3520 };
3521
3522 evthread_start IO::AIO::poll_fileno;
3523
3524 cf::sync_job {
3525 cf::load_settings;
3526 cf::load_materials;
3527
3528 reload_resources;
3529 reload_config;
3530 db_init;
3531
3532 cf::init_uuid;
3533 cf::init_signals;
3534 cf::init_commands;
3535 cf::init_skills;
3536
3537 cf::init_beforeplay;
3538
3539 atomic;
3540
3541 load_extensions;
3542
3543 utime time, time, $RUNTIMEFILE;
3544
3545 # no (long-running) fork's whatsoever before this point(!)
3546 use POSIX ();
3547 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3548
3549 (pop @POST_INIT)->(0) while @POST_INIT;
3550 };
3551
3552 main_loop;
694} 3553}
695 3554
696############################################################################# 3555#############################################################################
697# initialisation 3556# initialisation and cleanup
698 3557
699register "<global>", __PACKAGE__; 3558# install some emergency cleanup handlers
3559BEGIN {
3560 our %SIGWATCHER = ();
3561 for my $signal (qw(INT HUP TERM)) {
3562 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3563 cf::cleanup "SIG$signal";
3564 };
3565 }
3566}
3567
3568sub write_runtime_sync {
3569 # first touch the runtime file to show we are still running:
3570 # the fsync below can take a very very long time.
3571
3572 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3573
3574 my $guard = cf::lock_acquire "write_runtime";
3575
3576 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3577 or return;
3578
3579 my $value = $cf::RUNTIME + 90 + 10;
3580 # 10 is the runtime save interval, for a monotonic clock
3581 # 60 allows for the watchdog to kill the server.
3582
3583 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3584 and return;
3585
3586 # always fsync - this file is important
3587 aio_fsync $fh
3588 and return;
3589
3590 # touch it again to show we are up-to-date
3591 aio_utime $fh, undef, undef;
3592
3593 close $fh
3594 or return;
3595
3596 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3597 and return;
3598
3599 warn "runtime file written.\n";
3600
3601 1
3602}
3603
3604our $uuid_lock;
3605our $uuid_skip;
3606
3607sub write_uuid_sync($) {
3608 $uuid_skip ||= $_[0];
3609
3610 return if $uuid_lock;
3611 local $uuid_lock = 1;
3612
3613 my $uuid = "$LOCALDIR/uuid";
3614
3615 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3616 or return;
3617
3618 my $value = uuid_seq uuid_cur;
3619
3620 unless ($value) {
3621 warn "cowardly refusing to write zero uuid value!\n";
3622 return;
3623 }
3624
3625 my $value = uuid_str $value + $uuid_skip;
3626 $uuid_skip = 0;
3627
3628 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3629 and return;
3630
3631 # always fsync - this file is important
3632 aio_fsync $fh
3633 and return;
3634
3635 close $fh
3636 or return;
3637
3638 aio_rename "$uuid~", $uuid
3639 and return;
3640
3641 warn "uuid file written ($value).\n";
3642
3643 1
3644
3645}
3646
3647sub write_uuid($$) {
3648 my ($skip, $sync) = @_;
3649
3650 $sync ? write_uuid_sync $skip
3651 : async { write_uuid_sync $skip };
3652}
3653
3654sub emergency_save() {
3655 my $freeze_guard = cf::freeze_mainloop;
3656
3657 warn "emergency_perl_save: enter\n";
3658
3659 cf::sync_job {
3660 # this is a trade-off: we want to be very quick here, so
3661 # save all maps without fsync, and later call a global sync
3662 # (which in turn might be very very slow)
3663 local $USE_FSYNC = 0;
3664
3665 # use a peculiar iteration method to avoid tripping on perl
3666 # refcount bugs in for. also avoids problems with players
3667 # and maps saved/destroyed asynchronously.
3668 warn "emergency_perl_save: begin player save\n";
3669 for my $login (keys %cf::PLAYER) {
3670 my $pl = $cf::PLAYER{$login} or next;
3671 $pl->valid or next;
3672 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3673 $pl->save;
3674 }
3675 warn "emergency_perl_save: end player save\n";
3676
3677 warn "emergency_perl_save: begin map save\n";
3678 for my $path (keys %cf::MAP) {
3679 my $map = $cf::MAP{$path} or next;
3680 $map->valid or next;
3681 $map->save;
3682 }
3683 warn "emergency_perl_save: end map save\n";
3684
3685 warn "emergency_perl_save: begin database checkpoint\n";
3686 BDB::db_env_txn_checkpoint $DB_ENV;
3687 warn "emergency_perl_save: end database checkpoint\n";
3688
3689 warn "emergency_perl_save: begin write uuid\n";
3690 write_uuid_sync 1;
3691 warn "emergency_perl_save: end write uuid\n";
3692 };
3693
3694 warn "emergency_perl_save: starting sync()\n";
3695 IO::AIO::aio_sync sub {
3696 warn "emergency_perl_save: finished sync()\n";
3697 };
3698
3699 warn "emergency_perl_save: leave\n";
3700}
3701
3702sub post_cleanup {
3703 my ($make_core) = @_;
3704
3705 warn Carp::longmess "post_cleanup backtrace"
3706 if $make_core;
3707
3708 my $fh = pidfile;
3709 unlink $PIDFILE if <$fh> == $$;
3710}
3711
3712# a safer delete_package, copied from Symbol
3713sub clear_package($) {
3714 my $pkg = shift;
3715
3716 # expand to full symbol table name if needed
3717 unless ($pkg =~ /^main::.*::$/) {
3718 $pkg = "main$pkg" if $pkg =~ /^::/;
3719 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3720 $pkg .= '::' unless $pkg =~ /::$/;
3721 }
3722
3723 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3724 my $stem_symtab = *{$stem}{HASH};
3725
3726 defined $stem_symtab and exists $stem_symtab->{$leaf}
3727 or return;
3728
3729 # clear all symbols
3730 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3731 for my $name (keys %$leaf_symtab) {
3732 _gv_clear *{"$pkg$name"};
3733# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3734 }
3735 warn "cleared package $pkg\n";#d#
3736}
3737
3738sub do_reload_perl() {
3739 # can/must only be called in main
3740 if ($Coro::current != $Coro::main) {
3741 warn "can only reload from main coroutine";
3742 return;
3743 }
3744
3745 return if $RELOAD++;
3746
3747 my $t1 = EV::time;
3748
3749 while ($RELOAD) {
3750 warn "reloading...";
3751
3752 warn "entering sync_job";
3753
3754 cf::sync_job {
3755 cf::write_runtime_sync; # external watchdog should not bark
3756 cf::emergency_save;
3757 cf::write_runtime_sync; # external watchdog should not bark
3758
3759 warn "syncing database to disk";
3760 BDB::db_env_txn_checkpoint $DB_ENV;
3761
3762 # if anything goes wrong in here, we should simply crash as we already saved
3763
3764 warn "flushing outstanding aio requests";
3765 while (IO::AIO::nreqs || BDB::nreqs) {
3766 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3767 }
3768
3769 warn "cancelling all extension coros";
3770 $_->cancel for values %EXT_CORO;
3771 %EXT_CORO = ();
3772
3773 warn "removing commands";
3774 %COMMAND = ();
3775
3776 warn "removing ext/exti commands";
3777 %EXTCMD = ();
3778 %EXTICMD = ();
3779
3780 warn "unloading/nuking all extensions";
3781 for my $pkg (@EXTS) {
3782 warn "... unloading $pkg";
3783
3784 if (my $cb = $pkg->can ("unload")) {
3785 eval {
3786 $cb->($pkg);
3787 1
3788 } or warn "$pkg unloaded, but with errors: $@";
3789 }
3790
3791 warn "... clearing $pkg";
3792 clear_package $pkg;
3793 }
3794
3795 warn "unloading all perl modules loaded from $LIBDIR";
3796 while (my ($k, $v) = each %INC) {
3797 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3798
3799 warn "... unloading $k";
3800 delete $INC{$k};
3801
3802 $k =~ s/\.pm$//;
3803 $k =~ s/\//::/g;
3804
3805 if (my $cb = $k->can ("unload_module")) {
3806 $cb->();
3807 }
3808
3809 clear_package $k;
3810 }
3811
3812 warn "getting rid of safe::, as good as possible";
3813 clear_package "safe::$_"
3814 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3815
3816 warn "unloading cf.pm \"a bit\"";
3817 delete $INC{"cf.pm"};
3818 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
3819
3820 # don't, removes xs symbols, too,
3821 # and global variables created in xs
3822 #clear_package __PACKAGE__;
3823
3824 warn "unload completed, starting to reload now";
3825
3826 warn "reloading cf.pm";
3827 require cf;
3828 cf::_connect_to_perl_1;
3829
3830 warn "loading config and database again";
3831 cf::reload_config;
3832
3833 warn "loading extensions";
3834 cf::load_extensions;
3835
3836 if ($REATTACH_ON_RELOAD) {
3837 warn "reattaching attachments to objects/players";
3838 _global_reattach; # objects, sockets
3839 warn "reattaching attachments to maps";
3840 reattach $_ for values %MAP;
3841 warn "reattaching attachments to players";
3842 reattach $_ for values %PLAYER;
3843 }
3844
3845 warn "running post_init jobs";
3846 (pop @POST_INIT)->(1) while @POST_INIT;
3847
3848 warn "leaving sync_job";
3849
3850 1
3851 } or do {
3852 warn $@;
3853 cf::cleanup "error while reloading, exiting.";
3854 };
3855
3856 warn "reloaded";
3857 --$RELOAD;
3858 }
3859
3860 $t1 = EV::time - $t1;
3861 warn "reload completed in ${t1}s\n";
3862};
3863
3864our $RELOAD_WATCHER; # used only during reload
3865
3866sub reload_perl() {
3867 # doing reload synchronously and two reloads happen back-to-back,
3868 # coro crashes during coro_state_free->destroy here.
3869
3870 $RELOAD_WATCHER ||= cf::async {
3871 Coro::AIO::aio_wait cache_extensions;
3872
3873 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3874 do_reload_perl;
3875 undef $RELOAD_WATCHER;
3876 };
3877 };
3878}
3879
3880register_command "reload" => sub {
3881 my ($who, $arg) = @_;
3882
3883 if ($who->flag (FLAG_WIZ)) {
3884 $who->message ("reloading server.");
3885 async {
3886 $Coro::current->{desc} = "perl_reload";
3887 reload_perl;
3888 };
3889 }
3890};
700 3891
701unshift @INC, $LIBDIR; 3892unshift @INC, $LIBDIR;
702 3893
703load_extensions; 3894my $bug_warning = 0;
704 3895
705$TICK_WATCHER = Event->timer ( 3896our @WAIT_FOR_TICK;
706 prio => 1, 3897our @WAIT_FOR_TICK_BEGIN;
707 at => $NEXT_TICK || 1, 3898
708 cb => sub { 3899sub wait_for_tick {
3900 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3901
3902 my $signal = new Coro::Signal;
3903 push @WAIT_FOR_TICK, $signal;
3904 $signal->wait;
3905}
3906
3907sub wait_for_tick_begin {
3908 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3909
3910 my $signal = new Coro::Signal;
3911 push @WAIT_FOR_TICK_BEGIN, $signal;
3912 $signal->wait;
3913}
3914
3915sub tick {
3916 if ($Coro::current != $Coro::main) {
3917 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3918 unless ++$bug_warning > 10;
3919 return;
3920 }
3921
709 cf::server_tick; # one server iteration 3922 cf::server_tick; # one server iteration
710 3923
711 my $NOW = Event::time; 3924 #for(1..3e6){} EV::now_update; $NOW=EV::now; # generate load #d#
712 $NEXT_TICK += $TICK;
713 3925
714 # if we are delayed by four ticks, skip them all 3926 if ($NOW >= $NEXT_RUNTIME_WRITE) {
715 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 3927 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
716 3928 Coro::async_pool {
717 $TICK_WATCHER->at ($NEXT_TICK); 3929 $Coro::current->{desc} = "runtime saver";
718 $TICK_WATCHER->start; 3930 write_runtime_sync
3931 or warn "ERROR: unable to write runtime file: $!";
3932 };
719 }, 3933 }
720); 3934
3935 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3936 $sig->send;
3937 }
3938 while (my $sig = shift @WAIT_FOR_TICK) {
3939 $sig->send;
3940 }
3941
3942 $LOAD = ($NOW - $TICK_START) / $TICK;
3943 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3944
3945 if (0) {
3946 if ($NEXT_TICK) {
3947 my $jitter = $TICK_START - $NEXT_TICK;
3948 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3949 warn "jitter $JITTER\n";#d#
3950 }
3951 }
3952}
3953
3954{
3955 # configure BDB
3956
3957 BDB::min_parallel 16;
3958 BDB::max_poll_reqs $TICK * 0.1;
3959 $AnyEvent::BDB::WATCHER->priority (1);
3960
3961 unless ($DB_ENV) {
3962 $DB_ENV = BDB::db_env_create;
3963 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3964 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3965 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3966 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3967 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3968
3969 cf::sync_job {
3970 eval {
3971 BDB::db_env_open
3972 $DB_ENV,
3973 $BDBDIR,
3974 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3975 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3976 0666;
3977
3978 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3979 };
3980
3981 cf::cleanup "db_env_open(db): $@" if $@;
3982 };
3983 }
3984
3985 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3986 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3987 };
3988 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3989 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3990 };
3991 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3992 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3993 };
3994}
3995
3996{
3997 # configure IO::AIO
3998
3999 IO::AIO::min_parallel 8;
4000 IO::AIO::max_poll_time $TICK * 0.1;
4001 undef $AnyEvent::AIO::WATCHER;
4002}
4003
4004my $_log_backtrace;
4005
4006sub _log_backtrace {
4007 my ($msg, @addr) = @_;
4008
4009 $msg =~ s/\n//;
4010
4011 # limit the # of concurrent backtraces
4012 if ($_log_backtrace < 2) {
4013 ++$_log_backtrace;
4014 my $perl_bt = Carp::longmess $msg;
4015 async {
4016 $Coro::current->{desc} = "abt $msg";
4017
4018 my @bt = fork_call {
4019 @addr = map { sprintf "%x", $_ } @addr;
4020 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4021 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4022 or die "addr2line: $!";
4023
4024 my @funcs;
4025 my @res = <$fh>;
4026 chomp for @res;
4027 while (@res) {
4028 my ($func, $line) = splice @res, 0, 2, ();
4029 push @funcs, "[$func] $line";
4030 }
4031
4032 @funcs
4033 };
4034
4035 LOG llevInfo, "[ABT] $perl_bt\n";
4036 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4037 LOG llevInfo, "[ABT] $_\n" for @bt;
4038 --$_log_backtrace;
4039 };
4040 } else {
4041 LOG llevInfo, "[ABT] $msg\n";
4042 LOG llevInfo, "[ABT] [suppressed]\n";
4043 }
4044}
4045
4046# load additional modules
4047require "cf/$_.pm" for @EXTRA_MODULES;
4048cf::_connect_to_perl_2;
4049
4050END { cf::emergency_save }
721 4051
7221 40521
723 4053

Diff Legend

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