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.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.520 by root, Fri Apr 16 02:37:50 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;
49our $AIO_POLL_WATCHER; 99our $LIBDIR = "$DATADIR/ext";
50our $WRITE_RUNTIME_WATCHER; 100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE;
112
113our $OUTPUT_RATE_MIN = 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
51our $NEXT_TICK; 118our $NEXT_TICK;
52our $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);
53 127
54our %CFG; 128our %CFG;
55 129
56our $UPTIME; $UPTIME ||= time; 130our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 131our $RUNTIME;
132our $NOW;
58 133
59our %PLAYER; # all users 134our (%PLAYER, %PLAYER_LOADING); # all users
60our %MAP; # all maps 135our (%MAP, %MAP_LOADING ); # all maps
61our $LINK_MAP; # the special {link} map, which is always available 136our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 137
67# 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 ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 139our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 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
70binmode STDOUT; 151binmode STDOUT;
71binmode STDERR; 152binmode STDERR;
72 153
73# read virtual server time, if available 154# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 155unless ($RUNTIME || !-e $RUNTIMEFILE) {
75 open my $fh, "<", cf::localdir . "/runtime" 156 open my $fh, "<", $RUNTIMEFILE
76 or die "unable to read runtime file: $!"; 157 or die "unable to read $RUNTIMEFILE file: $!";
77 $RUNTIME = <$fh> + 0.; 158 $RUNTIME = <$fh> + 0.;
78} 159}
79 160
80mkdir cf::localdir; 161eval "sub TICK() { $TICK } 1" or die;
81mkdir cf::localdir . "/" . cf::playerdir; 162
82mkdir cf::localdir . "/" . cf::tmpdir; 163mkdir $_
83mkdir cf::localdir . "/" . cf::uniquedir; 164 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
84mkdir $RANDOM_MAPS;
85 165
86our $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::"} };
87 180
88############################################################################# 181#############################################################################
89 182
90=head2 GLOBAL VARIABLES 183=head2 GLOBAL VARIABLES
91 184
98=item $cf::RUNTIME 191=item $cf::RUNTIME
99 192
100The 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
101every server tick. 194every server tick.
102 195
103=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
104 199
105The perl library directory, where extensions and cf-specific modules can 200Various directories - "/etc", read-only install directory, perl-library
106be 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.
107 204
108=item $cf::NOW 205=item $cf::NOW
109 206
110The time of the last (current) server tick. 207The time of the last (current) server tick.
111 208
112=item $cf::TICK 209=item $cf::TICK
113 210
114The interval between server ticks, in seconds. 211The interval between server ticks, in seconds.
115 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
116=item %cf::CFG 223=item %cf::CFG
117 224
118Configuration for the server, loaded from C</etc/crossfire/config>, or 225Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119from wherever your confdir points to. 226from wherever your confdir points to.
120 227
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 228=item cf::wait_for_tick, cf::wait_for_tick_begin
122 229
123These 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
124or 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
125processing 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.
126window 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.
127 245
128=back 246=back
129 247
130=cut 248=cut
131 249
132BEGIN { 250$Coro::State::WARNHOOK = sub {
133 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 251 my $msg = join "", @_;
135 utf8::encode $msg;
136 252
137 $msg .= "\n" 253 $msg .= "\n"
138 unless $msg =~ /\n$/; 254 unless $msg =~ /\n$/;
139 255
256 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
257
140 LOG llevError, $msg; 258 LOG llevError, $msg;
141 }; 259};
142} 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};
143 274
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 275@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 276@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 277@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 278@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@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';
149@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)
150 282
151# 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
152# within the Safe compartment. 284# within the Safe compartment.
153for my $pkg (qw( 285for my $pkg (qw(
154 cf::global cf::attachable 286 cf::global cf::attachable
155 cf::object cf::object::player 287 cf::object cf::object::player
156 cf::client cf::player 288 cf::client cf::player
157 cf::arch cf::living 289 cf::arch cf::living
290 cf::map cf::mapspace
158 cf::map cf::party cf::region 291 cf::party cf::region
159)) { 292)) {
160 no strict 'refs';
161 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 293 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162} 294}
163 295
164$Event::DIED = sub { 296$EV::DIED = sub {
165 warn "error in event callback: @_"; 297 Carp::cluck "error in event callback: @_";
166}; 298};
299
300#############################################################################
167 301
168=head2 UTILITY FUNCTIONS 302=head2 UTILITY FUNCTIONS
169 303
170=over 4 304=over 4
171 305
190 $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;
191 $d 325 $d
192 } || "[unable to dump $_[0]: '$@']"; 326 } || "[unable to dump $_[0]: '$@']";
193} 327}
194 328
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 329=item $ref = cf::decode_json $json
198 330
199Converts a JSON string into the corresponding perl data structure. 331Converts a JSON string into the corresponding perl data structure.
200 332
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 333=item $json = cf::encode_json $ref
209 334
210Converts a perl data structure into its JSON representation. 335Converts a perl data structure into its JSON representation.
211 336
212=cut 337=cut
213 338
214sub to_json($) { 339our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 340
216 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;
217} 356}
218 357
219=item cf::lock_wait $string 358=item cf::lock_wait $string
220 359
221Wait until the given lock is available. See cf::lock_acquire. 360Wait until the given lock is available. See cf::lock_acquire.
222 361
223=item my $lock = cf::lock_acquire $string 362=item my $lock = cf::lock_acquire $string
224 363
225Wait 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
226a 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,
227for example when the coroutine gets canceled), the lock is automatically 366for example when the coroutine gets canceled), the lock is automatically
228returned. 367returned.
229 368
369Locks are *not* recursive, locking from the same coro twice results in a
370deadlocked coro.
371
230Lock 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
231uses map_find and cf::map::load uses map_load). 373uses map_find and cf::map::load uses map_load).
232 374
233=cut 375=item $locked = cf::lock_active $string
234 376
235our %LOCK; 377Return true if the lock is currently active, i.e. somebody has locked it.
378
379=cut
380
381our $LOCKS = new Coro::SemaphoreSet;
236 382
237sub lock_wait($) { 383sub lock_wait($) {
238 my ($key) = @_; 384 $LOCKS->wait ($_[0]);
239
240 # wait for lock, if any
241 while ($LOCK{$key}) {
242 push @{ $LOCK{$key} }, $Coro::current;
243 Coro::schedule;
244 }
245} 385}
246 386
247sub lock_acquire($) { 387sub lock_acquire($) {
248 my ($key) = @_; 388 $LOCKS->guard ($_[0])
389}
249 390
250 # wait, to be sure we are not locked 391sub lock_active($) {
251 lock_wait $key; 392 $LOCKS->count ($_[0]) < 1
252
253 $LOCK{$key} = [];
254
255 Coro::guard {
256 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} };
258 }
259} 393}
260 394
261sub freeze_mainloop { 395sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 396 tick_inhibit_inc;
263 397
264 my $guard = Coro::guard { 398 &Guard::guard (\&tick_inhibit_dec);
265 $TICK_WATCHER->start; 399}
266 $WRITE_RUNTIME_WATCHER->start; 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 }
267 }; 465 }
268 $WRITE_RUNTIME_WATCHER->stop; 466};
269 $TICK_WATCHER->stop; 467
270 $guard 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;
271} 481}
272 482
273=item cf::async { BLOCK } 483=item cf::async { BLOCK }
274 484
275Currently the same as Coro::async_pool, meaning you cannot use 485Currently the same as Coro::async_pool, meaning you cannot use
280 490
281BEGIN { *async = \&Coro::async_pool } 491BEGIN { *async = \&Coro::async_pool }
282 492
283=item cf::sync_job { BLOCK } 493=item cf::sync_job { BLOCK }
284 494
285The design of crossfire+ requires that the main coro ($Coro::main) is 495The design of Deliantra requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 496is always able to handle events or runnable, as Deliantra is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 497partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
498acceptable.
288 499
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 501the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 503fast or be very important.
295 506
296sub sync_job(&) { 507sub sync_job(&) {
297 my ($job) = @_; 508 my ($job) = @_;
298 509
299 if ($Coro::current == $Coro::main) { 510 if ($Coro::current == $Coro::main) {
511 my $time = AE::time;
512
300 # this is the main coro, too bad, we have to block 513 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 514 # till the operation succeeds, freezing the server :/
302 515
303 # TODO: use suspend/resume instead 516 LOG llevError, Carp::longmess "sync job";#d#
304 # (but this is cancel-safe) 517
305 my $freeze_guard = freeze_mainloop; 518 my $freeze_guard = freeze_mainloop;
306 519
307 my $busy = 1; 520 my $busy = 1;
308 my @res; 521 my @res;
309 522
310 (async { 523 (async {
524 $Coro::current->desc ("sync job coro");
311 @res = eval { $job->() }; 525 @res = eval { $job->() };
312 warn $@ if $@; 526 warn $@ if $@;
313 undef $busy; 527 undef $busy;
314 })->prio (Coro::PRIO_MAX); 528 })->prio (Coro::PRIO_MAX);
315 529
316 while ($busy) { 530 while ($busy) {
317 Coro::cede or Event::one_event; 531 if (Coro::nready) {
532 Coro::cede_notself;
533 } else {
534 EV::loop EV::LOOP_ONESHOT;
318 } 535 }
536 }
537
538 my $time = AE::time - $time;
539
540 $TICK_START += $time; # do not account sync jobs to server load
319 541
320 wantarray ? @res : $res[0] 542 wantarray ? @res : $res[0]
321 } else { 543 } else {
322 # we are in another coroutine, how wonderful, everything just works 544 # we are in another coroutine, how wonderful, everything just works
323 545
343 $EXT_CORO{$coro+0} = $coro; 565 $EXT_CORO{$coro+0} = $coro;
344 566
345 $coro 567 $coro
346} 568}
347 569
348sub write_runtime { 570=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 571
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 572Executes the given code block with the given arguments in a seperate
352 or return; 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.
353 576
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 577=cut
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357 578
358 aio_fsync $fh 579sub fork_call(&@) {
359 and return; 580 my ($cb, @args) = @_;
360 581
361 close $fh 582 # we seemingly have to make a local copy of the whole thing,
362 or return; 583 # otherwise perl prematurely frees the stuff :/
584 # TODO: investigate and fix (likely this will be rather laborious)
363 585
364 aio_rename "$runtime~", $runtime 586 my @res = Coro::Util::fork_eval {
365 and return; 587 reset_signals;
588 &$cb
589 }, @args;
366 590
591 wantarray ? @res : $res[-1]
592}
593
594sub objinfo {
367 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 });
368} 768}
369 769
370=back 770=back
371 771
372=cut 772=cut
373 773
374############################################################################# 774#############################################################################
375 775
376=head2 ATTACHABLE OBJECTS 776=head2 ATTACHABLE OBJECTS
377 777
378Many 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
379attach callbacks/event handlers (a collection of which is called an "attachment") 779attach callbacks/event handlers (a collection of which is called an "attachment")
380to it. All such attachable objects support the following methods. 780to it. All such attachable objects support the following methods.
381 781
382In 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>
383C<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
384crossfire+). 784Deliantra).
385 785
386=over 4 786=over 4
387 787
388=item $attachable->attach ($attachment, key => $value...) 788=item $attachable->attach ($attachment, key => $value...)
389 789
433=item cf::CLASS::attachment $name, ... 833=item cf::CLASS::attachment $name, ...
434 834
435Register an attachment by C<$name> through which attachable objects of the 835Register an attachment by C<$name> through which attachable objects of the
436given CLASS can refer to this attachment. 836given CLASS can refer to this attachment.
437 837
438Some classes such as crossfire maps and objects can specify attachments 838Some classes such as deliantra maps and objects can specify attachments
439that 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.
440 840
441These calls expect any number of the following handler/hook descriptions: 841These calls expect any number of the following handler/hook descriptions:
442 842
443=over 4 843=over 4
503our @CB_TYPE = (); # registry for type (cf-object class) based events 903our @CB_TYPE = (); # registry for type (cf-object class) based events
504our @CB_MAP = (); 904our @CB_MAP = ();
505 905
506my %attachment; 906my %attachment;
507 907
908sub cf::attachable::thawer_merge {
909 # simply override everything except _meta
910 local $_[0]{_meta};
911 %{$_[0]} = %{$_[1]};
912}
913
508sub _attach_cb($$$$) { 914sub _attach_cb($$$$) {
509 my ($registry, $event, $prio, $cb) = @_; 915 my ($registry, $event, $prio, $cb) = @_;
510 916
511 use sort 'stable'; 917 use sort 'stable';
512 918
546 $registry = $CB_TYPE[$object_type] ||= []; 952 $registry = $CB_TYPE[$object_type] ||= [];
547 953
548 } elsif ($type eq "subtype") { 954 } elsif ($type eq "subtype") {
549 defined $object_type or Carp::croak "subtype specified without type"; 955 defined $object_type or Carp::croak "subtype specified without type";
550 my $object_subtype = shift @arg; 956 my $object_subtype = shift @arg;
551 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 957 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
552 958
553 } elsif ($type eq "package") { 959 } elsif ($type eq "package") {
554 my $pkg = shift @arg; 960 my $pkg = shift @arg;
555 961
556 while (my ($name, $id) = each %cb_id) { 962 while (my ($name, $id) = each %cb_id) {
585 _attach $registry, $klass, @attach; 991 _attach $registry, $klass, @attach;
586 } 992 }
587 993
588 $obj->{$name} = \%arg; 994 $obj->{$name} = \%arg;
589 } else { 995 } else {
590 warn "object uses attachment '$name' that is not available, postponing.\n"; 996 warn "object uses attachment '$name' which is not available, postponing.\n";
591 } 997 }
592 998
593 $obj->{_attachment}{$name} = undef; 999 $obj->{_attachment}{$name} = undef;
594} 1000}
595 1001
597 if (ref $_[0]) { 1003 if (ref $_[0]) {
598 _object_attach @_; 1004 _object_attach @_;
599 } else { 1005 } else {
600 _attach shift->_attach_registry, @_; 1006 _attach shift->_attach_registry, @_;
601 } 1007 }
1008 _recalc_want;
602}; 1009};
603 1010
604# all those should be optimised 1011# all those should be optimised
605sub cf::attachable::detach { 1012sub cf::attachable::detach {
606 my ($obj, $name) = @_; 1013 my ($obj, $name) = @_;
609 delete $obj->{_attachment}{$name}; 1016 delete $obj->{_attachment}{$name};
610 reattach ($obj); 1017 reattach ($obj);
611 } else { 1018 } else {
612 Carp::croak "cannot, currently, detach class attachments"; 1019 Carp::croak "cannot, currently, detach class attachments";
613 } 1020 }
1021 _recalc_want;
614}; 1022};
615 1023
616sub cf::attachable::attached { 1024sub cf::attachable::attached {
617 my ($obj, $name) = @_; 1025 my ($obj, $name) = @_;
618 1026
633 "; 1041 ";
634 die if $@; 1042 die if $@;
635} 1043}
636 1044
637our $override; 1045our $override;
638our @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?
639 1047
640sub override { 1048sub override {
641 $override = 1; 1049 $override = 1;
642 @invoke_results = (); 1050 @INVOKE_RESULTS = (@_);
643} 1051}
644 1052
645sub do_invoke { 1053sub do_invoke {
646 my $event = shift; 1054 my $event = shift;
647 my $callbacks = shift; 1055 my $callbacks = shift;
648 1056
649 @invoke_results = (); 1057 @INVOKE_RESULTS = ();
650 1058
651 local $override; 1059 local $override;
652 1060
653 for (@$callbacks) { 1061 for (@$callbacks) {
654 eval { &{$_->[1]} }; 1062 eval { &{$_->[1]} };
663 } 1071 }
664 1072
665 0 1073 0
666} 1074}
667 1075
668=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1076=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
669 1077
670=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1078=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
671 1079
672Generate an object-specific event with the given arguments. 1080Generate an object-specific event with the given arguments.
673 1081
674This 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
675removed 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
676results (if you must, access C<@cf::invoke_results> directly). 1084results (if you must, access C<@cf::INVOKE_RESULTS> directly).
677 1085
678=back 1086=back
679 1087
680=cut 1088=cut
681 1089
682############################################################################# 1090#############################################################################
683# 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}
684 1134
685sub reattach { 1135sub reattach {
686 # basically do the same as instantiate, without calling instantiate 1136 # basically do the same as instantiate, without calling instantiate
687 my ($obj) = @_; 1137 my ($obj) = @_;
688 1138
1139 # no longer needed after getting rid of delete_package?
689 bless $obj, ref $obj; # re-bless in case extensions have been reloaded 1140 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
690 1141
691 my $registry = $obj->registry; 1142 my $registry = $obj->registry;
692 1143
693 @$registry = (); 1144 @$registry = ();
694 1145
709cf::attachable->attach ( 1160cf::attachable->attach (
710 prio => -1000000, 1161 prio => -1000000,
711 on_instantiate => sub { 1162 on_instantiate => sub {
712 my ($obj, $data) = @_; 1163 my ($obj, $data) = @_;
713 1164
714 $data = from_json $data; 1165 $data = decode_json $data;
715 1166
716 for (@$data) { 1167 for (@$data) {
717 my ($name, $args) = @$_; 1168 my ($name, $args) = @$_;
718 1169
719 $obj->attach ($name, %{$args || {} }); 1170 $obj->attach ($name, %{$args || {} });
735sub object_freezer_save { 1186sub object_freezer_save {
736 my ($filename, $rdata, $objs) = @_; 1187 my ($filename, $rdata, $objs) = @_;
737 1188
738 sync_job { 1189 sync_job {
739 if (length $$rdata) { 1190 if (length $$rdata) {
1191 utf8::decode (my $decname = $filename);
740 warn sprintf "saving %s (%d,%d)\n", 1192 warn sprintf "saving %s (%d,%d)\n",
741 $filename, length $$rdata, scalar @$objs; 1193 $decname, length $$rdata, scalar @$objs;
742 1194
743 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1195 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
744 chmod SAVE_MODE, $fh; 1196 aio_chmod $fh, SAVE_MODE;
745 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;
746 aio_fsync $fh; 1200 aio_fsync $fh;
1201 }
747 close $fh; 1202 aio_close $fh;
748 1203
749 if (@$objs) { 1204 if (@$objs) {
750 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) {
751 chmod SAVE_MODE, $fh; 1206 aio_chmod $fh, SAVE_MODE;
752 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1207 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
753 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;
754 aio_fsync $fh; 1211 aio_fsync $fh;
1212 }
755 close $fh; 1213 aio_close $fh;
756 aio_rename "$filename.pst~", "$filename.pst"; 1214 aio_rename "$filename.pst~", "$filename.pst";
757 } 1215 }
758 } else { 1216 } else {
759 aio_unlink "$filename.pst"; 1217 aio_unlink "$filename.pst";
760 } 1218 }
761 1219
762 aio_rename "$filename~", $filename; 1220 aio_rename "$filename~", $filename;
1221
1222 $filename =~ s%/[^/]+$%%;
1223 aio_pathsync $filename if $cf::USE_FSYNC;
763 } else { 1224 } else {
764 warn "FATAL: $filename~: $!\n"; 1225 warn "unable to save objects: $filename~: $!\n";
765 } 1226 }
766 } else { 1227 } else {
767 aio_unlink $filename; 1228 aio_unlink $filename;
768 aio_unlink "$filename.pst"; 1229 aio_unlink "$filename.pst";
769 } 1230 }
770 } 1231 };
771} 1232}
772 1233
773sub object_freezer_as_string { 1234sub object_freezer_as_string {
774 my ($rdata, $objs) = @_; 1235 my ($rdata, $objs) = @_;
775 1236
787 or return; 1248 or return;
788 1249
789 unless (aio_stat "$filename.pst") { 1250 unless (aio_stat "$filename.pst") {
790 (aio_load "$filename.pst", $av) >= 0 1251 (aio_load "$filename.pst", $av) >= 0
791 or return; 1252 or return;
1253
792 $av = eval { (Storable::thaw $av)->{objs} }; 1254 my $st = eval { Coro::Storable::thaw $av };
1255 $av = $st->{objs};
793 } 1256 }
794 1257
1258 utf8::decode (my $decname = $filename);
795 warn sprintf "loading %s (%d)\n", 1259 warn sprintf "loading %s (%d,%d)\n",
796 $filename, length $data, scalar @{$av || []};#d# 1260 $decname, length $data, scalar @{$av || []};
1261
797 return ($data, $av); 1262 ($data, $av)
798} 1263}
1264
1265=head2 COMMAND CALLBACKS
1266
1267=over 4
1268
1269=cut
799 1270
800############################################################################# 1271#############################################################################
801# command handling &c 1272# command handling &c
802 1273
803=item cf::register_command $name => \&callback($ob,$args); 1274=item cf::register_command $name => \&callback($ob,$args);
816 push @{ $COMMAND{$name} }, [$caller, $cb]; 1287 push @{ $COMMAND{$name} }, [$caller, $cb];
817} 1288}
818 1289
819=item cf::register_extcmd $name => \&callback($pl,$packet); 1290=item cf::register_extcmd $name => \&callback($pl,$packet);
820 1291
821Register 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.
822 1297
823If 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
824called. 1299called.
825 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
826=cut 1312=cut
827 1313
828sub register_extcmd { 1314sub register_extcmd {
829 my ($name, $cb) = @_; 1315 my ($name, $cb) = @_;
830 1316
831 $EXTCMD{$name} = $cb; 1317 $EXTCMD{$name} = $cb;
832} 1318}
833 1319
1320sub register_exticmd {
1321 my ($name, $cb) = @_;
1322
1323 $EXTICMD{$name} = $cb;
1324}
1325
1326use File::Glob ();
1327
834cf::player->attach ( 1328cf::player->attach (
835 on_command => sub { 1329 on_unknown_command => sub {
836 my ($pl, $name, $params) = @_; 1330 my ($pl, $name, $params) = @_;
837 1331
838 my $cb = $COMMAND{$name} 1332 my $cb = $COMMAND{$name}
839 or return; 1333 or return;
840 1334
845 cf::override; 1339 cf::override;
846 }, 1340 },
847 on_extcmd => sub { 1341 on_extcmd => sub {
848 my ($pl, $buf) = @_; 1342 my ($pl, $buf) = @_;
849 1343
850 my $msg = eval { from_json $buf }; 1344 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
851 1345
852 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
853 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1354 if (my $cb = $EXTCMD{$type}) {
854 if (my %reply = $cb->($pl, $msg)) { 1355 @reply = $cb->($pl, @payload);
855 $pl->ext_reply ($msg->{msgid}, %reply);
856 }
857 } 1356 }
1357
1358 $pl->ext_reply ($reply, @reply)
1359 if $reply;
1360
858 } else { 1361 } else {
859 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1362 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
860 } 1363 }
861 1364
862 cf::override; 1365 cf::override;
863 }, 1366 },
864); 1367);
865 1368
1369# "readahead" all extensions
866sub load_extension { 1370sub cache_extensions {
867 my ($path) = @_; 1371 my $grp = IO::AIO::aio_group;
868 1372
869 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1373 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
870 my $base = $1; 1374 for (grep /\.ext$/, @{$_[0]}) {
871 my $pkg = $1; 1375 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
872 $pkg =~ s/[^[:word:]]/_/g;
873 $pkg = "ext::$pkg";
874
875 warn "... loading '$path' into '$pkg'\n";
876
877 open my $fh, "<:utf8", $path
878 or die "$path: $!";
879
880 my $source =
881 "package $pkg; use strict; use utf8;\n"
882 . "#line 1 \"$path\"\n{\n"
883 . (do { local $/; <$fh> })
884 . "\n};\n1";
885
886 unless (eval $source) {
887 my $msg = $@ ? "$path: $@\n"
888 : "extension disabled.\n";
889 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
890 warn $@;
891 warn "mandatory extension failed to load, exiting.\n";
892 exit 1;
893 } 1376 }
894 die $@;
895 } 1377 };
896 1378
897 push @EXTS, $pkg; 1379 $grp
898} 1380}
899 1381
900sub load_extensions { 1382sub load_extensions {
1383 cf::sync_job {
1384 my %todo;
1385
901 for my $ext (<$LIBDIR/*.ext>) { 1386 for my $path (<$LIBDIR/*.ext>) {
902 next unless -r $ext; 1387 next unless -r $path;
903 eval { 1388
904 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 }
905 1 1449 }
906 } 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 }
907 } 1460 };
908} 1461}
909 1462
910############################################################################# 1463#############################################################################
911 1464
1465=back
1466
912=head2 CORE EXTENSIONS 1467=head2 CORE EXTENSIONS
913 1468
914Functions and methods that extend core crossfire objects. 1469Functions and methods that extend core deliantra objects.
915 1470
916=cut 1471=cut
917 1472
918package cf::player; 1473package cf::player;
919 1474
921 1476
922=head3 cf::player 1477=head3 cf::player
923 1478
924=over 4 1479=over 4
925 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
926=item cf::player::find $login 1495=item cf::player::find $login
927 1496
928Returns the given player object, loading it if necessary (might block). 1497Returns the given player object, loading it if necessary (might block).
929 1498
930=cut 1499=cut
931 1500
932sub playerdir($) { 1501sub playerdir($) {
933 cf::localdir 1502 "$PLAYERDIR/"
934 . "/"
935 . cf::playerdir
936 . "/"
937 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1503 . (ref $_[0] ? $_[0]->ob->name : $_[0])
938} 1504}
939 1505
940sub path($) { 1506sub path($) {
941 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1507 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
942 1508
943 (playerdir $login) . "/$login.pl" 1509 (playerdir $login) . "/playerdata"
944} 1510}
945 1511
946sub find_active($) { 1512sub find_active($) {
947 $cf::PLAYER{$_[0]} 1513 $cf::PLAYER{$_[0]}
948 and $cf::PLAYER{$_[0]}->active 1514 and $cf::PLAYER{$_[0]}->active
951 1517
952sub exists($) { 1518sub exists($) {
953 my ($login) = @_; 1519 my ($login) = @_;
954 1520
955 $cf::PLAYER{$login} 1521 $cf::PLAYER{$login}
956 or cf::sync_job { !aio_stat $login } 1522 or !aio_stat path $login
957} 1523}
958 1524
959sub find($) { 1525sub find($) {
960 return $cf::PLAYER{$_[0]} || do { 1526 return $cf::PLAYER{$_[0]} || do {
961 my $login = $_[0]; 1527 my $login = $_[0];
962 1528
963 my $guard = cf::lock_acquire "user_find:$login"; 1529 my $guard = cf::lock_acquire "user_find:$login";
964 1530
965 $cf::PLAYER{$_[0]} || do { 1531 $cf::PLAYER{$_[0]} || do {
966 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
967 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;
968 $cf::PLAYER{$login} = $pl 1547 $cf::PLAYER{$login} = $pl
969 } 1548 }
970 } 1549 }
971} 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);
972 1564
973sub save($) { 1565sub save($) {
974 my ($pl) = @_; 1566 my ($pl) = @_;
975 1567
976 return if $pl->{deny_save}; 1568 return if $pl->{deny_save};
981 return if $pl->{deny_save}; 1573 return if $pl->{deny_save};
982 1574
983 aio_mkdir playerdir $pl, 0770; 1575 aio_mkdir playerdir $pl, 0770;
984 $pl->{last_save} = $cf::RUNTIME; 1576 $pl->{last_save} = $cf::RUNTIME;
985 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
986 $pl->save_pl ($path); 1583 $pl->save_pl ($path);
987 Coro::cede; 1584 cf::cede_to_tick;
988} 1585}
989 1586
990sub new($) { 1587sub new($) {
991 my ($login) = @_; 1588 my ($login) = @_;
992 1589
998 $cf::PLAYER{$login} = $self; 1595 $cf::PLAYER{$login} = $self;
999 1596
1000 $self 1597 $self
1001} 1598}
1002 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
1003=item $pl->quit_character 1610=item $pl->quit_character
1004 1611
1005Nukes the player without looking back. If logged in, the connection will 1612Nukes the player without looking back. If logged in, the connection will
1006be destroyed. May block for a long time. 1613be destroyed. May block for a long time.
1007 1614
1008=cut 1615=cut
1009 1616
1010sub quit_character { 1617sub quit_character {
1011 my ($pl) = @_; 1618 my ($pl) = @_;
1012 1619
1620 my $name = $pl->ob->name;
1621
1013 $pl->{deny_save} = 1; 1622 $pl->{deny_save} = 1;
1014 $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
1015 1624
1016 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1625 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1017 $pl->deactivate; 1626 $pl->deactivate;
1627 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1628 $pl->ob->check_score;
1018 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1629 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1019 $pl->ns->destroy if $pl->ns; 1630 $pl->ns->destroy if $pl->ns;
1020 1631
1021 my $path = playerdir $pl; 1632 my $path = playerdir $pl;
1022 my $temp = "$path~$cf::RUNTIME~deleting~"; 1633 my $temp = "$path~$cf::RUNTIME~deleting~";
1023 aio_rename $path, $temp; 1634 aio_rename $path, $temp;
1024 delete $cf::PLAYER{$pl->ob->name}; 1635 delete $cf::PLAYER{$pl->ob->name};
1025 $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
1026 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;
1027} 1658}
1028 1659
1029=item cf::player::list_logins 1660=item cf::player::list_logins
1030 1661
1031Returns 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
1032while and may block, so not sync_job-capable, ever. 1663while and may block, so not sync_job-capable, ever.
1033 1664
1034=cut 1665=cut
1035 1666
1036sub list_logins { 1667sub list_logins {
1037 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1668 my $dirs = aio_readdir $PLAYERDIR
1038 or return []; 1669 or return [];
1039 1670
1040 my @logins; 1671 my @logins;
1041 1672
1042 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") {
1043 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1679 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1044 aio_read $fh, 0, 512, my $buf, 0 or next; 1680 aio_read $fh, 0, 512, my $buf, 0 or next;
1045 $buf !~ /^password -------------$/m or next; # official not-valid tag 1681 $buf !~ /^password -------------$/m or next; # official not-valid tag
1682 }
1046 1683
1047 utf8::decode $login; 1684 utf8::decode $login;
1048 push @logins, $login; 1685 push @logins, $login;
1049 } 1686 }
1050 1687
1058 1695
1059=cut 1696=cut
1060 1697
1061sub maps($) { 1698sub maps($) {
1062 my ($pl) = @_; 1699 my ($pl) = @_;
1700
1701 $pl = ref $pl ? $pl->ob->name : $pl;
1063 1702
1064 my $files = aio_readdir playerdir $pl 1703 my $files = aio_readdir playerdir $pl
1065 or return; 1704 or return;
1066 1705
1067 my @paths; 1706 my @paths;
1069 for (@$files) { 1708 for (@$files) {
1070 utf8::decode $_; 1709 utf8::decode $_;
1071 next if /\.(?:pl|pst)$/; 1710 next if /\.(?:pl|pst)$/;
1072 next unless /^$PATH_SEP/o; 1711 next unless /^$PATH_SEP/o;
1073 1712
1074 s/\.map$//; 1713 push @paths, cf::map::normalise "~$pl/$_";
1075 push @paths, "~" . $pl->ob->name . "/" . $_;
1076 } 1714 }
1077 1715
1078 \@paths 1716 \@paths
1079} 1717}
1080 1718
1719=item $protocol_xml = $player->expand_cfpod ($cfpod)
1720
1721Expand deliantra pod fragments into protocol xml.
1722
1081=item $player->ext_reply ($msgid, $msgtype, %msg) 1723=item $player->ext_reply ($msgid, @msg)
1082 1724
1083Sends an ext reply to the player. 1725Sends an ext reply to the player.
1084 1726
1085=cut 1727=cut
1086 1728
1087sub ext_reply($$$%) { 1729sub ext_reply($$@) {
1088 my ($self, $id, %msg) = @_; 1730 my ($self, $id, @msg) = @_;
1089 1731
1090 $msg{msgid} = $id; 1732 $self->ns->ext_reply ($id, @msg)
1091
1092 $self->send ("ext " . cf::to_json \%msg);
1093} 1733}
1094 1734
1095package 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}
1096 1775
1097=back 1776=back
1098
1099 1777
1100=head3 cf::map 1778=head3 cf::map
1101 1779
1102=over 4 1780=over 4
1103 1781
1107 1785
1108use Fcntl; 1786use Fcntl;
1109use Coro::AIO; 1787use Coro::AIO;
1110 1788
1111use overload 1789use overload
1112 '""' => \&as_string; 1790 '""' => \&as_string,
1791 fallback => 1;
1113 1792
1114our $MAX_RESET = 3600; 1793our $MAX_RESET = 3600;
1115our $DEFAULT_RESET = 3000; 1794our $DEFAULT_RESET = 3000;
1116 1795
1117sub generate_random_map { 1796sub generate_random_map {
1118 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
1119 1800
1120 # mit "rum" bekleckern, nicht 1801 # mit "rum" bekleckern, nicht
1121 $self->_create_random_map ( 1802 $self->_create_random_map (
1122 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1803 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1123 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1804 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1124 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1805 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1125 $rmp->{exit_on_final_map}, 1806 $rmp->{exit_on_final_map},
1126 $rmp->{xsize}, $rmp->{ysize}, 1807 $rmp->{xsize}, $rmp->{ysize},
1127 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1808 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1128 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1809 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1131 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1812 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1132 (cf::region::find $rmp->{region}), $rmp->{custom} 1813 (cf::region::find $rmp->{region}), $rmp->{custom}
1133 ) 1814 )
1134} 1815}
1135 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
1136sub register { 1825sub register {
1137 my (undef, $regex) = @_; 1826 my (undef, $regex, $prio) = @_;
1138 my $pkg = caller; 1827 my $pkg = caller;
1139 1828
1140 no strict; 1829 no strict;
1141 push @{"$pkg\::ISA"}, __PACKAGE__; 1830 push @{"$pkg\::ISA"}, __PACKAGE__;
1142 1831
1143 $EXT_MAP{$pkg} = qr<$regex>; 1832 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1144} 1833}
1145 1834
1146# also paths starting with '/' 1835# also paths starting with '/'
1147$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}
1148 1847
1149sub normalise { 1848sub normalise {
1150 my ($path, $base) = @_; 1849 my ($path, $base) = @_;
1850
1851 $path = "$path"; # make sure its a string
1852
1853 $path =~ s/\.map$//;
1151 1854
1152 # map plan: 1855 # map plan:
1153 # 1856 #
1154 # /! non-realised random map exit (special hack!) 1857 # /! non-realised random map exit (special hack!)
1155 # {... are special paths that are not being touched 1858 # {... are special paths that are not being touched
1183 1886
1184 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
1185 1888
1186 $path = normalise $path, $base; 1889 $path = normalise $path, $base;
1187 1890
1188 for my $pkg (keys %EXT_MAP) { 1891 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1189 if ($path =~ $EXT_MAP{$pkg}) { 1892 if ($path =~ $EXT_MAP{$pkg}[1]) {
1190 my $self = bless cf::map::new, $pkg; 1893 my $self = bless cf::map::new, $pkg;
1191 $self->{path} = $path; $self->path ($path); 1894 $self->{path} = $path; $self->path ($path);
1192 $self->init; # pass $1 etc. 1895 $self->init; # pass $1 etc.
1193 return $self; 1896 return $self;
1194 } 1897 }
1195 } 1898 }
1196 1899
1197 Carp::carp "unable to resolve path '$path'."; 1900 Carp::cluck "unable to resolve path '$path' (base '$base').";
1198 () 1901 ()
1199} 1902}
1200 1903
1201sub init { 1904sub init {
1202 my ($self) = @_; 1905 my ($self) = @_;
1217 1920
1218# the original (read-only) location 1921# the original (read-only) location
1219sub load_path { 1922sub load_path {
1220 my ($self) = @_; 1923 my ($self) = @_;
1221 1924
1222 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1925 "$MAPDIR/$self->{path}.map"
1223} 1926}
1224 1927
1225# the temporary/swap location 1928# the temporary/swap location
1226sub save_path { 1929sub save_path {
1227 my ($self) = @_; 1930 my ($self) = @_;
1228 1931
1229 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1932 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1230 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1933 "$TMPDIR/$path.map"
1231} 1934}
1232 1935
1233# the unique path, undef == no special unique path 1936# the unique path, undef == no special unique path
1234sub uniq_path { 1937sub uniq_path {
1235 my ($self) = @_; 1938 my ($self) = @_;
1236 1939
1237 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1940 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1238 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1941 "$UNIQUEDIR/$path"
1239} 1942}
1240 1943
1241# and all this just because we cannot iterate over 1944sub decay_objects {
1242# all maps in C++...
1243sub change_all_map_light {
1244 my ($change) = @_; 1945 my ($self) = @_;
1245 1946
1246 $_->change_map_light ($change) 1947 return if $self->{deny_reset};
1247 for grep $_->outdoor, values %cf::MAP; 1948
1949 $self->do_decay_objects;
1248} 1950}
1249 1951
1250sub unlink_save { 1952sub unlink_save {
1251 my ($self) = @_; 1953 my ($self) = @_;
1252 1954
1253 utf8::encode (my $save = $self->save_path); 1955 utf8::encode (my $save = $self->save_path);
1254 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1956 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1255 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1957 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1256} 1958}
1257 1959
1258sub load_header_from($) { 1960sub load_header_from($) {
1259 my ($self, $path) = @_; 1961 my ($self, $path) = @_;
1260 1962
1261 utf8::encode $path; 1963 utf8::encode $path;
1262 aio_open $path, O_RDONLY, 0 1964 my $f = new_from_file cf::object::thawer $path
1263 or return; 1965 or return;
1264 1966
1265 $self->_load_header ($path) 1967 $self->_load_header ($f)
1266 or return; 1968 or return;
1267 1969
1970 local $MAP_LOADING{$self->{path}} = $self;
1971 $f->resolve_delayed_derefs;
1972
1268 $self->{load_path} = $path; 1973 $self->{load_path} = $path;
1269 1974
1270 1 1975 1
1271} 1976}
1272 1977
1273sub load_orig { 1978sub load_header_orig {
1274 my ($self) = @_; 1979 my ($self) = @_;
1275 1980
1276 $self->load_header_from ($self->load_path) 1981 $self->load_header_from ($self->load_path)
1277} 1982}
1278 1983
1279sub load_temp { 1984sub load_header_temp {
1280 my ($self) = @_; 1985 my ($self) = @_;
1281 1986
1282 $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;
1283} 2007}
1284 2008
1285sub load_header { 2009sub load_header {
1286 my ($self) = @_; 2010 my ($self) = @_;
1287 2011
1288 if ($self->load_temp) { 2012 if ($self->load_header_temp) {
1289 $self->last_access ((delete $self->{last_access}) 2013 $self->prepare_temp;
1290 || $cf::RUNTIME); #d#
1291 # safety
1292 $self->{instantiate_time} = $cf::RUNTIME
1293 if $self->{instantiate_time} > $cf::RUNTIME;
1294 } else { 2014 } else {
1295 $self->load_orig 2015 $self->load_header_orig
1296 or return; 2016 or return;
1297 2017 $self->prepare_orig;
1298 $self->{load_original} = 1;
1299 $self->{instantiate_time} = $cf::RUNTIME;
1300 $self->last_access ($cf::RUNTIME);
1301 $self->instantiate;
1302 } 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;
1303 2025
1304 1 2026 1
1305} 2027}
1306 2028
1307sub find; 2029sub find;
1308sub find { 2030sub find {
1309 my ($path, $origin) = @_; 2031 my ($path, $origin) = @_;
1310 2032
1311 $path = normalise $path, $origin && $origin->path; 2033 $path = normalise $path, $origin && $origin->path;
1312 2034
2035 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1313 cf::lock_wait "map_find:$path"; 2036 my $guard2 = cf::lock_acquire "map_find:$path";
1314 2037
1315 $cf::MAP{$path} || do { 2038 $cf::MAP{$path} || do {
1316 my $guard = cf::lock_acquire "map_find:$path";
1317 my $map = new_from_path cf::map $path 2039 my $map = new_from_path cf::map $path
1318 or return; 2040 or return;
1319 2041
1320 $map->{last_save} = $cf::RUNTIME; 2042 $map->{last_save} = $cf::RUNTIME;
1321 2043
1322 $map->load_header 2044 $map->load_header
1323 or return; 2045 or return;
1324 2046
1325 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;
1326 $map->reset; 2052 $map->reset;
1327 undef $guard;
1328 $map = find $path 2053 return find $path;
1329 or return;
1330 } 2054 }
1331 2055
1332 $cf::MAP{$path} = $map 2056 $cf::MAP{$path} = $map
1333 } 2057 }
1334} 2058}
2059
2060sub pre_load { }
2061#sub post_load { } # XS
1335 2062
1336sub load { 2063sub load {
1337 my ($self) = @_; 2064 my ($self) = @_;
1338 2065
2066 local $self->{deny_reset} = 1; # loading can take a long time
2067
1339 my $path = $self->{path}; 2068 my $path = $self->{path};
2069
2070 {
1340 my $guard = cf::lock_acquire "map_load:$path"; 2071 my $guard = cf::lock_acquire "map_data:$path";
1341 2072
2073 return unless $self->valid;
1342 return if $self->in_memory != cf::MAP_SWAPPED; 2074 return unless $self->in_memory == cf::MAP_SWAPPED;
1343 2075
1344 $self->in_memory (cf::MAP_LOADING); 2076 $self->in_memory (cf::MAP_LOADING);
1345 2077
1346 $self->alloc; 2078 $self->alloc;
1347 $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)
1348 or return; 2086 or return;
1349 2087
1350 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2088 $self->post_load_original
1351 if delete $self->{load_original}; 2089 if delete $self->{load_original};
1352 2090
1353 if (my $uniq = $self->uniq_path) { 2091 if (my $uniq = $self->uniq_path) {
1354 utf8::encode $uniq; 2092 utf8::encode $uniq;
1355 if (aio_open $uniq, O_RDONLY, 0) { 2093 unless (aio_stat $uniq) {
2094 if (my $f = new_from_file cf::object::thawer $uniq) {
1356 $self->clear_unique_items; 2095 $self->clear_unique_items;
1357 $self->_load_objects ($uniq, 0); 2096 $self->_load_objects ($f);
2097 $f->resolve_delayed_derefs;
2098 }
1358 } 2099 }
1359 } 2100 }
1360 2101
1361 Coro::cede; 2102 $f->resolve_delayed_derefs;
1362 2103
2104 cf::cede_to_tick;
1363 # now do the right thing for maps 2105 # now do the right thing for maps
1364 $self->link_multipart_objects; 2106 $self->link_multipart_objects;
1365
1366 unless ($self->{deny_activate}) {
1367 $self->decay_objects;
1368 $self->fix_auto_apply;
1369 $self->update_buttons;
1370 Coro::cede;
1371 $self->set_darkness_map;
1372 $self->difficulty ($self->estimate_difficulty) 2107 $self->difficulty ($self->estimate_difficulty)
1373 unless $self->difficulty; 2108 unless $self->difficulty;
1374 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;
1375 $self->activate; 2116 $self->activate;
1376 } 2117 }
1377 2118
2119 $self->{last_save} = $cf::RUNTIME;
2120 $self->last_access ($cf::RUNTIME);
2121
1378 $self->in_memory (cf::MAP_IN_MEMORY); 2122 $self->in_memory (cf::MAP_ACTIVE);
1379} 2123 }
1380 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
1381sub customise_for { 2131sub customise_for {
1382 my ($self, $ob) = @_; 2132 my ($self, $ob) = @_;
1383 2133
1384 return find "~" . $ob->name . "/" . $self->{path} 2134 return find "~" . $ob->name . "/" . $self->{path}
1385 if $self->per_player; 2135 if $self->per_player;
1386 2136
2137# return find "?party/" . $ob->name . "/" . $self->{path}
2138# if $self->per_party;
2139
1387 $self 2140 $self
1388} 2141}
1389 2142
1390# 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
1391sub load_diag { 2144sub load_neighbours {
1392 my ($map) = @_; 2145 my ($map) = @_;
1393 2146
1394 my @diag; # diagonal neighbours 2147 my @neigh; # diagonal neighbours
1395 2148
1396 for (0 .. 3) { 2149 for (0 .. 3) {
1397 my $neigh = $map->tile_path ($_) 2150 my $neigh = $map->tile_path ($_)
1398 or next; 2151 or next;
1399 $neigh = find $neigh, $map 2152 $neigh = find $neigh, $map
1400 or next; 2153 or next;
1401 $neigh->load; 2154 $neigh->load;
1402 2155
2156 push @neigh,
1403 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2157 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1404 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2158 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1405 } 2159 }
1406 2160
1407 for (@diag) { 2161 for (grep defined $_->[0], @neigh) {
2162 my ($path, $origin) = @$_;
1408 my $neigh = find @$_ 2163 my $neigh = find $path, $origin
1409 or next; 2164 or next;
1410 $neigh->load; 2165 $neigh->load;
1411 } 2166 }
1412} 2167}
1413 2168
1418} 2173}
1419 2174
1420sub do_load_sync { 2175sub do_load_sync {
1421 my ($map) = @_; 2176 my ($map) = @_;
1422 2177
2178 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2179 if $Coro::current == $Coro::main;
2180
1423 cf::sync_job { $map->load }; 2181 cf::sync_job { $map->load };
1424} 2182}
1425 2183
1426our %MAP_PREFETCH; 2184our %MAP_PREFETCH;
1427our $MAP_PREFETCHER = Coro::async { 2185our $MAP_PREFETCHER = undef;
1428 while () {
1429 for my $path (keys %MAP_PREFETCH) {
1430 my $map = find $path
1431 or next;
1432 $map->load;
1433
1434 delete $MAP_PREFETCH{$path};
1435 }
1436 Coro::schedule;
1437 }
1438};
1439 2186
1440sub find_async { 2187sub find_async {
1441 my ($path, $origin) = @_; 2188 my ($path, $origin, $load) = @_;
1442 2189
1443 $path = normalise $path, $origin && $origin->{path}; 2190 $path = normalise $path, $origin && $origin->{path};
1444 2191
1445 if (my $map = $cf::MAP{$path}) { 2192 if (my $map = $cf::MAP{$path}) {
1446 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;
1447 } 2211 };
1448
1449 $MAP_PREFETCH{$path} = 0;
1450 $MAP_PREFETCHER->ready; 2212 $MAP_PREFETCHER->prio (6);
1451 2213
1452 () 2214 ()
1453} 2215}
1454 2216
2217# common code, used by both ->save and ->swapout
1455sub save { 2218sub _save {
1456 my ($self) = @_; 2219 my ($self) = @_;
1457
1458 my $lock = cf::lock_acquire "map_data:" . $self->path;
1459 2220
1460 $self->{last_save} = $cf::RUNTIME; 2221 $self->{last_save} = $cf::RUNTIME;
1461 2222
1462 return unless $self->dirty; 2223 return unless $self->dirty;
1463 2224
1469 return if $self->{deny_save}; 2230 return if $self->{deny_save};
1470 2231
1471 local $self->{last_access} = $self->last_access;#d# 2232 local $self->{last_access} = $self->last_access;#d#
1472 2233
1473 cf::async { 2234 cf::async {
2235 $Coro::current->{desc} = "map player save";
1474 $_->contr->save for $self->players; 2236 $_->contr->save for $self->players;
1475 }; 2237 };
2238
2239 cf::get_slot 0.02;
1476 2240
1477 if ($uniq) { 2241 if ($uniq) {
1478 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2242 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1479 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2243 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1480 } else { 2244 } else {
1481 $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);
1482 } 2246 }
1483} 2247}
1484 2248
2249sub save {
2250 my ($self) = @_;
2251
2252 my $lock = cf::lock_acquire "map_data:$self->{path}";
2253
2254 $self->_save;
2255}
2256
1485sub swap_out { 2257sub swap_out {
1486 my ($self) = @_; 2258 my ($self) = @_;
1487 2259
1488 # save first because save cedes
1489 $self->save;
1490
1491 my $lock = cf::lock_acquire "map_data:" . $self->path; 2260 my $lock = cf::lock_acquire "map_data:$self->{path}";
1492 2261
2262 return if $self->in_memory != cf::MAP_ACTIVE;
2263 return if $self->{deny_save};
1493 return if $self->players; 2264 return if $self->players;
1494 return if $self->in_memory != cf::MAP_IN_MEMORY;
1495 return if $self->{deny_save};
1496 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
1497 $self->clear; 2275 $self->clear;
1498 $self->in_memory (cf::MAP_SWAPPED);
1499} 2276}
1500 2277
1501sub reset_at { 2278sub reset_at {
1502 my ($self) = @_; 2279 my ($self) = @_;
1503 2280
1504 # TODO: safety, remove and allow resettable per-player maps 2281 # TODO: safety, remove and allow resettable per-player maps
1505 return 1e99 if $self->isa ("ext::map_per_player");#d#
1506 return 1e99 if $self->{deny_reset}; 2282 return 1e99 if $self->{deny_reset};
1507 2283
1508 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2284 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1509 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;
1510 2286
1515 my ($self) = @_; 2291 my ($self) = @_;
1516 2292
1517 $self->reset_at <= $cf::RUNTIME 2293 $self->reset_at <= $cf::RUNTIME
1518} 2294}
1519 2295
1520sub rename {
1521 my ($self, $new_path) = @_;
1522
1523 normalise $new_path;
1524
1525 $self->unlink_save;
1526
1527 delete $cf::MAP{$self->path};
1528 $self->{path} = $new_path; $self->path ($self->{path});
1529 $cf::MAP{$self->path} = $self;
1530
1531 $self->save;
1532}
1533
1534sub reset { 2296sub reset {
1535 my ($self) = @_; 2297 my ($self) = @_;
1536 2298
1537 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2299 my $lock = cf::lock_acquire "map_data:$self->{path}";
1538 2300
1539 return if $self->players; 2301 return if $self->players;
1540 return if $self->isa ("ext::map_per_player");#d#
1541 2302
1542 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 }
1543 2314
1544 delete $cf::MAP{$self->path}; 2315 delete $cf::MAP{$self->path};
1545 2316
1546 $self->in_memory (cf::MAP_SWAPPED); 2317 $self->deactivate;
2318 $_->clear_links_to ($self) for values %cf::MAP;
1547 $self->clear; 2319 $self->clear;
1548
1549 $_->clear_links_to ($self) for values %cf::MAP;
1550 2320
1551 $self->unlink_save; 2321 $self->unlink_save;
1552 $self->destroy; 2322 $self->destroy;
1553} 2323}
1554 2324
1555my $nuke_counter = "aaaa"; 2325my $nuke_counter = "aaaa";
1556 2326
1557sub nuke { 2327sub nuke {
1558 my ($self) = @_; 2328 my ($self) = @_;
1559 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};
1560 $self->{deny_save} = 1; 2339 $self->{deny_save} = 1;
1561 $self->reset_timeout (1); 2340 $self->reset_timeout (1);
1562 $self->rename ("{nuke}/" . ($nuke_counter++)); 2341 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2342
2343 $cf::MAP{$self->path} = $self;
2344 }
2345
1563 $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 ]
1564} 2383}
1565 2384
1566=item cf::map::unique_maps 2385=item cf::map::unique_maps
1567 2386
1568Returns an arrayref of paths of all shared maps that have 2387Returns an arrayref of paths of all shared maps that have
1569instantiated unique items. May block. 2388instantiated unique items. May block.
1570 2389
1571=cut 2390=cut
1572 2391
1573sub unique_maps() { 2392sub unique_maps() {
1574 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2393 [
1575 or return; 2394 map {
1576
1577 my @paths;
1578
1579 for (@$files) {
1580 utf8::decode $_; 2395 utf8::decode $_;
1581 next if /\.pst$/; 2396 s/\.map$//; # TODO future compatibility hack
1582 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}
1583 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) {
1584 s/\.map$//; 2425 s/\.map$// or next;
1585 push @paths, $_; 2426 utf8::decode $_;
1586 } 2427 push @maps, "$dir/$_";
2428 }
1587 2429
1588 \@paths 2430 push @dirs, map "$dir/$_", @$dirs;
1589} 2431 }
1590 2432
1591package cf; 2433 \@maps
2434}
1592 2435
1593=back 2436=back
1594 2437
1595=head3 cf::object 2438=head3 cf::object
1596 2439
1600 2443
1601=over 4 2444=over 4
1602 2445
1603=item $ob->inv_recursive 2446=item $ob->inv_recursive
1604 2447
1605Returns 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.
1606 2450
1607=cut 2451=cut
1608 2452
1609sub inv_recursive_; 2453sub inv_recursive_;
1610sub inv_recursive_ { 2454sub inv_recursive_ {
1613 2457
1614sub inv_recursive { 2458sub inv_recursive {
1615 inv_recursive_ inv $_[0] 2459 inv_recursive_ inv $_[0]
1616} 2460}
1617 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
1618package cf; 2490package cf;
1619 2491
1620=back 2492=back
1621 2493
1622=head3 cf::object::player 2494=head3 cf::object::player
1628Sends 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>
1629can 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
1630dialogue with the given NPC character. 2502dialogue with the given NPC character.
1631 2503
1632=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};
1633 2519
1634# rough implementation of a future "reply" method that works 2520# rough implementation of a future "reply" method that works
1635# with dialog boxes. 2521# with dialog boxes.
1636#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
1637sub cf::object::player::reply($$$;$) { 2523sub cf::object::player::reply($$$;$) {
1639 2525
1640 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2526 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1641 2527
1642 if ($self->{record_replies}) { 2528 if ($self->{record_replies}) {
1643 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2529 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2530
1644 } 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 {
1645 $msg = $npc->name . " says: $msg" if $npc; 2539 $msg = $npc->name . " says: $msg" if $npc;
1646 $self->message ($msg, $flags); 2540 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2541 }
1647 } 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 (@_);
1648} 2553}
1649 2554
1650=item $player_object->may ("access") 2555=item $player_object->may ("access")
1651 2556
1652Returns wether the given player is authorized to access resource "access" 2557Returns wether the given player is authorized to access resource "access"
1665 2570
1666=item $player_object->enter_link 2571=item $player_object->enter_link
1667 2572
1668Freezes 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}>).
1669 2574
1670The 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.
1671I<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.
1672 2579
1673Will never block. 2580Will never block.
1674 2581
1675=item $player_object->leave_link ($map, $x, $y) 2582=item $player_object->leave_link ($map, $x, $y)
1676 2583
1684=cut 2591=cut
1685 2592
1686sub link_map { 2593sub link_map {
1687 unless ($LINK_MAP) { 2594 unless ($LINK_MAP) {
1688 $LINK_MAP = cf::map::find "{link}" 2595 $LINK_MAP = cf::map::find "{link}"
1689 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2596 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1690 $LINK_MAP->load; 2597 $LINK_MAP->load;
1691 } 2598 }
1692 2599
1693 $LINK_MAP 2600 $LINK_MAP
1694} 2601}
1699 $self->deactivate_recursive; 2606 $self->deactivate_recursive;
1700 2607
1701 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2608 return if UNIVERSAL::isa $self->map, "ext::map_link";
1702 2609
1703 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2610 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1704 if $self->map; 2611 if $self->map && $self->map->{path} ne "{link}";
1705 2612
1706 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2613 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1707} 2614}
1708 2615
1709sub cf::object::player::leave_link { 2616sub cf::object::player::leave_link {
1710 my ($self, $map, $x, $y) = @_; 2617 my ($self, $map, $x, $y) = @_;
2618
2619 return unless $self->contr->active;
1711 2620
1712 my $link_pos = delete $self->{_link_pos}; 2621 my $link_pos = delete $self->{_link_pos};
1713 2622
1714 unless ($map) { 2623 unless ($map) {
1715 # restore original map position 2624 # restore original map position
1726 ($x, $y) = (-1, -1) 2635 ($x, $y) = (-1, -1)
1727 unless (defined $x) && (defined $y); 2636 unless (defined $x) && (defined $y);
1728 2637
1729 # use -1 or undef as default coordinates, not 0, 0 2638 # use -1 or undef as default coordinates, not 0, 0
1730 ($x, $y) = ($map->enter_x, $map->enter_y) 2639 ($x, $y) = ($map->enter_x, $map->enter_y)
1731 if $x <=0 && $y <= 0; 2640 if $x <= 0 && $y <= 0;
1732 2641
1733 $map->load; 2642 $map->load;
1734 $map->load_diag; 2643 $map->load_neighbours;
1735 2644
1736 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
1737 $self->activate_recursive; 2651 $self->activate_recursive;
1738 $self->enter_map ($map, $x, $y);
1739} 2652}
1740 2653
1741cf::player->attach ( 2654=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1742 on_logout => sub {
1743 my ($pl) = @_;
1744 2655
1745 # abort map switching before logout 2656Moves the player to the given map-path and coordinates by first freezing
1746 if ($pl->ob->{_link_pos}) { 2657her, loading and preparing them map, calling the provided $check callback
1747 cf::sync_job { 2658that has to return the map if sucecssful, and then unfreezes the player on
1748 $pl->ob->leave_link 2659the new (success) or old (failed) map position. In either case, $done will
1749 }; 2660be called at the end of this process.
1750 }
1751 },
1752 on_login => sub {
1753 my ($pl) = @_;
1754 2661
1755 # try to abort aborted map switching on player login :) 2662Note that $check will be called with a potentially non-loaded map, so if
1756 # should happen only on crashes 2663it needs a loaded map it has to call C<< ->load >>.
1757 if ($pl->ob->{_link_pos}) {
1758 $pl->ob->enter_link;
1759 (async {
1760 # we need this sleep as the login has a concurrent enter_exit running
1761 # and this sleep increases chances of the player not ending up in scorn
1762 $pl->ob->reply (undef,
1763 "There was an internal problem at your last logout, "
1764 . "the server will try to bring you to your intended destination in a second.",
1765 cf::NDI_RED);
1766 Coro::Timer::sleep 1;
1767 $pl->ob->leave_link;
1768 })->prio (2);
1769 }
1770 },
1771);
1772 2664
1773=item $player_object->goto ($path, $x, $y)
1774
1775=cut 2665=cut
2666
2667our $GOTOGEN;
1776 2668
1777sub cf::object::player::goto { 2669sub cf::object::player::goto {
1778 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;
1779 2674
1780 $self->enter_link; 2675 $self->enter_link;
1781 2676
1782 (async { 2677 (async {
1783 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) {
1784 $map = $map->customise_for ($self) if $map; 2703 $map = $map->customise_for ($self);
1785 2704 $map = $check->($map) if $check && $map;
1786# warn "entering ", $map->path, " at ($x, $y)\n" 2705 } else {
1787# if $map;
1788
1789 $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 }
1790 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};
1791 $self->leave_link ($map, $x, $y); 2719 $self->leave_link ($map, $x, $y);
2720 }
2721
2722 $done->() if $done;
1792 })->prio (1); 2723 })->prio (1);
1793} 2724}
1794 2725
1795=item $player_object->enter_exit ($exit_object) 2726=item $player_object->enter_exit ($exit_object)
1796 2727
1798 2729
1799sub parse_random_map_params { 2730sub parse_random_map_params {
1800 my ($spec) = @_; 2731 my ($spec) = @_;
1801 2732
1802 my $rmp = { # defaults 2733 my $rmp = { # defaults
1803 xsize => 10, 2734 xsize => (cf::rndm 15, 40),
1804 ysize => 10, 2735 ysize => (cf::rndm 15, 40),
2736 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2737 #layout => string,
1805 }; 2738 };
1806 2739
1807 for (split /\n/, $spec) { 2740 for (split /\n/, $spec) {
1808 my ($k, $v) = split /\s+/, $_, 2; 2741 my ($k, $v) = split /\s+/, $_, 2;
1809 2742
1821 # that depends on the exit object 2754 # that depends on the exit object
1822 2755
1823 my $rmp = parse_random_map_params $exit->msg; 2756 my $rmp = parse_random_map_params $exit->msg;
1824 2757
1825 if ($exit->map) { 2758 if ($exit->map) {
1826 $rmp->{region} = $exit->map->region_name; 2759 $rmp->{region} = $exit->region->name;
1827 $rmp->{origin_map} = $exit->map->path; 2760 $rmp->{origin_map} = $exit->map->path;
1828 $rmp->{origin_x} = $exit->x; 2761 $rmp->{origin_x} = $exit->x;
1829 $rmp->{origin_y} = $exit->y; 2762 $rmp->{origin_y} = $exit->y;
2763
2764 $exit->map->touch;
1830 } 2765 }
1831 2766
1832 $rmp->{random_seed} ||= $exit->random_seed; 2767 $rmp->{random_seed} ||= $exit->random_seed;
1833 2768
1834 my $data = cf::to_json $rmp; 2769 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1835 my $md5 = Digest::MD5::md5_hex $data; 2770 my $md5 = Digest::MD5::md5_hex $data;
2771 my $meta = "$RANDOMDIR/$md5.meta";
1836 2772
1837 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) {
1838 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;
1839 2777
2778 my $slaying = "?random/$md5";
2779
2780 if ($exit->valid) {
1840 $exit->slaying ("?random/$md5"); 2781 $exit->slaying ("?random/$md5");
1841 $exit->msg (undef); 2782 $exit->msg (undef);
2783 }
1842 } 2784 }
1843} 2785}
1844 2786
1845sub cf::object::player::enter_exit { 2787sub cf::object::player::enter_exit {
1846 my ($self, $exit) = @_; 2788 my ($self, $exit) = @_;
1848 return unless $self->type == cf::PLAYER; 2790 return unless $self->type == cf::PLAYER;
1849 2791
1850 $self->enter_link; 2792 $self->enter_link;
1851 2793
1852 (async { 2794 (async {
1853 $self->deactivate_recursive; # just to be sure 2795 $Coro::current->{desc} = "enter_exit";
2796
1854 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
1855 prepare_random_map $exit 2804 prepare_random_map $exit
1856 if $exit->slaying eq "/!"; 2805 if $exit->slaying eq "/!";
2806 }
1857 2807
1858 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;
1859 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2809 my $x = $exit->stats->hp;
2810 my $y = $exit->stats->sp;
1860 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
1861 1; 2818 1
1862 }) { 2819 }) {
1863 $self->message ("Something went wrong deep within the crossfire server. " 2820 $self->message ("Something went wrong deep within the deliantra server. "
1864 . "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. "
1865 . "Please report this to the dungeon master!", 2822 . "Please report this to the dungeon master!",
1866 cf::NDI_UNIQUE | cf::NDI_RED); 2823 cf::NDI_UNIQUE | cf::NDI_RED);
1867 2824
1868 warn "ERROR in enter_exit: $@"; 2825 warn "ERROR in enter_exit: $@";
1869 $self->leave_link; 2826 $self->leave_link;
1870 } 2827 }
1871 })->prio (1); 2828 })->prio (1);
1884 2841
1885sub cf::client::send_drawinfo { 2842sub cf::client::send_drawinfo {
1886 my ($self, $text, $flags) = @_; 2843 my ($self, $text, $flags) = @_;
1887 2844
1888 utf8::encode $text; 2845 utf8::encode $text;
1889 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2846 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1890} 2847}
1891 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}
1892 3070
1893=item $success = $client->query ($flags, "text", \&cb) 3071=item $success = $client->query ($flags, "text", \&cb)
1894 3072
1895Queues a query to the client, calling the given callback with 3073Queues a query to the client, calling the given callback with
1896the 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>,
1897C<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>.
1898 3076
1899Queries 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
1900reliable at some point in the future. 3078become reliable at some point in the future.
1901 3079
1902=cut 3080=cut
1903 3081
1904sub cf::client::query { 3082sub cf::client::query {
1905 my ($self, $flags, $text, $cb) = @_; 3083 my ($self, $flags, $text, $cb) = @_;
1913 utf8::encode $text; 3091 utf8::encode $text;
1914 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3092 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1915 3093
1916 $self->send_packet ($self->{query_queue}[0][0]) 3094 $self->send_packet ($self->{query_queue}[0][0])
1917 if @{ $self->{query_queue} } == 1; 3095 if @{ $self->{query_queue} } == 1;
3096
3097 1
1918} 3098}
1919 3099
1920cf::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 },
1921 on_reply => sub { 3106 on_reply => sub {
1922 my ($ns, $msg) = @_; 3107 my ($ns, $msg) = @_;
1923 3108
1924 # this weird shuffling is so that direct followup queries 3109 # this weird shuffling is so that direct followup queries
1925 # get handled first 3110 # get handled first
1926 my $queue = delete $ns->{query_queue} 3111 my $queue = delete $ns->{query_queue}
1927 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
1928 3113
1929 (shift @$queue)->[1]->($msg); 3114 (shift @$queue)->[1]->($msg);
3115 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1930 3116
1931 push @{ $ns->{query_queue} }, @$queue; 3117 push @{ $ns->{query_queue} }, @$queue;
1932 3118
1933 if (@{ $ns->{query_queue} } == @$queue) { 3119 if (@{ $ns->{query_queue} } == @$queue) {
1934 if (@$queue) { 3120 if (@$queue) {
1936 } else { 3122 } else {
1937 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3123 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1938 } 3124 }
1939 } 3125 }
1940 }, 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 },
1941); 3153);
1942 3154
1943=item $client->async (\&cb) 3155=item $client->async (\&cb)
1944 3156
1945Create a new coroutine, running the specified callback. The coroutine will 3157Create a new coroutine, running the specified callback. The coroutine will
1961 3173
1962 $coro 3174 $coro
1963} 3175}
1964 3176
1965cf::client->attach ( 3177cf::client->attach (
1966 on_destroy => sub { 3178 on_client_destroy => sub {
1967 my ($ns) = @_; 3179 my ($ns) = @_;
1968 3180
1969 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3181 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1970 }, 3182 },
1971); 3183);
1986our $safe = new Safe "safe"; 3198our $safe = new Safe "safe";
1987our $safe_hole = new Safe::Hole; 3199our $safe_hole = new Safe::Hole;
1988 3200
1989$SIG{FPE} = 'IGNORE'; 3201$SIG{FPE} = 'IGNORE';
1990 3202
1991$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));
1992 3208
1993# here we export the classes and methods available to script code 3209# here we export the classes and methods available to script code
1994 3210
1995=pod 3211=pod
1996 3212
1997The following fucntions and emthods are available within a safe environment: 3213The following functions and methods are available within a safe environment:
1998 3214
1999 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
2000 cf::object::player player 3220 cf::object::player
2001 cf::player peaceful 3221 player
2002 cf::map trigger 3222
3223 cf::player
3224 peaceful
3225
3226 cf::map
3227 trigger
2003 3228
2004=cut 3229=cut
2005 3230
2006for ( 3231for (
2007 ["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)],
2008 ["cf::object::player" => qw(player)], 3235 ["cf::object::player" => qw(player)],
2009 ["cf::player" => qw(peaceful)], 3236 ["cf::player" => qw(peaceful send_msg)],
2010 ["cf::map" => qw(trigger)], 3237 ["cf::map" => qw(trigger)],
2011) { 3238) {
2012 no strict 'refs'; 3239 no strict 'refs';
2013 my ($pkg, @funs) = @$_; 3240 my ($pkg, @funs) = @$_;
2014 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3241 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2032 3259
2033 my $qcode = $code; 3260 my $qcode = $code;
2034 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3261 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2035 $qcode =~ s/\n/\\n/g; 3262 $qcode =~ s/\n/\\n/g;
2036 3263
3264 %vars = (_dummy => 0) unless %vars;
3265
3266 my @res;
2037 local $_; 3267 local $_;
2038 local @safe::cf::_safe_eval_args = values %vars;
2039 3268
2040 my $eval = 3269 my $eval =
2041 "do {\n" 3270 "do {\n"
2042 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3271 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2043 . "#line 0 \"{$qcode}\"\n" 3272 . "#line 0 \"{$qcode}\"\n"
2044 . $code 3273 . $code
2045 . "\n}" 3274 . "\n}"
2046 ; 3275 ;
2047 3276
3277 if ($CFG{safe_eval}) {
2048 sub_generation_inc; 3278 sub_generation_inc;
3279 local @safe::cf::_safe_eval_args = values %vars;
2049 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3280 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2050 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 }
2051 3286
2052 if ($@) { 3287 if ($@) {
2053 warn "$@"; 3288 warn "$@";
2054 warn "while executing safe code '$code'\n"; 3289 warn "while executing safe code '$code'\n";
2055 warn "with arguments " . (join " ", %vars) . "\n"; 3290 warn "with arguments " . (join " ", %vars) . "\n";
2074=cut 3309=cut
2075 3310
2076sub register_script_function { 3311sub register_script_function {
2077 my ($fun, $cb) = @_; 3312 my ($fun, $cb) = @_;
2078 3313
2079 no strict 'refs'; 3314 $fun = "safe::$fun" if $CFG{safe_eval};
2080 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3315 *$fun = $safe_hole->wrap ($cb);
2081} 3316}
2082 3317
2083=back 3318=back
2084 3319
2085=cut 3320=cut
2086 3321
2087############################################################################# 3322#############################################################################
3323# the server's init and main functions
2088 3324
2089=head2 EXTENSION DATABASE SUPPORT 3325sub load_facedata($) {
3326 my ($path) = @_;
2090 3327
2091Crossfire maintains a very simple database for extension use. It can 3328 # HACK to clear player env face cache, we need some signal framework
2092currently store anything that can be serialised using Storable, which 3329 # for this (global event?)
2093excludes objects. 3330 %ext::player_env::MUSIC_FACE_CACHE = ();
2094 3331
2095The parameter C<$family> should best start with the name of the extension 3332 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2096using it, it should be unique.
2097 3333
2098=over 4 3334 warn "loading facedata from $path\n";
2099 3335
2100=item $hashref = cf::db_get $family 3336 my $facedata;
3337 0 < aio_load $path, $facedata
3338 or die "$path: $!";
2101 3339
2102Return a hashref for use by the extension C<$family>, which can be 3340 $facedata = Coro::Storable::thaw $facedata;
2103modified. After modifications, you have to call C<cf::db_dirty> or
2104C<cf::db_sync>.
2105 3341
2106=item $value = cf::db_get $family => $key 3342 $facedata->{version} == 2
3343 or cf::cleanup "$path: version mismatch, cannot proceed.";
2107 3344
2108Returns a single value from the database 3345 # patch in the exptable
2109 3346 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2110=item cf::db_put $family => $hashref 3347 $facedata->{resource}{"res/exp_table"} = {
2111 3348 type => FT_RSRC,
2112Stores the given family hashref into the database. Updates are delayed, if 3349 data => $exp_table,
2113you want the data to be synced to disk immediately, use C<cf::db_sync>. 3350 hash => (Digest::MD5::md5 $exp_table),
2114
2115=item cf::db_put $family => $key => $value
2116
2117Stores the given C<$value> in the family hash. Updates are delayed, if you
2118want the data to be synced to disk immediately, use C<cf::db_sync>.
2119
2120=item cf::db_dirty
2121
2122Marks the database as dirty, to be updated at a later time.
2123
2124=item cf::db_sync
2125
2126Immediately write the database to disk I<if it is dirty>.
2127
2128=cut
2129
2130our $DB;
2131
2132{
2133 my $path = cf::localdir . "/database.pst";
2134
2135 sub db_load() {
2136 $DB = stat $path ? Storable::retrieve $path : { };
2137 }
2138
2139 my $pid;
2140
2141 sub db_save() {
2142 waitpid $pid, 0 if $pid;
2143 if (0 == ($pid = fork)) {
2144 $DB->{_meta}{version} = 1;
2145 Storable::nstore $DB, "$path~";
2146 rename "$path~", $path;
2147 cf::_exit 0 if defined $pid;
2148 }
2149 }
2150
2151 my $dirty;
2152
2153 sub db_sync() {
2154 db_save if $dirty;
2155 undef $dirty;
2156 }
2157
2158 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2159 db_sync;
2160 }); 3351 };
3352 cf::cede_to_tick;
2161 3353
2162 sub db_dirty() {
2163 $dirty = 1;
2164 $idle->start;
2165 } 3354 {
3355 my $faces = $facedata->{faceinfo};
2166 3356
2167 sub db_get($;$) { 3357 while (my ($face, $info) = each %$faces) {
2168 @_ >= 2 3358 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2169 ? $DB->{$_[0]}{$_[1]}
2170 : ($DB->{$_[0]} ||= { })
2171 }
2172 3359
2173 sub db_put($$;$) { 3360 cf::face::set_visibility $idx, $info->{visibility};
2174 if (@_ >= 3) { 3361 cf::face::set_magicmap $idx, $info->{magicmap};
2175 $DB->{$_[0]}{$_[1]} = $_[2]; 3362 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2176 } else { 3363 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2177 $DB->{$_[0]} = $_[1];
2178 }
2179 db_dirty;
2180 }
2181 3364
2182 cf::global->attach ( 3365 cf::cede_to_tick;
2183 prio => 10000,
2184 on_cleanup => sub {
2185 db_sync;
2186 }, 3366 }
2187 );
2188}
2189 3367
2190############################################################################# 3368 while (my ($face, $info) = each %$faces) {
2191# the server's main() 3369 next unless $info->{smooth};
2192 3370
2193sub 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
2194 open my $fh, "<:utf8", cf::confdir . "/config" 3499 open my $fh, "<:utf8", "$CONFDIR/config"
2195 or return; 3500 or return;
2196 3501
2197 local $/; 3502 local $/;
2198 *CFG = YAML::Syck::Load <$fh>; 3503 *CFG = YAML::XS::Load scalar <$fh>;
2199 3504
2200 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3505 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2201 3506
2202 $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};
2203 $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};
2207 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3512 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2208 and die "WARNING: m(un)lockall failed: $!\n"; 3513 and die "WARNING: m(un)lockall failed: $!\n";
2209 }; 3514 };
2210 warn $@ if $@; 3515 warn $@ if $@;
2211 } 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;
2212} 3547}
2213 3548
2214sub 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
2215 # we must not ever block the main coroutine 3559 # we must not ever block the main coroutine
2216 local $Coro::idle = sub { 3560 local $Coro::idle = sub {
2217 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#
2218 async { Event::one_event }; 3562 (async {
3563 $Coro::current->{desc} = "IDLE BUG HANDLER";
3564 EV::loop EV::LOOP_ONESHOT;
3565 })->prio (Coro::PRIO_MAX);
2219 }; 3566 };
2220 3567
2221 cfg_load; 3568 evthread_start IO::AIO::poll_fileno;
2222 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
2223 load_extensions; 3591 load_extensions;
2224 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;
2225} 3606}
2226 3607
2227############################################################################# 3608#############################################################################
2228# initialisation and cleanup 3609# initialisation and cleanup
2229 3610
2230# install some emergency cleanup handlers 3611# install some emergency cleanup handlers
2231BEGIN { 3612BEGIN {
3613 our %SIGWATCHER = ();
2232 for my $signal (qw(INT HUP TERM)) { 3614 for my $signal (qw(INT HUP TERM)) {
2233 Event->signal ( 3615 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2234 data => WF_AUTOCANCEL,
2235 signal => $signal,
2236 cb => sub {
2237 cf::cleanup "SIG$signal"; 3616 cf::cleanup "SIG$signal";
2238 },
2239 ); 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
2240 } 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 };
2241} 3707}
2242 3708
2243sub emergency_save() { 3709sub emergency_save() {
2244 my $freeze_guard = cf::freeze_mainloop; 3710 my $freeze_guard = cf::freeze_mainloop;
2245 3711
2246 warn "enter emergency perl save\n"; 3712 warn "emergency_perl_save: enter\n";
2247 3713
2248 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
2249 # use a peculiar iteration method to avoid tripping on perl 3720 # use a peculiar iteration method to avoid tripping on perl
2250 # refcount bugs in for. also avoids problems with players 3721 # refcount bugs in for. also avoids problems with players
2251 # and maps saved/destroyed asynchronously. 3722 # and maps saved/destroyed asynchronously.
2252 warn "begin emergency player save\n"; 3723 warn "emergency_perl_save: begin player save\n";
2253 for my $login (keys %cf::PLAYER) { 3724 for my $login (keys %cf::PLAYER) {
2254 my $pl = $cf::PLAYER{$login} or next; 3725 my $pl = $cf::PLAYER{$login} or next;
2255 $pl->valid or next; 3726 $pl->valid or next;
3727 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2256 $pl->save; 3728 $pl->save;
2257 } 3729 }
2258 warn "end emergency player save\n"; 3730 warn "emergency_perl_save: end player save\n";
2259 3731
2260 warn "begin emergency map save\n"; 3732 warn "emergency_perl_save: begin map save\n";
2261 for my $path (keys %cf::MAP) { 3733 for my $path (keys %cf::MAP) {
2262 my $map = $cf::MAP{$path} or next; 3734 my $map = $cf::MAP{$path} or next;
2263 $map->valid or next; 3735 $map->valid or next;
2264 $map->save; 3736 $map->save;
2265 } 3737 }
2266 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";
2267 }; 3747 };
2268 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
2269 warn "leave emergency perl save\n"; 3754 warn "emergency_perl_save: leave\n";
2270} 3755}
2271 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}
3791
2272sub reload() { 3792sub do_reload_perl() {
2273 # can/must only be called in main 3793 # can/must only be called in main
2274 if ($Coro::current != $Coro::main) { 3794 if ($Coro::current != $Coro::main) {
2275 warn "can only reload from main coroutine\n"; 3795 warn "can only reload from main coroutine";
2276 return; 3796 return;
2277 } 3797 }
2278 3798
3799 return if $RELOAD++;
3800
3801 my $t1 = AE::time;
3802
3803 while ($RELOAD) {
2279 warn "reloading..."; 3804 warn "reloading...";
2280 3805
2281 warn "freezing server"; 3806 warn "entering sync_job";
2282 my $guard = freeze_mainloop; 3807
3808 cf::sync_job {
3809 cf::write_runtime_sync; # external watchdog should not bark
2283 cf::emergency_save; 3810 cf::emergency_save;
3811 cf::write_runtime_sync; # external watchdog should not bark
2284 3812
2285 warn "sync database to disk"; 3813 warn "syncing database to disk";
2286 cf::db_sync; 3814 BDB::db_env_txn_checkpoint $DB_ENV;
2287 IO::AIO::flush;
2288 3815
2289 eval {
2290 # if anything goes wrong in here, we should simply crash as we already saved 3816 # if anything goes wrong in here, we should simply crash as we already saved
2291 3817
2292 warn "cancel all watchers"; 3818 warn "flushing outstanding aio requests";
2293 for (Event::all_watchers) { 3819 while (IO::AIO::nreqs || BDB::nreqs) {
2294 $_->cancel if $_->data & WF_AUTOCANCEL; 3820 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2295 }
2296
2297 warn "cancel all extension coros";
2298 $_->cancel for values %EXT_CORO;
2299 %EXT_CORO = ();
2300
2301 warn "remove commands";
2302 %COMMAND = ();
2303
2304 warn "remove ext commands";
2305 %EXTCMD = ();
2306
2307 warn "unload/nuke all extensions";
2308 for my $pkg (@EXTS) {
2309 warn "... unloading $pkg";
2310
2311 if (my $cb = $pkg->can ("unload")) {
2312 eval {
2313 $cb->($pkg);
2314 1
2315 } or warn "$pkg unloaded, but with errors: $@";
2316 } 3821 }
2317 3822
3823 warn "cancelling all extension coros";
3824 $_->cancel for values %EXT_CORO;
3825 %EXT_CORO = ();
3826
3827 warn "removing commands";
3828 %COMMAND = ();
3829
3830 warn "removing ext/exti commands";
3831 %EXTCMD = ();
3832 %EXTICMD = ();
3833
3834 warn "unloading/nuking all extensions";
3835 for my $pkg (@EXTS) {
2318 warn "... nuking $pkg"; 3836 warn "... unloading $pkg";
2319 Symbol::delete_package $pkg;
2320 }
2321 3837
2322 warn "unload all perl modules loaded from $LIBDIR";
2323 while (my ($k, $v) = each %INC) {
2324 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2325
2326 warn "removing <$k>";
2327 delete $INC{$k};
2328
2329 $k =~ s/\.pm$//;
2330 $k =~ s/\//::/g;
2331
2332 if (my $cb = $k->can ("unload_module")) { 3838 if (my $cb = $pkg->can ("unload")) {
3839 eval {
2333 $cb->(); 3840 $cb->($pkg);
3841 1
3842 } or warn "$pkg unloaded, but with errors: $@";
3843 }
3844
3845 warn "... clearing $pkg";
3846 clear_package $pkg;
2334 } 3847 }
2335 3848
2336 Symbol::delete_package $k; 3849 warn "unloading all perl modules loaded from $LIBDIR";
3850 while (my ($k, $v) = each %INC) {
3851 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3852
3853 warn "... unloading $k";
3854 delete $INC{$k};
3855
3856 $k =~ s/\.pm$//;
3857 $k =~ s/\//::/g;
3858
3859 if (my $cb = $k->can ("unload_module")) {
3860 $cb->();
3861 }
3862
3863 clear_package $k;
2337 } 3864 }
2338 3865
2339 warn "get rid of safe::, as good as possible"; 3866 warn "getting rid of safe::, as good as possible";
2340 Symbol::delete_package "safe::$_" 3867 clear_package "safe::$_"
2341 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3868 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2342 3869
2343 warn "unload cf.pm \"a bit\""; 3870 warn "unloading cf.pm \"a bit\"";
2344 delete $INC{"cf.pm"}; 3871 delete $INC{"cf.pm"};
3872 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2345 3873
2346 # don't, removes xs symbols, too, 3874 # don't, removes xs symbols, too,
2347 # and global variables created in xs 3875 # and global variables created in xs
2348 #Symbol::delete_package __PACKAGE__; 3876 #clear_package __PACKAGE__;
2349 3877
3878 warn "unload completed, starting to reload now";
3879
2350 warn "reloading cf.pm"; 3880 warn "reloading cf.pm";
2351 require cf; 3881 require cf;
2352 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3882 cf::_connect_to_perl_1;
2353 3883
2354 warn "load config and database again"; 3884 warn "loading config and database again";
2355 cf::cfg_load; 3885 cf::reload_config;
2356 cf::db_load;
2357 3886
2358 warn "load extensions"; 3887 warn "loading extensions";
2359 cf::load_extensions; 3888 cf::load_extensions;
2360 3889
3890 if ($REATTACH_ON_RELOAD) {
2361 warn "reattach attachments to objects/players"; 3891 warn "reattaching attachments to objects/players";
2362 _global_reattach; 3892 _global_reattach; # objects, sockets
2363 warn "reattach attachments to maps"; 3893 warn "reattaching attachments to maps";
2364 reattach $_ for values %MAP; 3894 reattach $_ for values %MAP;
3895 warn "reattaching attachments to players";
3896 reattach $_ for values %PLAYER;
3897 }
3898
3899 warn "running post_init jobs";
3900 (pop @POST_INIT)->(1) while @POST_INIT;
3901
3902 warn "leaving sync_job";
3903
3904 1
3905 } or do {
3906 warn $@;
3907 cf::cleanup "error while reloading, exiting.";
3908 };
3909
3910 warn "reloaded";
3911 --$RELOAD;
3912 }
3913
3914 $t1 = AE::time - $t1;
3915 warn "reload completed in ${t1}s\n";
3916};
3917
3918our $RELOAD_WATCHER; # used only during reload
3919
3920sub reload_perl() {
3921 # doing reload synchronously and two reloads happen back-to-back,
3922 # coro crashes during coro_state_free->destroy here.
3923
3924 $RELOAD_WATCHER ||= cf::async {
3925 Coro::AIO::aio_wait cache_extensions;
3926
3927 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
3928 do_reload_perl;
3929 undef $RELOAD_WATCHER;
3930 };
2365 }; 3931 };
2366 3932}
2367 if ($@) {
2368 warn $@;
2369 warn "error while reloading, exiting.";
2370 exit 1;
2371 }
2372
2373 warn "reloaded";
2374};
2375 3933
2376register_command "reload" => sub { 3934register_command "reload" => sub {
2377 my ($who, $arg) = @_; 3935 my ($who, $arg) = @_;
2378 3936
2379 if ($who->flag (FLAG_WIZ)) { 3937 if ($who->flag (FLAG_WIZ)) {
2380 $who->message ("start of reload.");
2381 reload;
2382 $who->message ("end of reload."); 3938 $who->message ("reloading server.");
3939 async {
3940 $Coro::current->{desc} = "perl_reload";
3941 reload_perl;
3942 };
2383 } 3943 }
2384}; 3944};
2385 3945
2386unshift @INC, $LIBDIR; 3946unshift @INC, $LIBDIR;
2387 3947
2388$TICK_WATCHER = Event->timer ( 3948my $bug_warning = 0;
2389 reentrant => 0,
2390 prio => 0,
2391 at => $NEXT_TICK || $TICK,
2392 data => WF_AUTOCANCEL,
2393 cb => sub {
2394 $NOW = Event::time;
2395 3949
3950our @WAIT_FOR_TICK;
3951our @WAIT_FOR_TICK_BEGIN;
3952
3953sub wait_for_tick {
3954 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3955
3956 my $signal = new Coro::Signal;
3957 push @WAIT_FOR_TICK, $signal;
3958 $signal->wait;
3959}
3960
3961sub wait_for_tick_begin {
3962 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3963
3964 my $signal = new Coro::Signal;
3965 push @WAIT_FOR_TICK_BEGIN, $signal;
3966 $signal->wait;
3967}
3968
3969sub tick {
3970 if ($Coro::current != $Coro::main) {
3971 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3972 unless ++$bug_warning > 10;
3973 return;
3974 }
3975
2396 cf::server_tick; # one server iteration 3976 cf::server_tick; # one server iteration
2397 $RUNTIME += $TICK;
2398 $NEXT_TICK += $TICK;
2399 3977
2400 $WAIT_FOR_TICK->broadcast; 3978 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2401 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2402 3979
2403 # if we are delayed by four ticks or more, skip them all 3980 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2404 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3981 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2405 3982 Coro::async_pool {
2406 $TICK_WATCHER->at ($NEXT_TICK); 3983 $Coro::current->{desc} = "runtime saver";
2407 $TICK_WATCHER->start;
2408 },
2409);
2410
2411IO::AIO::max_poll_time $TICK * 0.2;
2412
2413$AIO_POLL_WATCHER = Event->io (
2414 fd => IO::AIO::poll_fileno,
2415 poll => 'r',
2416 prio => 5,
2417 data => WF_AUTOCANCEL,
2418 cb => \&IO::AIO::poll_cb,
2419);
2420
2421$WRITE_RUNTIME_WATCHER = Event->timer (
2422 data => WF_AUTOCANCEL,
2423 after => 0,
2424 interval => 10,
2425 cb => sub {
2426 (Coro::unblock_sub {
2427 write_runtime 3984 write_runtime_sync
2428 or warn "ERROR: unable to write runtime file: $!"; 3985 or warn "ERROR: unable to write runtime file: $!";
2429 })->(); 3986 };
2430 }, 3987 }
2431); 3988
3989 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3990 $sig->send;
3991 }
3992 while (my $sig = shift @WAIT_FOR_TICK) {
3993 $sig->send;
3994 }
3995
3996 $LOAD = ($NOW - $TICK_START) / $TICK;
3997 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3998
3999 if (0) {
4000 if ($NEXT_TICK) {
4001 my $jitter = $TICK_START - $NEXT_TICK;
4002 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4003 warn "jitter $JITTER\n";#d#
4004 }
4005 }
4006}
4007
4008{
4009 # configure BDB
4010
4011 BDB::min_parallel 16;
4012 BDB::max_poll_reqs $TICK * 0.1;
4013 $AnyEvent::BDB::WATCHER->priority (1);
4014
4015 unless ($DB_ENV) {
4016 $DB_ENV = BDB::db_env_create;
4017 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4018 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4019 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4020 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4021 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4022
4023 cf::sync_job {
4024 eval {
4025 BDB::db_env_open
4026 $DB_ENV,
4027 $BDBDIR,
4028 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4029 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4030 0666;
4031
4032 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
4033 };
4034
4035 cf::cleanup "db_env_open(db): $@" if $@;
4036 };
4037 }
4038
4039 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4040 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4041 };
4042 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4043 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4044 };
4045 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4046 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4047 };
4048}
4049
4050{
4051 # configure IO::AIO
4052
4053 IO::AIO::min_parallel 8;
4054 IO::AIO::max_poll_time $TICK * 0.1;
4055 undef $AnyEvent::AIO::WATCHER;
4056}
4057
4058my $_log_backtrace;
4059
4060sub _log_backtrace {
4061 my ($msg, @addr) = @_;
4062
4063 $msg =~ s/\n//;
4064
4065 # limit the # of concurrent backtraces
4066 if ($_log_backtrace < 2) {
4067 ++$_log_backtrace;
4068 my $perl_bt = Carp::longmess $msg;
4069 async {
4070 $Coro::current->{desc} = "abt $msg";
4071
4072 my @bt = fork_call {
4073 @addr = map { sprintf "%x", $_ } @addr;
4074 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4075 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4076 or die "addr2line: $!";
4077
4078 my @funcs;
4079 my @res = <$fh>;
4080 chomp for @res;
4081 while (@res) {
4082 my ($func, $line) = splice @res, 0, 2, ();
4083 push @funcs, "[$func] $line";
4084 }
4085
4086 @funcs
4087 };
4088
4089 LOG llevInfo, "[ABT] $perl_bt\n";
4090 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4091 LOG llevInfo, "[ABT] $_\n" for @bt;
4092 --$_log_backtrace;
4093 };
4094 } else {
4095 LOG llevInfo, "[ABT] $msg\n";
4096 LOG llevInfo, "[ABT] [suppressed]\n";
4097 }
4098}
4099
4100# load additional modules
4101require "cf/$_.pm" for @EXTRA_MODULES;
4102cf::_connect_to_perl_2;
2432 4103
2433END { cf::emergency_save } 4104END { cf::emergency_save }
2434 4105
24351 41061
2436 4107

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines