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.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.333 by root, Sun Aug 19 09:14:50 2007 UTC

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

Diff Legend

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