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.222 by root, Tue Mar 6 03:06:00 2007 UTC vs.
Revision 1.541 by root, Tue May 4 23:33:16 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines