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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines