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

Diff Legend

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