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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines