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.226 by root, Wed Mar 14 04:12:29 2007 UTC vs.
Revision 1.557 by root, Tue Oct 5 21:40:05 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines