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.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.552 by root, Mon May 17 21:12:59 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines