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

Diff Legend

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