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.224 by root, Mon Mar 12 21:42:12 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 IO::AIO 2.32 ();
27use YAML::Syck (); 57use YAML::XS ();
58use IO::AIO ();
28use Time::HiRes; 59use Time::HiRes;
29use Compress::LZF; 60use Compress::LZF;
61use Digest::MD5 ();
30 62
63AnyEvent::detect;
64
65# configure various modules to our taste
66#
67$Storable::canonical = 1; # reduce rsync transfers
31Coro::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";
32Compress::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
33$Event::Eval = 1; # no idea why this is required, but it is 75
76# strictly for debugging
77$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
34 78
35sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 79sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
36 80
37# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 81our @ORIG_INC;
38$YAML::Syck::ImplicitUnicode = 1;
39
40$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
41 82
42our %COMMAND = (); 83our %COMMAND = ();
43our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
44 85
45our @EXTS = (); # list of extension package names 86our @EXTS = (); # list of extension package names
46our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
47our %EXT_CORO = (); # coroutines bound to extensions 89our %EXT_CORO = (); # coroutines bound to extensions
48our %EXT_MAP = (); # pluggable maps 90our %EXT_MAP = (); # pluggable maps
49 91
50our $RELOAD; # number of reloads so far 92our $RELOAD; # number of reloads so far, non-zero while in reload
51our @EVENT; 93our @EVENT;
52our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
53 96
54our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
55our $TICK_WATCHER; 98our $DATADIR = datadir;
56our $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(!)
57our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
58our $NEXT_TICK; 121our $NEXT_TICK;
59our $NOW;
60our $USE_FSYNC = 1; # use fsync to write maps - default off 122our $USE_FSYNC = 1; # use fsync to write maps - default on
61 123
124our $BDB_DEADLOCK_WATCHER;
125our $BDB_CHECKPOINT_WATCHER;
62our $BDB_POLL_WATCHER; 126our $BDB_TRICKLE_WATCHER;
63our $DB_ENV; 127our $DB_ENV;
128
129our @EXTRA_MODULES = qw(pod match mapscript incloader);
64 130
65our %CFG; 131our %CFG;
66 132
67our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
68our $RUNTIME; 134our $RUNTIME;
135our $NOW;
69 136
70our %PLAYER; # all users 137our (%PLAYER, %PLAYER_LOADING); # all users
71our %MAP; # all maps 138our (%MAP, %MAP_LOADING ); # all maps
72our $LINK_MAP; # the special {link} map, which is always available 139our $LINK_MAP; # the special {link} map, which is always available
73our $RANDOM_MAPS = cf::localdir . "/random";
74our $BDB_ENV_DIR = cf::localdir . "/db";
75
76our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
77our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
78 140
79# 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 ∕
80our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
81 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
82binmode STDOUT; 154binmode STDOUT;
83binmode STDERR; 155binmode STDERR;
84 156
85# read virtual server time, if available 157# read virtual server time, if available
86unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
87 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
88 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
89 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
90} 162}
91 163
92mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
93mkdir cf::localdir . "/" . cf::playerdir; 165
94mkdir cf::localdir . "/" . cf::tmpdir; 166mkdir $_
95mkdir cf::localdir . "/" . cf::uniquedir; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
96mkdir $RANDOM_MAPS;
97mkdir $BDB_ENV_DIR;
98 168
99our $EMERGENCY_POSITION; 169our $EMERGENCY_POSITION;
100 170
101sub 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::"} };
102 187
103############################################################################# 188#############################################################################
104 189
105=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
106 191
113=item $cf::RUNTIME 198=item $cf::RUNTIME
114 199
115The 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
116every server tick. 201every server tick.
117 202
118=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
119 206
120The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
121be 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.
122 211
123=item $cf::NOW 212=item $cf::NOW
124 213
125The time of the last (current) server tick. 214The time of the last (current) server tick.
126 215
127=item $cf::TICK 216=item $cf::TICK
128 217
129The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
130 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
131=item %cf::CFG 230=item %cf::CFG
132 231
133Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
134from wherever your confdir points to. 233from wherever your confdir points to.
135 234
136=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 235=item cf::wait_for_tick, cf::wait_for_tick_begin
137 236
138These 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
139or 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
140processing 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.
141window 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.
142 257
143=back 258=back
144 259
145=cut 260=cut
146 261
147BEGIN { 262sub error(@) { LOG llevError, join "", @_ }
148 *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 {
149 my $msg = join "", @_; 269 my $msg = join "", @_;
150 utf8::encode $msg;
151 270
152 $msg .= "\n" 271 $msg .= "\n"
153 unless $msg =~ /\n$/; 272 unless $msg =~ /\n$/;
154 273
274 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
275
155 LOG llevError, $msg; 276 LOG llevWarn, $msg;
156 }; 277};
157} 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};
158 292
159@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 293@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
160@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 294@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
161@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 295@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
162@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 296@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
163@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';
164@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)
165 300
166# 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
167# within the Safe compartment. 302# within the Safe compartment.
168for my $pkg (qw( 303for my $pkg (qw(
169 cf::global cf::attachable 304 cf::global cf::attachable
170 cf::object cf::object::player 305 cf::object cf::object::player
171 cf::client cf::player 306 cf::client cf::player
172 cf::arch cf::living 307 cf::arch cf::living
308 cf::map cf::mapspace
173 cf::map cf::party cf::region 309 cf::party cf::region
174)) { 310)) {
175 no strict 'refs';
176 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 311 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
177} 312}
178 313
179$Event::DIED = sub { 314$EV::DIED = sub {
180 warn "error in event callback: @_"; 315 Carp::cluck "error in event callback: @_";
181}; 316};
317
318#############################################################################
182 319
183=head2 UTILITY FUNCTIONS 320=head2 UTILITY FUNCTIONS
184 321
185=over 4 322=over 4
186 323
205 $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;
206 $d 343 $d
207 } || "[unable to dump $_[0]: '$@']"; 344 } || "[unable to dump $_[0]: '$@']";
208} 345}
209 346
210use JSON::Syck (); # TODO# replace by JSON::PC once working
211
212=item $ref = cf::from_json $json 347=item $ref = cf::decode_json $json
213 348
214Converts a JSON string into the corresponding perl data structure. 349Converts a JSON string into the corresponding perl data structure.
215 350
216=cut
217
218sub from_json($) {
219 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
220 JSON::Syck::Load $_[0]
221}
222
223=item $json = cf::to_json $ref 351=item $json = cf::encode_json $ref
224 352
225Converts a perl data structure into its JSON representation. 353Converts a perl data structure into its JSON representation.
226 354
227=cut 355=cut
228 356
229sub to_json($) { 357our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
230 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 358
231 JSON::Syck::Dump $_[0] 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;
232} 386}
233 387
234=item cf::lock_wait $string 388=item cf::lock_wait $string
235 389
236Wait until the given lock is available. See cf::lock_acquire. 390Wait until the given lock is available. See cf::lock_acquire.
237 391
238=item my $lock = cf::lock_acquire $string 392=item my $lock = cf::lock_acquire $string
239 393
240Wait 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
241a 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,
242for example when the coroutine gets canceled), the lock is automatically 396for example when the coroutine gets canceled), the lock is automatically
243returned. 397returned.
244 398
399Locks are *not* recursive, locking from the same coro twice results in a
400deadlocked coro.
401
245Lock 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
246uses map_find and cf::map::load uses map_load). 403uses map_find and cf::map::load uses map_load).
247 404
248=cut 405=item $locked = cf::lock_active $string
249 406
250our %LOCK; 407Return true if the lock is currently active, i.e. somebody has locked it.
408
409=cut
410
411our $LOCKS = new Coro::SemaphoreSet;
251 412
252sub lock_wait($) { 413sub lock_wait($) {
253 my ($key) = @_; 414 $LOCKS->wait ($_[0]);
254
255 # wait for lock, if any
256 while ($LOCK{$key}) {
257 push @{ $LOCK{$key} }, $Coro::current;
258 Coro::schedule;
259 }
260} 415}
261 416
262sub lock_acquire($) { 417sub lock_acquire($) {
263 my ($key) = @_; 418 $LOCKS->guard ($_[0])
419}
264 420
265 # wait, to be sure we are not locked 421sub lock_active($) {
266 lock_wait $key; 422 $LOCKS->count ($_[0]) < 1
267
268 $LOCK{$key} = [];
269
270 Coro::guard {
271 # wake up all waiters, to be on the safe side
272 $_->ready for @{ delete $LOCK{$key} };
273 }
274} 423}
275 424
276sub freeze_mainloop { 425sub freeze_mainloop {
277 return unless $TICK_WATCHER->is_active; 426 tick_inhibit_inc;
278 427
279 my $guard = Coro::guard { 428 &Guard::guard (\&tick_inhibit_dec);
280 $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 }
281 }; 495 }
282 $TICK_WATCHER->stop; 496};
283 $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;
284} 511}
285 512
286=item cf::async { BLOCK } 513=item cf::async { BLOCK }
287 514
288Currently the same as Coro::async_pool, meaning you cannot use 515Currently the same as Coro::async_pool, meaning you cannot use
293 520
294BEGIN { *async = \&Coro::async_pool } 521BEGIN { *async = \&Coro::async_pool }
295 522
296=item cf::sync_job { BLOCK } 523=item cf::sync_job { BLOCK }
297 524
298The design of crossfire+ requires that the main coro ($Coro::main) is 525The design of Deliantra requires that the main coroutine ($Coro::main)
299always able to handle events or runnable, as crossfire+ is only partly 526is always able to handle events or runnable, as Deliantra is only
300reentrant. 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.
301 529
302If 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
303the given BLOCK in another coroutine while waiting for the result. The 531the given BLOCK in another coroutine while waiting for the result. The
304server 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
305fast or be very important. 533fast or be very important.
307=cut 535=cut
308 536
309sub sync_job(&) { 537sub sync_job(&) {
310 my ($job) = @_; 538 my ($job) = @_;
311 539
312 if ($Coro::current == $Coro::main) { 540 if (in_main) {
541 my $time = AE::time;
542
313 # this is the main coro, too bad, we have to block 543 # this is the main coro, too bad, we have to block
314 # till the operation succeeds, freezing the server :/ 544 # till the operation succeeds, freezing the server :/
315 545
316 # TODO: use suspend/resume instead 546 #LOG llevError, Carp::longmess "sync job";#d#
317 # (but this is cancel-safe) 547
318 my $freeze_guard = freeze_mainloop; 548 my $freeze_guard = freeze_mainloop;
319 549
320 my $busy = 1; 550 my $busy = 1;
321 my @res; 551 my @res;
322 552
323 (async { 553 (async {
554 $Coro::current->desc ("sync job coro");
324 @res = eval { $job->() }; 555 @res = eval { $job->() };
325 warn $@ if $@; 556 error $@ if $@;
326 undef $busy; 557 undef $busy;
327 })->prio (Coro::PRIO_MAX); 558 })->prio (Coro::PRIO_MAX);
328 559
329 while ($busy) { 560 while ($busy) {
330 Coro::cede or Event::one_event; 561 if (Coro::nready) {
562 Coro::cede_notself;
563 } else {
564 EV::loop EV::LOOP_ONESHOT;
331 } 565 }
566 }
567
568 my $time = AE::time - $time;
569
570 $TICK_START += $time; # do not account sync jobs to server load
332 571
333 wantarray ? @res : $res[0] 572 wantarray ? @res : $res[0]
334 } else { 573 } else {
335 # we are in another coroutine, how wonderful, everything just works 574 # we are in another coroutine, how wonderful, everything just works
336 575
356 $EXT_CORO{$coro+0} = $coro; 595 $EXT_CORO{$coro+0} = $coro;
357 596
358 $coro 597 $coro
359} 598}
360 599
361sub write_runtime { 600=item fork_call { }, @args
362 my $guard = cf::lock_acquire "write_runtime";
363 601
364 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.
365 606
366 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 607=cut
367 or return;
368 608
369 my $value = $cf::RUNTIME + 90 + 10; 609sub post_fork {
370 # 10 is the runtime save interval, for a monotonic clock 610 reset_signals;
371 # 60 allows for the watchdog to kill the server. 611}
372 612
373 (aio_write $fh, 0, (length $value), $value, 0) <= 0 613sub fork_call(&@) {
374 and return; 614 my ($cb, @args) = @_;
375 615
376 # always fsync - this file is important 616 # we seemingly have to make a local copy of the whole thing,
377 aio_fsync $fh 617 # otherwise perl prematurely frees the stuff :/
378 and return; 618 # TODO: investigate and fix (likely this will be rather laborious)
379 619
380 close $fh 620 my @res = Coro::Util::fork_eval {
381 or return; 621 cf::post_fork;
622 &$cb
623 } @args;
382 624
383 aio_rename "$runtime~", $runtime 625 wantarray ? @res : $res[-1]
384 and return; 626}
385 627
628sub objinfo {
386 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"
793}
794
795=item cf::datalog type => key => value, ...
796
797Log a datalog packet of the given type with the given key-value pairs.
798
799=cut
800
801sub datalog($@) {
802 my ($type, %kv) = @_;
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];
967 1550
968 (playerdir $login) . "/$login.pl" 1551 (playerdir $login) . "/playerdata"
969} 1552}
970 1553
971sub find_active($) { 1554sub find_active($) {
972 $cf::PLAYER{$_[0]} 1555 $cf::PLAYER{$_[0]}
973 and $cf::PLAYER{$_[0]}->active 1556 and $cf::PLAYER{$_[0]}->active
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];
987 1570
988 my $guard = cf::lock_acquire "user_find:$login"; 1571 my $guard = cf::lock_acquire "user_find:$login";
989 1572
990 $cf::PLAYER{$_[0]} || do { 1573 $cf::PLAYER{$_[0]} || do {
991 my $pl = load_pl path $login 1574 # rename old playerfiles to new ones
1575 #TODO: remove when no longer required
1576 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1577 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1578 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1579 aio_unlink +(playerdir $login) . "/$login.pl";
1580
1581 my $f = new_from_file cf::object::thawer path $login
992 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;
993 $cf::PLAYER{$login} = $pl 1589 $cf::PLAYER{$login} = $pl
994 } 1590 }
995 } 1591 }
996} 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);
997 1606
998sub save($) { 1607sub save($) {
999 my ($pl) = @_; 1608 my ($pl) = @_;
1000 1609
1001 return if $pl->{deny_save}; 1610 return if $pl->{deny_save};
1006 return if $pl->{deny_save}; 1615 return if $pl->{deny_save};
1007 1616
1008 aio_mkdir playerdir $pl, 0770; 1617 aio_mkdir playerdir $pl, 0770;
1009 $pl->{last_save} = $cf::RUNTIME; 1618 $pl->{last_save} = $cf::RUNTIME;
1010 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
1011 $pl->save_pl ($path); 1625 $pl->save_pl ($path);
1012 Coro::cede; 1626 cf::cede_to_tick;
1013} 1627}
1014 1628
1015sub new($) { 1629sub new($) {
1016 my ($login) = @_; 1630 my ($login) = @_;
1017 1631
1023 $cf::PLAYER{$login} = $self; 1637 $cf::PLAYER{$login} = $self;
1024 1638
1025 $self 1639 $self
1026} 1640}
1027 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
1028=item $pl->quit_character 1652=item $pl->quit_character
1029 1653
1030Nukes the player without looking back. If logged in, the connection will 1654Nukes the player without looking back. If logged in, the connection will
1031be destroyed. May block for a long time. 1655be destroyed. May block for a long time.
1032 1656
1036 my ($pl) = @_; 1660 my ($pl) = @_;
1037 1661
1038 my $name = $pl->ob->name; 1662 my $name = $pl->ob->name;
1039 1663
1040 $pl->{deny_save} = 1; 1664 $pl->{deny_save} = 1;
1041 $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
1042 1666
1043 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1667 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1044 $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
1045 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1673 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1046 $pl->ns->destroy if $pl->ns; 1674 $pl->ns->destroy if $pl->ns;
1047 1675
1048 my $path = playerdir $pl; 1676 my $path = playerdir $pl;
1049 my $temp = "$path~$cf::RUNTIME~deleting~"; 1677 my $temp = "$path~$cf::RUNTIME~deleting~";
1079while and may block, so not sync_job-capable, ever. 1707while and may block, so not sync_job-capable, ever.
1080 1708
1081=cut 1709=cut
1082 1710
1083sub list_logins { 1711sub list_logins {
1084 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1712 my $dirs = aio_readdir $PLAYERDIR
1085 or return []; 1713 or return [];
1086 1714
1087 my @logins; 1715 my @logins;
1088 1716
1089 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") {
1090 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1723 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1091 aio_read $fh, 0, 512, my $buf, 0 or next; 1724 aio_read $fh, 0, 512, my $buf, 0 or next;
1092 $buf !~ /^password -------------$/m or next; # official not-valid tag 1725 $buf !~ /^password -------------$/m or next; # official not-valid tag
1726 }
1093 1727
1094 utf8::decode $login; 1728 utf8::decode $login;
1095 push @logins, $login; 1729 push @logins, $login;
1096 } 1730 }
1097 1731
1098 \@logins 1732 \@logins
1099} 1733}
1100 1734
1101=item $player->maps 1735=item $player->maps
1736
1737=item cf::player::maps $login
1102 1738
1103Returns an arrayref of map paths that are private for this 1739Returns an arrayref of map paths that are private for this
1104player. May block. 1740player. May block.
1105 1741
1106=cut 1742=cut
1124 } 1760 }
1125 1761
1126 \@paths 1762 \@paths
1127} 1763}
1128 1764
1765=item $protocol_xml = $player->expand_cfpod ($cfpod)
1766
1767Expand deliantra pod fragments into protocol xml.
1768
1129=item $player->ext_reply ($msgid, $msgtype, %msg) 1769=item $player->ext_reply ($msgid, @msg)
1130 1770
1131Sends an ext reply to the player. 1771Sends an ext reply to the player.
1132 1772
1133=cut 1773=cut
1134 1774
1135sub ext_reply($$$%) { 1775sub ext_reply($$@) {
1136 my ($self, $id, %msg) = @_; 1776 my ($self, $id, @msg) = @_;
1137 1777
1138 $msg{msgid} = $id; 1778 $self->ns->ext_reply ($id, @msg)
1139
1140 $self->send ("ext " . cf::to_json \%msg);
1141} 1779}
1142 1780
1143package cf; 1781=item $player->ext_msg ($type, @msg)
1782
1783Sends an ext event to the client.
1784
1785=cut
1786
1787sub ext_msg($$@) {
1788 my ($self, $type, @msg) = @_;
1789
1790 $self->ns->ext_msg ($type, @msg);
1791}
1792
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}
1144 1823
1145=back 1824=back
1146
1147 1825
1148=head3 cf::map 1826=head3 cf::map
1149 1827
1150=over 4 1828=over 4
1151 1829
1163our $MAX_RESET = 3600; 1841our $MAX_RESET = 3600;
1164our $DEFAULT_RESET = 3000; 1842our $DEFAULT_RESET = 3000;
1165 1843
1166sub generate_random_map { 1844sub generate_random_map {
1167 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
1168 # mit "rum" bekleckern, nicht 1849 # mit "rum" bekleckern, nicht
1169 $self->_create_random_map ( 1850 $self->_create_random_map (
1170 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1851 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1171 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1852 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1172 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1853 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1173 $rmp->{exit_on_final_map}, 1854 $rmp->{exit_on_final_map},
1174 $rmp->{xsize}, $rmp->{ysize}, 1855 $rmp->{xsize}, $rmp->{ysize},
1175 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1856 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1176 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1857 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1191 1872
1192sub register { 1873sub register {
1193 my (undef, $regex, $prio) = @_; 1874 my (undef, $regex, $prio) = @_;
1194 my $pkg = caller; 1875 my $pkg = caller;
1195 1876
1196 no strict;
1197 push @{"$pkg\::ISA"}, __PACKAGE__; 1877 push @{"$pkg\::ISA"}, __PACKAGE__;
1198 1878
1199 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1879 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1200} 1880}
1201 1881
1202# also paths starting with '/' 1882# also paths starting with '/'
1203$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1883$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1204 1884
1205sub thawer_merge { 1885sub thawer_merge {
1206 my ($self, $merge) = @_; 1886 my ($self, $merge) = @_;
1207 1887
1208 # we have to keep some variables in memory intact 1888 # we have to keep some variables in memory intact
1209 local $self->{path}; 1889 local $self->{path};
1210 local $self->{load_path}; 1890 local $self->{load_path};
1211 local $self->{deny_save};
1212 local $self->{deny_reset};
1213 1891
1214 $self->SUPER::thawer_merge ($merge); 1892 $self->SUPER::thawer_merge ($merge);
1215} 1893}
1216 1894
1217sub normalise { 1895sub normalise {
1218 my ($path, $base) = @_; 1896 my ($path, $base) = @_;
1219 1897
1220 $path = "$path"; # make sure its a string 1898 $path = "$path"; # make sure it's a string
1221 1899
1222 $path =~ s/\.map$//; 1900 $path =~ s/\.map$//;
1223 1901
1224 # map plan: 1902 # map plan:
1225 # 1903 #
1264 $self->init; # pass $1 etc. 1942 $self->init; # pass $1 etc.
1265 return $self; 1943 return $self;
1266 } 1944 }
1267 } 1945 }
1268 1946
1269 Carp::carp "unable to resolve path '$path' (base '$base')."; 1947 Carp::cluck "unable to resolve path '$path' (base '$base')";
1270 () 1948 ()
1271} 1949}
1272 1950
1273sub init { 1951sub init {
1274 my ($self) = @_; 1952 my ($self) = @_;
1289 1967
1290# the original (read-only) location 1968# the original (read-only) location
1291sub load_path { 1969sub load_path {
1292 my ($self) = @_; 1970 my ($self) = @_;
1293 1971
1294 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1972 "$MAPDIR/$self->{path}.map"
1295} 1973}
1296 1974
1297# the temporary/swap location 1975# the temporary/swap location
1298sub save_path { 1976sub save_path {
1299 my ($self) = @_; 1977 my ($self) = @_;
1300 1978
1301 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1979 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1302 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1980 "$TMPDIR/$path.map"
1303} 1981}
1304 1982
1305# the unique path, undef == no special unique path 1983# the unique path, undef == no special unique path
1306sub uniq_path { 1984sub uniq_path {
1307 my ($self) = @_; 1985 my ($self) = @_;
1308 1986
1309 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1987 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1310 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1988 "$UNIQUEDIR/$path"
1311} 1989}
1312 1990
1313# and all this just because we cannot iterate over 1991sub decay_objects {
1314# all maps in C++...
1315sub change_all_map_light {
1316 my ($change) = @_; 1992 my ($self) = @_;
1317 1993
1318 $_->change_map_light ($change) 1994 return if $self->{deny_reset};
1319 for grep $_->outdoor, values %cf::MAP; 1995
1996 $self->do_decay_objects;
1320} 1997}
1321 1998
1322sub unlink_save { 1999sub unlink_save {
1323 my ($self) = @_; 2000 my ($self) = @_;
1324 2001
1329 2006
1330sub load_header_from($) { 2007sub load_header_from($) {
1331 my ($self, $path) = @_; 2008 my ($self, $path) = @_;
1332 2009
1333 utf8::encode $path; 2010 utf8::encode $path;
1334 #aio_open $path, O_RDONLY, 0 2011 my $f = new_from_file cf::object::thawer $path
1335 # or return;
1336
1337 $self->_load_header ($path)
1338 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;
1339 2019
1340 $self->{load_path} = $path; 2020 $self->{load_path} = $path;
1341 2021
1342 1 2022 1
1343} 2023}
1382 $self->load_header_orig 2062 $self->load_header_orig
1383 or return; 2063 or return;
1384 $self->prepare_orig; 2064 $self->prepare_orig;
1385 } 2065 }
1386 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
1387 1 2073 1
1388} 2074}
1389 2075
1390sub find; 2076sub find;
1391sub find { 2077sub find {
1392 my ($path, $origin) = @_; 2078 my ($path, $origin) = @_;
1393 2079
2080 cf::cede_to_tick;
2081
1394 $path = normalise $path, $origin && $origin->path; 2082 $path = normalise $path, $origin && $origin->path;
1395 2083
2084 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1396 cf::lock_wait "map_find:$path"; 2085 my $guard2 = cf::lock_acquire "map_find:$path";
1397 2086
1398 $cf::MAP{$path} || do { 2087 $cf::MAP{$path} || do {
1399 my $guard = cf::lock_acquire "map_find:$path";
1400 my $map = new_from_path cf::map $path 2088 my $map = new_from_path cf::map $path
1401 or return; 2089 or return;
1402 2090
1403 $map->{last_save} = $cf::RUNTIME; 2091 $map->{last_save} = $cf::RUNTIME;
1404 2092
1405 $map->load_header 2093 $map->load_header
1406 or return; 2094 or return;
1407 2095
1408 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2096 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1409 # doing this can freeze the server in a sync job, obviously 2097 # doing this can freeze the server in a sync job, obviously
1410 #$cf::WAIT_FOR_TICK->wait; 2098 #$cf::WAIT_FOR_TICK->wait;
2099 undef $guard2;
2100 undef $guard1;
1411 $map->reset; 2101 $map->reset;
1412 undef $guard;
1413 return find $path; 2102 return find $path;
1414 } 2103 }
1415 2104
1416 $cf::MAP{$path} = $map 2105 $cf::MAP{$path} = $map
1417 } 2106 }
1418} 2107}
1419 2108
1420sub pre_load { } 2109sub pre_load { }
1421sub post_load { } 2110#sub post_load { } # XS
1422 2111
1423sub load { 2112sub load {
1424 my ($self) = @_; 2113 my ($self) = @_;
1425 2114
1426 local $self->{deny_reset} = 1; # loading can take a long time 2115 local $self->{deny_reset} = 1; # loading can take a long time
1427 2116
1428 my $path = $self->{path}; 2117 my $path = $self->{path};
2118
2119 {
1429 my $guard = cf::lock_acquire "map_load:$path"; 2120 my $guard = cf::lock_acquire "map_data:$path";
1430 2121
2122 return unless $self->valid;
1431 return if $self->in_memory != cf::MAP_SWAPPED; 2123 return unless $self->in_memory == cf::MAP_SWAPPED;
1432 2124
1433 $self->in_memory (cf::MAP_LOADING); 2125 $self->in_memory (cf::MAP_LOADING);
1434 2126
1435 $self->alloc; 2127 $self->alloc;
1436 2128
1437 $self->pre_load; 2129 $self->pre_load;
2130 cf::cede_to_tick;
1438 2131
1439 $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)
1440 or return; 2135 or return;
1441 2136
1442 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2137 $self->post_load_original
1443 if delete $self->{load_original}; 2138 if delete $self->{load_original};
1444 2139
1445 if (my $uniq = $self->uniq_path) { 2140 if (my $uniq = $self->uniq_path) {
1446 utf8::encode $uniq; 2141 utf8::encode $uniq;
1447 if (aio_open $uniq, O_RDONLY, 0) { 2142 unless (aio_stat $uniq) {
2143 if (my $f = new_from_file cf::object::thawer $uniq) {
1448 $self->clear_unique_items; 2144 $self->clear_unique_items;
1449 $self->_load_objects ($uniq, 0); 2145 $self->_load_objects ($f);
2146 $f->resolve_delayed_derefs;
2147 }
1450 } 2148 }
1451 } 2149 }
1452 2150
1453 Coro::cede; 2151 $f->resolve_delayed_derefs;
1454 2152
2153 cf::cede_to_tick;
1455 # now do the right thing for maps 2154 # now do the right thing for maps
1456 $self->link_multipart_objects; 2155 $self->link_multipart_objects;
1457
1458 unless ($self->{deny_activate}) {
1459 $self->decay_objects;
1460 $self->fix_auto_apply;
1461 $self->update_buttons;
1462 Coro::cede;
1463 $self->set_darkness_map;
1464 $self->difficulty ($self->estimate_difficulty) 2156 $self->difficulty ($self->estimate_difficulty)
1465 unless $self->difficulty; 2157 unless $self->difficulty;
1466 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;
1467 $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);
1468 } 2172 }
1469 2173
1470 $self->post_load; 2174 $self->post_load;
1471
1472 $self->in_memory (cf::MAP_IN_MEMORY);
1473} 2175}
1474 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
1475sub customise_for { 2180sub customise_for {
1476 my ($self, $ob) = @_; 2181 my ($self, $ob) = @_;
1477 2182
1478 return find "~" . $ob->name . "/" . $self->{path} 2183 return find "~" . $ob->name . "/" . $self->{path}
1479 if $self->per_player; 2184 if $self->per_player;
1480 2185
2186# return find "?party/" . $ob->name . "/" . $self->{path}
2187# if $self->per_party;
2188
1481 $self 2189 $self
1482} 2190}
1483 2191
1484# 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
1485sub load_diag { 2193sub load_neighbours {
1486 my ($map) = @_; 2194 my ($map) = @_;
1487 2195
1488 my @diag; # diagonal neighbours 2196 my @neigh; # diagonal neighbours
1489 2197
1490 for (0 .. 3) { 2198 for (0 .. 3) {
1491 my $neigh = $map->tile_path ($_) 2199 my $neigh = $map->tile_path ($_)
1492 or next; 2200 or next;
1493 $neigh = find $neigh, $map 2201 $neigh = find $neigh, $map
1494 or next; 2202 or next;
1495 $neigh->load; 2203 $neigh->load;
1496 2204
2205 # now find the diagonal neighbours
2206 push @neigh,
1497 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2207 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1498 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2208 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1499 } 2209 }
1500 2210
1501 for (@diag) { 2211 for (grep defined $_->[0], @neigh) {
2212 my ($path, $origin) = @$_;
1502 my $neigh = find @$_ 2213 my $neigh = find $path, $origin
1503 or next; 2214 or next;
1504 $neigh->load; 2215 $neigh->load;
1505 } 2216 }
1506} 2217}
1507 2218
1508sub find_sync { 2219sub find_sync {
1509 my ($path, $origin) = @_; 2220 my ($path, $origin) = @_;
1510 2221
1511 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
1512} 2226}
1513 2227
1514sub do_load_sync { 2228sub do_load_sync {
1515 my ($map) = @_; 2229 my ($map) = @_;
1516 2230
1517 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;
1518} 2235}
1519 2236
1520our %MAP_PREFETCH; 2237our %MAP_PREFETCH;
1521our $MAP_PREFETCHER = undef; 2238our $MAP_PREFETCHER = undef;
1522 2239
1523sub find_async { 2240sub find_async {
1524 my ($path, $origin) = @_; 2241 my ($path, $origin, $load) = @_;
1525 2242
1526 $path = normalise $path, $origin && $origin->{path}; 2243 $path = normalise $path, $origin && $origin->{path};
1527 2244
1528 if (my $map = $cf::MAP{$path}) { 2245 if (my $map = $cf::MAP{$path}) {
1529 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2246 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1530 } 2247 }
1531 2248
1532 undef $MAP_PREFETCH{$path}; 2249 $MAP_PREFETCH{$path} |= $load;
2250
1533 $MAP_PREFETCHER ||= cf::async { 2251 $MAP_PREFETCHER ||= cf::async {
2252 $Coro::current->{desc} = "map prefetcher";
2253
1534 while (%MAP_PREFETCH) { 2254 while (%MAP_PREFETCH) {
1535 for my $path (keys %MAP_PREFETCH) { 2255 while (my ($k, $v) = each %MAP_PREFETCH) {
1536 my $map = find $path 2256 if (my $map = find $k) {
1537 or next;
1538 $map->load; 2257 $map->load if $v;
2258 }
1539 2259
1540 delete $MAP_PREFETCH{$path}; 2260 delete $MAP_PREFETCH{$k};
1541 } 2261 }
1542 } 2262 }
1543 undef $MAP_PREFETCHER; 2263 undef $MAP_PREFETCHER;
1544 }; 2264 };
1545 $MAP_PREFETCHER->prio (6); 2265 $MAP_PREFETCHER->prio (6);
1546 2266
1547 () 2267 ()
1548} 2268}
1549 2269
2270# common code, used by both ->save and ->swapout
1550sub save { 2271sub _save {
1551 my ($self) = @_; 2272 my ($self) = @_;
1552
1553 my $lock = cf::lock_acquire "map_data:" . $self->path;
1554 2273
1555 $self->{last_save} = $cf::RUNTIME; 2274 $self->{last_save} = $cf::RUNTIME;
1556 2275
1557 return unless $self->dirty; 2276 return unless $self->dirty;
1558 2277
1564 return if $self->{deny_save}; 2283 return if $self->{deny_save};
1565 2284
1566 local $self->{last_access} = $self->last_access;#d# 2285 local $self->{last_access} = $self->last_access;#d#
1567 2286
1568 cf::async { 2287 cf::async {
2288 $Coro::current->{desc} = "map player save";
1569 $_->contr->save for $self->players; 2289 $_->contr->save for $self->players;
1570 }; 2290 };
2291
2292 cf::get_slot 0.02;
1571 2293
1572 if ($uniq) { 2294 if ($uniq) {
1573 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2295 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1574 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2296 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1575 } else { 2297 } else {
1576 $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);
1577 } 2299 }
1578} 2300}
1579 2301
2302sub save {
2303 my ($self) = @_;
2304
2305 my $lock = cf::lock_acquire "map_data:$self->{path}";
2306
2307 $self->_save;
2308}
2309
1580sub swap_out { 2310sub swap_out {
1581 my ($self) = @_; 2311 my ($self) = @_;
1582 2312
1583 # save first because save cedes
1584 $self->save;
1585
1586 my $lock = cf::lock_acquire "map_data:" . $self->path; 2313 my $lock = cf::lock_acquire "map_data:$self->{path}";
1587 2314
2315 return if $self->in_memory != cf::MAP_ACTIVE;
2316 return if $self->{deny_save};
1588 return if $self->players; 2317 return if $self->players;
1589 return if $self->in_memory != cf::MAP_IN_MEMORY;
1590 return if $self->{deny_save};
1591 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
1592 $self->clear; 2328 $self->clear;
1593 $self->in_memory (cf::MAP_SWAPPED);
1594} 2329}
1595 2330
1596sub reset_at { 2331sub reset_at {
1597 my ($self) = @_; 2332 my ($self) = @_;
1598 2333
1599 # TODO: safety, remove and allow resettable per-player maps 2334 # TODO: safety, remove and allow resettable per-player maps
1600 return 1e99 if $self->isa ("ext::map_per_player");#d#
1601 return 1e99 if $self->{deny_reset}; 2335 return 1e99 if $self->{deny_reset};
1602 2336
1603 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2337 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1604 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;
1605 2339
1616 my ($self) = @_; 2350 my ($self) = @_;
1617 2351
1618 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2352 my $lock = cf::lock_acquire "map_data:$self->{path}";
1619 2353
1620 return if $self->players; 2354 return if $self->players;
1621 return if $self->isa ("ext::map_per_player");#d#
1622 2355
1623 warn "resetting map ", $self->path;#d# 2356 cf::trace "resetting map ", $self->path, "\n";
1624 2357
1625 $self->in_memory (cf::MAP_SWAPPED); 2358 $self->in_memory (cf::MAP_SWAPPED);
1626 2359
1627 # need to save uniques path 2360 # need to save uniques path
1628 unless ($self->{deny_save}) { 2361 unless ($self->{deny_save}) {
1632 if $uniq; 2365 if $uniq;
1633 } 2366 }
1634 2367
1635 delete $cf::MAP{$self->path}; 2368 delete $cf::MAP{$self->path};
1636 2369
2370 $self->deactivate;
2371 $_->clear_links_to ($self) for values %cf::MAP;
1637 $self->clear; 2372 $self->clear;
1638
1639 $_->clear_links_to ($self) for values %cf::MAP;
1640 2373
1641 $self->unlink_save; 2374 $self->unlink_save;
1642 $self->destroy; 2375 $self->destroy;
1643} 2376}
1644 2377
1645my $nuke_counter = "aaaa"; 2378my $nuke_counter = "aaaa";
1646 2379
1647sub nuke { 2380sub nuke {
1648 my ($self) = @_; 2381 my ($self) = @_;
1649 2382
2383 {
2384 my $lock = cf::lock_acquire "map_data:$self->{path}";
2385
1650 delete $cf::MAP{$self->path}; 2386 delete $cf::MAP{$self->path};
1651 2387
1652 $self->unlink_save; 2388 $self->unlink_save;
1653 2389
1654 bless $self, "cf::map"; 2390 bless $self, "cf::map::wrap";
1655 delete $self->{deny_reset}; 2391 delete $self->{deny_reset};
1656 $self->{deny_save} = 1; 2392 $self->{deny_save} = 1;
1657 $self->reset_timeout (1); 2393 $self->reset_timeout (1);
1658 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2394 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1659 2395
1660 $cf::MAP{$self->path} = $self; 2396 $cf::MAP{$self->path} = $self;
2397 }
1661 2398
1662 $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 ]
1663} 2436}
1664 2437
1665=item cf::map::unique_maps 2438=item cf::map::unique_maps
1666 2439
1667Returns an arrayref of paths of all shared maps that have 2440Returns an arrayref of paths of all shared maps that have
1668instantiated unique items. May block. 2441instantiated unique items. May block.
1669 2442
1670=cut 2443=cut
1671 2444
1672sub unique_maps() { 2445sub unique_maps() {
1673 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2446 [
1674 or return; 2447 map {
1675
1676 my @paths;
1677
1678 for (@$files) {
1679 utf8::decode $_; 2448 utf8::decode $_;
1680 next if /\.pst$/; 2449 s/\.map$//; # TODO future compatibility hack
1681 next unless /^$PATH_SEP/o; 2450 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1682 2451 ? ()
1683 push @paths, cf::map::normalise $_; 2452 : normalise $_
2453 } @{ aio_readdir $UNIQUEDIR or [] }
1684 } 2454 ]
1685
1686 \@paths
1687} 2455}
1688 2456
1689package 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}
1690 2488
1691=back 2489=back
1692 2490
1693=head3 cf::object 2491=head3 cf::object
1694 2492
1698 2496
1699=over 4 2497=over 4
1700 2498
1701=item $ob->inv_recursive 2499=item $ob->inv_recursive
1702 2500
1703Returns 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.
1704 2503
1705=cut 2504=cut
1706 2505
1707sub inv_recursive_; 2506sub inv_recursive_;
1708sub inv_recursive_ { 2507sub inv_recursive_ {
1711 2510
1712sub inv_recursive { 2511sub inv_recursive {
1713 inv_recursive_ inv $_[0] 2512 inv_recursive_ inv $_[0]
1714} 2513}
1715 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
1716package cf; 2543package cf;
1717 2544
1718=back 2545=back
1719 2546
1720=head3 cf::object::player 2547=head3 cf::object::player
1726Sends 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>
1727can 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
1728dialogue with the given NPC character. 2555dialogue with the given NPC character.
1729 2556
1730=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};
1731 2572
1732# rough implementation of a future "reply" method that works 2573# rough implementation of a future "reply" method that works
1733# with dialog boxes. 2574# with dialog boxes.
1734#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
1735sub cf::object::player::reply($$$;$) { 2576sub cf::object::player::reply($$$;$) {
1737 2578
1738 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2579 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1739 2580
1740 if ($self->{record_replies}) { 2581 if ($self->{record_replies}) {
1741 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2582 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2583
1742 } 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 {
1743 $msg = $npc->name . " says: $msg" if $npc; 2592 $msg = $npc->name . " says: $msg" if $npc;
1744 $self->message ($msg, $flags); 2593 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2594 }
1745 } 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 (@_);
1746} 2606}
1747 2607
1748=item $player_object->may ("access") 2608=item $player_object->may ("access")
1749 2609
1750Returns wether the given player is authorized to access resource "access" 2610Returns wether the given player is authorized to access resource "access"
1763 2623
1764=item $player_object->enter_link 2624=item $player_object->enter_link
1765 2625
1766Freezes 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}>).
1767 2627
1768The 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.
1769I<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.
1770 2632
1771Will never block. 2633Will never block.
1772 2634
1773=item $player_object->leave_link ($map, $x, $y) 2635=item $player_object->leave_link ($map, $x, $y)
1774 2636
1794sub cf::object::player::enter_link { 2656sub cf::object::player::enter_link {
1795 my ($self) = @_; 2657 my ($self) = @_;
1796 2658
1797 $self->deactivate_recursive; 2659 $self->deactivate_recursive;
1798 2660
2661 ++$self->{_link_recursion};
2662
1799 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2663 return if UNIVERSAL::isa $self->map, "ext::map_link";
1800 2664
1801 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2665 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1802 if $self->map; 2666 if $self->map && $self->map->{path} ne "{link}";
1803 2667
1804 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2668 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1805} 2669}
1806 2670
1807sub cf::object::player::leave_link { 2671sub cf::object::player::leave_link {
1808 my ($self, $map, $x, $y) = @_; 2672 my ($self, $map, $x, $y) = @_;
2673
2674 return unless $self->contr->active;
1809 2675
1810 my $link_pos = delete $self->{_link_pos}; 2676 my $link_pos = delete $self->{_link_pos};
1811 2677
1812 unless ($map) { 2678 unless ($map) {
1813 # restore original map position 2679 # restore original map position
1824 ($x, $y) = (-1, -1) 2690 ($x, $y) = (-1, -1)
1825 unless (defined $x) && (defined $y); 2691 unless (defined $x) && (defined $y);
1826 2692
1827 # use -1 or undef as default coordinates, not 0, 0 2693 # use -1 or undef as default coordinates, not 0, 0
1828 ($x, $y) = ($map->enter_x, $map->enter_y) 2694 ($x, $y) = ($map->enter_x, $map->enter_y)
1829 if $x <=0 && $y <= 0; 2695 if $x <= 0 && $y <= 0;
1830 2696
1831 $map->load; 2697 $map->load;
1832 $map->load_diag; 2698 $map->load_neighbours;
1833 2699
1834 return unless $self->contr->active; 2700 return unless $self->contr->active;
1835 $self->activate_recursive;
1836 2701
1837 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2702 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1838 $self->enter_map ($map, $x, $y); 2703 if ($self->enter_map ($map, $x, $y)) {
1839} 2704 # entering was successful
1840 2705 delete $self->{_link_recursion};
1841cf::player->attach ( 2706 # only activate afterwards, to support waiting in hooks
1842 on_logout => sub { 2707 $self->activate_recursive;
1843 my ($pl) = @_;
1844
1845 # abort map switching before logout
1846 if ($pl->ob->{_link_pos}) {
1847 cf::sync_job {
1848 $pl->ob->leave_link
1849 };
1850 }
1851 }, 2708 }
1852 on_login => sub {
1853 my ($pl) = @_;
1854 2709
1855 # try to abort aborted map switching on player login :) 2710}
1856 # should happen only on crashes
1857 if ($pl->ob->{_link_pos}) {
1858 $pl->ob->enter_link;
1859 (async {
1860 $pl->ob->reply (undef,
1861 "There was an internal problem at your last logout, "
1862 . "the server will try to bring you to your intended destination in a second.",
1863 cf::NDI_RED);
1864 # we need this sleep as the login has a concurrent enter_exit running
1865 # and this sleep increases chances of the player not ending up in scorn
1866 Coro::Timer::sleep 1;
1867 $pl->ob->leave_link;
1868 })->prio (2);
1869 }
1870 },
1871);
1872 2711
1873=item $player_object->goto ($path, $x, $y) 2712=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1874 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
1875=cut 2723=cut
2724
2725our $GOTOGEN;
1876 2726
1877sub cf::object::player::goto { 2727sub cf::object::player::goto {
1878 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;
1879 2738
1880 $self->enter_link; 2739 $self->enter_link;
1881 2740
1882 (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
1883 my $map = eval { 2763 my $map = eval {
1884 my $map = cf::map::find $path; 2764 my $map = defined $path ? cf::map::find $path : undef;
2765
2766 if ($map) {
1885 $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
1886 $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 $@;
1887 } or 2779 }
1888 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1889 2780
2781 if ($gen == $self->{_goto_generation}) {
2782 delete $self->{_goto_generation};
1890 $self->leave_link ($map, $x, $y); 2783 $self->leave_link ($map, $x, $y);
2784 }
2785
2786 $done->($self) if $done;
1891 })->prio (1); 2787 })->prio (1);
1892} 2788}
1893 2789
1894=item $player_object->enter_exit ($exit_object) 2790=item $player_object->enter_exit ($exit_object)
1895 2791
1915} 2811}
1916 2812
1917sub prepare_random_map { 2813sub prepare_random_map {
1918 my ($exit) = @_; 2814 my ($exit) = @_;
1919 2815
1920 my $guard = cf::lock_acquire "exit_prepare:$exit";
1921
1922 # all this does is basically replace the /! path by 2816 # all this does is basically replace the /! path by
1923 # a new random map path (?random/...) with a seed 2817 # a new random map path (?random/...) with a seed
1924 # that depends on the exit object 2818 # that depends on the exit object
1925 2819
1926 my $rmp = parse_random_map_params $exit->msg; 2820 my $rmp = parse_random_map_params $exit->msg;
1928 if ($exit->map) { 2822 if ($exit->map) {
1929 $rmp->{region} = $exit->region->name; 2823 $rmp->{region} = $exit->region->name;
1930 $rmp->{origin_map} = $exit->map->path; 2824 $rmp->{origin_map} = $exit->map->path;
1931 $rmp->{origin_x} = $exit->x; 2825 $rmp->{origin_x} = $exit->x;
1932 $rmp->{origin_y} = $exit->y; 2826 $rmp->{origin_y} = $exit->y;
2827
2828 $exit->map->touch;
1933 } 2829 }
1934 2830
1935 $rmp->{random_seed} ||= $exit->random_seed; 2831 $rmp->{random_seed} ||= $exit->random_seed;
1936 2832
1937 my $data = cf::to_json $rmp; 2833 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1938 my $md5 = Digest::MD5::md5_hex $data; 2834 my $md5 = Digest::MD5::md5_hex $data;
1939 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2835 my $meta = "$RANDOMDIR/$md5.meta";
1940 2836
1941 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2837 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1942 aio_write $fh, 0, (length $data), $data, 0; 2838 aio_write $fh, 0, (length $data), $data, 0;
1943 undef $fh; 2839 undef $fh;
1944 aio_rename "$meta~", $meta; 2840 aio_rename "$meta~", $meta;
1945 2841
2842 my $slaying = "?random/$md5";
2843
2844 if ($exit->valid) {
1946 $exit->slaying ("?random/$md5"); 2845 $exit->slaying ("?random/$md5");
1947 $exit->msg (undef); 2846 $exit->msg (undef);
2847 }
1948 } 2848 }
1949} 2849}
1950 2850
1951sub cf::object::player::enter_exit { 2851sub cf::object::player::enter_exit {
1952 my ($self, $exit) = @_; 2852 my ($self, $exit) = @_;
1953 2853
1954 return unless $self->type == cf::PLAYER; 2854 return unless $self->type == cf::PLAYER;
1955 2855
1956 if ($exit->slaying eq "/!") {
1957 #TODO: this should de-fi-ni-te-ly not be a sync-job
1958 cf::sync_job { prepare_random_map $exit };
1959 }
1960
1961 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1962 my $hp = $exit->stats->hp;
1963 my $sp = $exit->stats->sp;
1964
1965 $self->enter_link; 2856 $self->enter_link;
1966 2857
1967 (async { 2858 (async {
1968 $self->deactivate_recursive; # just to be sure 2859 $Coro::current->{desc} = "enter_exit";
2860
1969 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
1970 $self->goto ($slaying, $hp, $sp); 2876 $self->goto ($map, $x, $y);
1971 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
1972 1; 2882 1
1973 }) { 2883 }) {
1974 $self->message ("Something went wrong deep within the crossfire server. " 2884 $self->message ("Something went wrong deep within the deliantra server. "
1975 . "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. "
1976 . "Please report this to the dungeon master!", 2886 . "Please report this to the dungeon master!",
1977 cf::NDI_UNIQUE | cf::NDI_RED); 2887 cf::NDI_UNIQUE | cf::NDI_RED);
1978 2888
1979 warn "ERROR in enter_exit: $@"; 2889 error "ERROR in enter_exit: $@";
1980 $self->leave_link; 2890 $self->leave_link;
1981 } 2891 }
1982 })->prio (1); 2892 })->prio (1);
1983} 2893}
1984 2894
1995 2905
1996sub cf::client::send_drawinfo { 2906sub cf::client::send_drawinfo {
1997 my ($self, $text, $flags) = @_; 2907 my ($self, $text, $flags) = @_;
1998 2908
1999 utf8::encode $text; 2909 utf8::encode $text;
2000 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2910 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2001} 2911}
2002 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
3100=item $client->ext_msg ($type, @msg)
3101
3102Sends an ext event to the client.
3103
3104=cut
3105
3106sub cf::client::ext_msg($$@) {
3107 my ($self, $type, @msg) = @_;
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
3112 push @msg, msgtype => "event_$type";
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 }
3133}
2003 3134
2004=item $success = $client->query ($flags, "text", \&cb) 3135=item $success = $client->query ($flags, "text", \&cb)
2005 3136
2006Queues a query to the client, calling the given callback with 3137Queues a query to the client, calling the given callback with
2007the 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>,
2008C<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>.
2009 3140
2010Queries 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
2011reliable at some point in the future. 3142become reliable at some point in the future.
2012 3143
2013=cut 3144=cut
2014 3145
2015sub cf::client::query { 3146sub cf::client::query {
2016 my ($self, $flags, $text, $cb) = @_; 3147 my ($self, $flags, $text, $cb) = @_;
2024 utf8::encode $text; 3155 utf8::encode $text;
2025 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3156 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2026 3157
2027 $self->send_packet ($self->{query_queue}[0][0]) 3158 $self->send_packet ($self->{query_queue}[0][0])
2028 if @{ $self->{query_queue} } == 1; 3159 if @{ $self->{query_queue} } == 1;
3160
3161 1
2029} 3162}
2030 3163
2031cf::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 },
2032 on_reply => sub { 3170 on_reply => sub {
2033 my ($ns, $msg) = @_; 3171 my ($ns, $msg) = @_;
2034 3172
2035 # this weird shuffling is so that direct followup queries 3173 # this weird shuffling is so that direct followup queries
2036 # get handled first 3174 # get handled first
2048 } else { 3186 } else {
2049 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3187 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2050 } 3188 }
2051 } 3189 }
2052 }, 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 },
2053); 3217);
2054 3218
2055=item $client->async (\&cb) 3219=item $client->async (\&cb)
2056 3220
2057Create a new coroutine, running the specified callback. The coroutine will 3221Create a new coroutine, running the specified callback. The coroutine will
2073 3237
2074 $coro 3238 $coro
2075} 3239}
2076 3240
2077cf::client->attach ( 3241cf::client->attach (
2078 on_destroy => sub { 3242 on_client_destroy => sub {
2079 my ($ns) = @_; 3243 my ($ns) = @_;
2080 3244
2081 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3245 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2082 }, 3246 },
2083); 3247);
2098our $safe = new Safe "safe"; 3262our $safe = new Safe "safe";
2099our $safe_hole = new Safe::Hole; 3263our $safe_hole = new Safe::Hole;
2100 3264
2101$SIG{FPE} = 'IGNORE'; 3265$SIG{FPE} = 'IGNORE';
2102 3266
2103$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));
2104 3272
2105# here we export the classes and methods available to script code 3273# here we export the classes and methods available to script code
2106 3274
2107=pod 3275=pod
2108 3276
2109The following fucntions and emthods are available within a safe environment: 3277The following functions and methods are available within a safe environment:
2110 3278
2111 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
2112 cf::object::player player 3284 cf::object::player
2113 cf::player peaceful 3285 player
2114 cf::map trigger 3286
3287 cf::player
3288 peaceful
3289
3290 cf::map
3291 trigger
2115 3292
2116=cut 3293=cut
2117 3294
2118for ( 3295for (
2119 ["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)],
2120 ["cf::object::player" => qw(player)], 3299 ["cf::object::player" => qw(player)],
2121 ["cf::player" => qw(peaceful)], 3300 ["cf::player" => qw(peaceful send_msg)],
2122 ["cf::map" => qw(trigger)], 3301 ["cf::map" => qw(trigger)],
2123) { 3302) {
2124 no strict 'refs';
2125 my ($pkg, @funs) = @$_; 3303 my ($pkg, @funs) = @$_;
2126 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3304 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2127 for @funs; 3305 for @funs;
2128} 3306}
2129 3307
2144 3322
2145 my $qcode = $code; 3323 my $qcode = $code;
2146 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3324 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2147 $qcode =~ s/\n/\\n/g; 3325 $qcode =~ s/\n/\\n/g;
2148 3326
3327 %vars = (_dummy => 0) unless %vars;
3328
3329 my @res;
2149 local $_; 3330 local $_;
2150 local @safe::cf::_safe_eval_args = values %vars;
2151 3331
2152 my $eval = 3332 my $eval =
2153 "do {\n" 3333 "do {\n"
2154 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3334 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2155 . "#line 0 \"{$qcode}\"\n" 3335 . "#line 0 \"{$qcode}\"\n"
2156 . $code 3336 . $code
2157 . "\n}" 3337 . "\n}"
2158 ; 3338 ;
2159 3339
3340 if ($CFG{safe_eval}) {
2160 sub_generation_inc; 3341 sub_generation_inc;
3342 local @safe::cf::_safe_eval_args = values %vars;
2161 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3343 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2162 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 }
2163 3349
2164 if ($@) { 3350 if ($@) {
2165 warn "$@"; 3351 warn "$@",
2166 warn "while executing safe code '$code'\n"; 3352 "while executing safe code '$code'\n",
2167 warn "with arguments " . (join " ", %vars) . "\n"; 3353 "with arguments " . (join " ", %vars) . "\n";
2168 } 3354 }
2169 3355
2170 wantarray ? @res : $res[0] 3356 wantarray ? @res : $res[0]
2171} 3357}
2172 3358
2186=cut 3372=cut
2187 3373
2188sub register_script_function { 3374sub register_script_function {
2189 my ($fun, $cb) = @_; 3375 my ($fun, $cb) = @_;
2190 3376
2191 no strict 'refs'; 3377 $fun = "safe::$fun" if $CFG{safe_eval};
2192 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3378 *$fun = $safe_hole->wrap ($cb);
2193} 3379}
2194 3380
2195=back 3381=back
2196 3382
2197=cut 3383=cut
2198
2199#############################################################################
2200
2201=head2 EXTENSION DATABASE SUPPORT
2202
2203Crossfire maintains a very simple database for extension use. It can
2204currently store anything that can be serialised using Storable, which
2205excludes objects.
2206
2207The parameter C<$family> should best start with the name of the extension
2208using it, it should be unique.
2209
2210=over 4
2211
2212=item $value = cf::db_get $family => $key
2213
2214Returns a single value from the database.
2215
2216=item cf::db_put $family => $key => $value
2217
2218Stores the given C<$value> in the family.
2219
2220=cut
2221
2222our $DB;
2223
2224sub db_init {
2225 unless ($DB) {
2226 $DB = BDB::db_create $DB_ENV;
2227
2228 cf::sync_job {
2229 eval {
2230 $DB->set_flags (BDB::CHKSUM);
2231
2232 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2233 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2234 cf::cleanup "db_open(db): $!" if $!;
2235 };
2236 cf::cleanup "db_open(db): $@" if $@;
2237 };
2238
2239 my $path = cf::localdir . "/database.pst";
2240 if (stat $path) {
2241 cf::sync_job {
2242 my $pst = Storable::retrieve $path;
2243
2244 cf::db_put (board => data => $pst->{board});
2245 cf::db_put (guildrules => data => $pst->{guildrules});
2246 cf::db_put (rent => balance => $pst->{rent}{balance});
2247 BDB::db_env_txn_checkpoint $DB_ENV;
2248
2249 unlink $path;
2250 };
2251 }
2252 }
2253}
2254
2255sub db_get($$) {
2256 my $key = "$_[0]/$_[1]";
2257
2258 cf::sync_job {
2259 BDB::db_get $DB, undef, $key, my $data;
2260
2261 $! ? ()
2262 : Compress::LZF::sthaw $data
2263 }
2264}
2265
2266sub db_put($$$) {
2267 BDB::dbreq_pri 4;
2268 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2269}
2270 3384
2271############################################################################# 3385#############################################################################
2272# the server's init and main functions 3386# the server's init and main functions
2273 3387
2274sub load_faces { 3388sub load_facedata($) {
2275 my $path = sprintf "%s/faces", cf::datadir; 3389 my ($path) = @_;
2276 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
2277 warn "loading faces from $path\n"; 3397 trace "loading facedata from $path\n";
2278 3398
2279 my $faces;
2280 0 < aio_load $path, $faces 3399 0 < aio_load $path, my $facedata
2281 or die "$path: $!"; 3400 or die "$path: $!";
2282 3401
2283 Coro::cede;
2284 $faces = Storable::thaw $faces; 3402 $facedata = Coro::Storable::thaw $facedata;
2285 Coro::cede;
2286 3403
3404 $facedata->{version} == 2
3405 or cf::cleanup "$path: version mismatch, cannot proceed.";
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
2287 while (my ($face, $info) = each %$faces) { 3419 while (my ($face, $info) = each %$faces) {
2288 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3420 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2289 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};
2290 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3424 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2291 Coro::cede; 3425 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
3426
3427 cf::cede_to_tick;
3428 }
3429
3430 while (my ($face, $info) = each %$faces) {
3431 next unless $info->{smooth};
3432
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
2292 } 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);
2293 3476
2294 1 3477 1
2295} 3478}
2296 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}[$_]
3537 or next;
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
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 }
3548}
3549
2297sub reload_resources { 3550sub reload_resources {
2298 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3551 trace "reloading resource files...\n";
2299 or die "unable to load regions file\n";#d# 3552
3553 reload_exp_table;
3554 reload_materials;
2300 load_faces 3555 reload_facedata;
2301 or die "unable to load faces\n";#d# 3556 reload_sound;
2302} 3557 reload_archetypes;
2303
2304sub init {
2305 reload_resources; 3558 reload_regions;
2306} 3559 reload_treasures;
2307 3560
2308sub cfg_load { 3561 trace "finished reloading resource files\n";
2309 open my $fh, "<:utf8", cf::confdir . "/config" 3562}
2310 or return;
2311 3563
2312 local $/; 3564sub reload_config {
2313 *CFG = YAML::Syck::Load <$fh>; 3565 trace "reloading config file...\n";
2314 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
2315 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3573 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2316 3574
2317 $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};
2318 $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};
2319 3577
2320 if (exists $CFG{mlockall}) { 3578 if (exists $CFG{mlockall}) {
2324 }; 3582 };
2325 warn $@ if $@; 3583 warn $@ if $@;
2326 } 3584 }
2327} 3585}
2328 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
2329sub 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
2330 # we must not ever block the main coroutine 3625 # we must not ever block the main coroutine
2331 local $Coro::idle = sub { 3626 local $Coro::idle = sub {
2332 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#
2333 (async { 3628 (async {
2334 Event::one_event; 3629 $Coro::current->{desc} = "IDLE BUG HANDLER";
3630 EV::loop EV::LOOP_ONESHOT;
2335 })->prio (Coro::PRIO_MAX); 3631 })->prio (Coro::PRIO_MAX);
2336 }; 3632 };
2337 3633
2338 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;
2339 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
2340 load_extensions; 3657 load_extensions;
2341 3658
2342 $TICK_WATCHER->start; 3659 utime time, time, $RUNTIMEFILE;
2343 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;
2344} 3677}
2345 3678
2346############################################################################# 3679#############################################################################
2347# initialisation and cleanup 3680# initialisation and cleanup
2348 3681
2349# install some emergency cleanup handlers 3682# install some emergency cleanup handlers
2350BEGIN { 3683BEGIN {
3684 our %SIGWATCHER = ();
2351 for my $signal (qw(INT HUP TERM)) { 3685 for my $signal (qw(INT HUP TERM)) {
2352 Event->signal ( 3686 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2353 reentrant => 0,
2354 data => WF_AUTOCANCEL,
2355 signal => $signal,
2356 prio => 0,
2357 cb => sub {
2358 cf::cleanup "SIG$signal"; 3687 cf::cleanup "SIG$signal";
2359 },
2360 ); 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
2361 } 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 };
2362} 3778}
2363 3779
2364sub emergency_save() { 3780sub emergency_save() {
2365 my $freeze_guard = cf::freeze_mainloop; 3781 my $freeze_guard = cf::freeze_mainloop;
2366 3782
2367 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;
2368 3789
2369 cf::sync_job { 3790 cf::sync_job {
3791 cf::write_runtime_sync; # external watchdog should not bark
3792
2370 # use a peculiar iteration method to avoid tripping on perl 3793 # use a peculiar iteration method to avoid tripping on perl
2371 # refcount bugs in for. also avoids problems with players 3794 # refcount bugs in for. also avoids problems with players
2372 # and maps saved/destroyed asynchronously. 3795 # and maps saved/destroyed asynchronously.
2373 warn "begin emergency player save\n"; 3796 info "emergency_perl_save: begin player save\n";
2374 for my $login (keys %cf::PLAYER) { 3797 for my $login (keys %cf::PLAYER) {
2375 my $pl = $cf::PLAYER{$login} or next; 3798 my $pl = $cf::PLAYER{$login} or next;
2376 $pl->valid or next; 3799 $pl->valid or next;
3800 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2377 $pl->save; 3801 $pl->save;
2378 } 3802 }
2379 warn "end emergency player save\n"; 3803 info "emergency_perl_save: end player save\n";
2380 3804
2381 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";
2382 for my $path (keys %cf::MAP) { 3808 for my $path (keys %cf::MAP) {
2383 my $map = $cf::MAP{$path} or next; 3809 my $map = $cf::MAP{$path} or next;
2384 $map->valid or next; 3810 $map->valid or next;
2385 $map->save; 3811 $map->save;
2386 } 3812 }
2387 warn "end emergency map save\n"; 3813 info "emergency_perl_save: end map save\n";
2388 3814
2389 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";
2390 BDB::db_env_txn_checkpoint $DB_ENV; 3818 BDB::db_env_txn_checkpoint $DB_ENV;
2391 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
2392 }; 3843 };
2393 3844
2394 warn "leave emergency perl save\n"; 3845 info "emergency_perl_save: leave\n";
2395} 3846}
2396 3847
2397sub post_cleanup { 3848sub post_cleanup {
2398 my ($make_core) = @_; 3849 my ($make_core) = @_;
2399 3850
3851 IO::AIO::flush;
3852
2400 warn Carp::longmess "post_cleanup backtrace" 3853 error Carp::longmess "post_cleanup backtrace"
2401 if $make_core; 3854 if $make_core;
2402}
2403 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
2404sub reload() { 3885sub do_reload_perl() {
2405 # can/must only be called in main 3886 # can/must only be called in main
2406 if ($Coro::current != $Coro::main) { 3887 unless (in_main) {
2407 warn "can only reload from main coroutine"; 3888 error "can only reload from main coroutine";
2408 return; 3889 return;
2409 } 3890 }
2410 3891
3892 return if $RELOAD++;
3893
3894 my $t1 = AE::time;
3895
3896 while ($RELOAD) {
3897 cf::get_slot 0.1, -1, "reload_perl";
2411 warn "reloading..."; 3898 info "reloading...";
2412 3899
2413 warn "entering sync_job"; 3900 trace "entering sync_job";
2414 3901
2415 cf::sync_job { 3902 cf::sync_job {
2416 cf::write_runtime; # external watchdog should not bark
2417 cf::emergency_save; 3903 #cf::emergency_save;
2418 cf::write_runtime; # external watchdog should not bark
2419 3904
2420 warn "syncing database to disk";
2421 BDB::db_env_txn_checkpoint $DB_ENV;
2422
2423 # if anything goes wrong in here, we should simply crash as we already saved
2424
2425 warn "cancelling all WF_AUTOCANCEL watchers";
2426 for (Event::all_watchers) {
2427 $_->cancel if $_->data & WF_AUTOCANCEL;
2428 }
2429
2430 warn "flushing outstanding aio requests";
2431 for (;;) {
2432 BDB::flush;
2433 IO::AIO::flush;
2434 Coro::cede;
2435 last unless IO::AIO::nreqs || BDB::nreqs;
2436 warn "iterate...";
2437 }
2438
2439 ++$RELOAD;
2440
2441 warn "cancelling all extension coros"; 3905 trace "cancelling all extension coros";
2442 $_->cancel for values %EXT_CORO; 3906 $_->cancel for values %EXT_CORO;
2443 %EXT_CORO = (); 3907 %EXT_CORO = ();
2444 3908
2445 warn "removing commands"; 3909 trace "removing commands";
2446 %COMMAND = (); 3910 %COMMAND = ();
2447 3911
2448 warn "removing ext commands"; 3912 trace "removing ext/exti commands";
2449 %EXTCMD = (); 3913 %EXTCMD = ();
3914 %EXTICMD = ();
2450 3915
2451 warn "unloading/nuking all extensions"; 3916 trace "unloading/nuking all extensions";
2452 for my $pkg (@EXTS) { 3917 for my $pkg (@EXTS) {
2453 warn "... unloading $pkg"; 3918 trace "... unloading $pkg";
2454 3919
2455 if (my $cb = $pkg->can ("unload")) { 3920 if (my $cb = $pkg->can ("unload")) {
2456 eval { 3921 eval {
2457 $cb->($pkg); 3922 $cb->($pkg);
2458 1 3923 1
2459 } 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;
2460 } 3929 }
2461 3930
2462 warn "... nuking $pkg";
2463 Symbol::delete_package $pkg;
2464 }
2465
2466 warn "unloading all perl modules loaded from $LIBDIR"; 3931 trace "unloading all perl modules loaded from $LIBDIR";
2467 while (my ($k, $v) = each %INC) { 3932 while (my ($k, $v) = each %INC) {
2468 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3933 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2469 3934
2470 warn "... unloading $k"; 3935 trace "... unloading $k";
2471 delete $INC{$k}; 3936 delete $INC{$k};
2472 3937
2473 $k =~ s/\.pm$//; 3938 $k =~ s/\.pm$//;
2474 $k =~ s/\//::/g; 3939 $k =~ s/\//::/g;
2475 3940
2476 if (my $cb = $k->can ("unload_module")) { 3941 if (my $cb = $k->can ("unload_module")) {
2477 $cb->(); 3942 $cb->();
3943 }
3944
3945 clear_package $k;
2478 } 3946 }
2479 3947
2480 Symbol::delete_package $k;
2481 }
2482
2483 warn "getting rid of safe::, as good as possible"; 3948 trace "getting rid of safe::, as good as possible";
2484 Symbol::delete_package "safe::$_" 3949 clear_package "safe::$_"
2485 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);
2486 3951
2487 warn "unloading cf.pm \"a bit\""; 3952 trace "unloading cf.pm \"a bit\"";
2488 delete $INC{"cf.pm"}; 3953 delete $INC{"cf.pm"};
3954 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2489 3955
2490 # don't, removes xs symbols, too, 3956 # don't, removes xs symbols, too,
2491 # and global variables created in xs 3957 # and global variables created in xs
2492 #Symbol::delete_package __PACKAGE__; 3958 #clear_package __PACKAGE__;
2493 3959
2494 warn "unload completed, starting to reload now"; 3960 info "unload completed, starting to reload now";
2495 3961
2496 warn "reloading cf.pm"; 3962 trace "reloading cf.pm";
2497 require cf; 3963 require cf;
2498 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3964 cf::_connect_to_perl_1;
2499 3965
2500 warn "loading config and database again"; 3966 trace "loading config and database again";
2501 cf::cfg_load; 3967 cf::reload_config;
2502 3968
2503 warn "loading extensions"; 3969 trace "loading extensions";
2504 cf::load_extensions; 3970 cf::load_extensions;
2505 3971
3972 if ($REATTACH_ON_RELOAD) {
2506 warn "reattaching attachments to objects/players"; 3973 trace "reattaching attachments to objects/players";
2507 _global_reattach; # objects, sockets 3974 _global_reattach; # objects, sockets
2508 warn "reattaching attachments to maps"; 3975 trace "reattaching attachments to maps";
2509 reattach $_ for values %MAP; 3976 reattach $_ for values %MAP;
2510 warn "reattaching attachments to players"; 3977 trace "reattaching attachments to players";
2511 reattach $_ for values %PLAYER; 3978 reattach $_ for values %PLAYER;
3979 }
2512 3980
2513 warn "loading reloadable resources"; 3981 trace "running post_init jobs";
2514 reload_resources; 3982 (pop @POST_INIT)->(1) while @POST_INIT;
2515 3983
2516 warn "leaving sync_job"; 3984 trace "leaving sync_job";
2517 3985
2518 1 3986 1
2519 } or do { 3987 } or do {
2520 warn $@; 3988 error $@;
2521 warn "error while reloading, exiting."; 3989 cf::cleanup "error while reloading, exiting.";
2522 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 };
2523 }; 4013 };
2524 4014}
2525 warn "reloaded";
2526};
2527
2528our $RELOAD_WATCHER; # used only during reload
2529 4015
2530register_command "reload" => sub { 4016register_command "reload" => sub {
2531 my ($who, $arg) = @_; 4017 my ($who, $arg) = @_;
2532 4018
2533 if ($who->flag (FLAG_WIZ)) { 4019 if ($who->flag (FLAG_WIZ)) {
2534 $who->message ("reloading server."); 4020 $who->message ("reloading server.");
2535 4021 async {
2536 # doing reload synchronously and two reloads happen back-to-back, 4022 $Coro::current->{desc} = "perl_reload";
2537 # coro crashes during coro_state_free->destroy here.
2538
2539 $RELOAD_WATCHER ||= Event->timer (
2540 reentrant => 0,
2541 after => 0,
2542 data => WF_AUTOCANCEL,
2543 cb => sub {
2544 reload; 4023 reload_perl;
2545 undef $RELOAD_WATCHER;
2546 },
2547 ); 4024 };
2548 } 4025 }
2549}; 4026};
2550 4027
2551unshift @INC, $LIBDIR; 4028#############################################################################
2552 4029
2553my $bug_warning = 0; 4030my $bug_warning = 0;
2554 4031
2555$TICK_WATCHER = Event->timer ( 4032our @WAIT_FOR_TICK;
2556 reentrant => 0, 4033our @WAIT_FOR_TICK_BEGIN;
2557 parked => 1, 4034
2558 prio => 0, 4035sub wait_for_tick() {
2559 at => $NEXT_TICK || $TICK, 4036 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2560 data => WF_AUTOCANCEL, 4037
2561 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 {
2562 if ($Coro::current != $Coro::main) { 4052 if ($Coro::current != $Coro::main) {
2563 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"
2564 unless ++$bug_warning > 10; 4054 unless ++$bug_warning > 10;
2565 return; 4055 return;
2566 } 4056 }
2567 4057
2568 $NOW = Event::time;
2569
2570 cf::server_tick; # one server iteration 4058 cf::server_tick; # one server iteration
2571 $RUNTIME += $TICK;
2572 $NEXT_TICK += $TICK;
2573 4059
4060 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
4061
2574 if ($NOW >= $NEXT_RUNTIME_WRITE) { 4062 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2575 $NEXT_RUNTIME_WRITE = $NOW + 10; 4063 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2576 Coro::async_pool { 4064 Coro::async_pool {
4065 $Coro::current->{desc} = "runtime saver";
2577 write_runtime 4066 write_runtime_sync
2578 or warn "ERROR: unable to write runtime file: $!"; 4067 or error "ERROR: unable to write runtime file: $!";
2579 };
2580 } 4068 };
2581
2582 $WAIT_FOR_TICK->broadcast;
2583 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2584
2585# my $AFTER = Event::time;
2586# warn $AFTER - $NOW;#d#
2587
2588 # if we are delayed by four ticks or more, skip them all
2589 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2590
2591 $TICK_WATCHER->at ($NEXT_TICK);
2592 $TICK_WATCHER->start;
2593 }, 4069 }
2594); 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}
2595 4089
2596{ 4090{
2597 BDB::max_poll_time $TICK * 0.1; 4091 # configure BDB
2598 $BDB_POLL_WATCHER = Event->io ( 4092
2599 reentrant => 0,
2600 fd => BDB::poll_fileno,
2601 poll => 'r',
2602 prio => 0,
2603 data => WF_AUTOCANCEL,
2604 cb => \&BDB::poll_cb,
2605 );
2606 BDB::min_parallel 8; 4093 BDB::min_parallel 16;
2607 4094 BDB::max_poll_reqs $TICK * 0.1;
2608 BDB::set_sync_prepare { 4095 $AnyEvent::BDB::WATCHER->priority (1);
2609 my $status;
2610 my $current = $Coro::current;
2611 (
2612 sub {
2613 $status = $!;
2614 $current->ready; undef $current;
2615 },
2616 sub {
2617 Coro::schedule while defined $current;
2618 $! = $status;
2619 },
2620 )
2621 };
2622 4096
2623 unless ($DB_ENV) { 4097 unless ($DB_ENV) {
2624 $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);
2625 4104
2626 cf::sync_job { 4105 cf::sync_job {
2627 eval { 4106 eval {
2628 BDB::db_env_open 4107 BDB::db_env_open
2629 $DB_ENV, 4108 $DB_ENV,
2630 $BDB_ENV_DIR, 4109 $BDBDIR,
2631 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
2632 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4111 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2633 0666; 4112 0666;
2634 4113
2635 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 4114 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2636
2637 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2638 $DB_ENV->set_lk_detect;
2639 }; 4115 };
2640 4116
2641 cf::cleanup "db_env_open(db): $@" if $@; 4117 cf::cleanup "db_env_open(db): $@" if $@;
2642 }; 4118 };
2643 } 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 };
2644} 4130}
2645 4131
2646{ 4132{
4133 # configure IO::AIO
4134
2647 IO::AIO::min_parallel 8; 4135 IO::AIO::min_parallel 8;
2648
2649 undef $Coro::AIO::WATCHER;
2650 IO::AIO::max_poll_time $TICK * 0.1; 4136 IO::AIO::max_poll_time $TICK * 0.1;
2651 $AIO_POLL_WATCHER = Event->io ( 4137 undef $AnyEvent::AIO::WATCHER;
2652 reentrant => 0,
2653 data => WF_AUTOCANCEL,
2654 fd => IO::AIO::poll_fileno,
2655 poll => 'r',
2656 prio => 6,
2657 cb => \&IO::AIO::poll_cb,
2658 );
2659} 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;
2660 4185
2661END { cf::emergency_save } 4186END { cf::emergency_save }
2662 4187
26631 41881
2664 4189

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines