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.228 by root, Mon Mar 26 16:53:33 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 YAML::Syck (); 57use YAML::XS ();
27use IO::AIO 2.32 (); 58use IO::AIO ();
28use Time::HiRes; 59use Time::HiRes;
29use Compress::LZF; 60use Compress::LZF;
61use Digest::MD5 ();
62
63AnyEvent::detect;
30 64
31# configure various modules to our taste 65# configure various modules to our taste
32# 66#
67$Storable::canonical = 1; # reduce rsync transfers
33Coro::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";
34Compress::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
35 75
36$Event::Eval = 1; # no idea why this is required, but it is 76# strictly for debugging
37 77$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
38# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
39$YAML::Syck::ImplicitUnicode = 1;
40
41$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
42 78
43sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 79sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
80
81our @ORIG_INC;
44 82
45our %COMMAND = (); 83our %COMMAND = ();
46our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
47 85
48our @EXTS = (); # list of extension package names 86our @EXTS = (); # list of extension package names
49our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
50our %EXT_CORO = (); # coroutines bound to extensions 89our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 90our %EXT_MAP = (); # pluggable maps
52 91
53our $RELOAD; # number of reloads so far 92our $RELOAD; # number of reloads so far, non-zero while in reload
54our @EVENT; 93our @EVENT;
55our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
56 96
57our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
58our $TICK_WATCHER; 98our $DATADIR = datadir;
59our $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(!)
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 121our $NEXT_TICK;
62our $NOW;
63our $USE_FSYNC = 1; # use fsync to write maps - default off 122our $USE_FSYNC = 1; # use fsync to write maps - default on
64 123
124our $BDB_DEADLOCK_WATCHER;
125our $BDB_CHECKPOINT_WATCHER;
65our $BDB_POLL_WATCHER; 126our $BDB_TRICKLE_WATCHER;
66our $DB_ENV; 127our $DB_ENV;
128
129our @EXTRA_MODULES = qw(pod match mapscript);
67 130
68our %CFG; 131our %CFG;
69 132
70our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
71our $RUNTIME; 134our $RUNTIME;
135our $NOW;
72 136
73our %PLAYER; # all users 137our (%PLAYER, %PLAYER_LOADING); # all users
74our %MAP; # all maps 138our (%MAP, %MAP_LOADING ); # all maps
75our $LINK_MAP; # the special {link} map, which is always available 139our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 140
82# 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 ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 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
85binmode STDOUT; 154binmode STDOUT;
86binmode STDERR; 155binmode STDERR;
87 156
88# read virtual server time, if available 157# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
90 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
91 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
92 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
93} 162}
94 163
95mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
96mkdir cf::localdir . "/" . cf::playerdir; 165
97mkdir cf::localdir . "/" . cf::tmpdir; 166mkdir $_
98mkdir cf::localdir . "/" . cf::uniquedir; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 168
102our $EMERGENCY_POSITION; 169our $EMERGENCY_POSITION;
103 170
104sub 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::"} };
105 187
106############################################################################# 188#############################################################################
107 189
108=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
109 191
116=item $cf::RUNTIME 198=item $cf::RUNTIME
117 199
118The 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
119every server tick. 201every server tick.
120 202
121=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
122 206
123The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
124be 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.
125 211
126=item $cf::NOW 212=item $cf::NOW
127 213
128The time of the last (current) server tick. 214The time of the last (current) server tick.
129 215
130=item $cf::TICK 216=item $cf::TICK
131 217
132The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
133 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
134=item %cf::CFG 230=item %cf::CFG
135 231
136Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
137from wherever your confdir points to. 233from wherever your confdir points to.
138 234
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 235=item cf::wait_for_tick, cf::wait_for_tick_begin
140 236
141These 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
142or 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
143processing 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.
144window 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.
145 252
146=back 253=back
147 254
148=cut 255=cut
149 256
150BEGIN { 257sub error(@) { LOG llevError, join "", @_ }
151 *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 {
152 my $msg = join "", @_; 264 my $msg = join "", @_;
153 utf8::encode $msg;
154 265
155 $msg .= "\n" 266 $msg .= "\n"
156 unless $msg =~ /\n$/; 267 unless $msg =~ /\n$/;
157 268
269 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
270
158 LOG llevError, $msg; 271 LOG llevWarn, $msg;
159 }; 272};
160} 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};
161 287
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 288@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 289@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 290@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 291@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@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';
167@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)
168 295
169# 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
170# within the Safe compartment. 297# within the Safe compartment.
171for my $pkg (qw( 298for my $pkg (qw(
172 cf::global cf::attachable 299 cf::global cf::attachable
173 cf::object cf::object::player 300 cf::object cf::object::player
174 cf::client cf::player 301 cf::client cf::player
175 cf::arch cf::living 302 cf::arch cf::living
303 cf::map cf::mapspace
176 cf::map cf::party cf::region 304 cf::party cf::region
177)) { 305)) {
178 no strict 'refs';
179 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 306 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
180} 307}
181 308
182$Event::DIED = sub { 309$EV::DIED = sub {
183 warn "error in event callback: @_"; 310 Carp::cluck "error in event callback: @_";
184}; 311};
312
313#############################################################################
185 314
186=head2 UTILITY FUNCTIONS 315=head2 UTILITY FUNCTIONS
187 316
188=over 4 317=over 4
189 318
208 $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;
209 $d 338 $d
210 } || "[unable to dump $_[0]: '$@']"; 339 } || "[unable to dump $_[0]: '$@']";
211} 340}
212 341
213use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215=item $ref = cf::from_json $json 342=item $ref = cf::decode_json $json
216 343
217Converts a JSON string into the corresponding perl data structure. 344Converts a JSON string into the corresponding perl data structure.
218 345
219=item $json = cf::to_json $ref 346=item $json = cf::encode_json $ref
220 347
221Converts a perl data structure into its JSON representation. 348Converts a perl data structure into its JSON representation.
222 349
350=cut
351
352our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
353
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;
369}
370
223=item cf::lock_wait $string 371=item cf::lock_wait $string
224 372
225Wait until the given lock is available. See cf::lock_acquire. 373Wait until the given lock is available. See cf::lock_acquire.
226 374
227=item my $lock = cf::lock_acquire $string 375=item my $lock = cf::lock_acquire $string
228 376
229Wait 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
230a 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,
231for example when the coroutine gets canceled), the lock is automatically 379for example when the coroutine gets canceled), the lock is automatically
232returned. 380returned.
233 381
382Locks are *not* recursive, locking from the same coro twice results in a
383deadlocked coro.
384
234Lock 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
235uses map_find and cf::map::load uses map_load). 386uses map_find and cf::map::load uses map_load).
236 387
237=cut 388=item $locked = cf::lock_active $string
238 389
239our %LOCK; 390Return true if the lock is currently active, i.e. somebody has locked it.
391
392=cut
393
394our $LOCKS = new Coro::SemaphoreSet;
240 395
241sub lock_wait($) { 396sub lock_wait($) {
242 my ($key) = @_; 397 $LOCKS->wait ($_[0]);
243
244 # wait for lock, if any
245 while ($LOCK{$key}) {
246 push @{ $LOCK{$key} }, $Coro::current;
247 Coro::schedule;
248 }
249} 398}
250 399
251sub lock_acquire($) { 400sub lock_acquire($) {
252 my ($key) = @_; 401 $LOCKS->guard ($_[0])
402}
253 403
254 # wait, to be sure we are not locked 404sub lock_active($) {
255 lock_wait $key; 405 $LOCKS->count ($_[0]) < 1
256
257 $LOCK{$key} = [];
258
259 Coro::guard {
260 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} };
262 }
263} 406}
264 407
265sub freeze_mainloop { 408sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 409 tick_inhibit_inc;
267 410
268 my $guard = Coro::guard { 411 &Guard::guard (\&tick_inhibit_dec);
269 $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 }
270 }; 478 }
271 $TICK_WATCHER->stop; 479};
272 $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;
273} 494}
274 495
275=item cf::async { BLOCK } 496=item cf::async { BLOCK }
276 497
277Currently the same as Coro::async_pool, meaning you cannot use 498Currently the same as Coro::async_pool, meaning you cannot use
282 503
283BEGIN { *async = \&Coro::async_pool } 504BEGIN { *async = \&Coro::async_pool }
284 505
285=item cf::sync_job { BLOCK } 506=item cf::sync_job { BLOCK }
286 507
287The design of crossfire+ requires that the main coro ($Coro::main) is 508The design of Deliantra requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 509is always able to handle events or runnable, as Deliantra is only
289reentrant. 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.
290 512
291If 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
292the given BLOCK in another coroutine while waiting for the result. The 514the given BLOCK in another coroutine while waiting for the result. The
293server 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
294fast or be very important. 516fast or be very important.
296=cut 518=cut
297 519
298sub sync_job(&) { 520sub sync_job(&) {
299 my ($job) = @_; 521 my ($job) = @_;
300 522
301 if ($Coro::current == $Coro::main) { 523 if (in_main) {
524 my $time = AE::time;
525
302 # this is the main coro, too bad, we have to block 526 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 527 # till the operation succeeds, freezing the server :/
304 528
305 # TODO: use suspend/resume instead 529 #LOG llevError, Carp::longmess "sync job";#d#
306 # (but this is cancel-safe) 530
307 my $freeze_guard = freeze_mainloop; 531 my $freeze_guard = freeze_mainloop;
308 532
309 my $busy = 1; 533 my $busy = 1;
310 my @res; 534 my @res;
311 535
312 (async { 536 (async {
537 $Coro::current->desc ("sync job coro");
313 @res = eval { $job->() }; 538 @res = eval { $job->() };
314 warn $@ if $@; 539 error $@ if $@;
315 undef $busy; 540 undef $busy;
316 })->prio (Coro::PRIO_MAX); 541 })->prio (Coro::PRIO_MAX);
317 542
318 while ($busy) { 543 while ($busy) {
319 Coro::cede or Event::one_event; 544 if (Coro::nready) {
545 Coro::cede_notself;
546 } else {
547 EV::loop EV::LOOP_ONESHOT;
320 } 548 }
549 }
550
551 my $time = AE::time - $time;
552
553 $TICK_START += $time; # do not account sync jobs to server load
321 554
322 wantarray ? @res : $res[0] 555 wantarray ? @res : $res[0]
323 } else { 556 } else {
324 # we are in another coroutine, how wonderful, everything just works 557 # we are in another coroutine, how wonderful, everything just works
325 558
345 $EXT_CORO{$coro+0} = $coro; 578 $EXT_CORO{$coro+0} = $coro;
346 579
347 $coro 580 $coro
348} 581}
349 582
350sub write_runtime { 583=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 584
353 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.
354 589
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 590=cut
356 or return;
357 591
358 my $value = $cf::RUNTIME + 90 + 10; 592sub fork_call(&@) {
359 # 10 is the runtime save interval, for a monotonic clock 593 my ($cb, @args) = @_;
360 # 60 allows for the watchdog to kill the server.
361 594
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0 595 # we seemingly have to make a local copy of the whole thing,
363 and return; 596 # otherwise perl prematurely frees the stuff :/
597 # TODO: investigate and fix (likely this will be rather laborious)
364 598
365 # always fsync - this file is important 599 my @res = Coro::Util::fork_eval {
366 aio_fsync $fh 600 reset_signals;
367 and return; 601 &$cb
602 }, @args;
368 603
369 close $fh 604 wantarray ? @res : $res[-1]
370 or return; 605}
371 606
372 aio_rename "$runtime~", $runtime 607sub objinfo {
373 and return;
374
375 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 });
376} 783}
377 784
378=back 785=back
379 786
380=cut 787=cut
381 788
382############################################################################# 789#############################################################################
383 790
384=head2 ATTACHABLE OBJECTS 791=head2 ATTACHABLE OBJECTS
385 792
386Many 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
387attach callbacks/event handlers (a collection of which is called an "attachment") 794attach callbacks/event handlers (a collection of which is called an "attachment")
388to it. All such attachable objects support the following methods. 795to it. All such attachable objects support the following methods.
389 796
390In 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>
391C<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
392crossfire+). 799Deliantra).
393 800
394=over 4 801=over 4
395 802
396=item $attachable->attach ($attachment, key => $value...) 803=item $attachable->attach ($attachment, key => $value...)
397 804
441=item cf::CLASS::attachment $name, ... 848=item cf::CLASS::attachment $name, ...
442 849
443Register an attachment by C<$name> through which attachable objects of the 850Register an attachment by C<$name> through which attachable objects of the
444given CLASS can refer to this attachment. 851given CLASS can refer to this attachment.
445 852
446Some classes such as crossfire maps and objects can specify attachments 853Some classes such as deliantra maps and objects can specify attachments
447that 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.
448 855
449These calls expect any number of the following handler/hook descriptions: 856These calls expect any number of the following handler/hook descriptions:
450 857
451=over 4 858=over 4
560 $registry = $CB_TYPE[$object_type] ||= []; 967 $registry = $CB_TYPE[$object_type] ||= [];
561 968
562 } elsif ($type eq "subtype") { 969 } elsif ($type eq "subtype") {
563 defined $object_type or Carp::croak "subtype specified without type"; 970 defined $object_type or Carp::croak "subtype specified without type";
564 my $object_subtype = shift @arg; 971 my $object_subtype = shift @arg;
565 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 972 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
566 973
567 } elsif ($type eq "package") { 974 } elsif ($type eq "package") {
568 my $pkg = shift @arg; 975 my $pkg = shift @arg;
569 976
570 while (my ($name, $id) = each %cb_id) { 977 while (my ($name, $id) = each %cb_id) {
575 982
576 } elsif (exists $cb_id{$type}) { 983 } elsif (exists $cb_id{$type}) {
577 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 984 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
578 985
579 } elsif (ref $type) { 986 } elsif (ref $type) {
580 warn "attaching objects not supported, ignoring.\n"; 987 error "attaching objects not supported, ignoring.\n";
581 988
582 } else { 989 } else {
583 shift @arg; 990 shift @arg;
584 warn "attach argument '$type' not supported, ignoring.\n"; 991 error "attach argument '$type' not supported, ignoring.\n";
585 } 992 }
586 } 993 }
587} 994}
588 995
589sub _object_attach { 996sub _object_attach {
599 _attach $registry, $klass, @attach; 1006 _attach $registry, $klass, @attach;
600 } 1007 }
601 1008
602 $obj->{$name} = \%arg; 1009 $obj->{$name} = \%arg;
603 } else { 1010 } else {
604 warn "object uses attachment '$name' that is not available, postponing.\n"; 1011 info "object uses attachment '$name' which is not available, postponing.\n";
605 } 1012 }
606 1013
607 $obj->{_attachment}{$name} = undef; 1014 $obj->{_attachment}{$name} = undef;
608} 1015}
609 1016
611 if (ref $_[0]) { 1018 if (ref $_[0]) {
612 _object_attach @_; 1019 _object_attach @_;
613 } else { 1020 } else {
614 _attach shift->_attach_registry, @_; 1021 _attach shift->_attach_registry, @_;
615 } 1022 }
1023 _recalc_want;
616}; 1024};
617 1025
618# all those should be optimised 1026# all those should be optimised
619sub cf::attachable::detach { 1027sub cf::attachable::detach {
620 my ($obj, $name) = @_; 1028 my ($obj, $name) = @_;
623 delete $obj->{_attachment}{$name}; 1031 delete $obj->{_attachment}{$name};
624 reattach ($obj); 1032 reattach ($obj);
625 } else { 1033 } else {
626 Carp::croak "cannot, currently, detach class attachments"; 1034 Carp::croak "cannot, currently, detach class attachments";
627 } 1035 }
1036 _recalc_want;
628}; 1037};
629 1038
630sub cf::attachable::attached { 1039sub cf::attachable::attached {
631 my ($obj, $name) = @_; 1040 my ($obj, $name) = @_;
632 1041
647 "; 1056 ";
648 die if $@; 1057 die if $@;
649} 1058}
650 1059
651our $override; 1060our $override;
652our @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?
653 1062
654sub override { 1063sub override {
655 $override = 1; 1064 $override = 1;
656 @invoke_results = (); 1065 @INVOKE_RESULTS = (@_);
657} 1066}
658 1067
659sub do_invoke { 1068sub do_invoke {
660 my $event = shift; 1069 my $event = shift;
661 my $callbacks = shift; 1070 my $callbacks = shift;
662 1071
663 @invoke_results = (); 1072 @INVOKE_RESULTS = ();
664 1073
665 local $override; 1074 local $override;
666 1075
667 for (@$callbacks) { 1076 for (@$callbacks) {
668 eval { &{$_->[1]} }; 1077 eval { &{$_->[1]} };
669 1078
670 if ($@) { 1079 if ($@) {
671 warn "$@";
672 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1080 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
673 override; 1081 override;
674 } 1082 }
675 1083
676 return 1 if $override; 1084 return 1 if $override;
677 } 1085 }
678 1086
679 0 1087 0
680} 1088}
681 1089
682=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1090=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
683 1091
684=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1092=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
685 1093
686Generate an object-specific event with the given arguments. 1094Generate an object-specific event with the given arguments.
687 1095
688This 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
689removed 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
690results (if you must, access C<@cf::invoke_results> directly). 1098results (if you must, access C<@cf::INVOKE_RESULTS> directly).
691 1099
692=back 1100=back
693 1101
694=cut 1102=cut
695 1103
696############################################################################# 1104#############################################################################
697# 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}
698 1148
699sub reattach { 1149sub reattach {
700 # basically do the same as instantiate, without calling instantiate 1150 # basically do the same as instantiate, without calling instantiate
701 my ($obj) = @_; 1151 my ($obj) = @_;
702 1152
1153 # no longer needed after getting rid of delete_package?
703 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
704 1155
705 my $registry = $obj->registry; 1156 my $registry = $obj->registry;
706 1157
707 @$registry = (); 1158 @$registry = ();
708 1159
713 for (@$attach) { 1164 for (@$attach) {
714 my ($klass, @attach) = @$_; 1165 my ($klass, @attach) = @$_;
715 _attach $registry, $klass, @attach; 1166 _attach $registry, $klass, @attach;
716 } 1167 }
717 } else { 1168 } else {
718 warn "object uses attachment '$name' that is not available, postponing.\n"; 1169 info "object uses attachment '$name' that is not available, postponing.\n";
719 } 1170 }
720 } 1171 }
721} 1172}
722 1173
723cf::attachable->attach ( 1174cf::attachable->attach (
724 prio => -1000000, 1175 prio => -1000000,
725 on_instantiate => sub { 1176 on_instantiate => sub {
726 my ($obj, $data) = @_; 1177 my ($obj, $data) = @_;
727 1178
728 $data = from_json $data; 1179 $data = decode_json $data;
729 1180
730 for (@$data) { 1181 for (@$data) {
731 my ($name, $args) = @$_; 1182 my ($name, $args) = @$_;
732 1183
733 $obj->attach ($name, %{$args || {} }); 1184 $obj->attach ($name, %{$args || {} });
749sub object_freezer_save { 1200sub object_freezer_save {
750 my ($filename, $rdata, $objs) = @_; 1201 my ($filename, $rdata, $objs) = @_;
751 1202
752 sync_job { 1203 sync_job {
753 if (length $$rdata) { 1204 if (length $$rdata) {
1205 utf8::decode (my $decname = $filename);
754 warn sprintf "saving %s (%d,%d)\n", 1206 trace sprintf "saving %s (%d,%d)\n",
755 $filename, length $$rdata, scalar @$objs; 1207 $decname, length $$rdata, scalar @$objs
1208 if $VERBOSE_IO;
756 1209
757 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1210 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
758 chmod SAVE_MODE, $fh; 1211 aio_chmod $fh, SAVE_MODE;
759 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1212 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
760 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 }
761 close $fh; 1217 aio_close $fh;
762 1218
763 if (@$objs) { 1219 if (@$objs) {
764 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) {
765 chmod SAVE_MODE, $fh; 1221 aio_chmod $fh, SAVE_MODE;
766 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1222 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
767 aio_write $fh, 0, (length $data), $data, 0; 1223 aio_write $fh, 0, (length $data), $data, 0;
768 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 }
769 close $fh; 1228 aio_close $fh;
770 aio_rename "$filename.pst~", "$filename.pst"; 1229 aio_rename "$filename.pst~", "$filename.pst";
771 } 1230 }
772 } else { 1231 } else {
773 aio_unlink "$filename.pst"; 1232 aio_unlink "$filename.pst";
774 } 1233 }
775 1234
776 aio_rename "$filename~", $filename; 1235 aio_rename "$filename~", $filename;
1236
1237 $filename =~ s%/[^/]+$%%;
1238 aio_pathsync $filename if $cf::USE_FSYNC;
777 } else { 1239 } else {
778 warn "FATAL: $filename~: $!\n"; 1240 error "unable to save objects: $filename~: $!\n";
779 } 1241 }
780 } else { 1242 } else {
781 aio_unlink $filename; 1243 aio_unlink $filename;
782 aio_unlink "$filename.pst"; 1244 aio_unlink "$filename.pst";
783 } 1245 }
784 } 1246 };
785} 1247}
786 1248
787sub object_freezer_as_string { 1249sub object_freezer_as_string {
788 my ($rdata, $objs) = @_; 1250 my ($rdata, $objs) = @_;
789 1251
801 or return; 1263 or return;
802 1264
803 unless (aio_stat "$filename.pst") { 1265 unless (aio_stat "$filename.pst") {
804 (aio_load "$filename.pst", $av) >= 0 1266 (aio_load "$filename.pst", $av) >= 0
805 or return; 1267 or return;
1268
806 $av = eval { (Storable::thaw $av)->{objs} }; 1269 my $st = eval { Coro::Storable::thaw $av };
1270 $av = $st->{objs};
807 } 1271 }
808 1272
1273 utf8::decode (my $decname = $filename);
809 warn sprintf "loading %s (%d)\n", 1274 trace sprintf "loading %s (%d,%d)\n",
810 $filename, length $data, scalar @{$av || []};#d# 1275 $decname, length $data, scalar @{$av || []}
1276 if $VERBOSE_IO;
1277
811 return ($data, $av); 1278 ($data, $av)
812} 1279}
1280
1281=head2 COMMAND CALLBACKS
1282
1283=over 4
1284
1285=cut
813 1286
814############################################################################# 1287#############################################################################
815# command handling &c 1288# command handling &c
816 1289
817=item cf::register_command $name => \&callback($ob,$args); 1290=item cf::register_command $name => \&callback($ob,$args);
830 push @{ $COMMAND{$name} }, [$caller, $cb]; 1303 push @{ $COMMAND{$name} }, [$caller, $cb];
831} 1304}
832 1305
833=item cf::register_extcmd $name => \&callback($pl,$packet); 1306=item cf::register_extcmd $name => \&callback($pl,$packet);
834 1307
835Register 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.
836 1313
837If 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
838called. 1315called.
839 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
840=cut 1328=cut
841 1329
842sub register_extcmd { 1330sub register_extcmd {
843 my ($name, $cb) = @_; 1331 my ($name, $cb) = @_;
844 1332
845 $EXTCMD{$name} = $cb; 1333 $EXTCMD{$name} = $cb;
846} 1334}
847 1335
1336sub register_exticmd {
1337 my ($name, $cb) = @_;
1338
1339 $EXTICMD{$name} = $cb;
1340}
1341
1342use File::Glob ();
1343
848cf::player->attach ( 1344cf::player->attach (
849 on_command => sub { 1345 on_unknown_command => sub {
850 my ($pl, $name, $params) = @_; 1346 my ($pl, $name, $params) = @_;
851 1347
852 my $cb = $COMMAND{$name} 1348 my $cb = $COMMAND{$name}
853 or return; 1349 or return;
854 1350
859 cf::override; 1355 cf::override;
860 }, 1356 },
861 on_extcmd => sub { 1357 on_extcmd => sub {
862 my ($pl, $buf) = @_; 1358 my ($pl, $buf) = @_;
863 1359
864 my $msg = eval { from_json $buf }; 1360 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
865 1361
866 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
867 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1370 if (my $cb = $EXTCMD{$type}) {
868 if (my %reply = $cb->($pl, $msg)) { 1371 @reply = $cb->($pl, @payload);
869 $pl->ext_reply ($msg->{msgid}, %reply);
870 }
871 } 1372 }
1373
1374 $pl->ext_reply ($reply, @reply)
1375 if $reply;
1376
872 } else { 1377 } else {
873 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1378 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
874 } 1379 }
875 1380
876 cf::override; 1381 cf::override;
877 }, 1382 },
878); 1383);
879 1384
1385# "readahead" all extensions
880sub load_extension { 1386sub cache_extensions {
881 my ($path) = @_; 1387 my $grp = IO::AIO::aio_group;
882 1388
883 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1389 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
884 my $base = $1; 1390 for (grep /\.ext$/, @{$_[0]}) {
885 my $pkg = $1; 1391 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
886 $pkg =~ s/[^[:word:]]/_/g;
887 $pkg = "ext::$pkg";
888
889 warn "... loading '$path' into '$pkg'\n";
890
891 open my $fh, "<:utf8", $path
892 or die "$path: $!";
893
894 my $source =
895 "package $pkg; use strict; use utf8;\n"
896 . "#line 1 \"$path\"\n{\n"
897 . (do { local $/; <$fh> })
898 . "\n};\n1";
899
900 unless (eval $source) {
901 my $msg = $@ ? "$path: $@\n"
902 : "extension disabled.\n";
903 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
904 warn $@;
905 warn "mandatory extension failed to load, exiting.\n";
906 exit 1;
907 } 1392 }
908 die $@;
909 } 1393 };
910 1394
911 push @EXTS, $pkg; 1395 $grp
912} 1396}
913 1397
914sub load_extensions { 1398sub load_extensions {
1399 info "loading extensions...";
1400
1401 cf::sync_job {
1402 my %todo;
1403
915 for my $ext (<$LIBDIR/*.ext>) { 1404 for my $path (<$LIBDIR/*.ext>) {
916 next unless -r $ext; 1405 next unless -r $path;
917 eval { 1406
918 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 }
919 1 1471 }
920 } 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 }
921 } 1482 };
922} 1483}
923 1484
924############################################################################# 1485#############################################################################
925 1486
1487=back
1488
926=head2 CORE EXTENSIONS 1489=head2 CORE EXTENSIONS
927 1490
928Functions and methods that extend core crossfire objects. 1491Functions and methods that extend core deliantra objects.
929 1492
930=cut 1493=cut
931 1494
932package cf::player; 1495package cf::player;
933 1496
935 1498
936=head3 cf::player 1499=head3 cf::player
937 1500
938=over 4 1501=over 4
939 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
940=item cf::player::find $login 1517=item cf::player::find $login
941 1518
942Returns the given player object, loading it if necessary (might block). 1519Returns the given player object, loading it if necessary (might block).
943 1520
944=cut 1521=cut
945 1522
946sub playerdir($) { 1523sub playerdir($) {
947 cf::localdir 1524 "$PLAYERDIR/"
948 . "/"
949 . cf::playerdir
950 . "/"
951 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1525 . (ref $_[0] ? $_[0]->ob->name : $_[0])
952} 1526}
953 1527
954sub path($) { 1528sub path($) {
955 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1529 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
956 1530
957 (playerdir $login) . "/$login.pl" 1531 (playerdir $login) . "/playerdata"
958} 1532}
959 1533
960sub find_active($) { 1534sub find_active($) {
961 $cf::PLAYER{$_[0]} 1535 $cf::PLAYER{$_[0]}
962 and $cf::PLAYER{$_[0]}->active 1536 and $cf::PLAYER{$_[0]}->active
965 1539
966sub exists($) { 1540sub exists($) {
967 my ($login) = @_; 1541 my ($login) = @_;
968 1542
969 $cf::PLAYER{$login} 1543 $cf::PLAYER{$login}
970 or cf::sync_job { !aio_stat path $login } 1544 or !aio_stat path $login
971} 1545}
972 1546
973sub find($) { 1547sub find($) {
974 return $cf::PLAYER{$_[0]} || do { 1548 return $cf::PLAYER{$_[0]} || do {
975 my $login = $_[0]; 1549 my $login = $_[0];
976 1550
977 my $guard = cf::lock_acquire "user_find:$login"; 1551 my $guard = cf::lock_acquire "user_find:$login";
978 1552
979 $cf::PLAYER{$_[0]} || do { 1553 $cf::PLAYER{$_[0]} || do {
980 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
981 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;
982 $cf::PLAYER{$login} = $pl 1569 $cf::PLAYER{$login} = $pl
983 } 1570 }
984 } 1571 }
985} 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);
986 1586
987sub save($) { 1587sub save($) {
988 my ($pl) = @_; 1588 my ($pl) = @_;
989 1589
990 return if $pl->{deny_save}; 1590 return if $pl->{deny_save};
995 return if $pl->{deny_save}; 1595 return if $pl->{deny_save};
996 1596
997 aio_mkdir playerdir $pl, 0770; 1597 aio_mkdir playerdir $pl, 0770;
998 $pl->{last_save} = $cf::RUNTIME; 1598 $pl->{last_save} = $cf::RUNTIME;
999 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
1000 $pl->save_pl ($path); 1605 $pl->save_pl ($path);
1001 Coro::cede; 1606 cf::cede_to_tick;
1002} 1607}
1003 1608
1004sub new($) { 1609sub new($) {
1005 my ($login) = @_; 1610 my ($login) = @_;
1006 1611
1012 $cf::PLAYER{$login} = $self; 1617 $cf::PLAYER{$login} = $self;
1013 1618
1014 $self 1619 $self
1015} 1620}
1016 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
1017=item $pl->quit_character 1632=item $pl->quit_character
1018 1633
1019Nukes the player without looking back. If logged in, the connection will 1634Nukes the player without looking back. If logged in, the connection will
1020be destroyed. May block for a long time. 1635be destroyed. May block for a long time.
1021 1636
1025 my ($pl) = @_; 1640 my ($pl) = @_;
1026 1641
1027 my $name = $pl->ob->name; 1642 my $name = $pl->ob->name;
1028 1643
1029 $pl->{deny_save} = 1; 1644 $pl->{deny_save} = 1;
1030 $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
1031 1646
1032 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1647 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1033 $pl->deactivate; 1648 $pl->deactivate;
1649 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1034 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1650 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1035 $pl->ns->destroy if $pl->ns; 1651 $pl->ns->destroy if $pl->ns;
1036 1652
1037 my $path = playerdir $pl; 1653 my $path = playerdir $pl;
1038 my $temp = "$path~$cf::RUNTIME~deleting~"; 1654 my $temp = "$path~$cf::RUNTIME~deleting~";
1068while and may block, so not sync_job-capable, ever. 1684while and may block, so not sync_job-capable, ever.
1069 1685
1070=cut 1686=cut
1071 1687
1072sub list_logins { 1688sub list_logins {
1073 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1689 my $dirs = aio_readdir $PLAYERDIR
1074 or return []; 1690 or return [];
1075 1691
1076 my @logins; 1692 my @logins;
1077 1693
1078 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") {
1079 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1700 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1080 aio_read $fh, 0, 512, my $buf, 0 or next; 1701 aio_read $fh, 0, 512, my $buf, 0 or next;
1081 $buf !~ /^password -------------$/m or next; # official not-valid tag 1702 $buf !~ /^password -------------$/m or next; # official not-valid tag
1703 }
1082 1704
1083 utf8::decode $login; 1705 utf8::decode $login;
1084 push @logins, $login; 1706 push @logins, $login;
1085 } 1707 }
1086 1708
1087 \@logins 1709 \@logins
1088} 1710}
1089 1711
1090=item $player->maps 1712=item $player->maps
1713
1714=item cf::player::maps $login
1091 1715
1092Returns an arrayref of map paths that are private for this 1716Returns an arrayref of map paths that are private for this
1093player. May block. 1717player. May block.
1094 1718
1095=cut 1719=cut
1113 } 1737 }
1114 1738
1115 \@paths 1739 \@paths
1116} 1740}
1117 1741
1742=item $protocol_xml = $player->expand_cfpod ($cfpod)
1743
1744Expand deliantra pod fragments into protocol xml.
1745
1118=item $player->ext_reply ($msgid, $msgtype, %msg) 1746=item $player->ext_reply ($msgid, @msg)
1119 1747
1120Sends an ext reply to the player. 1748Sends an ext reply to the player.
1121 1749
1122=cut 1750=cut
1123 1751
1124sub ext_reply($$$%) { 1752sub ext_reply($$@) {
1125 my ($self, $id, %msg) = @_; 1753 my ($self, $id, @msg) = @_;
1126 1754
1127 $msg{msgid} = $id; 1755 $self->ns->ext_reply ($id, @msg)
1128
1129 $self->send ("ext " . cf::to_json \%msg);
1130} 1756}
1131 1757
1132package 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}
1133 1800
1134=back 1801=back
1135
1136 1802
1137=head3 cf::map 1803=head3 cf::map
1138 1804
1139=over 4 1805=over 4
1140 1806
1152our $MAX_RESET = 3600; 1818our $MAX_RESET = 3600;
1153our $DEFAULT_RESET = 3000; 1819our $DEFAULT_RESET = 3000;
1154 1820
1155sub generate_random_map { 1821sub generate_random_map {
1156 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
1157 # mit "rum" bekleckern, nicht 1826 # mit "rum" bekleckern, nicht
1158 $self->_create_random_map ( 1827 $self->_create_random_map (
1159 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1828 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1160 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1829 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1161 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1830 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1162 $rmp->{exit_on_final_map}, 1831 $rmp->{exit_on_final_map},
1163 $rmp->{xsize}, $rmp->{ysize}, 1832 $rmp->{xsize}, $rmp->{ysize},
1164 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1833 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1165 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1834 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1180 1849
1181sub register { 1850sub register {
1182 my (undef, $regex, $prio) = @_; 1851 my (undef, $regex, $prio) = @_;
1183 my $pkg = caller; 1852 my $pkg = caller;
1184 1853
1185 no strict;
1186 push @{"$pkg\::ISA"}, __PACKAGE__; 1854 push @{"$pkg\::ISA"}, __PACKAGE__;
1187 1855
1188 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1856 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1189} 1857}
1190 1858
1191# also paths starting with '/' 1859# also paths starting with '/'
1192$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1860$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1193 1861
1194sub thawer_merge { 1862sub thawer_merge {
1195 my ($self, $merge) = @_; 1863 my ($self, $merge) = @_;
1196 1864
1197 # we have to keep some variables in memory intact 1865 # we have to keep some variables in memory intact
1198 local $self->{path}; 1866 local $self->{path};
1199 local $self->{load_path}; 1867 local $self->{load_path};
1200 local $self->{deny_save};
1201 local $self->{deny_reset};
1202 1868
1203 $self->SUPER::thawer_merge ($merge); 1869 $self->SUPER::thawer_merge ($merge);
1204} 1870}
1205 1871
1206sub normalise { 1872sub normalise {
1253 $self->init; # pass $1 etc. 1919 $self->init; # pass $1 etc.
1254 return $self; 1920 return $self;
1255 } 1921 }
1256 } 1922 }
1257 1923
1258 Carp::carp "unable to resolve path '$path' (base '$base')."; 1924 Carp::cluck "unable to resolve path '$path' (base '$base').";
1259 () 1925 ()
1260} 1926}
1261 1927
1262sub init { 1928sub init {
1263 my ($self) = @_; 1929 my ($self) = @_;
1278 1944
1279# the original (read-only) location 1945# the original (read-only) location
1280sub load_path { 1946sub load_path {
1281 my ($self) = @_; 1947 my ($self) = @_;
1282 1948
1283 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1949 "$MAPDIR/$self->{path}.map"
1284} 1950}
1285 1951
1286# the temporary/swap location 1952# the temporary/swap location
1287sub save_path { 1953sub save_path {
1288 my ($self) = @_; 1954 my ($self) = @_;
1289 1955
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1956 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1291 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1957 "$TMPDIR/$path.map"
1292} 1958}
1293 1959
1294# the unique path, undef == no special unique path 1960# the unique path, undef == no special unique path
1295sub uniq_path { 1961sub uniq_path {
1296 my ($self) = @_; 1962 my ($self) = @_;
1297 1963
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1964 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1299 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1965 "$UNIQUEDIR/$path"
1300} 1966}
1301 1967
1302# and all this just because we cannot iterate over 1968sub decay_objects {
1303# all maps in C++...
1304sub change_all_map_light {
1305 my ($change) = @_; 1969 my ($self) = @_;
1306 1970
1307 $_->change_map_light ($change) 1971 return if $self->{deny_reset};
1308 for grep $_->outdoor, values %cf::MAP; 1972
1973 $self->do_decay_objects;
1309} 1974}
1310 1975
1311sub unlink_save { 1976sub unlink_save {
1312 my ($self) = @_; 1977 my ($self) = @_;
1313 1978
1318 1983
1319sub load_header_from($) { 1984sub load_header_from($) {
1320 my ($self, $path) = @_; 1985 my ($self, $path) = @_;
1321 1986
1322 utf8::encode $path; 1987 utf8::encode $path;
1323 #aio_open $path, O_RDONLY, 0 1988 my $f = new_from_file cf::object::thawer $path
1324 # or return;
1325
1326 $self->_load_header ($path)
1327 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;
1328 1996
1329 $self->{load_path} = $path; 1997 $self->{load_path} = $path;
1330 1998
1331 1 1999 1
1332} 2000}
1371 $self->load_header_orig 2039 $self->load_header_orig
1372 or return; 2040 or return;
1373 $self->prepare_orig; 2041 $self->prepare_orig;
1374 } 2042 }
1375 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
1376 1 2050 1
1377} 2051}
1378 2052
1379sub find; 2053sub find;
1380sub find { 2054sub find {
1381 my ($path, $origin) = @_; 2055 my ($path, $origin) = @_;
1382 2056
1383 $path = normalise $path, $origin && $origin->path; 2057 $path = normalise $path, $origin && $origin->path;
1384 2058
2059 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1385 cf::lock_wait "map_find:$path"; 2060 my $guard2 = cf::lock_acquire "map_find:$path";
1386 2061
1387 $cf::MAP{$path} || do { 2062 $cf::MAP{$path} || do {
1388 my $guard = cf::lock_acquire "map_find:$path";
1389 my $map = new_from_path cf::map $path 2063 my $map = new_from_path cf::map $path
1390 or return; 2064 or return;
1391 2065
1392 $map->{last_save} = $cf::RUNTIME; 2066 $map->{last_save} = $cf::RUNTIME;
1393 2067
1394 $map->load_header 2068 $map->load_header
1395 or return; 2069 or return;
1396 2070
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2071 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 2072 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 2073 #$cf::WAIT_FOR_TICK->wait;
2074 undef $guard2;
2075 undef $guard1;
1400 $map->reset; 2076 $map->reset;
1401 undef $guard;
1402 return find $path; 2077 return find $path;
1403 } 2078 }
1404 2079
1405 $cf::MAP{$path} = $map 2080 $cf::MAP{$path} = $map
1406 } 2081 }
1407} 2082}
1408 2083
1409sub pre_load { } 2084sub pre_load { }
1410sub post_load { } 2085#sub post_load { } # XS
1411 2086
1412sub load { 2087sub load {
1413 my ($self) = @_; 2088 my ($self) = @_;
1414 2089
1415 local $self->{deny_reset} = 1; # loading can take a long time 2090 local $self->{deny_reset} = 1; # loading can take a long time
1416 2091
1417 my $path = $self->{path}; 2092 my $path = $self->{path};
2093
2094 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 2095 my $guard = cf::lock_acquire "map_data:$path";
1419 2096
2097 return unless $self->valid;
1420 return if $self->in_memory != cf::MAP_SWAPPED; 2098 return unless $self->in_memory == cf::MAP_SWAPPED;
1421 2099
1422 $self->in_memory (cf::MAP_LOADING); 2100 $self->in_memory (cf::MAP_LOADING);
1423 2101
1424 $self->alloc; 2102 $self->alloc;
1425 2103
1426 $self->pre_load; 2104 $self->pre_load;
2105 cf::cede_to_tick;
1427 2106
1428 $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)
1429 or return; 2110 or return;
1430 2111
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2112 $self->post_load_original
1432 if delete $self->{load_original}; 2113 if delete $self->{load_original};
1433 2114
1434 if (my $uniq = $self->uniq_path) { 2115 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq; 2116 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) { 2117 unless (aio_stat $uniq) {
2118 if (my $f = new_from_file cf::object::thawer $uniq) {
1437 $self->clear_unique_items; 2119 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0); 2120 $self->_load_objects ($f);
2121 $f->resolve_delayed_derefs;
2122 }
1439 } 2123 }
1440 } 2124 }
1441 2125
1442 Coro::cede; 2126 $f->resolve_delayed_derefs;
1443 2127
2128 cf::cede_to_tick;
1444 # now do the right thing for maps 2129 # now do the right thing for maps
1445 $self->link_multipart_objects; 2130 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede;
1452 $self->set_darkness_map;
1453 $self->difficulty ($self->estimate_difficulty) 2131 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 2132 unless $self->difficulty;
1455 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;
1456 $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);
1457 } 2147 }
1458 2148
1459 $self->post_load; 2149 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 2150}
1463 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
1464sub customise_for { 2155sub customise_for {
1465 my ($self, $ob) = @_; 2156 my ($self, $ob) = @_;
1466 2157
1467 return find "~" . $ob->name . "/" . $self->{path} 2158 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 2159 if $self->per_player;
1469 2160
2161# return find "?party/" . $ob->name . "/" . $self->{path}
2162# if $self->per_party;
2163
1470 $self 2164 $self
1471} 2165}
1472 2166
1473# 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
1474sub load_diag { 2168sub load_neighbours {
1475 my ($map) = @_; 2169 my ($map) = @_;
1476 2170
1477 my @diag; # diagonal neighbours 2171 my @neigh; # diagonal neighbours
1478 2172
1479 for (0 .. 3) { 2173 for (0 .. 3) {
1480 my $neigh = $map->tile_path ($_) 2174 my $neigh = $map->tile_path ($_)
1481 or next; 2175 or next;
1482 $neigh = find $neigh, $map 2176 $neigh = find $neigh, $map
1483 or next; 2177 or next;
1484 $neigh->load; 2178 $neigh->load;
1485 2179
2180 # now find the diagonal neighbours
2181 push @neigh,
1486 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2182 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1487 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2183 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1488 } 2184 }
1489 2185
1490 for (@diag) { 2186 for (grep defined $_->[0], @neigh) {
2187 my ($path, $origin) = @$_;
1491 my $neigh = find @$_ 2188 my $neigh = find $path, $origin
1492 or next; 2189 or next;
1493 $neigh->load; 2190 $neigh->load;
1494 } 2191 }
1495} 2192}
1496 2193
1497sub find_sync { 2194sub find_sync {
1498 my ($path, $origin) = @_; 2195 my ($path, $origin) = @_;
1499 2196
1500 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
1501} 2201}
1502 2202
1503sub do_load_sync { 2203sub do_load_sync {
1504 my ($map) = @_; 2204 my ($map) = @_;
1505 2205
1506 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;
1507} 2210}
1508 2211
1509our %MAP_PREFETCH; 2212our %MAP_PREFETCH;
1510our $MAP_PREFETCHER = undef; 2213our $MAP_PREFETCHER = undef;
1511 2214
1512sub find_async { 2215sub find_async {
1513 my ($path, $origin) = @_; 2216 my ($path, $origin, $load) = @_;
1514 2217
1515 $path = normalise $path, $origin && $origin->{path}; 2218 $path = normalise $path, $origin && $origin->{path};
1516 2219
1517 if (my $map = $cf::MAP{$path}) { 2220 if (my $map = $cf::MAP{$path}) {
1518 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2221 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1519 } 2222 }
1520 2223
1521 undef $MAP_PREFETCH{$path}; 2224 $MAP_PREFETCH{$path} |= $load;
2225
1522 $MAP_PREFETCHER ||= cf::async { 2226 $MAP_PREFETCHER ||= cf::async {
2227 $Coro::current->{desc} = "map prefetcher";
2228
1523 while (%MAP_PREFETCH) { 2229 while (%MAP_PREFETCH) {
1524 for my $path (keys %MAP_PREFETCH) { 2230 while (my ($k, $v) = each %MAP_PREFETCH) {
1525 my $map = find $path 2231 if (my $map = find $k) {
1526 or next;
1527 $map->load; 2232 $map->load if $v;
2233 }
1528 2234
1529 delete $MAP_PREFETCH{$path}; 2235 delete $MAP_PREFETCH{$k};
1530 } 2236 }
1531 } 2237 }
1532 undef $MAP_PREFETCHER; 2238 undef $MAP_PREFETCHER;
1533 }; 2239 };
1534 $MAP_PREFETCHER->prio (6); 2240 $MAP_PREFETCHER->prio (6);
1535 2241
1536 () 2242 ()
1537} 2243}
1538 2244
2245# common code, used by both ->save and ->swapout
1539sub save { 2246sub _save {
1540 my ($self) = @_; 2247 my ($self) = @_;
1541
1542 my $lock = cf::lock_acquire "map_data:" . $self->path;
1543 2248
1544 $self->{last_save} = $cf::RUNTIME; 2249 $self->{last_save} = $cf::RUNTIME;
1545 2250
1546 return unless $self->dirty; 2251 return unless $self->dirty;
1547 2252
1553 return if $self->{deny_save}; 2258 return if $self->{deny_save};
1554 2259
1555 local $self->{last_access} = $self->last_access;#d# 2260 local $self->{last_access} = $self->last_access;#d#
1556 2261
1557 cf::async { 2262 cf::async {
2263 $Coro::current->{desc} = "map player save";
1558 $_->contr->save for $self->players; 2264 $_->contr->save for $self->players;
1559 }; 2265 };
2266
2267 cf::get_slot 0.02;
1560 2268
1561 if ($uniq) { 2269 if ($uniq) {
1562 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2270 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1563 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2271 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1564 } else { 2272 } else {
1565 $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);
1566 } 2274 }
1567} 2275}
1568 2276
2277sub save {
2278 my ($self) = @_;
2279
2280 my $lock = cf::lock_acquire "map_data:$self->{path}";
2281
2282 $self->_save;
2283}
2284
1569sub swap_out { 2285sub swap_out {
1570 my ($self) = @_; 2286 my ($self) = @_;
1571 2287
1572 # save first because save cedes
1573 $self->save;
1574
1575 my $lock = cf::lock_acquire "map_data:" . $self->path; 2288 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2289
2290 return if $self->in_memory != cf::MAP_ACTIVE;
2291 return if $self->{deny_save};
1577 return if $self->players; 2292 return if $self->players;
1578 return if $self->in_memory != cf::MAP_IN_MEMORY;
1579 return if $self->{deny_save};
1580 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
1581 $self->clear; 2303 $self->clear;
1582 $self->in_memory (cf::MAP_SWAPPED);
1583} 2304}
1584 2305
1585sub reset_at { 2306sub reset_at {
1586 my ($self) = @_; 2307 my ($self) = @_;
1587 2308
1588 # TODO: safety, remove and allow resettable per-player maps 2309 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 2310 return 1e99 if $self->{deny_reset};
1591 2311
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2312 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 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;
1594 2314
1605 my ($self) = @_; 2325 my ($self) = @_;
1606 2326
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2327 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 2328
1609 return if $self->players; 2329 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 2330
1612 warn "resetting map ", $self->path;#d# 2331 cf::trace "resetting map ", $self->path, "\n";
1613 2332
1614 $self->in_memory (cf::MAP_SWAPPED); 2333 $self->in_memory (cf::MAP_SWAPPED);
1615 2334
1616 # need to save uniques path 2335 # need to save uniques path
1617 unless ($self->{deny_save}) { 2336 unless ($self->{deny_save}) {
1621 if $uniq; 2340 if $uniq;
1622 } 2341 }
1623 2342
1624 delete $cf::MAP{$self->path}; 2343 delete $cf::MAP{$self->path};
1625 2344
2345 $self->deactivate;
2346 $_->clear_links_to ($self) for values %cf::MAP;
1626 $self->clear; 2347 $self->clear;
1627
1628 $_->clear_links_to ($self) for values %cf::MAP;
1629 2348
1630 $self->unlink_save; 2349 $self->unlink_save;
1631 $self->destroy; 2350 $self->destroy;
1632} 2351}
1633 2352
1634my $nuke_counter = "aaaa"; 2353my $nuke_counter = "aaaa";
1635 2354
1636sub nuke { 2355sub nuke {
1637 my ($self) = @_; 2356 my ($self) = @_;
1638 2357
2358 {
2359 my $lock = cf::lock_acquire "map_data:$self->{path}";
2360
1639 delete $cf::MAP{$self->path}; 2361 delete $cf::MAP{$self->path};
1640 2362
1641 $self->unlink_save; 2363 $self->unlink_save;
1642 2364
1643 bless $self, "cf::map"; 2365 bless $self, "cf::map::wrap";
1644 delete $self->{deny_reset}; 2366 delete $self->{deny_reset};
1645 $self->{deny_save} = 1; 2367 $self->{deny_save} = 1;
1646 $self->reset_timeout (1); 2368 $self->reset_timeout (1);
1647 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2369 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1648 2370
1649 $cf::MAP{$self->path} = $self; 2371 $cf::MAP{$self->path} = $self;
2372 }
1650 2373
1651 $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 ]
1652} 2411}
1653 2412
1654=item cf::map::unique_maps 2413=item cf::map::unique_maps
1655 2414
1656Returns an arrayref of paths of all shared maps that have 2415Returns an arrayref of paths of all shared maps that have
1657instantiated unique items. May block. 2416instantiated unique items. May block.
1658 2417
1659=cut 2418=cut
1660 2419
1661sub unique_maps() { 2420sub unique_maps() {
1662 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2421 [
1663 or return; 2422 map {
1664
1665 my @paths;
1666
1667 for (@$files) {
1668 utf8::decode $_; 2423 utf8::decode $_;
1669 next if /\.pst$/; 2424 s/\.map$//; # TODO future compatibility hack
1670 next unless /^$PATH_SEP/o; 2425 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1671 2426 ? ()
1672 push @paths, cf::map::normalise $_; 2427 : normalise $_
2428 } @{ aio_readdir $UNIQUEDIR or [] }
1673 } 2429 ]
1674
1675 \@paths
1676} 2430}
1677 2431
1678package 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}
1679 2463
1680=back 2464=back
1681 2465
1682=head3 cf::object 2466=head3 cf::object
1683 2467
1687 2471
1688=over 4 2472=over 4
1689 2473
1690=item $ob->inv_recursive 2474=item $ob->inv_recursive
1691 2475
1692Returns 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.
1693 2478
1694=cut 2479=cut
1695 2480
1696sub inv_recursive_; 2481sub inv_recursive_;
1697sub inv_recursive_ { 2482sub inv_recursive_ {
1700 2485
1701sub inv_recursive { 2486sub inv_recursive {
1702 inv_recursive_ inv $_[0] 2487 inv_recursive_ inv $_[0]
1703} 2488}
1704 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
1705package cf; 2518package cf;
1706 2519
1707=back 2520=back
1708 2521
1709=head3 cf::object::player 2522=head3 cf::object::player
1715Sends 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>
1716can 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
1717dialogue with the given NPC character. 2530dialogue with the given NPC character.
1718 2531
1719=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};
1720 2547
1721# rough implementation of a future "reply" method that works 2548# rough implementation of a future "reply" method that works
1722# with dialog boxes. 2549# with dialog boxes.
1723#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
1724sub cf::object::player::reply($$$;$) { 2551sub cf::object::player::reply($$$;$) {
1726 2553
1727 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2554 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728 2555
1729 if ($self->{record_replies}) { 2556 if ($self->{record_replies}) {
1730 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2557 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2558
1731 } 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 {
1732 $msg = $npc->name . " says: $msg" if $npc; 2567 $msg = $npc->name . " says: $msg" if $npc;
1733 $self->message ($msg, $flags); 2568 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2569 }
1734 } 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 (@_);
1735} 2581}
1736 2582
1737=item $player_object->may ("access") 2583=item $player_object->may ("access")
1738 2584
1739Returns wether the given player is authorized to access resource "access" 2585Returns wether the given player is authorized to access resource "access"
1752 2598
1753=item $player_object->enter_link 2599=item $player_object->enter_link
1754 2600
1755Freezes 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}>).
1756 2602
1757The 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.
1758I<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.
1759 2607
1760Will never block. 2608Will never block.
1761 2609
1762=item $player_object->leave_link ($map, $x, $y) 2610=item $player_object->leave_link ($map, $x, $y)
1763 2611
1783sub cf::object::player::enter_link { 2631sub cf::object::player::enter_link {
1784 my ($self) = @_; 2632 my ($self) = @_;
1785 2633
1786 $self->deactivate_recursive; 2634 $self->deactivate_recursive;
1787 2635
2636 ++$self->{_link_recursion};
2637
1788 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2638 return if UNIVERSAL::isa $self->map, "ext::map_link";
1789 2639
1790 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2640 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791 if $self->map; 2641 if $self->map && $self->map->{path} ne "{link}";
1792 2642
1793 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2643 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1794} 2644}
1795 2645
1796sub cf::object::player::leave_link { 2646sub cf::object::player::leave_link {
1797 my ($self, $map, $x, $y) = @_; 2647 my ($self, $map, $x, $y) = @_;
2648
2649 return unless $self->contr->active;
1798 2650
1799 my $link_pos = delete $self->{_link_pos}; 2651 my $link_pos = delete $self->{_link_pos};
1800 2652
1801 unless ($map) { 2653 unless ($map) {
1802 # restore original map position 2654 # restore original map position
1813 ($x, $y) = (-1, -1) 2665 ($x, $y) = (-1, -1)
1814 unless (defined $x) && (defined $y); 2666 unless (defined $x) && (defined $y);
1815 2667
1816 # use -1 or undef as default coordinates, not 0, 0 2668 # use -1 or undef as default coordinates, not 0, 0
1817 ($x, $y) = ($map->enter_x, $map->enter_y) 2669 ($x, $y) = ($map->enter_x, $map->enter_y)
1818 if $x <=0 && $y <= 0; 2670 if $x <= 0 && $y <= 0;
1819 2671
1820 $map->load; 2672 $map->load;
1821 $map->load_diag; 2673 $map->load_neighbours;
1822 2674
1823 return unless $self->contr->active; 2675 return unless $self->contr->active;
1824 $self->activate_recursive;
1825 2676
1826 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2677 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827 $self->enter_map ($map, $x, $y); 2678 if ($self->enter_map ($map, $x, $y)) {
1828} 2679 # entering was successful
1829 2680 delete $self->{_link_recursion};
1830cf::player->attach ( 2681 # only activate afterwards, to support waiting in hooks
1831 on_logout => sub { 2682 $self->activate_recursive;
1832 my ($pl) = @_;
1833
1834 # abort map switching before logout
1835 if ($pl->ob->{_link_pos}) {
1836 cf::sync_job {
1837 $pl->ob->leave_link
1838 };
1839 }
1840 }, 2683 }
1841 on_login => sub {
1842 my ($pl) = @_;
1843 2684
1844 # try to abort aborted map switching on player login :) 2685}
1845 # should happen only on crashes
1846 if ($pl->ob->{_link_pos}) {
1847 $pl->ob->enter_link;
1848 (async {
1849 $pl->ob->reply (undef,
1850 "There was an internal problem at your last logout, "
1851 . "the server will try to bring you to your intended destination in a second.",
1852 cf::NDI_RED);
1853 # we need this sleep as the login has a concurrent enter_exit running
1854 # and this sleep increases chances of the player not ending up in scorn
1855 Coro::Timer::sleep 1;
1856 $pl->ob->leave_link;
1857 })->prio (2);
1858 }
1859 },
1860);
1861 2686
1862=item $player_object->goto ($path, $x, $y) 2687=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1863 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
1864=cut 2698=cut
2699
2700our $GOTOGEN;
1865 2701
1866sub cf::object::player::goto { 2702sub cf::object::player::goto {
1867 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;
1868 2713
1869 $self->enter_link; 2714 $self->enter_link;
1870 2715
1871 (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
1872 my $map = eval { 2738 my $map = eval {
1873 my $map = cf::map::find $path; 2739 my $map = defined $path ? cf::map::find $path : undef;
2740
2741 if ($map) {
1874 $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
1875 $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 $@;
1876 } or 2754 }
1877 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878 2755
2756 if ($gen == $self->{_goto_generation}) {
2757 delete $self->{_goto_generation};
1879 $self->leave_link ($map, $x, $y); 2758 $self->leave_link ($map, $x, $y);
2759 }
2760
2761 $done->($self) if $done;
1880 })->prio (1); 2762 })->prio (1);
1881} 2763}
1882 2764
1883=item $player_object->enter_exit ($exit_object) 2765=item $player_object->enter_exit ($exit_object)
1884 2766
1904} 2786}
1905 2787
1906sub prepare_random_map { 2788sub prepare_random_map {
1907 my ($exit) = @_; 2789 my ($exit) = @_;
1908 2790
1909 my $guard = cf::lock_acquire "exit_prepare:$exit";
1910
1911 # all this does is basically replace the /! path by 2791 # all this does is basically replace the /! path by
1912 # a new random map path (?random/...) with a seed 2792 # a new random map path (?random/...) with a seed
1913 # that depends on the exit object 2793 # that depends on the exit object
1914 2794
1915 my $rmp = parse_random_map_params $exit->msg; 2795 my $rmp = parse_random_map_params $exit->msg;
1917 if ($exit->map) { 2797 if ($exit->map) {
1918 $rmp->{region} = $exit->region->name; 2798 $rmp->{region} = $exit->region->name;
1919 $rmp->{origin_map} = $exit->map->path; 2799 $rmp->{origin_map} = $exit->map->path;
1920 $rmp->{origin_x} = $exit->x; 2800 $rmp->{origin_x} = $exit->x;
1921 $rmp->{origin_y} = $exit->y; 2801 $rmp->{origin_y} = $exit->y;
2802
2803 $exit->map->touch;
1922 } 2804 }
1923 2805
1924 $rmp->{random_seed} ||= $exit->random_seed; 2806 $rmp->{random_seed} ||= $exit->random_seed;
1925 2807
1926 my $data = cf::to_json $rmp; 2808 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1927 my $md5 = Digest::MD5::md5_hex $data; 2809 my $md5 = Digest::MD5::md5_hex $data;
1928 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2810 my $meta = "$RANDOMDIR/$md5.meta";
1929 2811
1930 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2812 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931 aio_write $fh, 0, (length $data), $data, 0; 2813 aio_write $fh, 0, (length $data), $data, 0;
1932 undef $fh; 2814 undef $fh;
1933 aio_rename "$meta~", $meta; 2815 aio_rename "$meta~", $meta;
1934 2816
2817 my $slaying = "?random/$md5";
2818
2819 if ($exit->valid) {
1935 $exit->slaying ("?random/$md5"); 2820 $exit->slaying ("?random/$md5");
1936 $exit->msg (undef); 2821 $exit->msg (undef);
2822 }
1937 } 2823 }
1938} 2824}
1939 2825
1940sub cf::object::player::enter_exit { 2826sub cf::object::player::enter_exit {
1941 my ($self, $exit) = @_; 2827 my ($self, $exit) = @_;
1942 2828
1943 return unless $self->type == cf::PLAYER; 2829 return unless $self->type == cf::PLAYER;
1944 2830
1945 if ($exit->slaying eq "/!") {
1946 #TODO: this should de-fi-ni-te-ly not be a sync-job
1947 cf::sync_job { prepare_random_map $exit };
1948 }
1949
1950 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951 my $hp = $exit->stats->hp;
1952 my $sp = $exit->stats->sp;
1953
1954 $self->enter_link; 2831 $self->enter_link;
1955 2832
1956 (async { 2833 (async {
1957 $self->deactivate_recursive; # just to be sure 2834 $Coro::current->{desc} = "enter_exit";
2835
1958 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
1959 $self->goto ($slaying, $hp, $sp); 2851 $self->goto ($map, $x, $y);
1960 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
1961 1; 2857 1
1962 }) { 2858 }) {
1963 $self->message ("Something went wrong deep within the crossfire server. " 2859 $self->message ("Something went wrong deep within the deliantra server. "
1964 . "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. "
1965 . "Please report this to the dungeon master!", 2861 . "Please report this to the dungeon master!",
1966 cf::NDI_UNIQUE | cf::NDI_RED); 2862 cf::NDI_UNIQUE | cf::NDI_RED);
1967 2863
1968 warn "ERROR in enter_exit: $@"; 2864 error "ERROR in enter_exit: $@";
1969 $self->leave_link; 2865 $self->leave_link;
1970 } 2866 }
1971 })->prio (1); 2867 })->prio (1);
1972} 2868}
1973 2869
1987 2883
1988 utf8::encode $text; 2884 utf8::encode $text;
1989 $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);
1990} 2886}
1991 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}
1992 3109
1993=item $success = $client->query ($flags, "text", \&cb) 3110=item $success = $client->query ($flags, "text", \&cb)
1994 3111
1995Queues a query to the client, calling the given callback with 3112Queues a query to the client, calling the given callback with
1996the 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>,
1997C<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>.
1998 3115
1999Queries 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
2000reliable at some point in the future. 3117become reliable at some point in the future.
2001 3118
2002=cut 3119=cut
2003 3120
2004sub cf::client::query { 3121sub cf::client::query {
2005 my ($self, $flags, $text, $cb) = @_; 3122 my ($self, $flags, $text, $cb) = @_;
2013 utf8::encode $text; 3130 utf8::encode $text;
2014 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3131 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015 3132
2016 $self->send_packet ($self->{query_queue}[0][0]) 3133 $self->send_packet ($self->{query_queue}[0][0])
2017 if @{ $self->{query_queue} } == 1; 3134 if @{ $self->{query_queue} } == 1;
3135
3136 1
2018} 3137}
2019 3138
2020cf::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 },
2021 on_reply => sub { 3145 on_reply => sub {
2022 my ($ns, $msg) = @_; 3146 my ($ns, $msg) = @_;
2023 3147
2024 # this weird shuffling is so that direct followup queries 3148 # this weird shuffling is so that direct followup queries
2025 # get handled first 3149 # get handled first
2037 } else { 3161 } else {
2038 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039 } 3163 }
2040 } 3164 }
2041 }, 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 },
2042); 3192);
2043 3193
2044=item $client->async (\&cb) 3194=item $client->async (\&cb)
2045 3195
2046Create a new coroutine, running the specified callback. The coroutine will 3196Create a new coroutine, running the specified callback. The coroutine will
2062 3212
2063 $coro 3213 $coro
2064} 3214}
2065 3215
2066cf::client->attach ( 3216cf::client->attach (
2067 on_destroy => sub { 3217 on_client_destroy => sub {
2068 my ($ns) = @_; 3218 my ($ns) = @_;
2069 3219
2070 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3220 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2071 }, 3221 },
2072); 3222);
2087our $safe = new Safe "safe"; 3237our $safe = new Safe "safe";
2088our $safe_hole = new Safe::Hole; 3238our $safe_hole = new Safe::Hole;
2089 3239
2090$SIG{FPE} = 'IGNORE'; 3240$SIG{FPE} = 'IGNORE';
2091 3241
2092$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));
2093 3247
2094# here we export the classes and methods available to script code 3248# here we export the classes and methods available to script code
2095 3249
2096=pod 3250=pod
2097 3251
2098The following functions and methods are available within a safe environment: 3252The following functions and methods are available within a safe environment:
2099 3253
2100 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
2101 cf::object::player player 3259 cf::object::player
2102 cf::player peaceful 3260 player
2103 cf::map trigger 3261
3262 cf::player
3263 peaceful
3264
3265 cf::map
3266 trigger
2104 3267
2105=cut 3268=cut
2106 3269
2107for ( 3270for (
2108 ["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)],
2109 ["cf::object::player" => qw(player)], 3274 ["cf::object::player" => qw(player)],
2110 ["cf::player" => qw(peaceful)], 3275 ["cf::player" => qw(peaceful send_msg)],
2111 ["cf::map" => qw(trigger)], 3276 ["cf::map" => qw(trigger)],
2112) { 3277) {
2113 no strict 'refs';
2114 my ($pkg, @funs) = @$_; 3278 my ($pkg, @funs) = @$_;
2115 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3279 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2116 for @funs; 3280 for @funs;
2117} 3281}
2118 3282
2133 3297
2134 my $qcode = $code; 3298 my $qcode = $code;
2135 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3299 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2136 $qcode =~ s/\n/\\n/g; 3300 $qcode =~ s/\n/\\n/g;
2137 3301
3302 %vars = (_dummy => 0) unless %vars;
3303
3304 my @res;
2138 local $_; 3305 local $_;
2139 local @safe::cf::_safe_eval_args = values %vars;
2140 3306
2141 my $eval = 3307 my $eval =
2142 "do {\n" 3308 "do {\n"
2143 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3309 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2144 . "#line 0 \"{$qcode}\"\n" 3310 . "#line 0 \"{$qcode}\"\n"
2145 . $code 3311 . $code
2146 . "\n}" 3312 . "\n}"
2147 ; 3313 ;
2148 3314
3315 if ($CFG{safe_eval}) {
2149 sub_generation_inc; 3316 sub_generation_inc;
3317 local @safe::cf::_safe_eval_args = values %vars;
2150 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3318 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2151 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 }
2152 3324
2153 if ($@) { 3325 if ($@) {
2154 warn "$@"; 3326 warn "$@",
2155 warn "while executing safe code '$code'\n"; 3327 "while executing safe code '$code'\n",
2156 warn "with arguments " . (join " ", %vars) . "\n"; 3328 "with arguments " . (join " ", %vars) . "\n";
2157 } 3329 }
2158 3330
2159 wantarray ? @res : $res[0] 3331 wantarray ? @res : $res[0]
2160} 3332}
2161 3333
2175=cut 3347=cut
2176 3348
2177sub register_script_function { 3349sub register_script_function {
2178 my ($fun, $cb) = @_; 3350 my ($fun, $cb) = @_;
2179 3351
2180 no strict 'refs'; 3352 $fun = "safe::$fun" if $CFG{safe_eval};
2181 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3353 *$fun = $safe_hole->wrap ($cb);
2182} 3354}
2183 3355
2184=back 3356=back
2185 3357
2186=cut 3358=cut
2187
2188#############################################################################
2189
2190=head2 EXTENSION DATABASE SUPPORT
2191
2192Crossfire maintains a very simple database for extension use. It can
2193currently store anything that can be serialised using Storable, which
2194excludes objects.
2195
2196The parameter C<$family> should best start with the name of the extension
2197using it, it should be unique.
2198
2199=over 4
2200
2201=item $value = cf::db_get $family => $key
2202
2203Returns a single value from the database.
2204
2205=item cf::db_put $family => $key => $value
2206
2207Stores the given C<$value> in the family.
2208
2209=cut
2210
2211our $DB;
2212
2213sub db_init {
2214 unless ($DB) {
2215 $DB = BDB::db_create $DB_ENV;
2216
2217 cf::sync_job {
2218 eval {
2219 $DB->set_flags (BDB::CHKSUM);
2220
2221 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223 cf::cleanup "db_open(db): $!" if $!;
2224 };
2225 cf::cleanup "db_open(db): $@" if $@;
2226 };
2227
2228 my $path = cf::localdir . "/database.pst";
2229 if (stat $path) {
2230 cf::sync_job {
2231 my $pst = Storable::retrieve $path;
2232
2233 cf::db_put (board => data => $pst->{board});
2234 cf::db_put (guildrules => data => $pst->{guildrules});
2235 cf::db_put (rent => balance => $pst->{rent}{balance});
2236 BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238 unlink $path;
2239 };
2240 }
2241 }
2242}
2243
2244sub db_get($$) {
2245 my $key = "$_[0]/$_[1]";
2246
2247 cf::sync_job {
2248 BDB::db_get $DB, undef, $key, my $data;
2249
2250 $! ? ()
2251 : Compress::LZF::sthaw $data
2252 }
2253}
2254
2255sub db_put($$$) {
2256 BDB::dbreq_pri 4;
2257 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258}
2259 3359
2260############################################################################# 3360#############################################################################
2261# the server's init and main functions 3361# the server's init and main functions
2262 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
2263sub load_faces { 3406sub load_facedata($) {
2264 my $path = sprintf "%s/faces", cf::datadir; 3407 my ($path) = @_;
2265 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
2266 warn "loading faces from $path\n"; 3415 trace "loading facedata from $path\n";
2267 3416
2268 my $faces; 3417 my $facedata;
2269 0 < aio_load $path, $faces 3418 0 < aio_load $path, $facedata
2270 or die "$path: $!"; 3419 or die "$path: $!";
2271 3420
2272 Coro::cede;
2273 $faces = Storable::thaw $faces; 3421 $facedata = Coro::Storable::thaw $facedata;
2274 Coro::cede;
2275 3422
2276 my $meta = delete $faces->{""};
2277 $meta->{version} == 1 3423 $facedata->{version} == 2
2278 or cf::cleanup "$path: version mismatch, cannot proceed."; 3424 or cf::cleanup "$path: version mismatch, cannot proceed.";
2279 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
2280 while (my ($face, $info) = each %$faces) { 3438 while (my ($face, $info) = each %$faces) {
2281 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3439 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2282 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};
2283 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3443 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2284 Coro::cede; 3444 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2285 }
2286 3445
3446 cf::cede_to_tick;
3447 }
3448
2287 while (my ($face, $info) = each %$faces) { 3449 while (my ($face, $info) = each %$faces) {
2288 next unless $info->{smooth}; 3450 next unless $info->{smooth};
3451
2289 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}[$_]
2290 or next; 3556 or next;
2291 if (my $smooth = cf::face::find $info->{smooth}) {
2292 cf::face::set_smooth $idx, $smooth;
2293 } else {
2294 warn "smooth face '$info->{smooth}' not found for face '$face'";
2295 }
2296 Coro::cede;
2297 }
2298 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
2299 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 }
2300} 3567}
2301 3568
2302sub reload_resources { 3569sub reload_resources {
2303 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3570 trace "reloading resource files...\n";
2304 or die "unable to load regions file\n";#d# 3571
2305 load_faces 3572 reload_facedata;
2306 or die "unable to load faces\n";#d# 3573 reload_sound;
2307} 3574 reload_archetypes;
2308
2309sub init {
2310 reload_resources; 3575 reload_regions;
2311} 3576 reload_treasures;
2312 3577
2313sub cfg_load { 3578 trace "finished reloading resource files\n";
3579}
3580
3581sub reload_config {
3582 trace "reloading config file...\n";
3583
2314 open my $fh, "<:utf8", cf::confdir . "/config" 3584 open my $fh, "<:utf8", "$CONFDIR/config"
2315 or return; 3585 or return;
2316 3586
2317 local $/; 3587 local $/;
2318 *CFG = YAML::Syck::Load <$fh>; 3588 *CFG = YAML::XS::Load scalar <$fh>;
2319 3589
2320 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3590 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2321 3591
2322 $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};
2323 $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};
2324 3594
2325 if (exists $CFG{mlockall}) { 3595 if (exists $CFG{mlockall}) {
2327 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3597 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2328 and die "WARNING: m(un)lockall failed: $!\n"; 3598 and die "WARNING: m(un)lockall failed: $!\n";
2329 }; 3599 };
2330 warn $@ if $@; 3600 warn $@ if $@;
2331 } 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;
2332} 3632}
2333 3633
2334sub 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
2335 # we must not ever block the main coroutine 3644 # we must not ever block the main coroutine
2336 local $Coro::idle = sub { 3645 local $Coro::idle = sub {
2337 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#
2338 (async { 3647 (async {
2339 Event::one_event; 3648 $Coro::current->{desc} = "IDLE BUG HANDLER";
3649 EV::loop EV::LOOP_ONESHOT;
2340 })->prio (Coro::PRIO_MAX); 3650 })->prio (Coro::PRIO_MAX);
2341 }; 3651 };
2342 3652
2343 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;
2344 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
2345 load_extensions; 3678 load_extensions;
2346 3679
2347 $TICK_WATCHER->start; 3680 utime time, time, $RUNTIMEFILE;
2348 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;
2349} 3698}
2350 3699
2351############################################################################# 3700#############################################################################
2352# initialisation and cleanup 3701# initialisation and cleanup
2353 3702
2354# install some emergency cleanup handlers 3703# install some emergency cleanup handlers
2355BEGIN { 3704BEGIN {
3705 our %SIGWATCHER = ();
2356 for my $signal (qw(INT HUP TERM)) { 3706 for my $signal (qw(INT HUP TERM)) {
2357 Event->signal ( 3707 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2358 reentrant => 0,
2359 data => WF_AUTOCANCEL,
2360 signal => $signal,
2361 prio => 0,
2362 cb => sub {
2363 cf::cleanup "SIG$signal"; 3708 cf::cleanup "SIG$signal";
2364 },
2365 ); 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
2366 } 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 };
2367} 3799}
2368 3800
2369sub emergency_save() { 3801sub emergency_save() {
2370 my $freeze_guard = cf::freeze_mainloop; 3802 my $freeze_guard = cf::freeze_mainloop;
2371 3803
2372 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;
2373 3810
2374 cf::sync_job { 3811 cf::sync_job {
3812 cf::write_runtime_sync; # external watchdog should not bark
3813
2375 # use a peculiar iteration method to avoid tripping on perl 3814 # use a peculiar iteration method to avoid tripping on perl
2376 # refcount bugs in for. also avoids problems with players 3815 # refcount bugs in for. also avoids problems with players
2377 # and maps saved/destroyed asynchronously. 3816 # and maps saved/destroyed asynchronously.
2378 warn "begin emergency player save\n"; 3817 info "emergency_perl_save: begin player save\n";
2379 for my $login (keys %cf::PLAYER) { 3818 for my $login (keys %cf::PLAYER) {
2380 my $pl = $cf::PLAYER{$login} or next; 3819 my $pl = $cf::PLAYER{$login} or next;
2381 $pl->valid or next; 3820 $pl->valid or next;
3821 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2382 $pl->save; 3822 $pl->save;
2383 } 3823 }
2384 warn "end emergency player save\n"; 3824 info "emergency_perl_save: end player save\n";
2385 3825
2386 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";
2387 for my $path (keys %cf::MAP) { 3829 for my $path (keys %cf::MAP) {
2388 my $map = $cf::MAP{$path} or next; 3830 my $map = $cf::MAP{$path} or next;
2389 $map->valid or next; 3831 $map->valid or next;
2390 $map->save; 3832 $map->save;
2391 } 3833 }
2392 warn "end emergency map save\n"; 3834 info "emergency_perl_save: end map save\n";
2393 3835
2394 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";
2395 BDB::db_env_txn_checkpoint $DB_ENV; 3839 BDB::db_env_txn_checkpoint $DB_ENV;
2396 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
2397 }; 3864 };
2398 3865
2399 warn "leave emergency perl save\n"; 3866 info "emergency_perl_save: leave\n";
2400} 3867}
2401 3868
2402sub post_cleanup { 3869sub post_cleanup {
2403 my ($make_core) = @_; 3870 my ($make_core) = @_;
2404 3871
3872 IO::AIO::flush;
3873
2405 warn Carp::longmess "post_cleanup backtrace" 3874 error Carp::longmess "post_cleanup backtrace"
2406 if $make_core; 3875 if $make_core;
2407}
2408 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
2409sub reload() { 3906sub do_reload_perl() {
2410 # can/must only be called in main 3907 # can/must only be called in main
2411 if ($Coro::current != $Coro::main) { 3908 if (in_main) {
2412 warn "can only reload from main coroutine"; 3909 error "can only reload from main coroutine";
2413 return; 3910 return;
2414 } 3911 }
2415 3912
3913 return if $RELOAD++;
3914
3915 my $t1 = AE::time;
3916
3917 while ($RELOAD) {
2416 warn "reloading..."; 3918 info "reloading...";
2417 3919
2418 warn "entering sync_job"; 3920 trace "entering sync_job";
2419 3921
2420 cf::sync_job { 3922 cf::sync_job {
2421 cf::write_runtime; # external watchdog should not bark
2422 cf::emergency_save; 3923 cf::emergency_save;
2423 cf::write_runtime; # external watchdog should not bark
2424 3924
2425 warn "syncing database to disk";
2426 BDB::db_env_txn_checkpoint $DB_ENV;
2427
2428 # if anything goes wrong in here, we should simply crash as we already saved
2429
2430 warn "cancelling all WF_AUTOCANCEL watchers";
2431 for (Event::all_watchers) {
2432 $_->cancel if $_->data & WF_AUTOCANCEL;
2433 }
2434
2435 warn "flushing outstanding aio requests";
2436 for (;;) {
2437 BDB::flush;
2438 IO::AIO::flush;
2439 Coro::cede;
2440 last unless IO::AIO::nreqs || BDB::nreqs;
2441 warn "iterate...";
2442 }
2443
2444 ++$RELOAD;
2445
2446 warn "cancelling all extension coros"; 3925 trace "cancelling all extension coros";
2447 $_->cancel for values %EXT_CORO; 3926 $_->cancel for values %EXT_CORO;
2448 %EXT_CORO = (); 3927 %EXT_CORO = ();
2449 3928
2450 warn "removing commands"; 3929 trace "removing commands";
2451 %COMMAND = (); 3930 %COMMAND = ();
2452 3931
2453 warn "removing ext commands"; 3932 trace "removing ext/exti commands";
2454 %EXTCMD = (); 3933 %EXTCMD = ();
3934 %EXTICMD = ();
2455 3935
2456 warn "unloading/nuking all extensions"; 3936 trace "unloading/nuking all extensions";
2457 for my $pkg (@EXTS) { 3937 for my $pkg (@EXTS) {
2458 warn "... unloading $pkg"; 3938 trace "... unloading $pkg";
2459 3939
2460 if (my $cb = $pkg->can ("unload")) { 3940 if (my $cb = $pkg->can ("unload")) {
2461 eval { 3941 eval {
2462 $cb->($pkg); 3942 $cb->($pkg);
2463 1 3943 1
2464 } 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;
2465 } 3949 }
2466 3950
2467 warn "... nuking $pkg";
2468 Symbol::delete_package $pkg;
2469 }
2470
2471 warn "unloading all perl modules loaded from $LIBDIR"; 3951 trace "unloading all perl modules loaded from $LIBDIR";
2472 while (my ($k, $v) = each %INC) { 3952 while (my ($k, $v) = each %INC) {
2473 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3953 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2474 3954
2475 warn "... unloading $k"; 3955 trace "... unloading $k";
2476 delete $INC{$k}; 3956 delete $INC{$k};
2477 3957
2478 $k =~ s/\.pm$//; 3958 $k =~ s/\.pm$//;
2479 $k =~ s/\//::/g; 3959 $k =~ s/\//::/g;
2480 3960
2481 if (my $cb = $k->can ("unload_module")) { 3961 if (my $cb = $k->can ("unload_module")) {
2482 $cb->(); 3962 $cb->();
3963 }
3964
3965 clear_package $k;
2483 } 3966 }
2484 3967
2485 Symbol::delete_package $k;
2486 }
2487
2488 warn "getting rid of safe::, as good as possible"; 3968 trace "getting rid of safe::, as good as possible";
2489 Symbol::delete_package "safe::$_" 3969 clear_package "safe::$_"
2490 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);
2491 3971
2492 warn "unloading cf.pm \"a bit\""; 3972 trace "unloading cf.pm \"a bit\"";
2493 delete $INC{"cf.pm"}; 3973 delete $INC{"cf.pm"};
3974 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2494 3975
2495 # don't, removes xs symbols, too, 3976 # don't, removes xs symbols, too,
2496 # and global variables created in xs 3977 # and global variables created in xs
2497 #Symbol::delete_package __PACKAGE__; 3978 #clear_package __PACKAGE__;
2498 3979
2499 warn "unload completed, starting to reload now"; 3980 info "unload completed, starting to reload now";
2500 3981
2501 warn "reloading cf.pm"; 3982 trace "reloading cf.pm";
2502 require cf; 3983 require cf;
2503 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3984 cf::_connect_to_perl_1;
2504 3985
2505 warn "loading config and database again"; 3986 trace "loading config and database again";
2506 cf::cfg_load; 3987 cf::reload_config;
2507 3988
2508 warn "loading extensions"; 3989 trace "loading extensions";
2509 cf::load_extensions; 3990 cf::load_extensions;
2510 3991
3992 if ($REATTACH_ON_RELOAD) {
2511 warn "reattaching attachments to objects/players"; 3993 trace "reattaching attachments to objects/players";
2512 _global_reattach; # objects, sockets 3994 _global_reattach; # objects, sockets
2513 warn "reattaching attachments to maps"; 3995 trace "reattaching attachments to maps";
2514 reattach $_ for values %MAP; 3996 reattach $_ for values %MAP;
2515 warn "reattaching attachments to players"; 3997 trace "reattaching attachments to players";
2516 reattach $_ for values %PLAYER; 3998 reattach $_ for values %PLAYER;
3999 }
2517 4000
2518 warn "loading reloadable resources"; 4001 trace "running post_init jobs";
2519 reload_resources; 4002 (pop @POST_INIT)->(1) while @POST_INIT;
2520 4003
2521 warn "leaving sync_job"; 4004 trace "leaving sync_job";
2522 4005
2523 1 4006 1
2524 } or do { 4007 } or do {
2525 warn $@; 4008 error $@;
2526 warn "error while reloading, exiting."; 4009 cf::cleanup "error while reloading, exiting.";
2527 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 };
2528 }; 4033 };
2529 4034}
2530 warn "reloaded";
2531};
2532
2533our $RELOAD_WATCHER; # used only during reload
2534 4035
2535register_command "reload" => sub { 4036register_command "reload" => sub {
2536 my ($who, $arg) = @_; 4037 my ($who, $arg) = @_;
2537 4038
2538 if ($who->flag (FLAG_WIZ)) { 4039 if ($who->flag (FLAG_WIZ)) {
2539 $who->message ("reloading server."); 4040 $who->message ("reloading server.");
2540 4041 async {
2541 # doing reload synchronously and two reloads happen back-to-back, 4042 $Coro::current->{desc} = "perl_reload";
2542 # coro crashes during coro_state_free->destroy here.
2543
2544 $RELOAD_WATCHER ||= Event->timer (
2545 reentrant => 0,
2546 after => 0,
2547 data => WF_AUTOCANCEL,
2548 cb => sub {
2549 reload; 4043 reload_perl;
2550 undef $RELOAD_WATCHER;
2551 },
2552 ); 4044 };
2553 } 4045 }
2554}; 4046};
2555 4047
2556unshift @INC, $LIBDIR; 4048#############################################################################
2557 4049
2558my $bug_warning = 0; 4050my $bug_warning = 0;
2559 4051
2560$TICK_WATCHER = Event->timer ( 4052our @WAIT_FOR_TICK;
2561 reentrant => 0, 4053our @WAIT_FOR_TICK_BEGIN;
2562 parked => 1, 4054
2563 prio => 0, 4055sub wait_for_tick {
2564 at => $NEXT_TICK || $TICK, 4056 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2565 data => WF_AUTOCANCEL, 4057
2566 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 {
2567 if ($Coro::current != $Coro::main) { 4072 if ($Coro::current != $Coro::main) {
2568 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"
2569 unless ++$bug_warning > 10; 4074 unless ++$bug_warning > 10;
2570 return; 4075 return;
2571 } 4076 }
2572 4077
2573 $NOW = Event::time;
2574
2575 cf::server_tick; # one server iteration 4078 cf::server_tick; # one server iteration
2576 $RUNTIME += $TICK;
2577 $NEXT_TICK += $TICK;
2578 4079
4080 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
4081
2579 if ($NOW >= $NEXT_RUNTIME_WRITE) { 4082 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2580 $NEXT_RUNTIME_WRITE = $NOW + 10; 4083 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2581 Coro::async_pool { 4084 Coro::async_pool {
4085 $Coro::current->{desc} = "runtime saver";
2582 write_runtime 4086 write_runtime_sync
2583 or warn "ERROR: unable to write runtime file: $!"; 4087 or error "ERROR: unable to write runtime file: $!";
2584 };
2585 } 4088 };
2586
2587 $WAIT_FOR_TICK->broadcast;
2588 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2589
2590# my $AFTER = Event::time;
2591# warn $AFTER - $NOW;#d#
2592
2593 # if we are delayed by four ticks or more, skip them all
2594 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2595
2596 $TICK_WATCHER->at ($NEXT_TICK);
2597 $TICK_WATCHER->start;
2598 }, 4089 }
2599); 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}
2600 4109
2601{ 4110{
2602 BDB::max_poll_time $TICK * 0.1; 4111 # configure BDB
2603 $BDB_POLL_WATCHER = Event->io ( 4112
2604 reentrant => 0,
2605 fd => BDB::poll_fileno,
2606 poll => 'r',
2607 prio => 0,
2608 data => WF_AUTOCANCEL,
2609 cb => \&BDB::poll_cb,
2610 );
2611 BDB::min_parallel 8; 4113 BDB::min_parallel 16;
2612 4114 BDB::max_poll_reqs $TICK * 0.1;
2613 BDB::set_sync_prepare { 4115 $AnyEvent::BDB::WATCHER->priority (1);
2614 my $status;
2615 my $current = $Coro::current;
2616 (
2617 sub {
2618 $status = $!;
2619 $current->ready; undef $current;
2620 },
2621 sub {
2622 Coro::schedule while defined $current;
2623 $! = $status;
2624 },
2625 )
2626 };
2627 4116
2628 unless ($DB_ENV) { 4117 unless ($DB_ENV) {
2629 $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);
2630 4124
2631 cf::sync_job { 4125 cf::sync_job {
2632 eval { 4126 eval {
2633 BDB::db_env_open 4127 BDB::db_env_open
2634 $DB_ENV, 4128 $DB_ENV,
2635 $BDB_ENV_DIR, 4129 $BDBDIR,
2636 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
2637 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4131 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2638 0666; 4132 0666;
2639 4133
2640 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 4134 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2641
2642 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2643 $DB_ENV->set_lk_detect;
2644 }; 4135 };
2645 4136
2646 cf::cleanup "db_env_open(db): $@" if $@; 4137 cf::cleanup "db_env_open(db): $@" if $@;
2647 }; 4138 };
2648 } 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 };
2649} 4150}
2650 4151
2651{ 4152{
4153 # configure IO::AIO
4154
2652 IO::AIO::min_parallel 8; 4155 IO::AIO::min_parallel 8;
2653
2654 undef $Coro::AIO::WATCHER;
2655 IO::AIO::max_poll_time $TICK * 0.1; 4156 IO::AIO::max_poll_time $TICK * 0.1;
2656 $AIO_POLL_WATCHER = Event->io ( 4157 undef $AnyEvent::AIO::WATCHER;
2657 reentrant => 0,
2658 data => WF_AUTOCANCEL,
2659 fd => IO::AIO::poll_fileno,
2660 poll => 'r',
2661 prio => 6,
2662 cb => \&IO::AIO::poll_cb,
2663 );
2664} 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;
2665 4205
2666END { cf::emergency_save } 4206END { cf::emergency_save }
2667 4207
26681 42081
2669 4209

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines