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.216 by root, Thu Feb 15 14:30:21 2007 UTC vs.
Revision 1.542 by root, Wed May 5 09:05:03 2010 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines