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

Diff Legend

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