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.239 by root, Mon Apr 16 06:23:42 2007 UTC vs.
Revision 1.624 by root, Sat Nov 17 23:40:02 2018 UTC

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

Diff Legend

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