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.102 by root, Wed Dec 27 15:20:54 2006 UTC vs.
Revision 1.529 by root, Wed Apr 28 11:28:22 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines