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.163 by root, Thu Jan 11 01:01:56 2007 UTC vs.
Revision 1.386 by root, Mon Oct 15 17:50:27 2007 UTC

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

Diff Legend

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