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

Diff Legend

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