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.219 by root, Sat Feb 17 03:19:44 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 $guard = cf::lock_acquire "write_runtime";
360 584
361 my $runtime = cf::localdir . "/runtime"; 585Executes the given code block with the given arguments in a seperate
586process, returning the results. Everything must be serialisable with
587Coro::Storable. May, of course, block. Note that the executed sub may
588never block itself or use any form of event handling.
362 589
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 590=cut
364 or return;
365 591
366 my $value = $cf::RUNTIME + 90 + 10; 592sub fork_call(&@) {
367 # 10 is the runtime save interval, for a monotonic clock 593 my ($cb, @args) = @_;
368 # 60 allows for the watchdog to kill the server.
369 594
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0 595 # we seemingly have to make a local copy of the whole thing,
371 and return; 596 # otherwise perl prematurely frees the stuff :/
597 # TODO: investigate and fix (likely this will be rather laborious)
372 598
373 # always fsync - this file is important 599 my @res = Coro::Util::fork_eval {
374 aio_fsync $fh 600 reset_signals;
375 and return; 601 &$cb
602 }, @args;
376 603
377 close $fh 604 wantarray ? @res : $res[-1]
378 or return; 605}
379 606
380 aio_rename "$runtime~", $runtime 607sub objinfo {
381 and return;
382
383 1 608 (
609 "counter value" => cf::object::object_count,
610 "objects created" => cf::object::create_count,
611 "objects destroyed" => cf::object::destroy_count,
612 "freelist size" => cf::object::free_count,
613 "allocated objects" => cf::object::objects_size,
614 "active objects" => cf::object::actives_size,
615 )
616}
617
618=item $coin = coin_from_name $name
619
620=cut
621
622our %coin_alias = (
623 "silver" => "silvercoin",
624 "silvercoin" => "silvercoin",
625 "silvercoins" => "silvercoin",
626 "gold" => "goldcoin",
627 "goldcoin" => "goldcoin",
628 "goldcoins" => "goldcoin",
629 "platinum" => "platinacoin",
630 "platinumcoin" => "platinacoin",
631 "platinumcoins" => "platinacoin",
632 "platina" => "platinacoin",
633 "platinacoin" => "platinacoin",
634 "platinacoins" => "platinacoin",
635 "royalty" => "royalty",
636 "royalties" => "royalty",
637);
638
639sub coin_from_name($) {
640 $coin_alias{$_[0]}
641 ? cf::arch::find $coin_alias{$_[0]}
642 : undef
643}
644
645=item $value = cf::db_get $family => $key
646
647Returns a single value from the environment database.
648
649=item cf::db_put $family => $key => $value
650
651Stores the given C<$value> in the family. It can currently store binary
652data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
653
654=item $db = cf::db_table "name"
655
656Create and/or open a new database table. The string must not be "db" and must be unique
657within each server.
658
659=cut
660
661sub db_table($) {
662 cf::error "db_get called from main context"
663 if $Coro::current == $Coro::main;
664
665 my ($name) = @_;
666 my $db = BDB::db_create $DB_ENV;
667
668 eval {
669 $db->set_flags (BDB::CHKSUM);
670
671 utf8::encode $name;
672 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
673 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
674 cf::cleanup "db_open(db): $!" if $!;
675 };
676 cf::cleanup "db_open(db): $@" if $@;
677
678 $db
679}
680
681our $DB;
682
683sub db_init {
684 $DB ||= db_table "db";
685}
686
687sub db_get($$) {
688 my $key = "$_[0]/$_[1]";
689
690 cf::error "db_get called from main context"
691 if $Coro::current == $Coro::main;
692
693 BDB::db_get $DB, undef, $key, my $data;
694
695 $! ? ()
696 : $data
697}
698
699sub db_put($$$) {
700 BDB::dbreq_pri 4;
701 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
702}
703
704=item cf::cache $id => [$paths...], $processversion => $process
705
706Generic caching function that returns the value of the resource $id,
707caching and regenerating as required.
708
709This function can block.
710
711=cut
712
713sub cache {
714 my ($id, $src, $processversion, $process) = @_;
715
716 my $meta =
717 join "\x00",
718 $processversion,
719 map {
720 aio_stat $_
721 and Carp::croak "$_: $!";
722
723 ($_, (stat _)[7,9])
724 } @$src;
725
726 my $dbmeta = db_get cache => "$id/meta";
727 if ($dbmeta ne $meta) {
728 # changed, we may need to process
729
730 my @data;
731 my $md5;
732
733 for (0 .. $#$src) {
734 0 <= aio_load $src->[$_], $data[$_]
735 or Carp::croak "$src->[$_]: $!";
736 }
737
738 # if processing is expensive, check
739 # checksum first
740 if (1) {
741 $md5 =
742 join "\x00",
743 $processversion,
744 map {
745 cf::cede_to_tick;
746 ($src->[$_], Digest::MD5::md5_hex $data[$_])
747 } 0.. $#$src;
748
749
750 my $dbmd5 = db_get cache => "$id/md5";
751 if ($dbmd5 eq $md5) {
752 db_put cache => "$id/meta", $meta;
753
754 return db_get cache => "$id/data";
755 }
756 }
757
758 my $t1 = Time::HiRes::time;
759 my $data = $process->(\@data);
760 my $t2 = Time::HiRes::time;
761
762 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
763
764 db_put cache => "$id/data", $data;
765 db_put cache => "$id/md5" , $md5;
766 db_put cache => "$id/meta", $meta;
767
768 return $data;
769 }
770
771 db_get cache => "$id/data"
772}
773
774=item cf::datalog type => key => value, ...
775
776Log a datalog packet of the given type with the given key-value pairs.
777
778=cut
779
780sub datalog($@) {
781 my ($type, %kv) = @_;
782 info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 783}
385 784
386=back 785=back
387 786
388=cut 787=cut
389 788
390############################################################################# 789#############################################################################
391 790
392=head2 ATTACHABLE OBJECTS 791=head2 ATTACHABLE OBJECTS
393 792
394Many objects in crossfire are so-called attachable objects. That means you can 793Many objects in deliantra are so-called attachable objects. That means you can
395attach callbacks/event handlers (a collection of which is called an "attachment") 794attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 795to it. All such attachable objects support the following methods.
397 796
398In the following description, CLASS can be any of C<global>, C<object> 797In the following description, CLASS can be any of C<global>, C<object>
399C<player>, C<client> or C<map> (i.e. the attachable objects in 798C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 799Deliantra).
401 800
402=over 4 801=over 4
403 802
404=item $attachable->attach ($attachment, key => $value...) 803=item $attachable->attach ($attachment, key => $value...)
405 804
… …
449=item cf::CLASS::attachment $name, ... 848=item cf::CLASS::attachment $name, ...
450 849
451Register an attachment by C<$name> through which attachable objects of the 850Register an attachment by C<$name> through which attachable objects of the
452given CLASS can refer to this attachment. 851given CLASS can refer to this attachment.
453 852
454Some classes such as crossfire maps and objects can specify attachments 853Some classes such as deliantra maps and objects can specify attachments
455that are attached at load/instantiate time, thus the need for a name. 854that are attached at load/instantiate time, thus the need for a name.
456 855
457These calls expect any number of the following handler/hook descriptions: 856These calls expect any number of the following handler/hook descriptions:
458 857
459=over 4 858=over 4
… …
568 $registry = $CB_TYPE[$object_type] ||= []; 967 $registry = $CB_TYPE[$object_type] ||= [];
569 968
570 } elsif ($type eq "subtype") { 969 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 970 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 971 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 972 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 973
575 } elsif ($type eq "package") { 974 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 975 my $pkg = shift @arg;
577 976
578 while (my ($name, $id) = each %cb_id) { 977 while (my ($name, $id) = each %cb_id) {
… …
583 982
584 } elsif (exists $cb_id{$type}) { 983 } elsif (exists $cb_id{$type}) {
585 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 984 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
586 985
587 } elsif (ref $type) { 986 } elsif (ref $type) {
588 warn "attaching objects not supported, ignoring.\n"; 987 error "attaching objects not supported, ignoring.\n";
589 988
590 } else { 989 } else {
591 shift @arg; 990 shift @arg;
592 warn "attach argument '$type' not supported, ignoring.\n"; 991 error "attach argument '$type' not supported, ignoring.\n";
593 } 992 }
594 } 993 }
595} 994}
596 995
597sub _object_attach { 996sub _object_attach {
… …
607 _attach $registry, $klass, @attach; 1006 _attach $registry, $klass, @attach;
608 } 1007 }
609 1008
610 $obj->{$name} = \%arg; 1009 $obj->{$name} = \%arg;
611 } else { 1010 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 1011 info "object uses attachment '$name' which is not available, postponing.\n";
613 } 1012 }
614 1013
615 $obj->{_attachment}{$name} = undef; 1014 $obj->{_attachment}{$name} = undef;
616} 1015}
617 1016
… …
619 if (ref $_[0]) { 1018 if (ref $_[0]) {
620 _object_attach @_; 1019 _object_attach @_;
621 } else { 1020 } else {
622 _attach shift->_attach_registry, @_; 1021 _attach shift->_attach_registry, @_;
623 } 1022 }
1023 _recalc_want;
624}; 1024};
625 1025
626# all those should be optimised 1026# all those should be optimised
627sub cf::attachable::detach { 1027sub cf::attachable::detach {
628 my ($obj, $name) = @_; 1028 my ($obj, $name) = @_;
… …
631 delete $obj->{_attachment}{$name}; 1031 delete $obj->{_attachment}{$name};
632 reattach ($obj); 1032 reattach ($obj);
633 } else { 1033 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 1034 Carp::croak "cannot, currently, detach class attachments";
635 } 1035 }
1036 _recalc_want;
636}; 1037};
637 1038
638sub cf::attachable::attached { 1039sub cf::attachable::attached {
639 my ($obj, $name) = @_; 1040 my ($obj, $name) = @_;
640 1041
… …
655 "; 1056 ";
656 die if $@; 1057 die if $@;
657} 1058}
658 1059
659our $override; 1060our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1061our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661 1062
662sub override { 1063sub override {
663 $override = 1; 1064 $override = 1;
664 @invoke_results = (); 1065 @INVOKE_RESULTS = (@_);
665} 1066}
666 1067
667sub do_invoke { 1068sub do_invoke {
668 my $event = shift; 1069 my $event = shift;
669 my $callbacks = shift; 1070 my $callbacks = shift;
670 1071
671 @invoke_results = (); 1072 @INVOKE_RESULTS = ();
672 1073
673 local $override; 1074 local $override;
674 1075
675 for (@$callbacks) { 1076 for (@$callbacks) {
676 eval { &{$_->[1]} }; 1077 eval { &{$_->[1]} };
677 1078
678 if ($@) { 1079 if ($@) {
679 warn "$@";
680 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1080 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
681 override; 1081 override;
682 } 1082 }
683 1083
684 return 1 if $override; 1084 return 1 if $override;
685 } 1085 }
686 1086
687 0 1087 0
688} 1088}
689 1089
690=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1090=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
691 1091
692=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1092=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
693 1093
694Generate an object-specific event with the given arguments. 1094Generate an object-specific event with the given arguments.
695 1095
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1096This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697removed in future versions), and there is no public API to access override 1097removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly). 1098results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 1099
700=back 1100=back
701 1101
702=cut 1102=cut
703 1103
704############################################################################# 1104#############################################################################
705# object support 1105# object support
1106
1107sub _object_equal($$);
1108sub _object_equal($$) {
1109 my ($a, $b) = @_;
1110
1111 return 0 unless (ref $a) eq (ref $b);
1112
1113 if ("HASH" eq ref $a) {
1114 my @ka = keys %$a;
1115 my @kb = keys %$b;
1116
1117 return 0 if @ka != @kb;
1118
1119 for (0 .. $#ka) {
1120 return 0 unless $ka[$_] eq $kb[$_];
1121 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1122 }
1123
1124 } elsif ("ARRAY" eq ref $a) {
1125
1126 return 0 if @$a != @$b;
1127
1128 for (0 .. $#$a) {
1129 return 0 unless _object_equal $a->[$_], $b->[$_];
1130 }
1131
1132 } elsif ($a ne $b) {
1133 return 0;
1134 }
1135
1136 1
1137}
1138
1139our $SLOW_MERGES;#d#
1140sub _can_merge {
1141 my ($ob1, $ob2) = @_;
1142
1143 ++$SLOW_MERGES;#d#
1144
1145 # we do the slow way here
1146 return _object_equal $ob1, $ob2
1147}
706 1148
707sub reattach { 1149sub reattach {
708 # basically do the same as instantiate, without calling instantiate 1150 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_; 1151 my ($obj) = @_;
710 1152
1153 # no longer needed after getting rid of delete_package?
711 bless $obj, ref $obj; # re-bless in case extensions have been reloaded 1154 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
712 1155
713 my $registry = $obj->registry; 1156 my $registry = $obj->registry;
714 1157
715 @$registry = (); 1158 @$registry = ();
716 1159
… …
721 for (@$attach) { 1164 for (@$attach) {
722 my ($klass, @attach) = @$_; 1165 my ($klass, @attach) = @$_;
723 _attach $registry, $klass, @attach; 1166 _attach $registry, $klass, @attach;
724 } 1167 }
725 } else { 1168 } else {
726 warn "object uses attachment '$name' that is not available, postponing.\n"; 1169 info "object uses attachment '$name' that is not available, postponing.\n";
727 } 1170 }
728 } 1171 }
729} 1172}
730 1173
731cf::attachable->attach ( 1174cf::attachable->attach (
732 prio => -1000000, 1175 prio => -1000000,
733 on_instantiate => sub { 1176 on_instantiate => sub {
734 my ($obj, $data) = @_; 1177 my ($obj, $data) = @_;
735 1178
736 $data = from_json $data; 1179 $data = decode_json $data;
737 1180
738 for (@$data) { 1181 for (@$data) {
739 my ($name, $args) = @$_; 1182 my ($name, $args) = @$_;
740 1183
741 $obj->attach ($name, %{$args || {} }); 1184 $obj->attach ($name, %{$args || {} });
… …
757sub object_freezer_save { 1200sub object_freezer_save {
758 my ($filename, $rdata, $objs) = @_; 1201 my ($filename, $rdata, $objs) = @_;
759 1202
760 sync_job { 1203 sync_job {
761 if (length $$rdata) { 1204 if (length $$rdata) {
1205 utf8::decode (my $decname = $filename);
762 warn sprintf "saving %s (%d,%d)\n", 1206 trace sprintf "saving %s (%d,%d)\n",
763 $filename, length $$rdata, scalar @$objs; 1207 $decname, length $$rdata, scalar @$objs
1208 if $VERBOSE_IO;
764 1209
765 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1210 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
766 chmod SAVE_MODE, $fh; 1211 aio_chmod $fh, SAVE_MODE;
767 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1212 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
768 aio_fsync $fh if $cf::USE_FSYNC; 1213 if ($cf::USE_FSYNC) {
1214 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1215 aio_fsync $fh;
1216 }
769 close $fh; 1217 aio_close $fh;
770 1218
771 if (@$objs) { 1219 if (@$objs) {
772 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1220 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
773 chmod SAVE_MODE, $fh; 1221 aio_chmod $fh, SAVE_MODE;
774 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1222 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
775 aio_write $fh, 0, (length $data), $data, 0; 1223 aio_write $fh, 0, (length $data), $data, 0;
776 aio_fsync $fh if $cf::USE_FSYNC; 1224 if ($cf::USE_FSYNC) {
1225 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1226 aio_fsync $fh;
1227 }
777 close $fh; 1228 aio_close $fh;
778 aio_rename "$filename.pst~", "$filename.pst"; 1229 aio_rename "$filename.pst~", "$filename.pst";
779 } 1230 }
780 } else { 1231 } else {
781 aio_unlink "$filename.pst"; 1232 aio_unlink "$filename.pst";
782 } 1233 }
783 1234
784 aio_rename "$filename~", $filename; 1235 aio_rename "$filename~", $filename;
1236
1237 $filename =~ s%/[^/]+$%%;
1238 aio_pathsync $filename if $cf::USE_FSYNC;
785 } else { 1239 } else {
786 warn "FATAL: $filename~: $!\n"; 1240 error "unable to save objects: $filename~: $!\n";
787 } 1241 }
788 } else { 1242 } else {
789 aio_unlink $filename; 1243 aio_unlink $filename;
790 aio_unlink "$filename.pst"; 1244 aio_unlink "$filename.pst";
791 } 1245 }
792 } 1246 };
793} 1247}
794 1248
795sub object_freezer_as_string { 1249sub object_freezer_as_string {
796 my ($rdata, $objs) = @_; 1250 my ($rdata, $objs) = @_;
797 1251
… …
809 or return; 1263 or return;
810 1264
811 unless (aio_stat "$filename.pst") { 1265 unless (aio_stat "$filename.pst") {
812 (aio_load "$filename.pst", $av) >= 0 1266 (aio_load "$filename.pst", $av) >= 0
813 or return; 1267 or return;
1268
814 $av = eval { (Storable::thaw $av)->{objs} }; 1269 my $st = eval { Coro::Storable::thaw $av };
1270 $av = $st->{objs};
815 } 1271 }
816 1272
1273 utf8::decode (my $decname = $filename);
817 warn sprintf "loading %s (%d)\n", 1274 trace sprintf "loading %s (%d,%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1275 $decname, length $data, scalar @{$av || []}
1276 if $VERBOSE_IO;
1277
819 return ($data, $av); 1278 ($data, $av)
820} 1279}
1280
1281=head2 COMMAND CALLBACKS
1282
1283=over 4
1284
1285=cut
821 1286
822############################################################################# 1287#############################################################################
823# command handling &c 1288# command handling &c
824 1289
825=item cf::register_command $name => \&callback($ob,$args); 1290=item cf::register_command $name => \&callback($ob,$args);
… …
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1303 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1304}
840 1305
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1306=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1307
843Register a callbackf ro execution when the client sends an extcmd packet. 1308Register a callback for execution when the client sends an (synchronous)
1309extcmd packet. Ext commands will be processed in the order they are
1310received by the server, like other user commands. The first argument is
1311the logged-in player. Ext commands can only be processed after a player
1312has logged in successfully.
844 1313
845If the callback returns something, it is sent back as if reply was being 1314If the callback returns something, it is sent back as if reply was being
846called. 1315called.
847 1316
1317=item cf::register_exticmd $name => \&callback($ns,$packet);
1318
1319Register a callback for execution when the client sends an (asynchronous)
1320exticmd packet. Exti commands are processed by the server as soon as they
1321are received, i.e. out of order w.r.t. other commands. The first argument
1322is a client socket. Exti commands can be received anytime, even before
1323log-in.
1324
1325If the callback returns something, it is sent back as if reply was being
1326called.
1327
848=cut 1328=cut
849 1329
850sub register_extcmd { 1330sub register_extcmd {
851 my ($name, $cb) = @_; 1331 my ($name, $cb) = @_;
852 1332
853 $EXTCMD{$name} = $cb; 1333 $EXTCMD{$name} = $cb;
854} 1334}
855 1335
1336sub register_exticmd {
1337 my ($name, $cb) = @_;
1338
1339 $EXTICMD{$name} = $cb;
1340}
1341
1342use File::Glob ();
1343
856cf::player->attach ( 1344cf::player->attach (
857 on_command => sub { 1345 on_unknown_command => sub {
858 my ($pl, $name, $params) = @_; 1346 my ($pl, $name, $params) = @_;
859 1347
860 my $cb = $COMMAND{$name} 1348 my $cb = $COMMAND{$name}
861 or return; 1349 or return;
862 1350
… …
867 cf::override; 1355 cf::override;
868 }, 1356 },
869 on_extcmd => sub { 1357 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1358 my ($pl, $buf) = @_;
871 1359
872 my $msg = eval { from_json $buf }; 1360 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1361
874 if (ref $msg) { 1362 if (ref $msg) {
1363 my ($type, $reply, @payload) =
1364 "ARRAY" eq ref $msg
1365 ? @$msg
1366 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1367
1368 my @reply;
1369
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1370 if (my $cb = $EXTCMD{$type}) {
876 if (my %reply = $cb->($pl, $msg)) { 1371 @reply = $cb->($pl, @payload);
877 $pl->ext_reply ($msg->{msgid}, %reply);
878 }
879 } 1372 }
1373
1374 $pl->ext_reply ($reply, @reply)
1375 if $reply;
1376
880 } else { 1377 } else {
881 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1378 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882 } 1379 }
883 1380
884 cf::override; 1381 cf::override;
885 }, 1382 },
886); 1383);
887 1384
1385# "readahead" all extensions
888sub load_extension { 1386sub cache_extensions {
889 my ($path) = @_; 1387 my $grp = IO::AIO::aio_group;
890 1388
891 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1389 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
892 my $base = $1; 1390 for (grep /\.ext$/, @{$_[0]}) {
893 my $pkg = $1; 1391 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
894 $pkg =~ s/[^[:word:]]/_/g;
895 $pkg = "ext::$pkg";
896
897 warn "... loading '$path' into '$pkg'\n";
898
899 open my $fh, "<:utf8", $path
900 or die "$path: $!";
901
902 my $source =
903 "package $pkg; use strict; use utf8;\n"
904 . "#line 1 \"$path\"\n{\n"
905 . (do { local $/; <$fh> })
906 . "\n};\n1";
907
908 unless (eval $source) {
909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 } 1392 }
916 die $@;
917 } 1393 };
918 1394
919 push @EXTS, $pkg; 1395 $grp
920} 1396}
921 1397
922sub load_extensions { 1398sub load_extensions {
1399 info "loading extensions...";
1400
1401 cf::sync_job {
1402 my %todo;
1403
923 for my $ext (<$LIBDIR/*.ext>) { 1404 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1405 next unless -r $path;
925 eval { 1406
926 load_extension $ext; 1407 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1408 my $base = $1;
1409 my $pkg = $1;
1410 $pkg =~ s/[^[:word:]]/_/g;
1411 $pkg = "ext::$pkg";
1412
1413 open my $fh, "<:utf8", $path
1414 or die "$path: $!";
1415
1416 my $source = do { local $/; <$fh> };
1417
1418 my %ext = (
1419 path => $path,
1420 base => $base,
1421 pkg => $pkg,
1422 );
1423
1424 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1425 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1426
1427 $ext{source} =
1428 "package $pkg; use common::sense;\n"
1429 . "#line 1 \"$path\"\n{\n"
1430 . $source
1431 . "\n};\n1";
1432
1433 $todo{$base} = \%ext;
1434 }
1435
1436 my $pass = 0;
1437 my %done;
1438 while (%todo) {
1439 my $progress;
1440
1441 ++$pass;
1442
1443 ext:
1444 while (my ($k, $v) = each %todo) {
1445 for (split /,\s*/, $v->{meta}{depends}) {
1446 next ext
1447 unless exists $done{$_};
1448 }
1449
1450 trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
1451
1452 my $active = eval $v->{source};
1453
1454 if (length $@) {
1455 error "$v->{path}: $@\n";
1456
1457 cf::cleanup "mandatory extension '$k' failed to load, exiting."
1458 if exists $v->{meta}{mandatory};
1459
1460 warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
1461 delete $todo{$k};
1462 } else {
1463 $done{$k} = delete $todo{$k};
1464 push @EXTS, $v->{pkg};
1465 $progress = 1;
1466
1467 info "$v->{base}: extension inactive.\n"
1468 unless $active;
1469 }
927 1 1470 }
928 } or warn "$ext not loaded: $@"; 1471
1472 unless ($progress) {
1473 warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
1474
1475 while (my ($k, $v) = each %todo) {
1476 cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
1477 if exists $v->{meta}{mandatory};
1478 }
1479 }
1480 }
929 } 1481 };
930} 1482}
931 1483
932############################################################################# 1484#############################################################################
933 1485
1486=back
1487
934=head2 CORE EXTENSIONS 1488=head2 CORE EXTENSIONS
935 1489
936Functions and methods that extend core crossfire objects. 1490Functions and methods that extend core deliantra objects.
937 1491
938=cut 1492=cut
939 1493
940package cf::player; 1494package cf::player;
941 1495
… …
943 1497
944=head3 cf::player 1498=head3 cf::player
945 1499
946=over 4 1500=over 4
947 1501
1502=item cf::player::num_playing
1503
1504Returns the official number of playing players, as per the Crossfire metaserver rules.
1505
1506=cut
1507
1508sub num_playing {
1509 scalar grep
1510 $_->ob->map
1511 && !$_->hidden
1512 && !$_->ob->flag (cf::FLAG_WIZ),
1513 cf::player::list
1514}
1515
948=item cf::player::find $login 1516=item cf::player::find $login
949 1517
950Returns the given player object, loading it if necessary (might block). 1518Returns the given player object, loading it if necessary (might block).
951 1519
952=cut 1520=cut
953 1521
954sub playerdir($) { 1522sub playerdir($) {
955 cf::localdir 1523 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1524 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1525}
961 1526
962sub path($) { 1527sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1528 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1529
965 (playerdir $login) . "/$login.pl" 1530 (playerdir $login) . "/playerdata"
966} 1531}
967 1532
968sub find_active($) { 1533sub find_active($) {
969 $cf::PLAYER{$_[0]} 1534 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1535 and $cf::PLAYER{$_[0]}->active
… …
973 1538
974sub exists($) { 1539sub exists($) {
975 my ($login) = @_; 1540 my ($login) = @_;
976 1541
977 $cf::PLAYER{$login} 1542 $cf::PLAYER{$login}
978 or cf::sync_job { !aio_stat path $login } 1543 or !aio_stat path $login
979} 1544}
980 1545
981sub find($) { 1546sub find($) {
982 return $cf::PLAYER{$_[0]} || do { 1547 return $cf::PLAYER{$_[0]} || do {
983 my $login = $_[0]; 1548 my $login = $_[0];
984 1549
985 my $guard = cf::lock_acquire "user_find:$login"; 1550 my $guard = cf::lock_acquire "user_find:$login";
986 1551
987 $cf::PLAYER{$_[0]} || do { 1552 $cf::PLAYER{$_[0]} || do {
988 my $pl = load_pl path $login 1553 # rename old playerfiles to new ones
1554 #TODO: remove when no longer required
1555 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1556 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1557 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1558 aio_unlink +(playerdir $login) . "/$login.pl";
1559
1560 my $f = new_from_file cf::object::thawer path $login
989 or return; 1561 or return;
1562
1563 my $pl = cf::player::load_pl $f
1564 or return;
1565
1566 local $cf::PLAYER_LOADING{$login} = $pl;
1567 $f->resolve_delayed_derefs;
990 $cf::PLAYER{$login} = $pl 1568 $cf::PLAYER{$login} = $pl
991 } 1569 }
992 } 1570 }
993} 1571}
1572
1573cf::player->attach (
1574 on_load => sub {
1575 my ($pl, $path) = @_;
1576
1577 # restore slots saved in save, below
1578 my $slots = delete $pl->{_slots};
1579
1580 $pl->ob->current_weapon ($slots->[0]);
1581 $pl->combat_ob ($slots->[1]);
1582 $pl->ranged_ob ($slots->[2]);
1583 },
1584);
994 1585
995sub save($) { 1586sub save($) {
996 my ($pl) = @_; 1587 my ($pl) = @_;
997 1588
998 return if $pl->{deny_save}; 1589 return if $pl->{deny_save};
… …
1003 return if $pl->{deny_save}; 1594 return if $pl->{deny_save};
1004 1595
1005 aio_mkdir playerdir $pl, 0770; 1596 aio_mkdir playerdir $pl, 0770;
1006 $pl->{last_save} = $cf::RUNTIME; 1597 $pl->{last_save} = $cf::RUNTIME;
1007 1598
1599 cf::get_slot 0.01;
1600
1601 # save slots, to be restored later
1602 local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
1603
1008 $pl->save_pl ($path); 1604 $pl->save_pl ($path);
1009 Coro::cede; 1605 cf::cede_to_tick;
1010} 1606}
1011 1607
1012sub new($) { 1608sub new($) {
1013 my ($login) = @_; 1609 my ($login) = @_;
1014 1610
… …
1020 $cf::PLAYER{$login} = $self; 1616 $cf::PLAYER{$login} = $self;
1021 1617
1022 $self 1618 $self
1023} 1619}
1024 1620
1621=item $player->send_msg ($channel, $msg, $color, [extra...])
1622
1623=cut
1624
1625sub send_msg {
1626 my $ns = shift->ns
1627 or return;
1628 $ns->send_msg (@_);
1629}
1630
1025=item $pl->quit_character 1631=item $pl->quit_character
1026 1632
1027Nukes the player without looking back. If logged in, the connection will 1633Nukes the player without looking back. If logged in, the connection will
1028be destroyed. May block for a long time. 1634be destroyed. May block for a long time.
1029 1635
1030=cut 1636=cut
1031 1637
1032sub quit_character { 1638sub quit_character {
1033 my ($pl) = @_; 1639 my ($pl) = @_;
1034 1640
1641 my $name = $pl->ob->name;
1642
1035 $pl->{deny_save} = 1; 1643 $pl->{deny_save} = 1;
1036 $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
1037 1645
1038 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1646 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1039 $pl->deactivate; 1647 $pl->deactivate;
1648 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1040 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1649 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1041 $pl->ns->destroy if $pl->ns; 1650 $pl->ns->destroy if $pl->ns;
1042 1651
1043 my $path = playerdir $pl; 1652 my $path = playerdir $pl;
1044 my $temp = "$path~$cf::RUNTIME~deleting~"; 1653 my $temp = "$path~$cf::RUNTIME~deleting~";
1045 aio_rename $path, $temp; 1654 aio_rename $path, $temp;
1046 delete $cf::PLAYER{$pl->ob->name}; 1655 delete $cf::PLAYER{$pl->ob->name};
1047 $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
1048 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;
1049} 1678}
1050 1679
1051=item cf::player::list_logins 1680=item cf::player::list_logins
1052 1681
1053Returns 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
1054while and may block, so not sync_job-capable, ever. 1683while and may block, so not sync_job-capable, ever.
1055 1684
1056=cut 1685=cut
1057 1686
1058sub list_logins { 1687sub list_logins {
1059 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1688 my $dirs = aio_readdir $PLAYERDIR
1060 or return []; 1689 or return [];
1061 1690
1062 my @logins; 1691 my @logins;
1063 1692
1064 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") {
1065 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1699 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1066 aio_read $fh, 0, 512, my $buf, 0 or next; 1700 aio_read $fh, 0, 512, my $buf, 0 or next;
1067 $buf !~ /^password -------------$/m or next; # official not-valid tag 1701 $buf !~ /^password -------------$/m or next; # official not-valid tag
1702 }
1068 1703
1069 utf8::decode $login; 1704 utf8::decode $login;
1070 push @logins, $login; 1705 push @logins, $login;
1071 } 1706 }
1072 1707
1073 \@logins 1708 \@logins
1074} 1709}
1075 1710
1076=item $player->maps 1711=item $player->maps
1712
1713=item cf::player::maps $login
1077 1714
1078Returns an arrayref of map paths that are private for this 1715Returns an arrayref of map paths that are private for this
1079player. May block. 1716player. May block.
1080 1717
1081=cut 1718=cut
… …
1099 } 1736 }
1100 1737
1101 \@paths 1738 \@paths
1102} 1739}
1103 1740
1741=item $protocol_xml = $player->expand_cfpod ($cfpod)
1742
1743Expand deliantra pod fragments into protocol xml.
1744
1104=item $player->ext_reply ($msgid, $msgtype, %msg) 1745=item $player->ext_reply ($msgid, @msg)
1105 1746
1106Sends an ext reply to the player. 1747Sends an ext reply to the player.
1107 1748
1108=cut 1749=cut
1109 1750
1110sub ext_reply($$$%) { 1751sub ext_reply($$@) {
1111 my ($self, $id, %msg) = @_; 1752 my ($self, $id, @msg) = @_;
1112 1753
1113 $msg{msgid} = $id; 1754 $self->ns->ext_reply ($id, @msg)
1114
1115 $self->send ("ext " . cf::to_json \%msg);
1116} 1755}
1117 1756
1118package 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}
1119 1799
1120=back 1800=back
1121
1122 1801
1123=head3 cf::map 1802=head3 cf::map
1124 1803
1125=over 4 1804=over 4
1126 1805
… …
1138our $MAX_RESET = 3600; 1817our $MAX_RESET = 3600;
1139our $DEFAULT_RESET = 3000; 1818our $DEFAULT_RESET = 3000;
1140 1819
1141sub generate_random_map { 1820sub generate_random_map {
1142 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
1143 # mit "rum" bekleckern, nicht 1825 # mit "rum" bekleckern, nicht
1144 $self->_create_random_map ( 1826 $self->_create_random_map (
1145 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1827 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1146 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1828 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1147 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1829 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1148 $rmp->{exit_on_final_map}, 1830 $rmp->{exit_on_final_map},
1149 $rmp->{xsize}, $rmp->{ysize}, 1831 $rmp->{xsize}, $rmp->{ysize},
1150 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1832 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1151 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1833 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
… …
1166 1848
1167sub register { 1849sub register {
1168 my (undef, $regex, $prio) = @_; 1850 my (undef, $regex, $prio) = @_;
1169 my $pkg = caller; 1851 my $pkg = caller;
1170 1852
1171 no strict;
1172 push @{"$pkg\::ISA"}, __PACKAGE__; 1853 push @{"$pkg\::ISA"}, __PACKAGE__;
1173 1854
1174 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1855 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1175} 1856}
1176 1857
1177# also paths starting with '/' 1858# also paths starting with '/'
1178$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1859$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1179 1860
1180sub thawer_merge { 1861sub thawer_merge {
1181 my ($self, $merge) = @_; 1862 my ($self, $merge) = @_;
1182 1863
1183 # we have to keep some variables in memory intact 1864 # we have to keep some variables in memory intact
1184 local $self->{path}; 1865 local $self->{path};
1185 local $self->{load_path}; 1866 local $self->{load_path};
1186 local $self->{deny_save};
1187 local $self->{deny_reset};
1188 1867
1189 $self->SUPER::thawer_merge ($merge); 1868 $self->SUPER::thawer_merge ($merge);
1190} 1869}
1191 1870
1192sub normalise { 1871sub normalise {
… …
1239 $self->init; # pass $1 etc. 1918 $self->init; # pass $1 etc.
1240 return $self; 1919 return $self;
1241 } 1920 }
1242 } 1921 }
1243 1922
1244 Carp::carp "unable to resolve path '$path' (base '$base')."; 1923 Carp::cluck "unable to resolve path '$path' (base '$base').";
1245 () 1924 ()
1246} 1925}
1247 1926
1248sub init { 1927sub init {
1249 my ($self) = @_; 1928 my ($self) = @_;
… …
1264 1943
1265# the original (read-only) location 1944# the original (read-only) location
1266sub load_path { 1945sub load_path {
1267 my ($self) = @_; 1946 my ($self) = @_;
1268 1947
1269 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1948 "$MAPDIR/$self->{path}.map"
1270} 1949}
1271 1950
1272# the temporary/swap location 1951# the temporary/swap location
1273sub save_path { 1952sub save_path {
1274 my ($self) = @_; 1953 my ($self) = @_;
1275 1954
1276 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1955 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1277 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1956 "$TMPDIR/$path.map"
1278} 1957}
1279 1958
1280# the unique path, undef == no special unique path 1959# the unique path, undef == no special unique path
1281sub uniq_path { 1960sub uniq_path {
1282 my ($self) = @_; 1961 my ($self) = @_;
1283 1962
1284 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1963 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1285 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1964 "$UNIQUEDIR/$path"
1286} 1965}
1287 1966
1288# and all this just because we cannot iterate over 1967sub decay_objects {
1289# all maps in C++...
1290sub change_all_map_light {
1291 my ($change) = @_; 1968 my ($self) = @_;
1292 1969
1293 $_->change_map_light ($change) 1970 return if $self->{deny_reset};
1294 for grep $_->outdoor, values %cf::MAP; 1971
1972 $self->do_decay_objects;
1295} 1973}
1296 1974
1297sub unlink_save { 1975sub unlink_save {
1298 my ($self) = @_; 1976 my ($self) = @_;
1299 1977
… …
1304 1982
1305sub load_header_from($) { 1983sub load_header_from($) {
1306 my ($self, $path) = @_; 1984 my ($self, $path) = @_;
1307 1985
1308 utf8::encode $path; 1986 utf8::encode $path;
1309 #aio_open $path, O_RDONLY, 0 1987 my $f = new_from_file cf::object::thawer $path
1310 # or return;
1311
1312 $self->_load_header ($path)
1313 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;
1314 1995
1315 $self->{load_path} = $path; 1996 $self->{load_path} = $path;
1316 1997
1317 1 1998 1
1318} 1999}
… …
1357 $self->load_header_orig 2038 $self->load_header_orig
1358 or return; 2039 or return;
1359 $self->prepare_orig; 2040 $self->prepare_orig;
1360 } 2041 }
1361 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
1362 1 2049 1
1363} 2050}
1364 2051
1365sub find; 2052sub find;
1366sub find { 2053sub find {
1367 my ($path, $origin) = @_; 2054 my ($path, $origin) = @_;
1368 2055
1369 $path = normalise $path, $origin && $origin->path; 2056 $path = normalise $path, $origin && $origin->path;
1370 2057
2058 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1371 cf::lock_wait "map_find:$path"; 2059 my $guard2 = cf::lock_acquire "map_find:$path";
1372 2060
1373 $cf::MAP{$path} || do { 2061 $cf::MAP{$path} || do {
1374 my $guard = cf::lock_acquire "map_find:$path";
1375 my $map = new_from_path cf::map $path 2062 my $map = new_from_path cf::map $path
1376 or return; 2063 or return;
1377 2064
1378 $map->{last_save} = $cf::RUNTIME; 2065 $map->{last_save} = $cf::RUNTIME;
1379 2066
1380 $map->load_header 2067 $map->load_header
1381 or return; 2068 or return;
1382 2069
1383 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2070 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1384 # doing this can freeze the server in a sync job, obviously 2071 # doing this can freeze the server in a sync job, obviously
1385 #$cf::WAIT_FOR_TICK->wait; 2072 #$cf::WAIT_FOR_TICK->wait;
2073 undef $guard2;
2074 undef $guard1;
1386 $map->reset; 2075 $map->reset;
1387 undef $guard;
1388 return find $path; 2076 return find $path;
1389 } 2077 }
1390 2078
1391 $cf::MAP{$path} = $map 2079 $cf::MAP{$path} = $map
1392 } 2080 }
1393} 2081}
1394 2082
1395sub pre_load { } 2083sub pre_load { }
1396sub post_load { } 2084#sub post_load { } # XS
1397 2085
1398sub load { 2086sub load {
1399 my ($self) = @_; 2087 my ($self) = @_;
1400 2088
1401 local $self->{deny_reset} = 1; # loading can take a long time 2089 local $self->{deny_reset} = 1; # loading can take a long time
1402 2090
1403 my $path = $self->{path}; 2091 my $path = $self->{path};
2092
2093 {
1404 my $guard = cf::lock_acquire "map_load:$path"; 2094 my $guard = cf::lock_acquire "map_data:$path";
1405 2095
2096 return unless $self->valid;
1406 return if $self->in_memory != cf::MAP_SWAPPED; 2097 return unless $self->in_memory == cf::MAP_SWAPPED;
1407 2098
1408 $self->in_memory (cf::MAP_LOADING); 2099 $self->in_memory (cf::MAP_LOADING);
1409 2100
1410 $self->alloc; 2101 $self->alloc;
1411 2102
1412 $self->pre_load; 2103 $self->pre_load;
2104 cf::cede_to_tick;
1413 2105
1414 $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)
1415 or return; 2109 or return;
1416 2110
1417 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2111 $self->post_load_original
1418 if delete $self->{load_original}; 2112 if delete $self->{load_original};
1419 2113
1420 if (my $uniq = $self->uniq_path) { 2114 if (my $uniq = $self->uniq_path) {
1421 utf8::encode $uniq; 2115 utf8::encode $uniq;
1422 if (aio_open $uniq, O_RDONLY, 0) { 2116 unless (aio_stat $uniq) {
2117 if (my $f = new_from_file cf::object::thawer $uniq) {
1423 $self->clear_unique_items; 2118 $self->clear_unique_items;
1424 $self->_load_objects ($uniq, 0); 2119 $self->_load_objects ($f);
2120 $f->resolve_delayed_derefs;
2121 }
1425 } 2122 }
1426 } 2123 }
1427 2124
1428 Coro::cede; 2125 $f->resolve_delayed_derefs;
1429 2126
2127 cf::cede_to_tick;
1430 # now do the right thing for maps 2128 # now do the right thing for maps
1431 $self->link_multipart_objects; 2129 $self->link_multipart_objects;
1432
1433 unless ($self->{deny_activate}) {
1434 $self->decay_objects;
1435 $self->fix_auto_apply;
1436 $self->update_buttons;
1437 Coro::cede;
1438 $self->set_darkness_map;
1439 $self->difficulty ($self->estimate_difficulty) 2130 $self->difficulty ($self->estimate_difficulty)
1440 unless $self->difficulty; 2131 unless $self->difficulty;
1441 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;
1442 $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);
1443 } 2146 }
1444 2147
1445 $self->post_load; 2148 $self->post_load;
1446
1447 $self->in_memory (cf::MAP_IN_MEMORY);
1448} 2149}
1449 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
1450sub customise_for { 2154sub customise_for {
1451 my ($self, $ob) = @_; 2155 my ($self, $ob) = @_;
1452 2156
1453 return find "~" . $ob->name . "/" . $self->{path} 2157 return find "~" . $ob->name . "/" . $self->{path}
1454 if $self->per_player; 2158 if $self->per_player;
1455 2159
2160# return find "?party/" . $ob->name . "/" . $self->{path}
2161# if $self->per_party;
2162
1456 $self 2163 $self
1457} 2164}
1458 2165
1459# 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
1460sub load_diag { 2167sub load_neighbours {
1461 my ($map) = @_; 2168 my ($map) = @_;
1462 2169
1463 my @diag; # diagonal neighbours 2170 my @neigh; # diagonal neighbours
1464 2171
1465 for (0 .. 3) { 2172 for (0 .. 3) {
1466 my $neigh = $map->tile_path ($_) 2173 my $neigh = $map->tile_path ($_)
1467 or next; 2174 or next;
1468 $neigh = find $neigh, $map 2175 $neigh = find $neigh, $map
1469 or next; 2176 or next;
1470 $neigh->load; 2177 $neigh->load;
1471 2178
2179 # now find the diagonal neighbours
2180 push @neigh,
1472 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2181 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1473 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2182 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1474 } 2183 }
1475 2184
1476 for (@diag) { 2185 for (grep defined $_->[0], @neigh) {
2186 my ($path, $origin) = @$_;
1477 my $neigh = find @$_ 2187 my $neigh = find $path, $origin
1478 or next; 2188 or next;
1479 $neigh->load; 2189 $neigh->load;
1480 } 2190 }
1481} 2191}
1482 2192
1483sub find_sync { 2193sub find_sync {
1484 my ($path, $origin) = @_; 2194 my ($path, $origin) = @_;
1485 2195
1486 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
1487} 2200}
1488 2201
1489sub do_load_sync { 2202sub do_load_sync {
1490 my ($map) = @_; 2203 my ($map) = @_;
1491 2204
1492 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;
1493} 2209}
1494 2210
1495our %MAP_PREFETCH; 2211our %MAP_PREFETCH;
1496our $MAP_PREFETCHER = undef; 2212our $MAP_PREFETCHER = undef;
1497 2213
1498sub find_async { 2214sub find_async {
1499 my ($path, $origin) = @_; 2215 my ($path, $origin, $load) = @_;
1500 2216
1501 $path = normalise $path, $origin && $origin->{path}; 2217 $path = normalise $path, $origin && $origin->{path};
1502 2218
1503 if (my $map = $cf::MAP{$path}) { 2219 if (my $map = $cf::MAP{$path}) {
1504 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2220 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1505 } 2221 }
1506 2222
1507 undef $MAP_PREFETCH{$path}; 2223 $MAP_PREFETCH{$path} |= $load;
2224
1508 $MAP_PREFETCHER ||= cf::async { 2225 $MAP_PREFETCHER ||= cf::async {
2226 $Coro::current->{desc} = "map prefetcher";
2227
1509 while (%MAP_PREFETCH) { 2228 while (%MAP_PREFETCH) {
1510 for my $path (keys %MAP_PREFETCH) { 2229 while (my ($k, $v) = each %MAP_PREFETCH) {
1511 my $map = find $path 2230 if (my $map = find $k) {
1512 or next;
1513 $map->load; 2231 $map->load if $v;
2232 }
1514 2233
1515 delete $MAP_PREFETCH{$path}; 2234 delete $MAP_PREFETCH{$k};
1516 } 2235 }
1517 } 2236 }
1518 undef $MAP_PREFETCHER; 2237 undef $MAP_PREFETCHER;
1519 }; 2238 };
1520 $MAP_PREFETCHER->prio (6); 2239 $MAP_PREFETCHER->prio (6);
1521 2240
1522 () 2241 ()
1523} 2242}
1524 2243
2244# common code, used by both ->save and ->swapout
1525sub save { 2245sub _save {
1526 my ($self) = @_; 2246 my ($self) = @_;
1527
1528 my $lock = cf::lock_acquire "map_data:" . $self->path;
1529 2247
1530 $self->{last_save} = $cf::RUNTIME; 2248 $self->{last_save} = $cf::RUNTIME;
1531 2249
1532 return unless $self->dirty; 2250 return unless $self->dirty;
1533 2251
… …
1539 return if $self->{deny_save}; 2257 return if $self->{deny_save};
1540 2258
1541 local $self->{last_access} = $self->last_access;#d# 2259 local $self->{last_access} = $self->last_access;#d#
1542 2260
1543 cf::async { 2261 cf::async {
2262 $Coro::current->{desc} = "map player save";
1544 $_->contr->save for $self->players; 2263 $_->contr->save for $self->players;
1545 }; 2264 };
2265
2266 cf::get_slot 0.02;
1546 2267
1547 if ($uniq) { 2268 if ($uniq) {
1548 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2269 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1549 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2270 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1550 } else { 2271 } else {
1551 $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);
1552 } 2273 }
1553} 2274}
1554 2275
2276sub save {
2277 my ($self) = @_;
2278
2279 my $lock = cf::lock_acquire "map_data:$self->{path}";
2280
2281 $self->_save;
2282}
2283
1555sub swap_out { 2284sub swap_out {
1556 my ($self) = @_; 2285 my ($self) = @_;
1557 2286
1558 # save first because save cedes
1559 $self->save;
1560
1561 my $lock = cf::lock_acquire "map_data:" . $self->path; 2287 my $lock = cf::lock_acquire "map_data:$self->{path}";
1562 2288
2289 return if $self->in_memory != cf::MAP_ACTIVE;
2290 return if $self->{deny_save};
1563 return if $self->players; 2291 return if $self->players;
1564 return if $self->in_memory != cf::MAP_IN_MEMORY;
1565 return if $self->{deny_save};
1566 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
1567 $self->clear; 2302 $self->clear;
1568 $self->in_memory (cf::MAP_SWAPPED);
1569} 2303}
1570 2304
1571sub reset_at { 2305sub reset_at {
1572 my ($self) = @_; 2306 my ($self) = @_;
1573 2307
1574 # TODO: safety, remove and allow resettable per-player maps 2308 # TODO: safety, remove and allow resettable per-player maps
1575 return 1e99 if $self->isa ("ext::map_per_player");#d#
1576 return 1e99 if $self->{deny_reset}; 2309 return 1e99 if $self->{deny_reset};
1577 2310
1578 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2311 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1579 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;
1580 2313
… …
1591 my ($self) = @_; 2324 my ($self) = @_;
1592 2325
1593 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2326 my $lock = cf::lock_acquire "map_data:$self->{path}";
1594 2327
1595 return if $self->players; 2328 return if $self->players;
1596 return if $self->isa ("ext::map_per_player");#d#
1597 2329
1598 warn "resetting map ", $self->path;#d# 2330 cf::trace "resetting map ", $self->path, "\n";
1599 2331
1600 $self->in_memory (cf::MAP_SWAPPED); 2332 $self->in_memory (cf::MAP_SWAPPED);
1601 2333
1602 # need to save uniques path 2334 # need to save uniques path
1603 unless ($self->{deny_save}) { 2335 unless ($self->{deny_save}) {
… …
1607 if $uniq; 2339 if $uniq;
1608 } 2340 }
1609 2341
1610 delete $cf::MAP{$self->path}; 2342 delete $cf::MAP{$self->path};
1611 2343
2344 $self->deactivate;
2345 $_->clear_links_to ($self) for values %cf::MAP;
1612 $self->clear; 2346 $self->clear;
1613
1614 $_->clear_links_to ($self) for values %cf::MAP;
1615 2347
1616 $self->unlink_save; 2348 $self->unlink_save;
1617 $self->destroy; 2349 $self->destroy;
1618} 2350}
1619 2351
1620my $nuke_counter = "aaaa"; 2352my $nuke_counter = "aaaa";
1621 2353
1622sub nuke { 2354sub nuke {
1623 my ($self) = @_; 2355 my ($self) = @_;
1624 2356
2357 {
2358 my $lock = cf::lock_acquire "map_data:$self->{path}";
2359
1625 delete $cf::MAP{$self->path}; 2360 delete $cf::MAP{$self->path};
1626 2361
1627 $self->unlink_save; 2362 $self->unlink_save;
1628 2363
1629 bless $self, "cf::map"; 2364 bless $self, "cf::map::wrap";
1630 delete $self->{deny_reset}; 2365 delete $self->{deny_reset};
1631 $self->{deny_save} = 1; 2366 $self->{deny_save} = 1;
1632 $self->reset_timeout (1); 2367 $self->reset_timeout (1);
1633 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2368 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1634 2369
1635 $cf::MAP{$self->path} = $self; 2370 $cf::MAP{$self->path} = $self;
2371 }
1636 2372
1637 $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 ]
1638} 2410}
1639 2411
1640=item cf::map::unique_maps 2412=item cf::map::unique_maps
1641 2413
1642Returns an arrayref of paths of all shared maps that have 2414Returns an arrayref of paths of all shared maps that have
1643instantiated unique items. May block. 2415instantiated unique items. May block.
1644 2416
1645=cut 2417=cut
1646 2418
1647sub unique_maps() { 2419sub unique_maps() {
1648 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2420 [
1649 or return; 2421 map {
1650
1651 my @paths;
1652
1653 for (@$files) {
1654 utf8::decode $_; 2422 utf8::decode $_;
1655 next if /\.pst$/; 2423 s/\.map$//; # TODO future compatibility hack
1656 next unless /^$PATH_SEP/o; 2424 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1657 2425 ? ()
1658 push @paths, cf::map::normalise $_; 2426 : normalise $_
2427 } @{ aio_readdir $UNIQUEDIR or [] }
1659 } 2428 ]
1660
1661 \@paths
1662} 2429}
1663 2430
1664package 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}
1665 2462
1666=back 2463=back
1667 2464
1668=head3 cf::object 2465=head3 cf::object
1669 2466
… …
1673 2470
1674=over 4 2471=over 4
1675 2472
1676=item $ob->inv_recursive 2473=item $ob->inv_recursive
1677 2474
1678Returns 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.
1679 2477
1680=cut 2478=cut
1681 2479
1682sub inv_recursive_; 2480sub inv_recursive_;
1683sub inv_recursive_ { 2481sub inv_recursive_ {
… …
1686 2484
1687sub inv_recursive { 2485sub inv_recursive {
1688 inv_recursive_ inv $_[0] 2486 inv_recursive_ inv $_[0]
1689} 2487}
1690 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
1691package cf; 2517package cf;
1692 2518
1693=back 2519=back
1694 2520
1695=head3 cf::object::player 2521=head3 cf::object::player
… …
1701Sends 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>
1702can 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
1703dialogue with the given NPC character. 2529dialogue with the given NPC character.
1704 2530
1705=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};
1706 2546
1707# rough implementation of a future "reply" method that works 2547# rough implementation of a future "reply" method that works
1708# with dialog boxes. 2548# with dialog boxes.
1709#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
1710sub cf::object::player::reply($$$;$) { 2550sub cf::object::player::reply($$$;$) {
… …
1712 2552
1713 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2553 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1714 2554
1715 if ($self->{record_replies}) { 2555 if ($self->{record_replies}) {
1716 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2556 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2557
1717 } 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 {
1718 $msg = $npc->name . " says: $msg" if $npc; 2566 $msg = $npc->name . " says: $msg" if $npc;
1719 $self->message ($msg, $flags); 2567 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2568 }
1720 } 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 (@_);
1721} 2580}
1722 2581
1723=item $player_object->may ("access") 2582=item $player_object->may ("access")
1724 2583
1725Returns wether the given player is authorized to access resource "access" 2584Returns wether the given player is authorized to access resource "access"
… …
1738 2597
1739=item $player_object->enter_link 2598=item $player_object->enter_link
1740 2599
1741Freezes 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}>).
1742 2601
1743The 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.
1744I<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.
1745 2606
1746Will never block. 2607Will never block.
1747 2608
1748=item $player_object->leave_link ($map, $x, $y) 2609=item $player_object->leave_link ($map, $x, $y)
1749 2610
… …
1769sub cf::object::player::enter_link { 2630sub cf::object::player::enter_link {
1770 my ($self) = @_; 2631 my ($self) = @_;
1771 2632
1772 $self->deactivate_recursive; 2633 $self->deactivate_recursive;
1773 2634
2635 ++$self->{_link_recursion};
2636
1774 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2637 return if UNIVERSAL::isa $self->map, "ext::map_link";
1775 2638
1776 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2639 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1777 if $self->map; 2640 if $self->map && $self->map->{path} ne "{link}";
1778 2641
1779 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2642 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1780} 2643}
1781 2644
1782sub cf::object::player::leave_link { 2645sub cf::object::player::leave_link {
1783 my ($self, $map, $x, $y) = @_; 2646 my ($self, $map, $x, $y) = @_;
2647
2648 return unless $self->contr->active;
1784 2649
1785 my $link_pos = delete $self->{_link_pos}; 2650 my $link_pos = delete $self->{_link_pos};
1786 2651
1787 unless ($map) { 2652 unless ($map) {
1788 # restore original map position 2653 # restore original map position
… …
1799 ($x, $y) = (-1, -1) 2664 ($x, $y) = (-1, -1)
1800 unless (defined $x) && (defined $y); 2665 unless (defined $x) && (defined $y);
1801 2666
1802 # use -1 or undef as default coordinates, not 0, 0 2667 # use -1 or undef as default coordinates, not 0, 0
1803 ($x, $y) = ($map->enter_x, $map->enter_y) 2668 ($x, $y) = ($map->enter_x, $map->enter_y)
1804 if $x <=0 && $y <= 0; 2669 if $x <= 0 && $y <= 0;
1805 2670
1806 $map->load; 2671 $map->load;
1807 $map->load_diag; 2672 $map->load_neighbours;
1808 2673
1809 return unless $self->contr->active; 2674 return unless $self->contr->active;
1810 $self->activate_recursive;
1811 2675
1812 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2676 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2677 if ($self->enter_map ($map, $x, $y)) {
1814} 2678 # entering was successful
1815 2679 delete $self->{_link_recursion};
1816cf::player->attach ( 2680 # only activate afterwards, to support waiting in hooks
1817 on_logout => sub { 2681 $self->activate_recursive;
1818 my ($pl) = @_;
1819
1820 # abort map switching before logout
1821 if ($pl->ob->{_link_pos}) {
1822 cf::sync_job {
1823 $pl->ob->leave_link
1824 };
1825 }
1826 }, 2682 }
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2683
1830 # try to abort aborted map switching on player login :) 2684}
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 $pl->ob->reply (undef,
1836 "There was an internal problem at your last logout, "
1837 . "the server will try to bring you to your intended destination in a second.",
1838 cf::NDI_RED);
1839 # we need this sleep as the login has a concurrent enter_exit running
1840 # and this sleep increases chances of the player not ending up in scorn
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847 2685
1848=item $player_object->goto ($path, $x, $y) 2686=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1849 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
1850=cut 2697=cut
2698
2699our $GOTOGEN;
1851 2700
1852sub cf::object::player::goto { 2701sub cf::object::player::goto {
1853 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;
1854 2712
1855 $self->enter_link; 2713 $self->enter_link;
1856 2714
1857 (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
1858 my $map = eval { 2737 my $map = eval {
1859 my $map = cf::map::find $path; 2738 my $map = defined $path ? cf::map::find $path : undef;
2739
2740 if ($map) {
1860 $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
1861 $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 $@;
1862 } or 2753 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2754
2755 if ($gen == $self->{_goto_generation}) {
2756 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2757 $self->leave_link ($map, $x, $y);
2758 }
2759
2760 $done->($self) if $done;
1866 })->prio (1); 2761 })->prio (1);
1867} 2762}
1868 2763
1869=item $player_object->enter_exit ($exit_object) 2764=item $player_object->enter_exit ($exit_object)
1870 2765
… …
1890} 2785}
1891 2786
1892sub prepare_random_map { 2787sub prepare_random_map {
1893 my ($exit) = @_; 2788 my ($exit) = @_;
1894 2789
1895 my $guard = cf::lock_acquire "exit_prepare:$exit";
1896
1897 # all this does is basically replace the /! path by 2790 # all this does is basically replace the /! path by
1898 # a new random map path (?random/...) with a seed 2791 # a new random map path (?random/...) with a seed
1899 # that depends on the exit object 2792 # that depends on the exit object
1900 2793
1901 my $rmp = parse_random_map_params $exit->msg; 2794 my $rmp = parse_random_map_params $exit->msg;
… …
1903 if ($exit->map) { 2796 if ($exit->map) {
1904 $rmp->{region} = $exit->region->name; 2797 $rmp->{region} = $exit->region->name;
1905 $rmp->{origin_map} = $exit->map->path; 2798 $rmp->{origin_map} = $exit->map->path;
1906 $rmp->{origin_x} = $exit->x; 2799 $rmp->{origin_x} = $exit->x;
1907 $rmp->{origin_y} = $exit->y; 2800 $rmp->{origin_y} = $exit->y;
2801
2802 $exit->map->touch;
1908 } 2803 }
1909 2804
1910 $rmp->{random_seed} ||= $exit->random_seed; 2805 $rmp->{random_seed} ||= $exit->random_seed;
1911 2806
1912 my $data = cf::to_json $rmp; 2807 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1913 my $md5 = Digest::MD5::md5_hex $data; 2808 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2809 my $meta = "$RANDOMDIR/$md5.meta";
1915 2810
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2811 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2812 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2813 undef $fh;
1919 aio_rename "$meta~", $meta; 2814 aio_rename "$meta~", $meta;
1920 2815
2816 my $slaying = "?random/$md5";
2817
2818 if ($exit->valid) {
1921 $exit->slaying ("?random/$md5"); 2819 $exit->slaying ("?random/$md5");
1922 $exit->msg (undef); 2820 $exit->msg (undef);
2821 }
1923 } 2822 }
1924} 2823}
1925 2824
1926sub cf::object::player::enter_exit { 2825sub cf::object::player::enter_exit {
1927 my ($self, $exit) = @_; 2826 my ($self, $exit) = @_;
1928 2827
1929 return unless $self->type == cf::PLAYER; 2828 return unless $self->type == cf::PLAYER;
1930 2829
1931 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job
1933 cf::sync_job { prepare_random_map $exit };
1934 }
1935
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp;
1939
1940 $self->enter_link; 2830 $self->enter_link;
1941 2831
1942 (async { 2832 (async {
1943 $self->deactivate_recursive; # just to be sure 2833 $Coro::current->{desc} = "enter_exit";
2834
1944 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
1945 $self->goto ($slaying, $hp, $sp); 2850 $self->goto ($map, $x, $y);
1946 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
1947 1; 2856 1
1948 }) { 2857 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2858 $self->message ("Something went wrong deep within the deliantra server. "
1950 . "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. "
1951 . "Please report this to the dungeon master!", 2860 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2861 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2862
1954 warn "ERROR in enter_exit: $@"; 2863 error "ERROR in enter_exit: $@";
1955 $self->leave_link; 2864 $self->leave_link;
1956 } 2865 }
1957 })->prio (1); 2866 })->prio (1);
1958} 2867}
1959 2868
… …
1970 2879
1971sub cf::client::send_drawinfo { 2880sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2881 my ($self, $text, $flags) = @_;
1973 2882
1974 utf8::encode $text; 2883 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2884 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2885}
1977 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}
1978 3108
1979=item $success = $client->query ($flags, "text", \&cb) 3109=item $success = $client->query ($flags, "text", \&cb)
1980 3110
1981Queues a query to the client, calling the given callback with 3111Queues a query to the client, calling the given callback with
1982the 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>,
1983C<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>.
1984 3114
1985Queries 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
1986reliable at some point in the future. 3116become reliable at some point in the future.
1987 3117
1988=cut 3118=cut
1989 3119
1990sub cf::client::query { 3120sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 3121 my ($self, $flags, $text, $cb) = @_;
… …
1999 utf8::encode $text; 3129 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3130 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 3131
2002 $self->send_packet ($self->{query_queue}[0][0]) 3132 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 3133 if @{ $self->{query_queue} } == 1;
3134
3135 1
2004} 3136}
2005 3137
2006cf::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 },
2007 on_reply => sub { 3144 on_reply => sub {
2008 my ($ns, $msg) = @_; 3145 my ($ns, $msg) = @_;
2009 3146
2010 # this weird shuffling is so that direct followup queries 3147 # this weird shuffling is so that direct followup queries
2011 # get handled first 3148 # get handled first
… …
2023 } else { 3160 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3161 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 3162 }
2026 } 3163 }
2027 }, 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 },
2028); 3191);
2029 3192
2030=item $client->async (\&cb) 3193=item $client->async (\&cb)
2031 3194
2032Create a new coroutine, running the specified callback. The coroutine will 3195Create a new coroutine, running the specified callback. The coroutine will
… …
2048 3211
2049 $coro 3212 $coro
2050} 3213}
2051 3214
2052cf::client->attach ( 3215cf::client->attach (
2053 on_destroy => sub { 3216 on_client_destroy => sub {
2054 my ($ns) = @_; 3217 my ($ns) = @_;
2055 3218
2056 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3219 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2057 }, 3220 },
2058); 3221);
… …
2073our $safe = new Safe "safe"; 3236our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 3237our $safe_hole = new Safe::Hole;
2075 3238
2076$SIG{FPE} = 'IGNORE'; 3239$SIG{FPE} = 'IGNORE';
2077 3240
2078$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));
2079 3246
2080# here we export the classes and methods available to script code 3247# here we export the classes and methods available to script code
2081 3248
2082=pod 3249=pod
2083 3250
2084The following fucntions and emthods are available within a safe environment: 3251The following functions and methods are available within a safe environment:
2085 3252
2086 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
2087 cf::object::player player 3258 cf::object::player
2088 cf::player peaceful 3259 player
2089 cf::map trigger 3260
3261 cf::player
3262 peaceful
3263
3264 cf::map
3265 trigger
2090 3266
2091=cut 3267=cut
2092 3268
2093for ( 3269for (
2094 ["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)],
2095 ["cf::object::player" => qw(player)], 3273 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 3274 ["cf::player" => qw(peaceful send_msg)],
2097 ["cf::map" => qw(trigger)], 3275 ["cf::map" => qw(trigger)],
2098) { 3276) {
2099 no strict 'refs';
2100 my ($pkg, @funs) = @$_; 3277 my ($pkg, @funs) = @$_;
2101 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3278 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2102 for @funs; 3279 for @funs;
2103} 3280}
2104 3281
… …
2119 3296
2120 my $qcode = $code; 3297 my $qcode = $code;
2121 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3298 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2122 $qcode =~ s/\n/\\n/g; 3299 $qcode =~ s/\n/\\n/g;
2123 3300
3301 %vars = (_dummy => 0) unless %vars;
3302
3303 my @res;
2124 local $_; 3304 local $_;
2125 local @safe::cf::_safe_eval_args = values %vars;
2126 3305
2127 my $eval = 3306 my $eval =
2128 "do {\n" 3307 "do {\n"
2129 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3308 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2130 . "#line 0 \"{$qcode}\"\n" 3309 . "#line 0 \"{$qcode}\"\n"
2131 . $code 3310 . $code
2132 . "\n}" 3311 . "\n}"
2133 ; 3312 ;
2134 3313
3314 if ($CFG{safe_eval}) {
2135 sub_generation_inc; 3315 sub_generation_inc;
3316 local @safe::cf::_safe_eval_args = values %vars;
2136 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3317 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2137 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 }
2138 3323
2139 if ($@) { 3324 if ($@) {
2140 warn "$@"; 3325 warn "$@",
2141 warn "while executing safe code '$code'\n"; 3326 "while executing safe code '$code'\n",
2142 warn "with arguments " . (join " ", %vars) . "\n"; 3327 "with arguments " . (join " ", %vars) . "\n";
2143 } 3328 }
2144 3329
2145 wantarray ? @res : $res[0] 3330 wantarray ? @res : $res[0]
2146} 3331}
2147 3332
… …
2161=cut 3346=cut
2162 3347
2163sub register_script_function { 3348sub register_script_function {
2164 my ($fun, $cb) = @_; 3349 my ($fun, $cb) = @_;
2165 3350
2166 no strict 'refs'; 3351 $fun = "safe::$fun" if $CFG{safe_eval};
2167 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3352 *$fun = $safe_hole->wrap ($cb);
2168} 3353}
2169 3354
2170=back 3355=back
2171 3356
2172=cut 3357=cut
2173
2174#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $value = cf::db_get $family => $key
2188
2189Returns a single value from the database.
2190
2191=item cf::db_put $family => $key => $value
2192
2193Stores the given C<$value> in the family.
2194
2195=cut
2196
2197our $DB;
2198
2199sub db_init {
2200 unless ($DB) {
2201 $DB = BDB::db_create $DB_ENV;
2202
2203 cf::sync_job {
2204 eval {
2205 $DB->set_flags (BDB::CHKSUM);
2206
2207 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2208 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2209 cf::cleanup "db_open(db): $!" if $!;
2210 };
2211 cf::cleanup "db_open(db): $@" if $@;
2212 };
2213
2214 my $path = cf::localdir . "/database.pst";
2215 if (stat $path) {
2216 cf::sync_job {
2217 my $pst = Storable::retrieve $path;
2218
2219 cf::db_put (board => data => $pst->{board});
2220 cf::db_put (guildrules => data => $pst->{guildrules});
2221 cf::db_put (rent => balance => $pst->{rent}{balance});
2222 BDB::db_env_txn_checkpoint $DB_ENV;
2223
2224 unlink $path;
2225 };
2226 }
2227 }
2228}
2229
2230sub db_get($$) {
2231 my $key = "$_[0]/$_[1]";
2232
2233 cf::sync_job {
2234 BDB::db_get $DB, undef, $key, my $data;
2235
2236 $! ? ()
2237 : Compress::LZF::sthaw $data
2238 }
2239}
2240
2241sub db_put($$$) {
2242 BDB::dbreq_pri 4;
2243 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2244}
2245 3358
2246############################################################################# 3359#############################################################################
2247# the server's init and main functions 3360# the server's init and main functions
2248 3361
2249sub init_resources { 3362# async inc loader. yay.
2250 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 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
3505sub load_resource_file($) {
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"
2251 or die "unable to load regions file\n";#d# 3521 or die "unable to load regions file\n";
2252}
2253 3522
2254sub 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
2255 open my $fh, "<:utf8", cf::confdir . "/config" 3582 open my $fh, "<:utf8", "$CONFDIR/config"
2256 or return; 3583 or return;
2257 3584
2258 local $/; 3585 local $/;
2259 *CFG = YAML::Syck::Load <$fh>; 3586 *CFG = YAML::XS::Load scalar <$fh>;
2260 3587
2261 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3588 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2262 3589
2263 $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};
2264 $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};
2265 3592
2266 if (exists $CFG{mlockall}) { 3593 if (exists $CFG{mlockall}) {
… …
2268 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3595 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2269 and die "WARNING: m(un)lockall failed: $!\n"; 3596 and die "WARNING: m(un)lockall failed: $!\n";
2270 }; 3597 };
2271 warn $@ if $@; 3598 warn $@ if $@;
2272 } 3599 }
2273}
2274 3600
2275sub init { 3601 trace "finished reloading resource files\n";
2276 init_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;
2277} 3630}
2278 3631
2279sub 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
2280 # we must not ever block the main coroutine 3642 # we must not ever block the main coroutine
2281 local $Coro::idle = sub { 3643 local $Coro::idle = sub {
2282 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#
2283 (async { 3645 (async {
2284 Event::one_event; 3646 $Coro::current->{desc} = "IDLE BUG HANDLER";
3647 EV::loop EV::LOOP_ONESHOT;
2285 })->prio (Coro::PRIO_MAX); 3648 })->prio (Coro::PRIO_MAX);
2286 }; 3649 };
2287 3650
2288 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;
2289 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
2290 load_extensions; 3676 load_extensions;
2291 3677
2292 $TICK_WATCHER->start; 3678 utime time, time, $RUNTIMEFILE;
2293 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;
2294} 3696}
2295 3697
2296############################################################################# 3698#############################################################################
2297# initialisation and cleanup 3699# initialisation and cleanup
2298 3700
2299# install some emergency cleanup handlers 3701# install some emergency cleanup handlers
2300BEGIN { 3702BEGIN {
3703 our %SIGWATCHER = ();
2301 for my $signal (qw(INT HUP TERM)) { 3704 for my $signal (qw(INT HUP TERM)) {
2302 Event->signal ( 3705 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2303 reentrant => 0,
2304 data => WF_AUTOCANCEL,
2305 signal => $signal,
2306 prio => 0,
2307 cb => sub {
2308 cf::cleanup "SIG$signal"; 3706 cf::cleanup "SIG$signal";
2309 },
2310 ); 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
2311 } 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 };
2312} 3797}
2313 3798
2314sub emergency_save() { 3799sub emergency_save() {
2315 my $freeze_guard = cf::freeze_mainloop; 3800 my $freeze_guard = cf::freeze_mainloop;
2316 3801
2317 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;
2318 3808
2319 cf::sync_job { 3809 cf::sync_job {
3810 cf::write_runtime_sync; # external watchdog should not bark
3811
2320 # use a peculiar iteration method to avoid tripping on perl 3812 # use a peculiar iteration method to avoid tripping on perl
2321 # refcount bugs in for. also avoids problems with players 3813 # refcount bugs in for. also avoids problems with players
2322 # and maps saved/destroyed asynchronously. 3814 # and maps saved/destroyed asynchronously.
2323 warn "begin emergency player save\n"; 3815 info "emergency_perl_save: begin player save\n";
2324 for my $login (keys %cf::PLAYER) { 3816 for my $login (keys %cf::PLAYER) {
2325 my $pl = $cf::PLAYER{$login} or next; 3817 my $pl = $cf::PLAYER{$login} or next;
2326 $pl->valid or next; 3818 $pl->valid or next;
3819 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2327 $pl->save; 3820 $pl->save;
2328 } 3821 }
2329 warn "end emergency player save\n"; 3822 info "emergency_perl_save: end player save\n";
2330 3823
2331 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";
2332 for my $path (keys %cf::MAP) { 3827 for my $path (keys %cf::MAP) {
2333 my $map = $cf::MAP{$path} or next; 3828 my $map = $cf::MAP{$path} or next;
2334 $map->valid or next; 3829 $map->valid or next;
2335 $map->save; 3830 $map->save;
2336 } 3831 }
2337 warn "end emergency map save\n"; 3832 info "emergency_perl_save: end map save\n";
2338 3833
2339 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";
2340 BDB::db_env_txn_checkpoint $DB_ENV; 3837 BDB::db_env_txn_checkpoint $DB_ENV;
2341 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
2342 }; 3862 };
2343 3863
2344 warn "leave emergency perl save\n"; 3864 info "emergency_perl_save: leave\n";
2345} 3865}
2346 3866
2347sub post_cleanup { 3867sub post_cleanup {
2348 my ($make_core) = @_; 3868 my ($make_core) = @_;
2349 3869
3870 IO::AIO::flush;
3871
2350 warn Carp::longmess "post_cleanup backtrace" 3872 error Carp::longmess "post_cleanup backtrace"
2351 if $make_core; 3873 if $make_core;
2352}
2353 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
2354sub reload() { 3904sub do_reload_perl() {
2355 # can/must only be called in main 3905 # can/must only be called in main
2356 if ($Coro::current != $Coro::main) { 3906 if (in_main) {
2357 warn "can only reload from main coroutine"; 3907 error "can only reload from main coroutine";
2358 return; 3908 return;
2359 } 3909 }
2360 3910
3911 return if $RELOAD++;
3912
3913 my $t1 = AE::time;
3914
3915 while ($RELOAD) {
2361 warn "reloading..."; 3916 info "reloading...";
2362 3917
2363 warn "entering sync_job"; 3918 trace "entering sync_job";
2364 3919
2365 cf::sync_job { 3920 cf::sync_job {
2366 cf::write_runtime; # external watchdog should not bark
2367 cf::emergency_save; 3921 cf::emergency_save;
2368 cf::write_runtime; # external watchdog should not bark
2369 3922
2370 warn "syncing database to disk";
2371 BDB::db_env_txn_checkpoint $DB_ENV;
2372
2373 # if anything goes wrong in here, we should simply crash as we already saved
2374
2375 warn "cancelling all WF_AUTOCANCEL watchers";
2376 for (Event::all_watchers) {
2377 $_->cancel if $_->data & WF_AUTOCANCEL;
2378 }
2379
2380 warn "flushing outstanding aio requests";
2381 for (;;) {
2382 BDB::flush;
2383 IO::AIO::flush;
2384 Coro::cede;
2385 last unless IO::AIO::nreqs || BDB::nreqs;
2386 warn "iterate...";
2387 }
2388
2389 warn "cancelling all extension coros"; 3923 trace "cancelling all extension coros";
2390 $_->cancel for values %EXT_CORO; 3924 $_->cancel for values %EXT_CORO;
2391 %EXT_CORO = (); 3925 %EXT_CORO = ();
2392 3926
2393 warn "removing commands"; 3927 trace "removing commands";
2394 %COMMAND = (); 3928 %COMMAND = ();
2395 3929
2396 warn "removing ext commands"; 3930 trace "removing ext/exti commands";
2397 %EXTCMD = (); 3931 %EXTCMD = ();
3932 %EXTICMD = ();
2398 3933
2399 warn "unloading/nuking all extensions"; 3934 trace "unloading/nuking all extensions";
2400 for my $pkg (@EXTS) { 3935 for my $pkg (@EXTS) {
2401 warn "... unloading $pkg"; 3936 trace "... unloading $pkg";
2402 3937
2403 if (my $cb = $pkg->can ("unload")) { 3938 if (my $cb = $pkg->can ("unload")) {
2404 eval { 3939 eval {
2405 $cb->($pkg); 3940 $cb->($pkg);
2406 1 3941 1
2407 } 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;
2408 } 3947 }
2409 3948
2410 warn "... nuking $pkg";
2411 Symbol::delete_package $pkg;
2412 }
2413
2414 warn "unloading all perl modules loaded from $LIBDIR"; 3949 trace "unloading all perl modules loaded from $LIBDIR";
2415 while (my ($k, $v) = each %INC) { 3950 while (my ($k, $v) = each %INC) {
2416 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3951 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2417 3952
2418 warn "... unloading $k"; 3953 trace "... unloading $k";
2419 delete $INC{$k}; 3954 delete $INC{$k};
2420 3955
2421 $k =~ s/\.pm$//; 3956 $k =~ s/\.pm$//;
2422 $k =~ s/\//::/g; 3957 $k =~ s/\//::/g;
2423 3958
2424 if (my $cb = $k->can ("unload_module")) { 3959 if (my $cb = $k->can ("unload_module")) {
2425 $cb->(); 3960 $cb->();
3961 }
3962
3963 clear_package $k;
2426 } 3964 }
2427 3965
2428 Symbol::delete_package $k;
2429 }
2430
2431 warn "getting rid of safe::, as good as possible"; 3966 trace "getting rid of safe::, as good as possible";
2432 Symbol::delete_package "safe::$_" 3967 clear_package "safe::$_"
2433 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);
2434 3969
2435 warn "unloading cf.pm \"a bit\""; 3970 trace "unloading cf.pm \"a bit\"";
2436 delete $INC{"cf.pm"}; 3971 delete $INC{"cf.pm"};
3972 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2437 3973
2438 # don't, removes xs symbols, too, 3974 # don't, removes xs symbols, too,
2439 # and global variables created in xs 3975 # and global variables created in xs
2440 #Symbol::delete_package __PACKAGE__; 3976 #clear_package __PACKAGE__;
2441 3977
2442 warn "unload completed, starting to reload now"; 3978 info "unload completed, starting to reload now";
2443 3979
2444 warn "reloading cf.pm"; 3980 trace "reloading cf.pm";
2445 require cf; 3981 require cf;
2446 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3982 cf::_connect_to_perl_1;
2447 3983
2448 warn "loading config and database again"; 3984 trace "loading config and database again";
2449 cf::cfg_load; 3985 cf::reload_config;
2450 3986
2451 warn "loading extensions"; 3987 trace "loading extensions";
2452 cf::load_extensions; 3988 cf::load_extensions;
2453 3989
3990 if ($REATTACH_ON_RELOAD) {
2454 warn "reattaching attachments to objects/players"; 3991 trace "reattaching attachments to objects/players";
2455 _global_reattach; 3992 _global_reattach; # objects, sockets
2456 warn "reattaching attachments to maps"; 3993 trace "reattaching attachments to maps";
2457 reattach $_ for values %MAP; 3994 reattach $_ for values %MAP;
3995 trace "reattaching attachments to players";
3996 reattach $_ for values %PLAYER;
3997 }
2458 3998
2459 warn "loading reloadable resources"; 3999 trace "running post_init jobs";
2460 init_resources; 4000 (pop @POST_INIT)->(1) while @POST_INIT;
2461 4001
2462 warn "leaving sync_job"; 4002 trace "leaving sync_job";
2463 4003
2464 1 4004 1
2465 } or do { 4005 } or do {
2466 warn $@; 4006 error $@;
2467 warn "error while reloading, exiting."; 4007 cf::cleanup "error while reloading, exiting.";
2468 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 };
2469 }; 4031 };
2470 4032}
2471 warn "reloaded";
2472};
2473
2474our $RELOAD_WATCHER; # used only during reload
2475 4033
2476register_command "reload" => sub { 4034register_command "reload" => sub {
2477 my ($who, $arg) = @_; 4035 my ($who, $arg) = @_;
2478 4036
2479 if ($who->flag (FLAG_WIZ)) { 4037 if ($who->flag (FLAG_WIZ)) {
2480 $who->message ("reloading server."); 4038 $who->message ("reloading server.");
2481 4039 async {
2482 # doing reload synchronously and two reloads happen back-to-back, 4040 $Coro::current->{desc} = "perl_reload";
2483 # coro crashes during coro_state_free->destroy here.
2484
2485 $RELOAD_WATCHER ||= Event->timer (
2486 reentrant => 0,
2487 after => 0,
2488 data => WF_AUTOCANCEL,
2489 cb => sub {
2490 reload; 4041 reload_perl;
2491 undef $RELOAD_WATCHER;
2492 },
2493 ); 4042 };
2494 } 4043 }
2495}; 4044};
2496 4045
2497unshift @INC, $LIBDIR; 4046#############################################################################
2498 4047
2499my $bug_warning = 0; 4048my $bug_warning = 0;
2500 4049
2501$TICK_WATCHER = Event->timer ( 4050our @WAIT_FOR_TICK;
2502 reentrant => 0, 4051our @WAIT_FOR_TICK_BEGIN;
2503 parked => 1, 4052
2504 prio => 0, 4053sub wait_for_tick {
2505 at => $NEXT_TICK || $TICK, 4054 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2506 data => WF_AUTOCANCEL, 4055
2507 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 {
2508 if ($Coro::current != $Coro::main) { 4070 if ($Coro::current != $Coro::main) {
2509 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"
2510 unless ++$bug_warning > 10; 4072 unless ++$bug_warning > 10;
2511 return; 4073 return;
2512 } 4074 }
2513 4075
2514 $NOW = Event::time;
2515
2516 cf::server_tick; # one server iteration 4076 cf::server_tick; # one server iteration
2517 $RUNTIME += $TICK;
2518 $NEXT_TICK += $TICK;
2519 4077
4078 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
4079
2520 if ($NOW >= $NEXT_RUNTIME_WRITE) { 4080 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2521 $NEXT_RUNTIME_WRITE = $NOW + 10; 4081 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2522 Coro::async_pool { 4082 Coro::async_pool {
4083 $Coro::current->{desc} = "runtime saver";
2523 write_runtime 4084 write_runtime_sync
2524 or warn "ERROR: unable to write runtime file: $!"; 4085 or error "ERROR: unable to write runtime file: $!";
2525 };
2526 } 4086 };
2527
2528 $WAIT_FOR_TICK->broadcast;
2529 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2530
2531# my $AFTER = Event::time;
2532# warn $AFTER - $NOW;#d#
2533
2534 # if we are delayed by four ticks or more, skip them all
2535 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2536
2537 $TICK_WATCHER->at ($NEXT_TICK);
2538 $TICK_WATCHER->start;
2539 }, 4087 }
2540); 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}
2541 4107
2542{ 4108{
2543 BDB::max_poll_time $TICK * 0.1; 4109 # configure BDB
2544 $BDB_POLL_WATCHER = Event->io ( 4110
2545 reentrant => 0,
2546 fd => BDB::poll_fileno,
2547 poll => 'r',
2548 prio => 0,
2549 data => WF_AUTOCANCEL,
2550 cb => \&BDB::poll_cb,
2551 );
2552 BDB::min_parallel 8; 4111 BDB::min_parallel 16;
2553 4112 BDB::max_poll_reqs $TICK * 0.1;
2554 BDB::set_sync_prepare { 4113 $AnyEvent::BDB::WATCHER->priority (1);
2555 my $status;
2556 my $current = $Coro::current;
2557 (
2558 sub {
2559 $status = $!;
2560 $current->ready; undef $current;
2561 },
2562 sub {
2563 Coro::schedule while defined $current;
2564 $! = $status;
2565 },
2566 )
2567 };
2568 4114
2569 unless ($DB_ENV) { 4115 unless ($DB_ENV) {
2570 $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);
2571 4122
2572 cf::sync_job { 4123 cf::sync_job {
2573 eval { 4124 eval {
2574 BDB::db_env_open 4125 BDB::db_env_open
2575 $DB_ENV, 4126 $DB_ENV,
2576 $BDB_ENV_DIR, 4127 $BDBDIR,
2577 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
2578 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4129 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2579 0666; 4130 0666;
2580 4131
2581 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 4132 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2582
2583 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2584 $DB_ENV->set_lk_detect;
2585 }; 4133 };
2586 4134
2587 cf::cleanup "db_env_open(db): $@" if $@; 4135 cf::cleanup "db_env_open(db): $@" if $@;
2588 }; 4136 };
2589 } 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 };
2590} 4148}
2591 4149
2592{ 4150{
4151 # configure IO::AIO
4152
2593 IO::AIO::min_parallel 8; 4153 IO::AIO::min_parallel 8;
2594
2595 undef $Coro::AIO::WATCHER;
2596 IO::AIO::max_poll_time $TICK * 0.1; 4154 IO::AIO::max_poll_time $TICK * 0.1;
2597 $AIO_POLL_WATCHER = Event->io ( 4155 undef $AnyEvent::AIO::WATCHER;
2598 reentrant => 0,
2599 data => WF_AUTOCANCEL,
2600 fd => IO::AIO::poll_fileno,
2601 poll => 'r',
2602 prio => 6,
2603 cb => \&IO::AIO::poll_cb,
2604 );
2605} 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;
2606 4203
2607END { cf::emergency_save } 4204END { cf::emergency_save }
2608 4205
26091 42061
2610 4207

Diff Legend

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