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.157 by root, Wed Jan 10 01:16:54 2007 UTC vs.
Revision 1.448 by root, Fri Sep 19 05:30:23 2008 UTC

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

Diff Legend

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