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.154 by root, Tue Jan 9 15:36:19 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		44
29	# 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?
30	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
31		47
32	$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
33		49
34	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
35		51
36	our %COMMAND = ();	52	our %COMMAND = ();
37	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
		54
		55	our @EXTS = (); # list of extension package names
38	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
		58	our %EXT_CORO = (); # coroutines bound to extensions
		59	our %EXT_MAP = (); # pluggable maps
39		60
		61	our $RELOAD; # number of reloads so far
40	our @EVENT;	62	our @EVENT;
41	our $LIBDIR = datadir . "/ext";
42		63
43	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(!)
44	our $TICK_WATCHER;	77	our $TICK_WATCHER;
		78	our $AIO_POLL_WATCHER;
		79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
45	our $NEXT_TICK;	80	our $NEXT_TICK;
46	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;
47		89
48	our %CFG;	90	our %CFG;
49		91
50	our $UPTIME; $UPTIME ||= time;	92	our $UPTIME; $UPTIME ||= time;
51	our $RUNTIME;	93	our $RUNTIME;
52		94
53	our %PLAYER; # all users	95	our (%PLAYER, %PLAYER_LOADING); # all users
54	our %MAP; # all maps	96	our (%MAP, %MAP_LOADING ); # all maps
55	our $LINK_MAP; # the special {link} map	97	our $LINK_MAP; # the special {link} map, which is always available
56	our $RANDOM_MAPS = cf::localdir . "/random";	98
57	our %EXT_CORO; # coroutines bound to extensions	99	# used to convert map paths into valid unix filenames by replacing / by ∕
		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
58		105
59	binmode STDOUT;	106	binmode STDOUT;
60	binmode STDERR;	107	binmode STDERR;
61		108
62	# read virtual server time, if available	109	# read virtual server time, if available
63	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	110	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
64	open my $fh, "<", cf::localdir . "/runtime"	111	open my $fh, "<", "$LOCALDIR/runtime"
65	or die "unable to read runtime file: $!";	112	or die "unable to read runtime file: $!";
66	$RUNTIME = <$fh> + 0.;	113	$RUNTIME = <$fh> + 0.;
67	}	114	}
68		115
69	mkdir cf::localdir;	116	mkdir $_
70	mkdir cf::localdir . "/" . cf::playerdir;	117	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
71	mkdir cf::localdir . "/" . cf::tmpdir;
72	mkdir cf::localdir . "/" . cf::uniquedir;
73	mkdir $RANDOM_MAPS;
74		118
75	# a special map that is always available
76	our $LINK_MAP;
77	our $EMERGENCY_POSITION;	119	our $EMERGENCY_POSITION;
		120
		121	sub cf::map::normalise;
78		122
79	#############################################################################	123	#############################################################################
80		124
81	=head2 GLOBAL VARIABLES	125	=head2 GLOBAL VARIABLES
82		126
…		…
89	=item $cf::RUNTIME	133	=item $cf::RUNTIME
90		134
91	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
92	every server tick.	136	every server tick.
93		137
94	=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
95		141
96	The perl library directory, where extensions and cf-specific modules can	142	Various directories - "/etc", read-only install directory, perl-library
97	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.
98		146
99	=item $cf::NOW	147	=item $cf::NOW
100		148
101	The time of the last (current) server tick.	149	The time of the last (current) server tick.
102		150
103	=item $cf::TICK	151	=item $cf::TICK
104		152
105	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.
106		164
107	=item %cf::CFG	165	=item %cf::CFG
108		166
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/crossfire/config>, or
110	from wherever your confdir points to.	168	from wherever your confdir points to.
		169
		170	=item cf::wait_for_tick, cf::wait_for_tick_begin
		171
		172	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		173	returns directly I<after> the tick processing (and consequently, can only wake one process
		174	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		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.
111		181
112	=back	182	=back
113		183
114	=cut	184	=cut
115		185
116	BEGIN {	186	BEGIN {
117	*CORE::GLOBAL::warn = sub {	187	*CORE::GLOBAL::warn = sub {
118	my $msg = join "", @_;	188	my $msg = join "", @_;
119	utf8::encode $msg;
120		189
121	$msg .= "\n"	190	$msg .= "\n"
122	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
		192
		193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
123		194
124	LOG llevError, $msg;	195	LOG llevError, $msg;
125	};	196	};
126	}	197	}
127		198
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	199	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	200	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	201	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	202	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@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';
133	@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)
134		206
135	# 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
136	# within the Safe compartment.	208	# within the Safe compartment.
137	for my $pkg (qw(	209	for my $pkg (qw(
138	cf::global cf::attachable	210	cf::global cf::attachable
…		…
147		219
148	$Event::DIED = sub {	220	$Event::DIED = sub {
149	warn "error in event callback: @_";	221	warn "error in event callback: @_";
150	};	222	};
151		223
152	my %ext_pkg;	224	#############################################################################
153	my @exts;
154	my @hook;
155		225
156	=head2 UTILITY FUNCTIONS	226	=head2 UTILITY FUNCTIONS
157		227
158	=over 4	228	=over 4
159		229
…		…
178	$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;
179	$d	249	$d
180	} || "[unable to dump $_[0]: '$@']";	250	} || "[unable to dump $_[0]: '$@']";
181	}	251	}
182		252
183	use JSON::Syck (); # TODO# replace by JSON::PC once working
184
185	=item $ref = cf::from_json $json	253	=item $ref = cf::from_json $json
186		254
187	Converts a JSON string into the corresponding perl data structure.	255	Converts a JSON string into the corresponding perl data structure.
188		256
189	=cut
190
191	sub from_json($) {
192	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
193	JSON::Syck::Load $_[0]
194	}
195
196	=item $json = cf::to_json $ref	257	=item $json = cf::to_json $ref
197		258
198	Converts a perl data structure into its JSON representation.	259	Converts a perl data structure into its JSON representation.
199		260
200	=cut	261	=cut
201		262
202	sub to_json($) {	263	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
203	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	264
204	JSON::Syck::Dump $_[0]	265	sub to_json ($) { $json_coder->encode ($_[0]) }
205	}	266	sub from_json ($) { $json_coder->decode ($_[0]) }
206		267
207	=item cf::lock_wait $string	268	=item cf::lock_wait $string
208		269
209	Wait until the given lock is available. See cf::lock_acquire.	270	Wait until the given lock is available. See cf::lock_acquire.
210		271
…		…
213	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
214	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,
215	for example when the coroutine gets canceled), the lock is automatically	276	for example when the coroutine gets canceled), the lock is automatically
216	returned.	277	returned.
217		278
		279	Locks are *not* recursive, locking from the same coro twice results in a
		280	deadlocked coro.
		281
218	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
219	uses map_find and cf::map::load uses map_load).	283	uses map_find and cf::map::load uses map_load).
220		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
221	=cut	289	=cut
222		290
223	our %LOCK;	291	our %LOCK;
		292	our %LOCKER;#d#
224		293
225	sub lock_wait($) {	294	sub lock_wait($) {
226	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#
227		301
228	# wait for lock, if any	302	# wait for lock, if any
229	while ($LOCK{$key}) {	303	while ($LOCK{$key}) {
230	push @{ $LOCK{$key} }, $Coro::current;	304	push @{ $LOCK{$key} }, $Coro::current;
231	Coro::schedule;	305	Coro::schedule;
…		…
237		311
238	# wait, to be sure we are not locked	312	# wait, to be sure we are not locked
239	lock_wait $key;	313	lock_wait $key;
240		314
241	$LOCK{$key} = [];	315	$LOCK{$key} = [];
		316	$LOCKER{$key} = $Coro::current;#d#
242		317
243	Coro::guard {	318	Coro::guard {
		319	delete $LOCKER{$key};#d#
244	# wake up all waiters, to be on the safe side	320	# wake up all waiters, to be on the safe side
245	$_->ready for @{ delete $LOCK{$key} };	321	$_->ready for @{ delete $LOCK{$key} };
246	}	322	}
247	}	323	}
248		324
		325	sub lock_active($) {
		326	my ($key) = @_;
		327
		328	! ! $LOCK{$key}
		329	}
		330
249	sub freeze_mainloop {	331	sub freeze_mainloop {
250	return unless $TICK_WATCHER->is_active;	332	return unless $TICK_WATCHER->is_active;
251		333
252	my $guard = Coro::guard { $TICK_WATCHER->start };	334	my $guard = Coro::guard {
		335	$TICK_WATCHER->start;
		336	};
253	$TICK_WATCHER->stop;	337	$TICK_WATCHER->stop;
254	$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;
255	}	397	}
256		398
257	=item cf::async { BLOCK }	399	=item cf::async { BLOCK }
258		400
259	Currently the same as Coro::async_pool, meaning you cannot use	401	Currently the same as Coro::async_pool, meaning you cannot use
…		…
264		406
265	BEGIN { *async = \&Coro::async_pool }	407	BEGIN { *async = \&Coro::async_pool }
266		408
267	=item cf::sync_job { BLOCK }	409	=item cf::sync_job { BLOCK }
268		410
269	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)
270	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
271	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.
272		415
273	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
274	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
275	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
276	fast or be very important.	419	fast or be very important.
…		…
279		422
280	sub sync_job(&) {	423	sub sync_job(&) {
281	my ($job) = @_;	424	my ($job) = @_;
282		425
283	if ($Coro::current == $Coro::main) {	426	if ($Coro::current == $Coro::main) {
		427	my $time = Event::time;
		428
284	# this is the main coro, too bad, we have to block	429	# this is the main coro, too bad, we have to block
285	# till the operation succeeds, freezing the server :/	430	# till the operation succeeds, freezing the server :/
286		431
287	# TODO: use suspend/resume instead	432	# TODO: use suspend/resume instead
288	# (but this is cancel-safe)	433	# (but this is cancel-safe)
…		…
290		435
291	my $busy = 1;	436	my $busy = 1;
292	my @res;	437	my @res;
293		438
294	(async {	439	(async {
		440	$Coro::current->desc ("sync job coro");
295	@res = eval { $job->() };	441	@res = eval { $job->() };
296	warn $@ if $@;	442	warn $@ if $@;
297	undef $busy;	443	undef $busy;
298	})->prio (Coro::PRIO_MAX);	444	})->prio (Coro::PRIO_MAX);
299		445
300	while ($busy) {	446	while ($busy) {
301	Coro::cede or Event::one_event;	447	Coro::cede or Event::one_event;
302	}	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
303		456
304	wantarray ? @res : $res[0]	457	wantarray ? @res : $res[0]
305	} else {	458	} else {
306	# we are in another coroutine, how wonderful, everything just works	459	# we are in another coroutine, how wonderful, everything just works
307		460
…		…
309	}	462	}
310	}	463	}
311		464
312	=item $coro = cf::async_ext { BLOCK }	465	=item $coro = cf::async_ext { BLOCK }
313		466
314	Like async, but this coro is automcatially being canceled when the	467	Like async, but this coro is automatically being canceled when the
315	extension calling this is being unloaded.	468	extension calling this is being unloaded.
316		469
317	=cut	470	=cut
318		471
319	sub async_ext(&) {	472	sub async_ext(&) {
…		…
327	$EXT_CORO{$coro+0} = $coro;	480	$EXT_CORO{$coro+0} = $coro;
328		481
329	$coro	482	$coro
330	}	483	}
331		484
332	sub write_runtime {	485	=item fork_call { }, $args
333	my $runtime = cf::localdir . "/runtime";
334		486
335	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	487	Executes the given code block with the given arguments in a seperate
336	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.
337		491
338	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	492	=cut
339	(aio_write $fh, 0, (length $value), $value, 0) <= 0
340	and return;
341		493
342	aio_fsync $fh	494	sub fork_call(&@) {
343	and return;	495	my ($cb, @args) = @_;
344		496
345	close $fh	497	# we seemingly have to make a local copy of the whole thing,
346	or return;	498	# otherwise perl prematurely frees the stuff :/
		499	# TODO: investigate and fix (likely this will be rather laborious)
347		500
348	aio_rename "$runtime~", $runtime	501	my @res = Coro::Util::fork_eval {
349	and return;	502	reset_signals;
		503	&$cb
		504	}, @args;
350		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
351	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 });
352	}	645	}
353		646
354	=back	647	=back
355		648
356	=cut	649	=cut
357
358	#############################################################################
359
360	package cf::path;
361
362	# used to convert map paths into valid unix filenames by repalcing / by ∕
363	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
364
365	sub new {
366	my ($class, $path, $base) = @_;
367
368	$path = $path->as_string if ref $path;
369
370	my $self = bless { }, $class;
371
372	# {... are special paths that are not touched
373	# ?xxx/... are special absolute paths
374	# ?random/... random maps
375	# /! non-realised random map exit
376	# /... normal maps
377	# ~/... per-player maps without a specific player (DO NOT USE)
378	# ~user/... per-player map of a specific user
379
380	if ($path =~ /^{/) {
381	# fine as it is
382	} elsif ($path =~ s{^\?random/}{}) {
383	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
384	$self->{random} = cf::from_json $data;
385	} else {
386	if ($path =~ s{^~([^/]+)?}{}) {
387	$self->{user_rel} = 1;
388
389	if (defined $1) {
390	$self->{user} = $1;
391	} elsif ($base =~ m{^~([^/]+)/}) {
392	$self->{user} = $1;
393	} else {
394	warn "cannot resolve user-relative path without user <$path,$base>\n";
395	}
396	} elsif ($path =~ /^\//) {
397	# already absolute
398	} else {
399	$base =~ s{[^/]+/?$}{};
400	return $class->new ("$base/$path");
401	}
402
403	for ($path) {
404	redo if s{/\.?/}{/};
405	redo if s{/[^/]+/\.\./}{/};
406	}
407	}
408
409	$self->{path} = $path;
410
411	$self
412	}
413
414	# the name / primary key / in-game path
415	sub as_string {
416	my ($self) = @_;
417
418	$self->{user_rel} ? "~$self->{user}$self->{path}"
419	: $self->{random} ? "?random/$self->{path}"
420	: $self->{path}
421	}
422
423	# the displayed name, this is a one way mapping
424	sub visible_name {
425	my ($self) = @_;
426
427	# if (my $rmp = $self->{random}) {
428	# # todo: be more intelligent about this
429	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
430	# } else {
431	$self->as_string
432	# }
433	}
434
435	# escape the /'s in the path
436	sub _escaped_path {
437	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
438	$path
439	}
440
441	# the original (read-only) location
442	sub load_path {
443	my ($self) = @_;
444
445	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
446	}
447
448	# the temporary/swap location
449	sub save_path {
450	my ($self) = @_;
451
452	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
453	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
454	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
455	}
456
457	# the unique path, might be eq to save_path
458	sub uniq_path {
459	my ($self) = @_;
460
461	$self->{user_rel} || $self->{random}
462	? undef
463	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
464	}
465
466	# return random map parameters, or undef
467	sub random_map_params {
468	my ($self) = @_;
469
470	$self->{random}
471	}
472
473	# this is somewhat ugly, but style maps do need special treatment
474	sub is_style_map {
475	$_[0]{path} =~ m{^/styles/}
476	}
477
478	package cf;
479		650
480	#############################################################################	651	#############################################################################
481		652
482	=head2 ATTACHABLE OBJECTS	653	=head2 ATTACHABLE OBJECTS
483		654
…		…
485	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")
486	to it. All such attachable objects support the following methods.	657	to it. All such attachable objects support the following methods.
487		658
488	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>
489	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
490	crossfire+).	661	Crossfire TRT).
491		662
492	=over 4	663	=over 4
493		664
494	=item $attachable->attach ($attachment, key => $value...)	665	=item $attachable->attach ($attachment, key => $value...)
495		666
…		…
609	our @CB_TYPE = (); # registry for type (cf-object class) based events	780	our @CB_TYPE = (); # registry for type (cf-object class) based events
610	our @CB_MAP = ();	781	our @CB_MAP = ();
611		782
612	my %attachment;	783	my %attachment;
613		784
		785	sub cf::attachable::thawer_merge {
		786	# simply override everything except _meta
		787	local $_[0]{_meta};
		788	%{$_[0]} = %{$_[1]};
		789	}
		790
614	sub _attach_cb($$$$) {	791	sub _attach_cb($$$$) {
615	my ($registry, $event, $prio, $cb) = @_;	792	my ($registry, $event, $prio, $cb) = @_;
616		793
617	use sort 'stable';	794	use sort 'stable';
618		795
…		…
652	$registry = $CB_TYPE[$object_type] ||= [];	829	$registry = $CB_TYPE[$object_type] ||= [];
653		830
654	} elsif ($type eq "subtype") {	831	} elsif ($type eq "subtype") {
655	defined $object_type or Carp::croak "subtype specified without type";	832	defined $object_type or Carp::croak "subtype specified without type";
656	my $object_subtype = shift @arg;	833	my $object_subtype = shift @arg;
657	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	834	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
658		835
659	} elsif ($type eq "package") {	836	} elsif ($type eq "package") {
660	my $pkg = shift @arg;	837	my $pkg = shift @arg;
661		838
662	while (my ($name, $id) = each %cb_id) {	839	while (my ($name, $id) = each %cb_id) {
…		…
691	_attach $registry, $klass, @attach;	868	_attach $registry, $klass, @attach;
692	}	869	}
693		870
694	$obj->{$name} = \%arg;	871	$obj->{$name} = \%arg;
695	} else {	872	} else {
696	warn "object uses attachment '$name' that is not available, postponing.\n";	873	warn "object uses attachment '$name' which is not available, postponing.\n";
697	}	874	}
698		875
699	$obj->{_attachment}{$name} = undef;	876	$obj->{_attachment}{$name} = undef;
700	}	877	}
701		878
…		…
703	if (ref $_[0]) {	880	if (ref $_[0]) {
704	_object_attach @_;	881	_object_attach @_;
705	} else {	882	} else {
706	_attach shift->_attach_registry, @_;	883	_attach shift->_attach_registry, @_;
707	}	884	}
		885	_recalc_want;
708	};	886	};
709		887
710	# all those should be optimised	888	# all those should be optimised
711	sub cf::attachable::detach {	889	sub cf::attachable::detach {
712	my ($obj, $name) = @_;	890	my ($obj, $name) = @_;
…		…
715	delete $obj->{_attachment}{$name};	893	delete $obj->{_attachment}{$name};
716	reattach ($obj);	894	reattach ($obj);
717	} else {	895	} else {
718	Carp::croak "cannot, currently, detach class attachments";	896	Carp::croak "cannot, currently, detach class attachments";
719	}	897	}
		898	_recalc_want;
720	};	899	};
721		900
722	sub cf::attachable::attached {	901	sub cf::attachable::attached {
723	my ($obj, $name) = @_;	902	my ($obj, $name) = @_;
724		903
…		…
739	";	918	";
740	die if $@;	919	die if $@;
741	}	920	}
742		921
743	our $override;	922	our $override;
744	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?
745		924
746	sub override {	925	sub override {
747	$override = 1;	926	$override = 1;
748	@invoke_results = ();	927	@INVOKE_RESULTS = (@_);
749	}	928	}
750		929
751	sub do_invoke {	930	sub do_invoke {
752	my $event = shift;	931	my $event = shift;
753	my $callbacks = shift;	932	my $callbacks = shift;
754		933
755	@invoke_results = ();	934	@INVOKE_RESULTS = ();
756		935
757	local $override;	936	local $override;
758		937
759	for (@$callbacks) {	938	for (@$callbacks) {
760	eval { &{$_->[1]} };	939	eval { &{$_->[1]} };
…		…
777		956
778	Generate an object-specific event with the given arguments.	957	Generate an object-specific event with the given arguments.
779		958
780	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
781	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
782	results (if you must, access C<@cf::invoke_results> directly).	961	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
783		962
784	=back	963	=back
785		964
786	=cut	965	=cut
787		966
788	#############################################################################	967	#############################################################################
789	# 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	}
790		980
791	sub reattach {	981	sub reattach {
792	# basically do the same as instantiate, without calling instantiate	982	# basically do the same as instantiate, without calling instantiate
793	my ($obj) = @_;	983	my ($obj) = @_;
		984
		985	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
794		986
795	my $registry = $obj->registry;	987	my $registry = $obj->registry;
796		988
797	@$registry = ();	989	@$registry = ();
798		990
…		…
839	sub object_freezer_save {	1031	sub object_freezer_save {
840	my ($filename, $rdata, $objs) = @_;	1032	my ($filename, $rdata, $objs) = @_;
841		1033
842	sync_job {	1034	sync_job {
843	if (length $$rdata) {	1035	if (length $$rdata) {
		1036	utf8::decode (my $decname = $filename);
844	warn sprintf "saving %s (%d,%d)\n",	1037	warn sprintf "saving %s (%d,%d)\n",
845	$filename, length $$rdata, scalar @$objs;	1038	$decname, length $$rdata, scalar @$objs;
846		1039
847	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1040	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
848	chmod SAVE_MODE, $fh;	1041	chmod SAVE_MODE, $fh;
849	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1042	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
850	aio_fsync $fh;	1043	aio_fsync $fh if $cf::USE_FSYNC;
851	close $fh;	1044	close $fh;
852		1045
853	if (@$objs) {	1046	if (@$objs) {
854	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) {
855	chmod SAVE_MODE, $fh;	1048	chmod SAVE_MODE, $fh;
856	my $data = Storable::nfreeze { version => 1, objs => $objs };	1049	my $data = Storable::nfreeze { version => 1, objs => $objs };
857	aio_write $fh, 0, (length $data), $data, 0;	1050	aio_write $fh, 0, (length $data), $data, 0;
858	aio_fsync $fh;	1051	aio_fsync $fh if $cf::USE_FSYNC;
859	close $fh;	1052	close $fh;
860	aio_rename "$filename.pst~", "$filename.pst";	1053	aio_rename "$filename.pst~", "$filename.pst";
861	}	1054	}
862	} else {	1055	} else {
863	aio_unlink "$filename.pst";	1056	aio_unlink "$filename.pst";
…		…
869	}	1062	}
870	} else {	1063	} else {
871	aio_unlink $filename;	1064	aio_unlink $filename;
872	aio_unlink "$filename.pst";	1065	aio_unlink "$filename.pst";
873	}	1066	}
874	}	1067	};
875	}	1068	}
876		1069
877	sub object_freezer_as_string {	1070	sub object_freezer_as_string {
878	my ($rdata, $objs) = @_;	1071	my ($rdata, $objs) = @_;
879		1072
…		…
891	or return;	1084	or return;
892		1085
893	unless (aio_stat "$filename.pst") {	1086	unless (aio_stat "$filename.pst") {
894	(aio_load "$filename.pst", $av) >= 0	1087	(aio_load "$filename.pst", $av) >= 0
895	or return;	1088	or return;
		1089
896	$av = eval { (Storable::thaw $av)->{objs} };	1090	$av = eval { (Storable::thaw $av)->{objs} };
897	}	1091	}
898		1092
		1093	utf8::decode (my $decname = $filename);
899	warn sprintf "loading %s (%d)\n",	1094	warn sprintf "loading %s (%d,%d)\n",
900	$filename, length $data, scalar @{$av || []};#d#	1095	$decname, length $data, scalar @{$av || []};
		1096
901	return ($data, $av);	1097	($data, $av)
902	}	1098	}
		1099
		1100	=head2 COMMAND CALLBACKS
		1101
		1102	=over 4
		1103
		1104	=cut
903		1105
904	#############################################################################	1106	#############################################################################
905	# command handling &c	1107	# command handling &c
906		1108
907	=item cf::register_command $name => \&callback($ob,$args);	1109	=item cf::register_command $name => \&callback($ob,$args);
…		…
920	push @{ $COMMAND{$name} }, [$caller, $cb];	1122	push @{ $COMMAND{$name} }, [$caller, $cb];
921	}	1123	}
922		1124
923	=item cf::register_extcmd $name => \&callback($pl,$packet);	1125	=item cf::register_extcmd $name => \&callback($pl,$packet);
924		1126
925	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.
926		1132
927	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
928	called.	1134	called.
929		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
930	=cut	1147	=cut
931		1148
932	sub register_extcmd {	1149	sub register_extcmd {
933	my ($name, $cb) = @_;	1150	my ($name, $cb) = @_;
934		1151
935	my $caller = caller;
936	#warn "registering extcmd '$name' to '$caller'";
937
938	$EXTCMD{$name} = [$cb, $caller];	1152	$EXTCMD{$name} = $cb;
		1153	}
		1154
		1155	sub register_exticmd {
		1156	my ($name, $cb) = @_;
		1157
		1158	$EXTICMD{$name} = $cb;
939	}	1159	}
940		1160
941	cf::player->attach (	1161	cf::player->attach (
942	on_command => sub {	1162	on_command => sub {
943	my ($pl, $name, $params) = @_;	1163	my ($pl, $name, $params) = @_;
…		…
952	cf::override;	1172	cf::override;
953	},	1173	},
954	on_extcmd => sub {	1174	on_extcmd => sub {
955	my ($pl, $buf) = @_;	1175	my ($pl, $buf) = @_;
956		1176
957	my $msg = eval { from_json $buf };	1177	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
958		1178
959	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
960	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1187	if (my $cb = $EXTCMD{$type}) {
961	if (my %reply = $cb->[0]->($pl, $msg)) {	1188	@reply = $cb->($pl, @payload);
962	$pl->ext_reply ($msg->{msgid}, %reply);
963	}
964	}	1189	}
		1190
		1191	$pl->ext_reply ($reply, @reply)
		1192	if $reply;
		1193
965	} else {	1194	} else {
966	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1195	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
967	}	1196	}
968		1197
969	cf::override;	1198	cf::override;
970	},	1199	},
971	);	1200	);
972		1201
973	sub register {
974	my ($base, $pkg) = @_;
975
976	#TODO
977	}
978
979	sub load_extension {
980	my ($path) = @_;
981
982	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
983	my $base = $1;
984	my $pkg = $1;
985	$pkg =~ s/[^[:word:]]/_/g;
986	$pkg = "ext::$pkg";
987
988	warn "loading '$path' into '$pkg'\n";
989
990	open my $fh, "<:utf8", $path
991	or die "$path: $!";
992
993	my $source =
994	"package $pkg; use strict; use utf8;\n"
995	. "#line 1 \"$path\"\n{\n"
996	. (do { local $/; <$fh> })
997	. "\n};\n1";
998
999	eval $source
1000	or die $@ ? "$path: $@\n"
1001	: "extension disabled.\n";
1002
1003	push @exts, $pkg;
1004	$ext_pkg{$base} = $pkg;
1005
1006	# no strict 'refs';
1007	# @{"$pkg\::ISA"} = ext::;
1008
1009	register $base, $pkg;
1010	}
1011
1012	sub unload_extension {
1013	my ($pkg) = @_;
1014
1015	warn "removing extension $pkg\n";
1016
1017	# remove hooks
1018	#TODO
1019	# for my $idx (0 .. $#PLUGIN_EVENT) {
1020	# delete $hook[$idx]{$pkg};
1021	# }
1022
1023	# remove commands
1024	for my $name (keys %COMMAND) {
1025	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1026
1027	if (@cb) {
1028	$COMMAND{$name} = \@cb;
1029	} else {
1030	delete $COMMAND{$name};
1031	}
1032	}
1033
1034	# remove extcmds
1035	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1036	delete $EXTCMD{$name};
1037	}
1038
1039	if (my $cb = $pkg->can ("unload")) {
1040	eval {
1041	$cb->($pkg);
1042	1
1043	} or warn "$pkg unloaded, but with errors: $@";
1044	}
1045
1046	Symbol::delete_package $pkg;
1047	}
1048
1049	sub load_extensions {	1202	sub load_extensions {
		1203	cf::sync_job {
		1204	my %todo;
		1205
1050	for my $ext (<$LIBDIR/*.ext>) {	1206	for my $path (<$LIBDIR/*.ext>) {
1051	next unless -r $ext;	1207	next unless -r $path;
1052	eval {	1208
1053	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;
1054	1	1266	}
1055	} or warn "$ext not loaded: $@";	1267
		1268	skip:
		1269	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1270	unless $progress;
		1271	}
1056	}	1272	};
1057	}	1273	}
1058		1274
1059	#############################################################################	1275	#############################################################################
1060	# load/save/clean perl data associated with a map
1061		1276
1062	*cf::mapsupport::on_clean = sub {	1277	=back
1063	my ($map) = @_;
1064
1065	my $path = $map->tmpname;
1066	defined $path or return;
1067
1068	unlink "$path.pst";
1069	};
1070
1071	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1072
1073	#############################################################################
1074	# load/save perl data associated with player->ob objects
1075
1076	sub all_objects(@) {
1077	@_, map all_objects ($_->inv), @_
1078	}
1079
1080	# TODO: compatibility cruft, remove when no longer needed
1081	cf::player->attach (
1082	on_load => sub {
1083	my ($pl, $path) = @_;
1084
1085	for my $o (all_objects $pl->ob) {
1086	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1087	$o->set_ob_key_value ("_perl_data");
1088
1089	%$o = %{ Storable::thaw pack "H*", $value };
1090	}
1091	}
1092	},
1093	);
1094
1095	#############################################################################
1096		1278
1097	=head2 CORE EXTENSIONS	1279	=head2 CORE EXTENSIONS
1098		1280
1099	Functions and methods that extend core crossfire objects.	1281	Functions and methods that extend core crossfire objects.
1100		1282
…		…
1106		1288
1107	=head3 cf::player	1289	=head3 cf::player
1108		1290
1109	=over 4	1291	=over 4
1110		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
1111	=item cf::player::find $login	1307	=item cf::player::find $login
1112		1308
1113	Returns the given player object, loading it if necessary (might block).	1309	Returns the given player object, loading it if necessary (might block).
1114		1310
1115	=cut	1311	=cut
1116		1312
1117	sub playerdir($) {	1313	sub playerdir($) {
1118	cf::localdir	1314	"$PLAYERDIR/"
1119	. "/"
1120	. cf::playerdir
1121	. "/"
1122	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1315	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1123	}	1316	}
1124		1317
1125	sub path($) {	1318	sub path($) {
1126	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1319	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1127		1320
1128	(playerdir $login) . "/$login.pl"	1321	(playerdir $login) . "/playerdata"
1129	}	1322	}
1130		1323
1131	sub find_active($) {	1324	sub find_active($) {
1132	$cf::PLAYER{$_[0]}	1325	$cf::PLAYER{$_[0]}
1133	and $cf::PLAYER{$_[0]}->active	1326	and $cf::PLAYER{$_[0]}->active
…		…
1136		1329
1137	sub exists($) {	1330	sub exists($) {
1138	my ($login) = @_;	1331	my ($login) = @_;
1139		1332
1140	$cf::PLAYER{$login}	1333	$cf::PLAYER{$login}
1141	or cf::sync_job { !aio_stat $login }	1334	or cf::sync_job { !aio_stat path $login }
1142	}	1335	}
1143		1336
1144	sub find($) {	1337	sub find($) {
1145	return $cf::PLAYER{$_[0]} || do {	1338	return $cf::PLAYER{$_[0]} || do {
1146	my $login = $_[0];	1339	my $login = $_[0];
1147		1340
1148	my $guard = cf::lock_acquire "user_find:$login";	1341	my $guard = cf::lock_acquire "user_find:$login";
1149		1342
1150	$cf::PLAYER{$_[0]} || do {	1343	$cf::PLAYER{$_[0]} || do {
1151	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
1152	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;
1153	$cf::PLAYER{$login} = $pl	1358	$cf::PLAYER{$login} = $pl
1154	}	1359	}
1155	}	1360	}
1156	}	1361	}
1157		1362
…		…
1167		1372
1168	aio_mkdir playerdir $pl, 0770;	1373	aio_mkdir playerdir $pl, 0770;
1169	$pl->{last_save} = $cf::RUNTIME;	1374	$pl->{last_save} = $cf::RUNTIME;
1170		1375
1171	$pl->save_pl ($path);	1376	$pl->save_pl ($path);
1172	Coro::cede;	1377	cf::cede_to_tick;
1173	}	1378	}
1174		1379
1175	sub new($) {	1380	sub new($) {
1176	my ($login) = @_;	1381	my ($login) = @_;
1177		1382
…		…
1183	$cf::PLAYER{$login} = $self;	1388	$cf::PLAYER{$login} = $self;
1184		1389
1185	$self	1390	$self
1186	}	1391	}
1187		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
1188	=item $pl->quit_character	1403	=item $pl->quit_character
1189		1404
1190	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
1191	be destroyed. May block for a long time.	1406	be destroyed. May block for a long time.
1192		1407
1193	=cut	1408	=cut
1194		1409
1195	sub quit_character {	1410	sub quit_character {
1196	my ($pl) = @_;	1411	my ($pl) = @_;
		1412
		1413	my $name = $pl->ob->name;
1197		1414
1198	$pl->{deny_save} = 1;	1415	$pl->{deny_save} = 1;
1199	$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
1200		1417
1201	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1418	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1206	my $path = playerdir $pl;	1423	my $path = playerdir $pl;
1207	my $temp = "$path~$cf::RUNTIME~deleting~";	1424	my $temp = "$path~$cf::RUNTIME~deleting~";
1208	aio_rename $path, $temp;	1425	aio_rename $path, $temp;
1209	delete $cf::PLAYER{$pl->ob->name};	1426	delete $cf::PLAYER{$pl->ob->name};
1210	$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
1211	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;
1212	}	1449	}
1213		1450
1214	=item cf::player::list_logins	1451	=item cf::player::list_logins
1215		1452
1216	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
1217	while and may block, so not sync_job-capable, ever.	1454	while and may block, so not sync_job-capable, ever.
1218		1455
1219	=cut	1456	=cut
1220		1457
1221	sub list_logins {	1458	sub list_logins {
1222	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1459	my $dirs = aio_readdir $PLAYERDIR
1223	or return [];	1460	or return [];
1224		1461
1225	my @logins;	1462	my @logins;
1226		1463
1227	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") {
1228	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1469	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1229	aio_read $fh, 0, 512, my $buf, 0 or next;	1470	aio_read $fh, 0, 512, my $buf, 0 or next;
1230	$buf !~ /^password -------------$/ or next; # official not-valid tag	1471	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1472	}
1231		1473
1232	utf8::decode $login;	1474	utf8::decode $login;
1233	push @logins, $login;	1475	push @logins, $login;
1234	}	1476	}
1235		1477
1236	\@logins	1478	\@logins
1237	}	1479	}
1238		1480
1239	=item $player->maps	1481	=item $player->maps
1240		1482
1241	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
1242	player. May block.	1484	player. May block.
1243		1485
1244	=cut	1486	=cut
1245		1487
1246	sub maps($) {	1488	sub maps($) {
1247	my ($pl) = @_;	1489	my ($pl) = @_;
		1490
		1491	$pl = ref $pl ? $pl->ob->name : $pl;
1248		1492
1249	my $files = aio_readdir playerdir $pl	1493	my $files = aio_readdir playerdir $pl
1250	or return;	1494	or return;
1251		1495
1252	my @paths;	1496	my @paths;
1253		1497
1254	for (@$files) {	1498	for (@$files) {
1255	utf8::decode $_;	1499	utf8::decode $_;
1256	next if /\.(?:pl|pst)$/;	1500	next if /\.(?:pl|pst)$/;
1257	next unless /^$PATH_SEP/;	1501	next unless /^$PATH_SEP/o;
1258		1502
1259	s/$PATH_SEP/\//g;	1503	push @paths, cf::map::normalise "~$pl/$_";
1260	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1261	}	1504	}
1262		1505
1263	\@paths	1506	\@paths
1264	}	1507	}
1265		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
1266	=item $player->ext_reply ($msgid, $msgtype, %msg)	1560	=item $player->ext_reply ($msgid, @msg)
1267		1561
1268	Sends an ext reply to the player.	1562	Sends an ext reply to the player.
1269		1563
1270	=cut	1564	=cut
1271		1565
1272	sub ext_reply($$$%) {	1566	sub ext_reply($$@) {
1273	my ($self, $id, %msg) = @_;	1567	my ($self, $id, @msg) = @_;
1274		1568
1275	$msg{msgid} = $id;	1569	$self->ns->ext_reply ($id, @msg)
1276
1277	$self->send ("ext " . cf::to_json \%msg);
1278	}	1570	}
1279		1571
1280	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	}
1281		1612
1282	=back	1613	=back
1283
1284		1614
1285	=head3 cf::map	1615	=head3 cf::map
1286		1616
1287	=over 4	1617	=over 4
1288		1618
…		…
1291	package cf::map;	1621	package cf::map;
1292		1622
1293	use Fcntl;	1623	use Fcntl;
1294	use Coro::AIO;	1624	use Coro::AIO;
1295		1625
		1626	use overload
		1627	'""' => \&as_string,
		1628	fallback => 1;
		1629
1296	our $MAX_RESET = 3600;	1630	our $MAX_RESET = 3600;
1297	our $DEFAULT_RESET = 3000;	1631	our $DEFAULT_RESET = 3000;
1298		1632
1299	sub generate_random_map {	1633	sub generate_random_map {
1300	my ($path, $rmp) = @_;	1634	my ($self, $rmp) = @_;
1301
1302	# mit "rum" bekleckern, nicht	1635	# mit "rum" bekleckern, nicht
1303	cf::map::_create_random_map	1636	$self->_create_random_map (
1304	$path,
1305	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1637	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1306	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1638	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1307	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1639	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1308	$rmp->{exit_on_final_map},	1640	$rmp->{exit_on_final_map},
1309	$rmp->{xsize}, $rmp->{ysize},	1641	$rmp->{xsize}, $rmp->{ysize},
1310	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1642	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1311	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1643	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1312	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1644	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1313	$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},
1314	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1646	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1315	(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"
1316	}	1776	}
1317		1777
1318	# and all this just because we cannot iterate over	1778	# and all this just because we cannot iterate over
1319	# all maps in C++...	1779	# all maps in C++...
1320	sub change_all_map_light {	1780	sub change_all_map_light {
…		…
1322		1782
1323	$_->change_map_light ($change)	1783	$_->change_map_light ($change)
1324	for grep $_->outdoor, values %cf::MAP;	1784	for grep $_->outdoor, values %cf::MAP;
1325	}	1785	}
1326		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
1327	sub try_load_header($) {	1803	sub load_header_from($) {
1328	my ($path) = @_;	1804	my ($self, $path) = @_;
1329		1805
1330	utf8::encode $path;	1806	utf8::encode $path;
1331	aio_open $path, O_RDONLY, 0	1807	my $f = new_from_file cf::object::thawer $path
1332	or return;	1808	or return;
1333		1809
1334	my $map = cf::map::new	1810	$self->_load_header ($f)
1335	or return;	1811	or return;
1336		1812
1337	# for better error messages only, will be overwritten	1813	local $MAP_LOADING{$self->{path}} = $self;
1338	$map->path ($path);	1814	$f->resolve_delayed_derefs;
1339		1815
1340	$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
1341	or return;	1859	or return;
		1860	$self->prepare_orig;
		1861	}
1342		1862
1343	$map->{load_path} = $path;	1863	$self->{deny_reset} = 1
		1864	if $self->no_reset;
1344		1865
1345	$map	1866	$self->default_region (cf::region::find_by_path $self->{path})
		1867	unless $self->default_region;
		1868
		1869	1
1346	}	1870	}
1347		1871
1348	sub find;	1872	sub find;
1349	sub find {	1873	sub find {
1350	my ($path, $origin) = @_;	1874	my ($path, $origin) = @_;
1351		1875
1352	#warn "find<$path,$origin>\n";#d#
1353
1354	$path = new cf::path $path, $origin && $origin->path;	1876	$path = normalise $path, $origin && $origin->path;
1355	my $key = $path->as_string;
1356		1877
		1878	cf::lock_wait "map_data:$path";#d#remove
1357	cf::lock_wait "map_find:$key";	1879	cf::lock_wait "map_find:$path";
1358		1880
1359	$cf::MAP{$key} || do {	1881	$cf::MAP{$path} || do {
1360	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
1361		1884
1362	# do it the slow way	1885	my $map = new_from_path cf::map $path
1363	my $map = try_load_header $path->save_path;
1364
1365	Coro::cede;
1366
1367	if ($map) {
1368	$map->last_access ((delete $map->{last_access})
1369	|| $cf::RUNTIME); #d#
1370	# safety
1371	$map->{instantiate_time} = $cf::RUNTIME
1372	if $map->{instantiate_time} > $cf::RUNTIME;
1373	} else {
1374	if (my $rmp = $path->random_map_params) {
1375	$map = generate_random_map $key, $rmp;
1376	} else {
1377	$map = try_load_header $path->load_path;
1378	}
1379
1380	$map or return;	1886	or return;
1381		1887
1382	$map->{load_original} = 1;
1383	$map->{instantiate_time} = $cf::RUNTIME;
1384	$map->last_access ($cf::RUNTIME);
1385	$map->instantiate;
1386
1387	# per-player maps become, after loading, normal maps
1388	$map->per_player (0) if $path->{user_rel};
1389	}
1390
1391	$map->path ($key);
1392	$map->{path} = $path;
1393	$map->{last_save} = $cf::RUNTIME;	1888	$map->{last_save} = $cf::RUNTIME;
1394		1889
1395	Coro::cede;	1890	$map->load_header
		1891	or return;
1396		1892
1397	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;
1398	$map->reset;	1898	$map->reset;
1399	undef $guard;
1400	$map = find $path	1899	return find $path;
1401	or return;
1402	}	1900	}
1403		1901
1404	$cf::MAP{$key} = $map	1902	$cf::MAP{$path} = $map
1405	}	1903	}
1406	}	1904	}
		1905
		1906	sub pre_load { }
		1907	sub post_load { }
1407		1908
1408	sub load {	1909	sub load {
1409	my ($self) = @_;	1910	my ($self) = @_;
1410		1911
		1912	local $self->{deny_reset} = 1; # loading can take a long time
		1913
1411	my $path = $self->{path};	1914	my $path = $self->{path};
		1915
		1916	{
1412	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1917	my $guard = cf::lock_acquire "map_data:$path";
1413		1918
		1919	return unless $self->valid;
1414	return if $self->in_memory != cf::MAP_SWAPPED;	1920	return unless $self->in_memory == cf::MAP_SWAPPED;
1415		1921
1416	$self->in_memory (cf::MAP_LOADING);	1922	$self->in_memory (cf::MAP_LOADING);
1417		1923
1418	$self->alloc;	1924	$self->alloc;
1419	$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)
1420	or return;	1932	or return;
1421		1933
1422	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1934	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1423	if delete $self->{load_original};	1935	if delete $self->{load_original};
1424		1936
1425	if (my $uniq = $path->uniq_path) {	1937	if (my $uniq = $self->uniq_path) {
1426	utf8::encode $uniq;	1938	utf8::encode $uniq;
1427	if (aio_open $uniq, O_RDONLY, 0) {	1939	unless (aio_stat $uniq) {
		1940	if (my $f = new_from_file cf::object::thawer $uniq) {
1428	$self->clear_unique_items;	1941	$self->clear_unique_items;
1429	$self->load_objects ($uniq, 0);	1942	$self->_load_objects ($f);
		1943	$f->resolve_delayed_derefs;
		1944	}
1430	}	1945	}
1431	}	1946	}
1432		1947
1433	Coro::cede;	1948	$f->resolve_delayed_derefs;
1434		1949
		1950	cf::cede_to_tick;
1435	# now do the right thing for maps	1951	# now do the right thing for maps
1436	$self->link_multipart_objects;	1952	$self->link_multipart_objects;
1437
1438	if ($self->{path}->is_style_map) {
1439	$self->{deny_save} = 1;
1440	$self->{deny_reset} = 1;
1441	} else {
1442	$self->fix_auto_apply;
1443	$self->decay_objects;
1444	$self->update_buttons;
1445	$self->set_darkness_map;
1446	$self->difficulty ($self->estimate_difficulty)	1953	$self->difficulty ($self->estimate_difficulty)
1447	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;
1448	$self->activate;	1964	$self->activate;
1449	}	1965	}
1450		1966
1451	Coro::cede;	1967	$self->{last_save} = $cf::RUNTIME;
		1968	$self->last_access ($cf::RUNTIME);
1452		1969
1453	$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
		1986	}
		1987
		1988	# find and load all maps in the 3x3 area around a map
		1989	sub load_neighbours {
		1990	my ($map) = @_;
		1991
		1992	my @neigh; # diagonal neighbours
		1993
		1994	for (0 .. 3) {
		1995	my $neigh = $map->tile_path ($_)
		1996	or next;
		1997	$neigh = find $neigh, $map
		1998	or next;
		1999	$neigh->load;
		2000
		2001	push @neigh,
		2002	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2003	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2004	}
		2005
		2006	for (grep defined $_->[0], @neigh) {
		2007	my ($path, $origin) = @$_;
		2008	my $neigh = find $path, $origin
		2009	or next;
		2010	$neigh->load;
		2011	}
1454	}	2012	}
1455		2013
1456	sub find_sync {	2014	sub find_sync {
1457	my ($path, $origin) = @_;	2015	my ($path, $origin) = @_;
1458		2016
1459	cf::sync_job { cf::map::find $path, $origin }	2017	cf::sync_job { find $path, $origin }
1460	}	2018	}
1461		2019
1462	sub do_load_sync {	2020	sub do_load_sync {
1463	my ($map) = @_;	2021	my ($map) = @_;
1464		2022
		2023	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2024	if $Coro::current == $Coro::main;
		2025
1465	cf::sync_job { $map->load };	2026	cf::sync_job { $map->load };
		2027	}
		2028
		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
		2043	$MAP_PREFETCHER ||= cf::async {
		2044	$Coro::current->{desc} = "map prefetcher";
		2045
		2046	while (%MAP_PREFETCH) {
		2047	while (my ($k, $v) = each %MAP_PREFETCH) {
		2048	if (my $map = find $k) {
		2049	$map->load if $v;
		2050	}
		2051
		2052	delete $MAP_PREFETCH{$k};
		2053	}
		2054	}
		2055	undef $MAP_PREFETCHER;
		2056	};
		2057	$MAP_PREFETCHER->prio (6);
		2058
		2059	()
1466	}	2060	}
1467		2061
1468	sub save {	2062	sub save {
1469	my ($self) = @_;	2063	my ($self) = @_;
1470		2064
1471	my $lock = cf::lock_acquire "map_data:" . $self->path;	2065	my $lock = cf::lock_acquire "map_data:$self->{path}";
1472		2066
1473	$self->{last_save} = $cf::RUNTIME;	2067	$self->{last_save} = $cf::RUNTIME;
1474		2068
1475	return unless $self->dirty;	2069	return unless $self->dirty;
1476		2070
1477	my $save = $self->{path}->save_path; utf8::encode $save;	2071	my $save = $self->save_path; utf8::encode $save;
1478	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2072	my $uniq = $self->uniq_path; utf8::encode $uniq;
1479		2073
1480	$self->{load_path} = $save;	2074	$self->{load_path} = $save;
1481		2075
1482	return if $self->{deny_save};	2076	return if $self->{deny_save};
1483		2077
1484	local $self->{last_access} = $self->last_access;#d#	2078	local $self->{last_access} = $self->last_access;#d#
1485		2079
1486	cf::async {	2080	cf::async {
		2081	$Coro::current->{desc} = "map player save";
1487	$_->contr->save for $self->players;	2082	$_->contr->save for $self->players;
1488	};	2083	};
1489		2084
1490	if ($uniq) {	2085	if ($uniq) {
1491	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2086	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1492	$self->save_objects ($uniq, cf::IO_UNIQUES);	2087	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1493	} else {	2088	} else {
1494	$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);
1495	}	2090	}
1496	}	2091	}
1497		2092
1498	sub swap_out {	2093	sub swap_out {
1499	my ($self) = @_;	2094	my ($self) = @_;
1500		2095
1501	# save first because save cedes	2096	# save first because save cedes
1502	$self->save;	2097	$self->save;
1503		2098
1504	my $lock = cf::lock_acquire "map_data:" . $self->path;	2099	my $lock = cf::lock_acquire "map_data:$self->{path}";
1505		2100
1506	return if $self->players;	2101	return if $self->players;
1507	return if $self->in_memory != cf::MAP_IN_MEMORY;	2102	return if $self->in_memory != cf::MAP_IN_MEMORY;
1508	return if $self->{deny_save};	2103	return if $self->{deny_save};
1509		2104
		2105	$self->in_memory (cf::MAP_SWAPPED);
		2106
		2107	$self->deactivate;
		2108	$_->clear_links_to ($self) for values %cf::MAP;
1510	$self->clear;	2109	$self->clear;
1511	$self->in_memory (cf::MAP_SWAPPED);
1512	}	2110	}
1513		2111
1514	sub reset_at {	2112	sub reset_at {
1515	my ($self) = @_;	2113	my ($self) = @_;
1516		2114
1517	# TODO: safety, remove and allow resettable per-player maps	2115	# TODO: safety, remove and allow resettable per-player maps
1518	return 1e99 if $self->{path}{user_rel};
1519	return 1e99 if $self->{deny_reset};	2116	return 1e99 if $self->{deny_reset};
1520		2117
1521	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2118	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1522	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;
1523		2120
…		…
1528	my ($self) = @_;	2125	my ($self) = @_;
1529		2126
1530	$self->reset_at <= $cf::RUNTIME	2127	$self->reset_at <= $cf::RUNTIME
1531	}	2128	}
1532		2129
1533	sub unlink_save {
1534	my ($self) = @_;
1535
1536	utf8::encode (my $save = $self->{path}->save_path);
1537	aioreq_pri 3; IO::AIO::aio_unlink $save;
1538	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1539	}
1540
1541	sub rename {
1542	my ($self, $new_path) = @_;
1543
1544	$self->unlink_save;
1545
1546	delete $cf::MAP{$self->path};
1547	$self->{path} = new cf::path $new_path;
1548	$self->path ($self->{path}->as_string);
1549	$cf::MAP{$self->path} = $self;
1550
1551	$self->save;
1552	}
1553
1554	sub reset {	2130	sub reset {
1555	my ($self) = @_;	2131	my ($self) = @_;
1556		2132
1557	my $lock = cf::lock_acquire "map_data:" . $self->path;	2133	my $lock = cf::lock_acquire "map_data:$self->{path}";
1558		2134
1559	return if $self->players;	2135	return if $self->players;
1560	return if $self->{path}{user_rel};#d#
1561		2136
1562	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	}
1563		2148
1564	delete $cf::MAP{$self->path};	2149	delete $cf::MAP{$self->path};
1565		2150
		2151	$self->deactivate;
1566	$_->clear_links_to ($self) for values %cf::MAP;	2152	$_->clear_links_to ($self) for values %cf::MAP;
		2153	$self->clear;
1567		2154
1568	$self->unlink_save;	2155	$self->unlink_save;
1569	$self->destroy;	2156	$self->destroy;
1570	}	2157	}
1571		2158
1572	my $nuke_counter = "aaaa";	2159	my $nuke_counter = "aaaa";
1573		2160
1574	sub nuke {	2161	sub nuke {
1575	my ($self) = @_;	2162	my ($self) = @_;
1576		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};
1577	$self->{deny_save} = 1;	2173	$self->{deny_save} = 1;
1578	$self->reset_timeout (1);	2174	$self->reset_timeout (1);
1579	$self->rename ("{nuke}/" . ($nuke_counter++));	2175	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2176
		2177	$cf::MAP{$self->path} = $self;
		2178	}
		2179
1580	$self->reset; # polite request, might not happen	2180	$self->reset; # polite request, might not happen
1581	}	2181	}
1582		2182
1583	sub customise_for {	2183	=item $maps = cf::map::tmp_maps
1584	my ($map, $ob) = @_;
1585		2184
1586	if ($map->per_player) {	2185	Returns an arrayref with all map paths of currently instantiated and saved
1587	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2186	maps. May block.
		2187
		2188	=cut
		2189
		2190	sub tmp_maps() {
1588	}	2191	[
1589		2192	map {
1590	$map	2193	utf8::decode $_;
		2194	/\.map$/
		2195	? normalise $_
		2196	: ()
		2197	} @{ aio_readdir $TMPDIR or [] }
		2198	]
1591	}	2199	}
1592		2200
1593	sub emergency_save {	2201	=item $maps = cf::map::random_maps
1594	my $freeze_guard = cf::freeze_mainloop;
1595		2202
1596	warn "enter emergency perl save\n";	2203	Returns an arrayref with all map paths of currently instantiated and saved
		2204	random maps. May block.
1597		2205
1598	cf::sync_job {	2206	=cut
1599	warn "begin emergency player save\n";
1600	$_->save for values %cf::PLAYER;
1601	warn "end emergency player save\n";
1602		2207
1603	warn "begin emergency map save\n";	2208	sub random_maps() {
1604	$_->save for values %cf::MAP;	2209	[
1605	warn "end emergency map save\n";	2210	map {
1606	};	2211	utf8::decode $_;
		2212	/\.map$/
		2213	? normalise "?random/$_"
		2214	: ()
		2215	} @{ aio_readdir $RANDOMDIR or [] }
		2216	]
		2217	}
1607		2218
1608	warn "leave emergency perl save\n";	2219	=item cf::map::unique_maps
		2220
		2221	Returns an arrayref of paths of all shared maps that have
		2222	instantiated unique items. May block.
		2223
		2224	=cut
		2225
		2226	sub unique_maps() {
		2227	[
		2228	map {
		2229	utf8::decode $_;
		2230	/\.map$/
		2231	? normalise $_
		2232	: ()
		2233	} @{ aio_readdir $UNIQUEDIR or [] }
		2234	]
1609	}	2235	}
1610		2236
1611	package cf;	2237	package cf;
1612		2238
1613	=back	2239	=back
1614		2240
		2241	=head3 cf::object
		2242
		2243	=cut
		2244
		2245	package cf::object;
		2246
		2247	=over 4
		2248
		2249	=item $ob->inv_recursive
		2250
		2251	Returns the inventory of the object _and_ their inventories, recursively.
		2252
		2253	=cut
		2254
		2255	sub inv_recursive_;
		2256	sub inv_recursive_ {
		2257	map { $_, inv_recursive_ $_->inv } @_
		2258	}
		2259
		2260	sub inv_recursive {
		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	}
		2290	}
		2291
		2292	package cf;
		2293
		2294	=back
1615		2295
1616	=head3 cf::object::player	2296	=head3 cf::object::player
1617		2297
1618	=over 4	2298	=over 4
1619		2299
…		…
1633		2313
1634	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2314	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1635		2315
1636	if ($self->{record_replies}) {	2316	if ($self->{record_replies}) {
1637	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2317	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2318
1638	} 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 {
1639	$msg = $npc->name . " says: $msg" if $npc;	2327	$msg = $npc->name . " says: $msg" if $npc;
1640	$self->message ($msg, $flags);	2328	$self->message ($msg, $flags);
		2329	}
1641	}	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 (@_);
1642	}	2341	}
1643		2342
1644	=item $player_object->may ("access")	2343	=item $player_object->may ("access")
1645		2344
1646	Returns wether the given player is authorized to access resource "access"	2345	Returns wether the given player is authorized to access resource "access"
…		…
1659		2358
1660	=item $player_object->enter_link	2359	=item $player_object->enter_link
1661		2360
1662	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}>).
1663		2362
1664	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
1665	I<MUST> call C<leave_link> as soon as possible, though.	2364	I<MUST> call C<leave_link> as soon as possible, though.
1666		2365
		2366	Will never block.
		2367
1667	=item $player_object->leave_link ($map, $x, $y)	2368	=item $player_object->leave_link ($map, $x, $y)
1668		2369
1669	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
1670	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
1671	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
1672	to the emergency map position.	2373	fails, to the emergency map position.
1673		2374
1674	Might block.	2375	Might block.
1675		2376
1676	=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	}
1677		2388
1678	sub cf::object::player::enter_link {	2389	sub cf::object::player::enter_link {
1679	my ($self) = @_;	2390	my ($self) = @_;
1680		2391
1681	$self->deactivate_recursive;	2392	$self->deactivate_recursive;
1682		2393
1683	return if $self->map == $LINK_MAP;	2394	return if UNIVERSAL::isa $self->map, "ext::map_link";
1684		2395
1685	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2396	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1686	if $self->map;	2397	if $self->map && $self->map->{path} ne "{link}";
1687		2398
1688	$self->enter_map ($LINK_MAP, 20, 20);	2399	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1689	}	2400	}
1690		2401
1691	sub cf::object::player::leave_link {	2402	sub cf::object::player::leave_link {
1692	my ($self, $map, $x, $y) = @_;	2403	my ($self, $map, $x, $y) = @_;
		2404
		2405	return unless $self->contr->active;
1693		2406
1694	my $link_pos = delete $self->{_link_pos};	2407	my $link_pos = delete $self->{_link_pos};
1695		2408
1696	unless ($map) {	2409	unless ($map) {
1697	# restore original map position	2410	# restore original map position
…		…
1711	# use -1 or undef as default coordinates, not 0, 0	2424	# use -1 or undef as default coordinates, not 0, 0
1712	($x, $y) = ($map->enter_x, $map->enter_y)	2425	($x, $y) = ($map->enter_x, $map->enter_y)
1713	if $x <=0 && $y <= 0;	2426	if $x <=0 && $y <= 0;
1714		2427
1715	$map->load;	2428	$map->load;
		2429	$map->load_neighbours;
1716		2430
1717	return unless $self->contr->active;	2431	return unless $self->contr->active;
1718	$self->activate_recursive;	2432	$self->activate_recursive;
		2433
		2434	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1719	$self->enter_map ($map, $x, $y);	2435	$self->enter_map ($map, $x, $y);
1720	}	2436	}
1721		2437
1722	cf::player->attach (	2438	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1723	on_logout => sub {
1724	my ($pl) = @_;
1725		2439
1726	# abort map switching before logout	2440	Moves the player to the given map-path and coordinates by first freezing
1727	if ($pl->ob->{_link_pos}) {	2441	her, loading and preparing them map, calling the provided $check callback
1728	cf::sync_job {	2442	that has to return the map if sucecssful, and then unfreezes the player on
1729	$pl->ob->leave_link	2443	the new (success) or old (failed) map position. In either case, $done will
1730	};	2444	be called at the end of this process.
1731	}
1732	},
1733	on_login => sub {
1734	my ($pl) = @_;
1735		2445
1736	# try to abort aborted map switching on player login :)
1737	# should happen only on crashes
1738	if ($pl->ob->{_link_pos}) {
1739	$pl->ob->enter_link;
1740	(async {
1741	# we need this sleep as the login has a concurrent enter_exit running
1742	# and this sleep increases chances of the player not ending up in scorn
1743	$pl->ob->reply (undef,
1744	"There was an internal problem at your last logout, "
1745	. "the server will try to bring you to your intended destination in a second.",
1746	cf::NDI_RED);
1747	Coro::Timer::sleep 1;
1748	$pl->ob->leave_link;
1749	})->prio (2);
1750	}
1751	},
1752	);
1753
1754	=item $player_object->goto ($path, $x, $y)
1755
1756	=cut	2446	=cut
		2447
		2448	our $GOTOGEN;
1757		2449
1758	sub cf::object::player::goto {	2450	sub cf::object::player::goto {
1759	my ($self, $path, $x, $y) = @_;	2451	my ($self, $path, $x, $y, $check, $done) = @_;
1760		2452
1761	$path = new cf::path $path;	2453	# do generation counting so two concurrent goto's will be executed in-order
1762	$path ne "/" or Carp::cluck ("oy");#d#	2454	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1763		2455
1764	$self->enter_link;	2456	$self->enter_link;
1765		2457
1766	(async {	2458	(async {
1767	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) {
1768	$map = $map->customise_for ($self) if $map;	2484	$map = $map->customise_for ($self);
1769		2485	$map = $check->($map) if $check && $map;
1770	# warn "entering ", $map->path, " at ($x, $y)\n"	2486	} else {
1771	# if $map;
1772
1773	$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	}
1774		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};
1775	$self->leave_link ($map, $x, $y);	2500	$self->leave_link ($map, $x, $y);
		2501	}
		2502
		2503	$done->() if $done;
1776	})->prio (1);	2504	})->prio (1);
1777	}	2505	}
1778		2506
1779	=item $player_object->enter_exit ($exit_object)	2507	=item $player_object->enter_exit ($exit_object)
1780		2508
…		…
1782		2510
1783	sub parse_random_map_params {	2511	sub parse_random_map_params {
1784	my ($spec) = @_;	2512	my ($spec) = @_;
1785		2513
1786	my $rmp = { # defaults	2514	my $rmp = { # defaults
1787	xsize => 10,	2515	xsize => (cf::rndm 15, 40),
1788	ysize => 10,	2516	ysize => (cf::rndm 15, 40),
		2517	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2518	#layout => string,
1789	};	2519	};
1790		2520
1791	for (split /\n/, $spec) {	2521	for (split /\n/, $spec) {
1792	my ($k, $v) = split /\s+/, $_, 2;	2522	my ($k, $v) = split /\s+/, $_, 2;
1793		2523
…		…
1797	$rmp	2527	$rmp
1798	}	2528	}
1799		2529
1800	sub prepare_random_map {	2530	sub prepare_random_map {
1801	my ($exit) = @_;	2531	my ($exit) = @_;
		2532
		2533	my $guard = cf::lock_acquire "exit_prepare:$exit";
1802		2534
1803	# all this does is basically replace the /! path by	2535	# all this does is basically replace the /! path by
1804	# a new random map path (?random/...) with a seed	2536	# a new random map path (?random/...) with a seed
1805	# that depends on the exit object	2537	# that depends on the exit object
1806		2538
1807	my $rmp = parse_random_map_params $exit->msg;	2539	my $rmp = parse_random_map_params $exit->msg;
1808		2540
1809	if ($exit->map) {	2541	if ($exit->map) {
1810	$rmp->{region} = $exit->map->region_name;	2542	$rmp->{region} = $exit->region->name;
1811	$rmp->{origin_map} = $exit->map->path;	2543	$rmp->{origin_map} = $exit->map->path;
1812	$rmp->{origin_x} = $exit->x;	2544	$rmp->{origin_x} = $exit->x;
1813	$rmp->{origin_y} = $exit->y;	2545	$rmp->{origin_y} = $exit->y;
1814	}	2546	}
1815		2547
1816	$rmp->{random_seed} ||= $exit->random_seed;	2548	$rmp->{random_seed} ||= $exit->random_seed;
1817		2549
1818	my $data = cf::to_json $rmp;	2550	my $data = cf::to_json $rmp;
1819	my $md5 = Digest::MD5::md5_hex $data;	2551	my $md5 = Digest::MD5::md5_hex $data;
		2552	my $meta = "$RANDOMDIR/$md5.meta";
1820		2553
1821	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) {
1822	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;
1823		2558
1824	$exit->slaying ("?random/$md5");	2559	$exit->slaying ("?random/$md5");
1825	$exit->msg (undef);	2560	$exit->msg (undef);
1826	}	2561	}
1827	}	2562	}
…		…
1829	sub cf::object::player::enter_exit {	2564	sub cf::object::player::enter_exit {
1830	my ($self, $exit) = @_;	2565	my ($self, $exit) = @_;
1831		2566
1832	return unless $self->type == cf::PLAYER;	2567	return unless $self->type == cf::PLAYER;
1833		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
1834	$self->enter_link;	2580	$self->enter_link;
1835		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
1836	(async {	2586	(async {
		2587	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2588
1837	$self->deactivate_recursive; # just to be sure	2589	$self->deactivate_recursive; # just to be sure
1838	unless (eval {	2590	unless (eval {
1839	prepare_random_map $exit	2591	$self->goto ($slaying, $hp, $sp);
1840	if $exit->slaying eq "/!";
1841
1842	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1843	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1844		2592
1845	1;	2593	1;
1846	}) {	2594	}) {
1847	$self->message ("Something went wrong deep within the crossfire server. "	2595	$self->message ("Something went wrong deep within the crossfire server. "
1848	. "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. "
1849	. "Please report this to the dungeon master",	2597	. "Please report this to the dungeon master!",
1850	cf::NDI_UNIQUE | cf::NDI_RED);	2598	cf::NDI_UNIQUE | cf::NDI_RED);
1851		2599
1852	warn "ERROR in enter_exit: $@";	2600	warn "ERROR in enter_exit: $@";
1853	$self->leave_link;	2601	$self->leave_link;
1854	}	2602	}
1855	})->prio (1);	2603	})->prio (1);
…		…
1868		2616
1869	sub cf::client::send_drawinfo {	2617	sub cf::client::send_drawinfo {
1870	my ($self, $text, $flags) = @_;	2618	my ($self, $text, $flags) = @_;
1871		2619
1872	utf8::encode $text;	2620	utf8::encode $text;
1873	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2621	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1874	}	2622	}
1875		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	}
1876		2751
1877	=item $success = $client->query ($flags, "text", \&cb)	2752	=item $success = $client->query ($flags, "text", \&cb)
1878		2753
1879	Queues a query to the client, calling the given callback with	2754	Queues a query to the client, calling the given callback with
1880	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>,
1881	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>.
1882		2757
1883	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
1884	reliable at some point in the future.	2759	become reliable at some point in the future.
1885		2760
1886	=cut	2761	=cut
1887		2762
1888	sub cf::client::query {	2763	sub cf::client::query {
1889	my ($self, $flags, $text, $cb) = @_;	2764	my ($self, $flags, $text, $cb) = @_;
…		…
1897	utf8::encode $text;	2772	utf8::encode $text;
1898	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2773	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1899		2774
1900	$self->send_packet ($self->{query_queue}[0][0])	2775	$self->send_packet ($self->{query_queue}[0][0])
1901	if @{ $self->{query_queue} } == 1;	2776	if @{ $self->{query_queue} } == 1;
		2777
		2778	1
1902	}	2779	}
1903		2780
1904	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	},
1905	on_reply => sub {	2787	on_reply => sub {
1906	my ($ns, $msg) = @_;	2788	my ($ns, $msg) = @_;
1907		2789
1908	# this weird shuffling is so that direct followup queries	2790	# this weird shuffling is so that direct followup queries
1909	# get handled first	2791	# get handled first
1910	my $queue = delete $ns->{query_queue}	2792	my $queue = delete $ns->{query_queue}
1911	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
1912		2794
1913	(shift @$queue)->[1]->($msg);	2795	(shift @$queue)->[1]->($msg);
		2796	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1914		2797
1915	push @{ $ns->{query_queue} }, @$queue;	2798	push @{ $ns->{query_queue} }, @$queue;
1916		2799
1917	if (@{ $ns->{query_queue} } == @$queue) {	2800	if (@{ $ns->{query_queue} } == @$queue) {
1918	if (@$queue) {	2801	if (@$queue) {
…		…
1920	} else {	2803	} else {
1921	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2804	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1922	}	2805	}
1923	}	2806	}
1924	},	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	},
1925	);	2834	);
1926		2835
1927	=item $client->async (\&cb)	2836	=item $client->async (\&cb)
1928		2837
1929	Create a new coroutine, running the specified callback. The coroutine will	2838	Create a new coroutine, running the specified callback. The coroutine will
…		…
1970	our $safe = new Safe "safe";	2879	our $safe = new Safe "safe";
1971	our $safe_hole = new Safe::Hole;	2880	our $safe_hole = new Safe::Hole;
1972		2881
1973	$SIG{FPE} = 'IGNORE';	2882	$SIG{FPE} = 'IGNORE';
1974		2883
1975	$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	));
1976		2889
1977	# here we export the classes and methods available to script code	2890	# here we export the classes and methods available to script code
1978		2891
1979	=pod	2892	=pod
1980		2893
1981	The following fucntions and emthods are available within a safe environment:	2894	The following functions and methods are available within a safe environment:
1982		2895
1983	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
1984	cf::object::player player	2900	cf::object::player
1985	cf::player peaceful	2901	player
1986	cf::map trigger	2902
		2903	cf::player
		2904	peaceful
		2905
		2906	cf::map
		2907	trigger
1987		2908
1988	=cut	2909	=cut
1989		2910
1990	for (	2911	for (
1991	["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)],
1992	["cf::object::player" => qw(player)],	2915	["cf::object::player" => qw(player)],
1993	["cf::player" => qw(peaceful)],	2916	["cf::player" => qw(peaceful)],
1994	["cf::map" => qw(trigger)],	2917	["cf::map" => qw(trigger)],
1995	) {	2918	) {
1996	no strict 'refs';	2919	no strict 'refs';
…		…
2067	=back	2990	=back
2068		2991
2069	=cut	2992	=cut
2070		2993
2071	#############################################################################	2994	#############################################################################
		2995	# the server's init and main functions
2072		2996
2073	=head2 EXTENSION DATABASE SUPPORT	2997	sub load_facedata($) {
		2998	my ($path) = @_;
2074		2999
2075	Crossfire maintains a very simple database for extension use. It can	3000	# HACK to clear player env face cache, we need some signal framework
2076	currently store anything that can be serialised using Storable, which	3001	# for this (global event?)
2077	excludes objects.	3002	%ext::player_env::MUSIC_FACE_CACHE = ();
2078		3003
2079	The parameter C<$family> should best start with the name of the extension	3004	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2080	using it, it should be unique.
2081		3005
2082	=over 4	3006	warn "loading facedata from $path\n";
2083		3007
2084	=item $hashref = cf::db_get $family	3008	my $facedata;
		3009	0 < aio_load $path, $facedata
		3010	or die "$path: $!";
2085		3011
2086	Return a hashref for use by the extension C<$family>, which can be	3012	$facedata = Coro::Storable::thaw $facedata;
2087	modified. After modifications, you have to call C<cf::db_dirty> or
2088	C<cf::db_sync>.
2089		3013
2090	=item $value = cf::db_get $family => $key	3014	$facedata->{version} == 2
		3015	or cf::cleanup "$path: version mismatch, cannot proceed.";
2091		3016
2092	Returns a single value from the database	3017	# patch in the exptable
2093		3018	$facedata->{resource}{"res/exp_table"} = {
2094	=item cf::db_put $family => $hashref	3019	type => FT_RSRC,
2095		3020	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2096	Stores the given family hashref into the database. Updates are delayed, if
2097	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2098
2099	=item cf::db_put $family => $key => $value
2100
2101	Stores the given C<$value> in the family hash. Updates are delayed, if you
2102	want the data to be synced to disk immediately, use C<cf::db_sync>.
2103
2104	=item cf::db_dirty
2105
2106	Marks the database as dirty, to be updated at a later time.
2107
2108	=item cf::db_sync
2109
2110	Immediately write the database to disk I<if it is dirty>.
2111
2112	=cut
2113
2114	our $DB;
2115
2116	{
2117	my $path = cf::localdir . "/database.pst";
2118
2119	sub db_load() {
2120	$DB = stat $path ? Storable::retrieve $path : { };
2121	}
2122
2123	my $pid;
2124
2125	sub db_save() {
2126	waitpid $pid, 0 if $pid;
2127	if (0 == ($pid = fork)) {
2128	$DB->{_meta}{version} = 1;
2129	Storable::nstore $DB, "$path~";
2130	rename "$path~", $path;
2131	cf::_exit 0 if defined $pid;
2132	}
2133	}
2134
2135	my $dirty;
2136
2137	sub db_sync() {
2138	db_save if $dirty;
2139	undef $dirty;
2140	}
2141
2142	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2143	db_sync;
2144	});	3021	};
		3022	cf::cede_to_tick;
2145		3023
2146	sub db_dirty() {
2147	$dirty = 1;
2148	$idle->start;
2149	}	3024	{
		3025	my $faces = $facedata->{faceinfo};
2150		3026
2151	sub db_get($;$) {	3027	while (my ($face, $info) = each %$faces) {
2152	@_ >= 2	3028	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2153	? $DB->{$_[0]}{$_[1]}	3029	cf::face::set_visibility $idx, $info->{visibility};
2154	: ($DB->{$_[0]} ||= { })	3030	cf::face::set_magicmap $idx, $info->{magicmap};
2155	}	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};
2156		3033
2157	sub db_put($$;$) {	3034	cf::cede_to_tick;
2158	if (@_ >= 3) {
2159	$DB->{$_[0]}{$_[1]} = $_[2];
2160	} else {
2161	$DB->{$_[0]} = $_[1];
2162	}
2163	db_dirty;
2164	}
2165
2166	cf::global->attach (
2167	prio => 10000,
2168	on_cleanup => sub {
2169	db_sync;
2170	},	3035	}
2171	);
2172	}
2173		3036
2174	#############################################################################	3037	while (my ($face, $info) = each %$faces) {
2175	# 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	}
2176		3047
2177	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 {
2178	open my $fh, "<:utf8", cf::confdir . "/config"	3174	open my $fh, "<:utf8", "$CONFDIR/config"
2179	or return;	3175	or return;
2180		3176
2181	local $/;	3177	local $/;
2182	*CFG = YAML::Syck::Load <$fh>;	3178	*CFG = YAML::Syck::Load <$fh>;
2183		3179
…		…
2197		3193
2198	sub main {	3194	sub main {
2199	# we must not ever block the main coroutine	3195	# we must not ever block the main coroutine
2200	local $Coro::idle = sub {	3196	local $Coro::idle = sub {
2201	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";
2202	async { Event::one_event };	3200	Event::one_event;
		3201	})->prio (Coro::PRIO_MAX);
2203	};	3202	};
2204		3203
2205	cfg_load;	3204	reload_config;
2206	db_load;	3205	db_init;
2207	load_extensions;	3206	load_extensions;
		3207
		3208	$TICK_WATCHER->start;
2208	Event::loop;	3209	Event::loop;
2209	}	3210	}
2210		3211
2211	#############################################################################	3212	#############################################################################
2212	# initialisation	3213	# initialisation and cleanup
2213		3214
		3215	# install some emergency cleanup handlers
		3216	BEGIN {
		3217	for my $signal (qw(INT HUP TERM)) {
		3218	Event->signal (
		3219	reentrant => 0,
		3220	data => WF_AUTOCANCEL,
		3221	signal => $signal,
		3222	prio => 0,
		3223	cb => sub {
		3224	cf::cleanup "SIG$signal";
		3225	},
		3226	);
		3227	}
		3228	}
		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
		3268	sub emergency_save() {
		3269	my $freeze_guard = cf::freeze_mainloop;
		3270
		3271	warn "enter emergency perl save\n";
		3272
		3273	cf::sync_job {
		3274	# use a peculiar iteration method to avoid tripping on perl
		3275	# refcount bugs in for. also avoids problems with players
		3276	# and maps saved/destroyed asynchronously.
		3277	warn "begin emergency player save\n";
		3278	for my $login (keys %cf::PLAYER) {
		3279	my $pl = $cf::PLAYER{$login} or next;
		3280	$pl->valid or next;
		3281	$pl->save;
		3282	}
		3283	warn "end emergency player save\n";
		3284
		3285	warn "begin emergency map save\n";
		3286	for my $path (keys %cf::MAP) {
		3287	my $map = $cf::MAP{$path} or next;
		3288	$map->valid or next;
		3289	$map->save;
		3290	}
		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";
		3296	};
		3297
		3298	warn "leave emergency perl save\n";
		3299	}
		3300
		3301	sub post_cleanup {
		3302	my ($make_core) = @_;
		3303
		3304	warn Carp::longmess "post_cleanup backtrace"
		3305	if $make_core;
		3306	}
		3307
2214	sub reload() {	3308	sub do_reload_perl() {
2215	# can/must only be called in main	3309	# can/must only be called in main
2216	if ($Coro::current != $Coro::main) {	3310	if ($Coro::current != $Coro::main) {
2217	warn "can only reload from main coroutine\n";	3311	warn "can only reload from main coroutine";
2218	return;	3312	return;
2219	}	3313	}
2220		3314
2221	warn "reloading...";	3315	warn "reloading...";
2222		3316
2223	my $guard = freeze_mainloop;	3317	warn "entering sync_job";
		3318
		3319	cf::sync_job {
		3320	cf::write_runtime; # external watchdog should not bark
2224	cf::emergency_save;	3321	cf::emergency_save;
		3322	cf::write_runtime; # external watchdog should not bark
2225		3323
2226	eval {	3324	warn "syncing database to disk";
		3325	BDB::db_env_txn_checkpoint $DB_ENV;
		3326
2227	# 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
2228		3328
2229	# cancel all watchers	3329	warn "cancelling all WF_AUTOCANCEL watchers";
2230	for (Event::all_watchers) {	3330	for (Event::all_watchers) {
2231	$_->cancel if $_->data & WF_AUTOCANCEL;	3331	$_->cancel if $_->data & WF_AUTOCANCEL;
2232	}	3332	}
2233		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
2234	# cancel all extension coros	3345	warn "cancelling all extension coros";
2235	$_->cancel for values %EXT_CORO;	3346	$_->cancel for values %EXT_CORO;
2236	%EXT_CORO = ();	3347	%EXT_CORO = ();
2237		3348
2238	# unload all extensions	3349	warn "removing commands";
2239	for (@exts) {	3350	%COMMAND = ();
		3351
		3352	warn "removing ext/exti commands";
		3353	%EXTCMD = ();
		3354	%EXTICMD = ();
		3355
		3356	warn "unloading/nuking all extensions";
		3357	for my $pkg (@EXTS) {
2240	warn "unloading <$_>";	3358	warn "... unloading $pkg";
2241	unload_extension $_;	3359
		3360	if (my $cb = $pkg->can ("unload")) {
		3361	eval {
		3362	$cb->($pkg);
		3363	1
		3364	} or warn "$pkg unloaded, but with errors: $@";
2242	}	3365	}
2243		3366
		3367	warn "... nuking $pkg";
		3368	Symbol::delete_package $pkg;
		3369	}
		3370
2244	# unload all modules loaded from $LIBDIR	3371	warn "unloading all perl modules loaded from $LIBDIR";
2245	while (my ($k, $v) = each %INC) {	3372	while (my ($k, $v) = each %INC) {
2246	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3373	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2247		3374
2248	warn "removing <$k>";	3375	warn "... unloading $k";
2249	delete $INC{$k};	3376	delete $INC{$k};
2250		3377
2251	$k =~ s/\.pm$//;	3378	$k =~ s/\.pm$//;
2252	$k =~ s/\//::/g;	3379	$k =~ s/\//::/g;
2253		3380
…		…
2256	}	3383	}
2257		3384
2258	Symbol::delete_package $k;	3385	Symbol::delete_package $k;
2259	}	3386	}
2260		3387
2261	# sync database to disk
2262	cf::db_sync;
2263	IO::AIO::flush;
2264
2265	# get rid of safe::, as good as possible	3388	warn "getting rid of safe::, as good as possible";
2266	Symbol::delete_package "safe::$_"	3389	Symbol::delete_package "safe::$_"
2267	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);
2268		3391
2269	# remove register_script_function callbacks
2270	# TODO
2271
2272	# unload cf.pm "a bit"	3392	warn "unloading cf.pm \"a bit\"";
2273	delete $INC{"cf.pm"};	3393	delete $INC{"cf.pm"};
		3394	delete $INC{"cf/pod.pm"};
2274		3395
2275	# don't, removes xs symbols, too,	3396	# don't, removes xs symbols, too,
2276	# and global variables created in xs	3397	# and global variables created in xs
2277	#Symbol::delete_package __PACKAGE__;	3398	#Symbol::delete_package __PACKAGE__;
2278		3399
2279	# reload cf.pm	3400	warn "unload completed, starting to reload now";
		3401
2280	warn "reloading cf.pm";	3402	warn "reloading cf.pm";
2281	require cf;	3403	require cf;
2282	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3404	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2283		3405
2284	# load config and database again	3406	warn "loading config and database again";
2285	cf::cfg_load;	3407	cf::reload_config;
2286	cf::db_load;
2287		3408
2288	# load extensions
2289	warn "load extensions";	3409	warn "loading extensions";
2290	cf::load_extensions;	3410	cf::load_extensions;
2291		3411
2292	# reattach attachments to objects	3412	warn "reattaching attachments to objects/players";
2293	warn "reattach";	3413	_global_reattach; # objects, sockets
2294	_global_reattach;	3414	warn "reattaching attachments to maps";
2295	reattach $_ for values %MAP;	3415	reattach $_ for values %MAP;
2296	};	3416	warn "reattaching attachments to players";
		3417	reattach $_ for values %PLAYER;
2297		3418
2298	if ($@) {	3419	warn "leaving sync_job";
		3420
		3421	1
		3422	} or do {
2299	warn $@;	3423	warn $@;
2300	warn "error while reloading, exiting.";	3424	warn "error while reloading, exiting.";
2301	exit 1;	3425	exit 1;
2302	}	3426	};
2303		3427
2304	warn "reloaded successfully";	3428	warn "reloaded";
2305	};	3429	};
2306		3430
2307	#############################################################################	3431	our $RELOAD_WATCHER; # used only during reload
2308		3432
2309	unless ($LINK_MAP) {	3433	sub reload_perl() {
2310	$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.
2311		3436
2312	$LINK_MAP->width (41);	3437	$RELOAD_WATCHER ||= Event->timer (
2313	$LINK_MAP->height (41);	3438	reentrant => 0,
2314	$LINK_MAP->alloc;
2315	$LINK_MAP->path ("{link}");
2316	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2317	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2318
2319	# dirty hack because... archetypes are not yet loaded
2320	Event->timer (
2321	after => 10,	3439	after => 0,
		3440	data => WF_AUTOCANCEL,
2322	cb => sub {	3441	cb => sub {
2323	$_[0]->w->cancel;	3442	do_reload_perl;
2324		3443	undef $RELOAD_WATCHER;
2325	# provide some exits "home"
2326	my $exit = cf::object::new "exit";
2327
2328	$exit->slaying ($EMERGENCY_POSITION->[0]);
2329	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2330	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2331
2332	$LINK_MAP->insert ($exit->clone, 19, 19);
2333	$LINK_MAP->insert ($exit->clone, 19, 20);
2334	$LINK_MAP->insert ($exit->clone, 19, 21);
2335	$LINK_MAP->insert ($exit->clone, 20, 19);
2336	$LINK_MAP->insert ($exit->clone, 20, 21);
2337	$LINK_MAP->insert ($exit->clone, 21, 19);
2338	$LINK_MAP->insert ($exit->clone, 21, 20);
2339	$LINK_MAP->insert ($exit->clone, 21, 21);
2340
2341	$exit->destroy;
2342	});	3444	},
2343		3445	);
2344	$LINK_MAP->{deny_save} = 1;
2345	$LINK_MAP->{deny_reset} = 1;
2346
2347	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2348	}	3446	}
2349
2350	register "<global>", __PACKAGE__;
2351		3447
2352	register_command "reload" => sub {	3448	register_command "reload" => sub {
2353	my ($who, $arg) = @_;	3449	my ($who, $arg) = @_;
2354		3450
2355	if ($who->flag (FLAG_WIZ)) {	3451	if ($who->flag (FLAG_WIZ)) {
2356	$who->message ("start of reload.");
2357	reload;
2358	$who->message ("end of reload.");	3452	$who->message ("reloading server.");
		3453	async {
		3454	$Coro::current->{desc} = "perl_reload";
		3455	reload_perl;
		3456	};
2359	}	3457	}
2360	};	3458	};
2361		3459
2362	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	}
2363		3484
2364	$TICK_WATCHER = Event->timer (	3485	$TICK_WATCHER = Event->timer (
2365	reentrant => 0,	3486	reentrant => 0,
		3487	parked => 1,
2366	prio => 0,	3488	prio => 0,
2367	at => $NEXT_TICK || $TICK,	3489	at => $NEXT_TICK || $TICK,
2368	data => WF_AUTOCANCEL,	3490	data => WF_AUTOCANCEL,
2369	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
2370	cf::server_tick; # one server iteration	3500	cf::server_tick; # one server iteration
		3501
2371	$RUNTIME += $TICK;	3502	$RUNTIME += $TICK;
2372	$NEXT_TICK += $TICK;	3503	$NEXT_TICK += $TICK;
2373		3504
		3505	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		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;
		3522
2374	# 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
2375	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3524	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2376		3525
2377	$TICK_WATCHER->at ($NEXT_TICK);	3526	$TICK_WATCHER->at ($NEXT_TICK);
2378	$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;
2379	},	3533	},
2380	);	3534	);
2381		3535
		3536	{
		3537	BDB::min_parallel 8;
2382	IO::AIO::max_poll_time $TICK * 0.2;	3538	BDB::max_poll_time $TICK * 0.1;
2383		3539	$BDB_POLL_WATCHER = Event->io (
2384	Event->io (	3540	reentrant => 0,
2385	fd => IO::AIO::poll_fileno,	3541	fd => BDB::poll_fileno,
2386	poll => 'r',	3542	poll => 'r',
2387	prio => 5,	3543	prio => 0,
2388	data => WF_AUTOCANCEL,
2389	cb => \&IO::AIO::poll_cb,
2390	);
2391
2392	Event->timer (
2393	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 (
2394	after => 0,	3587	after => 3,
2395	interval => 10,	3588	interval => 1,
		3589	hard => 1,
		3590	prio => 0,
		3591	data => WF_AUTOCANCEL,
2396	cb => sub {	3592	cb => sub {
2397	(Coro::unblock_sub {	3593	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
2398	write_runtime	3594	},
2399	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;
2400	})->();	3666	};
		3667	} else {
		3668	LOG llevInfo, "[ABT] $msg\n";
		3669	LOG llevInfo, "[ABT] [suppressed]\n";
2401	},	3670	}
2402	);	3671	}
		3672
		3673	# load additional modules
		3674	use cf::pod;
2403		3675
2404	END { cf::emergency_save }	3676	END { cf::emergency_save }
2405		3677
2406	1	3678	1
2407		3679

Diff Legend

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