ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.235 by root, Tue Apr 10 09:35:23 2007 UTC vs.
Revision 1.548 by root, Mon May 10 21:40:22 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines