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.130 by root, Thu Jan 4 00:08:08 2007 UTC vs.
Revision 1.426 by root, Thu Apr 24 04:40:31 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	chmod SAVE_MODE, $fh;
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	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	chmod SAVE_MODE, $fh;
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	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";
…		…
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	local $cf::PLAYER_LOADING{$login} = $pl;
		1462	$f->resolve_delayed_derefs;
		1463	$cf::PLAYER{$login} = $pl
		1464	}
		1465	}
		1466	}
		1467
		1468	sub save($) {
		1469	my ($pl) = @_;
		1470
		1471	return if $pl->{deny_save};
		1472
		1473	my $path = path $pl;
		1474	my $guard = cf::lock_acquire "user_save:$path";
		1475
		1476	return if $pl->{deny_save};
		1477
		1478	aio_mkdir playerdir $pl, 0770;
		1479	$pl->{last_save} = $cf::RUNTIME;
		1480
		1481	cf::get_slot 0.01;
		1482
		1483	$pl->save_pl ($path);
		1484	cf::cede_to_tick;
		1485	}
		1486
		1487	sub new($) {
		1488	my ($login) = @_;
		1489
		1490	my $self = create;
		1491
		1492	$self->ob->name ($login);
		1493	$self->{deny_save} = 1;
		1494
		1495	$cf::PLAYER{$login} = $self;
		1496
		1497	$self
		1498	}
		1499
		1500	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1501
		1502	=cut
		1503
		1504	sub send_msg {
		1505	my $ns = shift->ns
		1506	or return;
		1507	$ns->send_msg (@_);
		1508	}
		1509
		1510	=item $pl->quit_character
		1511
		1512	Nukes the player without looking back. If logged in, the connection will
		1513	be destroyed. May block for a long time.
		1514
		1515	=cut
		1516
		1517	sub quit_character {
		1518	my ($pl) = @_;
		1519
		1520	my $name = $pl->ob->name;
		1521
		1522	$pl->{deny_save} = 1;
		1523	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1524
		1525	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1526	$pl->deactivate;
		1527	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1528	$pl->ns->destroy if $pl->ns;
		1529
		1530	my $path = playerdir $pl;
		1531	my $temp = "$path~$cf::RUNTIME~deleting~";
		1532	aio_rename $path, $temp;
		1533	delete $cf::PLAYER{$pl->ob->name};
		1534	$pl->destroy;
		1535
		1536	my $prefix = qr<^~\Q$name\E/>;
		1537
		1538	# nuke player maps
		1539	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1540
		1541	IO::AIO::aio_rmtree $temp;
		1542	}
		1543
		1544	=item $pl->kick
		1545
		1546	Kicks a player out of the game. This destroys the connection.
		1547
		1548	=cut
		1549
		1550	sub kick {
		1551	my ($pl, $kicker) = @_;
		1552
		1553	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1554	$pl->killer ("kicked");
		1555	$pl->ns->destroy;
		1556	}
		1557
		1558	=item cf::player::list_logins
		1559
		1560	Returns am arrayref of all valid playernames in the system, can take a
		1561	while and may block, so not sync_job-capable, ever.
		1562
		1563	=cut
		1564
		1565	sub list_logins {
		1566	my $dirs = aio_readdir $PLAYERDIR
		1567	or return [];
		1568
		1569	my @logins;
		1570
		1571	for my $login (@$dirs) {
		1572	my $path = path $login;
		1573
		1574	# a .pst is a dead give-away for a valid player
		1575	unless (-e "$path.pst") {
		1576	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1577	aio_read $fh, 0, 512, my $buf, 0 or next;
		1578	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1579	}
		1580
		1581	utf8::decode $login;
		1582	push @logins, $login;
		1583	}
		1584
		1585	\@logins
		1586	}
		1587
		1588	=item $player->maps
		1589
		1590	Returns an arrayref of map paths that are private for this
		1591	player. May block.
		1592
		1593	=cut
		1594
		1595	sub maps($) {
		1596	my ($pl) = @_;
		1597
		1598	$pl = ref $pl ? $pl->ob->name : $pl;
		1599
		1600	my $files = aio_readdir playerdir $pl
		1601	or return;
		1602
		1603	my @paths;
		1604
		1605	for (@$files) {
		1606	utf8::decode $_;
		1607	next if /\.(?:pl|pst)$/;
		1608	next unless /^$PATH_SEP/o;
		1609
		1610	push @paths, cf::map::normalise "~$pl/$_";
		1611	}
		1612
		1613	\@paths
		1614	}
		1615
		1616	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1617
		1618	Expand crossfire pod fragments into protocol xml.
		1619
		1620	=cut
		1621
		1622	use re 'eval';
		1623
		1624	my $group;
		1625	my $interior; $interior = qr{
		1626	# match a pod interior sequence sans C<< >>
		1627	(?:
		1628	\ (.*?)\ (?{ $group = $^N })
		1629	| < (??{$interior}) >
		1630	)
		1631	}x;
		1632
		1633	sub expand_cfpod {
		1634	my ($self, $pod) = @_;
		1635
		1636	my $xml;
		1637
		1638	while () {
		1639	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1640	$group = $1;
		1641
		1642	$group =~ s/&/&amp;/g;
		1643	$group =~ s/</&lt;/g;
		1644
		1645	$xml .= $group;
		1646	} elsif ($pod =~ m%\G
		1647	([BCGHITU])
		1648	<
		1649	(?:
		1650	([^<>]*) (?{ $group = $^N })
		1651	| < $interior >
		1652	)
		1653	>
		1654	%gcsx
		1655	) {
		1656	my ($code, $data) = ($1, $group);
		1657
		1658	if ($code eq "B") {
		1659	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1660	} elsif ($code eq "I") {
		1661	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1662	} elsif ($code eq "U") {
		1663	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1664	} elsif ($code eq "C") {
		1665	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1666	} elsif ($code eq "T") {
		1667	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1668	} elsif ($code eq "G") {
		1669	my ($male, $female) = split /\|/, $data;
		1670	$data = $self->gender ? $female : $male;
		1671	$xml .= expand_cfpod ($self, $data);
		1672	} elsif ($code eq "H") {
		1673	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1674	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1675	"")
		1676	[$self->{hintmode}];
		1677	} else {
		1678	$xml .= "error processing '$code($data)' directive";
		1679	}
		1680	} else {
		1681	if ($pod =~ /\G(.+)/) {
		1682	warn "parse error while expanding $pod (at $1)";
		1683	}
		1684	last;
		1685	}
		1686	}
		1687
		1688	for ($xml) {
		1689	# create single paragraphs (very hackish)
		1690	s/(?<=\S)\n(?=\w)/ /g;
		1691
		1692	# compress some whitespace
		1693	s/\s+\n/\n/g; # ws line-ends
		1694	s/\n\n+/\n/g; # double lines
		1695	s/^\n+//; # beginning lines
		1696	s/\n+$//; # ending lines
		1697	}
		1698
		1699	$xml
		1700	}
		1701
		1702	no re 'eval';
		1703
		1704	sub hintmode {
		1705	$_[0]{hintmode} = $_[1] if @_ > 1;
		1706	$_[0]{hintmode}
		1707	}
		1708
		1709	=item $player->ext_reply ($msgid, @msg)
		1710
		1711	Sends an ext reply to the player.
		1712
		1713	=cut
		1714
		1715	sub ext_reply($$@) {
		1716	my ($self, $id, @msg) = @_;
		1717
		1718	$self->ns->ext_reply ($id, @msg)
		1719	}
		1720
		1721	=item $player->ext_msg ($type, @msg)
		1722
		1723	Sends an ext event to the client.
		1724
		1725	=cut
		1726
		1727	sub ext_msg($$@) {
		1728	my ($self, $type, @msg) = @_;
		1729
		1730	$self->ns->ext_msg ($type, @msg);
		1731	}
		1732
		1733	=head3 cf::region
		1734
		1735	=over 4
		1736
		1737	=cut
		1738
		1739	package cf::region;
		1740
		1741	=item cf::region::find_by_path $path
		1742
		1743	Tries to decuce the likely region for a map knowing only its path.
		1744
		1745	=cut
		1746
		1747	sub find_by_path($) {
978	my ($path) = @_;	1748	my ($path) = @_;
979		1749
980	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1750	my ($match, $specificity);
981	my $base = $1;
982	my $pkg = $1;
983	$pkg =~ s/[^[:word:]]/_/g;
984	$pkg = "ext::$pkg";
985		1751
986	warn "loading '$path' into '$pkg'\n";	1752	for my $region (list) {
987		1753	if ($region->{match} && $path =~ $region->{match}) {
988	open my $fh, "<:utf8", $path	1754	($match, $specificity) = ($region, $region->specificity)
989	or die "$path: $!";	1755	if $region->specificity > $specificity;
990		1756	}
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	# }	1757	}
1020		1758
1021	# remove commands	1759	$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	}	1760	}
1127		1761
1128	=back	1762	=back
1129
1130		1763
1131	=head3 cf::map	1764	=head3 cf::map
1132		1765
1133	=over 4	1766	=over 4
1134		1767
…		…
1137	package cf::map;	1770	package cf::map;
1138		1771
1139	use Fcntl;	1772	use Fcntl;
1140	use Coro::AIO;	1773	use Coro::AIO;
1141		1774
		1775	use overload
		1776	'""' => \&as_string,
		1777	fallback => 1;
		1778
1142	our $MAX_RESET = 7200;	1779	our $MAX_RESET = 3600;
1143	our $DEFAULT_RESET = 3600;	1780	our $DEFAULT_RESET = 3000;
1144		1781
1145	sub generate_random_map {	1782	sub generate_random_map {
1146	my ($path, $rmp) = @_;	1783	my ($self, $rmp) = @_;
		1784
		1785	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1147		1786
1148	# mit "rum" bekleckern, nicht	1787	# mit "rum" bekleckern, nicht
1149	cf::map::_create_random_map	1788	$self->_create_random_map (
1150	$path,
1151	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1789	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1790	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1791	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154	$rmp->{exit_on_final_map},	1792	$rmp->{exit_on_final_map},
1155	$rmp->{xsize}, $rmp->{ysize},	1793	$rmp->{xsize}, $rmp->{ysize},
1156	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1794	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1795	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1158	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1796	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1159	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1797	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1160	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1798	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1161	(cf::region::find $rmp->{region})	1799	(cf::region::find $rmp->{region}), $rmp->{custom}
		1800	)
		1801	}
		1802
		1803	=item cf::map->register ($regex, $prio)
		1804
		1805	Register a handler for the map path matching the given regex at the
		1806	givne priority (higher is better, built-in handlers have priority 0, the
		1807	default).
		1808
		1809	=cut
		1810
		1811	sub register {
		1812	my (undef, $regex, $prio) = @_;
		1813	my $pkg = caller;
		1814
		1815	no strict;
		1816	push @{"$pkg\::ISA"}, __PACKAGE__;
		1817
		1818	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1819	}
		1820
		1821	# also paths starting with '/'
		1822	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1823
		1824	sub thawer_merge {
		1825	my ($self, $merge) = @_;
		1826
		1827	# we have to keep some variables in memory intact
		1828	local $self->{path};
		1829	local $self->{load_path};
		1830
		1831	$self->SUPER::thawer_merge ($merge);
		1832	}
		1833
		1834	sub normalise {
		1835	my ($path, $base) = @_;
		1836
		1837	$path = "$path"; # make sure its a string
		1838
		1839	$path =~ s/\.map$//;
		1840
		1841	# map plan:
		1842	#
		1843	# /! non-realised random map exit (special hack!)
		1844	# {... are special paths that are not being touched
		1845	# ?xxx/... are special absolute paths
		1846	# ?random/... random maps
		1847	# /... normal maps
		1848	# ~user/... per-player map of a specific user
		1849
		1850	$path =~ s/$PATH_SEP/\//go;
		1851
		1852	# treat it as relative path if it starts with
		1853	# something that looks reasonable
		1854	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1855	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1856
		1857	$base =~ s{[^/]+/?$}{};
		1858	$path = "$base/$path";
		1859	}
		1860
		1861	for ($path) {
		1862	redo if s{//}{/};
		1863	redo if s{/\.?/}{/};
		1864	redo if s{/[^/]+/\.\./}{/};
		1865	}
		1866
		1867	$path
		1868	}
		1869
		1870	sub new_from_path {
		1871	my (undef, $path, $base) = @_;
		1872
		1873	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1874
		1875	$path = normalise $path, $base;
		1876
		1877	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1878	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1879	my $self = bless cf::map::new, $pkg;
		1880	$self->{path} = $path; $self->path ($path);
		1881	$self->init; # pass $1 etc.
		1882	return $self;
		1883	}
		1884	}
		1885
		1886	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1887	()
		1888	}
		1889
		1890	sub init {
		1891	my ($self) = @_;
		1892
		1893	$self
		1894	}
		1895
		1896	sub as_string {
		1897	my ($self) = @_;
		1898
		1899	"$self->{path}"
		1900	}
		1901
		1902	# the displayed name, this is a one way mapping
		1903	sub visible_name {
		1904	&as_string
		1905	}
		1906
		1907	# the original (read-only) location
		1908	sub load_path {
		1909	my ($self) = @_;
		1910
		1911	"$MAPDIR/$self->{path}.map"
		1912	}
		1913
		1914	# the temporary/swap location
		1915	sub save_path {
		1916	my ($self) = @_;
		1917
		1918	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1919	"$TMPDIR/$path.map"
		1920	}
		1921
		1922	# the unique path, undef == no special unique path
		1923	sub uniq_path {
		1924	my ($self) = @_;
		1925
		1926	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1927	"$UNIQUEDIR/$path"
1162	}	1928	}
1163		1929
1164	# and all this just because we cannot iterate over	1930	# and all this just because we cannot iterate over
1165	# all maps in C++...	1931	# all maps in C++...
1166	sub change_all_map_light {	1932	sub change_all_map_light {
…		…
1168		1934
1169	$_->change_map_light ($change)	1935	$_->change_map_light ($change)
1170	for grep $_->outdoor, values %cf::MAP;	1936	for grep $_->outdoor, values %cf::MAP;
1171	}	1937	}
1172		1938
		1939	sub decay_objects {
		1940	my ($self) = @_;
		1941
		1942	return if $self->{deny_reset};
		1943
		1944	$self->do_decay_objects;
		1945	}
		1946
		1947	sub unlink_save {
		1948	my ($self) = @_;
		1949
		1950	utf8::encode (my $save = $self->save_path);
		1951	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1952	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1953	}
		1954
1173	sub try_load_header($) {	1955	sub load_header_from($) {
1174	my ($path) = @_;	1956	my ($self, $path) = @_;
1175		1957
1176	utf8::encode $path;	1958	utf8::encode $path;
1177	aio_open $path, O_RDONLY, 0	1959	my $f = new_from_file cf::object::thawer $path
1178	or return;	1960	or return;
1179		1961
1180	my $map = cf::map::new	1962	$self->_load_header ($f)
1181	or return;	1963	or return;
1182		1964
1183	$map->load_header ($path)	1965	local $MAP_LOADING{$self->{path}} = $self;
		1966	$f->resolve_delayed_derefs;
		1967
		1968	$self->{load_path} = $path;
		1969
		1970	1
		1971	}
		1972
		1973	sub load_header_orig {
		1974	my ($self) = @_;
		1975
		1976	$self->load_header_from ($self->load_path)
		1977	}
		1978
		1979	sub load_header_temp {
		1980	my ($self) = @_;
		1981
		1982	$self->load_header_from ($self->save_path)
		1983	}
		1984
		1985	sub prepare_temp {
		1986	my ($self) = @_;
		1987
		1988	$self->last_access ((delete $self->{last_access})
		1989	|| $cf::RUNTIME); #d#
		1990	# safety
		1991	$self->{instantiate_time} = $cf::RUNTIME
		1992	if $self->{instantiate_time} > $cf::RUNTIME;
		1993	}
		1994
		1995	sub prepare_orig {
		1996	my ($self) = @_;
		1997
		1998	$self->{load_original} = 1;
		1999	$self->{instantiate_time} = $cf::RUNTIME;
		2000	$self->last_access ($cf::RUNTIME);
		2001	$self->instantiate;
		2002	}
		2003
		2004	sub load_header {
		2005	my ($self) = @_;
		2006
		2007	if ($self->load_header_temp) {
		2008	$self->prepare_temp;
		2009	} else {
		2010	$self->load_header_orig
1184	or return;	2011	or return;
		2012	$self->prepare_orig;
		2013	}
1185		2014
1186	$map->{load_path} = $path;	2015	$self->{deny_reset} = 1
		2016	if $self->no_reset;
1187		2017
1188	$map	2018	$self->default_region (cf::region::find_by_path $self->{path})
1189	}	2019	unless $self->default_region;
1190		2020
		2021	1
		2022	}
		2023
1191	sub find_map;	2024	sub find;
1192	sub find_map {	2025	sub find {
1193	my ($path, $origin) = @_;	2026	my ($path, $origin) = @_;
1194		2027
1195	#warn "find_map<$path,$origin>\n";#d#
1196
1197	$path = new cf::path $path, $origin && $origin->path;	2028	$path = normalise $path, $origin && $origin->path;
1198	my $key = $path->as_string;
1199		2029
		2030	cf::lock_wait "map_data:$path";#d#remove
1200	cf::lock_wait "map_find:$key";	2031	cf::lock_wait "map_find:$path";
1201		2032
1202	$cf::MAP{$key} || do {	2033	$cf::MAP{$path} || do {
1203	my $guard = cf::lock_acquire "map_find:$key";	2034	my $guard1 = cf::lock_acquire "map_find:$path";
		2035	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1204		2036
1205	# do it the slow way	2037	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;	2038	or return;
1220		2039
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;	2040	$map->{last_save} = $cf::RUNTIME;
1232	$map->last_access ($cf::RUNTIME);
1233		2041
1234	if ($map->should_reset) {	2042	$map->load_header
		2043	or return;
		2044
		2045	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2046	# doing this can freeze the server in a sync job, obviously
		2047	#$cf::WAIT_FOR_TICK->wait;
		2048	undef $guard1;
		2049	undef $guard2;
1235	$map->reset;	2050	$map->reset;
1236	undef $guard;	2051	return find $path;
1237	$map = find_map $path
1238	or return;
1239	}	2052	}
1240		2053
1241	$cf::MAP{$key} = $map	2054	$cf::MAP{$path} = $map
1242	}	2055	}
1243	}	2056	}
		2057
		2058	sub pre_load { }
		2059	sub post_load { }
1244		2060
1245	sub load {	2061	sub load {
1246	my ($self) = @_;	2062	my ($self) = @_;
1247		2063
		2064	local $self->{deny_reset} = 1; # loading can take a long time
		2065
1248	my $path = $self->{path};	2066	my $path = $self->{path};
		2067
		2068	{
1249	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2069	my $guard = cf::lock_acquire "map_data:$path";
1250		2070
		2071	return unless $self->valid;
1251	return if $self->in_memory != cf::MAP_SWAPPED;	2072	return unless $self->in_memory == cf::MAP_SWAPPED;
1252		2073
1253	$self->in_memory (cf::MAP_LOADING);	2074	$self->in_memory (cf::MAP_LOADING);
1254		2075
1255	$self->alloc;	2076	$self->alloc;
1256	$self->load_objects ($self->{load_path}, 1)	2077
		2078	$self->pre_load;
		2079	cf::cede_to_tick;
		2080
		2081	my $f = new_from_file cf::object::thawer $self->{load_path};
		2082	$f->skip_block;
		2083	$self->_load_objects ($f)
1257	or return;	2084	or return;
1258		2085
1259	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2086	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1260	if delete $self->{load_original};	2087	if delete $self->{load_original};
1261		2088
1262	if (my $uniq = $path->uniq_path) {	2089	if (my $uniq = $self->uniq_path) {
1263	utf8::encode $uniq;	2090	utf8::encode $uniq;
1264	if (aio_open $uniq, O_RDONLY, 0) {	2091	unless (aio_stat $uniq) {
		2092	if (my $f = new_from_file cf::object::thawer $uniq) {
1265	$self->clear_unique_items;	2093	$self->clear_unique_items;
1266	$self->load_objects ($uniq, 0);	2094	$self->_load_objects ($f);
		2095	$f->resolve_delayed_derefs;
		2096	}
1267	}	2097	}
1268	}	2098	}
1269		2099
		2100	$f->resolve_delayed_derefs;
		2101
		2102	cf::cede_to_tick;
1270	# now do the right thing for maps	2103	# now do the right thing for maps
1271	$self->link_multipart_objects;	2104	$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)	2105	$self->difficulty ($self->estimate_difficulty)
1282	unless $self->difficulty;	2106	unless $self->difficulty;
		2107	cf::cede_to_tick;
		2108
		2109	unless ($self->{deny_activate}) {
		2110	$self->decay_objects;
		2111	$self->fix_auto_apply;
		2112	$self->update_buttons;
		2113	cf::cede_to_tick;
		2114	$self->set_darkness_map;
		2115	cf::cede_to_tick;
1283	$self->activate;	2116	$self->activate;
1284	}	2117	}
1285		2118
		2119	$self->{last_save} = $cf::RUNTIME;
		2120	$self->last_access ($cf::RUNTIME);
		2121
1286	$self->in_memory (cf::MAP_IN_MEMORY);	2122	$self->in_memory (cf::MAP_ACTIVE);
1287	}	2123	}
1288		2124
1289	sub load_map_sync {	2125	$self->post_load;
		2126	}
		2127
		2128	sub customise_for {
		2129	my ($self, $ob) = @_;
		2130
		2131	return find "~" . $ob->name . "/" . $self->{path}
		2132	if $self->per_player;
		2133
		2134	# return find "?party/" . $ob->name . "/" . $self->{path}
		2135	# if $self->per_party;
		2136
		2137	$self
		2138	}
		2139
		2140	# find and load all maps in the 3x3 area around a map
		2141	sub load_neighbours {
		2142	my ($map) = @_;
		2143
		2144	my @neigh; # diagonal neighbours
		2145
		2146	for (0 .. 3) {
		2147	my $neigh = $map->tile_path ($_)
		2148	or next;
		2149	$neigh = find $neigh, $map
		2150	or next;
		2151	$neigh->load;
		2152
		2153	push @neigh,
		2154	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2155	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2156	}
		2157
		2158	for (grep defined $_->[0], @neigh) {
		2159	my ($path, $origin) = @$_;
		2160	my $neigh = find $path, $origin
		2161	or next;
		2162	$neigh->load;
		2163	}
		2164	}
		2165
		2166	sub find_sync {
1290	my ($path, $origin) = @_;	2167	my ($path, $origin) = @_;
1291		2168
1292	#warn "load_map_sync<$path, $origin>\n";#d#	2169	cf::sync_job { find $path, $origin }
		2170	}
1293		2171
1294	cf::sync_job {	2172	sub do_load_sync {
1295	my $map = cf::map::find_map $path, $origin	2173	my ($map) = @_;
1296	or return;	2174
1297	$map->load;	2175	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1298	$map	2176	if $Coro::current == $Coro::main;
		2177
		2178	cf::sync_job { $map->load };
		2179	}
		2180
		2181	our %MAP_PREFETCH;
		2182	our $MAP_PREFETCHER = undef;
		2183
		2184	sub find_async {
		2185	my ($path, $origin, $load) = @_;
		2186
		2187	$path = normalise $path, $origin && $origin->{path};
		2188
		2189	if (my $map = $cf::MAP{$path}) {
		2190	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2191	}
		2192
		2193	$MAP_PREFETCH{$path} |= $load;
		2194
		2195	$MAP_PREFETCHER ||= cf::async {
		2196	$Coro::current->{desc} = "map prefetcher";
		2197
		2198	while (%MAP_PREFETCH) {
		2199	while (my ($k, $v) = each %MAP_PREFETCH) {
		2200	if (my $map = find $k) {
		2201	$map->load if $v;
		2202	}
		2203
		2204	delete $MAP_PREFETCH{$k};
		2205	}
		2206	}
		2207	undef $MAP_PREFETCHER;
1299	}	2208	};
		2209	$MAP_PREFETCHER->prio (6);
		2210
		2211	()
1300	}	2212	}
1301		2213
1302	sub save {	2214	sub save {
1303	my ($self) = @_;	2215	my ($self) = @_;
1304		2216
		2217	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2218
1305	$self->{last_save} = $cf::RUNTIME;	2219	$self->{last_save} = $cf::RUNTIME;
1306		2220
1307	return unless $self->dirty;	2221	return unless $self->dirty;
1308		2222
1309	my $save = $self->{path}->save_path; utf8::encode $save;	2223	my $save = $self->save_path; utf8::encode $save;
1310	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2224	my $uniq = $self->uniq_path; utf8::encode $uniq;
1311		2225
1312	$self->{load_path} = $save;	2226	$self->{load_path} = $save;
1313		2227
1314	return if $self->{deny_save};	2228	return if $self->{deny_save};
1315		2229
		2230	local $self->{last_access} = $self->last_access;#d#
		2231
		2232	cf::async {
		2233	$Coro::current->{desc} = "map player save";
		2234	$_->contr->save for $self->players;
		2235	};
		2236
		2237	cf::get_slot 0.02;
		2238
1316	if ($uniq) {	2239	if ($uniq) {
1317	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2240	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318	$self->save_objects ($uniq, cf::IO_UNIQUES);	2241	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1319	} else {	2242	} else {
1320	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2243	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1321	}	2244	}
1322	}	2245	}
1323		2246
1324	sub swap_out {	2247	sub swap_out {
1325	my ($self) = @_;	2248	my ($self) = @_;
1326		2249
1327	# save first because save cedes	2250	# save first because save cedes
1328	$self->save;	2251	$self->save;
1329		2252
		2253	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2254
1330	return if $self->players;	2255	return if $self->players;
1331	return if $self->in_memory != cf::MAP_IN_MEMORY;	2256	return if $self->in_memory != cf::MAP_ACTIVE;
1332	return if $self->{deny_save};	2257	return if $self->{deny_save};
1333		2258
		2259	$self->in_memory (cf::MAP_SWAPPED);
		2260
		2261	$self->deactivate;
		2262	$_->clear_links_to ($self) for values %cf::MAP;
1334	$self->clear;	2263	$self->clear;
1335	$self->in_memory (cf::MAP_SWAPPED);
1336	}	2264	}
1337		2265
1338	sub reset_at {	2266	sub reset_at {
1339	my ($self) = @_;	2267	my ($self) = @_;
1340		2268
1341	# TODO: safety, remove and allow resettable per-player maps	2269	# TODO: safety, remove and allow resettable per-player maps
1342	return 1e99 if $self->{path}{user_rel};
1343	return 1e99 if $self->{deny_reset};	2270	return 1e99 if $self->{deny_reset};
1344		2271
1345	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2272	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1346	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2273	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1347		2274
…		…
1352	my ($self) = @_;	2279	my ($self) = @_;
1353		2280
1354	$self->reset_at <= $cf::RUNTIME	2281	$self->reset_at <= $cf::RUNTIME
1355	}	2282	}
1356		2283
1357	sub unlink_save {
1358	my ($self) = @_;
1359
1360	utf8::encode (my $save = $self->{path}->save_path);
1361	aioreq_pri 3; IO::AIO::aio_unlink $save;
1362	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1363	}
1364
1365	sub rename {
1366	my ($self, $new_path) = @_;
1367
1368	$self->unlink_save;
1369
1370	delete $cf::MAP{$self->path};
1371	$self->{path} = new cf::path $new_path;
1372	$self->path ($self->{path}->as_string);
1373	$cf::MAP{$self->path} = $self;
1374
1375	$self->save;
1376	}
1377
1378	sub reset {	2284	sub reset {
1379	my ($self) = @_;	2285	my ($self) = @_;
1380		2286
		2287	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2288
1381	return if $self->players;	2289	return if $self->players;
1382	return if $self->{path}{user_rel};#d#
1383		2290
1384	warn "resetting map ", $self->path;#d#	2291	warn "resetting map ", $self->path;
		2292
		2293	$self->in_memory (cf::MAP_SWAPPED);
		2294
		2295	# need to save uniques path
		2296	unless ($self->{deny_save}) {
		2297	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2298
		2299	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2300	if $uniq;
		2301	}
1385		2302
1386	delete $cf::MAP{$self->path};	2303	delete $cf::MAP{$self->path};
1387		2304
		2305	$self->deactivate;
1388	$_->clear_links_to ($self) for values %cf::MAP;	2306	$_->clear_links_to ($self) for values %cf::MAP;
		2307	$self->clear;
1389		2308
1390	$self->unlink_save;	2309	$self->unlink_save;
1391	$self->destroy;	2310	$self->destroy;
1392	}	2311	}
1393		2312
1394	my $nuke_counter = "aaaa";	2313	my $nuke_counter = "aaaa";
1395		2314
1396	sub nuke {	2315	sub nuke {
1397	my ($self) = @_;	2316	my ($self) = @_;
1398		2317
		2318	{
		2319	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2320
		2321	delete $cf::MAP{$self->path};
		2322
		2323	$self->unlink_save;
		2324
		2325	bless $self, "cf::map";
		2326	delete $self->{deny_reset};
1399	$self->{deny_save} = 1;	2327	$self->{deny_save} = 1;
1400	$self->reset_timeout (1);	2328	$self->reset_timeout (1);
1401	$self->rename ("{nuke}/" . ($nuke_counter++));	2329	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2330
		2331	$cf::MAP{$self->path} = $self;
		2332	}
		2333
1402	$self->reset; # polite request, might not happen	2334	$self->reset; # polite request, might not happen
1403	}	2335	}
1404		2336
1405	sub customise_for {	2337	=item $maps = cf::map::tmp_maps
1406	my ($map, $ob) = @_;
1407		2338
1408	if ($map->per_player) {	2339	Returns an arrayref with all map paths of currently instantiated and saved
1409	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2340	maps. May block.
		2341
		2342	=cut
		2343
		2344	sub tmp_maps() {
1410	}	2345	[
1411		2346	map {
1412	$map	2347	utf8::decode $_;
		2348	/\.map$/
		2349	? normalise $_
		2350	: ()
		2351	} @{ aio_readdir $TMPDIR or [] }
		2352	]
1413	}	2353	}
1414		2354
1415	sub emergency_save {	2355	=item $maps = cf::map::random_maps
1416	local $cf::FREEZE = 1;
1417		2356
1418	warn "enter emergency map save\n";	2357	Returns an arrayref with all map paths of currently instantiated and saved
		2358	random maps. May block.
1419		2359
1420	cf::sync_job {	2360	=cut
1421	warn "begin emergency map save\n";	2361
1422	$_->save for values %cf::MAP;	2362	sub random_maps() {
		2363	[
		2364	map {
		2365	utf8::decode $_;
		2366	/\.map$/
		2367	? normalise "?random/$_"
		2368	: ()
		2369	} @{ aio_readdir $RANDOMDIR or [] }
		2370	]
		2371	}
		2372
		2373	=item cf::map::unique_maps
		2374
		2375	Returns an arrayref of paths of all shared maps that have
		2376	instantiated unique items. May block.
		2377
		2378	=cut
		2379
		2380	sub unique_maps() {
		2381	[
		2382	map {
		2383	utf8::decode $_;
		2384	s/\.map$//; # TODO future compatibility hack
		2385	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2386	? ()
		2387	: normalise $_
		2388	} @{ aio_readdir $UNIQUEDIR or [] }
		2389	]
		2390	}
		2391
		2392	=back
		2393
		2394	=head3 cf::object
		2395
		2396	=cut
		2397
		2398	package cf::object;
		2399
		2400	=over 4
		2401
		2402	=item $ob->inv_recursive
		2403
		2404	Returns the inventory of the object I<and> their inventories, recursively,
		2405	but I<not> the object itself.
		2406
		2407	=cut
		2408
		2409	sub inv_recursive_;
		2410	sub inv_recursive_ {
		2411	map { $_, inv_recursive_ $_->inv } @_
		2412	}
		2413
		2414	sub inv_recursive {
		2415	inv_recursive_ inv $_[0]
		2416	}
		2417
		2418	=item $ref = $ob->ref
		2419
		2420	Creates and returns a persistent reference to an object that can be stored as a string.
		2421
		2422	=item $ob = cf::object::deref ($refstring)
		2423
		2424	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2425	even if the object actually exists. May block.
		2426
		2427	=cut
		2428
		2429	sub deref {
		2430	my ($ref) = @_;
		2431
		2432	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2433	my ($uuid, $name) = ($1, $2);
		2434	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2435	or return;
		2436	$pl->ob->uuid eq $uuid
		2437	or return;
		2438
		2439	$pl->ob
		2440	} else {
		2441	warn "$ref: cannot resolve object reference\n";
		2442	undef
1423	};	2443	}
1424
1425	warn "end emergency map save\n";
1426	}	2444	}
1427		2445
1428	package cf;	2446	package cf;
1429		2447
1430	=back	2448	=back
1431
1432		2449
1433	=head3 cf::object::player	2450	=head3 cf::object::player
1434		2451
1435	=over 4	2452	=over 4
1436		2453
…		…
1450		2467
1451	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1452		2469
1453	if ($self->{record_replies}) {	2470	if ($self->{record_replies}) {
1454	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2471	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2472
1455	} else {	2473	} else {
		2474	my $pl = $self->contr;
		2475
		2476	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2477	my $dialog = $pl->{npc_dialog};
		2478	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2479
		2480	} else {
1456	$msg = $npc->name . " says: $msg" if $npc;	2481	$msg = $npc->name . " says: $msg" if $npc;
1457	$self->message ($msg, $flags);	2482	$self->message ($msg, $flags);
		2483	}
1458	}	2484	}
		2485	}
		2486
		2487	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2488
		2489	=cut
		2490
		2491	sub cf::object::send_msg {
		2492	my $pl = shift->contr
		2493	or return;
		2494	$pl->send_msg (@_);
1459	}	2495	}
1460		2496
1461	=item $player_object->may ("access")	2497	=item $player_object->may ("access")
1462		2498
1463	Returns wether the given player is authorized to access resource "access"	2499	Returns wether the given player is authorized to access resource "access"
…		…
1476		2512
1477	=item $player_object->enter_link	2513	=item $player_object->enter_link
1478		2514
1479	Freezes the player and moves him/her to a special map (C<{link}>).	2515	Freezes the player and moves him/her to a special map (C<{link}>).
1480		2516
1481	The player should be reaosnably safe there for short amounts of time. You	2517	The player should be reasonably safe there for short amounts of time. You
1482	I<MUST> call C<leave_link> as soon as possible, though.	2518	I<MUST> call C<leave_link> as soon as possible, though.
1483		2519
		2520	Will never block.
		2521
1484	=item $player_object->leave_link ($map, $x, $y)	2522	=item $player_object->leave_link ($map, $x, $y)
1485		2523
1486	Moves the player out of the specila link map onto the given map. If the	2524	Moves the player out of the special C<{link}> map onto the specified
1487	map is not valid (or omitted), the player will be moved back to the	2525	map. If the map is not valid (or omitted), the player will be moved back
1488	location he/she was before the call to C<enter_link>, or, if that fails,	2526	to the location he/she was before the call to C<enter_link>, or, if that
1489	to the emergency map position.	2527	fails, to the emergency map position.
1490		2528
1491	Might block.	2529	Might block.
1492		2530
1493	=cut	2531	=cut
		2532
		2533	sub link_map {
		2534	unless ($LINK_MAP) {
		2535	$LINK_MAP = cf::map::find "{link}"
		2536	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2537	$LINK_MAP->load;
		2538	}
		2539
		2540	$LINK_MAP
		2541	}
1494		2542
1495	sub cf::object::player::enter_link {	2543	sub cf::object::player::enter_link {
1496	my ($self) = @_;	2544	my ($self) = @_;
1497		2545
1498	$self->deactivate_recursive;	2546	$self->deactivate_recursive;
1499		2547
1500	return if $self->map == $LINK_MAP;	2548	return if UNIVERSAL::isa $self->map, "ext::map_link";
1501		2549
1502	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2550	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1503	if $self->map;	2551	if $self->map && $self->map->{path} ne "{link}";
1504		2552
1505	$self->enter_map ($LINK_MAP, 20, 20);	2553	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1506	}	2554	}
1507		2555
1508	sub cf::object::player::leave_link {	2556	sub cf::object::player::leave_link {
1509	my ($self, $map, $x, $y) = @_;	2557	my ($self, $map, $x, $y) = @_;
		2558
		2559	return unless $self->contr->active;
1510		2560
1511	my $link_pos = delete $self->{_link_pos};	2561	my $link_pos = delete $self->{_link_pos};
1512		2562
1513	unless ($map) {	2563	unless ($map) {
1514	# restore original map position	2564	# restore original map position
1515	($map, $x, $y) = @{ $link_pos || [] };	2565	($map, $x, $y) = @{ $link_pos || [] };
1516	$map = cf::map::find_map $map;	2566	$map = cf::map::find $map;
1517		2567
1518	unless ($map) {	2568	unless ($map) {
1519	($map, $x, $y) = @$EMERGENCY_POSITION;	2569	($map, $x, $y) = @$EMERGENCY_POSITION;
1520	$map = cf::map::find_map $map	2570	$map = cf::map::find $map
1521	or die "FATAL: cannot load emergency map\n";	2571	or die "FATAL: cannot load emergency map\n";
1522	}	2572	}
1523	}	2573	}
1524		2574
1525	($x, $y) = (-1, -1)	2575	($x, $y) = (-1, -1)
…		…
1528	# use -1 or undef as default coordinates, not 0, 0	2578	# use -1 or undef as default coordinates, not 0, 0
1529	($x, $y) = ($map->enter_x, $map->enter_y)	2579	($x, $y) = ($map->enter_x, $map->enter_y)
1530	if $x <=0 && $y <= 0;	2580	if $x <=0 && $y <= 0;
1531		2581
1532	$map->load;	2582	$map->load;
		2583	$map->load_neighbours;
1533		2584
		2585	return unless $self->contr->active;
1534	$self->activate_recursive;	2586	$self->activate_recursive;
		2587
		2588	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1535	$self->enter_map ($map, $x, $y);	2589	$self->enter_map ($map, $x, $y);
1536	}	2590	}
1537		2591
1538	cf::player->attach (	2592	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1539	on_logout => sub {
1540	my ($pl) = @_;
1541		2593
1542	# abort map switching before logout	2594	Moves the player to the given map-path and coordinates by first freezing
1543	if ($pl->ob->{_link_pos}) {	2595	her, loading and preparing them map, calling the provided $check callback
1544	cf::sync_job {	2596	that has to return the map if sucecssful, and then unfreezes the player on
1545	$pl->ob->leave_link	2597	the new (success) or old (failed) map position. In either case, $done will
1546	};	2598	be called at the end of this process.
1547	}
1548	},
1549	on_login => sub {
1550	my ($pl) = @_;
1551		2599
1552	# try to abort aborted map switching on player login :)
1553	# should happen only on crashes
1554	if ($pl->ob->{_link_pos}) {
1555	$pl->ob->enter_link;
1556	cf::async {
1557	# we need this sleep as the login has a concurrent enter_exit running
1558	# and this sleep increases chances of the player not ending up in scorn
1559	Coro::Timer::sleep 1;
1560	$pl->ob->leave_link;
1561	};
1562	}
1563	},
1564	);
1565
1566	=item $player_object->goto_map ($path, $x, $y)
1567
1568	=cut	2600	=cut
1569		2601
		2602	our $GOTOGEN;
		2603
1570	sub cf::object::player::goto_map {	2604	sub cf::object::player::goto {
1571	my ($self, $path, $x, $y) = @_;	2605	my ($self, $path, $x, $y, $check, $done) = @_;
		2606
		2607	# do generation counting so two concurrent goto's will be executed in-order
		2608	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1572		2609
1573	$self->enter_link;	2610	$self->enter_link;
1574		2611
1575	(cf::async {	2612	(async {
1576	$path = new cf::path $path;	2613	$Coro::current->{desc} = "player::goto $path $x $y";
1577		2614
1578	my $map = cf::map::find_map $path->as_string;	2615	# *tag paths override both path and x|y
		2616	if ($path =~ /^\*(.*)$/) {
		2617	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2618	my $ob = $obs[rand @obs];
		2619
		2620	# see if we actually can go there
		2621	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2622	$ob = $obs[rand @obs];
		2623	} else {
		2624	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2625	}
		2626	# else put us there anyways for now #d#
		2627
		2628	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2629	} else {
		2630	($path, $x, $y) = (undef, undef, undef);
		2631	}
		2632	}
		2633
		2634	my $map = eval {
		2635	my $map = defined $path ? cf::map::find $path : undef;
		2636
		2637	if ($map) {
1579	$map = $map->customise_for ($self) if $map;	2638	$map = $map->customise_for ($self);
1580		2639	$map = $check->($map) if $check && $map;
1581	# warn "entering ", $map->path, " at ($x, $y)\n"	2640	} else {
1582	# if $map;
1583
1584	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2641	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2642	}
1585		2643
		2644	$map
		2645	};
		2646
		2647	if ($@) {
		2648	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2649	LOG llevError | logBacktrace, Carp::longmess $@;
		2650	}
		2651
		2652	if ($gen == $self->{_goto_generation}) {
		2653	delete $self->{_goto_generation};
1586	$self->leave_link ($map, $x, $y);	2654	$self->leave_link ($map, $x, $y);
		2655	}
		2656
		2657	$done->() if $done;
1587	})->prio (1);	2658	})->prio (1);
1588	}	2659	}
1589		2660
1590	=item $player_object->enter_exit ($exit_object)	2661	=item $player_object->enter_exit ($exit_object)
1591		2662
…		…
1593		2664
1594	sub parse_random_map_params {	2665	sub parse_random_map_params {
1595	my ($spec) = @_;	2666	my ($spec) = @_;
1596		2667
1597	my $rmp = { # defaults	2668	my $rmp = { # defaults
1598	xsize => 10,	2669	xsize => (cf::rndm 15, 40),
1599	ysize => 10,	2670	ysize => (cf::rndm 15, 40),
		2671	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2672	#layout => string,
1600	};	2673	};
1601		2674
1602	for (split /\n/, $spec) {	2675	for (split /\n/, $spec) {
1603	my ($k, $v) = split /\s+/, $_, 2;	2676	my ($k, $v) = split /\s+/, $_, 2;
1604		2677
…		…
1608	$rmp	2681	$rmp
1609	}	2682	}
1610		2683
1611	sub prepare_random_map {	2684	sub prepare_random_map {
1612	my ($exit) = @_;	2685	my ($exit) = @_;
		2686
		2687	my $guard = cf::lock_acquire "exit_prepare:$exit";
1613		2688
1614	# all this does is basically replace the /! path by	2689	# all this does is basically replace the /! path by
1615	# a new random map path (?random/...) with a seed	2690	# a new random map path (?random/...) with a seed
1616	# that depends on the exit object	2691	# that depends on the exit object
1617		2692
1618	my $rmp = parse_random_map_params $exit->msg;	2693	my $rmp = parse_random_map_params $exit->msg;
1619		2694
1620	if ($exit->map) {	2695	if ($exit->map) {
1621	$rmp->{region} = $exit->map->region_name;	2696	$rmp->{region} = $exit->region->name;
1622	$rmp->{origin_map} = $exit->map->path;	2697	$rmp->{origin_map} = $exit->map->path;
1623	$rmp->{origin_x} = $exit->x;	2698	$rmp->{origin_x} = $exit->x;
1624	$rmp->{origin_y} = $exit->y;	2699	$rmp->{origin_y} = $exit->y;
1625	}	2700	}
1626		2701
1627	$rmp->{random_seed} ||= $exit->random_seed;	2702	$rmp->{random_seed} ||= $exit->random_seed;
1628		2703
1629	my $data = cf::to_json $rmp;	2704	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1630	my $md5 = Digest::MD5::md5_hex $data;	2705	my $md5 = Digest::MD5::md5_hex $data;
		2706	my $meta = "$RANDOMDIR/$md5.meta";
1631		2707
1632	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2708	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1633	aio_write $fh, 0, (length $data), $data, 0;	2709	aio_write $fh, 0, (length $data), $data, 0;
		2710	undef $fh;
		2711	aio_rename "$meta~", $meta;
1634		2712
1635	$exit->slaying ("?random/$md5");	2713	$exit->slaying ("?random/$md5");
1636	$exit->msg (undef);	2714	$exit->msg (undef);
1637	}	2715	}
1638	}	2716	}
…		…
1640	sub cf::object::player::enter_exit {	2718	sub cf::object::player::enter_exit {
1641	my ($self, $exit) = @_;	2719	my ($self, $exit) = @_;
1642		2720
1643	return unless $self->type == cf::PLAYER;	2721	return unless $self->type == cf::PLAYER;
1644		2722
		2723	if ($exit->slaying eq "/!") {
		2724	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2725	# the problem is that $exit might not survive long enough
		2726	# so it needs to be done right now, right here
		2727	cf::sync_job { prepare_random_map $exit };
		2728	}
		2729
		2730	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2731	my $hp = $exit->stats->hp;
		2732	my $sp = $exit->stats->sp;
		2733
1645	$self->enter_link;	2734	$self->enter_link;
1646		2735
		2736	# if exit is damned, update players death & WoR home-position
		2737	$self->contr->savebed ($slaying, $hp, $sp)
		2738	if $exit->flag (FLAG_DAMNED);
		2739
1647	(cf::async {	2740	(async {
		2741	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2742
		2743	$self->deactivate_recursive; # just to be sure
1648	unless (eval {	2744	unless (eval {
1649	prepare_random_map $exit	2745	$self->goto ($slaying, $hp, $sp);
1650	if $exit->slaying eq "/!";
1651
1652	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1653	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1654		2746
1655	1;	2747	1;
1656	}) {	2748	}) {
1657	$self->message ("Something went wrong deep within the crossfire server. "	2749	$self->message ("Something went wrong deep within the crossfire server. "
1658	. "I'll try to bring you back to the map you were before. "	2750	. "I'll try to bring you back to the map you were before. "
1659	. "Please report this to the dungeon master",	2751	. "Please report this to the dungeon master!",
1660	cf::NDI_UNIQUE | cf::NDI_RED);	2752	cf::NDI_UNIQUE | cf::NDI_RED);
1661		2753
1662	warn "ERROR in enter_exit: $@";	2754	warn "ERROR in enter_exit: $@";
1663	$self->leave_link;	2755	$self->leave_link;
1664	}	2756	}
1665	})->prio (1);	2757	})->prio (1);
…		…
1678		2770
1679	sub cf::client::send_drawinfo {	2771	sub cf::client::send_drawinfo {
1680	my ($self, $text, $flags) = @_;	2772	my ($self, $text, $flags) = @_;
1681		2773
1682	utf8::encode $text;	2774	utf8::encode $text;
1683	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2775	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1684	}	2776	}
1685		2777
		2778	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2779
		2780	Send a drawinfo or msg packet to the client, formatting the msg for the
		2781	client if neccessary. C<$type> should be a string identifying the type of
		2782	the message, with C<log> being the default. If C<$color> is negative, suppress
		2783	the message unless the client supports the msg packet.
		2784
		2785	=cut
		2786
		2787	# non-persistent channels (usually the info channel)
		2788	our %CHANNEL = (
		2789	"c/identify" => {
		2790	id => "infobox",
		2791	title => "Identify",
		2792	reply => undef,
		2793	tooltip => "Items recently identified",
		2794	},
		2795	"c/examine" => {
		2796	id => "infobox",
		2797	title => "Examine",
		2798	reply => undef,
		2799	tooltip => "Signs and other items you examined",
		2800	},
		2801	"c/book" => {
		2802	id => "infobox",
		2803	title => "Book",
		2804	reply => undef,
		2805	tooltip => "The contents of a note or book",
		2806	},
		2807	"c/lookat" => {
		2808	id => "infobox",
		2809	title => "Look",
		2810	reply => undef,
		2811	tooltip => "What you saw there",
		2812	},
		2813	"c/who" => {
		2814	id => "infobox",
		2815	title => "Players",
		2816	reply => undef,
		2817	tooltip => "Shows players who are currently online",
		2818	},
		2819	"c/body" => {
		2820	id => "infobox",
		2821	title => "Body Parts",
		2822	reply => undef,
		2823	tooltip => "Shows which body parts you posess and are available",
		2824	},
		2825	"c/uptime" => {
		2826	id => "infobox",
		2827	title => "Uptime",
		2828	reply => undef,
		2829	tooltip => "How long the server has been running since last restart",
		2830	},
		2831	"c/mapinfo" => {
		2832	id => "infobox",
		2833	title => "Map Info",
		2834	reply => undef,
		2835	tooltip => "Information related to the maps",
		2836	},
		2837	"c/party" => {
		2838	id => "party",
		2839	title => "Party",
		2840	reply => "gsay ",
		2841	tooltip => "Messages and chat related to your party",
		2842	},
		2843	);
		2844
		2845	sub cf::client::send_msg {
		2846	my ($self, $channel, $msg, $color, @extra) = @_;
		2847
		2848	$msg = $self->pl->expand_cfpod ($msg);
		2849
		2850	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2851
		2852	# check predefined channels, for the benefit of C
		2853	if ($CHANNEL{$channel}) {
		2854	$channel = $CHANNEL{$channel};
		2855
		2856	$self->ext_msg (channel_info => $channel)
		2857	if $self->can_msg;
		2858
		2859	$channel = $channel->{id};
		2860
		2861	} elsif (ref $channel) {
		2862	# send meta info to client, if not yet sent
		2863	unless (exists $self->{channel}{$channel->{id}}) {
		2864	$self->{channel}{$channel->{id}} = $channel;
		2865	$self->ext_msg (channel_info => $channel)
		2866	if $self->can_msg;
		2867	}
		2868
		2869	$channel = $channel->{id};
		2870	}
		2871
		2872	return unless @extra || length $msg;
		2873
		2874	if ($self->can_msg) {
		2875	# default colour, mask it out
		2876	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2877	if $color & cf::NDI_DEF;
		2878
		2879	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2880	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2881	} else {
		2882	if ($color >= 0) {
		2883	# replace some tags by gcfclient-compatible ones
		2884	for ($msg) {
		2885	1 while
		2886	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2887	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2888	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2889	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2890	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2891	}
		2892
		2893	$color &= cf::NDI_COLOR_MASK;
		2894
		2895	utf8::encode $msg;
		2896
		2897	if (0 && $msg =~ /\[/) {
		2898	# COMMAND/INFO
		2899	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2900	} else {
		2901	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2902	$self->send_packet ("drawinfo $color $msg")
		2903	}
		2904	}
		2905	}
		2906	}
		2907
		2908	=item $client->ext_msg ($type, @msg)
		2909
		2910	Sends an ext event to the client.
		2911
		2912	=cut
		2913
		2914	sub cf::client::ext_msg($$@) {
		2915	my ($self, $type, @msg) = @_;
		2916
		2917	if ($self->extcmd == 2) {
		2918	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2919	} elsif ($self->extcmd == 1) { # TODO: remove
		2920	push @msg, msgtype => "event_$type";
		2921	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2922	}
		2923	}
		2924
		2925	=item $client->ext_reply ($msgid, @msg)
		2926
		2927	Sends an ext reply to the client.
		2928
		2929	=cut
		2930
		2931	sub cf::client::ext_reply($$@) {
		2932	my ($self, $id, @msg) = @_;
		2933
		2934	if ($self->extcmd == 2) {
		2935	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2936	} elsif ($self->extcmd == 1) {
		2937	#TODO: version 1, remove
		2938	unshift @msg, msgtype => "reply", msgid => $id;
		2939	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2940	}
		2941	}
1686		2942
1687	=item $success = $client->query ($flags, "text", \&cb)	2943	=item $success = $client->query ($flags, "text", \&cb)
1688		2944
1689	Queues a query to the client, calling the given callback with	2945	Queues a query to the client, calling the given callback with
1690	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2946	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1691	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2947	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1692		2948
1693	Queries can fail, so check the return code. Or don't, as queries will become	2949	Queries can fail, so check the return code. Or don't, as queries will
1694	reliable at some point in the future.	2950	become reliable at some point in the future.
1695		2951
1696	=cut	2952	=cut
1697		2953
1698	sub cf::client::query {	2954	sub cf::client::query {
1699	my ($self, $flags, $text, $cb) = @_;	2955	my ($self, $flags, $text, $cb) = @_;
…		…
1707	utf8::encode $text;	2963	utf8::encode $text;
1708	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2964	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1709		2965
1710	$self->send_packet ($self->{query_queue}[0][0])	2966	$self->send_packet ($self->{query_queue}[0][0])
1711	if @{ $self->{query_queue} } == 1;	2967	if @{ $self->{query_queue} } == 1;
		2968
		2969	1
1712	}	2970	}
1713		2971
1714	cf::client->attach (	2972	cf::client->attach (
		2973	on_connect => sub {
		2974	my ($ns) = @_;
		2975
		2976	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2977	},
1715	on_reply => sub {	2978	on_reply => sub {
1716	my ($ns, $msg) = @_;	2979	my ($ns, $msg) = @_;
1717		2980
1718	# this weird shuffling is so that direct followup queries	2981	# this weird shuffling is so that direct followup queries
1719	# get handled first	2982	# get handled first
1720	my $queue = delete $ns->{query_queue}	2983	my $queue = delete $ns->{query_queue}
1721	or return; # be conservative, not sure how that can happen, but we saw a crash here	2984	or return; # be conservative, not sure how that can happen, but we saw a crash here
1722		2985
1723	(shift @$queue)->[1]->($msg);	2986	(shift @$queue)->[1]->($msg);
		2987	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1724		2988
1725	push @{ $ns->{query_queue} }, @$queue;	2989	push @{ $ns->{query_queue} }, @$queue;
1726		2990
1727	if (@{ $ns->{query_queue} } == @$queue) {	2991	if (@{ $ns->{query_queue} } == @$queue) {
1728	if (@$queue) {	2992	if (@$queue) {
…		…
1730	} else {	2994	} else {
1731	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2995	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1732	}	2996	}
1733	}	2997	}
1734	},	2998	},
		2999	on_exticmd => sub {
		3000	my ($ns, $buf) = @_;
		3001
		3002	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3003
		3004	if (ref $msg) {
		3005	my ($type, $reply, @payload) =
		3006	"ARRAY" eq ref $msg
		3007	? @$msg
		3008	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3009
		3010	my @reply;
		3011
		3012	if (my $cb = $EXTICMD{$type}) {
		3013	@reply = $cb->($ns, @payload);
		3014	}
		3015
		3016	$ns->ext_reply ($reply, @reply)
		3017	if $reply;
		3018
		3019	} else {
		3020	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3021	}
		3022
		3023	cf::override;
		3024	},
1735	);	3025	);
1736		3026
1737	=item $client->coro (\&cb)	3027	=item $client->async (\&cb)
1738		3028
1739	Create a new coroutine, running the specified callback. The coroutine will	3029	Create a new coroutine, running the specified callback. The coroutine will
1740	be automatically cancelled when the client gets destroyed (e.g. on logout,	3030	be automatically cancelled when the client gets destroyed (e.g. on logout,
1741	or loss of connection).	3031	or loss of connection).
1742		3032
1743	=cut	3033	=cut
1744		3034
1745	sub cf::client::coro {	3035	sub cf::client::async {
1746	my ($self, $cb) = @_;	3036	my ($self, $cb) = @_;
1747		3037
1748	my $coro = &cf::async ($cb);	3038	my $coro = &Coro::async ($cb);
1749		3039
1750	$coro->on_destroy (sub {	3040	$coro->on_destroy (sub {
1751	delete $self->{_coro}{$coro+0};	3041	delete $self->{_coro}{$coro+0};
1752	});	3042	});
1753		3043
…		…
1780	our $safe = new Safe "safe";	3070	our $safe = new Safe "safe";
1781	our $safe_hole = new Safe::Hole;	3071	our $safe_hole = new Safe::Hole;
1782		3072
1783	$SIG{FPE} = 'IGNORE';	3073	$SIG{FPE} = 'IGNORE';
1784		3074
1785	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3075	$safe->permit_only (Opcode::opset qw(
		3076	:base_core :base_mem :base_orig :base_math
		3077	grepstart grepwhile mapstart mapwhile
		3078	sort time
		3079	));
1786		3080
1787	# here we export the classes and methods available to script code	3081	# here we export the classes and methods available to script code
1788		3082
1789	=pod	3083	=pod
1790		3084
1791	The following fucntions and emthods are available within a safe environment:	3085	The following functions and methods are available within a safe environment:
1792		3086
1793	cf::object contr pay_amount pay_player map	3087	cf::object
		3088	contr pay_amount pay_player map x y force_find force_add destroy
		3089	insert remove name archname title slaying race decrease split
		3090
1794	cf::object::player player	3091	cf::object::player
1795	cf::player peaceful	3092	player
1796	cf::map trigger	3093
		3094	cf::player
		3095	peaceful
		3096
		3097	cf::map
		3098	trigger
1797		3099
1798	=cut	3100	=cut
1799		3101
1800	for (	3102	for (
1801	["cf::object" => qw(contr pay_amount pay_player map)],	3103	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3104	insert remove inv name archname title slaying race
		3105	decrease split destroy)],
1802	["cf::object::player" => qw(player)],	3106	["cf::object::player" => qw(player)],
1803	["cf::player" => qw(peaceful)],	3107	["cf::player" => qw(peaceful)],
1804	["cf::map" => qw(trigger)],	3108	["cf::map" => qw(trigger)],
1805	) {	3109	) {
1806	no strict 'refs';	3110	no strict 'refs';
…		…
1877	=back	3181	=back
1878		3182
1879	=cut	3183	=cut
1880		3184
1881	#############################################################################	3185	#############################################################################
		3186	# the server's init and main functions
1882		3187
1883	=head2 EXTENSION DATABASE SUPPORT	3188	sub load_facedata($) {
		3189	my ($path) = @_;
1884		3190
1885	Crossfire maintains a very simple database for extension use. It can	3191	# HACK to clear player env face cache, we need some signal framework
1886	currently store anything that can be serialised using Storable, which	3192	# for this (global event?)
1887	excludes objects.	3193	%ext::player_env::MUSIC_FACE_CACHE = ();
1888		3194
1889	The parameter C<$family> should best start with the name of the extension	3195	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1890	using it, it should be unique.
1891		3196
1892	=over 4	3197	warn "loading facedata from $path\n";
1893		3198
1894	=item $hashref = cf::db_get $family	3199	my $facedata;
		3200	0 < aio_load $path, $facedata
		3201	or die "$path: $!";
1895		3202
1896	Return a hashref for use by the extension C<$family>, which can be	3203	$facedata = Coro::Storable::thaw $facedata;
1897	modified. After modifications, you have to call C<cf::db_dirty> or
1898	C<cf::db_sync>.
1899		3204
1900	=item $value = cf::db_get $family => $key	3205	$facedata->{version} == 2
		3206	or cf::cleanup "$path: version mismatch, cannot proceed.";
1901		3207
1902	Returns a single value from the database	3208	# patch in the exptable
1903		3209	$facedata->{resource}{"res/exp_table"} = {
1904	=item cf::db_put $family => $hashref	3210	type => FT_RSRC,
1905		3211	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1906	Stores the given family hashref into the database. Updates are delayed, if
1907	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1908
1909	=item cf::db_put $family => $key => $value
1910
1911	Stores the given C<$value> in the family hash. Updates are delayed, if you
1912	want the data to be synced to disk immediately, use C<cf::db_sync>.
1913
1914	=item cf::db_dirty
1915
1916	Marks the database as dirty, to be updated at a later time.
1917
1918	=item cf::db_sync
1919
1920	Immediately write the database to disk I<if it is dirty>.
1921
1922	=cut
1923
1924	our $DB;
1925
1926	{
1927	my $path = cf::localdir . "/database.pst";
1928
1929	sub db_load() {
1930	$DB = stat $path ? Storable::retrieve $path : { };
1931	}
1932
1933	my $pid;
1934
1935	sub db_save() {
1936	waitpid $pid, 0 if $pid;
1937	if (0 == ($pid = fork)) {
1938	$DB->{_meta}{version} = 1;
1939	Storable::nstore $DB, "$path~";
1940	rename "$path~", $path;
1941	cf::_exit 0 if defined $pid;
1942	}
1943	}
1944
1945	my $dirty;
1946
1947	sub db_sync() {
1948	db_save if $dirty;
1949	undef $dirty;
1950	}
1951
1952	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1953	db_sync;
1954	});	3212	};
		3213	cf::cede_to_tick;
1955		3214
1956	sub db_dirty() {
1957	$dirty = 1;
1958	$idle->start;
1959	}	3215	{
		3216	my $faces = $facedata->{faceinfo};
1960		3217
1961	sub db_get($;$) {	3218	while (my ($face, $info) = each %$faces) {
1962	@_ >= 2	3219	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1963	? $DB->{$_[0]}{$_[1]}
1964	: ($DB->{$_[0]} ||= { })
1965	}
1966		3220
1967	sub db_put($$;$) {	3221	cf::face::set_visibility $idx, $info->{visibility};
1968	if (@_ >= 3) {	3222	cf::face::set_magicmap $idx, $info->{magicmap};
1969	$DB->{$_[0]}{$_[1]} = $_[2];	3223	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1970	} else {	3224	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1971	$DB->{$_[0]} = $_[1];
1972	}
1973	db_dirty;
1974	}
1975		3225
1976	cf::global->attach (	3226	cf::cede_to_tick;
1977	prio => 10000,
1978	on_cleanup => sub {
1979	db_sync;
1980	},	3227	}
1981	);
1982	}
1983		3228
1984	#############################################################################	3229	while (my ($face, $info) = each %$faces) {
1985	# the server's main()	3230	next unless $info->{smooth};
1986		3231
1987	sub cfg_load {	3232	my $idx = cf::face::find $face
		3233	or next;
		3234
		3235	if (my $smooth = cf::face::find $info->{smooth}) {
		3236	cf::face::set_smooth $idx, $smooth;
		3237	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3238	} else {
		3239	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3240	}
		3241
		3242	cf::cede_to_tick;
		3243	}
		3244	}
		3245
		3246	{
		3247	my $anims = $facedata->{animinfo};
		3248
		3249	while (my ($anim, $info) = each %$anims) {
		3250	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3251	cf::cede_to_tick;
		3252	}
		3253
		3254	cf::anim::invalidate_all; # d'oh
		3255	}
		3256
		3257	{
		3258	# TODO: for gcfclient pleasure, we should give resources
		3259	# that gcfclient doesn't grok a >10000 face index.
		3260	my $res = $facedata->{resource};
		3261
		3262	while (my ($name, $info) = each %$res) {
		3263	if (defined $info->{type}) {
		3264	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3265	my $data;
		3266
		3267	if ($info->{type} & 1) {
		3268	# prepend meta info
		3269
		3270	my $meta = $enc->encode ({
		3271	name => $name,
		3272	%{ $info->{meta} || {} },
		3273	});
		3274
		3275	$data = pack "(w/a*)*", $meta, $info->{data};
		3276	} else {
		3277	$data = $info->{data};
		3278	}
		3279
		3280	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3281	cf::face::set_type $idx, $info->{type};
		3282	} else {
		3283	$RESOURCE{$name} = $info;
		3284	}
		3285
		3286	cf::cede_to_tick;
		3287	}
		3288	}
		3289
		3290	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3291
		3292	1
		3293	}
		3294
		3295	cf::global->attach (on_resource_update => sub {
		3296	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3297	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3298
		3299	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3300	my $sound = $soundconf->{compat}[$_]
		3301	or next;
		3302
		3303	my $face = cf::face::find "sound/$sound->[1]";
		3304	cf::sound::set $sound->[0] => $face;
		3305	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3306	}
		3307
		3308	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3309	my $face = cf::face::find "sound/$v";
		3310	cf::sound::set $k => $face;
		3311	}
		3312	}
		3313	});
		3314
		3315	register_exticmd fx_want => sub {
		3316	my ($ns, $want) = @_;
		3317
		3318	while (my ($k, $v) = each %$want) {
		3319	$ns->fx_want ($k, $v);
		3320	}
		3321	};
		3322
		3323	sub load_resource_file($) {
		3324	my $guard = lock_acquire "load_resource_file";
		3325
		3326	my $status = load_resource_file_ $_[0];
		3327	get_slot 0.1, 100;
		3328	cf::arch::commit_load;
		3329
		3330	$status
		3331	}
		3332
		3333	sub reload_regions {
		3334	# HACK to clear player env face cache, we need some signal framework
		3335	# for this (global event?)
		3336	%ext::player_env::MUSIC_FACE_CACHE = ();
		3337
		3338	load_resource_file "$MAPDIR/regions"
		3339	or die "unable to load regions file\n";
		3340
		3341	for (cf::region::list) {
		3342	$_->{match} = qr/$_->{match}/
		3343	if exists $_->{match};
		3344	}
		3345	}
		3346
		3347	sub reload_facedata {
		3348	load_facedata "$DATADIR/facedata"
		3349	or die "unable to load facedata\n";
		3350	}
		3351
		3352	sub reload_archetypes {
		3353	load_resource_file "$DATADIR/archetypes"
		3354	or die "unable to load archetypes\n";
		3355	}
		3356
		3357	sub reload_treasures {
		3358	load_resource_file "$DATADIR/treasures"
		3359	or die "unable to load treasurelists\n";
		3360	}
		3361
		3362	sub reload_resources {
		3363	warn "reloading resource files...\n";
		3364
		3365	reload_facedata;
		3366	reload_archetypes;
		3367	reload_regions;
		3368	reload_treasures;
		3369
		3370	warn "finished reloading resource files\n";
		3371	}
		3372
		3373	sub init {
		3374	my $guard = freeze_mainloop;
		3375
		3376	reload_resources;
		3377	}
		3378
		3379	sub reload_config {
1988	open my $fh, "<:utf8", cf::confdir . "/config"	3380	open my $fh, "<:utf8", "$CONFDIR/config"
1989	or return;	3381	or return;
1990		3382
1991	local $/;	3383	local $/;
1992	*CFG = YAML::Syck::Load <$fh>;	3384	*CFG = YAML::Load <$fh>;
		3385
		3386	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3387
		3388	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3389	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3390
		3391	if (exists $CFG{mlockall}) {
		3392	eval {
		3393	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3394	and die "WARNING: m(un)lockall failed: $!\n";
		3395	};
		3396	warn $@ if $@;
		3397	}
1993	}	3398	}
1994		3399
1995	sub main {	3400	sub main {
1996	# we must not ever block the main coroutine	3401	# we must not ever block the main coroutine
1997	local $Coro::idle = sub {	3402	local $Coro::idle = sub {
1998	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3403	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1999	(Coro::unblock_sub {	3404	(async {
2000	Event::one_event;	3405	$Coro::current->{desc} = "IDLE BUG HANDLER";
2001	})->();	3406	EV::loop EV::LOOP_ONESHOT;
		3407	})->prio (Coro::PRIO_MAX);
2002	};	3408	};
2003		3409
2004	cfg_load;	3410	{
2005	db_load;	3411	my $guard = freeze_mainloop;
		3412	reload_config;
		3413	db_init;
2006	load_extensions;	3414	load_extensions;
		3415
		3416	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3417	evthread_start IO::AIO::poll_fileno;
		3418	}
		3419
2007	Event::loop;	3420	EV::loop;
2008	}	3421	}
2009		3422
2010	#############################################################################	3423	#############################################################################
2011	# initialisation	3424	# initialisation and cleanup
2012		3425
		3426	# install some emergency cleanup handlers
		3427	BEGIN {
		3428	our %SIGWATCHER = ();
		3429	for my $signal (qw(INT HUP TERM)) {
		3430	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3431	cf::cleanup "SIG$signal";
		3432	};
		3433	}
		3434	}
		3435
		3436	sub write_runtime_sync {
		3437	my $runtime = "$LOCALDIR/runtime";
		3438
		3439	# first touch the runtime file to show we are still running:
		3440	# the fsync below can take a very very long time.
		3441
		3442	IO::AIO::aio_utime $runtime, undef, undef;
		3443
		3444	my $guard = cf::lock_acquire "write_runtime";
		3445
		3446	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3447	or return;
		3448
		3449	my $value = $cf::RUNTIME + 90 + 10;
		3450	# 10 is the runtime save interval, for a monotonic clock
		3451	# 60 allows for the watchdog to kill the server.
		3452
		3453	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3454	and return;
		3455
		3456	# always fsync - this file is important
		3457	aio_fsync $fh
		3458	and return;
		3459
		3460	# touch it again to show we are up-to-date
		3461	aio_utime $fh, undef, undef;
		3462
		3463	close $fh
		3464	or return;
		3465
		3466	aio_rename "$runtime~", $runtime
		3467	and return;
		3468
		3469	warn "runtime file written.\n";
		3470
		3471	1
		3472	}
		3473
		3474	our $uuid_lock;
		3475	our $uuid_skip;
		3476
		3477	sub write_uuid_sync($) {
		3478	$uuid_skip ||= $_[0];
		3479
		3480	return if $uuid_lock;
		3481	local $uuid_lock = 1;
		3482
		3483	my $uuid = "$LOCALDIR/uuid";
		3484
		3485	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3486	or return;
		3487
		3488	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3489	$uuid_skip = 0;
		3490
		3491	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3492	and return;
		3493
		3494	# always fsync - this file is important
		3495	aio_fsync $fh
		3496	and return;
		3497
		3498	close $fh
		3499	or return;
		3500
		3501	aio_rename "$uuid~", $uuid
		3502	and return;
		3503
		3504	warn "uuid file written ($value).\n";
		3505
		3506	1
		3507
		3508	}
		3509
		3510	sub write_uuid($$) {
		3511	my ($skip, $sync) = @_;
		3512
		3513	$sync ? write_uuid_sync $skip
		3514	: async { write_uuid_sync $skip };
		3515	}
		3516
		3517	sub emergency_save() {
		3518	my $freeze_guard = cf::freeze_mainloop;
		3519
		3520	warn "enter emergency perl save\n";
		3521
		3522	cf::sync_job {
		3523	# use a peculiar iteration method to avoid tripping on perl
		3524	# refcount bugs in for. also avoids problems with players
		3525	# and maps saved/destroyed asynchronously.
		3526	warn "begin emergency player save\n";
		3527	for my $login (keys %cf::PLAYER) {
		3528	my $pl = $cf::PLAYER{$login} or next;
		3529	$pl->valid or next;
		3530	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3531	$pl->save;
		3532	}
		3533	warn "end emergency player save\n";
		3534
		3535	warn "begin emergency map save\n";
		3536	for my $path (keys %cf::MAP) {
		3537	my $map = $cf::MAP{$path} or next;
		3538	$map->valid or next;
		3539	$map->save;
		3540	}
		3541	warn "end emergency map save\n";
		3542
		3543	warn "begin emergency database checkpoint\n";
		3544	BDB::db_env_txn_checkpoint $DB_ENV;
		3545	warn "end emergency database checkpoint\n";
		3546
		3547	warn "begin write uuid\n";
		3548	write_uuid_sync 1;
		3549	warn "end write uuid\n";
		3550	};
		3551
		3552	warn "leave emergency perl save\n";
		3553	}
		3554
		3555	sub post_cleanup {
		3556	my ($make_core) = @_;
		3557
		3558	warn Carp::longmess "post_cleanup backtrace"
		3559	if $make_core;
		3560	}
		3561
2013	sub reload() {	3562	sub do_reload_perl() {
2014	# can/must only be called in main	3563	# can/must only be called in main
2015	if ($Coro::current != $Coro::main) {	3564	if ($Coro::current != $Coro::main) {
2016	warn "can only reload from main coroutine\n";	3565	warn "can only reload from main coroutine";
2017	return;	3566	return;
2018	}	3567	}
2019		3568
2020	warn "reloading...";	3569	warn "reloading...";
2021		3570
2022	local $FREEZE = 1;	3571	warn "entering sync_job";
		3572
		3573	cf::sync_job {
		3574	cf::write_runtime_sync; # external watchdog should not bark
2023	cf::emergency_save;	3575	cf::emergency_save;
		3576	cf::write_runtime_sync; # external watchdog should not bark
2024		3577
2025	eval {	3578	warn "syncing database to disk";
		3579	BDB::db_env_txn_checkpoint $DB_ENV;
		3580
2026	# if anything goes wrong in here, we should simply crash as we already saved	3581	# if anything goes wrong in here, we should simply crash as we already saved
2027		3582
2028	# cancel all watchers	3583	warn "flushing outstanding aio requests";
2029	for (Event::all_watchers) {	3584	for (;;) {
2030	$_->cancel if $_->data & WF_AUTOCANCEL;	3585	BDB::flush;
		3586	IO::AIO::flush;
		3587	Coro::cede_notself;
		3588	last unless IO::AIO::nreqs || BDB::nreqs;
		3589	warn "iterate...";
2031	}	3590	}
2032		3591
		3592	++$RELOAD;
		3593
2033	# cancel all extension coros	3594	warn "cancelling all extension coros";
2034	$_->cancel for values %EXT_CORO;	3595	$_->cancel for values %EXT_CORO;
2035	%EXT_CORO = ();	3596	%EXT_CORO = ();
2036		3597
2037	# unload all extensions	3598	warn "removing commands";
2038	for (@exts) {	3599	%COMMAND = ();
		3600
		3601	warn "removing ext/exti commands";
		3602	%EXTCMD = ();
		3603	%EXTICMD = ();
		3604
		3605	warn "unloading/nuking all extensions";
		3606	for my $pkg (@EXTS) {
2039	warn "unloading <$_>";	3607	warn "... unloading $pkg";
2040	unload_extension $_;	3608
		3609	if (my $cb = $pkg->can ("unload")) {
		3610	eval {
		3611	$cb->($pkg);
		3612	1
		3613	} or warn "$pkg unloaded, but with errors: $@";
2041	}	3614	}
2042		3615
		3616	warn "... nuking $pkg";
		3617	Symbol::delete_package $pkg;
		3618	}
		3619
2043	# unload all modules loaded from $LIBDIR	3620	warn "unloading all perl modules loaded from $LIBDIR";
2044	while (my ($k, $v) = each %INC) {	3621	while (my ($k, $v) = each %INC) {
2045	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3622	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2046		3623
2047	warn "removing <$k>";	3624	warn "... unloading $k";
2048	delete $INC{$k};	3625	delete $INC{$k};
2049		3626
2050	$k =~ s/\.pm$//;	3627	$k =~ s/\.pm$//;
2051	$k =~ s/\//::/g;	3628	$k =~ s/\//::/g;
2052		3629
…		…
2055	}	3632	}
2056		3633
2057	Symbol::delete_package $k;	3634	Symbol::delete_package $k;
2058	}	3635	}
2059		3636
2060	# sync database to disk
2061	cf::db_sync;
2062	IO::AIO::flush;
2063
2064	# get rid of safe::, as good as possible	3637	warn "getting rid of safe::, as good as possible";
2065	Symbol::delete_package "safe::$_"	3638	Symbol::delete_package "safe::$_"
2066	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3639	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2067		3640
2068	# remove register_script_function callbacks
2069	# TODO
2070
2071	# unload cf.pm "a bit"	3641	warn "unloading cf.pm \"a bit\"";
2072	delete $INC{"cf.pm"};	3642	delete $INC{"cf.pm"};
		3643	delete $INC{"cf/pod.pm"};
2073		3644
2074	# don't, removes xs symbols, too,	3645	# don't, removes xs symbols, too,
2075	# and global variables created in xs	3646	# and global variables created in xs
2076	#Symbol::delete_package __PACKAGE__;	3647	#Symbol::delete_package __PACKAGE__;
2077		3648
2078	# reload cf.pm	3649	warn "unload completed, starting to reload now";
		3650
2079	warn "reloading cf.pm";	3651	warn "reloading cf.pm";
2080	require cf;	3652	require cf;
2081	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3653	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2082		3654
2083	# load config and database again	3655	warn "loading config and database again";
2084	cf::cfg_load;	3656	cf::reload_config;
2085	cf::db_load;
2086		3657
2087	# load extensions
2088	warn "load extensions";	3658	warn "loading extensions";
2089	cf::load_extensions;	3659	cf::load_extensions;
2090		3660
2091	# reattach attachments to objects	3661	warn "reattaching attachments to objects/players";
2092	warn "reattach";	3662	_global_reattach; # objects, sockets
2093	_global_reattach;	3663	warn "reattaching attachments to maps";
		3664	reattach $_ for values %MAP;
		3665	warn "reattaching attachments to players";
		3666	reattach $_ for values %PLAYER;
		3667
		3668	warn "leaving sync_job";
		3669
		3670	1
		3671	} or do {
		3672	warn $@;
		3673	cf::cleanup "error while reloading, exiting.";
2094	};	3674	};
2095		3675
2096	if ($@) {	3676	warn "reloaded";
2097	warn $@;
2098	warn "error while reloading, exiting.";
2099	exit 1;
2100	}
2101
2102	warn "reloaded successfully";
2103	};	3677	};
2104		3678
2105	#############################################################################	3679	our $RELOAD_WATCHER; # used only during reload
2106		3680
2107	unless ($LINK_MAP) {	3681	sub reload_perl() {
2108	$LINK_MAP = cf::map::new;	3682	# doing reload synchronously and two reloads happen back-to-back,
		3683	# coro crashes during coro_state_free->destroy here.
2109		3684
2110	$LINK_MAP->width (41);	3685	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2111	$LINK_MAP->height (41);	3686	do_reload_perl;
2112	$LINK_MAP->alloc;	3687	undef $RELOAD_WATCHER;
2113	$LINK_MAP->path ("{link}");	3688	};
2114	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2115	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2116
2117	# dirty hack because... archetypes are not yet loaded
2118	Event->timer (
2119	after => 2,
2120	cb => sub {
2121	$_[0]->w->cancel;
2122
2123	# provide some exits "home"
2124	my $exit = cf::object::new "exit";
2125
2126	$exit->slaying ($EMERGENCY_POSITION->[0]);
2127	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2128	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2129
2130	$LINK_MAP->insert ($exit->clone, 19, 19);
2131	$LINK_MAP->insert ($exit->clone, 19, 20);
2132	$LINK_MAP->insert ($exit->clone, 19, 21);
2133	$LINK_MAP->insert ($exit->clone, 20, 19);
2134	$LINK_MAP->insert ($exit->clone, 20, 21);
2135	$LINK_MAP->insert ($exit->clone, 21, 19);
2136	$LINK_MAP->insert ($exit->clone, 21, 20);
2137	$LINK_MAP->insert ($exit->clone, 21, 21);
2138
2139	$exit->destroy;
2140	});
2141
2142	$LINK_MAP->{deny_save} = 1;
2143	$LINK_MAP->{deny_reset} = 1;
2144
2145	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2146	}	3689	}
2147
2148	register "<global>", __PACKAGE__;
2149		3690
2150	register_command "reload" => sub {	3691	register_command "reload" => sub {
2151	my ($who, $arg) = @_;	3692	my ($who, $arg) = @_;
2152		3693
2153	if ($who->flag (FLAG_WIZ)) {	3694	if ($who->flag (FLAG_WIZ)) {
2154	$who->message ("start of reload.");
2155	reload;
2156	$who->message ("end of reload.");	3695	$who->message ("reloading server.");
		3696	async {
		3697	$Coro::current->{desc} = "perl_reload";
		3698	reload_perl;
		3699	};
2157	}	3700	}
2158	};	3701	};
2159		3702
2160	unshift @INC, $LIBDIR;	3703	unshift @INC, $LIBDIR;
2161		3704
2162	$TICK_WATCHER = Event->timer (	3705	my $bug_warning = 0;
2163	reentrant => 0,	3706
2164	prio => 0,	3707	our @WAIT_FOR_TICK;
2165	at => $NEXT_TICK || $TICK,	3708	our @WAIT_FOR_TICK_BEGIN;
2166	data => WF_AUTOCANCEL,	3709
2167	cb => sub {	3710	sub wait_for_tick {
2168	unless ($FREEZE) {	3711	return if tick_inhibit || $Coro::current == $Coro::main;
		3712
		3713	my $signal = new Coro::Signal;
		3714	push @WAIT_FOR_TICK, $signal;
		3715	$signal->wait;
		3716	}
		3717
		3718	sub wait_for_tick_begin {
		3719	return if tick_inhibit || $Coro::current == $Coro::main;
		3720
		3721	my $signal = new Coro::Signal;
		3722	push @WAIT_FOR_TICK_BEGIN, $signal;
		3723	$signal->wait;
		3724	}
		3725
		3726	sub tick {
		3727	if ($Coro::current != $Coro::main) {
		3728	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3729	unless ++$bug_warning > 10;
		3730	return;
		3731	}
		3732
2169	cf::server_tick; # one server iteration	3733	cf::server_tick; # one server iteration
2170	$RUNTIME += $TICK;
2171	}
2172		3734
2173	$NEXT_TICK += $TICK;	3735	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2174		3736	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2175	# if we are delayed by four ticks or more, skip them all	3737	Coro::async_pool {
2176	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3738	$Coro::current->{desc} = "runtime saver";
2177
2178	$TICK_WATCHER->at ($NEXT_TICK);
2179	$TICK_WATCHER->start;
2180	},
2181	);
2182
2183	IO::AIO::max_poll_time $TICK * 0.2;
2184
2185	Event->io (
2186	fd => IO::AIO::poll_fileno,
2187	poll => 'r',
2188	prio => 5,
2189	data => WF_AUTOCANCEL,
2190	cb => \&IO::AIO::poll_cb,
2191	);
2192
2193	Event->timer (
2194	data => WF_AUTOCANCEL,
2195	after => 0,
2196	interval => 10,
2197	cb => sub {
2198	(Coro::unblock_sub {
2199	write_runtime	3739	write_runtime_sync
2200	or warn "ERROR: unable to write runtime file: $!";	3740	or warn "ERROR: unable to write runtime file: $!";
2201	})->();	3741	};
2202	},	3742	}
2203	);	3743
		3744	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3745	$sig->send;
		3746	}
		3747	while (my $sig = shift @WAIT_FOR_TICK) {
		3748	$sig->send;
		3749	}
		3750
		3751	$LOAD = ($NOW - $TICK_START) / $TICK;
		3752	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3753
		3754	if (0) {
		3755	if ($NEXT_TICK) {
		3756	my $jitter = $TICK_START - $NEXT_TICK;
		3757	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3758	warn "jitter $JITTER\n";#d#
		3759	}
		3760	}
		3761	}
		3762
		3763	{
		3764	# configure BDB
		3765
		3766	BDB::min_parallel 8;
		3767	BDB::max_poll_reqs $TICK * 0.1;
		3768	$Coro::BDB::WATCHER->priority (1);
		3769
		3770	unless ($DB_ENV) {
		3771	$DB_ENV = BDB::db_env_create;
		3772	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3773	| BDB::LOG_AUTOREMOVE, 1);
		3774	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3775	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3776
		3777	cf::sync_job {
		3778	eval {
		3779	BDB::db_env_open
		3780	$DB_ENV,
		3781	$BDBDIR,
		3782	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3783	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3784	0666;
		3785
		3786	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3787	};
		3788
		3789	cf::cleanup "db_env_open(db): $@" if $@;
		3790	};
		3791	}
		3792
		3793	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3794	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3795	};
		3796	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3797	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3798	};
		3799	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3800	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3801	};
		3802	}
		3803
		3804	{
		3805	# configure IO::AIO
		3806
		3807	IO::AIO::min_parallel 8;
		3808	IO::AIO::max_poll_time $TICK * 0.1;
		3809	$Coro::AIO::WATCHER->priority (1);
		3810	}
		3811
		3812	my $_log_backtrace;
		3813
		3814	sub _log_backtrace {
		3815	my ($msg, @addr) = @_;
		3816
		3817	$msg =~ s/\n//;
		3818
		3819	# limit the # of concurrent backtraces
		3820	if ($_log_backtrace < 2) {
		3821	++$_log_backtrace;
		3822	async {
		3823	$Coro::current->{desc} = "abt $msg";
		3824
		3825	my @bt = fork_call {
		3826	@addr = map { sprintf "%x", $_ } @addr;
		3827	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3828	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3829	or die "addr2line: $!";
		3830
		3831	my @funcs;
		3832	my @res = <$fh>;
		3833	chomp for @res;
		3834	while (@res) {
		3835	my ($func, $line) = splice @res, 0, 2, ();
		3836	push @funcs, "[$func] $line";
		3837	}
		3838
		3839	@funcs
		3840	};
		3841
		3842	LOG llevInfo, "[ABT] $msg\n";
		3843	LOG llevInfo, "[ABT] $_\n" for @bt;
		3844	--$_log_backtrace;
		3845	};
		3846	} else {
		3847	LOG llevInfo, "[ABT] $msg\n";
		3848	LOG llevInfo, "[ABT] [suppressed]\n";
		3849	}
		3850	}
		3851
		3852	# load additional modules
		3853	use cf::pod;
2204		3854
2205	END { cf::emergency_save }	3855	END { cf::emergency_save }
2206		3856
2207	1	3857	1
2208		3858

Diff Legend

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