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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.411 by root, Fri Feb 1 15:54:07 2008 UTC

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

Diff Legend

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