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

Diff Legend

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