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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines