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.379 by root, Thu Oct 4 23:59:07 2007 UTC

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

Diff Legend

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