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.220 by root, Sat Feb 17 23:54:35 2007 UTC vs.
Revision 1.544 by root, Thu May 6 21:58:07 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines