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.133 by root, Thu Jan 4 16:19:32 2007 UTC vs.
Revision 1.425 by root, Mon Apr 21 06:35:26 2008 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
2		23
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 $RANDOM_MAPS = cf::localdir . "/random";	114	our $LINK_MAP; # the special {link} map, which is always available
55	our %EXT_CORO;	115
		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
56		123
57	binmode STDOUT;	124	binmode STDOUT;
58	binmode STDERR;	125	binmode STDERR;
59		126
60	# read virtual server time, if available	127	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	128	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62	open my $fh, "<", cf::localdir . "/runtime"	129	open my $fh, "<", "$LOCALDIR/runtime"
63	or die "unable to read runtime file: $!";	130	or die "unable to read runtime file: $!";
64	$RUNTIME = <$fh> + 0.;	131	$RUNTIME = <$fh> + 0.;
65	}	132	}
66		133
67	mkdir cf::localdir;	134	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	135	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		136
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	137	our $EMERGENCY_POSITION;
		138
		139	sub cf::map::normalise;
76		140
77	#############################################################################	141	#############################################################################
78		142
79	=head2 GLOBAL VARIABLES	143	=head2 GLOBAL VARIABLES
80		144
…		…
87	=item $cf::RUNTIME	151	=item $cf::RUNTIME
88		152
89	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
90	every server tick.	154	every server tick.
91		155
92	=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
93		159
94	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
95	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.
96		164
97	=item $cf::NOW	165	=item $cf::NOW
98		166
99	The time of the last (current) server tick.	167	The time of the last (current) server tick.
100		168
101	=item $cf::TICK	169	=item $cf::TICK
102		170
103	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
104		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
105	=item %cf::CFG	183	=item %cf::CFG
106		184
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	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.
109		199
110	=back	200	=back
111		201
112	=cut	202	=cut
113		203
114	BEGIN {	204	BEGIN {
115	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	206	my $msg = join "", @_;
117	utf8::encode $msg;
118		207
119	$msg .= "\n"	208	$msg .= "\n"
120	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
121		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
122	LOG llevError, "cfperl: $msg";	213	LOG llevError, $msg;
123	};	214	};
124	}	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#?
125		231
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		239
133	# 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
134	# within the Safe compartment.	241	# within the Safe compartment.
135	for my $pkg (qw(	242	for my $pkg (qw(
136	cf::global cf::attachable	243	cf::global cf::attachable
…		…
141	)) {	248	)) {
142	no strict 'refs';	249	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	251	}
145		252
146	$Event::DIED = sub {	253	$EV::DIED = sub {
147	warn "error in event callback: @_";	254	warn "error in event callback: @_";
148	};	255	};
149		256
150	my %ext_pkg;	257	#############################################################################
151	my @exts;
152	my @hook;
153		258
154	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
155		260
156	=over 4	261	=over 4
157		262
158	=cut	263	=item dumpval $ref
159		264
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	265	=cut
161		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
162	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
163		287
164	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
165		289
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
174		291
175	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
176		293
177	=cut	294	=cut
178		295
179	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181	JSON::Syck::Dump $_[0]
182	}
183		297
184	=item my $guard = cf::guard { BLOCK }	298	sub encode_json($) { $json_coder->encode ($_[0]) }
185		299	sub decode_json($) { $json_coder->decode ($_[0]) }
186	Run the given callback when the guard object gets destroyed (useful for
187	coroutine cancellations).
188
189	You can call C<< ->cancel >> on the guard object to stop the block from
190	being executed.
191
192	=cut
193
194	sub guard(&) {
195	bless \(my $cb = $_[0]), cf::guard::;
196	}
197
198	sub cf::guard::cancel {
199	${$_[0]} = sub { };
200	}
201
202	sub cf::guard::DESTROY {
203	${$_[0]}->();
204	}
205		300
206	=item cf::lock_wait $string	301	=item cf::lock_wait $string
207		302
208	Wait until the given lock is available. See cf::lock_acquire.	303	Wait until the given lock is available. See cf::lock_acquire.
209		304
210	=item my $lock = cf::lock_acquire $string	305	=item my $lock = cf::lock_acquire $string
211		306
212	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
213	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,
214	for example when the coroutine gets canceled), the lock is automatically	309	for example when the coroutine gets canceled), the lock is automatically
215	returned.	310	returned.
216		311
		312	Locks are *not* recursive, locking from the same coro twice results in a
		313	deadlocked coro.
		314
217	Lock names should begin with a unique identifier (for example, cf::map::find	315	Lock names should begin with a unique identifier (for example, cf::map::find
218	uses map_find and cf::map::load uses map_load).	316	uses map_find and cf::map::load uses map_load).
219		317
		318	=item $locked = cf::lock_active $string
		319
		320	Return true if the lock is currently active, i.e. somebody has locked it.
		321
220	=cut	322	=cut
221		323
222	our %LOCK;	324	our %LOCK;
		325	our %LOCKER;#d#
223		326
224	sub lock_wait($) {	327	sub lock_wait($) {
225	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#
226		334
227	# wait for lock, if any	335	# wait for lock, if any
228	while ($LOCK{$key}) {	336	while ($LOCK{$key}) {
229	push @{ $LOCK{$key} }, $Coro::current;	337	push @{ $LOCK{$key} }, $Coro::current;
230	Coro::schedule;	338	Coro::schedule;
…		…
236		344
237	# wait, to be sure we are not locked	345	# wait, to be sure we are not locked
238	lock_wait $key;	346	lock_wait $key;
239		347
240	$LOCK{$key} = [];	348	$LOCK{$key} = [];
		349	$LOCKER{$key} = $Coro::current;#d#
241		350
242	cf::guard {	351	Coro::guard {
		352	delete $LOCKER{$key};#d#
243	# wake up all waiters, to be on the safe side	353	# wake up all waiters, to be on the safe side
244	$_->ready for @{ delete $LOCK{$key} };	354	$_->ready for @{ delete $LOCK{$key} };
245	}	355	}
246	}	356	}
247		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
248	=item cf::async { BLOCK }	445	=item cf::async { BLOCK }
249		446
250	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
251	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.
252		450
253	=cut	451	=cut
254		452
255	sub async(&) {	453	BEGIN { *async = \&Coro::async_pool }
256	my ($cb) = @_;
257
258	Coro::async {
259	eval { $cb->() };
260	warn $@ if $@;
261	}
262	}
263
264	sub freeze_mainloop {
265	return unless $TICK_WATCHER->is_active;
266
267	my $guard = guard { $TICK_WATCHER->start };
268	$TICK_WATCHER->stop;
269	$guard
270	}
271		454
272	=item cf::sync_job { BLOCK }	455	=item cf::sync_job { BLOCK }
273		456
274	The design of crossfire+ requires that the main coro ($Coro::main) is	457	The design of Deliantra requires that the main coroutine ($Coro::main)
275	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
276	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.
277		461
278	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
279	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
280	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
281	fast or be very important.	465	fast or be very important.
…		…
284		468
285	sub sync_job(&) {	469	sub sync_job(&) {
286	my ($job) = @_;	470	my ($job) = @_;
287		471
288	if ($Coro::current == $Coro::main) {	472	if ($Coro::current == $Coro::main) {
		473	my $time = EV::time;
		474
289	# this is the main coro, too bad, we have to block	475	# this is the main coro, too bad, we have to block
290	# till the operation succeeds, freezing the server :/	476	# till the operation succeeds, freezing the server :/
291		477
292	# TODO: use suspend/resume instead	478	LOG llevError, Carp::longmess "sync job";#d#
293	# (but this is cancel-safe)	479
294	my $freeze_guard = freeze_mainloop;	480	my $freeze_guard = freeze_mainloop;
295		481
296	my $busy = 1;	482	my $busy = 1;
297	my @res;	483	my @res;
298		484
299	(Coro::async {	485	(async {
		486	$Coro::current->desc ("sync job coro");
300	@res = eval { $job->() };	487	@res = eval { $job->() };
301	warn $@ if $@;	488	warn $@ if $@;
302	undef $busy;	489	undef $busy;
303	})->prio (Coro::PRIO_MAX);	490	})->prio (Coro::PRIO_MAX);
304		491
305	while ($busy) {	492	while ($busy) {
		493	if (Coro::nready) {
306	Coro::cede_notself;	494	Coro::cede_notself;
307	Event::one_event unless Coro::nready;	495	} else {
		496	EV::loop EV::LOOP_ONESHOT;
308	}	497	}
		498	}
		499
		500	my $time = EV::time - $time;
		501
		502	$TICK_START += $time; # do not account sync jobs to server load
309		503
310	wantarray ? @res : $res[0]	504	wantarray ? @res : $res[0]
311	} else {	505	} else {
312	# we are in another coroutine, how wonderful, everything just works	506	# we are in another coroutine, how wonderful, everything just works
313		507
314	$job->()	508	$job->()
315	}	509	}
316	}	510	}
317		511
318	=item $coro = cf::coro { BLOCK }	512	=item $coro = cf::async_ext { BLOCK }
319		513
320	Creates and returns a new coro. This coro is automcatially being canceled	514	Like async, but this coro is automatically being canceled when the
321	when the extension calling this is being unloaded.	515	extension calling this is being unloaded.
322		516
323	=cut	517	=cut
324		518
325	sub coro(&) {	519	sub async_ext(&) {
326	my $cb = shift;	520	my $cb = shift;
327		521
328	my $coro = &cf::async ($cb);	522	my $coro = &Coro::async ($cb);
329		523
330	$coro->on_destroy (sub {	524	$coro->on_destroy (sub {
331	delete $EXT_CORO{$coro+0};	525	delete $EXT_CORO{$coro+0};
332	});	526	});
333	$EXT_CORO{$coro+0} = $coro;	527	$EXT_CORO{$coro+0} = $coro;
334		528
335	$coro	529	$coro
336	}	530	}
337		531
338	sub write_runtime {	532	=item fork_call { }, $args
339	my $runtime = cf::localdir . "/runtime";
340		533
341	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	534	Executes the given code block with the given arguments in a seperate
342	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.
343		538
344	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	539	=cut
345	(aio_write $fh, 0, (length $value), $value, 0) <= 0
346	and return;
347		540
348	aio_fsync $fh	541	sub fork_call(&@) {
349	and return;	542	my ($cb, @args) = @_;
350		543
351	close $fh	544	# we seemingly have to make a local copy of the whole thing,
352	or return;	545	# otherwise perl prematurely frees the stuff :/
		546	# TODO: investigate and fix (likely this will be rather laborious)
353		547
354	aio_rename "$runtime~", $runtime	548	my @res = Coro::Util::fork_eval {
355	and return;	549	reset_signals;
		550	&$cb
		551	}, @args;
356		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
357	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 });
358	}	719	}
359		720
360	=back	721	=back
361		722
362	=cut	723	=cut
363
364	#############################################################################
365
366	package cf::path;
367
368	sub new {
369	my ($class, $path, $base) = @_;
370
371	$path = $path->as_string if ref $path;
372
373	my $self = bless { }, $class;
374
375	# {... are special paths that are not touched
376	# ?xxx/... are special absolute paths
377	# ?random/... random maps
378	# /! non-realised random map exit
379	# /... normal maps
380	# ~/... per-player maps without a specific player (DO NOT USE)
381	# ~user/... per-player map of a specific user
382
383	if ($path =~ /^{/) {
384	# fine as it is
385	} elsif ($path =~ s{^\?random/}{}) {
386	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
387	$self->{random} = cf::from_json $data;
388	} else {
389	if ($path =~ s{^~([^/]+)?}{}) {
390	$self->{user_rel} = 1;
391
392	if (defined $1) {
393	$self->{user} = $1;
394	} elsif ($base =~ m{^~([^/]+)/}) {
395	$self->{user} = $1;
396	} else {
397	warn "cannot resolve user-relative path without user <$path,$base>\n";
398	}
399	} elsif ($path =~ /^\//) {
400	# already absolute
401	} else {
402	$base =~ s{[^/]+/?$}{};
403	return $class->new ("$base/$path");
404	}
405
406	for ($path) {
407	redo if s{/\.?/}{/};
408	redo if s{/[^/]+/\.\./}{/};
409	}
410	}
411
412	$self->{path} = $path;
413
414	$self
415	}
416
417	# the name / primary key / in-game path
418	sub as_string {
419	my ($self) = @_;
420
421	$self->{user_rel} ? "~$self->{user}$self->{path}"
422	: $self->{random} ? "?random/$self->{path}"
423	: $self->{path}
424	}
425
426	# the displayed name, this is a one way mapping
427	sub visible_name {
428	my ($self) = @_;
429
430	# if (my $rmp = $self->{random}) {
431	# # todo: be more intelligent about this
432	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
433	# } else {
434	$self->as_string
435	# }
436	}
437
438	# escape the /'s in the path
439	sub _escaped_path {
440	# ∕ is U+2215
441	(my $path = $_[0]{path}) =~ s/\//∕/g;
442	$path
443	}
444
445	# the original (read-only) location
446	sub load_path {
447	my ($self) = @_;
448
449	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
450	}
451
452	# the temporary/swap location
453	sub save_path {
454	my ($self) = @_;
455
456	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
457	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
458	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
459	}
460
461	# the unique path, might be eq to save_path
462	sub uniq_path {
463	my ($self) = @_;
464
465	$self->{user_rel} || $self->{random}
466	? undef
467	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
468	}
469
470	# return random map parameters, or undef
471	sub random_map_params {
472	my ($self) = @_;
473
474	$self->{random}
475	}
476
477	# this is somewhat ugly, but style maps do need special treatment
478	sub is_style_map {
479	$_[0]{path} =~ m{^/styles/}
480	}
481
482	package cf;
483		724
484	#############################################################################	725	#############################################################################
485		726
486	=head2 ATTACHABLE OBJECTS	727	=head2 ATTACHABLE OBJECTS
487		728
…		…
489	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")
490	to it. All such attachable objects support the following methods.	731	to it. All such attachable objects support the following methods.
491		732
492	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>
493	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
494	crossfire+).	735	Deliantra).
495		736
496	=over 4	737	=over 4
497		738
498	=item $attachable->attach ($attachment, key => $value...)	739	=item $attachable->attach ($attachment, key => $value...)
499		740
…		…
613	our @CB_TYPE = (); # registry for type (cf-object class) based events	854	our @CB_TYPE = (); # registry for type (cf-object class) based events
614	our @CB_MAP = ();	855	our @CB_MAP = ();
615		856
616	my %attachment;	857	my %attachment;
617		858
		859	sub cf::attachable::thawer_merge {
		860	# simply override everything except _meta
		861	local $_[0]{_meta};
		862	%{$_[0]} = %{$_[1]};
		863	}
		864
618	sub _attach_cb($$$$) {	865	sub _attach_cb($$$$) {
619	my ($registry, $event, $prio, $cb) = @_;	866	my ($registry, $event, $prio, $cb) = @_;
620		867
621	use sort 'stable';	868	use sort 'stable';
622		869
…		…
656	$registry = $CB_TYPE[$object_type] ||= [];	903	$registry = $CB_TYPE[$object_type] ||= [];
657		904
658	} elsif ($type eq "subtype") {	905	} elsif ($type eq "subtype") {
659	defined $object_type or Carp::croak "subtype specified without type";	906	defined $object_type or Carp::croak "subtype specified without type";
660	my $object_subtype = shift @arg;	907	my $object_subtype = shift @arg;
661	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	908	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
662		909
663	} elsif ($type eq "package") {	910	} elsif ($type eq "package") {
664	my $pkg = shift @arg;	911	my $pkg = shift @arg;
665		912
666	while (my ($name, $id) = each %cb_id) {	913	while (my ($name, $id) = each %cb_id) {
…		…
695	_attach $registry, $klass, @attach;	942	_attach $registry, $klass, @attach;
696	}	943	}
697		944
698	$obj->{$name} = \%arg;	945	$obj->{$name} = \%arg;
699	} else {	946	} else {
700	warn "object uses attachment '$name' that is not available, postponing.\n";	947	warn "object uses attachment '$name' which is not available, postponing.\n";
701	}	948	}
702		949
703	$obj->{_attachment}{$name} = undef;	950	$obj->{_attachment}{$name} = undef;
704	}	951	}
705		952
…		…
707	if (ref $_[0]) {	954	if (ref $_[0]) {
708	_object_attach @_;	955	_object_attach @_;
709	} else {	956	} else {
710	_attach shift->_attach_registry, @_;	957	_attach shift->_attach_registry, @_;
711	}	958	}
		959	_recalc_want;
712	};	960	};
713		961
714	# all those should be optimised	962	# all those should be optimised
715	sub cf::attachable::detach {	963	sub cf::attachable::detach {
716	my ($obj, $name) = @_;	964	my ($obj, $name) = @_;
…		…
719	delete $obj->{_attachment}{$name};	967	delete $obj->{_attachment}{$name};
720	reattach ($obj);	968	reattach ($obj);
721	} else {	969	} else {
722	Carp::croak "cannot, currently, detach class attachments";	970	Carp::croak "cannot, currently, detach class attachments";
723	}	971	}
		972	_recalc_want;
724	};	973	};
725		974
726	sub cf::attachable::attached {	975	sub cf::attachable::attached {
727	my ($obj, $name) = @_;	976	my ($obj, $name) = @_;
728		977
…		…
743	";	992	";
744	die if $@;	993	die if $@;
745	}	994	}
746		995
747	our $override;	996	our $override;
748	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?
749		998
750	sub override {	999	sub override {
751	$override = 1;	1000	$override = 1;
752	@invoke_results = ();	1001	@INVOKE_RESULTS = (@_);
753	}	1002	}
754		1003
755	sub do_invoke {	1004	sub do_invoke {
756	my $event = shift;	1005	my $event = shift;
757	my $callbacks = shift;	1006	my $callbacks = shift;
758		1007
759	@invoke_results = ();	1008	@INVOKE_RESULTS = ();
760		1009
761	local $override;	1010	local $override;
762		1011
763	for (@$callbacks) {	1012	for (@$callbacks) {
764	eval { &{$_->[1]} };	1013	eval { &{$_->[1]} };
…		…
773	}	1022	}
774		1023
775	0	1024	0
776	}	1025	}
777		1026
778	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1027	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
779		1028
780	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1029	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
781		1030
782	Generate an object-specific event with the given arguments.	1031	Generate an object-specific event with the given arguments.
783		1032
784	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
785	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
786	results (if you must, access C<@cf::invoke_results> directly).	1035	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
787		1036
788	=back	1037	=back
789		1038
790	=cut	1039	=cut
791		1040
792	#############################################################################	1041	#############################################################################
793	# 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	}
794		1085
795	sub reattach {	1086	sub reattach {
796	# basically do the same as instantiate, without calling instantiate	1087	# basically do the same as instantiate, without calling instantiate
797	my ($obj) = @_;	1088	my ($obj) = @_;
		1089
		1090	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
798		1091
799	my $registry = $obj->registry;	1092	my $registry = $obj->registry;
800		1093
801	@$registry = ();	1094	@$registry = ();
802		1095
…		…
817	cf::attachable->attach (	1110	cf::attachable->attach (
818	prio => -1000000,	1111	prio => -1000000,
819	on_instantiate => sub {	1112	on_instantiate => sub {
820	my ($obj, $data) = @_;	1113	my ($obj, $data) = @_;
821		1114
822	$data = from_json $data;	1115	$data = decode_json $data;
823		1116
824	for (@$data) {	1117	for (@$data) {
825	my ($name, $args) = @$_;	1118	my ($name, $args) = @$_;
826		1119
827	$obj->attach ($name, %{$args || {} });	1120	$obj->attach ($name, %{$args || {} });
…		…
843	sub object_freezer_save {	1136	sub object_freezer_save {
844	my ($filename, $rdata, $objs) = @_;	1137	my ($filename, $rdata, $objs) = @_;
845		1138
846	sync_job {	1139	sync_job {
847	if (length $$rdata) {	1140	if (length $$rdata) {
		1141	utf8::decode (my $decname = $filename);
848	warn sprintf "saving %s (%d,%d)\n",	1142	warn sprintf "saving %s (%d,%d)\n",
849	$filename, length $$rdata, scalar @$objs;	1143	$decname, length $$rdata, scalar @$objs;
850		1144
851	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1145	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
852	chmod SAVE_MODE, $fh;	1146	chmod SAVE_MODE, $fh;
853	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1147	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
854	aio_fsync $fh;	1148	aio_fsync $fh if $cf::USE_FSYNC;
855	close $fh;	1149	close $fh;
856		1150
857	if (@$objs) {	1151	if (@$objs) {
858	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) {
859	chmod SAVE_MODE, $fh;	1153	chmod SAVE_MODE, $fh;
860	my $data = Storable::nfreeze { version => 1, objs => $objs };	1154	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
861	aio_write $fh, 0, (length $data), $data, 0;	1155	aio_write $fh, 0, (length $data), $data, 0;
862	aio_fsync $fh;	1156	aio_fsync $fh if $cf::USE_FSYNC;
863	close $fh;	1157	close $fh;
864	aio_rename "$filename.pst~", "$filename.pst";	1158	aio_rename "$filename.pst~", "$filename.pst";
865	}	1159	}
866	} else {	1160	} else {
867	aio_unlink "$filename.pst";	1161	aio_unlink "$filename.pst";
…		…
873	}	1167	}
874	} else {	1168	} else {
875	aio_unlink $filename;	1169	aio_unlink $filename;
876	aio_unlink "$filename.pst";	1170	aio_unlink "$filename.pst";
877	}	1171	}
878	}	1172	};
879	}	1173	}
880		1174
881	sub object_freezer_as_string {	1175	sub object_freezer_as_string {
882	my ($rdata, $objs) = @_;	1176	my ($rdata, $objs) = @_;
883		1177
…		…
895	or return;	1189	or return;
896		1190
897	unless (aio_stat "$filename.pst") {	1191	unless (aio_stat "$filename.pst") {
898	(aio_load "$filename.pst", $av) >= 0	1192	(aio_load "$filename.pst", $av) >= 0
899	or return;	1193	or return;
		1194
900	$av = eval { (Storable::thaw $av)->{objs} };	1195	my $st = eval { Coro::Storable::thaw $av };
		1196	$av = $st->{objs};
901	}	1197	}
902		1198
		1199	utf8::decode (my $decname = $filename);
903	warn sprintf "loading %s (%d)\n",	1200	warn sprintf "loading %s (%d,%d)\n",
904	$filename, length $data, scalar @{$av || []};#d#	1201	$decname, length $data, scalar @{$av || []};
		1202
905	return ($data, $av);	1203	($data, $av)
906	}	1204	}
		1205
		1206	=head2 COMMAND CALLBACKS
		1207
		1208	=over 4
		1209
		1210	=cut
907		1211
908	#############################################################################	1212	#############################################################################
909	# command handling &c	1213	# command handling &c
910		1214
911	=item cf::register_command $name => \&callback($ob,$args);	1215	=item cf::register_command $name => \&callback($ob,$args);
…		…
924	push @{ $COMMAND{$name} }, [$caller, $cb];	1228	push @{ $COMMAND{$name} }, [$caller, $cb];
925	}	1229	}
926		1230
927	=item cf::register_extcmd $name => \&callback($pl,$packet);	1231	=item cf::register_extcmd $name => \&callback($pl,$packet);
928		1232
929	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.
930		1238
931	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
932	called.	1240	called.
933		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
934	=cut	1253	=cut
935		1254
936	sub register_extcmd {	1255	sub register_extcmd {
937	my ($name, $cb) = @_;	1256	my ($name, $cb) = @_;
938		1257
939	my $caller = caller;
940	#warn "registering extcmd '$name' to '$caller'";
941
942	$EXTCMD{$name} = [$cb, $caller];	1258	$EXTCMD{$name} = $cb;
		1259	}
		1260
		1261	sub register_exticmd {
		1262	my ($name, $cb) = @_;
		1263
		1264	$EXTICMD{$name} = $cb;
943	}	1265	}
944		1266
945	cf::player->attach (	1267	cf::player->attach (
946	on_command => sub {	1268	on_command => sub {
947	my ($pl, $name, $params) = @_;	1269	my ($pl, $name, $params) = @_;
…		…
956	cf::override;	1278	cf::override;
957	},	1279	},
958	on_extcmd => sub {	1280	on_extcmd => sub {
959	my ($pl, $buf) = @_;	1281	my ($pl, $buf) = @_;
960		1282
961	my $msg = eval { from_json $buf };	1283	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
962		1284
963	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
964	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1293	if (my $cb = $EXTCMD{$type}) {
965	if (my %reply = $cb->[0]->($pl, $msg)) {	1294	@reply = $cb->($pl, @payload);
966	$pl->ext_reply ($msg->{msgid}, %reply);
967	}
968	}	1295	}
		1296
		1297	$pl->ext_reply ($reply, @reply)
		1298	if $reply;
		1299
969	} else {	1300	} else {
970	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1301	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
971	}	1302	}
972		1303
973	cf::override;	1304	cf::override;
974	},	1305	},
975	);	1306	);
976		1307
977	sub register {
978	my ($base, $pkg) = @_;
979
980	#TODO
981	}
982
983	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($) {
984	my ($path) = @_;	1748	my ($path) = @_;
985		1749
986	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1750	my ($match, $specificity);
987	my $base = $1;
988	my $pkg = $1;
989	$pkg =~ s/[^[:word:]]/_/g;
990	$pkg = "ext::$pkg";
991		1751
992	warn "loading '$path' into '$pkg'\n";	1752	for my $region (list) {
993		1753	if ($region->{match} && $path =~ $region->{match}) {
994	open my $fh, "<:utf8", $path	1754	($match, $specificity) = ($region, $region->specificity)
995	or die "$path: $!";	1755	if $region->specificity > $specificity;
996		1756	}
997	my $source =
998	"package $pkg; use strict; use utf8;\n"
999	. "#line 1 \"$path\"\n{\n"
1000	. (do { local $/; <$fh> })
1001	. "\n};\n1";
1002
1003	eval $source
1004	or die $@ ? "$path: $@\n"
1005	: "extension disabled.\n";
1006
1007	push @exts, $pkg;
1008	$ext_pkg{$base} = $pkg;
1009
1010	# no strict 'refs';
1011	# @{"$pkg\::ISA"} = ext::;
1012
1013	register $base, $pkg;
1014	}
1015
1016	sub unload_extension {
1017	my ($pkg) = @_;
1018
1019	warn "removing extension $pkg\n";
1020
1021	# remove hooks
1022	#TODO
1023	# for my $idx (0 .. $#PLUGIN_EVENT) {
1024	# delete $hook[$idx]{$pkg};
1025	# }	1757	}
1026		1758
1027	# remove commands	1759	$match
1028	for my $name (keys %COMMAND) {
1029	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1030
1031	if (@cb) {
1032	$COMMAND{$name} = \@cb;
1033	} else {
1034	delete $COMMAND{$name};
1035	}
1036	}
1037
1038	# remove extcmds
1039	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1040	delete $EXTCMD{$name};
1041	}
1042
1043	if (my $cb = $pkg->can ("unload")) {
1044	eval {
1045	$cb->($pkg);
1046	1
1047	} or warn "$pkg unloaded, but with errors: $@";
1048	}
1049
1050	Symbol::delete_package $pkg;
1051	}
1052
1053	sub load_extensions {
1054	for my $ext (<$LIBDIR/*.ext>) {
1055	next unless -r $ext;
1056	eval {
1057	load_extension $ext;
1058	1
1059	} or warn "$ext not loaded: $@";
1060	}
1061	}
1062
1063	#############################################################################
1064	# load/save/clean perl data associated with a map
1065
1066	*cf::mapsupport::on_clean = sub {
1067	my ($map) = @_;
1068
1069	my $path = $map->tmpname;
1070	defined $path or return;
1071
1072	unlink "$path.pst";
1073	};
1074
1075	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1076
1077	#############################################################################
1078	# load/save perl data associated with player->ob objects
1079
1080	sub all_objects(@) {
1081	@_, map all_objects ($_->inv), @_
1082	}
1083
1084	# TODO: compatibility cruft, remove when no longer needed
1085	cf::player->attach (
1086	on_load => sub {
1087	my ($pl, $path) = @_;
1088
1089	for my $o (all_objects $pl->ob) {
1090	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1091	$o->set_ob_key_value ("_perl_data");
1092
1093	%$o = %{ Storable::thaw pack "H*", $value };
1094	}
1095	}
1096	},
1097	);
1098
1099	#############################################################################
1100
1101	=head2 CORE EXTENSIONS
1102
1103	Functions and methods that extend core crossfire objects.
1104
1105	=head3 cf::player
1106
1107	=over 4
1108
1109	=item cf::player::exists $login
1110
1111	Returns true when the given account exists.
1112
1113	=cut
1114
1115	sub cf::player::exists($) {
1116	cf::player::find $_[0]
1117	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1118	}
1119
1120	=item $player->ext_reply ($msgid, $msgtype, %msg)
1121
1122	Sends an ext reply to the player.
1123
1124	=cut
1125
1126	sub cf::player::ext_reply($$$%) {
1127	my ($self, $id, %msg) = @_;
1128
1129	$msg{msgid} = $id;
1130
1131	$self->send ("ext " . to_json \%msg);
1132	}	1760	}
1133		1761
1134	=back	1762	=back
1135
1136		1763
1137	=head3 cf::map	1764	=head3 cf::map
1138		1765
1139	=over 4	1766	=over 4
1140		1767
…		…
1143	package cf::map;	1770	package cf::map;
1144		1771
1145	use Fcntl;	1772	use Fcntl;
1146	use Coro::AIO;	1773	use Coro::AIO;
1147		1774
		1775	use overload
		1776	'""' => \&as_string,
		1777	fallback => 1;
		1778
1148	our $MAX_RESET = 3600;	1779	our $MAX_RESET = 3600;
1149	our $DEFAULT_RESET = 3000;	1780	our $DEFAULT_RESET = 3000;
1150		1781
1151	sub generate_random_map {	1782	sub generate_random_map {
1152	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
1153		1786
1154	# mit "rum" bekleckern, nicht	1787	# mit "rum" bekleckern, nicht
1155	cf::map::_create_random_map	1788	$self->_create_random_map (
1156	$path,
1157	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1789	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1158	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1790	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1159	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1791	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1160	$rmp->{exit_on_final_map},	1792	$rmp->{exit_on_final_map},
1161	$rmp->{xsize}, $rmp->{ysize},	1793	$rmp->{xsize}, $rmp->{ysize},
1162	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1794	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1163	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1795	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1164	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1796	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1165	$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},
1166	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1798	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1167	(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"
1168	}	1928	}
1169		1929
1170	# and all this just because we cannot iterate over	1930	# and all this just because we cannot iterate over
1171	# all maps in C++...	1931	# all maps in C++...
1172	sub change_all_map_light {	1932	sub change_all_map_light {
…		…
1174		1934
1175	$_->change_map_light ($change)	1935	$_->change_map_light ($change)
1176	for grep $_->outdoor, values %cf::MAP;	1936	for grep $_->outdoor, values %cf::MAP;
1177	}	1937	}
1178		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
1179	sub try_load_header($) {	1955	sub load_header_from($) {
1180	my ($path) = @_;	1956	my ($self, $path) = @_;
1181		1957
1182	utf8::encode $path;	1958	utf8::encode $path;
1183	aio_open $path, O_RDONLY, 0	1959	my $f = new_from_file cf::object::thawer $path
1184	or return;	1960	or return;
1185		1961
1186	my $map = cf::map::new	1962	$self->_load_header ($f)
1187	or return;	1963	or return;
1188		1964
1189	$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
1190	or return;	2011	or return;
		2012	$self->prepare_orig;
		2013	}
1191		2014
1192	$map->{load_path} = $path;	2015	$self->{deny_reset} = 1
		2016	if $self->no_reset;
1193		2017
1194	$map	2018	$self->default_region (cf::region::find_by_path $self->{path})
		2019	unless $self->default_region;
		2020
		2021	1
1195	}	2022	}
1196		2023
1197	sub find;	2024	sub find;
1198	sub find {	2025	sub find {
1199	my ($path, $origin) = @_;	2026	my ($path, $origin) = @_;
1200		2027
1201	#warn "find<$path,$origin>\n";#d#
1202
1203	$path = new cf::path $path, $origin && $origin->path;	2028	$path = normalise $path, $origin && $origin->path;
1204	my $key = $path->as_string;
1205		2029
		2030	cf::lock_wait "map_data:$path";#d#remove
1206	cf::lock_wait "map_find:$key";	2031	cf::lock_wait "map_find:$path";
1207		2032
1208	$cf::MAP{$key} || do {	2033	$cf::MAP{$path} || do {
1209	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
1210		2036
1211	# do it the slow way	2037	my $map = new_from_path cf::map $path
1212	my $map = try_load_header $path->save_path;
1213
1214	if ($map) {
1215	$map->last_access ((delete $map->{last_access})
1216	|| $cf::RUNTIME); #d#
1217	# safety
1218	$map->{instantiate_time} = $cf::RUNTIME
1219	if $map->{instantiate_time} > $cf::RUNTIME;
1220	} else {
1221	if (my $rmp = $path->random_map_params) {
1222	$map = generate_random_map $key, $rmp;
1223	} else {
1224	$map = try_load_header $path->load_path;
1225	}
1226
1227	$map or return;	2038	or return;
1228		2039
1229	$map->{load_original} = 1;
1230	$map->{instantiate_time} = $cf::RUNTIME;
1231	$map->last_access ($cf::RUNTIME);
1232	$map->instantiate;
1233
1234	# per-player maps become, after loading, normal maps
1235	$map->per_player (0) if $path->{user_rel};
1236	}
1237
1238	$map->path ($key);
1239	$map->{path} = $path;
1240	$map->{last_save} = $cf::RUNTIME;	2040	$map->{last_save} = $cf::RUNTIME;
1241		2041
1242	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;
1243	$map->reset;	2050	$map->reset;
1244	undef $guard;
1245	$map = find $path	2051	return find $path;
1246	or return;
1247	}	2052	}
1248		2053
1249	$cf::MAP{$key} = $map	2054	$cf::MAP{$path} = $map
1250	}	2055	}
1251	}	2056	}
		2057
		2058	sub pre_load { }
		2059	sub post_load { }
1252		2060
1253	sub load {	2061	sub load {
1254	my ($self) = @_;	2062	my ($self) = @_;
1255		2063
		2064	local $self->{deny_reset} = 1; # loading can take a long time
		2065
1256	my $path = $self->{path};	2066	my $path = $self->{path};
		2067
		2068	{
1257	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2069	my $guard = cf::lock_acquire "map_data:$path";
1258		2070
		2071	return unless $self->valid;
1259	return if $self->in_memory != cf::MAP_SWAPPED;	2072	return unless $self->in_memory == cf::MAP_SWAPPED;
1260		2073
1261	$self->in_memory (cf::MAP_LOADING);	2074	$self->in_memory (cf::MAP_LOADING);
1262		2075
1263	$self->alloc;	2076	$self->alloc;
1264	$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)
1265	or return;	2084	or return;
1266		2085
1267	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2086	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1268	if delete $self->{load_original};	2087	if delete $self->{load_original};
1269		2088
1270	if (my $uniq = $path->uniq_path) {	2089	if (my $uniq = $self->uniq_path) {
1271	utf8::encode $uniq;	2090	utf8::encode $uniq;
1272	if (aio_open $uniq, O_RDONLY, 0) {	2091	unless (aio_stat $uniq) {
		2092	if (my $f = new_from_file cf::object::thawer $uniq) {
1273	$self->clear_unique_items;	2093	$self->clear_unique_items;
1274	$self->load_objects ($uniq, 0);	2094	$self->_load_objects ($f);
		2095	$f->resolve_delayed_derefs;
		2096	}
1275	}	2097	}
1276	}	2098	}
1277		2099
		2100	$f->resolve_delayed_derefs;
		2101
		2102	cf::cede_to_tick;
1278	# now do the right thing for maps	2103	# now do the right thing for maps
1279	$self->link_multipart_objects;	2104	$self->link_multipart_objects;
1280
1281	if ($self->{path}->is_style_map) {
1282	$self->{deny_save} = 1;
1283	$self->{deny_reset} = 1;
1284	} else {
1285	$self->fix_auto_apply;
1286	$self->decay_objects;
1287	$self->update_buttons;
1288	$self->set_darkness_map;
1289	$self->difficulty ($self->estimate_difficulty)	2105	$self->difficulty ($self->estimate_difficulty)
1290	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;
1291	$self->activate;	2116	$self->activate;
1292	}	2117	}
1293		2118
		2119	$self->{last_save} = $cf::RUNTIME;
		2120	$self->last_access ($cf::RUNTIME);
		2121
1294	$self->in_memory (cf::MAP_IN_MEMORY);	2122	$self->in_memory (cf::MAP_ACTIVE);
		2123	}
		2124
		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	}
1295	}	2164	}
1296		2165
1297	sub find_sync {	2166	sub find_sync {
1298	my ($path, $origin) = @_;	2167	my ($path, $origin) = @_;
1299		2168
1300	cf::sync_job { cf::map::find $path, $origin }	2169	cf::sync_job { find $path, $origin }
1301	}	2170	}
1302		2171
1303	sub do_load_sync {	2172	sub do_load_sync {
1304	my ($map) = @_;	2173	my ($map) = @_;
1305		2174
		2175	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2176	if $Coro::current == $Coro::main;
		2177
1306	cf::sync_job { $map->load };	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;
		2208	};
		2209	$MAP_PREFETCHER->prio (6);
		2210
		2211	()
1307	}	2212	}
1308		2213
1309	sub save {	2214	sub save {
1310	my ($self) = @_;	2215	my ($self) = @_;
1311		2216
		2217	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2218
1312	$self->{last_save} = $cf::RUNTIME;	2219	$self->{last_save} = $cf::RUNTIME;
1313		2220
1314	return unless $self->dirty;	2221	return unless $self->dirty;
1315		2222
1316	my $save = $self->{path}->save_path; utf8::encode $save;	2223	my $save = $self->save_path; utf8::encode $save;
1317	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2224	my $uniq = $self->uniq_path; utf8::encode $uniq;
1318		2225
1319	$self->{load_path} = $save;	2226	$self->{load_path} = $save;
1320		2227
1321	return if $self->{deny_save};	2228	return if $self->{deny_save};
1322		2229
1323	local $self->{last_access} = $self->last_access;#d#	2230	local $self->{last_access} = $self->last_access;#d#
1324		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
1325	if ($uniq) {	2239	if ($uniq) {
1326	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2240	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1327	$self->save_objects ($uniq, cf::IO_UNIQUES);	2241	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1328	} else {	2242	} else {
1329	$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);
1330	}	2244	}
1331	}	2245	}
1332		2246
1333	sub swap_out {	2247	sub swap_out {
1334	my ($self) = @_;	2248	my ($self) = @_;
1335		2249
1336	# save first because save cedes	2250	# save first because save cedes
1337	$self->save;	2251	$self->save;
1338		2252
		2253	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2254
1339	return if $self->players;	2255	return if $self->players;
1340	return if $self->in_memory != cf::MAP_IN_MEMORY;	2256	return if $self->in_memory != cf::MAP_ACTIVE;
1341	return if $self->{deny_save};	2257	return if $self->{deny_save};
1342		2258
		2259	$self->in_memory (cf::MAP_SWAPPED);
		2260
		2261	$self->deactivate;
		2262	$_->clear_links_to ($self) for values %cf::MAP;
1343	$self->clear;	2263	$self->clear;
1344	$self->in_memory (cf::MAP_SWAPPED);
1345	}	2264	}
1346		2265
1347	sub reset_at {	2266	sub reset_at {
1348	my ($self) = @_;	2267	my ($self) = @_;
1349		2268
1350	# TODO: safety, remove and allow resettable per-player maps	2269	# TODO: safety, remove and allow resettable per-player maps
1351	return 1e99 if $self->{path}{user_rel};
1352	return 1e99 if $self->{deny_reset};	2270	return 1e99 if $self->{deny_reset};
1353		2271
1354	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2272	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1355	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;
1356		2274
…		…
1361	my ($self) = @_;	2279	my ($self) = @_;
1362		2280
1363	$self->reset_at <= $cf::RUNTIME	2281	$self->reset_at <= $cf::RUNTIME
1364	}	2282	}
1365		2283
1366	sub unlink_save {
1367	my ($self) = @_;
1368
1369	utf8::encode (my $save = $self->{path}->save_path);
1370	aioreq_pri 3; IO::AIO::aio_unlink $save;
1371	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1372	}
1373
1374	sub rename {
1375	my ($self, $new_path) = @_;
1376
1377	$self->unlink_save;
1378
1379	delete $cf::MAP{$self->path};
1380	$self->{path} = new cf::path $new_path;
1381	$self->path ($self->{path}->as_string);
1382	$cf::MAP{$self->path} = $self;
1383
1384	$self->save;
1385	}
1386
1387	sub reset {	2284	sub reset {
1388	my ($self) = @_;	2285	my ($self) = @_;
1389		2286
		2287	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2288
1390	return if $self->players;	2289	return if $self->players;
1391	return if $self->{path}{user_rel};#d#
1392		2290
1393	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	}
1394		2302
1395	delete $cf::MAP{$self->path};	2303	delete $cf::MAP{$self->path};
1396		2304
		2305	$self->deactivate;
1397	$_->clear_links_to ($self) for values %cf::MAP;	2306	$_->clear_links_to ($self) for values %cf::MAP;
		2307	$self->clear;
1398		2308
1399	$self->unlink_save;	2309	$self->unlink_save;
1400	$self->destroy;	2310	$self->destroy;
1401	}	2311	}
1402		2312
1403	my $nuke_counter = "aaaa";	2313	my $nuke_counter = "aaaa";
1404		2314
1405	sub nuke {	2315	sub nuke {
1406	my ($self) = @_;	2316	my ($self) = @_;
1407		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};
1408	$self->{deny_save} = 1;	2327	$self->{deny_save} = 1;
1409	$self->reset_timeout (1);	2328	$self->reset_timeout (1);
1410	$self->rename ("{nuke}/" . ($nuke_counter++));	2329	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2330
		2331	$cf::MAP{$self->path} = $self;
		2332	}
		2333
1411	$self->reset; # polite request, might not happen	2334	$self->reset; # polite request, might not happen
1412	}	2335	}
1413		2336
1414	sub customise_for {	2337	=item $maps = cf::map::tmp_maps
1415	my ($map, $ob) = @_;
1416		2338
1417	if ($map->per_player) {	2339	Returns an arrayref with all map paths of currently instantiated and saved
1418	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2340	maps. May block.
		2341
		2342	=cut
		2343
		2344	sub tmp_maps() {
1419	}	2345	[
1420		2346	map {
1421	$map	2347	utf8::decode $_;
		2348	/\.map$/
		2349	? normalise $_
		2350	: ()
		2351	} @{ aio_readdir $TMPDIR or [] }
		2352	]
1422	}	2353	}
1423		2354
1424	sub emergency_save {	2355	=item $maps = cf::map::random_maps
1425	my $freeze_guard = cf::freeze_mainloop;
1426		2356
1427	warn "enter emergency map save\n";	2357	Returns an arrayref with all map paths of currently instantiated and saved
		2358	random maps. May block.
1428		2359
1429	cf::sync_job {	2360	=cut
1430	warn "begin emergency map save\n";	2361
1431	$_->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
1432	};	2443	}
1433
1434	warn "end emergency map save\n";
1435	}	2444	}
1436		2445
1437	package cf;	2446	package cf;
1438		2447
1439	=back	2448	=back
1440
1441		2449
1442	=head3 cf::object::player	2450	=head3 cf::object::player
1443		2451
1444	=over 4	2452	=over 4
1445		2453
…		…
1459		2467
1460	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1461		2469
1462	if ($self->{record_replies}) {	2470	if ($self->{record_replies}) {
1463	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2471	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2472
1464	} 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 {
1465	$msg = $npc->name . " says: $msg" if $npc;	2481	$msg = $npc->name . " says: $msg" if $npc;
1466	$self->message ($msg, $flags);	2482	$self->message ($msg, $flags);
		2483	}
1467	}	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 (@_);
1468	}	2495	}
1469		2496
1470	=item $player_object->may ("access")	2497	=item $player_object->may ("access")
1471		2498
1472	Returns wether the given player is authorized to access resource "access"	2499	Returns wether the given player is authorized to access resource "access"
…		…
1485		2512
1486	=item $player_object->enter_link	2513	=item $player_object->enter_link
1487		2514
1488	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}>).
1489		2516
1490	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
1491	I<MUST> call C<leave_link> as soon as possible, though.	2518	I<MUST> call C<leave_link> as soon as possible, though.
1492		2519
		2520	Will never block.
		2521
1493	=item $player_object->leave_link ($map, $x, $y)	2522	=item $player_object->leave_link ($map, $x, $y)
1494		2523
1495	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
1496	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
1497	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
1498	to the emergency map position.	2527	fails, to the emergency map position.
1499		2528
1500	Might block.	2529	Might block.
1501		2530
1502	=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	}
1503		2542
1504	sub cf::object::player::enter_link {	2543	sub cf::object::player::enter_link {
1505	my ($self) = @_;	2544	my ($self) = @_;
1506		2545
1507	$self->deactivate_recursive;	2546	$self->deactivate_recursive;
1508		2547
1509	return if $self->map == $LINK_MAP;	2548	return if UNIVERSAL::isa $self->map, "ext::map_link";
1510		2549
1511	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2550	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1512	if $self->map;	2551	if $self->map && $self->map->{path} ne "{link}";
1513		2552
1514	$self->enter_map ($LINK_MAP, 20, 20);	2553	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1515	}	2554	}
1516		2555
1517	sub cf::object::player::leave_link {	2556	sub cf::object::player::leave_link {
1518	my ($self, $map, $x, $y) = @_;	2557	my ($self, $map, $x, $y) = @_;
		2558
		2559	return unless $self->contr->active;
1519		2560
1520	my $link_pos = delete $self->{_link_pos};	2561	my $link_pos = delete $self->{_link_pos};
1521		2562
1522	unless ($map) {	2563	unless ($map) {
1523	# restore original map position	2564	# restore original map position
…		…
1537	# use -1 or undef as default coordinates, not 0, 0	2578	# use -1 or undef as default coordinates, not 0, 0
1538	($x, $y) = ($map->enter_x, $map->enter_y)	2579	($x, $y) = ($map->enter_x, $map->enter_y)
1539	if $x <=0 && $y <= 0;	2580	if $x <=0 && $y <= 0;
1540		2581
1541	$map->load;	2582	$map->load;
		2583	$map->load_neighbours;
1542		2584
		2585	return unless $self->contr->active;
1543	$self->activate_recursive;	2586	$self->activate_recursive;
		2587
		2588	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1544	$self->enter_map ($map, $x, $y);	2589	$self->enter_map ($map, $x, $y);
1545	}	2590	}
1546		2591
1547	cf::player->attach (	2592	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1548	on_logout => sub {
1549	my ($pl) = @_;
1550		2593
1551	# abort map switching before logout	2594	Moves the player to the given map-path and coordinates by first freezing
1552	if ($pl->ob->{_link_pos}) {	2595	her, loading and preparing them map, calling the provided $check callback
1553	cf::sync_job {	2596	that has to return the map if sucecssful, and then unfreezes the player on
1554	$pl->ob->leave_link	2597	the new (success) or old (failed) map position. In either case, $done will
1555	};	2598	be called at the end of this process.
1556	}
1557	},
1558	on_login => sub {
1559	my ($pl) = @_;
1560		2599
1561	# try to abort aborted map switching on player login :)
1562	# should happen only on crashes
1563	if ($pl->ob->{_link_pos}) {
1564	$pl->ob->enter_link;
1565	cf::async {
1566	# we need this sleep as the login has a concurrent enter_exit running
1567	# and this sleep increases chances of the player not ending up in scorn
1568	Coro::Timer::sleep 1;
1569	$pl->ob->leave_link;
1570	};
1571	}
1572	},
1573	);
1574
1575	=item $player_object->goto_map ($path, $x, $y)
1576
1577	=cut	2600	=cut
1578		2601
		2602	our $GOTOGEN;
		2603
1579	sub cf::object::player::goto_map {	2604	sub cf::object::player::goto {
1580	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;
1581		2609
1582	$self->enter_link;	2610	$self->enter_link;
1583		2611
1584	(cf::async {	2612	(async {
1585	$path = new cf::path $path;	2613	$Coro::current->{desc} = "player::goto $path $x $y";
1586		2614
1587	my $map = cf::map::find $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) {
1588	$map = $map->customise_for ($self) if $map;	2638	$map = $map->customise_for ($self);
1589		2639	$map = $check->($map) if $check && $map;
1590	# warn "entering ", $map->path, " at ($x, $y)\n"	2640	} else {
1591	# if $map;
1592
1593	$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	}
1594		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};
1595	$self->leave_link ($map, $x, $y);	2654	$self->leave_link ($map, $x, $y);
		2655	}
		2656
		2657	$done->() if $done;
1596	})->prio (1);	2658	})->prio (1);
1597	}	2659	}
1598		2660
1599	=item $player_object->enter_exit ($exit_object)	2661	=item $player_object->enter_exit ($exit_object)
1600		2662
…		…
1602		2664
1603	sub parse_random_map_params {	2665	sub parse_random_map_params {
1604	my ($spec) = @_;	2666	my ($spec) = @_;
1605		2667
1606	my $rmp = { # defaults	2668	my $rmp = { # defaults
1607	xsize => 10,	2669	xsize => (cf::rndm 15, 40),
1608	ysize => 10,	2670	ysize => (cf::rndm 15, 40),
		2671	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2672	#layout => string,
1609	};	2673	};
1610		2674
1611	for (split /\n/, $spec) {	2675	for (split /\n/, $spec) {
1612	my ($k, $v) = split /\s+/, $_, 2;	2676	my ($k, $v) = split /\s+/, $_, 2;
1613		2677
…		…
1617	$rmp	2681	$rmp
1618	}	2682	}
1619		2683
1620	sub prepare_random_map {	2684	sub prepare_random_map {
1621	my ($exit) = @_;	2685	my ($exit) = @_;
		2686
		2687	my $guard = cf::lock_acquire "exit_prepare:$exit";
1622		2688
1623	# all this does is basically replace the /! path by	2689	# all this does is basically replace the /! path by
1624	# a new random map path (?random/...) with a seed	2690	# a new random map path (?random/...) with a seed
1625	# that depends on the exit object	2691	# that depends on the exit object
1626		2692
1627	my $rmp = parse_random_map_params $exit->msg;	2693	my $rmp = parse_random_map_params $exit->msg;
1628		2694
1629	if ($exit->map) {	2695	if ($exit->map) {
1630	$rmp->{region} = $exit->map->region_name;	2696	$rmp->{region} = $exit->region->name;
1631	$rmp->{origin_map} = $exit->map->path;	2697	$rmp->{origin_map} = $exit->map->path;
1632	$rmp->{origin_x} = $exit->x;	2698	$rmp->{origin_x} = $exit->x;
1633	$rmp->{origin_y} = $exit->y;	2699	$rmp->{origin_y} = $exit->y;
1634	}	2700	}
1635		2701
1636	$rmp->{random_seed} ||= $exit->random_seed;	2702	$rmp->{random_seed} ||= $exit->random_seed;
1637		2703
1638	my $data = cf::to_json $rmp;	2704	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1639	my $md5 = Digest::MD5::md5_hex $data;	2705	my $md5 = Digest::MD5::md5_hex $data;
		2706	my $meta = "$RANDOMDIR/$md5.meta";
1640		2707
1641	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) {
1642	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;
1643		2712
1644	$exit->slaying ("?random/$md5");	2713	$exit->slaying ("?random/$md5");
1645	$exit->msg (undef);	2714	$exit->msg (undef);
1646	}	2715	}
1647	}	2716	}
…		…
1649	sub cf::object::player::enter_exit {	2718	sub cf::object::player::enter_exit {
1650	my ($self, $exit) = @_;	2719	my ($self, $exit) = @_;
1651		2720
1652	return unless $self->type == cf::PLAYER;	2721	return unless $self->type == cf::PLAYER;
1653		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
1654	$self->enter_link;	2734	$self->enter_link;
1655		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
1656	(cf::async {	2740	(async {
		2741	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2742
1657	$self->deactivate_recursive; # just to be sure	2743	$self->deactivate_recursive; # just to be sure
1658	unless (eval {	2744	unless (eval {
1659	prepare_random_map $exit	2745	$self->goto ($slaying, $hp, $sp);
1660	if $exit->slaying eq "/!";
1661
1662	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1663	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1664		2746
1665	1;	2747	1;
1666	}) {	2748	}) {
1667	$self->message ("Something went wrong deep within the crossfire server. "	2749	$self->message ("Something went wrong deep within the crossfire server. "
1668	. "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. "
1669	. "Please report this to the dungeon master",	2751	. "Please report this to the dungeon master!",
1670	cf::NDI_UNIQUE | cf::NDI_RED);	2752	cf::NDI_UNIQUE | cf::NDI_RED);
1671		2753
1672	warn "ERROR in enter_exit: $@";	2754	warn "ERROR in enter_exit: $@";
1673	$self->leave_link;	2755	$self->leave_link;
1674	}	2756	}
1675	})->prio (1);	2757	})->prio (1);
…		…
1688		2770
1689	sub cf::client::send_drawinfo {	2771	sub cf::client::send_drawinfo {
1690	my ($self, $text, $flags) = @_;	2772	my ($self, $text, $flags) = @_;
1691		2773
1692	utf8::encode $text;	2774	utf8::encode $text;
1693	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2775	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1694	}	2776	}
1695		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	);
		2838
		2839	sub cf::client::send_msg {
		2840	my ($self, $channel, $msg, $color, @extra) = @_;
		2841
		2842	$msg = $self->pl->expand_cfpod ($msg);
		2843
		2844	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2845
		2846	# check predefined channels, for the benefit of C
		2847	if ($CHANNEL{$channel}) {
		2848	$channel = $CHANNEL{$channel};
		2849
		2850	$self->ext_msg (channel_info => $channel)
		2851	if $self->can_msg;
		2852
		2853	$channel = $channel->{id};
		2854
		2855	} elsif (ref $channel) {
		2856	# send meta info to client, if not yet sent
		2857	unless (exists $self->{channel}{$channel->{id}}) {
		2858	$self->{channel}{$channel->{id}} = $channel;
		2859	$self->ext_msg (channel_info => $channel)
		2860	if $self->can_msg;
		2861	}
		2862
		2863	$channel = $channel->{id};
		2864	}
		2865
		2866	return unless @extra || length $msg;
		2867
		2868	if ($self->can_msg) {
		2869	# default colour, mask it out
		2870	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2871	if $color & cf::NDI_DEF;
		2872
		2873	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2874	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2875	} else {
		2876	if ($color >= 0) {
		2877	# replace some tags by gcfclient-compatible ones
		2878	for ($msg) {
		2879	1 while
		2880	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2881	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2882	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2883	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2884	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2885	}
		2886
		2887	$color &= cf::NDI_COLOR_MASK;
		2888
		2889	utf8::encode $msg;
		2890
		2891	if (0 && $msg =~ /\[/) {
		2892	# COMMAND/INFO
		2893	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2894	} else {
		2895	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2896	$self->send_packet ("drawinfo $color $msg")
		2897	}
		2898	}
		2899	}
		2900	}
		2901
		2902	=item $client->ext_msg ($type, @msg)
		2903
		2904	Sends an ext event to the client.
		2905
		2906	=cut
		2907
		2908	sub cf::client::ext_msg($$@) {
		2909	my ($self, $type, @msg) = @_;
		2910
		2911	if ($self->extcmd == 2) {
		2912	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2913	} elsif ($self->extcmd == 1) { # TODO: remove
		2914	push @msg, msgtype => "event_$type";
		2915	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2916	}
		2917	}
		2918
		2919	=item $client->ext_reply ($msgid, @msg)
		2920
		2921	Sends an ext reply to the client.
		2922
		2923	=cut
		2924
		2925	sub cf::client::ext_reply($$@) {
		2926	my ($self, $id, @msg) = @_;
		2927
		2928	if ($self->extcmd == 2) {
		2929	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2930	} elsif ($self->extcmd == 1) {
		2931	#TODO: version 1, remove
		2932	unshift @msg, msgtype => "reply", msgid => $id;
		2933	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2934	}
		2935	}
1696		2936
1697	=item $success = $client->query ($flags, "text", \&cb)	2937	=item $success = $client->query ($flags, "text", \&cb)
1698		2938
1699	Queues a query to the client, calling the given callback with	2939	Queues a query to the client, calling the given callback with
1700	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2940	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1701	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2941	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1702		2942
1703	Queries can fail, so check the return code. Or don't, as queries will become	2943	Queries can fail, so check the return code. Or don't, as queries will
1704	reliable at some point in the future.	2944	become reliable at some point in the future.
1705		2945
1706	=cut	2946	=cut
1707		2947
1708	sub cf::client::query {	2948	sub cf::client::query {
1709	my ($self, $flags, $text, $cb) = @_;	2949	my ($self, $flags, $text, $cb) = @_;
…		…
1717	utf8::encode $text;	2957	utf8::encode $text;
1718	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2958	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1719		2959
1720	$self->send_packet ($self->{query_queue}[0][0])	2960	$self->send_packet ($self->{query_queue}[0][0])
1721	if @{ $self->{query_queue} } == 1;	2961	if @{ $self->{query_queue} } == 1;
		2962
		2963	1
1722	}	2964	}
1723		2965
1724	cf::client->attach (	2966	cf::client->attach (
		2967	on_connect => sub {
		2968	my ($ns) = @_;
		2969
		2970	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2971	},
1725	on_reply => sub {	2972	on_reply => sub {
1726	my ($ns, $msg) = @_;	2973	my ($ns, $msg) = @_;
1727		2974
1728	# this weird shuffling is so that direct followup queries	2975	# this weird shuffling is so that direct followup queries
1729	# get handled first	2976	# get handled first
1730	my $queue = delete $ns->{query_queue}	2977	my $queue = delete $ns->{query_queue}
1731	or return; # be conservative, not sure how that can happen, but we saw a crash here	2978	or return; # be conservative, not sure how that can happen, but we saw a crash here
1732		2979
1733	(shift @$queue)->[1]->($msg);	2980	(shift @$queue)->[1]->($msg);
		2981	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1734		2982
1735	push @{ $ns->{query_queue} }, @$queue;	2983	push @{ $ns->{query_queue} }, @$queue;
1736		2984
1737	if (@{ $ns->{query_queue} } == @$queue) {	2985	if (@{ $ns->{query_queue} } == @$queue) {
1738	if (@$queue) {	2986	if (@$queue) {
…		…
1740	} else {	2988	} else {
1741	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2989	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1742	}	2990	}
1743	}	2991	}
1744	},	2992	},
		2993	on_exticmd => sub {
		2994	my ($ns, $buf) = @_;
		2995
		2996	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2997
		2998	if (ref $msg) {
		2999	my ($type, $reply, @payload) =
		3000	"ARRAY" eq ref $msg
		3001	? @$msg
		3002	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3003
		3004	my @reply;
		3005
		3006	if (my $cb = $EXTICMD{$type}) {
		3007	@reply = $cb->($ns, @payload);
		3008	}
		3009
		3010	$ns->ext_reply ($reply, @reply)
		3011	if $reply;
		3012
		3013	} else {
		3014	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3015	}
		3016
		3017	cf::override;
		3018	},
1745	);	3019	);
1746		3020
1747	=item $client->coro (\&cb)	3021	=item $client->async (\&cb)
1748		3022
1749	Create a new coroutine, running the specified callback. The coroutine will	3023	Create a new coroutine, running the specified callback. The coroutine will
1750	be automatically cancelled when the client gets destroyed (e.g. on logout,	3024	be automatically cancelled when the client gets destroyed (e.g. on logout,
1751	or loss of connection).	3025	or loss of connection).
1752		3026
1753	=cut	3027	=cut
1754		3028
1755	sub cf::client::coro {	3029	sub cf::client::async {
1756	my ($self, $cb) = @_;	3030	my ($self, $cb) = @_;
1757		3031
1758	my $coro = &cf::async ($cb);	3032	my $coro = &Coro::async ($cb);
1759		3033
1760	$coro->on_destroy (sub {	3034	$coro->on_destroy (sub {
1761	delete $self->{_coro}{$coro+0};	3035	delete $self->{_coro}{$coro+0};
1762	});	3036	});
1763		3037
…		…
1790	our $safe = new Safe "safe";	3064	our $safe = new Safe "safe";
1791	our $safe_hole = new Safe::Hole;	3065	our $safe_hole = new Safe::Hole;
1792		3066
1793	$SIG{FPE} = 'IGNORE';	3067	$SIG{FPE} = 'IGNORE';
1794		3068
1795	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3069	$safe->permit_only (Opcode::opset qw(
		3070	:base_core :base_mem :base_orig :base_math
		3071	grepstart grepwhile mapstart mapwhile
		3072	sort time
		3073	));
1796		3074
1797	# here we export the classes and methods available to script code	3075	# here we export the classes and methods available to script code
1798		3076
1799	=pod	3077	=pod
1800		3078
1801	The following fucntions and emthods are available within a safe environment:	3079	The following functions and methods are available within a safe environment:
1802		3080
1803	cf::object contr pay_amount pay_player map	3081	cf::object
		3082	contr pay_amount pay_player map x y force_find force_add destroy
		3083	insert remove name archname title slaying race decrease split
		3084
1804	cf::object::player player	3085	cf::object::player
1805	cf::player peaceful	3086	player
1806	cf::map trigger	3087
		3088	cf::player
		3089	peaceful
		3090
		3091	cf::map
		3092	trigger
1807		3093
1808	=cut	3094	=cut
1809		3095
1810	for (	3096	for (
1811	["cf::object" => qw(contr pay_amount pay_player map)],	3097	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3098	insert remove inv name archname title slaying race
		3099	decrease split destroy)],
1812	["cf::object::player" => qw(player)],	3100	["cf::object::player" => qw(player)],
1813	["cf::player" => qw(peaceful)],	3101	["cf::player" => qw(peaceful)],
1814	["cf::map" => qw(trigger)],	3102	["cf::map" => qw(trigger)],
1815	) {	3103	) {
1816	no strict 'refs';	3104	no strict 'refs';
…		…
1887	=back	3175	=back
1888		3176
1889	=cut	3177	=cut
1890		3178
1891	#############################################################################	3179	#############################################################################
		3180	# the server's init and main functions
1892		3181
1893	=head2 EXTENSION DATABASE SUPPORT	3182	sub load_facedata($) {
		3183	my ($path) = @_;
1894		3184
1895	Crossfire maintains a very simple database for extension use. It can	3185	# HACK to clear player env face cache, we need some signal framework
1896	currently store anything that can be serialised using Storable, which	3186	# for this (global event?)
1897	excludes objects.	3187	%ext::player_env::MUSIC_FACE_CACHE = ();
1898		3188
1899	The parameter C<$family> should best start with the name of the extension	3189	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1900	using it, it should be unique.
1901		3190
1902	=over 4	3191	warn "loading facedata from $path\n";
1903		3192
1904	=item $hashref = cf::db_get $family	3193	my $facedata;
		3194	0 < aio_load $path, $facedata
		3195	or die "$path: $!";
1905		3196
1906	Return a hashref for use by the extension C<$family>, which can be	3197	$facedata = Coro::Storable::thaw $facedata;
1907	modified. After modifications, you have to call C<cf::db_dirty> or
1908	C<cf::db_sync>.
1909		3198
1910	=item $value = cf::db_get $family => $key	3199	$facedata->{version} == 2
		3200	or cf::cleanup "$path: version mismatch, cannot proceed.";
1911		3201
1912	Returns a single value from the database	3202	# patch in the exptable
1913		3203	$facedata->{resource}{"res/exp_table"} = {
1914	=item cf::db_put $family => $hashref	3204	type => FT_RSRC,
1915		3205	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1916	Stores the given family hashref into the database. Updates are delayed, if
1917	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919	=item cf::db_put $family => $key => $value
1920
1921	Stores the given C<$value> in the family hash. Updates are delayed, if you
1922	want the data to be synced to disk immediately, use C<cf::db_sync>.
1923
1924	=item cf::db_dirty
1925
1926	Marks the database as dirty, to be updated at a later time.
1927
1928	=item cf::db_sync
1929
1930	Immediately write the database to disk I<if it is dirty>.
1931
1932	=cut
1933
1934	our $DB;
1935
1936	{
1937	my $path = cf::localdir . "/database.pst";
1938
1939	sub db_load() {
1940	$DB = stat $path ? Storable::retrieve $path : { };
1941	}
1942
1943	my $pid;
1944
1945	sub db_save() {
1946	waitpid $pid, 0 if $pid;
1947	if (0 == ($pid = fork)) {
1948	$DB->{_meta}{version} = 1;
1949	Storable::nstore $DB, "$path~";
1950	rename "$path~", $path;
1951	cf::_exit 0 if defined $pid;
1952	}
1953	}
1954
1955	my $dirty;
1956
1957	sub db_sync() {
1958	db_save if $dirty;
1959	undef $dirty;
1960	}
1961
1962	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1963	db_sync;
1964	});	3206	};
		3207	cf::cede_to_tick;
1965		3208
1966	sub db_dirty() {
1967	$dirty = 1;
1968	$idle->start;
1969	}	3209	{
		3210	my $faces = $facedata->{faceinfo};
1970		3211
1971	sub db_get($;$) {	3212	while (my ($face, $info) = each %$faces) {
1972	@_ >= 2	3213	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1973	? $DB->{$_[0]}{$_[1]}
1974	: ($DB->{$_[0]} ||= { })
1975	}
1976		3214
1977	sub db_put($$;$) {	3215	cf::face::set_visibility $idx, $info->{visibility};
1978	if (@_ >= 3) {	3216	cf::face::set_magicmap $idx, $info->{magicmap};
1979	$DB->{$_[0]}{$_[1]} = $_[2];	3217	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1980	} else {	3218	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1981	$DB->{$_[0]} = $_[1];
1982	}
1983	db_dirty;
1984	}
1985		3219
1986	cf::global->attach (	3220	cf::cede_to_tick;
1987	prio => 10000,
1988	on_cleanup => sub {
1989	db_sync;
1990	},	3221	}
1991	);
1992	}
1993		3222
1994	#############################################################################	3223	while (my ($face, $info) = each %$faces) {
1995	# the server's main()	3224	next unless $info->{smooth};
1996		3225
1997	sub cfg_load {	3226	my $idx = cf::face::find $face
		3227	or next;
		3228
		3229	if (my $smooth = cf::face::find $info->{smooth}) {
		3230	cf::face::set_smooth $idx, $smooth;
		3231	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3232	} else {
		3233	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3234	}
		3235
		3236	cf::cede_to_tick;
		3237	}
		3238	}
		3239
		3240	{
		3241	my $anims = $facedata->{animinfo};
		3242
		3243	while (my ($anim, $info) = each %$anims) {
		3244	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3245	cf::cede_to_tick;
		3246	}
		3247
		3248	cf::anim::invalidate_all; # d'oh
		3249	}
		3250
		3251	{
		3252	# TODO: for gcfclient pleasure, we should give resources
		3253	# that gcfclient doesn't grok a >10000 face index.
		3254	my $res = $facedata->{resource};
		3255
		3256	while (my ($name, $info) = each %$res) {
		3257	if (defined $info->{type}) {
		3258	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3259	my $data;
		3260
		3261	if ($info->{type} & 1) {
		3262	# prepend meta info
		3263
		3264	my $meta = $enc->encode ({
		3265	name => $name,
		3266	%{ $info->{meta} || {} },
		3267	});
		3268
		3269	$data = pack "(w/a*)*", $meta, $info->{data};
		3270	} else {
		3271	$data = $info->{data};
		3272	}
		3273
		3274	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3275	cf::face::set_type $idx, $info->{type};
		3276	} else {
		3277	$RESOURCE{$name} = $info;
		3278	}
		3279
		3280	cf::cede_to_tick;
		3281	}
		3282	}
		3283
		3284	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3285
		3286	1
		3287	}
		3288
		3289	cf::global->attach (on_resource_update => sub {
		3290	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3291	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3292
		3293	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3294	my $sound = $soundconf->{compat}[$_]
		3295	or next;
		3296
		3297	my $face = cf::face::find "sound/$sound->[1]";
		3298	cf::sound::set $sound->[0] => $face;
		3299	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3300	}
		3301
		3302	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3303	my $face = cf::face::find "sound/$v";
		3304	cf::sound::set $k => $face;
		3305	}
		3306	}
		3307	});
		3308
		3309	register_exticmd fx_want => sub {
		3310	my ($ns, $want) = @_;
		3311
		3312	while (my ($k, $v) = each %$want) {
		3313	$ns->fx_want ($k, $v);
		3314	}
		3315	};
		3316
		3317	sub load_resource_file($) {
		3318	my $guard = lock_acquire "load_resource_file";
		3319
		3320	my $status = load_resource_file_ $_[0];
		3321	get_slot 0.1, 100;
		3322	cf::arch::commit_load;
		3323
		3324	$status
		3325	}
		3326
		3327	sub reload_regions {
		3328	# HACK to clear player env face cache, we need some signal framework
		3329	# for this (global event?)
		3330	%ext::player_env::MUSIC_FACE_CACHE = ();
		3331
		3332	load_resource_file "$MAPDIR/regions"
		3333	or die "unable to load regions file\n";
		3334
		3335	for (cf::region::list) {
		3336	$_->{match} = qr/$_->{match}/
		3337	if exists $_->{match};
		3338	}
		3339	}
		3340
		3341	sub reload_facedata {
		3342	load_facedata "$DATADIR/facedata"
		3343	or die "unable to load facedata\n";
		3344	}
		3345
		3346	sub reload_archetypes {
		3347	load_resource_file "$DATADIR/archetypes"
		3348	or die "unable to load archetypes\n";
		3349	}
		3350
		3351	sub reload_treasures {
		3352	load_resource_file "$DATADIR/treasures"
		3353	or die "unable to load treasurelists\n";
		3354	}
		3355
		3356	sub reload_resources {
		3357	warn "reloading resource files...\n";
		3358
		3359	reload_facedata;
		3360	reload_archetypes;
		3361	reload_regions;
		3362	reload_treasures;
		3363
		3364	warn "finished reloading resource files\n";
		3365	}
		3366
		3367	sub init {
		3368	my $guard = freeze_mainloop;
		3369
		3370	reload_resources;
		3371	}
		3372
		3373	sub reload_config {
1998	open my $fh, "<:utf8", cf::confdir . "/config"	3374	open my $fh, "<:utf8", "$CONFDIR/config"
1999	or return;	3375	or return;
2000		3376
2001	local $/;	3377	local $/;
2002	*CFG = YAML::Syck::Load <$fh>;	3378	*CFG = YAML::Load <$fh>;
2003		3379
2004	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3380	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3381
		3382	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3383	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2005		3384
2006	if (exists $CFG{mlockall}) {	3385	if (exists $CFG{mlockall}) {
2007	eval {	3386	eval {
2008	$CFG{mlockall} ? &mlockall : &munlockall	3387	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2009	and die "WARNING: m(un)lockall failed: $!\n";	3388	and die "WARNING: m(un)lockall failed: $!\n";
2010	};	3389	};
2011	warn $@ if $@;	3390	warn $@ if $@;
2012	}	3391	}
2013	}	3392	}
2014		3393
2015	sub main {	3394	sub main {
2016	# we must not ever block the main coroutine	3395	# we must not ever block the main coroutine
2017	local $Coro::idle = sub {	3396	local $Coro::idle = sub {
2018	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3397	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2019	(Coro::unblock_sub {	3398	(async {
2020	Event::one_event;	3399	$Coro::current->{desc} = "IDLE BUG HANDLER";
2021	})->();	3400	EV::loop EV::LOOP_ONESHOT;
		3401	})->prio (Coro::PRIO_MAX);
2022	};	3402	};
2023		3403
2024	cfg_load;	3404	{
2025	db_load;	3405	my $guard = freeze_mainloop;
		3406	reload_config;
		3407	db_init;
2026	load_extensions;	3408	load_extensions;
		3409
		3410	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3411	evthread_start IO::AIO::poll_fileno;
		3412	}
		3413
2027	Event::loop;	3414	EV::loop;
2028	}	3415	}
2029		3416
2030	#############################################################################	3417	#############################################################################
2031	# initialisation	3418	# initialisation and cleanup
2032		3419
		3420	# install some emergency cleanup handlers
		3421	BEGIN {
		3422	our %SIGWATCHER = ();
		3423	for my $signal (qw(INT HUP TERM)) {
		3424	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3425	cf::cleanup "SIG$signal";
		3426	};
		3427	}
		3428	}
		3429
		3430	sub write_runtime_sync {
		3431	my $runtime = "$LOCALDIR/runtime";
		3432
		3433	# first touch the runtime file to show we are still running:
		3434	# the fsync below can take a very very long time.
		3435
		3436	IO::AIO::aio_utime $runtime, undef, undef;
		3437
		3438	my $guard = cf::lock_acquire "write_runtime";
		3439
		3440	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3441	or return;
		3442
		3443	my $value = $cf::RUNTIME + 90 + 10;
		3444	# 10 is the runtime save interval, for a monotonic clock
		3445	# 60 allows for the watchdog to kill the server.
		3446
		3447	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3448	and return;
		3449
		3450	# always fsync - this file is important
		3451	aio_fsync $fh
		3452	and return;
		3453
		3454	# touch it again to show we are up-to-date
		3455	aio_utime $fh, undef, undef;
		3456
		3457	close $fh
		3458	or return;
		3459
		3460	aio_rename "$runtime~", $runtime
		3461	and return;
		3462
		3463	warn "runtime file written.\n";
		3464
		3465	1
		3466	}
		3467
		3468	our $uuid_lock;
		3469	our $uuid_skip;
		3470
		3471	sub write_uuid_sync($) {
		3472	$uuid_skip ||= $_[0];
		3473
		3474	return if $uuid_lock;
		3475	local $uuid_lock = 1;
		3476
		3477	my $uuid = "$LOCALDIR/uuid";
		3478
		3479	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3480	or return;
		3481
		3482	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3483	$uuid_skip = 0;
		3484
		3485	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3486	and return;
		3487
		3488	# always fsync - this file is important
		3489	aio_fsync $fh
		3490	and return;
		3491
		3492	close $fh
		3493	or return;
		3494
		3495	aio_rename "$uuid~", $uuid
		3496	and return;
		3497
		3498	warn "uuid file written ($value).\n";
		3499
		3500	1
		3501
		3502	}
		3503
		3504	sub write_uuid($$) {
		3505	my ($skip, $sync) = @_;
		3506
		3507	$sync ? write_uuid_sync $skip
		3508	: async { write_uuid_sync $skip };
		3509	}
		3510
		3511	sub emergency_save() {
		3512	my $freeze_guard = cf::freeze_mainloop;
		3513
		3514	warn "enter emergency perl save\n";
		3515
		3516	cf::sync_job {
		3517	# use a peculiar iteration method to avoid tripping on perl
		3518	# refcount bugs in for. also avoids problems with players
		3519	# and maps saved/destroyed asynchronously.
		3520	warn "begin emergency player save\n";
		3521	for my $login (keys %cf::PLAYER) {
		3522	my $pl = $cf::PLAYER{$login} or next;
		3523	$pl->valid or next;
		3524	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3525	$pl->save;
		3526	}
		3527	warn "end emergency player save\n";
		3528
		3529	warn "begin emergency map save\n";
		3530	for my $path (keys %cf::MAP) {
		3531	my $map = $cf::MAP{$path} or next;
		3532	$map->valid or next;
		3533	$map->save;
		3534	}
		3535	warn "end emergency map save\n";
		3536
		3537	warn "begin emergency database checkpoint\n";
		3538	BDB::db_env_txn_checkpoint $DB_ENV;
		3539	warn "end emergency database checkpoint\n";
		3540
		3541	warn "begin write uuid\n";
		3542	write_uuid_sync 1;
		3543	warn "end write uuid\n";
		3544	};
		3545
		3546	warn "leave emergency perl save\n";
		3547	}
		3548
		3549	sub post_cleanup {
		3550	my ($make_core) = @_;
		3551
		3552	warn Carp::longmess "post_cleanup backtrace"
		3553	if $make_core;
		3554	}
		3555
2033	sub reload() {	3556	sub do_reload_perl() {
2034	# can/must only be called in main	3557	# can/must only be called in main
2035	if ($Coro::current != $Coro::main) {	3558	if ($Coro::current != $Coro::main) {
2036	warn "can only reload from main coroutine\n";	3559	warn "can only reload from main coroutine";
2037	return;	3560	return;
2038	}	3561	}
2039		3562
2040	warn "reloading...";	3563	warn "reloading...";
2041		3564
2042	my $guard = freeze_mainloop;	3565	warn "entering sync_job";
		3566
		3567	cf::sync_job {
		3568	cf::write_runtime_sync; # external watchdog should not bark
2043	cf::emergency_save;	3569	cf::emergency_save;
		3570	cf::write_runtime_sync; # external watchdog should not bark
2044		3571
2045	eval {	3572	warn "syncing database to disk";
		3573	BDB::db_env_txn_checkpoint $DB_ENV;
		3574
2046	# if anything goes wrong in here, we should simply crash as we already saved	3575	# if anything goes wrong in here, we should simply crash as we already saved
2047		3576
2048	# cancel all watchers	3577	warn "flushing outstanding aio requests";
2049	for (Event::all_watchers) {	3578	for (;;) {
2050	$_->cancel if $_->data & WF_AUTOCANCEL;	3579	BDB::flush;
		3580	IO::AIO::flush;
		3581	Coro::cede_notself;
		3582	last unless IO::AIO::nreqs || BDB::nreqs;
		3583	warn "iterate...";
2051	}	3584	}
2052		3585
		3586	++$RELOAD;
		3587
2053	# cancel all extension coros	3588	warn "cancelling all extension coros";
2054	$_->cancel for values %EXT_CORO;	3589	$_->cancel for values %EXT_CORO;
2055	%EXT_CORO = ();	3590	%EXT_CORO = ();
2056		3591
2057	# unload all extensions	3592	warn "removing commands";
2058	for (@exts) {	3593	%COMMAND = ();
		3594
		3595	warn "removing ext/exti commands";
		3596	%EXTCMD = ();
		3597	%EXTICMD = ();
		3598
		3599	warn "unloading/nuking all extensions";
		3600	for my $pkg (@EXTS) {
2059	warn "unloading <$_>";	3601	warn "... unloading $pkg";
2060	unload_extension $_;	3602
		3603	if (my $cb = $pkg->can ("unload")) {
		3604	eval {
		3605	$cb->($pkg);
		3606	1
		3607	} or warn "$pkg unloaded, but with errors: $@";
2061	}	3608	}
2062		3609
		3610	warn "... nuking $pkg";
		3611	Symbol::delete_package $pkg;
		3612	}
		3613
2063	# unload all modules loaded from $LIBDIR	3614	warn "unloading all perl modules loaded from $LIBDIR";
2064	while (my ($k, $v) = each %INC) {	3615	while (my ($k, $v) = each %INC) {
2065	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3616	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2066		3617
2067	warn "removing <$k>";	3618	warn "... unloading $k";
2068	delete $INC{$k};	3619	delete $INC{$k};
2069		3620
2070	$k =~ s/\.pm$//;	3621	$k =~ s/\.pm$//;
2071	$k =~ s/\//::/g;	3622	$k =~ s/\//::/g;
2072		3623
…		…
2075	}	3626	}
2076		3627
2077	Symbol::delete_package $k;	3628	Symbol::delete_package $k;
2078	}	3629	}
2079		3630
2080	# sync database to disk
2081	cf::db_sync;
2082	IO::AIO::flush;
2083
2084	# get rid of safe::, as good as possible	3631	warn "getting rid of safe::, as good as possible";
2085	Symbol::delete_package "safe::$_"	3632	Symbol::delete_package "safe::$_"
2086	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3633	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2087		3634
2088	# remove register_script_function callbacks
2089	# TODO
2090
2091	# unload cf.pm "a bit"	3635	warn "unloading cf.pm \"a bit\"";
2092	delete $INC{"cf.pm"};	3636	delete $INC{"cf.pm"};
		3637	delete $INC{"cf/pod.pm"};
2093		3638
2094	# don't, removes xs symbols, too,	3639	# don't, removes xs symbols, too,
2095	# and global variables created in xs	3640	# and global variables created in xs
2096	#Symbol::delete_package __PACKAGE__;	3641	#Symbol::delete_package __PACKAGE__;
2097		3642
2098	# reload cf.pm	3643	warn "unload completed, starting to reload now";
		3644
2099	warn "reloading cf.pm";	3645	warn "reloading cf.pm";
2100	require cf;	3646	require cf;
2101	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3647	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2102		3648
2103	# load config and database again	3649	warn "loading config and database again";
2104	cf::cfg_load;	3650	cf::reload_config;
2105	cf::db_load;
2106		3651
2107	# load extensions
2108	warn "load extensions";	3652	warn "loading extensions";
2109	cf::load_extensions;	3653	cf::load_extensions;
2110		3654
2111	# reattach attachments to objects	3655	warn "reattaching attachments to objects/players";
2112	warn "reattach";	3656	_global_reattach; # objects, sockets
2113	_global_reattach;	3657	warn "reattaching attachments to maps";
		3658	reattach $_ for values %MAP;
		3659	warn "reattaching attachments to players";
		3660	reattach $_ for values %PLAYER;
		3661
		3662	warn "leaving sync_job";
		3663
		3664	1
		3665	} or do {
		3666	warn $@;
		3667	cf::cleanup "error while reloading, exiting.";
2114	};	3668	};
2115		3669
2116	if ($@) {	3670	warn "reloaded";
2117	warn $@;
2118	warn "error while reloading, exiting.";
2119	exit 1;
2120	}
2121
2122	warn "reloaded successfully";
2123	};	3671	};
2124		3672
2125	#############################################################################	3673	our $RELOAD_WATCHER; # used only during reload
2126		3674
2127	unless ($LINK_MAP) {	3675	sub reload_perl() {
2128	$LINK_MAP = cf::map::new;	3676	# doing reload synchronously and two reloads happen back-to-back,
		3677	# coro crashes during coro_state_free->destroy here.
2129		3678
2130	$LINK_MAP->width (41);	3679	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2131	$LINK_MAP->height (41);	3680	do_reload_perl;
2132	$LINK_MAP->alloc;	3681	undef $RELOAD_WATCHER;
2133	$LINK_MAP->path ("{link}");	3682	};
2134	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2135	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2136
2137	# dirty hack because... archetypes are not yet loaded
2138	Event->timer (
2139	after => 2,
2140	cb => sub {
2141	$_[0]->w->cancel;
2142
2143	# provide some exits "home"
2144	my $exit = cf::object::new "exit";
2145
2146	$exit->slaying ($EMERGENCY_POSITION->[0]);
2147	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2148	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2149
2150	$LINK_MAP->insert ($exit->clone, 19, 19);
2151	$LINK_MAP->insert ($exit->clone, 19, 20);
2152	$LINK_MAP->insert ($exit->clone, 19, 21);
2153	$LINK_MAP->insert ($exit->clone, 20, 19);
2154	$LINK_MAP->insert ($exit->clone, 20, 21);
2155	$LINK_MAP->insert ($exit->clone, 21, 19);
2156	$LINK_MAP->insert ($exit->clone, 21, 20);
2157	$LINK_MAP->insert ($exit->clone, 21, 21);
2158
2159	$exit->destroy;
2160	});
2161
2162	$LINK_MAP->{deny_save} = 1;
2163	$LINK_MAP->{deny_reset} = 1;
2164
2165	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2166	}	3683	}
2167
2168	register "<global>", __PACKAGE__;
2169		3684
2170	register_command "reload" => sub {	3685	register_command "reload" => sub {
2171	my ($who, $arg) = @_;	3686	my ($who, $arg) = @_;
2172		3687
2173	if ($who->flag (FLAG_WIZ)) {	3688	if ($who->flag (FLAG_WIZ)) {
2174	$who->message ("start of reload.");
2175	reload;
2176	$who->message ("end of reload.");	3689	$who->message ("reloading server.");
		3690	async {
		3691	$Coro::current->{desc} = "perl_reload";
		3692	reload_perl;
		3693	};
2177	}	3694	}
2178	};	3695	};
2179		3696
2180	unshift @INC, $LIBDIR;	3697	unshift @INC, $LIBDIR;
2181		3698
2182	$TICK_WATCHER = Event->timer (	3699	my $bug_warning = 0;
2183	reentrant => 0,	3700
2184	prio => 0,	3701	our @WAIT_FOR_TICK;
2185	at => $NEXT_TICK || $TICK,	3702	our @WAIT_FOR_TICK_BEGIN;
2186	data => WF_AUTOCANCEL,	3703
2187	cb => sub {	3704	sub wait_for_tick {
		3705	return if tick_inhibit || $Coro::current == $Coro::main;
		3706
		3707	my $signal = new Coro::Signal;
		3708	push @WAIT_FOR_TICK, $signal;
		3709	$signal->wait;
		3710	}
		3711
		3712	sub wait_for_tick_begin {
		3713	return if tick_inhibit || $Coro::current == $Coro::main;
		3714
		3715	my $signal = new Coro::Signal;
		3716	push @WAIT_FOR_TICK_BEGIN, $signal;
		3717	$signal->wait;
		3718	}
		3719
		3720	sub tick {
		3721	if ($Coro::current != $Coro::main) {
		3722	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3723	unless ++$bug_warning > 10;
		3724	return;
		3725	}
		3726
2188	cf::server_tick; # one server iteration	3727	cf::server_tick; # one server iteration
2189	$RUNTIME += $TICK;
2190	$NEXT_TICK += $TICK;
2191		3728
2192	# if we are delayed by four ticks or more, skip them all	3729	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2193	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3730	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2194		3731	Coro::async_pool {
2195	$TICK_WATCHER->at ($NEXT_TICK);	3732	$Coro::current->{desc} = "runtime saver";
2196	$TICK_WATCHER->start;
2197	},
2198	);
2199
2200	IO::AIO::max_poll_time $TICK * 0.2;
2201
2202	Event->io (
2203	fd => IO::AIO::poll_fileno,
2204	poll => 'r',
2205	prio => 5,
2206	data => WF_AUTOCANCEL,
2207	cb => \&IO::AIO::poll_cb,
2208	);
2209
2210	Event->timer (
2211	data => WF_AUTOCANCEL,
2212	after => 0,
2213	interval => 10,
2214	cb => sub {
2215	(Coro::unblock_sub {
2216	write_runtime	3733	write_runtime_sync
2217	or warn "ERROR: unable to write runtime file: $!";	3734	or warn "ERROR: unable to write runtime file: $!";
2218	})->();	3735	};
2219	},	3736	}
2220	);	3737
		3738	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3739	$sig->send;
		3740	}
		3741	while (my $sig = shift @WAIT_FOR_TICK) {
		3742	$sig->send;
		3743	}
		3744
		3745	$LOAD = ($NOW - $TICK_START) / $TICK;
		3746	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3747
		3748	if (0) {
		3749	if ($NEXT_TICK) {
		3750	my $jitter = $TICK_START - $NEXT_TICK;
		3751	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3752	warn "jitter $JITTER\n";#d#
		3753	}
		3754	}
		3755	}
		3756
		3757	{
		3758	# configure BDB
		3759
		3760	BDB::min_parallel 8;
		3761	BDB::max_poll_reqs $TICK * 0.1;
		3762	$Coro::BDB::WATCHER->priority (1);
		3763
		3764	unless ($DB_ENV) {
		3765	$DB_ENV = BDB::db_env_create;
		3766	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3767	| BDB::LOG_AUTOREMOVE, 1);
		3768	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3769	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3770
		3771	cf::sync_job {
		3772	eval {
		3773	BDB::db_env_open
		3774	$DB_ENV,
		3775	$BDBDIR,
		3776	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3777	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3778	0666;
		3779
		3780	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3781	};
		3782
		3783	cf::cleanup "db_env_open(db): $@" if $@;
		3784	};
		3785	}
		3786
		3787	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3788	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3789	};
		3790	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3791	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3792	};
		3793	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3794	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3795	};
		3796	}
		3797
		3798	{
		3799	# configure IO::AIO
		3800
		3801	IO::AIO::min_parallel 8;
		3802	IO::AIO::max_poll_time $TICK * 0.1;
		3803	$Coro::AIO::WATCHER->priority (1);
		3804	}
		3805
		3806	my $_log_backtrace;
		3807
		3808	sub _log_backtrace {
		3809	my ($msg, @addr) = @_;
		3810
		3811	$msg =~ s/\n//;
		3812
		3813	# limit the # of concurrent backtraces
		3814	if ($_log_backtrace < 2) {
		3815	++$_log_backtrace;
		3816	async {
		3817	$Coro::current->{desc} = "abt $msg";
		3818
		3819	my @bt = fork_call {
		3820	@addr = map { sprintf "%x", $_ } @addr;
		3821	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3822	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3823	or die "addr2line: $!";
		3824
		3825	my @funcs;
		3826	my @res = <$fh>;
		3827	chomp for @res;
		3828	while (@res) {
		3829	my ($func, $line) = splice @res, 0, 2, ();
		3830	push @funcs, "[$func] $line";
		3831	}
		3832
		3833	@funcs
		3834	};
		3835
		3836	LOG llevInfo, "[ABT] $msg\n";
		3837	LOG llevInfo, "[ABT] $_\n" for @bt;
		3838	--$_log_backtrace;
		3839	};
		3840	} else {
		3841	LOG llevInfo, "[ABT] $msg\n";
		3842	LOG llevInfo, "[ABT] [suppressed]\n";
		3843	}
		3844	}
		3845
		3846	# load additional modules
		3847	use cf::pod;
2221		3848
2222	END { cf::emergency_save }	3849	END { cf::emergency_save }
2223		3850
2224	1	3851	1
2225		3852

Diff Legend

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