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.235 by root, Tue Apr 10 09:35:23 2007 UTC vs.
Revision 1.538 by root, Tue May 4 21:45:43 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
25use 5.10.0;
3use utf8; 26use utf8;
4use strict; 27use strict qw(vars subs);
5 28
6use Symbol; 29use Symbol;
7use List::Util; 30use List::Util;
8use Storable; 31use Socket;
9use Event; 32use EV;
10use Opcode; 33use Opcode;
11use Safe; 34use Safe;
12use Safe::Hole; 35use Safe::Hole;
36use Storable ();
37use Carp ();
13 38
39use Guard ();
14use Coro 3.52 (); 40use Coro ();
15use Coro::State; 41use Coro::State;
42use Coro::Handle;
43use Coro::EV;
16use Coro::Event; 44use Coro::AnyEvent;
17use Coro::Timer; 45use Coro::Timer;
18use Coro::Signal; 46use Coro::Signal;
19use Coro::Semaphore; 47use Coro::Semaphore;
48use Coro::SemaphoreSet;
49use Coro::AnyEvent;
20use Coro::AIO; 50use Coro::AIO;
51use Coro::BDB 1.6;
52use Coro::Storable;
53use Coro::Util ();
21 54
55use JSON::XS 2.01 ();
22use BDB (); 56use BDB ();
23use Data::Dumper; 57use Data::Dumper;
24use Digest::MD5;
25use Fcntl; 58use Fcntl;
26use YAML::Syck (); 59use YAML::XS ();
27use IO::AIO 2.32 (); 60use IO::AIO ();
28use Time::HiRes; 61use Time::HiRes;
29use Compress::LZF; 62use Compress::LZF;
63use Digest::MD5 ();
64
65AnyEvent::detect;
30 66
31# configure various modules to our taste 67# configure various modules to our taste
32# 68#
69$Storable::canonical = 1; # reduce rsync transfers
33Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 70Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
71
72$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
73
74# make sure c-lzf reinitialises itself
75Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
34Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 76Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35 77
36$Event::Eval = 1; # no idea why this is required, but it is 78# strictly for debugging
37 79$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 80
43sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 81sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
44 82
45our %COMMAND = (); 83our %COMMAND = ();
46our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
47 85
48our @EXTS = (); # list of extension package names 86our @EXTS = (); # list of extension package names
49our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
50our %EXT_CORO = (); # coroutines bound to extensions 89our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 90our %EXT_MAP = (); # pluggable maps
52 91
53our $RELOAD; # number of reloads so far 92our $RELOAD; # number of reloads so far, non-zero while in reload
54our @EVENT; 93our @EVENT;
55our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
56 96
57our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
58our $TICK_WATCHER; 98our $DATADIR = datadir;
59our $AIO_POLL_WATCHER; 99our $LIBDIR = "$DATADIR/ext";
100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE; # unused
112
113our $OUTPUT_RATE_MIN = 3000;
114our $OUTPUT_RATE_MAX = 1000000;
115
116our $MAX_LINKS = 32; # how many chained exits to follow
117our $VERBOSE_IO = 1;
118
119our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 121our $NEXT_TICK;
62our $NOW;
63our $USE_FSYNC = 1; # use fsync to write maps - default off 122our $USE_FSYNC = 1; # use fsync to write maps - default on
64 123
124our $BDB_DEADLOCK_WATCHER;
125our $BDB_CHECKPOINT_WATCHER;
65our $BDB_POLL_WATCHER; 126our $BDB_TRICKLE_WATCHER;
66our $DB_ENV; 127our $DB_ENV;
128
129our @EXTRA_MODULES = qw(pod match mapscript);
67 130
68our %CFG; 131our %CFG;
69 132
70our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
71our $RUNTIME; 134our $RUNTIME;
135our $NOW;
72 136
73our %PLAYER; # all users 137our (%PLAYER, %PLAYER_LOADING); # all users
74our %MAP; # all maps 138our (%MAP, %MAP_LOADING ); # all maps
75our $LINK_MAP; # the special {link} map, which is always available 139our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 140
82# used to convert map paths into valid unix filenames by replacing / by ∕ 141# used to convert map paths into valid unix filenames by replacing / by ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 143
144our $LOAD; # a number between 0 (idle) and 1 (too many objects)
145our $LOADAVG; # same thing, but with alpha-smoothing
146our $JITTER; # average jitter
147our $TICK_START; # for load detecting purposes
148
149our @POST_INIT;
150
151our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
152our $REALLY_UNLOOP; # never set to true, please :)
153
85binmode STDOUT; 154binmode STDOUT;
86binmode STDERR; 155binmode STDERR;
87 156
88# read virtual server time, if available 157# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
90 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
91 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
92 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
93} 162}
94 163
95mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
96mkdir cf::localdir . "/" . cf::playerdir; 165
97mkdir cf::localdir . "/" . cf::tmpdir; 166mkdir $_
98mkdir cf::localdir . "/" . cf::uniquedir; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 168
102our $EMERGENCY_POSITION; 169our $EMERGENCY_POSITION;
103 170
104sub cf::map::normalise; 171sub cf::map::normalise;
172
173sub in_main() {
174 $Coro::current == $Coro::main
175}
176
177#############################################################################
178
179%REFLECT = ();
180for (@REFLECT) {
181 my $reflect = JSON::XS::decode_json $_;
182 $REFLECT{$reflect->{class}} = $reflect;
183}
184
185# this is decidedly evil
186$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
105 187
106############################################################################# 188#############################################################################
107 189
108=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
109 191
116=item $cf::RUNTIME 198=item $cf::RUNTIME
117 199
118The time this server has run, starts at 0 and is increased by $cf::TICK on 200The time this server has run, starts at 0 and is increased by $cf::TICK on
119every server tick. 201every server tick.
120 202
121=item $cf::LIBDIR 203=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
204$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
205$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
122 206
123The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
124be found. It will be added to C<@INC> automatically. 208directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
209unique-items directory, player file directory, random maps directory and
210database environment.
125 211
126=item $cf::NOW 212=item $cf::NOW
127 213
128The time of the last (current) server tick. 214The time of the last (current) server tick.
129 215
130=item $cf::TICK 216=item $cf::TICK
131 217
132The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
133 219
220=item $cf::LOADAVG
221
222The current CPU load on the server (alpha-smoothed), as a value between 0
223(none) and 1 (overloaded), indicating how much time is spent on processing
224objects per tick. Healthy values are < 0.5.
225
226=item $cf::LOAD
227
228The raw value load value from the last tick.
229
134=item %cf::CFG 230=item %cf::CFG
135 231
136Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
137from wherever your confdir points to. 233from wherever your confdir points to.
138 234
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 235=item cf::wait_for_tick, cf::wait_for_tick_begin
140 236
141These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 237These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
142or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 238returns directly I<after> the tick processing (and consequently, can only wake one process
143processing has been done. Call C<< ->wait >> on them to maximise the 239per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
144window of cpu time available, or simply to synchronise to the server tick. 240
241=item @cf::INVOKE_RESULTS
242
243This array contains the results of the last C<invoke ()> call. When
244C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
245that call.
246
247=item %cf::REFLECT
248
249Contains, for each (C++) class name, a hash reference with information
250about object members (methods, scalars, arrays and flags) and other
251metadata, which is useful for introspection.
145 252
146=back 253=back
147 254
148=cut 255=cut
149 256
150BEGIN { 257sub error(@) { LOG llevError, join "", @_ }
151 *CORE::GLOBAL::warn = sub { 258sub warn (@) { LOG llevWarn , join "", @_ }
259sub info (@) { LOG llevInfo , join "", @_ }
260sub debug(@) { LOG llevDebug, join "", @_ }
261sub trace(@) { LOG llevTrace, join "", @_ }
262
263$Coro::State::WARNHOOK = sub {
152 my $msg = join "", @_; 264 my $msg = join "", @_;
153 utf8::encode $msg;
154 265
155 $msg .= "\n" 266 $msg .= "\n"
156 unless $msg =~ /\n$/; 267 unless $msg =~ /\n$/;
157 268
269 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
270
158 LOG llevError, $msg; 271 LOG llevWarn, $msg;
159 }; 272};
160} 273
274$Coro::State::DIEHOOK = sub {
275 return unless $^S eq 0; # "eq", not "=="
276
277 error Carp::longmess $_[0];
278
279 if (in_main) {#d#
280 error "DIEHOOK called in main context, Coro bug?\n";#d#
281 return;#d#
282 }#d#
283
284 # kill coroutine otherwise
285 Coro::terminate
286};
161 287
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 288@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 289@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 290@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 291@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 292@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
293@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
167@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 294@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
168 295
169# we bless all objects into (empty) derived classes to force a method lookup 296# we bless all objects into (empty) derived classes to force a method lookup
170# within the Safe compartment. 297# within the Safe compartment.
171for my $pkg (qw( 298for my $pkg (qw(
172 cf::global cf::attachable 299 cf::global cf::attachable
173 cf::object cf::object::player 300 cf::object cf::object::player
174 cf::client cf::player 301 cf::client cf::player
175 cf::arch cf::living 302 cf::arch cf::living
303 cf::map cf::mapspace
176 cf::map cf::party cf::region 304 cf::party cf::region
177)) { 305)) {
178 no strict 'refs';
179 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 306 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
180} 307}
181 308
182$Event::DIED = sub { 309$EV::DIED = sub {
183 warn "error in event callback: @_"; 310 Carp::cluck "error in event callback: @_";
184}; 311};
312
313#############################################################################
185 314
186=head2 UTILITY FUNCTIONS 315=head2 UTILITY FUNCTIONS
187 316
188=over 4 317=over 4
189 318
208 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 337 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
209 $d 338 $d
210 } || "[unable to dump $_[0]: '$@']"; 339 } || "[unable to dump $_[0]: '$@']";
211} 340}
212 341
213use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215=item $ref = cf::from_json $json 342=item $ref = cf::decode_json $json
216 343
217Converts a JSON string into the corresponding perl data structure. 344Converts a JSON string into the corresponding perl data structure.
218 345
219=item $json = cf::to_json $ref 346=item $json = cf::encode_json $ref
220 347
221Converts a perl data structure into its JSON representation. 348Converts a perl data structure into its JSON representation.
222 349
350=cut
351
352our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
353
354sub encode_json($) { $json_coder->encode ($_[0]) }
355sub decode_json($) { $json_coder->decode ($_[0]) }
356
357=item cf::post_init { BLOCK }
358
359Execute the given codeblock, I<after> all extensions have been (re-)loaded,
360but I<before> the server starts ticking again.
361
362The cdoeblock will have a single boolean argument to indicate whether this
363is a reload or not.
364
365=cut
366
367sub post_init(&) {
368 push @POST_INIT, shift;
369}
370
223=item cf::lock_wait $string 371=item cf::lock_wait $string
224 372
225Wait until the given lock is available. See cf::lock_acquire. 373Wait until the given lock is available. See cf::lock_acquire.
226 374
227=item my $lock = cf::lock_acquire $string 375=item my $lock = cf::lock_acquire $string
228 376
229Wait until the given lock is available and then acquires it and returns 377Wait until the given lock is available and then acquires it and returns
230a Coro::guard object. If the guard object gets destroyed (goes out of scope, 378a L<Guard> object. If the guard object gets destroyed (goes out of scope,
231for example when the coroutine gets canceled), the lock is automatically 379for example when the coroutine gets canceled), the lock is automatically
232returned. 380returned.
233 381
382Locks are *not* recursive, locking from the same coro twice results in a
383deadlocked coro.
384
234Lock names should begin with a unique identifier (for example, cf::map::find 385Lock names should begin with a unique identifier (for example, cf::map::find
235uses map_find and cf::map::load uses map_load). 386uses map_find and cf::map::load uses map_load).
236 387
237=cut 388=item $locked = cf::lock_active $string
238 389
239our %LOCK; 390Return true if the lock is currently active, i.e. somebody has locked it.
391
392=cut
393
394our $LOCKS = new Coro::SemaphoreSet;
240 395
241sub lock_wait($) { 396sub lock_wait($) {
242 my ($key) = @_; 397 $LOCKS->wait ($_[0]);
243
244 # wait for lock, if any
245 while ($LOCK{$key}) {
246 push @{ $LOCK{$key} }, $Coro::current;
247 Coro::schedule;
248 }
249} 398}
250 399
251sub lock_acquire($) { 400sub lock_acquire($) {
252 my ($key) = @_; 401 $LOCKS->guard ($_[0])
402}
253 403
254 # wait, to be sure we are not locked 404sub lock_active($) {
255 lock_wait $key; 405 $LOCKS->count ($_[0]) < 1
256
257 $LOCK{$key} = [];
258
259 Coro::guard {
260 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} };
262 }
263} 406}
264 407
265sub freeze_mainloop { 408sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 409 tick_inhibit_inc;
267 410
268 my $guard = Coro::guard { 411 &Guard::guard (\&tick_inhibit_dec);
269 $TICK_WATCHER->start; 412}
413
414=item cf::periodic $interval, $cb
415
416Like EV::periodic, but randomly selects a starting point so that the actions
417get spread over time.
418
419=cut
420
421sub periodic($$) {
422 my ($interval, $cb) = @_;
423
424 my $start = rand List::Util::min 180, $interval;
425
426 EV::periodic $start, $interval, 0, $cb
427}
428
429=item cf::get_slot $time[, $priority[, $name]]
430
431Allocate $time seconds of blocking CPU time at priority C<$priority>:
432This call blocks and returns only when you have at least C<$time> seconds
433of cpu time till the next tick. The slot is only valid till the next cede.
434
435The optional C<$name> can be used to identify the job to run. It might be
436used for statistical purposes and should identify the same time-class.
437
438Useful for short background jobs.
439
440=cut
441
442our @SLOT_QUEUE;
443our $SLOT_QUEUE;
444our $SLOT_DECAY = 0.9;
445
446$SLOT_QUEUE->cancel if $SLOT_QUEUE;
447$SLOT_QUEUE = Coro::async {
448 $Coro::current->desc ("timeslot manager");
449
450 my $signal = new Coro::Signal;
451 my $busy;
452
453 while () {
454 next_job:
455
456 my $avail = cf::till_tick;
457
458 for (0 .. $#SLOT_QUEUE) {
459 if ($SLOT_QUEUE[$_][0] <= $avail) {
460 $busy = 0;
461 my $job = splice @SLOT_QUEUE, $_, 1, ();
462 $job->[2]->send;
463 Coro::cede;
464 goto next_job;
465 } else {
466 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
467 }
468 }
469
470 if (@SLOT_QUEUE) {
471 # we do not use wait_for_tick() as it returns immediately when tick is inactive
472 push @cf::WAIT_FOR_TICK, $signal;
473 $signal->wait;
474 } else {
475 $busy = 0;
476 Coro::schedule;
477 }
270 }; 478 }
271 $TICK_WATCHER->stop; 479};
272 $guard 480
481sub get_slot($;$$) {
482 return if tick_inhibit || $Coro::current == $Coro::main;
483
484 my ($time, $pri, $name) = @_;
485
486 $time = clamp $time, 0.01, $TICK * .6;
487
488 my $sig = new Coro::Signal;
489
490 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
491 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
492 $SLOT_QUEUE->ready;
493 $sig->wait;
273} 494}
274 495
275=item cf::async { BLOCK } 496=item cf::async { BLOCK }
276 497
277Currently the same as Coro::async_pool, meaning you cannot use 498Currently the same as Coro::async_pool, meaning you cannot use
282 503
283BEGIN { *async = \&Coro::async_pool } 504BEGIN { *async = \&Coro::async_pool }
284 505
285=item cf::sync_job { BLOCK } 506=item cf::sync_job { BLOCK }
286 507
287The design of crossfire+ requires that the main coro ($Coro::main) is 508The design of Deliantra requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 509is always able to handle events or runnable, as Deliantra is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 510partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
511acceptable.
290 512
291If it must be done, put the blocking parts into C<sync_job>. This will run 513If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 514the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 515server will be frozen during this time, so the block should either finish
294fast or be very important. 516fast or be very important.
296=cut 518=cut
297 519
298sub sync_job(&) { 520sub sync_job(&) {
299 my ($job) = @_; 521 my ($job) = @_;
300 522
301 if ($Coro::current == $Coro::main) { 523 if (in_main) {
524 my $time = AE::time;
525
302 # this is the main coro, too bad, we have to block 526 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 527 # till the operation succeeds, freezing the server :/
304 528
305 # TODO: use suspend/resume instead 529 #LOG llevError, Carp::longmess "sync job";#d#
306 # (but this is cancel-safe) 530
307 my $freeze_guard = freeze_mainloop; 531 my $freeze_guard = freeze_mainloop;
308 532
309 my $busy = 1; 533 my $busy = 1;
310 my @res; 534 my @res;
311 535
312 (async { 536 (async {
537 $Coro::current->desc ("sync job coro");
313 @res = eval { $job->() }; 538 @res = eval { $job->() };
314 warn $@ if $@; 539 error $@ if $@;
315 undef $busy; 540 undef $busy;
316 })->prio (Coro::PRIO_MAX); 541 })->prio (Coro::PRIO_MAX);
317 542
318 while ($busy) { 543 while ($busy) {
319 Coro::cede or Event::one_event; 544 if (Coro::nready) {
545 Coro::cede_notself;
546 } else {
547 EV::loop EV::LOOP_ONESHOT;
320 } 548 }
549 }
550
551 my $time = AE::time - $time;
552
553 $TICK_START += $time; # do not account sync jobs to server load
321 554
322 wantarray ? @res : $res[0] 555 wantarray ? @res : $res[0]
323 } else { 556 } else {
324 # we are in another coroutine, how wonderful, everything just works 557 # we are in another coroutine, how wonderful, everything just works
325 558
345 $EXT_CORO{$coro+0} = $coro; 578 $EXT_CORO{$coro+0} = $coro;
346 579
347 $coro 580 $coro
348} 581}
349 582
350sub write_runtime { 583=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 584
353 my $runtime = cf::localdir . "/runtime"; 585Executes the given code block with the given arguments in a seperate
586process, returning the results. Everything must be serialisable with
587Coro::Storable. May, of course, block. Note that the executed sub may
588never block itself or use any form of event handling.
354 589
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 590=cut
356 or return;
357 591
358 my $value = $cf::RUNTIME + 90 + 10; 592sub fork_call(&@) {
359 # 10 is the runtime save interval, for a monotonic clock 593 my ($cb, @args) = @_;
360 # 60 allows for the watchdog to kill the server.
361 594
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0 595 # we seemingly have to make a local copy of the whole thing,
363 and return; 596 # otherwise perl prematurely frees the stuff :/
597 # TODO: investigate and fix (likely this will be rather laborious)
364 598
365 # always fsync - this file is important 599 my @res = Coro::Util::fork_eval {
366 aio_fsync $fh 600 reset_signals;
367 and return; 601 &$cb
602 }, @args;
368 603
369 close $fh 604 wantarray ? @res : $res[-1]
370 or return; 605}
371 606
372 aio_rename "$runtime~", $runtime 607sub objinfo {
373 and return;
374
375 1 608 (
609 "counter value" => cf::object::object_count,
610 "objects created" => cf::object::create_count,
611 "objects destroyed" => cf::object::destroy_count,
612 "freelist size" => cf::object::free_count,
613 "allocated objects" => cf::object::objects_size,
614 "active objects" => cf::object::actives_size,
615 )
616}
617
618=item $coin = coin_from_name $name
619
620=cut
621
622our %coin_alias = (
623 "silver" => "silvercoin",
624 "silvercoin" => "silvercoin",
625 "silvercoins" => "silvercoin",
626 "gold" => "goldcoin",
627 "goldcoin" => "goldcoin",
628 "goldcoins" => "goldcoin",
629 "platinum" => "platinacoin",
630 "platinumcoin" => "platinacoin",
631 "platinumcoins" => "platinacoin",
632 "platina" => "platinacoin",
633 "platinacoin" => "platinacoin",
634 "platinacoins" => "platinacoin",
635 "royalty" => "royalty",
636 "royalties" => "royalty",
637);
638
639sub coin_from_name($) {
640 $coin_alias{$_[0]}
641 ? cf::arch::find $coin_alias{$_[0]}
642 : undef
643}
644
645=item $value = cf::db_get $family => $key
646
647Returns a single value from the environment database.
648
649=item cf::db_put $family => $key => $value
650
651Stores the given C<$value> in the family. It can currently store binary
652data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
653
654=item $db = cf::db_table "name"
655
656Create and/or open a new database table. The string must not be "db" and must be unique
657within each server.
658
659=cut
660
661sub db_table($) {
662 cf::error "db_get called from main context"
663 if $Coro::current == $Coro::main;
664
665 my ($name) = @_;
666 my $db = BDB::db_create $DB_ENV;
667
668 eval {
669 $db->set_flags (BDB::CHKSUM);
670
671 utf8::encode $name;
672 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
673 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
674 cf::cleanup "db_open(db): $!" if $!;
675 };
676 cf::cleanup "db_open(db): $@" if $@;
677
678 $db
679}
680
681our $DB;
682
683sub db_init {
684 $DB ||= db_table "db";
685}
686
687sub db_get($$) {
688 my $key = "$_[0]/$_[1]";
689
690 cf::error "db_get called from main context"
691 if $Coro::current == $Coro::main;
692
693 BDB::db_get $DB, undef, $key, my $data;
694
695 $! ? ()
696 : $data
697}
698
699sub db_put($$$) {
700 BDB::dbreq_pri 4;
701 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
702}
703
704=item cf::cache $id => [$paths...], $processversion => $process
705
706Generic caching function that returns the value of the resource $id,
707caching and regenerating as required.
708
709This function can block.
710
711=cut
712
713sub cache {
714 my ($id, $src, $processversion, $process) = @_;
715
716 my $meta =
717 join "\x00",
718 $processversion,
719 map {
720 aio_stat $_
721 and Carp::croak "$_: $!";
722
723 ($_, (stat _)[7,9])
724 } @$src;
725
726 my $dbmeta = db_get cache => "$id/meta";
727 if ($dbmeta ne $meta) {
728 # changed, we may need to process
729
730 my @data;
731 my $md5;
732
733 for (0 .. $#$src) {
734 0 <= aio_load $src->[$_], $data[$_]
735 or Carp::croak "$src->[$_]: $!";
736 }
737
738 # if processing is expensive, check
739 # checksum first
740 if (1) {
741 $md5 =
742 join "\x00",
743 $processversion,
744 map {
745 cf::cede_to_tick;
746 ($src->[$_], Digest::MD5::md5_hex $data[$_])
747 } 0.. $#$src;
748
749
750 my $dbmd5 = db_get cache => "$id/md5";
751 if ($dbmd5 eq $md5) {
752 db_put cache => "$id/meta", $meta;
753
754 return db_get cache => "$id/data";
755 }
756 }
757
758 my $t1 = Time::HiRes::time;
759 my $data = $process->(\@data);
760 my $t2 = Time::HiRes::time;
761
762 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
763
764 db_put cache => "$id/data", $data;
765 db_put cache => "$id/md5" , $md5;
766 db_put cache => "$id/meta", $meta;
767
768 return $data;
769 }
770
771 db_get cache => "$id/data"
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 undef $@; # work around perl 5.10.0 utf-8 caching bug
1457
1458 cf::cleanup "mandatory extension '$k' failed to load, exiting."
1459 if exists $v->{meta}{mandatory};
1460
1461 warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
1462 delete $todo{$k};
1463 } else {
1464 $done{$k} = delete $todo{$k};
1465 push @EXTS, $v->{pkg};
1466 $progress = 1;
1467
1468 info "$v->{base}: extension inactive.\n"
1469 unless $active;
1470 }
930 1 1471 }
931 } or warn "$ext not loaded: $@"; 1472
1473 unless ($progress) {
1474 warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
1475
1476 while (my ($k, $v) = each %todo) {
1477 cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
1478 if exists $v->{meta}{mandatory};
1479 }
1480 }
1481 }
932 } 1482 };
933} 1483}
934 1484
935############################################################################# 1485#############################################################################
936 1486
1487=back
1488
937=head2 CORE EXTENSIONS 1489=head2 CORE EXTENSIONS
938 1490
939Functions and methods that extend core crossfire objects. 1491Functions and methods that extend core deliantra objects.
940 1492
941=cut 1493=cut
942 1494
943package cf::player; 1495package cf::player;
944 1496
946 1498
947=head3 cf::player 1499=head3 cf::player
948 1500
949=over 4 1501=over 4
950 1502
1503=item cf::player::num_playing
1504
1505Returns the official number of playing players, as per the Crossfire metaserver rules.
1506
1507=cut
1508
1509sub num_playing {
1510 scalar grep
1511 $_->ob->map
1512 && !$_->hidden
1513 && !$_->ob->flag (cf::FLAG_WIZ),
1514 cf::player::list
1515}
1516
951=item cf::player::find $login 1517=item cf::player::find $login
952 1518
953Returns the given player object, loading it if necessary (might block). 1519Returns the given player object, loading it if necessary (might block).
954 1520
955=cut 1521=cut
956 1522
957sub playerdir($) { 1523sub playerdir($) {
958 cf::localdir 1524 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1525 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1526}
964 1527
965sub path($) { 1528sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1529 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
976 1539
977sub exists($) { 1540sub exists($) {
978 my ($login) = @_; 1541 my ($login) = @_;
979 1542
980 $cf::PLAYER{$login} 1543 $cf::PLAYER{$login}
981 or cf::sync_job { !aio_stat path $login } 1544 or !aio_stat path $login
982} 1545}
983 1546
984sub find($) { 1547sub find($) {
985 return $cf::PLAYER{$_[0]} || do { 1548 return $cf::PLAYER{$_[0]} || do {
986 my $login = $_[0]; 1549 my $login = $_[0];
993 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1556 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
994 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1557 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
995 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1558 aio_unlink +(playerdir $login) . "/$login.pl.pst";
996 aio_unlink +(playerdir $login) . "/$login.pl"; 1559 aio_unlink +(playerdir $login) . "/$login.pl";
997 1560
998 my $pl = load_pl path $login 1561 my $f = new_from_file cf::object::thawer path $login
999 or return; 1562 or return;
1563
1564 my $pl = cf::player::load_pl $f
1565 or return;
1566
1567 local $cf::PLAYER_LOADING{$login} = $pl;
1568 $f->resolve_delayed_derefs;
1000 $cf::PLAYER{$login} = $pl 1569 $cf::PLAYER{$login} = $pl
1001 } 1570 }
1002 } 1571 }
1003} 1572}
1573
1574cf::player->attach (
1575 on_load => sub {
1576 my ($pl, $path) = @_;
1577
1578 # restore slots saved in save, below
1579 my $slots = delete $pl->{_slots};
1580
1581 $pl->ob->current_weapon ($slots->[0]);
1582 $pl->combat_ob ($slots->[1]);
1583 $pl->ranged_ob ($slots->[2]);
1584 },
1585);
1004 1586
1005sub save($) { 1587sub save($) {
1006 my ($pl) = @_; 1588 my ($pl) = @_;
1007 1589
1008 return if $pl->{deny_save}; 1590 return if $pl->{deny_save};
1013 return if $pl->{deny_save}; 1595 return if $pl->{deny_save};
1014 1596
1015 aio_mkdir playerdir $pl, 0770; 1597 aio_mkdir playerdir $pl, 0770;
1016 $pl->{last_save} = $cf::RUNTIME; 1598 $pl->{last_save} = $cf::RUNTIME;
1017 1599
1600 cf::get_slot 0.01;
1601
1602 # save slots, to be restored later
1603 local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
1604
1018 $pl->save_pl ($path); 1605 $pl->save_pl ($path);
1019 Coro::cede; 1606 cf::cede_to_tick;
1020} 1607}
1021 1608
1022sub new($) { 1609sub new($) {
1023 my ($login) = @_; 1610 my ($login) = @_;
1024 1611
1030 $cf::PLAYER{$login} = $self; 1617 $cf::PLAYER{$login} = $self;
1031 1618
1032 $self 1619 $self
1033} 1620}
1034 1621
1622=item $player->send_msg ($channel, $msg, $color, [extra...])
1623
1624=cut
1625
1626sub send_msg {
1627 my $ns = shift->ns
1628 or return;
1629 $ns->send_msg (@_);
1630}
1631
1035=item $pl->quit_character 1632=item $pl->quit_character
1036 1633
1037Nukes the player without looking back. If logged in, the connection will 1634Nukes the player without looking back. If logged in, the connection will
1038be destroyed. May block for a long time. 1635be destroyed. May block for a long time.
1039 1636
1043 my ($pl) = @_; 1640 my ($pl) = @_;
1044 1641
1045 my $name = $pl->ob->name; 1642 my $name = $pl->ob->name;
1046 1643
1047 $pl->{deny_save} = 1; 1644 $pl->{deny_save} = 1;
1048 $pl->password ("*"); # this should lock out the player until we nuked the dir 1645 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1049 1646
1050 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1647 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1051 $pl->deactivate; 1648 $pl->deactivate;
1649 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1052 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1650 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1053 $pl->ns->destroy if $pl->ns; 1651 $pl->ns->destroy if $pl->ns;
1054 1652
1055 my $path = playerdir $pl; 1653 my $path = playerdir $pl;
1056 my $temp = "$path~$cf::RUNTIME~deleting~"; 1654 my $temp = "$path~$cf::RUNTIME~deleting~";
1086while and may block, so not sync_job-capable, ever. 1684while and may block, so not sync_job-capable, ever.
1087 1685
1088=cut 1686=cut
1089 1687
1090sub list_logins { 1688sub list_logins {
1091 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1689 my $dirs = aio_readdir $PLAYERDIR
1092 or return []; 1690 or return [];
1093 1691
1094 my @logins; 1692 my @logins;
1095 1693
1096 for my $login (@$dirs) { 1694 for my $login (@$dirs) {
1695 my $path = path $login;
1696
1697 # a .pst is a dead give-away for a valid player
1698 # if no pst file found, open and chekc for blocked users
1699 if (aio_stat "$path.pst") {
1097 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1700 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1098 aio_read $fh, 0, 512, my $buf, 0 or next; 1701 aio_read $fh, 0, 512, my $buf, 0 or next;
1099 $buf !~ /^password -------------$/m or next; # official not-valid tag 1702 $buf !~ /^password -------------$/m or next; # official not-valid tag
1703 }
1100 1704
1101 utf8::decode $login; 1705 utf8::decode $login;
1102 push @logins, $login; 1706 push @logins, $login;
1103 } 1707 }
1104 1708
1105 \@logins 1709 \@logins
1106} 1710}
1107 1711
1108=item $player->maps 1712=item $player->maps
1713
1714=item cf::player::maps $login
1109 1715
1110Returns an arrayref of map paths that are private for this 1716Returns an arrayref of map paths that are private for this
1111player. May block. 1717player. May block.
1112 1718
1113=cut 1719=cut
1131 } 1737 }
1132 1738
1133 \@paths 1739 \@paths
1134} 1740}
1135 1741
1742=item $protocol_xml = $player->expand_cfpod ($cfpod)
1743
1744Expand deliantra pod fragments into protocol xml.
1745
1136=item $player->ext_reply ($msgid, %msg) 1746=item $player->ext_reply ($msgid, @msg)
1137 1747
1138Sends an ext reply to the player. 1748Sends an ext reply to the player.
1139 1749
1140=cut 1750=cut
1141 1751
1142sub ext_reply($$%) { 1752sub ext_reply($$@) {
1143 my ($self, $id, %msg) = @_; 1753 my ($self, $id, @msg) = @_;
1144 1754
1145 $msg{msgid} = $id; 1755 $self->ns->ext_reply ($id, @msg)
1146
1147 $self->send ("ext " . cf::to_json \%msg);
1148} 1756}
1149 1757
1150=item $player->ext_event ($type, %msg) 1758=item $player->ext_msg ($type, @msg)
1151 1759
1152Sends an ext event to the client. 1760Sends an ext event to the client.
1153 1761
1154=cut 1762=cut
1155 1763
1156sub ext_event($$%) { 1764sub ext_msg($$@) {
1157 my ($self, $type, %msg) = @_; 1765 my ($self, $type, @msg) = @_;
1158 1766
1159 $self->ns->ext_event ($type, %msg); 1767 $self->ns->ext_msg ($type, @msg);
1160} 1768}
1161 1769
1162package cf; 1770=head3 cf::region
1771
1772=over 4
1773
1774=cut
1775
1776package cf::region;
1777
1778=item cf::region::find_by_path $path
1779
1780Tries to decuce the likely region for a map knowing only its path.
1781
1782=cut
1783
1784sub find_by_path($) {
1785 my ($path) = @_;
1786
1787 $path =~ s/^~[^\/]*//; # skip ~login
1788
1789 my ($match, $specificity);
1790
1791 for my $region (list) {
1792 if ($region->{match} && $path =~ $region->{match}) {
1793 ($match, $specificity) = ($region, $region->specificity)
1794 if $region->specificity > $specificity;
1795 }
1796 }
1797
1798 $match
1799}
1163 1800
1164=back 1801=back
1165
1166 1802
1167=head3 cf::map 1803=head3 cf::map
1168 1804
1169=over 4 1805=over 4
1170 1806
1182our $MAX_RESET = 3600; 1818our $MAX_RESET = 3600;
1183our $DEFAULT_RESET = 3000; 1819our $DEFAULT_RESET = 3000;
1184 1820
1185sub generate_random_map { 1821sub generate_random_map {
1186 my ($self, $rmp) = @_; 1822 my ($self, $rmp) = @_;
1823
1824 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1825
1187 # mit "rum" bekleckern, nicht 1826 # mit "rum" bekleckern, nicht
1188 $self->_create_random_map ( 1827 $self->_create_random_map (
1189 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1828 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1190 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1829 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1191 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1830 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1192 $rmp->{exit_on_final_map}, 1831 $rmp->{exit_on_final_map},
1193 $rmp->{xsize}, $rmp->{ysize}, 1832 $rmp->{xsize}, $rmp->{ysize},
1194 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1833 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1195 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1834 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1217 1856
1218 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1857 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1219} 1858}
1220 1859
1221# also paths starting with '/' 1860# also paths starting with '/'
1222$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1861$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1223 1862
1224sub thawer_merge { 1863sub thawer_merge {
1225 my ($self, $merge) = @_; 1864 my ($self, $merge) = @_;
1226 1865
1227 # we have to keep some variables in memory intact 1866 # we have to keep some variables in memory intact
1228 local $self->{path}; 1867 local $self->{path};
1229 local $self->{load_path}; 1868 local $self->{load_path};
1230 local $self->{deny_save};
1231 local $self->{deny_reset};
1232 1869
1233 $self->SUPER::thawer_merge ($merge); 1870 $self->SUPER::thawer_merge ($merge);
1234} 1871}
1235 1872
1236sub normalise { 1873sub normalise {
1283 $self->init; # pass $1 etc. 1920 $self->init; # pass $1 etc.
1284 return $self; 1921 return $self;
1285 } 1922 }
1286 } 1923 }
1287 1924
1288 Carp::carp "unable to resolve path '$path' (base '$base')."; 1925 Carp::cluck "unable to resolve path '$path' (base '$base').";
1289 () 1926 ()
1290} 1927}
1291 1928
1292sub init { 1929sub init {
1293 my ($self) = @_; 1930 my ($self) = @_;
1308 1945
1309# the original (read-only) location 1946# the original (read-only) location
1310sub load_path { 1947sub load_path {
1311 my ($self) = @_; 1948 my ($self) = @_;
1312 1949
1313 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1950 "$MAPDIR/$self->{path}.map"
1314} 1951}
1315 1952
1316# the temporary/swap location 1953# the temporary/swap location
1317sub save_path { 1954sub save_path {
1318 my ($self) = @_; 1955 my ($self) = @_;
1319 1956
1320 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1957 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1321 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1958 "$TMPDIR/$path.map"
1322} 1959}
1323 1960
1324# the unique path, undef == no special unique path 1961# the unique path, undef == no special unique path
1325sub uniq_path { 1962sub uniq_path {
1326 my ($self) = @_; 1963 my ($self) = @_;
1327 1964
1328 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1965 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1329 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1966 "$UNIQUEDIR/$path"
1330} 1967}
1331 1968
1332# and all this just because we cannot iterate over 1969sub decay_objects {
1333# all maps in C++...
1334sub change_all_map_light {
1335 my ($change) = @_; 1970 my ($self) = @_;
1336 1971
1337 $_->change_map_light ($change) 1972 return if $self->{deny_reset};
1338 for grep $_->outdoor, values %cf::MAP; 1973
1974 $self->do_decay_objects;
1339} 1975}
1340 1976
1341sub unlink_save { 1977sub unlink_save {
1342 my ($self) = @_; 1978 my ($self) = @_;
1343 1979
1348 1984
1349sub load_header_from($) { 1985sub load_header_from($) {
1350 my ($self, $path) = @_; 1986 my ($self, $path) = @_;
1351 1987
1352 utf8::encode $path; 1988 utf8::encode $path;
1353 #aio_open $path, O_RDONLY, 0 1989 my $f = new_from_file cf::object::thawer $path
1354 # or return;
1355
1356 $self->_load_header ($path)
1357 or return; 1990 or return;
1991
1992 $self->_load_header ($f)
1993 or return;
1994
1995 local $MAP_LOADING{$self->{path}} = $self;
1996 $f->resolve_delayed_derefs;
1358 1997
1359 $self->{load_path} = $path; 1998 $self->{load_path} = $path;
1360 1999
1361 1 2000 1
1362} 2001}
1401 $self->load_header_orig 2040 $self->load_header_orig
1402 or return; 2041 or return;
1403 $self->prepare_orig; 2042 $self->prepare_orig;
1404 } 2043 }
1405 2044
2045 $self->{deny_reset} = 1
2046 if $self->no_reset;
2047
2048 $self->default_region (cf::region::find_by_path $self->{path})
2049 unless $self->default_region;
2050
1406 1 2051 1
1407} 2052}
1408 2053
1409sub find; 2054sub find;
1410sub find { 2055sub find {
1411 my ($path, $origin) = @_; 2056 my ($path, $origin) = @_;
1412 2057
1413 $path = normalise $path, $origin && $origin->path; 2058 $path = normalise $path, $origin && $origin->path;
1414 2059
2060 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1415 cf::lock_wait "map_find:$path"; 2061 my $guard2 = cf::lock_acquire "map_find:$path";
1416 2062
1417 $cf::MAP{$path} || do { 2063 $cf::MAP{$path} || do {
1418 my $guard = cf::lock_acquire "map_find:$path";
1419 my $map = new_from_path cf::map $path 2064 my $map = new_from_path cf::map $path
1420 or return; 2065 or return;
1421 2066
1422 $map->{last_save} = $cf::RUNTIME; 2067 $map->{last_save} = $cf::RUNTIME;
1423 2068
1424 $map->load_header 2069 $map->load_header
1425 or return; 2070 or return;
1426 2071
1427 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2072 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1428 # doing this can freeze the server in a sync job, obviously 2073 # doing this can freeze the server in a sync job, obviously
1429 #$cf::WAIT_FOR_TICK->wait; 2074 #$cf::WAIT_FOR_TICK->wait;
2075 undef $guard2;
2076 undef $guard1;
1430 $map->reset; 2077 $map->reset;
1431 undef $guard;
1432 return find $path; 2078 return find $path;
1433 } 2079 }
1434 2080
1435 $cf::MAP{$path} = $map 2081 $cf::MAP{$path} = $map
1436 } 2082 }
1437} 2083}
1438 2084
1439sub pre_load { } 2085sub pre_load { }
1440sub post_load { } 2086#sub post_load { } # XS
1441 2087
1442sub load { 2088sub load {
1443 my ($self) = @_; 2089 my ($self) = @_;
1444 2090
1445 local $self->{deny_reset} = 1; # loading can take a long time 2091 local $self->{deny_reset} = 1; # loading can take a long time
1446 2092
1447 my $path = $self->{path}; 2093 my $path = $self->{path};
2094
2095 {
1448 my $guard = cf::lock_acquire "map_load:$path"; 2096 my $guard = cf::lock_acquire "map_data:$path";
1449 2097
2098 return unless $self->valid;
1450 return if $self->in_memory != cf::MAP_SWAPPED; 2099 return unless $self->in_memory == cf::MAP_SWAPPED;
1451 2100
1452 $self->in_memory (cf::MAP_LOADING); 2101 $self->in_memory (cf::MAP_LOADING);
1453 2102
1454 $self->alloc; 2103 $self->alloc;
1455 2104
1456 $self->pre_load; 2105 $self->pre_load;
2106 cf::cede_to_tick;
1457 2107
1458 $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)
1459 or return; 2111 or return;
1460 2112
1461 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2113 $self->post_load_original
1462 if delete $self->{load_original}; 2114 if delete $self->{load_original};
1463 2115
1464 if (my $uniq = $self->uniq_path) { 2116 if (my $uniq = $self->uniq_path) {
1465 utf8::encode $uniq; 2117 utf8::encode $uniq;
1466 if (aio_open $uniq, O_RDONLY, 0) { 2118 unless (aio_stat $uniq) {
2119 if (my $f = new_from_file cf::object::thawer $uniq) {
1467 $self->clear_unique_items; 2120 $self->clear_unique_items;
1468 $self->_load_objects ($uniq, 0); 2121 $self->_load_objects ($f);
2122 $f->resolve_delayed_derefs;
2123 }
1469 } 2124 }
1470 } 2125 }
1471 2126
1472 Coro::cede; 2127 $f->resolve_delayed_derefs;
1473 2128
2129 cf::cede_to_tick;
1474 # now do the right thing for maps 2130 # now do the right thing for maps
1475 $self->link_multipart_objects; 2131 $self->link_multipart_objects;
1476
1477 unless ($self->{deny_activate}) {
1478 $self->decay_objects;
1479 $self->fix_auto_apply;
1480 $self->update_buttons;
1481 Coro::cede;
1482 $self->set_darkness_map;
1483 $self->difficulty ($self->estimate_difficulty) 2132 $self->difficulty ($self->estimate_difficulty)
1484 unless $self->difficulty; 2133 unless $self->difficulty;
1485 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;
1486 $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);
1487 } 2148 }
1488 2149
1489 $self->post_load; 2150 $self->post_load;
1490
1491 $self->in_memory (cf::MAP_IN_MEMORY);
1492} 2151}
1493 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
1494sub customise_for { 2156sub customise_for {
1495 my ($self, $ob) = @_; 2157 my ($self, $ob) = @_;
1496 2158
1497 return find "~" . $ob->name . "/" . $self->{path} 2159 return find "~" . $ob->name . "/" . $self->{path}
1498 if $self->per_player; 2160 if $self->per_player;
1499 2161
2162# return find "?party/" . $ob->name . "/" . $self->{path}
2163# if $self->per_party;
2164
1500 $self 2165 $self
1501} 2166}
1502 2167
1503# 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
1504sub load_diag { 2169sub load_neighbours {
1505 my ($map) = @_; 2170 my ($map) = @_;
1506 2171
1507 my @diag; # diagonal neighbours 2172 my @neigh; # diagonal neighbours
1508 2173
1509 for (0 .. 3) { 2174 for (0 .. 3) {
1510 my $neigh = $map->tile_path ($_) 2175 my $neigh = $map->tile_path ($_)
1511 or next; 2176 or next;
1512 $neigh = find $neigh, $map 2177 $neigh = find $neigh, $map
1513 or next; 2178 or next;
1514 $neigh->load; 2179 $neigh->load;
1515 2180
2181 # now find the diagonal neighbours
2182 push @neigh,
1516 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2183 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1517 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2184 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1518 } 2185 }
1519 2186
1520 for (@diag) { 2187 for (grep defined $_->[0], @neigh) {
2188 my ($path, $origin) = @$_;
1521 my $neigh = find @$_ 2189 my $neigh = find $path, $origin
1522 or next; 2190 or next;
1523 $neigh->load; 2191 $neigh->load;
1524 } 2192 }
1525} 2193}
1526 2194
1527sub find_sync { 2195sub find_sync {
1528 my ($path, $origin) = @_; 2196 my ($path, $origin) = @_;
1529 2197
1530 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
1531} 2202}
1532 2203
1533sub do_load_sync { 2204sub do_load_sync {
1534 my ($map) = @_; 2205 my ($map) = @_;
1535 2206
1536 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;
1537} 2211}
1538 2212
1539our %MAP_PREFETCH; 2213our %MAP_PREFETCH;
1540our $MAP_PREFETCHER = undef; 2214our $MAP_PREFETCHER = undef;
1541 2215
1542sub find_async { 2216sub find_async {
1543 my ($path, $origin) = @_; 2217 my ($path, $origin, $load) = @_;
1544 2218
1545 $path = normalise $path, $origin && $origin->{path}; 2219 $path = normalise $path, $origin && $origin->{path};
1546 2220
1547 if (my $map = $cf::MAP{$path}) { 2221 if (my $map = $cf::MAP{$path}) {
1548 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2222 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1549 } 2223 }
1550 2224
1551 undef $MAP_PREFETCH{$path}; 2225 $MAP_PREFETCH{$path} |= $load;
2226
1552 $MAP_PREFETCHER ||= cf::async { 2227 $MAP_PREFETCHER ||= cf::async {
2228 $Coro::current->{desc} = "map prefetcher";
2229
1553 while (%MAP_PREFETCH) { 2230 while (%MAP_PREFETCH) {
1554 for my $path (keys %MAP_PREFETCH) { 2231 while (my ($k, $v) = each %MAP_PREFETCH) {
1555 my $map = find $path 2232 if (my $map = find $k) {
1556 or next;
1557 $map->load; 2233 $map->load if $v;
2234 }
1558 2235
1559 delete $MAP_PREFETCH{$path}; 2236 delete $MAP_PREFETCH{$k};
1560 } 2237 }
1561 } 2238 }
1562 undef $MAP_PREFETCHER; 2239 undef $MAP_PREFETCHER;
1563 }; 2240 };
1564 $MAP_PREFETCHER->prio (6); 2241 $MAP_PREFETCHER->prio (6);
1565 2242
1566 () 2243 ()
1567} 2244}
1568 2245
2246# common code, used by both ->save and ->swapout
1569sub save { 2247sub _save {
1570 my ($self) = @_; 2248 my ($self) = @_;
1571
1572 my $lock = cf::lock_acquire "map_data:" . $self->path;
1573 2249
1574 $self->{last_save} = $cf::RUNTIME; 2250 $self->{last_save} = $cf::RUNTIME;
1575 2251
1576 return unless $self->dirty; 2252 return unless $self->dirty;
1577 2253
1583 return if $self->{deny_save}; 2259 return if $self->{deny_save};
1584 2260
1585 local $self->{last_access} = $self->last_access;#d# 2261 local $self->{last_access} = $self->last_access;#d#
1586 2262
1587 cf::async { 2263 cf::async {
2264 $Coro::current->{desc} = "map player save";
1588 $_->contr->save for $self->players; 2265 $_->contr->save for $self->players;
1589 }; 2266 };
2267
2268 cf::get_slot 0.02;
1590 2269
1591 if ($uniq) { 2270 if ($uniq) {
1592 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2271 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1593 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2272 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1594 } else { 2273 } else {
1595 $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);
1596 } 2275 }
1597} 2276}
1598 2277
2278sub save {
2279 my ($self) = @_;
2280
2281 my $lock = cf::lock_acquire "map_data:$self->{path}";
2282
2283 $self->_save;
2284}
2285
1599sub swap_out { 2286sub swap_out {
1600 my ($self) = @_; 2287 my ($self) = @_;
1601 2288
1602 # save first because save cedes
1603 $self->save;
1604
1605 my $lock = cf::lock_acquire "map_data:" . $self->path; 2289 my $lock = cf::lock_acquire "map_data:$self->{path}";
1606 2290
2291 return if $self->in_memory != cf::MAP_ACTIVE;
2292 return if $self->{deny_save};
1607 return if $self->players; 2293 return if $self->players;
1608 return if $self->in_memory != cf::MAP_IN_MEMORY;
1609 return if $self->{deny_save};
1610 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
1611 $self->clear; 2304 $self->clear;
1612 $self->in_memory (cf::MAP_SWAPPED);
1613} 2305}
1614 2306
1615sub reset_at { 2307sub reset_at {
1616 my ($self) = @_; 2308 my ($self) = @_;
1617 2309
1618 # TODO: safety, remove and allow resettable per-player maps 2310 # TODO: safety, remove and allow resettable per-player maps
1619 return 1e99 if $self->isa ("ext::map_per_player");#d#
1620 return 1e99 if $self->{deny_reset}; 2311 return 1e99 if $self->{deny_reset};
1621 2312
1622 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2313 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1623 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;
1624 2315
1635 my ($self) = @_; 2326 my ($self) = @_;
1636 2327
1637 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2328 my $lock = cf::lock_acquire "map_data:$self->{path}";
1638 2329
1639 return if $self->players; 2330 return if $self->players;
1640 return if $self->isa ("ext::map_per_player");#d#
1641 2331
1642 warn "resetting map ", $self->path;#d# 2332 cf::trace "resetting map ", $self->path, "\n";
1643 2333
1644 $self->in_memory (cf::MAP_SWAPPED); 2334 $self->in_memory (cf::MAP_SWAPPED);
1645 2335
1646 # need to save uniques path 2336 # need to save uniques path
1647 unless ($self->{deny_save}) { 2337 unless ($self->{deny_save}) {
1651 if $uniq; 2341 if $uniq;
1652 } 2342 }
1653 2343
1654 delete $cf::MAP{$self->path}; 2344 delete $cf::MAP{$self->path};
1655 2345
2346 $self->deactivate;
2347 $_->clear_links_to ($self) for values %cf::MAP;
1656 $self->clear; 2348 $self->clear;
1657
1658 $_->clear_links_to ($self) for values %cf::MAP;
1659 2349
1660 $self->unlink_save; 2350 $self->unlink_save;
1661 $self->destroy; 2351 $self->destroy;
1662} 2352}
1663 2353
1664my $nuke_counter = "aaaa"; 2354my $nuke_counter = "aaaa";
1665 2355
1666sub nuke { 2356sub nuke {
1667 my ($self) = @_; 2357 my ($self) = @_;
1668 2358
2359 {
2360 my $lock = cf::lock_acquire "map_data:$self->{path}";
2361
1669 delete $cf::MAP{$self->path}; 2362 delete $cf::MAP{$self->path};
1670 2363
1671 $self->unlink_save; 2364 $self->unlink_save;
1672 2365
1673 bless $self, "cf::map"; 2366 bless $self, "cf::map::wrap";
1674 delete $self->{deny_reset}; 2367 delete $self->{deny_reset};
1675 $self->{deny_save} = 1; 2368 $self->{deny_save} = 1;
1676 $self->reset_timeout (1); 2369 $self->reset_timeout (1);
1677 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2370 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1678 2371
1679 $cf::MAP{$self->path} = $self; 2372 $cf::MAP{$self->path} = $self;
2373 }
1680 2374
1681 $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 ]
1682} 2412}
1683 2413
1684=item cf::map::unique_maps 2414=item cf::map::unique_maps
1685 2415
1686Returns an arrayref of paths of all shared maps that have 2416Returns an arrayref of paths of all shared maps that have
1687instantiated unique items. May block. 2417instantiated unique items. May block.
1688 2418
1689=cut 2419=cut
1690 2420
1691sub unique_maps() { 2421sub unique_maps() {
1692 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2422 [
1693 or return; 2423 map {
1694
1695 my @paths;
1696
1697 for (@$files) {
1698 utf8::decode $_; 2424 utf8::decode $_;
1699 next if /\.pst$/; 2425 s/\.map$//; # TODO future compatibility hack
1700 next unless /^$PATH_SEP/o; 2426 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1701 2427 ? ()
1702 push @paths, cf::map::normalise $_; 2428 : normalise $_
2429 } @{ aio_readdir $UNIQUEDIR or [] }
1703 } 2430 ]
1704
1705 \@paths
1706} 2431}
1707 2432
1708package 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}
1709 2464
1710=back 2465=back
1711 2466
1712=head3 cf::object 2467=head3 cf::object
1713 2468
1717 2472
1718=over 4 2473=over 4
1719 2474
1720=item $ob->inv_recursive 2475=item $ob->inv_recursive
1721 2476
1722Returns 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.
1723 2479
1724=cut 2480=cut
1725 2481
1726sub inv_recursive_; 2482sub inv_recursive_;
1727sub inv_recursive_ { 2483sub inv_recursive_ {
1730 2486
1731sub inv_recursive { 2487sub inv_recursive {
1732 inv_recursive_ inv $_[0] 2488 inv_recursive_ inv $_[0]
1733} 2489}
1734 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
1735package cf; 2519package cf;
1736 2520
1737=back 2521=back
1738 2522
1739=head3 cf::object::player 2523=head3 cf::object::player
1745Sends 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>
1746can 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
1747dialogue with the given NPC character. 2531dialogue with the given NPC character.
1748 2532
1749=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};
1750 2548
1751# rough implementation of a future "reply" method that works 2549# rough implementation of a future "reply" method that works
1752# with dialog boxes. 2550# with dialog boxes.
1753#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
1754sub cf::object::player::reply($$$;$) { 2552sub cf::object::player::reply($$$;$) {
1756 2554
1757 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2555 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1758 2556
1759 if ($self->{record_replies}) { 2557 if ($self->{record_replies}) {
1760 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2558 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2559
1761 } 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 {
1762 $msg = $npc->name . " says: $msg" if $npc; 2568 $msg = $npc->name . " says: $msg" if $npc;
1763 $self->message ($msg, $flags); 2569 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2570 }
1764 } 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 (@_);
1765} 2582}
1766 2583
1767=item $player_object->may ("access") 2584=item $player_object->may ("access")
1768 2585
1769Returns wether the given player is authorized to access resource "access" 2586Returns wether the given player is authorized to access resource "access"
1782 2599
1783=item $player_object->enter_link 2600=item $player_object->enter_link
1784 2601
1785Freezes 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}>).
1786 2603
1787The 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.
1788I<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.
1789 2608
1790Will never block. 2609Will never block.
1791 2610
1792=item $player_object->leave_link ($map, $x, $y) 2611=item $player_object->leave_link ($map, $x, $y)
1793 2612
1813sub cf::object::player::enter_link { 2632sub cf::object::player::enter_link {
1814 my ($self) = @_; 2633 my ($self) = @_;
1815 2634
1816 $self->deactivate_recursive; 2635 $self->deactivate_recursive;
1817 2636
2637 ++$self->{_link_recursion};
2638
1818 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2639 return if UNIVERSAL::isa $self->map, "ext::map_link";
1819 2640
1820 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2641 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1821 if $self->map; 2642 if $self->map && $self->map->{path} ne "{link}";
1822 2643
1823 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2644 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1824} 2645}
1825 2646
1826sub cf::object::player::leave_link { 2647sub cf::object::player::leave_link {
1827 my ($self, $map, $x, $y) = @_; 2648 my ($self, $map, $x, $y) = @_;
2649
2650 return unless $self->contr->active;
1828 2651
1829 my $link_pos = delete $self->{_link_pos}; 2652 my $link_pos = delete $self->{_link_pos};
1830 2653
1831 unless ($map) { 2654 unless ($map) {
1832 # restore original map position 2655 # restore original map position
1843 ($x, $y) = (-1, -1) 2666 ($x, $y) = (-1, -1)
1844 unless (defined $x) && (defined $y); 2667 unless (defined $x) && (defined $y);
1845 2668
1846 # use -1 or undef as default coordinates, not 0, 0 2669 # use -1 or undef as default coordinates, not 0, 0
1847 ($x, $y) = ($map->enter_x, $map->enter_y) 2670 ($x, $y) = ($map->enter_x, $map->enter_y)
1848 if $x <=0 && $y <= 0; 2671 if $x <= 0 && $y <= 0;
1849 2672
1850 $map->load; 2673 $map->load;
1851 $map->load_diag; 2674 $map->load_neighbours;
1852 2675
1853 return unless $self->contr->active; 2676 return unless $self->contr->active;
1854 $self->activate_recursive;
1855 2677
1856 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2678 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1857 $self->enter_map ($map, $x, $y); 2679 if ($self->enter_map ($map, $x, $y)) {
1858} 2680 # entering was successful
1859 2681 delete $self->{_link_recursion};
1860cf::player->attach ( 2682 # only activate afterwards, to support waiting in hooks
1861 on_logout => sub { 2683 $self->activate_recursive;
1862 my ($pl) = @_;
1863
1864 # abort map switching before logout
1865 if ($pl->ob->{_link_pos}) {
1866 cf::sync_job {
1867 $pl->ob->leave_link
1868 };
1869 }
1870 }, 2684 }
1871 on_login => sub {
1872 my ($pl) = @_;
1873 2685
1874 # try to abort aborted map switching on player login :) 2686}
1875 # should happen only on crashes
1876 if ($pl->ob->{_link_pos}) {
1877 $pl->ob->enter_link;
1878 (async {
1879 $pl->ob->reply (undef,
1880 "There was an internal problem at your last logout, "
1881 . "the server will try to bring you to your intended destination in a second.",
1882 cf::NDI_RED);
1883 # we need this sleep as the login has a concurrent enter_exit running
1884 # and this sleep increases chances of the player not ending up in scorn
1885 Coro::Timer::sleep 1;
1886 $pl->ob->leave_link;
1887 })->prio (2);
1888 }
1889 },
1890);
1891 2687
1892=item $player_object->goto ($path, $x, $y) 2688=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1893 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
1894=cut 2699=cut
2700
2701our $GOTOGEN;
1895 2702
1896sub cf::object::player::goto { 2703sub cf::object::player::goto {
1897 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;
1898 2714
1899 $self->enter_link; 2715 $self->enter_link;
1900 2716
1901 (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
1902 my $map = eval { 2739 my $map = eval {
1903 my $map = cf::map::find $path; 2740 my $map = defined $path ? cf::map::find $path : undef;
2741
2742 if ($map) {
1904 $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
1905 $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 $@;
1906 } or 2755 }
1907 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1908 2756
2757 if ($gen == $self->{_goto_generation}) {
2758 delete $self->{_goto_generation};
1909 $self->leave_link ($map, $x, $y); 2759 $self->leave_link ($map, $x, $y);
2760 }
2761
2762 $done->($self) if $done;
1910 })->prio (1); 2763 })->prio (1);
1911} 2764}
1912 2765
1913=item $player_object->enter_exit ($exit_object) 2766=item $player_object->enter_exit ($exit_object)
1914 2767
1934} 2787}
1935 2788
1936sub prepare_random_map { 2789sub prepare_random_map {
1937 my ($exit) = @_; 2790 my ($exit) = @_;
1938 2791
1939 my $guard = cf::lock_acquire "exit_prepare:$exit";
1940
1941 # all this does is basically replace the /! path by 2792 # all this does is basically replace the /! path by
1942 # a new random map path (?random/...) with a seed 2793 # a new random map path (?random/...) with a seed
1943 # that depends on the exit object 2794 # that depends on the exit object
1944 2795
1945 my $rmp = parse_random_map_params $exit->msg; 2796 my $rmp = parse_random_map_params $exit->msg;
1947 if ($exit->map) { 2798 if ($exit->map) {
1948 $rmp->{region} = $exit->region->name; 2799 $rmp->{region} = $exit->region->name;
1949 $rmp->{origin_map} = $exit->map->path; 2800 $rmp->{origin_map} = $exit->map->path;
1950 $rmp->{origin_x} = $exit->x; 2801 $rmp->{origin_x} = $exit->x;
1951 $rmp->{origin_y} = $exit->y; 2802 $rmp->{origin_y} = $exit->y;
2803
2804 $exit->map->touch;
1952 } 2805 }
1953 2806
1954 $rmp->{random_seed} ||= $exit->random_seed; 2807 $rmp->{random_seed} ||= $exit->random_seed;
1955 2808
1956 my $data = cf::to_json $rmp; 2809 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1957 my $md5 = Digest::MD5::md5_hex $data; 2810 my $md5 = Digest::MD5::md5_hex $data;
1958 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2811 my $meta = "$RANDOMDIR/$md5.meta";
1959 2812
1960 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2813 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1961 aio_write $fh, 0, (length $data), $data, 0; 2814 aio_write $fh, 0, (length $data), $data, 0;
1962 undef $fh; 2815 undef $fh;
1963 aio_rename "$meta~", $meta; 2816 aio_rename "$meta~", $meta;
1964 2817
2818 my $slaying = "?random/$md5";
2819
2820 if ($exit->valid) {
1965 $exit->slaying ("?random/$md5"); 2821 $exit->slaying ("?random/$md5");
1966 $exit->msg (undef); 2822 $exit->msg (undef);
2823 }
1967 } 2824 }
1968} 2825}
1969 2826
1970sub cf::object::player::enter_exit { 2827sub cf::object::player::enter_exit {
1971 my ($self, $exit) = @_; 2828 my ($self, $exit) = @_;
1972 2829
1973 return unless $self->type == cf::PLAYER; 2830 return unless $self->type == cf::PLAYER;
1974 2831
1975 if ($exit->slaying eq "/!") {
1976 #TODO: this should de-fi-ni-te-ly not be a sync-job
1977 # the problem is that $exit might not survive long enough
1978 # so it needs to be done right now, right here
1979 cf::sync_job { prepare_random_map $exit };
1980 }
1981
1982 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1983 my $hp = $exit->stats->hp;
1984 my $sp = $exit->stats->sp;
1985
1986 $self->enter_link; 2832 $self->enter_link;
1987 2833
1988 (async { 2834 (async {
1989 $self->deactivate_recursive; # just to be sure 2835 $Coro::current->{desc} = "enter_exit";
2836
1990 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
1991 $self->goto ($slaying, $hp, $sp); 2852 $self->goto ($map, $x, $y);
1992 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
1993 1; 2858 1
1994 }) { 2859 }) {
1995 $self->message ("Something went wrong deep within the crossfire server. " 2860 $self->message ("Something went wrong deep within the deliantra server. "
1996 . "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. "
1997 . "Please report this to the dungeon master!", 2862 . "Please report this to the dungeon master!",
1998 cf::NDI_UNIQUE | cf::NDI_RED); 2863 cf::NDI_UNIQUE | cf::NDI_RED);
1999 2864
2000 warn "ERROR in enter_exit: $@"; 2865 error "ERROR in enter_exit: $@";
2001 $self->leave_link; 2866 $self->leave_link;
2002 } 2867 }
2003 })->prio (1); 2868 })->prio (1);
2004} 2869}
2005 2870
2019 2884
2020 utf8::encode $text; 2885 utf8::encode $text;
2021 $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);
2022} 2887}
2023 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
2024=item $client->ext_event ($type, %msg) 3076=item $client->ext_msg ($type, @msg)
2025 3077
2026Sends an exti event to the client. 3078Sends an ext event to the client.
2027 3079
2028=cut 3080=cut
2029 3081
2030sub cf::client::ext_event($$%) { 3082sub cf::client::ext_msg($$@) {
2031 my ($self, $type, %msg) = @_; 3083 my ($self, $type, @msg) = @_;
2032 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
2033 $msg{msgtype} = "event_$type"; 3088 push @msg, msgtype => "event_$type";
2034 $self->send_packet ("ext " . cf::to_json \%msg); 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 }
2035} 3109}
2036 3110
2037=item $success = $client->query ($flags, "text", \&cb) 3111=item $success = $client->query ($flags, "text", \&cb)
2038 3112
2039Queues a query to the client, calling the given callback with 3113Queues a query to the client, calling the given callback with
2040the 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>,
2041C<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>.
2042 3116
2043Queries 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
2044reliable at some point in the future. 3118become reliable at some point in the future.
2045 3119
2046=cut 3120=cut
2047 3121
2048sub cf::client::query { 3122sub cf::client::query {
2049 my ($self, $flags, $text, $cb) = @_; 3123 my ($self, $flags, $text, $cb) = @_;
2057 utf8::encode $text; 3131 utf8::encode $text;
2058 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3132 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2059 3133
2060 $self->send_packet ($self->{query_queue}[0][0]) 3134 $self->send_packet ($self->{query_queue}[0][0])
2061 if @{ $self->{query_queue} } == 1; 3135 if @{ $self->{query_queue} } == 1;
3136
3137 1
2062} 3138}
2063 3139
2064cf::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 },
2065 on_reply => sub { 3146 on_reply => sub {
2066 my ($ns, $msg) = @_; 3147 my ($ns, $msg) = @_;
2067 3148
2068 # this weird shuffling is so that direct followup queries 3149 # this weird shuffling is so that direct followup queries
2069 # get handled first 3150 # get handled first
2081 } else { 3162 } else {
2082 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2083 } 3164 }
2084 } 3165 }
2085 }, 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 },
2086); 3193);
2087 3194
2088=item $client->async (\&cb) 3195=item $client->async (\&cb)
2089 3196
2090Create a new coroutine, running the specified callback. The coroutine will 3197Create a new coroutine, running the specified callback. The coroutine will
2106 3213
2107 $coro 3214 $coro
2108} 3215}
2109 3216
2110cf::client->attach ( 3217cf::client->attach (
2111 on_destroy => sub { 3218 on_client_destroy => sub {
2112 my ($ns) = @_; 3219 my ($ns) = @_;
2113 3220
2114 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3221 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2115 }, 3222 },
2116); 3223);
2131our $safe = new Safe "safe"; 3238our $safe = new Safe "safe";
2132our $safe_hole = new Safe::Hole; 3239our $safe_hole = new Safe::Hole;
2133 3240
2134$SIG{FPE} = 'IGNORE'; 3241$SIG{FPE} = 'IGNORE';
2135 3242
2136$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));
2137 3248
2138# here we export the classes and methods available to script code 3249# here we export the classes and methods available to script code
2139 3250
2140=pod 3251=pod
2141 3252
2142The following functions and methods are available within a safe environment: 3253The following functions and methods are available within a safe environment:
2143 3254
2144 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
2145 cf::object::player player 3260 cf::object::player
2146 cf::player peaceful 3261 player
2147 cf::map trigger 3262
3263 cf::player
3264 peaceful
3265
3266 cf::map
3267 trigger
2148 3268
2149=cut 3269=cut
2150 3270
2151for ( 3271for (
2152 ["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)],
2153 ["cf::object::player" => qw(player)], 3275 ["cf::object::player" => qw(player)],
2154 ["cf::player" => qw(peaceful)], 3276 ["cf::player" => qw(peaceful send_msg)],
2155 ["cf::map" => qw(trigger)], 3277 ["cf::map" => qw(trigger)],
2156) { 3278) {
2157 no strict 'refs'; 3279 no strict 'refs';
2158 my ($pkg, @funs) = @$_; 3280 my ($pkg, @funs) = @$_;
2159 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3281 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2177 3299
2178 my $qcode = $code; 3300 my $qcode = $code;
2179 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3301 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2180 $qcode =~ s/\n/\\n/g; 3302 $qcode =~ s/\n/\\n/g;
2181 3303
3304 %vars = (_dummy => 0) unless %vars;
3305
3306 my @res;
2182 local $_; 3307 local $_;
2183 local @safe::cf::_safe_eval_args = values %vars;
2184 3308
2185 my $eval = 3309 my $eval =
2186 "do {\n" 3310 "do {\n"
2187 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3311 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2188 . "#line 0 \"{$qcode}\"\n" 3312 . "#line 0 \"{$qcode}\"\n"
2189 . $code 3313 . $code
2190 . "\n}" 3314 . "\n}"
2191 ; 3315 ;
2192 3316
3317 if ($CFG{safe_eval}) {
2193 sub_generation_inc; 3318 sub_generation_inc;
3319 local @safe::cf::_safe_eval_args = values %vars;
2194 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3320 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2195 sub_generation_inc; 3321 sub_generation_inc;
3322 } else {
3323 local @cf::_safe_eval_args = values %vars;
3324 @res = wantarray ? eval eval : scalar eval $eval;
3325 }
2196 3326
2197 if ($@) { 3327 if ($@) {
2198 warn "$@"; 3328 warn "$@",
2199 warn "while executing safe code '$code'\n"; 3329 "while executing safe code '$code'\n",
2200 warn "with arguments " . (join " ", %vars) . "\n"; 3330 "with arguments " . (join " ", %vars) . "\n";
2201 } 3331 }
2202 3332
2203 wantarray ? @res : $res[0] 3333 wantarray ? @res : $res[0]
2204} 3334}
2205 3335
2219=cut 3349=cut
2220 3350
2221sub register_script_function { 3351sub register_script_function {
2222 my ($fun, $cb) = @_; 3352 my ($fun, $cb) = @_;
2223 3353
2224 no strict 'refs'; 3354 $fun = "safe::$fun" if $CFG{safe_eval};
2225 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3355 *$fun = $safe_hole->wrap ($cb);
2226} 3356}
2227 3357
2228=back 3358=back
2229 3359
2230=cut 3360=cut
2231
2232#############################################################################
2233
2234=head2 EXTENSION DATABASE SUPPORT
2235
2236Crossfire maintains a very simple database for extension use. It can
2237currently store anything that can be serialised using Storable, which
2238excludes objects.
2239
2240The parameter C<$family> should best start with the name of the extension
2241using it, it should be unique.
2242
2243=over 4
2244
2245=item $value = cf::db_get $family => $key
2246
2247Returns a single value from the database.
2248
2249=item cf::db_put $family => $key => $value
2250
2251Stores the given C<$value> in the family.
2252
2253=cut
2254
2255our $DB;
2256
2257sub db_init {
2258 unless ($DB) {
2259 $DB = BDB::db_create $DB_ENV;
2260
2261 cf::sync_job {
2262 eval {
2263 $DB->set_flags (BDB::CHKSUM);
2264
2265 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2266 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2267 cf::cleanup "db_open(db): $!" if $!;
2268 };
2269 cf::cleanup "db_open(db): $@" if $@;
2270 };
2271
2272 my $path = cf::localdir . "/database.pst";
2273 if (stat $path) {
2274 cf::sync_job {
2275 my $pst = Storable::retrieve $path;
2276
2277 cf::db_put (board => data => $pst->{board});
2278 cf::db_put (guildrules => data => $pst->{guildrules});
2279 cf::db_put (rent => balance => $pst->{rent}{balance});
2280 BDB::db_env_txn_checkpoint $DB_ENV;
2281
2282 unlink $path;
2283 };
2284 }
2285 }
2286}
2287
2288sub db_get($$) {
2289 my $key = "$_[0]/$_[1]";
2290
2291 cf::sync_job {
2292 BDB::db_get $DB, undef, $key, my $data;
2293
2294 $! ? ()
2295 : Compress::LZF::sthaw $data
2296 }
2297}
2298
2299sub db_put($$$) {
2300 BDB::dbreq_pri 4;
2301 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2302}
2303 3361
2304############################################################################# 3362#############################################################################
2305# the server's init and main functions 3363# the server's init and main functions
2306 3364
2307sub load_facedata { 3365sub load_facedata($) {
2308 my $path = sprintf "%s/facedata", cf::datadir; 3366 my ($path) = @_;
2309 3367
3368 # HACK to clear player env face cache, we need some signal framework
3369 # for this (global event?)
3370 %ext::player_env::MUSIC_FACE_CACHE = ();
3371
3372 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3373
2310 warn "loading facedata from $path\n"; 3374 trace "loading facedata from $path\n";
2311 3375
2312 my $faces; 3376 my $facedata;
2313 0 < aio_load $path, $faces 3377 0 < aio_load $path, $facedata
2314 or die "$path: $!"; 3378 or die "$path: $!";
2315 3379
2316 Coro::cede;
2317 $faces = Storable::thaw $faces; 3380 $facedata = Coro::Storable::thaw $facedata;
2318 Coro::cede;
2319 3381
2320 my $meta = delete $faces->{""};
2321 $meta->{version} == 1 3382 $facedata->{version} == 2
2322 or cf::cleanup "$path: version mismatch, cannot proceed."; 3383 or cf::cleanup "$path: version mismatch, cannot proceed.";
2323 3384
3385 # patch in the exptable
3386 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3387 $facedata->{resource}{"res/exp_table"} = {
3388 type => FT_RSRC,
3389 data => $exp_table,
3390 hash => (Digest::MD5::md5 $exp_table),
3391 };
3392 cf::cede_to_tick;
3393
3394 {
3395 my $faces = $facedata->{faceinfo};
3396
2324 while (my ($face, $info) = each %$faces) { 3397 while (my ($face, $info) = each %$faces) {
2325 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3398 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2326 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 3399
3400 cf::face::set_visibility $idx, $info->{visibility};
3401 cf::face::set_magicmap $idx, $info->{magicmap};
2327 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3402 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2328 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 3403 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2329 Coro::cede;
2330 }
2331 3404
3405 cf::cede_to_tick;
3406 }
3407
2332 while (my ($face, $info) = each %$faces) { 3408 while (my ($face, $info) = each %$faces) {
2333 next unless $info->{smooth}; 3409 next unless $info->{smooth};
3410
2334 my $idx = cf::face::find $face 3411 my $idx = cf::face::find $face
3412 or next;
3413
3414 if (my $smooth = cf::face::find $info->{smooth}) {
3415 cf::face::set_smooth $idx, $smooth;
3416 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3417 } else {
3418 error "smooth face '$info->{smooth}' not found for face '$face'";
3419 }
3420
3421 cf::cede_to_tick;
3422 }
3423 }
3424
3425 {
3426 my $anims = $facedata->{animinfo};
3427
3428 while (my ($anim, $info) = each %$anims) {
3429 cf::anim::set $anim, $info->{frames}, $info->{facings};
3430 cf::cede_to_tick;
3431 }
3432
3433 cf::anim::invalidate_all; # d'oh
3434 }
3435
3436 {
3437 my $res = $facedata->{resource};
3438
3439 while (my ($name, $info) = each %$res) {
3440 if (defined $info->{type}) {
3441 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3442
3443 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3444 cf::face::set_type $idx, $info->{type};
3445 } else {
3446 $RESOURCE{$name} = $info; # unused
3447 }
3448
3449 cf::cede_to_tick;
3450 }
3451 }
3452
3453 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3454
3455 1
3456}
3457
3458register_exticmd fx_want => sub {
3459 my ($ns, $want) = @_;
3460
3461 while (my ($k, $v) = each %$want) {
3462 $ns->fx_want ($k, $v);
3463 }
3464};
3465
3466sub load_resource_file($) {
3467 my $guard = lock_acquire "load_resource_file";
3468
3469 my $status = load_resource_file_ $_[0];
3470 get_slot 0.1, 100;
3471 cf::arch::commit_load;
3472
3473 $status
3474}
3475
3476sub reload_regions {
3477 # HACK to clear player env face cache, we need some signal framework
3478 # for this (global event?)
3479 %ext::player_env::MUSIC_FACE_CACHE = ();
3480
3481 load_resource_file "$MAPDIR/regions"
3482 or die "unable to load regions file\n";
3483
3484 for (cf::region::list) {
3485 $_->{match} = qr/$_->{match}/
3486 if exists $_->{match};
3487 }
3488}
3489
3490sub reload_facedata {
3491 load_facedata "$DATADIR/facedata"
3492 or die "unable to load facedata\n";
3493}
3494
3495sub reload_archetypes {
3496 load_resource_file "$DATADIR/archetypes"
3497 or die "unable to load archetypes\n";
3498}
3499
3500sub reload_treasures {
3501 load_resource_file "$DATADIR/treasures"
3502 or die "unable to load treasurelists\n";
3503}
3504
3505sub reload_sound {
3506 trace "loading sound config from $DATADIR/sound\n";
3507
3508 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3509 or die "$DATADIR/sound $!";
3510
3511 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3512
3513 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3514 my $sound = $soundconf->{compat}[$_]
2335 or next; 3515 or next;
2336 if (my $smooth = cf::face::find $info->{smooth}) {
2337 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2338 } else {
2339 warn "smooth face '$info->{smooth}' not found for face '$face'";
2340 }
2341 Coro::cede;
2342 }
2343 3516
3517 my $face = cf::face::find "sound/$sound->[1]";
3518 cf::sound::set $sound->[0] => $face;
3519 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2344 1 3520 }
3521
3522 while (my ($k, $v) = each %{$soundconf->{event}}) {
3523 my $face = cf::face::find "sound/$v";
3524 cf::sound::set $k => $face;
3525 }
2345} 3526}
2346 3527
2347sub reload_resources { 3528sub reload_resources {
2348 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3529 trace "reloading resource files...\n";
2349 or die "unable to load regions file\n";#d# 3530
2350 load_facedata 3531 reload_facedata;
2351 or die "unable to load facedata\n";#d# 3532 reload_sound;
2352} 3533 reload_archetypes;
2353
2354sub init {
2355 reload_resources; 3534 reload_regions;
2356} 3535 reload_treasures;
2357 3536
2358sub cfg_load { 3537 trace "finished reloading resource files\n";
3538}
3539
3540sub reload_config {
3541 trace "reloading config file...\n";
3542
2359 open my $fh, "<:utf8", cf::confdir . "/config" 3543 open my $fh, "<:utf8", "$CONFDIR/config"
2360 or return; 3544 or return;
2361 3545
2362 local $/; 3546 local $/;
2363 *CFG = YAML::Syck::Load <$fh>; 3547 *CFG = YAML::XS::Load scalar <$fh>;
2364 3548
2365 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3549 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2366 3550
2367 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3551 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2368 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3552 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2369 3553
2370 if (exists $CFG{mlockall}) { 3554 if (exists $CFG{mlockall}) {
2372 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3556 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2373 and die "WARNING: m(un)lockall failed: $!\n"; 3557 and die "WARNING: m(un)lockall failed: $!\n";
2374 }; 3558 };
2375 warn $@ if $@; 3559 warn $@ if $@;
2376 } 3560 }
3561
3562 trace "finished reloading resource files\n";
3563}
3564
3565sub pidfile() {
3566 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3567 or die "$PIDFILE: $!";
3568 flock $fh, &Fcntl::LOCK_EX
3569 or die "$PIDFILE: flock: $!";
3570 $fh
3571}
3572
3573# make sure only one server instance is running at any one time
3574sub atomic {
3575 my $fh = pidfile;
3576
3577 my $pid = <$fh>;
3578 kill 9, $pid if $pid > 0;
3579
3580 seek $fh, 0, 0;
3581 print $fh $$;
3582}
3583
3584sub main_loop {
3585 trace "EV::loop starting\n";
3586 if (1) {
3587 EV::loop;
3588 }
3589 trace "EV::loop returned\n";
3590 goto &main_loop unless $REALLY_UNLOOP;
2377} 3591}
2378 3592
2379sub main { 3593sub main {
3594 cf::init_globals; # initialise logging
3595
3596 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3597 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3598 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3599 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3600
3601 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3602
2380 # we must not ever block the main coroutine 3603 # we must not ever block the main coroutine
2381 local $Coro::idle = sub { 3604 local $Coro::idle = sub {
2382 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3605 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2383 (async { 3606 (async {
2384 Event::one_event; 3607 $Coro::current->{desc} = "IDLE BUG HANDLER";
3608 EV::loop EV::LOOP_ONESHOT;
2385 })->prio (Coro::PRIO_MAX); 3609 })->prio (Coro::PRIO_MAX);
2386 }; 3610 };
2387 3611
2388 cfg_load; 3612 evthread_start IO::AIO::poll_fileno;
3613
3614 cf::sync_job {
3615 cf::init_experience;
3616 cf::init_anim;
3617 cf::init_attackmess;
3618 cf::init_dynamic;
3619
3620 cf::load_settings;
3621 cf::load_materials;
3622
3623 reload_resources;
3624 reload_config;
2389 db_init; 3625 db_init;
3626
3627 cf::init_uuid;
3628 cf::init_signals;
3629 cf::init_skills;
3630
3631 cf::init_beforeplay;
3632
3633 atomic;
3634
2390 load_extensions; 3635 load_extensions;
2391 3636
2392 $TICK_WATCHER->start; 3637 utime time, time, $RUNTIMEFILE;
2393 Event::loop; 3638
3639 # no (long-running) fork's whatsoever before this point(!)
3640 use POSIX ();
3641 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3642
3643 (pop @POST_INIT)->(0) while @POST_INIT;
3644 };
3645
3646 cf::object::thawer::errors_are_fatal 0;
3647 info "parse errors in files are no longer fatal from this point on.\n";
3648
3649 main_loop;
2394} 3650}
2395 3651
2396############################################################################# 3652#############################################################################
2397# initialisation and cleanup 3653# initialisation and cleanup
2398 3654
2399# install some emergency cleanup handlers 3655# install some emergency cleanup handlers
2400BEGIN { 3656BEGIN {
3657 our %SIGWATCHER = ();
2401 for my $signal (qw(INT HUP TERM)) { 3658 for my $signal (qw(INT HUP TERM)) {
2402 Event->signal ( 3659 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2403 reentrant => 0,
2404 data => WF_AUTOCANCEL,
2405 signal => $signal,
2406 prio => 0,
2407 cb => sub {
2408 cf::cleanup "SIG$signal"; 3660 cf::cleanup "SIG$signal";
2409 },
2410 ); 3661 };
3662 }
3663}
3664
3665sub write_runtime_sync {
3666 my $t0 = AE::time;
3667
3668 # first touch the runtime file to show we are still running:
3669 # the fsync below can take a very very long time.
3670
3671 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3672
3673 my $guard = cf::lock_acquire "write_runtime";
3674
3675 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3676 or return;
3677
3678 my $value = $cf::RUNTIME + 90 + 10;
3679 # 10 is the runtime save interval, for a monotonic clock
3680 # 60 allows for the watchdog to kill the server.
3681
3682 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3683 and return;
3684
3685 # always fsync - this file is important
3686 aio_fsync $fh
3687 and return;
3688
3689 # touch it again to show we are up-to-date
3690 aio_utime $fh, undef, undef;
3691
3692 close $fh
3693 or return;
3694
3695 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3696 and return;
3697
3698 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3699
2411 } 3700 1
3701}
3702
3703our $uuid_lock;
3704our $uuid_skip;
3705
3706sub write_uuid_sync($) {
3707 $uuid_skip ||= $_[0];
3708
3709 return if $uuid_lock;
3710 local $uuid_lock = 1;
3711
3712 my $uuid = "$LOCALDIR/uuid";
3713
3714 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3715 or return;
3716
3717 my $value = uuid_seq uuid_cur;
3718
3719 unless ($value) {
3720 info "cowardly refusing to write zero uuid value!\n";
3721 return;
3722 }
3723
3724 my $value = uuid_str $value + $uuid_skip;
3725 $uuid_skip = 0;
3726
3727 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3728 and return;
3729
3730 # always fsync - this file is important
3731 aio_fsync $fh
3732 and return;
3733
3734 close $fh
3735 or return;
3736
3737 aio_rename "$uuid~", $uuid
3738 and return;
3739
3740 trace "uuid file written ($value).\n";
3741
3742 1
3743
3744}
3745
3746sub write_uuid($$) {
3747 my ($skip, $sync) = @_;
3748
3749 $sync ? write_uuid_sync $skip
3750 : async { write_uuid_sync $skip };
2412} 3751}
2413 3752
2414sub emergency_save() { 3753sub emergency_save() {
2415 my $freeze_guard = cf::freeze_mainloop; 3754 my $freeze_guard = cf::freeze_mainloop;
2416 3755
2417 warn "enter emergency perl save\n"; 3756 info "emergency_perl_save: enter\n";
3757
3758 # this is a trade-off: we want to be very quick here, so
3759 # save all maps without fsync, and later call a global sync
3760 # (which in turn might be very very slow)
3761 local $USE_FSYNC = 0;
2418 3762
2419 cf::sync_job { 3763 cf::sync_job {
3764 cf::write_runtime_sync; # external watchdog should not bark
3765
2420 # use a peculiar iteration method to avoid tripping on perl 3766 # use a peculiar iteration method to avoid tripping on perl
2421 # refcount bugs in for. also avoids problems with players 3767 # refcount bugs in for. also avoids problems with players
2422 # and maps saved/destroyed asynchronously. 3768 # and maps saved/destroyed asynchronously.
2423 warn "begin emergency player save\n"; 3769 info "emergency_perl_save: begin player save\n";
2424 for my $login (keys %cf::PLAYER) { 3770 for my $login (keys %cf::PLAYER) {
2425 my $pl = $cf::PLAYER{$login} or next; 3771 my $pl = $cf::PLAYER{$login} or next;
2426 $pl->valid or next; 3772 $pl->valid or next;
3773 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2427 $pl->save; 3774 $pl->save;
2428 } 3775 }
2429 warn "end emergency player save\n"; 3776 info "emergency_perl_save: end player save\n";
2430 3777
2431 warn "begin emergency map save\n"; 3778 cf::write_runtime_sync; # external watchdog should not bark
3779
3780 info "emergency_perl_save: begin map save\n";
2432 for my $path (keys %cf::MAP) { 3781 for my $path (keys %cf::MAP) {
2433 my $map = $cf::MAP{$path} or next; 3782 my $map = $cf::MAP{$path} or next;
2434 $map->valid or next; 3783 $map->valid or next;
2435 $map->save; 3784 $map->save;
2436 } 3785 }
2437 warn "end emergency map save\n"; 3786 info "emergency_perl_save: end map save\n";
2438 3787
2439 warn "begin emergency database checkpoint\n"; 3788 cf::write_runtime_sync; # external watchdog should not bark
3789
3790 info "emergency_perl_save: begin database checkpoint\n";
2440 BDB::db_env_txn_checkpoint $DB_ENV; 3791 BDB::db_env_txn_checkpoint $DB_ENV;
2441 warn "end emergency database checkpoint\n"; 3792 info "emergency_perl_save: end database checkpoint\n";
3793
3794 info "emergency_perl_save: begin write uuid\n";
3795 write_uuid_sync 1;
3796 info "emergency_perl_save: end write uuid\n";
3797
3798 cf::write_runtime_sync; # external watchdog should not bark
3799
3800 trace "emergency_perl_save: syncing database to disk";
3801 BDB::db_env_txn_checkpoint $DB_ENV;
3802
3803 info "emergency_perl_save: starting sync\n";
3804 IO::AIO::aio_sync sub {
3805 info "emergency_perl_save: finished sync\n";
3806 };
3807
3808 cf::write_runtime_sync; # external watchdog should not bark
3809
3810 trace "emergency_perl_save: flushing outstanding aio requests";
3811 while (IO::AIO::nreqs || BDB::nreqs) {
3812 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3813 }
3814
3815 cf::write_runtime_sync; # external watchdog should not bark
2442 }; 3816 };
2443 3817
2444 warn "leave emergency perl save\n"; 3818 info "emergency_perl_save: leave\n";
2445} 3819}
2446 3820
2447sub post_cleanup { 3821sub post_cleanup {
2448 my ($make_core) = @_; 3822 my ($make_core) = @_;
2449 3823
3824 IO::AIO::flush;
3825
2450 warn Carp::longmess "post_cleanup backtrace" 3826 error Carp::longmess "post_cleanup backtrace"
2451 if $make_core; 3827 if $make_core;
2452}
2453 3828
3829 my $fh = pidfile;
3830 unlink $PIDFILE if <$fh> == $$;
3831}
3832
3833# a safer delete_package, copied from Symbol
3834sub clear_package($) {
3835 my $pkg = shift;
3836
3837 # expand to full symbol table name if needed
3838 unless ($pkg =~ /^main::.*::$/) {
3839 $pkg = "main$pkg" if $pkg =~ /^::/;
3840 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3841 $pkg .= '::' unless $pkg =~ /::$/;
3842 }
3843
3844 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3845 my $stem_symtab = *{$stem}{HASH};
3846
3847 defined $stem_symtab and exists $stem_symtab->{$leaf}
3848 or return;
3849
3850 # clear all symbols
3851 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3852 for my $name (keys %$leaf_symtab) {
3853 _gv_clear *{"$pkg$name"};
3854# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3855 }
3856}
3857
2454sub reload() { 3858sub do_reload_perl() {
2455 # can/must only be called in main 3859 # can/must only be called in main
2456 if ($Coro::current != $Coro::main) { 3860 if (in_main) {
2457 warn "can only reload from main coroutine"; 3861 error "can only reload from main coroutine";
2458 return; 3862 return;
2459 } 3863 }
2460 3864
3865 return if $RELOAD++;
3866
3867 my $t1 = AE::time;
3868
3869 while ($RELOAD) {
2461 warn "reloading..."; 3870 info "reloading...";
2462 3871
2463 warn "entering sync_job"; 3872 trace "entering sync_job";
2464 3873
2465 cf::sync_job { 3874 cf::sync_job {
2466 cf::write_runtime; # external watchdog should not bark
2467 cf::emergency_save; 3875 cf::emergency_save;
2468 cf::write_runtime; # external watchdog should not bark
2469 3876
2470 warn "syncing database to disk";
2471 BDB::db_env_txn_checkpoint $DB_ENV;
2472
2473 # if anything goes wrong in here, we should simply crash as we already saved
2474
2475 warn "cancelling all WF_AUTOCANCEL watchers";
2476 for (Event::all_watchers) {
2477 $_->cancel if $_->data & WF_AUTOCANCEL;
2478 }
2479
2480 warn "flushing outstanding aio requests";
2481 for (;;) {
2482 BDB::flush;
2483 IO::AIO::flush;
2484 Coro::cede;
2485 last unless IO::AIO::nreqs || BDB::nreqs;
2486 warn "iterate...";
2487 }
2488
2489 ++$RELOAD;
2490
2491 warn "cancelling all extension coros"; 3877 trace "cancelling all extension coros";
2492 $_->cancel for values %EXT_CORO; 3878 $_->cancel for values %EXT_CORO;
2493 %EXT_CORO = (); 3879 %EXT_CORO = ();
2494 3880
2495 warn "removing commands"; 3881 trace "removing commands";
2496 %COMMAND = (); 3882 %COMMAND = ();
2497 3883
2498 warn "removing ext commands"; 3884 trace "removing ext/exti commands";
2499 %EXTCMD = (); 3885 %EXTCMD = ();
3886 %EXTICMD = ();
2500 3887
2501 warn "unloading/nuking all extensions"; 3888 trace "unloading/nuking all extensions";
2502 for my $pkg (@EXTS) { 3889 for my $pkg (@EXTS) {
2503 warn "... unloading $pkg"; 3890 trace "... unloading $pkg";
2504 3891
2505 if (my $cb = $pkg->can ("unload")) { 3892 if (my $cb = $pkg->can ("unload")) {
2506 eval { 3893 eval {
2507 $cb->($pkg); 3894 $cb->($pkg);
2508 1 3895 1
2509 } or warn "$pkg unloaded, but with errors: $@"; 3896 } or error "$pkg unloaded, but with errors: $@";
3897 }
3898
3899 trace "... clearing $pkg";
3900 clear_package $pkg;
2510 } 3901 }
2511 3902
2512 warn "... nuking $pkg";
2513 Symbol::delete_package $pkg;
2514 }
2515
2516 warn "unloading all perl modules loaded from $LIBDIR"; 3903 trace "unloading all perl modules loaded from $LIBDIR";
2517 while (my ($k, $v) = each %INC) { 3904 while (my ($k, $v) = each %INC) {
2518 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3905 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2519 3906
2520 warn "... unloading $k"; 3907 trace "... unloading $k";
2521 delete $INC{$k}; 3908 delete $INC{$k};
2522 3909
2523 $k =~ s/\.pm$//; 3910 $k =~ s/\.pm$//;
2524 $k =~ s/\//::/g; 3911 $k =~ s/\//::/g;
2525 3912
2526 if (my $cb = $k->can ("unload_module")) { 3913 if (my $cb = $k->can ("unload_module")) {
2527 $cb->(); 3914 $cb->();
3915 }
3916
3917 clear_package $k;
2528 } 3918 }
2529 3919
2530 Symbol::delete_package $k;
2531 }
2532
2533 warn "getting rid of safe::, as good as possible"; 3920 trace "getting rid of safe::, as good as possible";
2534 Symbol::delete_package "safe::$_" 3921 clear_package "safe::$_"
2535 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3922 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2536 3923
2537 warn "unloading cf.pm \"a bit\""; 3924 trace "unloading cf.pm \"a bit\"";
2538 delete $INC{"cf.pm"}; 3925 delete $INC{"cf.pm"};
3926 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2539 3927
2540 # don't, removes xs symbols, too, 3928 # don't, removes xs symbols, too,
2541 # and global variables created in xs 3929 # and global variables created in xs
2542 #Symbol::delete_package __PACKAGE__; 3930 #clear_package __PACKAGE__;
2543 3931
2544 warn "unload completed, starting to reload now"; 3932 info "unload completed, starting to reload now";
2545 3933
2546 warn "reloading cf.pm"; 3934 trace "reloading cf.pm";
2547 require cf; 3935 require cf;
2548 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3936 cf::_connect_to_perl_1;
2549 3937
2550 warn "loading config and database again"; 3938 trace "loading config and database again";
2551 cf::cfg_load; 3939 cf::reload_config;
2552 3940
2553 warn "loading extensions"; 3941 trace "loading extensions";
2554 cf::load_extensions; 3942 cf::load_extensions;
2555 3943
3944 if ($REATTACH_ON_RELOAD) {
2556 warn "reattaching attachments to objects/players"; 3945 trace "reattaching attachments to objects/players";
2557 _global_reattach; # objects, sockets 3946 _global_reattach; # objects, sockets
2558 warn "reattaching attachments to maps"; 3947 trace "reattaching attachments to maps";
2559 reattach $_ for values %MAP; 3948 reattach $_ for values %MAP;
2560 warn "reattaching attachments to players"; 3949 trace "reattaching attachments to players";
2561 reattach $_ for values %PLAYER; 3950 reattach $_ for values %PLAYER;
3951 }
2562 3952
2563 warn "loading reloadable resources"; 3953 trace "running post_init jobs";
2564 reload_resources; 3954 (pop @POST_INIT)->(1) while @POST_INIT;
2565 3955
2566 warn "leaving sync_job"; 3956 trace "leaving sync_job";
2567 3957
2568 1 3958 1
2569 } or do { 3959 } or do {
2570 warn $@; 3960 error $@;
2571 warn "error while reloading, exiting."; 3961 cf::cleanup "error while reloading, exiting.";
2572 exit 1; 3962 };
3963
3964 info "reloaded";
3965 --$RELOAD;
3966 }
3967
3968 $t1 = AE::time - $t1;
3969 info "reload completed in ${t1}s\n";
3970};
3971
3972our $RELOAD_WATCHER; # used only during reload
3973
3974sub reload_perl() {
3975 # doing reload synchronously and two reloads happen back-to-back,
3976 # coro crashes during coro_state_free->destroy here.
3977
3978 $RELOAD_WATCHER ||= cf::async {
3979 Coro::AIO::aio_wait cache_extensions;
3980
3981 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
3982 do_reload_perl;
3983 undef $RELOAD_WATCHER;
3984 };
2573 }; 3985 };
2574 3986}
2575 warn "reloaded";
2576};
2577
2578our $RELOAD_WATCHER; # used only during reload
2579 3987
2580register_command "reload" => sub { 3988register_command "reload" => sub {
2581 my ($who, $arg) = @_; 3989 my ($who, $arg) = @_;
2582 3990
2583 if ($who->flag (FLAG_WIZ)) { 3991 if ($who->flag (FLAG_WIZ)) {
2584 $who->message ("reloading server."); 3992 $who->message ("reloading server.");
2585 3993 async {
2586 # doing reload synchronously and two reloads happen back-to-back, 3994 $Coro::current->{desc} = "perl_reload";
2587 # coro crashes during coro_state_free->destroy here.
2588
2589 $RELOAD_WATCHER ||= Event->timer (
2590 reentrant => 0,
2591 after => 0,
2592 data => WF_AUTOCANCEL,
2593 cb => sub {
2594 reload; 3995 reload_perl;
2595 undef $RELOAD_WATCHER;
2596 },
2597 ); 3996 };
2598 } 3997 }
2599}; 3998};
2600 3999
2601unshift @INC, $LIBDIR; 4000unshift @INC, $LIBDIR;
2602 4001
2603my $bug_warning = 0; 4002my $bug_warning = 0;
2604 4003
2605$TICK_WATCHER = Event->timer ( 4004our @WAIT_FOR_TICK;
2606 reentrant => 0, 4005our @WAIT_FOR_TICK_BEGIN;
2607 parked => 1, 4006
2608 prio => 0, 4007sub wait_for_tick {
2609 at => $NEXT_TICK || $TICK, 4008 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2610 data => WF_AUTOCANCEL, 4009
2611 cb => sub { 4010 my $signal = new Coro::Signal;
4011 push @WAIT_FOR_TICK, $signal;
4012 $signal->wait;
4013}
4014
4015sub wait_for_tick_begin {
4016 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4017
4018 my $signal = new Coro::Signal;
4019 push @WAIT_FOR_TICK_BEGIN, $signal;
4020 $signal->wait;
4021}
4022
4023sub tick {
2612 if ($Coro::current != $Coro::main) { 4024 if ($Coro::current != $Coro::main) {
2613 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 4025 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2614 unless ++$bug_warning > 10; 4026 unless ++$bug_warning > 10;
2615 return; 4027 return;
2616 } 4028 }
2617 4029
2618 $NOW = Event::time;
2619
2620 cf::server_tick; # one server iteration 4030 cf::server_tick; # one server iteration
2621 $RUNTIME += $TICK;
2622 $NEXT_TICK += $TICK;
2623 4031
4032 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
4033
2624 if ($NOW >= $NEXT_RUNTIME_WRITE) { 4034 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2625 $NEXT_RUNTIME_WRITE = $NOW + 10; 4035 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2626 Coro::async_pool { 4036 Coro::async_pool {
4037 $Coro::current->{desc} = "runtime saver";
2627 write_runtime 4038 write_runtime_sync
2628 or warn "ERROR: unable to write runtime file: $!"; 4039 or error "ERROR: unable to write runtime file: $!";
2629 };
2630 } 4040 };
2631
2632 $WAIT_FOR_TICK->broadcast;
2633 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2634
2635# my $AFTER = Event::time;
2636# warn $AFTER - $NOW;#d#
2637
2638 # if we are delayed by four ticks or more, skip them all
2639 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2640
2641 $TICK_WATCHER->at ($NEXT_TICK);
2642 $TICK_WATCHER->start;
2643 }, 4041 }
2644); 4042
4043 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4044 $sig->send;
4045 }
4046 while (my $sig = shift @WAIT_FOR_TICK) {
4047 $sig->send;
4048 }
4049
4050 $LOAD = ($NOW - $TICK_START) / $TICK;
4051 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4052
4053 if (0) {
4054 if ($NEXT_TICK) {
4055 my $jitter = $TICK_START - $NEXT_TICK;
4056 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4057 debug "jitter $JITTER\n";#d#
4058 }
4059 }
4060}
2645 4061
2646{ 4062{
2647 BDB::max_poll_time $TICK * 0.1; 4063 # configure BDB
2648 $BDB_POLL_WATCHER = Event->io ( 4064
2649 reentrant => 0,
2650 fd => BDB::poll_fileno,
2651 poll => 'r',
2652 prio => 0,
2653 data => WF_AUTOCANCEL,
2654 cb => \&BDB::poll_cb,
2655 );
2656 BDB::min_parallel 8; 4065 BDB::min_parallel 16;
2657 4066 BDB::max_poll_reqs $TICK * 0.1;
2658 BDB::set_sync_prepare { 4067 $AnyEvent::BDB::WATCHER->priority (1);
2659 my $status;
2660 my $current = $Coro::current;
2661 (
2662 sub {
2663 $status = $!;
2664 $current->ready; undef $current;
2665 },
2666 sub {
2667 Coro::schedule while defined $current;
2668 $! = $status;
2669 },
2670 )
2671 };
2672 4068
2673 unless ($DB_ENV) { 4069 unless ($DB_ENV) {
2674 $DB_ENV = BDB::db_env_create; 4070 $DB_ENV = BDB::db_env_create;
4071 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4072 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4073 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4074 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4075 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2675 4076
2676 cf::sync_job { 4077 cf::sync_job {
2677 eval { 4078 eval {
2678 BDB::db_env_open 4079 BDB::db_env_open
2679 $DB_ENV, 4080 $DB_ENV,
2680 $BDB_ENV_DIR, 4081 $BDBDIR,
2681 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 4082 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2682 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4083 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2683 0666; 4084 0666;
2684 4085
2685 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 4086 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2686
2687 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2688 $DB_ENV->set_lk_detect;
2689 }; 4087 };
2690 4088
2691 cf::cleanup "db_env_open(db): $@" if $@; 4089 cf::cleanup "db_env_open(db): $@" if $@;
2692 }; 4090 };
2693 } 4091 }
4092
4093 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4094 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4095 };
4096 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4097 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4098 };
4099 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4100 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4101 };
2694} 4102}
2695 4103
2696{ 4104{
4105 # configure IO::AIO
4106
2697 IO::AIO::min_parallel 8; 4107 IO::AIO::min_parallel 8;
2698
2699 undef $Coro::AIO::WATCHER;
2700 IO::AIO::max_poll_time $TICK * 0.1; 4108 IO::AIO::max_poll_time $TICK * 0.1;
2701 $AIO_POLL_WATCHER = Event->io ( 4109 undef $AnyEvent::AIO::WATCHER;
2702 reentrant => 0,
2703 data => WF_AUTOCANCEL,
2704 fd => IO::AIO::poll_fileno,
2705 poll => 'r',
2706 prio => 6,
2707 cb => \&IO::AIO::poll_cb,
2708 );
2709} 4110}
4111
4112my $_log_backtrace;
4113
4114sub _log_backtrace {
4115 my ($msg, @addr) = @_;
4116
4117 $msg =~ s/\n//;
4118
4119 # limit the # of concurrent backtraces
4120 if ($_log_backtrace < 2) {
4121 ++$_log_backtrace;
4122 my $perl_bt = Carp::longmess $msg;
4123 async {
4124 $Coro::current->{desc} = "abt $msg";
4125
4126 my @bt = fork_call {
4127 @addr = map { sprintf "%x", $_ } @addr;
4128 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4129 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4130 or die "addr2line: $!";
4131
4132 my @funcs;
4133 my @res = <$fh>;
4134 chomp for @res;
4135 while (@res) {
4136 my ($func, $line) = splice @res, 0, 2, ();
4137 push @funcs, "[$func] $line";
4138 }
4139
4140 @funcs
4141 };
4142
4143 LOG llevInfo, "[ABT] $perl_bt\n";
4144 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4145 LOG llevInfo, "[ABT] $_\n" for @bt;
4146 --$_log_backtrace;
4147 };
4148 } else {
4149 LOG llevInfo, "[ABT] $msg\n";
4150 LOG llevInfo, "[ABT] [suppressed]\n";
4151 }
4152}
4153
4154# load additional modules
4155require "cf/$_.pm" for @EXTRA_MODULES;
4156cf::_connect_to_perl_2;
2710 4157
2711END { cf::emergency_save } 4158END { cf::emergency_save }
2712 4159
27131 41601
2714 4161

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines