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.129 by root, Wed Jan 3 00:41:19 2007 UTC vs.
Revision 1.464 by root, Thu Jan 1 18:35:48 2009 UTC

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

Diff Legend

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