ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.379 by root, Thu Oct 4 23:59:07 2007 UTC

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

Diff Legend

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