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.189 by root, Sun Jan 21 21:28:27 2007 UTC vs.
Revision 1.556 by root, Sat Jul 3 01:49:18 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines