ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.420 by root, Tue Apr 15 14:21:04 2008 UTC

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

Diff Legend

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