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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.624 by root, Sat Nov 17 23:40:02 2018 UTC

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

Diff Legend

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