ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.130 by root, Thu Jan 4 00:08:08 2007 UTC vs.
Revision 1.419 by root, Sun Apr 13 01:34:09 2008 UTC

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

Diff Legend

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