ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.594 by root, Fri Nov 9 02:50:50 2012 UTC

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

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines