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

Diff Legend

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