ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.165 by root, Fri Jan 12 22:09:22 2007 UTC vs.
Revision 1.434 by root, Thu May 29 03:27:37 2008 UTC

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

Diff Legend

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