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.127 by root, Wed Jan 3 00:05:26 2007 UTC vs.
Revision 1.447 by root, Fri Sep 19 01:39:45 2008 UTC

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

Diff Legend

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