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.136 by root, Fri Jan 5 01:06:28 2007 UTC vs.
Revision 1.450 by root, Mon Sep 22 01:33:09 2008 UTC

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

Diff Legend

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