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.159 by root, Wed Jan 10 22:50:12 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 ();
20	use Data::Dumper;	53	use Data::Dumper;
21	use Digest::MD5;	54	use Digest::MD5;
22	use Fcntl;	55	use Fcntl;
		56	use YAML ();
23	use IO::AIO 2.32 ();	57	use IO::AIO ();
24	use YAML::Syck ();
25	use Time::HiRes;	58	use Time::HiRes;
		59	use Compress::LZF;
		60	use Digest::MD5 ();
26		61
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	62	AnyEvent::detect;
		63
		64	# configure various modules to our taste
		65	#
		66	$Storable::canonical = 1; # reduce rsync transfers
		67	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		68
		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
28		74
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	75	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		76
36	our %COMMAND = ();	77	our %COMMAND = ();
37	our %COMMAND_TIME = ();	78	our %COMMAND_TIME = ();
38		79
39	our @EXTS = (); # list of extension package names	80	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	81	our %EXTCMD = ();
		82	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	83	our %EXT_CORO = (); # coroutines bound to extensions
		84	our %EXT_MAP = (); # pluggable maps
42		85
		86	our $RELOAD; # number of reloads so far, non-zero while in reload
43	our @EVENT;	87	our @EVENT;
44	our $LIBDIR = datadir . "/ext";
45		88
46	our $TICK = MAX_TIME * 1e-6;	89	our $CONFDIR = confdir;
47	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
48	our $NEXT_TICK;	107	our $NEXT_TICK;
49	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;
50		114
51	our %CFG;	115	our %CFG;
52		116
53	our $UPTIME; $UPTIME ||= time;	117	our $UPTIME; $UPTIME ||= time;
54	our $RUNTIME;	118	our $RUNTIME;
		119	our $NOW;
55		120
56	our %PLAYER; # all users	121	our (%PLAYER, %PLAYER_LOADING); # all users
57	our %MAP; # all maps	122	our (%MAP, %MAP_LOADING ); # all maps
58	our $LINK_MAP; # the special {link} map	123	our $LINK_MAP; # the special {link} map, which is always available
59	our $RANDOM_MAPS = cf::localdir . "/random";
60		124
61	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	125	# used to convert map paths into valid unix filenames by replacing / by ∕
62	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;	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;
63		134
64	binmode STDOUT;	135	binmode STDOUT;
65	binmode STDERR;	136	binmode STDERR;
66		137
67	# read virtual server time, if available	138	# read virtual server time, if available
68	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	139	unless ($RUNTIME || !-e $RUNTIMEFILE) {
69	open my $fh, "<", cf::localdir . "/runtime"	140	open my $fh, "<", $RUNTIMEFILE
70	or die "unable to read runtime file: $!";	141	or die "unable to read $RUNTIMEFILE file: $!";
71	$RUNTIME = <$fh> + 0.;	142	$RUNTIME = <$fh> + 0.;
72	}	143	}
73		144
74	mkdir cf::localdir;	145	mkdir $_
75	mkdir cf::localdir . "/" . cf::playerdir;	146	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
76	mkdir cf::localdir . "/" . cf::tmpdir;
77	mkdir cf::localdir . "/" . cf::uniquedir;
78	mkdir $RANDOM_MAPS;
79		147
80	# a special map that is always available
81	our $LINK_MAP;
82	our $EMERGENCY_POSITION;	148	our $EMERGENCY_POSITION;
		149
		150	sub cf::map::normalise;
83		151
84	#############################################################################	152	#############################################################################
85		153
86	=head2 GLOBAL VARIABLES	154	=head2 GLOBAL VARIABLES
87		155
…		…
94	=item $cf::RUNTIME	162	=item $cf::RUNTIME
95		163
96	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
97	every server tick.	165	every server tick.
98		166
99	=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
100		170
101	The perl library directory, where extensions and cf-specific modules can	171	Various directories - "/etc", read-only install directory, perl-library
102	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.
103		175
104	=item $cf::NOW	176	=item $cf::NOW
105		177
106	The time of the last (current) server tick.	178	The time of the last (current) server tick.
107		179
108	=item $cf::TICK	180	=item $cf::TICK
109		181
110	The interval between server ticks, in seconds.	182	The interval between server ticks, in seconds.
111		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
112	=item %cf::CFG	194	=item %cf::CFG
113		195
114	Configuration for the server, loaded from C</etc/crossfire/config>, or	196	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
115	from wherever your confdir points to.	197	from wherever your confdir points to.
116		198
117	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	199	=item cf::wait_for_tick, cf::wait_for_tick_begin
118		200
119	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	201	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
120	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	202	returns directly I<after> the tick processing (and consequently, can only wake one process
121	processing has been done. Call C<< ->wait >> on them to maximise the	203	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
122	window of cpu time available, or simply to synchronise to the server tick.	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.
123		210
124	=back	211	=back
125		212
126	=cut	213	=cut
127		214
128	BEGIN {	215	BEGIN {
129	*CORE::GLOBAL::warn = sub {	216	*CORE::GLOBAL::warn = sub {
130	my $msg = join "", @_;	217	my $msg = join "", @_;
131	utf8::encode $msg;
132		218
133	$msg .= "\n"	219	$msg .= "\n"
134	unless $msg =~ /\n$/;	220	unless $msg =~ /\n$/;
135		221
		222	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		223
136	LOG llevError, $msg;	224	LOG llevError, $msg;
137	};	225	};
138	}	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#?
139		242
140	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	243	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
141	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	244	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
142	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	245	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
143	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	246	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
144	@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';
145	@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)
146		250
147	# 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
148	# within the Safe compartment.	252	# within the Safe compartment.
149	for my $pkg (qw(	253	for my $pkg (qw(
150	cf::global cf::attachable	254	cf::global cf::attachable
151	cf::object cf::object::player	255	cf::object cf::object::player
152	cf::client cf::player	256	cf::client cf::player
153	cf::arch cf::living	257	cf::arch cf::living
		258	cf::map cf::mapspace
154	cf::map cf::party cf::region	259	cf::party cf::region
155	)) {	260	)) {
156	no strict 'refs';
157	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	261	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
158	}	262	}
159		263
160	$Event::DIED = sub {	264	$EV::DIED = sub {
161	warn "error in event callback: @_";	265	warn "error in event callback: @_";
162	};	266	};
		267
		268	#############################################################################
163		269
164	=head2 UTILITY FUNCTIONS	270	=head2 UTILITY FUNCTIONS
165		271
166	=over 4	272	=over 4
167		273
…		…
186	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	292	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
187	$d	293	$d
188	} || "[unable to dump $_[0]: '$@']";	294	} || "[unable to dump $_[0]: '$@']";
189	}	295	}
190		296
191	use JSON::Syck (); # TODO# replace by JSON::PC once working
192
193	=item $ref = cf::from_json $json	297	=item $ref = cf::decode_json $json
194		298
195	Converts a JSON string into the corresponding perl data structure.	299	Converts a JSON string into the corresponding perl data structure.
196		300
197	=cut
198
199	sub from_json($) {
200	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
201	JSON::Syck::Load $_[0]
202	}
203
204	=item $json = cf::to_json $ref	301	=item $json = cf::encode_json $ref
205		302
206	Converts a perl data structure into its JSON representation.	303	Converts a perl data structure into its JSON representation.
207		304
208	=cut	305	=cut
209		306
210	sub to_json($) {	307	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
211	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	308
212	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;
213	}	324	}
214		325
215	=item cf::lock_wait $string	326	=item cf::lock_wait $string
216		327
217	Wait until the given lock is available. See cf::lock_acquire.	328	Wait until the given lock is available. See cf::lock_acquire.
…		…
221	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
222	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,
223	for example when the coroutine gets canceled), the lock is automatically	334	for example when the coroutine gets canceled), the lock is automatically
224	returned.	335	returned.
225		336
		337	Locks are *not* recursive, locking from the same coro twice results in a
		338	deadlocked coro.
		339
226	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
227	uses map_find and cf::map::load uses map_load).	341	uses map_find and cf::map::load uses map_load).
228		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
229	=cut	347	=cut
230		348
231	our %LOCK;	349	our %LOCK;
		350	our %LOCKER;#d#
232		351
233	sub lock_wait($) {	352	sub lock_wait($) {
234	my ($key) = @_;	353	my ($key) = @_;
235		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
236	# wait for lock, if any	360	# wait for lock, if any
237	while ($LOCK{$key}) {	361	while ($LOCK{$key}) {
		362	#local $Coro::current->{desc} = "$Coro::current->{desc} <waiting for lock $key>";
238	push @{ $LOCK{$key} }, $Coro::current;	363	push @{ $LOCK{$key} }, $Coro::current;
239	Coro::schedule;	364	Coro::schedule;
240	}	365	}
241	}	366	}
242		367
…		…
245		370
246	# wait, to be sure we are not locked	371	# wait, to be sure we are not locked
247	lock_wait $key;	372	lock_wait $key;
248		373
249	$LOCK{$key} = [];	374	$LOCK{$key} = [];
		375	$LOCKER{$key} = $Coro::current;#d#
250		376
251	Coro::guard {	377	Coro::guard {
		378	delete $LOCKER{$key};#d#
252	# wake up all waiters, to be on the safe side	379	# wake up all waiters, to be on the safe side
253	$_->ready for @{ delete $LOCK{$key} };	380	$_->ready for @{ delete $LOCK{$key} };
254	}	381	}
255	}	382	}
256		383
		384	sub lock_active($) {
		385	my ($key) = @_;
		386
		387	! ! $LOCK{$key}
		388	}
		389
257	sub freeze_mainloop {	390	sub freeze_mainloop {
258	return unless $TICK_WATCHER->is_active;	391	tick_inhibit_inc;
259		392
260	my $guard = Coro::guard { $TICK_WATCHER->start };	393	Coro::guard \&tick_inhibit_dec;
261	$TICK_WATCHER->stop;	394	}
262	$guard	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;
263	}	469	}
264		470
265	=item cf::async { BLOCK }	471	=item cf::async { BLOCK }
266		472
267	Currently the same as Coro::async_pool, meaning you cannot use	473	Currently the same as Coro::async_pool, meaning you cannot use
…		…
272		478
273	BEGIN { *async = \&Coro::async_pool }	479	BEGIN { *async = \&Coro::async_pool }
274		480
275	=item cf::sync_job { BLOCK }	481	=item cf::sync_job { BLOCK }
276		482
277	The design of crossfire+ requires that the main coro ($Coro::main) is	483	The design of Deliantra requires that the main coroutine ($Coro::main)
278	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
279	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.
280		487
281	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
282	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
283	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
284	fast or be very important.	491	fast or be very important.
…		…
287		494
288	sub sync_job(&) {	495	sub sync_job(&) {
289	my ($job) = @_;	496	my ($job) = @_;
290		497
291	if ($Coro::current == $Coro::main) {	498	if ($Coro::current == $Coro::main) {
		499	my $time = EV::time;
		500
292	# this is the main coro, too bad, we have to block	501	# this is the main coro, too bad, we have to block
293	# till the operation succeeds, freezing the server :/	502	# till the operation succeeds, freezing the server :/
294		503
295	# TODO: use suspend/resume instead	504	LOG llevError, Carp::longmess "sync job";#d#
296	# (but this is cancel-safe)	505
297	my $freeze_guard = freeze_mainloop;	506	my $freeze_guard = freeze_mainloop;
298		507
299	my $busy = 1;	508	my $busy = 1;
300	my @res;	509	my @res;
301		510
302	(async {	511	(async {
		512	$Coro::current->desc ("sync job coro");
303	@res = eval { $job->() };	513	@res = eval { $job->() };
304	warn $@ if $@;	514	warn $@ if $@;
305	undef $busy;	515	undef $busy;
306	})->prio (Coro::PRIO_MAX);	516	})->prio (Coro::PRIO_MAX);
307		517
308	while ($busy) {	518	while ($busy) {
309	Coro::cede or Event::one_event;	519	if (Coro::nready) {
		520	Coro::cede_notself;
		521	} else {
		522	EV::loop EV::LOOP_ONESHOT;
310	}	523	}
		524	}
		525
		526	my $time = EV::time - $time;
		527
		528	$TICK_START += $time; # do not account sync jobs to server load
311		529
312	wantarray ? @res : $res[0]	530	wantarray ? @res : $res[0]
313	} else {	531	} else {
314	# we are in another coroutine, how wonderful, everything just works	532	# we are in another coroutine, how wonderful, everything just works
315		533
…		…
335	$EXT_CORO{$coro+0} = $coro;	553	$EXT_CORO{$coro+0} = $coro;
336		554
337	$coro	555	$coro
338	}	556	}
339		557
340	sub write_runtime {	558	=item fork_call { }, $args
341	my $runtime = cf::localdir . "/runtime";
342		559
343	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	560	Executes the given code block with the given arguments in a seperate
344	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.
345		564
346	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	565	=cut
347	(aio_write $fh, 0, (length $value), $value, 0) <= 0
348	and return;
349		566
350	aio_fsync $fh	567	sub fork_call(&@) {
351	and return;	568	my ($cb, @args) = @_;
352		569
353	close $fh	570	# we seemingly have to make a local copy of the whole thing,
354	or return;	571	# otherwise perl prematurely frees the stuff :/
		572	# TODO: investigate and fix (likely this will be rather laborious)
355		573
356	aio_rename "$runtime~", $runtime	574	my @res = Coro::Util::fork_eval {
357	and return;	575	reset_signals;
		576	&$cb
		577	}, @args;
358		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
359	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 });
360	}	745	}
361		746
362	=back	747	=back
363		748
364	=cut	749	=cut
365		750
366	#############################################################################	751	#############################################################################
367		752
368	package cf::path;
369
370	use overload
371	'""' => \&as_string;
372
373	# used to convert map paths into valid unix filenames by repalcing / by ∕
374	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
375
376	sub new {
377	my ($class, $path, $base) = @_;
378
379	$path = $path->as_string if ref $path;
380
381	my $self = bless { }, $class;
382
383	# {... are special paths that are not touched
384	# ?xxx/... are special absolute paths
385	# ?random/... random maps
386	# /! non-realised random map exit
387	# /... normal maps
388	# ~/... per-player maps without a specific player (DO NOT USE)
389	# ~user/... per-player map of a specific user
390
391	$path =~ s/$PATH_SEP/\//go;
392
393	if ($path =~ /^{/) {
394	# fine as it is
395	} elsif ($path =~ s{^\?random/}{}) {
396	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
397	$self->{random} = cf::from_json $data;
398	} else {
399	if ($path =~ s{^~([^/]+)?}{}) {
400	$self->{user_rel} = 1;
401
402	if (defined $1) {
403	$self->{user} = $1;
404	} elsif ($base =~ m{^~([^/]+)/}) {
405	$self->{user} = $1;
406	} else {
407	warn "cannot resolve user-relative path without user <$path,$base>\n";
408	}
409	} elsif ($path =~ /^\//) {
410	# already absolute
411	} else {
412	$base =~ s{[^/]+/?$}{};
413	return $class->new ("$base/$path");
414	}
415
416	for ($path) {
417	redo if s{/\.?/}{/};
418	redo if s{/[^/]+/\.\./}{/};
419	}
420	}
421
422	$self->{path} = $path;
423
424	$self
425	}
426
427	# the name / primary key / in-game path
428	sub as_string {
429	my ($self) = @_;
430
431	$self->{user_rel} ? "~$self->{user}$self->{path}"
432	: $self->{random} ? "?random/$self->{path}"
433	: $self->{path}
434	}
435
436	# the displayed name, this is a one way mapping
437	sub visible_name {
438	my ($self) = @_;
439
440	# if (my $rmp = $self->{random}) {
441	# # todo: be more intelligent about this
442	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
443	# } else {
444	$self->as_string
445	# }
446	}
447
448	# escape the /'s in the path
449	sub _escaped_path {
450	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
451	$path
452	}
453
454	# the original (read-only) location
455	sub load_path {
456	my ($self) = @_;
457
458	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
459	}
460
461	# the temporary/swap location
462	sub save_path {
463	my ($self) = @_;
464
465	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
466	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
467	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
468	}
469
470	# the unique path, might be eq to save_path
471	sub uniq_path {
472	my ($self) = @_;
473
474	$self->{user_rel} || $self->{random}
475	? undef
476	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
477	}
478
479	# return random map parameters, or undef
480	sub random_map_params {
481	my ($self) = @_;
482
483	$self->{random}
484	}
485
486	# this is somewhat ugly, but style maps do need special treatment
487	sub is_style_map {
488	$_[0]{path} =~ m{^/styles/}
489	}
490
491	package cf;
492
493	#############################################################################
494
495	=head2 ATTACHABLE OBJECTS	753	=head2 ATTACHABLE OBJECTS
496		754
497	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
498	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")
499	to it. All such attachable objects support the following methods.	757	to it. All such attachable objects support the following methods.
500		758
501	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>
502	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
503	crossfire+).	761	Deliantra).
504		762
505	=over 4	763	=over 4
506		764
507	=item $attachable->attach ($attachment, key => $value...)	765	=item $attachable->attach ($attachment, key => $value...)
508		766
…		…
552	=item cf::CLASS::attachment $name, ...	810	=item cf::CLASS::attachment $name, ...
553		811
554	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
555	given CLASS can refer to this attachment.	813	given CLASS can refer to this attachment.
556		814
557	Some classes such as crossfire maps and objects can specify attachments	815	Some classes such as deliantra maps and objects can specify attachments
558	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.
559		817
560	These calls expect any number of the following handler/hook descriptions:	818	These calls expect any number of the following handler/hook descriptions:
561		819
562	=over 4	820	=over 4
…		…
622	our @CB_TYPE = (); # registry for type (cf-object class) based events	880	our @CB_TYPE = (); # registry for type (cf-object class) based events
623	our @CB_MAP = ();	881	our @CB_MAP = ();
624		882
625	my %attachment;	883	my %attachment;
626		884
		885	sub cf::attachable::thawer_merge {
		886	# simply override everything except _meta
		887	local $_[0]{_meta};
		888	%{$_[0]} = %{$_[1]};
		889	}
		890
627	sub _attach_cb($$$$) {	891	sub _attach_cb($$$$) {
628	my ($registry, $event, $prio, $cb) = @_;	892	my ($registry, $event, $prio, $cb) = @_;
629		893
630	use sort 'stable';	894	use sort 'stable';
631		895
…		…
665	$registry = $CB_TYPE[$object_type] ||= [];	929	$registry = $CB_TYPE[$object_type] ||= [];
666		930
667	} elsif ($type eq "subtype") {	931	} elsif ($type eq "subtype") {
668	defined $object_type or Carp::croak "subtype specified without type";	932	defined $object_type or Carp::croak "subtype specified without type";
669	my $object_subtype = shift @arg;	933	my $object_subtype = shift @arg;
670	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	934	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
671		935
672	} elsif ($type eq "package") {	936	} elsif ($type eq "package") {
673	my $pkg = shift @arg;	937	my $pkg = shift @arg;
674		938
675	while (my ($name, $id) = each %cb_id) {	939	while (my ($name, $id) = each %cb_id) {
…		…
704	_attach $registry, $klass, @attach;	968	_attach $registry, $klass, @attach;
705	}	969	}
706		970
707	$obj->{$name} = \%arg;	971	$obj->{$name} = \%arg;
708	} else {	972	} else {
709	warn "object uses attachment '$name' that is not available, postponing.\n";	973	warn "object uses attachment '$name' which is not available, postponing.\n";
710	}	974	}
711		975
712	$obj->{_attachment}{$name} = undef;	976	$obj->{_attachment}{$name} = undef;
713	}	977	}
714		978
…		…
716	if (ref $_[0]) {	980	if (ref $_[0]) {
717	_object_attach @_;	981	_object_attach @_;
718	} else {	982	} else {
719	_attach shift->_attach_registry, @_;	983	_attach shift->_attach_registry, @_;
720	}	984	}
		985	_recalc_want;
721	};	986	};
722		987
723	# all those should be optimised	988	# all those should be optimised
724	sub cf::attachable::detach {	989	sub cf::attachable::detach {
725	my ($obj, $name) = @_;	990	my ($obj, $name) = @_;
…		…
728	delete $obj->{_attachment}{$name};	993	delete $obj->{_attachment}{$name};
729	reattach ($obj);	994	reattach ($obj);
730	} else {	995	} else {
731	Carp::croak "cannot, currently, detach class attachments";	996	Carp::croak "cannot, currently, detach class attachments";
732	}	997	}
		998	_recalc_want;
733	};	999	};
734		1000
735	sub cf::attachable::attached {	1001	sub cf::attachable::attached {
736	my ($obj, $name) = @_;	1002	my ($obj, $name) = @_;
737		1003
…		…
752	";	1018	";
753	die if $@;	1019	die if $@;
754	}	1020	}
755		1021
756	our $override;	1022	our $override;
757	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?
758		1024
759	sub override {	1025	sub override {
760	$override = 1;	1026	$override = 1;
761	@invoke_results = ();	1027	@INVOKE_RESULTS = (@_);
762	}	1028	}
763		1029
764	sub do_invoke {	1030	sub do_invoke {
765	my $event = shift;	1031	my $event = shift;
766	my $callbacks = shift;	1032	my $callbacks = shift;
767		1033
768	@invoke_results = ();	1034	@INVOKE_RESULTS = ();
769		1035
770	local $override;	1036	local $override;
771		1037
772	for (@$callbacks) {	1038	for (@$callbacks) {
773	eval { &{$_->[1]} };	1039	eval { &{$_->[1]} };
…		…
782	}	1048	}
783		1049
784	0	1050	0
785	}	1051	}
786		1052
787	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1053	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
788		1054
789	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1055	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
790		1056
791	Generate an object-specific event with the given arguments.	1057	Generate an object-specific event with the given arguments.
792		1058
793	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
794	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
795	results (if you must, access C<@cf::invoke_results> directly).	1061	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
796		1062
797	=back	1063	=back
798		1064
799	=cut	1065	=cut
800		1066
801	#############################################################################	1067	#############################################################################
802	# 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	}
803		1111
804	sub reattach {	1112	sub reattach {
805	# basically do the same as instantiate, without calling instantiate	1113	# basically do the same as instantiate, without calling instantiate
806	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
807		1118
808	my $registry = $obj->registry;	1119	my $registry = $obj->registry;
809		1120
810	@$registry = ();	1121	@$registry = ();
811		1122
…		…
826	cf::attachable->attach (	1137	cf::attachable->attach (
827	prio => -1000000,	1138	prio => -1000000,
828	on_instantiate => sub {	1139	on_instantiate => sub {
829	my ($obj, $data) = @_;	1140	my ($obj, $data) = @_;
830		1141
831	$data = from_json $data;	1142	$data = decode_json $data;
832		1143
833	for (@$data) {	1144	for (@$data) {
834	my ($name, $args) = @$_;	1145	my ($name, $args) = @$_;
835		1146
836	$obj->attach ($name, %{$args || {} });	1147	$obj->attach ($name, %{$args || {} });
…		…
852	sub object_freezer_save {	1163	sub object_freezer_save {
853	my ($filename, $rdata, $objs) = @_;	1164	my ($filename, $rdata, $objs) = @_;
854		1165
855	sync_job {	1166	sync_job {
856	if (length $$rdata) {	1167	if (length $$rdata) {
		1168	utf8::decode (my $decname = $filename);
857	warn sprintf "saving %s (%d,%d)\n",	1169	warn sprintf "saving %s (%d,%d)\n",
858	$filename, length $$rdata, scalar @$objs;	1170	$decname, length $$rdata, scalar @$objs;
859		1171
860	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1172	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
861	chmod SAVE_MODE, $fh;	1173	aio_chmod $fh, SAVE_MODE;
862	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1174	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
863	aio_fsync $fh;	1175	aio_fsync $fh if $cf::USE_FSYNC;
864	close $fh;	1176	aio_close $fh;
865		1177
866	if (@$objs) {	1178	if (@$objs) {
867	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) {
868	chmod SAVE_MODE, $fh;	1180	aio_chmod $fh, SAVE_MODE;
869	my $data = Storable::nfreeze { version => 1, objs => $objs };	1181	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
870	aio_write $fh, 0, (length $data), $data, 0;	1182	aio_write $fh, 0, (length $data), $data, 0;
871	aio_fsync $fh;	1183	aio_fsync $fh if $cf::USE_FSYNC;
872	close $fh;	1184	aio_close $fh;
873	aio_rename "$filename.pst~", "$filename.pst";	1185	aio_rename "$filename.pst~", "$filename.pst";
874	}	1186	}
875	} else {	1187	} else {
876	aio_unlink "$filename.pst";	1188	aio_unlink "$filename.pst";
877	}	1189	}
878		1190
879	aio_rename "$filename~", $filename;	1191	aio_rename "$filename~", $filename;
		1192
		1193	$filename =~ s%/[^/]+$%%;
		1194	aio_pathsync $filename;
880	} else {	1195	} else {
881	warn "FATAL: $filename~: $!\n";	1196	warn "FATAL: $filename~: $!\n";
882	}	1197	}
883	} else {	1198	} else {
884	aio_unlink $filename;	1199	aio_unlink $filename;
885	aio_unlink "$filename.pst";	1200	aio_unlink "$filename.pst";
886	}	1201	}
887	}	1202	};
888	}	1203	}
889		1204
890	sub object_freezer_as_string {	1205	sub object_freezer_as_string {
891	my ($rdata, $objs) = @_;	1206	my ($rdata, $objs) = @_;
892		1207
…		…
904	or return;	1219	or return;
905		1220
906	unless (aio_stat "$filename.pst") {	1221	unless (aio_stat "$filename.pst") {
907	(aio_load "$filename.pst", $av) >= 0	1222	(aio_load "$filename.pst", $av) >= 0
908	or return;	1223	or return;
		1224
909	$av = eval { (Storable::thaw $av)->{objs} };	1225	my $st = eval { Coro::Storable::thaw $av };
		1226	$av = $st->{objs};
910	}	1227	}
911		1228
		1229	utf8::decode (my $decname = $filename);
912	warn sprintf "loading %s (%d)\n",	1230	warn sprintf "loading %s (%d,%d)\n",
913	$filename, length $data, scalar @{$av || []};#d#	1231	$decname, length $data, scalar @{$av || []};
		1232
914	return ($data, $av);	1233	($data, $av)
915	}	1234	}
		1235
		1236	=head2 COMMAND CALLBACKS
		1237
		1238	=over 4
		1239
		1240	=cut
916		1241
917	#############################################################################	1242	#############################################################################
918	# command handling &c	1243	# command handling &c
919		1244
920	=item cf::register_command $name => \&callback($ob,$args);	1245	=item cf::register_command $name => \&callback($ob,$args);
…		…
933	push @{ $COMMAND{$name} }, [$caller, $cb];	1258	push @{ $COMMAND{$name} }, [$caller, $cb];
934	}	1259	}
935		1260
936	=item cf::register_extcmd $name => \&callback($pl,$packet);	1261	=item cf::register_extcmd $name => \&callback($pl,$packet);
937		1262
938	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.
939		1268
940	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
941	called.	1270	called.
942		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
943	=cut	1283	=cut
944		1284
945	sub register_extcmd {	1285	sub register_extcmd {
946	my ($name, $cb) = @_;	1286	my ($name, $cb) = @_;
947		1287
948	$EXTCMD{$name} = $cb;	1288	$EXTCMD{$name} = $cb;
		1289	}
		1290
		1291	sub register_exticmd {
		1292	my ($name, $cb) = @_;
		1293
		1294	$EXTICMD{$name} = $cb;
949	}	1295	}
950		1296
951	cf::player->attach (	1297	cf::player->attach (
952	on_command => sub {	1298	on_command => sub {
953	my ($pl, $name, $params) = @_;	1299	my ($pl, $name, $params) = @_;
…		…
962	cf::override;	1308	cf::override;
963	},	1309	},
964	on_extcmd => sub {	1310	on_extcmd => sub {
965	my ($pl, $buf) = @_;	1311	my ($pl, $buf) = @_;
966		1312
967	my $msg = eval { from_json $buf };	1313	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
968		1314
969	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
970	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1323	if (my $cb = $EXTCMD{$type}) {
971	if (my %reply = $cb->($pl, $msg)) {	1324	@reply = $cb->($pl, @payload);
972	$pl->ext_reply ($msg->{msgid}, %reply);
973	}
974	}	1325	}
		1326
		1327	$pl->ext_reply ($reply, @reply)
		1328	if $reply;
		1329
975	} else {	1330	} else {
976	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1331	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
977	}	1332	}
978		1333
979	cf::override;	1334	cf::override;
980	},	1335	},
981	);	1336	);
982		1337
983	sub load_extension {
984	my ($path) = @_;
985
986	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
987	my $base = $1;
988	my $pkg = $1;
989	$pkg =~ s/[^[:word:]]/_/g;
990	$pkg = "ext::$pkg";
991
992	warn "loading '$path' into '$pkg'\n";
993
994	open my $fh, "<:utf8", $path
995	or die "$path: $!";
996
997	my $source =
998	"package $pkg; use strict; use utf8;\n"
999	. "#line 1 \"$path\"\n{\n"
1000	. (do { local $/; <$fh> })
1001	. "\n};\n1";
1002
1003	eval $source
1004	or die $@ ? "$path: $@\n"
1005	: "extension disabled.\n";
1006
1007	push @EXTS, $pkg;
1008	}
1009
1010	sub load_extensions {	1338	sub load_extensions {
		1339	cf::sync_job {
		1340	my %todo;
		1341
1011	for my $ext (<$LIBDIR/*.ext>) {	1342	for my $path (<$LIBDIR/*.ext>) {
1012	next unless -r $ext;	1343	next unless -r $path;
1013	eval {	1344
1014	load_extension $ext;	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;
1015	1	1401	}
1016	} or warn "$ext not loaded: $@";	1402
		1403	skip:
		1404	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1405	unless $progress;
		1406	}
1017	}	1407	};
1018	}	1408	}
1019		1409
1020	#############################################################################	1410	#############################################################################
1021	# load/save/clean perl data associated with a map
1022		1411
1023	*cf::mapsupport::on_clean = sub {	1412	=back
1024	my ($map) = @_;
1025
1026	my $path = $map->tmpname;
1027	defined $path or return;
1028
1029	unlink "$path.pst";
1030	};
1031
1032	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1033
1034	#############################################################################
1035		1413
1036	=head2 CORE EXTENSIONS	1414	=head2 CORE EXTENSIONS
1037		1415
1038	Functions and methods that extend core crossfire objects.	1416	Functions and methods that extend core deliantra objects.
1039		1417
1040	=cut	1418	=cut
1041		1419
1042	package cf::player;	1420	package cf::player;
1043		1421
…		…
1045		1423
1046	=head3 cf::player	1424	=head3 cf::player
1047		1425
1048	=over 4	1426	=over 4
1049		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
1050	=item cf::player::find $login	1442	=item cf::player::find $login
1051		1443
1052	Returns the given player object, loading it if necessary (might block).	1444	Returns the given player object, loading it if necessary (might block).
1053		1445
1054	=cut	1446	=cut
1055		1447
1056	sub playerdir($) {	1448	sub playerdir($) {
1057	cf::localdir	1449	"$PLAYERDIR/"
1058	. "/"
1059	. cf::playerdir
1060	. "/"
1061	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1450	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1062	}	1451	}
1063		1452
1064	sub path($) {	1453	sub path($) {
1065	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1454	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1066		1455
1067	(playerdir $login) . "/$login.pl"	1456	(playerdir $login) . "/playerdata"
1068	}	1457	}
1069		1458
1070	sub find_active($) {	1459	sub find_active($) {
1071	$cf::PLAYER{$_[0]}	1460	$cf::PLAYER{$_[0]}
1072	and $cf::PLAYER{$_[0]}->active	1461	and $cf::PLAYER{$_[0]}->active
…		…
1075		1464
1076	sub exists($) {	1465	sub exists($) {
1077	my ($login) = @_;	1466	my ($login) = @_;
1078		1467
1079	$cf::PLAYER{$login}	1468	$cf::PLAYER{$login}
1080	or cf::sync_job { !aio_stat $login }	1469	or !aio_stat path $login
1081	}	1470	}
1082		1471
1083	sub find($) {	1472	sub find($) {
1084	return $cf::PLAYER{$_[0]} || do {	1473	return $cf::PLAYER{$_[0]} || do {
1085	my $login = $_[0];	1474	my $login = $_[0];
1086		1475
1087	my $guard = cf::lock_acquire "user_find:$login";	1476	my $guard = cf::lock_acquire "user_find:$login";
1088		1477
1089	$cf::PLAYER{$_[0]} || do {	1478	$cf::PLAYER{$_[0]} || do {
1090	my $pl = load_pl path $login	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
1091	or return;	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;
1092	$cf::PLAYER{$login} = $pl	1494	$cf::PLAYER{$login} = $pl
1093	}	1495	}
1094	}	1496	}
1095	}	1497	}
1096		1498
…		…
1105	return if $pl->{deny_save};	1507	return if $pl->{deny_save};
1106		1508
1107	aio_mkdir playerdir $pl, 0770;	1509	aio_mkdir playerdir $pl, 0770;
1108	$pl->{last_save} = $cf::RUNTIME;	1510	$pl->{last_save} = $cf::RUNTIME;
1109		1511
		1512	cf::get_slot 0.01;
		1513
1110	$pl->save_pl ($path);	1514	$pl->save_pl ($path);
1111	Coro::cede;	1515	cf::cede_to_tick;
1112	}	1516	}
1113		1517
1114	sub new($) {	1518	sub new($) {
1115	my ($login) = @_;	1519	my ($login) = @_;
1116		1520
…		…
1122	$cf::PLAYER{$login} = $self;	1526	$cf::PLAYER{$login} = $self;
1123		1527
1124	$self	1528	$self
1125	}	1529	}
1126		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
1127	=item $pl->quit_character	1541	=item $pl->quit_character
1128		1542
1129	Nukes the player without looking back. If logged in, the connection will	1543	Nukes the player without looking back. If logged in, the connection will
1130	be destroyed. May block for a long time.	1544	be destroyed. May block for a long time.
1131		1545
1132	=cut	1546	=cut
1133		1547
1134	sub quit_character {	1548	sub quit_character {
1135	my ($pl) = @_;	1549	my ($pl) = @_;
1136		1550
		1551	my $name = $pl->ob->name;
		1552
1137	$pl->{deny_save} = 1;	1553	$pl->{deny_save} = 1;
1138	$pl->password ("*"); # this should lock out the player until we nuked the dir	1554	$pl->password ("*"); # this should lock out the player until we have nuked the dir
1139		1555
1140	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1556	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1141	$pl->deactivate;	1557	$pl->deactivate;
		1558	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1559	$pl->ob->check_score;
1142	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1560	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1143	$pl->ns->destroy if $pl->ns;	1561	$pl->ns->destroy if $pl->ns;
1144		1562
1145	my $path = playerdir $pl;	1563	my $path = playerdir $pl;
1146	my $temp = "$path~$cf::RUNTIME~deleting~";	1564	my $temp = "$path~$cf::RUNTIME~deleting~";
1147	aio_rename $path, $temp;	1565	aio_rename $path, $temp;
1148	delete $cf::PLAYER{$pl->ob->name};	1566	delete $cf::PLAYER{$pl->ob->name};
1149	$pl->destroy;	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
1150	IO::AIO::aio_rmtree $temp;	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;
1151	}	1589	}
1152		1590
1153	=item cf::player::list_logins	1591	=item cf::player::list_logins
1154		1592
1155	Returns am arrayref of all valid playernames in the system, can take a	1593	Returns am arrayref of all valid playernames in the system, can take a
1156	while and may block, so not sync_job-capable, ever.	1594	while and may block, so not sync_job-capable, ever.
1157		1595
1158	=cut	1596	=cut
1159		1597
1160	sub list_logins {	1598	sub list_logins {
1161	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1599	my $dirs = aio_readdir $PLAYERDIR
1162	or return [];	1600	or return [];
1163		1601
1164	my @logins;	1602	my @logins;
1165		1603
1166	for my $login (@$dirs) {	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") {
1167	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1610	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1168	aio_read $fh, 0, 512, my $buf, 0 or next;	1611	aio_read $fh, 0, 512, my $buf, 0 or next;
1169	$buf !~ /^password -------------$/m or next; # official not-valid tag	1612	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1613	}
1170		1614
1171	utf8::decode $login;	1615	utf8::decode $login;
1172	push @logins, $login;	1616	push @logins, $login;
1173	}	1617	}
1174		1618
1175	\@logins	1619	\@logins
1176	}	1620	}
1177		1621
1178	=item $player->maps	1622	=item $player->maps
1179		1623
1180	Returns an arrayref of cf::path's of all maps that are private for this	1624	Returns an arrayref of map paths that are private for this
1181	player. May block.	1625	player. May block.
1182		1626
1183	=cut	1627	=cut
1184		1628
1185	sub maps($) {	1629	sub maps($) {
1186	my ($pl) = @_;	1630	my ($pl) = @_;
		1631
		1632	$pl = ref $pl ? $pl->ob->name : $pl;
1187		1633
1188	my $files = aio_readdir playerdir $pl	1634	my $files = aio_readdir playerdir $pl
1189	or return;	1635	or return;
1190		1636
1191	my @paths;	1637	my @paths;
…		…
1193	for (@$files) {	1639	for (@$files) {
1194	utf8::decode $_;	1640	utf8::decode $_;
1195	next if /\.(?:pl|pst)$/;	1641	next if /\.(?:pl|pst)$/;
1196	next unless /^$PATH_SEP/o;	1642	next unless /^$PATH_SEP/o;
1197		1643
1198	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1644	push @paths, cf::map::normalise "~$pl/$_";
1199	}	1645	}
1200		1646
1201	\@paths	1647	\@paths
1202	}	1648	}
1203		1649
		1650	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1651
		1652	Expand deliantra pod fragments into protocol xml.
		1653
1204	=item $player->ext_reply ($msgid, $msgtype, %msg)	1654	=item $player->ext_reply ($msgid, @msg)
1205		1655
1206	Sends an ext reply to the player.	1656	Sends an ext reply to the player.
1207		1657
1208	=cut	1658	=cut
1209		1659
1210	sub ext_reply($$$%) {	1660	sub ext_reply($$@) {
1211	my ($self, $id, %msg) = @_;	1661	my ($self, $id, @msg) = @_;
1212		1662
1213	$msg{msgid} = $id;	1663	$self->ns->ext_reply ($id, @msg)
1214
1215	$self->send ("ext " . cf::to_json \%msg);
1216	}	1664	}
1217		1665
1218	package cf;	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($) {
		1693	my ($path) = @_;
		1694
		1695	my ($match, $specificity);
		1696
		1697	for my $region (list) {
		1698	if ($region->{match} && $path =~ $region->{match}) {
		1699	($match, $specificity) = ($region, $region->specificity)
		1700	if $region->specificity > $specificity;
		1701	}
		1702	}
		1703
		1704	$match
		1705	}
1219		1706
1220	=back	1707	=back
1221
1222		1708
1223	=head3 cf::map	1709	=head3 cf::map
1224		1710
1225	=over 4	1711	=over 4
1226		1712
…		…
1229	package cf::map;	1715	package cf::map;
1230		1716
1231	use Fcntl;	1717	use Fcntl;
1232	use Coro::AIO;	1718	use Coro::AIO;
1233		1719
		1720	use overload
		1721	'""' => \&as_string,
		1722	fallback => 1;
		1723
1234	our $MAX_RESET = 3600;	1724	our $MAX_RESET = 3600;
1235	our $DEFAULT_RESET = 3000;	1725	our $DEFAULT_RESET = 3000;
1236		1726
1237	sub generate_random_map {	1727	sub generate_random_map {
1238	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
1239		1731
1240	# mit "rum" bekleckern, nicht	1732	# mit "rum" bekleckern, nicht
1241	cf::map::_create_random_map	1733	$self->_create_random_map (
1242	$path,
1243	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1734	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1244	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1735	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1245	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1736	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1246	$rmp->{exit_on_final_map},	1737	$rmp->{exit_on_final_map},
1247	$rmp->{xsize}, $rmp->{ysize},	1738	$rmp->{xsize}, $rmp->{ysize},
1248	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1739	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1249	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1740	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1250	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1741	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1251	$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},
1252	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1743	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1253	(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"
1254	}	1873	}
1255		1874
1256	# and all this just because we cannot iterate over	1875	# and all this just because we cannot iterate over
1257	# all maps in C++...	1876	# all maps in C++...
1258	sub change_all_map_light {	1877	sub change_all_map_light {
…		…
1260		1879
1261	$_->change_map_light ($change)	1880	$_->change_map_light ($change)
1262	for grep $_->outdoor, values %cf::MAP;	1881	for grep $_->outdoor, values %cf::MAP;
1263	}	1882	}
1264		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
1265	sub try_load_header($) {	1900	sub load_header_from($) {
1266	my ($path) = @_;	1901	my ($self, $path) = @_;
1267		1902
1268	utf8::encode $path;	1903	utf8::encode $path;
1269	aio_open $path, O_RDONLY, 0	1904	my $f = new_from_file cf::object::thawer $path
1270	or return;	1905	or return;
1271		1906
1272	my $map = cf::map::new	1907	$self->_load_header ($f)
1273	or return;	1908	or return;
1274		1909
1275	# for better error messages only, will be overwritten	1910	local $MAP_LOADING{$self->{path}} = $self;
1276	$map->path ($path);	1911	$f->resolve_delayed_derefs;
1277		1912
1278	$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
1279	or return;	1956	or return;
		1957	$self->prepare_orig;
		1958	}
1280		1959
1281	$map->{load_path} = $path;	1960	$self->{deny_reset} = 1
		1961	if $self->no_reset;
1282		1962
1283	$map	1963	$self->default_region (cf::region::find_by_path $self->{path})
		1964	unless $self->default_region;
		1965
		1966	1
1284	}	1967	}
1285		1968
1286	sub find;	1969	sub find;
1287	sub find {	1970	sub find {
1288	my ($path, $origin) = @_;	1971	my ($path, $origin) = @_;
1289		1972
1290	#warn "find<$path,$origin>\n";#d#
1291
1292	$path = new cf::path $path, $origin && $origin->path;	1973	$path = normalise $path, $origin && $origin->path;
1293	my $key = $path->as_string;
1294		1974
		1975	cf::lock_wait "map_data:$path";#d#remove
1295	cf::lock_wait "map_find:$key";	1976	cf::lock_wait "map_find:$path";
1296		1977
1297	$cf::MAP{$key} || do {	1978	$cf::MAP{$path} || do {
		1979	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1298	my $guard = cf::lock_acquire "map_find:$key";	1980	my $guard2 = cf::lock_acquire "map_find:$path";
1299		1981
1300	# do it the slow way	1982	my $map = new_from_path cf::map $path
1301	my $map = try_load_header $path->save_path;
1302
1303	Coro::cede;
1304
1305	if ($map) {
1306	$map->last_access ((delete $map->{last_access})
1307	|| $cf::RUNTIME); #d#
1308	# safety
1309	$map->{instantiate_time} = $cf::RUNTIME
1310	if $map->{instantiate_time} > $cf::RUNTIME;
1311	} else {
1312	if (my $rmp = $path->random_map_params) {
1313	$map = generate_random_map $key, $rmp;
1314	} else {
1315	$map = try_load_header $path->load_path;
1316	}
1317
1318	$map or return;	1983	or return;
1319		1984
1320	$map->{load_original} = 1;
1321	$map->{instantiate_time} = $cf::RUNTIME;
1322	$map->last_access ($cf::RUNTIME);
1323	$map->instantiate;
1324
1325	# per-player maps become, after loading, normal maps
1326	$map->per_player (0) if $path->{user_rel};
1327	}
1328
1329	$map->path ($key);
1330	$map->{path} = $path;
1331	$map->{last_save} = $cf::RUNTIME;	1985	$map->{last_save} = $cf::RUNTIME;
1332		1986
1333	Coro::cede;	1987	$map->load_header
		1988	or return;
1334		1989
1335	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;
1336	$map->reset;	1995	$map->reset;
1337	undef $guard;
1338	$map = find $path	1996	return find $path;
1339	or return;
1340	}	1997	}
1341		1998
1342	$cf::MAP{$key} = $map	1999	$cf::MAP{$path} = $map
1343	}	2000	}
1344	}	2001	}
		2002
		2003	sub pre_load { }
		2004	sub post_load { }
1345		2005
1346	sub load {	2006	sub load {
1347	my ($self) = @_;	2007	my ($self) = @_;
1348		2008
		2009	local $self->{deny_reset} = 1; # loading can take a long time
		2010
1349	my $path = $self->{path};	2011	my $path = $self->{path};
		2012
		2013	{
1350	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2014	my $guard = cf::lock_acquire "map_data:$path";
1351		2015
		2016	return unless $self->valid;
1352	return if $self->in_memory != cf::MAP_SWAPPED;	2017	return unless $self->in_memory == cf::MAP_SWAPPED;
1353		2018
1354	$self->in_memory (cf::MAP_LOADING);	2019	$self->in_memory (cf::MAP_LOADING);
1355		2020
1356	$self->alloc;	2021	$self->alloc;
1357	$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)
1358	or return;	2029	or return;
1359		2030
1360	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2031	$self->post_load_original
1361	if delete $self->{load_original};	2032	if delete $self->{load_original};
1362		2033
1363	if (my $uniq = $path->uniq_path) {	2034	if (my $uniq = $self->uniq_path) {
1364	utf8::encode $uniq;	2035	utf8::encode $uniq;
1365	if (aio_open $uniq, O_RDONLY, 0) {	2036	unless (aio_stat $uniq) {
		2037	if (my $f = new_from_file cf::object::thawer $uniq) {
1366	$self->clear_unique_items;	2038	$self->clear_unique_items;
1367	$self->load_objects ($uniq, 0);	2039	$self->_load_objects ($f);
		2040	$f->resolve_delayed_derefs;
		2041	}
1368	}	2042	}
1369	}	2043	}
1370		2044
1371	Coro::cede;	2045	$f->resolve_delayed_derefs;
1372		2046
		2047	cf::cede_to_tick;
1373	# now do the right thing for maps	2048	# now do the right thing for maps
1374	$self->link_multipart_objects;	2049	$self->link_multipart_objects;
1375
1376	if ($self->{path}->is_style_map) {
1377	$self->{deny_save} = 1;
1378	$self->{deny_reset} = 1;
1379	} else {
1380	$self->fix_auto_apply;
1381	$self->decay_objects;
1382	$self->update_buttons;
1383	$self->set_darkness_map;
1384	$self->difficulty ($self->estimate_difficulty)	2050	$self->difficulty ($self->estimate_difficulty)
1385	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;
1386	$self->activate;	2061	$self->activate;
1387	}	2062	}
1388		2063
1389	Coro::cede;	2064	$self->{last_save} = $cf::RUNTIME;
		2065	$self->last_access ($cf::RUNTIME);
1390		2066
1391	$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
1392	}	2083	}
1393		2084
1394	# find and load all maps in the 3x3 area around a map	2085	# find and load all maps in the 3x3 area around a map
1395	sub load_diag {	2086	sub load_neighbours {
1396	my ($map) = @_;	2087	my ($map) = @_;
1397		2088
1398	my @diag; # diagonal neighbours	2089	my @neigh; # diagonal neighbours
1399		2090
1400	for (0 .. 3) {	2091	for (0 .. 3) {
1401	my $neigh = $map->tile_path ($_)	2092	my $neigh = $map->tile_path ($_)
1402	or next;	2093	or next;
1403	$neigh = find $neigh, $map	2094	$neigh = find $neigh, $map
1404	or next;	2095	or next;
1405	$neigh->load;	2096	$neigh->load;
1406		2097
		2098	push @neigh,
1407	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2099	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1408	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2100	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1409	}	2101	}
1410		2102
1411	for (@diag) {	2103	for (grep defined $_->[0], @neigh) {
		2104	my ($path, $origin) = @$_;
1412	my $neigh = find @$_	2105	my $neigh = find $path, $origin
1413	or next;	2106	or next;
1414	$neigh->load;	2107	$neigh->load;
1415	}	2108	}
1416	}	2109	}
1417		2110
…		…
1422	}	2115	}
1423		2116
1424	sub do_load_sync {	2117	sub do_load_sync {
1425	my ($map) = @_;	2118	my ($map) = @_;
1426		2119
		2120	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2121	if $Coro::current == $Coro::main;
		2122
1427	cf::sync_job { $map->load };	2123	cf::sync_job { $map->load };
1428	}	2124	}
1429		2125
1430	our %MAP_PREFETCH;	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
1431	our $MAP_PREFETCHER = Coro::async {	2140	$MAP_PREFETCHER ||= cf::async {
1432	while () {	2141	$Coro::current->{desc} = "map prefetcher";
		2142
1433	while (%MAP_PREFETCH) {	2143	while (%MAP_PREFETCH) {
1434	my $key = each %MAP_PREFETCH	2144	while (my ($k, $v) = each %MAP_PREFETCH) {
1435	or next;	2145	if (my $map = find $k) {
		2146	$map->load if $v;
		2147	}
		2148
1436	my $path = delete $MAP_PREFETCH{$key};	2149	delete $MAP_PREFETCH{$k};
1437
1438	my $map = find $path
1439	or next;
1440	$map->load;
1441	}	2150	}
1442	Coro::schedule;	2151	}
		2152	undef $MAP_PREFETCHER;
1443	}	2153	};
1444	};
1445
1446	sub find_async {
1447	my ($path, $origin) = @_;
1448
1449	$path = new cf::path $path, $origin && $origin->path;
1450	my $key = $path->as_string;
1451
1452	if (my $map = $cf::MAP{$key}) {
1453	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1454	}
1455
1456	$MAP_PREFETCH{$key} = $path;
1457	$MAP_PREFETCHER->ready;	2154	$MAP_PREFETCHER->prio (6);
1458		2155
1459	()	2156	()
1460	}	2157	}
1461		2158
1462	sub save {	2159	sub save {
1463	my ($self) = @_;	2160	my ($self) = @_;
1464		2161
1465	my $lock = cf::lock_acquire "map_data:" . $self->path;	2162	my $lock = cf::lock_acquire "map_data:$self->{path}";
1466		2163
1467	$self->{last_save} = $cf::RUNTIME;	2164	$self->{last_save} = $cf::RUNTIME;
1468		2165
1469	return unless $self->dirty;	2166	return unless $self->dirty;
1470		2167
1471	my $save = $self->{path}->save_path; utf8::encode $save;	2168	my $save = $self->save_path; utf8::encode $save;
1472	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2169	my $uniq = $self->uniq_path; utf8::encode $uniq;
1473		2170
1474	$self->{load_path} = $save;	2171	$self->{load_path} = $save;
1475		2172
1476	return if $self->{deny_save};	2173	return if $self->{deny_save};
1477		2174
1478	local $self->{last_access} = $self->last_access;#d#	2175	local $self->{last_access} = $self->last_access;#d#
1479		2176
1480	cf::async {	2177	cf::async {
		2178	$Coro::current->{desc} = "map player save";
1481	$_->contr->save for $self->players;	2179	$_->contr->save for $self->players;
1482	};	2180	};
1483		2181
		2182	cf::get_slot 0.02;
		2183
1484	if ($uniq) {	2184	if ($uniq) {
1485	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2185	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1486	$self->save_objects ($uniq, cf::IO_UNIQUES);	2186	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1487	} else {	2187	} else {
1488	$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);
1489	}	2189	}
1490	}	2190	}
1491		2191
1492	sub swap_out {	2192	sub swap_out {
1493	my ($self) = @_;	2193	my ($self) = @_;
1494		2194
1495	# save first because save cedes	2195	# save first because save cedes
1496	$self->save;	2196	$self->save;
1497		2197
1498	my $lock = cf::lock_acquire "map_data:" . $self->path;	2198	my $lock = cf::lock_acquire "map_data:$self->{path}";
1499		2199
1500	return if $self->players;	2200	return if $self->players;
1501	return if $self->in_memory != cf::MAP_IN_MEMORY;	2201	return if $self->in_memory != cf::MAP_ACTIVE;
1502	return if $self->{deny_save};	2202	return if $self->{deny_save};
1503		2203
		2204	$self->in_memory (cf::MAP_SWAPPED);
		2205
		2206	$self->deactivate;
		2207	$_->clear_links_to ($self) for values %cf::MAP;
1504	$self->clear;	2208	$self->clear;
1505	$self->in_memory (cf::MAP_SWAPPED);
1506	}	2209	}
1507		2210
1508	sub reset_at {	2211	sub reset_at {
1509	my ($self) = @_;	2212	my ($self) = @_;
1510		2213
1511	# TODO: safety, remove and allow resettable per-player maps	2214	# TODO: safety, remove and allow resettable per-player maps
1512	return 1e99 if $self->{path}{user_rel};
1513	return 1e99 if $self->{deny_reset};	2215	return 1e99 if $self->{deny_reset};
1514		2216
1515	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2217	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1516	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;
1517		2219
…		…
1522	my ($self) = @_;	2224	my ($self) = @_;
1523		2225
1524	$self->reset_at <= $cf::RUNTIME	2226	$self->reset_at <= $cf::RUNTIME
1525	}	2227	}
1526		2228
1527	sub unlink_save {
1528	my ($self) = @_;
1529
1530	utf8::encode (my $save = $self->{path}->save_path);
1531	aioreq_pri 3; IO::AIO::aio_unlink $save;
1532	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1533	}
1534
1535	sub rename {
1536	my ($self, $new_path) = @_;
1537
1538	$self->unlink_save;
1539
1540	delete $cf::MAP{$self->path};
1541	$self->{path} = new cf::path $new_path;
1542	$self->path ($self->{path}->as_string);
1543	$cf::MAP{$self->path} = $self;
1544
1545	$self->save;
1546	}
1547
1548	sub reset {	2229	sub reset {
1549	my ($self) = @_;	2230	my ($self) = @_;
1550		2231
1551	my $lock = cf::lock_acquire "map_data:" . $self->path;	2232	my $lock = cf::lock_acquire "map_data:$self->{path}";
1552		2233
1553	return if $self->players;	2234	return if $self->players;
1554	return if $self->{path}{user_rel};#d#
1555		2235
1556	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	}
1557		2247
1558	delete $cf::MAP{$self->path};	2248	delete $cf::MAP{$self->path};
1559		2249
		2250	$self->deactivate;
1560	$_->clear_links_to ($self) for values %cf::MAP;	2251	$_->clear_links_to ($self) for values %cf::MAP;
		2252	$self->clear;
1561		2253
1562	$self->unlink_save;	2254	$self->unlink_save;
1563	$self->destroy;	2255	$self->destroy;
1564	}	2256	}
1565		2257
1566	my $nuke_counter = "aaaa";	2258	my $nuke_counter = "aaaa";
1567		2259
1568	sub nuke {	2260	sub nuke {
1569	my ($self) = @_;	2261	my ($self) = @_;
1570		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};
1571	$self->{deny_save} = 1;	2272	$self->{deny_save} = 1;
1572	$self->reset_timeout (1);	2273	$self->reset_timeout (1);
1573	$self->rename ("{nuke}/" . ($nuke_counter++));	2274	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2275
		2276	$cf::MAP{$self->path} = $self;
		2277	}
		2278
1574	$self->reset; # polite request, might not happen	2279	$self->reset; # polite request, might not happen
1575	}	2280	}
1576		2281
1577	sub customise_for {	2282	=item $maps = cf::map::tmp_maps
1578	my ($map, $ob) = @_;
1579		2283
1580	if ($map->per_player) {	2284	Returns an arrayref with all map paths of currently instantiated and saved
1581	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2285	maps. May block.
		2286
		2287	=cut
		2288
		2289	sub tmp_maps() {
1582	}	2290	[
		2291	map {
		2292	utf8::decode $_;
		2293	/\.map$/
		2294	? normalise $_
		2295	: ()
		2296	} @{ aio_readdir $TMPDIR or [] }
		2297	]
		2298	}
1583		2299
1584	$map	2300	=item $maps = cf::map::random_maps
		2301
		2302	Returns an arrayref with all map paths of currently instantiated and saved
		2303	random maps. May block.
		2304
		2305	=cut
		2306
		2307	sub random_maps() {
		2308	[
		2309	map {
		2310	utf8::decode $_;
		2311	/\.map$/
		2312	? normalise "?random/$_"
		2313	: ()
		2314	} @{ aio_readdir $RANDOMDIR or [] }
		2315	]
1585	}	2316	}
1586		2317
1587	=item cf::map::unique_maps	2318	=item cf::map::unique_maps
1588		2319
1589	Returns an arrayref of cf::path's of all shared maps that have	2320	Returns an arrayref of paths of all shared maps that have
1590	instantiated unique items. May block.	2321	instantiated unique items. May block.
1591		2322
1592	=cut	2323	=cut
1593		2324
1594	sub unique_maps() {	2325	sub unique_maps() {
1595	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2326	[
1596	or return;	2327	map {
1597
1598	my @paths;
1599
1600	for (@$files) {
1601	utf8::decode $_;	2328	utf8::decode $_;
1602	next if /\.pst$/;	2329	s/\.map$//; # TODO future compatibility hack
1603	next unless /^$PATH_SEP/o;	2330	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1604		2331	? ()
1605	push @paths, new cf::path $_;	2332	: normalise $_
		2333	} @{ aio_readdir $UNIQUEDIR or [] }
1606	}	2334	]
1607
1608	\@paths
1609	}	2335	}
1610
1611	package cf;
1612		2336
1613	=back	2337	=back
1614		2338
1615	=head3 cf::object	2339	=head3 cf::object
1616		2340
…		…
1620		2344
1621	=over 4	2345	=over 4
1622		2346
1623	=item $ob->inv_recursive	2347	=item $ob->inv_recursive
1624		2348
1625	Returns the inventory of the object _and_ their inventories, recursively.	2349	Returns the inventory of the object I<and> their inventories, recursively,
		2350	but I<not> the object itself.
1626		2351
1627	=cut	2352	=cut
1628		2353
1629	sub inv_recursive_;	2354	sub inv_recursive_;
1630	sub inv_recursive_ {	2355	sub inv_recursive_ {
…		…
1633		2358
1634	sub inv_recursive {	2359	sub inv_recursive {
1635	inv_recursive_ inv $_[0]	2360	inv_recursive_ inv $_[0]
1636	}	2361	}
1637		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
		2388	}
		2389	}
		2390
1638	package cf;	2391	package cf;
1639		2392
1640	=back	2393	=back
1641		2394
1642	=head3 cf::object::player	2395	=head3 cf::object::player
…		…
1648	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>
1649	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
1650	dialogue with the given NPC character.	2403	dialogue with the given NPC character.
1651		2404
1652	=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	};
1653		2420
1654	# rough implementation of a future "reply" method that works	2421	# rough implementation of a future "reply" method that works
1655	# with dialog boxes.	2422	# with dialog boxes.
1656	#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
1657	sub cf::object::player::reply($$$;$) {	2424	sub cf::object::player::reply($$$;$) {
…		…
1659		2426
1660	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2427	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1661		2428
1662	if ($self->{record_replies}) {	2429	if ($self->{record_replies}) {
1663	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2430	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2431
1664	} 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 {
1665	$msg = $npc->name . " says: $msg" if $npc;	2440	$msg = $npc->name . " says: $msg" if $npc;
1666	$self->message ($msg, $flags);	2441	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2442	}
1667	}	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 (@_);
1668	}	2454	}
1669		2455
1670	=item $player_object->may ("access")	2456	=item $player_object->may ("access")
1671		2457
1672	Returns wether the given player is authorized to access resource "access"	2458	Returns wether the given player is authorized to access resource "access"
…		…
1685		2471
1686	=item $player_object->enter_link	2472	=item $player_object->enter_link
1687		2473
1688	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}>).
1689		2475
1690	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.
1691	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.
1692		2482
1693	=item $player_object->leave_link ($map, $x, $y)	2483	=item $player_object->leave_link ($map, $x, $y)
1694		2484
1695	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
1696	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
1697	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
1698	to the emergency map position.	2488	fails, to the emergency map position.
1699		2489
1700	Might block.	2490	Might block.
1701		2491
1702	=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	}
1703		2503
1704	sub cf::object::player::enter_link {	2504	sub cf::object::player::enter_link {
1705	my ($self) = @_;	2505	my ($self) = @_;
1706		2506
1707	$self->deactivate_recursive;	2507	$self->deactivate_recursive;
1708		2508
1709	return if $self->map == $LINK_MAP;	2509	return if UNIVERSAL::isa $self->map, "ext::map_link";
1710		2510
1711	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2511	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1712	if $self->map;	2512	if $self->map && $self->map->{path} ne "{link}";
1713		2513
1714	$self->enter_map ($LINK_MAP, 20, 20);	2514	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1715	}	2515	}
1716		2516
1717	sub cf::object::player::leave_link {	2517	sub cf::object::player::leave_link {
1718	my ($self, $map, $x, $y) = @_;	2518	my ($self, $map, $x, $y) = @_;
		2519
		2520	return unless $self->contr->active;
1719		2521
1720	my $link_pos = delete $self->{_link_pos};	2522	my $link_pos = delete $self->{_link_pos};
1721		2523
1722	unless ($map) {	2524	unless ($map) {
1723	# restore original map position	2525	# restore original map position
…		…
1737	# use -1 or undef as default coordinates, not 0, 0	2539	# use -1 or undef as default coordinates, not 0, 0
1738	($x, $y) = ($map->enter_x, $map->enter_y)	2540	($x, $y) = ($map->enter_x, $map->enter_y)
1739	if $x <=0 && $y <= 0;	2541	if $x <=0 && $y <= 0;
1740		2542
1741	$map->load;	2543	$map->load;
1742	$map->load_diag;	2544	$map->load_neighbours;
1743		2545
1744	return unless $self->contr->active;	2546	return unless $self->contr->active;
		2547	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1745	$self->activate_recursive;	2548	$self->activate_recursive;
		2549
		2550	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1746	$self->enter_map ($map, $x, $y);	2551	$self->enter_map ($map, $x, $y);
1747	}	2552	}
1748		2553
1749	cf::player->attach (	2554	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1750	on_logout => sub {
1751	my ($pl) = @_;
1752		2555
1753	# abort map switching before logout	2556	Moves the player to the given map-path and coordinates by first freezing
1754	if ($pl->ob->{_link_pos}) {	2557	her, loading and preparing them map, calling the provided $check callback
1755	cf::sync_job {	2558	that has to return the map if sucecssful, and then unfreezes the player on
1756	$pl->ob->leave_link	2559	the new (success) or old (failed) map position. In either case, $done will
1757	};	2560	be called at the end of this process.
1758	}
1759	},
1760	on_login => sub {
1761	my ($pl) = @_;
1762		2561
1763	# try to abort aborted map switching on player login :)	2562	Note that $check will be called with a potentially non-loaded map, so if
1764	# should happen only on crashes	2563	it needs a loaded map it has to call C<< ->load >>.
1765	if ($pl->ob->{_link_pos}) {
1766	$pl->ob->enter_link;
1767	(async {
1768	# we need this sleep as the login has a concurrent enter_exit running
1769	# and this sleep increases chances of the player not ending up in scorn
1770	$pl->ob->reply (undef,
1771	"There was an internal problem at your last logout, "
1772	. "the server will try to bring you to your intended destination in a second.",
1773	cf::NDI_RED);
1774	Coro::Timer::sleep 1;
1775	$pl->ob->leave_link;
1776	})->prio (2);
1777	}
1778	},
1779	);
1780		2564
1781	=item $player_object->goto ($path, $x, $y)
1782
1783	=cut	2565	=cut
		2566
		2567	our $GOTOGEN;
1784		2568
1785	sub cf::object::player::goto {	2569	sub cf::object::player::goto {
1786	my ($self, $path, $x, $y) = @_;	2570	my ($self, $path, $x, $y, $check, $done) = @_;
1787		2571
1788	$path = new cf::path $path;	2572	# do generation counting so two concurrent goto's will be executed in-order
		2573	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1789		2574
1790	$self->enter_link;	2575	$self->enter_link;
1791		2576
1792	(async {	2577	(async {
1793	my $map = cf::map::find $path->as_string;	2578	$Coro::current->{desc} = "player::goto $path $x $y";
		2579
		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) {
1794	$map = $map->customise_for ($self) if $map;	2603	$map = $map->customise_for ($self);
1795		2604	$map = $check->($map) if $check && $map;
1796	# warn "entering ", $map->path, " at ($x, $y)\n"	2605	} else {
1797	# if $map;
1798
1799	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2606	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2607	}
1800		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};
1801	$self->leave_link ($map, $x, $y);	2619	$self->leave_link ($map, $x, $y);
		2620	}
		2621
		2622	$done->() if $done;
1802	})->prio (1);	2623	})->prio (1);
1803	}	2624	}
1804		2625
1805	=item $player_object->enter_exit ($exit_object)	2626	=item $player_object->enter_exit ($exit_object)
1806		2627
…		…
1808		2629
1809	sub parse_random_map_params {	2630	sub parse_random_map_params {
1810	my ($spec) = @_;	2631	my ($spec) = @_;
1811		2632
1812	my $rmp = { # defaults	2633	my $rmp = { # defaults
1813	xsize => 10,	2634	xsize => (cf::rndm 15, 40),
1814	ysize => 10,	2635	ysize => (cf::rndm 15, 40),
		2636	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2637	#layout => string,
1815	};	2638	};
1816		2639
1817	for (split /\n/, $spec) {	2640	for (split /\n/, $spec) {
1818	my ($k, $v) = split /\s+/, $_, 2;	2641	my ($k, $v) = split /\s+/, $_, 2;
1819		2642
…		…
1831	# that depends on the exit object	2654	# that depends on the exit object
1832		2655
1833	my $rmp = parse_random_map_params $exit->msg;	2656	my $rmp = parse_random_map_params $exit->msg;
1834		2657
1835	if ($exit->map) {	2658	if ($exit->map) {
1836	$rmp->{region} = $exit->map->region_name;	2659	$rmp->{region} = $exit->region->name;
1837	$rmp->{origin_map} = $exit->map->path;	2660	$rmp->{origin_map} = $exit->map->path;
1838	$rmp->{origin_x} = $exit->x;	2661	$rmp->{origin_x} = $exit->x;
1839	$rmp->{origin_y} = $exit->y;	2662	$rmp->{origin_y} = $exit->y;
		2663
		2664	$exit->map->touch;
1840	}	2665	}
1841		2666
1842	$rmp->{random_seed} ||= $exit->random_seed;	2667	$rmp->{random_seed} ||= $exit->random_seed;
1843		2668
1844	my $data = cf::to_json $rmp;	2669	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1845	my $md5 = Digest::MD5::md5_hex $data;	2670	my $md5 = Digest::MD5::md5_hex $data;
		2671	my $meta = "$RANDOMDIR/$md5.meta";
1846		2672
1847	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) {
1848	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;
1849		2677
		2678	my $slaying = "?random/$md5";
		2679
		2680	if ($exit->valid) {
1850	$exit->slaying ("?random/$md5");	2681	$exit->slaying ("?random/$md5");
1851	$exit->msg (undef);	2682	$exit->msg (undef);
		2683	}
1852	}	2684	}
1853	}	2685	}
1854		2686
1855	sub cf::object::player::enter_exit {	2687	sub cf::object::player::enter_exit {
1856	my ($self, $exit) = @_;	2688	my ($self, $exit) = @_;
…		…
1858	return unless $self->type == cf::PLAYER;	2690	return unless $self->type == cf::PLAYER;
1859		2691
1860	$self->enter_link;	2692	$self->enter_link;
1861		2693
1862	(async {	2694	(async {
1863	$self->deactivate_recursive; # just to be sure	2695	$Coro::current->{desc} = "enter_exit";
		2696
1864	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
1865	prepare_random_map $exit	2704	prepare_random_map $exit
1866	if $exit->slaying eq "/!";	2705	if $exit->slaying eq "/!";
		2706	}
1867		2707
1868	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;
1869	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2709	my $x = $exit->stats->hp;
		2710	my $y = $exit->stats->sp;
1870		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
1871	1;	2718	1
1872	}) {	2719	}) {
1873	$self->message ("Something went wrong deep within the crossfire server. "	2720	$self->message ("Something went wrong deep within the deliantra server. "
1874	. "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. "
1875	. "Please report this to the dungeon master!",	2722	. "Please report this to the dungeon master!",
1876	cf::NDI_UNIQUE | cf::NDI_RED);	2723	cf::NDI_UNIQUE | cf::NDI_RED);
1877		2724
1878	warn "ERROR in enter_exit: $@";	2725	warn "ERROR in enter_exit: $@";
1879	$self->leave_link;	2726	$self->leave_link;
1880	}	2727	}
1881	})->prio (1);	2728	})->prio (1);
…		…
1894		2741
1895	sub cf::client::send_drawinfo {	2742	sub cf::client::send_drawinfo {
1896	my ($self, $text, $flags) = @_;	2743	my ($self, $text, $flags) = @_;
1897		2744
1898	utf8::encode $text;	2745	utf8::encode $text;
1899	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2746	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1900	}	2747	}
1901		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	}
1902		2934
1903	=item $success = $client->query ($flags, "text", \&cb)	2935	=item $success = $client->query ($flags, "text", \&cb)
1904		2936
1905	Queues a query to the client, calling the given callback with	2937	Queues a query to the client, calling the given callback with
1906	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>,
1907	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>.
1908		2940
1909	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
1910	reliable at some point in the future.	2942	become reliable at some point in the future.
1911		2943
1912	=cut	2944	=cut
1913		2945
1914	sub cf::client::query {	2946	sub cf::client::query {
1915	my ($self, $flags, $text, $cb) = @_;	2947	my ($self, $flags, $text, $cb) = @_;
…		…
1923	utf8::encode $text;	2955	utf8::encode $text;
1924	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2956	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1925		2957
1926	$self->send_packet ($self->{query_queue}[0][0])	2958	$self->send_packet ($self->{query_queue}[0][0])
1927	if @{ $self->{query_queue} } == 1;	2959	if @{ $self->{query_queue} } == 1;
		2960
		2961	1
1928	}	2962	}
1929		2963
1930	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	},
1931	on_reply => sub {	2970	on_reply => sub {
1932	my ($ns, $msg) = @_;	2971	my ($ns, $msg) = @_;
1933		2972
1934	# this weird shuffling is so that direct followup queries	2973	# this weird shuffling is so that direct followup queries
1935	# get handled first	2974	# get handled first
1936	my $queue = delete $ns->{query_queue}	2975	my $queue = delete $ns->{query_queue}
1937	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
1938		2977
1939	(shift @$queue)->[1]->($msg);	2978	(shift @$queue)->[1]->($msg);
		2979	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1940		2980
1941	push @{ $ns->{query_queue} }, @$queue;	2981	push @{ $ns->{query_queue} }, @$queue;
1942		2982
1943	if (@{ $ns->{query_queue} } == @$queue) {	2983	if (@{ $ns->{query_queue} } == @$queue) {
1944	if (@$queue) {	2984	if (@$queue) {
…		…
1946	} else {	2986	} else {
1947	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2987	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1948	}	2988	}
1949	}	2989	}
1950	},	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	},
1951	);	3017	);
1952		3018
1953	=item $client->async (\&cb)	3019	=item $client->async (\&cb)
1954		3020
1955	Create a new coroutine, running the specified callback. The coroutine will	3021	Create a new coroutine, running the specified callback. The coroutine will
…		…
1996	our $safe = new Safe "safe";	3062	our $safe = new Safe "safe";
1997	our $safe_hole = new Safe::Hole;	3063	our $safe_hole = new Safe::Hole;
1998		3064
1999	$SIG{FPE} = 'IGNORE';	3065	$SIG{FPE} = 'IGNORE';
2000		3066
2001	$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	));
2002		3072
2003	# here we export the classes and methods available to script code	3073	# here we export the classes and methods available to script code
2004		3074
2005	=pod	3075	=pod
2006		3076
2007	The following fucntions and emthods are available within a safe environment:	3077	The following functions and methods are available within a safe environment:
2008		3078
2009	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
2010	cf::object::player player	3083	cf::object::player
2011	cf::player peaceful	3084	player
2012	cf::map trigger	3085
		3086	cf::player
		3087	peaceful
		3088
		3089	cf::map
		3090	trigger
2013		3091
2014	=cut	3092	=cut
2015		3093
2016	for (	3094	for (
2017	["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)],
2018	["cf::object::player" => qw(player)],	3098	["cf::object::player" => qw(player)],
2019	["cf::player" => qw(peaceful)],	3099	["cf::player" => qw(peaceful)],
2020	["cf::map" => qw(trigger)],	3100	["cf::map" => qw(trigger)],
2021	) {	3101	) {
2022	no strict 'refs';	3102	no strict 'refs';
…		…
2093	=back	3173	=back
2094		3174
2095	=cut	3175	=cut
2096		3176
2097	#############################################################################	3177	#############################################################################
		3178	# the server's init and main functions
2098		3179
2099	=head2 EXTENSION DATABASE SUPPORT	3180	sub load_facedata($) {
		3181	my ($path) = @_;
2100		3182
2101	Crossfire maintains a very simple database for extension use. It can	3183	# HACK to clear player env face cache, we need some signal framework
2102	currently store anything that can be serialised using Storable, which	3184	# for this (global event?)
2103	excludes objects.	3185	%ext::player_env::MUSIC_FACE_CACHE = ();
2104		3186
2105	The parameter C<$family> should best start with the name of the extension	3187	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2106	using it, it should be unique.
2107		3188
2108	=over 4	3189	warn "loading facedata from $path\n";
2109		3190
2110	=item $hashref = cf::db_get $family	3191	my $facedata;
		3192	0 < aio_load $path, $facedata
		3193	or die "$path: $!";
2111		3194
2112	Return a hashref for use by the extension C<$family>, which can be	3195	$facedata = Coro::Storable::thaw $facedata;
2113	modified. After modifications, you have to call C<cf::db_dirty> or
2114	C<cf::db_sync>.
2115		3196
2116	=item $value = cf::db_get $family => $key	3197	$facedata->{version} == 2
		3198	or cf::cleanup "$path: version mismatch, cannot proceed.";
2117		3199
2118	Returns a single value from the database	3200	# patch in the exptable
2119		3201	$facedata->{resource}{"res/exp_table"} = {
2120	=item cf::db_put $family => $hashref	3202	type => FT_RSRC,
2121		3203	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2122	Stores the given family hashref into the database. Updates are delayed, if
2123	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2124
2125	=item cf::db_put $family => $key => $value
2126
2127	Stores the given C<$value> in the family hash. Updates are delayed, if you
2128	want the data to be synced to disk immediately, use C<cf::db_sync>.
2129
2130	=item cf::db_dirty
2131
2132	Marks the database as dirty, to be updated at a later time.
2133
2134	=item cf::db_sync
2135
2136	Immediately write the database to disk I<if it is dirty>.
2137
2138	=cut
2139
2140	our $DB;
2141
2142	{
2143	my $path = cf::localdir . "/database.pst";
2144
2145	sub db_load() {
2146	$DB = stat $path ? Storable::retrieve $path : { };
2147	}
2148
2149	my $pid;
2150
2151	sub db_save() {
2152	waitpid $pid, 0 if $pid;
2153	if (0 == ($pid = fork)) {
2154	$DB->{_meta}{version} = 1;
2155	Storable::nstore $DB, "$path~";
2156	rename "$path~", $path;
2157	cf::_exit 0 if defined $pid;
2158	}
2159	}
2160
2161	my $dirty;
2162
2163	sub db_sync() {
2164	db_save if $dirty;
2165	undef $dirty;
2166	}
2167
2168	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2169	db_sync;
2170	});	3204	};
		3205	cf::cede_to_tick;
2171		3206
2172	sub db_dirty() {
2173	$dirty = 1;
2174	$idle->start;
2175	}	3207	{
		3208	my $faces = $facedata->{faceinfo};
2176		3209
2177	sub db_get($;$) {	3210	while (my ($face, $info) = each %$faces) {
2178	@_ >= 2	3211	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2179	? $DB->{$_[0]}{$_[1]}
2180	: ($DB->{$_[0]} ||= { })
2181	}
2182		3212
2183	sub db_put($$;$) {	3213	cf::face::set_visibility $idx, $info->{visibility};
2184	if (@_ >= 3) {	3214	cf::face::set_magicmap $idx, $info->{magicmap};
2185	$DB->{$_[0]}{$_[1]} = $_[2];	3215	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2186	} else {	3216	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2187	$DB->{$_[0]} = $_[1];
2188	}
2189	db_dirty;
2190	}
2191		3217
2192	cf::global->attach (	3218	cf::cede_to_tick;
2193	prio => 10000,
2194	on_cleanup => sub {
2195	db_sync;
2196	},	3219	}
2197	);
2198	}
2199		3220
2200	#############################################################################	3221	while (my ($face, $info) = each %$faces) {
2201	# the server's main()	3222	next unless $info->{smooth};
2202		3223
2203	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 {
2204	open my $fh, "<:utf8", cf::confdir . "/config"	3366	open my $fh, "<:utf8", "$CONFDIR/config"
2205	or return;	3367	or return;
2206		3368
2207	local $/;	3369	local $/;
2208	*CFG = YAML::Syck::Load <$fh>;	3370	*CFG = YAML::Load <$fh>;
2209		3371
2210	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3372	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2211		3373
2212	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3374	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2213	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3375	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2219	};	3381	};
2220	warn $@ if $@;	3382	warn $@ if $@;
2221	}	3383	}
2222	}	3384	}
2223		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
2224	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
2225	# we must not ever block the main coroutine	3421	# we must not ever block the main coroutine
2226	local $Coro::idle = sub {	3422	local $Coro::idle = sub {
2227	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#
2228	async { Event::one_event };	3424	(async {
		3425	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3426	EV::loop EV::LOOP_ONESHOT;
		3427	})->prio (Coro::PRIO_MAX);
2229	};	3428	};
2230		3429
2231	cfg_load;	3430	evthread_start IO::AIO::poll_fileno;
2232	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
2233	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
2234	Event::loop;	3458	EV::loop;
2235	}	3459	}
2236		3460
2237	#############################################################################	3461	#############################################################################
2238	# initialisation and cleanup	3462	# initialisation and cleanup
2239		3463
2240	# install some emergency cleanup handlers	3464	# install some emergency cleanup handlers
2241	BEGIN {	3465	BEGIN {
		3466	our %SIGWATCHER = ();
2242	for my $signal (qw(INT HUP TERM)) {	3467	for my $signal (qw(INT HUP TERM)) {
2243	Event->signal (	3468	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2244	data => WF_AUTOCANCEL,
2245	signal => $signal,
2246	cb => sub {
2247	cf::cleanup "SIG$signal";	3469	cf::cleanup "SIG$signal";
2248	},
2249	);	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
2250	}	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 };
2251	}	3558	}
2252		3559
2253	sub emergency_save() {	3560	sub emergency_save() {
2254	my $freeze_guard = cf::freeze_mainloop;	3561	my $freeze_guard = cf::freeze_mainloop;
2255		3562
2256	warn "enter emergency perl save\n";	3563	warn "enter emergency perl save\n";
2257		3564
2258	cf::sync_job {	3565	cf::sync_job {
2259	# use a peculiar iteration method to avoid tripping on perl	3566	# use a peculiar iteration method to avoid tripping on perl
2260	# refcount bugs in for. also avoids problems with players	3567	# refcount bugs in for. also avoids problems with players
2261	# and maps saved/Destroyed asynchronously.	3568	# and maps saved/destroyed asynchronously.
2262	warn "begin emergency player save\n";	3569	warn "begin emergency player save\n";
2263	for my $login (keys %cf::PLAYER) {	3570	for my $login (keys %cf::PLAYER) {
2264	my $pl = $cf::PLAYER{$login} or next;	3571	my $pl = $cf::PLAYER{$login} or next;
2265	$pl->valid or next;	3572	$pl->valid or next;
		3573	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2266	$pl->save;	3574	$pl->save;
2267	}	3575	}
2268	warn "end emergency player save\n";	3576	warn "end emergency player save\n";
2269		3577
2270	warn "begin emergency map save\n";	3578	warn "begin emergency map save\n";
…		…
2272	my $map = $cf::MAP{$path} or next;	3580	my $map = $cf::MAP{$path} or next;
2273	$map->valid or next;	3581	$map->valid or next;
2274	$map->save;	3582	$map->save;
2275	}	3583	}
2276	warn "end emergency map save\n";	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";
2277	};	3593	};
2278		3594
2279	warn "leave emergency perl save\n";	3595	warn "leave emergency perl save\n";
2280	}	3596	}
2281		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
2282	sub reload() {	3634	sub do_reload_perl() {
2283	# can/must only be called in main	3635	# can/must only be called in main
2284	if ($Coro::current != $Coro::main) {	3636	if ($Coro::current != $Coro::main) {
2285	warn "can only reload from main coroutine\n";	3637	warn "can only reload from main coroutine";
2286	return;	3638	return;
2287	}	3639	}
2288		3640
		3641	return if $RELOAD++;
		3642
		3643	while ($RELOAD) {
2289	warn "reloading...";	3644	warn "reloading...";
2290		3645
2291	warn "freezing server";	3646	warn "entering sync_job";
2292	my $guard = freeze_mainloop;	3647
		3648	cf::sync_job {
		3649	cf::write_runtime_sync; # external watchdog should not bark
2293	cf::emergency_save;	3650	cf::emergency_save;
		3651	cf::write_runtime_sync; # external watchdog should not bark
2294		3652
2295	warn "sync database to disk";	3653	warn "syncing database to disk";
2296	cf::db_sync;	3654	BDB::db_env_txn_checkpoint $DB_ENV;
2297	IO::AIO::flush;
2298		3655
2299	eval {
2300	# 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
2301		3657
2302	warn "cancel all watchers";	3658	warn "flushing outstanding aio requests";
2303	for (Event::all_watchers) {	3659	while (IO::AIO::nreqs || BDB::nreqs) {
2304	$_->cancel if $_->data & WF_AUTOCANCEL;	3660	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2305	}
2306
2307	warn "cancel all extension coros";
2308	$_->cancel for values %EXT_CORO;
2309	%EXT_CORO = ();
2310
2311	warn "remove commands";
2312	%COMMAND = ();
2313
2314	warn "remove ext commands";
2315	%EXTCMD = ();
2316
2317	warn "unload/nuke all extensions";
2318	for my $pkg (@EXTS) {
2319	warn "unloading <$pkg>";
2320
2321	if (my $cb = $pkg->can ("unload")) {
2322	eval {
2323	$cb->($pkg);
2324	1
2325	} or warn "$pkg unloaded, but with errors: $@";
2326	}	3661	}
2327		3662
2328	Symbol::delete_package $pkg;	3663	warn "cancelling all extension coros";
2329	}	3664	$_->cancel for values %EXT_CORO;
		3665	%EXT_CORO = ();
2330		3666
2331	warn "unload all perl modules loaded from $LIBDIR";
2332	while (my ($k, $v) = each %INC) {
2333	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2334
2335	warn "removing <$k>";	3667	warn "removing commands";
2336	delete $INC{$k};	3668	%COMMAND = ();
2337		3669
2338	$k =~ s/\.pm$//;	3670	warn "removing ext/exti commands";
2339	$k =~ s/\//::/g;	3671	%EXTCMD = ();
		3672	%EXTICMD = ();
2340		3673
		3674	warn "unloading/nuking all extensions";
		3675	for my $pkg (@EXTS) {
		3676	warn "... unloading $pkg";
		3677
2341	if (my $cb = $k->can ("unload_module")) {	3678	if (my $cb = $pkg->can ("unload")) {
		3679	eval {
2342	$cb->();	3680	$cb->($pkg);
		3681	1
		3682	} or warn "$pkg unloaded, but with errors: $@";
		3683	}
		3684
		3685	warn "... clearing $pkg";
		3686	clear_package $pkg;
2343	}	3687	}
2344		3688
2345	Symbol::delete_package $k;	3689	warn "unloading all perl modules loaded from $LIBDIR";
		3690	while (my ($k, $v) = each %INC) {
		3691	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		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;
2346	}	3704	}
2347		3705
2348	warn "get rid of safe::, as good as possible";	3706	warn "getting rid of safe::, as good as possible";
2349	Symbol::delete_package "safe::$_"	3707	clear_package "safe::$_"
2350	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);
2351		3709
2352	warn "unload cf.pm \"a bit\"";	3710	warn "unloading cf.pm \"a bit\"";
2353	delete $INC{"cf.pm"};	3711	delete $INC{"cf.pm"};
		3712	delete $INC{"cf/pod.pm"};
2354		3713
2355	# don't, removes xs symbols, too,	3714	# don't, removes xs symbols, too,
2356	# and global variables created in xs	3715	# and global variables created in xs
2357	#Symbol::delete_package __PACKAGE__;	3716	#clear_package __PACKAGE__;
2358		3717
		3718	warn "unload completed, starting to reload now";
		3719
2359	warn "reloading cf.pm";	3720	warn "reloading cf.pm";
2360	require cf;	3721	require cf;
2361	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3722	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2362		3723
2363	warn "load config and database again";	3724	warn "loading config and database again";
2364	cf::cfg_load;	3725	cf::reload_config;
2365	cf::db_load;
2366		3726
2367	warn "load extensions";	3727	warn "loading extensions";
2368	cf::load_extensions;	3728	cf::load_extensions;
2369		3729
2370	warn "reattach attachments to objects/players";	3730	warn "reattaching attachments to objects/players";
2371	_global_reattach;	3731	_global_reattach; # objects, sockets
2372	warn "reattach attachments to maps";	3732	warn "reattaching attachments to maps";
2373	reattach $_ for values %MAP;	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
		3748	warn "reloaded";
		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;
2374	};	3762	};
2375
2376	if ($@) {
2377	warn $@;
2378	warn "error while reloading, exiting.";
2379	exit 1;
2380	}
2381
2382	warn "reloaded";
2383	};
2384
2385	#############################################################################
2386
2387	unless ($LINK_MAP) {
2388	$LINK_MAP = cf::map::new;
2389
2390	$LINK_MAP->width (41);
2391	$LINK_MAP->height (41);
2392	$LINK_MAP->alloc;
2393	$LINK_MAP->path ("{link}");
2394	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2395	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2396
2397	# dirty hack because... archetypes are not yet loaded
2398	Event->timer (
2399	after => 10,
2400	cb => sub {
2401	$_[0]->w->cancel;
2402
2403	# provide some exits "home"
2404	my $exit = cf::object::new "exit";
2405
2406	$exit->slaying ($EMERGENCY_POSITION->[0]);
2407	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2408	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2409
2410	$LINK_MAP->insert ($exit->clone, 19, 19);
2411	$LINK_MAP->insert ($exit->clone, 19, 20);
2412	$LINK_MAP->insert ($exit->clone, 19, 21);
2413	$LINK_MAP->insert ($exit->clone, 20, 19);
2414	$LINK_MAP->insert ($exit->clone, 20, 21);
2415	$LINK_MAP->insert ($exit->clone, 21, 19);
2416	$LINK_MAP->insert ($exit->clone, 21, 20);
2417	$LINK_MAP->insert ($exit->clone, 21, 21);
2418
2419	$exit->destroy;
2420	});
2421
2422	$LINK_MAP->{deny_save} = 1;
2423	$LINK_MAP->{deny_reset} = 1;
2424
2425	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2426	}	3763	}
2427		3764
2428	register_command "reload" => sub {	3765	register_command "reload" => sub {
2429	my ($who, $arg) = @_;	3766	my ($who, $arg) = @_;
2430		3767
2431	if ($who->flag (FLAG_WIZ)) {	3768	if ($who->flag (FLAG_WIZ)) {
2432	$who->message ("start of reload.");
2433	reload;
2434	$who->message ("end of reload.");	3769	$who->message ("reloading server.");
		3770	async {
		3771	$Coro::current->{desc} = "perl_reload";
		3772	reload_perl;
		3773	};
2435	}	3774	}
2436	};	3775	};
2437		3776
2438	unshift @INC, $LIBDIR;	3777	unshift @INC, $LIBDIR;
2439		3778
2440	$TICK_WATCHER = Event->timer (	3779	my $bug_warning = 0;
2441	reentrant => 0,	3780
2442	prio => 0,	3781	our @WAIT_FOR_TICK;
2443	at => $NEXT_TICK || $TICK,	3782	our @WAIT_FOR_TICK_BEGIN;
2444	data => WF_AUTOCANCEL,	3783
2445	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
2446	cf::server_tick; # one server iteration	3807	cf::server_tick; # one server iteration
2447	$RUNTIME += $TICK;
2448	$NEXT_TICK += $TICK;
2449		3808
2450	$WAIT_FOR_TICK->broadcast;	3809	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2451	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3810	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2452		3811	Coro::async_pool {
2453	# if we are delayed by four ticks or more, skip them all	3812	$Coro::current->{desc} = "runtime saver";
2454	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2455
2456	$TICK_WATCHER->at ($NEXT_TICK);
2457	$TICK_WATCHER->start;
2458	},
2459	);
2460
2461	IO::AIO::max_poll_time $TICK * 0.2;
2462
2463	Event->io (
2464	fd => IO::AIO::poll_fileno,
2465	poll => 'r',
2466	prio => 5,
2467	data => WF_AUTOCANCEL,
2468	cb => \&IO::AIO::poll_cb,
2469	);
2470
2471	Event->timer (
2472	data => WF_AUTOCANCEL,
2473	after => 0,
2474	interval => 10,
2475	cb => sub {
2476	(Coro::unblock_sub {
2477	write_runtime	3813	write_runtime_sync
2478	or warn "ERROR: unable to write runtime file: $!";	3814	or warn "ERROR: unable to write runtime file: $!";
2479	})->();	3815	};
2480	},	3816	}
2481	);	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;
2482		3931
2483	END { cf::emergency_save }	3932	END { cf::emergency_save }
2484		3933
2485	1	3934	1
2486		3935

Diff Legend

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