ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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