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.237 by root, Fri Apr 13 05:08:51 2007 UTC vs.
Revision 1.544 by root, Thu May 6 21:58:07 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines