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

Diff Legend

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