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.202 by root, Mon Jan 29 20:16:28 2007 UTC vs.
Revision 1.560 by root, Fri Apr 22 02:03:12 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines