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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines