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

Diff Legend

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