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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines