ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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