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.162 by root, Thu Jan 11 00:41:08 2007 UTC vs.
Revision 1.388 by root, Thu Oct 18 02:56:13 2007 UTC

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

Diff Legend

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