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

Diff Legend

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