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

Diff Legend

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