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.418 by root, Fri Apr 11 21:09:53 2008 UTC

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

Diff Legend

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