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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines