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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines