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.73 by root, Sun Oct 1 11:46:51 2006 UTC vs.
Revision 1.544 by root, Thu May 6 21:58:07 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines