ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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