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

Diff Legend

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