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.133 by root, Thu Jan 4 16:19:32 2007 UTC vs.
Revision 1.335 by root, Mon Aug 20 22:21:48 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 $RANDOM_MAPS = cf::localdir . "/random";	95
55	our %EXT_CORO;	96	# used to convert map paths into valid unix filenames by replacing / by ∕
		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
56		102
57	binmode STDOUT;	103	binmode STDOUT;
58	binmode STDERR;	104	binmode STDERR;
59		105
60	# read virtual server time, if available	106	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
63	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
64	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
65	}	111	}
66		112
67	mkdir cf::localdir;	113	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		115
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
		117
		118	sub cf::map::normalise;
76		119
77	#############################################################################	120	#############################################################################
78		121
79	=head2 GLOBAL VARIABLES	122	=head2 GLOBAL VARIABLES
80		123
…		…
87	=item $cf::RUNTIME	130	=item $cf::RUNTIME
88		131
89	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
90	every server tick.	133	every server tick.
91		134
92	=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
93		138
94	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
95	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.
96		143
97	=item $cf::NOW	144	=item $cf::NOW
98		145
99	The time of the last (current) server tick.	146	The time of the last (current) server tick.
100		147
101	=item $cf::TICK	148	=item $cf::TICK
102		149
103	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.
104		161
105	=item %cf::CFG	162	=item %cf::CFG
106		163
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
108	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.
109		178
110	=back	179	=back
111		180
112	=cut	181	=cut
113		182
114	BEGIN {	183	BEGIN {
115	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	185	my $msg = join "", @_;
117	utf8::encode $msg;
118		186
119	$msg .= "\n"	187	$msg .= "\n"
120	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
121		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
122	LOG llevError, "cfperl: $msg";	193	LOG llevError, $msg;
123	};	194	};
124	}	195	}
125		196
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		204
133	# 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
134	# within the Safe compartment.	206	# within the Safe compartment.
135	for my $pkg (qw(	207	for my $pkg (qw(
136	cf::global cf::attachable	208	cf::global cf::attachable
…		…
145		217
146	$Event::DIED = sub {	218	$Event::DIED = sub {
147	warn "error in event callback: @_";	219	warn "error in event callback: @_";
148	};	220	};
149		221
150	my %ext_pkg;	222	#############################################################################
151	my @exts;
152	my @hook;
153		223
154	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
155		225
156	=over 4	226	=over 4
157		227
158	=cut	228	=item dumpval $ref
159		229
160	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	}
161		250
162	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
163		252
164	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
165		254
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
174		256
175	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
176		258
177	=cut	259	=cut
178		260
179	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181	JSON::Syck::Dump $_[0]
182	}
183		262
184	=item my $guard = cf::guard { BLOCK }	263	sub to_json ($) { $json_coder->encode ($_[0]) }
185		264	sub from_json ($) { $json_coder->decode ($_[0]) }
186	Run the given callback when the guard object gets destroyed (useful for
187	coroutine cancellations).
188
189	You can call C<< ->cancel >> on the guard object to stop the block from
190	being executed.
191
192	=cut
193
194	sub guard(&) {
195	bless \(my $cb = $_[0]), cf::guard::;
196	}
197
198	sub cf::guard::cancel {
199	${$_[0]} = sub { };
200	}
201
202	sub cf::guard::DESTROY {
203	${$_[0]}->();
204	}
205		265
206	=item cf::lock_wait $string	266	=item cf::lock_wait $string
207		267
208	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
209		269
210	=item my $lock = cf::lock_acquire $string	270	=item my $lock = cf::lock_acquire $string
211		271
212	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
213	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,
214	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
215	returned.	275	returned.
216		276
217	Lock names should begin with a unique identifier (for example, cf::map::find	277	Lock names should begin with a unique identifier (for example, cf::map::find
218	uses map_find and cf::map::load 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.
219		283
220	=cut	284	=cut
221		285
222	our %LOCK;	286	our %LOCK;
223		287
…		…
237	# wait, to be sure we are not locked	301	# wait, to be sure we are not locked
238	lock_wait $key;	302	lock_wait $key;
239		303
240	$LOCK{$key} = [];	304	$LOCK{$key} = [];
241		305
242	cf::guard {	306	Coro::guard {
243	# wake up all waiters, to be on the safe side	307	# wake up all waiters, to be on the safe side
244	$_->ready for @{ delete $LOCK{$key} };	308	$_->ready for @{ delete $LOCK{$key} };
245	}	309	}
246	}	310	}
247		311
248	=item cf::async { BLOCK }	312	sub lock_active($) {
249
250	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
251	error instead of exiting the server in case of a problem.
252
253	=cut
254
255	sub async(&) {
256	my ($cb) = @_;	313	my ($key) = @_;
257		314
258	Coro::async {	315	! ! $LOCK{$key}
259	eval { $cb->() };
260	warn $@ if $@;
261	}
262	}	316	}
263		317
264	sub freeze_mainloop {	318	sub freeze_mainloop {
265	return unless $TICK_WATCHER->is_active;	319	return unless $TICK_WATCHER->is_active;
266		320
267	my $guard = guard { $TICK_WATCHER->start };	321	my $guard = Coro::guard {
		322	$TICK_WATCHER->start;
		323	};
268	$TICK_WATCHER->stop;	324	$TICK_WATCHER->stop;
269	$guard	325	$guard
270	}	326	}
271		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
		384	=item cf::async { BLOCK }
		385
		386	Currently the same as Coro::async_pool, meaning you cannot use
		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.
		389
		390	=cut
		391
		392	BEGIN { *async = \&Coro::async_pool }
		393
272	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
273		395
274	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)
275	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
276	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.
277		400
278	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
279	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
280	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
281	fast or be very important.	404	fast or be very important.
…		…
284		407
285	sub sync_job(&) {	408	sub sync_job(&) {
286	my ($job) = @_;	409	my ($job) = @_;
287		410
288	if ($Coro::current == $Coro::main) {	411	if ($Coro::current == $Coro::main) {
		412	my $time = Event::time;
		413
289	# this is the main coro, too bad, we have to block	414	# this is the main coro, too bad, we have to block
290	# till the operation succeeds, freezing the server :/	415	# till the operation succeeds, freezing the server :/
291		416
292	# TODO: use suspend/resume instead	417	# TODO: use suspend/resume instead
293	# (but this is cancel-safe)	418	# (but this is cancel-safe)
294	my $freeze_guard = freeze_mainloop;	419	my $freeze_guard = freeze_mainloop;
295		420
296	my $busy = 1;	421	my $busy = 1;
297	my @res;	422	my @res;
298		423
299	(Coro::async {	424	(async {
300	@res = eval { $job->() };	425	@res = eval { $job->() };
301	warn $@ if $@;	426	warn $@ if $@;
302	undef $busy;	427	undef $busy;
303	})->prio (Coro::PRIO_MAX);	428	})->prio (Coro::PRIO_MAX);
304		429
305	while ($busy) {	430	while ($busy) {
306	Coro::cede_notself;	431	Coro::cede or Event::one_event;
307	Event::one_event unless Coro::nready;
308	}	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
309		440
310	wantarray ? @res : $res[0]	441	wantarray ? @res : $res[0]
311	} else {	442	} else {
312	# we are in another coroutine, how wonderful, everything just works	443	# we are in another coroutine, how wonderful, everything just works
313		444
314	$job->()	445	$job->()
315	}	446	}
316	}	447	}
317		448
318	=item $coro = cf::coro { BLOCK }	449	=item $coro = cf::async_ext { BLOCK }
319		450
320	Creates and returns a new coro. This coro is automcatially being canceled	451	Like async, but this coro is automatically being canceled when the
321	when the extension calling this is being unloaded.	452	extension calling this is being unloaded.
322		453
323	=cut	454	=cut
324		455
325	sub coro(&) {	456	sub async_ext(&) {
326	my $cb = shift;	457	my $cb = shift;
327		458
328	my $coro = &cf::async ($cb);	459	my $coro = &Coro::async ($cb);
329		460
330	$coro->on_destroy (sub {	461	$coro->on_destroy (sub {
331	delete $EXT_CORO{$coro+0};	462	delete $EXT_CORO{$coro+0};
332	});	463	});
333	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
334		465
335	$coro	466	$coro
336	}	467	}
337		468
338	sub write_runtime {	469	=item fork_call { }, $args
339	my $runtime = cf::localdir . "/runtime";
340		470
341	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	471	Executes the given code block with the given arguments in a seperate
342	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.
343		475
344	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	476	=cut
345	(aio_write $fh, 0, (length $value), $value, 0) <= 0
346	and return;
347		477
348	aio_fsync $fh	478	sub fork_call(&@) {
349	and return;	479	my ($cb, @args) = @_;
350		480
351	close $fh	481	# we seemingly have to make a local copy of the whole thing,
352	or return;	482	# otherwise perl prematurely frees the stuff :/
		483	# TODO: investigate and fix (liekly this will be rather laborious)
353		484
354	aio_rename "$runtime~", $runtime	485	my @res = Coro::Util::fork_eval {
355	and return;	486	reset_signals;
		487	&$cb
		488	}, @args;
356		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	};
357	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 });
358	}	618	}
359		619
360	=back	620	=back
361		621
362	=cut	622	=cut
363
364	#############################################################################
365
366	package cf::path;
367
368	sub new {
369	my ($class, $path, $base) = @_;
370
371	$path = $path->as_string if ref $path;
372
373	my $self = bless { }, $class;
374
375	# {... are special paths that are not touched
376	# ?xxx/... are special absolute paths
377	# ?random/... random maps
378	# /! non-realised random map exit
379	# /... normal maps
380	# ~/... per-player maps without a specific player (DO NOT USE)
381	# ~user/... per-player map of a specific user
382
383	if ($path =~ /^{/) {
384	# fine as it is
385	} elsif ($path =~ s{^\?random/}{}) {
386	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
387	$self->{random} = cf::from_json $data;
388	} else {
389	if ($path =~ s{^~([^/]+)?}{}) {
390	$self->{user_rel} = 1;
391
392	if (defined $1) {
393	$self->{user} = $1;
394	} elsif ($base =~ m{^~([^/]+)/}) {
395	$self->{user} = $1;
396	} else {
397	warn "cannot resolve user-relative path without user <$path,$base>\n";
398	}
399	} elsif ($path =~ /^\//) {
400	# already absolute
401	} else {
402	$base =~ s{[^/]+/?$}{};
403	return $class->new ("$base/$path");
404	}
405
406	for ($path) {
407	redo if s{/\.?/}{/};
408	redo if s{/[^/]+/\.\./}{/};
409	}
410	}
411
412	$self->{path} = $path;
413
414	$self
415	}
416
417	# the name / primary key / in-game path
418	sub as_string {
419	my ($self) = @_;
420
421	$self->{user_rel} ? "~$self->{user}$self->{path}"
422	: $self->{random} ? "?random/$self->{path}"
423	: $self->{path}
424	}
425
426	# the displayed name, this is a one way mapping
427	sub visible_name {
428	my ($self) = @_;
429
430	# if (my $rmp = $self->{random}) {
431	# # todo: be more intelligent about this
432	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
433	# } else {
434	$self->as_string
435	# }
436	}
437
438	# escape the /'s in the path
439	sub _escaped_path {
440	# ∕ is U+2215
441	(my $path = $_[0]{path}) =~ s/\//∕/g;
442	$path
443	}
444
445	# the original (read-only) location
446	sub load_path {
447	my ($self) = @_;
448
449	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
450	}
451
452	# the temporary/swap location
453	sub save_path {
454	my ($self) = @_;
455
456	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
457	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
458	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
459	}
460
461	# the unique path, might be eq to save_path
462	sub uniq_path {
463	my ($self) = @_;
464
465	$self->{user_rel} || $self->{random}
466	? undef
467	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
468	}
469
470	# return random map parameters, or undef
471	sub random_map_params {
472	my ($self) = @_;
473
474	$self->{random}
475	}
476
477	# this is somewhat ugly, but style maps do need special treatment
478	sub is_style_map {
479	$_[0]{path} =~ m{^/styles/}
480	}
481
482	package cf;
483		623
484	#############################################################################	624	#############################################################################
485		625
486	=head2 ATTACHABLE OBJECTS	626	=head2 ATTACHABLE OBJECTS
487		627
…		…
489	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")
490	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
491		631
492	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>
493	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
494	crossfire+).	634	Crossfire TRT).
495		635
496	=over 4	636	=over 4
497		637
498	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
499		639
…		…
613	our @CB_TYPE = (); # registry for type (cf-object class) based events	753	our @CB_TYPE = (); # registry for type (cf-object class) based events
614	our @CB_MAP = ();	754	our @CB_MAP = ();
615		755
616	my %attachment;	756	my %attachment;
617		757
		758	sub cf::attachable::thawer_merge {
		759	# simply override everything except _meta
		760	local $_[0]{_meta};
		761	%{$_[0]} = %{$_[1]};
		762	}
		763
618	sub _attach_cb($$$$) {	764	sub _attach_cb($$$$) {
619	my ($registry, $event, $prio, $cb) = @_;	765	my ($registry, $event, $prio, $cb) = @_;
620		766
621	use sort 'stable';	767	use sort 'stable';
622		768
…		…
656	$registry = $CB_TYPE[$object_type] ||= [];	802	$registry = $CB_TYPE[$object_type] ||= [];
657		803
658	} elsif ($type eq "subtype") {	804	} elsif ($type eq "subtype") {
659	defined $object_type or Carp::croak "subtype specified without type";	805	defined $object_type or Carp::croak "subtype specified without type";
660	my $object_subtype = shift @arg;	806	my $object_subtype = shift @arg;
661	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	807	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
662		808
663	} elsif ($type eq "package") {	809	} elsif ($type eq "package") {
664	my $pkg = shift @arg;	810	my $pkg = shift @arg;
665		811
666	while (my ($name, $id) = each %cb_id) {	812	while (my ($name, $id) = each %cb_id) {
…		…
695	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
696	}	842	}
697		843
698	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
699	} else {	845	} else {
700	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
701	}	847	}
702		848
703	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
704	}	850	}
705		851
…		…
707	if (ref $_[0]) {	853	if (ref $_[0]) {
708	_object_attach @_;	854	_object_attach @_;
709	} else {	855	} else {
710	_attach shift->_attach_registry, @_;	856	_attach shift->_attach_registry, @_;
711	}	857	}
		858	_recalc_want;
712	};	859	};
713		860
714	# all those should be optimised	861	# all those should be optimised
715	sub cf::attachable::detach {	862	sub cf::attachable::detach {
716	my ($obj, $name) = @_;	863	my ($obj, $name) = @_;
…		…
719	delete $obj->{_attachment}{$name};	866	delete $obj->{_attachment}{$name};
720	reattach ($obj);	867	reattach ($obj);
721	} else {	868	} else {
722	Carp::croak "cannot, currently, detach class attachments";	869	Carp::croak "cannot, currently, detach class attachments";
723	}	870	}
		871	_recalc_want;
724	};	872	};
725		873
726	sub cf::attachable::attached {	874	sub cf::attachable::attached {
727	my ($obj, $name) = @_;	875	my ($obj, $name) = @_;
728		876
…		…
743	";	891	";
744	die if $@;	892	die if $@;
745	}	893	}
746		894
747	our $override;	895	our $override;
748	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?
749		897
750	sub override {	898	sub override {
751	$override = 1;	899	$override = 1;
752	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
753	}	901	}
754		902
755	sub do_invoke {	903	sub do_invoke {
756	my $event = shift;	904	my $event = shift;
757	my $callbacks = shift;	905	my $callbacks = shift;
758		906
759	@invoke_results = ();	907	@INVOKE_RESULTS = ();
760		908
761	local $override;	909	local $override;
762		910
763	for (@$callbacks) {	911	for (@$callbacks) {
764	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
781		929
782	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
783		931
784	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
785	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
786	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
787		935
788	=back	936	=back
789		937
790	=cut	938	=cut
791		939
792	#############################################################################	940	#############################################################################
793	# 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	}
794		953
795	sub reattach {	954	sub reattach {
796	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
797	my ($obj) = @_;	956	my ($obj) = @_;
		957
		958	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
798		959
799	my $registry = $obj->registry;	960	my $registry = $obj->registry;
800		961
801	@$registry = ();	962	@$registry = ();
802		963
…		…
849	$filename, length $$rdata, scalar @$objs;	1010	$filename, length $$rdata, scalar @$objs;
850		1011
851	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1012	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
852	chmod SAVE_MODE, $fh;	1013	chmod SAVE_MODE, $fh;
853	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1014	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
854	aio_fsync $fh;	1015	aio_fsync $fh if $cf::USE_FSYNC;
855	close $fh;	1016	close $fh;
856		1017
857	if (@$objs) {	1018	if (@$objs) {
858	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) {
859	chmod SAVE_MODE, $fh;	1020	chmod SAVE_MODE, $fh;
860	my $data = Storable::nfreeze { version => 1, objs => $objs };	1021	my $data = Storable::nfreeze { version => 1, objs => $objs };
861	aio_write $fh, 0, (length $data), $data, 0;	1022	aio_write $fh, 0, (length $data), $data, 0;
862	aio_fsync $fh;	1023	aio_fsync $fh if $cf::USE_FSYNC;
863	close $fh;	1024	close $fh;
864	aio_rename "$filename.pst~", "$filename.pst";	1025	aio_rename "$filename.pst~", "$filename.pst";
865	}	1026	}
866	} else {	1027	} else {
867	aio_unlink "$filename.pst";	1028	aio_unlink "$filename.pst";
…		…
899	or return;	1060	or return;
900	$av = eval { (Storable::thaw $av)->{objs} };	1061	$av = eval { (Storable::thaw $av)->{objs} };
901	}	1062	}
902		1063
903	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
904	$filename, length $data, scalar @{$av || []};#d#	1065	$filename, length $data, scalar @{$av || []};
905	return ($data, $av);	1066	return ($data, $av);
906	}	1067	}
		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
907		1074
908	#############################################################################	1075	#############################################################################
909	# command handling &c	1076	# command handling &c
910		1077
911	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
…		…
924	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
925	}	1092	}
926		1093
927	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
928		1095
929	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.
930		1101
931	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
932	called.	1103	called.
933		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
934	=cut	1116	=cut
935		1117
936	sub register_extcmd {	1118	sub register_extcmd {
937	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
938		1120
939	my $caller = caller;
940	#warn "registering extcmd '$name' to '$caller'";
941
942	$EXTCMD{$name} = [$cb, $caller];	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
943	}	1128	}
944		1129
945	cf::player->attach (	1130	cf::player->attach (
946	on_command => sub {	1131	on_command => sub {
947	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
956	cf::override;	1141	cf::override;
957	},	1142	},
958	on_extcmd => sub {	1143	on_extcmd => sub {
959	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
960		1145
961	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
962		1147
963	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
964	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1154	if (my $cb = $EXTCMD{$type}) {
965	if (my %reply = $cb->[0]->($pl, $msg)) {	1155	my @reply = $cb->($pl, @payload);
		1156
966	$pl->ext_reply ($msg->{msgid}, %reply);	1157	$pl->ext_reply ($reply, @reply)
967	}	1158	if $reply;
968	}	1159	}
969	} else {	1160	} else {
970	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1161	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
971	}	1162	}
972		1163
973	cf::override;	1164	cf::override;
974	},	1165	},
975	);	1166	);
976		1167
977	sub register {
978	my ($base, $pkg) = @_;
979
980	#TODO
981	}
982
983	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($) {
984	my ($path) = @_;	1546	my ($path) = @_;
985		1547
986	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1548	my ($match, $specificity);
987	my $base = $1;
988	my $pkg = $1;
989	$pkg =~ s/[^[:word:]]/_/g;
990	$pkg = "ext::$pkg";
991		1549
992	warn "loading '$path' into '$pkg'\n";	1550	for my $region (list) {
993		1551	if ($region->{match} && $path =~ $region->{match}) {
994	open my $fh, "<:utf8", $path	1552	($match, $specificity) = ($region, $region->specificity)
995	or die "$path: $!";	1553	if $region->specificity > $specificity;
996		1554	}
997	my $source =
998	"package $pkg; use strict; use utf8;\n"
999	. "#line 1 \"$path\"\n{\n"
1000	. (do { local $/; <$fh> })
1001	. "\n};\n1";
1002
1003	eval $source
1004	or die $@ ? "$path: $@\n"
1005	: "extension disabled.\n";
1006
1007	push @exts, $pkg;
1008	$ext_pkg{$base} = $pkg;
1009
1010	# no strict 'refs';
1011	# @{"$pkg\::ISA"} = ext::;
1012
1013	register $base, $pkg;
1014	}
1015
1016	sub unload_extension {
1017	my ($pkg) = @_;
1018
1019	warn "removing extension $pkg\n";
1020
1021	# remove hooks
1022	#TODO
1023	# for my $idx (0 .. $#PLUGIN_EVENT) {
1024	# delete $hook[$idx]{$pkg};
1025	# }	1555	}
1026		1556
1027	# remove commands	1557	$match
1028	for my $name (keys %COMMAND) {
1029	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1030
1031	if (@cb) {
1032	$COMMAND{$name} = \@cb;
1033	} else {
1034	delete $COMMAND{$name};
1035	}
1036	}
1037
1038	# remove extcmds
1039	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1040	delete $EXTCMD{$name};
1041	}
1042
1043	if (my $cb = $pkg->can ("unload")) {
1044	eval {
1045	$cb->($pkg);
1046	1
1047	} or warn "$pkg unloaded, but with errors: $@";
1048	}
1049
1050	Symbol::delete_package $pkg;
1051	}
1052
1053	sub load_extensions {
1054	for my $ext (<$LIBDIR/*.ext>) {
1055	next unless -r $ext;
1056	eval {
1057	load_extension $ext;
1058	1
1059	} or warn "$ext not loaded: $@";
1060	}
1061	}
1062
1063	#############################################################################
1064	# load/save/clean perl data associated with a map
1065
1066	*cf::mapsupport::on_clean = sub {
1067	my ($map) = @_;
1068
1069	my $path = $map->tmpname;
1070	defined $path or return;
1071
1072	unlink "$path.pst";
1073	};
1074
1075	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1076
1077	#############################################################################
1078	# load/save perl data associated with player->ob objects
1079
1080	sub all_objects(@) {
1081	@_, map all_objects ($_->inv), @_
1082	}
1083
1084	# TODO: compatibility cruft, remove when no longer needed
1085	cf::player->attach (
1086	on_load => sub {
1087	my ($pl, $path) = @_;
1088
1089	for my $o (all_objects $pl->ob) {
1090	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1091	$o->set_ob_key_value ("_perl_data");
1092
1093	%$o = %{ Storable::thaw pack "H*", $value };
1094	}
1095	}
1096	},
1097	);
1098
1099	#############################################################################
1100
1101	=head2 CORE EXTENSIONS
1102
1103	Functions and methods that extend core crossfire objects.
1104
1105	=head3 cf::player
1106
1107	=over 4
1108
1109	=item cf::player::exists $login
1110
1111	Returns true when the given account exists.
1112
1113	=cut
1114
1115	sub cf::player::exists($) {
1116	cf::player::find $_[0]
1117	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1118	}
1119
1120	=item $player->ext_reply ($msgid, $msgtype, %msg)
1121
1122	Sends an ext reply to the player.
1123
1124	=cut
1125
1126	sub cf::player::ext_reply($$$%) {
1127	my ($self, $id, %msg) = @_;
1128
1129	$msg{msgid} = $id;
1130
1131	$self->send ("ext " . to_json \%msg);
1132	}	1558	}
1133		1559
1134	=back	1560	=back
1135
1136		1561
1137	=head3 cf::map	1562	=head3 cf::map
1138		1563
1139	=over 4	1564	=over 4
1140		1565
…		…
1143	package cf::map;	1568	package cf::map;
1144		1569
1145	use Fcntl;	1570	use Fcntl;
1146	use Coro::AIO;	1571	use Coro::AIO;
1147		1572
		1573	use overload
		1574	'""' => \&as_string,
		1575	fallback => 1;
		1576
1148	our $MAX_RESET = 3600;	1577	our $MAX_RESET = 3600;
1149	our $DEFAULT_RESET = 3000;	1578	our $DEFAULT_RESET = 3000;
1150		1579
1151	sub generate_random_map {	1580	sub generate_random_map {
1152	my ($path, $rmp) = @_;	1581	my ($self, $rmp) = @_;
1153
1154	# mit "rum" bekleckern, nicht	1582	# mit "rum" bekleckern, nicht
1155	cf::map::_create_random_map	1583	$self->_create_random_map (
1156	$path,
1157	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1584	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1158	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1585	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1159	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1586	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1160	$rmp->{exit_on_final_map},	1587	$rmp->{exit_on_final_map},
1161	$rmp->{xsize}, $rmp->{ysize},	1588	$rmp->{xsize}, $rmp->{ysize},
1162	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1589	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1163	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1590	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1164	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1591	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1165	$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},
1166	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1593	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1167	(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"
1168	}	1723	}
1169		1724
1170	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1171	# all maps in C++...	1726	# all maps in C++...
1172	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1174		1729
1175	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1176	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1177	}	1732	}
1178		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
1179	sub try_load_header($) {	1750	sub load_header_from($) {
1180	my ($path) = @_;	1751	my ($self, $path) = @_;
1181		1752
1182	utf8::encode $path;	1753	utf8::encode $path;
1183	aio_open $path, O_RDONLY, 0	1754	#aio_open $path, O_RDONLY, 0
		1755	# or return;
		1756
		1757	$self->_load_header ($path)
1184	or return;	1758	or return;
1185		1759
1186	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
1187	or return;	1803	or return;
		1804	$self->prepare_orig;
		1805	}
1188		1806
1189	$map->load_header ($path)	1807	$self->{deny_reset} = 1
1190	or return;	1808	if $self->no_reset;
1191		1809
1192	$map->{load_path} = $path;	1810	$self->default_region (cf::region::find_by_path $self->{path})
		1811	unless $self->default_region;
1193		1812
1194	$map	1813	1
1195	}	1814	}
1196		1815
1197	sub find;	1816	sub find;
1198	sub find {	1817	sub find {
1199	my ($path, $origin) = @_;	1818	my ($path, $origin) = @_;
1200		1819
1201	#warn "find<$path,$origin>\n";#d#
1202
1203	$path = new cf::path $path, $origin && $origin->path;	1820	$path = normalise $path, $origin && $origin->path;
1204	my $key = $path->as_string;
1205		1821
1206	cf::lock_wait "map_find:$key";	1822	cf::lock_wait "map_find:$path";
1207		1823
1208	$cf::MAP{$key} || do {	1824	$cf::MAP{$path} || do {
1209	my $guard = cf::lock_acquire "map_find:$key";	1825	my $guard = cf::lock_acquire "map_find:$path";
1210		1826	my $map = new_from_path cf::map $path
1211	# do it the slow way
1212	my $map = try_load_header $path->save_path;
1213
1214	if ($map) {
1215	$map->last_access ((delete $map->{last_access})
1216	|| $cf::RUNTIME); #d#
1217	# safety
1218	$map->{instantiate_time} = $cf::RUNTIME
1219	if $map->{instantiate_time} > $cf::RUNTIME;
1220	} else {
1221	if (my $rmp = $path->random_map_params) {
1222	$map = generate_random_map $key, $rmp;
1223	} else {
1224	$map = try_load_header $path->load_path;
1225	}
1226
1227	$map or return;	1827	or return;
1228		1828
1229	$map->{load_original} = 1;
1230	$map->{instantiate_time} = $cf::RUNTIME;
1231	$map->last_access ($cf::RUNTIME);
1232	$map->instantiate;
1233
1234	# per-player maps become, after loading, normal maps
1235	$map->per_player (0) if $path->{user_rel};
1236	}
1237
1238	$map->path ($key);
1239	$map->{path} = $path;
1240	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1241		1830
1242	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;
1243	$map->reset;	1837	$map->reset;
1244	undef $guard;	1838	undef $guard;
1245	$map = find $path	1839	return find $path;
1246	or return;
1247	}	1840	}
1248		1841
1249	$cf::MAP{$key} = $map	1842	$cf::MAP{$path} = $map
1250	}	1843	}
1251	}	1844	}
		1845
		1846	sub pre_load { }
		1847	sub post_load { }
1252		1848
1253	sub load {	1849	sub load {
1254	my ($self) = @_;	1850	my ($self) = @_;
1255		1851
		1852	local $self->{deny_reset} = 1; # loading can take a long time
		1853
1256	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
1257	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1857	my $guard = cf::lock_acquire "map_load:$path";
1258		1858
1259	return if $self->in_memory != cf::MAP_SWAPPED;	1859	return if $self->in_memory != cf::MAP_SWAPPED;
1260		1860
1261	$self->in_memory (cf::MAP_LOADING);	1861	$self->in_memory (cf::MAP_LOADING);
1262		1862
1263	$self->alloc;	1863	$self->alloc;
		1864
		1865	$self->pre_load;
		1866	Coro::cede;
		1867
1264	$self->load_objects ($self->{load_path}, 1)	1868	$self->_load_objects ($self->{load_path}, 1)
1265	or return;	1869	or return;
1266		1870
1267	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1871	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1268	if delete $self->{load_original};	1872	if delete $self->{load_original};
1269		1873
1270	if (my $uniq = $path->uniq_path) {	1874	if (my $uniq = $self->uniq_path) {
1271	utf8::encode $uniq;	1875	utf8::encode $uniq;
1272	if (aio_open $uniq, O_RDONLY, 0) {	1876	if (aio_open $uniq, O_RDONLY, 0) {
1273	$self->clear_unique_items;	1877	$self->clear_unique_items;
1274	$self->load_objects ($uniq, 0);	1878	$self->_load_objects ($uniq, 0);
1275	}	1879	}
1276	}	1880	}
1277		1881
		1882	Coro::cede;
1278	# now do the right thing for maps	1883	# now do the right thing for maps
1279	$self->link_multipart_objects;	1884	$self->link_multipart_objects;
1280
1281	if ($self->{path}->is_style_map) {
1282	$self->{deny_save} = 1;
1283	$self->{deny_reset} = 1;
1284	} else {
1285	$self->fix_auto_apply;
1286	$self->decay_objects;
1287	$self->update_buttons;
1288	$self->set_darkness_map;
1289	$self->difficulty ($self->estimate_difficulty)	1885	$self->difficulty ($self->estimate_difficulty)
1290	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;
1291	$self->activate;	1896	$self->activate;
1292	}	1897	}
1293		1898
		1899	$self->{last_save} = $cf::RUNTIME;
		1900	$self->last_access ($cf::RUNTIME);
		1901
1294	$self->in_memory (cf::MAP_IN_MEMORY);	1902	$self->in_memory (cf::MAP_IN_MEMORY);
		1903	}
		1904
		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	}
1295	}	1944	}
1296		1945
1297	sub find_sync {	1946	sub find_sync {
1298	my ($path, $origin) = @_;	1947	my ($path, $origin) = @_;
1299		1948
1300	cf::sync_job { cf::map::find $path, $origin }	1949	cf::sync_job { find $path, $origin }
1301	}	1950	}
1302		1951
1303	sub do_load_sync {	1952	sub do_load_sync {
1304	my ($map) = @_;	1953	my ($map) = @_;
1305		1954
1306	cf::sync_job { $map->load };	1955	cf::sync_job { $map->load };
1307	}	1956	}
1308		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) {
		1975	$map->load;
		1976	}
		1977
		1978	delete $MAP_PREFETCH{$path};
		1979	}
		1980	}
		1981	undef $MAP_PREFETCHER;
		1982	};
		1983	$MAP_PREFETCHER->prio (6);
		1984
		1985	()
		1986	}
		1987
1309	sub save {	1988	sub save {
1310	my ($self) = @_;	1989	my ($self) = @_;
1311		1990
		1991	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1992
1312	$self->{last_save} = $cf::RUNTIME;	1993	$self->{last_save} = $cf::RUNTIME;
1313		1994
1314	return unless $self->dirty;	1995	return unless $self->dirty;
1315		1996
1316	my $save = $self->{path}->save_path; utf8::encode $save;	1997	my $save = $self->save_path; utf8::encode $save;
1317	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1998	my $uniq = $self->uniq_path; utf8::encode $uniq;
1318		1999
1319	$self->{load_path} = $save;	2000	$self->{load_path} = $save;
1320		2001
1321	return if $self->{deny_save};	2002	return if $self->{deny_save};
1322		2003
1323	local $self->{last_access} = $self->last_access;#d#	2004	local $self->{last_access} = $self->last_access;#d#
1324		2005
		2006	cf::async {
		2007	$_->contr->save for $self->players;
		2008	};
		2009
1325	if ($uniq) {	2010	if ($uniq) {
1326	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2011	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1327	$self->save_objects ($uniq, cf::IO_UNIQUES);	2012	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1328	} else {	2013	} else {
1329	$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);
1330	}	2015	}
1331	}	2016	}
1332		2017
1333	sub swap_out {	2018	sub swap_out {
1334	my ($self) = @_;	2019	my ($self) = @_;
1335		2020
1336	# save first because save cedes	2021	# save first because save cedes
1337	$self->save;	2022	$self->save;
		2023
		2024	my $lock = cf::lock_acquire "map_data:" . $self->path;
1338		2025
1339	return if $self->players;	2026	return if $self->players;
1340	return if $self->in_memory != cf::MAP_IN_MEMORY;	2027	return if $self->in_memory != cf::MAP_IN_MEMORY;
1341	return if $self->{deny_save};	2028	return if $self->{deny_save};
1342		2029
…		…
1346		2033
1347	sub reset_at {	2034	sub reset_at {
1348	my ($self) = @_;	2035	my ($self) = @_;
1349		2036
1350	# TODO: safety, remove and allow resettable per-player maps	2037	# TODO: safety, remove and allow resettable per-player maps
1351	return 1e99 if $self->{path}{user_rel};
1352	return 1e99 if $self->{deny_reset};	2038	return 1e99 if $self->{deny_reset};
1353		2039
1354	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2040	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1355	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;
1356		2042
…		…
1361	my ($self) = @_;	2047	my ($self) = @_;
1362		2048
1363	$self->reset_at <= $cf::RUNTIME	2049	$self->reset_at <= $cf::RUNTIME
1364	}	2050	}
1365		2051
1366	sub unlink_save {
1367	my ($self) = @_;
1368
1369	utf8::encode (my $save = $self->{path}->save_path);
1370	aioreq_pri 3; IO::AIO::aio_unlink $save;
1371	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1372	}
1373
1374	sub rename {
1375	my ($self, $new_path) = @_;
1376
1377	$self->unlink_save;
1378
1379	delete $cf::MAP{$self->path};
1380	$self->{path} = new cf::path $new_path;
1381	$self->path ($self->{path}->as_string);
1382	$cf::MAP{$self->path} = $self;
1383
1384	$self->save;
1385	}
1386
1387	sub reset {	2052	sub reset {
1388	my ($self) = @_;	2053	my ($self) = @_;
1389		2054
		2055	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2056
1390	return if $self->players;	2057	return if $self->players;
1391	return if $self->{path}{user_rel};#d#
1392		2058
1393	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	}
1394		2070
1395	delete $cf::MAP{$self->path};	2071	delete $cf::MAP{$self->path};
		2072
		2073	$self->clear;
1396		2074
1397	$_->clear_links_to ($self) for values %cf::MAP;	2075	$_->clear_links_to ($self) for values %cf::MAP;
1398		2076
1399	$self->unlink_save;	2077	$self->unlink_save;
1400	$self->destroy;	2078	$self->destroy;
…		…
1403	my $nuke_counter = "aaaa";	2081	my $nuke_counter = "aaaa";
1404		2082
1405	sub nuke {	2083	sub nuke {
1406	my ($self) = @_;	2084	my ($self) = @_;
1407		2085
		2086	delete $cf::MAP{$self->path};
		2087
		2088	$self->unlink_save;
		2089
		2090	bless $self, "cf::map";
		2091	delete $self->{deny_reset};
1408	$self->{deny_save} = 1;	2092	$self->{deny_save} = 1;
1409	$self->reset_timeout (1);	2093	$self->reset_timeout (1);
1410	$self->rename ("{nuke}/" . ($nuke_counter++));	2094	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2095
		2096	$cf::MAP{$self->path} = $self;
		2097
1411	$self->reset; # polite request, might not happen	2098	$self->reset; # polite request, might not happen
1412	}	2099	}
1413		2100
1414	sub customise_for {	2101	=item $maps = cf::map::tmp_maps
1415	my ($map, $ob) = @_;
1416		2102
1417	if ($map->per_player) {	2103	Returns an arrayref with all map paths of currently instantiated and saved
1418	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2104	maps. May block.
		2105
		2106	=cut
		2107
		2108	sub tmp_maps() {
1419	}	2109	[
1420		2110	map {
1421	$map	2111	utf8::decode $_;
		2112	/\.map$/
		2113	? normalise $_
		2114	: ()
		2115	} @{ aio_readdir $TMPDIR or [] }
		2116	]
1422	}	2117	}
1423		2118
1424	sub emergency_save {	2119	=item $maps = cf::map::random_maps
1425	my $freeze_guard = cf::freeze_mainloop;
1426		2120
1427	warn "enter emergency map save\n";	2121	Returns an arrayref with all map paths of currently instantiated and saved
		2122	random maps. May block.
1428		2123
1429	cf::sync_job {	2124	=cut
1430	warn "begin emergency map save\n";
1431	$_->save for values %cf::MAP;
1432	};
1433		2125
1434	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	]
1435	}	2153	}
1436		2154
1437	package cf;	2155	package cf;
1438		2156
1439	=back	2157	=back
1440		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
1441		2185
1442	=head3 cf::object::player	2186	=head3 cf::object::player
1443		2187
1444	=over 4	2188	=over 4
1445		2189
…		…
1459		2203
1460	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2204	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1461		2205
1462	if ($self->{record_replies}) {	2206	if ($self->{record_replies}) {
1463	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2207	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2208
1464	} 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 {
1465	$msg = $npc->name . " says: $msg" if $npc;	2217	$msg = $npc->name . " says: $msg" if $npc;
1466	$self->message ($msg, $flags);	2218	$self->message ($msg, $flags);
		2219	}
1467	}	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 (@_);
1468	}	2231	}
1469		2232
1470	=item $player_object->may ("access")	2233	=item $player_object->may ("access")
1471		2234
1472	Returns wether the given player is authorized to access resource "access"	2235	Returns wether the given player is authorized to access resource "access"
…		…
1485		2248
1486	=item $player_object->enter_link	2249	=item $player_object->enter_link
1487		2250
1488	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}>).
1489		2252
1490	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
1491	I<MUST> call C<leave_link> as soon as possible, though.	2254	I<MUST> call C<leave_link> as soon as possible, though.
1492		2255
		2256	Will never block.
		2257
1493	=item $player_object->leave_link ($map, $x, $y)	2258	=item $player_object->leave_link ($map, $x, $y)
1494		2259
1495	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
1496	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
1497	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
1498	to the emergency map position.	2263	fails, to the emergency map position.
1499		2264
1500	Might block.	2265	Might block.
1501		2266
1502	=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	}
1503		2278
1504	sub cf::object::player::enter_link {	2279	sub cf::object::player::enter_link {
1505	my ($self) = @_;	2280	my ($self) = @_;
1506		2281
1507	$self->deactivate_recursive;	2282	$self->deactivate_recursive;
1508		2283
1509	return if $self->map == $LINK_MAP;	2284	return if UNIVERSAL::isa $self->map, "ext::map_link";
1510		2285
1511	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2286	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1512	if $self->map;	2287	if $self->map && $self->map->{path} ne "{link}";
1513		2288
1514	$self->enter_map ($LINK_MAP, 20, 20);	2289	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1515	}	2290	}
1516		2291
1517	sub cf::object::player::leave_link {	2292	sub cf::object::player::leave_link {
1518	my ($self, $map, $x, $y) = @_;	2293	my ($self, $map, $x, $y) = @_;
		2294
		2295	return unless $self->contr->active;
1519		2296
1520	my $link_pos = delete $self->{_link_pos};	2297	my $link_pos = delete $self->{_link_pos};
1521		2298
1522	unless ($map) {	2299	unless ($map) {
1523	# restore original map position	2300	# restore original map position
…		…
1537	# use -1 or undef as default coordinates, not 0, 0	2314	# use -1 or undef as default coordinates, not 0, 0
1538	($x, $y) = ($map->enter_x, $map->enter_y)	2315	($x, $y) = ($map->enter_x, $map->enter_y)
1539	if $x <=0 && $y <= 0;	2316	if $x <=0 && $y <= 0;
1540		2317
1541	$map->load;	2318	$map->load;
		2319	$map->load_neighbours;
1542		2320
		2321	return unless $self->contr->active;
1543	$self->activate_recursive;	2322	$self->activate_recursive;
		2323
		2324	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1544	$self->enter_map ($map, $x, $y);	2325	$self->enter_map ($map, $x, $y);
1545	}	2326	}
1546		2327
1547	cf::player->attach (	2328	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1548	on_logout => sub {
1549	my ($pl) = @_;
1550		2329
1551	# abort map switching before logout	2330	Moves the player to the given map-path and coordinates by first freezing
1552	if ($pl->ob->{_link_pos}) {	2331	her, loading and preparing them map, calling the provided $check callback
1553	cf::sync_job {	2332	that has to return the map if sucecssful, and then unfreezes the player on
1554	$pl->ob->leave_link	2333	the new (success) or old (failed) map position. In either case, $done will
1555	};	2334	be called at the end of this process.
1556	}
1557	},
1558	on_login => sub {
1559	my ($pl) = @_;
1560		2335
1561	# try to abort aborted map switching on player login :)
1562	# should happen only on crashes
1563	if ($pl->ob->{_link_pos}) {
1564	$pl->ob->enter_link;
1565	cf::async {
1566	# we need this sleep as the login has a concurrent enter_exit running
1567	# and this sleep increases chances of the player not ending up in scorn
1568	Coro::Timer::sleep 1;
1569	$pl->ob->leave_link;
1570	};
1571	}
1572	},
1573	);
1574
1575	=item $player_object->goto_map ($path, $x, $y)
1576
1577	=cut	2336	=cut
1578		2337
		2338	our $GOTOGEN;
		2339
1579	sub cf::object::player::goto_map {	2340	sub cf::object::player::goto {
1580	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;
1581		2345
1582	$self->enter_link;	2346	$self->enter_link;
1583		2347
1584	(cf::async {	2348	(async {
1585	$path = new cf::path $path;	2349	my $map = eval {
1586
1587	my $map = cf::map::find $path->as_string;	2350	my $map = cf::map::find $path;
		2351
		2352	if ($map) {
1588	$map = $map->customise_for ($self) if $map;	2353	$map = $map->customise_for ($self);
1589		2354	$map = $check->($map) if $check && $map;
1590	# warn "entering ", $map->path, " at ($x, $y)\n"	2355	} else {
1591	# if $map;
1592
1593	$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	}
1594		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};
1595	$self->leave_link ($map, $x, $y);	2369	$self->leave_link ($map, $x, $y);
		2370	}
		2371
		2372	$done->() if $done;
1596	})->prio (1);	2373	})->prio (1);
1597	}	2374	}
1598		2375
1599	=item $player_object->enter_exit ($exit_object)	2376	=item $player_object->enter_exit ($exit_object)
1600		2377
…		…
1602		2379
1603	sub parse_random_map_params {	2380	sub parse_random_map_params {
1604	my ($spec) = @_;	2381	my ($spec) = @_;
1605		2382
1606	my $rmp = { # defaults	2383	my $rmp = { # defaults
1607	xsize => 10,	2384	xsize => (cf::rndm 15, 40),
1608	ysize => 10,	2385	ysize => (cf::rndm 15, 40),
		2386	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2387	#layout => string,
1609	};	2388	};
1610		2389
1611	for (split /\n/, $spec) {	2390	for (split /\n/, $spec) {
1612	my ($k, $v) = split /\s+/, $_, 2;	2391	my ($k, $v) = split /\s+/, $_, 2;
1613		2392
…		…
1617	$rmp	2396	$rmp
1618	}	2397	}
1619		2398
1620	sub prepare_random_map {	2399	sub prepare_random_map {
1621	my ($exit) = @_;	2400	my ($exit) = @_;
		2401
		2402	my $guard = cf::lock_acquire "exit_prepare:$exit";
1622		2403
1623	# all this does is basically replace the /! path by	2404	# all this does is basically replace the /! path by
1624	# a new random map path (?random/...) with a seed	2405	# a new random map path (?random/...) with a seed
1625	# that depends on the exit object	2406	# that depends on the exit object
1626		2407
1627	my $rmp = parse_random_map_params $exit->msg;	2408	my $rmp = parse_random_map_params $exit->msg;
1628		2409
1629	if ($exit->map) {	2410	if ($exit->map) {
1630	$rmp->{region} = $exit->map->region_name;	2411	$rmp->{region} = $exit->region->name;
1631	$rmp->{origin_map} = $exit->map->path;	2412	$rmp->{origin_map} = $exit->map->path;
1632	$rmp->{origin_x} = $exit->x;	2413	$rmp->{origin_x} = $exit->x;
1633	$rmp->{origin_y} = $exit->y;	2414	$rmp->{origin_y} = $exit->y;
1634	}	2415	}
1635		2416
1636	$rmp->{random_seed} ||= $exit->random_seed;	2417	$rmp->{random_seed} ||= $exit->random_seed;
1637		2418
1638	my $data = cf::to_json $rmp;	2419	my $data = cf::to_json $rmp;
1639	my $md5 = Digest::MD5::md5_hex $data;	2420	my $md5 = Digest::MD5::md5_hex $data;
		2421	my $meta = "$RANDOMDIR/$md5.meta";
1640		2422
1641	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) {
1642	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;
1643		2427
1644	$exit->slaying ("?random/$md5");	2428	$exit->slaying ("?random/$md5");
1645	$exit->msg (undef);	2429	$exit->msg (undef);
1646	}	2430	}
1647	}	2431	}
…		…
1649	sub cf::object::player::enter_exit {	2433	sub cf::object::player::enter_exit {
1650	my ($self, $exit) = @_;	2434	my ($self, $exit) = @_;
1651		2435
1652	return unless $self->type == cf::PLAYER;	2436	return unless $self->type == cf::PLAYER;
1653		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
1654	$self->enter_link;	2449	$self->enter_link;
1655		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
1656	(cf::async {	2455	(async {
1657	$self->deactivate_recursive; # just to be sure	2456	$self->deactivate_recursive; # just to be sure
1658	unless (eval {	2457	unless (eval {
1659	prepare_random_map $exit	2458	$self->goto ($slaying, $hp, $sp);
1660	if $exit->slaying eq "/!";
1661
1662	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1663	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1664		2459
1665	1;	2460	1;
1666	}) {	2461	}) {
1667	$self->message ("Something went wrong deep within the crossfire server. "	2462	$self->message ("Something went wrong deep within the crossfire server. "
1668	. "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. "
1669	. "Please report this to the dungeon master",	2464	. "Please report this to the dungeon master!",
1670	cf::NDI_UNIQUE | cf::NDI_RED);	2465	cf::NDI_UNIQUE | cf::NDI_RED);
1671		2466
1672	warn "ERROR in enter_exit: $@";	2467	warn "ERROR in enter_exit: $@";
1673	$self->leave_link;	2468	$self->leave_link;
1674	}	2469	}
1675	})->prio (1);	2470	})->prio (1);
…		…
1688		2483
1689	sub cf::client::send_drawinfo {	2484	sub cf::client::send_drawinfo {
1690	my ($self, $text, $flags) = @_;	2485	my ($self, $text, $flags) = @_;
1691		2486
1692	utf8::encode $text;	2487	utf8::encode $text;
1693	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2488	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1694	}	2489	}
1695		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	}
1696		2571
1697	=item $success = $client->query ($flags, "text", \&cb)	2572	=item $success = $client->query ($flags, "text", \&cb)
1698		2573
1699	Queues a query to the client, calling the given callback with	2574	Queues a query to the client, calling the given callback with
1700	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>,
1701	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>.
1702		2577
1703	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
1704	reliable at some point in the future.	2579	become reliable at some point in the future.
1705		2580
1706	=cut	2581	=cut
1707		2582
1708	sub cf::client::query {	2583	sub cf::client::query {
1709	my ($self, $flags, $text, $cb) = @_;	2584	my ($self, $flags, $text, $cb) = @_;
…		…
1717	utf8::encode $text;	2592	utf8::encode $text;
1718	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2593	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1719		2594
1720	$self->send_packet ($self->{query_queue}[0][0])	2595	$self->send_packet ($self->{query_queue}[0][0])
1721	if @{ $self->{query_queue} } == 1;	2596	if @{ $self->{query_queue} } == 1;
		2597
		2598	1
1722	}	2599	}
1723		2600
1724	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	},
1725	on_reply => sub {	2607	on_reply => sub {
1726	my ($ns, $msg) = @_;	2608	my ($ns, $msg) = @_;
1727		2609
1728	# this weird shuffling is so that direct followup queries	2610	# this weird shuffling is so that direct followup queries
1729	# get handled first	2611	# get handled first
1730	my $queue = delete $ns->{query_queue}	2612	my $queue = delete $ns->{query_queue}
1731	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
1732		2614
1733	(shift @$queue)->[1]->($msg);	2615	(shift @$queue)->[1]->($msg);
		2616	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1734		2617
1735	push @{ $ns->{query_queue} }, @$queue;	2618	push @{ $ns->{query_queue} }, @$queue;
1736		2619
1737	if (@{ $ns->{query_queue} } == @$queue) {	2620	if (@{ $ns->{query_queue} } == @$queue) {
1738	if (@$queue) {	2621	if (@$queue) {
…		…
1740	} else {	2623	} else {
1741	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2624	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1742	}	2625	}
1743	}	2626	}
1744	},	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	},
1745	);	2651	);
1746		2652
1747	=item $client->coro (\&cb)	2653	=item $client->async (\&cb)
1748		2654
1749	Create a new coroutine, running the specified callback. The coroutine will	2655	Create a new coroutine, running the specified callback. The coroutine will
1750	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,
1751	or loss of connection).	2657	or loss of connection).
1752		2658
1753	=cut	2659	=cut
1754		2660
1755	sub cf::client::coro {	2661	sub cf::client::async {
1756	my ($self, $cb) = @_;	2662	my ($self, $cb) = @_;
1757		2663
1758	my $coro = &cf::async ($cb);	2664	my $coro = &Coro::async ($cb);
1759		2665
1760	$coro->on_destroy (sub {	2666	$coro->on_destroy (sub {
1761	delete $self->{_coro}{$coro+0};	2667	delete $self->{_coro}{$coro+0};
1762	});	2668	});
1763		2669
…		…
1790	our $safe = new Safe "safe";	2696	our $safe = new Safe "safe";
1791	our $safe_hole = new Safe::Hole;	2697	our $safe_hole = new Safe::Hole;
1792		2698
1793	$SIG{FPE} = 'IGNORE';	2699	$SIG{FPE} = 'IGNORE';
1794		2700
1795	$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	));
1796		2706
1797	# here we export the classes and methods available to script code	2707	# here we export the classes and methods available to script code
1798		2708
1799	=pod	2709	=pod
1800		2710
1801	The following fucntions and emthods are available within a safe environment:	2711	The following functions and methods are available within a safe environment:
1802		2712
1803	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
1804	cf::object::player player	2717	cf::object::player
1805	cf::player peaceful	2718	player
1806	cf::map trigger	2719
		2720	cf::player
		2721	peaceful
		2722
		2723	cf::map
		2724	trigger
1807		2725
1808	=cut	2726	=cut
1809		2727
1810	for (	2728	for (
1811	["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)],
1812	["cf::object::player" => qw(player)],	2731	["cf::object::player" => qw(player)],
1813	["cf::player" => qw(peaceful)],	2732	["cf::player" => qw(peaceful)],
1814	["cf::map" => qw(trigger)],	2733	["cf::map" => qw(trigger)],
1815	) {	2734	) {
1816	no strict 'refs';	2735	no strict 'refs';
…		…
1887	=back	2806	=back
1888		2807
1889	=cut	2808	=cut
1890		2809
1891	#############################################################################	2810	#############################################################################
		2811	# the server's init and main functions
1892		2812
1893	=head2 EXTENSION DATABASE SUPPORT	2813	sub load_facedata($) {
		2814	my ($path) = @_;
1894		2815
1895	Crossfire maintains a very simple database for extension use. It can	2816	my $enc = JSON::XS->new->utf8->canonical;
1896	currently store anything that can be serialised using Storable, which
1897	excludes objects.
1898		2817
1899	The parameter C<$family> should best start with the name of the extension	2818	warn "loading facedata from $path\n";
1900	using it, it should be unique.
1901		2819
1902	=over 4	2820	my $facedata;
		2821	0 < aio_load $path, $facedata
		2822	or die "$path: $!";
1903		2823
1904	=item $hashref = cf::db_get $family	2824	$facedata = Coro::Storable::thaw $facedata;
1905		2825
1906	Return a hashref for use by the extension C<$family>, which can be	2826	$facedata->{version} == 2
1907	modified. After modifications, you have to call C<cf::db_dirty> or	2827	or cf::cleanup "$path: version mismatch, cannot proceed.";
1908	C<cf::db_sync>.
1909		2828
1910	=item $value = cf::db_get $family => $key	2829	# patch in the exptable
1911		2830	$facedata->{resource}{"res/exp_table"} = {
1912	Returns a single value from the database	2831	type => FT_RSRC,
1913		2832	data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
1914	=item cf::db_put $family => $hashref
1915
1916	Stores the given family hashref into the database. Updates are delayed, if
1917	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919	=item cf::db_put $family => $key => $value
1920
1921	Stores the given C<$value> in the family hash. Updates are delayed, if you
1922	want the data to be synced to disk immediately, use C<cf::db_sync>.
1923
1924	=item cf::db_dirty
1925
1926	Marks the database as dirty, to be updated at a later time.
1927
1928	=item cf::db_sync
1929
1930	Immediately write the database to disk I<if it is dirty>.
1931
1932	=cut
1933
1934	our $DB;
1935
1936	{
1937	my $path = cf::localdir . "/database.pst";
1938
1939	sub db_load() {
1940	$DB = stat $path ? Storable::retrieve $path : { };
1941	}
1942
1943	my $pid;
1944
1945	sub db_save() {
1946	waitpid $pid, 0 if $pid;
1947	if (0 == ($pid = fork)) {
1948	$DB->{_meta}{version} = 1;
1949	Storable::nstore $DB, "$path~";
1950	rename "$path~", $path;
1951	cf::_exit 0 if defined $pid;
1952	}
1953	}
1954
1955	my $dirty;
1956
1957	sub db_sync() {
1958	db_save if $dirty;
1959	undef $dirty;
1960	}
1961
1962	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1963	db_sync;
1964	});	2833	};
		2834	cf::cede_to_tick;
1965		2835
1966	sub db_dirty() {
1967	$dirty = 1;
1968	$idle->start;
1969	}	2836	{
		2837	my $faces = $facedata->{faceinfo};
1970		2838
1971	sub db_get($;$) {	2839	while (my ($face, $info) = each %$faces) {
1972	@_ >= 2	2840	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1973	? $DB->{$_[0]}{$_[1]}	2841	cf::face::set_visibility $idx, $info->{visibility};
1974	: ($DB->{$_[0]} ||= { })	2842	cf::face::set_magicmap $idx, $info->{magicmap};
1975	}	2843	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2844	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1976		2845
1977	sub db_put($$;$) {	2846	cf::cede_to_tick;
1978	if (@_ >= 3) {
1979	$DB->{$_[0]}{$_[1]} = $_[2];
1980	} else {
1981	$DB->{$_[0]} = $_[1];
1982	}
1983	db_dirty;
1984	}
1985
1986	cf::global->attach (
1987	prio => 10000,
1988	on_cleanup => sub {
1989	db_sync;
1990	},	2847	}
1991	);
1992	}
1993		2848
1994	#############################################################################	2849	while (my ($face, $info) = each %$faces) {
1995	# the server's main()	2850	next unless $info->{smooth};
		2851	my $idx = cf::face::find $face
		2852	or next;
		2853	if (my $smooth = cf::face::find $info->{smooth}) {
		2854	cf::face::set_smooth $idx, $smooth;
		2855	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2856	} else {
		2857	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2858	}
		2859
		2860	cf::cede_to_tick;
		2861	}
		2862	}
		2863
		2864	{
		2865	my $anims = $facedata->{animinfo};
		2866
		2867	while (my ($anim, $info) = each %$anims) {
		2868	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2869	cf::cede_to_tick;
		2870	}
		2871
		2872	cf::anim::invalidate_all; # d'oh
		2873	}
		2874
		2875	{
		2876	# TODO: for gcfclient pleasure, we should give resources
		2877	# that gcfclient doesn't grok a >10000 face index.
		2878	my $res = $facedata->{resource};
		2879
		2880	my $soundconf = delete $res->{"res/sound.conf"};
		2881
		2882	while (my ($name, $info) = each %$res) {
		2883	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2884	my $data;
		2885
		2886	if ($info->{type} & 1) {
		2887	# prepend meta info
		2888
		2889	my $meta = $enc->encode ({
		2890	name => $name,
		2891	%{ $info->{meta} || {} },
		2892	});
		2893
		2894	$data = pack "(w/a*)*", $meta, $info->{data};
		2895	}
		2896
		2897	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2898	cf::face::set_type $idx, $info->{type};
		2899
		2900	cf::cede_to_tick;
		2901	}
		2902
		2903	if ($soundconf) {
		2904	$soundconf = $enc->decode (delete $soundconf->{data});
		2905
		2906	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2907	my $sound = $soundconf->{compat}[$_]
		2908	or next;
		2909
		2910	my $face = cf::face::find "sound/$sound->[1]";
		2911	cf::sound::set $sound->[0] => $face;
		2912	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2913	}
		2914
		2915	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2916	my $face = cf::face::find "sound/$v";
		2917	cf::sound::set $k => $face;
		2918	}
		2919	}
		2920	}
		2921
		2922	1
		2923	}
		2924
		2925	register_exticmd fx_want => sub {
		2926	my ($ns, $want) = @_;
		2927
		2928	while (my ($k, $v) = each %$want) {
		2929	$ns->fx_want ($k, $v);
		2930	}
		2931	};
		2932
		2933	sub reload_regions {
		2934	load_resource_file "$MAPDIR/regions"
		2935	or die "unable to load regions file\n";
		2936
		2937	for (cf::region::list) {
		2938	$_->{match} = qr/$_->{match}/
		2939	if exists $_->{match};
		2940	}
		2941	}
		2942
		2943	sub reload_facedata {
		2944	load_facedata "$DATADIR/facedata"
		2945	or die "unable to load facedata\n";
		2946	}
		2947
		2948	sub reload_archetypes {
		2949	load_resource_file "$DATADIR/archetypes"
		2950	or die "unable to load archetypes\n";
		2951	#d# NEED to laod twice to resolve forward references
		2952	# this really needs to be done in an extra post-pass
		2953	# (which needs to be synchronous, so solve it differently)
		2954	load_resource_file "$DATADIR/archetypes"
		2955	or die "unable to load archetypes\n";
		2956	}
		2957
		2958	sub reload_treasures {
		2959	load_resource_file "$DATADIR/treasures"
		2960	or die "unable to load treasurelists\n";
		2961	}
		2962
		2963	sub reload_resources {
		2964	warn "reloading resource files...\n";
		2965
		2966	reload_regions;
		2967	reload_facedata;
		2968	#reload_archetypes;#d#
		2969	reload_archetypes;
		2970	reload_treasures;
		2971
		2972	warn "finished reloading resource files\n";
		2973	}
		2974
		2975	sub init {
		2976	reload_resources;
		2977	}
1996		2978
1997	sub cfg_load {	2979	sub cfg_load {
1998	open my $fh, "<:utf8", cf::confdir . "/config"	2980	open my $fh, "<:utf8", "$CONFDIR/config"
1999	or return;	2981	or return;
2000		2982
2001	local $/;	2983	local $/;
2002	*CFG = YAML::Syck::Load <$fh>;	2984	*CFG = YAML::Syck::Load <$fh>;
2003		2985
2004	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	2986	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2005		2987
		2988	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2989	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2990
2006	if (exists $CFG{mlockall}) {	2991	if (exists $CFG{mlockall}) {
2007	eval {	2992	eval {
2008	$CFG{mlockall} ? &mlockall : &munlockall	2993	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2009	and die "WARNING: m(un)lockall failed: $!\n";	2994	and die "WARNING: m(un)lockall failed: $!\n";
2010	};	2995	};
2011	warn $@ if $@;	2996	warn $@ if $@;
2012	}	2997	}
2013	}	2998	}
2014		2999
2015	sub main {	3000	sub main {
2016	# we must not ever block the main coroutine	3001	# we must not ever block the main coroutine
2017	local $Coro::idle = sub {	3002	local $Coro::idle = sub {
2018	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3003	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2019	(Coro::unblock_sub {	3004	(async {
2020	Event::one_event;	3005	Event::one_event;
2021	})->();	3006	})->prio (Coro::PRIO_MAX);
2022	};	3007	};
2023		3008
2024	cfg_load;	3009	cfg_load;
2025	db_load;	3010	db_init;
2026	load_extensions;	3011	load_extensions;
		3012
		3013	$TICK_WATCHER->start;
2027	Event::loop;	3014	Event::loop;
2028	}	3015	}
2029		3016
2030	#############################################################################	3017	#############################################################################
2031	# initialisation	3018	# initialisation and cleanup
2032		3019
		3020	# install some emergency cleanup handlers
		3021	BEGIN {
		3022	for my $signal (qw(INT HUP TERM)) {
		3023	Event->signal (
		3024	reentrant => 0,
		3025	data => WF_AUTOCANCEL,
		3026	signal => $signal,
		3027	prio => 0,
		3028	cb => sub {
		3029	cf::cleanup "SIG$signal";
		3030	},
		3031	);
		3032	}
		3033	}
		3034
		3035	sub write_runtime {
		3036	my $runtime = "$LOCALDIR/runtime";
		3037
		3038	# first touch the runtime file to show we are still running:
		3039	# the fsync below can take a very very long time.
		3040
		3041	IO::AIO::aio_utime $runtime, undef, undef;
		3042
		3043	my $guard = cf::lock_acquire "write_runtime";
		3044
		3045	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3046	or return;
		3047
		3048	my $value = $cf::RUNTIME + 90 + 10;
		3049	# 10 is the runtime save interval, for a monotonic clock
		3050	# 60 allows for the watchdog to kill the server.
		3051
		3052	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3053	and return;
		3054
		3055	# always fsync - this file is important
		3056	aio_fsync $fh
		3057	and return;
		3058
		3059	# touch it again to show we are up-to-date
		3060	aio_utime $fh, undef, undef;
		3061
		3062	close $fh
		3063	or return;
		3064
		3065	aio_rename "$runtime~", $runtime
		3066	and return;
		3067
		3068	warn "runtime file written.\n";
		3069
		3070	1
		3071	}
		3072
		3073	sub emergency_save() {
		3074	my $freeze_guard = cf::freeze_mainloop;
		3075
		3076	warn "enter emergency perl save\n";
		3077
		3078	cf::sync_job {
		3079	# use a peculiar iteration method to avoid tripping on perl
		3080	# refcount bugs in for. also avoids problems with players
		3081	# and maps saved/destroyed asynchronously.
		3082	warn "begin emergency player save\n";
		3083	for my $login (keys %cf::PLAYER) {
		3084	my $pl = $cf::PLAYER{$login} or next;
		3085	$pl->valid or next;
		3086	$pl->save;
		3087	}
		3088	warn "end emergency player save\n";
		3089
		3090	warn "begin emergency map save\n";
		3091	for my $path (keys %cf::MAP) {
		3092	my $map = $cf::MAP{$path} or next;
		3093	$map->valid or next;
		3094	$map->save;
		3095	}
		3096	warn "end emergency map save\n";
		3097
		3098	warn "begin emergency database checkpoint\n";
		3099	BDB::db_env_txn_checkpoint $DB_ENV;
		3100	warn "end emergency database checkpoint\n";
		3101	};
		3102
		3103	warn "leave emergency perl save\n";
		3104	}
		3105
		3106	sub post_cleanup {
		3107	my ($make_core) = @_;
		3108
		3109	warn Carp::longmess "post_cleanup backtrace"
		3110	if $make_core;
		3111	}
		3112
2033	sub reload() {	3113	sub do_reload_perl() {
2034	# can/must only be called in main	3114	# can/must only be called in main
2035	if ($Coro::current != $Coro::main) {	3115	if ($Coro::current != $Coro::main) {
2036	warn "can only reload from main coroutine\n";	3116	warn "can only reload from main coroutine";
2037	return;	3117	return;
2038	}	3118	}
2039		3119
2040	warn "reloading...";	3120	warn "reloading...";
2041		3121
2042	my $guard = freeze_mainloop;	3122	warn "entering sync_job";
		3123
		3124	cf::sync_job {
		3125	cf::write_runtime; # external watchdog should not bark
2043	cf::emergency_save;	3126	cf::emergency_save;
		3127	cf::write_runtime; # external watchdog should not bark
2044		3128
2045	eval {	3129	warn "syncing database to disk";
		3130	BDB::db_env_txn_checkpoint $DB_ENV;
		3131
2046	# if anything goes wrong in here, we should simply crash as we already saved	3132	# if anything goes wrong in here, we should simply crash as we already saved
2047		3133
2048	# cancel all watchers	3134	warn "cancelling all WF_AUTOCANCEL watchers";
2049	for (Event::all_watchers) {	3135	for (Event::all_watchers) {
2050	$_->cancel if $_->data & WF_AUTOCANCEL;	3136	$_->cancel if $_->data & WF_AUTOCANCEL;
2051	}	3137	}
2052		3138
		3139	warn "flushing outstanding aio requests";
		3140	for (;;) {
		3141	BDB::flush;
		3142	IO::AIO::flush;
		3143	Coro::cede;
		3144	last unless IO::AIO::nreqs || BDB::nreqs;
		3145	warn "iterate...";
		3146	}
		3147
		3148	++$RELOAD;
		3149
2053	# cancel all extension coros	3150	warn "cancelling all extension coros";
2054	$_->cancel for values %EXT_CORO;	3151	$_->cancel for values %EXT_CORO;
2055	%EXT_CORO = ();	3152	%EXT_CORO = ();
2056		3153
2057	# unload all extensions	3154	warn "removing commands";
2058	for (@exts) {	3155	%COMMAND = ();
		3156
		3157	warn "removing ext/exti commands";
		3158	%EXTCMD = ();
		3159	%EXTICMD = ();
		3160
		3161	warn "unloading/nuking all extensions";
		3162	for my $pkg (@EXTS) {
2059	warn "unloading <$_>";	3163	warn "... unloading $pkg";
2060	unload_extension $_;	3164
		3165	if (my $cb = $pkg->can ("unload")) {
		3166	eval {
		3167	$cb->($pkg);
		3168	1
		3169	} or warn "$pkg unloaded, but with errors: $@";
2061	}	3170	}
2062		3171
		3172	warn "... nuking $pkg";
		3173	Symbol::delete_package $pkg;
		3174	}
		3175
2063	# unload all modules loaded from $LIBDIR	3176	warn "unloading all perl modules loaded from $LIBDIR";
2064	while (my ($k, $v) = each %INC) {	3177	while (my ($k, $v) = each %INC) {
2065	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3178	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2066		3179
2067	warn "removing <$k>";	3180	warn "... unloading $k";
2068	delete $INC{$k};	3181	delete $INC{$k};
2069		3182
2070	$k =~ s/\.pm$//;	3183	$k =~ s/\.pm$//;
2071	$k =~ s/\//::/g;	3184	$k =~ s/\//::/g;
2072		3185
…		…
2075	}	3188	}
2076		3189
2077	Symbol::delete_package $k;	3190	Symbol::delete_package $k;
2078	}	3191	}
2079		3192
2080	# sync database to disk
2081	cf::db_sync;
2082	IO::AIO::flush;
2083
2084	# get rid of safe::, as good as possible	3193	warn "getting rid of safe::, as good as possible";
2085	Symbol::delete_package "safe::$_"	3194	Symbol::delete_package "safe::$_"
2086	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3195	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2087		3196
2088	# remove register_script_function callbacks
2089	# TODO
2090
2091	# unload cf.pm "a bit"	3197	warn "unloading cf.pm \"a bit\"";
2092	delete $INC{"cf.pm"};	3198	delete $INC{"cf.pm"};
		3199	delete $INC{"cf/pod.pm"};
2093		3200
2094	# don't, removes xs symbols, too,	3201	# don't, removes xs symbols, too,
2095	# and global variables created in xs	3202	# and global variables created in xs
2096	#Symbol::delete_package __PACKAGE__;	3203	#Symbol::delete_package __PACKAGE__;
2097		3204
2098	# reload cf.pm	3205	warn "unload completed, starting to reload now";
		3206
2099	warn "reloading cf.pm";	3207	warn "reloading cf.pm";
2100	require cf;	3208	require cf;
2101	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3209	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2102		3210
2103	# load config and database again	3211	warn "loading config and database again";
2104	cf::cfg_load;	3212	cf::cfg_load;
2105	cf::db_load;
2106		3213
2107	# load extensions
2108	warn "load extensions";	3214	warn "loading extensions";
2109	cf::load_extensions;	3215	cf::load_extensions;
2110		3216
2111	# reattach attachments to objects	3217	warn "reattaching attachments to objects/players";
2112	warn "reattach";	3218	_global_reattach; # objects, sockets
2113	_global_reattach;	3219	warn "reattaching attachments to maps";
2114	};	3220	reattach $_ for values %MAP;
		3221	warn "reattaching attachments to players";
		3222	reattach $_ for values %PLAYER;
2115		3223
2116	if ($@) {	3224	warn "leaving sync_job";
		3225
		3226	1
		3227	} or do {
2117	warn $@;	3228	warn $@;
2118	warn "error while reloading, exiting.";	3229	warn "error while reloading, exiting.";
2119	exit 1;	3230	exit 1;
2120	}	3231	};
2121		3232
2122	warn "reloaded successfully";	3233	warn "reloaded";
2123	};	3234	};
2124		3235
2125	#############################################################################	3236	our $RELOAD_WATCHER; # used only during reload
2126		3237
2127	unless ($LINK_MAP) {	3238	sub reload_perl() {
2128	$LINK_MAP = cf::map::new;	3239	# doing reload synchronously and two reloads happen back-to-back,
		3240	# coro crashes during coro_state_free->destroy here.
2129		3241
2130	$LINK_MAP->width (41);	3242	$RELOAD_WATCHER ||= Event->timer (
2131	$LINK_MAP->height (41);	3243	reentrant => 0,
2132	$LINK_MAP->alloc;
2133	$LINK_MAP->path ("{link}");
2134	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2135	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2136
2137	# dirty hack because... archetypes are not yet loaded
2138	Event->timer (
2139	after => 2,	3244	after => 0,
		3245	data => WF_AUTOCANCEL,
2140	cb => sub {	3246	cb => sub {
2141	$_[0]->w->cancel;	3247	do_reload_perl;
2142		3248	undef $RELOAD_WATCHER;
2143	# provide some exits "home"
2144	my $exit = cf::object::new "exit";
2145
2146	$exit->slaying ($EMERGENCY_POSITION->[0]);
2147	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2148	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2149
2150	$LINK_MAP->insert ($exit->clone, 19, 19);
2151	$LINK_MAP->insert ($exit->clone, 19, 20);
2152	$LINK_MAP->insert ($exit->clone, 19, 21);
2153	$LINK_MAP->insert ($exit->clone, 20, 19);
2154	$LINK_MAP->insert ($exit->clone, 20, 21);
2155	$LINK_MAP->insert ($exit->clone, 21, 19);
2156	$LINK_MAP->insert ($exit->clone, 21, 20);
2157	$LINK_MAP->insert ($exit->clone, 21, 21);
2158
2159	$exit->destroy;
2160	});	3249	},
2161		3250	);
2162	$LINK_MAP->{deny_save} = 1;
2163	$LINK_MAP->{deny_reset} = 1;
2164
2165	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2166	}	3251	}
2167
2168	register "<global>", __PACKAGE__;
2169		3252
2170	register_command "reload" => sub {	3253	register_command "reload" => sub {
2171	my ($who, $arg) = @_;	3254	my ($who, $arg) = @_;
2172		3255
2173	if ($who->flag (FLAG_WIZ)) {	3256	if ($who->flag (FLAG_WIZ)) {
2174	$who->message ("start of reload.");
2175	reload;
2176	$who->message ("end of reload.");	3257	$who->message ("reloading server.");
		3258	async { reload_perl };
2177	}	3259	}
2178	};	3260	};
2179		3261
2180	unshift @INC, $LIBDIR;	3262	unshift @INC, $LIBDIR;
2181		3263
		3264	my $bug_warning = 0;
		3265
		3266	our @WAIT_FOR_TICK;
		3267	our @WAIT_FOR_TICK_BEGIN;
		3268
		3269	sub wait_for_tick {
		3270	return unless $TICK_WATCHER->is_active;
		3271	return if $Coro::current == $Coro::main;
		3272
		3273	my $signal = new Coro::Signal;
		3274	push @WAIT_FOR_TICK, $signal;
		3275	$signal->wait;
		3276	}
		3277
		3278	sub wait_for_tick_begin {
		3279	return unless $TICK_WATCHER->is_active;
		3280	return if $Coro::current == $Coro::main;
		3281
		3282	my $signal = new Coro::Signal;
		3283	push @WAIT_FOR_TICK_BEGIN, $signal;
		3284	$signal->wait;
		3285	}
		3286
		3287	my $min = 1e6;#d#
		3288	my $avg = 10;
2182	$TICK_WATCHER = Event->timer (	3289	$TICK_WATCHER = Event->timer (
2183	reentrant => 0,	3290	reentrant => 0,
		3291	parked => 1,
2184	prio => 0,	3292	prio => 0,
2185	at => $NEXT_TICK || $TICK,	3293	at => $NEXT_TICK || $TICK,
2186	data => WF_AUTOCANCEL,	3294	data => WF_AUTOCANCEL,
2187	cb => sub {	3295	cb => sub {
		3296	if ($Coro::current != $Coro::main) {
		3297	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3298	unless ++$bug_warning > 10;
		3299	return;
		3300	}
		3301
		3302	$NOW = $tick_start = Event::time;
		3303
2188	cf::server_tick; # one server iteration	3304	cf::server_tick; # one server iteration
		3305
		3306	0 && sync_job {#d#
		3307	for(1..10) {
		3308	my $t = Event::time;
		3309	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3310	or die;
		3311
		3312	$map->width (50);
		3313	$map->height (50);
		3314	$map->alloc;
		3315	$map->_load_objects ("/tmp/x.map", 1);
		3316	my $t = Event::time - $t;
		3317
		3318	#next unless $t < 0.0013;#d#
		3319	if ($t < $min) {
		3320	$min = $t;
		3321	}
		3322	$avg = $avg * 0.99 + $t * 0.01;
		3323	}
		3324	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3325	exit 0;
		3326	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3327	};
		3328
2189	$RUNTIME += $TICK;	3329	$RUNTIME += $TICK;
2190	$NEXT_TICK += $TICK;	3330	$NEXT_TICK += $TICK;
2191		3331
		3332	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3333	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3334	Coro::async_pool {
		3335	write_runtime
		3336	or warn "ERROR: unable to write runtime file: $!";
		3337	};
		3338	}
		3339
		3340	# my $AFTER = Event::time;
		3341	# warn $AFTER - $NOW;#d#
		3342
		3343	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3344	$sig->send;
		3345	}
		3346	while (my $sig = shift @WAIT_FOR_TICK) {
		3347	$sig->send;
		3348	}
		3349
		3350	$NOW = Event::time;
		3351
2192	# if we are delayed by four ticks or more, skip them all	3352	# if we are delayed by four ticks or more, skip them all
2193	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3353	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2194		3354
2195	$TICK_WATCHER->at ($NEXT_TICK);	3355	$TICK_WATCHER->at ($NEXT_TICK);
2196	$TICK_WATCHER->start;	3356	$TICK_WATCHER->start;
		3357
		3358	$LOAD = ($NOW - $tick_start) / $TICK;
		3359	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3360
		3361	_post_tick;
		3362
		3363
2197	},	3364	},
2198	);	3365	);
2199		3366
		3367	{
2200	IO::AIO::max_poll_time $TICK * 0.2;	3368	BDB::max_poll_time $TICK * 0.1;
2201		3369	$BDB_POLL_WATCHER = Event->io (
2202	Event->io (	3370	reentrant => 0,
2203	fd => IO::AIO::poll_fileno,	3371	fd => BDB::poll_fileno,
2204	poll => 'r',	3372	poll => 'r',
2205	prio => 5,	3373	prio => 0,
2206	data => WF_AUTOCANCEL,
2207	cb => \&IO::AIO::poll_cb,
2208	);
2209
2210	Event->timer (
2211	data => WF_AUTOCANCEL,	3374	data => WF_AUTOCANCEL,
2212	after => 0,	3375	cb => \&BDB::poll_cb,
2213	interval => 10,	3376	);
2214	cb => sub {	3377	BDB::min_parallel 8;
2215	(Coro::unblock_sub {	3378
2216	write_runtime	3379	BDB::set_sync_prepare {
2217	or warn "ERROR: unable to write runtime file: $!";	3380	my $status;
		3381	my $current = $Coro::current;
		3382	(
		3383	sub {
		3384	$status = $!;
		3385	$current->ready; undef $current;
		3386	},
		3387	sub {
		3388	Coro::schedule while defined $current;
		3389	$! = $status;
		3390	},
		3391	)
		3392	};
		3393
		3394	unless ($DB_ENV) {
		3395	$DB_ENV = BDB::db_env_create;
		3396
		3397	cf::sync_job {
		3398	eval {
		3399	BDB::db_env_open
		3400	$DB_ENV,
		3401	$BDBDIR,
		3402	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3403	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3404	0666;
		3405
		3406	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3407
		3408	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3409	$DB_ENV->set_lk_detect;
		3410	};
		3411
		3412	cf::cleanup "db_env_open(db): $@" if $@;
2218	})->();	3413	};
2219	},	3414	}
2220	);	3415	}
		3416
		3417	{
		3418	IO::AIO::min_parallel 8;
		3419
		3420	undef $Coro::AIO::WATCHER;
		3421	IO::AIO::max_poll_time $TICK * 0.1;
		3422	$AIO_POLL_WATCHER = Event->io (
		3423	reentrant => 0,
		3424	data => WF_AUTOCANCEL,
		3425	fd => IO::AIO::poll_fileno,
		3426	poll => 'r',
		3427	prio => 6,
		3428	cb => \&IO::AIO::poll_cb,
		3429	);
		3430	}
		3431
		3432	my $_log_backtrace;
		3433
		3434	sub _log_backtrace {
		3435	my ($msg, @addr) = @_;
		3436
		3437	$msg =~ s/\n//;
		3438
		3439	# limit the # of concurrent backtraces
		3440	if ($_log_backtrace < 2) {
		3441	++$_log_backtrace;
		3442	async {
		3443	my @bt = fork_call {
		3444	@addr = map { sprintf "%x", $_ } @addr;
		3445	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3446	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3447	or die "addr2line: $!";
		3448
		3449	my @funcs;
		3450	my @res = <$fh>;
		3451	chomp for @res;
		3452	while (@res) {
		3453	my ($func, $line) = splice @res, 0, 2, ();
		3454	push @funcs, "[$func] $line";
		3455	}
		3456
		3457	@funcs
		3458	};
		3459
		3460	LOG llevInfo, "[ABT] $msg\n";
		3461	LOG llevInfo, "[ABT] $_\n" for @bt;
		3462	--$_log_backtrace;
		3463	};
		3464	} else {
		3465	LOG llevInfo, "[ABT] $msg\n";
		3466	LOG llevInfo, "[ABT] [suppressed]\n";
		3467	}
		3468	}
		3469
		3470	# load additional modules
		3471	use cf::pod;
2221		3472
2222	END { cf::emergency_save }	3473	END { cf::emergency_save }
2223		3474
2224	1	3475	1
2225		3476

Diff Legend

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