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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines