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.225 by root, Wed Mar 14 00:04:58 2007 UTC vs.
Revision 1.540 by root, Tue May 4 23:32:29 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines