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.499 by root, Sun Jan 10 17:43:46 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines