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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.476 by root, Wed Sep 2 16:54:20 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines