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

Diff Legend

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