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.152 by root, Mon Jan 8 22:32:10 2007 UTC vs.
Revision 1.385 by root, Fri Oct 12 19:13:26 2007 UTC

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

Diff Legend

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