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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.474 by root, Thu Jul 16 21:42:56 2009 UTC

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

Diff Legend

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