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.159 by root, Wed Jan 10 22:50:12 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
		76	our %EXT_MAP = (); # pluggable maps
42		77
		78	our $RELOAD; # number of reloads so far
43	our @EVENT;	79	our @EVENT;
44	our $LIBDIR = datadir . "/ext";
45		80
46	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(!)
47	our $TICK_WATCHER;	95	our $AIO_POLL_WATCHER;
		96	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
48	our $NEXT_TICK;	97	our $NEXT_TICK;
49	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;
50		105
51	our %CFG;	106	our %CFG;
52		107
53	our $UPTIME; $UPTIME ||= time;	108	our $UPTIME; $UPTIME ||= time;
54	our $RUNTIME;	109	our $RUNTIME;
		110	our $NOW;
55		111
56	our %PLAYER; # all users	112	our (%PLAYER, %PLAYER_LOADING); # all users
57	our %MAP; # all maps	113	our (%MAP, %MAP_LOADING ); # all maps
58	our $LINK_MAP; # the special {link} map	114	our $LINK_MAP; # the special {link} map, which is always available
59	our $RANDOM_MAPS = cf::localdir . "/random";
60		115
61	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	116	# used to convert map paths into valid unix filenames by replacing / by ∕
62	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
63		123
64	binmode STDOUT;	124	binmode STDOUT;
65	binmode STDERR;	125	binmode STDERR;
66		126
67	# read virtual server time, if available	127	# read virtual server time, if available
68	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	128	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
69	open my $fh, "<", cf::localdir . "/runtime"	129	open my $fh, "<", "$LOCALDIR/runtime"
70	or die "unable to read runtime file: $!";	130	or die "unable to read runtime file: $!";
71	$RUNTIME = <$fh> + 0.;	131	$RUNTIME = <$fh> + 0.;
72	}	132	}
73		133
74	mkdir cf::localdir;	134	mkdir $_
75	mkdir cf::localdir . "/" . cf::playerdir;	135	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
76	mkdir cf::localdir . "/" . cf::tmpdir;
77	mkdir cf::localdir . "/" . cf::uniquedir;
78	mkdir $RANDOM_MAPS;
79		136
80	# a special map that is always available
81	our $LINK_MAP;
82	our $EMERGENCY_POSITION;	137	our $EMERGENCY_POSITION;
		138
		139	sub cf::map::normalise;
83		140
84	#############################################################################	141	#############################################################################
85		142
86	=head2 GLOBAL VARIABLES	143	=head2 GLOBAL VARIABLES
87		144
…		…
94	=item $cf::RUNTIME	151	=item $cf::RUNTIME
95		152
96	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
97	every server tick.	154	every server tick.
98		155
99	=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
100		159
101	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
102	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.
103		164
104	=item $cf::NOW	165	=item $cf::NOW
105		166
106	The time of the last (current) server tick.	167	The time of the last (current) server tick.
107		168
108	=item $cf::TICK	169	=item $cf::TICK
109		170
110	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
111		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
112	=item %cf::CFG	183	=item %cf::CFG
113		184
114	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
115	from wherever your confdir points to.	186	from wherever your confdir points to.
116		187
117	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	188	=item cf::wait_for_tick, cf::wait_for_tick_begin
118		189
119	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
120	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
121	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.
122	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.
123		199
124	=back	200	=back
125		201
126	=cut	202	=cut
127		203
128	BEGIN {	204	BEGIN {
129	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
130	my $msg = join "", @_;	206	my $msg = join "", @_;
131	utf8::encode $msg;
132		207
133	$msg .= "\n"	208	$msg .= "\n"
134	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
135		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
136	LOG llevError, $msg;	213	LOG llevError, $msg;
137	};	214	};
138	}	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#?
139		231
140	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
141	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
142	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
143	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
144	@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';
145	@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)
146		239
147	# 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
148	# within the Safe compartment.	241	# within the Safe compartment.
149	for my $pkg (qw(	242	for my $pkg (qw(
150	cf::global cf::attachable	243	cf::global cf::attachable
…		…
155	)) {	248	)) {
156	no strict 'refs';	249	no strict 'refs';
157	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
158	}	251	}
159		252
160	$Event::DIED = sub {	253	$EV::DIED = sub {
161	warn "error in event callback: @_";	254	warn "error in event callback: @_";
162	};	255	};
		256
		257	#############################################################################
163		258
164	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
165		260
166	=over 4	261	=over 4
167		262
…		…
186	$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;
187	$d	282	$d
188	} || "[unable to dump $_[0]: '$@']";	283	} || "[unable to dump $_[0]: '$@']";
189	}	284	}
190		285
191	use JSON::Syck (); # TODO# replace by JSON::PC once working
192
193	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
194		287
195	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
196		289
197	=cut
198
199	sub from_json($) {
200	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
201	JSON::Syck::Load $_[0]
202	}
203
204	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
205		291
206	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
207		293
208	=cut	294	=cut
209		295
210	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
211	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	297
212	JSON::Syck::Dump $_[0]	298	sub encode_json($) { $json_coder->encode ($_[0]) }
213	}	299	sub decode_json($) { $json_coder->decode ($_[0]) }
214		300
215	=item cf::lock_wait $string	301	=item cf::lock_wait $string
216		302
217	Wait until the given lock is available. See cf::lock_acquire.	303	Wait until the given lock is available. See cf::lock_acquire.
218		304
…		…
221	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
222	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,
223	for example when the coroutine gets canceled), the lock is automatically	309	for example when the coroutine gets canceled), the lock is automatically
224	returned.	310	returned.
225		311
		312	Locks are *not* recursive, locking from the same coro twice results in a
		313	deadlocked coro.
		314
226	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
227	uses map_find and cf::map::load uses map_load).	316	uses map_find and cf::map::load uses map_load).
228		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
229	=cut	322	=cut
230		323
231	our %LOCK;	324	our %LOCK;
		325	our %LOCKER;#d#
232		326
233	sub lock_wait($) {	327	sub lock_wait($) {
234	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#
235		334
236	# wait for lock, if any	335	# wait for lock, if any
237	while ($LOCK{$key}) {	336	while ($LOCK{$key}) {
238	push @{ $LOCK{$key} }, $Coro::current;	337	push @{ $LOCK{$key} }, $Coro::current;
239	Coro::schedule;	338	Coro::schedule;
…		…
245		344
246	# wait, to be sure we are not locked	345	# wait, to be sure we are not locked
247	lock_wait $key;	346	lock_wait $key;
248		347
249	$LOCK{$key} = [];	348	$LOCK{$key} = [];
		349	$LOCKER{$key} = $Coro::current;#d#
250		350
251	Coro::guard {	351	Coro::guard {
		352	delete $LOCKER{$key};#d#
252	# wake up all waiters, to be on the safe side	353	# wake up all waiters, to be on the safe side
253	$_->ready for @{ delete $LOCK{$key} };	354	$_->ready for @{ delete $LOCK{$key} };
254	}	355	}
255	}	356	}
256		357
		358	sub lock_active($) {
		359	my ($key) = @_;
		360
		361	! ! $LOCK{$key}
		362	}
		363
257	sub freeze_mainloop {	364	sub freeze_mainloop {
258	return unless $TICK_WATCHER->is_active;	365	tick_inhibit_inc;
259		366
260	my $guard = Coro::guard { $TICK_WATCHER->start };	367	Coro::guard \&tick_inhibit_dec;
261	$TICK_WATCHER->stop;	368	}
262	$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;
263	}	441	}
264		442
265	=item cf::async { BLOCK }	443	=item cf::async { BLOCK }
266		444
267	Currently the same as Coro::async_pool, meaning you cannot use	445	Currently the same as Coro::async_pool, meaning you cannot use
…		…
272		450
273	BEGIN { *async = \&Coro::async_pool }	451	BEGIN { *async = \&Coro::async_pool }
274		452
275	=item cf::sync_job { BLOCK }	453	=item cf::sync_job { BLOCK }
276		454
277	The design of crossfire+ requires that the main coro ($Coro::main) is	455	The design of Deliantra requires that the main coroutine ($Coro::main)
278	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
279	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.
280		459
281	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
282	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
283	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
284	fast or be very important.	463	fast or be very important.
…		…
287		466
288	sub sync_job(&) {	467	sub sync_job(&) {
289	my ($job) = @_;	468	my ($job) = @_;
290		469
291	if ($Coro::current == $Coro::main) {	470	if ($Coro::current == $Coro::main) {
		471	my $time = EV::time;
		472
292	# this is the main coro, too bad, we have to block	473	# this is the main coro, too bad, we have to block
293	# till the operation succeeds, freezing the server :/	474	# till the operation succeeds, freezing the server :/
294		475
295	# TODO: use suspend/resume instead	476	LOG llevError, Carp::longmess "sync job";#d#
296	# (but this is cancel-safe)	477
297	my $freeze_guard = freeze_mainloop;	478	my $freeze_guard = freeze_mainloop;
298		479
299	my $busy = 1;	480	my $busy = 1;
300	my @res;	481	my @res;
301		482
302	(async {	483	(async {
		484	$Coro::current->desc ("sync job coro");
303	@res = eval { $job->() };	485	@res = eval { $job->() };
304	warn $@ if $@;	486	warn $@ if $@;
305	undef $busy;	487	undef $busy;
306	})->prio (Coro::PRIO_MAX);	488	})->prio (Coro::PRIO_MAX);
307		489
308	while ($busy) {	490	while ($busy) {
309	Coro::cede or Event::one_event;	491	if (Coro::nready) {
		492	Coro::cede_notself;
		493	} else {
		494	EV::loop EV::LOOP_ONESHOT;
310	}	495	}
		496	}
		497
		498	my $time = EV::time - $time;
		499
		500	$TICK_START += $time; # do not account sync jobs to server load
311		501
312	wantarray ? @res : $res[0]	502	wantarray ? @res : $res[0]
313	} else {	503	} else {
314	# we are in another coroutine, how wonderful, everything just works	504	# we are in another coroutine, how wonderful, everything just works
315		505
…		…
335	$EXT_CORO{$coro+0} = $coro;	525	$EXT_CORO{$coro+0} = $coro;
336		526
337	$coro	527	$coro
338	}	528	}
339		529
340	sub write_runtime {	530	=item fork_call { }, $args
341	my $runtime = cf::localdir . "/runtime";
342		531
343	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	532	Executes the given code block with the given arguments in a seperate
344	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.
345		536
346	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	537	=cut
347	(aio_write $fh, 0, (length $value), $value, 0) <= 0
348	and return;
349		538
350	aio_fsync $fh	539	sub fork_call(&@) {
351	and return;	540	my ($cb, @args) = @_;
352		541
353	close $fh	542	# we seemingly have to make a local copy of the whole thing,
354	or return;	543	# otherwise perl prematurely frees the stuff :/
		544	# TODO: investigate and fix (likely this will be rather laborious)
355		545
356	aio_rename "$runtime~", $runtime	546	my @res = Coro::Util::fork_eval {
357	and return;	547	reset_signals;
		548	&$cb
		549	}, @args;
358		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
359	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 });
360	}	717	}
361		718
362	=back	719	=back
363		720
364	=cut	721	=cut
365
366	#############################################################################
367
368	package cf::path;
369
370	use overload
371	'""' => \&as_string;
372
373	# used to convert map paths into valid unix filenames by repalcing / by ∕
374	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
375
376	sub new {
377	my ($class, $path, $base) = @_;
378
379	$path = $path->as_string if ref $path;
380
381	my $self = bless { }, $class;
382
383	# {... are special paths that are not touched
384	# ?xxx/... are special absolute paths
385	# ?random/... random maps
386	# /! non-realised random map exit
387	# /... normal maps
388	# ~/... per-player maps without a specific player (DO NOT USE)
389	# ~user/... per-player map of a specific user
390
391	$path =~ s/$PATH_SEP/\//go;
392
393	if ($path =~ /^{/) {
394	# fine as it is
395	} elsif ($path =~ s{^\?random/}{}) {
396	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
397	$self->{random} = cf::from_json $data;
398	} else {
399	if ($path =~ s{^~([^/]+)?}{}) {
400	$self->{user_rel} = 1;
401
402	if (defined $1) {
403	$self->{user} = $1;
404	} elsif ($base =~ m{^~([^/]+)/}) {
405	$self->{user} = $1;
406	} else {
407	warn "cannot resolve user-relative path without user <$path,$base>\n";
408	}
409	} elsif ($path =~ /^\//) {
410	# already absolute
411	} else {
412	$base =~ s{[^/]+/?$}{};
413	return $class->new ("$base/$path");
414	}
415
416	for ($path) {
417	redo if s{/\.?/}{/};
418	redo if s{/[^/]+/\.\./}{/};
419	}
420	}
421
422	$self->{path} = $path;
423
424	$self
425	}
426
427	# the name / primary key / in-game path
428	sub as_string {
429	my ($self) = @_;
430
431	$self->{user_rel} ? "~$self->{user}$self->{path}"
432	: $self->{random} ? "?random/$self->{path}"
433	: $self->{path}
434	}
435
436	# the displayed name, this is a one way mapping
437	sub visible_name {
438	my ($self) = @_;
439
440	# if (my $rmp = $self->{random}) {
441	# # todo: be more intelligent about this
442	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
443	# } else {
444	$self->as_string
445	# }
446	}
447
448	# escape the /'s in the path
449	sub _escaped_path {
450	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
451	$path
452	}
453
454	# the original (read-only) location
455	sub load_path {
456	my ($self) = @_;
457
458	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
459	}
460
461	# the temporary/swap location
462	sub save_path {
463	my ($self) = @_;
464
465	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
466	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
467	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
468	}
469
470	# the unique path, might be eq to save_path
471	sub uniq_path {
472	my ($self) = @_;
473
474	$self->{user_rel} || $self->{random}
475	? undef
476	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
477	}
478
479	# return random map parameters, or undef
480	sub random_map_params {
481	my ($self) = @_;
482
483	$self->{random}
484	}
485
486	# this is somewhat ugly, but style maps do need special treatment
487	sub is_style_map {
488	$_[0]{path} =~ m{^/styles/}
489	}
490
491	package cf;
492		722
493	#############################################################################	723	#############################################################################
494		724
495	=head2 ATTACHABLE OBJECTS	725	=head2 ATTACHABLE OBJECTS
496		726
…		…
498	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")
499	to it. All such attachable objects support the following methods.	729	to it. All such attachable objects support the following methods.
500		730
501	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>
502	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
503	crossfire+).	733	Deliantra).
504		734
505	=over 4	735	=over 4
506		736
507	=item $attachable->attach ($attachment, key => $value...)	737	=item $attachable->attach ($attachment, key => $value...)
508		738
…		…
622	our @CB_TYPE = (); # registry for type (cf-object class) based events	852	our @CB_TYPE = (); # registry for type (cf-object class) based events
623	our @CB_MAP = ();	853	our @CB_MAP = ();
624		854
625	my %attachment;	855	my %attachment;
626		856
		857	sub cf::attachable::thawer_merge {
		858	# simply override everything except _meta
		859	local $_[0]{_meta};
		860	%{$_[0]} = %{$_[1]};
		861	}
		862
627	sub _attach_cb($$$$) {	863	sub _attach_cb($$$$) {
628	my ($registry, $event, $prio, $cb) = @_;	864	my ($registry, $event, $prio, $cb) = @_;
629		865
630	use sort 'stable';	866	use sort 'stable';
631		867
…		…
665	$registry = $CB_TYPE[$object_type] ||= [];	901	$registry = $CB_TYPE[$object_type] ||= [];
666		902
667	} elsif ($type eq "subtype") {	903	} elsif ($type eq "subtype") {
668	defined $object_type or Carp::croak "subtype specified without type";	904	defined $object_type or Carp::croak "subtype specified without type";
669	my $object_subtype = shift @arg;	905	my $object_subtype = shift @arg;
670	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	906	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
671		907
672	} elsif ($type eq "package") {	908	} elsif ($type eq "package") {
673	my $pkg = shift @arg;	909	my $pkg = shift @arg;
674		910
675	while (my ($name, $id) = each %cb_id) {	911	while (my ($name, $id) = each %cb_id) {
…		…
704	_attach $registry, $klass, @attach;	940	_attach $registry, $klass, @attach;
705	}	941	}
706		942
707	$obj->{$name} = \%arg;	943	$obj->{$name} = \%arg;
708	} else {	944	} else {
709	warn "object uses attachment '$name' that is not available, postponing.\n";	945	warn "object uses attachment '$name' which is not available, postponing.\n";
710	}	946	}
711		947
712	$obj->{_attachment}{$name} = undef;	948	$obj->{_attachment}{$name} = undef;
713	}	949	}
714		950
…		…
716	if (ref $_[0]) {	952	if (ref $_[0]) {
717	_object_attach @_;	953	_object_attach @_;
718	} else {	954	} else {
719	_attach shift->_attach_registry, @_;	955	_attach shift->_attach_registry, @_;
720	}	956	}
		957	_recalc_want;
721	};	958	};
722		959
723	# all those should be optimised	960	# all those should be optimised
724	sub cf::attachable::detach {	961	sub cf::attachable::detach {
725	my ($obj, $name) = @_;	962	my ($obj, $name) = @_;
…		…
728	delete $obj->{_attachment}{$name};	965	delete $obj->{_attachment}{$name};
729	reattach ($obj);	966	reattach ($obj);
730	} else {	967	} else {
731	Carp::croak "cannot, currently, detach class attachments";	968	Carp::croak "cannot, currently, detach class attachments";
732	}	969	}
		970	_recalc_want;
733	};	971	};
734		972
735	sub cf::attachable::attached {	973	sub cf::attachable::attached {
736	my ($obj, $name) = @_;	974	my ($obj, $name) = @_;
737		975
…		…
752	";	990	";
753	die if $@;	991	die if $@;
754	}	992	}
755		993
756	our $override;	994	our $override;
757	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?
758		996
759	sub override {	997	sub override {
760	$override = 1;	998	$override = 1;
761	@invoke_results = ();	999	@INVOKE_RESULTS = (@_);
762	}	1000	}
763		1001
764	sub do_invoke {	1002	sub do_invoke {
765	my $event = shift;	1003	my $event = shift;
766	my $callbacks = shift;	1004	my $callbacks = shift;
767		1005
768	@invoke_results = ();	1006	@INVOKE_RESULTS = ();
769		1007
770	local $override;	1008	local $override;
771		1009
772	for (@$callbacks) {	1010	for (@$callbacks) {
773	eval { &{$_->[1]} };	1011	eval { &{$_->[1]} };
…		…
782	}	1020	}
783		1021
784	0	1022	0
785	}	1023	}
786		1024
787	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1025	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
788		1026
789	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1027	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
790		1028
791	Generate an object-specific event with the given arguments.	1029	Generate an object-specific event with the given arguments.
792		1030
793	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
794	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
795	results (if you must, access C<@cf::invoke_results> directly).	1033	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
796		1034
797	=back	1035	=back
798		1036
799	=cut	1037	=cut
800		1038
801	#############################################################################	1039	#############################################################################
802	# 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	}
803		1083
804	sub reattach {	1084	sub reattach {
805	# basically do the same as instantiate, without calling instantiate	1085	# basically do the same as instantiate, without calling instantiate
806	my ($obj) = @_;	1086	my ($obj) = @_;
		1087
		1088	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
807		1089
808	my $registry = $obj->registry;	1090	my $registry = $obj->registry;
809		1091
810	@$registry = ();	1092	@$registry = ();
811		1093
…		…
826	cf::attachable->attach (	1108	cf::attachable->attach (
827	prio => -1000000,	1109	prio => -1000000,
828	on_instantiate => sub {	1110	on_instantiate => sub {
829	my ($obj, $data) = @_;	1111	my ($obj, $data) = @_;
830		1112
831	$data = from_json $data;	1113	$data = decode_json $data;
832		1114
833	for (@$data) {	1115	for (@$data) {
834	my ($name, $args) = @$_;	1116	my ($name, $args) = @$_;
835		1117
836	$obj->attach ($name, %{$args || {} });	1118	$obj->attach ($name, %{$args || {} });
…		…
852	sub object_freezer_save {	1134	sub object_freezer_save {
853	my ($filename, $rdata, $objs) = @_;	1135	my ($filename, $rdata, $objs) = @_;
854		1136
855	sync_job {	1137	sync_job {
856	if (length $$rdata) {	1138	if (length $$rdata) {
		1139	utf8::decode (my $decname = $filename);
857	warn sprintf "saving %s (%d,%d)\n",	1140	warn sprintf "saving %s (%d,%d)\n",
858	$filename, length $$rdata, scalar @$objs;	1141	$decname, length $$rdata, scalar @$objs;
859		1142
860	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1143	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
861	chmod SAVE_MODE, $fh;	1144	chmod SAVE_MODE, $fh;
862	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1145	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
863	aio_fsync $fh;	1146	aio_fsync $fh if $cf::USE_FSYNC;
864	close $fh;	1147	close $fh;
865		1148
866	if (@$objs) {	1149	if (@$objs) {
867	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) {
868	chmod SAVE_MODE, $fh;	1151	chmod SAVE_MODE, $fh;
869	my $data = Storable::nfreeze { version => 1, objs => $objs };	1152	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
870	aio_write $fh, 0, (length $data), $data, 0;	1153	aio_write $fh, 0, (length $data), $data, 0;
871	aio_fsync $fh;	1154	aio_fsync $fh if $cf::USE_FSYNC;
872	close $fh;	1155	close $fh;
873	aio_rename "$filename.pst~", "$filename.pst";	1156	aio_rename "$filename.pst~", "$filename.pst";
874	}	1157	}
875	} else {	1158	} else {
876	aio_unlink "$filename.pst";	1159	aio_unlink "$filename.pst";
…		…
882	}	1165	}
883	} else {	1166	} else {
884	aio_unlink $filename;	1167	aio_unlink $filename;
885	aio_unlink "$filename.pst";	1168	aio_unlink "$filename.pst";
886	}	1169	}
887	}	1170	};
888	}	1171	}
889		1172
890	sub object_freezer_as_string {	1173	sub object_freezer_as_string {
891	my ($rdata, $objs) = @_;	1174	my ($rdata, $objs) = @_;
892		1175
…		…
904	or return;	1187	or return;
905		1188
906	unless (aio_stat "$filename.pst") {	1189	unless (aio_stat "$filename.pst") {
907	(aio_load "$filename.pst", $av) >= 0	1190	(aio_load "$filename.pst", $av) >= 0
908	or return;	1191	or return;
		1192
909	$av = eval { (Storable::thaw $av)->{objs} };	1193	my $st = eval { Coro::Storable::thaw $av };
		1194	$av = $st->{objs};
910	}	1195	}
911		1196
		1197	utf8::decode (my $decname = $filename);
912	warn sprintf "loading %s (%d)\n",	1198	warn sprintf "loading %s (%d,%d)\n",
913	$filename, length $data, scalar @{$av || []};#d#	1199	$decname, length $data, scalar @{$av || []};
		1200
914	return ($data, $av);	1201	($data, $av)
915	}	1202	}
		1203
		1204	=head2 COMMAND CALLBACKS
		1205
		1206	=over 4
		1207
		1208	=cut
916		1209
917	#############################################################################	1210	#############################################################################
918	# command handling &c	1211	# command handling &c
919		1212
920	=item cf::register_command $name => \&callback($ob,$args);	1213	=item cf::register_command $name => \&callback($ob,$args);
…		…
933	push @{ $COMMAND{$name} }, [$caller, $cb];	1226	push @{ $COMMAND{$name} }, [$caller, $cb];
934	}	1227	}
935		1228
936	=item cf::register_extcmd $name => \&callback($pl,$packet);	1229	=item cf::register_extcmd $name => \&callback($pl,$packet);
937		1230
938	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.
939		1236
940	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
941	called.	1238	called.
942		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
943	=cut	1251	=cut
944		1252
945	sub register_extcmd {	1253	sub register_extcmd {
946	my ($name, $cb) = @_;	1254	my ($name, $cb) = @_;
947		1255
948	$EXTCMD{$name} = $cb;	1256	$EXTCMD{$name} = $cb;
		1257	}
		1258
		1259	sub register_exticmd {
		1260	my ($name, $cb) = @_;
		1261
		1262	$EXTICMD{$name} = $cb;
949	}	1263	}
950		1264
951	cf::player->attach (	1265	cf::player->attach (
952	on_command => sub {	1266	on_command => sub {
953	my ($pl, $name, $params) = @_;	1267	my ($pl, $name, $params) = @_;
…		…
962	cf::override;	1276	cf::override;
963	},	1277	},
964	on_extcmd => sub {	1278	on_extcmd => sub {
965	my ($pl, $buf) = @_;	1279	my ($pl, $buf) = @_;
966		1280
967	my $msg = eval { from_json $buf };	1281	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
968		1282
969	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
970	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1291	if (my $cb = $EXTCMD{$type}) {
971	if (my %reply = $cb->($pl, $msg)) {	1292	@reply = $cb->($pl, @payload);
972	$pl->ext_reply ($msg->{msgid}, %reply);
973	}
974	}	1293	}
		1294
		1295	$pl->ext_reply ($reply, @reply)
		1296	if $reply;
		1297
975	} else {	1298	} else {
976	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1299	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
977	}	1300	}
978		1301
979	cf::override;	1302	cf::override;
980	},	1303	},
981	);	1304	);
982		1305
983	sub load_extension {
984	my ($path) = @_;
985
986	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
987	my $base = $1;
988	my $pkg = $1;
989	$pkg =~ s/[^[:word:]]/_/g;
990	$pkg = "ext::$pkg";
991
992	warn "loading '$path' into '$pkg'\n";
993
994	open my $fh, "<:utf8", $path
995	or die "$path: $!";
996
997	my $source =
998	"package $pkg; use strict; use utf8;\n"
999	. "#line 1 \"$path\"\n{\n"
1000	. (do { local $/; <$fh> })
1001	. "\n};\n1";
1002
1003	eval $source
1004	or die $@ ? "$path: $@\n"
1005	: "extension disabled.\n";
1006
1007	push @EXTS, $pkg;
1008	}
1009
1010	sub load_extensions {	1306	sub load_extensions {
		1307	cf::sync_job {
		1308	my %todo;
		1309
1011	for my $ext (<$LIBDIR/*.ext>) {	1310	for my $path (<$LIBDIR/*.ext>) {
1012	next unless -r $ext;	1311	next unless -r $path;
1013	eval {	1312
1014	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;
1015	1	1369	}
1016	} or warn "$ext not loaded: $@";	1370
		1371	skip:
		1372	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1373	unless $progress;
		1374	}
1017	}	1375	};
1018	}	1376	}
1019		1377
1020	#############################################################################	1378	#############################################################################
1021	# load/save/clean perl data associated with a map
1022		1379
1023	*cf::mapsupport::on_clean = sub {	1380	=back
1024	my ($map) = @_;
1025
1026	my $path = $map->tmpname;
1027	defined $path or return;
1028
1029	unlink "$path.pst";
1030	};
1031
1032	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1033
1034	#############################################################################
1035		1381
1036	=head2 CORE EXTENSIONS	1382	=head2 CORE EXTENSIONS
1037		1383
1038	Functions and methods that extend core crossfire objects.	1384	Functions and methods that extend core crossfire objects.
1039		1385
…		…
1045		1391
1046	=head3 cf::player	1392	=head3 cf::player
1047		1393
1048	=over 4	1394	=over 4
1049		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
1050	=item cf::player::find $login	1410	=item cf::player::find $login
1051		1411
1052	Returns the given player object, loading it if necessary (might block).	1412	Returns the given player object, loading it if necessary (might block).
1053		1413
1054	=cut	1414	=cut
1055		1415
1056	sub playerdir($) {	1416	sub playerdir($) {
1057	cf::localdir	1417	"$PLAYERDIR/"
1058	. "/"
1059	. cf::playerdir
1060	. "/"
1061	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1418	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1062	}	1419	}
1063		1420
1064	sub path($) {	1421	sub path($) {
1065	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1422	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1066		1423
1067	(playerdir $login) . "/$login.pl"	1424	(playerdir $login) . "/playerdata"
1068	}	1425	}
1069		1426
1070	sub find_active($) {	1427	sub find_active($) {
1071	$cf::PLAYER{$_[0]}	1428	$cf::PLAYER{$_[0]}
1072	and $cf::PLAYER{$_[0]}->active	1429	and $cf::PLAYER{$_[0]}->active
…		…
1075		1432
1076	sub exists($) {	1433	sub exists($) {
1077	my ($login) = @_;	1434	my ($login) = @_;
1078		1435
1079	$cf::PLAYER{$login}	1436	$cf::PLAYER{$login}
1080	or cf::sync_job { !aio_stat $login }	1437	or cf::sync_job { !aio_stat path $login }
1081	}	1438	}
1082		1439
1083	sub find($) {	1440	sub find($) {
1084	return $cf::PLAYER{$_[0]} || do {	1441	return $cf::PLAYER{$_[0]} || do {
1085	my $login = $_[0];	1442	my $login = $_[0];
1086		1443
1087	my $guard = cf::lock_acquire "user_find:$login";	1444	my $guard = cf::lock_acquire "user_find:$login";
1088		1445
1089	$cf::PLAYER{$_[0]} || do {	1446	$cf::PLAYER{$_[0]} || do {
1090	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
1091	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;
1092	$cf::PLAYER{$login} = $pl	1461	$cf::PLAYER{$login} = $pl
1093	}	1462	}
1094	}	1463	}
1095	}	1464	}
1096		1465
…		…
1106		1475
1107	aio_mkdir playerdir $pl, 0770;	1476	aio_mkdir playerdir $pl, 0770;
1108	$pl->{last_save} = $cf::RUNTIME;	1477	$pl->{last_save} = $cf::RUNTIME;
1109		1478
1110	$pl->save_pl ($path);	1479	$pl->save_pl ($path);
1111	Coro::cede;	1480	cf::cede_to_tick;
1112	}	1481	}
1113		1482
1114	sub new($) {	1483	sub new($) {
1115	my ($login) = @_;	1484	my ($login) = @_;
1116		1485
…		…
1122	$cf::PLAYER{$login} = $self;	1491	$cf::PLAYER{$login} = $self;
1123		1492
1124	$self	1493	$self
1125	}	1494	}
1126		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
1127	=item $pl->quit_character	1506	=item $pl->quit_character
1128		1507
1129	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
1130	be destroyed. May block for a long time.	1509	be destroyed. May block for a long time.
1131		1510
1132	=cut	1511	=cut
1133		1512
1134	sub quit_character {	1513	sub quit_character {
1135	my ($pl) = @_;	1514	my ($pl) = @_;
		1515
		1516	my $name = $pl->ob->name;
1136		1517
1137	$pl->{deny_save} = 1;	1518	$pl->{deny_save} = 1;
1138	$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
1139		1520
1140	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1521	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1145	my $path = playerdir $pl;	1526	my $path = playerdir $pl;
1146	my $temp = "$path~$cf::RUNTIME~deleting~";	1527	my $temp = "$path~$cf::RUNTIME~deleting~";
1147	aio_rename $path, $temp;	1528	aio_rename $path, $temp;
1148	delete $cf::PLAYER{$pl->ob->name};	1529	delete $cf::PLAYER{$pl->ob->name};
1149	$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
1150	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;
1151	}	1552	}
1152		1553
1153	=item cf::player::list_logins	1554	=item cf::player::list_logins
1154		1555
1155	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
1156	while and may block, so not sync_job-capable, ever.	1557	while and may block, so not sync_job-capable, ever.
1157		1558
1158	=cut	1559	=cut
1159		1560
1160	sub list_logins {	1561	sub list_logins {
1161	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1562	my $dirs = aio_readdir $PLAYERDIR
1162	or return [];	1563	or return [];
1163		1564
1164	my @logins;	1565	my @logins;
1165		1566
1166	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") {
1167	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1572	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1168	aio_read $fh, 0, 512, my $buf, 0 or next;	1573	aio_read $fh, 0, 512, my $buf, 0 or next;
1169	$buf !~ /^password -------------$/m or next; # official not-valid tag	1574	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1575	}
1170		1576
1171	utf8::decode $login;	1577	utf8::decode $login;
1172	push @logins, $login;	1578	push @logins, $login;
1173	}	1579	}
1174		1580
1175	\@logins	1581	\@logins
1176	}	1582	}
1177		1583
1178	=item $player->maps	1584	=item $player->maps
1179		1585
1180	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
1181	player. May block.	1587	player. May block.
1182		1588
1183	=cut	1589	=cut
1184		1590
1185	sub maps($) {	1591	sub maps($) {
1186	my ($pl) = @_;	1592	my ($pl) = @_;
		1593
		1594	$pl = ref $pl ? $pl->ob->name : $pl;
1187		1595
1188	my $files = aio_readdir playerdir $pl	1596	my $files = aio_readdir playerdir $pl
1189	or return;	1597	or return;
1190		1598
1191	my @paths;	1599	my @paths;
…		…
1193	for (@$files) {	1601	for (@$files) {
1194	utf8::decode $_;	1602	utf8::decode $_;
1195	next if /\.(?:pl|pst)$/;	1603	next if /\.(?:pl|pst)$/;
1196	next unless /^$PATH_SEP/o;	1604	next unless /^$PATH_SEP/o;
1197		1605
1198	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1606	push @paths, cf::map::normalise "~$pl/$_";
1199	}	1607	}
1200		1608
1201	\@paths	1609	\@paths
1202	}	1610	}
1203		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
1204	=item $player->ext_reply ($msgid, $msgtype, %msg)	1705	=item $player->ext_reply ($msgid, @msg)
1205		1706
1206	Sends an ext reply to the player.	1707	Sends an ext reply to the player.
1207		1708
1208	=cut	1709	=cut
1209		1710
1210	sub ext_reply($$$%) {	1711	sub ext_reply($$@) {
1211	my ($self, $id, %msg) = @_;	1712	my ($self, $id, @msg) = @_;
1212		1713
1213	$msg{msgid} = $id;	1714	$self->ns->ext_reply ($id, @msg)
1214
1215	$self->send ("ext " . cf::to_json \%msg);
1216	}	1715	}
1217		1716
1218	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	}
1219		1757
1220	=back	1758	=back
1221
1222		1759
1223	=head3 cf::map	1760	=head3 cf::map
1224		1761
1225	=over 4	1762	=over 4
1226		1763
…		…
1229	package cf::map;	1766	package cf::map;
1230		1767
1231	use Fcntl;	1768	use Fcntl;
1232	use Coro::AIO;	1769	use Coro::AIO;
1233		1770
		1771	use overload
		1772	'""' => \&as_string,
		1773	fallback => 1;
		1774
1234	our $MAX_RESET = 3600;	1775	our $MAX_RESET = 3600;
1235	our $DEFAULT_RESET = 3000;	1776	our $DEFAULT_RESET = 3000;
1236		1777
1237	sub generate_random_map {	1778	sub generate_random_map {
1238	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
1239		1782
1240	# mit "rum" bekleckern, nicht	1783	# mit "rum" bekleckern, nicht
1241	cf::map::_create_random_map	1784	$self->_create_random_map (
1242	$path,
1243	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1785	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1244	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1786	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1245	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1787	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1246	$rmp->{exit_on_final_map},	1788	$rmp->{exit_on_final_map},
1247	$rmp->{xsize}, $rmp->{ysize},	1789	$rmp->{xsize}, $rmp->{ysize},
1248	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1790	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1249	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1791	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1250	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1792	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1251	$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},
1252	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1794	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1253	(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"
1254	}	1924	}
1255		1925
1256	# and all this just because we cannot iterate over	1926	# and all this just because we cannot iterate over
1257	# all maps in C++...	1927	# all maps in C++...
1258	sub change_all_map_light {	1928	sub change_all_map_light {
…		…
1260		1930
1261	$_->change_map_light ($change)	1931	$_->change_map_light ($change)
1262	for grep $_->outdoor, values %cf::MAP;	1932	for grep $_->outdoor, values %cf::MAP;
1263	}	1933	}
1264		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
1265	sub try_load_header($) {	1951	sub load_header_from($) {
1266	my ($path) = @_;	1952	my ($self, $path) = @_;
1267		1953
1268	utf8::encode $path;	1954	utf8::encode $path;
1269	aio_open $path, O_RDONLY, 0	1955	my $f = new_from_file cf::object::thawer $path
1270	or return;	1956	or return;
1271		1957
1272	my $map = cf::map::new	1958	$self->_load_header ($f)
1273	or return;	1959	or return;
1274		1960
1275	# for better error messages only, will be overwritten	1961	local $MAP_LOADING{$self->{path}} = $self;
1276	$map->path ($path);	1962	$f->resolve_delayed_derefs;
1277		1963
1278	$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
1279	or return;	2007	or return;
		2008	$self->prepare_orig;
		2009	}
1280		2010
1281	$map->{load_path} = $path;	2011	$self->{deny_reset} = 1
		2012	if $self->no_reset;
1282		2013
1283	$map	2014	$self->default_region (cf::region::find_by_path $self->{path})
		2015	unless $self->default_region;
		2016
		2017	1
1284	}	2018	}
1285		2019
1286	sub find;	2020	sub find;
1287	sub find {	2021	sub find {
1288	my ($path, $origin) = @_;	2022	my ($path, $origin) = @_;
1289		2023
1290	#warn "find<$path,$origin>\n";#d#
1291
1292	$path = new cf::path $path, $origin && $origin->path;	2024	$path = normalise $path, $origin && $origin->path;
1293	my $key = $path->as_string;
1294		2025
		2026	cf::lock_wait "map_data:$path";#d#remove
1295	cf::lock_wait "map_find:$key";	2027	cf::lock_wait "map_find:$path";
1296		2028
1297	$cf::MAP{$key} || do {	2029	$cf::MAP{$path} || do {
1298	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
1299		2032
1300	# do it the slow way	2033	my $map = new_from_path cf::map $path
1301	my $map = try_load_header $path->save_path;
1302
1303	Coro::cede;
1304
1305	if ($map) {
1306	$map->last_access ((delete $map->{last_access})
1307	|| $cf::RUNTIME); #d#
1308	# safety
1309	$map->{instantiate_time} = $cf::RUNTIME
1310	if $map->{instantiate_time} > $cf::RUNTIME;
1311	} else {
1312	if (my $rmp = $path->random_map_params) {
1313	$map = generate_random_map $key, $rmp;
1314	} else {
1315	$map = try_load_header $path->load_path;
1316	}
1317
1318	$map or return;	2034	or return;
1319		2035
1320	$map->{load_original} = 1;
1321	$map->{instantiate_time} = $cf::RUNTIME;
1322	$map->last_access ($cf::RUNTIME);
1323	$map->instantiate;
1324
1325	# per-player maps become, after loading, normal maps
1326	$map->per_player (0) if $path->{user_rel};
1327	}
1328
1329	$map->path ($key);
1330	$map->{path} = $path;
1331	$map->{last_save} = $cf::RUNTIME;	2036	$map->{last_save} = $cf::RUNTIME;
1332		2037
1333	Coro::cede;	2038	$map->load_header
		2039	or return;
1334		2040
1335	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;
1336	$map->reset;	2046	$map->reset;
1337	undef $guard;
1338	$map = find $path	2047	return find $path;
1339	or return;
1340	}	2048	}
1341		2049
1342	$cf::MAP{$key} = $map	2050	$cf::MAP{$path} = $map
1343	}	2051	}
1344	}	2052	}
		2053
		2054	sub pre_load { }
		2055	sub post_load { }
1345		2056
1346	sub load {	2057	sub load {
1347	my ($self) = @_;	2058	my ($self) = @_;
1348		2059
		2060	local $self->{deny_reset} = 1; # loading can take a long time
		2061
1349	my $path = $self->{path};	2062	my $path = $self->{path};
		2063
		2064	{
1350	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2065	my $guard = cf::lock_acquire "map_data:$path";
1351		2066
		2067	return unless $self->valid;
1352	return if $self->in_memory != cf::MAP_SWAPPED;	2068	return unless $self->in_memory == cf::MAP_SWAPPED;
1353		2069
1354	$self->in_memory (cf::MAP_LOADING);	2070	$self->in_memory (cf::MAP_LOADING);
1355		2071
1356	$self->alloc;	2072	$self->alloc;
1357	$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)
1358	or return;	2080	or return;
1359		2081
1360	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2082	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1361	if delete $self->{load_original};	2083	if delete $self->{load_original};
1362		2084
1363	if (my $uniq = $path->uniq_path) {	2085	if (my $uniq = $self->uniq_path) {
1364	utf8::encode $uniq;	2086	utf8::encode $uniq;
1365	if (aio_open $uniq, O_RDONLY, 0) {	2087	unless (aio_stat $uniq) {
		2088	if (my $f = new_from_file cf::object::thawer $uniq) {
1366	$self->clear_unique_items;	2089	$self->clear_unique_items;
1367	$self->load_objects ($uniq, 0);	2090	$self->_load_objects ($f);
		2091	$f->resolve_delayed_derefs;
		2092	}
1368	}	2093	}
1369	}	2094	}
1370		2095
1371	Coro::cede;	2096	$f->resolve_delayed_derefs;
1372		2097
		2098	cf::cede_to_tick;
1373	# now do the right thing for maps	2099	# now do the right thing for maps
1374	$self->link_multipart_objects;	2100	$self->link_multipart_objects;
1375
1376	if ($self->{path}->is_style_map) {
1377	$self->{deny_save} = 1;
1378	$self->{deny_reset} = 1;
1379	} else {
1380	$self->fix_auto_apply;
1381	$self->decay_objects;
1382	$self->update_buttons;
1383	$self->set_darkness_map;
1384	$self->difficulty ($self->estimate_difficulty)	2101	$self->difficulty ($self->estimate_difficulty)
1385	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;
1386	$self->activate;	2112	$self->activate;
1387	}	2113	}
1388		2114
1389	Coro::cede;	2115	$self->{last_save} = $cf::RUNTIME;
		2116	$self->last_access ($cf::RUNTIME);
1390		2117
1391	$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
1392	}	2134	}
1393		2135
1394	# 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
1395	sub load_diag {	2137	sub load_neighbours {
1396	my ($map) = @_;	2138	my ($map) = @_;
1397		2139
1398	my @diag; # diagonal neighbours	2140	my @neigh; # diagonal neighbours
1399		2141
1400	for (0 .. 3) {	2142	for (0 .. 3) {
1401	my $neigh = $map->tile_path ($_)	2143	my $neigh = $map->tile_path ($_)
1402	or next;	2144	or next;
1403	$neigh = find $neigh, $map	2145	$neigh = find $neigh, $map
1404	or next;	2146	or next;
1405	$neigh->load;	2147	$neigh->load;
1406		2148
		2149	push @neigh,
1407	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2150	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1408	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2151	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1409	}	2152	}
1410		2153
1411	for (@diag) {	2154	for (grep defined $_->[0], @neigh) {
		2155	my ($path, $origin) = @$_;
1412	my $neigh = find @$_	2156	my $neigh = find $path, $origin
1413	or next;	2157	or next;
1414	$neigh->load;	2158	$neigh->load;
1415	}	2159	}
1416	}	2160	}
1417		2161
…		…
1422	}	2166	}
1423		2167
1424	sub do_load_sync {	2168	sub do_load_sync {
1425	my ($map) = @_;	2169	my ($map) = @_;
1426		2170
		2171	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2172	if $Coro::current == $Coro::main;
		2173
1427	cf::sync_job { $map->load };	2174	cf::sync_job { $map->load };
1428	}	2175	}
1429		2176
1430	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
1431	our $MAP_PREFETCHER = Coro::async {	2191	$MAP_PREFETCHER ||= cf::async {
1432	while () {	2192	$Coro::current->{desc} = "map prefetcher";
		2193
1433	while (%MAP_PREFETCH) {	2194	while (%MAP_PREFETCH) {
1434	my $key = each %MAP_PREFETCH	2195	while (my ($k, $v) = each %MAP_PREFETCH) {
1435	or next;	2196	if (my $map = find $k) {
		2197	$map->load if $v;
		2198	}
		2199
1436	my $path = delete $MAP_PREFETCH{$key};	2200	delete $MAP_PREFETCH{$k};
1437
1438	my $map = find $path
1439	or next;
1440	$map->load;
1441	}	2201	}
1442	Coro::schedule;	2202	}
		2203	undef $MAP_PREFETCHER;
1443	}	2204	};
1444	};
1445
1446	sub find_async {
1447	my ($path, $origin) = @_;
1448
1449	$path = new cf::path $path, $origin && $origin->path;
1450	my $key = $path->as_string;
1451
1452	if (my $map = $cf::MAP{$key}) {
1453	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1454	}
1455
1456	$MAP_PREFETCH{$key} = $path;
1457	$MAP_PREFETCHER->ready;	2205	$MAP_PREFETCHER->prio (6);
1458		2206
1459	()	2207	()
1460	}	2208	}
1461		2209
1462	sub save {	2210	sub save {
1463	my ($self) = @_;	2211	my ($self) = @_;
1464		2212
1465	my $lock = cf::lock_acquire "map_data:" . $self->path;	2213	my $lock = cf::lock_acquire "map_data:$self->{path}";
1466		2214
1467	$self->{last_save} = $cf::RUNTIME;	2215	$self->{last_save} = $cf::RUNTIME;
1468		2216
1469	return unless $self->dirty;	2217	return unless $self->dirty;
1470		2218
1471	my $save = $self->{path}->save_path; utf8::encode $save;	2219	my $save = $self->save_path; utf8::encode $save;
1472	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2220	my $uniq = $self->uniq_path; utf8::encode $uniq;
1473		2221
1474	$self->{load_path} = $save;	2222	$self->{load_path} = $save;
1475		2223
1476	return if $self->{deny_save};	2224	return if $self->{deny_save};
1477		2225
1478	local $self->{last_access} = $self->last_access;#d#	2226	local $self->{last_access} = $self->last_access;#d#
1479		2227
1480	cf::async {	2228	cf::async {
		2229	$Coro::current->{desc} = "map player save";
1481	$_->contr->save for $self->players;	2230	$_->contr->save for $self->players;
1482	};	2231	};
1483		2232
1484	if ($uniq) {	2233	if ($uniq) {
1485	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2234	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1486	$self->save_objects ($uniq, cf::IO_UNIQUES);	2235	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1487	} else {	2236	} else {
1488	$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);
1489	}	2238	}
1490	}	2239	}
1491		2240
1492	sub swap_out {	2241	sub swap_out {
1493	my ($self) = @_;	2242	my ($self) = @_;
1494		2243
1495	# save first because save cedes	2244	# save first because save cedes
1496	$self->save;	2245	$self->save;
1497		2246
1498	my $lock = cf::lock_acquire "map_data:" . $self->path;	2247	my $lock = cf::lock_acquire "map_data:$self->{path}";
1499		2248
1500	return if $self->players;	2249	return if $self->players;
1501	return if $self->in_memory != cf::MAP_IN_MEMORY;	2250	return if $self->in_memory != cf::MAP_IN_MEMORY;
1502	return if $self->{deny_save};	2251	return if $self->{deny_save};
1503		2252
		2253	$self->in_memory (cf::MAP_SWAPPED);
		2254
		2255	$self->deactivate;
		2256	$_->clear_links_to ($self) for values %cf::MAP;
1504	$self->clear;	2257	$self->clear;
1505	$self->in_memory (cf::MAP_SWAPPED);
1506	}	2258	}
1507		2259
1508	sub reset_at {	2260	sub reset_at {
1509	my ($self) = @_;	2261	my ($self) = @_;
1510		2262
1511	# TODO: safety, remove and allow resettable per-player maps	2263	# TODO: safety, remove and allow resettable per-player maps
1512	return 1e99 if $self->{path}{user_rel};
1513	return 1e99 if $self->{deny_reset};	2264	return 1e99 if $self->{deny_reset};
1514		2265
1515	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2266	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1516	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;
1517		2268
…		…
1522	my ($self) = @_;	2273	my ($self) = @_;
1523		2274
1524	$self->reset_at <= $cf::RUNTIME	2275	$self->reset_at <= $cf::RUNTIME
1525	}	2276	}
1526		2277
1527	sub unlink_save {
1528	my ($self) = @_;
1529
1530	utf8::encode (my $save = $self->{path}->save_path);
1531	aioreq_pri 3; IO::AIO::aio_unlink $save;
1532	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1533	}
1534
1535	sub rename {
1536	my ($self, $new_path) = @_;
1537
1538	$self->unlink_save;
1539
1540	delete $cf::MAP{$self->path};
1541	$self->{path} = new cf::path $new_path;
1542	$self->path ($self->{path}->as_string);
1543	$cf::MAP{$self->path} = $self;
1544
1545	$self->save;
1546	}
1547
1548	sub reset {	2278	sub reset {
1549	my ($self) = @_;	2279	my ($self) = @_;
1550		2280
1551	my $lock = cf::lock_acquire "map_data:" . $self->path;	2281	my $lock = cf::lock_acquire "map_data:$self->{path}";
1552		2282
1553	return if $self->players;	2283	return if $self->players;
1554	return if $self->{path}{user_rel};#d#
1555		2284
1556	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	}
1557		2296
1558	delete $cf::MAP{$self->path};	2297	delete $cf::MAP{$self->path};
1559		2298
		2299	$self->deactivate;
1560	$_->clear_links_to ($self) for values %cf::MAP;	2300	$_->clear_links_to ($self) for values %cf::MAP;
		2301	$self->clear;
1561		2302
1562	$self->unlink_save;	2303	$self->unlink_save;
1563	$self->destroy;	2304	$self->destroy;
1564	}	2305	}
1565		2306
1566	my $nuke_counter = "aaaa";	2307	my $nuke_counter = "aaaa";
1567		2308
1568	sub nuke {	2309	sub nuke {
1569	my ($self) = @_;	2310	my ($self) = @_;
1570		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};
1571	$self->{deny_save} = 1;	2321	$self->{deny_save} = 1;
1572	$self->reset_timeout (1);	2322	$self->reset_timeout (1);
1573	$self->rename ("{nuke}/" . ($nuke_counter++));	2323	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2324
		2325	$cf::MAP{$self->path} = $self;
		2326	}
		2327
1574	$self->reset; # polite request, might not happen	2328	$self->reset; # polite request, might not happen
1575	}	2329	}
1576		2330
1577	sub customise_for {	2331	=item $maps = cf::map::tmp_maps
1578	my ($map, $ob) = @_;
1579		2332
1580	if ($map->per_player) {	2333	Returns an arrayref with all map paths of currently instantiated and saved
1581	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2334	maps. May block.
		2335
		2336	=cut
		2337
		2338	sub tmp_maps() {
1582	}	2339	[
		2340	map {
		2341	utf8::decode $_;
		2342	/\.map$/
		2343	? normalise $_
		2344	: ()
		2345	} @{ aio_readdir $TMPDIR or [] }
		2346	]
		2347	}
1583		2348
1584	$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	]
1585	}	2365	}
1586		2366
1587	=item cf::map::unique_maps	2367	=item cf::map::unique_maps
1588		2368
1589	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
1590	instantiated unique items. May block.	2370	instantiated unique items. May block.
1591		2371
1592	=cut	2372	=cut
1593		2373
1594	sub unique_maps() {	2374	sub unique_maps() {
1595	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2375	[
1596	or return;	2376	map {
1597
1598	my @paths;
1599
1600	for (@$files) {
1601	utf8::decode $_;	2377	utf8::decode $_;
1602	next if /\.pst$/;	2378	/\.map$/
1603	next unless /^$PATH_SEP/o;	2379	? normalise $_
1604		2380	: ()
1605	push @paths, new cf::path $_;	2381	} @{ aio_readdir $UNIQUEDIR or [] }
1606	}	2382	]
1607
1608	\@paths
1609	}	2383	}
1610
1611	package cf;
1612		2384
1613	=back	2385	=back
1614		2386
1615	=head3 cf::object	2387	=head3 cf::object
1616		2388
…		…
1631	map { $_, inv_recursive_ $_->inv } @_	2403	map { $_, inv_recursive_ $_->inv } @_
1632	}	2404	}
1633		2405
1634	sub inv_recursive {	2406	sub inv_recursive {
1635	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	}
1636	}	2436	}
1637		2437
1638	package cf;	2438	package cf;
1639		2439
1640	=back	2440	=back
…		…
1659		2459
1660	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2460	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1661		2461
1662	if ($self->{record_replies}) {	2462	if ($self->{record_replies}) {
1663	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2463	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2464
1664	} 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 {
1665	$msg = $npc->name . " says: $msg" if $npc;	2473	$msg = $npc->name . " says: $msg" if $npc;
1666	$self->message ($msg, $flags);	2474	$self->message ($msg, $flags);
		2475	}
1667	}	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 (@_);
1668	}	2487	}
1669		2488
1670	=item $player_object->may ("access")	2489	=item $player_object->may ("access")
1671		2490
1672	Returns wether the given player is authorized to access resource "access"	2491	Returns wether the given player is authorized to access resource "access"
…		…
1685		2504
1686	=item $player_object->enter_link	2505	=item $player_object->enter_link
1687		2506
1688	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}>).
1689		2508
1690	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
1691	I<MUST> call C<leave_link> as soon as possible, though.	2510	I<MUST> call C<leave_link> as soon as possible, though.
1692		2511
		2512	Will never block.
		2513
1693	=item $player_object->leave_link ($map, $x, $y)	2514	=item $player_object->leave_link ($map, $x, $y)
1694		2515
1695	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
1696	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
1697	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
1698	to the emergency map position.	2519	fails, to the emergency map position.
1699		2520
1700	Might block.	2521	Might block.
1701		2522
1702	=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	}
1703		2534
1704	sub cf::object::player::enter_link {	2535	sub cf::object::player::enter_link {
1705	my ($self) = @_;	2536	my ($self) = @_;
1706		2537
1707	$self->deactivate_recursive;	2538	$self->deactivate_recursive;
1708		2539
1709	return if $self->map == $LINK_MAP;	2540	return if UNIVERSAL::isa $self->map, "ext::map_link";
1710		2541
1711	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2542	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1712	if $self->map;	2543	if $self->map && $self->map->{path} ne "{link}";
1713		2544
1714	$self->enter_map ($LINK_MAP, 20, 20);	2545	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1715	}	2546	}
1716		2547
1717	sub cf::object::player::leave_link {	2548	sub cf::object::player::leave_link {
1718	my ($self, $map, $x, $y) = @_;	2549	my ($self, $map, $x, $y) = @_;
		2550
		2551	return unless $self->contr->active;
1719		2552
1720	my $link_pos = delete $self->{_link_pos};	2553	my $link_pos = delete $self->{_link_pos};
1721		2554
1722	unless ($map) {	2555	unless ($map) {
1723	# restore original map position	2556	# restore original map position
…		…
1737	# use -1 or undef as default coordinates, not 0, 0	2570	# use -1 or undef as default coordinates, not 0, 0
1738	($x, $y) = ($map->enter_x, $map->enter_y)	2571	($x, $y) = ($map->enter_x, $map->enter_y)
1739	if $x <=0 && $y <= 0;	2572	if $x <=0 && $y <= 0;
1740		2573
1741	$map->load;	2574	$map->load;
1742	$map->load_diag;	2575	$map->load_neighbours;
1743		2576
1744	return unless $self->contr->active;	2577	return unless $self->contr->active;
1745	$self->activate_recursive;	2578	$self->activate_recursive;
		2579
		2580	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1746	$self->enter_map ($map, $x, $y);	2581	$self->enter_map ($map, $x, $y);
1747	}	2582	}
1748		2583
1749	cf::player->attach (	2584	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1750	on_logout => sub {
1751	my ($pl) = @_;
1752		2585
1753	# abort map switching before logout	2586	Moves the player to the given map-path and coordinates by first freezing
1754	if ($pl->ob->{_link_pos}) {	2587	her, loading and preparing them map, calling the provided $check callback
1755	cf::sync_job {	2588	that has to return the map if sucecssful, and then unfreezes the player on
1756	$pl->ob->leave_link	2589	the new (success) or old (failed) map position. In either case, $done will
1757	};	2590	be called at the end of this process.
1758	}
1759	},
1760	on_login => sub {
1761	my ($pl) = @_;
1762		2591
1763	# try to abort aborted map switching on player login :)
1764	# should happen only on crashes
1765	if ($pl->ob->{_link_pos}) {
1766	$pl->ob->enter_link;
1767	(async {
1768	# we need this sleep as the login has a concurrent enter_exit running
1769	# and this sleep increases chances of the player not ending up in scorn
1770	$pl->ob->reply (undef,
1771	"There was an internal problem at your last logout, "
1772	. "the server will try to bring you to your intended destination in a second.",
1773	cf::NDI_RED);
1774	Coro::Timer::sleep 1;
1775	$pl->ob->leave_link;
1776	})->prio (2);
1777	}
1778	},
1779	);
1780
1781	=item $player_object->goto ($path, $x, $y)
1782
1783	=cut	2592	=cut
		2593
		2594	our $GOTOGEN;
1784		2595
1785	sub cf::object::player::goto {	2596	sub cf::object::player::goto {
1786	my ($self, $path, $x, $y) = @_;	2597	my ($self, $path, $x, $y, $check, $done) = @_;
1787		2598
1788	$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;
1789		2601
1790	$self->enter_link;	2602	$self->enter_link;
1791		2603
1792	(async {	2604	(async {
1793	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) {
1794	$map = $map->customise_for ($self) if $map;	2630	$map = $map->customise_for ($self);
1795		2631	$map = $check->($map) if $check && $map;
1796	# warn "entering ", $map->path, " at ($x, $y)\n"	2632	} else {
1797	# if $map;
1798
1799	$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	}
1800		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};
1801	$self->leave_link ($map, $x, $y);	2646	$self->leave_link ($map, $x, $y);
		2647	}
		2648
		2649	$done->() if $done;
1802	})->prio (1);	2650	})->prio (1);
1803	}	2651	}
1804		2652
1805	=item $player_object->enter_exit ($exit_object)	2653	=item $player_object->enter_exit ($exit_object)
1806		2654
…		…
1808		2656
1809	sub parse_random_map_params {	2657	sub parse_random_map_params {
1810	my ($spec) = @_;	2658	my ($spec) = @_;
1811		2659
1812	my $rmp = { # defaults	2660	my $rmp = { # defaults
1813	xsize => 10,	2661	xsize => (cf::rndm 15, 40),
1814	ysize => 10,	2662	ysize => (cf::rndm 15, 40),
		2663	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2664	#layout => string,
1815	};	2665	};
1816		2666
1817	for (split /\n/, $spec) {	2667	for (split /\n/, $spec) {
1818	my ($k, $v) = split /\s+/, $_, 2;	2668	my ($k, $v) = split /\s+/, $_, 2;
1819		2669
…		…
1823	$rmp	2673	$rmp
1824	}	2674	}
1825		2675
1826	sub prepare_random_map {	2676	sub prepare_random_map {
1827	my ($exit) = @_;	2677	my ($exit) = @_;
		2678
		2679	my $guard = cf::lock_acquire "exit_prepare:$exit";
1828		2680
1829	# all this does is basically replace the /! path by	2681	# all this does is basically replace the /! path by
1830	# a new random map path (?random/...) with a seed	2682	# a new random map path (?random/...) with a seed
1831	# that depends on the exit object	2683	# that depends on the exit object
1832		2684
1833	my $rmp = parse_random_map_params $exit->msg;	2685	my $rmp = parse_random_map_params $exit->msg;
1834		2686
1835	if ($exit->map) {	2687	if ($exit->map) {
1836	$rmp->{region} = $exit->map->region_name;	2688	$rmp->{region} = $exit->region->name;
1837	$rmp->{origin_map} = $exit->map->path;	2689	$rmp->{origin_map} = $exit->map->path;
1838	$rmp->{origin_x} = $exit->x;	2690	$rmp->{origin_x} = $exit->x;
1839	$rmp->{origin_y} = $exit->y;	2691	$rmp->{origin_y} = $exit->y;
1840	}	2692	}
1841		2693
1842	$rmp->{random_seed} ||= $exit->random_seed;	2694	$rmp->{random_seed} ||= $exit->random_seed;
1843		2695
1844	my $data = cf::to_json $rmp;	2696	my $data = cf::encode_json $rmp;
1845	my $md5 = Digest::MD5::md5_hex $data;	2697	my $md5 = Digest::MD5::md5_hex $data;
		2698	my $meta = "$RANDOMDIR/$md5.meta";
1846		2699
1847	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) {
1848	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;
1849		2704
1850	$exit->slaying ("?random/$md5");	2705	$exit->slaying ("?random/$md5");
1851	$exit->msg (undef);	2706	$exit->msg (undef);
1852	}	2707	}
1853	}	2708	}
…		…
1855	sub cf::object::player::enter_exit {	2710	sub cf::object::player::enter_exit {
1856	my ($self, $exit) = @_;	2711	my ($self, $exit) = @_;
1857		2712
1858	return unless $self->type == cf::PLAYER;	2713	return unless $self->type == cf::PLAYER;
1859		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
1860	$self->enter_link;	2726	$self->enter_link;
1861		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
1862	(async {	2732	(async {
		2733	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2734
1863	$self->deactivate_recursive; # just to be sure	2735	$self->deactivate_recursive; # just to be sure
1864	unless (eval {	2736	unless (eval {
1865	prepare_random_map $exit	2737	$self->goto ($slaying, $hp, $sp);
1866	if $exit->slaying eq "/!";
1867
1868	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1869	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1870		2738
1871	1;	2739	1;
1872	}) {	2740	}) {
1873	$self->message ("Something went wrong deep within the crossfire server. "	2741	$self->message ("Something went wrong deep within the crossfire server. "
1874	. "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. "
1875	. "Please report this to the dungeon master!",	2743	. "Please report this to the dungeon master!",
1876	cf::NDI_UNIQUE | cf::NDI_RED);	2744	cf::NDI_UNIQUE | cf::NDI_RED);
1877		2745
1878	warn "ERROR in enter_exit: $@";	2746	warn "ERROR in enter_exit: $@";
1879	$self->leave_link;	2747	$self->leave_link;
1880	}	2748	}
1881	})->prio (1);	2749	})->prio (1);
…		…
1894		2762
1895	sub cf::client::send_drawinfo {	2763	sub cf::client::send_drawinfo {
1896	my ($self, $text, $flags) = @_;	2764	my ($self, $text, $flags) = @_;
1897		2765
1898	utf8::encode $text;	2766	utf8::encode $text;
1899	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2767	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1900	}	2768	}
1901		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	}
1902		2928
1903	=item $success = $client->query ($flags, "text", \&cb)	2929	=item $success = $client->query ($flags, "text", \&cb)
1904		2930
1905	Queues a query to the client, calling the given callback with	2931	Queues a query to the client, calling the given callback with
1906	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>,
1907	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>.
1908		2934
1909	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
1910	reliable at some point in the future.	2936	become reliable at some point in the future.
1911		2937
1912	=cut	2938	=cut
1913		2939
1914	sub cf::client::query {	2940	sub cf::client::query {
1915	my ($self, $flags, $text, $cb) = @_;	2941	my ($self, $flags, $text, $cb) = @_;
…		…
1923	utf8::encode $text;	2949	utf8::encode $text;
1924	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2950	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1925		2951
1926	$self->send_packet ($self->{query_queue}[0][0])	2952	$self->send_packet ($self->{query_queue}[0][0])
1927	if @{ $self->{query_queue} } == 1;	2953	if @{ $self->{query_queue} } == 1;
		2954
		2955	1
1928	}	2956	}
1929		2957
1930	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	},
1931	on_reply => sub {	2964	on_reply => sub {
1932	my ($ns, $msg) = @_;	2965	my ($ns, $msg) = @_;
1933		2966
1934	# this weird shuffling is so that direct followup queries	2967	# this weird shuffling is so that direct followup queries
1935	# get handled first	2968	# get handled first
1936	my $queue = delete $ns->{query_queue}	2969	my $queue = delete $ns->{query_queue}
1937	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
1938		2971
1939	(shift @$queue)->[1]->($msg);	2972	(shift @$queue)->[1]->($msg);
		2973	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1940		2974
1941	push @{ $ns->{query_queue} }, @$queue;	2975	push @{ $ns->{query_queue} }, @$queue;
1942		2976
1943	if (@{ $ns->{query_queue} } == @$queue) {	2977	if (@{ $ns->{query_queue} } == @$queue) {
1944	if (@$queue) {	2978	if (@$queue) {
…		…
1946	} else {	2980	} else {
1947	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2981	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1948	}	2982	}
1949	}	2983	}
1950	},	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	},
1951	);	3011	);
1952		3012
1953	=item $client->async (\&cb)	3013	=item $client->async (\&cb)
1954		3014
1955	Create a new coroutine, running the specified callback. The coroutine will	3015	Create a new coroutine, running the specified callback. The coroutine will
…		…
1996	our $safe = new Safe "safe";	3056	our $safe = new Safe "safe";
1997	our $safe_hole = new Safe::Hole;	3057	our $safe_hole = new Safe::Hole;
1998		3058
1999	$SIG{FPE} = 'IGNORE';	3059	$SIG{FPE} = 'IGNORE';
2000		3060
2001	$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	));
2002		3066
2003	# here we export the classes and methods available to script code	3067	# here we export the classes and methods available to script code
2004		3068
2005	=pod	3069	=pod
2006		3070
2007	The following fucntions and emthods are available within a safe environment:	3071	The following functions and methods are available within a safe environment:
2008		3072
2009	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
2010	cf::object::player player	3077	cf::object::player
2011	cf::player peaceful	3078	player
2012	cf::map trigger	3079
		3080	cf::player
		3081	peaceful
		3082
		3083	cf::map
		3084	trigger
2013		3085
2014	=cut	3086	=cut
2015		3087
2016	for (	3088	for (
2017	["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)],
2018	["cf::object::player" => qw(player)],	3092	["cf::object::player" => qw(player)],
2019	["cf::player" => qw(peaceful)],	3093	["cf::player" => qw(peaceful)],
2020	["cf::map" => qw(trigger)],	3094	["cf::map" => qw(trigger)],
2021	) {	3095	) {
2022	no strict 'refs';	3096	no strict 'refs';
…		…
2093	=back	3167	=back
2094		3168
2095	=cut	3169	=cut
2096		3170
2097	#############################################################################	3171	#############################################################################
		3172	# the server's init and main functions
2098		3173
2099	=head2 EXTENSION DATABASE SUPPORT	3174	sub load_facedata($) {
		3175	my ($path) = @_;
2100		3176
2101	Crossfire maintains a very simple database for extension use. It can	3177	# HACK to clear player env face cache, we need some signal framework
2102	currently store anything that can be serialised using Storable, which	3178	# for this (global event?)
2103	excludes objects.	3179	%ext::player_env::MUSIC_FACE_CACHE = ();
2104		3180
2105	The parameter C<$family> should best start with the name of the extension	3181	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2106	using it, it should be unique.
2107		3182
2108	=over 4	3183	warn "loading facedata from $path\n";
2109		3184
2110	=item $hashref = cf::db_get $family	3185	my $facedata;
		3186	0 < aio_load $path, $facedata
		3187	or die "$path: $!";
2111		3188
2112	Return a hashref for use by the extension C<$family>, which can be	3189	$facedata = Coro::Storable::thaw $facedata;
2113	modified. After modifications, you have to call C<cf::db_dirty> or
2114	C<cf::db_sync>.
2115		3190
2116	=item $value = cf::db_get $family => $key	3191	$facedata->{version} == 2
		3192	or cf::cleanup "$path: version mismatch, cannot proceed.";
2117		3193
2118	Returns a single value from the database	3194	# patch in the exptable
2119		3195	$facedata->{resource}{"res/exp_table"} = {
2120	=item cf::db_put $family => $hashref	3196	type => FT_RSRC,
2121		3197	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2122	Stores the given family hashref into the database. Updates are delayed, if
2123	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2124
2125	=item cf::db_put $family => $key => $value
2126
2127	Stores the given C<$value> in the family hash. Updates are delayed, if you
2128	want the data to be synced to disk immediately, use C<cf::db_sync>.
2129
2130	=item cf::db_dirty
2131
2132	Marks the database as dirty, to be updated at a later time.
2133
2134	=item cf::db_sync
2135
2136	Immediately write the database to disk I<if it is dirty>.
2137
2138	=cut
2139
2140	our $DB;
2141
2142	{
2143	my $path = cf::localdir . "/database.pst";
2144
2145	sub db_load() {
2146	$DB = stat $path ? Storable::retrieve $path : { };
2147	}
2148
2149	my $pid;
2150
2151	sub db_save() {
2152	waitpid $pid, 0 if $pid;
2153	if (0 == ($pid = fork)) {
2154	$DB->{_meta}{version} = 1;
2155	Storable::nstore $DB, "$path~";
2156	rename "$path~", $path;
2157	cf::_exit 0 if defined $pid;
2158	}
2159	}
2160
2161	my $dirty;
2162
2163	sub db_sync() {
2164	db_save if $dirty;
2165	undef $dirty;
2166	}
2167
2168	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2169	db_sync;
2170	});	3198	};
		3199	cf::cede_to_tick;
2171		3200
2172	sub db_dirty() {
2173	$dirty = 1;
2174	$idle->start;
2175	}	3201	{
		3202	my $faces = $facedata->{faceinfo};
2176		3203
2177	sub db_get($;$) {	3204	while (my ($face, $info) = each %$faces) {
2178	@_ >= 2	3205	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2179	? $DB->{$_[0]}{$_[1]}
2180	: ($DB->{$_[0]} ||= { })
2181	}
2182		3206
2183	sub db_put($$;$) {	3207	cf::face::set_visibility $idx, $info->{visibility};
2184	if (@_ >= 3) {	3208	cf::face::set_magicmap $idx, $info->{magicmap};
2185	$DB->{$_[0]}{$_[1]} = $_[2];	3209	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2186	} else {	3210	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2187	$DB->{$_[0]} = $_[1];
2188	}
2189	db_dirty;
2190	}
2191		3211
2192	cf::global->attach (	3212	cf::cede_to_tick;
2193	prio => 10000,
2194	on_cleanup => sub {
2195	db_sync;
2196	},	3213	}
2197	);
2198	}
2199		3214
2200	#############################################################################	3215	while (my ($face, $info) = each %$faces) {
2201	# the server's main()	3216	next unless $info->{smooth};
2202		3217
2203	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 {
2204	open my $fh, "<:utf8", cf::confdir . "/config"	3360	open my $fh, "<:utf8", "$CONFDIR/config"
2205	or return;	3361	or return;
2206		3362
2207	local $/;	3363	local $/;
2208	*CFG = YAML::Syck::Load <$fh>;	3364	*CFG = YAML::Load <$fh>;
2209		3365
2210	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3366	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2211		3367
2212	$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};
2213	$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};
…		…
2223		3379
2224	sub main {	3380	sub main {
2225	# we must not ever block the main coroutine	3381	# we must not ever block the main coroutine
2226	local $Coro::idle = sub {	3382	local $Coro::idle = sub {
2227	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#
2228	async { Event::one_event };	3384	(async {
		3385	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3386	EV::loop EV::LOOP_ONESHOT;
		3387	})->prio (Coro::PRIO_MAX);
2229	};	3388	};
2230		3389
2231	cfg_load;	3390	reload_config;
2232	db_load;	3391	db_init;
2233	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;
2234	Event::loop;	3396	EV::loop;
2235	}	3397	}
2236		3398
2237	#############################################################################	3399	#############################################################################
2238	# initialisation and cleanup	3400	# initialisation and cleanup
2239		3401
2240	# install some emergency cleanup handlers	3402	# install some emergency cleanup handlers
2241	BEGIN {	3403	BEGIN {
		3404	our %SIGWATCHER = ();
2242	for my $signal (qw(INT HUP TERM)) {	3405	for my $signal (qw(INT HUP TERM)) {
2243	Event->signal (	3406	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2244	data => WF_AUTOCANCEL,
2245	signal => $signal,
2246	cb => sub {
2247	cf::cleanup "SIG$signal";	3407	cf::cleanup "SIG$signal";
2248	},
2249	);	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
2250	}	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 };
2251	}	3491	}
2252		3492
2253	sub emergency_save() {	3493	sub emergency_save() {
2254	my $freeze_guard = cf::freeze_mainloop;	3494	my $freeze_guard = cf::freeze_mainloop;
2255		3495
2256	warn "enter emergency perl save\n";	3496	warn "enter emergency perl save\n";
2257		3497
2258	cf::sync_job {	3498	cf::sync_job {
2259	# use a peculiar iteration method to avoid tripping on perl	3499	# use a peculiar iteration method to avoid tripping on perl
2260	# refcount bugs in for. also avoids problems with players	3500	# refcount bugs in for. also avoids problems with players
2261	# and maps saved/Destroyed asynchronously.	3501	# and maps saved/destroyed asynchronously.
2262	warn "begin emergency player save\n";	3502	warn "begin emergency player save\n";
2263	for my $login (keys %cf::PLAYER) {	3503	for my $login (keys %cf::PLAYER) {
2264	my $pl = $cf::PLAYER{$login} or next;	3504	my $pl = $cf::PLAYER{$login} or next;
2265	$pl->valid or next;	3505	$pl->valid or next;
		3506	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2266	$pl->save;	3507	$pl->save;
2267	}	3508	}
2268	warn "end emergency player save\n";	3509	warn "end emergency player save\n";
2269		3510
2270	warn "begin emergency map save\n";	3511	warn "begin emergency map save\n";
…		…
2272	my $map = $cf::MAP{$path} or next;	3513	my $map = $cf::MAP{$path} or next;
2273	$map->valid or next;	3514	$map->valid or next;
2274	$map->save;	3515	$map->save;
2275	}	3516	}
2276	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";
2277	};	3526	};
2278		3527
2279	warn "leave emergency perl save\n";	3528	warn "leave emergency perl save\n";
2280	}	3529	}
2281		3530
		3531	sub post_cleanup {
		3532	my ($make_core) = @_;
		3533
		3534	warn Carp::longmess "post_cleanup backtrace"
		3535	if $make_core;
		3536	}
		3537
2282	sub reload() {	3538	sub do_reload_perl() {
2283	# can/must only be called in main	3539	# can/must only be called in main
2284	if ($Coro::current != $Coro::main) {	3540	if ($Coro::current != $Coro::main) {
2285	warn "can only reload from main coroutine\n";	3541	warn "can only reload from main coroutine";
2286	return;	3542	return;
2287	}	3543	}
2288		3544
2289	warn "reloading...";	3545	warn "reloading...";
2290		3546
2291	warn "freezing server";	3547	warn "entering sync_job";
2292	my $guard = freeze_mainloop;	3548
		3549	cf::sync_job {
		3550	cf::write_runtime_sync; # external watchdog should not bark
2293	cf::emergency_save;	3551	cf::emergency_save;
		3552	cf::write_runtime_sync; # external watchdog should not bark
2294		3553
2295	warn "sync database to disk";	3554	warn "syncing database to disk";
2296	cf::db_sync;	3555	BDB::db_env_txn_checkpoint $DB_ENV;
2297	IO::AIO::flush;
2298		3556
2299	eval {
2300	# 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
2301		3558
2302	warn "cancel all watchers";	3559	warn "flushing outstanding aio requests";
2303	for (Event::all_watchers) {	3560	for (;;) {
2304	$_->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...";
2305	}	3566	}
2306		3567
		3568	++$RELOAD;
		3569
2307	warn "cancel all extension coros";	3570	warn "cancelling all extension coros";
2308	$_->cancel for values %EXT_CORO;	3571	$_->cancel for values %EXT_CORO;
2309	%EXT_CORO = ();	3572	%EXT_CORO = ();
2310		3573
2311	warn "remove commands";	3574	warn "removing commands";
2312	%COMMAND = ();	3575	%COMMAND = ();
2313		3576
2314	warn "remove ext commands";	3577	warn "removing ext/exti commands";
2315	%EXTCMD = ();	3578	%EXTCMD = ();
		3579	%EXTICMD = ();
2316		3580
2317	warn "unload/nuke all extensions";	3581	warn "unloading/nuking all extensions";
2318	for my $pkg (@EXTS) {	3582	for my $pkg (@EXTS) {
2319	warn "unloading <$pkg>";	3583	warn "... unloading $pkg";
2320		3584
2321	if (my $cb = $pkg->can ("unload")) {	3585	if (my $cb = $pkg->can ("unload")) {
2322	eval {	3586	eval {
2323	$cb->($pkg);	3587	$cb->($pkg);
2324	1	3588	1
2325	} or warn "$pkg unloaded, but with errors: $@";	3589	} or warn "$pkg unloaded, but with errors: $@";
2326	}	3590	}
2327		3591
		3592	warn "... nuking $pkg";
2328	Symbol::delete_package $pkg;	3593	Symbol::delete_package $pkg;
2329	}	3594	}
2330		3595
2331	warn "unload all perl modules loaded from $LIBDIR";	3596	warn "unloading all perl modules loaded from $LIBDIR";
2332	while (my ($k, $v) = each %INC) {	3597	while (my ($k, $v) = each %INC) {
2333	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3598	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2334		3599
2335	warn "removing <$k>";	3600	warn "... unloading $k";
2336	delete $INC{$k};	3601	delete $INC{$k};
2337		3602
2338	$k =~ s/\.pm$//;	3603	$k =~ s/\.pm$//;
2339	$k =~ s/\//::/g;	3604	$k =~ s/\//::/g;
2340		3605
…		…
2343	}	3608	}
2344		3609
2345	Symbol::delete_package $k;	3610	Symbol::delete_package $k;
2346	}	3611	}
2347		3612
2348	warn "get rid of safe::, as good as possible";	3613	warn "getting rid of safe::, as good as possible";
2349	Symbol::delete_package "safe::$_"	3614	Symbol::delete_package "safe::$_"
2350	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);
2351		3616
2352	warn "unload cf.pm \"a bit\"";	3617	warn "unloading cf.pm \"a bit\"";
2353	delete $INC{"cf.pm"};	3618	delete $INC{"cf.pm"};
		3619	delete $INC{"cf/pod.pm"};
2354		3620
2355	# don't, removes xs symbols, too,	3621	# don't, removes xs symbols, too,
2356	# and global variables created in xs	3622	# and global variables created in xs
2357	#Symbol::delete_package __PACKAGE__;	3623	#Symbol::delete_package __PACKAGE__;
2358		3624
		3625	warn "unload completed, starting to reload now";
		3626
2359	warn "reloading cf.pm";	3627	warn "reloading cf.pm";
2360	require cf;	3628	require cf;
2361	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3629	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2362		3630
2363	warn "load config and database again";	3631	warn "loading config and database again";
2364	cf::cfg_load;	3632	cf::reload_config;
2365	cf::db_load;
2366		3633
2367	warn "load extensions";	3634	warn "loading extensions";
2368	cf::load_extensions;	3635	cf::load_extensions;
2369		3636
2370	warn "reattach attachments to objects/players";	3637	warn "reattaching attachments to objects/players";
2371	_global_reattach;	3638	_global_reattach; # objects, sockets
2372	warn "reattach attachments to maps";	3639	warn "reattaching attachments to maps";
2373	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.";
2374	};	3650	};
2375
2376	if ($@) {
2377	warn $@;
2378	warn "error while reloading, exiting.";
2379	exit 1;
2380	}
2381		3651
2382	warn "reloaded";	3652	warn "reloaded";
2383	};	3653	};
2384		3654
2385	#############################################################################	3655	our $RELOAD_WATCHER; # used only during reload
2386		3656
2387	unless ($LINK_MAP) {	3657	sub reload_perl() {
2388	$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.
2389		3660
2390	$LINK_MAP->width (41);	3661	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2391	$LINK_MAP->height (41);	3662	do_reload_perl;
2392	$LINK_MAP->alloc;	3663	undef $RELOAD_WATCHER;
2393	$LINK_MAP->path ("{link}");	3664	};
2394	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2395	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2396
2397	# dirty hack because... archetypes are not yet loaded
2398	Event->timer (
2399	after => 10,
2400	cb => sub {
2401	$_[0]->w->cancel;
2402
2403	# provide some exits "home"
2404	my $exit = cf::object::new "exit";
2405
2406	$exit->slaying ($EMERGENCY_POSITION->[0]);
2407	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2408	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2409
2410	$LINK_MAP->insert ($exit->clone, 19, 19);
2411	$LINK_MAP->insert ($exit->clone, 19, 20);
2412	$LINK_MAP->insert ($exit->clone, 19, 21);
2413	$LINK_MAP->insert ($exit->clone, 20, 19);
2414	$LINK_MAP->insert ($exit->clone, 20, 21);
2415	$LINK_MAP->insert ($exit->clone, 21, 19);
2416	$LINK_MAP->insert ($exit->clone, 21, 20);
2417	$LINK_MAP->insert ($exit->clone, 21, 21);
2418
2419	$exit->destroy;
2420	});
2421
2422	$LINK_MAP->{deny_save} = 1;
2423	$LINK_MAP->{deny_reset} = 1;
2424
2425	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2426	}	3665	}
2427		3666
2428	register_command "reload" => sub {	3667	register_command "reload" => sub {
2429	my ($who, $arg) = @_;	3668	my ($who, $arg) = @_;
2430		3669
2431	if ($who->flag (FLAG_WIZ)) {	3670	if ($who->flag (FLAG_WIZ)) {
2432	$who->message ("start of reload.");
2433	reload;
2434	$who->message ("end of reload.");	3671	$who->message ("reloading server.");
		3672	async {
		3673	$Coro::current->{desc} = "perl_reload";
		3674	reload_perl;
		3675	};
2435	}	3676	}
2436	};	3677	};
2437		3678
2438	unshift @INC, $LIBDIR;	3679	unshift @INC, $LIBDIR;
2439		3680
2440	$TICK_WATCHER = Event->timer (	3681	my $bug_warning = 0;
2441	reentrant => 0,	3682
2442	prio => 0,	3683	our @WAIT_FOR_TICK;
2443	at => $NEXT_TICK || $TICK,	3684	our @WAIT_FOR_TICK_BEGIN;
2444	data => WF_AUTOCANCEL,	3685
2445	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
2446	cf::server_tick; # one server iteration	3711	cf::server_tick; # one server iteration
2447	$RUNTIME += $TICK;
2448	$NEXT_TICK += $TICK;
2449		3712
2450	$WAIT_FOR_TICK->broadcast;	3713	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2451	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3714	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2452		3715	Coro::async_pool {
2453	# if we are delayed by four ticks or more, skip them all	3716	$Coro::current->{desc} = "runtime saver";
2454	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2455
2456	$TICK_WATCHER->at ($NEXT_TICK);
2457	$TICK_WATCHER->start;
2458	},
2459	);
2460
2461	IO::AIO::max_poll_time $TICK * 0.2;
2462
2463	Event->io (
2464	fd => IO::AIO::poll_fileno,
2465	poll => 'r',
2466	prio => 5,
2467	data => WF_AUTOCANCEL,
2468	cb => \&IO::AIO::poll_cb,
2469	);
2470
2471	Event->timer (
2472	data => WF_AUTOCANCEL,
2473	after => 0,
2474	interval => 10,
2475	cb => sub {
2476	(Coro::unblock_sub {
2477	write_runtime	3717	write_runtime_sync
2478	or warn "ERROR: unable to write runtime file: $!";	3718	or warn "ERROR: unable to write runtime file: $!";
2479	})->();	3719	};
2480	},	3720	}
2481	);	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;
2482		3832
2483	END { cf::emergency_save }	3833	END { cf::emergency_save }
2484		3834
2485	1	3835	1
2486		3836

Diff Legend

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