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

Diff Legend

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