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.113 by root, Mon Jan 1 15:32:40 2007 UTC vs.
Revision 1.568 by root, Tue May 3 17:12:14 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
202 if ($Coro::current == $Coro::main) { 601 if (in_main) {
602 my $time = AE::time;
603
203 # this is the main coro, too bad, we have to block 604 # this is the main coro, too bad, we have to block
204 # till the operation succeeds, freezing the server :/ 605 # till the operation succeeds, freezing the server :/
205 606
206 # TODO: use suspend/resume instead 607 #LOG llevError, Carp::longmess "sync job";#d#
207 # (but this is cancel-safe) 608
208 local $FREEZE = 1; 609 my $freeze_guard = freeze_mainloop;
209 610
210 my $busy = 1; 611 my $busy = 1;
211 my @res; 612 my @res;
212 613
213 (Coro::async { 614 (async {
615 $Coro::current->desc ("sync job coro");
214 @res = eval { $job->() }; 616 @res = eval { $job->() };
215 warn $@ if $@; 617 error $@ if $@;
216 undef $busy; 618 undef $busy;
217 })->prio (Coro::PRIO_MAX); 619 })->prio (Coro::PRIO_MAX);
218 620
219 while ($busy) { 621 while ($busy) {
622 if (Coro::nready) {
220 Coro::cede_notself; 623 Coro::cede_notself;
221 Event::one_event unless Coro::nready; 624 } else {
625 EV::loop EV::LOOP_ONESHOT;
222 } 626 }
627 }
628
629 my $time = AE::time - $time;
630
631 $TICK_START += $time; # do not account sync jobs to server load
223 632
224 wantarray ? @res : $res[0] 633 wantarray ? @res : $res[0]
225 } else { 634 } else {
226 # we are in another coroutine, how wonderful, everything just works 635 # we are in another coroutine, how wonderful, everything just works
227 636
228 $job->() 637 $job->()
229 } 638 }
230} 639}
231 640
232=item $coro = cf::coro { BLOCK } 641=item $coro = cf::async_ext { BLOCK }
233 642
234Creates and returns a new coro. This coro is automcatially being canceled 643Like async, but this coro is automatically being canceled when the
235when the extension calling this is being unloaded. 644extension calling this is being unloaded.
236 645
237=cut 646=cut
238 647
239sub coro(&) { 648sub async_ext(&) {
240 my $cb = shift; 649 my $cb = shift;
241 650
242 my $coro; $coro = async { 651 my $coro = &Coro::async ($cb);
243 eval {
244 $cb->();
245 };
246 warn $@ if $@;
247 };
248 652
249 $coro->on_destroy (sub { 653 $coro->on_destroy (sub {
250 delete $EXT_CORO{$coro+0}; 654 delete $EXT_CORO{$coro+0};
251 }); 655 });
252 $EXT_CORO{$coro+0} = $coro; 656 $EXT_CORO{$coro+0} = $coro;
253 657
254 $coro 658 $coro
255} 659}
256 660
257sub write_runtime { 661=item fork_call { }, @args
258 my $runtime = cf::localdir . "/runtime";
259 662
260 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 663Executes the given code block with the given arguments in a seperate
261 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.
262 667
263 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 668=cut
264 (aio_write $fh, 0, (length $value), $value, 0) <= 0
265 and return;
266 669
267 aio_fsync $fh 670sub post_fork {
268 and return; 671 reset_signals;
672}
269 673
270 close $fh 674sub fork_call(&@) {
271 or return; 675 my ($cb, @args) = @_;
272 676
273 aio_rename "$runtime~", $runtime 677 # we seemingly have to make a local copy of the whole thing,
274 and return; 678 # otherwise perl prematurely frees the stuff :/
679 # TODO: investigate and fix (likely this will be rather laborious)
275 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 {
276 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 });
277} 864}
278 865
279=back 866=back
280 867
281=cut 868=cut
282 869
283############################################################################# 870#############################################################################
284 871
285package cf::path;
286
287sub new {
288 my ($class, $path, $base) = @_;
289
290 $path = $path->as_string if ref $path;
291
292 my $self = bless { }, $class;
293
294 if ($path =~ s{^\?random/}{}) {
295 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
296 $self->{random} = cf::from_json $data;
297 } else {
298 if ($path =~ s{^~([^/]+)?}{}) {
299 $self->{user_rel} = 1;
300
301 if (defined $1) {
302 $self->{user} = $1;
303 } elsif ($base =~ m{^~([^/]+)/}) {
304 $self->{user} = $1;
305 } else {
306 warn "cannot resolve user-relative path without user <$path,$base>\n";
307 }
308 } elsif ($path =~ /^\//) {
309 # already absolute
310 } else {
311 $base =~ s{[^/]+/?$}{};
312 return $class->new ("$base/$path");
313 }
314
315 for ($path) {
316 redo if s{/\.?/}{/};
317 redo if s{/[^/]+/\.\./}{/};
318 }
319 }
320
321 $self->{path} = $path;
322
323 $self
324}
325
326# the name / primary key / in-game path
327sub as_string {
328 my ($self) = @_;
329
330 $self->{user_rel} ? "~$self->{user}$self->{path}"
331 : $self->{random} ? "?random/$self->{path}"
332 : $self->{path}
333}
334
335# the displayed name, this is a one way mapping
336sub visible_name {
337 my ($self) = @_;
338
339# if (my $rmp = $self->{random}) {
340# # todo: be more intelligent about this
341# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
342# } else {
343 $self->as_string
344# }
345}
346
347# escape the /'s in the path
348sub _escaped_path {
349 # ∕ is U+2215
350 (my $path = $_[0]{path}) =~ s/\//∕/g;
351 $path
352}
353
354# the original (read-only) location
355sub load_path {
356 my ($self) = @_;
357
358 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
359}
360
361# the temporary/swap location
362sub save_path {
363 my ($self) = @_;
364
365 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
366 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
367 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
368}
369
370# the unique path, might be eq to save_path
371sub uniq_path {
372 my ($self) = @_;
373
374 $self->{user_rel} || $self->{random}
375 ? undef
376 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
377}
378
379# return random map parameters, or undef
380sub random_map_params {
381 my ($self) = @_;
382
383 $self->{random}
384}
385
386# this is somewhat ugly, but style maps do need special treatment
387sub is_style_map {
388 $_[0]{path} =~ m{^/styles/}
389}
390
391package cf;
392
393#############################################################################
394
395=head2 ATTACHABLE OBJECTS 872=head2 ATTACHABLE OBJECTS
396 873
397Many 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
398attach callbacks/event handlers (a collection of which is called an "attachment") 875attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 876to it. All such attachable objects support the following methods.
400 877
401In 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>
402C<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
403crossfire+). 880Deliantra).
404 881
405=over 4 882=over 4
406 883
407=item $attachable->attach ($attachment, key => $value...) 884=item $attachable->attach ($attachment, key => $value...)
408 885
452=item cf::CLASS::attachment $name, ... 929=item cf::CLASS::attachment $name, ...
453 930
454Register an attachment by C<$name> through which attachable objects of the 931Register an attachment by C<$name> through which attachable objects of the
455given CLASS can refer to this attachment. 932given CLASS can refer to this attachment.
456 933
457Some classes such as crossfire maps and objects can specify attachments 934Some classes such as deliantra maps and objects can specify attachments
458that 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.
459 936
460These calls expect any number of the following handler/hook descriptions: 937These calls expect any number of the following handler/hook descriptions:
461 938
462=over 4 939=over 4
522our @CB_TYPE = (); # registry for type (cf-object class) based events 999our @CB_TYPE = (); # registry for type (cf-object class) based events
523our @CB_MAP = (); 1000our @CB_MAP = ();
524 1001
525my %attachment; 1002my %attachment;
526 1003
1004sub cf::attachable::thawer_merge {
1005 # simply override everything except _meta
1006 local $_[0]{_meta};
1007 %{$_[0]} = %{$_[1]};
1008}
1009
527sub _attach_cb($$$$) { 1010sub _attach_cb($$$$) {
528 my ($registry, $event, $prio, $cb) = @_; 1011 my ($registry, $event, $prio, $cb) = @_;
529 1012
530 use sort 'stable'; 1013 use sort 'stable';
531 1014
565 $registry = $CB_TYPE[$object_type] ||= []; 1048 $registry = $CB_TYPE[$object_type] ||= [];
566 1049
567 } elsif ($type eq "subtype") { 1050 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 1051 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 1052 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 1053 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 1054
572 } elsif ($type eq "package") { 1055 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 1056 my $pkg = shift @arg;
574 1057
575 while (my ($name, $id) = each %cb_id) { 1058 while (my ($name, $id) = each %cb_id) {
580 1063
581 } elsif (exists $cb_id{$type}) { 1064 } elsif (exists $cb_id{$type}) {
582 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 1065 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
583 1066
584 } elsif (ref $type) { 1067 } elsif (ref $type) {
585 warn "attaching objects not supported, ignoring.\n"; 1068 error "attaching objects not supported, ignoring.\n";
586 1069
587 } else { 1070 } else {
588 shift @arg; 1071 shift @arg;
589 warn "attach argument '$type' not supported, ignoring.\n"; 1072 error "attach argument '$type' not supported, ignoring.\n";
590 } 1073 }
591 } 1074 }
592} 1075}
593 1076
594sub _object_attach { 1077sub _object_attach {
604 _attach $registry, $klass, @attach; 1087 _attach $registry, $klass, @attach;
605 } 1088 }
606 1089
607 $obj->{$name} = \%arg; 1090 $obj->{$name} = \%arg;
608 } else { 1091 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 1092 info "object uses attachment '$name' which is not available, postponing.\n";
610 } 1093 }
611 1094
612 $obj->{_attachment}{$name} = undef; 1095 $obj->{_attachment}{$name} = undef;
613} 1096}
614 1097
616 if (ref $_[0]) { 1099 if (ref $_[0]) {
617 _object_attach @_; 1100 _object_attach @_;
618 } else { 1101 } else {
619 _attach shift->_attach_registry, @_; 1102 _attach shift->_attach_registry, @_;
620 } 1103 }
1104 _recalc_want;
621}; 1105};
622 1106
623# all those should be optimised 1107# all those should be optimised
624sub cf::attachable::detach { 1108sub cf::attachable::detach {
625 my ($obj, $name) = @_; 1109 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 1112 delete $obj->{_attachment}{$name};
629 reattach ($obj); 1113 reattach ($obj);
630 } else { 1114 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 1115 Carp::croak "cannot, currently, detach class attachments";
632 } 1116 }
1117 _recalc_want;
633}; 1118};
634 1119
635sub cf::attachable::attached { 1120sub cf::attachable::attached {
636 my ($obj, $name) = @_; 1121 my ($obj, $name) = @_;
637 1122
652 "; 1137 ";
653 die if $@; 1138 die if $@;
654} 1139}
655 1140
656our $override; 1141our $override;
657our @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?
658 1143
659sub override { 1144sub override {
660 $override = 1; 1145 $override = 1;
661 @invoke_results = (); 1146 @INVOKE_RESULTS = (@_);
662} 1147}
663 1148
664sub do_invoke { 1149sub do_invoke {
665 my $event = shift; 1150 my $event = shift;
666 my $callbacks = shift; 1151 my $callbacks = shift;
667 1152
668 @invoke_results = (); 1153 @INVOKE_RESULTS = ();
669 1154
670 local $override; 1155 local $override;
671 1156
672 for (@$callbacks) { 1157 for (@$callbacks) {
673 eval { &{$_->[1]} }; 1158 eval { &{$_->[1]} };
674 1159
675 if ($@) { 1160 if ($@) {
676 warn "$@";
677 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1161 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
678 override; 1162 override;
679 } 1163 }
680 1164
681 return 1 if $override; 1165 return 1 if $override;
682 } 1166 }
683 1167
684 0 1168 0
685} 1169}
686 1170
687=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1171=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688 1172
689=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1173=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690 1174
691Generate an object-specific event with the given arguments. 1175Generate an object-specific event with the given arguments.
692 1176
693This 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
694removed 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
695results (if you must, access C<@cf::invoke_results> directly). 1179results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 1180
697=back 1181=back
698 1182
699=cut 1183=cut
700 1184
701############################################################################# 1185#############################################################################
702# 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}
703 1229
704sub reattach { 1230sub reattach {
705 # basically do the same as instantiate, without calling instantiate 1231 # basically do the same as instantiate, without calling instantiate
706 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
707 1236
708 my $registry = $obj->registry; 1237 my $registry = $obj->registry;
709 1238
710 @$registry = (); 1239 @$registry = ();
711 1240
716 for (@$attach) { 1245 for (@$attach) {
717 my ($klass, @attach) = @$_; 1246 my ($klass, @attach) = @$_;
718 _attach $registry, $klass, @attach; 1247 _attach $registry, $klass, @attach;
719 } 1248 }
720 } else { 1249 } else {
721 warn "object uses attachment '$name' that is not available, postponing.\n"; 1250 info "object uses attachment '$name' that is not available, postponing.\n";
722 } 1251 }
723 } 1252 }
724} 1253}
725 1254
726cf::attachable->attach ( 1255cf::attachable->attach (
727 prio => -1000000, 1256 prio => -1000000,
728 on_instantiate => sub { 1257 on_instantiate => sub {
729 my ($obj, $data) = @_; 1258 my ($obj, $data) = @_;
730 1259
731 $data = from_json $data; 1260 $data = decode_json $data;
732 1261
733 for (@$data) { 1262 for (@$data) {
734 my ($name, $args) = @$_; 1263 my ($name, $args) = @$_;
735 1264
736 $obj->attach ($name, %{$args || {} }); 1265 $obj->attach ($name, %{$args || {} });
752sub object_freezer_save { 1281sub object_freezer_save {
753 my ($filename, $rdata, $objs) = @_; 1282 my ($filename, $rdata, $objs) = @_;
754 1283
755 sync_job { 1284 sync_job {
756 if (length $$rdata) { 1285 if (length $$rdata) {
1286 utf8::decode (my $decname = $filename);
757 warn sprintf "saving %s (%d,%d)\n", 1287 trace sprintf "saving %s (%d,%d)\n",
758 $filename, length $$rdata, scalar @$objs; 1288 $decname, length $$rdata, scalar @$objs
1289 if $VERBOSE_IO;
759 1290
760 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1291 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
761 chmod SAVE_MODE, $fh; 1292 aio_chmod $fh, SAVE_MODE;
762 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;
763 aio_fsync $fh; 1296 aio_fsync $fh;
1297 }
764 close $fh; 1298 aio_close $fh;
765 1299
766 if (@$objs) { 1300 if (@$objs) {
767 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) {
768 chmod SAVE_MODE, $fh; 1302 aio_chmod $fh, SAVE_MODE;
769 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1303 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
770 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;
771 aio_fsync $fh; 1307 aio_fsync $fh;
1308 }
772 close $fh; 1309 aio_close $fh;
773 aio_rename "$filename.pst~", "$filename.pst"; 1310 aio_rename "$filename.pst~", "$filename.pst";
774 } 1311 }
775 } else { 1312 } else {
776 aio_unlink "$filename.pst"; 1313 aio_unlink "$filename.pst";
777 } 1314 }
778 1315
779 aio_rename "$filename~", $filename; 1316 aio_rename "$filename~", $filename;
1317
1318 $filename =~ s%/[^/]+$%%;
1319 aio_pathsync $filename if $cf::USE_FSYNC;
780 } else { 1320 } else {
781 warn "FATAL: $filename~: $!\n"; 1321 error "unable to save objects: $filename~: $!\n";
782 } 1322 }
783 } else { 1323 } else {
784 aio_unlink $filename; 1324 aio_unlink $filename;
785 aio_unlink "$filename.pst"; 1325 aio_unlink "$filename.pst";
786 } 1326 }
787 } 1327 };
788} 1328}
789 1329
790sub object_freezer_as_string { 1330sub object_freezer_as_string {
791 my ($rdata, $objs) = @_; 1331 my ($rdata, $objs) = @_;
792 1332
804 or return; 1344 or return;
805 1345
806 unless (aio_stat "$filename.pst") { 1346 unless (aio_stat "$filename.pst") {
807 (aio_load "$filename.pst", $av) >= 0 1347 (aio_load "$filename.pst", $av) >= 0
808 or return; 1348 or return;
1349
809 $av = eval { (Storable::thaw $av)->{objs} }; 1350 my $st = eval { Coro::Storable::thaw $av };
1351 $av = $st->{objs};
810 } 1352 }
811 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
812 return ($data, $av); 1359 ($data, $av)
813} 1360}
1361
1362=head2 COMMAND CALLBACKS
1363
1364=over 4
1365
1366=cut
814 1367
815############################################################################# 1368#############################################################################
816# command handling &c 1369# command handling &c
817 1370
818=item cf::register_command $name => \&callback($ob,$args); 1371=item cf::register_command $name => \&callback($ob,$args);
831 push @{ $COMMAND{$name} }, [$caller, $cb]; 1384 push @{ $COMMAND{$name} }, [$caller, $cb];
832} 1385}
833 1386
834=item cf::register_extcmd $name => \&callback($pl,$packet); 1387=item cf::register_extcmd $name => \&callback($pl,$packet);
835 1388
836Register 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.
837 1394
838If 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
839called. 1396called.
840 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
841=cut 1409=cut
842 1410
843sub register_extcmd { 1411sub register_extcmd {
844 my ($name, $cb) = @_; 1412 my ($name, $cb) = @_;
845 1413
846 my $caller = caller;
847 #warn "registering extcmd '$name' to '$caller'";
848
849 $EXTCMD{$name} = [$cb, $caller]; 1414 $EXTCMD{$name} = $cb;
850} 1415}
1416
1417sub register_exticmd {
1418 my ($name, $cb) = @_;
1419
1420 $EXTICMD{$name} = $cb;
1421}
1422
1423use File::Glob ();
851 1424
852cf::player->attach ( 1425cf::player->attach (
853 on_command => sub { 1426 on_unknown_command => sub {
854 my ($pl, $name, $params) = @_; 1427 my ($pl, $name, $params) = @_;
855 1428
856 my $cb = $COMMAND{$name} 1429 my $cb = $COMMAND{$name}
857 or return; 1430 or return;
858 1431
863 cf::override; 1436 cf::override;
864 }, 1437 },
865 on_extcmd => sub { 1438 on_extcmd => sub {
866 my ($pl, $buf) = @_; 1439 my ($pl, $buf) = @_;
867 1440
868 my $msg = eval { from_json $buf }; 1441 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
869 1442
870 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
871 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1451 if (my $cb = $EXTCMD{$type}) {
872 if (my %reply = $cb->[0]->($pl, $msg)) { 1452 @reply = $cb->($pl, @payload);
873 $pl->ext_reply ($msg->{msgid}, %reply);
874 }
875 } 1453 }
1454
1455 $pl->ext_reply ($reply, @reply)
1456 if $reply;
1457
876 } else { 1458 } else {
877 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1459 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
878 } 1460 }
879 1461
880 cf::override; 1462 cf::override;
881 }, 1463 },
882); 1464);
883 1465
884sub register { 1466# "readahead" all extensions
885 my ($base, $pkg) = @_;
886
887 #TODO
888}
889
890sub load_extension { 1467sub cache_extensions {
891 my ($path) = @_; 1468 my $grp = IO::AIO::aio_group;
892 1469
893 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1470 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
894 my $base = $1; 1471 for (grep /\.ext$/, @{$_[0]}) {
895 my $pkg = $1; 1472 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
896 $pkg =~ s/[^[:word:]]/_/g;
897 $pkg = "ext::$pkg";
898
899 warn "loading '$path' into '$pkg'\n";
900
901 open my $fh, "<:utf8", $path
902 or die "$path: $!";
903
904 my $source =
905 "package $pkg; use strict; use utf8;\n"
906 . "#line 1 \"$path\"\n{\n"
907 . (do { local $/; <$fh> })
908 . "\n};\n1";
909
910 eval $source
911 or die $@ ? "$path: $@\n"
912 : "extension disabled.\n";
913
914 push @exts, $pkg;
915 $ext_pkg{$base} = $pkg;
916
917# no strict 'refs';
918# @{"$pkg\::ISA"} = ext::;
919
920 register $base, $pkg;
921}
922
923sub unload_extension {
924 my ($pkg) = @_;
925
926 warn "removing extension $pkg\n";
927
928 # remove hooks
929 #TODO
930# for my $idx (0 .. $#PLUGIN_EVENT) {
931# delete $hook[$idx]{$pkg};
932# }
933
934 # remove commands
935 for my $name (keys %COMMAND) {
936 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
937
938 if (@cb) {
939 $COMMAND{$name} = \@cb;
940 } else {
941 delete $COMMAND{$name};
942 } 1473 }
943 } 1474 };
944 1475
945 # remove extcmds 1476 $grp
946 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
947 delete $EXTCMD{$name};
948 }
949
950 if (my $cb = $pkg->can ("unload")) {
951 eval {
952 $cb->($pkg);
953 1
954 } or warn "$pkg unloaded, but with errors: $@";
955 }
956
957 Symbol::delete_package $pkg;
958} 1477}
959 1478
960sub load_extensions { 1479sub load_extensions {
1480 info "loading extensions...";
1481
1482 cf::sync_job {
1483 my %todo;
1484
961 for my $ext (<$LIBDIR/*.ext>) { 1485 for my $path (<$LIBDIR/*.ext>) {
962 next unless -r $ext; 1486 next unless -r $path;
963 eval { 1487
964 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 }
965 1 1551 }
966 } 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 }
967 } 1564 };
968} 1565}
969 1566
970############################################################################# 1567#############################################################################
971# load/save/clean perl data associated with a map
972 1568
973*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($) {
974 my ($map) = @_; 1623 my ($login) = @_;
975 1624
976 my $path = $map->tmpname; 1625 $cf::PLAYER{$login}
977 defined $path or return; 1626 or !aio_stat path $login
978
979 unlink "$path.pst";
980};
981
982cf::map->attach (prio => -10000, package => cf::mapsupport::);
983
984#############################################################################
985# load/save perl data associated with player->ob objects
986
987sub all_objects(@) {
988 @_, map all_objects ($_->inv), @_
989} 1627}
990 1628
991# 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
992cf::player->attach ( 1656cf::player->attach (
993 on_load => sub { 1657 on_load => sub {
994 my ($pl, $path) = @_; 1658 my ($pl, $path) = @_;
995 1659
996 for my $o (all_objects $pl->ob) { 1660 # restore slots saved in save, below
997 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1661 my $slots = delete $pl->{_slots};
998 $o->set_ob_key_value ("_perl_data");
999 1662
1000 %$o = %{ Storable::thaw pack "H*", $value }; 1663 $pl->ob->current_weapon ($slots->[0]);
1001 } 1664 $pl->combat_ob ($slots->[1]);
1002 } 1665 $pl->ranged_ob ($slots->[2]);
1003 }, 1666 },
1004); 1667);
1005 1668
1006############################################################################# 1669sub save($) {
1670 my ($pl) = @_;
1007 1671
1008=head2 CORE EXTENSIONS 1672 return if $pl->{deny_save};
1009 1673
1010Functions and methods that extend core crossfire objects. 1674 my $path = path $pl;
1675 my $guard = cf::lock_acquire "user_save:$path";
1011 1676
1012=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
1013 1856
1014=over 4 1857=over 4
1015 1858
1016=item cf::player::exists $login
1017
1018Returns true when the given account exists.
1019
1020=cut 1859=cut
1021 1860
1022sub cf::player::exists($) { 1861package cf::region;
1023 cf::player::find $_[0]
1024 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1025}
1026 1862
1027=item $player->ext_reply ($msgid, $msgtype, %msg) 1863=item cf::region::find_by_path $path
1028 1864
1029Sends an ext reply to the player. 1865Tries to decuce the likely region for a map knowing only its path.
1030 1866
1031=cut 1867=cut
1032 1868
1033sub cf::player::ext_reply($$$%) { 1869sub find_by_path($) {
1034 my ($self, $id, %msg) = @_; 1870 my ($path) = @_;
1035 1871
1036 $msg{msgid} = $id; 1872 $path =~ s/^~[^\/]*//; # skip ~login
1037 1873
1038 $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
1039} 1884}
1040 1885
1041=back 1886=back
1042
1043 1887
1044=head3 cf::map 1888=head3 cf::map
1045 1889
1046=over 4 1890=over 4
1047 1891
1050package cf::map; 1894package cf::map;
1051 1895
1052use Fcntl; 1896use Fcntl;
1053use Coro::AIO; 1897use Coro::AIO;
1054 1898
1899use overload
1900 '""' => \&as_string,
1901 fallback => 1;
1902
1055our $MAX_RESET = 7200; 1903our $MAX_RESET = 3600;
1056our $DEFAULT_RESET = 3600; 1904our $DEFAULT_RESET = 3000;
1057 1905
1058sub 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 {
1059 my ($path, $rmp) = @_; 1945 my ($path, $base) = @_;
1060 1946
1061 # mit "rum" bekleckern, nicht 1947 $path = "$path"; # make sure it's a string
1062 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
1063 $path, 1976 $path
1064 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1065 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1066 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1067 $rmp->{exit_on_final_map},
1068 $rmp->{xsize}, $rmp->{ysize},
1069 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1070 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1071 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1072 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1073 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1074 (cf::region::find $rmp->{region})
1075} 1977}
1076 1978
1077# and all this just because we cannot iterate over 1979sub new_from_path {
1078# all maps in C++... 1980 my (undef, $path, $base) = @_;
1079sub 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 {
1080 my ($change) = @_; 2001 my ($self) = @_;
1081 2002
1082 $_->change_map_light ($change) for values %cf::MAP; 2003 $self
1083} 2004}
1084 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
1085sub try_load_header($) { 2056sub load_header_from($) {
1086 my ($path) = @_; 2057 my ($self, $path) = @_;
1087 2058
1088 utf8::encode $path; 2059 utf8::encode $path;
1089 aio_open $path, O_RDONLY, 0 2060 my $f = new_from_file cf::object::thawer $path
1090 or return; 2061 or return;
1091 2062
1092 my $map = cf::map::new 2063 $self->_load_header ($f)
1093 or return; 2064 or return;
1094 2065
1095 $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
1096 or return; 2116 or return;
2117 $self->prepare_orig;
2118 }
1097 2119
1098 $map->{load_path} = $path; 2120 $self->{deny_reset} = 1
2121 if $self->no_reset;
1099 2122
1100 $map 2123 $self->default_region (cf::region::find_by_path $self->{path})
1101} 2124 unless $self->default_region;
1102 2125
2126 1
2127}
2128
2129sub find;
1103sub find_map { 2130sub find {
1104 my ($path, $origin) = @_; 2131 my ($path, $origin) = @_;
1105 2132
1106 #warn "find_map<$path,$origin>\n";#d# 2133 cf::cede_to_tick;
1107 2134
1108 $path = new cf::path $path, $origin && $origin->path; 2135 $path = normalise $path, $origin;
1109 my $key = $path->as_string;
1110 2136
2137 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
2138 my $guard2 = cf::lock_acquire "map_find:$path";
2139
1111 $cf::MAP{$key} || do { 2140 $cf::MAP{$path} || do {
1112 # do it the slow way 2141 my $map = new_from_path cf::map $path
1113 my $map = try_load_header $path->save_path;
1114
1115 if ($map) {
1116 # safety
1117 $map->{instantiate_time} = $cf::RUNTIME
1118 if $map->{instantiate_time} > $cf::RUNTIME;
1119 } else {
1120 if (my $rmp = $path->random_map_params) {
1121 $map = generate_random_map $key, $rmp;
1122 } else {
1123 $map = try_load_header $path->load_path;
1124 }
1125
1126 $map or return; 2142 or return;
1127 2143
1128 $map->{load_original} = 1;
1129 $map->{instantiate_time} = $cf::RUNTIME;
1130 $map->instantiate;
1131
1132 # per-player maps become, after loading, normal maps
1133 $map->per_player (0) if $path->{user_rel};
1134 }
1135
1136 $map->path ($key);
1137 $map->{path} = $path;
1138 $map->last_access ($cf::RUNTIME); 2144 $map->{last_save} = $cf::RUNTIME;
1139 2145
1140 if ($map->should_reset) { 2146 $map->load_header
2147 or return;
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;
1141 $map->reset; 2154 $map->reset;
1142 $map = find_map $path; 2155 return find $path;
1143 } 2156 }
1144 2157
1145 $cf::MAP{$key} = $map 2158 $cf::MAP{$path} = $map
1146 } 2159 }
1147} 2160}
2161
2162sub pre_load { }
2163#sub post_load { } # XS
1148 2164
1149sub load { 2165sub load {
1150 my ($self) = @_; 2166 my ($self) = @_;
1151 2167
1152 return if $self->in_memory != cf::MAP_SWAPPED; 2168 local $self->{deny_reset} = 1; # loading can take a long time
1153
1154 $self->in_memory (cf::MAP_LOADING);
1155 2169
1156 my $path = $self->{path}; 2170 my $path = $self->{path};
1157 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
2178 $self->in_memory (cf::MAP_LOADING);
2179
1158 $self->alloc; 2180 $self->alloc;
1159 $self->load_objects ($self->{load_path}, 1) 2181
2182 $self->pre_load;
2183 cf::cede_to_tick;
2184
2185 if (exists $self->{load_path}) {
2186 my $f = new_from_file cf::object::thawer $self->{load_path};
2187 $f->skip_block;
2188 $self->_load_objects ($f)
1160 or return; 2189 or return;
1161 2190
1162 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2191 $self->post_load_original
1163 if delete $self->{load_original}; 2192 if delete $self->{load_original};
1164 2193
1165 if (my $uniq = $path->uniq_path) { 2194 if (my $uniq = $self->uniq_path) {
1166 utf8::encode $uniq; 2195 utf8::encode $uniq;
1167 if (aio_open $uniq, O_RDONLY, 0) { 2196 unless (aio_stat $uniq) {
2197 if (my $f = new_from_file cf::object::thawer $uniq) {
1168 $self->clear_unique_items; 2198 $self->clear_unique_items;
1169 $self->load_objects ($uniq, 0); 2199 $self->_load_objects ($f);
2200 $f->resolve_delayed_derefs;
2201 }
2202 }
1170 } 2203 }
1171 }
1172 2204
2205 $f->resolve_delayed_derefs;
2206 } else {
2207 $self->post_load_original
2208 if delete $self->{load_original};
2209 }
2210
2211 cf::cede_to_tick;
1173 # now do the right thing for maps 2212 # now do the right thing for maps
1174 $self->link_multipart_objects; 2213 $self->link_multipart_objects;
1175
1176 if ($self->{path}->is_style_map) {
1177 $self->{deny_save} = 1;
1178 $self->{deny_reset} = 1;
1179 } else {
1180 $self->fix_auto_apply;
1181 $self->decay_objects;
1182 $self->update_buttons;
1183 $self->set_darkness_map;
1184 $self->difficulty ($self->estimate_difficulty) 2214 $self->difficulty ($self->estimate_difficulty)
1185 unless $self->difficulty; 2215 unless $self->difficulty;
1186 $self->activate; 2216 cf::cede_to_tick;
1187 }
1188 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
1189 $self->in_memory (cf::MAP_IN_MEMORY); 2229 $self->in_memory (cf::MAP_ACTIVE);
1190} 2230 }
1191 2231
1192sub load_map_sync { 2232 $self->post_load;
2233
2234 1
2235}
2236
2237# customize the map for a given player, i.e.
2238# return the _real_ map. used by e.g. per-player
2239# maps to change the path to ~playername/mappath
2240sub customise_for {
2241 my ($self, $ob) = @_;
2242
2243 return find "~" . $ob->name . "/" . $self->{path}
2244 if $self->per_player;
2245
2246# return find "?party/" . $ob->name . "/" . $self->{path}
2247# if $self->per_party;
2248
2249 $self
2250}
2251
2252# find and load all maps in the 3x3 area around a map
2253sub load_neighbours {
2254 my ($map) = @_;
2255
2256 my @neigh; # diagonal neighbours
2257
2258 for (0 .. 3) {
2259 my $neigh = $map->tile_path ($_)
2260 or next;
2261 $neigh = find $neigh, $map
2262 or next;
2263 $neigh->load;
2264
2265 # now find the diagonal neighbours
2266 push @neigh,
2267 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2268 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2269 }
2270
2271 for (grep defined $_->[0], @neigh) {
2272 my ($path, $origin) = @$_;
2273 my $neigh = find $path, $origin
2274 or next;
2275 $neigh->load;
2276 }
2277}
2278
2279sub find_sync {
1193 my ($path, $origin) = @_; 2280 my ($path, $origin) = @_;
1194 2281
1195 #warn "load_map_sync<$path, $origin>\n";#d# 2282 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2283 if $Coro::current == $Coro::main;
1196 2284
1197 cf::sync_job { 2285 find $path, $origin
1198 my $map = cf::map::find_map $path, $origin 2286}
1199 or return; 2287
2288sub do_load_sync {
2289 my ($map) = @_;
2290
2291 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2292 if $Coro::current == $Coro::main;
2293
1200 $map->load; 2294 $map->load;
1201 $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->in_memory == cf::MAP_ACTIVE;
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);
1202 } 2359 }
1203} 2360}
1204 2361
1205sub save { 2362sub save {
1206 my ($self) = @_; 2363 my ($self) = @_;
1207 2364
1208 my $save = $self->{path}->save_path; utf8::encode $save; 2365 my $lock = cf::lock_acquire "map_data:$self->{path}";
1209 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1210 2366
1211 $self->{last_save} = $cf::RUNTIME; 2367 $self->_save;
1212
1213 return unless $self->dirty;
1214
1215 $self->{load_path} = $save;
1216
1217 return if $self->{deny_save};
1218
1219 if ($uniq) {
1220 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1221 $self->save_objects ($uniq, cf::IO_UNIQUES);
1222 } else {
1223 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1224 }
1225} 2368}
1226 2369
1227sub swap_out { 2370sub swap_out {
1228 my ($self) = @_; 2371 my ($self) = @_;
1229 2372
2373 my $lock = cf::lock_acquire "map_data:$self->{path}";
2374
2375 return if $self->in_memory != cf::MAP_ACTIVE;
2376 return if $self->{deny_save};
1230 return if $self->players; 2377 return if $self->players;
1231 return if $self->in_memory != cf::MAP_IN_MEMORY;
1232 return if $self->{deny_save};
1233 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
1234 $self->save; 2385 $self->_save;
2386
2387 # then free the map
1235 $self->clear; 2388 $self->clear;
1236 $self->in_memory (cf::MAP_SWAPPED);
1237} 2389}
1238 2390
1239sub reset_at { 2391sub reset_at {
1240 my ($self) = @_; 2392 my ($self) = @_;
1241 2393
1242 # TODO: safety, remove and allow resettable per-player maps 2394 # TODO: safety, remove and allow resettable per-player maps
1243 return 1e100 if $self->{path}{user_rel};
1244 return 1e100 if $self->{deny_reset}; 2395 return 1e99 if $self->{deny_reset};
1245 2396
1246 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2397 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1247 my $to = $self->reset_timeout || $DEFAULT_RESET; 2398 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1248 $to = $MAX_RESET if $to > $MAX_RESET;
1249 2399
1250 $time + $to 2400 $time + $to
1251} 2401}
1252 2402
1253sub should_reset { 2403sub should_reset {
1254 my ($self) = @_; 2404 my ($self) = @_;
1255 2405
1256 $self->reset_at <= $cf::RUNTIME 2406 $self->reset_at <= $cf::RUNTIME
1257} 2407}
1258 2408
1259sub unlink_save {
1260 my ($self) = @_;
1261
1262 utf8::encode (my $save = $self->{path}->save_path);
1263 aioreq_pri 3; IO::AIO::aio_unlink $save;
1264 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1265}
1266
1267sub rename {
1268 my ($self, $new_path) = @_;
1269
1270 $self->unlink_save;
1271
1272 delete $cf::MAP{$self->path};
1273 $self->{path} = new cf::path $new_path;
1274 $self->path ($self->{path}->path);
1275 $cf::MAP{$self->path} = $self;
1276
1277 $self->save;
1278}
1279
1280sub reset { 2409sub reset {
1281 my ($self) = @_; 2410 my ($self) = @_;
1282 2411
2412 my $lock = cf::lock_acquire "map_data:$self->{path}";
2413
1283 return if $self->players; 2414 return if $self->players;
1284 return if $self->{path}{user_rel};#d#
1285 2415
1286 warn "resetting map ", $self->path;#d# 2416 cf::trace "resetting map ", $self->path, "\n";
2417
2418 $self->in_memory (cf::MAP_SWAPPED);
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 }
1287 2427
1288 delete $cf::MAP{$self->path}; 2428 delete $cf::MAP{$self->path};
1289 2429
2430 $self->deactivate;
1290 $_->clear_links_to ($self) for values %cf::MAP; 2431 $_->clear_links_to ($self) for values %cf::MAP;
2432 $self->clear;
1291 2433
1292 $self->unlink_save; 2434 $self->unlink_save;
1293 $self->destroy; 2435 $self->destroy;
1294} 2436}
1295 2437
1296sub customise_for { 2438my $nuke_counter = "aaaa";
1297 my ($map, $ob) = @_;
1298 2439
1299 if ($map->per_player) { 2440sub nuke {
1300 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2441 my ($self) = @_;
2442
1301 } 2443 {
2444 my $lock = cf::lock_acquire "map_data:$self->{path}";
1302 2445
1303 $map 2446 delete $cf::MAP{$self->path};
1304}
1305 2447
1306sub emergency_save { 2448 $self->unlink_save;
1307 local $cf::FREEZE = 1;
1308 2449
1309 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++));
1310 2455
1311 cf::sync_job { 2456 $cf::MAP{$self->path} = $self;
1312 warn "begin emergency map save\n";
1313 $_->save for values %cf::MAP;
1314 }; 2457 }
1315 2458
1316 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 }
1317} 2601}
1318 2602
1319package cf; 2603package cf;
1320 2604
1321=back 2605=back
1322
1323 2606
1324=head3 cf::object::player 2607=head3 cf::object::player
1325 2608
1326=over 4 2609=over 4
1327 2610
1330Sends 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>
1331can 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
1332dialogue with the given NPC character. 2615dialogue with the given NPC character.
1333 2616
1334=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};
1335 2632
1336# rough implementation of a future "reply" method that works 2633# rough implementation of a future "reply" method that works
1337# with dialog boxes. 2634# with dialog boxes.
1338#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
1339sub cf::object::player::reply($$$;$) { 2636sub cf::object::player::reply($$$;$) {
1341 2638
1342 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2639 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1343 2640
1344 if ($self->{record_replies}) { 2641 if ($self->{record_replies}) {
1345 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2642 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2643
1346 } 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 {
1347 $msg = $npc->name . " says: $msg" if $npc; 2652 $msg = $npc->name . " says: $msg" if $npc;
1348 $self->message ($msg, $flags); 2653 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2654 }
1349 } 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 (@_);
1350} 2666}
1351 2667
1352=item $player_object->may ("access") 2668=item $player_object->may ("access")
1353 2669
1354Returns wether the given player is authorized to access resource "access" 2670Returns wether the given player is authorized to access resource "access"
1363 (ref $cf::CFG{"may_$access"} 2679 (ref $cf::CFG{"may_$access"}
1364 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2680 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1365 : $cf::CFG{"may_$access"}) 2681 : $cf::CFG{"may_$access"})
1366} 2682}
1367 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
1368sub cf::object::player::enter_link { 2716sub cf::object::player::enter_link {
1369 my ($self) = @_; 2717 my ($self) = @_;
1370 2718
1371 return if $self->map == $LINK_MAP;
1372
1373 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1374 if $self->map;
1375
1376 $self->enter_map ($LINK_MAP, 20, 20);
1377 $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);
1378} 2729}
1379 2730
1380sub cf::object::player::leave_link { 2731sub cf::object::player::leave_link {
1381 my ($self, $map, $x, $y) = @_; 2732 my ($self, $map, $x, $y) = @_;
1382 2733
2734 return unless $self->contr->active;
2735
1383 my $link_pos = delete $self->{_link_pos}; 2736 my $link_pos = delete $self->{_link_pos};
1384 2737
1385 unless ($map) { 2738 unless ($map) {
1386 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1387
1388 # restore original map position 2739 # restore original map position
1389 ($map, $x, $y) = @{ $link_pos || [] }; 2740 ($map, $x, $y) = @{ $link_pos || [] };
1390 $map = cf::map::find_map $map; 2741 $map = cf::map::find $map;
1391 2742
1392 unless ($map) { 2743 unless ($map) {
1393 ($map, $x, $y) = @$EMERGENCY_POSITION; 2744 ($map, $x, $y) = @$EMERGENCY_POSITION;
1394 $map = cf::map::find_map $map 2745 $map = cf::map::find $map
1395 or die "FATAL: cannot load emergency map\n"; 2746 or die "FATAL: cannot load emergency map\n";
1396 } 2747 }
1397 } 2748 }
1398 2749
1399 ($x, $y) = (-1, -1) 2750 ($x, $y) = (-1, -1)
1400 unless (defined $x) && (defined $y); 2751 unless (defined $x) && (defined $y);
1401 2752
1402 # use -1 or undef as default coordinates, not 0, 0 2753 # use -1 or undef as default coordinates, not 0, 0
1403 ($x, $y) = ($map->enter_x, $map->enter_y) 2754 ($x, $y) = ($map->enter_x, $map->enter_y)
1404 if $x <=0 && $y <= 0; 2755 if $x <= 0 && $y <= 0;
1405 2756
1406 $map->load; 2757 $map->load;
2758 $map->load_neighbours;
1407 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
1408 $self->activate_recursive; 2767 $self->activate_recursive;
1409 $self->enter_map ($map, $x, $y); 2768 }
1410}
1411 2769
1412=item $player_object->goto_map ($map, $x, $y) 2770}
1413 2771
1414=cut 2772=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1415 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
1416sub cf::object::player::goto_map { 2787sub cf::object::player::goto {
1417 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;
1418 2798
1419 $self->enter_link; 2799 $self->enter_link;
1420 2800
1421 (Coro::async { 2801 (async {
1422 $path = new cf::path $path; 2802 $Coro::current->{desc} = "player::goto $path $x $y";
1423 2803
1424 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) {
1425 $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 }
1426 2832
1427 warn "entering ", $map->path, " at ($x, $y)\n"
1428 if $map; 2833 $map
2834 };
1429 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};
1430 $self->leave_link ($map, $x, $y); 2843 $self->leave_link ($map, $x, $y);
2844 }
2845
2846 $done->($self) if $done;
1431 })->prio (1); 2847 })->prio (1);
1432} 2848}
1433 2849
1434=item $player_object->enter_exit ($exit_object) 2850=item $player_object->enter_exit ($exit_object)
1435 2851
1437 2853
1438sub parse_random_map_params { 2854sub parse_random_map_params {
1439 my ($spec) = @_; 2855 my ($spec) = @_;
1440 2856
1441 my $rmp = { # defaults 2857 my $rmp = { # defaults
1442 xsize => 10, 2858 xsize => (cf::rndm 15, 40),
1443 ysize => 10, 2859 ysize => (cf::rndm 15, 40),
2860 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2861 #layout => string,
1444 }; 2862 };
1445 2863
1446 for (split /\n/, $spec) { 2864 for (split /\n/, $spec) {
1447 my ($k, $v) = split /\s+/, $_, 2; 2865 my ($k, $v) = split /\s+/, $_, 2;
1448 2866
1460 # that depends on the exit object 2878 # that depends on the exit object
1461 2879
1462 my $rmp = parse_random_map_params $exit->msg; 2880 my $rmp = parse_random_map_params $exit->msg;
1463 2881
1464 if ($exit->map) { 2882 if ($exit->map) {
1465 $rmp->{region} = $exit->map->region_name; 2883 $rmp->{region} = $exit->region->name;
1466 $rmp->{origin_map} = $exit->map->path; 2884 $rmp->{origin_map} = $exit->map->path;
1467 $rmp->{origin_x} = $exit->x; 2885 $rmp->{origin_x} = $exit->x;
1468 $rmp->{origin_y} = $exit->y; 2886 $rmp->{origin_y} = $exit->y;
2887
2888 $exit->map->touch;
1469 } 2889 }
1470 2890
1471 $rmp->{random_seed} ||= $exit->random_seed; 2891 $rmp->{random_seed} ||= $exit->random_seed;
1472 2892
1473 my $data = cf::to_json $rmp; 2893 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1474 my $md5 = Digest::MD5::md5_hex $data; 2894 my $md5 = Digest::MD5::md5_hex $data;
2895 my $meta = "$RANDOMDIR/$md5.meta";
1475 2896
1476 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) {
1477 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;
1478 2901
2902 my $slaying = "?random/$md5";
2903
2904 if ($exit->valid) {
1479 $exit->slaying ("?random/$md5"); 2905 $exit->slaying ("?random/$md5");
1480 $exit->msg (undef); 2906 $exit->msg (undef);
2907 }
1481 } 2908 }
1482} 2909}
1483 2910
1484sub cf::object::player::enter_exit { 2911sub cf::object::player::enter_exit {
1485 my ($self, $exit) = @_; 2912 my ($self, $exit) = @_;
1486 2913
1487 return unless $self->type == cf::PLAYER; 2914 return unless $self->type == cf::PLAYER;
1488 2915
1489 $self->enter_link; 2916 $self->enter_link;
1490 2917
1491 (Coro::async { 2918 (async {
2919 $Coro::current->{desc} = "enter_exit";
2920
1492 unless (eval { 2921 unless (eval {
2922 $self->deactivate_recursive; # just to be sure
1493 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
1494 prepare_random_map $exit 2935 prepare_random_map $exit
1495 if $exit->slaying eq "/!"; 2936 if $slaying eq "/!"; # need to re-check after getting the lock
1496 2937
1497 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2938 } elsif ($slaying eq '!up') {
1498 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp); 2939 $map = $exit->map->tile_path (cf::TILE_UP);
2940 $x = $exit->x;
2941 $y = $exit->y;
1499 2942
2943 } elsif ($slaying eq '!down') {
2944 $map = $exit->map->tile_path (cf::TILE_DOWN);
2945 $x = $exit->x;
2946 $y = $exit->y;
2947 }
2948
2949 $self->goto ($map, $x, $y);
2950
2951 # if exit is damned, update players death & WoR home-position
2952 $self->contr->savebed ($map, $x, $y)
2953 if $exit->flag (cf::FLAG_DAMNED);
2954
1500 1; 2955 1
1501 }) { 2956 }) {
1502 $self->message ("Something went wrong deep within the crossfire server. " 2957 $self->message ("Something went wrong deep within the deliantra server. "
1503 . "I'll try to bring you back to the map you were before. " 2958 . "I'll try to bring you back to the map you were before. "
1504 . "Please report this to the dungeon master", 2959 . "Please report this to the dungeon master!",
1505 cf::NDI_UNIQUE | cf::NDI_RED); 2960 cf::NDI_UNIQUE | cf::NDI_RED);
1506 2961
1507 warn "ERROR in enter_exit: $@"; 2962 error "ERROR in enter_exit: $@";
1508 $self->leave_link; 2963 $self->leave_link;
1509 } 2964 }
1510 })->prio (1); 2965 })->prio (1);
1511} 2966}
1512 2967
1523 2978
1524sub cf::client::send_drawinfo { 2979sub cf::client::send_drawinfo {
1525 my ($self, $text, $flags) = @_; 2980 my ($self, $text, $flags) = @_;
1526 2981
1527 utf8::encode $text; 2982 utf8::encode $text;
1528 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2983 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1529} 2984}
1530 2985
2986=item $client->send_big_packet ($pkt)
2987
2988Like C<send_packet>, but tries to compress large packets, and fragments
2989them as required.
2990
2991=cut
2992
2993our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2994
2995sub cf::client::send_big_packet {
2996 my ($self, $pkt) = @_;
2997
2998 # try lzf for large packets
2999 $pkt = "lzf " . Compress::LZF::compress $pkt
3000 if 1024 <= length $pkt and $self->{can_lzf};
3001
3002 # split very large packets
3003 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
3004 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
3005 $pkt = "frag";
3006 }
3007
3008 $self->send_packet ($pkt);
3009}
3010
3011=item $client->send_msg ($channel, $msg, $color, [extra...])
3012
3013Send a drawinfo or msg packet to the client, formatting the msg for the
3014client if neccessary. C<$type> should be a string identifying the type of
3015the message, with C<log> being the default. If C<$color> is negative, suppress
3016the message unless the client supports the msg packet.
3017
3018=cut
3019
3020# non-persistent channels (usually the info channel)
3021our %CHANNEL = (
3022 "c/motd" => {
3023 id => "infobox",
3024 title => "MOTD",
3025 reply => undef,
3026 tooltip => "The message of the day",
3027 },
3028 "c/identify" => {
3029 id => "infobox",
3030 title => "Identify",
3031 reply => undef,
3032 tooltip => "Items recently identified",
3033 },
3034 "c/examine" => {
3035 id => "infobox",
3036 title => "Examine",
3037 reply => undef,
3038 tooltip => "Signs and other items you examined",
3039 },
3040 "c/shopinfo" => {
3041 id => "infobox",
3042 title => "Shop Info",
3043 reply => undef,
3044 tooltip => "What your bargaining skill tells you about the shop",
3045 },
3046 "c/book" => {
3047 id => "infobox",
3048 title => "Book",
3049 reply => undef,
3050 tooltip => "The contents of a note or book",
3051 },
3052 "c/lookat" => {
3053 id => "infobox",
3054 title => "Look",
3055 reply => undef,
3056 tooltip => "What you saw there",
3057 },
3058 "c/who" => {
3059 id => "infobox",
3060 title => "Players",
3061 reply => undef,
3062 tooltip => "Shows players who are currently online",
3063 },
3064 "c/body" => {
3065 id => "infobox",
3066 title => "Body Parts",
3067 reply => undef,
3068 tooltip => "Shows which body parts you posess and are available",
3069 },
3070 "c/statistics" => {
3071 id => "infobox",
3072 title => "Statistics",
3073 reply => undef,
3074 tooltip => "Shows your primary statistics",
3075 },
3076 "c/skills" => {
3077 id => "infobox",
3078 title => "Skills",
3079 reply => undef,
3080 tooltip => "Shows your experience per skill and item power",
3081 },
3082 "c/shopitems" => {
3083 id => "infobox",
3084 title => "Shop Items",
3085 reply => undef,
3086 tooltip => "Shows the items currently for sale in this shop",
3087 },
3088 "c/resistances" => {
3089 id => "infobox",
3090 title => "Resistances",
3091 reply => undef,
3092 tooltip => "Shows your resistances",
3093 },
3094 "c/pets" => {
3095 id => "infobox",
3096 title => "Pets",
3097 reply => undef,
3098 tooltip => "Shows information abotu your pets/a specific pet",
3099 },
3100 "c/perceiveself" => {
3101 id => "infobox",
3102 title => "Perceive Self",
3103 reply => undef,
3104 tooltip => "You gained detailed knowledge about yourself",
3105 },
3106 "c/uptime" => {
3107 id => "infobox",
3108 title => "Uptime",
3109 reply => undef,
3110 tooltip => "How long the server has been running since last restart",
3111 },
3112 "c/mapinfo" => {
3113 id => "infobox",
3114 title => "Map Info",
3115 reply => undef,
3116 tooltip => "Information related to the maps",
3117 },
3118 "c/party" => {
3119 id => "party",
3120 title => "Party",
3121 reply => "gsay ",
3122 tooltip => "Messages and chat related to your party",
3123 },
3124 "c/death" => {
3125 id => "death",
3126 title => "Death",
3127 reply => undef,
3128 tooltip => "Reason for and more info about your most recent death",
3129 },
3130 "c/say" => $SAY_CHANNEL,
3131 "c/chat" => $CHAT_CHANNEL,
3132);
3133
3134sub cf::client::send_msg {
3135 my ($self, $channel, $msg, $color, @extra) = @_;
3136
3137 $msg = $self->pl->expand_cfpod ($msg)
3138 unless $color & cf::NDI_VERBATIM;
3139
3140 $color &= cf::NDI_CLIENT_MASK; # just in case...
3141
3142 # check predefined channels, for the benefit of C
3143 if ($CHANNEL{$channel}) {
3144 $channel = $CHANNEL{$channel};
3145
3146 $self->ext_msg (channel_info => $channel);
3147 $channel = $channel->{id};
3148
3149 } elsif (ref $channel) {
3150 # send meta info to client, if not yet sent
3151 unless (exists $self->{channel}{$channel->{id}}) {
3152 $self->{channel}{$channel->{id}} = $channel;
3153 $self->ext_msg (channel_info => $channel);
3154 }
3155
3156 $channel = $channel->{id};
3157 }
3158
3159 return unless @extra || length $msg;
3160
3161 # default colour, mask it out
3162 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3163 if $color & cf::NDI_DEF;
3164
3165 my $pkt = "msg "
3166 . $self->{json_coder}->encode (
3167 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3168 );
3169
3170 $self->send_big_packet ($pkt);
3171}
3172
3173=item $client->ext_msg ($type, @msg)
3174
3175Sends an ext event to the client.
3176
3177=cut
3178
3179sub cf::client::ext_msg($$@) {
3180 my ($self, $type, @msg) = @_;
3181
3182 if ($self->extcmd == 2) {
3183 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
3184 } elsif ($self->extcmd == 1) { # TODO: remove
3185 push @msg, msgtype => "event_$type";
3186 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3187 }
3188}
3189
3190=item $client->ext_reply ($msgid, @msg)
3191
3192Sends an ext reply to the client.
3193
3194=cut
3195
3196sub cf::client::ext_reply($$@) {
3197 my ($self, $id, @msg) = @_;
3198
3199 if ($self->extcmd == 2) {
3200 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
3201 } elsif ($self->extcmd == 1) {
3202 #TODO: version 1, remove
3203 unshift @msg, msgtype => "reply", msgid => $id;
3204 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3205 }
3206}
1531 3207
1532=item $success = $client->query ($flags, "text", \&cb) 3208=item $success = $client->query ($flags, "text", \&cb)
1533 3209
1534Queues a query to the client, calling the given callback with 3210Queues a query to the client, calling the given callback with
1535the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3211the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1536C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3212C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1537 3213
1538Queries can fail, so check the return code. Or don't, as queries will become 3214Queries can fail, so check the return code. Or don't, as queries will
1539reliable at some point in the future. 3215become reliable at some point in the future.
1540 3216
1541=cut 3217=cut
1542 3218
1543sub cf::client::query { 3219sub cf::client::query {
1544 my ($self, $flags, $text, $cb) = @_; 3220 my ($self, $flags, $text, $cb) = @_;
1552 utf8::encode $text; 3228 utf8::encode $text;
1553 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3229 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1554 3230
1555 $self->send_packet ($self->{query_queue}[0][0]) 3231 $self->send_packet ($self->{query_queue}[0][0])
1556 if @{ $self->{query_queue} } == 1; 3232 if @{ $self->{query_queue} } == 1;
3233
3234 1
1557} 3235}
1558 3236
1559cf::client->attach ( 3237cf::client->attach (
3238 on_connect => sub {
3239 my ($ns) = @_;
3240
3241 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3242 },
1560 on_reply => sub { 3243 on_reply => sub {
1561 my ($ns, $msg) = @_; 3244 my ($ns, $msg) = @_;
1562 3245
1563 # this weird shuffling is so that direct followup queries 3246 # this weird shuffling is so that direct followup queries
1564 # get handled first 3247 # get handled first
1565 my $queue = delete $ns->{query_queue}; 3248 my $queue = delete $ns->{query_queue}
3249 or return; # be conservative, not sure how that can happen, but we saw a crash here
1566 3250
1567 (shift @$queue)->[1]->($msg); 3251 (shift @$queue)->[1]->($msg);
3252 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1568 3253
1569 push @{ $ns->{query_queue} }, @$queue; 3254 push @{ $ns->{query_queue} }, @$queue;
1570 3255
1571 if (@{ $ns->{query_queue} } == @$queue) { 3256 if (@{ $ns->{query_queue} } == @$queue) {
1572 if (@$queue) { 3257 if (@$queue) {
1574 } else { 3259 } else {
1575 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3260 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1576 } 3261 }
1577 } 3262 }
1578 }, 3263 },
3264 on_exticmd => sub {
3265 my ($ns, $buf) = @_;
3266
3267 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3268
3269 if (ref $msg) {
3270 my ($type, $reply, @payload) =
3271 "ARRAY" eq ref $msg
3272 ? @$msg
3273 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3274
3275 my @reply;
3276
3277 if (my $cb = $EXTICMD{$type}) {
3278 @reply = $cb->($ns, @payload);
3279 }
3280
3281 $ns->ext_reply ($reply, @reply)
3282 if $reply;
3283
3284 } else {
3285 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3286 }
3287
3288 cf::override;
3289 },
1579); 3290);
1580 3291
1581=item $client->coro (\&cb) 3292=item $client->async (\&cb)
1582 3293
1583Create a new coroutine, running the specified callback. The coroutine will 3294Create a new coroutine, running the specified callback. The coroutine will
1584be automatically cancelled when the client gets destroyed (e.g. on logout, 3295be automatically cancelled when the client gets destroyed (e.g. on logout,
1585or loss of connection). 3296or loss of connection).
1586 3297
1587=cut 3298=cut
1588 3299
1589sub cf::client::coro { 3300sub cf::client::async {
1590 my ($self, $cb) = @_; 3301 my ($self, $cb) = @_;
1591 3302
1592 my $coro; $coro = async { 3303 my $coro = &Coro::async ($cb);
1593 eval {
1594 $cb->();
1595 };
1596 warn $@ if $@;
1597 };
1598 3304
1599 $coro->on_destroy (sub { 3305 $coro->on_destroy (sub {
1600 delete $self->{_coro}{$coro+0}; 3306 delete $self->{_coro}{$coro+0};
1601 }); 3307 });
1602 3308
1604 3310
1605 $coro 3311 $coro
1606} 3312}
1607 3313
1608cf::client->attach ( 3314cf::client->attach (
1609 on_destroy => sub { 3315 on_client_destroy => sub {
1610 my ($ns) = @_; 3316 my ($ns) = @_;
1611 3317
1612 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3318 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1613 }, 3319 },
1614); 3320);
1629our $safe = new Safe "safe"; 3335our $safe = new Safe "safe";
1630our $safe_hole = new Safe::Hole; 3336our $safe_hole = new Safe::Hole;
1631 3337
1632$SIG{FPE} = 'IGNORE'; 3338$SIG{FPE} = 'IGNORE';
1633 3339
1634$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3340$safe->permit_only (Opcode::opset qw(
3341 :base_core :base_mem :base_orig :base_math :base_loop
3342 grepstart grepwhile mapstart mapwhile
3343 sort time
3344));
1635 3345
1636# here we export the classes and methods available to script code 3346# here we export the classes and methods available to script code
1637 3347
1638=pod 3348=pod
1639 3349
1640The following fucntions and emthods are available within a safe environment: 3350The following functions and methods are available within a safe environment:
1641 3351
1642 cf::object contr pay_amount pay_player map 3352 cf::object
3353 contr pay_amount pay_player map x y force_find force_add destroy
3354 insert remove name archname title slaying race decrease split
3355 value
3356
1643 cf::object::player player 3357 cf::object::player
1644 cf::player peaceful 3358 player
1645 cf::map trigger 3359
3360 cf::player
3361 peaceful
3362
3363 cf::map
3364 trigger
1646 3365
1647=cut 3366=cut
1648 3367
1649for ( 3368for (
1650 ["cf::object" => qw(contr pay_amount pay_player map)], 3369 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3370 insert remove inv nrof name archname title slaying race
3371 decrease split destroy change_exp value msg lore send_msg)],
1651 ["cf::object::player" => qw(player)], 3372 ["cf::object::player" => qw(player)],
1652 ["cf::player" => qw(peaceful)], 3373 ["cf::player" => qw(peaceful send_msg)],
1653 ["cf::map" => qw(trigger)], 3374 ["cf::map" => qw(trigger)],
1654) { 3375) {
1655 no strict 'refs';
1656 my ($pkg, @funs) = @$_; 3376 my ($pkg, @funs) = @$_;
1657 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3377 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1658 for @funs; 3378 for @funs;
1659} 3379}
1660 3380
1675 3395
1676 my $qcode = $code; 3396 my $qcode = $code;
1677 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3397 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1678 $qcode =~ s/\n/\\n/g; 3398 $qcode =~ s/\n/\\n/g;
1679 3399
3400 %vars = (_dummy => 0) unless %vars;
3401
3402 my @res;
1680 local $_; 3403 local $_;
1681 local @safe::cf::_safe_eval_args = values %vars;
1682 3404
1683 my $eval = 3405 my $eval =
1684 "do {\n" 3406 "do {\n"
1685 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3407 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1686 . "#line 0 \"{$qcode}\"\n" 3408 . "#line 0 \"{$qcode}\"\n"
1687 . $code 3409 . $code
1688 . "\n}" 3410 . "\n}"
1689 ; 3411 ;
1690 3412
3413 if ($CFG{safe_eval}) {
1691 sub_generation_inc; 3414 sub_generation_inc;
3415 local @safe::cf::_safe_eval_args = values %vars;
1692 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3416 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1693 sub_generation_inc; 3417 sub_generation_inc;
3418 } else {
3419 local @cf::_safe_eval_args = values %vars;
3420 @res = wantarray ? eval eval : scalar eval $eval;
3421 }
1694 3422
1695 if ($@) { 3423 if ($@) {
1696 warn "$@"; 3424 warn "$@",
1697 warn "while executing safe code '$code'\n"; 3425 "while executing safe code '$code'\n",
1698 warn "with arguments " . (join " ", %vars) . "\n"; 3426 "with arguments " . (join " ", %vars) . "\n";
1699 } 3427 }
1700 3428
1701 wantarray ? @res : $res[0] 3429 wantarray ? @res : $res[0]
1702} 3430}
1703 3431
1717=cut 3445=cut
1718 3446
1719sub register_script_function { 3447sub register_script_function {
1720 my ($fun, $cb) = @_; 3448 my ($fun, $cb) = @_;
1721 3449
1722 no strict 'refs'; 3450 $fun = "safe::$fun" if $CFG{safe_eval};
1723 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3451 *$fun = $safe_hole->wrap ($cb);
1724} 3452}
1725 3453
1726=back 3454=back
1727 3455
1728=cut 3456=cut
1729 3457
1730############################################################################# 3458#############################################################################
3459# the server's init and main functions
1731 3460
1732=head2 EXTENSION DATABASE SUPPORT 3461sub load_facedata($) {
3462 my ($path) = @_;
1733 3463
1734Crossfire maintains a very simple database for extension use. It can 3464 # HACK to clear player env face cache, we need some signal framework
1735currently store anything that can be serialised using Storable, which 3465 # for this (global event?)
1736excludes objects. 3466 %ext::player_env::MUSIC_FACE_CACHE = ();
1737 3467
1738The parameter C<$family> should best start with the name of the extension 3468 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1739using it, it should be unique.
1740 3469
1741=over 4 3470 trace "loading facedata from $path\n";
1742 3471
1743=item $hashref = cf::db_get $family 3472 my $facedata = decode_storable load_file $path;
1744 3473
1745Return a hashref for use by the extension C<$family>, which can be 3474 $facedata->{version} == 2
1746modified. After modifications, you have to call C<cf::db_dirty> or 3475 or cf::cleanup "$path: version mismatch, cannot proceed.";
1747C<cf::db_sync>.
1748 3476
1749=item $value = cf::db_get $family => $key 3477 # patch in the exptable
1750 3478 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
1751Returns a single value from the database 3479 $facedata->{resource}{"res/exp_table"} = {
1752 3480 type => FT_RSRC,
1753=item cf::db_put $family => $hashref 3481 data => $exp_table,
1754 3482 hash => (Digest::MD5::md5 $exp_table),
1755Stores the given family hashref into the database. Updates are delayed, if
1756you want the data to be synced to disk immediately, use C<cf::db_sync>.
1757
1758=item cf::db_put $family => $key => $value
1759
1760Stores the given C<$value> in the family hash. Updates are delayed, if you
1761want the data to be synced to disk immediately, use C<cf::db_sync>.
1762
1763=item cf::db_dirty
1764
1765Marks the database as dirty, to be updated at a later time.
1766
1767=item cf::db_sync
1768
1769Immediately write the database to disk I<if it is dirty>.
1770
1771=cut
1772
1773our $DB;
1774
1775{
1776 my $path = cf::localdir . "/database.pst";
1777
1778 sub db_load() {
1779 warn "loading database $path\n";#d# remove later
1780 $DB = stat $path ? Storable::retrieve $path : { };
1781 }
1782
1783 my $pid;
1784
1785 sub db_save() {
1786 warn "saving database $path\n";#d# remove later
1787 waitpid $pid, 0 if $pid;
1788 if (0 == ($pid = fork)) {
1789 $DB->{_meta}{version} = 1;
1790 Storable::nstore $DB, "$path~";
1791 rename "$path~", $path;
1792 cf::_exit 0 if defined $pid;
1793 }
1794 }
1795
1796 my $dirty;
1797
1798 sub db_sync() {
1799 db_save if $dirty;
1800 undef $dirty;
1801 }
1802
1803 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1804 db_sync;
1805 }); 3483 };
3484 cf::cede_to_tick;
1806 3485
1807 sub db_dirty() {
1808 $dirty = 1;
1809 $idle->start;
1810 } 3486 {
3487 my $faces = $facedata->{faceinfo};
1811 3488
1812 sub db_get($;$) { 3489 while (my ($face, $info) = each %$faces) {
1813 @_ >= 2 3490 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1814 ? $DB->{$_[0]}{$_[1]}
1815 : ($DB->{$_[0]} ||= { })
1816 }
1817 3491
1818 sub db_put($$;$) { 3492 cf::face::set_visibility $idx, $info->{visibility};
1819 if (@_ >= 3) { 3493 cf::face::set_magicmap $idx, $info->{magicmap};
1820 $DB->{$_[0]}{$_[1]} = $_[2]; 3494 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
1821 } else { 3495 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1822 $DB->{$_[0]} = $_[1]; 3496 cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
1823 }
1824 db_dirty;
1825 }
1826 3497
1827 cf::global->attach ( 3498 cf::cede_to_tick;
1828 prio => 10000,
1829 on_cleanup => sub {
1830 db_sync;
1831 }, 3499 }
1832 );
1833}
1834 3500
1835############################################################################# 3501 while (my ($face, $info) = each %$faces) {
1836# the server's main() 3502 next unless $info->{smooth};
1837 3503
1838sub cfg_load { 3504 my $idx = cf::face::find $face
1839 open my $fh, "<:utf8", cf::confdir . "/config" 3505 or next;
1840 or return;
1841 3506
1842 local $/; 3507 if (my $smooth = cf::face::find $info->{smooth}) {
1843 *CFG = YAML::Syck::Load <$fh>; 3508 cf::face::set_smooth $idx, $smooth;
3509 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3510 } else {
3511 error "smooth face '$info->{smooth}' not found for face '$face'";
3512 }
3513
3514 cf::cede_to_tick;
3515 }
3516 }
3517
3518 {
3519 my $anims = $facedata->{animinfo};
3520
3521 while (my ($anim, $info) = each %$anims) {
3522 cf::anim::set $anim, $info->{frames}, $info->{facings};
3523 cf::cede_to_tick;
3524 }
3525
3526 cf::anim::invalidate_all; # d'oh
3527 }
3528
3529 {
3530 my $res = $facedata->{resource};
3531
3532 while (my ($name, $info) = each %$res) {
3533 if (defined $info->{type}) {
3534 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3535
3536 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3537 cf::face::set_type $idx, $info->{type};
3538 } else {
3539 $RESOURCE{$name} = $info; # unused
3540 }
3541
3542 cf::cede_to_tick;
3543 }
3544 }
3545
3546 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3547
3548 1
3549}
3550
3551register_exticmd fx_want => sub {
3552 my ($ns, $want) = @_;
3553
3554 while (my ($k, $v) = each %$want) {
3555 $ns->fx_want ($k, $v);
3556 }
3557};
3558
3559sub load_resource_file($) {
3560 my $guard = lock_acquire "load_resource_file";
3561
3562 my $status = load_resource_file_ $_[0];
3563 get_slot 0.1, 100;
3564 cf::arch::commit_load;
3565
3566 $status
3567}
3568
3569sub reload_regions {
3570 # HACK to clear player env face cache, we need some signal framework
3571 # for this (global event?)
3572 %ext::player_env::MUSIC_FACE_CACHE = ();
3573
3574 load_resource_file "$MAPDIR/regions"
3575 or die "unable to load regions file\n";
3576
3577 for (cf::region::list) {
3578 $_->{match} = qr/$_->{match}/
3579 if exists $_->{match};
3580 }
3581}
3582
3583sub reload_facedata {
3584 load_facedata "$DATADIR/facedata"
3585 or die "unable to load facedata\n";
3586}
3587
3588sub reload_archetypes {
3589 load_resource_file "$DATADIR/archetypes"
3590 or die "unable to load archetypes\n";
3591}
3592
3593sub reload_treasures {
3594 load_resource_file "$DATADIR/treasures"
3595 or die "unable to load treasurelists\n";
3596}
3597
3598sub reload_sound {
3599 trace "loading sound config from $DATADIR/sound\n";
3600
3601 my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
3602
3603 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3604 my $sound = $soundconf->{compat}[$_]
3605 or next;
3606
3607 my $face = cf::face::find "sound/$sound->[1]";
3608 cf::sound::set $sound->[0] => $face;
3609 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3610 }
3611
3612 while (my ($k, $v) = each %{$soundconf->{event}}) {
3613 my $face = cf::face::find "sound/$v";
3614 cf::sound::set $k => $face;
3615 }
3616}
3617
3618sub reload_resources {
3619 trace "reloading resource files...\n";
3620
3621 reload_exp_table;
3622 reload_materials;
3623 reload_facedata;
3624 reload_sound;
3625 reload_archetypes;
3626 reload_regions;
3627 reload_treasures;
3628
3629 trace "finished reloading resource files\n";
3630}
3631
3632sub reload_config {
3633 trace "reloading config file...\n";
3634
3635 my $config = load_file "$CONFDIR/config";
3636 utf8::decode $config;
3637 *CFG = decode_yaml $config;
3638
3639 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
3640
3641 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3642 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3643
3644 if (exists $CFG{mlockall}) {
3645 eval {
3646 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3647 and die "WARNING: m(un)lockall failed: $!\n";
3648 };
3649 warn $@ if $@;
3650 }
3651}
3652
3653sub pidfile() {
3654 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3655 or die "$PIDFILE: $!";
3656 flock $fh, &Fcntl::LOCK_EX
3657 or die "$PIDFILE: flock: $!";
3658 $fh
3659}
3660
3661# make sure only one server instance is running at any one time
3662sub atomic {
3663 my $fh = pidfile;
3664
3665 my $pid = <$fh>;
3666 kill 9, $pid if $pid > 0;
3667
3668 seek $fh, 0, 0;
3669 print $fh $$;
3670}
3671
3672sub main_loop {
3673 trace "EV::loop starting\n";
3674 if (1) {
3675 EV::loop;
3676 }
3677 trace "EV::loop returned\n";
3678 goto &main_loop unless $REALLY_UNLOOP;
1844} 3679}
1845 3680
1846sub main { 3681sub main {
3682 cf::init_globals; # initialise logging
3683
3684 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3685 LOG llevInfo, "Copyright (C) 2005-2011 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3686 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3687 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3688
3689 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3690
1847 # we must not ever block the main coroutine 3691 # we must not ever block the main coroutine
1848 local $Coro::idle = sub { 3692 local $Coro::idle = sub {
1849 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3693 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1850 (Coro::unblock_sub { 3694 (async {
1851 Event::one_event; 3695 $Coro::current->{desc} = "IDLE BUG HANDLER";
1852 })->(); 3696 EV::loop EV::LOOP_ONESHOT;
3697 })->prio (Coro::PRIO_MAX);
1853 }; 3698 };
1854 3699
1855 cfg_load; 3700 evthread_start IO::AIO::poll_fileno;
1856 db_load; 3701
3702 cf::sync_job {
3703 cf::incloader::init ();
3704
3705 cf::init_anim;
3706 cf::init_attackmess;
3707 cf::init_dynamic;
3708
3709 cf::load_settings;
3710
3711 reload_resources;
3712 reload_config;
3713 db_init;
3714
3715 cf::init_uuid;
3716 cf::init_signals;
3717 cf::init_skills;
3718
3719 cf::init_beforeplay;
3720
3721 atomic;
3722
1857 load_extensions; 3723 load_extensions;
1858 Event::loop; 3724
3725 utime time, time, $RUNTIMEFILE;
3726
3727 # no (long-running) fork's whatsoever before this point(!)
3728 use POSIX ();
3729 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3730
3731 cf::_post_init 0;
3732 };
3733
3734 cf::object::thawer::errors_are_fatal 0;
3735 info "parse errors in files are no longer fatal from this point on.\n";
3736
3737 my $free_main; $free_main = EV::idle sub {
3738 undef $free_main;
3739 undef &main; # free gobs of memory :)
3740 };
3741
3742 goto &main_loop;
1859} 3743}
1860 3744
1861############################################################################# 3745#############################################################################
1862# initialisation 3746# initialisation and cleanup
1863 3747
3748# install some emergency cleanup handlers
3749BEGIN {
3750 our %SIGWATCHER = ();
3751 for my $signal (qw(INT HUP TERM)) {
3752 $SIGWATCHER{$signal} = AE::signal $signal, sub {
3753 cf::cleanup "SIG$signal";
3754 };
3755 }
3756}
3757
3758sub write_runtime_sync {
3759 my $t0 = AE::time;
3760
3761 # first touch the runtime file to show we are still running:
3762 # the fsync below can take a very very long time.
3763
3764 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3765
3766 my $guard = cf::lock_acquire "write_runtime";
3767
3768 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3769 or return;
3770
3771 my $value = $cf::RUNTIME + 90 + 10;
3772 # 10 is the runtime save interval, for a monotonic clock
3773 # 60 allows for the watchdog to kill the server.
3774
3775 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3776 and return;
3777
3778 # always fsync - this file is important
3779 aio_fsync $fh
3780 and return;
3781
3782 # touch it again to show we are up-to-date
3783 aio_utime $fh, undef, undef;
3784
3785 close $fh
3786 or return;
3787
3788 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3789 and return;
3790
3791 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3792
3793 1
3794}
3795
3796our $uuid_lock;
3797our $uuid_skip;
3798
3799sub write_uuid_sync($) {
3800 $uuid_skip ||= $_[0];
3801
3802 return if $uuid_lock;
3803 local $uuid_lock = 1;
3804
3805 my $uuid = "$LOCALDIR/uuid";
3806
3807 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3808 or return;
3809
3810 my $value = uuid_seq uuid_cur;
3811
3812 unless ($value) {
3813 info "cowardly refusing to write zero uuid value!\n";
3814 return;
3815 }
3816
3817 my $value = uuid_str $value + $uuid_skip;
3818 $uuid_skip = 0;
3819
3820 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3821 and return;
3822
3823 # always fsync - this file is important
3824 aio_fsync $fh
3825 and return;
3826
3827 close $fh
3828 or return;
3829
3830 aio_rename "$uuid~", $uuid
3831 and return;
3832
3833 trace "uuid file written ($value).\n";
3834
3835 1
3836
3837}
3838
3839sub write_uuid($$) {
3840 my ($skip, $sync) = @_;
3841
3842 $sync ? write_uuid_sync $skip
3843 : async { write_uuid_sync $skip };
3844}
3845
3846sub emergency_save() {
3847 my $freeze_guard = cf::freeze_mainloop;
3848
3849 info "emergency_perl_save: enter\n";
3850
3851 # this is a trade-off: we want to be very quick here, so
3852 # save all maps without fsync, and later call a global sync
3853 # (which in turn might be very very slow)
3854 local $USE_FSYNC = 0;
3855
3856 cf::sync_job {
3857 cf::write_runtime_sync; # external watchdog should not bark
3858
3859 # use a peculiar iteration method to avoid tripping on perl
3860 # refcount bugs in for. also avoids problems with players
3861 # and maps saved/destroyed asynchronously.
3862 info "emergency_perl_save: begin player save\n";
3863 for my $login (keys %cf::PLAYER) {
3864 my $pl = $cf::PLAYER{$login} or next;
3865 $pl->valid or next;
3866 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3867 $pl->save;
3868 }
3869 info "emergency_perl_save: end player save\n";
3870
3871 cf::write_runtime_sync; # external watchdog should not bark
3872
3873 info "emergency_perl_save: begin map save\n";
3874 for my $path (keys %cf::MAP) {
3875 my $map = $cf::MAP{$path} or next;
3876 $map->valid or next;
3877 $map->save;
3878 }
3879 info "emergency_perl_save: end map save\n";
3880
3881 cf::write_runtime_sync; # external watchdog should not bark
3882
3883 info "emergency_perl_save: begin database checkpoint\n";
3884 BDB::db_env_txn_checkpoint $DB_ENV;
3885 info "emergency_perl_save: end database checkpoint\n";
3886
3887 info "emergency_perl_save: begin write uuid\n";
3888 write_uuid_sync 1;
3889 info "emergency_perl_save: end write uuid\n";
3890
3891 cf::write_runtime_sync; # external watchdog should not bark
3892
3893 trace "emergency_perl_save: syncing database to disk";
3894 BDB::db_env_txn_checkpoint $DB_ENV;
3895
3896 info "emergency_perl_save: starting sync\n";
3897 IO::AIO::aio_sync sub {
3898 info "emergency_perl_save: finished sync\n";
3899 };
3900
3901 cf::write_runtime_sync; # external watchdog should not bark
3902
3903 trace "emergency_perl_save: flushing outstanding aio requests";
3904 while (IO::AIO::nreqs || BDB::nreqs) {
3905 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3906 }
3907
3908 cf::write_runtime_sync; # external watchdog should not bark
3909 };
3910
3911 info "emergency_perl_save: leave\n";
3912}
3913
3914sub post_cleanup {
3915 my ($make_core) = @_;
3916
3917 IO::AIO::flush;
3918
3919 error Carp::longmess "post_cleanup backtrace"
3920 if $make_core;
3921
3922 my $fh = pidfile;
3923 unlink $PIDFILE if <$fh> == $$;
3924}
3925
3926# a safer delete_package, copied from Symbol
3927sub clear_package($) {
3928 my $pkg = shift;
3929
3930 # expand to full symbol table name if needed
3931 unless ($pkg =~ /^main::.*::$/) {
3932 $pkg = "main$pkg" if $pkg =~ /^::/;
3933 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3934 $pkg .= '::' unless $pkg =~ /::$/;
3935 }
3936
3937 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3938 my $stem_symtab = *{$stem}{HASH};
3939
3940 defined $stem_symtab and exists $stem_symtab->{$leaf}
3941 or return;
3942
3943 # clear all symbols
3944 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3945 for my $name (keys %$leaf_symtab) {
3946 _gv_clear *{"$pkg$name"};
3947# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3948 }
3949}
3950
1864sub reload() { 3951sub do_reload_perl() {
1865 # can/must only be called in main 3952 # can/must only be called in main
1866 if ($Coro::current != $Coro::main) { 3953 unless (in_main) {
1867 warn "can only reload from main coroutine\n"; 3954 error "can only reload from main coroutine";
1868 return; 3955 return;
1869 } 3956 }
1870 3957
1871 warn "reloading..."; 3958 return if $RELOAD++;
1872 3959
1873 local $FREEZE = 1; 3960 my $t1 = AE::time;
3961
3962 while ($RELOAD) {
3963 cf::get_slot 0.1, -1, "reload_perl";
3964 info "perl_reload: reloading...";
3965
3966 trace "perl_reload: entering sync_job";
3967
3968 cf::sync_job {
1874 cf::emergency_save; 3969 #cf::emergency_save;
1875 3970
1876 eval { 3971 trace "perl_reload: cancelling all extension coros";
1877 # if anything goes wrong in here, we should simply crash as we already saved
1878
1879 # cancel all watchers
1880 for (Event::all_watchers) {
1881 $_->cancel if $_->data & WF_AUTOCANCEL;
1882 }
1883
1884 # cancel all extension coros
1885 $_->cancel for values %EXT_CORO; 3972 $_->cancel for values %EXT_CORO;
1886 %EXT_CORO = (); 3973 %EXT_CORO = ();
1887 3974
1888 # unload all extensions 3975 trace "perl_reload: removing commands";
1889 for (@exts) { 3976 %COMMAND = ();
1890 warn "unloading <$_>";
1891 unload_extension $_;
1892 }
1893 3977
1894 # unload all modules loaded from $LIBDIR 3978 trace "perl_reload: removing ext/exti commands";
1895 while (my ($k, $v) = each %INC) { 3979 %EXTCMD = ();
1896 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3980 %EXTICMD = ();
1897 3981
1898 warn "removing <$k>"; 3982 trace "perl_reload: unloading/nuking all extensions";
1899 delete $INC{$k}; 3983 for my $pkg (@EXTS) {
3984 trace "... unloading $pkg";
1900 3985
1901 $k =~ s/\.pm$//;
1902 $k =~ s/\//::/g;
1903
1904 if (my $cb = $k->can ("unload_module")) { 3986 if (my $cb = $pkg->can ("unload")) {
3987 eval {
1905 $cb->(); 3988 $cb->($pkg);
3989 1
3990 } or error "$pkg unloaded, but with errors: $@";
3991 }
3992
3993 trace "... clearing $pkg";
3994 clear_package $pkg;
1906 } 3995 }
1907 3996
1908 Symbol::delete_package $k; 3997 trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
3998 while (my ($k, $v) = each %INC) {
3999 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
4000
4001 trace "... unloading $k";
4002 delete $INC{$k};
4003
4004 $k =~ s/\.pm$//;
4005 $k =~ s/\//::/g;
4006
4007 if (my $cb = $k->can ("unload_module")) {
4008 $cb->();
4009 }
4010
4011 clear_package $k;
1909 } 4012 }
1910 4013
1911 # sync database to disk
1912 cf::db_sync;
1913 IO::AIO::flush;
1914
1915 # get rid of safe::, as good as possible 4014 trace "perl_reload: getting rid of safe::, as good as possible";
1916 Symbol::delete_package "safe::$_" 4015 clear_package "safe::$_"
1917 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 4016 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1918 4017
1919 # remove register_script_function callbacks 4018 trace "perl_reload: unloading cf.pm \"a bit\"";
1920 # TODO
1921
1922 # unload cf.pm "a bit"
1923 delete $INC{"cf.pm"}; 4019 delete $INC{"cf.pm"};
4020 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
1924 4021
1925 # don't, removes xs symbols, too, 4022 # don't, removes xs symbols, too,
1926 # and global variables created in xs 4023 # and global variables created in xs
1927 #Symbol::delete_package __PACKAGE__; 4024 #clear_package __PACKAGE__;
1928 4025
1929 # reload cf.pm 4026 info "perl_reload: unload completed, starting to reload now";
1930 warn "reloading cf.pm"; 4027
4028 trace "perl_reload: reloading cf.pm";
1931 require cf; 4029 require cf;
1932 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 4030 cf::_connect_to_perl_1;
1933 4031
1934 # load config and database again 4032 trace "perl_reload: loading config and database again";
1935 cf::cfg_load; 4033 cf::reload_config;
1936 cf::db_load;
1937 4034
1938 # load extensions 4035 trace "perl_reload: loading extensions";
1939 warn "load extensions";
1940 cf::load_extensions; 4036 cf::load_extensions;
1941 4037
1942 # reattach attachments to objects 4038 if ($REATTACH_ON_RELOAD) {
1943 warn "reattach"; 4039 trace "perl_reload: reattaching attachments to objects/players";
1944 _global_reattach; 4040 _global_reattach; # objects, sockets
4041 trace "perl_reload: reattaching attachments to maps";
4042 reattach $_ for values %MAP;
4043 trace "perl_reload: reattaching attachments to players";
4044 reattach $_ for values %PLAYER;
4045 }
4046
4047 cf::_post_init 1;
4048
4049 trace "perl_reload: leaving sync_job";
4050
4051 1
4052 } or do {
4053 error $@;
4054 cf::cleanup "perl_reload: error, exiting.";
4055 };
4056
4057 --$RELOAD;
4058 }
4059
4060 $t1 = AE::time - $t1;
4061 info "perl_reload: completed in ${t1}s\n";
4062};
4063
4064our $RELOAD_WATCHER; # used only during reload
4065
4066sub reload_perl() {
4067 # doing reload synchronously and two reloads happen back-to-back,
4068 # coro crashes during coro_state_free->destroy here.
4069
4070 $RELOAD_WATCHER ||= cf::async {
4071 Coro::AIO::aio_wait cache_extensions;
4072
4073 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
4074 do_reload_perl;
4075 undef $RELOAD_WATCHER;
4076 };
1945 }; 4077 };
1946
1947 if ($@) {
1948 warn $@;
1949 warn "error while reloading, exiting.";
1950 exit 1;
1951 }
1952
1953 warn "reloaded successfully";
1954};
1955
1956#############################################################################
1957
1958unless ($LINK_MAP) {
1959 $LINK_MAP = cf::map::new;
1960
1961 $LINK_MAP->width (41);
1962 $LINK_MAP->height (41);
1963 $LINK_MAP->alloc;
1964 $LINK_MAP->path ("{link}");
1965 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1966 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1967
1968 # dirty hack because... archetypes are not yet loaded
1969 Event->timer (
1970 after => 2,
1971 cb => sub {
1972 $_[0]->w->cancel;
1973
1974 # provide some exits "home"
1975 my $exit = cf::object::new "exit";
1976
1977 $exit->slaying ($EMERGENCY_POSITION->[0]);
1978 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
1979 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
1980
1981 $LINK_MAP->insert ($exit->clone, 19, 19);
1982 $LINK_MAP->insert ($exit->clone, 19, 20);
1983 $LINK_MAP->insert ($exit->clone, 19, 21);
1984 $LINK_MAP->insert ($exit->clone, 20, 19);
1985 $LINK_MAP->insert ($exit->clone, 20, 21);
1986 $LINK_MAP->insert ($exit->clone, 21, 19);
1987 $LINK_MAP->insert ($exit->clone, 21, 20);
1988 $LINK_MAP->insert ($exit->clone, 21, 21);
1989
1990 $exit->destroy;
1991 });
1992
1993 $LINK_MAP->{deny_save} = 1;
1994 $LINK_MAP->{deny_reset} = 1;
1995
1996 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1997} 4078}
1998
1999register "<global>", __PACKAGE__;
2000 4079
2001register_command "reload" => sub { 4080register_command "reload" => sub {
2002 my ($who, $arg) = @_; 4081 my ($who, $arg) = @_;
2003 4082
2004 if ($who->flag (FLAG_WIZ)) { 4083 if ($who->flag (FLAG_WIZ)) {
2005 $who->message ("start of reload.");
2006 reload;
2007 $who->message ("end of reload."); 4084 $who->message ("reloading server.");
4085 async {
4086 $Coro::current->{desc} = "perl_reload";
4087 reload_perl;
4088 };
2008 } 4089 }
2009}; 4090};
2010 4091
2011unshift @INC, $LIBDIR; 4092#############################################################################
2012 4093
2013$TICK_WATCHER = Event->timer ( 4094my $bug_warning = 0;
2014 reentrant => 0, 4095
2015 prio => 0, 4096our @WAIT_FOR_TICK;
2016 at => $NEXT_TICK || $TICK, 4097our @WAIT_FOR_TICK_BEGIN;
2017 data => WF_AUTOCANCEL, 4098
2018 cb => sub { 4099sub wait_for_tick() {
2019 unless ($FREEZE) { 4100 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4101
4102 my $signal = new Coro::Signal;
4103 push @WAIT_FOR_TICK, $signal;
4104 $signal->wait;
4105}
4106
4107sub wait_for_tick_begin() {
4108 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4109
4110 my $signal = new Coro::Signal;
4111 push @WAIT_FOR_TICK_BEGIN, $signal;
4112 $signal->wait;
4113}
4114
4115sub tick {
4116 if ($Coro::current != $Coro::main) {
4117 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
4118 unless ++$bug_warning > 10;
4119 return;
4120 }
4121
2020 cf::server_tick; # one server iteration 4122 cf::server_tick; # one server iteration
2021 $RUNTIME += $TICK;
2022 }
2023 4123
2024 $NEXT_TICK += $TICK; 4124 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2025 4125
2026 # if we are delayed by four ticks or more, skip them all 4126 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2027 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 4127 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2028 4128 Coro::async_pool {
2029 $TICK_WATCHER->at ($NEXT_TICK); 4129 $Coro::current->{desc} = "runtime saver";
2030 $TICK_WATCHER->start;
2031 },
2032);
2033
2034IO::AIO::max_poll_time $TICK * 0.2;
2035
2036Event->io (
2037 fd => IO::AIO::poll_fileno,
2038 poll => 'r',
2039 prio => 5,
2040 data => WF_AUTOCANCEL,
2041 cb => \&IO::AIO::poll_cb,
2042);
2043
2044Event->timer (
2045 data => WF_AUTOCANCEL,
2046 after => 0,
2047 interval => 10,
2048 cb => sub {
2049 (Coro::unblock_sub {
2050 write_runtime 4130 write_runtime_sync
2051 or warn "ERROR: unable to write runtime file: $!"; 4131 or error "ERROR: unable to write runtime file: $!";
2052 })->(); 4132 };
2053 }, 4133 }
2054); 4134
4135 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4136 $sig->send;
4137 }
4138 while (my $sig = shift @WAIT_FOR_TICK) {
4139 $sig->send;
4140 }
4141
4142 $LOAD = ($NOW - $TICK_START) / $TICK;
4143 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4144
4145 if (0) {
4146 if ($NEXT_TICK) {
4147 my $jitter = $TICK_START - $NEXT_TICK;
4148 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4149 debug "jitter $JITTER\n";#d#
4150 }
4151 }
4152}
4153
4154{
4155 # configure BDB
4156
4157 BDB::min_parallel 16;
4158 BDB::max_poll_reqs $TICK * 0.1;
4159 $AnyEvent::BDB::WATCHER->priority (1);
4160
4161 unless ($DB_ENV) {
4162 $DB_ENV = BDB::db_env_create;
4163 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4164 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4165 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4166 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4167 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4168
4169 cf::sync_job {
4170 eval {
4171 BDB::db_env_open
4172 $DB_ENV,
4173 $BDBDIR,
4174 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4175 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4176 0666;
4177
4178 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
4179 };
4180
4181 cf::cleanup "db_env_open(db): $@" if $@;
4182 };
4183 }
4184
4185 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4186 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4187 };
4188 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4189 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4190 };
4191 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4192 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4193 };
4194}
4195
4196{
4197 # configure IO::AIO
4198
4199 IO::AIO::min_parallel 8;
4200 IO::AIO::max_poll_time $TICK * 0.1;
4201 undef $AnyEvent::AIO::WATCHER;
4202}
4203
4204our $_log_backtrace;
4205our $_log_backtrace_last;
4206
4207sub _log_backtrace {
4208 my ($msg, @addr) = @_;
4209
4210 $msg =~ s/\n$//;
4211
4212 if ($_log_backtrace_last eq $msg) {
4213 LOG llevInfo, "[ABT] $msg\n";
4214 LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
4215 # limit the # of concurrent backtraces
4216 } elsif ($_log_backtrace < 2) {
4217 $_log_backtrace_last = $msg;
4218 ++$_log_backtrace;
4219 my $perl_bt = Carp::longmess $msg;
4220 async {
4221 $Coro::current->{desc} = "abt $msg";
4222
4223 my @bt = fork_call {
4224 @addr = map { sprintf "%x", $_ } @addr;
4225 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4226 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4227 or die "addr2line: $!";
4228
4229 my @funcs;
4230 my @res = <$fh>;
4231 chomp for @res;
4232 while (@res) {
4233 my ($func, $line) = splice @res, 0, 2, ();
4234 push @funcs, "[$func] $line";
4235 }
4236
4237 @funcs
4238 };
4239
4240 LOG llevInfo, "[ABT] $perl_bt\n";
4241 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4242 LOG llevInfo, "[ABT] $_\n" for @bt;
4243 --$_log_backtrace;
4244 };
4245 } else {
4246 LOG llevInfo, "[ABT] $msg\n";
4247 LOG llevInfo, "[ABT] [overload, suppressed]\n";
4248 }
4249}
4250
4251# load additional modules
4252require "cf/$_.pm" for @EXTRA_MODULES;
4253cf::_connect_to_perl_2;
4254
4255END { cf::emergency_save }
2055 4256
20561 42571
2057 4258

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines