ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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