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.269 by root, Tue May 22 21:35:26 2007 UTC vs.
Revision 1.607 by root, Sun Nov 18 09:29:25 2012 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# 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 Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Socket;	29	use Socket;
9	use Storable;	30	use EV;
10	use Event;
11	use Opcode;	31	use Opcode;
12	use Safe;	32	use Safe;
13	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
14		36
		37	use AnyEvent ();
		38	use AnyEvent::IO ();
		39	use AnyEvent::DNS ();
		40
15	use Coro 3.61 ();	41	use Coro ();
16	use Coro::State;	42	use Coro::State;
17	use Coro::Handle;	43	use Coro::Handle;
		44	use Coro::EV;
18	use Coro::Event;	45	use Coro::AnyEvent;
19	use Coro::Timer;	46	use Coro::Timer;
20	use Coro::Signal;	47	use Coro::Signal;
21	use Coro::Semaphore;	48	use Coro::Semaphore;
		49	use Coro::SemaphoreSet;
		50	use Coro::AnyEvent;
22	use Coro::AIO;	51	use Coro::AIO;
		52	use Coro::BDB 1.6;
23	use Coro::Storable;	53	use Coro::Storable;
		54	use Coro::Util ();
24		55
		56	use Guard ();
		57	use JSON::XS 2.01 ();
25	use BDB ();	58	use BDB ();
26	use Data::Dumper;	59	use Data::Dumper;
27	use Digest::MD5;
28	use Fcntl;	60	use Fcntl;
29	use YAML::Syck ();	61	use YAML::XS ();
30	use IO::AIO 2.32 ();	62	use IO::AIO ();
31	use Time::HiRes;
32	use Compress::LZF;	63	use Compress::LZF;
		64	use Digest::MD5 ();
		65
		66	AnyEvent::detect;
33		67
34	# configure various modules to our taste	68	# configure various modules to our taste
35	#	69	#
36	$Storable::canonical = 1; # reduce rsync transfers	70	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		72
		73	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		74
		75	# make sure c-lzf reinitialises itself
		76	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	77	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39		78
40	$Event::Eval = 1; # no idea why this is required, but it is	79	# strictly for debugging
41		80	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
43	$YAML::Syck::ImplicitUnicode = 1;
44
45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
46		81
47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		83
		84	our @ORIG_INC;
48		85
49	our %COMMAND = ();	86	our %COMMAND = ();
50	our %COMMAND_TIME = ();	87	our %COMMAND_TIME = ();
51		88
52	our @EXTS = (); # list of extension package names	89	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	90	our %EXTCMD = ();
		91	our %EXTACMD = ();
		92	our %EXTICMD = ();
		93	our %EXTIACMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	94	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	95	our %EXT_MAP = (); # pluggable maps
56		96
57	our $RELOAD; # number of reloads so far	97	our $RELOAD; # number of reloads so far, non-zero while in reload
58	our @EVENT;	98	our @EVENT;
		99	our @REFLECT; # set by XS
		100	our %REFLECT; # set by us
59		101
60	our $CONFDIR = confdir;	102	our $CONFDIR = confdir;
		103
61	our $DATADIR = datadir;	104	our $DATADIR = datadir;
62	our $LIBDIR = "$DATADIR/ext";	105	our $LIBDIR = "$DATADIR/ext";
63	our $PODDIR = "$DATADIR/pod";	106	our $PODDIR = "$DATADIR/pod";
64	our $MAPDIR = "$DATADIR/" . mapdir;	107	our $MAPDIR = "$DATADIR/" . mapdir;
		108
65	our $LOCALDIR = localdir;	109	our $LOCALDIR = localdir;
66	our $TMPDIR = "$LOCALDIR/" . tmpdir;	110	our $TMPDIR = "$LOCALDIR/" . tmpdir;
67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;	111	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;	112	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69	our $RANDOMDIR = "$LOCALDIR/random";	113	our $RANDOMDIR = "$LOCALDIR/random";
70	our $BDBDIR = "$LOCALDIR/db";	114	our $BDBDIR = "$LOCALDIR/db";
		115	our $PIDFILE = "$LOCALDIR/pid";
		116	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		117
		118	#our %RESOURCE; # unused
		119
		120	our $OUTPUT_RATE_MIN = 3000;
		121	our $OUTPUT_RATE_MAX = 1000000;
		122
		123	our $MAX_LINKS = 32; # how many chained exits to follow
		124	our $VERBOSE_IO = 1;
71		125
72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)	126	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
73	our $TICK_WATCHER;
74	our $AIO_POLL_WATCHER;
75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	127	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
76	our $NEXT_TICK;	128	our $NEXT_TICK;
		129	our $USE_FSYNC = 1; # use fsync to write maps - default on
		130
		131	our $BDB_DEADLOCK_WATCHER;
		132	our $BDB_CHECKPOINT_WATCHER;
		133	our $BDB_TRICKLE_WATCHER;
		134	our $DB_ENV;
		135
		136	our @EXTRA_MODULES = qw(pod match mapscript incloader);
		137
		138	our %CFG;
		139	our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
		140
		141	our $UPTIME; $UPTIME ||= time;
		142	our $RUNTIME = 0;
		143	our $SERVER_TICK = 0;
77	our $NOW;	144	our $NOW;
78	our $USE_FSYNC = 1; # use fsync to write maps - default off
79		145
80	our $BDB_POLL_WATCHER;	146	our (%PLAYER, %PLAYER_LOADING); # all users
81	our $DB_ENV;	147	our (%MAP, %MAP_LOADING ); # all maps
82
83	our %CFG;
84
85	our $UPTIME; $UPTIME ||= time;
86	our $RUNTIME;
87
88	our %PLAYER; # all users
89	our %MAP; # all maps
90	our $LINK_MAP; # the special {link} map, which is always available	148	our $LINK_MAP; # the special {link} map, which is always available
91		149
92	# used to convert map paths into valid unix filenames by replacing / by ∕	150	# used to convert map paths into valid unix filenames by replacing / by ∕
93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	151	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94		152
95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)	153	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96	our $LOADAVG; # same thing, but with alpha-smoothing	154	our $LOADAVG; # same thing, but with alpha-smoothing
		155	our $JITTER; # average jitter
97	our $tick_start; # for load detecting purposes	156	our $TICK_START; # for load detecting purposes
		157
		158	our @POST_INIT;
		159
		160	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		161	our $REALLY_UNLOOP; # never set to true, please :)
		162
		163	our $WAIT_FOR_TICK = new Coro::Signal;
		164	our @WAIT_FOR_TICK_BEGIN;
98		165
99	binmode STDOUT;	166	binmode STDOUT;
100	binmode STDERR;	167	binmode STDERR;
101		168
102	# read virtual server time, if available	169	# read virtual server time, if available
103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {	170	unless ($RUNTIME || !-e $RUNTIMEFILE) {
104	open my $fh, "<", "$LOCALDIR/runtime"	171	open my $fh, "<", $RUNTIMEFILE
105	or die "unable to read runtime file: $!";	172	or die "unable to read $RUNTIMEFILE file: $!";
106	$RUNTIME = <$fh> + 0.;	173	$RUNTIME = <$fh> + 0.;
107	}	174	}
		175
		176	eval "sub TICK() { $TICK } 1" or die;
108		177
109	mkdir $_	178	mkdir $_
110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;	179	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
111		180
112	our $EMERGENCY_POSITION;	181	our $EMERGENCY_POSITION;
113		182
114	sub cf::map::normalise;	183	sub cf::map::normalise;
115		184
		185	sub in_main() {
		186	$Coro::current == $Coro::main
		187	}
		188
116	#############################################################################	189	#############################################################################
117		190
		191	%REFLECT = ();
		192	for (@REFLECT) {
		193	my $reflect = JSON::XS::decode_json $_;
		194	$REFLECT{$reflect->{class}} = $reflect;
		195	}
		196
		197	# this is decidedly evil
		198	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		199
		200	#############################################################################
		201
118	=head2 GLOBAL VARIABLES	202	=head2 GLOBAL VARIABLES
119		203
120	=over 4	204	=over 4
121		205
122	=item $cf::UPTIME	206	=item $cf::UPTIME
123		207
124	The timestamp of the server start (so not actually an uptime).	208	The timestamp of the server start (so not actually an "uptime").
		209
		210	=item $cf::SERVER_TICK
		211
		212	An unsigned integer that starts at zero when the server is started and is
		213	incremented on every tick.
		214
		215	=item $cf::NOW
		216
		217	The (real) time of the last (current) server tick - updated before and
		218	after tick processing, so this is useful only as a rough "what time is it
		219	now" estimate.
		220
		221	=item $cf::TICK
		222
		223	The interval between each server tick, in seconds.
125		224
126	=item $cf::RUNTIME	225	=item $cf::RUNTIME
127		226
128	The time this server has run, starts at 0 and is increased by $cf::TICK on	227	The time this server has run, starts at 0 and is increased by $cf::TICK on
129	every server tick.	228	every server tick.
130		229
131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR	230	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR	231	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR	232	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
134		233
135	Various directories - "/etc", read-only install directory, perl-library	234	Various directories - "/etc", read-only install directory, perl-library
136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",	235	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137	unique-items directory, player file directory, random maps directory and	236	unique-items directory, player file directory, random maps directory and
138	database environment.	237	database environment.
139		238
140	=item $cf::NOW
141
142	The time of the last (current) server tick.
143
144	=item $cf::TICK
145
146	The interval between server ticks, in seconds.
147
148	=item $cf::LOADAVG	239	=item $cf::LOADAVG
149		240
150	The current CPU load on the server (alpha-smoothed), as a value between 0	241	The current CPU load on the server (alpha-smoothed), as a value between 0
151	(none) and 1 (overloaded), indicating how much time is spent on processing	242	(none) and 1 (overloaded), indicating how much time is spent on processing
152	objects per tick. Healthy values are < 0.5.	243	objects per tick. Healthy values are < 0.5.
…		…
155		246
156	The raw value load value from the last tick.	247	The raw value load value from the last tick.
157		248
158	=item %cf::CFG	249	=item %cf::CFG
159		250
160	Configuration for the server, loaded from C</etc/crossfire/config>, or	251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
161	from wherever your confdir points to.	252	from wherever your confdir points to.
162		253
163	=item cf::wait_for_tick, cf::wait_for_tick_begin	254	=item cf::wait_for_tick, cf::wait_for_tick_begin
164		255
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	256	These are functions that inhibit the current coroutine one tick.
166	returns directly I<after> the tick processing (and consequently, can only wake one process	257	cf::wait_for_tick_begin only returns directly I<after> the tick
		258	processing (and consequently, can only wake one thread per tick), while
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	259	cf::wait_for_tick wakes up all waiters after tick processing.
		260
		261	Note that cf::wait_for_tick will immediately return when the server is not
		262	ticking, making it suitable for small pauses in threads that need to run
		263	when the server is paused. If that is not applicable (i.e. you I<really>
		264	want to wait, use C<$cf::WAIT_FOR_TICK>).
		265
		266	=item $cf::WAIT_FOR_TICK
		267
		268	Note that C<cf::wait_for_tick> is probably the correct thing to use. This
		269	variable contains a L<Coro::Signal> that is broadcats after every server
		270	tick. Calling C<< ->wait >> on it will suspend the caller until after the
		271	next server tick.
		272
		273	=cut
		274
		275	sub wait_for_tick();
		276	sub wait_for_tick_begin();
		277
		278	=item @cf::INVOKE_RESULTS
		279
		280	This array contains the results of the last C<invoke ()> call. When
		281	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		282	that call.
		283
		284	=item %cf::REFLECT
		285
		286	Contains, for each (C++) class name, a hash reference with information
		287	about object members (methods, scalars, arrays and flags) and other
		288	metadata, which is useful for introspection.
168		289
169	=back	290	=back
170		291
171	=cut	292	=cut
172		293
173	BEGIN {	294	sub error(@) { LOG llevError, join "", @_ }
174	*CORE::GLOBAL::warn = sub {	295	sub warn (@) { LOG llevWarn , join "", @_ }
		296	sub info (@) { LOG llevInfo , join "", @_ }
		297	sub debug(@) { LOG llevDebug, join "", @_ }
		298	sub trace(@) { LOG llevTrace, join "", @_ }
		299
		300	$Coro::State::WARNHOOK = sub {
175	my $msg = join "", @_;	301	my $msg = join "", @_;
176		302
177	$msg .= "\n"	303	$msg .= "\n"
178	unless $msg =~ /\n$/;	304	unless $msg =~ /\n$/;
179		305
180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;	306	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181		307
182	utf8::encode $msg;
183	LOG llevError, $msg;	308	LOG llevWarn, $msg;
184	};	309	};
185	}	310
		311	$Coro::State::DIEHOOK = sub {
		312	return unless $^S eq 0; # "eq", not "=="
		313
		314	error Carp::longmess $_[0];
		315
		316	if (in_main) {#d#
		317	error "DIEHOOK called in main context, Coro bug?\n";#d#
		318	return;#d#
		319	}#d#
		320
		321	# kill coroutine otherwise
		322	Coro::terminate
		323	};
186		324
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	325	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	326	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	327	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	328	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	329	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		330	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	331	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		332
194	# we bless all objects into (empty) derived classes to force a method lookup	333	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	334	# within the Safe compartment.
196	for my $pkg (qw(	335	for my $pkg (qw(
197	cf::global cf::attachable	336	cf::global cf::attachable
198	cf::object cf::object::player	337	cf::object cf::object::player
199	cf::client cf::player	338	cf::client cf::player
200	cf::arch cf::living	339	cf::arch cf::living
		340	cf::map cf::mapspace
201	cf::map cf::party cf::region	341	cf::party cf::region
202	)) {	342	)) {
203	no strict 'refs';
204	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	343	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
205	}	344	}
206		345
207	$Event::DIED = sub {	346	$EV::DIED = sub {
208	warn "error in event callback: @_";	347	warn "error in event callback: $@";
209	};	348	};
		349
		350	#############################################################################
		351
		352	sub fork_call(&@);
		353	sub get_slot($;$$);
		354
		355	#############################################################################
210		356
211	=head2 UTILITY FUNCTIONS	357	=head2 UTILITY FUNCTIONS
212		358
213	=over 4	359	=over 4
214		360
…		…
233	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	379	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234	$d	380	$d
235	} || "[unable to dump $_[0]: '$@']";	381	} || "[unable to dump $_[0]: '$@']";
236	}	382	}
237		383
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working	384	=item $scalar = cf::load_file $path
239		385
		386	Loads the given file from path and returns its contents. Croaks on error
		387	and can block.
		388
		389	=cut
		390
		391	sub load_file($) {
		392	0 <= aio_load $_[0], my $data
		393	or Carp::croak "$_[0]: $!";
		394
		395	$data
		396	}
		397
		398	=item $success = cf::replace_file $path, $data, $sync
		399
		400	Atomically replaces the file at the given $path with new $data, and
		401	optionally $sync the data to disk before replacing the file.
		402
		403	=cut
		404
		405	sub replace_file($$;$) {
		406	my ($path, $data, $sync) = @_;
		407
		408	my $lock = cf::lock_acquire ("replace_file:$path");
		409
		410	my $fh = aio_open "$path~", Fcntl::O_WRONLY | Fcntl::O_CREAT | Fcntl::O_TRUNC, 0644
		411	or return;
		412
		413	$data = $data->() if ref $data;
		414
		415	length $data == aio_write $fh, 0, (length $data), $data, 0
		416	or return;
		417
		418	!$sync
		419	or !aio_fsync $fh
		420	or return;
		421
		422	aio_close $fh
		423	and return;
		424
		425	aio_rename "$path~", $path
		426	and return;
		427
		428	if ($sync) {
		429	$path =~ s%/[^/]*$%%;
		430	aio_pathsync $path;
		431	}
		432
		433	1
		434	}
		435
240	=item $ref = cf::from_json $json	436	=item $ref = cf::decode_json $json
241		437
242	Converts a JSON string into the corresponding perl data structure.	438	Converts a JSON string into the corresponding perl data structure.
243		439
244	=item $json = cf::to_json $ref	440	=item $json = cf::encode_json $ref
245		441
246	Converts a perl data structure into its JSON representation.	442	Converts a perl data structure into its JSON representation.
247		443
		444	=cut
		445
		446	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		447
		448	sub encode_json($) { $json_coder->encode ($_[0]) }
		449	sub decode_json($) { $json_coder->decode ($_[0]) }
		450
		451	=item $ref = cf::decode_storable $scalar
		452
		453	Same as Coro::Storable::thaw, so blocks.
		454
		455	=cut
		456
		457	BEGIN { *decode_storable = \&Coro::Storable::thaw }
		458
		459	=item $ref = cf::decode_yaml $scalar
		460
		461	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
		462
		463	=cut
		464
		465	sub decode_yaml($) {
		466	fork_call { YAML::XS::Load $_[0] } @_
		467	}
		468
		469	=item $scalar = cf::unlzf $scalar
		470
		471	Same as Compress::LZF::compress, but takes server ticks into account, so
		472	blocks.
		473
		474	=cut
		475
		476	sub unlzf($) {
		477	# we assume 100mb/s minimum decompression speed (noncompressible data on a ~2ghz machine)
		478	cf::get_slot +(length $_[0]) / 100_000_000, 0, "unlzf";
		479	Compress::LZF::decompress $_[0]
		480	}
		481
		482	=item cf::post_init { BLOCK }
		483
		484	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
		485	but I<before> the server starts ticking again.
		486
		487	The codeblock will have a single boolean argument to indicate whether this
		488	is a reload or not.
		489
		490	=cut
		491
		492	sub post_init(&) {
		493	push @POST_INIT, shift;
		494	}
		495
		496	sub _post_init {
		497	trace "running post_init jobs";
		498
		499	# run them in parallel...
		500
		501	my @join;
		502
		503	while () {
		504	push @join, map &Coro::async ($_, 0), @POST_INIT;
		505	@POST_INIT = ();
		506
		507	@join or last;
		508
		509	(pop @join)->join;
		510	}
		511	}
		512
248	=item cf::lock_wait $string	513	=item cf::lock_wait $string
249		514
250	Wait until the given lock is available. See cf::lock_acquire.	515	Wait until the given lock is available. See cf::lock_acquire.
251		516
252	=item my $lock = cf::lock_acquire $string	517	=item my $lock = cf::lock_acquire $string
253		518
254	Wait until the given lock is available and then acquires it and returns	519	Wait until the given lock is available and then acquires it and returns
255	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	520	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
256	for example when the coroutine gets canceled), the lock is automatically	521	for example when the coroutine gets canceled), the lock is automatically
257	returned.	522	returned.
258		523
		524	Locks are *not* recursive, locking from the same coro twice results in a
		525	deadlocked coro.
		526
259	Lock names should begin with a unique identifier (for example, cf::map::find	527	Lock names should begin with a unique identifier (for example, cf::map::find
260	uses map_find and cf::map::load uses map_load).	528	uses map_find and cf::map::load uses map_load).
261		529
262	=item $locked = cf::lock_active $string	530	=item $locked = cf::lock_active $string
263		531
264	Return true if the lock is currently active, i.e. somebody has locked it.	532	Return true if the lock is currently active, i.e. somebody has locked it.
265		533
266	=cut	534	=cut
267		535
268	our %LOCK;	536	our $LOCKS = new Coro::SemaphoreSet;
269		537
270	sub lock_wait($) {	538	sub lock_wait($) {
271	my ($key) = @_;	539	$LOCKS->wait ($_[0]);
272
273	# wait for lock, if any
274	while ($LOCK{$key}) {
275	push @{ $LOCK{$key} }, $Coro::current;
276	Coro::schedule;
277	}
278	}	540	}
279		541
280	sub lock_acquire($) {	542	sub lock_acquire($) {
281	my ($key) = @_;	543	$LOCKS->guard ($_[0])
282
283	# wait, to be sure we are not locked
284	lock_wait $key;
285
286	$LOCK{$key} = [];
287
288	Coro::guard {
289	# wake up all waiters, to be on the safe side
290	$_->ready for @{ delete $LOCK{$key} };
291	}
292	}	544	}
293		545
294	sub lock_active($) {	546	sub lock_active($) {
295	my ($key) = @_;	547	$LOCKS->count ($_[0]) < 1
296
297	! ! $LOCK{$key}
298	}	548	}
299		549
300	sub freeze_mainloop {	550	sub freeze_mainloop {
301	return unless $TICK_WATCHER->is_active;	551	tick_inhibit_inc;
302		552
303	my $guard = Coro::guard {	553	&Guard::guard (\&tick_inhibit_dec);
304	$TICK_WATCHER->start;	554	}
		555
		556	=item cf::periodic $interval, $cb
		557
		558	Like EV::periodic, but randomly selects a starting point so that the actions
		559	get spread over time.
		560
		561	=cut
		562
		563	sub periodic($$) {
		564	my ($interval, $cb) = @_;
		565
		566	my $start = rand List::Util::min 180, $interval;
		567
		568	EV::periodic $start, $interval, 0, $cb
		569	}
		570
		571	=item cf::get_slot $time[, $priority[, $name]]
		572
		573	Allocate $time seconds of blocking CPU time at priority C<$priority>
		574	(default: 0): This call blocks and returns only when you have at least
		575	C<$time> seconds of cpu time till the next tick. The slot is only valid
		576	till the next cede.
		577
		578	Background jobs should use a priority less than zero, interactive jobs
		579	should use 100 or more.
		580
		581	The optional C<$name> can be used to identify the job to run. It might be
		582	used for statistical purposes and should identify the same time-class.
		583
		584	Useful for short background jobs.
		585
		586	=cut
		587
		588	our @SLOT_QUEUE;
		589	our $SLOT_QUEUE;
		590	our $SLOT_DECAY = 0.9;
		591
		592	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		593	$SLOT_QUEUE = Coro::async {
		594	$Coro::current->desc ("timeslot manager");
		595
		596	my $signal = new Coro::Signal;
		597	my $busy;
		598
		599	while () {
		600	next_job:
		601
		602	my $avail = cf::till_tick;
		603
		604	for (0 .. $#SLOT_QUEUE) {
		605	if ($SLOT_QUEUE[$_][0] <= $avail) {
		606	$busy = 0;
		607	my $job = splice @SLOT_QUEUE, $_, 1, ();
		608	$job->[2]->send;
		609	Coro::cede;
		610	goto next_job;
		611	} else {
		612	$SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
		613	}
		614	}
		615
		616	if (@SLOT_QUEUE) {
		617	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		618	$WAIT_FOR_TICK->wait;
		619	} else {
		620	$busy = 0;
		621	Coro::schedule;
		622	}
305	};	623	}
306	$TICK_WATCHER->stop;	624	};
307	$guard	625
		626	sub get_slot($;$$) {
		627	return if tick_inhibit || $Coro::current == $Coro::main;
		628
		629	my ($time, $pri, $name) = @_;
		630
		631	$time = clamp $time, 0.01, $TICK * .6;
		632
		633	my $sig = new Coro::Signal;
		634
		635	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		636	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		637	$SLOT_QUEUE->ready;
		638	$sig->wait;
308	}	639	}
309		640
310	=item cf::async { BLOCK }	641	=item cf::async { BLOCK }
311		642
312	Currently the same as Coro::async_pool, meaning you cannot use	643	Currently the same as Coro::async_pool, meaning you cannot use
…		…
317		648
318	BEGIN { *async = \&Coro::async_pool }	649	BEGIN { *async = \&Coro::async_pool }
319		650
320	=item cf::sync_job { BLOCK }	651	=item cf::sync_job { BLOCK }
321		652
322	The design of crossfire+ requires that the main coro ($Coro::main) is	653	The design of Deliantra requires that the main coroutine ($Coro::main)
323	always able to handle events or runnable, as crossfire+ is only partly	654	is always able to handle events or runnable, as Deliantra is only
324	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	655	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		656	acceptable.
325		657
326	If it must be done, put the blocking parts into C<sync_job>. This will run	658	If it must be done, put the blocking parts into C<sync_job>. This will run
327	the given BLOCK in another coroutine while waiting for the result. The	659	the given BLOCK in another coroutine while waiting for the result. The
328	server will be frozen during this time, so the block should either finish	660	server will be frozen during this time, so the block should either finish
329	fast or be very important.	661	fast or be very important.
…		…
331	=cut	663	=cut
332		664
333	sub sync_job(&) {	665	sub sync_job(&) {
334	my ($job) = @_;	666	my ($job) = @_;
335		667
336	if ($Coro::current == $Coro::main) {	668	if (in_main) {
337	my $time = Event::time;	669	my $time = AE::time;
338		670
339	# this is the main coro, too bad, we have to block	671	# this is the main coro, too bad, we have to block
340	# till the operation succeeds, freezing the server :/	672	# till the operation succeeds, freezing the server :/
341		673
342	# TODO: use suspend/resume instead	674	#LOG llevError, Carp::longmess "sync job";#d#
343	# (but this is cancel-safe)	675
344	my $freeze_guard = freeze_mainloop;	676	my $freeze_guard = freeze_mainloop;
345		677
346	my $busy = 1;	678	my $busy = 1;
347	my @res;	679	my @res;
348		680
349	(async {	681	(async {
		682	$Coro::current->desc ("sync job coro");
350	@res = eval { $job->() };	683	@res = eval { $job->() };
351	warn $@ if $@;	684	error $@ if $@;
352	undef $busy;	685	undef $busy;
353	})->prio (Coro::PRIO_MAX);	686	})->prio (Coro::PRIO_MAX);
354		687
355	while ($busy) {	688	while ($busy) {
356	Coro::cede or Event::one_event;	689	if (Coro::nready) {
		690	Coro::cede_notself;
		691	} else {
		692	EV::loop EV::LOOP_ONESHOT;
357	}	693	}
		694	}
358		695
359	$time = Event::time - $time;	696	my $time = AE::time - $time;
360		697
361	LOG llevError | logBacktrace, Carp::longmess "long sync job"
362	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
363
364	$tick_start += $time; # do not account sync jobs to server load	698	$TICK_START += $time; # do not account sync jobs to server load
365		699
366	wantarray ? @res : $res[0]	700	wantarray ? @res : $res[0]
367	} else {	701	} else {
368	# we are in another coroutine, how wonderful, everything just works	702	# we are in another coroutine, how wonderful, everything just works
369		703
…		…
389	$EXT_CORO{$coro+0} = $coro;	723	$EXT_CORO{$coro+0} = $coro;
390		724
391	$coro	725	$coro
392	}	726	}
393		727
394	sub write_runtime {	728	=item fork_call { }, @args
395	my $runtime = "$LOCALDIR/runtime";
396		729
397	# first touch the runtime file to show we are still running:	730	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	731	process, returning the results. Everything must be serialisable with
		732	Coro::Storable. May, of course, block. Note that the executed sub may
		733	never block itself or use any form of event handling.
399		734
400	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	735	=cut
401	utime undef, undef, $fh;	736
		737	sub post_fork {
		738	reset_signals;
		739	}
		740
		741	sub fork_call(&@) {
		742	my ($cb, @args) = @_;
		743
		744	my @res = Coro::Util::fork_eval {
		745	cf::post_fork;
		746	&$cb
		747	} @args;
		748
		749	wantarray ? @res : $res[-1]
		750	}
		751
		752	sub objinfo {
		753	(
		754	"counter value" => cf::object::object_count,
		755	"objects created" => cf::object::create_count,
		756	"objects destroyed" => cf::object::destroy_count,
		757	"freelist size" => cf::object::free_count,
		758	"allocated objects" => cf::object::objects_size,
		759	"active objects" => cf::object::actives_size,
		760	)
		761	}
		762
		763	=item $coin = coin_from_name $name
		764
		765	=cut
		766
		767	our %coin_alias = (
		768	"silver" => "silvercoin",
		769	"silvercoin" => "silvercoin",
		770	"silvercoins" => "silvercoin",
		771	"gold" => "goldcoin",
		772	"goldcoin" => "goldcoin",
		773	"goldcoins" => "goldcoin",
		774	"platinum" => "platinacoin",
		775	"platinumcoin" => "platinacoin",
		776	"platinumcoins" => "platinacoin",
		777	"platina" => "platinacoin",
		778	"platinacoin" => "platinacoin",
		779	"platinacoins" => "platinacoin",
		780	"royalty" => "royalty",
		781	"royalties" => "royalty",
		782	);
		783
		784	sub coin_from_name($) {
		785	$coin_alias{$_[0]}
		786	? cf::arch::find $coin_alias{$_[0]}
		787	: undef
		788	}
		789
		790	=item $value = cf::db_get $family => $key
		791
		792	Returns a single value from the environment database.
		793
		794	=item cf::db_put $family => $key => $value
		795
		796	Stores the given C<$value> in the family. It can currently store binary
		797	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		798
		799	=item $db = cf::db_table "name"
		800
		801	Create and/or open a new database table. The string must not be "db" and must be unique
		802	within each server.
		803
		804	=cut
		805
		806	sub db_table($) {
		807	cf::error "db_get called from main context"
		808	if $Coro::current == $Coro::main;
		809
		810	my ($name) = @_;
		811	my $db = BDB::db_create $DB_ENV;
		812
		813	eval {
		814	$db->set_flags (BDB::CHKSUM);
		815
		816	utf8::encode $name;
		817	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		818	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		819	cf::cleanup "db_open(db): $!" if $!;
402	}	820	};
		821	cf::cleanup "db_open(db): $@" if $@;
403		822
404	my $guard = cf::lock_acquire "write_runtime";	823	$db
		824	}
405		825
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	826	our $DB;
407	or return;
408		827
409	my $value = $cf::RUNTIME + 90 + 10;	828	sub db_init {
410	# 10 is the runtime save interval, for a monotonic clock	829	$DB ||= db_table "db";
411	# 60 allows for the watchdog to kill the server.	830	}
412		831
413	(aio_write $fh, 0, (length $value), $value, 0) <= 0	832	sub db_get($$) {
414	and return;	833	my $key = "$_[0]/$_[1]";
415		834
416	# always fsync - this file is important	835	cf::error "db_get called from main context"
417	aio_fsync $fh	836	if $Coro::current == $Coro::main;
418	and return;
419		837
420	# touch it again to show we are up-to-date	838	BDB::db_get $DB, undef, $key, my $data;
421	utime undef, undef, $fh;
422		839
423	close $fh	840	$! ? ()
424	or return;	841	: $data
		842	}
425		843
426	aio_rename "$runtime~", $runtime	844	sub db_put($$$) {
427	and return;	845	BDB::dbreq_pri 4;
		846	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		847	}
428		848
429	warn "runtime file written.\n";#d#	849	=item cf::cache $id => [$paths...], $processversion => $process
430		850
		851	Generic caching function that returns the value of the resource $id,
		852	caching and regenerating as required.
		853
		854	This function can block.
		855
		856	=cut
		857
		858	sub cache {
		859	my ($id, $src, $processversion, $process) = @_;
		860
		861	my $meta =
		862	join "\x00",
		863	$processversion,
		864	map {
		865	aio_stat $_
		866	and Carp::croak "$_: $!";
		867
		868	($_, (stat _)[7,9])
		869	} @$src;
		870
		871	my $dbmeta = db_get cache => "$id/meta";
		872	if ($dbmeta ne $meta) {
		873	# changed, we may need to process
		874
		875	my @data;
		876	my $md5;
		877
		878	for (0 .. $#$src) {
		879	$data[$_] = load_file $src->[$_];
		880	}
		881
		882	# if processing is expensive, check
		883	# checksum first
		884	if (1) {
		885	$md5 =
		886	join "\x00",
		887	$processversion,
		888	map {
		889	cf::cede_to_tick;
		890	($src->[$_], Digest::MD5::md5_hex $data[$_])
		891	} 0.. $#$src;
		892
		893
		894	my $dbmd5 = db_get cache => "$id/md5";
		895	if ($dbmd5 eq $md5) {
		896	db_put cache => "$id/meta", $meta;
		897
		898	return db_get cache => "$id/data";
		899	}
		900	}
		901
		902	my $t1 = EV::time;
		903	my $data = $process->(\@data);
		904	my $t2 = EV::time;
		905
		906	info "cache: '$id' processed in ", $t2 - $t1, "s\n";
		907
		908	db_put cache => "$id/data", $data;
		909	db_put cache => "$id/md5" , $md5;
		910	db_put cache => "$id/meta", $meta;
		911
		912	return $data;
431	1	913	}
		914
		915	db_get cache => "$id/data"
432	}	916	}
433		917
434	=item cf::datalog type => key => value, ...	918	=item cf::datalog type => key => value, ...
435		919
436	Log a datalog packet of the given type with the given key-value pairs.	920	Log a datalog packet of the given type with the given key-value pairs.
437		921
438	=cut	922	=cut
439		923
440	sub datalog($@) {	924	sub datalog($@) {
441	my ($type, %kv) = @_;	925	my ($type, %kv) = @_;
442	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });	926	info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
443	}	927	}
444		928
445	=back	929	=back
446		930
447	=cut	931	=cut
448		932
449	#############################################################################	933	#############################################################################
450		934
451	=head2 ATTACHABLE OBJECTS	935	=head2 ATTACHABLE OBJECTS
452		936
453	Many objects in crossfire are so-called attachable objects. That means you can	937	Many objects in deliantra are so-called attachable objects. That means you can
454	attach callbacks/event handlers (a collection of which is called an "attachment")	938	attach callbacks/event handlers (a collection of which is called an "attachment")
455	to it. All such attachable objects support the following methods.	939	to it. All such attachable objects support the following methods.
456		940
457	In the following description, CLASS can be any of C<global>, C<object>	941	In the following description, CLASS can be any of C<global>, C<object>
458	C<player>, C<client> or C<map> (i.e. the attachable objects in	942	C<player>, C<client> or C<map> (i.e. the attachable objects in
459	crossfire+).	943	Deliantra).
460		944
461	=over 4	945	=over 4
462		946
463	=item $attachable->attach ($attachment, key => $value...)	947	=item $attachable->attach ($attachment, key => $value...)
464		948
…		…
508	=item cf::CLASS::attachment $name, ...	992	=item cf::CLASS::attachment $name, ...
509		993
510	Register an attachment by C<$name> through which attachable objects of the	994	Register an attachment by C<$name> through which attachable objects of the
511	given CLASS can refer to this attachment.	995	given CLASS can refer to this attachment.
512		996
513	Some classes such as crossfire maps and objects can specify attachments	997	Some classes such as deliantra maps and objects can specify attachments
514	that are attached at load/instantiate time, thus the need for a name.	998	that are attached at load/instantiate time, thus the need for a name.
515		999
516	These calls expect any number of the following handler/hook descriptions:	1000	These calls expect any number of the following handler/hook descriptions:
517		1001
518	=over 4	1002	=over 4
…		…
642		1126
643	} elsif (exists $cb_id{$type}) {	1127	} elsif (exists $cb_id{$type}) {
644	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1128	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
645		1129
646	} elsif (ref $type) {	1130	} elsif (ref $type) {
647	warn "attaching objects not supported, ignoring.\n";	1131	error "attaching objects not supported, ignoring.\n";
648		1132
649	} else {	1133	} else {
650	shift @arg;	1134	shift @arg;
651	warn "attach argument '$type' not supported, ignoring.\n";	1135	error "attach argument '$type' not supported, ignoring.\n";
652	}	1136	}
653	}	1137	}
654	}	1138	}
655		1139
656	sub _object_attach {	1140	sub _object_attach {
…		…
666	_attach $registry, $klass, @attach;	1150	_attach $registry, $klass, @attach;
667	}	1151	}
668		1152
669	$obj->{$name} = \%arg;	1153	$obj->{$name} = \%arg;
670	} else {	1154	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	1155	info "object uses attachment '$name' which is not available, postponing.\n";
672	}	1156	}
673		1157
674	$obj->{_attachment}{$name} = undef;	1158	$obj->{_attachment}{$name} = undef;
675	}	1159	}
676		1160
…		…
716	";	1200	";
717	die if $@;	1201	die if $@;
718	}	1202	}
719		1203
720	our $override;	1204	our $override;
721	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	1205	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
722		1206
723	sub override {	1207	sub override {
724	$override = 1;	1208	$override = 1;
725	@invoke_results = ();	1209	@INVOKE_RESULTS = (@_);
726	}	1210	}
727		1211
728	sub do_invoke {	1212	sub do_invoke {
729	my $event = shift;	1213	my $event = shift;
730	my $callbacks = shift;	1214	my $callbacks = shift;
731		1215
732	@invoke_results = ();	1216	@INVOKE_RESULTS = ();
733		1217
734	local $override;	1218	local $override;
735		1219
736	for (@$callbacks) {	1220	for (@$callbacks) {
737	eval { &{$_->[1]} };	1221	eval { &{$_->[1]} };
738		1222
739	if ($@) {	1223	if ($@) {
740	warn "$@";
741	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1224	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
742	override;	1225	override;
743	}	1226	}
744		1227
745	return 1 if $override;	1228	return 1 if $override;
746	}	1229	}
747		1230
748	0	1231	0
749	}	1232	}
750		1233
751	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
752		1235
753	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1236	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
754		1237
755	Generate an object-specific event with the given arguments.	1238	Generate an object-specific event with the given arguments.
756		1239
757	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1240	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
758	removed in future versions), and there is no public API to access override	1241	removed in future versions), and there is no public API to access override
759	results (if you must, access C<@cf::invoke_results> directly).	1242	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760		1243
761	=back	1244	=back
762		1245
763	=cut	1246	=cut
764		1247
765	#############################################################################	1248	#############################################################################
766	# object support	1249	# object support
		1250
		1251	sub _object_equal($$);
		1252	sub _object_equal($$) {
		1253	my ($a, $b) = @_;
		1254
		1255	return 0 unless (ref $a) eq (ref $b);
		1256
		1257	if ("HASH" eq ref $a) {
		1258	my @ka = keys %$a;
		1259	my @kb = keys %$b;
		1260
		1261	return 0 if @ka != @kb;
		1262
		1263	for (0 .. $#ka) {
		1264	return 0 unless $ka[$_] eq $kb[$_];
		1265	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1266	}
		1267
		1268	} elsif ("ARRAY" eq ref $a) {
		1269
		1270	return 0 if @$a != @$b;
		1271
		1272	for (0 .. $#$a) {
		1273	return 0 unless _object_equal $a->[$_], $b->[$_];
		1274	}
		1275
		1276	} elsif ($a ne $b) {
		1277	return 0;
		1278	}
		1279
		1280	1
		1281	}
		1282
		1283	our $SLOW_MERGES;#d#
		1284	sub _can_merge {
		1285	my ($ob1, $ob2) = @_;
		1286
		1287	++$SLOW_MERGES;#d#
		1288
		1289	# we do the slow way here
		1290	return _object_equal $ob1, $ob2
		1291	}
767		1292
768	sub reattach {	1293	sub reattach {
769	# basically do the same as instantiate, without calling instantiate	1294	# basically do the same as instantiate, without calling instantiate
770	my ($obj) = @_;	1295	my ($obj) = @_;
771		1296
		1297	# no longer needed after getting rid of delete_package?
772	bless $obj, ref $obj; # re-bless in case extensions have been reloaded	1298	#bless $obj, ref $obj; # re-bless in case extensions have been reloaded
773		1299
774	my $registry = $obj->registry;	1300	my $registry = $obj->registry;
775		1301
776	@$registry = ();	1302	@$registry = ();
777		1303
…		…
782	for (@$attach) {	1308	for (@$attach) {
783	my ($klass, @attach) = @$_;	1309	my ($klass, @attach) = @$_;
784	_attach $registry, $klass, @attach;	1310	_attach $registry, $klass, @attach;
785	}	1311	}
786	} else {	1312	} else {
787	warn "object uses attachment '$name' that is not available, postponing.\n";	1313	info "object uses attachment '$name' that is not available, postponing.\n";
788	}	1314	}
789	}	1315	}
790	}	1316	}
791		1317
792	cf::attachable->attach (	1318	cf::attachable->attach (
793	prio => -1000000,	1319	prio => -1000000,
794	on_instantiate => sub {	1320	on_instantiate => sub {
795	my ($obj, $data) = @_;	1321	my ($obj, $data) = @_;
796		1322
797	$data = from_json $data;	1323	$data = decode_json $data;
798		1324
799	for (@$data) {	1325	for (@$data) {
800	my ($name, $args) = @$_;	1326	my ($name, $args) = @$_;
801		1327
802	$obj->attach ($name, %{$args || {} });	1328	$obj->attach ($name, %{$args || {} });
…		…
818	sub object_freezer_save {	1344	sub object_freezer_save {
819	my ($filename, $rdata, $objs) = @_;	1345	my ($filename, $rdata, $objs) = @_;
820		1346
821	sync_job {	1347	sync_job {
822	if (length $$rdata) {	1348	if (length $$rdata) {
		1349	utf8::decode (my $decname = $filename);
823	warn sprintf "saving %s (%d,%d)\n",	1350	trace sprintf "saving %s (%d,%d)\n",
824	$filename, length $$rdata, scalar @$objs;	1351	$decname, length $$rdata, scalar @$objs
		1352	if $VERBOSE_IO;
825		1353
826	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1354	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
827	chmod SAVE_MODE, $fh;	1355	aio_chmod $fh, SAVE_MODE;
828	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1356	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
829	aio_fsync $fh if $cf::USE_FSYNC;	1357	if ($cf::USE_FSYNC) {
		1358	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1359	aio_fsync $fh;
		1360	}
830	close $fh;	1361	aio_close $fh;
831		1362
832	if (@$objs) {	1363	if (@$objs) {
833	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1364	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
834	chmod SAVE_MODE, $fh;	1365	aio_chmod $fh, SAVE_MODE;
835	my $data = Storable::nfreeze { version => 1, objs => $objs };	1366	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
836	aio_write $fh, 0, (length $data), $data, 0;	1367	aio_write $fh, 0, (length $data), $data, 0;
837	aio_fsync $fh if $cf::USE_FSYNC;	1368	if ($cf::USE_FSYNC) {
		1369	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1370	aio_fsync $fh;
		1371	}
838	close $fh;	1372	aio_close $fh;
839	aio_rename "$filename.pst~", "$filename.pst";	1373	aio_rename "$filename.pst~", "$filename.pst";
840	}	1374	}
841	} else {	1375	} else {
842	aio_unlink "$filename.pst";	1376	aio_unlink "$filename.pst";
843	}	1377	}
844		1378
845	aio_rename "$filename~", $filename;	1379	aio_rename "$filename~", $filename;
		1380
		1381	$filename =~ s%/[^/]+$%%;
		1382	aio_pathsync $filename if $cf::USE_FSYNC;
846	} else {	1383	} else {
847	warn "FATAL: $filename~: $!\n";	1384	error "unable to save objects: $filename~: $!\n";
848	}	1385	}
849	} else {	1386	} else {
850	aio_unlink $filename;	1387	aio_unlink $filename;
851	aio_unlink "$filename.pst";	1388	aio_unlink "$filename.pst";
852	}	1389	}
853	}	1390	};
854	}	1391	}
855		1392
856	sub object_freezer_as_string {	1393	sub object_freezer_as_string {
857	my ($rdata, $objs) = @_;	1394	my ($rdata, $objs) = @_;
858		1395
…		…
870	or return;	1407	or return;
871		1408
872	unless (aio_stat "$filename.pst") {	1409	unless (aio_stat "$filename.pst") {
873	(aio_load "$filename.pst", $av) >= 0	1410	(aio_load "$filename.pst", $av) >= 0
874	or return;	1411	or return;
		1412
875	$av = eval { (Storable::thaw $av)->{objs} };	1413	my $st = eval { Coro::Storable::thaw $av };
		1414	$av = $st->{objs};
876	}	1415	}
877		1416
		1417	utf8::decode (my $decname = $filename);
878	warn sprintf "loading %s (%d)\n",	1418	trace sprintf "loading %s (%d,%d)\n",
879	$filename, length $data, scalar @{$av || []};#d#	1419	$decname, length $data, scalar @{$av || []}
		1420	if $VERBOSE_IO;
		1421
880	return ($data, $av);	1422	($data, $av)
881	}	1423	}
		1424
		1425	=head2 COMMAND CALLBACKS
		1426
		1427	=over 4
		1428
		1429	=cut
882		1430
883	#############################################################################	1431	#############################################################################
884	# command handling &c	1432	# command handling &c
885		1433
886	=item cf::register_command $name => \&callback($ob,$args);	1434	=item cf::register_command $name => \&callback($ob,$args)
887		1435
888	Register a callback for execution when the client sends the user command	1436	Register a callback for execution when the client sends the user command
889	$name.	1437	$name.
890		1438
891	=cut	1439	=cut
…		…
897	#warn "registering command '$name/$time' to '$caller'";	1445	#warn "registering command '$name/$time' to '$caller'";
898		1446
899	push @{ $COMMAND{$name} }, [$caller, $cb];	1447	push @{ $COMMAND{$name} }, [$caller, $cb];
900	}	1448	}
901		1449
902	=item cf::register_extcmd $name => \&callback($pl,$packet);	1450	=item cf::register_extcmd $name => \&callback($pl,@args)
903		1451
904	Register a callbackf ro execution when the client sends an extcmd packet.	1452	Register a callback for execution when the client sends an (synchronous)
		1453	extcmd packet. Ext commands will be processed in the order they are
		1454	received by the server, like other user commands. The first argument is
		1455	the logged-in player. Ext commands can only be processed after a player
		1456	has logged in successfully.
905		1457
906	If the callback returns something, it is sent back as if reply was being	1458	The values will be sent back to the client.
907	called.
908		1459
909	=cut	1460	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
910		1461
		1462	Same as C<cf::register_extcmd>, but instead of returning values, the
		1463	callback needs to clal the C<$reply> function.
		1464
		1465	=item cf::register_exticmd $name => \&callback($ns,@args)
		1466
		1467	Register a callback for execution when the client sends an (asynchronous)
		1468	exticmd packet. Exti commands are processed by the server as soon as they
		1469	are received, i.e. out of order w.r.t. other commands. The first argument
		1470	is a client socket. Exti commands can be received anytime, even before
		1471	log-in.
		1472
		1473	The values will be sent back to the client.
		1474
		1475	=item cf::register_async_exticmd $name => \&callback($ns,$reply->(...),@args)
		1476
		1477	Same as C<cf::register_extcmd>, but instead of returning values, the
		1478	callback needs to clal the C<$reply> function.
		1479
		1480	=cut
		1481
911	sub register_extcmd {	1482	sub register_extcmd($$) {
912	my ($name, $cb) = @_;	1483	my ($name, $cb) = @_;
913		1484
914	$EXTCMD{$name} = $cb;	1485	$EXTCMD{$name} = $cb;
915	}	1486	}
916		1487
		1488	sub register_async_extcmd($$) {
		1489	my ($name, $cb) = @_;
		1490
		1491	$EXTACMD{$name} = $cb;
		1492	}
		1493
		1494	sub register_exticmd($$) {
		1495	my ($name, $cb) = @_;
		1496
		1497	$EXTICMD{$name} = $cb;
		1498	}
		1499
		1500	sub register_async_exticmd($$) {
		1501	my ($name, $cb) = @_;
		1502
		1503	$EXTIACMD{$name} = $cb;
		1504	}
		1505
		1506	use File::Glob ();
		1507
917	cf::player->attach (	1508	cf::player->attach (
918	on_command => sub {	1509	on_unknown_command => sub {
919	my ($pl, $name, $params) = @_;	1510	my ($pl, $name, $params) = @_;
920		1511
921	my $cb = $COMMAND{$name}	1512	my $cb = $COMMAND{$name}
922	or return;	1513	or return;
923		1514
…		…
928	cf::override;	1519	cf::override;
929	},	1520	},
930	on_extcmd => sub {	1521	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1522	my ($pl, $buf) = @_;
932		1523
933	my $msg = eval { from_json $buf };	1524	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1525
935	if (ref $msg) {	1526	if (ref $msg) {
		1527	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1528
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1529	if (my $cb = $EXTACMD{$type}) {
937	if (my %reply = $cb->($pl, $msg)) {	1530	$cb->(
938	$pl->ext_reply ($msg->{msgid}, %reply);	1531	$pl,
		1532	sub {
		1533	$pl->ext_msg ("reply-$reply", @_)
		1534	if $reply;
		1535	},
		1536	@payload
		1537	);
		1538	} else {
		1539	my @reply;
		1540
		1541	if (my $cb = $EXTCMD{$type}) {
		1542	@reply = $cb->($pl, @payload);
939	}	1543	}
		1544
		1545	$pl->ext_msg ("reply-$reply", @reply)
		1546	if $reply;
940	}	1547	}
		1548
941	} else {	1549	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1550	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943	}	1551	}
944		1552
945	cf::override;	1553	cf::override;
946	},	1554	},
947	);	1555	);
948		1556
		1557	# "readahead" all extensions
949	sub load_extension {	1558	sub cache_extensions {
950	my ($path) = @_;	1559	my $grp = IO::AIO::aio_group;
951		1560
952	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1561	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
953	my $base = $1;	1562	for (grep /\.ext$/, @{$_[0]}) {
954	my $pkg = $1;	1563	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
955	$pkg =~ s/[^[:word:]]/_/g;
956	$pkg = "ext::$pkg";
957
958	warn "... loading '$path' into '$pkg'\n";
959
960	open my $fh, "<:utf8", $path
961	or die "$path: $!";
962
963	my $source =
964	"package $pkg; use strict; use utf8;\n"
965	. "#line 1 \"$path\"\n{\n"
966	. (do { local $/; <$fh> })
967	. "\n};\n1";
968
969	unless (eval $source) {
970	my $msg = $@ ? "$path: $@\n"
971	: "extension disabled.\n";
972	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973	warn $@;
974	warn "mandatory extension failed to load, exiting.\n";
975	exit 1;
976	}	1564	}
977	die $@;
978	}	1565	};
979		1566
980	push @EXTS, $pkg;	1567	$grp
		1568	}
		1569
		1570	sub _ext_cfg_reg($$$$) {
		1571	my ($rvar, $varname, $cfgname, $default) = @_;
		1572
		1573	$cfgname = lc $varname
		1574	unless length $cfgname;
		1575
		1576	$EXT_CFG{$cfgname} = [$rvar, $default];
		1577
		1578	$$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
981	}	1579	}
982		1580
983	sub load_extensions {	1581	sub load_extensions {
		1582	info "loading extensions...";
		1583
		1584	%EXT_CFG = ();
		1585
		1586	cf::sync_job {
		1587	my %todo;
		1588
984	for my $ext (<$LIBDIR/*.ext>) {	1589	for my $path (<$LIBDIR/*.ext>) {
985	next unless -r $ext;	1590	next unless -r $path;
986	eval {	1591
987	load_extension $ext;	1592	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1593	my $base = $1;
		1594	my $pkg = $1;
		1595	$pkg =~ s/[^[:word:]]/_/g;
		1596	$pkg = "ext::$pkg";
		1597
		1598	open my $fh, "<:utf8", $path
		1599	or die "$path: $!";
		1600
		1601	my $source = do { local $/; <$fh> };
		1602
		1603	my %ext = (
		1604	path => $path,
		1605	base => $base,
		1606	pkg => $pkg,
		1607	);
		1608
		1609	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1610	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1611
		1612	$ext{source} =
		1613	"package $pkg; use common::sense;\n"
		1614	. "#line 1 \"$path\"\n{\n"
		1615	. $source
		1616	. "\n};\n1";
		1617
		1618	$todo{$base} = \%ext;
		1619	}
		1620
		1621	my $pass = 0;
		1622	my %done;
		1623	while (%todo) {
		1624	my $progress;
		1625
		1626	++$pass;
		1627
		1628	ext:
		1629	while (my ($k, $v) = each %todo) {
		1630	for (split /,\s*/, $v->{meta}{depends}) {
		1631	next ext
		1632	unless exists $done{$_};
		1633	}
		1634
		1635	trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
		1636
		1637	my $source = $v->{source};
		1638
		1639	# support "CONF varname :confname = default" pseudo-statements
		1640	$source =~ s{
		1641	^ CONF \s+ ([^\s:=]+) \s* (?:: \s* ([^\s:=]+) \s* )? = ([^\n#]+)
		1642	}{
		1643	"our \$$1; BEGIN { cf::_ext_cfg_reg \\\$$1, q\x00$1\x00, q\x00$2\x00, $3 }";
		1644	}gmxe;
		1645
		1646	my $active = eval $source;
		1647
		1648	if (length $@) {
		1649	error "$v->{path}: $@\n";
		1650
		1651	cf::cleanup "mandatory extension '$k' failed to load, exiting."
		1652	if exists $v->{meta}{mandatory};
		1653
		1654	warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
		1655	delete $todo{$k};
		1656	} else {
		1657	$done{$k} = delete $todo{$k};
		1658	push @EXTS, $v->{pkg};
		1659	$progress = 1;
		1660
		1661	info "$v->{base}: extension inactive.\n"
		1662	unless $active;
		1663	}
988	1	1664	}
989	} or warn "$ext not loaded: $@";	1665
		1666	unless ($progress) {
		1667	warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
		1668
		1669	while (my ($k, $v) = each %todo) {
		1670	cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
		1671	if exists $v->{meta}{mandatory};
		1672	}
		1673
		1674	last;
		1675	}
		1676	}
990	}	1677	};
991	}	1678	}
992		1679
993	#############################################################################	1680	#############################################################################
994		1681
		1682	=back
		1683
995	=head2 CORE EXTENSIONS	1684	=head2 CORE EXTENSIONS
996		1685
997	Functions and methods that extend core crossfire objects.	1686	Functions and methods that extend core deliantra objects.
998		1687
999	=cut	1688	=cut
1000		1689
1001	package cf::player;	1690	package cf::player;
1002		1691
1003	use Coro::AIO;	1692	use Coro::AIO;
1004		1693
1005	=head3 cf::player	1694	=head3 cf::player
1006		1695
1007	=over 4	1696	=over 4
		1697
		1698	=item cf::player::num_playing
		1699
		1700	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1701
		1702	=cut
		1703
		1704	sub num_playing {
		1705	scalar grep
		1706	$_->ob->map
		1707	&& !$_->hidden
		1708	&& !$_->ob->flag (cf::FLAG_WIZ),
		1709	cf::player::list
		1710	}
1008		1711
1009	=item cf::player::find $login	1712	=item cf::player::find $login
1010		1713
1011	Returns the given player object, loading it if necessary (might block).	1714	Returns the given player object, loading it if necessary (might block).
1012		1715
…		…
1031		1734
1032	sub exists($) {	1735	sub exists($) {
1033	my ($login) = @_;	1736	my ($login) = @_;
1034		1737
1035	$cf::PLAYER{$login}	1738	$cf::PLAYER{$login}
1036	or cf::sync_job { !aio_stat path $login }	1739	or !aio_stat path $login
1037	}	1740	}
1038		1741
1039	sub find($) {	1742	sub find($) {
1040	return $cf::PLAYER{$_[0]} || do {	1743	return $cf::PLAYER{$_[0]} || do {
1041	my $login = $_[0];	1744	my $login = $_[0];
…		…
1048	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1751	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1049	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1752	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1050	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1753	aio_unlink +(playerdir $login) . "/$login.pl.pst";
1051	aio_unlink +(playerdir $login) . "/$login.pl";	1754	aio_unlink +(playerdir $login) . "/$login.pl";
1052		1755
1053	my $pl = load_pl path $login	1756	my $f = new_from_file cf::object::thawer path $login
1054	or return;	1757	or return;
		1758
		1759	my $pl = cf::player::load_pl $f
		1760	or return;
		1761
		1762	local $cf::PLAYER_LOADING{$login} = $pl;
		1763	$f->resolve_delayed_derefs;
1055	$cf::PLAYER{$login} = $pl	1764	$cf::PLAYER{$login} = $pl
1056	}	1765	}
1057	}	1766	}
1058	}	1767	}
		1768
		1769	cf::player->attach (
		1770	on_load => sub {
		1771	my ($pl, $path) = @_;
		1772
		1773	# restore slots saved in save, below
		1774	my $slots = delete $pl->{_slots};
		1775
		1776	$pl->ob->current_weapon ($slots->[0]);
		1777	$pl->combat_ob ($slots->[1]);
		1778	$pl->ranged_ob ($slots->[2]);
		1779	},
		1780	);
1059		1781
1060	sub save($) {	1782	sub save($) {
1061	my ($pl) = @_;	1783	my ($pl) = @_;
1062		1784
1063	return if $pl->{deny_save};	1785	return if $pl->{deny_save};
…		…
1068	return if $pl->{deny_save};	1790	return if $pl->{deny_save};
1069		1791
1070	aio_mkdir playerdir $pl, 0770;	1792	aio_mkdir playerdir $pl, 0770;
1071	$pl->{last_save} = $cf::RUNTIME;	1793	$pl->{last_save} = $cf::RUNTIME;
1072		1794
		1795	cf::get_slot 0.01;
		1796
		1797	# save slots, to be restored later
		1798	local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
		1799
1073	$pl->save_pl ($path);	1800	$pl->save_pl ($path);
1074	Coro::cede;	1801	cf::cede_to_tick;
1075	}	1802	}
1076		1803
1077	sub new($) {	1804	sub new($) {
1078	my ($login) = @_;	1805	my ($login) = @_;
1079		1806
…		…
1085	$cf::PLAYER{$login} = $self;	1812	$cf::PLAYER{$login} = $self;
1086		1813
1087	$self	1814	$self
1088	}	1815	}
1089		1816
		1817	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1818
		1819	=cut
		1820
		1821	sub send_msg {
		1822	my $ns = shift->ns
		1823	or return;
		1824	$ns->send_msg (@_);
		1825	}
		1826
1090	=item $pl->quit_character	1827	=item $pl->quit_character
1091		1828
1092	Nukes the player without looking back. If logged in, the connection will	1829	Nukes the player without looking back. If logged in, the connection will
1093	be destroyed. May block for a long time.	1830	be destroyed. May block for a long time.
1094		1831
…		…
1098	my ($pl) = @_;	1835	my ($pl) = @_;
1099		1836
1100	my $name = $pl->ob->name;	1837	my $name = $pl->ob->name;
1101		1838
1102	$pl->{deny_save} = 1;	1839	$pl->{deny_save} = 1;
1103	$pl->password ("*"); # this should lock out the player until we nuked the dir	1840	$pl->password ("*"); # this should lock out the player until we have nuked the dir
1104		1841
1105	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1842	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1106	$pl->deactivate;	1843	$pl->deactivate;
		1844
		1845	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1107	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1846	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1847	ext::highscore::check ($pl->ob);
		1848
1108	$pl->ns->destroy if $pl->ns;	1849	$pl->ns->destroy if $pl->ns;
1109		1850
1110	my $path = playerdir $pl;	1851	my $path = playerdir $pl;
1111	my $temp = "$path~$cf::RUNTIME~deleting~";	1852	my $temp = "$path~$cf::RUNTIME~deleting~";
1112	aio_rename $path, $temp;	1853	aio_rename $path, $temp;
…		…
1147	or return [];	1888	or return [];
1148		1889
1149	my @logins;	1890	my @logins;
1150		1891
1151	for my $login (@$dirs) {	1892	for my $login (@$dirs) {
		1893	my $path = path $login;
		1894
		1895	# a .pst is a dead give-away for a valid player
		1896	# if no pst file found, open and chekc for blocked users
		1897	if (aio_stat "$path.pst") {
1152	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1898	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1153	aio_read $fh, 0, 512, my $buf, 0 or next;	1899	aio_read $fh, 0, 512, my $buf, 0 or next;
1154	$buf !~ /^password -------------$/m or next; # official not-valid tag	1900	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1901	}
1155		1902
1156	utf8::decode $login;	1903	utf8::decode $login;
1157	push @logins, $login;	1904	push @logins, $login;
1158	}	1905	}
1159		1906
1160	\@logins	1907	\@logins
1161	}	1908	}
1162		1909
1163	=item $player->maps	1910	=item $player->maps
		1911
		1912	=item cf::player::maps $login
1164		1913
1165	Returns an arrayref of map paths that are private for this	1914	Returns an arrayref of map paths that are private for this
1166	player. May block.	1915	player. May block.
1167		1916
1168	=cut	1917	=cut
…		…
1186	}	1935	}
1187		1936
1188	\@paths	1937	\@paths
1189	}	1938	}
1190		1939
1191	=item $player->ext_reply ($msgid, %msg)	1940	=item $protocol_xml = $player->expand_cfpod ($cfpod)
1192		1941
1193	Sends an ext reply to the player.	1942	Expand deliantra pod fragments into protocol xml.
1194		1943
1195	=cut
1196
1197	sub ext_reply($$%) {
1198	my ($self, $id, %msg) = @_;
1199
1200	$msg{msgid} = $id;
1201
1202	$self->send ("ext " . cf::to_json \%msg);
1203	}
1204
1205	=item $player->ext_event ($type, %msg)	1944	=item $player->ext_msg ($type, @msg)
1206		1945
1207	Sends an ext event to the client.	1946	Sends an ext event to the client.
1208		1947
1209	=cut	1948	=cut
1210		1949
1211	sub ext_event($$%) {	1950	sub ext_msg($$@) {
1212	my ($self, $type, %msg) = @_;	1951	my ($self, $type, @msg) = @_;
1213		1952
1214	$self->ns->ext_event ($type, %msg);	1953	$self->ns->ext_msg ($type, @msg);
1215	}	1954	}
1216		1955
1217	=head3 cf::region	1956	=head3 cf::region
1218		1957
1219	=over 4	1958	=over 4
…		…
1222		1961
1223	package cf::region;	1962	package cf::region;
1224		1963
1225	=item cf::region::find_by_path $path	1964	=item cf::region::find_by_path $path
1226		1965
1227	Tries to decuce the probable region for a map knowing only its path.	1966	Tries to decuce the likely region for a map knowing only its path.
1228		1967
1229	=cut	1968	=cut
1230		1969
1231	sub find_by_path($) {	1970	sub find_by_path($) {
1232	my ($path) = @_;	1971	my ($path) = @_;
1233		1972
		1973	$path =~ s/^~[^\/]*//; # skip ~login
		1974
1234	my ($match, $specificity);	1975	my ($match, $specificity);
1235		1976
1236	for my $region (list) {	1977	for my $region (list) {
1237	if ($region->match && $path =~ $region->match) {	1978	if ($region->{match} && $path =~ $region->{match}) {
1238	($match, $specificity) = ($region, $region->specificity)	1979	($match, $specificity) = ($region, $region->specificity)
1239	if $region->specificity > $specificity;	1980	if $region->specificity > $specificity;
1240	}	1981	}
1241	}	1982	}
1242		1983
…		…
1263	our $MAX_RESET = 3600;	2004	our $MAX_RESET = 3600;
1264	our $DEFAULT_RESET = 3000;	2005	our $DEFAULT_RESET = 3000;
1265		2006
1266	sub generate_random_map {	2007	sub generate_random_map {
1267	my ($self, $rmp) = @_;	2008	my ($self, $rmp) = @_;
1268	# mit "rum" bekleckern, nicht	2009
		2010	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		2011
1269	$self->_create_random_map (	2012	$self->_create_random_map ($rmp);
1270	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1271	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1272	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1273	$rmp->{exit_on_final_map},
1274	$rmp->{xsize}, $rmp->{ysize},
1275	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1276	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1277	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1278	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1279	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1280	(cf::region::find $rmp->{region}), $rmp->{custom}
1281	)
1282	}	2013	}
1283		2014
1284	=item cf::map->register ($regex, $prio)	2015	=item cf::map->register ($regex, $prio)
1285		2016
1286	Register a handler for the map path matching the given regex at the	2017	Register a handler for the map path matching the given regex at the
…		…
1291		2022
1292	sub register {	2023	sub register {
1293	my (undef, $regex, $prio) = @_;	2024	my (undef, $regex, $prio) = @_;
1294	my $pkg = caller;	2025	my $pkg = caller;
1295		2026
1296	no strict;
1297	push @{"$pkg\::ISA"}, __PACKAGE__;	2027	push @{"$pkg\::ISA"}, __PACKAGE__;
1298		2028
1299	$EXT_MAP{$pkg} = [$prio, qr<$regex>];	2029	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1300	}	2030	}
1301		2031
1302	# also paths starting with '/'	2032	# also paths starting with '/'
1303	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];	2033	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1304		2034
1305	sub thawer_merge {	2035	sub thawer_merge {
1306	my ($self, $merge) = @_;	2036	my ($self, $merge) = @_;
1307		2037
1308	# we have to keep some variables in memory intact	2038	# we have to keep some variables in memory intact
1309	local $self->{path};	2039	local $self->{path};
1310	local $self->{load_path};	2040	local $self->{load_path};
1311	local $self->{deny_save};
1312	local $self->{deny_reset};
1313		2041
1314	$self->SUPER::thawer_merge ($merge);	2042	$self->SUPER::thawer_merge ($merge);
1315	}	2043	}
1316		2044
1317	sub normalise {	2045	sub normalise {
1318	my ($path, $base) = @_;	2046	my ($path, $base) = @_;
1319		2047
1320	$path = "$path"; # make sure its a string	2048	$path = "$path"; # make sure it's a string
1321		2049
1322	$path =~ s/\.map$//;	2050	$path =~ s/\.map$//;
1323		2051
1324	# map plan:	2052	# map plan:
1325	#	2053	#
…		…
1340	$base =~ s{[^/]+/?$}{};	2068	$base =~ s{[^/]+/?$}{};
1341	$path = "$base/$path";	2069	$path = "$base/$path";
1342	}	2070	}
1343		2071
1344	for ($path) {	2072	for ($path) {
1345	redo if s{//}{/};
1346	redo if s{/\.?/}{/};	2073	redo if s{/\.?/}{/};
1347	redo if s{/[^/]+/\.\./}{/};	2074	redo if s{/[^/]+/\.\./}{/};
1348	}	2075	}
1349		2076
1350	$path	2077	$path
…		…
1364	$self->init; # pass $1 etc.	2091	$self->init; # pass $1 etc.
1365	return $self;	2092	return $self;
1366	}	2093	}
1367	}	2094	}
1368		2095
1369	Carp::carp "unable to resolve path '$path' (base '$base').";	2096	Carp::cluck "unable to resolve path '$path' (base '$base')";
1370	()	2097	()
1371	}	2098	}
1372		2099
		2100	# may re-bless or do other evil things
1373	sub init {	2101	sub init {
1374	my ($self) = @_;	2102	my ($self) = @_;
1375		2103
1376	$self	2104	$self
1377	}	2105	}
…		…
1396		2124
1397	# the temporary/swap location	2125	# the temporary/swap location
1398	sub save_path {	2126	sub save_path {
1399	my ($self) = @_;	2127	my ($self) = @_;
1400		2128
1401	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2129	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1402	"$TMPDIR/$path.map"	2130	"$TMPDIR/$path.map"
1403	}	2131	}
1404		2132
1405	# the unique path, undef == no special unique path	2133	# the unique path, undef == no special unique path
1406	sub uniq_path {	2134	sub uniq_path {
1407	my ($self) = @_;	2135	my ($self) = @_;
1408		2136
1409	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2137	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1410	"$UNIQUEDIR/$path"	2138	"$UNIQUEDIR/$path"
1411	}	2139	}
1412		2140
1413	# and all this just because we cannot iterate over	2141	sub decay_objects {
1414	# all maps in C++...
1415	sub change_all_map_light {
1416	my ($change) = @_;	2142	my ($self) = @_;
1417		2143
1418	$_->change_map_light ($change)	2144	return if $self->{deny_reset};
1419	for grep $_->outdoor, values %cf::MAP;	2145
		2146	$self->do_decay_objects;
1420	}	2147	}
1421		2148
1422	sub unlink_save {	2149	sub unlink_save {
1423	my ($self) = @_;	2150	my ($self) = @_;
1424		2151
…		…
1429		2156
1430	sub load_header_from($) {	2157	sub load_header_from($) {
1431	my ($self, $path) = @_;	2158	my ($self, $path) = @_;
1432		2159
1433	utf8::encode $path;	2160	utf8::encode $path;
1434	#aio_open $path, O_RDONLY, 0	2161	my $f = new_from_file cf::object::thawer $path
1435	# or return;
1436
1437	$self->_load_header ($path)
1438	or return;	2162	or return;
1439		2163
		2164	$self->_load_header ($f)
		2165	or return;
		2166
		2167	local $MAP_LOADING{$self->{path}} = $self;
		2168	$f->resolve_delayed_derefs;
		2169
1440	$self->{load_path} = $path;	2170	$self->{load_path} = $path;
1441		2171
1442	1	2172	1
1443	}	2173	}
1444		2174
		2175	# used to laod the header of an original map
1445	sub load_header_orig {	2176	sub load_header_orig {
1446	my ($self) = @_;	2177	my ($self) = @_;
1447		2178
1448	$self->load_header_from ($self->load_path)	2179	$self->load_header_from ($self->load_path)
1449	}	2180	}
1450		2181
		2182	# used to laod the header of an instantiated map
1451	sub load_header_temp {	2183	sub load_header_temp {
1452	my ($self) = @_;	2184	my ($self) = @_;
1453		2185
1454	$self->load_header_from ($self->save_path)	2186	$self->load_header_from ($self->save_path)
1455	}	2187	}
1456		2188
		2189	# called after loading the header from an instantiated map
1457	sub prepare_temp {	2190	sub prepare_temp {
1458	my ($self) = @_;	2191	my ($self) = @_;
1459		2192
1460	$self->last_access ((delete $self->{last_access})	2193	$self->last_access ((delete $self->{last_access})
1461	|| $cf::RUNTIME); #d#	2194	|| $cf::RUNTIME); #d#
1462	# safety	2195	# safety
1463	$self->{instantiate_time} = $cf::RUNTIME	2196	$self->{instantiate_time} = $cf::RUNTIME
1464	if $self->{instantiate_time} > $cf::RUNTIME;	2197	if $self->{instantiate_time} > $cf::RUNTIME;
1465	}	2198	}
1466		2199
		2200	# called after loading the header from an original map
1467	sub prepare_orig {	2201	sub prepare_orig {
1468	my ($self) = @_;	2202	my ($self) = @_;
1469		2203
1470	$self->{load_original} = 1;	2204	$self->{load_original} = 1;
1471	$self->{instantiate_time} = $cf::RUNTIME;	2205	$self->{instantiate_time} = $cf::RUNTIME;
…		…
1482	$self->load_header_orig	2216	$self->load_header_orig
1483	or return;	2217	or return;
1484	$self->prepare_orig;	2218	$self->prepare_orig;
1485	}	2219	}
1486		2220
		2221	$self->{deny_reset} = 1
		2222	if $self->no_reset;
		2223
1487	$self->default_region (cf::region::find_by_path $self->{path})	2224	$self->default_region (cf::region::find_by_path $self->{path})
1488	unless $self->default_region;	2225	unless $self->default_region;
1489		2226
1490	1	2227	1
1491	}	2228	}
1492		2229
1493	sub find;	2230	sub find;
1494	sub find {	2231	sub find {
1495	my ($path, $origin) = @_;	2232	my ($path, $origin) = @_;
1496		2233
		2234	cf::cede_to_tick;
		2235
1497	$path = normalise $path, $origin && $origin->path;	2236	$path = normalise $path, $origin;
1498		2237
		2238	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1499	cf::lock_wait "map_find:$path";	2239	my $guard2 = cf::lock_acquire "map_find:$path";
1500		2240
1501	$cf::MAP{$path} || do {	2241	$cf::MAP{$path} || do {
1502	my $guard = cf::lock_acquire "map_find:$path";
1503	my $map = new_from_path cf::map $path	2242	my $map = new_from_path cf::map $path
1504	or return;	2243	or return;
1505		2244
1506	$map->{last_save} = $cf::RUNTIME;	2245	$map->{last_save} = $cf::RUNTIME;
1507		2246
1508	$map->load_header	2247	$map->load_header
1509	or return;	2248	or return;
1510		2249
1511	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2250	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512	# doing this can freeze the server in a sync job, obviously	2251	# doing this can freeze the server in a sync job, obviously
1513	#$cf::WAIT_FOR_TICK->wait;	2252	#$cf::WAIT_FOR_TICK->wait;
		2253	undef $guard2;
		2254	undef $guard1;
1514	$map->reset;	2255	$map->reset;
1515	undef $guard;
1516	return find $path;	2256	return find $path;
1517	}	2257	}
1518		2258
1519	$cf::MAP{$path} = $map	2259	$cf::MAP{$path} = $map
1520	}	2260	}
1521	}	2261	}
1522		2262
1523	sub pre_load { }	2263	sub pre_load { }
1524	sub post_load { }	2264	#sub post_load { } # XS
1525		2265
1526	sub load {	2266	sub load {
1527	my ($self) = @_;	2267	my ($self) = @_;
1528		2268
1529	local $self->{deny_reset} = 1; # loading can take a long time	2269	local $self->{deny_reset} = 1; # loading can take a long time
1530		2270
1531	my $path = $self->{path};	2271	my $path = $self->{path};
1532		2272
1533	{	2273	{
1534	my $guard = cf::lock_acquire "map_load:$path";	2274	my $guard = cf::lock_acquire "map_data:$path";
1535		2275
		2276	return unless $self->valid;
1536	return if $self->in_memory != cf::MAP_SWAPPED;	2277	return unless $self->state == cf::MAP_SWAPPED;
1537
1538	$self->in_memory (cf::MAP_LOADING);
1539		2278
1540	$self->alloc;	2279	$self->alloc;
1541		2280
1542	$self->pre_load;	2281	$self->pre_load;
1543	Coro::cede;	2282	cf::cede_to_tick;
1544		2283
1545	$self->_load_objects ($self->{load_path}, 1)	2284	if (exists $self->{load_path}) {
		2285	my $f = new_from_file cf::object::thawer $self->{load_path};
		2286	$f->skip_block;
		2287	$self->_load_objects ($f)
1546	or return;	2288	or return;
1547		2289
1548	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2290	$self->post_load_original
1549	if delete $self->{load_original};	2291	if delete $self->{load_original};
1550		2292
1551	if (my $uniq = $self->uniq_path) {	2293	if (my $uniq = $self->uniq_path) {
1552	utf8::encode $uniq;	2294	utf8::encode $uniq;
1553	if (aio_open $uniq, O_RDONLY, 0) {	2295	unless (aio_stat $uniq) {
		2296	if (my $f = new_from_file cf::object::thawer $uniq) {
1554	$self->clear_unique_items;	2297	$self->clear_unique_items;
1555	$self->_load_objects ($uniq, 0);	2298	$self->_load_objects ($f);
		2299	$f->resolve_delayed_derefs;
		2300	}
		2301	}
1556	}	2302	}
1557	}
1558		2303
1559	Coro::cede;	2304	$f->resolve_delayed_derefs;
		2305	} else {
		2306	$self->post_load_original
		2307	if delete $self->{load_original};
		2308	}
		2309
		2310	$self->state (cf::MAP_INACTIVE);
		2311
		2312	cf::cede_to_tick;
1560	# now do the right thing for maps	2313	# now do the right thing for maps
1561	$self->link_multipart_objects;	2314	$self->link_multipart_objects;
1562	$self->difficulty ($self->estimate_difficulty)	2315	$self->difficulty ($self->estimate_difficulty)
1563	unless $self->difficulty;	2316	unless $self->difficulty;
1564	Coro::cede;	2317	cf::cede_to_tick;
1565		2318
1566	unless ($self->{deny_activate}) {	2319	unless ($self->{deny_activate}) {
1567	$self->decay_objects;	2320	$self->decay_objects;
1568	$self->fix_auto_apply;	2321	$self->fix_auto_apply;
1569	$self->update_buttons;	2322	$self->update_buttons;
1570	Coro::cede;	2323	cf::cede_to_tick;
1571	$self->set_darkness_map;	2324	#$self->activate; # no longer activate maps automatically
1572	Coro::cede;
1573	$self->activate;
1574	}	2325	}
1575		2326
1576	$self->in_memory (cf::MAP_IN_MEMORY);	2327	$self->{last_save} = $cf::RUNTIME;
		2328	$self->last_access ($cf::RUNTIME);
1577	}	2329	}
1578		2330
1579	$self->post_load;	2331	$self->post_load;
1580	}
1581		2332
		2333	1
		2334	}
		2335
		2336	# customize the map for a given player, i.e.
		2337	# return the _real_ map. used by e.g. per-player
		2338	# maps to change the path to ~playername/mappath
1582	sub customise_for {	2339	sub customise_for {
1583	my ($self, $ob) = @_;	2340	my ($self, $ob) = @_;
1584		2341
1585	return find "~" . $ob->name . "/" . $self->{path}	2342	return find "~" . $ob->name . "/" . $self->{path}
1586	if $self->per_player;	2343	if $self->per_player;
1587		2344
		2345	# return find "?party/" . $ob->name . "/" . $self->{path}
		2346	# if $self->per_party;
		2347
1588	$self	2348	$self
1589	}
1590
1591	# find and load all maps in the 3x3 area around a map
1592	sub load_diag {
1593	my ($map) = @_;
1594
1595	my @diag; # diagonal neighbours
1596
1597	for (0 .. 3) {
1598	my $neigh = $map->tile_path ($_)
1599	or next;
1600	$neigh = find $neigh, $map
1601	or next;
1602	$neigh->load;
1603
1604	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1605	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1606	}
1607
1608	for (@diag) {
1609	my $neigh = find @$_
1610	or next;
1611	$neigh->load;
1612	}
1613	}	2349	}
1614		2350
1615	sub find_sync {	2351	sub find_sync {
1616	my ($path, $origin) = @_;	2352	my ($path, $origin) = @_;
1617		2353
1618	cf::sync_job { find $path, $origin }	2354	# it's a bug to call this from the main context
		2355	return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
		2356	if $Coro::current == $Coro::main;
		2357
		2358	find $path, $origin
1619	}	2359	}
1620		2360
1621	sub do_load_sync {	2361	sub do_load_sync {
1622	my ($map) = @_;	2362	my ($map) = @_;
1623		2363
1624	cf::sync_job { $map->load };	2364	# it's a bug to call this from the main context
		2365	return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
		2366	if $Coro::current == $Coro::main;
		2367
		2368	$map->load;
1625	}	2369	}
1626		2370
1627	our %MAP_PREFETCH;	2371	our %MAP_PREFETCH;
1628	our $MAP_PREFETCHER = undef;	2372	our $MAP_PREFETCHER = undef;
1629		2373
1630	sub find_async {	2374	sub find_async {
1631	my ($path, $origin) = @_;	2375	my ($path, $origin, $load) = @_;
1632		2376
1633	$path = normalise $path, $origin && $origin->{path};	2377	$path = normalise $path, $origin;
1634		2378
1635	if (my $map = $cf::MAP{$path}) {	2379	if (my $map = $cf::MAP{$path}) {
1636	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2380	return $map if !$load || $map->linkable;
1637	}	2381	}
1638		2382
1639	undef $MAP_PREFETCH{$path};	2383	$MAP_PREFETCH{$path} |= $load;
		2384
1640	$MAP_PREFETCHER ||= cf::async {	2385	$MAP_PREFETCHER ||= cf::async {
		2386	$Coro::current->{desc} = "map prefetcher";
		2387
1641	while (%MAP_PREFETCH) {	2388	while (%MAP_PREFETCH) {
1642	for my $path (keys %MAP_PREFETCH) {	2389	while (my ($k, $v) = each %MAP_PREFETCH) {
1643	my $map = find $path	2390	if (my $map = find $k) {
1644	or next;
1645	$map->load;	2391	$map->load if $v;
		2392	}
1646		2393
1647	delete $MAP_PREFETCH{$path};	2394	delete $MAP_PREFETCH{$k};
1648	}	2395	}
1649	}	2396	}
1650	undef $MAP_PREFETCHER;	2397	undef $MAP_PREFETCHER;
1651	};	2398	};
1652	$MAP_PREFETCHER->prio (6);	2399	$MAP_PREFETCHER->prio (6);
1653		2400
1654	()	2401	()
1655	}	2402	}
1656		2403
		2404	# common code, used by both ->save and ->swapout
1657	sub save {	2405	sub _save {
1658	my ($self) = @_;	2406	my ($self) = @_;
1659
1660	my $lock = cf::lock_acquire "map_data:" . $self->path;
1661		2407
1662	$self->{last_save} = $cf::RUNTIME;	2408	$self->{last_save} = $cf::RUNTIME;
1663		2409
1664	return unless $self->dirty;	2410	return unless $self->dirty;
1665		2411
…		…
1671	return if $self->{deny_save};	2417	return if $self->{deny_save};
1672		2418
1673	local $self->{last_access} = $self->last_access;#d#	2419	local $self->{last_access} = $self->last_access;#d#
1674		2420
1675	cf::async {	2421	cf::async {
		2422	$Coro::current->{desc} = "map player save";
1676	$_->contr->save for $self->players;	2423	$_->contr->save for $self->players;
1677	};	2424	};
		2425
		2426	cf::get_slot 0.02;
1678		2427
1679	if ($uniq) {	2428	if ($uniq) {
1680	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2429	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1681	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2430	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1682	} else {	2431	} else {
1683	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2432	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1684	}	2433	}
1685	}	2434	}
1686		2435
		2436	sub save {
		2437	my ($self) = @_;
		2438
		2439	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2440
		2441	$self->_save;
		2442	}
		2443
1687	sub swap_out {	2444	sub swap_out {
1688	my ($self) = @_;	2445	my ($self) = @_;
1689		2446
1690	# save first because save cedes
1691	$self->save;
1692
1693	my $lock = cf::lock_acquire "map_data:" . $self->path;	2447	my $lock = cf::lock_acquire "map_data:$self->{path}";
1694		2448
		2449	return if !$self->linkable;
		2450	return if $self->{deny_save};
1695	return if $self->players;	2451	return if $self->players;
1696	return if $self->in_memory != cf::MAP_IN_MEMORY;
1697	return if $self->{deny_save};
1698		2452
		2453	# first deactivate the map and "unlink" it from the core
		2454	$self->deactivate;
		2455	$_->clear_links_to ($self) for values %cf::MAP;
		2456	$self->state (cf::MAP_SWAPPED);
		2457
		2458	# then atomically save
		2459	$self->_save;
		2460
		2461	# then free the map
1699	$self->clear;	2462	$self->clear;
1700	$self->in_memory (cf::MAP_SWAPPED);
1701	}	2463	}
1702		2464
1703	sub reset_at {	2465	sub reset_at {
1704	my ($self) = @_;	2466	my ($self) = @_;
1705		2467
1706	# TODO: safety, remove and allow resettable per-player maps	2468	# TODO: safety, remove and allow resettable per-player maps
1707	return 1e99 if $self->isa ("ext::map_per_player");#d#
1708	return 1e99 if $self->{deny_reset};	2469	return 1e99 if $self->{deny_reset};
1709		2470
1710	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2471	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2472	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712		2473
…		…
1723	my ($self) = @_;	2484	my ($self) = @_;
1724		2485
1725	my $lock = cf::lock_acquire "map_data:$self->{path}";	2486	my $lock = cf::lock_acquire "map_data:$self->{path}";
1726		2487
1727	return if $self->players;	2488	return if $self->players;
1728	return if $self->isa ("ext::map_per_player");#d#
1729		2489
1730	warn "resetting map ", $self->path;#d#	2490	cf::trace "resetting map ", $self->path, "\n";
1731		2491
1732	$self->in_memory (cf::MAP_SWAPPED);	2492	$self->state (cf::MAP_SWAPPED);
1733		2493
1734	# need to save uniques path	2494	# need to save uniques path
1735	unless ($self->{deny_save}) {	2495	unless ($self->{deny_save}) {
1736	my $uniq = $self->uniq_path; utf8::encode $uniq;	2496	my $uniq = $self->uniq_path; utf8::encode $uniq;
1737		2497
…		…
1739	if $uniq;	2499	if $uniq;
1740	}	2500	}
1741		2501
1742	delete $cf::MAP{$self->path};	2502	delete $cf::MAP{$self->path};
1743		2503
		2504	$self->deactivate;
		2505	$_->clear_links_to ($self) for values %cf::MAP;
1744	$self->clear;	2506	$self->clear;
1745
1746	$_->clear_links_to ($self) for values %cf::MAP;
1747		2507
1748	$self->unlink_save;	2508	$self->unlink_save;
1749	$self->destroy;	2509	$self->destroy;
1750	}	2510	}
1751		2511
1752	my $nuke_counter = "aaaa";	2512	my $nuke_counter = "aaaa";
1753		2513
1754	sub nuke {	2514	sub nuke {
1755	my ($self) = @_;	2515	my ($self) = @_;
1756		2516
		2517	{
		2518	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2519
1757	delete $cf::MAP{$self->path};	2520	delete $cf::MAP{$self->path};
1758		2521
1759	$self->unlink_save;	2522	$self->unlink_save;
1760		2523
1761	bless $self, "cf::map";	2524	bless $self, "cf::map::wrap";
1762	delete $self->{deny_reset};	2525	delete $self->{deny_reset};
1763	$self->{deny_save} = 1;	2526	$self->{deny_save} = 1;
1764	$self->reset_timeout (1);	2527	$self->reset_timeout (1);
1765	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2528	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1766		2529
1767	$cf::MAP{$self->path} = $self;	2530	$cf::MAP{$self->path} = $self;
		2531	}
1768		2532
1769	$self->reset; # polite request, might not happen	2533	$self->reset; # polite request, might not happen
		2534	}
		2535
		2536	=item $maps = cf::map::tmp_maps
		2537
		2538	Returns an arrayref with all map paths of currently instantiated and saved
		2539	maps. May block.
		2540
		2541	=cut
		2542
		2543	sub tmp_maps() {
		2544	[
		2545	map {
		2546	utf8::decode $_;
		2547	/\.map$/
		2548	? normalise $_
		2549	: ()
		2550	} @{ aio_readdir $TMPDIR or [] }
		2551	]
		2552	}
		2553
		2554	=item $maps = cf::map::random_maps
		2555
		2556	Returns an arrayref with all map paths of currently instantiated and saved
		2557	random maps. May block.
		2558
		2559	=cut
		2560
		2561	sub random_maps() {
		2562	[
		2563	map {
		2564	utf8::decode $_;
		2565	/\.map$/
		2566	? normalise "?random/$_"
		2567	: ()
		2568	} @{ aio_readdir $RANDOMDIR or [] }
		2569	]
1770	}	2570	}
1771		2571
1772	=item cf::map::unique_maps	2572	=item cf::map::unique_maps
1773		2573
1774	Returns an arrayref of paths of all shared maps that have	2574	Returns an arrayref of paths of all shared maps that have
1775	instantiated unique items. May block.	2575	instantiated unique items. May block.
1776		2576
1777	=cut	2577	=cut
1778		2578
1779	sub unique_maps() {	2579	sub unique_maps() {
1780	my $files = aio_readdir $UNIQUEDIR	2580	[
1781	or return;	2581	map {
1782
1783	my @paths;
1784
1785	for (@$files) {
1786	utf8::decode $_;	2582	utf8::decode $_;
1787	next if /\.pst$/;	2583	s/\.map$//; # TODO future compatibility hack
1788	next unless /^$PATH_SEP/o;	2584	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1789		2585	? ()
1790	push @paths, cf::map::normalise $_;	2586	: normalise $_
		2587	} @{ aio_readdir $UNIQUEDIR or [] }
1791	}	2588	]
1792
1793	\@paths
1794	}	2589	}
1795		2590
1796	package cf;	2591	=item cf::map::static_maps
		2592
		2593	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2594	file in the shared directory excluding F</styles> and F</editor>). May
		2595	block.
		2596
		2597	=cut
		2598
		2599	sub static_maps() {
		2600	my @dirs = "";
		2601	my @maps;
		2602
		2603	while (@dirs) {
		2604	my $dir = shift @dirs;
		2605
		2606	next if $dir eq "/styles" || $dir eq "/editor";
		2607
		2608	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2609	or return;
		2610
		2611	for (@$files) {
		2612	s/\.map$// or next;
		2613	utf8::decode $_;
		2614	push @maps, "$dir/$_";
		2615	}
		2616
		2617	push @dirs, map "$dir/$_", @$dirs;
		2618	}
		2619
		2620	\@maps
		2621	}
1797		2622
1798	=back	2623	=back
1799		2624
1800	=head3 cf::object	2625	=head3 cf::object
1801		2626
…		…
1805		2630
1806	=over 4	2631	=over 4
1807		2632
1808	=item $ob->inv_recursive	2633	=item $ob->inv_recursive
1809		2634
1810	Returns the inventory of the object _and_ their inventories, recursively.	2635	Returns the inventory of the object I<and> their inventories, recursively,
		2636	but I<not> the object itself.
1811		2637
1812	=cut	2638	=cut
1813		2639
1814	sub inv_recursive_;	2640	sub inv_recursive_;
1815	sub inv_recursive_ {	2641	sub inv_recursive_ {
…		…
1818		2644
1819	sub inv_recursive {	2645	sub inv_recursive {
1820	inv_recursive_ inv $_[0]	2646	inv_recursive_ inv $_[0]
1821	}	2647	}
1822		2648
		2649	=item $ref = $ob->ref
		2650
		2651	Creates and returns a persistent reference to an object that can be stored as a string.
		2652
		2653	=item $ob = cf::object::deref ($refstring)
		2654
		2655	returns the objetc referenced by refstring. may return undef when it cannot find the object,
		2656	even if the object actually exists. May block.
		2657
		2658	=cut
		2659
		2660	sub deref {
		2661	my ($ref) = @_;
		2662
		2663	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2664	my ($uuid, $name) = ($1, $2);
		2665	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2666	or return;
		2667	$pl->ob->uuid eq $uuid
		2668	or return;
		2669
		2670	$pl->ob
		2671	} else {
		2672	warn "$ref: cannot resolve object reference\n";
		2673	undef
		2674	}
		2675	}
		2676
1823	package cf;	2677	package cf;
1824		2678
1825	=back	2679	=back
1826		2680
1827	=head3 cf::object::player	2681	=head3 cf::object::player
…		…
1833	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2687	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1834	can be C<undef>. Does the right thing when the player is currently in a	2688	can be C<undef>. Does the right thing when the player is currently in a
1835	dialogue with the given NPC character.	2689	dialogue with the given NPC character.
1836		2690
1837	=cut	2691	=cut
		2692
		2693	our $SAY_CHANNEL = {
		2694	id => "say",
		2695	title => "Map",
		2696	reply => "say ",
		2697	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2698	};
		2699
		2700	our $CHAT_CHANNEL = {
		2701	id => "chat",
		2702	title => "Chat",
		2703	reply => "chat ",
		2704	tooltip => "Player chat and shouts, global to the server.",
		2705	};
1838		2706
1839	# rough implementation of a future "reply" method that works	2707	# rough implementation of a future "reply" method that works
1840	# with dialog boxes.	2708	# with dialog boxes.
1841	#TODO: the first argument must go, split into a $npc->reply_to ( method	2709	#TODO: the first argument must go, split into a $npc->reply_to ( method
1842	sub cf::object::player::reply($$$;$) {	2710	sub cf::object::player::reply($$$;$) {
…		…
1844		2712
1845	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846		2714
1847	if ($self->{record_replies}) {	2715	if ($self->{record_replies}) {
1848	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2717
1849	} else {	2718	} else {
		2719	my $pl = $self->contr;
		2720
		2721	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2722	my $dialog = $pl->{npc_dialog};
		2723	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2724
		2725	} else {
1850	$msg = $npc->name . " says: $msg" if $npc;	2726	$msg = $npc->name . " says: $msg" if $npc;
1851	$self->message ($msg, $flags);	2727	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2728	}
1852	}	2729	}
		2730	}
		2731
		2732	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2733
		2734	=cut
		2735
		2736	sub cf::object::send_msg {
		2737	my $pl = shift->contr
		2738	or return;
		2739	$pl->send_msg (@_);
1853	}	2740	}
1854		2741
1855	=item $player_object->may ("access")	2742	=item $player_object->may ("access")
1856		2743
1857	Returns wether the given player is authorized to access resource "access"	2744	Returns wether the given player is authorized to access resource "access"
…		…
1870		2757
1871	=item $player_object->enter_link	2758	=item $player_object->enter_link
1872		2759
1873	Freezes the player and moves him/her to a special map (C<{link}>).	2760	Freezes the player and moves him/her to a special map (C<{link}>).
1874		2761
1875	The player should be reasonably safe there for short amounts of time. You	2762	The player should be reasonably safe there for short amounts of time (e.g.
1876	I<MUST> call C<leave_link> as soon as possible, though.	2763	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2764	though, as the player cannot control the character while it is on the link
		2765	map.
1877		2766
1878	Will never block.	2767	Will never block.
1879		2768
1880	=item $player_object->leave_link ($map, $x, $y)	2769	=item $player_object->leave_link ($map, $x, $y)
1881		2770
…		…
1901	sub cf::object::player::enter_link {	2790	sub cf::object::player::enter_link {
1902	my ($self) = @_;	2791	my ($self) = @_;
1903		2792
1904	$self->deactivate_recursive;	2793	$self->deactivate_recursive;
1905		2794
		2795	++$self->{_link_recursion};
		2796
1906	return if UNIVERSAL::isa $self->map, "ext::map_link";	2797	return if UNIVERSAL::isa $self->map, "ext::map_link";
1907		2798
1908	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909	if $self->map;	2800	if $self->map && $self->map->{path} ne "{link}";
1910		2801
1911	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2802	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1912	}	2803	}
1913		2804
1914	sub cf::object::player::leave_link {	2805	sub cf::object::player::leave_link {
1915	my ($self, $map, $x, $y) = @_;	2806	my ($self, $map, $x, $y) = @_;
		2807
		2808	return unless $self->contr->active;
1916		2809
1917	my $link_pos = delete $self->{_link_pos};	2810	my $link_pos = delete $self->{_link_pos};
1918		2811
1919	unless ($map) {	2812	unless ($map) {
1920	# restore original map position	2813	# restore original map position
…		…
1931	($x, $y) = (-1, -1)	2824	($x, $y) = (-1, -1)
1932	unless (defined $x) && (defined $y);	2825	unless (defined $x) && (defined $y);
1933		2826
1934	# use -1 or undef as default coordinates, not 0, 0	2827	# use -1 or undef as default coordinates, not 0, 0
1935	($x, $y) = ($map->enter_x, $map->enter_y)	2828	($x, $y) = ($map->enter_x, $map->enter_y)
1936	if $x <=0 && $y <= 0;	2829	if $x <= 0 && $y <= 0;
1937		2830
1938	$map->load;	2831	$map->load;
1939	$map->load_diag;
1940		2832
1941	return unless $self->contr->active;	2833	return unless $self->contr->active;
1942	$self->activate_recursive;
1943		2834
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2835	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2836	if ($self->enter_map ($map, $x, $y)) {
1946	}	2837	# entering was successful
1947		2838	delete $self->{_link_recursion};
1948	cf::player->attach (	2839	# only activate afterwards, to support waiting in hooks
1949	on_logout => sub {	2840	$self->activate_recursive;
1950	my ($pl) = @_;
1951
1952	# abort map switching before logout
1953	if ($pl->ob->{_link_pos}) {
1954	cf::sync_job {
1955	$pl->ob->leave_link
1956	};
1957	}
1958	},	2841	}
1959	on_login => sub {
1960	my ($pl) = @_;
1961		2842
1962	# try to abort aborted map switching on player login :)	2843	}
1963	# should happen only on crashes
1964	if ($pl->ob->{_link_pos}) {
1965	$pl->ob->enter_link;
1966	(async {
1967	$pl->ob->reply (undef,
1968	"There was an internal problem at your last logout, "
1969	. "the server will try to bring you to your intended destination in a second.",
1970	cf::NDI_RED);
1971	# we need this sleep as the login has a concurrent enter_exit running
1972	# and this sleep increases chances of the player not ending up in scorn
1973	Coro::Timer::sleep 1;
1974	$pl->ob->leave_link;
1975	})->prio (2);
1976	}
1977	},
1978	);
1979		2844
1980	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2845	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1981		2846
1982	Moves the player to the given map-path and coordinates by first freezing	2847	Moves the player to the given map-path and coordinates by first freezing
1983	her, loading and preparing them map, calling the provided $check callback	2848	her, loading and preparing them map, calling the provided $check callback
1984	that has to return the map if sucecssful, and then unfreezes the player on	2849	that has to return the map if sucecssful, and then unfreezes the player on
1985	the new (success) or old (failed) map position.	2850	the new (success) or old (failed) map position. In either case, $done will
		2851	be called at the end of this process.
1986		2852
		2853	Note that $check will be called with a potentially non-loaded map, so if
		2854	it needs a loaded map it has to call C<< ->load >>.
		2855
1987	=cut	2856	=cut
		2857
		2858	our $GOTOGEN;
1988		2859
1989	sub cf::object::player::goto {	2860	sub cf::object::player::goto {
1990	my ($self, $path, $x, $y, $check) = @_;	2861	my ($self, $path, $x, $y, $check, $done) = @_;
		2862
		2863	if ($self->{_link_recursion} >= $MAX_LINKS) {
		2864	error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
		2865	$self->failmsg ("Something went wrong inside the server - please contact an administrator!");
		2866	($path, $x, $y) = @$EMERGENCY_POSITION;
		2867	}
		2868
		2869	# do generation counting so two concurrent goto's will be executed in-order
		2870	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1991		2871
1992	$self->enter_link;	2872	$self->enter_link;
1993		2873
1994	(async {	2874	(async {
		2875	$Coro::current->{desc} = "player::goto $path $x $y";
		2876
		2877	# *tag paths override both path and x|y
		2878	if ($path =~ /^\*(.*)$/) {
		2879	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2880	my $ob = $obs[rand @obs];
		2881
		2882	# see if we actually can go there
		2883	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2884	$ob = $obs[rand @obs];
		2885	} else {
		2886	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2887	}
		2888	# else put us there anyways for now #d#
		2889
		2890	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2891	} else {
		2892	($path, $x, $y) = (undef, undef, undef);
		2893	}
		2894	}
		2895
1995	my $map = eval {	2896	my $map = eval {
1996	my $map = cf::map::find $path;	2897	my $map = defined $path ? cf::map::find $path, $self->map : undef;
1997		2898
1998	if ($map) {	2899	if ($map) {
1999	$map = $map->customise_for ($self);	2900	$map = $map->customise_for ($self);
2000	$map = $check->($map) if $check && $map;	2901	$map = $check->($map, $x, $y, $self) if $check && $map;
2001	} else {	2902	} else {
2002	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2903	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2003	}	2904	}
2004		2905
2005	$map	2906	$map
2006	};	2907	};
2007		2908
2008	if ($@) {	2909	if ($@) {
2009	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);	2910	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2010	LOG llevError | logBacktrace, Carp::longmess $@;	2911	LOG llevError | logBacktrace, Carp::longmess $@;
2011	}	2912	}
2012		2913
		2914	if ($gen == $self->{_goto_generation}) {
		2915	delete $self->{_goto_generation};
2013	$self->leave_link ($map, $x, $y);	2916	$self->leave_link ($map, $x, $y);
		2917	}
		2918
		2919	$done->($self) if $done;
2014	})->prio (1);	2920	})->prio (1);
2015	}	2921	}
2016		2922
2017	=item $player_object->enter_exit ($exit_object)	2923	=item $player_object->enter_exit ($exit_object)
2018		2924
…		…
2038	}	2944	}
2039		2945
2040	sub prepare_random_map {	2946	sub prepare_random_map {
2041	my ($exit) = @_;	2947	my ($exit) = @_;
2042		2948
2043	my $guard = cf::lock_acquire "exit_prepare:$exit";
2044
2045	# all this does is basically replace the /! path by	2949	# all this does is basically replace the /! path by
2046	# a new random map path (?random/...) with a seed	2950	# a new random map path (?random/...) with a seed
2047	# that depends on the exit object	2951	# that depends on the exit object
2048		2952
2049	my $rmp = parse_random_map_params $exit->msg;	2953	my $rmp = parse_random_map_params $exit->msg;
…		…
2051	if ($exit->map) {	2955	if ($exit->map) {
2052	$rmp->{region} = $exit->region->name;	2956	$rmp->{region} = $exit->region->name;
2053	$rmp->{origin_map} = $exit->map->path;	2957	$rmp->{origin_map} = $exit->map->path;
2054	$rmp->{origin_x} = $exit->x;	2958	$rmp->{origin_x} = $exit->x;
2055	$rmp->{origin_y} = $exit->y;	2959	$rmp->{origin_y} = $exit->y;
		2960
		2961	$exit->map->touch;
2056	}	2962	}
2057		2963
2058	$rmp->{random_seed} ||= $exit->random_seed;	2964	$rmp->{random_seed} ||= $exit->random_seed;
2059		2965
2060	my $data = cf::to_json $rmp;	2966	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2061	my $md5 = Digest::MD5::md5_hex $data;	2967	my $md5 = Digest::MD5::md5_hex $data;
2062	my $meta = "$RANDOMDIR/$md5.meta";	2968	my $meta = "$RANDOMDIR/$md5.meta";
2063		2969
2064	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2970	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2065	aio_write $fh, 0, (length $data), $data, 0;	2971	aio_write $fh, 0, (length $data), $data, 0;
2066	undef $fh;	2972	undef $fh;
2067	aio_rename "$meta~", $meta;	2973	aio_rename "$meta~", $meta;
2068		2974
		2975	my $slaying = "?random/$md5";
		2976
		2977	if ($exit->valid) {
2069	$exit->slaying ("?random/$md5");	2978	$exit->slaying ("?random/$md5");
2070	$exit->msg (undef);	2979	$exit->msg (undef);
		2980	}
2071	}	2981	}
2072	}	2982	}
2073		2983
2074	sub cf::object::player::enter_exit {	2984	sub cf::object::player::enter_exit {
2075	my ($self, $exit) = @_;	2985	my ($self, $exit) = @_;
2076		2986
2077	return unless $self->type == cf::PLAYER;	2987	return unless $self->type == cf::PLAYER;
2078		2988
2079	if ($exit->slaying eq "/!") {
2080	#TODO: this should de-fi-ni-te-ly not be a sync-job
2081	# the problem is that $exit might not survive long enough
2082	# so it needs to be done right now, right here
2083	cf::sync_job { prepare_random_map $exit };
2084	}
2085
2086	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2087	my $hp = $exit->stats->hp;
2088	my $sp = $exit->stats->sp;
2089
2090	$self->enter_link;	2989	$self->enter_link;
2091		2990
2092	(async {	2991	(async {
2093	$self->deactivate_recursive; # just to be sure	2992	$Coro::current->{desc} = "enter_exit";
		2993
2094	unless (eval {	2994	unless (eval {
		2995	$self->deactivate_recursive; # just to be sure
		2996
		2997	my $map = cf::map::normalise $exit->slaying, $exit->map;
		2998	my $x = $exit->stats->hp;
		2999	my $y = $exit->stats->sp;
		3000
		3001	# special map handling
		3002	my $slaying = $exit->slaying;
		3003
		3004	# special map handling
		3005	if ($slaying eq "/!") {
		3006	my $guard = cf::lock_acquire "exit_prepare:$exit";
		3007
		3008	prepare_random_map $exit
		3009	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3010
		3011	$map = $exit->slaying;
		3012
		3013	} elsif ($slaying eq '!up') {
		3014	$map = $exit->map->tile_path (cf::TILE_UP);
		3015	$x = $exit->x;
		3016	$y = $exit->y;
		3017
		3018	} elsif ($slaying eq '!down') {
		3019	$map = $exit->map->tile_path (cf::TILE_DOWN);
		3020	$x = $exit->x;
		3021	$y = $exit->y;
		3022	}
		3023
2095	$self->goto ($slaying, $hp, $sp);	3024	$self->goto ($map, $x, $y);
2096		3025
		3026	# if exit is damned, update players death & WoR home-position
		3027	$self->contr->savebed ($map, $x, $y)
		3028	if $exit->flag (cf::FLAG_DAMNED);
		3029
2097	1;	3030	1
2098	}) {	3031	}) {
2099	$self->message ("Something went wrong deep within the crossfire server. "	3032	$self->message ("Something went wrong deep within the deliantra server. "
2100	. "I'll try to bring you back to the map you were before. "	3033	. "I'll try to bring you back to the map you were before. "
2101	. "Please report this to the dungeon master!",	3034	. "Please report this to the dungeon master!",
2102	cf::NDI_UNIQUE | cf::NDI_RED);	3035	cf::NDI_UNIQUE | cf::NDI_RED);
2103		3036
2104	warn "ERROR in enter_exit: $@";	3037	error "ERROR in enter_exit: $@";
2105	$self->leave_link;	3038	$self->leave_link;
2106	}	3039	}
2107	})->prio (1);	3040	})->prio (1);
2108	}	3041	}
2109		3042
…		…
2120		3053
2121	sub cf::client::send_drawinfo {	3054	sub cf::client::send_drawinfo {
2122	my ($self, $text, $flags) = @_;	3055	my ($self, $text, $flags) = @_;
2123		3056
2124	utf8::encode $text;	3057	utf8::encode $text;
2125	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	3058	$self->send_packet (sprintf "msg %d log %s", $flags || cf::NDI_BLACK, $text);
2126	}	3059	}
2127		3060
		3061	=item $client->send_big_packet ($pkt)
		3062
		3063	Like C<send_packet>, but tries to compress large packets, and fragments
		3064	them as required.
		3065
		3066	=cut
		3067
		3068	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		3069
		3070	sub cf::client::send_big_packet {
		3071	my ($self, $pkt) = @_;
		3072
		3073	# try lzf for large packets
		3074	$pkt = "lzf " . Compress::LZF::compress $pkt
		3075	if 1024 <= length $pkt and $self->{can_lzf};
		3076
		3077	# split very large packets
		3078	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		3079	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		3080	$pkt = "frag";
		3081	}
		3082
		3083	$self->send_packet ($pkt);
		3084	}
		3085
		3086	=item $client->send_msg ($channel, $msg, $color, [extra...])
		3087
		3088	Send a msg packet to the client, formatting the msg for the client if
		3089	necessary. C<$type> should be a string identifying the type of the
		3090	message, with C<log> being the default. If C<$color> is negative, suppress
		3091	the message unless the client supports the msg packet.
		3092
		3093	=cut
		3094
		3095	# non-persistent channels (usually the info channel)
		3096	our %CHANNEL = (
		3097	"c/motd" => {
		3098	id => "infobox",
		3099	title => "MOTD",
		3100	reply => undef,
		3101	tooltip => "The message of the day",
		3102	},
		3103	"c/identify" => {
		3104	id => "infobox",
		3105	title => "Identify",
		3106	reply => undef,
		3107	tooltip => "Items recently identified",
		3108	},
		3109	"c/examine" => {
		3110	id => "infobox",
		3111	title => "Examine",
		3112	reply => undef,
		3113	tooltip => "Signs and other items you examined",
		3114	},
		3115	"c/shopinfo" => {
		3116	id => "infobox",
		3117	title => "Shop Info",
		3118	reply => undef,
		3119	tooltip => "What your bargaining skill tells you about the shop",
		3120	},
		3121	"c/book" => {
		3122	id => "infobox",
		3123	title => "Book",
		3124	reply => undef,
		3125	tooltip => "The contents of a note or book",
		3126	},
		3127	"c/lookat" => {
		3128	id => "infobox",
		3129	title => "Look",
		3130	reply => undef,
		3131	tooltip => "What you saw there",
		3132	},
		3133	"c/who" => {
		3134	id => "infobox",
		3135	title => "Players",
		3136	reply => undef,
		3137	tooltip => "Shows players who are currently online",
		3138	},
		3139	"c/body" => {
		3140	id => "infobox",
		3141	title => "Body Parts",
		3142	reply => undef,
		3143	tooltip => "Shows which body parts you posess and are available",
		3144	},
		3145	"c/statistics" => {
		3146	id => "infobox",
		3147	title => "Statistics",
		3148	reply => undef,
		3149	tooltip => "Shows your primary statistics",
		3150	},
		3151	"c/skills" => {
		3152	id => "infobox",
		3153	title => "Skills",
		3154	reply => undef,
		3155	tooltip => "Shows your experience per skill and item power",
		3156	},
		3157	"c/shopitems" => {
		3158	id => "infobox",
		3159	title => "Shop Items",
		3160	reply => undef,
		3161	tooltip => "Shows the items currently for sale in this shop",
		3162	},
		3163	"c/resistances" => {
		3164	id => "infobox",
		3165	title => "Resistances",
		3166	reply => undef,
		3167	tooltip => "Shows your resistances",
		3168	},
		3169	"c/pets" => {
		3170	id => "infobox",
		3171	title => "Pets",
		3172	reply => undef,
		3173	tooltip => "Shows information abotu your pets/a specific pet",
		3174	},
		3175	"c/perceiveself" => {
		3176	id => "infobox",
		3177	title => "Perceive Self",
		3178	reply => undef,
		3179	tooltip => "You gained detailed knowledge about yourself",
		3180	},
		3181	"c/uptime" => {
		3182	id => "infobox",
		3183	title => "Uptime",
		3184	reply => undef,
		3185	tooltip => "How long the server has been running since last restart",
		3186	},
		3187	"c/mapinfo" => {
		3188	id => "infobox",
		3189	title => "Map Info",
		3190	reply => undef,
		3191	tooltip => "Information related to the maps",
		3192	},
		3193	"c/party" => {
		3194	id => "party",
		3195	title => "Party",
		3196	reply => "gsay ",
		3197	tooltip => "Messages and chat related to your party",
		3198	},
		3199	"c/death" => {
		3200	id => "death",
		3201	title => "Death",
		3202	reply => undef,
		3203	tooltip => "Reason for and more info about your most recent death",
		3204	},
		3205	"c/fatal" => {
		3206	id => "fatal",
		3207	title => "Fatal Error",
		3208	reply => undef,
		3209	tooltip => "Reason for the server disconnect",
		3210	},
		3211	"c/say" => $SAY_CHANNEL,
		3212	"c/chat" => $CHAT_CHANNEL,
		3213	);
		3214
		3215	sub cf::client::send_msg {
		3216	my ($self, $channel, $msg, $color, @extra) = @_;
		3217
		3218	$msg = $self->pl->expand_cfpod ($msg)
		3219	unless $color & cf::NDI_VERBATIM;
		3220
		3221	$color &= cf::NDI_CLIENT_MASK; # just in case...
		3222
		3223	# check predefined channels, for the benefit of C
		3224	if ($CHANNEL{$channel}) {
		3225	$channel = $CHANNEL{$channel};
		3226
		3227	$self->ext_msg (channel_info => $channel);
		3228	$channel = $channel->{id};
		3229
		3230	} elsif (ref $channel) {
		3231	# send meta info to client, if not yet sent
		3232	unless (exists $self->{channel}{$channel->{id}}) {
		3233	$self->{channel}{$channel->{id}} = $channel;
		3234	$self->ext_msg (channel_info => $channel);
		3235	}
		3236
		3237	$channel = $channel->{id};
		3238	}
		3239
		3240	return unless @extra || length $msg;
		3241
		3242	# default colour, mask it out
		3243	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3244	if $color & cf::NDI_DEF;
		3245
		3246	my $pkt = "msg "
		3247	. $self->{json_coder}->encode (
		3248	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3249	);
		3250
		3251	$self->send_big_packet ($pkt);
		3252	}
		3253
2128	=item $client->ext_event ($type, %msg)	3254	=item $client->ext_msg ($type, @msg)
2129		3255
2130	Sends an exti event to the client.	3256	Sends an ext event to the client.
2131		3257
2132	=cut	3258	=cut
2133		3259
2134	sub cf::client::ext_event($$%) {	3260	sub cf::client::ext_msg($$@) {
2135	my ($self, $type, %msg) = @_;	3261	my ($self, $type, @msg) = @_;
2136		3262
2137	$msg{msgtype} = "event_$type";	3263	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2138	$self->send_packet ("ext " . cf::to_json \%msg);
2139	}	3264	}
2140		3265
2141	=item $success = $client->query ($flags, "text", \&cb)	3266	=item $success = $client->query ($flags, "text", \&cb)
2142		3267
2143	Queues a query to the client, calling the given callback with	3268	Queues a query to the client, calling the given callback with
2144	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3269	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2145	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3270	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2146		3271
2147	Queries can fail, so check the return code. Or don't, as queries will become	3272	Queries can fail, so check the return code. Or don't, as queries will
2148	reliable at some point in the future.	3273	become reliable at some point in the future.
2149		3274
2150	=cut	3275	=cut
2151		3276
2152	sub cf::client::query {	3277	sub cf::client::query {
2153	my ($self, $flags, $text, $cb) = @_;	3278	my ($self, $flags, $text, $cb) = @_;
…		…
2161	utf8::encode $text;	3286	utf8::encode $text;
2162	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3287	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2163		3288
2164	$self->send_packet ($self->{query_queue}[0][0])	3289	$self->send_packet ($self->{query_queue}[0][0])
2165	if @{ $self->{query_queue} } == 1;	3290	if @{ $self->{query_queue} } == 1;
		3291
		3292	1
2166	}	3293	}
2167		3294
2168	cf::client->attach (	3295	cf::client->attach (
		3296	on_connect => sub {
		3297	my ($ns) = @_;
		3298
		3299	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3300	},
2169	on_reply => sub {	3301	on_reply => sub {
2170	my ($ns, $msg) = @_;	3302	my ($ns, $msg) = @_;
2171		3303
2172	# this weird shuffling is so that direct followup queries	3304	# this weird shuffling is so that direct followup queries
2173	# get handled first	3305	# get handled first
…		…
2185	} else {	3317	} else {
2186	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3318	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2187	}	3319	}
2188	}	3320	}
2189	},	3321	},
		3322	on_exticmd => sub {
		3323	my ($ns, $buf) = @_;
		3324
		3325	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3326
		3327	if (ref $msg) {
		3328	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3329
		3330	if (my $cb = $EXTIACMD{$type}) {
		3331	$cb->(
		3332	$ns,
		3333	sub {
		3334	$ns->ext_msg ("reply-$reply", @_)
		3335	if $reply;
		3336	},
		3337	@payload
		3338	);
		3339	} else {
		3340	my @reply;
		3341
		3342	if (my $cb = $EXTICMD{$type}) {
		3343	@reply = $cb->($ns, @payload);
		3344	}
		3345
		3346	$ns->ext_msg ("reply-$reply", @reply)
		3347	if $reply;
		3348	}
		3349	} else {
		3350	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3351	}
		3352
		3353	cf::override;
		3354	},
2190	);	3355	);
2191		3356
2192	=item $client->async (\&cb)	3357	=item $client->async (\&cb)
2193		3358
2194	Create a new coroutine, running the specified callback. The coroutine will	3359	Create a new coroutine, running the specified callback. The coroutine will
…		…
2210		3375
2211	$coro	3376	$coro
2212	}	3377	}
2213		3378
2214	cf::client->attach (	3379	cf::client->attach (
2215	on_destroy => sub {	3380	on_client_destroy => sub {
2216	my ($ns) = @_;	3381	my ($ns) = @_;
2217		3382
2218	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3383	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2219	},	3384	},
2220	);	3385	);
…		…
2235	our $safe = new Safe "safe";	3400	our $safe = new Safe "safe";
2236	our $safe_hole = new Safe::Hole;	3401	our $safe_hole = new Safe::Hole;
2237		3402
2238	$SIG{FPE} = 'IGNORE';	3403	$SIG{FPE} = 'IGNORE';
2239		3404
2240	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3405	$safe->permit_only (Opcode::opset qw(
		3406	:base_core :base_mem :base_orig :base_math :base_loop
		3407	grepstart grepwhile mapstart mapwhile
		3408	sort time
		3409	));
2241		3410
2242	# here we export the classes and methods available to script code	3411	# here we export the classes and methods available to script code
2243		3412
2244	=pod	3413	=pod
2245		3414
2246	The following functions and methods are available within a safe environment:	3415	The following functions and methods are available within a safe environment:
2247		3416
2248	cf::object contr pay_amount pay_player map	3417	cf::object
		3418	contr pay_amount pay_player map x y force_find force_add destroy
		3419	insert remove name archname title slaying race decrease split
		3420	value
		3421
2249	cf::object::player player	3422	cf::object::player
2250	cf::player peaceful	3423	player
2251	cf::map trigger	3424
		3425	cf::player
		3426	peaceful
		3427
		3428	cf::map
		3429	trigger
2252		3430
2253	=cut	3431	=cut
2254		3432
2255	for (	3433	for (
2256	["cf::object" => qw(contr pay_amount pay_player map)],	3434	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3435	insert remove inv nrof name archname title slaying race
		3436	decrease split destroy change_exp value msg lore send_msg)],
2257	["cf::object::player" => qw(player)],	3437	["cf::object::player" => qw(player)],
2258	["cf::player" => qw(peaceful)],	3438	["cf::player" => qw(peaceful send_msg)],
2259	["cf::map" => qw(trigger)],	3439	["cf::map" => qw(trigger)],
2260	) {	3440	) {
2261	no strict 'refs';
2262	my ($pkg, @funs) = @$_;	3441	my ($pkg, @funs) = @$_;
2263	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3442	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2264	for @funs;	3443	for @funs;
2265	}	3444	}
2266		3445
…		…
2281		3460
2282	my $qcode = $code;	3461	my $qcode = $code;
2283	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3462	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2284	$qcode =~ s/\n/\\n/g;	3463	$qcode =~ s/\n/\\n/g;
2285		3464
		3465	%vars = (_dummy => 0) unless %vars;
		3466
		3467	my @res;
2286	local $_;	3468	local $_;
2287	local @safe::cf::_safe_eval_args = values %vars;
2288		3469
2289	my $eval =	3470	my $eval =
2290	"do {\n"	3471	"do {\n"
2291	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3472	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2292	. "#line 0 \"{$qcode}\"\n"	3473	. "#line 0 \"{$qcode}\"\n"
2293	. $code	3474	. $code
2294	. "\n}"	3475	. "\n}"
2295	;	3476	;
2296		3477
		3478	if ($CFG{safe_eval}) {
2297	sub_generation_inc;	3479	sub_generation_inc;
		3480	local @safe::cf::_safe_eval_args = values %vars;
2298	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3481	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2299	sub_generation_inc;	3482	sub_generation_inc;
		3483	} else {
		3484	local @cf::_safe_eval_args = values %vars;
		3485	@res = wantarray ? eval eval : scalar eval $eval;
		3486	}
2300		3487
2301	if ($@) {	3488	if ($@) {
2302	warn "$@";	3489	warn "$@",
2303	warn "while executing safe code '$code'\n";	3490	"while executing safe code '$code'\n",
2304	warn "with arguments " . (join " ", %vars) . "\n";	3491	"with arguments " . (join " ", %vars) . "\n";
2305	}	3492	}
2306		3493
2307	wantarray ? @res : $res[0]	3494	wantarray ? @res : $res[0]
2308	}	3495	}
2309		3496
…		…
2323	=cut	3510	=cut
2324		3511
2325	sub register_script_function {	3512	sub register_script_function {
2326	my ($fun, $cb) = @_;	3513	my ($fun, $cb) = @_;
2327		3514
2328	no strict 'refs';	3515	$fun = "safe::$fun" if $CFG{safe_eval};
2329	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3516	*$fun = $safe_hole->wrap ($cb);
2330	}	3517	}
2331		3518
2332	=back	3519	=back
2333		3520
2334	=cut	3521	=cut
2335
2336	#############################################################################
2337
2338	=head2 EXTENSION DATABASE SUPPORT
2339
2340	Crossfire maintains a very simple database for extension use. It can
2341	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2342	convert to/from binary).
2343
2344	The parameter C<$family> should best start with the name of the extension
2345	using it, it should be unique.
2346
2347	=over 4
2348
2349	=item $value = cf::db_get $family => $key
2350
2351	Returns a single value from the database.
2352
2353	=item cf::db_put $family => $key => $value
2354
2355	Stores the given C<$value> in the family.
2356
2357	=cut
2358
2359	our $DB;
2360
2361	sub db_init {
2362	unless ($DB) {
2363	$DB = BDB::db_create $DB_ENV;
2364
2365	cf::sync_job {
2366	eval {
2367	$DB->set_flags (BDB::CHKSUM);
2368
2369	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2370	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2371	cf::cleanup "db_open(db): $!" if $!;
2372	};
2373	cf::cleanup "db_open(db): $@" if $@;
2374	};
2375	}
2376	}
2377
2378	sub db_get($$) {
2379	my $key = "$_[0]/$_[1]";
2380
2381	cf::sync_job {
2382	BDB::db_get $DB, undef, $key, my $data;
2383
2384	$! ? ()
2385	: $data
2386	}
2387	}
2388
2389	sub db_put($$$) {
2390	BDB::dbreq_pri 4;
2391	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2392	}
2393
2394	=item cf::cache $id => [$paths...], $processversion => $process
2395
2396	Generic caching function that returns the value of the resource $id,
2397	caching and regenerating as required.
2398
2399	This function can block.
2400
2401	=cut
2402
2403	sub cache {
2404	my ($id, $src, $processversion, $process) = @_;
2405
2406	my $meta =
2407	join "\x00",
2408	$processversion,
2409	map {
2410	aio_stat $_
2411	and Carp::croak "$_: $!";
2412
2413	($_, (stat _)[7,9])
2414	} @$src;
2415
2416	my $dbmeta = db_get cache => "$id/meta";
2417	if ($dbmeta ne $meta) {
2418	# changed, we may need to process
2419
2420	my @data;
2421	my $md5;
2422
2423	for (0 .. $#$src) {
2424	0 <= aio_load $src->[$_], $data[$_]
2425	or Carp::croak "$src->[$_]: $!";
2426	}
2427
2428	# if processing is expensive, check
2429	# checksum first
2430	if (1) {
2431	$md5 =
2432	join "\x00",
2433	$processversion,
2434	map {
2435	Coro::cede;
2436	($src->[$_], Digest::MD5::md5_hex $data[$_])
2437	} 0.. $#$src;
2438
2439
2440	my $dbmd5 = db_get cache => "$id/md5";
2441	if ($dbmd5 eq $md5) {
2442	db_put cache => "$id/meta", $meta;
2443
2444	return db_get cache => "$id/data";
2445	}
2446	}
2447
2448	my $t1 = Time::HiRes::time;
2449	my $data = $process->(\@data);
2450	my $t2 = Time::HiRes::time;
2451
2452	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2453
2454	db_put cache => "$id/data", $data;
2455	db_put cache => "$id/md5" , $md5;
2456	db_put cache => "$id/meta", $meta;
2457
2458	return $data;
2459	}
2460
2461	db_get cache => "$id/data"
2462	}
2463
2464	=item fork_call { }, $args
2465
2466	Executes the given code block with the given arguments in a seperate
2467	process, returning the results. Everything must be serialisable with
2468	Coro::Storable. May, of course, block. Note that the executed sub may
2469	never block itself or use any form of Event handling.
2470
2471	=cut
2472
2473	sub fork_call(&@) {
2474	my ($cb, @args) = @_;
2475
2476	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2477	# or die "socketpair: $!";
2478	pipe my $fh1, my $fh2
2479	or die "pipe: $!";
2480
2481	if (my $pid = fork) {
2482	close $fh2;
2483
2484	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2485	$res = Coro::Storable::thaw $res;
2486
2487	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2488
2489	die $$res unless "ARRAY" eq ref $res;
2490
2491	return wantarray ? @$res : $res->[-1];
2492	} else {
2493	reset_signals;
2494	local $SIG{__WARN__};
2495	local $SIG{__DIE__};
2496	eval {
2497	close $fh1;
2498
2499	my @res = eval { $cb->(@args) };
2500	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2501	};
2502
2503	warn $@ if $@;
2504	_exit 0;
2505	}
2506	}
2507
2508
2509		3522
2510	#############################################################################	3523	#############################################################################
2511	# the server's init and main functions	3524	# the server's init and main functions
2512		3525
		3526	{
		3527	package cf::face;
		3528
		3529	our %HASH; # hash => idx
		3530	our @DATA; # dynamically-created facedata, only faceste 0 used
		3531	our @FOFS; # file offset, if > 0
		3532	our @SIZE; # size of face, in octets
		3533	our @META; # meta hash of face, if any
		3534	our $DATAFH; # facedata filehandle
		3535
		3536	# internal api, not finalised
		3537	sub set {
		3538	my ($name, $type, $data) = @_;
		3539
		3540	my $idx = cf::face::find $name;
		3541
		3542	if ($idx) {
		3543	delete $HASH{cf::face::get_csum $idx};
		3544	} else {
		3545	$idx = cf::face::alloc $name;
		3546	}
		3547
		3548	my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
		3549
		3550	cf::face::set_type $idx, $type;
		3551	cf::face::set_csum $idx, 0, $hash;
		3552
		3553	# we need to destroy the SV itself, not just modify it, as a running ix
		3554	# might hold a reference to it: "delete" achieves that.
		3555	delete $FOFS[0][$idx];
		3556	delete $DATA[0][$idx];
		3557	$DATA[0][$idx] = $data;
		3558	$SIZE[0][$idx] = length $data;
		3559	delete $META[$idx];
		3560	$HASH{$hash} = $idx;#d#
		3561
		3562	$idx
		3563	}
		3564
		3565	sub _get_data($$$) {
		3566	my ($idx, $set, $cb) = @_;
		3567
		3568	if (defined $DATA[$set][$idx]) {
		3569	$cb->($DATA[$set][$idx]);
		3570	} elsif (my $fofs = $FOFS[$set][$idx]) {
		3571	my $size = $SIZE[$set][$idx];
		3572	my $buf;
		3573	IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
		3574	if ($_[0] == $size) {
		3575	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3576	$cb->($buf);
		3577	} else {
		3578	cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
		3579	}
		3580	};
		3581	} else {
		3582	cf::error "requested facedata for unknown face $idx#$set, ignoring.";
		3583	}
		3584	}
		3585
		3586	# rather ineffient
		3587	sub cf::face::get_data($;$) {
		3588	my ($idx, $set) = @_;
		3589
		3590	_get_data $idx, $set, Coro::rouse_cb;
		3591	Coro::rouse_wait
		3592	}
		3593
		3594	sub cf::face::ix {
		3595	my ($ns, $set, $idx, $pri) = @_;
		3596
		3597	_get_data $idx, $set, sub {
		3598	$ns->ix_send ($idx, $pri, $_[0]);
		3599	};
		3600	}
		3601	}
		3602
2513	sub load_facedata($) {	3603	sub load_facedata($) {
2514	my ($path) = @_;	3604	my ($path) = @_;
2515		3605
		3606	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3607
2516	warn "loading facedata from $path\n";	3608	trace "loading facedata from $path\n";
2517		3609
2518	my $facedata;	3610	my $facedata = decode_storable load_file "$path/faceinfo";
2519	0 < aio_load $path, $facedata
2520	or die "$path: $!";
2521
2522	$facedata = Coro::Storable::thaw $facedata;
2523		3611
2524	$facedata->{version} == 2	3612	$facedata->{version} == 2
2525	or cf::cleanup "$path: version mismatch, cannot proceed.";	3613	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3614
		3615	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3616	or cf::cleanup "$path/facedata: $!, cannot proceed.";
		3617
		3618	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3619
		3620	# BEGIN ATOMIC
		3621	# from here on, everything must be atomic - no thread switch allowed
		3622	my $t1 = EV::time;
2526		3623
2527	{	3624	{
2528	my $faces = $facedata->{faceinfo};	3625	my $faces = $facedata->{faceinfo};
2529		3626
2530	while (my ($face, $info) = each %$faces) {	3627	for my $face (sort keys %$faces) {
		3628	my $info = $faces->{$face};
2531	my $idx = (cf::face::find $face) || cf::face::alloc $face;	3629	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3630
2532	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	3631	cf::face::set_visibility $idx, $info->{visibility};
2533	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3632	cf::face::set_magicmap $idx, $info->{magicmap};
2534	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3633	cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
2535	Coro::cede;	3634	cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
		3635	cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
		3636	$cf::face::HASH{$info->{hash64}} = $idx;
		3637	delete $cf::face::META[$idx];
2536	}	3638	}
2537		3639
2538	while (my ($face, $info) = each %$faces) {	3640	while (my ($face, $info) = each %$faces) {
2539	next unless $info->{smooth};	3641	next unless $info->{smooth};
		3642
2540	my $idx = cf::face::find $face	3643	my $idx = cf::face::find $face
2541	or next;	3644	or next;
		3645
2542	if (my $smooth = cf::face::find $info->{smooth}) {	3646	if (my $smooth = cf::face::find $info->{smooth}) {
		3647	cf::face::set_smooth $idx, $smooth;
2543	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	3648	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2544	} else {	3649	} else {
2545	warn "smooth face '$info->{smooth}' not found for face '$face'";	3650	error "smooth face '$info->{smooth}' not found for face '$face'";
2546	}	3651	}
2547	Coro::cede;
2548	}	3652	}
2549	}	3653	}
2550		3654
2551	{	3655	{
2552	my $anims = $facedata->{animinfo};	3656	my $anims = $facedata->{animinfo};
2553		3657
2554	while (my ($anim, $info) = each %$anims) {	3658	while (my ($anim, $info) = each %$anims) {
2555	cf::anim::set $anim, $info->{frames}, $info->{facings};	3659	cf::anim::set $anim, $info->{frames}, $info->{facings};
2556	Coro::cede;
2557	}	3660	}
2558		3661
2559	cf::anim::invalidate_all; # d'oh	3662	cf::anim::invalidate_all; # d'oh
2560	}	3663	}
2561		3664
		3665	{
		3666	my $res = $facedata->{resource};
		3667
		3668	while (my ($name, $info) = each %$res) {
		3669	if (defined (my $type = $info->{type})) {
		3670	# TODO: different hash - must free and use new index, or cache ixface data queue
		3671	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3672
		3673	cf::face::set_type $idx, $type;
		3674	cf::face::set_csum $idx, 0, $info->{hash};
		3675	$cf::face::SIZE[0][$idx] = $info->{size};
		3676	$cf::face::FOFS[0][$idx] = $info->{fofs};
		3677	$cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3678	$cf::face::HASH{$info->{hash}} = $idx;
		3679	} else {
		3680	# $RESOURCE{$name} = $info; # unused
		3681	}
		3682	}
		3683	}
		3684
		3685	($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
		3686
		3687	# HACK to clear player env face cache, we need some signal framework
		3688	# for this (global event?)
		3689	%ext::player_env::MUSIC_FACE_CACHE = ();
		3690
		3691	# END ATOMIC
		3692
		3693	cf::debug "facedata atomic update time ", EV::time - $t1;
		3694
		3695	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3696
		3697	aio_close $fh if $fh; # close old facedata
		3698
2562	1	3699	1
2563	}	3700	}
2564		3701
		3702	register_exticmd fx_want => sub {
		3703	my ($ns, $want) = @_;
		3704
		3705	while (my ($k, $v) = each %$want) {
		3706	$ns->fx_want ($k, $v);
		3707	}
		3708	};
		3709
		3710	sub load_resource_file($) {
		3711	my $guard = lock_acquire "load_resource_file";
		3712
		3713	my $status = load_resource_file_ $_[0];
		3714	get_slot 0.1, 100;
		3715	cf::arch::commit_load;
		3716
		3717	$status
		3718	}
		3719
		3720	sub reload_exp_table {
		3721	_reload_exp_table;
		3722
		3723	cf::face::set
		3724	"res/exp_table" => FT_RSRC,
		3725	JSON::XS->new->utf8->canonical->encode (
		3726	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
		3727	);
		3728	}
		3729
		3730	sub reload_materials {
		3731	_reload_materials;
		3732	}
		3733
2565	sub reload_regions {	3734	sub reload_regions {
		3735	# HACK to clear player env face cache, we need some signal framework
		3736	# for this (global event?)
		3737	%ext::player_env::MUSIC_FACE_CACHE = ();
		3738
2566	load_resource_file "$MAPDIR/regions"	3739	load_resource_file "$MAPDIR/regions"
2567	or die "unable to load regions file\n";	3740	or die "unable to load regions file\n";
		3741
		3742	for (cf::region::list) {
		3743	$_->{match} = qr/$_->{match}/
		3744	if exists $_->{match};
		3745	}
2568	}	3746	}
2569		3747
2570	sub reload_facedata {	3748	sub reload_facedata {
2571	load_facedata "$DATADIR/facedata"	3749	load_facedata $DATADIR
2572	or die "unable to load facedata\n";	3750	or die "unable to load facedata\n";
2573	}	3751	}
2574		3752
2575	sub reload_archetypes {	3753	sub reload_archetypes {
2576	load_resource_file "$DATADIR/archetypes"	3754	load_resource_file "$DATADIR/archetypes"
2577	or die "unable to load archetypes\n";	3755	or die "unable to load archetypes\n";
		3756
		3757	cf::face::set
		3758	"res/skill_info" => FT_RSRC,
		3759	JSON::XS->new->utf8->canonical->encode (
		3760	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3761	);
		3762
		3763	cf::face::set
		3764	"res/spell_paths" => FT_RSRC,
		3765	JSON::XS->new->utf8->canonical->encode (
		3766	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3767	);
2578	}	3768	}
2579		3769
2580	sub reload_treasures {	3770	sub reload_treasures {
2581	load_resource_file "$DATADIR/treasures"	3771	load_resource_file "$DATADIR/treasures"
2582	or die "unable to load treasurelists\n";	3772	or die "unable to load treasurelists\n";
2583	}	3773	}
2584		3774
		3775	sub reload_sound {
		3776	trace "loading sound config from $DATADIR/sound\n";
		3777
		3778	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3779
		3780	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3781	my $sound = $soundconf->{compat}[$_]
		3782	or next;
		3783
		3784	my $face = cf::face::find "sound/$sound->[1]";
		3785	cf::sound::set $sound->[0] => $face;
		3786	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3787	}
		3788
		3789	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3790	my $face = cf::face::find "sound/$v";
		3791	cf::sound::set $k => $face;
		3792	}
		3793	}
		3794
2585	sub reload_resources {	3795	sub reload_resources {
2586	warn "reloading resource files...\n";	3796	trace "reloading resource files...\n";
2587		3797
		3798	reload_materials;
		3799	reload_facedata;
		3800	reload_exp_table;
		3801	reload_sound;
		3802	reload_archetypes;
2588	reload_regions;	3803	reload_regions;
2589	reload_facedata;
2590	reload_archetypes;
2591	reload_treasures;	3804	reload_treasures;
2592		3805
2593	warn "finished reloading resource files\n";	3806	trace "finished reloading resource files\n";
2594	}	3807	}
2595		3808
2596	sub init {	3809	sub reload_config {
2597	reload_resources;	3810	trace "reloading config file...\n";
2598	}
2599		3811
2600	sub cfg_load {	3812	my $config = load_file "$CONFDIR/config";
2601	open my $fh, "<:utf8", "$CONFDIR/config"	3813	utf8::decode $config;
2602	or return;	3814	*CFG = decode_yaml $config;
2603		3815
2604	local $/;
2605	*CFG = YAML::Syck::Load <$fh>;
2606
2607	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3816	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2608		3817
2609	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3818	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2610	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3819	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2611		3820
2612	if (exists $CFG{mlockall}) {	3821	if (exists $CFG{mlockall}) {
…		…
2616	};	3825	};
2617	warn $@ if $@;	3826	warn $@ if $@;
2618	}	3827	}
2619	}	3828	}
2620		3829
		3830	sub pidfile() {
		3831	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3832	or die "$PIDFILE: $!";
		3833	flock $fh, &Fcntl::LOCK_EX
		3834	or die "$PIDFILE: flock: $!";
		3835	$fh
		3836	}
		3837
		3838	# make sure only one server instance is running at any one time
		3839	sub atomic {
		3840	my $fh = pidfile;
		3841
		3842	my $pid = <$fh>;
		3843	kill 9, $pid if $pid > 0;
		3844
		3845	seek $fh, 0, 0;
		3846	print $fh $$;
		3847	}
		3848
		3849	sub main_loop {
		3850	trace "EV::loop starting\n";
		3851	if (1) {
		3852	EV::loop;
		3853	}
		3854	trace "EV::loop returned\n";
		3855	goto &main_loop unless $REALLY_UNLOOP;
		3856	}
		3857
2621	sub main {	3858	sub main {
		3859	cf::init_globals; # initialise logging
		3860
		3861	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3862	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3863	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3864	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3865
		3866	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3867
2622	# we must not ever block the main coroutine	3868	# we must not ever block the main coroutine
2623	local $Coro::idle = sub {	3869	$Coro::idle = sub {
2624	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3870	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2625	(async {	3871	(async {
2626	Event::one_event;	3872	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3873	EV::loop EV::LOOP_ONESHOT;
2627	})->prio (Coro::PRIO_MAX);	3874	})->prio (Coro::PRIO_MAX);
2628	};	3875	};
2629		3876
2630	cfg_load;	3877	evthread_start IO::AIO::poll_fileno;
		3878
		3879	cf::sync_job {
		3880	cf::incloader::init ();
		3881
2631	db_init;	3882	db_init;
		3883
		3884	cf::init_anim;
		3885	cf::init_attackmess;
		3886	cf::init_dynamic;
		3887
		3888	cf::load_settings;
		3889
		3890	reload_resources;
		3891	reload_config;
		3892
		3893	cf::init_uuid;
		3894	cf::init_signals;
		3895	cf::init_skills;
		3896
		3897	cf::init_beforeplay;
		3898
		3899	atomic;
		3900
2632	load_extensions;	3901	load_extensions;
2633		3902
2634	$TICK_WATCHER->start;	3903	utime time, time, $RUNTIMEFILE;
2635	Event::loop;	3904
		3905	# no (long-running) fork's whatsoever before this point(!)
		3906	use POSIX ();
		3907	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3908
		3909	cf::_post_init 0;
		3910	};
		3911
		3912	cf::object::thawer::errors_are_fatal 0;
		3913	info "parse errors in files are no longer fatal from this point on.\n";
		3914
		3915	AE::postpone {
		3916	undef &main; # free gobs of memory :)
		3917	};
		3918
		3919	goto &main_loop;
2636	}	3920	}
2637		3921
2638	#############################################################################	3922	#############################################################################
2639	# initialisation and cleanup	3923	# initialisation and cleanup
2640		3924
2641	# install some emergency cleanup handlers	3925	# install some emergency cleanup handlers
2642	BEGIN {	3926	BEGIN {
		3927	our %SIGWATCHER = ();
2643	for my $signal (qw(INT HUP TERM)) {	3928	for my $signal (qw(INT HUP TERM)) {
2644	Event->signal (	3929	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2645	reentrant => 0,
2646	data => WF_AUTOCANCEL,
2647	signal => $signal,
2648	prio => 0,
2649	cb => sub {
2650	cf::cleanup "SIG$signal";	3930	cf::cleanup "SIG$signal";
2651	},
2652	);	3931	};
		3932	}
		3933	}
		3934
		3935	sub write_runtime_sync {
		3936	my $t0 = AE::time;
		3937
		3938	# first touch the runtime file to show we are still running:
		3939	# the fsync below can take a very very long time.
		3940
		3941	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3942
		3943	my $guard = cf::lock_acquire "write_runtime";
		3944
		3945	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3946	or return;
		3947
		3948	my $value = $cf::RUNTIME + 90 + 10;
		3949	# 10 is the runtime save interval, for a monotonic clock
		3950	# 60 allows for the watchdog to kill the server.
		3951
		3952	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3953	and return;
		3954
		3955	# always fsync - this file is important
		3956	aio_fsync $fh
		3957	and return;
		3958
		3959	# touch it again to show we are up-to-date
		3960	aio_utime $fh, undef, undef;
		3961
		3962	close $fh
		3963	or return;
		3964
		3965	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3966	and return;
		3967
		3968	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3969
2653	}	3970	1
		3971	}
		3972
		3973	our $uuid_lock;
		3974	our $uuid_skip;
		3975
		3976	sub write_uuid_sync($) {
		3977	$uuid_skip ||= $_[0];
		3978
		3979	return if $uuid_lock;
		3980	local $uuid_lock = 1;
		3981
		3982	my $uuid = "$LOCALDIR/uuid";
		3983
		3984	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3985	or return;
		3986
		3987	my $value = uuid_seq uuid_cur;
		3988
		3989	unless ($value) {
		3990	info "cowardly refusing to write zero uuid value!\n";
		3991	return;
		3992	}
		3993
		3994	my $value = uuid_str $value + $uuid_skip;
		3995	$uuid_skip = 0;
		3996
		3997	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3998	and return;
		3999
		4000	# always fsync - this file is important
		4001	aio_fsync $fh
		4002	and return;
		4003
		4004	close $fh
		4005	or return;
		4006
		4007	aio_rename "$uuid~", $uuid
		4008	and return;
		4009
		4010	trace "uuid file written ($value).\n";
		4011
		4012	1
		4013
		4014	}
		4015
		4016	sub write_uuid($$) {
		4017	my ($skip, $sync) = @_;
		4018
		4019	$sync ? write_uuid_sync $skip
		4020	: async { write_uuid_sync $skip };
2654	}	4021	}
2655		4022
2656	sub emergency_save() {	4023	sub emergency_save() {
2657	my $freeze_guard = cf::freeze_mainloop;	4024	my $freeze_guard = cf::freeze_mainloop;
2658		4025
2659	warn "enter emergency perl save\n";	4026	info "emergency_perl_save: enter\n";
		4027
		4028	# this is a trade-off: we want to be very quick here, so
		4029	# save all maps without fsync, and later call a global sync
		4030	# (which in turn might be very very slow)
		4031	local $USE_FSYNC = 0;
2660		4032
2661	cf::sync_job {	4033	cf::sync_job {
		4034	cf::write_runtime_sync; # external watchdog should not bark
		4035
2662	# use a peculiar iteration method to avoid tripping on perl	4036	# use a peculiar iteration method to avoid tripping on perl
2663	# refcount bugs in for. also avoids problems with players	4037	# refcount bugs in for. also avoids problems with players
2664	# and maps saved/destroyed asynchronously.	4038	# and maps saved/destroyed asynchronously.
2665	warn "begin emergency player save\n";	4039	info "emergency_perl_save: begin player save\n";
2666	for my $login (keys %cf::PLAYER) {	4040	for my $login (keys %cf::PLAYER) {
2667	my $pl = $cf::PLAYER{$login} or next;	4041	my $pl = $cf::PLAYER{$login} or next;
2668	$pl->valid or next;	4042	$pl->valid or next;
		4043	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2669	$pl->save;	4044	$pl->save;
2670	}	4045	}
2671	warn "end emergency player save\n";	4046	info "emergency_perl_save: end player save\n";
2672		4047
2673	warn "begin emergency map save\n";	4048	cf::write_runtime_sync; # external watchdog should not bark
		4049
		4050	info "emergency_perl_save: begin map save\n";
2674	for my $path (keys %cf::MAP) {	4051	for my $path (keys %cf::MAP) {
2675	my $map = $cf::MAP{$path} or next;	4052	my $map = $cf::MAP{$path} or next;
2676	$map->valid or next;	4053	$map->valid or next;
2677	$map->save;	4054	$map->save;
2678	}	4055	}
2679	warn "end emergency map save\n";	4056	info "emergency_perl_save: end map save\n";
2680		4057
2681	warn "begin emergency database checkpoint\n";	4058	cf::write_runtime_sync; # external watchdog should not bark
		4059
		4060	info "emergency_perl_save: begin database checkpoint\n";
2682	BDB::db_env_txn_checkpoint $DB_ENV;	4061	BDB::db_env_txn_checkpoint $DB_ENV;
2683	warn "end emergency database checkpoint\n";	4062	info "emergency_perl_save: end database checkpoint\n";
		4063
		4064	info "emergency_perl_save: begin write uuid\n";
		4065	write_uuid_sync 1;
		4066	info "emergency_perl_save: end write uuid\n";
		4067
		4068	cf::write_runtime_sync; # external watchdog should not bark
		4069
		4070	trace "emergency_perl_save: syncing database to disk";
		4071	BDB::db_env_txn_checkpoint $DB_ENV;
		4072
		4073	info "emergency_perl_save: starting sync\n";
		4074	IO::AIO::aio_sync sub {
		4075	info "emergency_perl_save: finished sync\n";
		4076	};
		4077
		4078	cf::write_runtime_sync; # external watchdog should not bark
		4079
		4080	trace "emergency_perl_save: flushing outstanding aio requests";
		4081	while (IO::AIO::nreqs || BDB::nreqs) {
		4082	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4083	}
		4084
		4085	cf::write_runtime_sync; # external watchdog should not bark
2684	};	4086	};
2685		4087
2686	warn "leave emergency perl save\n";	4088	info "emergency_perl_save: leave\n";
2687	}	4089	}
2688		4090
2689	sub post_cleanup {	4091	sub post_cleanup {
2690	my ($make_core) = @_;	4092	my ($make_core) = @_;
2691		4093
		4094	IO::AIO::flush;
		4095
2692	warn Carp::longmess "post_cleanup backtrace"	4096	error Carp::longmess "post_cleanup backtrace"
2693	if $make_core;	4097	if $make_core;
		4098
		4099	my $fh = pidfile;
		4100	unlink $PIDFILE if <$fh> == $$;
		4101	}
		4102
		4103	# a safer delete_package, copied from Symbol
		4104	sub clear_package($) {
		4105	my $pkg = shift;
		4106
		4107	# expand to full symbol table name if needed
		4108	unless ($pkg =~ /^main::.*::$/) {
		4109	$pkg = "main$pkg" if $pkg =~ /^::/;
		4110	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4111	$pkg .= '::' unless $pkg =~ /::$/;
		4112	}
		4113
		4114	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4115	my $stem_symtab = *{$stem}{HASH};
		4116
		4117	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4118	or return;
		4119
		4120	# clear all symbols
		4121	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4122	for my $name (keys %$leaf_symtab) {
		4123	_gv_clear *{"$pkg$name"};
		4124	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4125	}
2694	}	4126	}
2695		4127
2696	sub do_reload_perl() {	4128	sub do_reload_perl() {
2697	# can/must only be called in main	4129	# can/must only be called in main
2698	if ($Coro::current != $Coro::main) {	4130	unless (in_main) {
2699	warn "can only reload from main coroutine";	4131	error "can only reload from main coroutine";
2700	return;	4132	return;
2701	}	4133	}
2702		4134
2703	warn "reloading...";	4135	return if $RELOAD++;
2704		4136
2705	warn "entering sync_job";	4137	my $t1 = AE::time;
2706		4138
		4139	while ($RELOAD) {
		4140	cf::get_slot 0.1, -1, "reload_perl";
		4141	info "perl_reload: reloading...";
		4142
		4143	trace "perl_reload: entering sync_job";
		4144
2707	cf::sync_job {	4145	cf::sync_job {
2708	cf::write_runtime; # external watchdog should not bark
2709	cf::emergency_save;	4146	#cf::emergency_save;
2710	cf::write_runtime; # external watchdog should not bark
2711		4147
2712	warn "syncing database to disk";
2713	BDB::db_env_txn_checkpoint $DB_ENV;
2714
2715	# if anything goes wrong in here, we should simply crash as we already saved
2716
2717	warn "cancelling all WF_AUTOCANCEL watchers";
2718	for (Event::all_watchers) {
2719	$_->cancel if $_->data & WF_AUTOCANCEL;
2720	}
2721
2722	warn "flushing outstanding aio requests";
2723	for (;;) {
2724	BDB::flush;
2725	IO::AIO::flush;
2726	Coro::cede;
2727	last unless IO::AIO::nreqs || BDB::nreqs;
2728	warn "iterate...";
2729	}
2730
2731	++$RELOAD;
2732
2733	warn "cancelling all extension coros";	4148	trace "perl_reload: cancelling all extension coros";
2734	$_->cancel for values %EXT_CORO;	4149	$_->cancel for values %EXT_CORO;
2735	%EXT_CORO = ();	4150	%EXT_CORO = ();
2736		4151
2737	warn "removing commands";	4152	trace "perl_reload: removing commands";
2738	%COMMAND = ();	4153	%COMMAND = ();
2739		4154
2740	warn "removing ext commands";	4155	trace "perl_reload: removing ext/exti commands";
2741	%EXTCMD = ();	4156	%EXTCMD = ();
		4157	%EXTICMD = ();
2742		4158
2743	warn "unloading/nuking all extensions";	4159	trace "perl_reload: unloading/nuking all extensions";
2744	for my $pkg (@EXTS) {	4160	for my $pkg (@EXTS) {
2745	warn "... unloading $pkg";	4161	trace "... unloading $pkg";
2746		4162
2747	if (my $cb = $pkg->can ("unload")) {	4163	if (my $cb = $pkg->can ("unload")) {
2748	eval {	4164	eval {
2749	$cb->($pkg);	4165	$cb->($pkg);
2750	1	4166	1
2751	} or warn "$pkg unloaded, but with errors: $@";	4167	} or error "$pkg unloaded, but with errors: $@";
		4168	}
		4169
		4170	trace "... clearing $pkg";
		4171	clear_package $pkg;
2752	}	4172	}
2753		4173
2754	warn "... nuking $pkg";
2755	Symbol::delete_package $pkg;
2756	}
2757
2758	warn "unloading all perl modules loaded from $LIBDIR";	4174	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2759	while (my ($k, $v) = each %INC) {	4175	while (my ($k, $v) = each %INC) {
2760	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4176	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2761		4177
2762	warn "... unloading $k";	4178	trace "... unloading $k";
2763	delete $INC{$k};	4179	delete $INC{$k};
2764		4180
2765	$k =~ s/\.pm$//;	4181	$k =~ s/\.pm$//;
2766	$k =~ s/\//::/g;	4182	$k =~ s/\//::/g;
2767		4183
2768	if (my $cb = $k->can ("unload_module")) {	4184	if (my $cb = $k->can ("unload_module")) {
2769	$cb->();	4185	$cb->();
		4186	}
		4187
		4188	clear_package $k;
2770	}	4189	}
2771		4190
2772	Symbol::delete_package $k;
2773	}
2774
2775	warn "getting rid of safe::, as good as possible";	4191	trace "perl_reload: getting rid of safe::, as good as possible";
2776	Symbol::delete_package "safe::$_"	4192	clear_package "safe::$_"
2777	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4193	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2778		4194
2779	warn "unloading cf.pm \"a bit\"";	4195	trace "perl_reload: unloading cf.pm \"a bit\"";
2780	delete $INC{"cf.pm"};	4196	delete $INC{"cf.pm"};
2781	delete $INC{"cf/pod.pm"};	4197	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2782		4198
2783	# don't, removes xs symbols, too,	4199	# don't, removes xs symbols, too,
2784	# and global variables created in xs	4200	# and global variables created in xs
2785	#Symbol::delete_package __PACKAGE__;	4201	#clear_package __PACKAGE__;
2786		4202
2787	warn "unload completed, starting to reload now";	4203	info "perl_reload: unload completed, starting to reload now";
2788		4204
2789	warn "reloading cf.pm";	4205	trace "perl_reload: reloading cf.pm";
2790	require cf;	4206	require cf;
2791	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4207	cf::_connect_to_perl_1;
2792		4208
2793	warn "loading config and database again";	4209	trace "perl_reload: loading config and database again";
2794	cf::cfg_load;	4210	cf::reload_config;
2795		4211
2796	warn "loading extensions";	4212	trace "perl_reload: loading extensions";
2797	cf::load_extensions;	4213	cf::load_extensions;
2798		4214
		4215	if ($REATTACH_ON_RELOAD) {
2799	warn "reattaching attachments to objects/players";	4216	trace "perl_reload: reattaching attachments to objects/players";
2800	_global_reattach; # objects, sockets	4217	_global_reattach; # objects, sockets
2801	warn "reattaching attachments to maps";	4218	trace "perl_reload: reattaching attachments to maps";
2802	reattach $_ for values %MAP;	4219	reattach $_ for values %MAP;
2803	warn "reattaching attachments to players";	4220	trace "perl_reload: reattaching attachments to players";
2804	reattach $_ for values %PLAYER;	4221	reattach $_ for values %PLAYER;
		4222	}
2805		4223
2806	warn "leaving sync_job";	4224	cf::_post_init 1;
2807		4225
		4226	trace "perl_reload: leaving sync_job";
		4227
2808	1	4228	1
2809	} or do {	4229	} or do {
2810	warn $@;	4230	error $@;
2811	warn "error while reloading, exiting.";	4231	cf::cleanup "perl_reload: error, exiting.";
2812	exit 1;	4232	};
		4233
		4234	--$RELOAD;
2813	};	4235	}
2814		4236
2815	warn "reloaded";	4237	$t1 = AE::time - $t1;
		4238	info "perl_reload: completed in ${t1}s\n";
2816	};	4239	};
2817		4240
2818	our $RELOAD_WATCHER; # used only during reload	4241	our $RELOAD_WATCHER; # used only during reload
2819		4242
2820	sub reload_perl() {	4243	sub reload_perl() {
2821	# doing reload synchronously and two reloads happen back-to-back,	4244	# doing reload synchronously and two reloads happen back-to-back,
2822	# coro crashes during coro_state_free->destroy here.	4245	# coro crashes during coro_state_free->destroy here.
2823		4246
2824	$RELOAD_WATCHER ||= Event->timer (	4247	$RELOAD_WATCHER ||= cf::async {
2825	reentrant => 0,	4248	Coro::AIO::aio_wait cache_extensions;
2826	after => 0,	4249
2827	data => WF_AUTOCANCEL,	4250	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
2828	cb => sub {
2829	do_reload_perl;	4251	do_reload_perl;
2830	undef $RELOAD_WATCHER;	4252	undef $RELOAD_WATCHER;
2831	},	4253	};
2832	);	4254	};
2833	}	4255	}
2834		4256
2835	register_command "reload" => sub {	4257	register_command "reload" => sub {
2836	my ($who, $arg) = @_;	4258	my ($who, $arg) = @_;
2837		4259
2838	if ($who->flag (FLAG_WIZ)) {	4260	if ($who->flag (FLAG_WIZ)) {
2839	$who->message ("reloading server.");	4261	$who->message ("reloading server.");
		4262	async {
		4263	$Coro::current->{desc} = "perl_reload";
2840	async { reload_perl };	4264	reload_perl;
		4265	};
2841	}	4266	}
2842	};	4267	};
2843		4268
2844	unshift @INC, $LIBDIR;	4269	#############################################################################
2845		4270
2846	my $bug_warning = 0;	4271	my $bug_warning = 0;
2847		4272
2848	our @WAIT_FOR_TICK;
2849	our @WAIT_FOR_TICK_BEGIN;
2850
2851	sub wait_for_tick {	4273	sub wait_for_tick() {
2852	return unless $TICK_WATCHER->is_active;	4274	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2853	return if $Coro::current == $Coro::main;
2854		4275
2855	my $signal = new Coro::Signal;	4276	$WAIT_FOR_TICK->wait;
2856	push @WAIT_FOR_TICK, $signal;
2857	$signal->wait;
2858	}	4277	}
2859		4278
2860	sub wait_for_tick_begin {	4279	sub wait_for_tick_begin() {
2861	return unless $TICK_WATCHER->is_active;	4280	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2862	return if $Coro::current == $Coro::main;
2863		4281
2864	my $signal = new Coro::Signal;	4282	my $signal = new Coro::Signal;
2865	push @WAIT_FOR_TICK_BEGIN, $signal;	4283	push @WAIT_FOR_TICK_BEGIN, $signal;
2866	$signal->wait;	4284	$signal->wait;
2867	}	4285	}
2868		4286
2869	my $min = 1e6;#d#	4287	sub tick {
2870	my $avg = 10;
2871	$TICK_WATCHER = Event->timer (
2872	reentrant => 0,
2873	parked => 1,
2874	prio => 0,
2875	at => $NEXT_TICK || $TICK,
2876	data => WF_AUTOCANCEL,
2877	cb => sub {
2878	if ($Coro::current != $Coro::main) {	4288	if ($Coro::current != $Coro::main) {
2879	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	4289	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2880	unless ++$bug_warning > 10;	4290	unless ++$bug_warning > 10;
2881	return;	4291	return;
2882	}	4292	}
2883		4293
2884	$NOW = $tick_start = Event::time;	4294	cf::one_tick; # one server iteration
2885		4295
2886	cf::server_tick; # one server iteration	4296	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2887		4297
2888	0 && sync_job {#d#	4298	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2889	for(1..10) {	4299	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2890	my $t = Event::time;	4300	Coro::async_pool {
2891	my $map = my $map = new_from_path cf::map "/tmp/x.map"	4301	$Coro::current->{desc} = "runtime saver";
2892	or die;	4302	write_runtime_sync
2893		4303	or error "ERROR: unable to write runtime file: $!";
2894	$map->width (50);
2895	$map->height (50);
2896	$map->alloc;
2897	$map->_load_objects ("/tmp/x.map", 1);
2898	my $t = Event::time - $t;
2899
2900	#next unless $t < 0.0013;#d#
2901	if ($t < $min) {
2902	$min = $t;
2903	}
2904	$avg = $avg * 0.99 + $t * 0.01;
2905	}
2906	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2907	exit 0;
2908	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2909	};	4304	};
		4305	}
2910		4306
2911	$RUNTIME += $TICK;
2912	$NEXT_TICK += $TICK;
2913
2914	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2915	$NEXT_RUNTIME_WRITE = $NOW + 10;
2916	Coro::async_pool {
2917	write_runtime
2918	or warn "ERROR: unable to write runtime file: $!";
2919	};
2920	}
2921
2922	# my $AFTER = Event::time;
2923	# warn $AFTER - $NOW;#d#
2924
2925	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	4307	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2926	$sig->send;	4308	$sig->send;
2927	}	4309	}
2928	while (my $sig = shift @WAIT_FOR_TICK) {	4310	$WAIT_FOR_TICK->broadcast;
2929	$sig->send;
2930	}
2931		4311
2932	$NOW = Event::time;	4312	$LOAD = ($NOW - $TICK_START) / $TICK;
2933
2934	# if we are delayed by four ticks or more, skip them all
2935	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2936
2937	$TICK_WATCHER->at ($NEXT_TICK);
2938	$TICK_WATCHER->start;
2939
2940	$LOAD = ($NOW - $tick_start) / $TICK;
2941	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;	4313	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2942		4314
2943	_post_tick;	4315	if (0) {
2944		4316	if ($NEXT_TICK) {
2945		4317	my $jitter = $TICK_START - $NEXT_TICK;
		4318	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4319	debug "jitter $JITTER\n";#d#
		4320	}
2946	},	4321	}
2947	);	4322	}
2948		4323
2949	{	4324	{
2950	BDB::max_poll_time $TICK * 0.1;	4325	# configure BDB
2951	$BDB_POLL_WATCHER = Event->io (	4326	info "initialising database";
2952	reentrant => 0,	4327
2953	fd => BDB::poll_fileno,
2954	poll => 'r',
2955	prio => 0,
2956	data => WF_AUTOCANCEL,
2957	cb => \&BDB::poll_cb,
2958	);
2959	BDB::min_parallel 8;	4328	BDB::min_parallel 16;
2960		4329	BDB::max_poll_reqs $TICK * 0.1;
2961	BDB::set_sync_prepare {	4330	#$AnyEvent::BDB::WATCHER->priority (1);
2962	my $status;
2963	my $current = $Coro::current;
2964	(
2965	sub {
2966	$status = $!;
2967	$current->ready; undef $current;
2968	},
2969	sub {
2970	Coro::schedule while defined $current;
2971	$! = $status;
2972	},
2973	)
2974	};
2975		4331
2976	unless ($DB_ENV) {	4332	unless ($DB_ENV) {
2977	$DB_ENV = BDB::db_env_create;	4333	$DB_ENV = BDB::db_env_create;
		4334	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4335	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4336	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4337	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4338	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2978		4339
2979	cf::sync_job {	4340	cf::sync_job {
2980	eval {	4341	eval {
2981	BDB::db_env_open	4342	BDB::db_env_open
2982	$DB_ENV,	4343	$DB_ENV,
…		…
2984	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	4345	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2985	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	4346	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2986	0666;	4347	0666;
2987		4348
2988	cf::cleanup "db_env_open($BDBDIR): $!" if $!;	4349	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2989
2990	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2991	$DB_ENV->set_lk_detect;
2992	};	4350	};
2993		4351
2994	cf::cleanup "db_env_open(db): $@" if $@;	4352	cf::cleanup "db_env_open(db): $@" if $@;
2995	};	4353	};
2996	}	4354	}
		4355
		4356	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4357	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4358	};
		4359	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4360	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4361	};
		4362	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4363	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4364	};
		4365
		4366	info "database initialised";
2997	}	4367	}
2998		4368
2999	{	4369	{
		4370	# configure IO::AIO
		4371
		4372	info "initialising aio";
3000	IO::AIO::min_parallel 8;	4373	IO::AIO::min_parallel 8;
3001
3002	undef $Coro::AIO::WATCHER;
3003	IO::AIO::max_poll_time $TICK * 0.1;	4374	IO::AIO::max_poll_time $TICK * 0.1;
3004	$AIO_POLL_WATCHER = Event->io (	4375	undef $AnyEvent::AIO::WATCHER;
3005	reentrant => 0,	4376	info "aio initialised";
3006	data => WF_AUTOCANCEL,
3007	fd => IO::AIO::poll_fileno,
3008	poll => 'r',
3009	prio => 6,
3010	cb => \&IO::AIO::poll_cb,
3011	);
3012	}	4377	}
3013		4378
3014	my $_log_backtrace;	4379	our $_log_backtrace;
		4380	our $_log_backtrace_last;
3015		4381
3016	sub _log_backtrace {	4382	sub _log_backtrace {
3017	my ($msg, @addr) = @_;	4383	my ($msg, @addr) = @_;
3018		4384
3019	$msg =~ s/\n//;	4385	$msg =~ s/\n$//;
3020		4386
		4387	if ($_log_backtrace_last eq $msg) {
		4388	LOG llevInfo, "[ABT] $msg\n";
		4389	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
3021	# limit the # of concurrent backtraces	4390	# limit the # of concurrent backtraces
3022	if ($_log_backtrace < 2) {	4391	} elsif ($_log_backtrace < 2) {
		4392	$_log_backtrace_last = $msg;
3023	++$_log_backtrace;	4393	++$_log_backtrace;
		4394	my $perl_bt = Carp::longmess $msg;
3024	async {	4395	async {
		4396	$Coro::current->{desc} = "abt $msg";
		4397
3025	my @bt = fork_call {	4398	my @bt = fork_call {
3026	@addr = map { sprintf "%x", $_ } @addr;	4399	@addr = map { sprintf "%x", $_ } @addr;
3027	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;	4400	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3028	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"	4401	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3029	or die "addr2line: $!";	4402	or die "addr2line: $!";
…		…
3037	}	4410	}
3038		4411
3039	@funcs	4412	@funcs
3040	};	4413	};
3041		4414
3042	LOG llevInfo, "[ABT] $msg\n";	4415	LOG llevInfo, "[ABT] $perl_bt\n";
		4416	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3043	LOG llevInfo, "[ABT] $_\n" for @bt;	4417	LOG llevInfo, "[ABT] $_\n" for @bt;
3044	--$_log_backtrace;	4418	--$_log_backtrace;
3045	};	4419	};
3046	} else {	4420	} else {
3047	LOG llevInfo, "[ABT] $msg\n";	4421	LOG llevInfo, "[ABT] $msg\n";
3048	LOG llevInfo, "[ABT] [suppressed]\n";	4422	LOG llevInfo, "[ABT] [overload, suppressed]\n";
3049	}	4423	}
3050	}	4424	}
3051		4425
3052	# load additional modules	4426	# load additional modules
3053	use cf::pod;	4427	require "cf/$_.pm" for @EXTRA_MODULES;
		4428	cf::_connect_to_perl_2;
3054		4429
3055	END { cf::emergency_save }	4430	END { cf::emergency_save }
3056		4431
3057	1	4432	1
3058		4433

Diff Legend

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