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.203 by root, Thu Feb 1 19:40:42 2007 UTC vs.
Revision 1.422 by root, Tue Apr 15 20:46:55 2008 UTC

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

Diff Legend

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