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

Diff Legend

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