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.187 by root, Sat Jan 20 21:06:52 2007 UTC vs.
Revision 1.544 by root, Thu May 6 21:58:07 2010 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
2 24
3use utf8; 25use common::sense;
4use strict;
5 26
6use Symbol; 27use Symbol;
7use List::Util; 28use List::Util;
8use Storable; 29use Socket;
30use EV;
9use Opcode; 31use Opcode;
10use Safe; 32use Safe;
11use Safe::Hole; 33use Safe::Hole;
34use Storable ();
35use Carp ();
12 36
37use Guard ();
13use Coro 3.4 (); 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; 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);
53 130
54our %CFG; 131our %CFG;
55 132
56our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 134our $RUNTIME;
135our $NOW;
58 136
59our %PLAYER; # all users 137our (%PLAYER, %PLAYER_LOADING); # all users
60our %MAP; # all maps 138our (%MAP, %MAP_LOADING ); # all maps
61our $LINK_MAP; # the special {link} map, which is always available 139our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 140
67# 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 ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 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
70binmode STDOUT; 154binmode STDOUT;
71binmode STDERR; 155binmode STDERR;
72 156
73# read virtual server time, if available 157# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
75 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
76 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
77 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
78} 162}
79 163
80mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
81mkdir cf::localdir . "/" . cf::playerdir; 165
82mkdir cf::localdir . "/" . cf::tmpdir; 166mkdir $_
83mkdir cf::localdir . "/" . cf::uniquedir; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
84mkdir $RANDOM_MAPS;
85 168
86our $EMERGENCY_POSITION; 169our $EMERGENCY_POSITION;
170
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::"} };
87 187
88############################################################################# 188#############################################################################
89 189
90=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
91 191
98=item $cf::RUNTIME 198=item $cf::RUNTIME
99 199
100The 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
101every server tick. 201every server tick.
102 202
103=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
104 206
105The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
106be 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.
107 211
108=item $cf::NOW 212=item $cf::NOW
109 213
110The time of the last (current) server tick. 214The time of the last (current) server tick.
111 215
112=item $cf::TICK 216=item $cf::TICK
113 217
114The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
115 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
116=item %cf::CFG 230=item %cf::CFG
117 231
118Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119from wherever your confdir points to. 233from wherever your confdir points to.
120 234
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 235=item cf::wait_for_tick, cf::wait_for_tick_begin
122 236
123These 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
124or 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
125processing 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.
126window 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.
127 252
128=back 253=back
129 254
130=cut 255=cut
131 256
132BEGIN { 257sub error(@) { LOG llevError, join "", @_ }
133 *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 {
134 my $msg = join "", @_; 264 my $msg = join "", @_;
135 utf8::encode $msg;
136 265
137 $msg .= "\n" 266 $msg .= "\n"
138 unless $msg =~ /\n$/; 267 unless $msg =~ /\n$/;
139 268
269 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
270
140 LOG llevError, $msg; 271 LOG llevWarn, $msg;
141 }; 272};
142} 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};
143 287
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 288@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 289@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 290@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 291@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@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';
149@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)
150 295
151# 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
152# within the Safe compartment. 297# within the Safe compartment.
153for my $pkg (qw( 298for my $pkg (qw(
154 cf::global cf::attachable 299 cf::global cf::attachable
155 cf::object cf::object::player 300 cf::object cf::object::player
156 cf::client cf::player 301 cf::client cf::player
157 cf::arch cf::living 302 cf::arch cf::living
303 cf::map cf::mapspace
158 cf::map cf::party cf::region 304 cf::party cf::region
159)) { 305)) {
160 no strict 'refs';
161 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 306 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162} 307}
163 308
164$Event::DIED = sub { 309$EV::DIED = sub {
165 warn "error in event callback: @_"; 310 Carp::cluck "error in event callback: @_";
166}; 311};
312
313#############################################################################
167 314
168=head2 UTILITY FUNCTIONS 315=head2 UTILITY FUNCTIONS
169 316
170=over 4 317=over 4
171 318
190 $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;
191 $d 338 $d
192 } || "[unable to dump $_[0]: '$@']"; 339 } || "[unable to dump $_[0]: '$@']";
193} 340}
194 341
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 342=item $ref = cf::decode_json $json
198 343
199Converts a JSON string into the corresponding perl data structure. 344Converts a JSON string into the corresponding perl data structure.
200 345
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 346=item $json = cf::encode_json $ref
209 347
210Converts a perl data structure into its JSON representation. 348Converts a perl data structure into its JSON representation.
211 349
212=cut 350=cut
213 351
214sub to_json($) { 352our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 353
216 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;
217} 369}
218 370
219=item cf::lock_wait $string 371=item cf::lock_wait $string
220 372
221Wait until the given lock is available. See cf::lock_acquire. 373Wait until the given lock is available. See cf::lock_acquire.
222 374
223=item my $lock = cf::lock_acquire $string 375=item my $lock = cf::lock_acquire $string
224 376
225Wait 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
226a 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,
227for example when the coroutine gets canceled), the lock is automatically 379for example when the coroutine gets canceled), the lock is automatically
228returned. 380returned.
229 381
382Locks are *not* recursive, locking from the same coro twice results in a
383deadlocked coro.
384
230Lock 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
231uses map_find and cf::map::load uses map_load). 386uses map_find and cf::map::load uses map_load).
232 387
233=cut 388=item $locked = cf::lock_active $string
234 389
235our %LOCK; 390Return true if the lock is currently active, i.e. somebody has locked it.
391
392=cut
393
394our $LOCKS = new Coro::SemaphoreSet;
236 395
237sub lock_wait($) { 396sub lock_wait($) {
238 my ($key) = @_; 397 $LOCKS->wait ($_[0]);
239
240 # wait for lock, if any
241 while ($LOCK{$key}) {
242 push @{ $LOCK{$key} }, $Coro::current;
243 Coro::schedule;
244 }
245} 398}
246 399
247sub lock_acquire($) { 400sub lock_acquire($) {
248 my ($key) = @_; 401 $LOCKS->guard ($_[0])
402}
249 403
250 # wait, to be sure we are not locked 404sub lock_active($) {
251 lock_wait $key; 405 $LOCKS->count ($_[0]) < 1
252
253 $LOCK{$key} = [];
254
255 Coro::guard {
256 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} };
258 }
259} 406}
260 407
261sub freeze_mainloop { 408sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 409 tick_inhibit_inc;
263 410
264 my $guard = Coro::guard { 411 &Guard::guard (\&tick_inhibit_dec);
265 $TICK_WATCHER->start; 412}
266 $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 }
267 }; 478 }
268 $WRITE_RUNTIME_WATCHER->stop; 479};
269 $TICK_WATCHER->stop; 480
270 $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;
271} 494}
272 495
273=item cf::async { BLOCK } 496=item cf::async { BLOCK }
274 497
275Currently the same as Coro::async_pool, meaning you cannot use 498Currently the same as Coro::async_pool, meaning you cannot use
280 503
281BEGIN { *async = \&Coro::async_pool } 504BEGIN { *async = \&Coro::async_pool }
282 505
283=item cf::sync_job { BLOCK } 506=item cf::sync_job { BLOCK }
284 507
285The design of crossfire+ requires that the main coro ($Coro::main) is 508The design of Deliantra requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 509is always able to handle events or runnable, as Deliantra is only
287reentrant. 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.
288 512
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 514the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 516fast or be very important.
294=cut 518=cut
295 519
296sub sync_job(&) { 520sub sync_job(&) {
297 my ($job) = @_; 521 my ($job) = @_;
298 522
299 if ($Coro::current == $Coro::main) { 523 if (in_main) {
524 my $time = AE::time;
525
300 # this is the main coro, too bad, we have to block 526 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 527 # till the operation succeeds, freezing the server :/
302 528
303 # TODO: use suspend/resume instead 529 #LOG llevError, Carp::longmess "sync job";#d#
304 # (but this is cancel-safe) 530
305 my $freeze_guard = freeze_mainloop; 531 my $freeze_guard = freeze_mainloop;
306 532
307 my $busy = 1; 533 my $busy = 1;
308 my @res; 534 my @res;
309 535
310 (async { 536 (async {
537 $Coro::current->desc ("sync job coro");
311 @res = eval { $job->() }; 538 @res = eval { $job->() };
312 warn $@ if $@; 539 error $@ if $@;
313 undef $busy; 540 undef $busy;
314 })->prio (Coro::PRIO_MAX); 541 })->prio (Coro::PRIO_MAX);
315 542
316 while ($busy) { 543 while ($busy) {
317 Coro::cede or Event::one_event; 544 if (Coro::nready) {
545 Coro::cede_notself;
546 } else {
547 EV::loop EV::LOOP_ONESHOT;
318 } 548 }
549 }
550
551 my $time = AE::time - $time;
552
553 $TICK_START += $time; # do not account sync jobs to server load
319 554
320 wantarray ? @res : $res[0] 555 wantarray ? @res : $res[0]
321 } else { 556 } else {
322 # we are in another coroutine, how wonderful, everything just works 557 # we are in another coroutine, how wonderful, everything just works
323 558
343 $EXT_CORO{$coro+0} = $coro; 578 $EXT_CORO{$coro+0} = $coro;
344 579
345 $coro 580 $coro
346} 581}
347 582
348sub write_runtime { 583=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 584
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 585Executes the given code block with the given arguments in a seperate
352 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.
353 589
354 my $value = $cf::RUNTIME + 90 + 10; 590=cut
355 # 10 is the runtime save interval, for a monotonic clock
356 # 60 allows for the watchdog to kill the server.
357 591
358 (aio_write $fh, 0, (length $value), $value, 0) <= 0 592sub fork_call(&@) {
359 and return; 593 my ($cb, @args) = @_;
360 594
361 aio_fsync $fh 595 # we seemingly have to make a local copy of the whole thing,
362 and return; 596 # otherwise perl prematurely frees the stuff :/
597 # TODO: investigate and fix (likely this will be rather laborious)
363 598
364 close $fh 599 my @res = Coro::Util::fork_eval {
365 or return; 600 reset_signals;
601 &$cb
602 }, @args;
366 603
367 aio_rename "$runtime~", $runtime 604 wantarray ? @res : $res[-1]
368 and return; 605}
369 606
607sub objinfo {
370 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 });
371} 783}
372 784
373=back 785=back
374 786
375=cut 787=cut
376 788
377############################################################################# 789#############################################################################
378 790
379=head2 ATTACHABLE OBJECTS 791=head2 ATTACHABLE OBJECTS
380 792
381Many 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
382attach callbacks/event handlers (a collection of which is called an "attachment") 794attach callbacks/event handlers (a collection of which is called an "attachment")
383to it. All such attachable objects support the following methods. 795to it. All such attachable objects support the following methods.
384 796
385In 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>
386C<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
387crossfire+). 799Deliantra).
388 800
389=over 4 801=over 4
390 802
391=item $attachable->attach ($attachment, key => $value...) 803=item $attachable->attach ($attachment, key => $value...)
392 804
436=item cf::CLASS::attachment $name, ... 848=item cf::CLASS::attachment $name, ...
437 849
438Register an attachment by C<$name> through which attachable objects of the 850Register an attachment by C<$name> through which attachable objects of the
439given CLASS can refer to this attachment. 851given CLASS can refer to this attachment.
440 852
441Some classes such as crossfire maps and objects can specify attachments 853Some classes such as deliantra maps and objects can specify attachments
442that 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.
443 855
444These calls expect any number of the following handler/hook descriptions: 856These calls expect any number of the following handler/hook descriptions:
445 857
446=over 4 858=over 4
555 $registry = $CB_TYPE[$object_type] ||= []; 967 $registry = $CB_TYPE[$object_type] ||= [];
556 968
557 } elsif ($type eq "subtype") { 969 } elsif ($type eq "subtype") {
558 defined $object_type or Carp::croak "subtype specified without type"; 970 defined $object_type or Carp::croak "subtype specified without type";
559 my $object_subtype = shift @arg; 971 my $object_subtype = shift @arg;
560 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 972 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561 973
562 } elsif ($type eq "package") { 974 } elsif ($type eq "package") {
563 my $pkg = shift @arg; 975 my $pkg = shift @arg;
564 976
565 while (my ($name, $id) = each %cb_id) { 977 while (my ($name, $id) = each %cb_id) {
570 982
571 } elsif (exists $cb_id{$type}) { 983 } elsif (exists $cb_id{$type}) {
572 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 984 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
573 985
574 } elsif (ref $type) { 986 } elsif (ref $type) {
575 warn "attaching objects not supported, ignoring.\n"; 987 error "attaching objects not supported, ignoring.\n";
576 988
577 } else { 989 } else {
578 shift @arg; 990 shift @arg;
579 warn "attach argument '$type' not supported, ignoring.\n"; 991 error "attach argument '$type' not supported, ignoring.\n";
580 } 992 }
581 } 993 }
582} 994}
583 995
584sub _object_attach { 996sub _object_attach {
594 _attach $registry, $klass, @attach; 1006 _attach $registry, $klass, @attach;
595 } 1007 }
596 1008
597 $obj->{$name} = \%arg; 1009 $obj->{$name} = \%arg;
598 } else { 1010 } else {
599 warn "object uses attachment '$name' that is not available, postponing.\n"; 1011 info "object uses attachment '$name' which is not available, postponing.\n";
600 } 1012 }
601 1013
602 $obj->{_attachment}{$name} = undef; 1014 $obj->{_attachment}{$name} = undef;
603} 1015}
604 1016
606 if (ref $_[0]) { 1018 if (ref $_[0]) {
607 _object_attach @_; 1019 _object_attach @_;
608 } else { 1020 } else {
609 _attach shift->_attach_registry, @_; 1021 _attach shift->_attach_registry, @_;
610 } 1022 }
1023 _recalc_want;
611}; 1024};
612 1025
613# all those should be optimised 1026# all those should be optimised
614sub cf::attachable::detach { 1027sub cf::attachable::detach {
615 my ($obj, $name) = @_; 1028 my ($obj, $name) = @_;
618 delete $obj->{_attachment}{$name}; 1031 delete $obj->{_attachment}{$name};
619 reattach ($obj); 1032 reattach ($obj);
620 } else { 1033 } else {
621 Carp::croak "cannot, currently, detach class attachments"; 1034 Carp::croak "cannot, currently, detach class attachments";
622 } 1035 }
1036 _recalc_want;
623}; 1037};
624 1038
625sub cf::attachable::attached { 1039sub cf::attachable::attached {
626 my ($obj, $name) = @_; 1040 my ($obj, $name) = @_;
627 1041
642 "; 1056 ";
643 die if $@; 1057 die if $@;
644} 1058}
645 1059
646our $override; 1060our $override;
647our @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?
648 1062
649sub override { 1063sub override {
650 $override = 1; 1064 $override = 1;
651 @invoke_results = (); 1065 @INVOKE_RESULTS = (@_);
652} 1066}
653 1067
654sub do_invoke { 1068sub do_invoke {
655 my $event = shift; 1069 my $event = shift;
656 my $callbacks = shift; 1070 my $callbacks = shift;
657 1071
658 @invoke_results = (); 1072 @INVOKE_RESULTS = ();
659 1073
660 local $override; 1074 local $override;
661 1075
662 for (@$callbacks) { 1076 for (@$callbacks) {
663 eval { &{$_->[1]} }; 1077 eval { &{$_->[1]} };
664 1078
665 if ($@) { 1079 if ($@) {
666 warn "$@";
667 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1080 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
668 override; 1081 override;
669 } 1082 }
670 1083
671 return 1 if $override; 1084 return 1 if $override;
672 } 1085 }
673 1086
674 0 1087 0
675} 1088}
676 1089
677=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1090=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
678 1091
679=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1092=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
680 1093
681Generate an object-specific event with the given arguments. 1094Generate an object-specific event with the given arguments.
682 1095
683This 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
684removed 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
685results (if you must, access C<@cf::invoke_results> directly). 1098results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686 1099
687=back 1100=back
688 1101
689=cut 1102=cut
690 1103
691############################################################################# 1104#############################################################################
692# 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}
693 1148
694sub reattach { 1149sub reattach {
695 # basically do the same as instantiate, without calling instantiate 1150 # basically do the same as instantiate, without calling instantiate
696 my ($obj) = @_; 1151 my ($obj) = @_;
697 1152
1153 # no longer needed after getting rid of delete_package?
698 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
699 1155
700 my $registry = $obj->registry; 1156 my $registry = $obj->registry;
701 1157
702 @$registry = (); 1158 @$registry = ();
703 1159
708 for (@$attach) { 1164 for (@$attach) {
709 my ($klass, @attach) = @$_; 1165 my ($klass, @attach) = @$_;
710 _attach $registry, $klass, @attach; 1166 _attach $registry, $klass, @attach;
711 } 1167 }
712 } else { 1168 } else {
713 warn "object uses attachment '$name' that is not available, postponing.\n"; 1169 info "object uses attachment '$name' that is not available, postponing.\n";
714 } 1170 }
715 } 1171 }
716} 1172}
717 1173
718cf::attachable->attach ( 1174cf::attachable->attach (
719 prio => -1000000, 1175 prio => -1000000,
720 on_instantiate => sub { 1176 on_instantiate => sub {
721 my ($obj, $data) = @_; 1177 my ($obj, $data) = @_;
722 1178
723 $data = from_json $data; 1179 $data = decode_json $data;
724 1180
725 for (@$data) { 1181 for (@$data) {
726 my ($name, $args) = @$_; 1182 my ($name, $args) = @$_;
727 1183
728 $obj->attach ($name, %{$args || {} }); 1184 $obj->attach ($name, %{$args || {} });
744sub object_freezer_save { 1200sub object_freezer_save {
745 my ($filename, $rdata, $objs) = @_; 1201 my ($filename, $rdata, $objs) = @_;
746 1202
747 sync_job { 1203 sync_job {
748 if (length $$rdata) { 1204 if (length $$rdata) {
1205 utf8::decode (my $decname = $filename);
749 warn sprintf "saving %s (%d,%d)\n", 1206 trace sprintf "saving %s (%d,%d)\n",
750 $filename, length $$rdata, scalar @$objs; 1207 $decname, length $$rdata, scalar @$objs
1208 if $VERBOSE_IO;
751 1209
752 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1210 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753 chmod SAVE_MODE, $fh; 1211 aio_chmod $fh, SAVE_MODE;
754 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1212 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
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;
755 aio_fsync $fh; 1215 aio_fsync $fh;
1216 }
756 close $fh; 1217 aio_close $fh;
757 1218
758 if (@$objs) { 1219 if (@$objs) {
759 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) {
760 chmod SAVE_MODE, $fh; 1221 aio_chmod $fh, SAVE_MODE;
761 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1222 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
762 aio_write $fh, 0, (length $data), $data, 0; 1223 aio_write $fh, 0, (length $data), $data, 0;
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;
763 aio_fsync $fh; 1226 aio_fsync $fh;
1227 }
764 close $fh; 1228 aio_close $fh;
765 aio_rename "$filename.pst~", "$filename.pst"; 1229 aio_rename "$filename.pst~", "$filename.pst";
766 } 1230 }
767 } else { 1231 } else {
768 aio_unlink "$filename.pst"; 1232 aio_unlink "$filename.pst";
769 } 1233 }
770 1234
771 aio_rename "$filename~", $filename; 1235 aio_rename "$filename~", $filename;
1236
1237 $filename =~ s%/[^/]+$%%;
1238 aio_pathsync $filename if $cf::USE_FSYNC;
772 } else { 1239 } else {
773 warn "FATAL: $filename~: $!\n"; 1240 error "unable to save objects: $filename~: $!\n";
774 } 1241 }
775 } else { 1242 } else {
776 aio_unlink $filename; 1243 aio_unlink $filename;
777 aio_unlink "$filename.pst"; 1244 aio_unlink "$filename.pst";
778 } 1245 }
779 } 1246 };
780} 1247}
781 1248
782sub object_freezer_as_string { 1249sub object_freezer_as_string {
783 my ($rdata, $objs) = @_; 1250 my ($rdata, $objs) = @_;
784 1251
796 or return; 1263 or return;
797 1264
798 unless (aio_stat "$filename.pst") { 1265 unless (aio_stat "$filename.pst") {
799 (aio_load "$filename.pst", $av) >= 0 1266 (aio_load "$filename.pst", $av) >= 0
800 or return; 1267 or return;
1268
801 $av = eval { (Storable::thaw $av)->{objs} }; 1269 my $st = eval { Coro::Storable::thaw $av };
1270 $av = $st->{objs};
802 } 1271 }
803 1272
1273 utf8::decode (my $decname = $filename);
804 warn sprintf "loading %s (%d)\n", 1274 trace sprintf "loading %s (%d,%d)\n",
805 $filename, length $data, scalar @{$av || []};#d# 1275 $decname, length $data, scalar @{$av || []}
1276 if $VERBOSE_IO;
1277
806 return ($data, $av); 1278 ($data, $av)
807} 1279}
1280
1281=head2 COMMAND CALLBACKS
1282
1283=over 4
1284
1285=cut
808 1286
809############################################################################# 1287#############################################################################
810# command handling &c 1288# command handling &c
811 1289
812=item cf::register_command $name => \&callback($ob,$args); 1290=item cf::register_command $name => \&callback($ob,$args);
825 push @{ $COMMAND{$name} }, [$caller, $cb]; 1303 push @{ $COMMAND{$name} }, [$caller, $cb];
826} 1304}
827 1305
828=item cf::register_extcmd $name => \&callback($pl,$packet); 1306=item cf::register_extcmd $name => \&callback($pl,$packet);
829 1307
830Register 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.
831 1313
832If 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
833called. 1315called.
834 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
835=cut 1328=cut
836 1329
837sub register_extcmd { 1330sub register_extcmd {
838 my ($name, $cb) = @_; 1331 my ($name, $cb) = @_;
839 1332
840 $EXTCMD{$name} = $cb; 1333 $EXTCMD{$name} = $cb;
841} 1334}
842 1335
1336sub register_exticmd {
1337 my ($name, $cb) = @_;
1338
1339 $EXTICMD{$name} = $cb;
1340}
1341
1342use File::Glob ();
1343
843cf::player->attach ( 1344cf::player->attach (
844 on_command => sub { 1345 on_unknown_command => sub {
845 my ($pl, $name, $params) = @_; 1346 my ($pl, $name, $params) = @_;
846 1347
847 my $cb = $COMMAND{$name} 1348 my $cb = $COMMAND{$name}
848 or return; 1349 or return;
849 1350
854 cf::override; 1355 cf::override;
855 }, 1356 },
856 on_extcmd => sub { 1357 on_extcmd => sub {
857 my ($pl, $buf) = @_; 1358 my ($pl, $buf) = @_;
858 1359
859 my $msg = eval { from_json $buf }; 1360 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860 1361
861 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
862 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1370 if (my $cb = $EXTCMD{$type}) {
863 if (my %reply = $cb->($pl, $msg)) { 1371 @reply = $cb->($pl, @payload);
864 $pl->ext_reply ($msg->{msgid}, %reply);
865 }
866 } 1372 }
1373
1374 $pl->ext_reply ($reply, @reply)
1375 if $reply;
1376
867 } else { 1377 } else {
868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1378 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869 } 1379 }
870 1380
871 cf::override; 1381 cf::override;
872 }, 1382 },
873); 1383);
874 1384
1385# "readahead" all extensions
875sub load_extension { 1386sub cache_extensions {
876 my ($path) = @_; 1387 my $grp = IO::AIO::aio_group;
877 1388
878 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1389 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
879 my $base = $1; 1390 for (grep /\.ext$/, @{$_[0]}) {
880 my $pkg = $1; 1391 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
881 $pkg =~ s/[^[:word:]]/_/g;
882 $pkg = "ext::$pkg";
883
884 warn "... loading '$path' into '$pkg'\n";
885
886 open my $fh, "<:utf8", $path
887 or die "$path: $!";
888
889 my $source =
890 "package $pkg; use strict; use utf8;\n"
891 . "#line 1 \"$path\"\n{\n"
892 . (do { local $/; <$fh> })
893 . "\n};\n1";
894
895 unless (eval $source) {
896 my $msg = $@ ? "$path: $@\n"
897 : "extension disabled.\n";
898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899 warn $@;
900 warn "mandatory extension failed to load, exiting.\n";
901 exit 1;
902 } 1392 }
903 die $@;
904 } 1393 };
905 1394
906 push @EXTS, $pkg; 1395 $grp
907} 1396}
908 1397
909sub load_extensions { 1398sub load_extensions {
1399 info "loading extensions...";
1400
1401 cf::sync_job {
1402 my %todo;
1403
910 for my $ext (<$LIBDIR/*.ext>) { 1404 for my $path (<$LIBDIR/*.ext>) {
911 next unless -r $ext; 1405 next unless -r $path;
912 eval { 1406
913 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 }
914 1 1470 }
915 } 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 }
916 } 1481 };
917} 1482}
918 1483
919############################################################################# 1484#############################################################################
920 1485
1486=back
1487
921=head2 CORE EXTENSIONS 1488=head2 CORE EXTENSIONS
922 1489
923Functions and methods that extend core crossfire objects. 1490Functions and methods that extend core deliantra objects.
924 1491
925=cut 1492=cut
926 1493
927package cf::player; 1494package cf::player;
928 1495
930 1497
931=head3 cf::player 1498=head3 cf::player
932 1499
933=over 4 1500=over 4
934 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
935=item cf::player::find $login 1516=item cf::player::find $login
936 1517
937Returns the given player object, loading it if necessary (might block). 1518Returns the given player object, loading it if necessary (might block).
938 1519
939=cut 1520=cut
940 1521
941sub playerdir($) { 1522sub playerdir($) {
942 cf::localdir 1523 "$PLAYERDIR/"
943 . "/"
944 . cf::playerdir
945 . "/"
946 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1524 . (ref $_[0] ? $_[0]->ob->name : $_[0])
947} 1525}
948 1526
949sub path($) { 1527sub path($) {
950 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1528 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951 1529
952 (playerdir $login) . "/$login.pl" 1530 (playerdir $login) . "/playerdata"
953} 1531}
954 1532
955sub find_active($) { 1533sub find_active($) {
956 $cf::PLAYER{$_[0]} 1534 $cf::PLAYER{$_[0]}
957 and $cf::PLAYER{$_[0]}->active 1535 and $cf::PLAYER{$_[0]}->active
960 1538
961sub exists($) { 1539sub exists($) {
962 my ($login) = @_; 1540 my ($login) = @_;
963 1541
964 $cf::PLAYER{$login} 1542 $cf::PLAYER{$login}
965 or cf::sync_job { !aio_stat path $login } 1543 or !aio_stat path $login
966} 1544}
967 1545
968sub find($) { 1546sub find($) {
969 return $cf::PLAYER{$_[0]} || do { 1547 return $cf::PLAYER{$_[0]} || do {
970 my $login = $_[0]; 1548 my $login = $_[0];
971 1549
972 my $guard = cf::lock_acquire "user_find:$login"; 1550 my $guard = cf::lock_acquire "user_find:$login";
973 1551
974 $cf::PLAYER{$_[0]} || do { 1552 $cf::PLAYER{$_[0]} || do {
975 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
976 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;
977 $cf::PLAYER{$login} = $pl 1568 $cf::PLAYER{$login} = $pl
978 } 1569 }
979 } 1570 }
980} 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);
981 1585
982sub save($) { 1586sub save($) {
983 my ($pl) = @_; 1587 my ($pl) = @_;
984 1588
985 return if $pl->{deny_save}; 1589 return if $pl->{deny_save};
990 return if $pl->{deny_save}; 1594 return if $pl->{deny_save};
991 1595
992 aio_mkdir playerdir $pl, 0770; 1596 aio_mkdir playerdir $pl, 0770;
993 $pl->{last_save} = $cf::RUNTIME; 1597 $pl->{last_save} = $cf::RUNTIME;
994 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
995 $pl->save_pl ($path); 1604 $pl->save_pl ($path);
996 Coro::cede; 1605 cf::cede_to_tick;
997} 1606}
998 1607
999sub new($) { 1608sub new($) {
1000 my ($login) = @_; 1609 my ($login) = @_;
1001 1610
1007 $cf::PLAYER{$login} = $self; 1616 $cf::PLAYER{$login} = $self;
1008 1617
1009 $self 1618 $self
1010} 1619}
1011 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
1012=item $pl->quit_character 1631=item $pl->quit_character
1013 1632
1014Nukes the player without looking back. If logged in, the connection will 1633Nukes the player without looking back. If logged in, the connection will
1015be destroyed. May block for a long time. 1634be destroyed. May block for a long time.
1016 1635
1017=cut 1636=cut
1018 1637
1019sub quit_character { 1638sub quit_character {
1020 my ($pl) = @_; 1639 my ($pl) = @_;
1021 1640
1641 my $name = $pl->ob->name;
1642
1022 $pl->{deny_save} = 1; 1643 $pl->{deny_save} = 1;
1023 $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
1024 1645
1025 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1646 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1026 $pl->deactivate; 1647 $pl->deactivate;
1648 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1027 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1649 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1028 $pl->ns->destroy if $pl->ns; 1650 $pl->ns->destroy if $pl->ns;
1029 1651
1030 my $path = playerdir $pl; 1652 my $path = playerdir $pl;
1031 my $temp = "$path~$cf::RUNTIME~deleting~"; 1653 my $temp = "$path~$cf::RUNTIME~deleting~";
1032 aio_rename $path, $temp; 1654 aio_rename $path, $temp;
1033 delete $cf::PLAYER{$pl->ob->name}; 1655 delete $cf::PLAYER{$pl->ob->name};
1034 $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
1035 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;
1036} 1678}
1037 1679
1038=item cf::player::list_logins 1680=item cf::player::list_logins
1039 1681
1040Returns 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
1041while and may block, so not sync_job-capable, ever. 1683while and may block, so not sync_job-capable, ever.
1042 1684
1043=cut 1685=cut
1044 1686
1045sub list_logins { 1687sub list_logins {
1046 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1688 my $dirs = aio_readdir $PLAYERDIR
1047 or return []; 1689 or return [];
1048 1690
1049 my @logins; 1691 my @logins;
1050 1692
1051 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") {
1052 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1699 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1053 aio_read $fh, 0, 512, my $buf, 0 or next; 1700 aio_read $fh, 0, 512, my $buf, 0 or next;
1054 $buf !~ /^password -------------$/m or next; # official not-valid tag 1701 $buf !~ /^password -------------$/m or next; # official not-valid tag
1702 }
1055 1703
1056 utf8::decode $login; 1704 utf8::decode $login;
1057 push @logins, $login; 1705 push @logins, $login;
1058 } 1706 }
1059 1707
1060 \@logins 1708 \@logins
1061} 1709}
1062 1710
1063=item $player->maps 1711=item $player->maps
1064 1712
1713=item cf::player::maps $login
1714
1065Returns an arrayref of map paths that are private for this 1715Returns an arrayref of map paths that are private for this
1066player. May block. 1716player. May block.
1067 1717
1068=cut 1718=cut
1069 1719
1070sub maps($) { 1720sub maps($) {
1071 my ($pl) = @_; 1721 my ($pl) = @_;
1722
1723 $pl = ref $pl ? $pl->ob->name : $pl;
1072 1724
1073 my $files = aio_readdir playerdir $pl 1725 my $files = aio_readdir playerdir $pl
1074 or return; 1726 or return;
1075 1727
1076 my @paths; 1728 my @paths;
1078 for (@$files) { 1730 for (@$files) {
1079 utf8::decode $_; 1731 utf8::decode $_;
1080 next if /\.(?:pl|pst)$/; 1732 next if /\.(?:pl|pst)$/;
1081 next unless /^$PATH_SEP/o; 1733 next unless /^$PATH_SEP/o;
1082 1734
1083 s/\.map$//; 1735 push @paths, cf::map::normalise "~$pl/$_";
1084 push @paths, "~" . $pl->ob->name . "/" . $_;
1085 } 1736 }
1086 1737
1087 \@paths 1738 \@paths
1088} 1739}
1089 1740
1741=item $protocol_xml = $player->expand_cfpod ($cfpod)
1742
1743Expand deliantra pod fragments into protocol xml.
1744
1090=item $player->ext_reply ($msgid, $msgtype, %msg) 1745=item $player->ext_reply ($msgid, @msg)
1091 1746
1092Sends an ext reply to the player. 1747Sends an ext reply to the player.
1093 1748
1094=cut 1749=cut
1095 1750
1096sub ext_reply($$$%) { 1751sub ext_reply($$@) {
1097 my ($self, $id, %msg) = @_; 1752 my ($self, $id, @msg) = @_;
1098 1753
1099 $msg{msgid} = $id; 1754 $self->ns->ext_reply ($id, @msg)
1100
1101 $self->send ("ext " . cf::to_json \%msg);
1102} 1755}
1103 1756
1104package 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}
1105 1799
1106=back 1800=back
1107
1108 1801
1109=head3 cf::map 1802=head3 cf::map
1110 1803
1111=over 4 1804=over 4
1112 1805
1124our $MAX_RESET = 3600; 1817our $MAX_RESET = 3600;
1125our $DEFAULT_RESET = 3000; 1818our $DEFAULT_RESET = 3000;
1126 1819
1127sub generate_random_map { 1820sub generate_random_map {
1128 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
1129 # mit "rum" bekleckern, nicht 1825 # mit "rum" bekleckern, nicht
1130 $self->_create_random_map ( 1826 $self->_create_random_map (
1131 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1827 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1828 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1133 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1829 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134 $rmp->{exit_on_final_map}, 1830 $rmp->{exit_on_final_map},
1135 $rmp->{xsize}, $rmp->{ysize}, 1831 $rmp->{xsize}, $rmp->{ysize},
1136 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1832 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1833 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1152 1848
1153sub register { 1849sub register {
1154 my (undef, $regex, $prio) = @_; 1850 my (undef, $regex, $prio) = @_;
1155 my $pkg = caller; 1851 my $pkg = caller;
1156 1852
1157 no strict;
1158 push @{"$pkg\::ISA"}, __PACKAGE__; 1853 push @{"$pkg\::ISA"}, __PACKAGE__;
1159 1854
1160 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1855 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1161} 1856}
1162 1857
1163# also paths starting with '/' 1858# also paths starting with '/'
1164$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1859$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1165 1860
1166sub thawer_merge { 1861sub thawer_merge {
1167 my ($self, $merge) = @_; 1862 my ($self, $merge) = @_;
1168 1863
1169 # we have to keep some variables in memory intact 1864 # we have to keep some variables in memory intact
1170 local $self->{path}; 1865 local $self->{path};
1171 local $self->{load_path}; 1866 local $self->{load_path};
1172 local $self->{deny_save};
1173 local $self->{deny_reset};
1174 1867
1175 $self->SUPER::thawer_merge ($merge); 1868 $self->SUPER::thawer_merge ($merge);
1176} 1869}
1177 1870
1178sub normalise { 1871sub normalise {
1179 my ($path, $base) = @_; 1872 my ($path, $base) = @_;
1873
1874 $path = "$path"; # make sure it's a string
1875
1876 $path =~ s/\.map$//;
1180 1877
1181 # map plan: 1878 # map plan:
1182 # 1879 #
1183 # /! non-realised random map exit (special hack!) 1880 # /! non-realised random map exit (special hack!)
1184 # {... are special paths that are not being touched 1881 # {... are special paths that are not being touched
1221 $self->init; # pass $1 etc. 1918 $self->init; # pass $1 etc.
1222 return $self; 1919 return $self;
1223 } 1920 }
1224 } 1921 }
1225 1922
1226 Carp::carp "unable to resolve path '$path'."; 1923 Carp::cluck "unable to resolve path '$path' (base '$base')";
1227 () 1924 ()
1228} 1925}
1229 1926
1230sub init { 1927sub init {
1231 my ($self) = @_; 1928 my ($self) = @_;
1246 1943
1247# the original (read-only) location 1944# the original (read-only) location
1248sub load_path { 1945sub load_path {
1249 my ($self) = @_; 1946 my ($self) = @_;
1250 1947
1251 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1948 "$MAPDIR/$self->{path}.map"
1252} 1949}
1253 1950
1254# the temporary/swap location 1951# the temporary/swap location
1255sub save_path { 1952sub save_path {
1256 my ($self) = @_; 1953 my ($self) = @_;
1257 1954
1258 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1955 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1259 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1956 "$TMPDIR/$path.map"
1260} 1957}
1261 1958
1262# the unique path, undef == no special unique path 1959# the unique path, undef == no special unique path
1263sub uniq_path { 1960sub uniq_path {
1264 my ($self) = @_; 1961 my ($self) = @_;
1265 1962
1266 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1963 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1267 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1964 "$UNIQUEDIR/$path"
1268} 1965}
1269 1966
1270# and all this just because we cannot iterate over 1967sub decay_objects {
1271# all maps in C++...
1272sub change_all_map_light {
1273 my ($change) = @_; 1968 my ($self) = @_;
1274 1969
1275 $_->change_map_light ($change) 1970 return if $self->{deny_reset};
1276 for grep $_->outdoor, values %cf::MAP; 1971
1972 $self->do_decay_objects;
1277} 1973}
1278 1974
1279sub unlink_save { 1975sub unlink_save {
1280 my ($self) = @_; 1976 my ($self) = @_;
1281 1977
1286 1982
1287sub load_header_from($) { 1983sub load_header_from($) {
1288 my ($self, $path) = @_; 1984 my ($self, $path) = @_;
1289 1985
1290 utf8::encode $path; 1986 utf8::encode $path;
1291 aio_open $path, O_RDONLY, 0 1987 my $f = new_from_file cf::object::thawer $path
1292 or return; 1988 or return;
1293 1989
1294 $self->_load_header ($path) 1990 $self->_load_header ($f)
1295 or return; 1991 or return;
1296 1992
1993 local $MAP_LOADING{$self->{path}} = $self;
1994 $f->resolve_delayed_derefs;
1995
1297 $self->{load_path} = $path; 1996 $self->{load_path} = $path;
1298 1997
1299 1 1998 1
1300} 1999}
1301 2000
1302sub load_orig { 2001sub load_header_orig {
1303 my ($self) = @_; 2002 my ($self) = @_;
1304 2003
1305 $self->load_header_from ($self->load_path) 2004 $self->load_header_from ($self->load_path)
1306} 2005}
1307 2006
1308sub load_temp { 2007sub load_header_temp {
1309 my ($self) = @_; 2008 my ($self) = @_;
1310 2009
1311 $self->load_header_from ($self->save_path) 2010 $self->load_header_from ($self->save_path)
2011}
2012
2013sub prepare_temp {
2014 my ($self) = @_;
2015
2016 $self->last_access ((delete $self->{last_access})
2017 || $cf::RUNTIME); #d#
2018 # safety
2019 $self->{instantiate_time} = $cf::RUNTIME
2020 if $self->{instantiate_time} > $cf::RUNTIME;
2021}
2022
2023sub prepare_orig {
2024 my ($self) = @_;
2025
2026 $self->{load_original} = 1;
2027 $self->{instantiate_time} = $cf::RUNTIME;
2028 $self->last_access ($cf::RUNTIME);
2029 $self->instantiate;
1312} 2030}
1313 2031
1314sub load_header { 2032sub load_header {
1315 my ($self) = @_; 2033 my ($self) = @_;
1316 2034
1317 if ($self->load_temp) { 2035 if ($self->load_header_temp) {
1318 $self->last_access ((delete $self->{last_access}) 2036 $self->prepare_temp;
1319 || $cf::RUNTIME); #d#
1320 # safety
1321 $self->{instantiate_time} = $cf::RUNTIME
1322 if $self->{instantiate_time} > $cf::RUNTIME;
1323 } else { 2037 } else {
1324 $self->load_orig 2038 $self->load_header_orig
1325 or return; 2039 or return;
1326 2040 $self->prepare_orig;
1327 $self->{load_original} = 1;
1328 $self->{instantiate_time} = $cf::RUNTIME;
1329 $self->last_access ($cf::RUNTIME);
1330 $self->instantiate;
1331 } 2041 }
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;
1332 2048
1333 1 2049 1
1334} 2050}
1335 2051
1336sub find; 2052sub find;
1337sub find { 2053sub find {
1338 my ($path, $origin) = @_; 2054 my ($path, $origin) = @_;
1339 2055
2056 cf::cede_to_tick;
2057
1340 $path = normalise $path, $origin && $origin->path; 2058 $path = normalise $path, $origin && $origin->path;
1341 2059
2060 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1342 cf::lock_wait "map_find:$path"; 2061 my $guard2 = cf::lock_acquire "map_find:$path";
1343 2062
1344 $cf::MAP{$path} || do { 2063 $cf::MAP{$path} || do {
1345 my $guard = cf::lock_acquire "map_find:$path";
1346 my $map = new_from_path cf::map $path 2064 my $map = new_from_path cf::map $path
1347 or return; 2065 or return;
1348 2066
1349 $map->{last_save} = $cf::RUNTIME; 2067 $map->{last_save} = $cf::RUNTIME;
1350 2068
1351 $map->load_header 2069 $map->load_header
1352 or return; 2070 or return;
1353 2071
1354 if ($map->should_reset) { 2072 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1355 # doing this can freeze the server in a sync job, obviously 2073 # doing this can freeze the server in a sync job, obviously
1356 #$cf::WAIT_FOR_TICK->wait; 2074 #$cf::WAIT_FOR_TICK->wait;
2075 undef $guard2;
2076 undef $guard1;
1357 $map->reset; 2077 $map->reset;
1358 undef $guard;
1359 $map = find $path 2078 return find $path;
1360 or return;
1361 } 2079 }
1362 2080
1363 $cf::MAP{$path} = $map 2081 $cf::MAP{$path} = $map
1364 } 2082 }
1365} 2083}
2084
2085sub pre_load { }
2086#sub post_load { } # XS
1366 2087
1367sub load { 2088sub load {
1368 my ($self) = @_; 2089 my ($self) = @_;
1369 2090
2091 local $self->{deny_reset} = 1; # loading can take a long time
2092
1370 my $path = $self->{path}; 2093 my $path = $self->{path};
2094
2095 {
1371 my $guard = cf::lock_acquire "map_load:$path"; 2096 my $guard = cf::lock_acquire "map_data:$path";
1372 2097
2098 return unless $self->valid;
1373 return if $self->in_memory != cf::MAP_SWAPPED; 2099 return unless $self->in_memory == cf::MAP_SWAPPED;
1374 2100
1375 $self->in_memory (cf::MAP_LOADING); 2101 $self->in_memory (cf::MAP_LOADING);
1376 2102
1377 $self->alloc; 2103 $self->alloc;
1378 $self->_load_objects ($self->{load_path}, 1) 2104
2105 $self->pre_load;
2106 cf::cede_to_tick;
2107
2108 my $f = new_from_file cf::object::thawer $self->{load_path};
2109 $f->skip_block;
2110 $self->_load_objects ($f)
1379 or return; 2111 or return;
1380 2112
1381 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2113 $self->post_load_original
1382 if delete $self->{load_original}; 2114 if delete $self->{load_original};
1383 2115
1384 if (my $uniq = $self->uniq_path) { 2116 if (my $uniq = $self->uniq_path) {
1385 utf8::encode $uniq; 2117 utf8::encode $uniq;
1386 if (aio_open $uniq, O_RDONLY, 0) { 2118 unless (aio_stat $uniq) {
2119 if (my $f = new_from_file cf::object::thawer $uniq) {
1387 $self->clear_unique_items; 2120 $self->clear_unique_items;
1388 $self->_load_objects ($uniq, 0); 2121 $self->_load_objects ($f);
2122 $f->resolve_delayed_derefs;
2123 }
1389 } 2124 }
1390 } 2125 }
1391 2126
1392 Coro::cede; 2127 $f->resolve_delayed_derefs;
1393 2128
2129 cf::cede_to_tick;
1394 # now do the right thing for maps 2130 # now do the right thing for maps
1395 $self->link_multipart_objects; 2131 $self->link_multipart_objects;
1396
1397 unless ($self->{deny_activate}) {
1398 $self->decay_objects;
1399 $self->fix_auto_apply;
1400 $self->update_buttons;
1401 Coro::cede;
1402 $self->set_darkness_map;
1403 $self->difficulty ($self->estimate_difficulty) 2132 $self->difficulty ($self->estimate_difficulty)
1404 unless $self->difficulty; 2133 unless $self->difficulty;
1405 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;
1406 $self->activate; 2141 $self->activate;
1407 } 2142 }
1408 2143
2144 $self->{last_save} = $cf::RUNTIME;
2145 $self->last_access ($cf::RUNTIME);
2146
1409 $self->in_memory (cf::MAP_IN_MEMORY); 2147 $self->in_memory (cf::MAP_ACTIVE);
1410} 2148 }
1411 2149
2150 $self->post_load;
2151}
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
1412sub customise_for { 2156sub customise_for {
1413 my ($self, $ob) = @_; 2157 my ($self, $ob) = @_;
1414 2158
1415 return find "~" . $ob->name . "/" . $self->{path} 2159 return find "~" . $ob->name . "/" . $self->{path}
1416 if $self->per_player; 2160 if $self->per_player;
1417 2161
2162# return find "?party/" . $ob->name . "/" . $self->{path}
2163# if $self->per_party;
2164
1418 $self 2165 $self
1419} 2166}
1420 2167
1421# 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
1422sub load_diag { 2169sub load_neighbours {
1423 my ($map) = @_; 2170 my ($map) = @_;
1424 2171
1425 my @diag; # diagonal neighbours 2172 my @neigh; # diagonal neighbours
1426 2173
1427 for (0 .. 3) { 2174 for (0 .. 3) {
1428 my $neigh = $map->tile_path ($_) 2175 my $neigh = $map->tile_path ($_)
1429 or next; 2176 or next;
1430 $neigh = find $neigh, $map 2177 $neigh = find $neigh, $map
1431 or next; 2178 or next;
1432 $neigh->load; 2179 $neigh->load;
1433 2180
2181 # now find the diagonal neighbours
2182 push @neigh,
1434 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2183 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1435 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2184 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1436 } 2185 }
1437 2186
1438 for (@diag) { 2187 for (grep defined $_->[0], @neigh) {
2188 my ($path, $origin) = @$_;
1439 my $neigh = find @$_ 2189 my $neigh = find $path, $origin
1440 or next; 2190 or next;
1441 $neigh->load; 2191 $neigh->load;
1442 } 2192 }
1443} 2193}
1444 2194
1445sub find_sync { 2195sub find_sync {
1446 my ($path, $origin) = @_; 2196 my ($path, $origin) = @_;
1447 2197
1448 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
1449} 2202}
1450 2203
1451sub do_load_sync { 2204sub do_load_sync {
1452 my ($map) = @_; 2205 my ($map) = @_;
1453 2206
1454 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;
1455} 2211}
1456 2212
1457our %MAP_PREFETCH; 2213our %MAP_PREFETCH;
1458our $MAP_PREFETCHER = undef; 2214our $MAP_PREFETCHER = undef;
1459 2215
1460sub find_async { 2216sub find_async {
1461 my ($path, $origin) = @_; 2217 my ($path, $origin, $load) = @_;
1462 2218
1463 $path = normalise $path, $origin && $origin->{path}; 2219 $path = normalise $path, $origin && $origin->{path};
1464 2220
1465 if (my $map = $cf::MAP{$path}) { 2221 if (my $map = $cf::MAP{$path}) {
1466 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2222 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1467 } 2223 }
1468 2224
1469 undef $MAP_PREFETCH{$path}; 2225 $MAP_PREFETCH{$path} |= $load;
2226
1470 $MAP_PREFETCHER ||= cf::async { 2227 $MAP_PREFETCHER ||= cf::async {
2228 $Coro::current->{desc} = "map prefetcher";
2229
1471 while (%MAP_PREFETCH) { 2230 while (%MAP_PREFETCH) {
1472 for my $path (keys %MAP_PREFETCH) { 2231 while (my ($k, $v) = each %MAP_PREFETCH) {
1473 my $map = find $path 2232 if (my $map = find $k) {
1474 or next;
1475 $map->load; 2233 $map->load if $v;
2234 }
1476 2235
1477 delete $MAP_PREFETCH{$path}; 2236 delete $MAP_PREFETCH{$k};
1478 } 2237 }
1479 } 2238 }
1480 undef $MAP_PREFETCHER; 2239 undef $MAP_PREFETCHER;
1481 }; 2240 };
2241 $MAP_PREFETCHER->prio (6);
1482 2242
1483 () 2243 ()
1484} 2244}
1485 2245
2246# common code, used by both ->save and ->swapout
1486sub save { 2247sub _save {
1487 my ($self) = @_; 2248 my ($self) = @_;
1488
1489 my $lock = cf::lock_acquire "map_data:" . $self->path;
1490 2249
1491 $self->{last_save} = $cf::RUNTIME; 2250 $self->{last_save} = $cf::RUNTIME;
1492 2251
1493 return unless $self->dirty; 2252 return unless $self->dirty;
1494 2253
1500 return if $self->{deny_save}; 2259 return if $self->{deny_save};
1501 2260
1502 local $self->{last_access} = $self->last_access;#d# 2261 local $self->{last_access} = $self->last_access;#d#
1503 2262
1504 cf::async { 2263 cf::async {
2264 $Coro::current->{desc} = "map player save";
1505 $_->contr->save for $self->players; 2265 $_->contr->save for $self->players;
1506 }; 2266 };
2267
2268 cf::get_slot 0.02;
1507 2269
1508 if ($uniq) { 2270 if ($uniq) {
1509 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2271 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1510 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2272 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1511 } else { 2273 } else {
1512 $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);
1513 } 2275 }
1514} 2276}
1515 2277
2278sub save {
2279 my ($self) = @_;
2280
2281 my $lock = cf::lock_acquire "map_data:$self->{path}";
2282
2283 $self->_save;
2284}
2285
1516sub swap_out { 2286sub swap_out {
1517 my ($self) = @_; 2287 my ($self) = @_;
1518 2288
1519 # save first because save cedes
1520 $self->save;
1521
1522 my $lock = cf::lock_acquire "map_data:" . $self->path; 2289 my $lock = cf::lock_acquire "map_data:$self->{path}";
1523 2290
2291 return if $self->in_memory != cf::MAP_ACTIVE;
2292 return if $self->{deny_save};
1524 return if $self->players; 2293 return if $self->players;
1525 return if $self->in_memory != cf::MAP_IN_MEMORY;
1526 return if $self->{deny_save};
1527 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
1528 $self->clear; 2304 $self->clear;
1529 $self->in_memory (cf::MAP_SWAPPED);
1530} 2305}
1531 2306
1532sub reset_at { 2307sub reset_at {
1533 my ($self) = @_; 2308 my ($self) = @_;
1534 2309
1535 # TODO: safety, remove and allow resettable per-player maps 2310 # TODO: safety, remove and allow resettable per-player maps
1536 return 1e99 if $self->isa ("ext::map_per_player");#d#
1537 return 1e99 if $self->{deny_reset}; 2311 return 1e99 if $self->{deny_reset};
1538 2312
1539 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2313 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1540 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;
1541 2315
1552 my ($self) = @_; 2326 my ($self) = @_;
1553 2327
1554 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2328 my $lock = cf::lock_acquire "map_data:$self->{path}";
1555 2329
1556 return if $self->players; 2330 return if $self->players;
1557 return if $self->isa ("ext::map_per_player");#d#
1558 2331
1559 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 }
1560 2343
1561 delete $cf::MAP{$self->path}; 2344 delete $cf::MAP{$self->path};
1562 2345
1563 $self->in_memory (cf::MAP_SWAPPED); 2346 $self->deactivate;
2347 $_->clear_links_to ($self) for values %cf::MAP;
1564 $self->clear; 2348 $self->clear;
1565
1566 $_->clear_links_to ($self) for values %cf::MAP;
1567 2349
1568 $self->unlink_save; 2350 $self->unlink_save;
1569 $self->destroy; 2351 $self->destroy;
1570} 2352}
1571 2353
1572my $nuke_counter = "aaaa"; 2354my $nuke_counter = "aaaa";
1573 2355
1574sub nuke { 2356sub nuke {
1575 my ($self) = @_; 2357 my ($self) = @_;
1576 2358
2359 {
2360 my $lock = cf::lock_acquire "map_data:$self->{path}";
2361
1577 delete $cf::MAP{$self->path}; 2362 delete $cf::MAP{$self->path};
1578 2363
1579 $self->unlink_save; 2364 $self->unlink_save;
1580 2365
1581 bless $self, "cf::map"; 2366 bless $self, "cf::map::wrap";
1582 delete $self->{deny_reset}; 2367 delete $self->{deny_reset};
1583 $self->{deny_save} = 1; 2368 $self->{deny_save} = 1;
1584 $self->reset_timeout (1); 2369 $self->reset_timeout (1);
1585 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2370 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1586 2371
1587 $cf::MAP{$self->path} = $self; 2372 $cf::MAP{$self->path} = $self;
2373 }
1588 2374
1589 $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 ]
1590} 2412}
1591 2413
1592=item cf::map::unique_maps 2414=item cf::map::unique_maps
1593 2415
1594Returns an arrayref of paths of all shared maps that have 2416Returns an arrayref of paths of all shared maps that have
1595instantiated unique items. May block. 2417instantiated unique items. May block.
1596 2418
1597=cut 2419=cut
1598 2420
1599sub unique_maps() { 2421sub unique_maps() {
1600 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2422 [
1601 or return; 2423 map {
1602
1603 my @paths;
1604
1605 for (@$files) {
1606 utf8::decode $_; 2424 utf8::decode $_;
1607 next if /\.pst$/; 2425 s/\.map$//; # TODO future compatibility hack
1608 next unless /^$PATH_SEP/o; 2426 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2427 ? ()
2428 : normalise $_
2429 } @{ aio_readdir $UNIQUEDIR or [] }
2430 ]
2431}
1609 2432
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) {
1610 s/\.map$//; 2454 s/\.map$// or next;
1611 push @paths, $_; 2455 utf8::decode $_;
1612 } 2456 push @maps, "$dir/$_";
2457 }
1613 2458
1614 \@paths 2459 push @dirs, map "$dir/$_", @$dirs;
1615} 2460 }
1616 2461
1617package cf; 2462 \@maps
2463}
1618 2464
1619=back 2465=back
1620 2466
1621=head3 cf::object 2467=head3 cf::object
1622 2468
1626 2472
1627=over 4 2473=over 4
1628 2474
1629=item $ob->inv_recursive 2475=item $ob->inv_recursive
1630 2476
1631Returns 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.
1632 2479
1633=cut 2480=cut
1634 2481
1635sub inv_recursive_; 2482sub inv_recursive_;
1636sub inv_recursive_ { 2483sub inv_recursive_ {
1639 2486
1640sub inv_recursive { 2487sub inv_recursive {
1641 inv_recursive_ inv $_[0] 2488 inv_recursive_ inv $_[0]
1642} 2489}
1643 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
1644package cf; 2519package cf;
1645 2520
1646=back 2521=back
1647 2522
1648=head3 cf::object::player 2523=head3 cf::object::player
1654Sends 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>
1655can 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
1656dialogue with the given NPC character. 2531dialogue with the given NPC character.
1657 2532
1658=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};
1659 2548
1660# rough implementation of a future "reply" method that works 2549# rough implementation of a future "reply" method that works
1661# with dialog boxes. 2550# with dialog boxes.
1662#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
1663sub cf::object::player::reply($$$;$) { 2552sub cf::object::player::reply($$$;$) {
1665 2554
1666 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2555 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1667 2556
1668 if ($self->{record_replies}) { 2557 if ($self->{record_replies}) {
1669 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2558 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2559
1670 } 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 {
1671 $msg = $npc->name . " says: $msg" if $npc; 2568 $msg = $npc->name . " says: $msg" if $npc;
1672 $self->message ($msg, $flags); 2569 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2570 }
1673 } 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 (@_);
1674} 2582}
1675 2583
1676=item $player_object->may ("access") 2584=item $player_object->may ("access")
1677 2585
1678Returns wether the given player is authorized to access resource "access" 2586Returns wether the given player is authorized to access resource "access"
1691 2599
1692=item $player_object->enter_link 2600=item $player_object->enter_link
1693 2601
1694Freezes 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}>).
1695 2603
1696The 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.
1697I<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.
1698 2608
1699Will never block. 2609Will never block.
1700 2610
1701=item $player_object->leave_link ($map, $x, $y) 2611=item $player_object->leave_link ($map, $x, $y)
1702 2612
1710=cut 2620=cut
1711 2621
1712sub link_map { 2622sub link_map {
1713 unless ($LINK_MAP) { 2623 unless ($LINK_MAP) {
1714 $LINK_MAP = cf::map::find "{link}" 2624 $LINK_MAP = cf::map::find "{link}"
1715 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2625 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1716 $LINK_MAP->load; 2626 $LINK_MAP->load;
1717 } 2627 }
1718 2628
1719 $LINK_MAP 2629 $LINK_MAP
1720} 2630}
1722sub cf::object::player::enter_link { 2632sub cf::object::player::enter_link {
1723 my ($self) = @_; 2633 my ($self) = @_;
1724 2634
1725 $self->deactivate_recursive; 2635 $self->deactivate_recursive;
1726 2636
2637 ++$self->{_link_recursion};
2638
1727 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2639 return if UNIVERSAL::isa $self->map, "ext::map_link";
1728 2640
1729 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2641 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1730 if $self->map; 2642 if $self->map && $self->map->{path} ne "{link}";
1731 2643
1732 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2644 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1733} 2645}
1734 2646
1735sub cf::object::player::leave_link { 2647sub cf::object::player::leave_link {
1736 my ($self, $map, $x, $y) = @_; 2648 my ($self, $map, $x, $y) = @_;
2649
2650 return unless $self->contr->active;
1737 2651
1738 my $link_pos = delete $self->{_link_pos}; 2652 my $link_pos = delete $self->{_link_pos};
1739 2653
1740 unless ($map) { 2654 unless ($map) {
1741 # restore original map position 2655 # restore original map position
1752 ($x, $y) = (-1, -1) 2666 ($x, $y) = (-1, -1)
1753 unless (defined $x) && (defined $y); 2667 unless (defined $x) && (defined $y);
1754 2668
1755 # use -1 or undef as default coordinates, not 0, 0 2669 # use -1 or undef as default coordinates, not 0, 0
1756 ($x, $y) = ($map->enter_x, $map->enter_y) 2670 ($x, $y) = ($map->enter_x, $map->enter_y)
1757 if $x <=0 && $y <= 0; 2671 if $x <= 0 && $y <= 0;
1758 2672
1759 $map->load; 2673 $map->load;
1760 $map->load_diag; 2674 $map->load_neighbours;
1761 2675
1762 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
1763 $self->activate_recursive; 2683 $self->activate_recursive;
1764 $self->enter_map ($map, $x, $y);
1765}
1766
1767cf::player->attach (
1768 on_logout => sub {
1769 my ($pl) = @_;
1770
1771 # abort map switching before logout
1772 if ($pl->ob->{_link_pos}) {
1773 cf::sync_job {
1774 $pl->ob->leave_link
1775 };
1776 }
1777 }, 2684 }
1778 on_login => sub {
1779 my ($pl) = @_;
1780 2685
1781 # try to abort aborted map switching on player login :) 2686}
1782 # should happen only on crashes
1783 if ($pl->ob->{_link_pos}) {
1784 $pl->ob->enter_link;
1785 (async {
1786 # we need this sleep as the login has a concurrent enter_exit running
1787 # and this sleep increases chances of the player not ending up in scorn
1788 $pl->ob->reply (undef,
1789 "There was an internal problem at your last logout, "
1790 . "the server will try to bring you to your intended destination in a second.",
1791 cf::NDI_RED);
1792 Coro::Timer::sleep 1;
1793 $pl->ob->leave_link;
1794 })->prio (2);
1795 }
1796 },
1797);
1798 2687
1799=item $player_object->goto ($path, $x, $y) 2688=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1800 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
1801=cut 2699=cut
2700
2701our $GOTOGEN;
1802 2702
1803sub cf::object::player::goto { 2703sub cf::object::player::goto {
1804 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;
1805 2714
1806 $self->enter_link; 2715 $self->enter_link;
1807 2716
1808 (async { 2717 (async {
1809 my $map = cf::map::find $path; 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
2739 my $map = eval {
2740 my $map = defined $path ? cf::map::find $path : undef;
2741
2742 if ($map) {
1810 $map = $map->customise_for ($self) if $map; 2743 $map = $map->customise_for ($self);
1811 2744 $map = $check->($map, $x, $y, $self) if $check && $map;
1812# warn "entering ", $map->path, " at ($x, $y)\n" 2745 } else {
1813# if $map;
1814
1815 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2746 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2747 }
1816 2748
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 $@;
2755 }
2756
2757 if ($gen == $self->{_goto_generation}) {
2758 delete $self->{_goto_generation};
1817 $self->leave_link ($map, $x, $y); 2759 $self->leave_link ($map, $x, $y);
2760 }
2761
2762 $done->($self) if $done;
1818 })->prio (1); 2763 })->prio (1);
1819} 2764}
1820 2765
1821=item $player_object->enter_exit ($exit_object) 2766=item $player_object->enter_exit ($exit_object)
1822 2767
1842} 2787}
1843 2788
1844sub prepare_random_map { 2789sub prepare_random_map {
1845 my ($exit) = @_; 2790 my ($exit) = @_;
1846 2791
1847 my $guard = cf::lock_acquire "exit_prepare:$exit";
1848
1849 # all this does is basically replace the /! path by 2792 # all this does is basically replace the /! path by
1850 # a new random map path (?random/...) with a seed 2793 # a new random map path (?random/...) with a seed
1851 # that depends on the exit object 2794 # that depends on the exit object
1852 2795
1853 my $rmp = parse_random_map_params $exit->msg; 2796 my $rmp = parse_random_map_params $exit->msg;
1854 2797
1855 if ($exit->map) { 2798 if ($exit->map) {
1856 $rmp->{region} = $exit->map->region_name; 2799 $rmp->{region} = $exit->region->name;
1857 $rmp->{origin_map} = $exit->map->path; 2800 $rmp->{origin_map} = $exit->map->path;
1858 $rmp->{origin_x} = $exit->x; 2801 $rmp->{origin_x} = $exit->x;
1859 $rmp->{origin_y} = $exit->y; 2802 $rmp->{origin_y} = $exit->y;
2803
2804 $exit->map->touch;
1860 } 2805 }
1861 2806
1862 $rmp->{random_seed} ||= $exit->random_seed; 2807 $rmp->{random_seed} ||= $exit->random_seed;
1863 2808
1864 my $data = cf::to_json $rmp; 2809 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1865 my $md5 = Digest::MD5::md5_hex $data; 2810 my $md5 = Digest::MD5::md5_hex $data;
1866 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2811 my $meta = "$RANDOMDIR/$md5.meta";
1867 2812
1868 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2813 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1869 aio_write $fh, 0, (length $data), $data, 0; 2814 aio_write $fh, 0, (length $data), $data, 0;
1870 undef $fh; 2815 undef $fh;
1871 aio_rename "$meta~", $meta; 2816 aio_rename "$meta~", $meta;
1872 2817
2818 my $slaying = "?random/$md5";
2819
2820 if ($exit->valid) {
1873 $exit->slaying ("?random/$md5"); 2821 $exit->slaying ("?random/$md5");
1874 $exit->msg (undef); 2822 $exit->msg (undef);
2823 }
1875 } 2824 }
1876} 2825}
1877 2826
1878sub cf::object::player::enter_exit { 2827sub cf::object::player::enter_exit {
1879 my ($self, $exit) = @_; 2828 my ($self, $exit) = @_;
1881 return unless $self->type == cf::PLAYER; 2830 return unless $self->type == cf::PLAYER;
1882 2831
1883 $self->enter_link; 2832 $self->enter_link;
1884 2833
1885 (async { 2834 (async {
1886 $self->deactivate_recursive; # just to be sure 2835 $Coro::current->{desc} = "enter_exit";
2836
1887 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
1888 prepare_random_map $exit 2844 prepare_random_map $exit
1889 if $exit->slaying eq "/!"; 2845 if $exit->slaying eq "/!";
2846 }
1890 2847
1891 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path; 2848 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1892 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2849 my $x = $exit->stats->hp;
2850 my $y = $exit->stats->sp;
1893 2851
2852 $self->goto ($map, $x, $y);
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
1894 1; 2858 1
1895 }) { 2859 }) {
1896 $self->message ("Something went wrong deep within the crossfire server. " 2860 $self->message ("Something went wrong deep within the deliantra server. "
1897 . "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. "
1898 . "Please report this to the dungeon master!", 2862 . "Please report this to the dungeon master!",
1899 cf::NDI_UNIQUE | cf::NDI_RED); 2863 cf::NDI_UNIQUE | cf::NDI_RED);
1900 2864
1901 warn "ERROR in enter_exit: $@"; 2865 error "ERROR in enter_exit: $@";
1902 $self->leave_link; 2866 $self->leave_link;
1903 } 2867 }
1904 })->prio (1); 2868 })->prio (1);
1905} 2869}
1906 2870
1917 2881
1918sub cf::client::send_drawinfo { 2882sub cf::client::send_drawinfo {
1919 my ($self, $text, $flags) = @_; 2883 my ($self, $text, $flags) = @_;
1920 2884
1921 utf8::encode $text; 2885 utf8::encode $text;
1922 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2886 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1923} 2887}
1924 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}
1925 3110
1926=item $success = $client->query ($flags, "text", \&cb) 3111=item $success = $client->query ($flags, "text", \&cb)
1927 3112
1928Queues a query to the client, calling the given callback with 3113Queues a query to the client, calling the given callback with
1929the 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>,
1930C<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>.
1931 3116
1932Queries 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
1933reliable at some point in the future. 3118become reliable at some point in the future.
1934 3119
1935=cut 3120=cut
1936 3121
1937sub cf::client::query { 3122sub cf::client::query {
1938 my ($self, $flags, $text, $cb) = @_; 3123 my ($self, $flags, $text, $cb) = @_;
1946 utf8::encode $text; 3131 utf8::encode $text;
1947 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3132 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1948 3133
1949 $self->send_packet ($self->{query_queue}[0][0]) 3134 $self->send_packet ($self->{query_queue}[0][0])
1950 if @{ $self->{query_queue} } == 1; 3135 if @{ $self->{query_queue} } == 1;
3136
3137 1
1951} 3138}
1952 3139
1953cf::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 },
1954 on_reply => sub { 3146 on_reply => sub {
1955 my ($ns, $msg) = @_; 3147 my ($ns, $msg) = @_;
1956 3148
1957 # this weird shuffling is so that direct followup queries 3149 # this weird shuffling is so that direct followup queries
1958 # get handled first 3150 # get handled first
1959 my $queue = delete $ns->{query_queue} 3151 my $queue = delete $ns->{query_queue}
1960 or return; # be conservative, not sure how that can happen, but we saw a crash here 3152 or return; # be conservative, not sure how that can happen, but we saw a crash here
1961 3153
1962 (shift @$queue)->[1]->($msg); 3154 (shift @$queue)->[1]->($msg);
3155 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1963 3156
1964 push @{ $ns->{query_queue} }, @$queue; 3157 push @{ $ns->{query_queue} }, @$queue;
1965 3158
1966 if (@{ $ns->{query_queue} } == @$queue) { 3159 if (@{ $ns->{query_queue} } == @$queue) {
1967 if (@$queue) { 3160 if (@$queue) {
1969 } else { 3162 } else {
1970 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1971 } 3164 }
1972 } 3165 }
1973 }, 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 },
1974); 3193);
1975 3194
1976=item $client->async (\&cb) 3195=item $client->async (\&cb)
1977 3196
1978Create a new coroutine, running the specified callback. The coroutine will 3197Create a new coroutine, running the specified callback. The coroutine will
1994 3213
1995 $coro 3214 $coro
1996} 3215}
1997 3216
1998cf::client->attach ( 3217cf::client->attach (
1999 on_destroy => sub { 3218 on_client_destroy => sub {
2000 my ($ns) = @_; 3219 my ($ns) = @_;
2001 3220
2002 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3221 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2003 }, 3222 },
2004); 3223);
2019our $safe = new Safe "safe"; 3238our $safe = new Safe "safe";
2020our $safe_hole = new Safe::Hole; 3239our $safe_hole = new Safe::Hole;
2021 3240
2022$SIG{FPE} = 'IGNORE'; 3241$SIG{FPE} = 'IGNORE';
2023 3242
2024$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));
2025 3248
2026# here we export the classes and methods available to script code 3249# here we export the classes and methods available to script code
2027 3250
2028=pod 3251=pod
2029 3252
2030The following fucntions and emthods are available within a safe environment: 3253The following functions and methods are available within a safe environment:
2031 3254
2032 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
2033 cf::object::player player 3260 cf::object::player
2034 cf::player peaceful 3261 player
2035 cf::map trigger 3262
3263 cf::player
3264 peaceful
3265
3266 cf::map
3267 trigger
2036 3268
2037=cut 3269=cut
2038 3270
2039for ( 3271for (
2040 ["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)],
2041 ["cf::object::player" => qw(player)], 3275 ["cf::object::player" => qw(player)],
2042 ["cf::player" => qw(peaceful)], 3276 ["cf::player" => qw(peaceful send_msg)],
2043 ["cf::map" => qw(trigger)], 3277 ["cf::map" => qw(trigger)],
2044) { 3278) {
2045 no strict 'refs';
2046 my ($pkg, @funs) = @$_; 3279 my ($pkg, @funs) = @$_;
2047 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3280 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2048 for @funs; 3281 for @funs;
2049} 3282}
2050 3283
2065 3298
2066 my $qcode = $code; 3299 my $qcode = $code;
2067 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3300 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2068 $qcode =~ s/\n/\\n/g; 3301 $qcode =~ s/\n/\\n/g;
2069 3302
3303 %vars = (_dummy => 0) unless %vars;
3304
3305 my @res;
2070 local $_; 3306 local $_;
2071 local @safe::cf::_safe_eval_args = values %vars;
2072 3307
2073 my $eval = 3308 my $eval =
2074 "do {\n" 3309 "do {\n"
2075 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3310 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2076 . "#line 0 \"{$qcode}\"\n" 3311 . "#line 0 \"{$qcode}\"\n"
2077 . $code 3312 . $code
2078 . "\n}" 3313 . "\n}"
2079 ; 3314 ;
2080 3315
3316 if ($CFG{safe_eval}) {
2081 sub_generation_inc; 3317 sub_generation_inc;
3318 local @safe::cf::_safe_eval_args = values %vars;
2082 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3319 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2083 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 }
2084 3325
2085 if ($@) { 3326 if ($@) {
2086 warn "$@"; 3327 warn "$@",
2087 warn "while executing safe code '$code'\n"; 3328 "while executing safe code '$code'\n",
2088 warn "with arguments " . (join " ", %vars) . "\n"; 3329 "with arguments " . (join " ", %vars) . "\n";
2089 } 3330 }
2090 3331
2091 wantarray ? @res : $res[0] 3332 wantarray ? @res : $res[0]
2092} 3333}
2093 3334
2107=cut 3348=cut
2108 3349
2109sub register_script_function { 3350sub register_script_function {
2110 my ($fun, $cb) = @_; 3351 my ($fun, $cb) = @_;
2111 3352
2112 no strict 'refs'; 3353 $fun = "safe::$fun" if $CFG{safe_eval};
2113 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3354 *$fun = $safe_hole->wrap ($cb);
2114} 3355}
2115 3356
2116=back 3357=back
2117 3358
2118=cut 3359=cut
2119 3360
2120############################################################################# 3361#############################################################################
3362# the server's init and main functions
2121 3363
2122=head2 EXTENSION DATABASE SUPPORT 3364sub load_facedata($) {
3365 my ($path) = @_;
2123 3366
2124Crossfire maintains a very simple database for extension use. It can 3367 # HACK to clear player env face cache, we need some signal framework
2125currently store anything that can be serialised using Storable, which 3368 # for this (global event?)
2126excludes objects. 3369 %ext::player_env::MUSIC_FACE_CACHE = ();
2127 3370
2128The parameter C<$family> should best start with the name of the extension 3371 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2129using it, it should be unique.
2130 3372
2131=over 4 3373 trace "loading facedata from $path\n";
2132 3374
2133=item $hashref = cf::db_get $family 3375 my $facedata;
3376 0 < aio_load $path, $facedata
3377 or die "$path: $!";
2134 3378
2135Return a hashref for use by the extension C<$family>, which can be 3379 $facedata = Coro::Storable::thaw $facedata;
2136modified. After modifications, you have to call C<cf::db_dirty> or
2137C<cf::db_sync>.
2138 3380
2139=item $value = cf::db_get $family => $key 3381 $facedata->{version} == 2
3382 or cf::cleanup "$path: version mismatch, cannot proceed.";
2140 3383
2141Returns a single value from the database 3384 # patch in the exptable
2142 3385 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2143=item cf::db_put $family => $hashref 3386 $facedata->{resource}{"res/exp_table"} = {
2144 3387 type => FT_RSRC,
2145Stores the given family hashref into the database. Updates are delayed, if 3388 data => $exp_table,
2146you want the data to be synced to disk immediately, use C<cf::db_sync>. 3389 hash => (Digest::MD5::md5 $exp_table),
2147
2148=item cf::db_put $family => $key => $value
2149
2150Stores the given C<$value> in the family hash. Updates are delayed, if you
2151want the data to be synced to disk immediately, use C<cf::db_sync>.
2152
2153=item cf::db_dirty
2154
2155Marks the database as dirty, to be updated at a later time.
2156
2157=item cf::db_sync
2158
2159Immediately write the database to disk I<if it is dirty>.
2160
2161=cut
2162
2163our $DB;
2164
2165{
2166 my $path = cf::localdir . "/database.pst";
2167
2168 sub db_load() {
2169 $DB = stat $path ? Storable::retrieve $path : { };
2170 }
2171
2172 my $pid;
2173
2174 sub db_save() {
2175 waitpid $pid, 0 if $pid;
2176 if (0 == ($pid = fork)) {
2177 $DB->{_meta}{version} = 1;
2178 Storable::nstore $DB, "$path~";
2179 rename "$path~", $path;
2180 cf::_exit 0 if defined $pid;
2181 }
2182 }
2183
2184 my $dirty;
2185
2186 sub db_sync() {
2187 db_save if $dirty;
2188 undef $dirty;
2189 }
2190
2191 my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2192 db_sync;
2193 }); 3390 };
3391 cf::cede_to_tick;
2194 3392
2195 sub db_dirty() {
2196 $dirty = 1;
2197 $idle->start;
2198 } 3393 {
3394 my $faces = $facedata->{faceinfo};
2199 3395
2200 sub db_get($;$) { 3396 while (my ($face, $info) = each %$faces) {
2201 @_ >= 2 3397 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2202 ? $DB->{$_[0]}{$_[1]}
2203 : ($DB->{$_[0]} ||= { })
2204 }
2205 3398
2206 sub db_put($$;$) { 3399 cf::face::set_visibility $idx, $info->{visibility};
2207 if (@_ >= 3) { 3400 cf::face::set_magicmap $idx, $info->{magicmap};
2208 $DB->{$_[0]}{$_[1]} = $_[2]; 3401 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2209 } else { 3402 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2210 $DB->{$_[0]} = $_[1];
2211 }
2212 db_dirty;
2213 }
2214 3403
2215 cf::global->attach ( 3404 cf::cede_to_tick;
2216 prio => 10000,
2217 on_cleanup => sub {
2218 db_sync;
2219 }, 3405 }
2220 );
2221}
2222 3406
2223############################################################################# 3407 while (my ($face, $info) = each %$faces) {
2224# the server's main() 3408 next unless $info->{smooth};
2225 3409
2226sub cfg_load { 3410 my $idx = cf::face::find $face
3411 or next;
3412
3413 if (my $smooth = cf::face::find $info->{smooth}) {
3414 cf::face::set_smooth $idx, $smooth;
3415 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3416 } else {
3417 error "smooth face '$info->{smooth}' not found for face '$face'";
3418 }
3419
3420 cf::cede_to_tick;
3421 }
3422 }
3423
3424 {
3425 my $anims = $facedata->{animinfo};
3426
3427 while (my ($anim, $info) = each %$anims) {
3428 cf::anim::set $anim, $info->{frames}, $info->{facings};
3429 cf::cede_to_tick;
3430 }
3431
3432 cf::anim::invalidate_all; # d'oh
3433 }
3434
3435 {
3436 my $res = $facedata->{resource};
3437
3438 while (my ($name, $info) = each %$res) {
3439 if (defined $info->{type}) {
3440 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3441
3442 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3443 cf::face::set_type $idx, $info->{type};
3444 } else {
3445 $RESOURCE{$name} = $info; # unused
3446 }
3447
3448 cf::cede_to_tick;
3449 }
3450 }
3451
3452 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3453
3454 1
3455}
3456
3457register_exticmd fx_want => sub {
3458 my ($ns, $want) = @_;
3459
3460 while (my ($k, $v) = each %$want) {
3461 $ns->fx_want ($k, $v);
3462 }
3463};
3464
3465sub load_resource_file($) {
3466 my $guard = lock_acquire "load_resource_file";
3467
3468 my $status = load_resource_file_ $_[0];
3469 get_slot 0.1, 100;
3470 cf::arch::commit_load;
3471
3472 $status
3473}
3474
3475sub reload_regions {
3476 # HACK to clear player env face cache, we need some signal framework
3477 # for this (global event?)
3478 %ext::player_env::MUSIC_FACE_CACHE = ();
3479
3480 load_resource_file "$MAPDIR/regions"
3481 or die "unable to load regions file\n";
3482
3483 for (cf::region::list) {
3484 $_->{match} = qr/$_->{match}/
3485 if exists $_->{match};
3486 }
3487}
3488
3489sub reload_facedata {
3490 load_facedata "$DATADIR/facedata"
3491 or die "unable to load facedata\n";
3492}
3493
3494sub reload_archetypes {
3495 load_resource_file "$DATADIR/archetypes"
3496 or die "unable to load archetypes\n";
3497}
3498
3499sub reload_treasures {
3500 load_resource_file "$DATADIR/treasures"
3501 or die "unable to load treasurelists\n";
3502}
3503
3504sub reload_exp {
3505 cf::init_experience;
3506}
3507
3508sub reload_sound {
3509 trace "loading sound config from $DATADIR/sound\n";
3510
3511 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3512 or die "$DATADIR/sound $!";
3513
3514 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3515
3516 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3517 my $sound = $soundconf->{compat}[$_]
3518 or next;
3519
3520 my $face = cf::face::find "sound/$sound->[1]";
3521 cf::sound::set $sound->[0] => $face;
3522 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3523 }
3524
3525 while (my ($k, $v) = each %{$soundconf->{event}}) {
3526 my $face = cf::face::find "sound/$v";
3527 cf::sound::set $k => $face;
3528 }
3529}
3530
3531sub reload_resources {
3532 trace "reloading resource files...\n";
3533
3534 reload_exp;
3535 reload_facedata;
3536 reload_sound;
3537 reload_archetypes;
3538 reload_regions;
3539 reload_treasures;
3540
3541 trace "finished reloading resource files\n";
3542}
3543
3544sub reload_config {
3545 trace "reloading config file...\n";
3546
2227 open my $fh, "<:utf8", cf::confdir . "/config" 3547 open my $fh, "<:utf8", "$CONFDIR/config"
2228 or return; 3548 or return;
2229 3549
2230 local $/; 3550 local $/;
2231 *CFG = YAML::Syck::Load <$fh>; 3551 *CFG = YAML::XS::Load scalar <$fh>;
2232 3552
2233 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3553 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2234 3554
2235 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3555 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2236 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3556 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2237 3557
2238 if (exists $CFG{mlockall}) { 3558 if (exists $CFG{mlockall}) {
2240 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3560 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2241 and die "WARNING: m(un)lockall failed: $!\n"; 3561 and die "WARNING: m(un)lockall failed: $!\n";
2242 }; 3562 };
2243 warn $@ if $@; 3563 warn $@ if $@;
2244 } 3564 }
3565
3566 trace "finished reloading resource files\n";
3567}
3568
3569sub pidfile() {
3570 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3571 or die "$PIDFILE: $!";
3572 flock $fh, &Fcntl::LOCK_EX
3573 or die "$PIDFILE: flock: $!";
3574 $fh
3575}
3576
3577# make sure only one server instance is running at any one time
3578sub atomic {
3579 my $fh = pidfile;
3580
3581 my $pid = <$fh>;
3582 kill 9, $pid if $pid > 0;
3583
3584 seek $fh, 0, 0;
3585 print $fh $$;
3586}
3587
3588sub main_loop {
3589 trace "EV::loop starting\n";
3590 if (1) {
3591 EV::loop;
3592 }
3593 trace "EV::loop returned\n";
3594 goto &main_loop unless $REALLY_UNLOOP;
2245} 3595}
2246 3596
2247sub main { 3597sub main {
3598 cf::init_globals; # initialise logging
3599
3600 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3601 LOG llevInfo, "Copyright (C) 2005-2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3602 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3603 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3604
3605 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3606
2248 # we must not ever block the main coroutine 3607 # we must not ever block the main coroutine
2249 local $Coro::idle = sub { 3608 local $Coro::idle = sub {
2250 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3609 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2251 (async { 3610 (async {
2252 Event::one_event; 3611 $Coro::current->{desc} = "IDLE BUG HANDLER";
3612 EV::loop EV::LOOP_ONESHOT;
2253 })->prio (Coro::PRIO_MAX); 3613 })->prio (Coro::PRIO_MAX);
2254 }; 3614 };
2255 3615
2256 cfg_load; 3616 evthread_start IO::AIO::poll_fileno;
2257 db_load; 3617
3618 cf::sync_job {
3619 cf::incloader::init ();
3620
3621 cf::init_anim;
3622 cf::init_attackmess;
3623 cf::init_dynamic;
3624
3625 cf::load_settings;
3626 cf::load_materials;
3627
3628 reload_resources;
3629 reload_config;
3630 db_init;
3631
3632 cf::init_uuid;
3633 cf::init_signals;
3634 cf::init_skills;
3635
3636 cf::init_beforeplay;
3637
3638 atomic;
3639
2258 load_extensions; 3640 load_extensions;
2259 3641
2260 $TICK_WATCHER->start; 3642 utime time, time, $RUNTIMEFILE;
2261 Event::loop; 3643
3644 # no (long-running) fork's whatsoever before this point(!)
3645 use POSIX ();
3646 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3647
3648 (pop @POST_INIT)->(0) while @POST_INIT;
3649 };
3650
3651 cf::object::thawer::errors_are_fatal 0;
3652 info "parse errors in files are no longer fatal from this point on.\n";
3653
3654 my $free_main; $free_main = EV::idle sub {
3655 undef $free_main;
3656 undef &main; # free gobs of memory :)
3657 };
3658
3659 goto &main_loop;
2262} 3660}
2263 3661
2264############################################################################# 3662#############################################################################
2265# initialisation and cleanup 3663# initialisation and cleanup
2266 3664
2267# install some emergency cleanup handlers 3665# install some emergency cleanup handlers
2268BEGIN { 3666BEGIN {
3667 our %SIGWATCHER = ();
2269 for my $signal (qw(INT HUP TERM)) { 3668 for my $signal (qw(INT HUP TERM)) {
2270 Event->signal ( 3669 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2271 data => WF_AUTOCANCEL,
2272 signal => $signal,
2273 cb => sub {
2274 cf::cleanup "SIG$signal"; 3670 cf::cleanup "SIG$signal";
2275 },
2276 ); 3671 };
3672 }
3673}
3674
3675sub write_runtime_sync {
3676 my $t0 = AE::time;
3677
3678 # first touch the runtime file to show we are still running:
3679 # the fsync below can take a very very long time.
3680
3681 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3682
3683 my $guard = cf::lock_acquire "write_runtime";
3684
3685 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3686 or return;
3687
3688 my $value = $cf::RUNTIME + 90 + 10;
3689 # 10 is the runtime save interval, for a monotonic clock
3690 # 60 allows for the watchdog to kill the server.
3691
3692 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3693 and return;
3694
3695 # always fsync - this file is important
3696 aio_fsync $fh
3697 and return;
3698
3699 # touch it again to show we are up-to-date
3700 aio_utime $fh, undef, undef;
3701
3702 close $fh
3703 or return;
3704
3705 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3706 and return;
3707
3708 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3709
2277 } 3710 1
3711}
3712
3713our $uuid_lock;
3714our $uuid_skip;
3715
3716sub write_uuid_sync($) {
3717 $uuid_skip ||= $_[0];
3718
3719 return if $uuid_lock;
3720 local $uuid_lock = 1;
3721
3722 my $uuid = "$LOCALDIR/uuid";
3723
3724 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3725 or return;
3726
3727 my $value = uuid_seq uuid_cur;
3728
3729 unless ($value) {
3730 info "cowardly refusing to write zero uuid value!\n";
3731 return;
3732 }
3733
3734 my $value = uuid_str $value + $uuid_skip;
3735 $uuid_skip = 0;
3736
3737 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3738 and return;
3739
3740 # always fsync - this file is important
3741 aio_fsync $fh
3742 and return;
3743
3744 close $fh
3745 or return;
3746
3747 aio_rename "$uuid~", $uuid
3748 and return;
3749
3750 trace "uuid file written ($value).\n";
3751
3752 1
3753
3754}
3755
3756sub write_uuid($$) {
3757 my ($skip, $sync) = @_;
3758
3759 $sync ? write_uuid_sync $skip
3760 : async { write_uuid_sync $skip };
2278} 3761}
2279 3762
2280sub emergency_save() { 3763sub emergency_save() {
2281 my $freeze_guard = cf::freeze_mainloop; 3764 my $freeze_guard = cf::freeze_mainloop;
2282 3765
2283 warn "enter emergency perl save\n"; 3766 info "emergency_perl_save: enter\n";
3767
3768 # this is a trade-off: we want to be very quick here, so
3769 # save all maps without fsync, and later call a global sync
3770 # (which in turn might be very very slow)
3771 local $USE_FSYNC = 0;
2284 3772
2285 cf::sync_job { 3773 cf::sync_job {
3774 cf::write_runtime_sync; # external watchdog should not bark
3775
2286 # use a peculiar iteration method to avoid tripping on perl 3776 # use a peculiar iteration method to avoid tripping on perl
2287 # refcount bugs in for. also avoids problems with players 3777 # refcount bugs in for. also avoids problems with players
2288 # and maps saved/destroyed asynchronously. 3778 # and maps saved/destroyed asynchronously.
2289 warn "begin emergency player save\n"; 3779 info "emergency_perl_save: begin player save\n";
2290 for my $login (keys %cf::PLAYER) { 3780 for my $login (keys %cf::PLAYER) {
2291 my $pl = $cf::PLAYER{$login} or next; 3781 my $pl = $cf::PLAYER{$login} or next;
2292 $pl->valid or next; 3782 $pl->valid or next;
3783 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2293 $pl->save; 3784 $pl->save;
2294 } 3785 }
2295 warn "end emergency player save\n"; 3786 info "emergency_perl_save: end player save\n";
2296 3787
2297 warn "begin emergency map save\n"; 3788 cf::write_runtime_sync; # external watchdog should not bark
3789
3790 info "emergency_perl_save: begin map save\n";
2298 for my $path (keys %cf::MAP) { 3791 for my $path (keys %cf::MAP) {
2299 my $map = $cf::MAP{$path} or next; 3792 my $map = $cf::MAP{$path} or next;
2300 $map->valid or next; 3793 $map->valid or next;
2301 $map->save; 3794 $map->save;
2302 } 3795 }
2303 warn "end emergency map save\n"; 3796 info "emergency_perl_save: end map save\n";
3797
3798 cf::write_runtime_sync; # external watchdog should not bark
3799
3800 info "emergency_perl_save: begin database checkpoint\n";
3801 BDB::db_env_txn_checkpoint $DB_ENV;
3802 info "emergency_perl_save: end database checkpoint\n";
3803
3804 info "emergency_perl_save: begin write uuid\n";
3805 write_uuid_sync 1;
3806 info "emergency_perl_save: end write uuid\n";
3807
3808 cf::write_runtime_sync; # external watchdog should not bark
3809
3810 trace "emergency_perl_save: syncing database to disk";
3811 BDB::db_env_txn_checkpoint $DB_ENV;
3812
3813 info "emergency_perl_save: starting sync\n";
3814 IO::AIO::aio_sync sub {
3815 info "emergency_perl_save: finished sync\n";
3816 };
3817
3818 cf::write_runtime_sync; # external watchdog should not bark
3819
3820 trace "emergency_perl_save: flushing outstanding aio requests";
3821 while (IO::AIO::nreqs || BDB::nreqs) {
3822 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3823 }
3824
3825 cf::write_runtime_sync; # external watchdog should not bark
2304 }; 3826 };
2305 3827
2306 warn "leave emergency perl save\n"; 3828 info "emergency_perl_save: leave\n";
2307} 3829}
2308 3830
3831sub post_cleanup {
3832 my ($make_core) = @_;
3833
3834 IO::AIO::flush;
3835
3836 error Carp::longmess "post_cleanup backtrace"
3837 if $make_core;
3838
3839 my $fh = pidfile;
3840 unlink $PIDFILE if <$fh> == $$;
3841}
3842
3843# a safer delete_package, copied from Symbol
3844sub clear_package($) {
3845 my $pkg = shift;
3846
3847 # expand to full symbol table name if needed
3848 unless ($pkg =~ /^main::.*::$/) {
3849 $pkg = "main$pkg" if $pkg =~ /^::/;
3850 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3851 $pkg .= '::' unless $pkg =~ /::$/;
3852 }
3853
3854 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3855 my $stem_symtab = *{$stem}{HASH};
3856
3857 defined $stem_symtab and exists $stem_symtab->{$leaf}
3858 or return;
3859
3860 # clear all symbols
3861 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3862 for my $name (keys %$leaf_symtab) {
3863 _gv_clear *{"$pkg$name"};
3864# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3865 }
3866}
3867
2309sub reload() { 3868sub do_reload_perl() {
2310 # can/must only be called in main 3869 # can/must only be called in main
2311 if ($Coro::current != $Coro::main) { 3870 unless (in_main) {
2312 warn "can only reload from main coroutine"; 3871 error "can only reload from main coroutine";
2313 return; 3872 return;
2314 } 3873 }
2315 3874
3875 return if $RELOAD++;
3876
3877 my $t1 = AE::time;
3878
3879 while ($RELOAD) {
3880 cf::get_slot 0.1, -1, "reload_perl";
2316 warn "reloading..."; 3881 info "reloading...";
2317 3882
2318 warn "cancelling server ticker"; 3883 trace "entering sync_job";
2319 $TICK_WATCHER->cancel;
2320 3884
3885 cf::sync_job {
2321 cf::emergency_save; 3886 #cf::emergency_save;
2322 3887
2323 eval {
2324 # if anything goes wrong in here, we should simply crash as we already saved
2325
2326 warn "syncing database to disk";
2327 cf::db_sync;
2328
2329 warn "cancelling all WF_AUTOCANCEL watchers";
2330 for (Event::all_watchers) {
2331 $_->cancel if $_->data & WF_AUTOCANCEL;
2332 }
2333
2334 warn "flushing outstanding aio requests";
2335 for (;;) {
2336 IO::AIO::flush;
2337 Coro::cede;
2338 last unless IO::AIO::nreqs;
2339 warn "iterate...";
2340 }
2341
2342 warn "cancelling all extension coros"; 3888 trace "cancelling all extension coros";
2343 $_->cancel for values %EXT_CORO; 3889 $_->cancel for values %EXT_CORO;
2344 %EXT_CORO = (); 3890 %EXT_CORO = ();
2345 3891
2346 warn "removing commands"; 3892 trace "removing commands";
2347 %COMMAND = (); 3893 %COMMAND = ();
2348 3894
2349 warn "removing ext commands"; 3895 trace "removing ext/exti commands";
2350 %EXTCMD = (); 3896 %EXTCMD = ();
3897 %EXTICMD = ();
2351 3898
2352 warn "unloading/nuking all extensions"; 3899 trace "unloading/nuking all extensions";
2353 for my $pkg (@EXTS) { 3900 for my $pkg (@EXTS) {
2354 warn "... unloading $pkg"; 3901 trace "... unloading $pkg";
2355 3902
2356 if (my $cb = $pkg->can ("unload")) { 3903 if (my $cb = $pkg->can ("unload")) {
2357 eval { 3904 eval {
2358 $cb->($pkg); 3905 $cb->($pkg);
2359 1 3906 1
2360 } or warn "$pkg unloaded, but with errors: $@"; 3907 } or error "$pkg unloaded, but with errors: $@";
3908 }
3909
3910 trace "... clearing $pkg";
3911 clear_package $pkg;
2361 } 3912 }
2362 3913
2363 warn "... nuking $pkg";
2364 Symbol::delete_package $pkg;
2365 }
2366
2367 warn "unloading all perl modules loaded from $LIBDIR"; 3914 trace "unloading all perl modules loaded from $LIBDIR";
2368 while (my ($k, $v) = each %INC) { 3915 while (my ($k, $v) = each %INC) {
2369 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3916 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2370 3917
2371 warn "... unloading $k"; 3918 trace "... unloading $k";
2372 delete $INC{$k}; 3919 delete $INC{$k};
2373 3920
2374 $k =~ s/\.pm$//; 3921 $k =~ s/\.pm$//;
2375 $k =~ s/\//::/g; 3922 $k =~ s/\//::/g;
2376 3923
2377 if (my $cb = $k->can ("unload_module")) { 3924 if (my $cb = $k->can ("unload_module")) {
2378 $cb->(); 3925 $cb->();
3926 }
3927
3928 clear_package $k;
2379 } 3929 }
2380 3930
2381 Symbol::delete_package $k;
2382 }
2383
2384 warn "getting rid of safe::, as good as possible"; 3931 trace "getting rid of safe::, as good as possible";
2385 Symbol::delete_package "safe::$_" 3932 clear_package "safe::$_"
2386 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3933 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2387 3934
2388 warn "unloading cf.pm \"a bit\""; 3935 trace "unloading cf.pm \"a bit\"";
2389 delete $INC{"cf.pm"}; 3936 delete $INC{"cf.pm"};
3937 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2390 3938
2391 # don't, removes xs symbols, too, 3939 # don't, removes xs symbols, too,
2392 # and global variables created in xs 3940 # and global variables created in xs
2393 #Symbol::delete_package __PACKAGE__; 3941 #clear_package __PACKAGE__;
2394 3942
2395 warn "unload completed, starting to reload now"; 3943 info "unload completed, starting to reload now";
2396 3944
2397 warn "reloading cf.pm"; 3945 trace "reloading cf.pm";
2398 require cf; 3946 require cf;
2399 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3947 cf::_connect_to_perl_1;
2400 3948
2401 warn "loading config and database again"; 3949 trace "loading config and database again";
2402 cf::cfg_load; 3950 cf::reload_config;
2403 cf::db_load;
2404 3951
2405 warn "loading extensions"; 3952 trace "loading extensions";
2406 cf::load_extensions; 3953 cf::load_extensions;
2407 3954
3955 if ($REATTACH_ON_RELOAD) {
2408 warn "reattaching attachments to objects/players"; 3956 trace "reattaching attachments to objects/players";
2409 _global_reattach; 3957 _global_reattach; # objects, sockets
2410 warn "reattaching attachments to maps"; 3958 trace "reattaching attachments to maps";
2411 reattach $_ for values %MAP; 3959 reattach $_ for values %MAP;
3960 trace "reattaching attachments to players";
3961 reattach $_ for values %PLAYER;
3962 }
2412 3963
2413 warn "restarting server ticker"; 3964 trace "running post_init jobs";
3965 (pop @POST_INIT)->(1) while @POST_INIT;
2414 3966
2415 $TICK_WATCHER->start; 3967 trace "leaving sync_job";
3968
3969 1
3970 } or do {
3971 error $@;
3972 cf::cleanup "error while reloading, exiting.";
3973 };
3974
3975 info "reloaded";
3976 --$RELOAD;
3977 }
3978
3979 $t1 = AE::time - $t1;
3980 info "reload completed in ${t1}s\n";
3981};
3982
3983our $RELOAD_WATCHER; # used only during reload
3984
3985sub reload_perl() {
3986 # doing reload synchronously and two reloads happen back-to-back,
3987 # coro crashes during coro_state_free->destroy here.
3988
3989 $RELOAD_WATCHER ||= cf::async {
3990 Coro::AIO::aio_wait cache_extensions;
3991
3992 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
3993 do_reload_perl;
3994 undef $RELOAD_WATCHER;
3995 };
2416 }; 3996 };
2417 3997}
2418 if ($@) {
2419 warn $@;
2420 warn "error while reloading, exiting.";
2421 exit 1;
2422 }
2423
2424 warn "reloaded";
2425};
2426
2427our $RELOAD_WATCHER; # used only during reload
2428 3998
2429register_command "reload" => sub { 3999register_command "reload" => sub {
2430 my ($who, $arg) = @_; 4000 my ($who, $arg) = @_;
2431 4001
2432 if ($who->flag (FLAG_WIZ)) { 4002 if ($who->flag (FLAG_WIZ)) {
2433 $who->message ("reloading server."); 4003 $who->message ("reloading server.");
2434 4004 async {
2435 # doing reload synchronously and two reloads happen back-to-back, 4005 $Coro::current->{desc} = "perl_reload";
2436 # coro crashes during coro_state_free->destroy here.
2437
2438 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2439 reload; 4006 reload_perl;
2440 undef $RELOAD_WATCHER;
2441 }); 4007 };
2442 } 4008 }
2443}; 4009};
2444 4010
2445unshift @INC, $LIBDIR; 4011#############################################################################
2446 4012
2447my $bug_warning = 0; 4013my $bug_warning = 0;
2448 4014
2449$TICK_WATCHER = Event->timer ( 4015our @WAIT_FOR_TICK;
2450 reentrant => 0, 4016our @WAIT_FOR_TICK_BEGIN;
2451 parked => 1, 4017
2452 prio => 0, 4018sub wait_for_tick {
2453 at => $NEXT_TICK || $TICK, 4019 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2454 data => WF_AUTOCANCEL, 4020
2455 cb => sub { 4021 my $signal = new Coro::Signal;
4022 push @WAIT_FOR_TICK, $signal;
4023 $signal->wait;
4024}
4025
4026sub wait_for_tick_begin {
4027 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4028
4029 my $signal = new Coro::Signal;
4030 push @WAIT_FOR_TICK_BEGIN, $signal;
4031 $signal->wait;
4032}
4033
4034sub tick {
2456 if ($Coro::current != $Coro::main) { 4035 if ($Coro::current != $Coro::main) {
2457 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 4036 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2458 unless ++$bug_warning > 10; 4037 unless ++$bug_warning > 10;
2459 return; 4038 return;
2460 } 4039 }
2461 4040
2462 $NOW = Event::time;
2463
2464 cf::server_tick; # one server iteration 4041 cf::server_tick; # one server iteration
2465 $RUNTIME += $TICK;
2466 $NEXT_TICK += $TICK;
2467 4042
2468 $WAIT_FOR_TICK->broadcast; 4043 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2469 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2470 4044
2471 # if we are delayed by four ticks or more, skip them all 4045 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2472 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 4046 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2473 4047 Coro::async_pool {
2474 $TICK_WATCHER->at ($NEXT_TICK); 4048 $Coro::current->{desc} = "runtime saver";
2475 $TICK_WATCHER->start; 4049 write_runtime_sync
4050 or error "ERROR: unable to write runtime file: $!";
4051 };
2476 }, 4052 }
2477);
2478 4053
4054 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4055 $sig->send;
4056 }
4057 while (my $sig = shift @WAIT_FOR_TICK) {
4058 $sig->send;
4059 }
4060
4061 $LOAD = ($NOW - $TICK_START) / $TICK;
4062 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4063
4064 if (0) {
4065 if ($NEXT_TICK) {
4066 my $jitter = $TICK_START - $NEXT_TICK;
4067 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4068 debug "jitter $JITTER\n";#d#
4069 }
4070 }
4071}
4072
4073{
4074 # configure BDB
4075
4076 BDB::min_parallel 16;
4077 BDB::max_poll_reqs $TICK * 0.1;
4078 $AnyEvent::BDB::WATCHER->priority (1);
4079
4080 unless ($DB_ENV) {
4081 $DB_ENV = BDB::db_env_create;
4082 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4083 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4084 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4085 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4086 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4087
4088 cf::sync_job {
4089 eval {
4090 BDB::db_env_open
4091 $DB_ENV,
4092 $BDBDIR,
4093 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4094 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4095 0666;
4096
4097 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
4098 };
4099
4100 cf::cleanup "db_env_open(db): $@" if $@;
4101 };
4102 }
4103
4104 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4105 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4106 };
4107 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4108 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4109 };
4110 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4111 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4112 };
4113}
4114
4115{
4116 # configure IO::AIO
4117
4118 IO::AIO::min_parallel 8;
2479IO::AIO::max_poll_time $TICK * 0.2; 4119 IO::AIO::max_poll_time $TICK * 0.1;
4120 undef $AnyEvent::AIO::WATCHER;
4121}
2480 4122
2481$AIO_POLL_WATCHER = Event->io ( 4123my $_log_backtrace;
2482 fd => IO::AIO::poll_fileno,
2483 poll => 'r',
2484 prio => 5,
2485 data => WF_AUTOCANCEL,
2486 cb => \&IO::AIO::poll_cb,
2487);
2488 4124
2489$WRITE_RUNTIME_WATCHER = Event->timer ( 4125sub _log_backtrace {
2490 data => WF_AUTOCANCEL, 4126 my ($msg, @addr) = @_;
2491 after => 1, 4127
2492 interval => 10, 4128 $msg =~ s/\n//;
2493 prio => 6, # keep it lowest so it acts like a watchdog 4129
2494 cb => Coro::unblock_sub { 4130 # limit the # of concurrent backtraces
2495 write_runtime 4131 if ($_log_backtrace < 2) {
2496 or warn "ERROR: unable to write runtime file: $!"; 4132 ++$_log_backtrace;
4133 my $perl_bt = Carp::longmess $msg;
4134 async {
4135 $Coro::current->{desc} = "abt $msg";
4136
4137 my @bt = fork_call {
4138 @addr = map { sprintf "%x", $_ } @addr;
4139 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4140 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4141 or die "addr2line: $!";
4142
4143 my @funcs;
4144 my @res = <$fh>;
4145 chomp for @res;
4146 while (@res) {
4147 my ($func, $line) = splice @res, 0, 2, ();
4148 push @funcs, "[$func] $line";
4149 }
4150
4151 @funcs
4152 };
4153
4154 LOG llevInfo, "[ABT] $perl_bt\n";
4155 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4156 LOG llevInfo, "[ABT] $_\n" for @bt;
4157 --$_log_backtrace;
4158 };
4159 } else {
4160 LOG llevInfo, "[ABT] $msg\n";
4161 LOG llevInfo, "[ABT] [suppressed]\n";
2497 }, 4162 }
2498); 4163}
4164
4165# load additional modules
4166require "cf/$_.pm" for @EXTRA_MODULES;
4167cf::_connect_to_perl_2;
2499 4168
2500END { cf::emergency_save } 4169END { cf::emergency_save }
2501 4170
25021 41711
2503 4172

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines