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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines