ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.159 by root, Wed Jan 10 22:50:12 2007 UTC vs.
Revision 1.463 by root, Sun Dec 28 06:59:27 2008 UTC

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

Diff Legend

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