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.165 by root, Fri Jan 12 22:09:22 2007 UTC vs.
Revision 1.416 by root, Fri Apr 11 13:59:06 2008 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
2		23
3	use utf8;	24	use utf8;
4	use strict;	25	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV 3.2;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
12		35
13	use Coro 3.3 ();	36	use Coro 4.50 ();
		37	use Coro::State;
		38	use Coro::Handle;
14	use Coro::Event;	39	use Coro::EV;
15	use Coro::Timer;	40	use Coro::Timer;
16	use Coro::Signal;	41	use Coro::Signal;
17	use Coro::Semaphore;	42	use Coro::Semaphore;
18	use Coro::AIO;	43	use Coro::AIO;
		44	use Coro::BDB;
		45	use Coro::Storable;
		46	use Coro::Util ();
19		47
		48	use JSON::XS 2.01 ();
		49	use BDB ();
20	use Data::Dumper;	50	use Data::Dumper;
21	use Digest::MD5;	51	use Digest::MD5;
22	use Fcntl;	52	use Fcntl;
		53	use YAML ();
23	use IO::AIO 2.32 ();	54	use IO::AIO 2.51 ();
24	use YAML::Syck ();
25	use Time::HiRes;	55	use Time::HiRes;
		56	use Compress::LZF;
		57	use Digest::MD5 ();
26		58
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	59	# configure various modules to our taste
		60	#
		61	$Storable::canonical = 1; # reduce rsync transfers
		62	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		63	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		64
		65	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
28		66
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	67	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		68
36	our %COMMAND = ();	69	our %COMMAND = ();
37	our %COMMAND_TIME = ();	70	our %COMMAND_TIME = ();
38		71
39	our @EXTS = (); # list of extension package names	72	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	73	our %EXTCMD = ();
		74	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	75	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	76	our %EXT_MAP = (); # pluggable maps
43		77
		78	our $RELOAD; # number of reloads so far
44	our @EVENT;	79	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		80
47	our $TICK = MAX_TIME * 1e-6;	81	our $CONFDIR = confdir;
		82	our $DATADIR = datadir;
		83	our $LIBDIR = "$DATADIR/ext";
		84	our $PODDIR = "$DATADIR/pod";
		85	our $MAPDIR = "$DATADIR/" . mapdir;
		86	our $LOCALDIR = localdir;
		87	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		88	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		89	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		90	our $RANDOMDIR = "$LOCALDIR/random";
		91	our $BDBDIR = "$LOCALDIR/db";
		92	our %RESOURCE;
		93
		94	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	95	our $AIO_POLL_WATCHER;
		96	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
49	our $NEXT_TICK;	97	our $NEXT_TICK;
50	our $NOW;	98	our $USE_FSYNC = 1; # use fsync to write maps - default off
		99
		100	our $BDB_POLL_WATCHER;
		101	our $BDB_DEADLOCK_WATCHER;
		102	our $BDB_CHECKPOINT_WATCHER;
		103	our $BDB_TRICKLE_WATCHER;
		104	our $DB_ENV;
51		105
52	our %CFG;	106	our %CFG;
53		107
54	our $UPTIME; $UPTIME ||= time;	108	our $UPTIME; $UPTIME ||= time;
55	our $RUNTIME;	109	our $RUNTIME;
		110	our $NOW;
56		111
57	our %PLAYER; # all users	112	our (%PLAYER, %PLAYER_LOADING); # all users
58	our %MAP; # all maps	113	our (%MAP, %MAP_LOADING ); # all maps
59	our $LINK_MAP; # the special {link} map	114	our $LINK_MAP; # the special {link} map, which is always available
60	our $RANDOM_MAPS = cf::localdir . "/random";
61		115
62	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	116	# used to convert map paths into valid unix filenames by replacing / by ∕
63	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;	117	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		118
		119	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		120	our $LOADAVG; # same thing, but with alpha-smoothing
		121	our $JITTER; # average jitter
		122	our $TICK_START; # for load detecting purposes
64		123
65	binmode STDOUT;	124	binmode STDOUT;
66	binmode STDERR;	125	binmode STDERR;
67		126
68	# read virtual server time, if available	127	# read virtual server time, if available
69	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	128	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
70	open my $fh, "<", cf::localdir . "/runtime"	129	open my $fh, "<", "$LOCALDIR/runtime"
71	or die "unable to read runtime file: $!";	130	or die "unable to read runtime file: $!";
72	$RUNTIME = <$fh> + 0.;	131	$RUNTIME = <$fh> + 0.;
73	}	132	}
74		133
75	mkdir cf::localdir;	134	mkdir $_
76	mkdir cf::localdir . "/" . cf::playerdir;	135	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
77	mkdir cf::localdir . "/" . cf::tmpdir;
78	mkdir cf::localdir . "/" . cf::uniquedir;
79	mkdir $RANDOM_MAPS;
80		136
81	# a special map that is always available
82	our $LINK_MAP;
83	our $EMERGENCY_POSITION;	137	our $EMERGENCY_POSITION;
		138
		139	sub cf::map::normalise;
84		140
85	#############################################################################	141	#############################################################################
86		142
87	=head2 GLOBAL VARIABLES	143	=head2 GLOBAL VARIABLES
88		144
…		…
95	=item $cf::RUNTIME	151	=item $cf::RUNTIME
96		152
97	The time this server has run, starts at 0 and is increased by $cf::TICK on	153	The time this server has run, starts at 0 and is increased by $cf::TICK on
98	every server tick.	154	every server tick.
99		155
100	=item $cf::LIBDIR	156	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		157	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		158	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
101		159
102	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
103	be found. It will be added to C<@INC> automatically.	161	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		162	unique-items directory, player file directory, random maps directory and
		163	database environment.
104		164
105	=item $cf::NOW	165	=item $cf::NOW
106		166
107	The time of the last (current) server tick.	167	The time of the last (current) server tick.
108		168
109	=item $cf::TICK	169	=item $cf::TICK
110		170
111	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
112		172
		173	=item $cf::LOADAVG
		174
		175	The current CPU load on the server (alpha-smoothed), as a value between 0
		176	(none) and 1 (overloaded), indicating how much time is spent on processing
		177	objects per tick. Healthy values are < 0.5.
		178
		179	=item $cf::LOAD
		180
		181	The raw value load value from the last tick.
		182
113	=item %cf::CFG	183	=item %cf::CFG
114		184
115	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
116	from wherever your confdir points to.	186	from wherever your confdir points to.
117		187
118	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	188	=item cf::wait_for_tick, cf::wait_for_tick_begin
119		189
120	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	190	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
121	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	191	returns directly I<after> the tick processing (and consequently, can only wake one process
122	processing has been done. Call C<< ->wait >> on them to maximise the	192	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
123	window of cpu time available, or simply to synchronise to the server tick.	193
		194	=item @cf::INVOKE_RESULTS
		195
		196	This array contains the results of the last C<invoke ()> call. When
		197	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		198	that call.
124		199
125	=back	200	=back
126		201
127	=cut	202	=cut
128		203
129	BEGIN {	204	BEGIN {
130	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
131	my $msg = join "", @_;	206	my $msg = join "", @_;
132	utf8::encode $msg;
133		207
134	$msg .= "\n"	208	$msg .= "\n"
135	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
136		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
137	LOG llevError, $msg;	213	LOG llevError, $msg;
138	};	214	};
139	}	215	}
		216
		217	$Coro::State::DIEHOOK = sub {
		218	return unless $^S eq 0; # "eq", not "=="
		219
		220	if ($Coro::current == $Coro::main) {#d#
		221	warn "DIEHOOK called in main context, Coro bug?\n";#d#
		222	return;#d#
		223	}#d#
		224
		225	# kill coroutine otherwise
		226	warn Carp::longmess $_[0];
		227	Coro::terminate
		228	};
		229
		230	$SIG{__DIE__} = sub { }; #d#?
140		231
141	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
142	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
143	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
144	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
145	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	236	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		237	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
146	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	238	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
147		239
148	# we bless all objects into (empty) derived classes to force a method lookup	240	# we bless all objects into (empty) derived classes to force a method lookup
149	# within the Safe compartment.	241	# within the Safe compartment.
150	for my $pkg (qw(	242	for my $pkg (qw(
151	cf::global cf::attachable	243	cf::global cf::attachable
…		…
156	)) {	248	)) {
157	no strict 'refs';	249	no strict 'refs';
158	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
159	}	251	}
160		252
161	$Event::DIED = sub {	253	$EV::DIED = sub {
162	warn "error in event callback: @_";	254	warn "error in event callback: @_";
163	};	255	};
		256
		257	#############################################################################
164		258
165	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
166		260
167	=over 4	261	=over 4
168		262
…		…
187	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	281	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
188	$d	282	$d
189	} || "[unable to dump $_[0]: '$@']";	283	} || "[unable to dump $_[0]: '$@']";
190	}	284	}
191		285
192	use JSON::Syck (); # TODO# replace by JSON::PC once working
193
194	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
195		287
196	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
197		289
198	=cut
199
200	sub from_json($) {
201	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
202	JSON::Syck::Load $_[0]
203	}
204
205	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
206		291
207	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
208		293
209	=cut	294	=cut
210		295
211	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
212	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	297
213	JSON::Syck::Dump $_[0]	298	sub encode_json($) { $json_coder->encode ($_[0]) }
214	}	299	sub decode_json($) { $json_coder->decode ($_[0]) }
215		300
216	=item cf::lock_wait $string	301	=item cf::lock_wait $string
217		302
218	Wait until the given lock is available. See cf::lock_acquire.	303	Wait until the given lock is available. See cf::lock_acquire.
219		304
…		…
222	Wait until the given lock is available and then acquires it and returns	307	Wait until the given lock is available and then acquires it and returns
223	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	308	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
224	for example when the coroutine gets canceled), the lock is automatically	309	for example when the coroutine gets canceled), the lock is automatically
225	returned.	310	returned.
226		311
		312	Locks are *not* recursive, locking from the same coro twice results in a
		313	deadlocked coro.
		314
227	Lock names should begin with a unique identifier (for example, cf::map::find	315	Lock names should begin with a unique identifier (for example, cf::map::find
228	uses map_find and cf::map::load uses map_load).	316	uses map_find and cf::map::load uses map_load).
229		317
		318	=item $locked = cf::lock_active $string
		319
		320	Return true if the lock is currently active, i.e. somebody has locked it.
		321
230	=cut	322	=cut
231		323
232	our %LOCK;	324	our %LOCK;
		325	our %LOCKER;#d#
233		326
234	sub lock_wait($) {	327	sub lock_wait($) {
235	my ($key) = @_;	328	my ($key) = @_;
		329
		330	if ($LOCKER{$key} == $Coro::current) {#d#
		331	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		332	return;#d#
		333	}#d#
236		334
237	# wait for lock, if any	335	# wait for lock, if any
238	while ($LOCK{$key}) {	336	while ($LOCK{$key}) {
239	push @{ $LOCK{$key} }, $Coro::current;	337	push @{ $LOCK{$key} }, $Coro::current;
240	Coro::schedule;	338	Coro::schedule;
…		…
246		344
247	# wait, to be sure we are not locked	345	# wait, to be sure we are not locked
248	lock_wait $key;	346	lock_wait $key;
249		347
250	$LOCK{$key} = [];	348	$LOCK{$key} = [];
		349	$LOCKER{$key} = $Coro::current;#d#
251		350
252	Coro::guard {	351	Coro::guard {
		352	delete $LOCKER{$key};#d#
253	# wake up all waiters, to be on the safe side	353	# wake up all waiters, to be on the safe side
254	$_->ready for @{ delete $LOCK{$key} };	354	$_->ready for @{ delete $LOCK{$key} };
255	}	355	}
256	}	356	}
257		357
		358	sub lock_active($) {
		359	my ($key) = @_;
		360
		361	! ! $LOCK{$key}
		362	}
		363
258	sub freeze_mainloop {	364	sub freeze_mainloop {
259	return unless $TICK_WATCHER->is_active;	365	tick_inhibit_inc;
260		366
261	my $guard = Coro::guard { $TICK_WATCHER->start };	367	Coro::guard \&tick_inhibit_dec;
262	$TICK_WATCHER->stop;	368	}
263	$guard	369
		370	=item cf::periodic $interval, $cb
		371
		372	Like EV::periodic, but randomly selects a starting point so that the actions
		373	get spread over timer.
		374
		375	=cut
		376
		377	sub periodic($$) {
		378	my ($interval, $cb) = @_;
		379
		380	my $start = rand List::Util::min 180, $interval;
		381
		382	EV::periodic $start, $interval, 0, $cb
		383	}
		384
		385	=item cf::get_slot $time[, $priority[, $name]]
		386
		387	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		388	This call blocks and returns only when you have at least C<$time> seconds
		389	of cpu time till the next tick. The slot is only valid till the next cede.
		390
		391	The optional C<$name> can be used to identify the job to run. It might be
		392	used for statistical purposes and should identify the same time-class.
		393
		394	Useful for short background jobs.
		395
		396	=cut
		397
		398	our @SLOT_QUEUE;
		399	our $SLOT_QUEUE;
		400
		401	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		402	$SLOT_QUEUE = Coro::async {
		403	$Coro::current->desc ("timeslot manager");
		404
		405	my $signal = new Coro::Signal;
		406
		407	while () {
		408	next_job:
		409	my $avail = cf::till_tick;
		410	if ($avail > 0.01) {
		411	for (0 .. $#SLOT_QUEUE) {
		412	if ($SLOT_QUEUE[$_][0] < $avail) {
		413	my $job = splice @SLOT_QUEUE, $_, 1, ();
		414	$job->[2]->send;
		415	Coro::cede;
		416	goto next_job;
		417	}
		418	}
		419	}
		420
		421	if (@SLOT_QUEUE) {
		422	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		423	push @cf::WAIT_FOR_TICK, $signal;
		424	$signal->wait;
		425	} else {
		426	Coro::schedule;
		427	}
		428	}
		429	};
		430
		431	sub get_slot($;$$) {
		432	my ($time, $pri, $name) = @_;
		433
		434	$time = $TICK * .6 if $time > $TICK * .6;
		435	my $sig = new Coro::Signal;
		436
		437	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		438	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		439	$SLOT_QUEUE->ready;
		440	$sig->wait;
264	}	441	}
265		442
266	=item cf::async { BLOCK }	443	=item cf::async { BLOCK }
267		444
268	Currently the same as Coro::async_pool, meaning you cannot use	445	Currently the same as Coro::async_pool, meaning you cannot use
…		…
273		450
274	BEGIN { *async = \&Coro::async_pool }	451	BEGIN { *async = \&Coro::async_pool }
275		452
276	=item cf::sync_job { BLOCK }	453	=item cf::sync_job { BLOCK }
277		454
278	The design of crossfire+ requires that the main coro ($Coro::main) is	455	The design of Deliantra requires that the main coroutine ($Coro::main)
279	always able to handle events or runnable, as crossfire+ is only partly	456	is always able to handle events or runnable, as Deliantra is only
280	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	457	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		458	acceptable.
281		459
282	If it must be done, put the blocking parts into C<sync_job>. This will run	460	If it must be done, put the blocking parts into C<sync_job>. This will run
283	the given BLOCK in another coroutine while waiting for the result. The	461	the given BLOCK in another coroutine while waiting for the result. The
284	server will be frozen during this time, so the block should either finish	462	server will be frozen during this time, so the block should either finish
285	fast or be very important.	463	fast or be very important.
…		…
288		466
289	sub sync_job(&) {	467	sub sync_job(&) {
290	my ($job) = @_;	468	my ($job) = @_;
291		469
292	if ($Coro::current == $Coro::main) {	470	if ($Coro::current == $Coro::main) {
		471	my $time = EV::time;
		472
293	# this is the main coro, too bad, we have to block	473	# this is the main coro, too bad, we have to block
294	# till the operation succeeds, freezing the server :/	474	# till the operation succeeds, freezing the server :/
295		475
296	# TODO: use suspend/resume instead	476	LOG llevError, Carp::longmess "sync job";#d#
297	# (but this is cancel-safe)	477
298	my $freeze_guard = freeze_mainloop;	478	my $freeze_guard = freeze_mainloop;
299		479
300	my $busy = 1;	480	my $busy = 1;
301	my @res;	481	my @res;
302		482
303	(async {	483	(async {
		484	$Coro::current->desc ("sync job coro");
304	@res = eval { $job->() };	485	@res = eval { $job->() };
305	warn $@ if $@;	486	warn $@ if $@;
306	undef $busy;	487	undef $busy;
307	})->prio (Coro::PRIO_MAX);	488	})->prio (Coro::PRIO_MAX);
308		489
309	while ($busy) {	490	while ($busy) {
310	Coro::cede or Event::one_event;	491	if (Coro::nready) {
		492	Coro::cede_notself;
		493	} else {
		494	EV::loop EV::LOOP_ONESHOT;
311	}	495	}
		496	}
		497
		498	my $time = EV::time - $time;
		499
		500	$TICK_START += $time; # do not account sync jobs to server load
312		501
313	wantarray ? @res : $res[0]	502	wantarray ? @res : $res[0]
314	} else {	503	} else {
315	# we are in another coroutine, how wonderful, everything just works	504	# we are in another coroutine, how wonderful, everything just works
316		505
…		…
336	$EXT_CORO{$coro+0} = $coro;	525	$EXT_CORO{$coro+0} = $coro;
337		526
338	$coro	527	$coro
339	}	528	}
340		529
341	sub write_runtime {	530	=item fork_call { }, $args
342	my $runtime = cf::localdir . "/runtime";
343		531
344	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	532	Executes the given code block with the given arguments in a seperate
345	or return;	533	process, returning the results. Everything must be serialisable with
		534	Coro::Storable. May, of course, block. Note that the executed sub may
		535	never block itself or use any form of event handling.
346		536
347	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	537	=cut
348	(aio_write $fh, 0, (length $value), $value, 0) <= 0
349	and return;
350		538
351	aio_fsync $fh	539	sub fork_call(&@) {
352	and return;	540	my ($cb, @args) = @_;
353		541
354	close $fh	542	# we seemingly have to make a local copy of the whole thing,
355	or return;	543	# otherwise perl prematurely frees the stuff :/
		544	# TODO: investigate and fix (likely this will be rather laborious)
356		545
357	aio_rename "$runtime~", $runtime	546	my @res = Coro::Util::fork_eval {
358	and return;	547	reset_signals;
		548	&$cb
		549	}, @args;
359		550
		551	wantarray ? @res : $res[-1]
		552	}
		553
		554	=item $coin = coin_from_name $name
		555
		556	=cut
		557
		558	our %coin_alias = (
		559	"silver" => "silvercoin",
		560	"silvercoin" => "silvercoin",
		561	"silvercoins" => "silvercoin",
		562	"gold" => "goldcoin",
		563	"goldcoin" => "goldcoin",
		564	"goldcoins" => "goldcoin",
		565	"platinum" => "platinacoin",
		566	"platinumcoin" => "platinacoin",
		567	"platinumcoins" => "platinacoin",
		568	"platina" => "platinacoin",
		569	"platinacoin" => "platinacoin",
		570	"platinacoins" => "platinacoin",
		571	"royalty" => "royalty",
		572	"royalties" => "royalty",
		573	);
		574
		575	sub coin_from_name($) {
		576	$coin_alias{$_[0]}
		577	? cf::arch::find $coin_alias{$_[0]}
		578	: undef
		579	}
		580
		581	=item $value = cf::db_get $family => $key
		582
		583	Returns a single value from the environment database.
		584
		585	=item cf::db_put $family => $key => $value
		586
		587	Stores the given C<$value> in the family. It can currently store binary
		588	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		589
		590	=item $db = cf::db_table "name"
		591
		592	Create and/or open a new database table. The string must not be "db" and must be unique
		593	within each server.
		594
		595	=cut
		596
		597	sub db_table($) {
		598	my ($name) = @_;
		599	my $db = BDB::db_create $DB_ENV;
		600
		601	eval {
		602	$db->set_flags (BDB::CHKSUM);
		603
		604	utf8::encode $name;
		605	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		606	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		607	cf::cleanup "db_open(db): $!" if $!;
		608	};
		609	cf::cleanup "db_open(db): $@" if $@;
		610
		611	$db
		612	}
		613
		614	our $DB;
		615
		616	sub db_init {
		617	cf::sync_job {
		618	$DB ||= db_table "db";
		619	};
		620	}
		621
		622	sub db_get($$) {
		623	my $key = "$_[0]/$_[1]";
		624
		625	cf::sync_job {
		626	BDB::db_get $DB, undef, $key, my $data;
		627
		628	$! ? ()
		629	: $data
360	1	630	}
		631	}
		632
		633	sub db_put($$$) {
		634	BDB::dbreq_pri 4;
		635	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		636	}
		637
		638	=item cf::cache $id => [$paths...], $processversion => $process
		639
		640	Generic caching function that returns the value of the resource $id,
		641	caching and regenerating as required.
		642
		643	This function can block.
		644
		645	=cut
		646
		647	sub cache {
		648	my ($id, $src, $processversion, $process) = @_;
		649
		650	my $meta =
		651	join "\x00",
		652	$processversion,
		653	map {
		654	aio_stat $_
		655	and Carp::croak "$_: $!";
		656
		657	($_, (stat _)[7,9])
		658	} @$src;
		659
		660	my $dbmeta = db_get cache => "$id/meta";
		661	if ($dbmeta ne $meta) {
		662	# changed, we may need to process
		663
		664	my @data;
		665	my $md5;
		666
		667	for (0 .. $#$src) {
		668	0 <= aio_load $src->[$_], $data[$_]
		669	or Carp::croak "$src->[$_]: $!";
		670	}
		671
		672	# if processing is expensive, check
		673	# checksum first
		674	if (1) {
		675	$md5 =
		676	join "\x00",
		677	$processversion,
		678	map {
		679	cf::cede_to_tick;
		680	($src->[$_], Digest::MD5::md5_hex $data[$_])
		681	} 0.. $#$src;
		682
		683
		684	my $dbmd5 = db_get cache => "$id/md5";
		685	if ($dbmd5 eq $md5) {
		686	db_put cache => "$id/meta", $meta;
		687
		688	return db_get cache => "$id/data";
		689	}
		690	}
		691
		692	my $t1 = Time::HiRes::time;
		693	my $data = $process->(\@data);
		694	my $t2 = Time::HiRes::time;
		695
		696	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		697
		698	db_put cache => "$id/data", $data;
		699	db_put cache => "$id/md5" , $md5;
		700	db_put cache => "$id/meta", $meta;
		701
		702	return $data;
		703	}
		704
		705	db_get cache => "$id/data"
		706	}
		707
		708	=item cf::datalog type => key => value, ...
		709
		710	Log a datalog packet of the given type with the given key-value pairs.
		711
		712	=cut
		713
		714	sub datalog($@) {
		715	my ($type, %kv) = @_;
		716	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
361	}	717	}
362		718
363	=back	719	=back
364		720
365	=cut	721	=cut
366
367	#############################################################################
368
369	package cf::path;
370
371	use overload
372	'""' => \&as_string;
373
374	# used to convert map paths into valid unix filenames by repalcing / by ∕
375	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
376
377	sub register {
378	my ($pkg, $prefix) = @_;
379
380	$EXT_MAP{$prefix} = $pkg;
381	}
382
383	sub new {
384	my ($class, $path, $base) = @_;
385
386	return $path if ref $path;
387
388	my $self = {};
389
390	# {... are special paths that are not being touched
391	# ?xxx/... are special absolute paths
392	# ?random/... random maps
393	# /! non-realised random map exit
394	# /... normal maps
395	# ~/... per-player maps without a specific player (DO NOT USE)
396	# ~user/... per-player map of a specific user
397
398	$path =~ s/$PATH_SEP/\//go;
399
400	if ($path =~ /^{/) {
401	# fine as it is
402	} else {
403	if ($path =~ s{^~([^/]+)?}{}) {
404	# ~user
405	$self->{user_rel} = 1;
406
407	if (defined $1) {
408	$self->{user} = $1;
409	} elsif ($base =~ m{^~([^/]+)/}) {
410	$self->{user} = $1;
411	} else {
412	warn "cannot resolve user-relative path without user <$path,$base>\n";
413	}
414	} elsif ($path =~ s{^\?([^/]+)/}{}) {
415	# ?...
416	$self->{ext} = $1;
417	if (my $ext = $EXT_MAP{$1}) {
418	bless $self, $ext;
419	}
420	} elsif ($path =~ /^\//) {
421	# /...
422	# already absolute
423	} else {
424	# relative
425	$base =~ s{[^/]+/?$}{};
426	return $class->new ("$base/$path");
427	}
428
429	for ($path) {
430	redo if s{/\.?/}{/};
431	redo if s{/[^/]+/\.\./}{/};
432	}
433	}
434
435	$self->{path} = $path;
436
437	if ("HASH" eq ref $self) {
438	bless $self, $class;
439	} else {
440	$self->init;
441	}
442
443	for my $ext (values %EXT_MAP) {
444	if (my $subst = $ext->substitute ($self)) {
445	return $subst;
446	}
447	}
448
449	$self
450	}
451
452	sub init {
453	# nop
454	}
455
456	sub substitute {
457	()
458	}
459
460	# the name / primary key / in-game path
461	sub as_string {
462	my ($self) = @_;
463
464	$self->{user_rel} ? "~$self->{user}$self->{path}"
465	: $self->{ext} ? "?$self->{ext}/$self->{path}"
466	: $self->{path}
467	}
468
469	# the displayed name, this is a one way mapping
470	sub visible_name {
471	&as_string
472	}
473
474	# escape the /'s in the path
475	sub _escaped_path {
476	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
477
478	$path
479	}
480
481	# the original (read-only) location
482	sub load_path {
483	my ($self) = @_;
484
485	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
486	}
487
488	# the temporary/swap location
489	sub save_path {
490	my ($self) = @_;
491
492	$self->{user_rel}
493	? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
494	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
495	}
496
497	# the unique path, undef == no special unique path
498	sub uniq_path {
499	my ($self) = @_;
500
501	$self->{user_rel} || $self->{ext}
502	? undef
503	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
504	}
505
506	sub customise_for {
507	my ($self, $map, $ob) = @_;
508
509	if ($map->per_player) {
510	return cf::map::find ("~" . $ob->name . "/" . $map->{path}{path});
511	}
512
513	$map
514	}
515
516	# this is somewhat ugly, but style maps do need special treatment
517	sub is_style_map {
518	$_[0]{path} =~ m{^/styles/}
519	}
520
521	sub load_orig {
522	my ($self) = @_;
523
524	&cf::map::load_map_header ($self->load_path)
525	}
526
527	sub load_temp {
528	my ($self) = @_;
529
530	&cf::map::load_map_header ($self->save_path)
531	}
532
533	sub unlink_save {
534	my ($self) = @_;
535
536	utf8::encode (my $save = $self->save_path);
537	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
538	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
539	}
540
541	package cf;
542		722
543	#############################################################################	723	#############################################################################
544		724
545	=head2 ATTACHABLE OBJECTS	725	=head2 ATTACHABLE OBJECTS
546		726
…		…
548	attach callbacks/event handlers (a collection of which is called an "attachment")	728	attach callbacks/event handlers (a collection of which is called an "attachment")
549	to it. All such attachable objects support the following methods.	729	to it. All such attachable objects support the following methods.
550		730
551	In the following description, CLASS can be any of C<global>, C<object>	731	In the following description, CLASS can be any of C<global>, C<object>
552	C<player>, C<client> or C<map> (i.e. the attachable objects in	732	C<player>, C<client> or C<map> (i.e. the attachable objects in
553	crossfire+).	733	Deliantra).
554		734
555	=over 4	735	=over 4
556		736
557	=item $attachable->attach ($attachment, key => $value...)	737	=item $attachable->attach ($attachment, key => $value...)
558		738
…		…
672	our @CB_TYPE = (); # registry for type (cf-object class) based events	852	our @CB_TYPE = (); # registry for type (cf-object class) based events
673	our @CB_MAP = ();	853	our @CB_MAP = ();
674		854
675	my %attachment;	855	my %attachment;
676		856
		857	sub cf::attachable::thawer_merge {
		858	# simply override everything except _meta
		859	local $_[0]{_meta};
		860	%{$_[0]} = %{$_[1]};
		861	}
		862
677	sub _attach_cb($$$$) {	863	sub _attach_cb($$$$) {
678	my ($registry, $event, $prio, $cb) = @_;	864	my ($registry, $event, $prio, $cb) = @_;
679		865
680	use sort 'stable';	866	use sort 'stable';
681		867
…		…
715	$registry = $CB_TYPE[$object_type] ||= [];	901	$registry = $CB_TYPE[$object_type] ||= [];
716		902
717	} elsif ($type eq "subtype") {	903	} elsif ($type eq "subtype") {
718	defined $object_type or Carp::croak "subtype specified without type";	904	defined $object_type or Carp::croak "subtype specified without type";
719	my $object_subtype = shift @arg;	905	my $object_subtype = shift @arg;
720	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	906	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
721		907
722	} elsif ($type eq "package") {	908	} elsif ($type eq "package") {
723	my $pkg = shift @arg;	909	my $pkg = shift @arg;
724		910
725	while (my ($name, $id) = each %cb_id) {	911	while (my ($name, $id) = each %cb_id) {
…		…
754	_attach $registry, $klass, @attach;	940	_attach $registry, $klass, @attach;
755	}	941	}
756		942
757	$obj->{$name} = \%arg;	943	$obj->{$name} = \%arg;
758	} else {	944	} else {
759	warn "object uses attachment '$name' that is not available, postponing.\n";	945	warn "object uses attachment '$name' which is not available, postponing.\n";
760	}	946	}
761		947
762	$obj->{_attachment}{$name} = undef;	948	$obj->{_attachment}{$name} = undef;
763	}	949	}
764		950
…		…
766	if (ref $_[0]) {	952	if (ref $_[0]) {
767	_object_attach @_;	953	_object_attach @_;
768	} else {	954	} else {
769	_attach shift->_attach_registry, @_;	955	_attach shift->_attach_registry, @_;
770	}	956	}
		957	_recalc_want;
771	};	958	};
772		959
773	# all those should be optimised	960	# all those should be optimised
774	sub cf::attachable::detach {	961	sub cf::attachable::detach {
775	my ($obj, $name) = @_;	962	my ($obj, $name) = @_;
…		…
778	delete $obj->{_attachment}{$name};	965	delete $obj->{_attachment}{$name};
779	reattach ($obj);	966	reattach ($obj);
780	} else {	967	} else {
781	Carp::croak "cannot, currently, detach class attachments";	968	Carp::croak "cannot, currently, detach class attachments";
782	}	969	}
		970	_recalc_want;
783	};	971	};
784		972
785	sub cf::attachable::attached {	973	sub cf::attachable::attached {
786	my ($obj, $name) = @_;	974	my ($obj, $name) = @_;
787		975
…		…
802	";	990	";
803	die if $@;	991	die if $@;
804	}	992	}
805		993
806	our $override;	994	our $override;
807	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	995	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
808		996
809	sub override {	997	sub override {
810	$override = 1;	998	$override = 1;
811	@invoke_results = ();	999	@INVOKE_RESULTS = (@_);
812	}	1000	}
813		1001
814	sub do_invoke {	1002	sub do_invoke {
815	my $event = shift;	1003	my $event = shift;
816	my $callbacks = shift;	1004	my $callbacks = shift;
817		1005
818	@invoke_results = ();	1006	@INVOKE_RESULTS = ();
819		1007
820	local $override;	1008	local $override;
821		1009
822	for (@$callbacks) {	1010	for (@$callbacks) {
823	eval { &{$_->[1]} };	1011	eval { &{$_->[1]} };
…		…
832	}	1020	}
833		1021
834	0	1022	0
835	}	1023	}
836		1024
837	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1025	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
838		1026
839	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1027	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
840		1028
841	Generate an object-specific event with the given arguments.	1029	Generate an object-specific event with the given arguments.
842		1030
843	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1031	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
844	removed in future versions), and there is no public API to access override	1032	removed in future versions), and there is no public API to access override
845	results (if you must, access C<@cf::invoke_results> directly).	1033	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
846		1034
847	=back	1035	=back
848		1036
849	=cut	1037	=cut
850		1038
851	#############################################################################	1039	#############################################################################
852	# object support	1040	# object support
		1041
		1042	sub _object_equal($$);
		1043	sub _object_equal($$) {
		1044	my ($a, $b) = @_;
		1045
		1046	return 0 unless (ref $a) eq (ref $b);
		1047
		1048	if ("HASH" eq ref $a) {
		1049	my @ka = keys %$a;
		1050	my @kb = keys %$b;
		1051
		1052	return 0 if @ka != @kb;
		1053
		1054	for (0 .. $#ka) {
		1055	return 0 unless $ka[$_] eq $kb[$_];
		1056	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1057	}
		1058
		1059	} elsif ("ARRAY" eq ref $a) {
		1060
		1061	return 0 if @$a != @$b;
		1062
		1063	for (0 .. $#$a) {
		1064	return 0 unless _object_equal $a->[$_], $b->[$_];
		1065	}
		1066
		1067	} elsif ($a ne $b) {
		1068	return 0;
		1069	}
		1070
		1071	1
		1072	}
		1073
		1074	our $SLOW_MERGES;#d#
		1075	sub _can_merge {
		1076	my ($ob1, $ob2) = @_;
		1077
		1078	++$SLOW_MERGES;#d#
		1079
		1080	# we do the slow way here
		1081	return _object_equal $ob1, $ob2
		1082	}
853		1083
854	sub reattach {	1084	sub reattach {
855	# basically do the same as instantiate, without calling instantiate	1085	# basically do the same as instantiate, without calling instantiate
856	my ($obj) = @_;	1086	my ($obj) = @_;
		1087
		1088	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
857		1089
858	my $registry = $obj->registry;	1090	my $registry = $obj->registry;
859		1091
860	@$registry = ();	1092	@$registry = ();
861		1093
…		…
876	cf::attachable->attach (	1108	cf::attachable->attach (
877	prio => -1000000,	1109	prio => -1000000,
878	on_instantiate => sub {	1110	on_instantiate => sub {
879	my ($obj, $data) = @_;	1111	my ($obj, $data) = @_;
880		1112
881	$data = from_json $data;	1113	$data = decode_json $data;
882		1114
883	for (@$data) {	1115	for (@$data) {
884	my ($name, $args) = @$_;	1116	my ($name, $args) = @$_;
885		1117
886	$obj->attach ($name, %{$args || {} });	1118	$obj->attach ($name, %{$args || {} });
…		…
902	sub object_freezer_save {	1134	sub object_freezer_save {
903	my ($filename, $rdata, $objs) = @_;	1135	my ($filename, $rdata, $objs) = @_;
904		1136
905	sync_job {	1137	sync_job {
906	if (length $$rdata) {	1138	if (length $$rdata) {
		1139	utf8::decode (my $decname = $filename);
907	warn sprintf "saving %s (%d,%d)\n",	1140	warn sprintf "saving %s (%d,%d)\n",
908	$filename, length $$rdata, scalar @$objs;	1141	$decname, length $$rdata, scalar @$objs;
909		1142
910	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1143	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
911	chmod SAVE_MODE, $fh;	1144	chmod SAVE_MODE, $fh;
912	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1145	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
913	aio_fsync $fh;	1146	aio_fsync $fh if $cf::USE_FSYNC;
914	close $fh;	1147	close $fh;
915		1148
916	if (@$objs) {	1149	if (@$objs) {
917	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1150	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
918	chmod SAVE_MODE, $fh;	1151	chmod SAVE_MODE, $fh;
919	my $data = Storable::nfreeze { version => 1, objs => $objs };	1152	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
920	aio_write $fh, 0, (length $data), $data, 0;	1153	aio_write $fh, 0, (length $data), $data, 0;
921	aio_fsync $fh;	1154	aio_fsync $fh if $cf::USE_FSYNC;
922	close $fh;	1155	close $fh;
923	aio_rename "$filename.pst~", "$filename.pst";	1156	aio_rename "$filename.pst~", "$filename.pst";
924	}	1157	}
925	} else {	1158	} else {
926	aio_unlink "$filename.pst";	1159	aio_unlink "$filename.pst";
…		…
932	}	1165	}
933	} else {	1166	} else {
934	aio_unlink $filename;	1167	aio_unlink $filename;
935	aio_unlink "$filename.pst";	1168	aio_unlink "$filename.pst";
936	}	1169	}
937	}	1170	};
938	}	1171	}
939		1172
940	sub object_freezer_as_string {	1173	sub object_freezer_as_string {
941	my ($rdata, $objs) = @_;	1174	my ($rdata, $objs) = @_;
942		1175
…		…
954	or return;	1187	or return;
955		1188
956	unless (aio_stat "$filename.pst") {	1189	unless (aio_stat "$filename.pst") {
957	(aio_load "$filename.pst", $av) >= 0	1190	(aio_load "$filename.pst", $av) >= 0
958	or return;	1191	or return;
		1192
959	$av = eval { (Storable::thaw $av)->{objs} };	1193	my $st = eval { Coro::Storable::thaw $av };
		1194	$av = $st->{objs};
960	}	1195	}
961		1196
		1197	utf8::decode (my $decname = $filename);
962	warn sprintf "loading %s (%d)\n",	1198	warn sprintf "loading %s (%d,%d)\n",
963	$filename, length $data, scalar @{$av || []};#d#	1199	$decname, length $data, scalar @{$av || []};
		1200
964	return ($data, $av);	1201	($data, $av)
965	}	1202	}
		1203
		1204	=head2 COMMAND CALLBACKS
		1205
		1206	=over 4
		1207
		1208	=cut
966		1209
967	#############################################################################	1210	#############################################################################
968	# command handling &c	1211	# command handling &c
969		1212
970	=item cf::register_command $name => \&callback($ob,$args);	1213	=item cf::register_command $name => \&callback($ob,$args);
…		…
983	push @{ $COMMAND{$name} }, [$caller, $cb];	1226	push @{ $COMMAND{$name} }, [$caller, $cb];
984	}	1227	}
985		1228
986	=item cf::register_extcmd $name => \&callback($pl,$packet);	1229	=item cf::register_extcmd $name => \&callback($pl,$packet);
987		1230
988	Register a callbackf ro execution when the client sends an extcmd packet.	1231	Register a callback for execution when the client sends an (synchronous)
		1232	extcmd packet. Ext commands will be processed in the order they are
		1233	received by the server, like other user commands. The first argument is
		1234	the logged-in player. Ext commands can only be processed after a player
		1235	has logged in successfully.
989		1236
990	If the callback returns something, it is sent back as if reply was being	1237	If the callback returns something, it is sent back as if reply was being
991	called.	1238	called.
992		1239
		1240	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1241
		1242	Register a callback for execution when the client sends an (asynchronous)
		1243	exticmd packet. Exti commands are processed by the server as soon as they
		1244	are received, i.e. out of order w.r.t. other commands. The first argument
		1245	is a client socket. Exti commands can be received anytime, even before
		1246	log-in.
		1247
		1248	If the callback returns something, it is sent back as if reply was being
		1249	called.
		1250
993	=cut	1251	=cut
994		1252
995	sub register_extcmd {	1253	sub register_extcmd {
996	my ($name, $cb) = @_;	1254	my ($name, $cb) = @_;
997		1255
998	$EXTCMD{$name} = $cb;	1256	$EXTCMD{$name} = $cb;
		1257	}
		1258
		1259	sub register_exticmd {
		1260	my ($name, $cb) = @_;
		1261
		1262	$EXTICMD{$name} = $cb;
999	}	1263	}
1000		1264
1001	cf::player->attach (	1265	cf::player->attach (
1002	on_command => sub {	1266	on_command => sub {
1003	my ($pl, $name, $params) = @_;	1267	my ($pl, $name, $params) = @_;
…		…
1012	cf::override;	1276	cf::override;
1013	},	1277	},
1014	on_extcmd => sub {	1278	on_extcmd => sub {
1015	my ($pl, $buf) = @_;	1279	my ($pl, $buf) = @_;
1016		1280
1017	my $msg = eval { from_json $buf };	1281	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
1018		1282
1019	if (ref $msg) {	1283	if (ref $msg) {
		1284	my ($type, $reply, @payload) =
		1285	"ARRAY" eq ref $msg
		1286	? @$msg
		1287	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1288
		1289	my @reply;
		1290
1020	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1291	if (my $cb = $EXTCMD{$type}) {
1021	if (my %reply = $cb->($pl, $msg)) {	1292	@reply = $cb->($pl, @payload);
1022	$pl->ext_reply ($msg->{msgid}, %reply);
1023	}
1024	}	1293	}
		1294
		1295	$pl->ext_reply ($reply, @reply)
		1296	if $reply;
		1297
1025	} else {	1298	} else {
1026	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1299	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1027	}	1300	}
1028		1301
1029	cf::override;	1302	cf::override;
1030	},	1303	},
1031	);	1304	);
1032		1305
1033	sub load_extension {
1034	my ($path) = @_;
1035
1036	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
1037	my $base = $1;
1038	my $pkg = $1;
1039	$pkg =~ s/[^[:word:]]/_/g;
1040	$pkg = "ext::$pkg";
1041
1042	warn "... loading '$path' into '$pkg'\n";
1043
1044	open my $fh, "<:utf8", $path
1045	or die "$path: $!";
1046
1047	my $source =
1048	"package $pkg; use strict; use utf8;\n"
1049	. "#line 1 \"$path\"\n{\n"
1050	. (do { local $/; <$fh> })
1051	. "\n};\n1";
1052
1053	eval $source
1054	or die $@ ? "$path: $@\n"
1055	: "extension disabled.\n";
1056
1057	push @EXTS, $pkg;
1058	}
1059
1060	sub load_extensions {	1306	sub load_extensions {
		1307	cf::sync_job {
		1308	my %todo;
		1309
1061	for my $ext (<$LIBDIR/*.ext>) {	1310	for my $path (<$LIBDIR/*.ext>) {
1062	next unless -r $ext;	1311	next unless -r $path;
1063	eval {	1312
1064	load_extension $ext;	1313	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1314	my $base = $1;
		1315	my $pkg = $1;
		1316	$pkg =~ s/[^[:word:]]/_/g;
		1317	$pkg = "ext::$pkg";
		1318
		1319	open my $fh, "<:utf8", $path
		1320	or die "$path: $!";
		1321
		1322	my $source = do { local $/; <$fh> };
		1323
		1324	my %ext = (
		1325	path => $path,
		1326	base => $base,
		1327	pkg => $pkg,
		1328	);
		1329
		1330	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1331	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1332
		1333	$ext{source} =
		1334	"package $pkg; use strict; use utf8;\n"
		1335	. "#line 1 \"$path\"\n{\n"
		1336	. $source
		1337	. "\n};\n1";
		1338
		1339	$todo{$base} = \%ext;
		1340	}
		1341
		1342	my %done;
		1343	while (%todo) {
		1344	my $progress;
		1345
		1346	while (my ($k, $v) = each %todo) {
		1347	for (split /,\s*/, $v->{meta}{depends}) {
		1348	goto skip
		1349	unless exists $done{$_};
		1350	}
		1351
		1352	warn "... loading '$k' into '$v->{pkg}'\n";
		1353
		1354	unless (eval $v->{source}) {
		1355	my $msg = $@ ? "$v->{path}: $@\n"
		1356	: "$v->{base}: extension inactive.\n";
		1357
		1358	if (exists $v->{meta}{mandatory}) {
		1359	warn $msg;
		1360	cf::cleanup "mandatory extension failed to load, exiting.";
		1361	}
		1362
		1363	warn $msg;
		1364	}
		1365
		1366	$done{$k} = delete $todo{$k};
		1367	push @EXTS, $v->{pkg};
		1368	$progress = 1;
1065	1	1369	}
1066	} or warn "$ext not loaded: $@";	1370
		1371	skip:
		1372	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1373	unless $progress;
		1374	}
1067	}	1375	};
1068	}	1376	}
1069		1377
1070	#############################################################################	1378	#############################################################################
1071	# load/save/clean perl data associated with a map
1072		1379
1073	*cf::mapsupport::on_clean = sub {	1380	=back
1074	my ($map) = @_;
1075
1076	my $path = $map->tmpname;
1077	defined $path or return;
1078
1079	unlink "$path.pst";
1080	};
1081
1082	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1083
1084	#############################################################################
1085		1381
1086	=head2 CORE EXTENSIONS	1382	=head2 CORE EXTENSIONS
1087		1383
1088	Functions and methods that extend core crossfire objects.	1384	Functions and methods that extend core crossfire objects.
1089		1385
…		…
1095		1391
1096	=head3 cf::player	1392	=head3 cf::player
1097		1393
1098	=over 4	1394	=over 4
1099		1395
		1396	=item cf::player::num_playing
		1397
		1398	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1399
		1400	=cut
		1401
		1402	sub num_playing {
		1403	scalar grep
		1404	$_->ob->map
		1405	&& !$_->hidden
		1406	&& !$_->ob->flag (cf::FLAG_WIZ),
		1407	cf::player::list
		1408	}
		1409
1100	=item cf::player::find $login	1410	=item cf::player::find $login
1101		1411
1102	Returns the given player object, loading it if necessary (might block).	1412	Returns the given player object, loading it if necessary (might block).
1103		1413
1104	=cut	1414	=cut
1105		1415
1106	sub playerdir($) {	1416	sub playerdir($) {
1107	cf::localdir	1417	"$PLAYERDIR/"
1108	. "/"
1109	. cf::playerdir
1110	. "/"
1111	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1418	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1112	}	1419	}
1113		1420
1114	sub path($) {	1421	sub path($) {
1115	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1422	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1116		1423
1117	(playerdir $login) . "/$login.pl"	1424	(playerdir $login) . "/playerdata"
1118	}	1425	}
1119		1426
1120	sub find_active($) {	1427	sub find_active($) {
1121	$cf::PLAYER{$_[0]}	1428	$cf::PLAYER{$_[0]}
1122	and $cf::PLAYER{$_[0]}->active	1429	and $cf::PLAYER{$_[0]}->active
…		…
1125		1432
1126	sub exists($) {	1433	sub exists($) {
1127	my ($login) = @_;	1434	my ($login) = @_;
1128		1435
1129	$cf::PLAYER{$login}	1436	$cf::PLAYER{$login}
1130	or cf::sync_job { !aio_stat $login }	1437	or cf::sync_job { !aio_stat path $login }
1131	}	1438	}
1132		1439
1133	sub find($) {	1440	sub find($) {
1134	return $cf::PLAYER{$_[0]} || do {	1441	return $cf::PLAYER{$_[0]} || do {
1135	my $login = $_[0];	1442	my $login = $_[0];
1136		1443
1137	my $guard = cf::lock_acquire "user_find:$login";	1444	my $guard = cf::lock_acquire "user_find:$login";
1138		1445
1139	$cf::PLAYER{$_[0]} || do {	1446	$cf::PLAYER{$_[0]} || do {
1140	my $pl = load_pl path $login	1447	# rename old playerfiles to new ones
		1448	#TODO: remove when no longer required
		1449	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1450	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1451	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1452	aio_unlink +(playerdir $login) . "/$login.pl";
		1453
		1454	my $f = new_from_file cf::object::thawer path $login
1141	or return;	1455	or return;
		1456
		1457	my $pl = cf::player::load_pl $f
		1458	or return;
		1459	local $cf::PLAYER_LOADING{$login} = $pl;
		1460	$f->resolve_delayed_derefs;
1142	$cf::PLAYER{$login} = $pl	1461	$cf::PLAYER{$login} = $pl
1143	}	1462	}
1144	}	1463	}
1145	}	1464	}
1146		1465
…		…
1156		1475
1157	aio_mkdir playerdir $pl, 0770;	1476	aio_mkdir playerdir $pl, 0770;
1158	$pl->{last_save} = $cf::RUNTIME;	1477	$pl->{last_save} = $cf::RUNTIME;
1159		1478
1160	$pl->save_pl ($path);	1479	$pl->save_pl ($path);
1161	Coro::cede;	1480	cf::cede_to_tick;
1162	}	1481	}
1163		1482
1164	sub new($) {	1483	sub new($) {
1165	my ($login) = @_;	1484	my ($login) = @_;
1166		1485
…		…
1172	$cf::PLAYER{$login} = $self;	1491	$cf::PLAYER{$login} = $self;
1173		1492
1174	$self	1493	$self
1175	}	1494	}
1176		1495
		1496	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1497
		1498	=cut
		1499
		1500	sub send_msg {
		1501	my $ns = shift->ns
		1502	or return;
		1503	$ns->send_msg (@_);
		1504	}
		1505
1177	=item $pl->quit_character	1506	=item $pl->quit_character
1178		1507
1179	Nukes the player without looking back. If logged in, the connection will	1508	Nukes the player without looking back. If logged in, the connection will
1180	be destroyed. May block for a long time.	1509	be destroyed. May block for a long time.
1181		1510
1182	=cut	1511	=cut
1183		1512
1184	sub quit_character {	1513	sub quit_character {
1185	my ($pl) = @_;	1514	my ($pl) = @_;
		1515
		1516	my $name = $pl->ob->name;
1186		1517
1187	$pl->{deny_save} = 1;	1518	$pl->{deny_save} = 1;
1188	$pl->password ("*"); # this should lock out the player until we nuked the dir	1519	$pl->password ("*"); # this should lock out the player until we nuked the dir
1189		1520
1190	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1521	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1195	my $path = playerdir $pl;	1526	my $path = playerdir $pl;
1196	my $temp = "$path~$cf::RUNTIME~deleting~";	1527	my $temp = "$path~$cf::RUNTIME~deleting~";
1197	aio_rename $path, $temp;	1528	aio_rename $path, $temp;
1198	delete $cf::PLAYER{$pl->ob->name};	1529	delete $cf::PLAYER{$pl->ob->name};
1199	$pl->destroy;	1530	$pl->destroy;
		1531
		1532	my $prefix = qr<^~\Q$name\E/>;
		1533
		1534	# nuke player maps
		1535	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1536
1200	IO::AIO::aio_rmtree $temp;	1537	IO::AIO::aio_rmtree $temp;
		1538	}
		1539
		1540	=item $pl->kick
		1541
		1542	Kicks a player out of the game. This destroys the connection.
		1543
		1544	=cut
		1545
		1546	sub kick {
		1547	my ($pl, $kicker) = @_;
		1548
		1549	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1550	$pl->killer ("kicked");
		1551	$pl->ns->destroy;
1201	}	1552	}
1202		1553
1203	=item cf::player::list_logins	1554	=item cf::player::list_logins
1204		1555
1205	Returns am arrayref of all valid playernames in the system, can take a	1556	Returns am arrayref of all valid playernames in the system, can take a
1206	while and may block, so not sync_job-capable, ever.	1557	while and may block, so not sync_job-capable, ever.
1207		1558
1208	=cut	1559	=cut
1209		1560
1210	sub list_logins {	1561	sub list_logins {
1211	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1562	my $dirs = aio_readdir $PLAYERDIR
1212	or return [];	1563	or return [];
1213		1564
1214	my @logins;	1565	my @logins;
1215		1566
1216	for my $login (@$dirs) {	1567	for my $login (@$dirs) {
		1568	my $path = path $login;
		1569
		1570	# a .pst is a dead give-away for a valid player
		1571	unless (-e "$path.pst") {
1217	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1572	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1218	aio_read $fh, 0, 512, my $buf, 0 or next;	1573	aio_read $fh, 0, 512, my $buf, 0 or next;
1219	$buf !~ /^password -------------$/m or next; # official not-valid tag	1574	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1575	}
1220		1576
1221	utf8::decode $login;	1577	utf8::decode $login;
1222	push @logins, $login;	1578	push @logins, $login;
1223	}	1579	}
1224		1580
1225	\@logins	1581	\@logins
1226	}	1582	}
1227		1583
1228	=item $player->maps	1584	=item $player->maps
1229		1585
1230	Returns an arrayref of cf::path's of all maps that are private for this	1586	Returns an arrayref of map paths that are private for this
1231	player. May block.	1587	player. May block.
1232		1588
1233	=cut	1589	=cut
1234		1590
1235	sub maps($) {	1591	sub maps($) {
1236	my ($pl) = @_;	1592	my ($pl) = @_;
		1593
		1594	$pl = ref $pl ? $pl->ob->name : $pl;
1237		1595
1238	my $files = aio_readdir playerdir $pl	1596	my $files = aio_readdir playerdir $pl
1239	or return;	1597	or return;
1240		1598
1241	my @paths;	1599	my @paths;
…		…
1243	for (@$files) {	1601	for (@$files) {
1244	utf8::decode $_;	1602	utf8::decode $_;
1245	next if /\.(?:pl|pst)$/;	1603	next if /\.(?:pl|pst)$/;
1246	next unless /^$PATH_SEP/o;	1604	next unless /^$PATH_SEP/o;
1247		1605
1248	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1606	push @paths, cf::map::normalise "~$pl/$_";
1249	}	1607	}
1250		1608
1251	\@paths	1609	\@paths
1252	}	1610	}
1253		1611
		1612	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1613
		1614	Expand crossfire pod fragments into protocol xml.
		1615
		1616	=cut
		1617
		1618	use re 'eval';
		1619
		1620	my $group;
		1621	my $interior; $interior = qr{
		1622	# match a pod interior sequence sans C<< >>
		1623	(?:
		1624	\ (.*?)\ (?{ $group = $^N })
		1625	| < (??{$interior}) >
		1626	)
		1627	}x;
		1628
		1629	sub expand_cfpod {
		1630	my ($self, $pod) = @_;
		1631
		1632	my $xml;
		1633
		1634	while () {
		1635	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1636	$group = $1;
		1637
		1638	$group =~ s/&/&amp;/g;
		1639	$group =~ s/</&lt;/g;
		1640
		1641	$xml .= $group;
		1642	} elsif ($pod =~ m%\G
		1643	([BCGHITU])
		1644	<
		1645	(?:
		1646	([^<>]*) (?{ $group = $^N })
		1647	| < $interior >
		1648	)
		1649	>
		1650	%gcsx
		1651	) {
		1652	my ($code, $data) = ($1, $group);
		1653
		1654	if ($code eq "B") {
		1655	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1656	} elsif ($code eq "I") {
		1657	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1658	} elsif ($code eq "U") {
		1659	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1660	} elsif ($code eq "C") {
		1661	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1662	} elsif ($code eq "T") {
		1663	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1664	} elsif ($code eq "G") {
		1665	my ($male, $female) = split /\|/, $data;
		1666	$data = $self->gender ? $female : $male;
		1667	$xml .= expand_cfpod ($self, $data);
		1668	} elsif ($code eq "H") {
		1669	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1670	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1671	"")
		1672	[$self->{hintmode}];
		1673	} else {
		1674	$xml .= "error processing '$code($data)' directive";
		1675	}
		1676	} else {
		1677	if ($pod =~ /\G(.+)/) {
		1678	warn "parse error while expanding $pod (at $1)";
		1679	}
		1680	last;
		1681	}
		1682	}
		1683
		1684	for ($xml) {
		1685	# create single paragraphs (very hackish)
		1686	s/(?<=\S)\n(?=\w)/ /g;
		1687
		1688	# compress some whitespace
		1689	s/\s+\n/\n/g; # ws line-ends
		1690	s/\n\n+/\n/g; # double lines
		1691	s/^\n+//; # beginning lines
		1692	s/\n+$//; # ending lines
		1693	}
		1694
		1695	$xml
		1696	}
		1697
		1698	no re 'eval';
		1699
		1700	sub hintmode {
		1701	$_[0]{hintmode} = $_[1] if @_ > 1;
		1702	$_[0]{hintmode}
		1703	}
		1704
1254	=item $player->ext_reply ($msgid, $msgtype, %msg)	1705	=item $player->ext_reply ($msgid, @msg)
1255		1706
1256	Sends an ext reply to the player.	1707	Sends an ext reply to the player.
1257		1708
1258	=cut	1709	=cut
1259		1710
1260	sub ext_reply($$$%) {	1711	sub ext_reply($$@) {
1261	my ($self, $id, %msg) = @_;	1712	my ($self, $id, @msg) = @_;
1262		1713
1263	$msg{msgid} = $id;	1714	$self->ns->ext_reply ($id, @msg)
1264
1265	$self->send ("ext " . cf::to_json \%msg);
1266	}	1715	}
1267		1716
1268	package cf;	1717	=item $player->ext_msg ($type, @msg)
		1718
		1719	Sends an ext event to the client.
		1720
		1721	=cut
		1722
		1723	sub ext_msg($$@) {
		1724	my ($self, $type, @msg) = @_;
		1725
		1726	$self->ns->ext_msg ($type, @msg);
		1727	}
		1728
		1729	=head3 cf::region
		1730
		1731	=over 4
		1732
		1733	=cut
		1734
		1735	package cf::region;
		1736
		1737	=item cf::region::find_by_path $path
		1738
		1739	Tries to decuce the likely region for a map knowing only its path.
		1740
		1741	=cut
		1742
		1743	sub find_by_path($) {
		1744	my ($path) = @_;
		1745
		1746	my ($match, $specificity);
		1747
		1748	for my $region (list) {
		1749	if ($region->{match} && $path =~ $region->{match}) {
		1750	($match, $specificity) = ($region, $region->specificity)
		1751	if $region->specificity > $specificity;
		1752	}
		1753	}
		1754
		1755	$match
		1756	}
1269		1757
1270	=back	1758	=back
1271
1272		1759
1273	=head3 cf::map	1760	=head3 cf::map
1274		1761
1275	=over 4	1762	=over 4
1276		1763
…		…
1279	package cf::map;	1766	package cf::map;
1280		1767
1281	use Fcntl;	1768	use Fcntl;
1282	use Coro::AIO;	1769	use Coro::AIO;
1283		1770
		1771	use overload
		1772	'""' => \&as_string,
		1773	fallback => 1;
		1774
1284	our $MAX_RESET = 3600;	1775	our $MAX_RESET = 3600;
1285	our $DEFAULT_RESET = 3000;	1776	our $DEFAULT_RESET = 3000;
1286		1777
1287	sub generate_random_map {	1778	sub generate_random_map {
1288	my ($path, $rmp) = @_;	1779	my ($self, $rmp) = @_;
1289
1290	# mit "rum" bekleckern, nicht	1780	# mit "rum" bekleckern, nicht
1291	cf::map::_create_random_map (	1781	$self->_create_random_map (
1292	$path,
1293	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1782	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1294	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1783	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1295	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1784	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1296	$rmp->{exit_on_final_map},	1785	$rmp->{exit_on_final_map},
1297	$rmp->{xsize}, $rmp->{ysize},	1786	$rmp->{xsize}, $rmp->{ysize},
…		…
1302	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1791	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1303	(cf::region::find $rmp->{region}), $rmp->{custom}	1792	(cf::region::find $rmp->{region}), $rmp->{custom}
1304	)	1793	)
1305	}	1794	}
1306		1795
		1796	=item cf::map->register ($regex, $prio)
		1797
		1798	Register a handler for the map path matching the given regex at the
		1799	givne priority (higher is better, built-in handlers have priority 0, the
		1800	default).
		1801
		1802	=cut
		1803
		1804	sub register {
		1805	my (undef, $regex, $prio) = @_;
		1806	my $pkg = caller;
		1807
		1808	no strict;
		1809	push @{"$pkg\::ISA"}, __PACKAGE__;
		1810
		1811	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1812	}
		1813
		1814	# also paths starting with '/'
		1815	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1816
		1817	sub thawer_merge {
		1818	my ($self, $merge) = @_;
		1819
		1820	# we have to keep some variables in memory intact
		1821	local $self->{path};
		1822	local $self->{load_path};
		1823
		1824	$self->SUPER::thawer_merge ($merge);
		1825	}
		1826
		1827	sub normalise {
		1828	my ($path, $base) = @_;
		1829
		1830	$path = "$path"; # make sure its a string
		1831
		1832	$path =~ s/\.map$//;
		1833
		1834	# map plan:
		1835	#
		1836	# /! non-realised random map exit (special hack!)
		1837	# {... are special paths that are not being touched
		1838	# ?xxx/... are special absolute paths
		1839	# ?random/... random maps
		1840	# /... normal maps
		1841	# ~user/... per-player map of a specific user
		1842
		1843	$path =~ s/$PATH_SEP/\//go;
		1844
		1845	# treat it as relative path if it starts with
		1846	# something that looks reasonable
		1847	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1848	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1849
		1850	$base =~ s{[^/]+/?$}{};
		1851	$path = "$base/$path";
		1852	}
		1853
		1854	for ($path) {
		1855	redo if s{//}{/};
		1856	redo if s{/\.?/}{/};
		1857	redo if s{/[^/]+/\.\./}{/};
		1858	}
		1859
		1860	$path
		1861	}
		1862
		1863	sub new_from_path {
		1864	my (undef, $path, $base) = @_;
		1865
		1866	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1867
		1868	$path = normalise $path, $base;
		1869
		1870	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1871	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1872	my $self = bless cf::map::new, $pkg;
		1873	$self->{path} = $path; $self->path ($path);
		1874	$self->init; # pass $1 etc.
		1875	return $self;
		1876	}
		1877	}
		1878
		1879	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1880	()
		1881	}
		1882
		1883	sub init {
		1884	my ($self) = @_;
		1885
		1886	$self
		1887	}
		1888
		1889	sub as_string {
		1890	my ($self) = @_;
		1891
		1892	"$self->{path}"
		1893	}
		1894
		1895	# the displayed name, this is a one way mapping
		1896	sub visible_name {
		1897	&as_string
		1898	}
		1899
		1900	# the original (read-only) location
		1901	sub load_path {
		1902	my ($self) = @_;
		1903
		1904	"$MAPDIR/$self->{path}.map"
		1905	}
		1906
		1907	# the temporary/swap location
		1908	sub save_path {
		1909	my ($self) = @_;
		1910
		1911	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1912	"$TMPDIR/$path.map"
		1913	}
		1914
		1915	# the unique path, undef == no special unique path
		1916	sub uniq_path {
		1917	my ($self) = @_;
		1918
		1919	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1920	"$UNIQUEDIR/$path"
		1921	}
		1922
1307	# and all this just because we cannot iterate over	1923	# and all this just because we cannot iterate over
1308	# all maps in C++...	1924	# all maps in C++...
1309	sub change_all_map_light {	1925	sub change_all_map_light {
1310	my ($change) = @_;	1926	my ($change) = @_;
1311		1927
1312	$_->change_map_light ($change)	1928	$_->change_map_light ($change)
1313	for grep $_->outdoor, values %cf::MAP;	1929	for grep $_->outdoor, values %cf::MAP;
1314	}	1930	}
1315		1931
		1932	sub decay_objects {
		1933	my ($self) = @_;
		1934
		1935	return if $self->{deny_reset};
		1936
		1937	$self->do_decay_objects;
		1938	}
		1939
		1940	sub unlink_save {
		1941	my ($self) = @_;
		1942
		1943	utf8::encode (my $save = $self->save_path);
		1944	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1945	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1946	}
		1947
1316	sub load_map_header($) {	1948	sub load_header_from($) {
1317	my ($path) = @_;	1949	my ($self, $path) = @_;
1318		1950
1319	utf8::encode $path;	1951	utf8::encode $path;
1320	aio_open $path, O_RDONLY, 0	1952	my $f = new_from_file cf::object::thawer $path
1321	or return;	1953	or return;
1322		1954
1323	my $map = cf::map::new	1955	$self->_load_header ($f)
1324	or return;	1956	or return;
1325		1957
1326	# for better error messages only, will be overwritten later	1958	local $MAP_LOADING{$self->{path}} = $self;
1327	$map->path ($path);	1959	$f->resolve_delayed_derefs;
1328		1960
1329	$map->load_header ($path)	1961	$self->{load_path} = $path;
		1962
		1963	1
		1964	}
		1965
		1966	sub load_header_orig {
		1967	my ($self) = @_;
		1968
		1969	$self->load_header_from ($self->load_path)
		1970	}
		1971
		1972	sub load_header_temp {
		1973	my ($self) = @_;
		1974
		1975	$self->load_header_from ($self->save_path)
		1976	}
		1977
		1978	sub prepare_temp {
		1979	my ($self) = @_;
		1980
		1981	$self->last_access ((delete $self->{last_access})
		1982	|| $cf::RUNTIME); #d#
		1983	# safety
		1984	$self->{instantiate_time} = $cf::RUNTIME
		1985	if $self->{instantiate_time} > $cf::RUNTIME;
		1986	}
		1987
		1988	sub prepare_orig {
		1989	my ($self) = @_;
		1990
		1991	$self->{load_original} = 1;
		1992	$self->{instantiate_time} = $cf::RUNTIME;
		1993	$self->last_access ($cf::RUNTIME);
		1994	$self->instantiate;
		1995	}
		1996
		1997	sub load_header {
		1998	my ($self) = @_;
		1999
		2000	if ($self->load_header_temp) {
		2001	$self->prepare_temp;
		2002	} else {
		2003	$self->load_header_orig
1330	or return;	2004	or return;
		2005	$self->prepare_orig;
		2006	}
1331		2007
1332	$map->{load_path} = $path;	2008	$self->{deny_reset} = 1
		2009	if $self->no_reset;
1333		2010
1334	$map	2011	$self->default_region (cf::region::find_by_path $self->{path})
		2012	unless $self->default_region;
		2013
		2014	1
1335	}	2015	}
1336		2016
1337	sub find;	2017	sub find;
1338	sub find {	2018	sub find {
1339	my ($path, $origin) = @_;	2019	my ($path, $origin) = @_;
1340		2020
1341	#warn "find<$path,$origin>\n";#d#
1342
1343	$path = new cf::path $path, $origin && $origin->path;	2021	$path = normalise $path, $origin && $origin->path;
1344	my $key = $path->as_string;
1345		2022
		2023	cf::lock_wait "map_data:$path";#d#remove
1346	cf::lock_wait "map_find:$key";	2024	cf::lock_wait "map_find:$path";
1347		2025
1348	$cf::MAP{$key} || do {	2026	$cf::MAP{$path} || do {
1349	my $guard = cf::lock_acquire "map_find:$key";	2027	my $guard1 = cf::lock_acquire "map_find:$path";
		2028	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1350		2029
1351	# do it the slow way	2030	my $map = new_from_path cf::map $path
1352	my $map = $path->load_temp;
1353
1354	Coro::cede;
1355
1356	if ($map) {
1357	$map->last_access ((delete $map->{last_access})
1358	|| $cf::RUNTIME); #d#
1359	# safety
1360	$map->{instantiate_time} = $cf::RUNTIME
1361	if $map->{instantiate_time} > $cf::RUNTIME;
1362	} else {
1363	$map = $path->load_orig
1364	or return;	2031	or return;
1365		2032
1366	$map->{load_original} = 1;
1367	$map->{instantiate_time} = $cf::RUNTIME;
1368	$map->last_access ($cf::RUNTIME);
1369	$map->instantiate;
1370
1371	# per-player maps become, after loading, normal maps
1372	$map->per_player (0) if $path->{user_rel};
1373	}
1374
1375	$map->path ($key);
1376	$map->{path} = $path;
1377	$map->{last_save} = $cf::RUNTIME;	2033	$map->{last_save} = $cf::RUNTIME;
1378		2034
1379	Coro::cede;	2035	$map->load_header
		2036	or return;
1380		2037
1381	if ($map->should_reset) {	2038	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2039	# doing this can freeze the server in a sync job, obviously
		2040	#$cf::WAIT_FOR_TICK->wait;
		2041	undef $guard1;
		2042	undef $guard2;
1382	$map->reset;	2043	$map->reset;
1383	undef $guard;
1384	$map = find $path	2044	return find $path;
1385	or return;
1386	}	2045	}
1387		2046
1388	$cf::MAP{$key} = $map	2047	$cf::MAP{$path} = $map
1389	}	2048	}
1390	}	2049	}
		2050
		2051	sub pre_load { }
		2052	sub post_load { }
1391		2053
1392	sub load {	2054	sub load {
1393	my ($self) = @_;	2055	my ($self) = @_;
1394		2056
		2057	local $self->{deny_reset} = 1; # loading can take a long time
		2058
1395	my $path = $self->{path};	2059	my $path = $self->{path};
		2060
		2061	{
1396	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2062	my $guard = cf::lock_acquire "map_data:$path";
1397		2063
		2064	return unless $self->valid;
1398	return if $self->in_memory != cf::MAP_SWAPPED;	2065	return unless $self->in_memory == cf::MAP_SWAPPED;
1399		2066
1400	$self->in_memory (cf::MAP_LOADING);	2067	$self->in_memory (cf::MAP_LOADING);
1401		2068
1402	$self->alloc;	2069	$self->alloc;
1403	$self->load_objects ($self->{load_path}, 1)	2070
		2071	$self->pre_load;
		2072	cf::cede_to_tick;
		2073
		2074	my $f = new_from_file cf::object::thawer $self->{load_path};
		2075	$f->skip_block;
		2076	$self->_load_objects ($f)
1404	or return;	2077	or return;
1405		2078
1406	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2079	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1407	if delete $self->{load_original};	2080	if delete $self->{load_original};
1408		2081
1409	if (my $uniq = $path->uniq_path) {	2082	if (my $uniq = $self->uniq_path) {
1410	utf8::encode $uniq;	2083	utf8::encode $uniq;
1411	if (aio_open $uniq, O_RDONLY, 0) {	2084	unless (aio_stat $uniq) {
		2085	if (my $f = new_from_file cf::object::thawer $uniq) {
1412	$self->clear_unique_items;	2086	$self->clear_unique_items;
1413	$self->load_objects ($uniq, 0);	2087	$self->_load_objects ($f);
		2088	$f->resolve_delayed_derefs;
		2089	}
1414	}	2090	}
1415	}	2091	}
1416		2092
1417	Coro::cede;	2093	$f->resolve_delayed_derefs;
1418		2094
		2095	cf::cede_to_tick;
1419	# now do the right thing for maps	2096	# now do the right thing for maps
1420	$self->link_multipart_objects;	2097	$self->link_multipart_objects;
1421
1422	if ($self->{path}->is_style_map) {
1423	$self->{deny_save} = 1;
1424	$self->{deny_reset} = 1;
1425	} else {
1426	$self->decay_objects;
1427	$self->fix_auto_apply;
1428	$self->update_buttons;
1429	$self->set_darkness_map;
1430	$self->difficulty ($self->estimate_difficulty)	2098	$self->difficulty ($self->estimate_difficulty)
1431	unless $self->difficulty;	2099	unless $self->difficulty;
		2100	cf::cede_to_tick;
		2101
		2102	unless ($self->{deny_activate}) {
		2103	$self->decay_objects;
		2104	$self->fix_auto_apply;
		2105	$self->update_buttons;
		2106	cf::cede_to_tick;
		2107	$self->set_darkness_map;
		2108	cf::cede_to_tick;
1432	$self->activate;	2109	$self->activate;
1433	}	2110	}
1434		2111
1435	Coro::cede;	2112	$self->{last_save} = $cf::RUNTIME;
		2113	$self->last_access ($cf::RUNTIME);
1436		2114
1437	$self->in_memory (cf::MAP_IN_MEMORY);	2115	$self->in_memory (cf::MAP_IN_MEMORY);
		2116	}
		2117
		2118	$self->post_load;
		2119	}
		2120
		2121	sub customise_for {
		2122	my ($self, $ob) = @_;
		2123
		2124	return find "~" . $ob->name . "/" . $self->{path}
		2125	if $self->per_player;
		2126
		2127	# return find "?party/" . $ob->name . "/" . $self->{path}
		2128	# if $self->per_party;
		2129
		2130	$self
1438	}	2131	}
1439		2132
1440	# find and load all maps in the 3x3 area around a map	2133	# find and load all maps in the 3x3 area around a map
1441	sub load_diag {	2134	sub load_neighbours {
1442	my ($map) = @_;	2135	my ($map) = @_;
1443		2136
1444	my @diag; # diagonal neighbours	2137	my @neigh; # diagonal neighbours
1445		2138
1446	for (0 .. 3) {	2139	for (0 .. 3) {
1447	my $neigh = $map->tile_path ($_)	2140	my $neigh = $map->tile_path ($_)
1448	or next;	2141	or next;
1449	$neigh = find $neigh, $map	2142	$neigh = find $neigh, $map
1450	or next;	2143	or next;
1451	$neigh->load;	2144	$neigh->load;
1452		2145
		2146	push @neigh,
1453	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2147	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1454	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2148	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1455	}	2149	}
1456		2150
1457	for (@diag) {	2151	for (grep defined $_->[0], @neigh) {
		2152	my ($path, $origin) = @$_;
1458	my $neigh = find @$_	2153	my $neigh = find $path, $origin
1459	or next;	2154	or next;
1460	$neigh->load;	2155	$neigh->load;
1461	}	2156	}
1462	}	2157	}
1463		2158
…		…
1468	}	2163	}
1469		2164
1470	sub do_load_sync {	2165	sub do_load_sync {
1471	my ($map) = @_;	2166	my ($map) = @_;
1472		2167
		2168	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2169	if $Coro::current == $Coro::main;
		2170
1473	cf::sync_job { $map->load };	2171	cf::sync_job { $map->load };
1474	}	2172	}
1475		2173
1476	our %MAP_PREFETCH;	2174	our %MAP_PREFETCH;
		2175	our $MAP_PREFETCHER = undef;
		2176
		2177	sub find_async {
		2178	my ($path, $origin, $load) = @_;
		2179
		2180	$path = normalise $path, $origin && $origin->{path};
		2181
		2182	if (my $map = $cf::MAP{$path}) {
		2183	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
		2184	}
		2185
		2186	$MAP_PREFETCH{$path} |= $load;
		2187
1477	our $MAP_PREFETCHER = Coro::async {	2188	$MAP_PREFETCHER ||= cf::async {
1478	while () {	2189	$Coro::current->{desc} = "map prefetcher";
		2190
1479	while (%MAP_PREFETCH) {	2191	while (%MAP_PREFETCH) {
1480	my $key = each %MAP_PREFETCH	2192	while (my ($k, $v) = each %MAP_PREFETCH) {
1481	or next;	2193	if (my $map = find $k) {
		2194	$map->load if $v;
		2195	}
		2196
1482	my $path = delete $MAP_PREFETCH{$key};	2197	delete $MAP_PREFETCH{$k};
1483
1484	my $map = find $path
1485	or next;
1486	$map->load;
1487	}	2198	}
1488	Coro::schedule;	2199	}
		2200	undef $MAP_PREFETCHER;
1489	}	2201	};
1490	};
1491
1492	sub find_async {
1493	my ($path, $origin) = @_;
1494
1495	$path = new cf::path $path, $origin && $origin->path;
1496	my $key = $path->as_string;
1497
1498	if (my $map = $cf::MAP{$key}) {
1499	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1500	}
1501
1502	$MAP_PREFETCH{$key} = $path;
1503	$MAP_PREFETCHER->ready;	2202	$MAP_PREFETCHER->prio (6);
1504		2203
1505	()	2204	()
1506	}	2205	}
1507		2206
1508	sub save {	2207	sub save {
1509	my ($self) = @_;	2208	my ($self) = @_;
1510		2209
1511	my $lock = cf::lock_acquire "map_data:" . $self->path;	2210	my $lock = cf::lock_acquire "map_data:$self->{path}";
1512		2211
1513	$self->{last_save} = $cf::RUNTIME;	2212	$self->{last_save} = $cf::RUNTIME;
1514		2213
1515	return unless $self->dirty;	2214	return unless $self->dirty;
1516		2215
1517	my $save = $self->{path}->save_path; utf8::encode $save;	2216	my $save = $self->save_path; utf8::encode $save;
1518	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2217	my $uniq = $self->uniq_path; utf8::encode $uniq;
1519		2218
1520	$self->{load_path} = $save;	2219	$self->{load_path} = $save;
1521		2220
1522	return if $self->{deny_save};	2221	return if $self->{deny_save};
1523		2222
1524	local $self->{last_access} = $self->last_access;#d#	2223	local $self->{last_access} = $self->last_access;#d#
1525		2224
1526	cf::async {	2225	cf::async {
		2226	$Coro::current->{desc} = "map player save";
1527	$_->contr->save for $self->players;	2227	$_->contr->save for $self->players;
1528	};	2228	};
1529		2229
1530	if ($uniq) {	2230	if ($uniq) {
1531	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2231	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1532	$self->save_objects ($uniq, cf::IO_UNIQUES);	2232	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1533	} else {	2233	} else {
1534	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2234	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1535	}	2235	}
1536	}	2236	}
1537		2237
1538	sub swap_out {	2238	sub swap_out {
1539	my ($self) = @_;	2239	my ($self) = @_;
1540		2240
1541	# save first because save cedes	2241	# save first because save cedes
1542	$self->save;	2242	$self->save;
1543		2243
1544	my $lock = cf::lock_acquire "map_data:" . $self->path;	2244	my $lock = cf::lock_acquire "map_data:$self->{path}";
1545		2245
1546	return if $self->players;	2246	return if $self->players;
1547	return if $self->in_memory != cf::MAP_IN_MEMORY;	2247	return if $self->in_memory != cf::MAP_IN_MEMORY;
1548	return if $self->{deny_save};	2248	return if $self->{deny_save};
1549		2249
		2250	$self->in_memory (cf::MAP_SWAPPED);
		2251
		2252	$self->deactivate;
		2253	$_->clear_links_to ($self) for values %cf::MAP;
1550	$self->clear;	2254	$self->clear;
1551	$self->in_memory (cf::MAP_SWAPPED);
1552	}	2255	}
1553		2256
1554	sub reset_at {	2257	sub reset_at {
1555	my ($self) = @_;	2258	my ($self) = @_;
1556		2259
1557	# TODO: safety, remove and allow resettable per-player maps	2260	# TODO: safety, remove and allow resettable per-player maps
1558	return 1e99 if $self->{path}{user_rel};
1559	return 1e99 if $self->{deny_reset};	2261	return 1e99 if $self->{deny_reset};
1560		2262
1561	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2263	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1562	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2264	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1563		2265
…		…
1568	my ($self) = @_;	2270	my ($self) = @_;
1569		2271
1570	$self->reset_at <= $cf::RUNTIME	2272	$self->reset_at <= $cf::RUNTIME
1571	}	2273	}
1572		2274
1573	sub rename {
1574	my ($self, $new_path) = @_;
1575
1576	$self->{path}->unlink_save;
1577
1578	delete $cf::MAP{$self->path};
1579	$self->{path} = new cf::path $new_path;
1580	$self->path ($self->{path}->as_string);
1581	$cf::MAP{$self->path} = $self;
1582
1583	$self->save;
1584	}
1585
1586	sub reset {	2275	sub reset {
1587	my ($self) = @_;	2276	my ($self) = @_;
1588		2277
1589	my $lock = cf::lock_acquire "map_data:" . $self->path;	2278	my $lock = cf::lock_acquire "map_data:$self->{path}";
1590		2279
1591	return if $self->players;	2280	return if $self->players;
1592	return if $self->{path}{user_rel};#d#
1593		2281
1594	warn "resetting map ", $self->path;#d#	2282	warn "resetting map ", $self->path;
		2283
		2284	$self->in_memory (cf::MAP_SWAPPED);
		2285
		2286	# need to save uniques path
		2287	unless ($self->{deny_save}) {
		2288	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2289
		2290	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2291	if $uniq;
		2292	}
1595		2293
1596	delete $cf::MAP{$self->path};	2294	delete $cf::MAP{$self->path};
1597		2295
		2296	$self->deactivate;
1598	$_->clear_links_to ($self) for values %cf::MAP;	2297	$_->clear_links_to ($self) for values %cf::MAP;
		2298	$self->clear;
1599		2299
1600	$self->{path}->unlink_save;	2300	$self->unlink_save;
1601	$self->destroy;	2301	$self->destroy;
1602	}	2302	}
1603		2303
1604	my $nuke_counter = "aaaa";	2304	my $nuke_counter = "aaaa";
1605		2305
1606	sub nuke {	2306	sub nuke {
1607	my ($self) = @_;	2307	my ($self) = @_;
1608		2308
		2309	{
		2310	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2311
		2312	delete $cf::MAP{$self->path};
		2313
		2314	$self->unlink_save;
		2315
		2316	bless $self, "cf::map";
		2317	delete $self->{deny_reset};
1609	$self->{deny_save} = 1;	2318	$self->{deny_save} = 1;
1610	$self->reset_timeout (1);	2319	$self->reset_timeout (1);
1611	$self->rename ("{nuke}/" . ($nuke_counter++));	2320	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2321
		2322	$cf::MAP{$self->path} = $self;
		2323	}
		2324
1612	$self->reset; # polite request, might not happen	2325	$self->reset; # polite request, might not happen
1613	}	2326	}
1614		2327
		2328	=item $maps = cf::map::tmp_maps
		2329
		2330	Returns an arrayref with all map paths of currently instantiated and saved
		2331	maps. May block.
		2332
		2333	=cut
		2334
		2335	sub tmp_maps() {
		2336	[
		2337	map {
		2338	utf8::decode $_;
		2339	/\.map$/
		2340	? normalise $_
		2341	: ()
		2342	} @{ aio_readdir $TMPDIR or [] }
		2343	]
		2344	}
		2345
		2346	=item $maps = cf::map::random_maps
		2347
		2348	Returns an arrayref with all map paths of currently instantiated and saved
		2349	random maps. May block.
		2350
		2351	=cut
		2352
		2353	sub random_maps() {
		2354	[
		2355	map {
		2356	utf8::decode $_;
		2357	/\.map$/
		2358	? normalise "?random/$_"
		2359	: ()
		2360	} @{ aio_readdir $RANDOMDIR or [] }
		2361	]
		2362	}
		2363
1615	=item cf::map::unique_maps	2364	=item cf::map::unique_maps
1616		2365
1617	Returns an arrayref of cf::path's of all shared maps that have	2366	Returns an arrayref of paths of all shared maps that have
1618	instantiated unique items. May block.	2367	instantiated unique items. May block.
1619		2368
1620	=cut	2369	=cut
1621		2370
1622	sub unique_maps() {	2371	sub unique_maps() {
1623	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2372	[
1624	or return;	2373	map {
1625
1626	my @paths;
1627
1628	for (@$files) {
1629	utf8::decode $_;	2374	utf8::decode $_;
1630	next if /\.pst$/;	2375	/\.map$/
1631	next unless /^$PATH_SEP/o;	2376	? normalise $_
1632		2377	: ()
1633	push @paths, new cf::path $_;	2378	} @{ aio_readdir $UNIQUEDIR or [] }
1634	}	2379	]
1635
1636	\@paths
1637	}	2380	}
1638
1639	package cf;
1640		2381
1641	=back	2382	=back
1642		2383
1643	=head3 cf::object	2384	=head3 cf::object
1644		2385
…		…
1659	map { $_, inv_recursive_ $_->inv } @_	2400	map { $_, inv_recursive_ $_->inv } @_
1660	}	2401	}
1661		2402
1662	sub inv_recursive {	2403	sub inv_recursive {
1663	inv_recursive_ inv $_[0]	2404	inv_recursive_ inv $_[0]
		2405	}
		2406
		2407	=item $ref = $ob->ref
		2408
		2409	creates and returns a persistent reference to an objetc that can be stored as a string.
		2410
		2411	=item $ob = cf::object::deref ($refstring)
		2412
		2413	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2414	even if the object actually exists. May block.
		2415
		2416	=cut
		2417
		2418	sub deref {
		2419	my ($ref) = @_;
		2420
		2421	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2422	my ($uuid, $name) = ($1, $2);
		2423	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2424	or return;
		2425	$pl->ob->uuid eq $uuid
		2426	or return;
		2427
		2428	$pl->ob
		2429	} else {
		2430	warn "$ref: cannot resolve object reference\n";
		2431	undef
		2432	}
1664	}	2433	}
1665		2434
1666	package cf;	2435	package cf;
1667		2436
1668	=back	2437	=back
…		…
1687		2456
1688	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2457	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1689		2458
1690	if ($self->{record_replies}) {	2459	if ($self->{record_replies}) {
1691	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2460	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2461
1692	} else {	2462	} else {
		2463	my $pl = $self->contr;
		2464
		2465	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2466	my $dialog = $pl->{npc_dialog};
		2467	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2468
		2469	} else {
1693	$msg = $npc->name . " says: $msg" if $npc;	2470	$msg = $npc->name . " says: $msg" if $npc;
1694	$self->message ($msg, $flags);	2471	$self->message ($msg, $flags);
		2472	}
1695	}	2473	}
		2474	}
		2475
		2476	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2477
		2478	=cut
		2479
		2480	sub cf::object::send_msg {
		2481	my $pl = shift->contr
		2482	or return;
		2483	$pl->send_msg (@_);
1696	}	2484	}
1697		2485
1698	=item $player_object->may ("access")	2486	=item $player_object->may ("access")
1699		2487
1700	Returns wether the given player is authorized to access resource "access"	2488	Returns wether the given player is authorized to access resource "access"
…		…
1713		2501
1714	=item $player_object->enter_link	2502	=item $player_object->enter_link
1715		2503
1716	Freezes the player and moves him/her to a special map (C<{link}>).	2504	Freezes the player and moves him/her to a special map (C<{link}>).
1717		2505
1718	The player should be reaosnably safe there for short amounts of time. You	2506	The player should be reasonably safe there for short amounts of time. You
1719	I<MUST> call C<leave_link> as soon as possible, though.	2507	I<MUST> call C<leave_link> as soon as possible, though.
1720		2508
		2509	Will never block.
		2510
1721	=item $player_object->leave_link ($map, $x, $y)	2511	=item $player_object->leave_link ($map, $x, $y)
1722		2512
1723	Moves the player out of the specila link map onto the given map. If the	2513	Moves the player out of the special C<{link}> map onto the specified
1724	map is not valid (or omitted), the player will be moved back to the	2514	map. If the map is not valid (or omitted), the player will be moved back
1725	location he/she was before the call to C<enter_link>, or, if that fails,	2515	to the location he/she was before the call to C<enter_link>, or, if that
1726	to the emergency map position.	2516	fails, to the emergency map position.
1727		2517
1728	Might block.	2518	Might block.
1729		2519
1730	=cut	2520	=cut
		2521
		2522	sub link_map {
		2523	unless ($LINK_MAP) {
		2524	$LINK_MAP = cf::map::find "{link}"
		2525	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2526	$LINK_MAP->load;
		2527	}
		2528
		2529	$LINK_MAP
		2530	}
1731		2531
1732	sub cf::object::player::enter_link {	2532	sub cf::object::player::enter_link {
1733	my ($self) = @_;	2533	my ($self) = @_;
1734		2534
1735	$self->deactivate_recursive;	2535	$self->deactivate_recursive;
1736		2536
1737	return if $self->map == $LINK_MAP;	2537	return if UNIVERSAL::isa $self->map, "ext::map_link";
1738		2538
1739	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2539	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1740	if $self->map;	2540	if $self->map && $self->map->{path} ne "{link}";
1741		2541
1742	$self->enter_map ($LINK_MAP, 20, 20);	2542	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1743	}	2543	}
1744		2544
1745	sub cf::object::player::leave_link {	2545	sub cf::object::player::leave_link {
1746	my ($self, $map, $x, $y) = @_;	2546	my ($self, $map, $x, $y) = @_;
		2547
		2548	return unless $self->contr->active;
1747		2549
1748	my $link_pos = delete $self->{_link_pos};	2550	my $link_pos = delete $self->{_link_pos};
1749		2551
1750	unless ($map) {	2552	unless ($map) {
1751	# restore original map position	2553	# restore original map position
…		…
1765	# use -1 or undef as default coordinates, not 0, 0	2567	# use -1 or undef as default coordinates, not 0, 0
1766	($x, $y) = ($map->enter_x, $map->enter_y)	2568	($x, $y) = ($map->enter_x, $map->enter_y)
1767	if $x <=0 && $y <= 0;	2569	if $x <=0 && $y <= 0;
1768		2570
1769	$map->load;	2571	$map->load;
1770	$map->load_diag;	2572	$map->load_neighbours;
1771		2573
1772	return unless $self->contr->active;	2574	return unless $self->contr->active;
1773	$self->activate_recursive;	2575	$self->activate_recursive;
		2576
		2577	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1774	$self->enter_map ($map, $x, $y);	2578	$self->enter_map ($map, $x, $y);
1775	}	2579	}
1776		2580
1777	cf::player->attach (	2581	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1778	on_logout => sub {
1779	my ($pl) = @_;
1780		2582
1781	# abort map switching before logout	2583	Moves the player to the given map-path and coordinates by first freezing
1782	if ($pl->ob->{_link_pos}) {	2584	her, loading and preparing them map, calling the provided $check callback
1783	cf::sync_job {	2585	that has to return the map if sucecssful, and then unfreezes the player on
1784	$pl->ob->leave_link	2586	the new (success) or old (failed) map position. In either case, $done will
1785	};	2587	be called at the end of this process.
1786	}
1787	},
1788	on_login => sub {
1789	my ($pl) = @_;
1790		2588
1791	# try to abort aborted map switching on player login :)
1792	# should happen only on crashes
1793	if ($pl->ob->{_link_pos}) {
1794	$pl->ob->enter_link;
1795	(async {
1796	# we need this sleep as the login has a concurrent enter_exit running
1797	# and this sleep increases chances of the player not ending up in scorn
1798	$pl->ob->reply (undef,
1799	"There was an internal problem at your last logout, "
1800	. "the server will try to bring you to your intended destination in a second.",
1801	cf::NDI_RED);
1802	Coro::Timer::sleep 1;
1803	$pl->ob->leave_link;
1804	})->prio (2);
1805	}
1806	},
1807	);
1808
1809	=item $player_object->goto ($path, $x, $y)
1810
1811	=cut	2589	=cut
		2590
		2591	our $GOTOGEN;
1812		2592
1813	sub cf::object::player::goto {	2593	sub cf::object::player::goto {
1814	my ($self, $path, $x, $y) = @_;	2594	my ($self, $path, $x, $y, $check, $done) = @_;
1815		2595
1816	$path = new cf::path $path;	2596	# do generation counting so two concurrent goto's will be executed in-order
		2597	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1817		2598
1818	$self->enter_link;	2599	$self->enter_link;
1819		2600
1820	(async {	2601	(async {
1821	my $map = cf::map::find $path->as_string;	2602	$Coro::current->{desc} = "player::goto $path $x $y";
1822	$map = $map->{path}->customise_for ($map, $self) if $map;
1823		2603
1824	# warn "entering ", $map->path, " at ($x, $y)\n"	2604	# *tag paths override both path and x|y
		2605	if ($path =~ /^\*(.*)$/) {
		2606	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2607	my $ob = $obs[rand @obs];
		2608
		2609	# see if we actually can go there
		2610	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2611	$ob = $obs[rand @obs];
		2612	} else {
		2613	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2614	}
		2615	# else put us there anyways for now #d#
		2616
		2617	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2618	} else {
		2619	($path, $x, $y) = (undef, undef, undef);
		2620	}
		2621	}
		2622
		2623	my $map = eval {
		2624	my $map = defined $path ? cf::map::find $path : undef;
		2625
1825	# if $map;	2626	if ($map) {
1826		2627	$map = $map->customise_for ($self);
		2628	$map = $check->($map) if $check && $map;
		2629	} else {
1827	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2630	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2631	}
1828		2632
		2633	$map
		2634	};
		2635
		2636	if ($@) {
		2637	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2638	LOG llevError | logBacktrace, Carp::longmess $@;
		2639	}
		2640
		2641	if ($gen == $self->{_goto_generation}) {
		2642	delete $self->{_goto_generation};
1829	$self->leave_link ($map, $x, $y);	2643	$self->leave_link ($map, $x, $y);
		2644	}
		2645
		2646	$done->() if $done;
1830	})->prio (1);	2647	})->prio (1);
1831	}	2648	}
1832		2649
1833	=item $player_object->enter_exit ($exit_object)	2650	=item $player_object->enter_exit ($exit_object)
1834		2651
…		…
1836		2653
1837	sub parse_random_map_params {	2654	sub parse_random_map_params {
1838	my ($spec) = @_;	2655	my ($spec) = @_;
1839		2656
1840	my $rmp = { # defaults	2657	my $rmp = { # defaults
1841	xsize => 10,	2658	xsize => (cf::rndm 15, 40),
1842	ysize => 10,	2659	ysize => (cf::rndm 15, 40),
		2660	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2661	#layout => string,
1843	};	2662	};
1844		2663
1845	for (split /\n/, $spec) {	2664	for (split /\n/, $spec) {
1846	my ($k, $v) = split /\s+/, $_, 2;	2665	my ($k, $v) = split /\s+/, $_, 2;
1847		2666
…		…
1851	$rmp	2670	$rmp
1852	}	2671	}
1853		2672
1854	sub prepare_random_map {	2673	sub prepare_random_map {
1855	my ($exit) = @_;	2674	my ($exit) = @_;
		2675
		2676	my $guard = cf::lock_acquire "exit_prepare:$exit";
1856		2677
1857	# all this does is basically replace the /! path by	2678	# all this does is basically replace the /! path by
1858	# a new random map path (?random/...) with a seed	2679	# a new random map path (?random/...) with a seed
1859	# that depends on the exit object	2680	# that depends on the exit object
1860		2681
1861	my $rmp = parse_random_map_params $exit->msg;	2682	my $rmp = parse_random_map_params $exit->msg;
1862		2683
1863	if ($exit->map) {	2684	if ($exit->map) {
1864	$rmp->{region} = $exit->map->region_name;	2685	$rmp->{region} = $exit->region->name;
1865	$rmp->{origin_map} = $exit->map->path;	2686	$rmp->{origin_map} = $exit->map->path;
1866	$rmp->{origin_x} = $exit->x;	2687	$rmp->{origin_x} = $exit->x;
1867	$rmp->{origin_y} = $exit->y;	2688	$rmp->{origin_y} = $exit->y;
1868	}	2689	}
1869		2690
1870	$rmp->{random_seed} ||= $exit->random_seed;	2691	$rmp->{random_seed} ||= $exit->random_seed;
1871		2692
1872	my $data = cf::to_json $rmp;	2693	my $data = cf::encode_json $rmp;
1873	my $md5 = Digest::MD5::md5_hex $data;	2694	my $md5 = Digest::MD5::md5_hex $data;
		2695	my $meta = "$RANDOMDIR/$md5.meta";
1874		2696
1875	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2697	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1876	aio_write $fh, 0, (length $data), $data, 0;	2698	aio_write $fh, 0, (length $data), $data, 0;
		2699	undef $fh;
		2700	aio_rename "$meta~", $meta;
1877		2701
1878	$exit->slaying ("?random/$md5");	2702	$exit->slaying ("?random/$md5");
1879	$exit->msg (undef);	2703	$exit->msg (undef);
1880	}	2704	}
1881	}	2705	}
…		…
1883	sub cf::object::player::enter_exit {	2707	sub cf::object::player::enter_exit {
1884	my ($self, $exit) = @_;	2708	my ($self, $exit) = @_;
1885		2709
1886	return unless $self->type == cf::PLAYER;	2710	return unless $self->type == cf::PLAYER;
1887		2711
		2712	if ($exit->slaying eq "/!") {
		2713	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2714	# the problem is that $exit might not survive long enough
		2715	# so it needs to be done right now, right here
		2716	cf::sync_job { prepare_random_map $exit };
		2717	}
		2718
		2719	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2720	my $hp = $exit->stats->hp;
		2721	my $sp = $exit->stats->sp;
		2722
1888	$self->enter_link;	2723	$self->enter_link;
1889		2724
		2725	# if exit is damned, update players death & WoR home-position
		2726	$self->contr->savebed ($slaying, $hp, $sp)
		2727	if $exit->flag (FLAG_DAMNED);
		2728
1890	(async {	2729	(async {
		2730	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2731
1891	$self->deactivate_recursive; # just to be sure	2732	$self->deactivate_recursive; # just to be sure
1892	unless (eval {	2733	unless (eval {
1893	prepare_random_map $exit	2734	$self->goto ($slaying, $hp, $sp);
1894	if $exit->slaying eq "/!";
1895
1896	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1897	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1898		2735
1899	1;	2736	1;
1900	}) {	2737	}) {
1901	$self->message ("Something went wrong deep within the crossfire server. "	2738	$self->message ("Something went wrong deep within the crossfire server. "
1902	. "I'll try to bring you back to the map you were before. "	2739	. "I'll try to bring you back to the map you were before. "
1903	. "Please report this to the dungeon master!",	2740	. "Please report this to the dungeon master!",
1904	cf::NDI_UNIQUE | cf::NDI_RED);	2741	cf::NDI_UNIQUE | cf::NDI_RED);
1905		2742
1906	warn "ERROR in enter_exit: $@";	2743	warn "ERROR in enter_exit: $@";
1907	$self->leave_link;	2744	$self->leave_link;
1908	}	2745	}
1909	})->prio (1);	2746	})->prio (1);
…		…
1922		2759
1923	sub cf::client::send_drawinfo {	2760	sub cf::client::send_drawinfo {
1924	my ($self, $text, $flags) = @_;	2761	my ($self, $text, $flags) = @_;
1925		2762
1926	utf8::encode $text;	2763	utf8::encode $text;
1927	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2764	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1928	}	2765	}
1929		2766
		2767	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2768
		2769	Send a drawinfo or msg packet to the client, formatting the msg for the
		2770	client if neccessary. C<$type> should be a string identifying the type of
		2771	the message, with C<log> being the default. If C<$color> is negative, suppress
		2772	the message unless the client supports the msg packet.
		2773
		2774	=cut
		2775
		2776	# non-persistent channels (usually the info channel)
		2777	our %CHANNEL = (
		2778	"c/identify" => {
		2779	id => "infobox",
		2780	title => "Identify",
		2781	reply => undef,
		2782	tooltip => "Items recently identified",
		2783	},
		2784	"c/examine" => {
		2785	id => "infobox",
		2786	title => "Examine",
		2787	reply => undef,
		2788	tooltip => "Signs and other items you examined",
		2789	},
		2790	"c/book" => {
		2791	id => "infobox",
		2792	title => "Book",
		2793	reply => undef,
		2794	tooltip => "The contents of a note or book",
		2795	},
		2796	"c/lookat" => {
		2797	id => "infobox",
		2798	title => "Look",
		2799	reply => undef,
		2800	tooltip => "What you saw there",
		2801	},
		2802	"c/who" => {
		2803	id => "infobox",
		2804	title => "Players",
		2805	reply => undef,
		2806	tooltip => "Shows players who are currently online",
		2807	},
		2808	"c/body" => {
		2809	id => "infobox",
		2810	title => "Body Parts",
		2811	reply => undef,
		2812	tooltip => "Shows which body parts you posess and are available",
		2813	},
		2814	"c/uptime" => {
		2815	id => "infobox",
		2816	title => "Uptime",
		2817	reply => undef,
		2818	tooltip => "How long the server has been running since last restart",
		2819	},
		2820	"c/mapinfo" => {
		2821	id => "infobox",
		2822	title => "Map Info",
		2823	reply => undef,
		2824	tooltip => "Information related to the maps",
		2825	},
		2826	);
		2827
		2828	sub cf::client::send_msg {
		2829	my ($self, $channel, $msg, $color, @extra) = @_;
		2830
		2831	$msg = $self->pl->expand_cfpod ($msg);
		2832
		2833	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2834
		2835	# check predefined channels, for the benefit of C
		2836	if ($CHANNEL{$channel}) {
		2837	$channel = $CHANNEL{$channel};
		2838
		2839	$self->ext_msg (channel_info => $channel)
		2840	if $self->can_msg;
		2841
		2842	$channel = $channel->{id};
		2843
		2844	} elsif (ref $channel) {
		2845	# send meta info to client, if not yet sent
		2846	unless (exists $self->{channel}{$channel->{id}}) {
		2847	$self->{channel}{$channel->{id}} = $channel;
		2848	$self->ext_msg (channel_info => $channel)
		2849	if $self->can_msg;
		2850	}
		2851
		2852	$channel = $channel->{id};
		2853	}
		2854
		2855	return unless @extra || length $msg;
		2856
		2857	if ($self->can_msg) {
		2858	# default colour, mask it out
		2859	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2860	if $color & cf::NDI_DEF;
		2861
		2862	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2863	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2864	} else {
		2865	if ($color >= 0) {
		2866	# replace some tags by gcfclient-compatible ones
		2867	for ($msg) {
		2868	1 while
		2869	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2870	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2871	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2872	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2873	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2874	}
		2875
		2876	$color &= cf::NDI_COLOR_MASK;
		2877
		2878	utf8::encode $msg;
		2879
		2880	if (0 && $msg =~ /\[/) {
		2881	# COMMAND/INFO
		2882	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2883	} else {
		2884	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2885	$self->send_packet ("drawinfo $color $msg")
		2886	}
		2887	}
		2888	}
		2889	}
		2890
		2891	=item $client->ext_msg ($type, @msg)
		2892
		2893	Sends an ext event to the client.
		2894
		2895	=cut
		2896
		2897	sub cf::client::ext_msg($$@) {
		2898	my ($self, $type, @msg) = @_;
		2899
		2900	if ($self->extcmd == 2) {
		2901	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2902	} elsif ($self->extcmd == 1) { # TODO: remove
		2903	push @msg, msgtype => "event_$type";
		2904	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2905	}
		2906	}
		2907
		2908	=item $client->ext_reply ($msgid, @msg)
		2909
		2910	Sends an ext reply to the client.
		2911
		2912	=cut
		2913
		2914	sub cf::client::ext_reply($$@) {
		2915	my ($self, $id, @msg) = @_;
		2916
		2917	if ($self->extcmd == 2) {
		2918	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2919	} elsif ($self->extcmd == 1) {
		2920	#TODO: version 1, remove
		2921	unshift @msg, msgtype => "reply", msgid => $id;
		2922	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2923	}
		2924	}
1930		2925
1931	=item $success = $client->query ($flags, "text", \&cb)	2926	=item $success = $client->query ($flags, "text", \&cb)
1932		2927
1933	Queues a query to the client, calling the given callback with	2928	Queues a query to the client, calling the given callback with
1934	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2929	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1935	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2930	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1936		2931
1937	Queries can fail, so check the return code. Or don't, as queries will become	2932	Queries can fail, so check the return code. Or don't, as queries will
1938	reliable at some point in the future.	2933	become reliable at some point in the future.
1939		2934
1940	=cut	2935	=cut
1941		2936
1942	sub cf::client::query {	2937	sub cf::client::query {
1943	my ($self, $flags, $text, $cb) = @_;	2938	my ($self, $flags, $text, $cb) = @_;
…		…
1951	utf8::encode $text;	2946	utf8::encode $text;
1952	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2947	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1953		2948
1954	$self->send_packet ($self->{query_queue}[0][0])	2949	$self->send_packet ($self->{query_queue}[0][0])
1955	if @{ $self->{query_queue} } == 1;	2950	if @{ $self->{query_queue} } == 1;
		2951
		2952	1
1956	}	2953	}
1957		2954
1958	cf::client->attach (	2955	cf::client->attach (
		2956	on_connect => sub {
		2957	my ($ns) = @_;
		2958
		2959	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2960	},
1959	on_reply => sub {	2961	on_reply => sub {
1960	my ($ns, $msg) = @_;	2962	my ($ns, $msg) = @_;
1961		2963
1962	# this weird shuffling is so that direct followup queries	2964	# this weird shuffling is so that direct followup queries
1963	# get handled first	2965	# get handled first
1964	my $queue = delete $ns->{query_queue}	2966	my $queue = delete $ns->{query_queue}
1965	or return; # be conservative, not sure how that can happen, but we saw a crash here	2967	or return; # be conservative, not sure how that can happen, but we saw a crash here
1966		2968
1967	(shift @$queue)->[1]->($msg);	2969	(shift @$queue)->[1]->($msg);
		2970	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1968		2971
1969	push @{ $ns->{query_queue} }, @$queue;	2972	push @{ $ns->{query_queue} }, @$queue;
1970		2973
1971	if (@{ $ns->{query_queue} } == @$queue) {	2974	if (@{ $ns->{query_queue} } == @$queue) {
1972	if (@$queue) {	2975	if (@$queue) {
…		…
1974	} else {	2977	} else {
1975	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2978	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1976	}	2979	}
1977	}	2980	}
1978	},	2981	},
		2982	on_exticmd => sub {
		2983	my ($ns, $buf) = @_;
		2984
		2985	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2986
		2987	if (ref $msg) {
		2988	my ($type, $reply, @payload) =
		2989	"ARRAY" eq ref $msg
		2990	? @$msg
		2991	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2992
		2993	my @reply;
		2994
		2995	if (my $cb = $EXTICMD{$type}) {
		2996	@reply = $cb->($ns, @payload);
		2997	}
		2998
		2999	$ns->ext_reply ($reply, @reply)
		3000	if $reply;
		3001
		3002	} else {
		3003	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3004	}
		3005
		3006	cf::override;
		3007	},
1979	);	3008	);
1980		3009
1981	=item $client->async (\&cb)	3010	=item $client->async (\&cb)
1982		3011
1983	Create a new coroutine, running the specified callback. The coroutine will	3012	Create a new coroutine, running the specified callback. The coroutine will
…		…
2024	our $safe = new Safe "safe";	3053	our $safe = new Safe "safe";
2025	our $safe_hole = new Safe::Hole;	3054	our $safe_hole = new Safe::Hole;
2026		3055
2027	$SIG{FPE} = 'IGNORE';	3056	$SIG{FPE} = 'IGNORE';
2028		3057
2029	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3058	$safe->permit_only (Opcode::opset qw(
		3059	:base_core :base_mem :base_orig :base_math
		3060	grepstart grepwhile mapstart mapwhile
		3061	sort time
		3062	));
2030		3063
2031	# here we export the classes and methods available to script code	3064	# here we export the classes and methods available to script code
2032		3065
2033	=pod	3066	=pod
2034		3067
2035	The following fucntions and emthods are available within a safe environment:	3068	The following functions and methods are available within a safe environment:
2036		3069
2037	cf::object contr pay_amount pay_player map	3070	cf::object
		3071	contr pay_amount pay_player map x y force_find force_add destroy
		3072	insert remove name archname title slaying race decrease_ob_nr
		3073
2038	cf::object::player player	3074	cf::object::player
2039	cf::player peaceful	3075	player
2040	cf::map trigger	3076
		3077	cf::player
		3078	peaceful
		3079
		3080	cf::map
		3081	trigger
2041		3082
2042	=cut	3083	=cut
2043		3084
2044	for (	3085	for (
2045	["cf::object" => qw(contr pay_amount pay_player map)],	3086	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3087	insert remove inv name archname title slaying race
		3088	decrease_ob_nr destroy)],
2046	["cf::object::player" => qw(player)],	3089	["cf::object::player" => qw(player)],
2047	["cf::player" => qw(peaceful)],	3090	["cf::player" => qw(peaceful)],
2048	["cf::map" => qw(trigger)],	3091	["cf::map" => qw(trigger)],
2049	) {	3092	) {
2050	no strict 'refs';	3093	no strict 'refs';
…		…
2121	=back	3164	=back
2122		3165
2123	=cut	3166	=cut
2124		3167
2125	#############################################################################	3168	#############################################################################
		3169	# the server's init and main functions
2126		3170
2127	=head2 EXTENSION DATABASE SUPPORT	3171	sub load_facedata($) {
		3172	my ($path) = @_;
2128		3173
2129	Crossfire maintains a very simple database for extension use. It can	3174	# HACK to clear player env face cache, we need some signal framework
2130	currently store anything that can be serialised using Storable, which	3175	# for this (global event?)
2131	excludes objects.	3176	%ext::player_env::MUSIC_FACE_CACHE = ();
2132		3177
2133	The parameter C<$family> should best start with the name of the extension	3178	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2134	using it, it should be unique.
2135		3179
2136	=over 4	3180	warn "loading facedata from $path\n";
2137		3181
2138	=item $hashref = cf::db_get $family	3182	my $facedata;
		3183	0 < aio_load $path, $facedata
		3184	or die "$path: $!";
2139		3185
2140	Return a hashref for use by the extension C<$family>, which can be	3186	$facedata = Coro::Storable::thaw $facedata;
2141	modified. After modifications, you have to call C<cf::db_dirty> or
2142	C<cf::db_sync>.
2143		3187
2144	=item $value = cf::db_get $family => $key	3188	$facedata->{version} == 2
		3189	or cf::cleanup "$path: version mismatch, cannot proceed.";
2145		3190
2146	Returns a single value from the database	3191	# patch in the exptable
2147		3192	$facedata->{resource}{"res/exp_table"} = {
2148	=item cf::db_put $family => $hashref	3193	type => FT_RSRC,
2149		3194	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2150	Stores the given family hashref into the database. Updates are delayed, if
2151	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2152
2153	=item cf::db_put $family => $key => $value
2154
2155	Stores the given C<$value> in the family hash. Updates are delayed, if you
2156	want the data to be synced to disk immediately, use C<cf::db_sync>.
2157
2158	=item cf::db_dirty
2159
2160	Marks the database as dirty, to be updated at a later time.
2161
2162	=item cf::db_sync
2163
2164	Immediately write the database to disk I<if it is dirty>.
2165
2166	=cut
2167
2168	our $DB;
2169
2170	{
2171	my $path = cf::localdir . "/database.pst";
2172
2173	sub db_load() {
2174	$DB = stat $path ? Storable::retrieve $path : { };
2175	}
2176
2177	my $pid;
2178
2179	sub db_save() {
2180	waitpid $pid, 0 if $pid;
2181	if (0 == ($pid = fork)) {
2182	$DB->{_meta}{version} = 1;
2183	Storable::nstore $DB, "$path~";
2184	rename "$path~", $path;
2185	cf::_exit 0 if defined $pid;
2186	}
2187	}
2188
2189	my $dirty;
2190
2191	sub db_sync() {
2192	db_save if $dirty;
2193	undef $dirty;
2194	}
2195
2196	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2197	db_sync;
2198	});	3195	};
		3196	cf::cede_to_tick;
2199		3197
2200	sub db_dirty() {
2201	$dirty = 1;
2202	$idle->start;
2203	}	3198	{
		3199	my $faces = $facedata->{faceinfo};
2204		3200
2205	sub db_get($;$) {	3201	while (my ($face, $info) = each %$faces) {
2206	@_ >= 2	3202	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2207	? $DB->{$_[0]}{$_[1]}
2208	: ($DB->{$_[0]} ||= { })
2209	}
2210		3203
2211	sub db_put($$;$) {	3204	cf::face::set_visibility $idx, $info->{visibility};
2212	if (@_ >= 3) {	3205	cf::face::set_magicmap $idx, $info->{magicmap};
2213	$DB->{$_[0]}{$_[1]} = $_[2];	3206	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2214	} else {	3207	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2215	$DB->{$_[0]} = $_[1];
2216	}
2217	db_dirty;
2218	}
2219		3208
2220	cf::global->attach (	3209	cf::cede_to_tick;
2221	prio => 10000,
2222	on_cleanup => sub {
2223	db_sync;
2224	},	3210	}
2225	);
2226	}
2227		3211
2228	#############################################################################	3212	while (my ($face, $info) = each %$faces) {
2229	# the server's main()	3213	next unless $info->{smooth};
2230		3214
2231	sub cfg_load {	3215	my $idx = cf::face::find $face
		3216	or next;
		3217
		3218	if (my $smooth = cf::face::find $info->{smooth}) {
		3219	cf::face::set_smooth $idx, $smooth;
		3220	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3221	} else {
		3222	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3223	}
		3224
		3225	cf::cede_to_tick;
		3226	}
		3227	}
		3228
		3229	{
		3230	my $anims = $facedata->{animinfo};
		3231
		3232	while (my ($anim, $info) = each %$anims) {
		3233	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3234	cf::cede_to_tick;
		3235	}
		3236
		3237	cf::anim::invalidate_all; # d'oh
		3238	}
		3239
		3240	{
		3241	# TODO: for gcfclient pleasure, we should give resources
		3242	# that gcfclient doesn't grok a >10000 face index.
		3243	my $res = $facedata->{resource};
		3244
		3245	while (my ($name, $info) = each %$res) {
		3246	if (defined $info->{type}) {
		3247	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3248	my $data;
		3249
		3250	if ($info->{type} & 1) {
		3251	# prepend meta info
		3252
		3253	my $meta = $enc->encode ({
		3254	name => $name,
		3255	%{ $info->{meta} || {} },
		3256	});
		3257
		3258	$data = pack "(w/a*)*", $meta, $info->{data};
		3259	} else {
		3260	$data = $info->{data};
		3261	}
		3262
		3263	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3264	cf::face::set_type $idx, $info->{type};
		3265	} else {
		3266	$RESOURCE{$name} = $info;
		3267	}
		3268
		3269	cf::cede_to_tick;
		3270	}
		3271	}
		3272
		3273	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3274
		3275	1
		3276	}
		3277
		3278	cf::global->attach (on_resource_update => sub {
		3279	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3280	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3281
		3282	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3283	my $sound = $soundconf->{compat}[$_]
		3284	or next;
		3285
		3286	my $face = cf::face::find "sound/$sound->[1]";
		3287	cf::sound::set $sound->[0] => $face;
		3288	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3289	}
		3290
		3291	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3292	my $face = cf::face::find "sound/$v";
		3293	cf::sound::set $k => $face;
		3294	}
		3295	}
		3296	});
		3297
		3298	register_exticmd fx_want => sub {
		3299	my ($ns, $want) = @_;
		3300
		3301	while (my ($k, $v) = each %$want) {
		3302	$ns->fx_want ($k, $v);
		3303	}
		3304	};
		3305
		3306	sub reload_regions {
		3307	# HACK to clear player env face cache, we need some signal framework
		3308	# for this (global event?)
		3309	%ext::player_env::MUSIC_FACE_CACHE = ();
		3310
		3311	load_resource_file "$MAPDIR/regions"
		3312	or die "unable to load regions file\n";
		3313
		3314	for (cf::region::list) {
		3315	$_->{match} = qr/$_->{match}/
		3316	if exists $_->{match};
		3317	}
		3318	}
		3319
		3320	sub reload_facedata {
		3321	load_facedata "$DATADIR/facedata"
		3322	or die "unable to load facedata\n";
		3323	}
		3324
		3325	sub reload_archetypes {
		3326	load_resource_file "$DATADIR/archetypes"
		3327	or die "unable to load archetypes\n";
		3328	#d# NEED to laod twice to resolve forward references
		3329	# this really needs to be done in an extra post-pass
		3330	# (which needs to be synchronous, so solve it differently)
		3331	load_resource_file "$DATADIR/archetypes"
		3332	or die "unable to load archetypes\n";
		3333	}
		3334
		3335	sub reload_treasures {
		3336	load_resource_file "$DATADIR/treasures"
		3337	or die "unable to load treasurelists\n";
		3338	}
		3339
		3340	sub reload_resources {
		3341	warn "reloading resource files...\n";
		3342
		3343	reload_regions;
		3344	reload_facedata;
		3345	#reload_archetypes;#d#
		3346	reload_archetypes;
		3347	reload_treasures;
		3348
		3349	warn "finished reloading resource files\n";
		3350	}
		3351
		3352	sub init {
		3353	reload_resources;
		3354	}
		3355
		3356	sub reload_config {
2232	open my $fh, "<:utf8", cf::confdir . "/config"	3357	open my $fh, "<:utf8", "$CONFDIR/config"
2233	or return;	3358	or return;
2234		3359
2235	local $/;	3360	local $/;
2236	*CFG = YAML::Syck::Load <$fh>;	3361	*CFG = YAML::Load <$fh>;
2237		3362
2238	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3363	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2239		3364
2240	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3365	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2241	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3366	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2251		3376
2252	sub main {	3377	sub main {
2253	# we must not ever block the main coroutine	3378	# we must not ever block the main coroutine
2254	local $Coro::idle = sub {	3379	local $Coro::idle = sub {
2255	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3380	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2256	async { Event::one_event };	3381	(async {
		3382	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3383	EV::loop EV::LOOP_ONESHOT;
		3384	})->prio (Coro::PRIO_MAX);
2257	};	3385	};
2258		3386
2259	cfg_load;	3387	reload_config;
2260	db_load;	3388	db_init;
2261	load_extensions;	3389	load_extensions;
		3390
		3391	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3392	evthread_start IO::AIO::poll_fileno;
2262	Event::loop;	3393	EV::loop;
2263	}	3394	}
2264		3395
2265	#############################################################################	3396	#############################################################################
2266	# initialisation and cleanup	3397	# initialisation and cleanup
2267		3398
2268	# install some emergency cleanup handlers	3399	# install some emergency cleanup handlers
2269	BEGIN {	3400	BEGIN {
		3401	our %SIGWATCHER = ();
2270	for my $signal (qw(INT HUP TERM)) {	3402	for my $signal (qw(INT HUP TERM)) {
2271	Event->signal (	3403	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2272	data => WF_AUTOCANCEL,
2273	signal => $signal,
2274	cb => sub {
2275	cf::cleanup "SIG$signal";	3404	cf::cleanup "SIG$signal";
2276	},
2277	);	3405	};
		3406	}
		3407	}
		3408
		3409	sub write_runtime {
		3410	my $runtime = "$LOCALDIR/runtime";
		3411
		3412	# first touch the runtime file to show we are still running:
		3413	# the fsync below can take a very very long time.
		3414
		3415	IO::AIO::aio_utime $runtime, undef, undef;
		3416
		3417	my $guard = cf::lock_acquire "write_runtime";
		3418
		3419	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3420	or return;
		3421
		3422	my $value = $cf::RUNTIME + 90 + 10;
		3423	# 10 is the runtime save interval, for a monotonic clock
		3424	# 60 allows for the watchdog to kill the server.
		3425
		3426	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3427	and return;
		3428
		3429	# always fsync - this file is important
		3430	aio_fsync $fh
		3431	and return;
		3432
		3433	# touch it again to show we are up-to-date
		3434	aio_utime $fh, undef, undef;
		3435
		3436	close $fh
		3437	or return;
		3438
		3439	aio_rename "$runtime~", $runtime
		3440	and return;
		3441
		3442	warn "runtime file written.\n";
		3443
2278	}	3444	1
		3445	}
		3446
		3447	our $uuid_lock;
		3448	our $uuid_skip;
		3449
		3450	sub write_uuid_sync($) {
		3451	$uuid_skip ||= $_[0];
		3452
		3453	return if $uuid_lock;
		3454	local $uuid_lock = 1;
		3455
		3456	my $uuid = "$LOCALDIR/uuid";
		3457
		3458	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3459	or return;
		3460
		3461	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3462	$uuid_skip = 0;
		3463
		3464	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3465	and return;
		3466
		3467	# always fsync - this file is important
		3468	aio_fsync $fh
		3469	and return;
		3470
		3471	close $fh
		3472	or return;
		3473
		3474	aio_rename "$uuid~", $uuid
		3475	and return;
		3476
		3477	warn "uuid file written ($value).\n";
		3478
		3479	1
		3480
		3481	}
		3482
		3483	sub write_uuid($$) {
		3484	my ($skip, $sync) = @_;
		3485
		3486	$sync ? write_uuid_sync $skip
		3487	: async { write_uuid_sync $skip };
2279	}	3488	}
2280		3489
2281	sub emergency_save() {	3490	sub emergency_save() {
2282	my $freeze_guard = cf::freeze_mainloop;	3491	my $freeze_guard = cf::freeze_mainloop;
2283		3492
2284	warn "enter emergency perl save\n";	3493	warn "enter emergency perl save\n";
2285		3494
2286	cf::sync_job {	3495	cf::sync_job {
2287	# use a peculiar iteration method to avoid tripping on perl	3496	# use a peculiar iteration method to avoid tripping on perl
2288	# refcount bugs in for. also avoids problems with players	3497	# refcount bugs in for. also avoids problems with players
2289	# and maps saved/Destroyed asynchronously.	3498	# and maps saved/destroyed asynchronously.
2290	warn "begin emergency player save\n";	3499	warn "begin emergency player save\n";
2291	for my $login (keys %cf::PLAYER) {	3500	for my $login (keys %cf::PLAYER) {
2292	my $pl = $cf::PLAYER{$login} or next;	3501	my $pl = $cf::PLAYER{$login} or next;
2293	$pl->valid or next;	3502	$pl->valid or next;
		3503	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2294	$pl->save;	3504	$pl->save;
2295	}	3505	}
2296	warn "end emergency player save\n";	3506	warn "end emergency player save\n";
2297		3507
2298	warn "begin emergency map save\n";	3508	warn "begin emergency map save\n";
…		…
2300	my $map = $cf::MAP{$path} or next;	3510	my $map = $cf::MAP{$path} or next;
2301	$map->valid or next;	3511	$map->valid or next;
2302	$map->save;	3512	$map->save;
2303	}	3513	}
2304	warn "end emergency map save\n";	3514	warn "end emergency map save\n";
		3515
		3516	warn "begin emergency database checkpoint\n";
		3517	BDB::db_env_txn_checkpoint $DB_ENV;
		3518	warn "end emergency database checkpoint\n";
		3519
		3520	warn "begin write uuid\n";
		3521	write_uuid_sync 1;
		3522	warn "end write uuid\n";
2305	};	3523	};
2306		3524
2307	warn "leave emergency perl save\n";	3525	warn "leave emergency perl save\n";
2308	}	3526	}
2309		3527
		3528	sub post_cleanup {
		3529	my ($make_core) = @_;
		3530
		3531	warn Carp::longmess "post_cleanup backtrace"
		3532	if $make_core;
		3533	}
		3534
2310	sub reload() {	3535	sub do_reload_perl() {
2311	# can/must only be called in main	3536	# can/must only be called in main
2312	if ($Coro::current != $Coro::main) {	3537	if ($Coro::current != $Coro::main) {
2313	warn "can only reload from main coroutine\n";	3538	warn "can only reload from main coroutine";
2314	return;	3539	return;
2315	}	3540	}
2316		3541
2317	warn "reloading...";	3542	warn "reloading...";
2318		3543
2319	warn "freezing server";	3544	warn "entering sync_job";
2320	my $guard = freeze_mainloop;	3545
		3546	cf::sync_job {
		3547	cf::write_runtime; # external watchdog should not bark
2321	cf::emergency_save;	3548	cf::emergency_save;
		3549	cf::write_runtime; # external watchdog should not bark
2322		3550
2323	warn "sync database to disk";	3551	warn "syncing database to disk";
2324	cf::db_sync;	3552	BDB::db_env_txn_checkpoint $DB_ENV;
2325	IO::AIO::flush;
2326		3553
2327	eval {
2328	# if anything goes wrong in here, we should simply crash as we already saved	3554	# if anything goes wrong in here, we should simply crash as we already saved
2329		3555
2330	warn "cancel all watchers";	3556	warn "flushing outstanding aio requests";
2331	for (Event::all_watchers) {	3557	for (;;) {
2332	$_->cancel if $_->data & WF_AUTOCANCEL;	3558	BDB::flush;
		3559	IO::AIO::flush;
		3560	Coro::cede_notself;
		3561	last unless IO::AIO::nreqs || BDB::nreqs;
		3562	warn "iterate...";
2333	}	3563	}
2334		3564
		3565	++$RELOAD;
		3566
2335	warn "cancel all extension coros";	3567	warn "cancelling all extension coros";
2336	$_->cancel for values %EXT_CORO;	3568	$_->cancel for values %EXT_CORO;
2337	%EXT_CORO = ();	3569	%EXT_CORO = ();
2338		3570
2339	warn "remove commands";	3571	warn "removing commands";
2340	%COMMAND = ();	3572	%COMMAND = ();
2341		3573
2342	warn "remove ext commands";	3574	warn "removing ext/exti commands";
2343	%EXTCMD = ();	3575	%EXTCMD = ();
		3576	%EXTICMD = ();
2344		3577
2345	warn "unload/nuke all extensions";	3578	warn "unloading/nuking all extensions";
2346	for my $pkg (@EXTS) {	3579	for my $pkg (@EXTS) {
2347	warn "... unloading $pkg";	3580	warn "... unloading $pkg";
2348		3581
2349	if (my $cb = $pkg->can ("unload")) {	3582	if (my $cb = $pkg->can ("unload")) {
2350	eval {	3583	eval {
…		…
2355		3588
2356	warn "... nuking $pkg";	3589	warn "... nuking $pkg";
2357	Symbol::delete_package $pkg;	3590	Symbol::delete_package $pkg;
2358	}	3591	}
2359		3592
2360	warn "unload all perl modules loaded from $LIBDIR";	3593	warn "unloading all perl modules loaded from $LIBDIR";
2361	while (my ($k, $v) = each %INC) {	3594	while (my ($k, $v) = each %INC) {
2362	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3595	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2363		3596
2364	warn "removing <$k>";	3597	warn "... unloading $k";
2365	delete $INC{$k};	3598	delete $INC{$k};
2366		3599
2367	$k =~ s/\.pm$//;	3600	$k =~ s/\.pm$//;
2368	$k =~ s/\//::/g;	3601	$k =~ s/\//::/g;
2369		3602
…		…
2372	}	3605	}
2373		3606
2374	Symbol::delete_package $k;	3607	Symbol::delete_package $k;
2375	}	3608	}
2376		3609
2377	warn "get rid of safe::, as good as possible";	3610	warn "getting rid of safe::, as good as possible";
2378	Symbol::delete_package "safe::$_"	3611	Symbol::delete_package "safe::$_"
2379	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3612	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2380		3613
2381	warn "unload cf.pm \"a bit\"";	3614	warn "unloading cf.pm \"a bit\"";
2382	delete $INC{"cf.pm"};	3615	delete $INC{"cf.pm"};
		3616	delete $INC{"cf/pod.pm"};
2383		3617
2384	# don't, removes xs symbols, too,	3618	# don't, removes xs symbols, too,
2385	# and global variables created in xs	3619	# and global variables created in xs
2386	#Symbol::delete_package __PACKAGE__;	3620	#Symbol::delete_package __PACKAGE__;
2387		3621
		3622	warn "unload completed, starting to reload now";
		3623
2388	warn "reloading cf.pm";	3624	warn "reloading cf.pm";
2389	require cf;	3625	require cf;
2390	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3626	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2391		3627
2392	warn "load config and database again";	3628	warn "loading config and database again";
2393	cf::cfg_load;	3629	cf::reload_config;
2394	cf::db_load;
2395		3630
2396	warn "load extensions";	3631	warn "loading extensions";
2397	cf::load_extensions;	3632	cf::load_extensions;
2398		3633
2399	warn "reattach attachments to objects/players";	3634	warn "reattaching attachments to objects/players";
2400	_global_reattach;	3635	_global_reattach; # objects, sockets
2401	warn "reattach attachments to maps";	3636	warn "reattaching attachments to maps";
2402	reattach $_ for values %MAP;	3637	reattach $_ for values %MAP;
		3638	warn "reattaching attachments to players";
		3639	reattach $_ for values %PLAYER;
		3640
		3641	warn "leaving sync_job";
		3642
		3643	1
		3644	} or do {
		3645	warn $@;
		3646	cf::cleanup "error while reloading, exiting.";
2403	};	3647	};
2404
2405	if ($@) {
2406	warn $@;
2407	warn "error while reloading, exiting.";
2408	exit 1;
2409	}
2410		3648
2411	warn "reloaded";	3649	warn "reloaded";
2412	};	3650	};
2413		3651
2414	#############################################################################	3652	our $RELOAD_WATCHER; # used only during reload
2415		3653
2416	unless ($LINK_MAP) {	3654	sub reload_perl() {
2417	$LINK_MAP = cf::map::new;	3655	# doing reload synchronously and two reloads happen back-to-back,
		3656	# coro crashes during coro_state_free->destroy here.
2418		3657
2419	$LINK_MAP->width (41);	3658	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2420	$LINK_MAP->height (41);	3659	do_reload_perl;
2421	$LINK_MAP->alloc;	3660	undef $RELOAD_WATCHER;
2422	$LINK_MAP->path ("{link}");	3661	};
2423	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2424	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2425
2426	# dirty hack because... archetypes are not yet loaded
2427	Event->timer (
2428	after => 10,
2429	cb => sub {
2430	$_[0]->w->cancel;
2431
2432	# provide some exits "home"
2433	my $exit = cf::object::new "exit";
2434
2435	$exit->slaying ($EMERGENCY_POSITION->[0]);
2436	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2437	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2438
2439	$LINK_MAP->insert ($exit->clone, 19, 19);
2440	$LINK_MAP->insert ($exit->clone, 19, 20);
2441	$LINK_MAP->insert ($exit->clone, 19, 21);
2442	$LINK_MAP->insert ($exit->clone, 20, 19);
2443	$LINK_MAP->insert ($exit->clone, 20, 21);
2444	$LINK_MAP->insert ($exit->clone, 21, 19);
2445	$LINK_MAP->insert ($exit->clone, 21, 20);
2446	$LINK_MAP->insert ($exit->clone, 21, 21);
2447
2448	$exit->destroy;
2449	});
2450
2451	$LINK_MAP->{deny_save} = 1;
2452	$LINK_MAP->{deny_reset} = 1;
2453
2454	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2455	}	3662	}
2456		3663
2457	register_command "reload" => sub {	3664	register_command "reload" => sub {
2458	my ($who, $arg) = @_;	3665	my ($who, $arg) = @_;
2459		3666
2460	if ($who->flag (FLAG_WIZ)) {	3667	if ($who->flag (FLAG_WIZ)) {
2461	$who->message ("start of reload.");
2462	reload;
2463	$who->message ("end of reload.");	3668	$who->message ("reloading server.");
		3669	async {
		3670	$Coro::current->{desc} = "perl_reload";
		3671	reload_perl;
		3672	};
2464	}	3673	}
2465	};	3674	};
2466		3675
2467	unshift @INC, $LIBDIR;	3676	unshift @INC, $LIBDIR;
2468		3677
2469	$TICK_WATCHER = Event->timer (	3678	my $bug_warning = 0;
2470	reentrant => 0,
2471	prio => 0,
2472	at => $NEXT_TICK || $TICK,
2473	data => WF_AUTOCANCEL,
2474	cb => sub {
2475	$NOW = Event::time;
2476		3679
		3680	our @WAIT_FOR_TICK;
		3681	our @WAIT_FOR_TICK_BEGIN;
		3682
		3683	sub wait_for_tick {
		3684	return if tick_inhibit;
		3685	return if $Coro::current == $Coro::main;
		3686
		3687	my $signal = new Coro::Signal;
		3688	push @WAIT_FOR_TICK, $signal;
		3689	$signal->wait;
		3690	}
		3691
		3692	sub wait_for_tick_begin {
		3693	return if tick_inhibit;
		3694	return if $Coro::current == $Coro::main;
		3695
		3696	my $signal = new Coro::Signal;
		3697	push @WAIT_FOR_TICK_BEGIN, $signal;
		3698	$signal->wait;
		3699	}
		3700
		3701	sub tick {
		3702	if ($Coro::current != $Coro::main) {
		3703	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3704	unless ++$bug_warning > 10;
		3705	return;
		3706	}
		3707
2477	cf::server_tick; # one server iteration	3708	cf::server_tick; # one server iteration
2478	$RUNTIME += $TICK;
2479	$NEXT_TICK += $TICK;
2480		3709
2481	$WAIT_FOR_TICK->broadcast;	3710	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2482	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3711	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2483		3712	Coro::async_pool {
2484	# if we are delayed by four ticks or more, skip them all	3713	$Coro::current->{desc} = "runtime saver";
2485	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2486
2487	$TICK_WATCHER->at ($NEXT_TICK);
2488	$TICK_WATCHER->start;
2489	},
2490	);
2491
2492	IO::AIO::max_poll_time $TICK * 0.2;
2493
2494	Event->io (
2495	fd => IO::AIO::poll_fileno,
2496	poll => 'r',
2497	prio => 5,
2498	data => WF_AUTOCANCEL,
2499	cb => \&IO::AIO::poll_cb,
2500	);
2501
2502	Event->timer (
2503	data => WF_AUTOCANCEL,
2504	after => 0,
2505	interval => 10,
2506	cb => sub {
2507	(Coro::unblock_sub {
2508	write_runtime	3714	write_runtime
2509	or warn "ERROR: unable to write runtime file: $!";	3715	or warn "ERROR: unable to write runtime file: $!";
2510	})->();	3716	};
2511	},	3717	}
2512	);	3718
		3719	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3720	$sig->send;
		3721	}
		3722	while (my $sig = shift @WAIT_FOR_TICK) {
		3723	$sig->send;
		3724	}
		3725
		3726	$LOAD = ($NOW - $TICK_START) / $TICK;
		3727	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3728
		3729	if (0) {
		3730	if ($NEXT_TICK) {
		3731	my $jitter = $TICK_START - $NEXT_TICK;
		3732	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3733	warn "jitter $JITTER\n";#d#
		3734	}
		3735	}
		3736	}
		3737
		3738	{
		3739	# configure BDB
		3740
		3741	BDB::min_parallel 8;
		3742	BDB::max_poll_reqs $TICK * 0.1;
		3743	$Coro::BDB::WATCHER->priority (1);
		3744
		3745	unless ($DB_ENV) {
		3746	$DB_ENV = BDB::db_env_create;
		3747	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3748	| BDB::LOG_AUTOREMOVE, 1);
		3749	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3750	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3751
		3752	cf::sync_job {
		3753	eval {
		3754	BDB::db_env_open
		3755	$DB_ENV,
		3756	$BDBDIR,
		3757	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3758	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3759	0666;
		3760
		3761	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3762	};
		3763
		3764	cf::cleanup "db_env_open(db): $@" if $@;
		3765	};
		3766	}
		3767
		3768	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3769	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3770	};
		3771	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3772	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3773	};
		3774	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3775	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3776	};
		3777	}
		3778
		3779	{
		3780	# configure IO::AIO
		3781
		3782	IO::AIO::min_parallel 8;
		3783	IO::AIO::max_poll_time $TICK * 0.1;
		3784	$Coro::AIO::WATCHER->priority (1);
		3785	}
		3786
		3787	my $_log_backtrace;
		3788
		3789	sub _log_backtrace {
		3790	my ($msg, @addr) = @_;
		3791
		3792	$msg =~ s/\n//;
		3793
		3794	# limit the # of concurrent backtraces
		3795	if ($_log_backtrace < 2) {
		3796	++$_log_backtrace;
		3797	async {
		3798	$Coro::current->{desc} = "abt $msg";
		3799
		3800	my @bt = fork_call {
		3801	@addr = map { sprintf "%x", $_ } @addr;
		3802	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3803	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3804	or die "addr2line: $!";
		3805
		3806	my @funcs;
		3807	my @res = <$fh>;
		3808	chomp for @res;
		3809	while (@res) {
		3810	my ($func, $line) = splice @res, 0, 2, ();
		3811	push @funcs, "[$func] $line";
		3812	}
		3813
		3814	@funcs
		3815	};
		3816
		3817	LOG llevInfo, "[ABT] $msg\n";
		3818	LOG llevInfo, "[ABT] $_\n" for @bt;
		3819	--$_log_backtrace;
		3820	};
		3821	} else {
		3822	LOG llevInfo, "[ABT] $msg\n";
		3823	LOG llevInfo, "[ABT] [suppressed]\n";
		3824	}
		3825	}
		3826
		3827	# load additional modules
		3828	use cf::pod;
2513		3829
2514	END { cf::emergency_save }	3830	END { cf::emergency_save }
2515		3831
2516	1	3832	1
2517		3833

Diff Legend

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