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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.449 by root, Sat Sep 20 00:09:27 2008 UTC

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

Diff Legend

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