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.194 by root, Wed Jan 24 22:42:49 2007 UTC vs.
Revision 1.552 by root, Mon May 17 21:12:59 2010 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
2 24
3use utf8; 25use common::sense;
4use strict;
5 26
6use Symbol; 27use Symbol;
7use List::Util; 28use List::Util;
8use Storable; 29use Socket;
30use EV;
9use Opcode; 31use Opcode;
10use Safe; 32use Safe;
11use Safe::Hole; 33use Safe::Hole;
34use Storable ();
35use Carp ();
12 36
37use Guard ();
13use Coro 3.5 (); 38use Coro ();
39use Coro::State;
40use Coro::Handle;
41use Coro::EV;
14use Coro::Event; 42use Coro::AnyEvent;
15use Coro::Timer; 43use Coro::Timer;
16use Coro::Signal; 44use Coro::Signal;
17use Coro::Semaphore; 45use Coro::Semaphore;
46use Coro::SemaphoreSet;
47use Coro::AnyEvent;
18use Coro::AIO; 48use Coro::AIO;
49use Coro::BDB 1.6;
50use Coro::Storable;
51use Coro::Util ();
19 52
53use JSON::XS 2.01 ();
54use BDB ();
20use Data::Dumper; 55use Data::Dumper;
21use Digest::MD5;
22use Fcntl; 56use Fcntl;
23use IO::AIO 2.32 ();
24use YAML::Syck (); 57use YAML::XS ();
58use IO::AIO ();
25use Time::HiRes; 59use Time::HiRes;
60use Compress::LZF;
61use Digest::MD5 ();
26 62
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 63AnyEvent::detect;
64
65# configure various modules to our taste
66#
67$Storable::canonical = 1; # reduce rsync transfers
68Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
69
70$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
71
72# make sure c-lzf reinitialises itself
73Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
74Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
75
76# strictly for debugging
77$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
28 78
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 79sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 80
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 81our @ORIG_INC;
32$YAML::Syck::ImplicitUnicode = 1;
33
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 82
36our %COMMAND = (); 83our %COMMAND = ();
37our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
38 85
39our @EXTS = (); # list of extension package names 86our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 89our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 90our %EXT_MAP = (); # pluggable maps
43 91
92our $RELOAD; # number of reloads so far, non-zero while in reload
44our @EVENT; 93our @EVENT;
45our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
46 96
47our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
48our $TICK_WATCHER; 98our $DATADIR = datadir;
49our $AIO_POLL_WATCHER; 99our $LIBDIR = "$DATADIR/ext";
50our $WRITE_RUNTIME_WATCHER; 100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE; # unused
112
113our $OUTPUT_RATE_MIN = 3000;
114our $OUTPUT_RATE_MAX = 1000000;
115
116our $MAX_LINKS = 32; # how many chained exits to follow
117our $VERBOSE_IO = 1;
118
119our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 121our $NEXT_TICK;
52our $NOW; 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) = @_;
1863
1864 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1865
1129 # mit "rum" bekleckern, nicht 1866 # mit "rum" bekleckern, nicht
1130 $self->_create_random_map ( 1867 $self->_create_random_map (
1131 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1868 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1869 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1133 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1870 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134 $rmp->{exit_on_final_map}, 1871 $rmp->{exit_on_final_map},
1135 $rmp->{xsize}, $rmp->{ysize}, 1872 $rmp->{xsize}, $rmp->{ysize},
1136 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1873 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1874 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1152 1889
1153sub register { 1890sub register {
1154 my (undef, $regex, $prio) = @_; 1891 my (undef, $regex, $prio) = @_;
1155 my $pkg = caller; 1892 my $pkg = caller;
1156 1893
1157 no strict;
1158 push @{"$pkg\::ISA"}, __PACKAGE__; 1894 push @{"$pkg\::ISA"}, __PACKAGE__;
1159 1895
1160 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1896 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1161} 1897}
1162 1898
1163# also paths starting with '/' 1899# also paths starting with '/'
1164$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1900$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1165 1901
1166sub thawer_merge { 1902sub thawer_merge {
1167 my ($self, $merge) = @_; 1903 my ($self, $merge) = @_;
1168 1904
1169 # we have to keep some variables in memory intact 1905 # we have to keep some variables in memory intact
1170 local $self->{path}; 1906 local $self->{path};
1171 local $self->{load_path}; 1907 local $self->{load_path};
1172 local $self->{deny_save};
1173 local $self->{deny_reset};
1174 1908
1175 $self->SUPER::thawer_merge ($merge); 1909 $self->SUPER::thawer_merge ($merge);
1176} 1910}
1177 1911
1178sub normalise { 1912sub normalise {
1179 my ($path, $base) = @_; 1913 my ($path, $base) = @_;
1180 1914
1181 $path = "$path"; # make sure its a string 1915 $path = "$path"; # make sure it's a string
1916
1917 $path =~ s/\.map$//;
1182 1918
1183 # map plan: 1919 # map plan:
1184 # 1920 #
1185 # /! non-realised random map exit (special hack!) 1921 # /! non-realised random map exit (special hack!)
1186 # {... are special paths that are not being touched 1922 # {... are special paths that are not being touched
1199 $base =~ s{[^/]+/?$}{}; 1935 $base =~ s{[^/]+/?$}{};
1200 $path = "$base/$path"; 1936 $path = "$base/$path";
1201 } 1937 }
1202 1938
1203 for ($path) { 1939 for ($path) {
1204 redo if s{//}{/};
1205 redo if s{/\.?/}{/}; 1940 redo if s{/\.?/}{/};
1206 redo if s{/[^/]+/\.\./}{/}; 1941 redo if s{/[^/]+/\.\./}{/};
1207 } 1942 }
1208 1943
1209 $path 1944 $path
1223 $self->init; # pass $1 etc. 1958 $self->init; # pass $1 etc.
1224 return $self; 1959 return $self;
1225 } 1960 }
1226 } 1961 }
1227 1962
1228 Carp::carp "unable to resolve path '$path' (base '$base')."; 1963 Carp::cluck "unable to resolve path '$path' (base '$base')";
1229 () 1964 ()
1230} 1965}
1231 1966
1232sub init { 1967sub init {
1233 my ($self) = @_; 1968 my ($self) = @_;
1248 1983
1249# the original (read-only) location 1984# the original (read-only) location
1250sub load_path { 1985sub load_path {
1251 my ($self) = @_; 1986 my ($self) = @_;
1252 1987
1253 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1988 "$MAPDIR/$self->{path}.map"
1254} 1989}
1255 1990
1256# the temporary/swap location 1991# the temporary/swap location
1257sub save_path { 1992sub save_path {
1258 my ($self) = @_; 1993 my ($self) = @_;
1259 1994
1260 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1995 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1261 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1996 "$TMPDIR/$path.map"
1262} 1997}
1263 1998
1264# the unique path, undef == no special unique path 1999# the unique path, undef == no special unique path
1265sub uniq_path { 2000sub uniq_path {
1266 my ($self) = @_; 2001 my ($self) = @_;
1267 2002
1268 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 2003 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1269 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 2004 "$UNIQUEDIR/$path"
1270} 2005}
1271 2006
1272# and all this just because we cannot iterate over 2007sub decay_objects {
1273# all maps in C++...
1274sub change_all_map_light {
1275 my ($change) = @_; 2008 my ($self) = @_;
1276 2009
1277 $_->change_map_light ($change) 2010 return if $self->{deny_reset};
1278 for grep $_->outdoor, values %cf::MAP; 2011
2012 $self->do_decay_objects;
1279} 2013}
1280 2014
1281sub unlink_save { 2015sub unlink_save {
1282 my ($self) = @_; 2016 my ($self) = @_;
1283 2017
1288 2022
1289sub load_header_from($) { 2023sub load_header_from($) {
1290 my ($self, $path) = @_; 2024 my ($self, $path) = @_;
1291 2025
1292 utf8::encode $path; 2026 utf8::encode $path;
1293 aio_open $path, O_RDONLY, 0 2027 my $f = new_from_file cf::object::thawer $path
1294 or return; 2028 or return;
1295 2029
1296 $self->_load_header ($path) 2030 $self->_load_header ($f)
1297 or return; 2031 or return;
2032
2033 local $MAP_LOADING{$self->{path}} = $self;
2034 $f->resolve_delayed_derefs;
1298 2035
1299 $self->{load_path} = $path; 2036 $self->{load_path} = $path;
1300 2037
1301 1 2038 1
1302} 2039}
1341 $self->load_header_orig 2078 $self->load_header_orig
1342 or return; 2079 or return;
1343 $self->prepare_orig; 2080 $self->prepare_orig;
1344 } 2081 }
1345 2082
2083 $self->{deny_reset} = 1
2084 if $self->no_reset;
2085
2086 $self->default_region (cf::region::find_by_path $self->{path})
2087 unless $self->default_region;
2088
1346 1 2089 1
1347} 2090}
1348 2091
1349sub find; 2092sub find;
1350sub find { 2093sub find {
1351 my ($path, $origin) = @_; 2094 my ($path, $origin) = @_;
1352 2095
2096 cf::cede_to_tick;
2097
1353 $path = normalise $path, $origin && $origin->path; 2098 $path = normalise $path, $origin && $origin->path;
1354 2099
2100 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1355 cf::lock_wait "map_find:$path"; 2101 my $guard2 = cf::lock_acquire "map_find:$path";
1356 2102
1357 $cf::MAP{$path} || do { 2103 $cf::MAP{$path} || do {
1358 my $guard = cf::lock_acquire "map_find:$path";
1359 my $map = new_from_path cf::map $path 2104 my $map = new_from_path cf::map $path
1360 or return; 2105 or return;
1361 2106
1362 $map->{last_save} = $cf::RUNTIME; 2107 $map->{last_save} = $cf::RUNTIME;
1363 2108
1364 $map->load_header 2109 $map->load_header
1365 or return; 2110 or return;
1366 2111
1367 if ($map->should_reset) { 2112 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368 # doing this can freeze the server in a sync job, obviously 2113 # doing this can freeze the server in a sync job, obviously
1369 #$cf::WAIT_FOR_TICK->wait; 2114 #$cf::WAIT_FOR_TICK->wait;
2115 undef $guard2;
2116 undef $guard1;
1370 $map->reset; 2117 $map->reset;
1371 undef $guard;
1372 return find $path; 2118 return find $path;
1373 } 2119 }
1374 2120
1375 $cf::MAP{$path} = $map 2121 $cf::MAP{$path} = $map
1376 } 2122 }
1377} 2123}
1378 2124
1379sub pre_load { } 2125sub pre_load { }
1380sub post_load { } 2126#sub post_load { } # XS
1381 2127
1382sub load { 2128sub load {
1383 my ($self) = @_; 2129 my ($self) = @_;
1384 2130
2131 local $self->{deny_reset} = 1; # loading can take a long time
2132
1385 my $path = $self->{path}; 2133 my $path = $self->{path};
2134
2135 {
1386 my $guard = cf::lock_acquire "map_load:$path"; 2136 my $guard = cf::lock_acquire "map_data:$path";
1387 2137
2138 return unless $self->valid;
1388 return if $self->in_memory != cf::MAP_SWAPPED; 2139 return unless $self->in_memory == cf::MAP_SWAPPED;
1389 2140
1390 $self->in_memory (cf::MAP_LOADING); 2141 $self->in_memory (cf::MAP_LOADING);
1391 2142
1392 $self->alloc; 2143 $self->alloc;
1393 2144
1394 $self->pre_load; 2145 $self->pre_load;
2146 cf::cede_to_tick;
1395 2147
1396 $self->_load_objects ($self->{load_path}, 1) 2148 my $f = new_from_file cf::object::thawer $self->{load_path};
2149 $f->skip_block;
2150 $self->_load_objects ($f)
1397 or return; 2151 or return;
1398 2152
1399 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2153 $self->post_load_original
1400 if delete $self->{load_original}; 2154 if delete $self->{load_original};
1401 2155
1402 if (my $uniq = $self->uniq_path) { 2156 if (my $uniq = $self->uniq_path) {
1403 utf8::encode $uniq; 2157 utf8::encode $uniq;
1404 if (aio_open $uniq, O_RDONLY, 0) { 2158 unless (aio_stat $uniq) {
2159 if (my $f = new_from_file cf::object::thawer $uniq) {
1405 $self->clear_unique_items; 2160 $self->clear_unique_items;
1406 $self->_load_objects ($uniq, 0); 2161 $self->_load_objects ($f);
2162 $f->resolve_delayed_derefs;
2163 }
1407 } 2164 }
1408 } 2165 }
1409 2166
1410 Coro::cede; 2167 $f->resolve_delayed_derefs;
1411 2168
2169 cf::cede_to_tick;
1412 # now do the right thing for maps 2170 # now do the right thing for maps
1413 $self->link_multipart_objects; 2171 $self->link_multipart_objects;
1414
1415 unless ($self->{deny_activate}) {
1416 $self->decay_objects;
1417 $self->fix_auto_apply;
1418 $self->update_buttons;
1419 Coro::cede;
1420 $self->set_darkness_map;
1421 $self->difficulty ($self->estimate_difficulty) 2172 $self->difficulty ($self->estimate_difficulty)
1422 unless $self->difficulty; 2173 unless $self->difficulty;
1423 Coro::cede; 2174 cf::cede_to_tick;
2175
2176 unless ($self->{deny_activate}) {
2177 $self->decay_objects;
2178 $self->fix_auto_apply;
2179 $self->update_buttons;
2180 cf::cede_to_tick;
1424 $self->activate; 2181 $self->activate;
2182 }
2183
2184 $self->{last_save} = $cf::RUNTIME;
2185 $self->last_access ($cf::RUNTIME);
2186
2187 $self->in_memory (cf::MAP_ACTIVE);
1425 } 2188 }
1426 2189
1427 $self->post_load; 2190 $self->post_load;
1428
1429 $self->in_memory (cf::MAP_IN_MEMORY);
1430} 2191}
1431 2192
2193# customize the map for a given player, i.e.
2194# return the _real_ map. used by e.g. per-player
2195# maps to change the path to ~playername/mappath
1432sub customise_for { 2196sub customise_for {
1433 my ($self, $ob) = @_; 2197 my ($self, $ob) = @_;
1434 2198
1435 return find "~" . $ob->name . "/" . $self->{path} 2199 return find "~" . $ob->name . "/" . $self->{path}
1436 if $self->per_player; 2200 if $self->per_player;
1437 2201
2202# return find "?party/" . $ob->name . "/" . $self->{path}
2203# if $self->per_party;
2204
1438 $self 2205 $self
1439} 2206}
1440 2207
1441# find and load all maps in the 3x3 area around a map 2208# find and load all maps in the 3x3 area around a map
1442sub load_diag { 2209sub load_neighbours {
1443 my ($map) = @_; 2210 my ($map) = @_;
1444 2211
1445 my @diag; # diagonal neighbours 2212 my @neigh; # diagonal neighbours
1446 2213
1447 for (0 .. 3) { 2214 for (0 .. 3) {
1448 my $neigh = $map->tile_path ($_) 2215 my $neigh = $map->tile_path ($_)
1449 or next; 2216 or next;
1450 $neigh = find $neigh, $map 2217 $neigh = find $neigh, $map
1451 or next; 2218 or next;
1452 $neigh->load; 2219 $neigh->load;
1453 2220
2221 # now find the diagonal neighbours
2222 push @neigh,
1454 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2223 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1455 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2224 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1456 } 2225 }
1457 2226
1458 for (@diag) { 2227 for (grep defined $_->[0], @neigh) {
2228 my ($path, $origin) = @$_;
1459 my $neigh = find @$_ 2229 my $neigh = find $path, $origin
1460 or next; 2230 or next;
1461 $neigh->load; 2231 $neigh->load;
1462 } 2232 }
1463} 2233}
1464 2234
1465sub find_sync { 2235sub find_sync {
1466 my ($path, $origin) = @_; 2236 my ($path, $origin) = @_;
1467 2237
1468 cf::sync_job { find $path, $origin } 2238 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2239 if $Coro::current == $Coro::main;
2240
2241 find $path, $origin
1469} 2242}
1470 2243
1471sub do_load_sync { 2244sub do_load_sync {
1472 my ($map) = @_; 2245 my ($map) = @_;
1473 2246
1474 cf::sync_job { $map->load }; 2247 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2248 if $Coro::current == $Coro::main;
2249
2250 $map->load;
1475} 2251}
1476 2252
1477our %MAP_PREFETCH; 2253our %MAP_PREFETCH;
1478our $MAP_PREFETCHER = undef; 2254our $MAP_PREFETCHER = undef;
1479 2255
1480sub find_async { 2256sub find_async {
1481 my ($path, $origin) = @_; 2257 my ($path, $origin, $load) = @_;
1482 2258
1483 $path = normalise $path, $origin && $origin->{path}; 2259 $path = normalise $path, $origin && $origin->{path};
1484 2260
1485 if (my $map = $cf::MAP{$path}) { 2261 if (my $map = $cf::MAP{$path}) {
1486 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2262 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1487 } 2263 }
1488 2264
1489 undef $MAP_PREFETCH{$path}; 2265 $MAP_PREFETCH{$path} |= $load;
2266
1490 $MAP_PREFETCHER ||= cf::async { 2267 $MAP_PREFETCHER ||= cf::async {
2268 $Coro::current->{desc} = "map prefetcher";
2269
1491 while (%MAP_PREFETCH) { 2270 while (%MAP_PREFETCH) {
1492 for my $path (keys %MAP_PREFETCH) { 2271 while (my ($k, $v) = each %MAP_PREFETCH) {
1493 my $map = find $path 2272 if (my $map = find $k) {
1494 or next;
1495 $map->load; 2273 $map->load if $v;
2274 }
1496 2275
1497 delete $MAP_PREFETCH{$path}; 2276 delete $MAP_PREFETCH{$k};
1498 } 2277 }
1499 } 2278 }
1500 undef $MAP_PREFETCHER; 2279 undef $MAP_PREFETCHER;
1501 }; 2280 };
1502 $MAP_PREFETCHER->prio (6); 2281 $MAP_PREFETCHER->prio (6);
1503 2282
1504 () 2283 ()
1505} 2284}
1506 2285
2286# common code, used by both ->save and ->swapout
1507sub save { 2287sub _save {
1508 my ($self) = @_; 2288 my ($self) = @_;
1509
1510 my $lock = cf::lock_acquire "map_data:" . $self->path;
1511 2289
1512 $self->{last_save} = $cf::RUNTIME; 2290 $self->{last_save} = $cf::RUNTIME;
1513 2291
1514 return unless $self->dirty; 2292 return unless $self->dirty;
1515 2293
1521 return if $self->{deny_save}; 2299 return if $self->{deny_save};
1522 2300
1523 local $self->{last_access} = $self->last_access;#d# 2301 local $self->{last_access} = $self->last_access;#d#
1524 2302
1525 cf::async { 2303 cf::async {
2304 $Coro::current->{desc} = "map player save";
1526 $_->contr->save for $self->players; 2305 $_->contr->save for $self->players;
1527 }; 2306 };
2307
2308 cf::get_slot 0.02;
1528 2309
1529 if ($uniq) { 2310 if ($uniq) {
1530 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2311 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1531 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2312 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1532 } else { 2313 } else {
1533 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2314 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1534 } 2315 }
1535} 2316}
1536 2317
2318sub save {
2319 my ($self) = @_;
2320
2321 my $lock = cf::lock_acquire "map_data:$self->{path}";
2322
2323 $self->_save;
2324}
2325
1537sub swap_out { 2326sub swap_out {
1538 my ($self) = @_; 2327 my ($self) = @_;
1539 2328
1540 # save first because save cedes
1541 $self->save;
1542
1543 my $lock = cf::lock_acquire "map_data:" . $self->path; 2329 my $lock = cf::lock_acquire "map_data:$self->{path}";
1544 2330
2331 return if $self->in_memory != cf::MAP_ACTIVE;
2332 return if $self->{deny_save};
1545 return if $self->players; 2333 return if $self->players;
1546 return if $self->in_memory != cf::MAP_IN_MEMORY;
1547 return if $self->{deny_save};
1548 2334
2335 # first deactivate the map and "unlink" it from the core
2336 $self->deactivate;
2337 $_->clear_links_to ($self) for values %cf::MAP;
2338 $self->in_memory (cf::MAP_SWAPPED);
2339
2340 # then atomically save
2341 $self->_save;
2342
2343 # then free the map
1549 $self->clear; 2344 $self->clear;
1550 $self->in_memory (cf::MAP_SWAPPED);
1551} 2345}
1552 2346
1553sub reset_at { 2347sub reset_at {
1554 my ($self) = @_; 2348 my ($self) = @_;
1555 2349
1556 # TODO: safety, remove and allow resettable per-player maps 2350 # TODO: safety, remove and allow resettable per-player maps
1557 return 1e99 if $self->isa ("ext::map_per_player");#d#
1558 return 1e99 if $self->{deny_reset}; 2351 return 1e99 if $self->{deny_reset};
1559 2352
1560 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2353 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1561 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2354 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1562 2355
1573 my ($self) = @_; 2366 my ($self) = @_;
1574 2367
1575 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2368 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2369
1577 return if $self->players; 2370 return if $self->players;
1578 return if $self->isa ("ext::map_per_player");#d#
1579 2371
1580 warn "resetting map ", $self->path;#d# 2372 cf::trace "resetting map ", $self->path, "\n";
2373
2374 $self->in_memory (cf::MAP_SWAPPED);
2375
2376 # need to save uniques path
2377 unless ($self->{deny_save}) {
2378 my $uniq = $self->uniq_path; utf8::encode $uniq;
2379
2380 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2381 if $uniq;
2382 }
1581 2383
1582 delete $cf::MAP{$self->path}; 2384 delete $cf::MAP{$self->path};
1583 2385
1584 $self->in_memory (cf::MAP_SWAPPED); 2386 $self->deactivate;
2387 $_->clear_links_to ($self) for values %cf::MAP;
1585 $self->clear; 2388 $self->clear;
1586
1587 $_->clear_links_to ($self) for values %cf::MAP;
1588 2389
1589 $self->unlink_save; 2390 $self->unlink_save;
1590 $self->destroy; 2391 $self->destroy;
1591} 2392}
1592 2393
1593my $nuke_counter = "aaaa"; 2394my $nuke_counter = "aaaa";
1594 2395
1595sub nuke { 2396sub nuke {
1596 my ($self) = @_; 2397 my ($self) = @_;
1597 2398
2399 {
2400 my $lock = cf::lock_acquire "map_data:$self->{path}";
2401
1598 delete $cf::MAP{$self->path}; 2402 delete $cf::MAP{$self->path};
1599 2403
1600 $self->unlink_save; 2404 $self->unlink_save;
1601 2405
1602 bless $self, "cf::map"; 2406 bless $self, "cf::map::wrap";
1603 delete $self->{deny_reset}; 2407 delete $self->{deny_reset};
1604 $self->{deny_save} = 1; 2408 $self->{deny_save} = 1;
1605 $self->reset_timeout (1); 2409 $self->reset_timeout (1);
1606 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2410 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1607 2411
1608 $cf::MAP{$self->path} = $self; 2412 $cf::MAP{$self->path} = $self;
2413 }
1609 2414
1610 $self->reset; # polite request, might not happen 2415 $self->reset; # polite request, might not happen
2416}
2417
2418=item $maps = cf::map::tmp_maps
2419
2420Returns an arrayref with all map paths of currently instantiated and saved
2421maps. May block.
2422
2423=cut
2424
2425sub tmp_maps() {
2426 [
2427 map {
2428 utf8::decode $_;
2429 /\.map$/
2430 ? normalise $_
2431 : ()
2432 } @{ aio_readdir $TMPDIR or [] }
2433 ]
2434}
2435
2436=item $maps = cf::map::random_maps
2437
2438Returns an arrayref with all map paths of currently instantiated and saved
2439random maps. May block.
2440
2441=cut
2442
2443sub random_maps() {
2444 [
2445 map {
2446 utf8::decode $_;
2447 /\.map$/
2448 ? normalise "?random/$_"
2449 : ()
2450 } @{ aio_readdir $RANDOMDIR or [] }
2451 ]
1611} 2452}
1612 2453
1613=item cf::map::unique_maps 2454=item cf::map::unique_maps
1614 2455
1615Returns an arrayref of paths of all shared maps that have 2456Returns an arrayref of paths of all shared maps that have
1616instantiated unique items. May block. 2457instantiated unique items. May block.
1617 2458
1618=cut 2459=cut
1619 2460
1620sub unique_maps() { 2461sub unique_maps() {
1621 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2462 [
1622 or return; 2463 map {
1623
1624 my @paths;
1625
1626 for (@$files) {
1627 utf8::decode $_; 2464 utf8::decode $_;
1628 next if /\.pst$/; 2465 s/\.map$//; # TODO future compatibility hack
1629 next unless /^$PATH_SEP/o; 2466 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2467 ? ()
2468 : normalise $_
2469 } @{ aio_readdir $UNIQUEDIR or [] }
2470 ]
2471}
1630 2472
2473=item cf::map::static_maps
2474
2475Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2476file in the shared directory excluding F</styles> and F</editor>). May
2477block.
2478
2479=cut
2480
2481sub static_maps() {
2482 my @dirs = "";
2483 my @maps;
2484
2485 while (@dirs) {
2486 my $dir = shift @dirs;
2487
2488 next if $dir eq "/styles" || $dir eq "/editor";
2489
2490 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2491 or return;
2492
2493 for (@$files) {
1631 s/\.map$//; 2494 s/\.map$// or next;
1632 push @paths, $_; 2495 utf8::decode $_;
1633 } 2496 push @maps, "$dir/$_";
2497 }
1634 2498
1635 \@paths 2499 push @dirs, map "$dir/$_", @$dirs;
1636} 2500 }
1637 2501
1638package cf; 2502 \@maps
2503}
1639 2504
1640=back 2505=back
1641 2506
1642=head3 cf::object 2507=head3 cf::object
1643 2508
1647 2512
1648=over 4 2513=over 4
1649 2514
1650=item $ob->inv_recursive 2515=item $ob->inv_recursive
1651 2516
1652Returns the inventory of the object _and_ their inventories, recursively. 2517Returns the inventory of the object I<and> their inventories, recursively,
2518but I<not> the object itself.
1653 2519
1654=cut 2520=cut
1655 2521
1656sub inv_recursive_; 2522sub inv_recursive_;
1657sub inv_recursive_ { 2523sub inv_recursive_ {
1660 2526
1661sub inv_recursive { 2527sub inv_recursive {
1662 inv_recursive_ inv $_[0] 2528 inv_recursive_ inv $_[0]
1663} 2529}
1664 2530
2531=item $ref = $ob->ref
2532
2533Creates and returns a persistent reference to an object that can be stored as a string.
2534
2535=item $ob = cf::object::deref ($refstring)
2536
2537returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2538even if the object actually exists. May block.
2539
2540=cut
2541
2542sub deref {
2543 my ($ref) = @_;
2544
2545 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2546 my ($uuid, $name) = ($1, $2);
2547 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2548 or return;
2549 $pl->ob->uuid eq $uuid
2550 or return;
2551
2552 $pl->ob
2553 } else {
2554 warn "$ref: cannot resolve object reference\n";
2555 undef
2556 }
2557}
2558
1665package cf; 2559package cf;
1666 2560
1667=back 2561=back
1668 2562
1669=head3 cf::object::player 2563=head3 cf::object::player
1675Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2569Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1676can be C<undef>. Does the right thing when the player is currently in a 2570can be C<undef>. Does the right thing when the player is currently in a
1677dialogue with the given NPC character. 2571dialogue with the given NPC character.
1678 2572
1679=cut 2573=cut
2574
2575our $SAY_CHANNEL = {
2576 id => "say",
2577 title => "Map",
2578 reply => "say ",
2579 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2580};
2581
2582our $CHAT_CHANNEL = {
2583 id => "chat",
2584 title => "Chat",
2585 reply => "chat ",
2586 tooltip => "Player chat and shouts, global to the server.",
2587};
1680 2588
1681# rough implementation of a future "reply" method that works 2589# rough implementation of a future "reply" method that works
1682# with dialog boxes. 2590# with dialog boxes.
1683#TODO: the first argument must go, split into a $npc->reply_to ( method 2591#TODO: the first argument must go, split into a $npc->reply_to ( method
1684sub cf::object::player::reply($$$;$) { 2592sub cf::object::player::reply($$$;$) {
1686 2594
1687 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2595 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1688 2596
1689 if ($self->{record_replies}) { 2597 if ($self->{record_replies}) {
1690 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2598 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2599
1691 } else { 2600 } else {
2601 my $pl = $self->contr;
2602
2603 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2604 my $dialog = $pl->{npc_dialog};
2605 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2606
2607 } else {
1692 $msg = $npc->name . " says: $msg" if $npc; 2608 $msg = $npc->name . " says: $msg" if $npc;
1693 $self->message ($msg, $flags); 2609 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2610 }
1694 } 2611 }
2612}
2613
2614=item $object->send_msg ($channel, $msg, $color, [extra...])
2615
2616=cut
2617
2618sub cf::object::send_msg {
2619 my $pl = shift->contr
2620 or return;
2621 $pl->send_msg (@_);
1695} 2622}
1696 2623
1697=item $player_object->may ("access") 2624=item $player_object->may ("access")
1698 2625
1699Returns wether the given player is authorized to access resource "access" 2626Returns wether the given player is authorized to access resource "access"
1712 2639
1713=item $player_object->enter_link 2640=item $player_object->enter_link
1714 2641
1715Freezes the player and moves him/her to a special map (C<{link}>). 2642Freezes the player and moves him/her to a special map (C<{link}>).
1716 2643
1717The player should be reasonably safe there for short amounts of time. You 2644The player should be reasonably safe there for short amounts of time (e.g.
1718I<MUST> call C<leave_link> as soon as possible, though. 2645for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2646though, as the player cannot control the character while it is on the link
2647map.
1719 2648
1720Will never block. 2649Will never block.
1721 2650
1722=item $player_object->leave_link ($map, $x, $y) 2651=item $player_object->leave_link ($map, $x, $y)
1723 2652
1731=cut 2660=cut
1732 2661
1733sub link_map { 2662sub link_map {
1734 unless ($LINK_MAP) { 2663 unless ($LINK_MAP) {
1735 $LINK_MAP = cf::map::find "{link}" 2664 $LINK_MAP = cf::map::find "{link}"
1736 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2665 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1737 $LINK_MAP->load; 2666 $LINK_MAP->load;
1738 } 2667 }
1739 2668
1740 $LINK_MAP 2669 $LINK_MAP
1741} 2670}
1743sub cf::object::player::enter_link { 2672sub cf::object::player::enter_link {
1744 my ($self) = @_; 2673 my ($self) = @_;
1745 2674
1746 $self->deactivate_recursive; 2675 $self->deactivate_recursive;
1747 2676
2677 ++$self->{_link_recursion};
2678
1748 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2679 return if UNIVERSAL::isa $self->map, "ext::map_link";
1749 2680
1750 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2681 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1751 if $self->map; 2682 if $self->map && $self->map->{path} ne "{link}";
1752 2683
1753 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2684 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1754} 2685}
1755 2686
1756sub cf::object::player::leave_link { 2687sub cf::object::player::leave_link {
1757 my ($self, $map, $x, $y) = @_; 2688 my ($self, $map, $x, $y) = @_;
2689
2690 return unless $self->contr->active;
1758 2691
1759 my $link_pos = delete $self->{_link_pos}; 2692 my $link_pos = delete $self->{_link_pos};
1760 2693
1761 unless ($map) { 2694 unless ($map) {
1762 # restore original map position 2695 # restore original map position
1773 ($x, $y) = (-1, -1) 2706 ($x, $y) = (-1, -1)
1774 unless (defined $x) && (defined $y); 2707 unless (defined $x) && (defined $y);
1775 2708
1776 # use -1 or undef as default coordinates, not 0, 0 2709 # use -1 or undef as default coordinates, not 0, 0
1777 ($x, $y) = ($map->enter_x, $map->enter_y) 2710 ($x, $y) = ($map->enter_x, $map->enter_y)
1778 if $x <=0 && $y <= 0; 2711 if $x <= 0 && $y <= 0;
1779 2712
1780 $map->load; 2713 $map->load;
1781 $map->load_diag; 2714 $map->load_neighbours;
1782 2715
1783 return unless $self->contr->active; 2716 return unless $self->contr->active;
2717
2718 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2719 if ($self->enter_map ($map, $x, $y)) {
2720 # entering was successful
2721 delete $self->{_link_recursion};
2722 # only activate afterwards, to support waiting in hooks
1784 $self->activate_recursive; 2723 $self->activate_recursive;
1785 $self->enter_map ($map, $x, $y);
1786}
1787
1788cf::player->attach (
1789 on_logout => sub {
1790 my ($pl) = @_;
1791
1792 # abort map switching before logout
1793 if ($pl->ob->{_link_pos}) {
1794 cf::sync_job {
1795 $pl->ob->leave_link
1796 };
1797 }
1798 }, 2724 }
1799 on_login => sub {
1800 my ($pl) = @_;
1801 2725
1802 # try to abort aborted map switching on player login :) 2726}
1803 # should happen only on crashes
1804 if ($pl->ob->{_link_pos}) {
1805 $pl->ob->enter_link;
1806 (async {
1807 # we need this sleep as the login has a concurrent enter_exit running
1808 # and this sleep increases chances of the player not ending up in scorn
1809 $pl->ob->reply (undef,
1810 "There was an internal problem at your last logout, "
1811 . "the server will try to bring you to your intended destination in a second.",
1812 cf::NDI_RED);
1813 Coro::Timer::sleep 1;
1814 $pl->ob->leave_link;
1815 })->prio (2);
1816 }
1817 },
1818);
1819 2727
1820=item $player_object->goto ($path, $x, $y) 2728=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1821 2729
2730Moves the player to the given map-path and coordinates by first freezing
2731her, loading and preparing them map, calling the provided $check callback
2732that has to return the map if sucecssful, and then unfreezes the player on
2733the new (success) or old (failed) map position. In either case, $done will
2734be called at the end of this process.
2735
2736Note that $check will be called with a potentially non-loaded map, so if
2737it needs a loaded map it has to call C<< ->load >>.
2738
1822=cut 2739=cut
2740
2741our $GOTOGEN;
1823 2742
1824sub cf::object::player::goto { 2743sub cf::object::player::goto {
1825 my ($self, $path, $x, $y) = @_; 2744 my ($self, $path, $x, $y, $check, $done) = @_;
2745
2746 if ($self->{_link_recursion} >= $MAX_LINKS) {
2747 error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
2748 $self->failmsg ("Something went wrong inside the server - please contact an administrator!");
2749 ($path, $x, $y) = @$EMERGENCY_POSITION;
2750 }
2751
2752 # do generation counting so two concurrent goto's will be executed in-order
2753 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1826 2754
1827 $self->enter_link; 2755 $self->enter_link;
1828 2756
1829 (async { 2757 (async {
1830 my $map = cf::map::find $path; 2758 $Coro::current->{desc} = "player::goto $path $x $y";
2759
2760 # *tag paths override both path and x|y
2761 if ($path =~ /^\*(.*)$/) {
2762 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2763 my $ob = $obs[rand @obs];
2764
2765 # see if we actually can go there
2766 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2767 $ob = $obs[rand @obs];
2768 } else {
2769 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2770 }
2771 # else put us there anyways for now #d#
2772
2773 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2774 } else {
2775 ($path, $x, $y) = (undef, undef, undef);
2776 }
2777 }
2778
2779 my $map = eval {
2780 my $map = defined $path ? cf::map::find $path : undef;
2781
2782 if ($map) {
1831 $map = $map->customise_for ($self) if $map; 2783 $map = $map->customise_for ($self);
1832 2784 $map = $check->($map, $x, $y, $self) if $check && $map;
1833# warn "entering ", $map->path, " at ($x, $y)\n" 2785 } else {
1834# if $map;
1835
1836 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2786 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2787 }
1837 2788
2789 $map
2790 };
2791
2792 if ($@) {
2793 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2794 LOG llevError | logBacktrace, Carp::longmess $@;
2795 }
2796
2797 if ($gen == $self->{_goto_generation}) {
2798 delete $self->{_goto_generation};
1838 $self->leave_link ($map, $x, $y); 2799 $self->leave_link ($map, $x, $y);
2800 }
2801
2802 $done->($self) if $done;
1839 })->prio (1); 2803 })->prio (1);
1840} 2804}
1841 2805
1842=item $player_object->enter_exit ($exit_object) 2806=item $player_object->enter_exit ($exit_object)
1843 2807
1863} 2827}
1864 2828
1865sub prepare_random_map { 2829sub prepare_random_map {
1866 my ($exit) = @_; 2830 my ($exit) = @_;
1867 2831
1868 my $guard = cf::lock_acquire "exit_prepare:$exit";
1869
1870 # all this does is basically replace the /! path by 2832 # all this does is basically replace the /! path by
1871 # a new random map path (?random/...) with a seed 2833 # a new random map path (?random/...) with a seed
1872 # that depends on the exit object 2834 # that depends on the exit object
1873 2835
1874 my $rmp = parse_random_map_params $exit->msg; 2836 my $rmp = parse_random_map_params $exit->msg;
1875 2837
1876 if ($exit->map) { 2838 if ($exit->map) {
1877 $rmp->{region} = $exit->map->region_name; 2839 $rmp->{region} = $exit->region->name;
1878 $rmp->{origin_map} = $exit->map->path; 2840 $rmp->{origin_map} = $exit->map->path;
1879 $rmp->{origin_x} = $exit->x; 2841 $rmp->{origin_x} = $exit->x;
1880 $rmp->{origin_y} = $exit->y; 2842 $rmp->{origin_y} = $exit->y;
2843
2844 $exit->map->touch;
1881 } 2845 }
1882 2846
1883 $rmp->{random_seed} ||= $exit->random_seed; 2847 $rmp->{random_seed} ||= $exit->random_seed;
1884 2848
1885 my $data = cf::to_json $rmp; 2849 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1886 my $md5 = Digest::MD5::md5_hex $data; 2850 my $md5 = Digest::MD5::md5_hex $data;
1887 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2851 my $meta = "$RANDOMDIR/$md5.meta";
1888 2852
1889 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2853 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1890 aio_write $fh, 0, (length $data), $data, 0; 2854 aio_write $fh, 0, (length $data), $data, 0;
1891 undef $fh; 2855 undef $fh;
1892 aio_rename "$meta~", $meta; 2856 aio_rename "$meta~", $meta;
1893 2857
2858 my $slaying = "?random/$md5";
2859
2860 if ($exit->valid) {
1894 $exit->slaying ("?random/$md5"); 2861 $exit->slaying ("?random/$md5");
1895 $exit->msg (undef); 2862 $exit->msg (undef);
2863 }
1896 } 2864 }
1897} 2865}
1898 2866
1899sub cf::object::player::enter_exit { 2867sub cf::object::player::enter_exit {
1900 my ($self, $exit) = @_; 2868 my ($self, $exit) = @_;
1902 return unless $self->type == cf::PLAYER; 2870 return unless $self->type == cf::PLAYER;
1903 2871
1904 $self->enter_link; 2872 $self->enter_link;
1905 2873
1906 (async { 2874 (async {
1907 $self->deactivate_recursive; # just to be sure 2875 $Coro::current->{desc} = "enter_exit";
2876
1908 unless (eval { 2877 unless (eval {
2878 $self->deactivate_recursive; # just to be sure
2879
2880 # random map handling
2881 {
2882 my $guard = cf::lock_acquire "exit_prepare:$exit";
2883
1909 prepare_random_map $exit 2884 prepare_random_map $exit
1910 if $exit->slaying eq "/!"; 2885 if $exit->slaying eq "/!";
2886 }
1911 2887
1912 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path; 2888 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1913 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2889 my $x = $exit->stats->hp;
2890 my $y = $exit->stats->sp;
1914 2891
2892 $self->goto ($map, $x, $y);
2893
2894 # if exit is damned, update players death & WoR home-position
2895 $self->contr->savebed ($map, $x, $y)
2896 if $exit->flag (cf::FLAG_DAMNED);
2897
1915 1; 2898 1
1916 }) { 2899 }) {
1917 $self->message ("Something went wrong deep within the crossfire server. " 2900 $self->message ("Something went wrong deep within the deliantra server. "
1918 . "I'll try to bring you back to the map you were before. " 2901 . "I'll try to bring you back to the map you were before. "
1919 . "Please report this to the dungeon master!", 2902 . "Please report this to the dungeon master!",
1920 cf::NDI_UNIQUE | cf::NDI_RED); 2903 cf::NDI_UNIQUE | cf::NDI_RED);
1921 2904
1922 warn "ERROR in enter_exit: $@"; 2905 error "ERROR in enter_exit: $@";
1923 $self->leave_link; 2906 $self->leave_link;
1924 } 2907 }
1925 })->prio (1); 2908 })->prio (1);
1926} 2909}
1927 2910
1938 2921
1939sub cf::client::send_drawinfo { 2922sub cf::client::send_drawinfo {
1940 my ($self, $text, $flags) = @_; 2923 my ($self, $text, $flags) = @_;
1941 2924
1942 utf8::encode $text; 2925 utf8::encode $text;
1943 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2926 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1944} 2927}
1945 2928
2929=item $client->send_big_packet ($pkt)
2930
2931Like C<send_packet>, but tries to compress large packets, and fragments
2932them as required.
2933
2934=cut
2935
2936our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2937
2938sub cf::client::send_big_packet {
2939 my ($self, $pkt) = @_;
2940
2941 # try lzf for large packets
2942 $pkt = "lzf " . Compress::LZF::compress $pkt
2943 if 1024 <= length $pkt and $self->{can_lzf};
2944
2945 # split very large packets
2946 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2947 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2948 $pkt = "frag";
2949 }
2950
2951 $self->send_packet ($pkt);
2952}
2953
2954=item $client->send_msg ($channel, $msg, $color, [extra...])
2955
2956Send a drawinfo or msg packet to the client, formatting the msg for the
2957client if neccessary. C<$type> should be a string identifying the type of
2958the message, with C<log> being the default. If C<$color> is negative, suppress
2959the message unless the client supports the msg packet.
2960
2961=cut
2962
2963# non-persistent channels (usually the info channel)
2964our %CHANNEL = (
2965 "c/motd" => {
2966 id => "infobox",
2967 title => "MOTD",
2968 reply => undef,
2969 tooltip => "The message of the day",
2970 },
2971 "c/identify" => {
2972 id => "infobox",
2973 title => "Identify",
2974 reply => undef,
2975 tooltip => "Items recently identified",
2976 },
2977 "c/examine" => {
2978 id => "infobox",
2979 title => "Examine",
2980 reply => undef,
2981 tooltip => "Signs and other items you examined",
2982 },
2983 "c/shopinfo" => {
2984 id => "infobox",
2985 title => "Shop Info",
2986 reply => undef,
2987 tooltip => "What your bargaining skill tells you about the shop",
2988 },
2989 "c/book" => {
2990 id => "infobox",
2991 title => "Book",
2992 reply => undef,
2993 tooltip => "The contents of a note or book",
2994 },
2995 "c/lookat" => {
2996 id => "infobox",
2997 title => "Look",
2998 reply => undef,
2999 tooltip => "What you saw there",
3000 },
3001 "c/who" => {
3002 id => "infobox",
3003 title => "Players",
3004 reply => undef,
3005 tooltip => "Shows players who are currently online",
3006 },
3007 "c/body" => {
3008 id => "infobox",
3009 title => "Body Parts",
3010 reply => undef,
3011 tooltip => "Shows which body parts you posess and are available",
3012 },
3013 "c/statistics" => {
3014 id => "infobox",
3015 title => "Statistics",
3016 reply => undef,
3017 tooltip => "Shows your primary statistics",
3018 },
3019 "c/skills" => {
3020 id => "infobox",
3021 title => "Skills",
3022 reply => undef,
3023 tooltip => "Shows your experience per skill and item power",
3024 },
3025 "c/shopitems" => {
3026 id => "infobox",
3027 title => "Shop Items",
3028 reply => undef,
3029 tooltip => "Shows the items currently for sale in this shop",
3030 },
3031 "c/resistances" => {
3032 id => "infobox",
3033 title => "Resistances",
3034 reply => undef,
3035 tooltip => "Shows your resistances",
3036 },
3037 "c/pets" => {
3038 id => "infobox",
3039 title => "Pets",
3040 reply => undef,
3041 tooltip => "Shows information abotu your pets/a specific pet",
3042 },
3043 "c/perceiveself" => {
3044 id => "infobox",
3045 title => "Perceive Self",
3046 reply => undef,
3047 tooltip => "You gained detailed knowledge about yourself",
3048 },
3049 "c/uptime" => {
3050 id => "infobox",
3051 title => "Uptime",
3052 reply => undef,
3053 tooltip => "How long the server has been running since last restart",
3054 },
3055 "c/mapinfo" => {
3056 id => "infobox",
3057 title => "Map Info",
3058 reply => undef,
3059 tooltip => "Information related to the maps",
3060 },
3061 "c/party" => {
3062 id => "party",
3063 title => "Party",
3064 reply => "gsay ",
3065 tooltip => "Messages and chat related to your party",
3066 },
3067 "c/death" => {
3068 id => "death",
3069 title => "Death",
3070 reply => undef,
3071 tooltip => "Reason for and more info about your most recent death",
3072 },
3073 "c/say" => $SAY_CHANNEL,
3074 "c/chat" => $CHAT_CHANNEL,
3075);
3076
3077sub cf::client::send_msg {
3078 my ($self, $channel, $msg, $color, @extra) = @_;
3079
3080 $msg = $self->pl->expand_cfpod ($msg)
3081 unless $color & cf::NDI_VERBATIM;
3082
3083 $color &= cf::NDI_CLIENT_MASK; # just in case...
3084
3085 # check predefined channels, for the benefit of C
3086 if ($CHANNEL{$channel}) {
3087 $channel = $CHANNEL{$channel};
3088
3089 $self->ext_msg (channel_info => $channel);
3090 $channel = $channel->{id};
3091
3092 } elsif (ref $channel) {
3093 # send meta info to client, if not yet sent
3094 unless (exists $self->{channel}{$channel->{id}}) {
3095 $self->{channel}{$channel->{id}} = $channel;
3096 $self->ext_msg (channel_info => $channel);
3097 }
3098
3099 $channel = $channel->{id};
3100 }
3101
3102 return unless @extra || length $msg;
3103
3104 # default colour, mask it out
3105 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3106 if $color & cf::NDI_DEF;
3107
3108 my $pkt = "msg "
3109 . $self->{json_coder}->encode (
3110 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3111 );
3112
3113 $self->send_big_packet ($pkt);
3114}
3115
3116=item $client->ext_msg ($type, @msg)
3117
3118Sends an ext event to the client.
3119
3120=cut
3121
3122sub cf::client::ext_msg($$@) {
3123 my ($self, $type, @msg) = @_;
3124
3125 if ($self->extcmd == 2) {
3126 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
3127 } elsif ($self->extcmd == 1) { # TODO: remove
3128 push @msg, msgtype => "event_$type";
3129 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3130 }
3131}
3132
3133=item $client->ext_reply ($msgid, @msg)
3134
3135Sends an ext reply to the client.
3136
3137=cut
3138
3139sub cf::client::ext_reply($$@) {
3140 my ($self, $id, @msg) = @_;
3141
3142 if ($self->extcmd == 2) {
3143 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
3144 } elsif ($self->extcmd == 1) {
3145 #TODO: version 1, remove
3146 unshift @msg, msgtype => "reply", msgid => $id;
3147 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3148 }
3149}
1946 3150
1947=item $success = $client->query ($flags, "text", \&cb) 3151=item $success = $client->query ($flags, "text", \&cb)
1948 3152
1949Queues a query to the client, calling the given callback with 3153Queues a query to the client, calling the given callback with
1950the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3154the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1951C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3155C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1952 3156
1953Queries can fail, so check the return code. Or don't, as queries will become 3157Queries can fail, so check the return code. Or don't, as queries will
1954reliable at some point in the future. 3158become reliable at some point in the future.
1955 3159
1956=cut 3160=cut
1957 3161
1958sub cf::client::query { 3162sub cf::client::query {
1959 my ($self, $flags, $text, $cb) = @_; 3163 my ($self, $flags, $text, $cb) = @_;
1967 utf8::encode $text; 3171 utf8::encode $text;
1968 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3172 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1969 3173
1970 $self->send_packet ($self->{query_queue}[0][0]) 3174 $self->send_packet ($self->{query_queue}[0][0])
1971 if @{ $self->{query_queue} } == 1; 3175 if @{ $self->{query_queue} } == 1;
3176
3177 1
1972} 3178}
1973 3179
1974cf::client->attach ( 3180cf::client->attach (
3181 on_connect => sub {
3182 my ($ns) = @_;
3183
3184 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3185 },
1975 on_reply => sub { 3186 on_reply => sub {
1976 my ($ns, $msg) = @_; 3187 my ($ns, $msg) = @_;
1977 3188
1978 # this weird shuffling is so that direct followup queries 3189 # this weird shuffling is so that direct followup queries
1979 # get handled first 3190 # get handled first
1980 my $queue = delete $ns->{query_queue} 3191 my $queue = delete $ns->{query_queue}
1981 or return; # be conservative, not sure how that can happen, but we saw a crash here 3192 or return; # be conservative, not sure how that can happen, but we saw a crash here
1982 3193
1983 (shift @$queue)->[1]->($msg); 3194 (shift @$queue)->[1]->($msg);
3195 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1984 3196
1985 push @{ $ns->{query_queue} }, @$queue; 3197 push @{ $ns->{query_queue} }, @$queue;
1986 3198
1987 if (@{ $ns->{query_queue} } == @$queue) { 3199 if (@{ $ns->{query_queue} } == @$queue) {
1988 if (@$queue) { 3200 if (@$queue) {
1990 } else { 3202 } else {
1991 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3203 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1992 } 3204 }
1993 } 3205 }
1994 }, 3206 },
3207 on_exticmd => sub {
3208 my ($ns, $buf) = @_;
3209
3210 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3211
3212 if (ref $msg) {
3213 my ($type, $reply, @payload) =
3214 "ARRAY" eq ref $msg
3215 ? @$msg
3216 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3217
3218 my @reply;
3219
3220 if (my $cb = $EXTICMD{$type}) {
3221 @reply = $cb->($ns, @payload);
3222 }
3223
3224 $ns->ext_reply ($reply, @reply)
3225 if $reply;
3226
3227 } else {
3228 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3229 }
3230
3231 cf::override;
3232 },
1995); 3233);
1996 3234
1997=item $client->async (\&cb) 3235=item $client->async (\&cb)
1998 3236
1999Create a new coroutine, running the specified callback. The coroutine will 3237Create a new coroutine, running the specified callback. The coroutine will
2015 3253
2016 $coro 3254 $coro
2017} 3255}
2018 3256
2019cf::client->attach ( 3257cf::client->attach (
2020 on_destroy => sub { 3258 on_client_destroy => sub {
2021 my ($ns) = @_; 3259 my ($ns) = @_;
2022 3260
2023 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3261 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2024 }, 3262 },
2025); 3263);
2040our $safe = new Safe "safe"; 3278our $safe = new Safe "safe";
2041our $safe_hole = new Safe::Hole; 3279our $safe_hole = new Safe::Hole;
2042 3280
2043$SIG{FPE} = 'IGNORE'; 3281$SIG{FPE} = 'IGNORE';
2044 3282
2045$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3283$safe->permit_only (Opcode::opset qw(
3284 :base_core :base_mem :base_orig :base_math :base_loop
3285 grepstart grepwhile mapstart mapwhile
3286 sort time
3287));
2046 3288
2047# here we export the classes and methods available to script code 3289# here we export the classes and methods available to script code
2048 3290
2049=pod 3291=pod
2050 3292
2051The following fucntions and emthods are available within a safe environment: 3293The following functions and methods are available within a safe environment:
2052 3294
2053 cf::object contr pay_amount pay_player map 3295 cf::object
3296 contr pay_amount pay_player map x y force_find force_add destroy
3297 insert remove name archname title slaying race decrease split
3298 value
3299
2054 cf::object::player player 3300 cf::object::player
2055 cf::player peaceful 3301 player
2056 cf::map trigger 3302
3303 cf::player
3304 peaceful
3305
3306 cf::map
3307 trigger
2057 3308
2058=cut 3309=cut
2059 3310
2060for ( 3311for (
2061 ["cf::object" => qw(contr pay_amount pay_player map)], 3312 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3313 insert remove inv nrof name archname title slaying race
3314 decrease split destroy change_exp value msg lore send_msg)],
2062 ["cf::object::player" => qw(player)], 3315 ["cf::object::player" => qw(player)],
2063 ["cf::player" => qw(peaceful)], 3316 ["cf::player" => qw(peaceful send_msg)],
2064 ["cf::map" => qw(trigger)], 3317 ["cf::map" => qw(trigger)],
2065) { 3318) {
2066 no strict 'refs';
2067 my ($pkg, @funs) = @$_; 3319 my ($pkg, @funs) = @$_;
2068 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3320 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2069 for @funs; 3321 for @funs;
2070} 3322}
2071 3323
2086 3338
2087 my $qcode = $code; 3339 my $qcode = $code;
2088 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3340 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2089 $qcode =~ s/\n/\\n/g; 3341 $qcode =~ s/\n/\\n/g;
2090 3342
3343 %vars = (_dummy => 0) unless %vars;
3344
3345 my @res;
2091 local $_; 3346 local $_;
2092 local @safe::cf::_safe_eval_args = values %vars;
2093 3347
2094 my $eval = 3348 my $eval =
2095 "do {\n" 3349 "do {\n"
2096 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3350 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2097 . "#line 0 \"{$qcode}\"\n" 3351 . "#line 0 \"{$qcode}\"\n"
2098 . $code 3352 . $code
2099 . "\n}" 3353 . "\n}"
2100 ; 3354 ;
2101 3355
3356 if ($CFG{safe_eval}) {
2102 sub_generation_inc; 3357 sub_generation_inc;
3358 local @safe::cf::_safe_eval_args = values %vars;
2103 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3359 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2104 sub_generation_inc; 3360 sub_generation_inc;
3361 } else {
3362 local @cf::_safe_eval_args = values %vars;
3363 @res = wantarray ? eval eval : scalar eval $eval;
3364 }
2105 3365
2106 if ($@) { 3366 if ($@) {
2107 warn "$@"; 3367 warn "$@",
2108 warn "while executing safe code '$code'\n"; 3368 "while executing safe code '$code'\n",
2109 warn "with arguments " . (join " ", %vars) . "\n"; 3369 "with arguments " . (join " ", %vars) . "\n";
2110 } 3370 }
2111 3371
2112 wantarray ? @res : $res[0] 3372 wantarray ? @res : $res[0]
2113} 3373}
2114 3374
2128=cut 3388=cut
2129 3389
2130sub register_script_function { 3390sub register_script_function {
2131 my ($fun, $cb) = @_; 3391 my ($fun, $cb) = @_;
2132 3392
2133 no strict 'refs'; 3393 $fun = "safe::$fun" if $CFG{safe_eval};
2134 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3394 *$fun = $safe_hole->wrap ($cb);
2135} 3395}
2136 3396
2137=back 3397=back
2138 3398
2139=cut 3399=cut
2140 3400
2141############################################################################# 3401#############################################################################
3402# the server's init and main functions
2142 3403
2143=head2 EXTENSION DATABASE SUPPORT 3404sub load_facedata($) {
3405 my ($path) = @_;
2144 3406
2145Crossfire maintains a very simple database for extension use. It can 3407 # HACK to clear player env face cache, we need some signal framework
2146currently store anything that can be serialised using Storable, which 3408 # for this (global event?)
2147excludes objects. 3409 %ext::player_env::MUSIC_FACE_CACHE = ();
2148 3410
2149The parameter C<$family> should best start with the name of the extension 3411 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2150using it, it should be unique.
2151 3412
2152=over 4 3413 trace "loading facedata from $path\n";
2153 3414
2154=item $hashref = cf::db_get $family 3415 0 < aio_load $path, my $facedata
3416 or die "$path: $!";
2155 3417
2156Return a hashref for use by the extension C<$family>, which can be 3418 $facedata = Coro::Storable::thaw $facedata;
2157modified. After modifications, you have to call C<cf::db_dirty> or
2158C<cf::db_sync>.
2159 3419
2160=item $value = cf::db_get $family => $key 3420 $facedata->{version} == 2
3421 or cf::cleanup "$path: version mismatch, cannot proceed.";
2161 3422
2162Returns a single value from the database 3423 # patch in the exptable
2163 3424 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2164=item cf::db_put $family => $hashref 3425 $facedata->{resource}{"res/exp_table"} = {
2165 3426 type => FT_RSRC,
2166Stores the given family hashref into the database. Updates are delayed, if 3427 data => $exp_table,
2167you want the data to be synced to disk immediately, use C<cf::db_sync>. 3428 hash => (Digest::MD5::md5 $exp_table),
2168
2169=item cf::db_put $family => $key => $value
2170
2171Stores the given C<$value> in the family hash. Updates are delayed, if you
2172want the data to be synced to disk immediately, use C<cf::db_sync>.
2173
2174=item cf::db_dirty
2175
2176Marks the database as dirty, to be updated at a later time.
2177
2178=item cf::db_sync
2179
2180Immediately write the database to disk I<if it is dirty>.
2181
2182=cut
2183
2184our $DB;
2185
2186{
2187 my $path = cf::localdir . "/database.pst";
2188
2189 sub db_load() {
2190 $DB = stat $path ? Storable::retrieve $path : { };
2191 } 3429 };
3430 cf::cede_to_tick;
2192 3431
2193 my $pid;
2194
2195 sub db_save() {
2196 waitpid $pid, 0 if $pid;
2197 if (0 == ($pid = fork)) {
2198 $DB->{_meta}{version} = 1;
2199 Storable::nstore $DB, "$path~";
2200 rename "$path~", $path;
2201 cf::_exit 0 if defined $pid;
2202 }
2203 } 3432 {
3433 my $faces = $facedata->{faceinfo};
2204 3434
2205 my $dirty; 3435 while (my ($face, $info) = each %$faces) {
3436 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2206 3437
2207 sub db_sync() { 3438 cf::face::set_visibility $idx, $info->{visibility};
2208 db_save if $dirty; 3439 cf::face::set_magicmap $idx, $info->{magicmap};
2209 undef $dirty; 3440 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2210 } 3441 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2211 3442
2212 my $idle = Event->idle ( 3443 cf::cede_to_tick;
2213 reentrant => 0,
2214 min => 10,
2215 max => 20,
2216 repeat => 0,
2217 data => WF_AUTOCANCEL,
2218 cb => \&db_sync,
2219 );
2220
2221 sub db_dirty() {
2222 $dirty = 1;
2223 $idle->start;
2224 }
2225
2226 sub db_get($;$) {
2227 @_ >= 2
2228 ? $DB->{$_[0]}{$_[1]}
2229 : ($DB->{$_[0]} ||= { })
2230 }
2231
2232 sub db_put($$;$) {
2233 if (@_ >= 3) {
2234 $DB->{$_[0]}{$_[1]} = $_[2];
2235 } else {
2236 $DB->{$_[0]} = $_[1];
2237 }
2238 db_dirty;
2239 }
2240
2241 cf::global->attach (
2242 prio => 10000,
2243 on_cleanup => sub {
2244 db_sync;
2245 }, 3444 }
2246 );
2247}
2248 3445
2249############################################################################# 3446 while (my ($face, $info) = each %$faces) {
2250# the server's main() 3447 next unless $info->{smooth};
2251 3448
2252sub cfg_load { 3449 my $idx = cf::face::find $face
2253 open my $fh, "<:utf8", cf::confdir . "/config" 3450 or next;
2254 or return;
2255 3451
2256 local $/; 3452 if (my $smooth = cf::face::find $info->{smooth}) {
2257 *CFG = YAML::Syck::Load <$fh>; 3453 cf::face::set_smooth $idx, $smooth;
3454 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3455 } else {
3456 error "smooth face '$info->{smooth}' not found for face '$face'";
3457 }
2258 3458
3459 cf::cede_to_tick;
3460 }
3461 }
3462
3463 {
3464 my $anims = $facedata->{animinfo};
3465
3466 while (my ($anim, $info) = each %$anims) {
3467 cf::anim::set $anim, $info->{frames}, $info->{facings};
3468 cf::cede_to_tick;
3469 }
3470
3471 cf::anim::invalidate_all; # d'oh
3472 }
3473
3474 {
3475 my $res = $facedata->{resource};
3476
3477 while (my ($name, $info) = each %$res) {
3478 if (defined $info->{type}) {
3479 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3480
3481 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3482 cf::face::set_type $idx, $info->{type};
3483 } else {
3484 $RESOURCE{$name} = $info; # unused
3485 }
3486
3487 cf::cede_to_tick;
3488 }
3489 }
3490
3491 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3492
3493 1
3494}
3495
3496register_exticmd fx_want => sub {
3497 my ($ns, $want) = @_;
3498
3499 while (my ($k, $v) = each %$want) {
3500 $ns->fx_want ($k, $v);
3501 }
3502};
3503
3504sub load_resource_file($) {
3505 my $guard = lock_acquire "load_resource_file";
3506
3507 my $status = load_resource_file_ $_[0];
3508 get_slot 0.1, 100;
3509 cf::arch::commit_load;
3510
3511 $status
3512}
3513
3514sub reload_regions {
3515 # HACK to clear player env face cache, we need some signal framework
3516 # for this (global event?)
3517 %ext::player_env::MUSIC_FACE_CACHE = ();
3518
3519 load_resource_file "$MAPDIR/regions"
3520 or die "unable to load regions file\n";
3521
3522 for (cf::region::list) {
3523 $_->{match} = qr/$_->{match}/
3524 if exists $_->{match};
3525 }
3526}
3527
3528sub reload_facedata {
3529 load_facedata "$DATADIR/facedata"
3530 or die "unable to load facedata\n";
3531}
3532
3533sub reload_archetypes {
3534 load_resource_file "$DATADIR/archetypes"
3535 or die "unable to load archetypes\n";
3536}
3537
3538sub reload_treasures {
3539 load_resource_file "$DATADIR/treasures"
3540 or die "unable to load treasurelists\n";
3541}
3542
3543sub reload_sound {
3544 trace "loading sound config from $DATADIR/sound\n";
3545
3546 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3547 or die "$DATADIR/sound $!";
3548
3549 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3550
3551 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3552 my $sound = $soundconf->{compat}[$_]
3553 or next;
3554
3555 my $face = cf::face::find "sound/$sound->[1]";
3556 cf::sound::set $sound->[0] => $face;
3557 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3558 }
3559
3560 while (my ($k, $v) = each %{$soundconf->{event}}) {
3561 my $face = cf::face::find "sound/$v";
3562 cf::sound::set $k => $face;
3563 }
3564}
3565
3566sub reload_resources {
3567 trace "reloading resource files...\n";
3568
3569 reload_exp_table;
3570 reload_materials;
3571 reload_facedata;
3572 reload_sound;
3573 reload_archetypes;
3574 reload_regions;
3575 reload_treasures;
3576
3577 trace "finished reloading resource files\n";
3578}
3579
3580sub reload_config {
3581 trace "reloading config file...\n";
3582
3583 0 < aio_load "$CONFDIR/config", my $config
3584 or die "$CONFDIR/config: $!";
3585
3586 utf8::decode $config;
3587 *CFG = yaml_load $config;
3588
2259 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3589 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2260 3590
2261 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3591 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2262 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3592 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2263 3593
2264 if (exists $CFG{mlockall}) { 3594 if (exists $CFG{mlockall}) {
2268 }; 3598 };
2269 warn $@ if $@; 3599 warn $@ if $@;
2270 } 3600 }
2271} 3601}
2272 3602
3603sub pidfile() {
3604 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3605 or die "$PIDFILE: $!";
3606 flock $fh, &Fcntl::LOCK_EX
3607 or die "$PIDFILE: flock: $!";
3608 $fh
3609}
3610
3611# make sure only one server instance is running at any one time
3612sub atomic {
3613 my $fh = pidfile;
3614
3615 my $pid = <$fh>;
3616 kill 9, $pid if $pid > 0;
3617
3618 seek $fh, 0, 0;
3619 print $fh $$;
3620}
3621
3622sub main_loop {
3623 trace "EV::loop starting\n";
3624 if (1) {
3625 EV::loop;
3626 }
3627 trace "EV::loop returned\n";
3628 goto &main_loop unless $REALLY_UNLOOP;
3629}
3630
2273sub main { 3631sub main {
3632 cf::init_globals; # initialise logging
3633
3634 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3635 LOG llevInfo, "Copyright (C) 2005-2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3636 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3637 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3638
3639 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3640
2274 # we must not ever block the main coroutine 3641 # we must not ever block the main coroutine
2275 local $Coro::idle = sub { 3642 local $Coro::idle = sub {
2276 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3643 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2277 (async { 3644 (async {
2278 Event::one_event; 3645 $Coro::current->{desc} = "IDLE BUG HANDLER";
3646 EV::loop EV::LOOP_ONESHOT;
2279 })->prio (Coro::PRIO_MAX); 3647 })->prio (Coro::PRIO_MAX);
2280 }; 3648 };
2281 3649
2282 cfg_load; 3650 evthread_start IO::AIO::poll_fileno;
2283 db_load; 3651
3652 cf::sync_job {
3653 cf::incloader::init ();
3654
3655 cf::init_anim;
3656 cf::init_attackmess;
3657 cf::init_dynamic;
3658
3659 cf::load_settings;
3660
3661 reload_resources;
3662 reload_config;
3663 db_init;
3664
3665 cf::init_uuid;
3666 cf::init_signals;
3667 cf::init_skills;
3668
3669 cf::init_beforeplay;
3670
3671 atomic;
3672
2284 load_extensions; 3673 load_extensions;
2285 3674
2286 $TICK_WATCHER->start; 3675 utime time, time, $RUNTIMEFILE;
2287 Event::loop; 3676
3677 # no (long-running) fork's whatsoever before this point(!)
3678 use POSIX ();
3679 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3680
3681 cf::_post_init 0;
3682 };
3683
3684 cf::object::thawer::errors_are_fatal 0;
3685 info "parse errors in files are no longer fatal from this point on.\n";
3686
3687 my $free_main; $free_main = EV::idle sub {
3688 undef $free_main;
3689 undef &main; # free gobs of memory :)
3690 };
3691
3692 goto &main_loop;
2288} 3693}
2289 3694
2290############################################################################# 3695#############################################################################
2291# initialisation and cleanup 3696# initialisation and cleanup
2292 3697
2293# install some emergency cleanup handlers 3698# install some emergency cleanup handlers
2294BEGIN { 3699BEGIN {
3700 our %SIGWATCHER = ();
2295 for my $signal (qw(INT HUP TERM)) { 3701 for my $signal (qw(INT HUP TERM)) {
2296 Event->signal ( 3702 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2297 reentrant => 0,
2298 data => WF_AUTOCANCEL,
2299 signal => $signal,
2300 prio => 0,
2301 cb => sub {
2302 cf::cleanup "SIG$signal"; 3703 cf::cleanup "SIG$signal";
2303 },
2304 ); 3704 };
3705 }
3706}
3707
3708sub write_runtime_sync {
3709 my $t0 = AE::time;
3710
3711 # first touch the runtime file to show we are still running:
3712 # the fsync below can take a very very long time.
3713
3714 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3715
3716 my $guard = cf::lock_acquire "write_runtime";
3717
3718 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3719 or return;
3720
3721 my $value = $cf::RUNTIME + 90 + 10;
3722 # 10 is the runtime save interval, for a monotonic clock
3723 # 60 allows for the watchdog to kill the server.
3724
3725 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3726 and return;
3727
3728 # always fsync - this file is important
3729 aio_fsync $fh
3730 and return;
3731
3732 # touch it again to show we are up-to-date
3733 aio_utime $fh, undef, undef;
3734
3735 close $fh
3736 or return;
3737
3738 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3739 and return;
3740
3741 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3742
2305 } 3743 1
3744}
3745
3746our $uuid_lock;
3747our $uuid_skip;
3748
3749sub write_uuid_sync($) {
3750 $uuid_skip ||= $_[0];
3751
3752 return if $uuid_lock;
3753 local $uuid_lock = 1;
3754
3755 my $uuid = "$LOCALDIR/uuid";
3756
3757 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3758 or return;
3759
3760 my $value = uuid_seq uuid_cur;
3761
3762 unless ($value) {
3763 info "cowardly refusing to write zero uuid value!\n";
3764 return;
3765 }
3766
3767 my $value = uuid_str $value + $uuid_skip;
3768 $uuid_skip = 0;
3769
3770 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3771 and return;
3772
3773 # always fsync - this file is important
3774 aio_fsync $fh
3775 and return;
3776
3777 close $fh
3778 or return;
3779
3780 aio_rename "$uuid~", $uuid
3781 and return;
3782
3783 trace "uuid file written ($value).\n";
3784
3785 1
3786
3787}
3788
3789sub write_uuid($$) {
3790 my ($skip, $sync) = @_;
3791
3792 $sync ? write_uuid_sync $skip
3793 : async { write_uuid_sync $skip };
2306} 3794}
2307 3795
2308sub emergency_save() { 3796sub emergency_save() {
2309 my $freeze_guard = cf::freeze_mainloop; 3797 my $freeze_guard = cf::freeze_mainloop;
2310 3798
2311 warn "enter emergency perl save\n"; 3799 info "emergency_perl_save: enter\n";
3800
3801 # this is a trade-off: we want to be very quick here, so
3802 # save all maps without fsync, and later call a global sync
3803 # (which in turn might be very very slow)
3804 local $USE_FSYNC = 0;
2312 3805
2313 cf::sync_job { 3806 cf::sync_job {
3807 cf::write_runtime_sync; # external watchdog should not bark
3808
2314 # use a peculiar iteration method to avoid tripping on perl 3809 # use a peculiar iteration method to avoid tripping on perl
2315 # refcount bugs in for. also avoids problems with players 3810 # refcount bugs in for. also avoids problems with players
2316 # and maps saved/destroyed asynchronously. 3811 # and maps saved/destroyed asynchronously.
2317 warn "begin emergency player save\n"; 3812 info "emergency_perl_save: begin player save\n";
2318 for my $login (keys %cf::PLAYER) { 3813 for my $login (keys %cf::PLAYER) {
2319 my $pl = $cf::PLAYER{$login} or next; 3814 my $pl = $cf::PLAYER{$login} or next;
2320 $pl->valid or next; 3815 $pl->valid or next;
3816 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2321 $pl->save; 3817 $pl->save;
2322 } 3818 }
2323 warn "end emergency player save\n"; 3819 info "emergency_perl_save: end player save\n";
2324 3820
2325 warn "begin emergency map save\n"; 3821 cf::write_runtime_sync; # external watchdog should not bark
3822
3823 info "emergency_perl_save: begin map save\n";
2326 for my $path (keys %cf::MAP) { 3824 for my $path (keys %cf::MAP) {
2327 my $map = $cf::MAP{$path} or next; 3825 my $map = $cf::MAP{$path} or next;
2328 $map->valid or next; 3826 $map->valid or next;
2329 $map->save; 3827 $map->save;
2330 } 3828 }
2331 warn "end emergency map save\n"; 3829 info "emergency_perl_save: end map save\n";
3830
3831 cf::write_runtime_sync; # external watchdog should not bark
3832
3833 info "emergency_perl_save: begin database checkpoint\n";
3834 BDB::db_env_txn_checkpoint $DB_ENV;
3835 info "emergency_perl_save: end database checkpoint\n";
3836
3837 info "emergency_perl_save: begin write uuid\n";
3838 write_uuid_sync 1;
3839 info "emergency_perl_save: end write uuid\n";
3840
3841 cf::write_runtime_sync; # external watchdog should not bark
3842
3843 trace "emergency_perl_save: syncing database to disk";
3844 BDB::db_env_txn_checkpoint $DB_ENV;
3845
3846 info "emergency_perl_save: starting sync\n";
3847 IO::AIO::aio_sync sub {
3848 info "emergency_perl_save: finished sync\n";
3849 };
3850
3851 cf::write_runtime_sync; # external watchdog should not bark
3852
3853 trace "emergency_perl_save: flushing outstanding aio requests";
3854 while (IO::AIO::nreqs || BDB::nreqs) {
3855 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3856 }
3857
3858 cf::write_runtime_sync; # external watchdog should not bark
2332 }; 3859 };
2333 3860
2334 warn "leave emergency perl save\n"; 3861 info "emergency_perl_save: leave\n";
2335} 3862}
2336 3863
3864sub post_cleanup {
3865 my ($make_core) = @_;
3866
3867 IO::AIO::flush;
3868
3869 error Carp::longmess "post_cleanup backtrace"
3870 if $make_core;
3871
3872 my $fh = pidfile;
3873 unlink $PIDFILE if <$fh> == $$;
3874}
3875
3876# a safer delete_package, copied from Symbol
3877sub clear_package($) {
3878 my $pkg = shift;
3879
3880 # expand to full symbol table name if needed
3881 unless ($pkg =~ /^main::.*::$/) {
3882 $pkg = "main$pkg" if $pkg =~ /^::/;
3883 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3884 $pkg .= '::' unless $pkg =~ /::$/;
3885 }
3886
3887 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3888 my $stem_symtab = *{$stem}{HASH};
3889
3890 defined $stem_symtab and exists $stem_symtab->{$leaf}
3891 or return;
3892
3893 # clear all symbols
3894 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3895 for my $name (keys %$leaf_symtab) {
3896 _gv_clear *{"$pkg$name"};
3897# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3898 }
3899}
3900
2337sub reload() { 3901sub do_reload_perl() {
2338 # can/must only be called in main 3902 # can/must only be called in main
2339 if ($Coro::current != $Coro::main) { 3903 unless (in_main) {
2340 warn "can only reload from main coroutine"; 3904 error "can only reload from main coroutine";
2341 return; 3905 return;
2342 } 3906 }
2343 3907
2344 warn "reloading..."; 3908 return if $RELOAD++;
2345 3909
2346 warn "cancelling server ticker"; 3910 my $t1 = AE::time;
2347 $TICK_WATCHER->cancel;
2348 3911
3912 while ($RELOAD) {
3913 cf::get_slot 0.1, -1, "reload_perl";
3914 info "perl_reload: reloading...";
3915
3916 trace "perl_reload: entering sync_job";
3917
3918 cf::sync_job {
2349 cf::emergency_save; 3919 #cf::emergency_save;
2350 3920
2351 eval {
2352 # if anything goes wrong in here, we should simply crash as we already saved
2353
2354 warn "syncing database to disk";
2355 cf::db_sync;
2356
2357 warn "cancelling all WF_AUTOCANCEL watchers";
2358 for (Event::all_watchers) {
2359 $_->cancel if $_->data & WF_AUTOCANCEL;
2360 }
2361
2362 warn "flushing outstanding aio requests";
2363 for (;;) {
2364 IO::AIO::flush;
2365 Coro::cede;
2366 last unless IO::AIO::nreqs;
2367 warn "iterate...";
2368 }
2369
2370 warn "cancelling all extension coros"; 3921 trace "perl_reload: cancelling all extension coros";
2371 $_->cancel for values %EXT_CORO; 3922 $_->cancel for values %EXT_CORO;
2372 %EXT_CORO = (); 3923 %EXT_CORO = ();
2373 3924
2374 warn "removing commands"; 3925 trace "perl_reload: removing commands";
2375 %COMMAND = (); 3926 %COMMAND = ();
2376 3927
2377 warn "removing ext commands"; 3928 trace "perl_reload: removing ext/exti commands";
2378 %EXTCMD = (); 3929 %EXTCMD = ();
3930 %EXTICMD = ();
2379 3931
2380 warn "unloading/nuking all extensions"; 3932 trace "perl_reload: unloading/nuking all extensions";
2381 for my $pkg (@EXTS) { 3933 for my $pkg (@EXTS) {
2382 warn "... unloading $pkg"; 3934 trace "... unloading $pkg";
2383 3935
2384 if (my $cb = $pkg->can ("unload")) { 3936 if (my $cb = $pkg->can ("unload")) {
2385 eval { 3937 eval {
2386 $cb->($pkg); 3938 $cb->($pkg);
2387 1 3939 1
2388 } or warn "$pkg unloaded, but with errors: $@"; 3940 } or error "$pkg unloaded, but with errors: $@";
3941 }
3942
3943 trace "... clearing $pkg";
3944 clear_package $pkg;
2389 } 3945 }
2390 3946
2391 warn "... nuking $pkg";
2392 Symbol::delete_package $pkg;
2393 }
2394
2395 warn "unloading all perl modules loaded from $LIBDIR"; 3947 trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2396 while (my ($k, $v) = each %INC) { 3948 while (my ($k, $v) = each %INC) {
2397 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3949 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2398 3950
2399 warn "... unloading $k"; 3951 trace "... unloading $k";
2400 delete $INC{$k}; 3952 delete $INC{$k};
2401 3953
2402 $k =~ s/\.pm$//; 3954 $k =~ s/\.pm$//;
2403 $k =~ s/\//::/g; 3955 $k =~ s/\//::/g;
2404 3956
2405 if (my $cb = $k->can ("unload_module")) { 3957 if (my $cb = $k->can ("unload_module")) {
2406 $cb->(); 3958 $cb->();
3959 }
3960
3961 clear_package $k;
2407 } 3962 }
2408 3963
2409 Symbol::delete_package $k;
2410 }
2411
2412 warn "getting rid of safe::, as good as possible"; 3964 trace "perl_reload: getting rid of safe::, as good as possible";
2413 Symbol::delete_package "safe::$_" 3965 clear_package "safe::$_"
2414 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3966 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2415 3967
2416 warn "unloading cf.pm \"a bit\""; 3968 trace "perl_reload: unloading cf.pm \"a bit\"";
2417 delete $INC{"cf.pm"}; 3969 delete $INC{"cf.pm"};
3970 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2418 3971
2419 # don't, removes xs symbols, too, 3972 # don't, removes xs symbols, too,
2420 # and global variables created in xs 3973 # and global variables created in xs
2421 #Symbol::delete_package __PACKAGE__; 3974 #clear_package __PACKAGE__;
2422 3975
2423 warn "unload completed, starting to reload now"; 3976 info "perl_reload: unload completed, starting to reload now";
2424 3977
2425 warn "reloading cf.pm"; 3978 trace "perl_reload: reloading cf.pm";
2426 require cf; 3979 require cf;
2427 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3980 cf::_connect_to_perl_1;
2428 3981
2429 warn "loading config and database again"; 3982 trace "perl_reload: loading config and database again";
2430 cf::cfg_load; 3983 cf::reload_config;
2431 cf::db_load;
2432 3984
2433 warn "loading extensions"; 3985 trace "perl_reload: loading extensions";
2434 cf::load_extensions; 3986 cf::load_extensions;
2435 3987
3988 if ($REATTACH_ON_RELOAD) {
2436 warn "reattaching attachments to objects/players"; 3989 trace "perl_reload: reattaching attachments to objects/players";
2437 _global_reattach; 3990 _global_reattach; # objects, sockets
2438 warn "reattaching attachments to maps"; 3991 trace "perl_reload: reattaching attachments to maps";
2439 reattach $_ for values %MAP; 3992 reattach $_ for values %MAP;
3993 trace "perl_reload: reattaching attachments to players";
3994 reattach $_ for values %PLAYER;
3995 }
2440 3996
2441 warn "restarting server ticker"; 3997 cf::_post_init 1;
2442 3998
2443 $TICK_WATCHER->start; 3999 trace "perl_reload: leaving sync_job";
4000
4001 1
4002 } or do {
4003 error $@;
4004 cf::cleanup "perl_reload: error, exiting.";
4005 };
4006
4007 --$RELOAD;
4008 }
4009
4010 $t1 = AE::time - $t1;
4011 info "perl_reload: completed in ${t1}s\n";
4012};
4013
4014our $RELOAD_WATCHER; # used only during reload
4015
4016sub reload_perl() {
4017 # doing reload synchronously and two reloads happen back-to-back,
4018 # coro crashes during coro_state_free->destroy here.
4019
4020 $RELOAD_WATCHER ||= cf::async {
4021 Coro::AIO::aio_wait cache_extensions;
4022
4023 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
4024 do_reload_perl;
4025 undef $RELOAD_WATCHER;
4026 };
2444 }; 4027 };
2445 4028}
2446 if ($@) {
2447 warn $@;
2448 warn "error while reloading, exiting.";
2449 exit 1;
2450 }
2451
2452 warn "reloaded";
2453};
2454
2455our $RELOAD_WATCHER; # used only during reload
2456 4029
2457register_command "reload" => sub { 4030register_command "reload" => sub {
2458 my ($who, $arg) = @_; 4031 my ($who, $arg) = @_;
2459 4032
2460 if ($who->flag (FLAG_WIZ)) { 4033 if ($who->flag (FLAG_WIZ)) {
2461 $who->message ("reloading server."); 4034 $who->message ("reloading server.");
2462 4035 async {
2463 # doing reload synchronously and two reloads happen back-to-back, 4036 $Coro::current->{desc} = "perl_reload";
2464 # coro crashes during coro_state_free->destroy here.
2465
2466 $RELOAD_WATCHER ||= Event->timer (
2467 reentrant => 0,
2468 after => 0,
2469 data => WF_AUTOCANCEL,
2470 cb => sub {
2471 reload; 4037 reload_perl;
2472 undef $RELOAD_WATCHER;
2473 },
2474 ); 4038 };
2475 } 4039 }
2476}; 4040};
2477 4041
2478unshift @INC, $LIBDIR; 4042#############################################################################
2479 4043
2480my $bug_warning = 0; 4044my $bug_warning = 0;
2481 4045
2482$TICK_WATCHER = Event->timer ( 4046our @WAIT_FOR_TICK;
2483 reentrant => 0, 4047our @WAIT_FOR_TICK_BEGIN;
2484 parked => 1, 4048
2485 prio => 0, 4049sub wait_for_tick() {
2486 at => $NEXT_TICK || $TICK, 4050 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2487 data => WF_AUTOCANCEL, 4051
2488 cb => sub { 4052 my $signal = new Coro::Signal;
4053 push @WAIT_FOR_TICK, $signal;
4054 $signal->wait;
4055}
4056
4057sub wait_for_tick_begin() {
4058 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4059
4060 my $signal = new Coro::Signal;
4061 push @WAIT_FOR_TICK_BEGIN, $signal;
4062 $signal->wait;
4063}
4064
4065sub tick {
2489 if ($Coro::current != $Coro::main) { 4066 if ($Coro::current != $Coro::main) {
2490 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 4067 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2491 unless ++$bug_warning > 10; 4068 unless ++$bug_warning > 10;
2492 return; 4069 return;
2493 } 4070 }
2494 4071
2495 $NOW = Event::time;
2496
2497 cf::server_tick; # one server iteration 4072 cf::server_tick; # one server iteration
2498 $RUNTIME += $TICK;
2499 $NEXT_TICK += $TICK;
2500 4073
2501 $WAIT_FOR_TICK->broadcast; 4074 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2502 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2503 4075
2504 Event::sweep; 4076 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2505 Coro::cede_notself; 4077 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
4078 Coro::async_pool {
4079 $Coro::current->{desc} = "runtime saver";
4080 write_runtime_sync
4081 or error "ERROR: unable to write runtime file: $!";
4082 };
4083 }
4084
4085 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4086 $sig->send;
4087 }
4088 while (my $sig = shift @WAIT_FOR_TICK) {
4089 $sig->send;
4090 }
4091
4092 $LOAD = ($NOW - $TICK_START) / $TICK;
4093 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4094
4095 if (0) {
4096 if ($NEXT_TICK) {
4097 my $jitter = $TICK_START - $NEXT_TICK;
4098 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4099 debug "jitter $JITTER\n";#d#
2506 4100 }
2507# my $AFTER = Event::time;
2508# warn $AFTER - $NOW;#d#
2509
2510 # if we are delayed by four ticks or more, skip them all
2511 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2512
2513 $TICK_WATCHER->at ($NEXT_TICK);
2514 $TICK_WATCHER->start;
2515 }, 4101 }
2516); 4102}
2517 4103
4104{
4105 # configure BDB
4106
4107 BDB::min_parallel 16;
4108 BDB::max_poll_reqs $TICK * 0.1;
4109 $AnyEvent::BDB::WATCHER->priority (1);
4110
4111 unless ($DB_ENV) {
4112 $DB_ENV = BDB::db_env_create;
4113 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4114 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4115 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4116 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4117 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4118
4119 cf::sync_job {
4120 eval {
4121 BDB::db_env_open
4122 $DB_ENV,
4123 $BDBDIR,
4124 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4125 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4126 0666;
4127
4128 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
4129 };
4130
4131 cf::cleanup "db_env_open(db): $@" if $@;
4132 };
4133 }
4134
4135 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4136 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4137 };
4138 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4139 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4140 };
4141 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4142 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4143 };
4144}
4145
4146{
4147 # configure IO::AIO
4148
4149 IO::AIO::min_parallel 8;
2518IO::AIO::max_poll_time $TICK * 0.1; 4150 IO::AIO::max_poll_time $TICK * 0.1;
4151 undef $AnyEvent::AIO::WATCHER;
4152}
2519 4153
2520undef $Coro::AIO::WATCHER; 4154our $_log_backtrace;
2521$AIO_POLL_WATCHER = Event->io ( 4155our $_log_backtrace_last;
2522 reentrant => 0,
2523 fd => IO::AIO::poll_fileno,
2524 poll => 'r',
2525 prio => 6,
2526 data => WF_AUTOCANCEL,
2527 cb => \&IO::AIO::poll_cb,
2528);
2529 4156
2530$WRITE_RUNTIME_WATCHER = Event->timer ( 4157sub _log_backtrace {
2531 reentrant => 0, 4158 my ($msg, @addr) = @_;
2532 data => WF_AUTOCANCEL, 4159
2533 after => 1, 4160 $msg =~ s/\n$//;
2534 interval => 10, 4161
2535 prio => 6, # keep it lowest so it acts like a watchdog 4162 if ($_log_backtrace_last eq $msg) {
2536 cb => Coro::unblock_sub { 4163 LOG llevInfo, "[ABT] $msg\n";
2537 write_runtime 4164 LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
2538 or warn "ERROR: unable to write runtime file: $!"; 4165 # limit the # of concurrent backtraces
4166 } elsif ($_log_backtrace < 2) {
4167 $_log_backtrace_last = $msg;
4168 ++$_log_backtrace;
4169 my $perl_bt = Carp::longmess $msg;
4170 async {
4171 $Coro::current->{desc} = "abt $msg";
4172
4173 my @bt = fork_call {
4174 @addr = map { sprintf "%x", $_ } @addr;
4175 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4176 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4177 or die "addr2line: $!";
4178
4179 my @funcs;
4180 my @res = <$fh>;
4181 chomp for @res;
4182 while (@res) {
4183 my ($func, $line) = splice @res, 0, 2, ();
4184 push @funcs, "[$func] $line";
4185 }
4186
4187 @funcs
4188 };
4189
4190 LOG llevInfo, "[ABT] $perl_bt\n";
4191 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4192 LOG llevInfo, "[ABT] $_\n" for @bt;
4193 --$_log_backtrace;
4194 };
4195 } else {
4196 LOG llevInfo, "[ABT] $msg\n";
4197 LOG llevInfo, "[ABT] [overload, suppressed]\n";
2539 }, 4198 }
2540); 4199}
4200
4201# load additional modules
4202require "cf/$_.pm" for @EXTRA_MODULES;
4203cf::_connect_to_perl_2;
2541 4204
2542END { cf::emergency_save } 4205END { cf::emergency_save }
2543 4206
25441 42071
2545 4208

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines