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.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.569 by root, Wed May 4 07:36:40 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines