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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines