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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines