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.223 by root, Sun Mar 11 02:12:44 2007 UTC vs.
Revision 1.534 by root, Thu Apr 29 08:13:51 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines