ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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