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.129 by root, Wed Jan 3 00:41:19 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 $FREEZE;	95
55	our $RANDOM_MAPS = cf::localdir . "/random";	96	# used to convert map paths into valid unix filenames by replacing / by ∕
56	our %EXT_CORO;	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
57		102
58	binmode STDOUT;	103	binmode STDOUT;
59	binmode STDERR;	104	binmode STDERR;
60		105
61	# read virtual server time, if available	106	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
66	}	111	}
67		112
68	mkdir cf::localdir;	113	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		115
74	# a special map that is always available	116	our $EMERGENCY_POSITION;
75	our $LINK_MAP;
76		117
77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];	118	sub cf::map::normalise;
78		119
79	#############################################################################	120	#############################################################################
80		121
81	=head2 GLOBAL VARIABLES	122	=head2 GLOBAL VARIABLES
82		123
…		…
89	=item $cf::RUNTIME	130	=item $cf::RUNTIME
90		131
91	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
92	every server tick.	133	every server tick.
93		134
94	=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
95		138
96	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
97	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.
98		143
99	=item $cf::NOW	144	=item $cf::NOW
100		145
101	The time of the last (current) server tick.	146	The time of the last (current) server tick.
102		147
103	=item $cf::TICK	148	=item $cf::TICK
104		149
105	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.
106		161
107	=item %cf::CFG	162	=item %cf::CFG
108		163
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
110	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.
111		178
112	=back	179	=back
113		180
114	=cut	181	=cut
115		182
116	BEGIN {	183	BEGIN {
117	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
118	my $msg = join "", @_;	185	my $msg = join "", @_;
119	utf8::encode $msg;
120		186
121	$msg .= "\n"	187	$msg .= "\n"
122	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
123		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
124	LOG llevError, "cfperl: $msg";	193	LOG llevError, $msg;
125	};	194	};
126	}	195	}
127		196
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@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';
133	@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)
134		204
135	# 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
136	# within the Safe compartment.	206	# within the Safe compartment.
137	for my $pkg (qw(	207	for my $pkg (qw(
138	cf::global cf::attachable	208	cf::global cf::attachable
…		…
147		217
148	$Event::DIED = sub {	218	$Event::DIED = sub {
149	warn "error in event callback: @_";	219	warn "error in event callback: @_";
150	};	220	};
151		221
152	my %ext_pkg;	222	#############################################################################
153	my @exts;
154	my @hook;
155		223
156	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
157		225
158	=over 4	226	=over 4
159		227
160	=cut	228	=item dumpval $ref
161		229
162	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	}
163		250
164	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
165		252
166	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
167		254
168	=cut
169
170	sub from_json($) {
171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172	JSON::Syck::Load $_[0]
173	}
174
175	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
176		256
177	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
178		258
179	=cut	259	=cut
180		260
181	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183	JSON::Syck::Dump $_[0]
184	}
185		262
186	=item my $guard = cf::guard { BLOCK }	263	sub to_json ($) { $json_coder->encode ($_[0]) }
187		264	sub from_json ($) { $json_coder->decode ($_[0]) }
188	Run the given callback when the guard object gets destroyed (useful for
189	coroutine cancellations).
190
191	You can call C<< ->cancel >> on the guard object to stop the block from
192	being executed.
193
194	=cut
195
196	sub guard(&) {
197	bless \(my $cb = $_[0]), cf::guard::;
198	}
199
200	sub cf::guard::cancel {
201	${$_[0]} = sub { };
202	}
203
204	sub cf::guard::DESTROY {
205	${$_[0]}->();
206	}
207		265
208	=item cf::lock_wait $string	266	=item cf::lock_wait $string
209		267
210	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
211		269
212	=item my $lock = cf::lock_acquire $string	270	=item my $lock = cf::lock_acquire $string
213		271
214	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
215	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,
216	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
217	returned.	275	returned.
218		276
219	Lock names should begin with a unique identifier (for example, find_map	277	Lock names should begin with a unique identifier (for example, cf::map::find
220	uses map_find and load_map uses map_load).	278	uses map_find and cf::map::load uses map_load).
		279
		280	=item $locked = cf::lock_active $string
		281
		282	Return true if the lock is currently active, i.e. somebody has locked it.
221		283
222	=cut	284	=cut
223		285
224	our %LOCK;	286	our %LOCK;
225		287
…		…
239	# wait, to be sure we are not locked	301	# wait, to be sure we are not locked
240	lock_wait $key;	302	lock_wait $key;
241		303
242	$LOCK{$key} = [];	304	$LOCK{$key} = [];
243		305
244	cf::guard {	306	Coro::guard {
245	# wake up all waiters, to be on the safe side	307	# wake up all waiters, to be on the safe side
246	$_->ready for @{ delete $LOCK{$key} };	308	$_->ready for @{ delete $LOCK{$key} };
247	}	309	}
248	}	310	}
249		311
		312	sub lock_active($) {
		313	my ($key) = @_;
		314
		315	! ! $LOCK{$key}
		316	}
		317
		318	sub freeze_mainloop {
		319	return unless $TICK_WATCHER->is_active;
		320
		321	my $guard = Coro::guard {
		322	$TICK_WATCHER->start;
		323	};
		324	$TICK_WATCHER->stop;
		325	$guard
		326	}
		327
		328	=item cf::get_slot $time[, $priority[, $name]]
		329
		330	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		331	This call blocks and returns only when you have at least C<$time> seconds
		332	of cpu time till the next tick. The slot is only valid till the next cede.
		333
		334	The optional C<$name> can be used to identify the job to run. It might be
		335	used for statistical purposes and should identify the same time-class.
		336
		337	Useful for short background jobs.
		338
		339	=cut
		340
		341	our @SLOT_QUEUE;
		342	our $SLOT_QUEUE;
		343
		344	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		345	$SLOT_QUEUE = Coro::async {
		346	my $signal = new Coro::Signal;
		347
		348	while () {
		349	next_job:
		350	my $avail = cf::till_tick;
		351	if ($avail > 0.01) {
		352	for (0 .. $#SLOT_QUEUE) {
		353	if ($SLOT_QUEUE[$_][0] < $avail) {
		354	my $job = splice @SLOT_QUEUE, $_, 1, ();
		355	$job->[2]->send;
		356	Coro::cede;
		357	goto next_job;
		358	}
		359	}
		360	}
		361
		362	if (@SLOT_QUEUE) {
		363	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		364	push @cf::WAIT_FOR_TICK, $signal;
		365	$signal->wait;
		366	} else {
		367	Coro::schedule;
		368	}
		369	}
		370	};
		371
		372	sub get_slot($;$$) {
		373	my ($time, $pri, $name) = @_;
		374
		375	$time = $TICK * .6 if $time > $TICK * .6;
		376	my $sig = new Coro::Signal;
		377
		378	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		379	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		380	$SLOT_QUEUE->ready;
		381	$sig->wait;
		382	}
		383
250	=item cf::async { BLOCK }	384	=item cf::async { BLOCK }
251		385
252	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the	386	Currently the same as Coro::async_pool, meaning you cannot use
253	error instead of exiting the server in case of a problem.	387	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		388	thing you are allowed to do is call C<prio> on it.
254		389
255	=cut	390	=cut
256		391
257	sub async(&) {	392	BEGIN { *async = \&Coro::async_pool }
258	my ($cb) = @_;
259
260	Coro::async {
261	eval { $cb->() };
262	warn $@ if $@;
263	}
264	}
265		393
266	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
267		395
268	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)
269	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
270	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.
271		400
272	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
273	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
274	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
275	fast or be very important.	404	fast or be very important.
…		…
278		407
279	sub sync_job(&) {	408	sub sync_job(&) {
280	my ($job) = @_;	409	my ($job) = @_;
281		410
282	if ($Coro::current == $Coro::main) {	411	if ($Coro::current == $Coro::main) {
		412	my $time = Event::time;
		413
283	# this is the main coro, too bad, we have to block	414	# this is the main coro, too bad, we have to block
284	# till the operation succeeds, freezing the server :/	415	# till the operation succeeds, freezing the server :/
285		416
286	# TODO: use suspend/resume instead	417	# TODO: use suspend/resume instead
287	# (but this is cancel-safe)	418	# (but this is cancel-safe)
288	local $FREEZE = 1;	419	my $freeze_guard = freeze_mainloop;
289		420
290	my $busy = 1;	421	my $busy = 1;
291	my @res;	422	my @res;
292		423
293	(Coro::async {	424	(async {
294	@res = eval { $job->() };	425	@res = eval { $job->() };
295	warn $@ if $@;	426	warn $@ if $@;
296	undef $busy;	427	undef $busy;
297	})->prio (Coro::PRIO_MAX);	428	})->prio (Coro::PRIO_MAX);
298		429
299	while ($busy) {	430	while ($busy) {
300	Coro::cede_notself;	431	Coro::cede or Event::one_event;
301	Event::one_event unless Coro::nready;
302	}	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
303		440
304	wantarray ? @res : $res[0]	441	wantarray ? @res : $res[0]
305	} else {	442	} else {
306	# we are in another coroutine, how wonderful, everything just works	443	# we are in another coroutine, how wonderful, everything just works
307		444
308	$job->()	445	$job->()
309	}	446	}
310	}	447	}
311		448
312	=item $coro = cf::coro { BLOCK }	449	=item $coro = cf::async_ext { BLOCK }
313		450
314	Creates and returns a new coro. This coro is automcatially being canceled	451	Like async, but this coro is automatically being canceled when the
315	when the extension calling this is being unloaded.	452	extension calling this is being unloaded.
316		453
317	=cut	454	=cut
318		455
319	sub coro(&) {	456	sub async_ext(&) {
320	my $cb = shift;	457	my $cb = shift;
321		458
322	my $coro = &cf::async ($cb);	459	my $coro = &Coro::async ($cb);
323		460
324	$coro->on_destroy (sub {	461	$coro->on_destroy (sub {
325	delete $EXT_CORO{$coro+0};	462	delete $EXT_CORO{$coro+0};
326	});	463	});
327	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
328		465
329	$coro	466	$coro
330	}	467	}
331		468
332	sub write_runtime {	469	=item fork_call { }, $args
333	my $runtime = cf::localdir . "/runtime";
334		470
335	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	471	Executes the given code block with the given arguments in a seperate
336	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.
337		475
338	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	476	=cut
339	(aio_write $fh, 0, (length $value), $value, 0) <= 0
340	and return;
341		477
342	aio_fsync $fh	478	sub fork_call(&@) {
343	and return;	479	my ($cb, @args) = @_;
344		480
345	close $fh	481	# we seemingly have to make a local copy of the whole thing,
346	or return;	482	# otherwise perl prematurely frees the stuff :/
		483	# TODO: investigate and fix (liekly this will be rather laborious)
347		484
348	aio_rename "$runtime~", $runtime	485	my @res = Coro::Util::fork_eval {
349	and return;	486	reset_signals;
		487	&$cb
		488	}, @args;
350		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	};
351	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 });
352	}	618	}
353		619
354	=back	620	=back
355		621
356	=cut	622	=cut
357
358	#############################################################################
359
360	package cf::path;
361
362	sub new {
363	my ($class, $path, $base) = @_;
364
365	$path = $path->as_string if ref $path;
366
367	my $self = bless { }, $class;
368
369	# {... are special paths that are not touched
370	# ?xxx/... are special absolute paths
371	# ?random/... random maps
372	# /! non-realised random map exit
373	# /... normal maps
374	# ~/... per-player maps without a specific player (DO NOT USE)
375	# ~user/... per-player map of a specific user
376
377	if ($path =~ /^{/) {
378	# fine as it is
379	} elsif ($path =~ s{^\?random/}{}) {
380	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
381	$self->{random} = cf::from_json $data;
382	} else {
383	if ($path =~ s{^~([^/]+)?}{}) {
384	$self->{user_rel} = 1;
385
386	if (defined $1) {
387	$self->{user} = $1;
388	} elsif ($base =~ m{^~([^/]+)/}) {
389	$self->{user} = $1;
390	} else {
391	warn "cannot resolve user-relative path without user <$path,$base>\n";
392	}
393	} elsif ($path =~ /^\//) {
394	# already absolute
395	} else {
396	$base =~ s{[^/]+/?$}{};
397	return $class->new ("$base/$path");
398	}
399
400	for ($path) {
401	redo if s{/\.?/}{/};
402	redo if s{/[^/]+/\.\./}{/};
403	}
404	}
405
406	$self->{path} = $path;
407
408	$self
409	}
410
411	# the name / primary key / in-game path
412	sub as_string {
413	my ($self) = @_;
414
415	$self->{user_rel} ? "~$self->{user}$self->{path}"
416	: $self->{random} ? "?random/$self->{path}"
417	: $self->{path}
418	}
419
420	# the displayed name, this is a one way mapping
421	sub visible_name {
422	my ($self) = @_;
423
424	# if (my $rmp = $self->{random}) {
425	# # todo: be more intelligent about this
426	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
427	# } else {
428	$self->as_string
429	# }
430	}
431
432	# escape the /'s in the path
433	sub _escaped_path {
434	# ∕ is U+2215
435	(my $path = $_[0]{path}) =~ s/\//∕/g;
436	$path
437	}
438
439	# the original (read-only) location
440	sub load_path {
441	my ($self) = @_;
442
443	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
444	}
445
446	# the temporary/swap location
447	sub save_path {
448	my ($self) = @_;
449
450	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
451	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
452	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
453	}
454
455	# the unique path, might be eq to save_path
456	sub uniq_path {
457	my ($self) = @_;
458
459	$self->{user_rel} || $self->{random}
460	? undef
461	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
462	}
463
464	# return random map parameters, or undef
465	sub random_map_params {
466	my ($self) = @_;
467
468	$self->{random}
469	}
470
471	# this is somewhat ugly, but style maps do need special treatment
472	sub is_style_map {
473	$_[0]{path} =~ m{^/styles/}
474	}
475
476	package cf;
477		623
478	#############################################################################	624	#############################################################################
479		625
480	=head2 ATTACHABLE OBJECTS	626	=head2 ATTACHABLE OBJECTS
481		627
…		…
483	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")
484	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
485		631
486	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>
487	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
488	crossfire+).	634	Crossfire TRT).
489		635
490	=over 4	636	=over 4
491		637
492	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
493		639
…		…
607	our @CB_TYPE = (); # registry for type (cf-object class) based events	753	our @CB_TYPE = (); # registry for type (cf-object class) based events
608	our @CB_MAP = ();	754	our @CB_MAP = ();
609		755
610	my %attachment;	756	my %attachment;
611		757
		758	sub cf::attachable::thawer_merge {
		759	# simply override everything except _meta
		760	local $_[0]{_meta};
		761	%{$_[0]} = %{$_[1]};
		762	}
		763
612	sub _attach_cb($$$$) {	764	sub _attach_cb($$$$) {
613	my ($registry, $event, $prio, $cb) = @_;	765	my ($registry, $event, $prio, $cb) = @_;
614		766
615	use sort 'stable';	767	use sort 'stable';
616		768
…		…
650	$registry = $CB_TYPE[$object_type] ||= [];	802	$registry = $CB_TYPE[$object_type] ||= [];
651		803
652	} elsif ($type eq "subtype") {	804	} elsif ($type eq "subtype") {
653	defined $object_type or Carp::croak "subtype specified without type";	805	defined $object_type or Carp::croak "subtype specified without type";
654	my $object_subtype = shift @arg;	806	my $object_subtype = shift @arg;
655	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	807	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
656		808
657	} elsif ($type eq "package") {	809	} elsif ($type eq "package") {
658	my $pkg = shift @arg;	810	my $pkg = shift @arg;
659		811
660	while (my ($name, $id) = each %cb_id) {	812	while (my ($name, $id) = each %cb_id) {
…		…
689	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
690	}	842	}
691		843
692	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
693	} else {	845	} else {
694	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
695	}	847	}
696		848
697	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
698	}	850	}
699		851
…		…
701	if (ref $_[0]) {	853	if (ref $_[0]) {
702	_object_attach @_;	854	_object_attach @_;
703	} else {	855	} else {
704	_attach shift->_attach_registry, @_;	856	_attach shift->_attach_registry, @_;
705	}	857	}
		858	_recalc_want;
706	};	859	};
707		860
708	# all those should be optimised	861	# all those should be optimised
709	sub cf::attachable::detach {	862	sub cf::attachable::detach {
710	my ($obj, $name) = @_;	863	my ($obj, $name) = @_;
…		…
713	delete $obj->{_attachment}{$name};	866	delete $obj->{_attachment}{$name};
714	reattach ($obj);	867	reattach ($obj);
715	} else {	868	} else {
716	Carp::croak "cannot, currently, detach class attachments";	869	Carp::croak "cannot, currently, detach class attachments";
717	}	870	}
		871	_recalc_want;
718	};	872	};
719		873
720	sub cf::attachable::attached {	874	sub cf::attachable::attached {
721	my ($obj, $name) = @_;	875	my ($obj, $name) = @_;
722		876
…		…
737	";	891	";
738	die if $@;	892	die if $@;
739	}	893	}
740		894
741	our $override;	895	our $override;
742	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?
743		897
744	sub override {	898	sub override {
745	$override = 1;	899	$override = 1;
746	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
747	}	901	}
748		902
749	sub do_invoke {	903	sub do_invoke {
750	my $event = shift;	904	my $event = shift;
751	my $callbacks = shift;	905	my $callbacks = shift;
752		906
753	@invoke_results = ();	907	@INVOKE_RESULTS = ();
754		908
755	local $override;	909	local $override;
756		910
757	for (@$callbacks) {	911	for (@$callbacks) {
758	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
775		929
776	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
777		931
778	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
779	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
780	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
781		935
782	=back	936	=back
783		937
784	=cut	938	=cut
785		939
786	#############################################################################	940	#############################################################################
787	# 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	}
788		953
789	sub reattach {	954	sub reattach {
790	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
791	my ($obj) = @_;	956	my ($obj) = @_;
		957
		958	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
792		959
793	my $registry = $obj->registry;	960	my $registry = $obj->registry;
794		961
795	@$registry = ();	962	@$registry = ();
796		963
…		…
843	$filename, length $$rdata, scalar @$objs;	1010	$filename, length $$rdata, scalar @$objs;
844		1011
845	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1012	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
846	chmod SAVE_MODE, $fh;	1013	chmod SAVE_MODE, $fh;
847	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1014	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
848	aio_fsync $fh;	1015	aio_fsync $fh if $cf::USE_FSYNC;
849	close $fh;	1016	close $fh;
850		1017
851	if (@$objs) {	1018	if (@$objs) {
852	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) {
853	chmod SAVE_MODE, $fh;	1020	chmod SAVE_MODE, $fh;
854	my $data = Storable::nfreeze { version => 1, objs => $objs };	1021	my $data = Storable::nfreeze { version => 1, objs => $objs };
855	aio_write $fh, 0, (length $data), $data, 0;	1022	aio_write $fh, 0, (length $data), $data, 0;
856	aio_fsync $fh;	1023	aio_fsync $fh if $cf::USE_FSYNC;
857	close $fh;	1024	close $fh;
858	aio_rename "$filename.pst~", "$filename.pst";	1025	aio_rename "$filename.pst~", "$filename.pst";
859	}	1026	}
860	} else {	1027	} else {
861	aio_unlink "$filename.pst";	1028	aio_unlink "$filename.pst";
…		…
893	or return;	1060	or return;
894	$av = eval { (Storable::thaw $av)->{objs} };	1061	$av = eval { (Storable::thaw $av)->{objs} };
895	}	1062	}
896		1063
897	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
898	$filename, length $data, scalar @{$av || []};#d#	1065	$filename, length $data, scalar @{$av || []};
899	return ($data, $av);	1066	return ($data, $av);
900	}	1067	}
		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
901		1074
902	#############################################################################	1075	#############################################################################
903	# command handling &c	1076	# command handling &c
904		1077
905	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
…		…
918	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
919	}	1092	}
920		1093
921	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
922		1095
923	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.
924		1101
925	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
926	called.	1103	called.
927		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
928	=cut	1116	=cut
929		1117
930	sub register_extcmd {	1118	sub register_extcmd {
931	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
932		1120
933	my $caller = caller;
934	#warn "registering extcmd '$name' to '$caller'";
935
936	$EXTCMD{$name} = [$cb, $caller];	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
937	}	1128	}
938		1129
939	cf::player->attach (	1130	cf::player->attach (
940	on_command => sub {	1131	on_command => sub {
941	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
950	cf::override;	1141	cf::override;
951	},	1142	},
952	on_extcmd => sub {	1143	on_extcmd => sub {
953	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
954		1145
955	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
956		1147
957	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
958	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1154	if (my $cb = $EXTCMD{$type}) {
959	if (my %reply = $cb->[0]->($pl, $msg)) {	1155	my @reply = $cb->($pl, @payload);
		1156
960	$pl->ext_reply ($msg->{msgid}, %reply);	1157	$pl->ext_reply ($reply, @reply)
961	}	1158	if $reply;
962	}	1159	}
963	} else {	1160	} else {
964	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1161	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
965	}	1162	}
966		1163
967	cf::override;	1164	cf::override;
968	},	1165	},
969	);	1166	);
970		1167
971	sub register {
972	my ($base, $pkg) = @_;
973
974	#TODO
975	}
976
977	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($) {
978	my ($path) = @_;	1546	my ($path) = @_;
979		1547
980	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1548	my ($match, $specificity);
981	my $base = $1;
982	my $pkg = $1;
983	$pkg =~ s/[^[:word:]]/_/g;
984	$pkg = "ext::$pkg";
985		1549
986	warn "loading '$path' into '$pkg'\n";	1550	for my $region (list) {
987		1551	if ($region->{match} && $path =~ $region->{match}) {
988	open my $fh, "<:utf8", $path	1552	($match, $specificity) = ($region, $region->specificity)
989	or die "$path: $!";	1553	if $region->specificity > $specificity;
990		1554	}
991	my $source =
992	"package $pkg; use strict; use utf8;\n"
993	. "#line 1 \"$path\"\n{\n"
994	. (do { local $/; <$fh> })
995	. "\n};\n1";
996
997	eval $source
998	or die $@ ? "$path: $@\n"
999	: "extension disabled.\n";
1000
1001	push @exts, $pkg;
1002	$ext_pkg{$base} = $pkg;
1003
1004	# no strict 'refs';
1005	# @{"$pkg\::ISA"} = ext::;
1006
1007	register $base, $pkg;
1008	}
1009
1010	sub unload_extension {
1011	my ($pkg) = @_;
1012
1013	warn "removing extension $pkg\n";
1014
1015	# remove hooks
1016	#TODO
1017	# for my $idx (0 .. $#PLUGIN_EVENT) {
1018	# delete $hook[$idx]{$pkg};
1019	# }	1555	}
1020		1556
1021	# remove commands	1557	$match
1022	for my $name (keys %COMMAND) {
1023	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1024
1025	if (@cb) {
1026	$COMMAND{$name} = \@cb;
1027	} else {
1028	delete $COMMAND{$name};
1029	}
1030	}
1031
1032	# remove extcmds
1033	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1034	delete $EXTCMD{$name};
1035	}
1036
1037	if (my $cb = $pkg->can ("unload")) {
1038	eval {
1039	$cb->($pkg);
1040	1
1041	} or warn "$pkg unloaded, but with errors: $@";
1042	}
1043
1044	Symbol::delete_package $pkg;
1045	}
1046
1047	sub load_extensions {
1048	for my $ext (<$LIBDIR/*.ext>) {
1049	next unless -r $ext;
1050	eval {
1051	load_extension $ext;
1052	1
1053	} or warn "$ext not loaded: $@";
1054	}
1055	}
1056
1057	#############################################################################
1058	# load/save/clean perl data associated with a map
1059
1060	*cf::mapsupport::on_clean = sub {
1061	my ($map) = @_;
1062
1063	my $path = $map->tmpname;
1064	defined $path or return;
1065
1066	unlink "$path.pst";
1067	};
1068
1069	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1070
1071	#############################################################################
1072	# load/save perl data associated with player->ob objects
1073
1074	sub all_objects(@) {
1075	@_, map all_objects ($_->inv), @_
1076	}
1077
1078	# TODO: compatibility cruft, remove when no longer needed
1079	cf::player->attach (
1080	on_load => sub {
1081	my ($pl, $path) = @_;
1082
1083	for my $o (all_objects $pl->ob) {
1084	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1085	$o->set_ob_key_value ("_perl_data");
1086
1087	%$o = %{ Storable::thaw pack "H*", $value };
1088	}
1089	}
1090	},
1091	);
1092
1093	#############################################################################
1094
1095	=head2 CORE EXTENSIONS
1096
1097	Functions and methods that extend core crossfire objects.
1098
1099	=head3 cf::player
1100
1101	=over 4
1102
1103	=item cf::player::exists $login
1104
1105	Returns true when the given account exists.
1106
1107	=cut
1108
1109	sub cf::player::exists($) {
1110	cf::player::find $_[0]
1111	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1112	}
1113
1114	=item $player->ext_reply ($msgid, $msgtype, %msg)
1115
1116	Sends an ext reply to the player.
1117
1118	=cut
1119
1120	sub cf::player::ext_reply($$$%) {
1121	my ($self, $id, %msg) = @_;
1122
1123	$msg{msgid} = $id;
1124
1125	$self->send ("ext " . to_json \%msg);
1126	}	1558	}
1127		1559
1128	=back	1560	=back
1129
1130		1561
1131	=head3 cf::map	1562	=head3 cf::map
1132		1563
1133	=over 4	1564	=over 4
1134		1565
…		…
1137	package cf::map;	1568	package cf::map;
1138		1569
1139	use Fcntl;	1570	use Fcntl;
1140	use Coro::AIO;	1571	use Coro::AIO;
1141		1572
		1573	use overload
		1574	'""' => \&as_string,
		1575	fallback => 1;
		1576
1142	our $MAX_RESET = 7200;	1577	our $MAX_RESET = 3600;
1143	our $DEFAULT_RESET = 3600;	1578	our $DEFAULT_RESET = 3000;
1144		1579
1145	sub generate_random_map {	1580	sub generate_random_map {
1146	my ($path, $rmp) = @_;	1581	my ($self, $rmp) = @_;
1147
1148	# mit "rum" bekleckern, nicht	1582	# mit "rum" bekleckern, nicht
1149	cf::map::_create_random_map	1583	$self->_create_random_map (
1150	$path,
1151	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1584	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1585	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1586	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154	$rmp->{exit_on_final_map},	1587	$rmp->{exit_on_final_map},
1155	$rmp->{xsize}, $rmp->{ysize},	1588	$rmp->{xsize}, $rmp->{ysize},
1156	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1589	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1590	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1158	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1591	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1159	$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},
1160	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1593	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1161	(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"
1162	}	1723	}
1163		1724
1164	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1165	# all maps in C++...	1726	# all maps in C++...
1166	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1168		1729
1169	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1170	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1171	}	1732	}
1172		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
1173	sub try_load_header($) {	1750	sub load_header_from($) {
1174	my ($path) = @_;	1751	my ($self, $path) = @_;
1175		1752
1176	utf8::encode $path;	1753	utf8::encode $path;
1177	aio_open $path, O_RDONLY, 0	1754	#aio_open $path, O_RDONLY, 0
		1755	# or return;
		1756
		1757	$self->_load_header ($path)
1178	or return;	1758	or return;
1179		1759
1180	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
1181	or return;	1803	or return;
		1804	$self->prepare_orig;
		1805	}
1182		1806
1183	$map->load_header ($path)	1807	$self->{deny_reset} = 1
1184	or return;	1808	if $self->no_reset;
1185		1809
1186	$map->{load_path} = $path;	1810	$self->default_region (cf::region::find_by_path $self->{path})
		1811	unless $self->default_region;
1187		1812
1188	$map	1813	1
1189	}	1814	}
1190		1815
1191	sub find_map;	1816	sub find;
1192	sub find_map {	1817	sub find {
1193	my ($path, $origin) = @_;	1818	my ($path, $origin) = @_;
1194		1819
1195	#warn "find_map<$path,$origin>\n";#d#
1196
1197	$path = new cf::path $path, $origin && $origin->path;	1820	$path = normalise $path, $origin && $origin->path;
1198	my $key = $path->as_string;
1199		1821
1200	cf::lock_wait "map_find:$key";	1822	cf::lock_wait "map_find:$path";
1201		1823
1202	$cf::MAP{$key} || do {	1824	$cf::MAP{$path} || do {
1203	my $guard = cf::lock_acquire "map_find:$key";	1825	my $guard = cf::lock_acquire "map_find:$path";
1204		1826	my $map = new_from_path cf::map $path
1205	# do it the slow way
1206	my $map = try_load_header $path->save_path;
1207
1208	if ($map) {
1209	# safety
1210	$map->{instantiate_time} = $cf::RUNTIME
1211	if $map->{instantiate_time} > $cf::RUNTIME;
1212	} else {
1213	if (my $rmp = $path->random_map_params) {
1214	$map = generate_random_map $key, $rmp;
1215	} else {
1216	$map = try_load_header $path->load_path;
1217	}
1218
1219	$map or return;	1827	or return;
1220		1828
1221	$map->{load_original} = 1;
1222	$map->{instantiate_time} = $cf::RUNTIME;
1223	$map->instantiate;
1224
1225	# per-player maps become, after loading, normal maps
1226	$map->per_player (0) if $path->{user_rel};
1227	}
1228
1229	$map->path ($key);
1230	$map->{path} = $path;
1231	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1232	$map->last_access ($cf::RUNTIME);
1233		1830
1234	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;
1235	$map->reset;	1837	$map->reset;
1236	undef $guard;	1838	undef $guard;
1237	$map = find_map $path	1839	return find $path;
1238	or return;
1239	}	1840	}
1240		1841
1241	$cf::MAP{$key} = $map	1842	$cf::MAP{$path} = $map
1242	}	1843	}
1243	}	1844	}
		1845
		1846	sub pre_load { }
		1847	sub post_load { }
1244		1848
1245	sub load {	1849	sub load {
1246	my ($self) = @_;	1850	my ($self) = @_;
1247		1851
		1852	local $self->{deny_reset} = 1; # loading can take a long time
		1853
1248	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
1249	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1857	my $guard = cf::lock_acquire "map_load:$path";
1250		1858
1251	return if $self->in_memory != cf::MAP_SWAPPED;	1859	return if $self->in_memory != cf::MAP_SWAPPED;
1252		1860
1253	$self->in_memory (cf::MAP_LOADING);	1861	$self->in_memory (cf::MAP_LOADING);
1254		1862
1255	$self->alloc;	1863	$self->alloc;
		1864
		1865	$self->pre_load;
		1866	Coro::cede;
		1867
1256	$self->load_objects ($self->{load_path}, 1)	1868	$self->_load_objects ($self->{load_path}, 1)
1257	or return;	1869	or return;
1258		1870
1259	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1871	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1260	if delete $self->{load_original};	1872	if delete $self->{load_original};
1261		1873
1262	if (my $uniq = $path->uniq_path) {	1874	if (my $uniq = $self->uniq_path) {
1263	utf8::encode $uniq;	1875	utf8::encode $uniq;
1264	if (aio_open $uniq, O_RDONLY, 0) {	1876	if (aio_open $uniq, O_RDONLY, 0) {
1265	$self->clear_unique_items;	1877	$self->clear_unique_items;
1266	$self->load_objects ($uniq, 0);	1878	$self->_load_objects ($uniq, 0);
1267	}	1879	}
1268	}	1880	}
1269		1881
		1882	Coro::cede;
1270	# now do the right thing for maps	1883	# now do the right thing for maps
1271	$self->link_multipart_objects;	1884	$self->link_multipart_objects;
1272
1273	if ($self->{path}->is_style_map) {
1274	$self->{deny_save} = 1;
1275	$self->{deny_reset} = 1;
1276	} else {
1277	$self->fix_auto_apply;
1278	$self->decay_objects;
1279	$self->update_buttons;
1280	$self->set_darkness_map;
1281	$self->difficulty ($self->estimate_difficulty)	1885	$self->difficulty ($self->estimate_difficulty)
1282	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;
1283	$self->activate;	1896	$self->activate;
1284	}	1897	}
1285		1898
		1899	$self->{last_save} = $cf::RUNTIME;
		1900	$self->last_access ($cf::RUNTIME);
		1901
1286	$self->in_memory (cf::MAP_IN_MEMORY);	1902	$self->in_memory (cf::MAP_IN_MEMORY);
1287	}	1903	}
1288		1904
1289	sub load_map_sync {	1905	$self->post_load;
		1906	}
		1907
		1908	sub customise_for {
		1909	my ($self, $ob) = @_;
		1910
		1911	return find "~" . $ob->name . "/" . $self->{path}
		1912	if $self->per_player;
		1913
		1914	# return find "?party/" . $ob->name . "/" . $self->{path}
		1915	# if $self->per_party;
		1916
		1917	$self
		1918	}
		1919
		1920	# find and load all maps in the 3x3 area around a map
		1921	sub load_neighbours {
		1922	my ($map) = @_;
		1923
		1924	my @neigh; # diagonal neighbours
		1925
		1926	for (0 .. 3) {
		1927	my $neigh = $map->tile_path ($_)
		1928	or next;
		1929	$neigh = find $neigh, $map
		1930	or next;
		1931	$neigh->load;
		1932
		1933	push @neigh,
		1934	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		1935	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1936	}
		1937
		1938	for (grep defined $_->[0], @neigh) {
		1939	my ($path, $origin) = @$_;
		1940	my $neigh = find $path, $origin
		1941	or next;
		1942	$neigh->load;
		1943	}
		1944	}
		1945
		1946	sub find_sync {
1290	my ($path, $origin) = @_;	1947	my ($path, $origin) = @_;
1291		1948
1292	#warn "load_map_sync<$path, $origin>\n";#d#	1949	cf::sync_job { find $path, $origin }
		1950	}
1293		1951
1294	cf::sync_job {	1952	sub do_load_sync {
1295	my $map = cf::map::find_map $path, $origin	1953	my ($map) = @_;
1296	or return;	1954
		1955	cf::sync_job { $map->load };
		1956	}
		1957
		1958	our %MAP_PREFETCH;
		1959	our $MAP_PREFETCHER = undef;
		1960
		1961	sub find_async {
		1962	my ($path, $origin) = @_;
		1963
		1964	$path = normalise $path, $origin && $origin->{path};
		1965
		1966	if (my $map = $cf::MAP{$path}) {
		1967	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1968	}
		1969
		1970	undef $MAP_PREFETCH{$path};
		1971	$MAP_PREFETCHER ||= cf::async {
		1972	while (%MAP_PREFETCH) {
		1973	for my $path (keys %MAP_PREFETCH) {
		1974	if (my $map = find $path) {
1297	$map->load;	1975	$map->load;
1298	$map	1976	}
		1977
		1978	delete $MAP_PREFETCH{$path};
		1979	}
		1980	}
		1981	undef $MAP_PREFETCHER;
1299	}	1982	};
		1983	$MAP_PREFETCHER->prio (6);
		1984
		1985	()
1300	}	1986	}
1301		1987
1302	sub save {	1988	sub save {
1303	my ($self) = @_;	1989	my ($self) = @_;
1304		1990
		1991	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1992
1305	$self->{last_save} = $cf::RUNTIME;	1993	$self->{last_save} = $cf::RUNTIME;
1306		1994
1307	return unless $self->dirty;	1995	return unless $self->dirty;
1308		1996
1309	my $save = $self->{path}->save_path; utf8::encode $save;	1997	my $save = $self->save_path; utf8::encode $save;
1310	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1998	my $uniq = $self->uniq_path; utf8::encode $uniq;
1311		1999
1312	$self->{load_path} = $save;	2000	$self->{load_path} = $save;
1313		2001
1314	return if $self->{deny_save};	2002	return if $self->{deny_save};
1315		2003
		2004	local $self->{last_access} = $self->last_access;#d#
		2005
		2006	cf::async {
		2007	$_->contr->save for $self->players;
		2008	};
		2009
1316	if ($uniq) {	2010	if ($uniq) {
1317	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2011	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318	$self->save_objects ($uniq, cf::IO_UNIQUES);	2012	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1319	} else {	2013	} else {
1320	$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);
1321	}	2015	}
1322	}	2016	}
1323		2017
1324	sub swap_out {	2018	sub swap_out {
1325	my ($self) = @_;	2019	my ($self) = @_;
		2020
		2021	# save first because save cedes
		2022	$self->save;
		2023
		2024	my $lock = cf::lock_acquire "map_data:" . $self->path;
1326		2025
1327	return if $self->players;	2026	return if $self->players;
1328	return if $self->in_memory != cf::MAP_IN_MEMORY;	2027	return if $self->in_memory != cf::MAP_IN_MEMORY;
1329	return if $self->{deny_save};	2028	return if $self->{deny_save};
1330		2029
1331	$self->save;
1332	$self->clear;	2030	$self->clear;
1333	$self->in_memory (cf::MAP_SWAPPED);	2031	$self->in_memory (cf::MAP_SWAPPED);
1334	}	2032	}
1335		2033
1336	sub reset_at {	2034	sub reset_at {
1337	my ($self) = @_;	2035	my ($self) = @_;
1338		2036
1339	# TODO: safety, remove and allow resettable per-player maps	2037	# TODO: safety, remove and allow resettable per-player maps
1340	return 1e99 if $self->{path}{user_rel};
1341	return 1e99 if $self->{deny_reset};	2038	return 1e99 if $self->{deny_reset};
1342		2039
1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2040	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344	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;
1345		2042
…		…
1350	my ($self) = @_;	2047	my ($self) = @_;
1351		2048
1352	$self->reset_at <= $cf::RUNTIME	2049	$self->reset_at <= $cf::RUNTIME
1353	}	2050	}
1354		2051
1355	sub unlink_save {
1356	my ($self) = @_;
1357
1358	utf8::encode (my $save = $self->{path}->save_path);
1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361	}
1362
1363	sub rename {
1364	my ($self, $new_path) = @_;
1365
1366	$self->unlink_save;
1367
1368	delete $cf::MAP{$self->path};
1369	$self->{path} = new cf::path $new_path;
1370	$self->path ($self->{path}->as_string);
1371	$cf::MAP{$self->path} = $self;
1372
1373	$self->save;
1374	}
1375
1376	sub reset {	2052	sub reset {
1377	my ($self) = @_;	2053	my ($self) = @_;
1378		2054
		2055	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2056
1379	return if $self->players;	2057	return if $self->players;
1380	return if $self->{path}{user_rel};#d#
1381		2058
1382	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	}
1383		2070
1384	delete $cf::MAP{$self->path};	2071	delete $cf::MAP{$self->path};
		2072
		2073	$self->clear;
1385		2074
1386	$_->clear_links_to ($self) for values %cf::MAP;	2075	$_->clear_links_to ($self) for values %cf::MAP;
1387		2076
1388	$self->unlink_save;	2077	$self->unlink_save;
1389	$self->destroy;	2078	$self->destroy;
…		…
1392	my $nuke_counter = "aaaa";	2081	my $nuke_counter = "aaaa";
1393		2082
1394	sub nuke {	2083	sub nuke {
1395	my ($self) = @_;	2084	my ($self) = @_;
1396		2085
		2086	delete $cf::MAP{$self->path};
		2087
		2088	$self->unlink_save;
		2089
		2090	bless $self, "cf::map";
		2091	delete $self->{deny_reset};
1397	$self->{deny_save} = 1;	2092	$self->{deny_save} = 1;
1398	$self->reset_timeout (1);	2093	$self->reset_timeout (1);
1399	$self->rename ("{nuke}/" . ($nuke_counter++));	2094	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2095
		2096	$cf::MAP{$self->path} = $self;
		2097
1400	$self->reset; # polite request, might not happen	2098	$self->reset; # polite request, might not happen
1401	}	2099	}
1402		2100
1403	sub customise_for {	2101	=item $maps = cf::map::tmp_maps
1404	my ($map, $ob) = @_;
1405		2102
1406	if ($map->per_player) {	2103	Returns an arrayref with all map paths of currently instantiated and saved
1407	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2104	maps. May block.
		2105
		2106	=cut
		2107
		2108	sub tmp_maps() {
1408	}	2109	[
1409		2110	map {
1410	$map	2111	utf8::decode $_;
		2112	/\.map$/
		2113	? normalise $_
		2114	: ()
		2115	} @{ aio_readdir $TMPDIR or [] }
		2116	]
1411	}	2117	}
1412		2118
1413	sub emergency_save {	2119	=item $maps = cf::map::random_maps
1414	local $cf::FREEZE = 1;
1415		2120
1416	warn "enter emergency map save\n";	2121	Returns an arrayref with all map paths of currently instantiated and saved
		2122	random maps. May block.
1417		2123
1418	cf::sync_job {	2124	=cut
1419	warn "begin emergency map save\n";
1420	$_->save for values %cf::MAP;
1421	};
1422		2125
1423	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	]
1424	}	2153	}
1425		2154
1426	package cf;	2155	package cf;
1427		2156
1428	=back	2157	=back
1429		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
1430		2185
1431	=head3 cf::object::player	2186	=head3 cf::object::player
1432		2187
1433	=over 4	2188	=over 4
1434		2189
…		…
1448		2203
1449	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2204	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1450		2205
1451	if ($self->{record_replies}) {	2206	if ($self->{record_replies}) {
1452	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2207	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2208
1453	} 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 {
1454	$msg = $npc->name . " says: $msg" if $npc;	2217	$msg = $npc->name . " says: $msg" if $npc;
1455	$self->message ($msg, $flags);	2218	$self->message ($msg, $flags);
		2219	}
1456	}	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 (@_);
1457	}	2231	}
1458		2232
1459	=item $player_object->may ("access")	2233	=item $player_object->may ("access")
1460		2234
1461	Returns wether the given player is authorized to access resource "access"	2235	Returns wether the given player is authorized to access resource "access"
…		…
1474		2248
1475	=item $player_object->enter_link	2249	=item $player_object->enter_link
1476		2250
1477	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}>).
1478		2252
1479	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
1480	I<MUST> call C<leave_link> as soon as possible, though.	2254	I<MUST> call C<leave_link> as soon as possible, though.
1481		2255
		2256	Will never block.
		2257
1482	=item $player_object->leave_link ($map, $x, $y)	2258	=item $player_object->leave_link ($map, $x, $y)
1483		2259
1484	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
1485	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
1486	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
1487	to the emergency map position.	2263	fails, to the emergency map position.
1488		2264
1489	Might block.	2265	Might block.
1490		2266
1491	=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	}
1492		2278
1493	sub cf::object::player::enter_link {	2279	sub cf::object::player::enter_link {
1494	my ($self) = @_;	2280	my ($self) = @_;
1495		2281
1496	$self->deactivate_recursive;	2282	$self->deactivate_recursive;
1497		2283
1498	return if $self->map == $LINK_MAP;	2284	return if UNIVERSAL::isa $self->map, "ext::map_link";
1499		2285
1500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2286	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501	if $self->map;	2287	if $self->map && $self->map->{path} ne "{link}";
1502		2288
1503	$self->enter_map ($LINK_MAP, 20, 20);	2289	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1504	}	2290	}
1505		2291
1506	sub cf::object::player::leave_link {	2292	sub cf::object::player::leave_link {
1507	my ($self, $map, $x, $y) = @_;	2293	my ($self, $map, $x, $y) = @_;
		2294
		2295	return unless $self->contr->active;
1508		2296
1509	my $link_pos = delete $self->{_link_pos};	2297	my $link_pos = delete $self->{_link_pos};
1510		2298
1511	unless ($map) {	2299	unless ($map) {
1512	# restore original map position	2300	# restore original map position
1513	($map, $x, $y) = @{ $link_pos || [] };	2301	($map, $x, $y) = @{ $link_pos || [] };
1514	$map = cf::map::find_map $map;	2302	$map = cf::map::find $map;
1515		2303
1516	unless ($map) {	2304	unless ($map) {
1517	($map, $x, $y) = @$EMERGENCY_POSITION;	2305	($map, $x, $y) = @$EMERGENCY_POSITION;
1518	$map = cf::map::find_map $map	2306	$map = cf::map::find $map
1519	or die "FATAL: cannot load emergency map\n";	2307	or die "FATAL: cannot load emergency map\n";
1520	}	2308	}
1521	}	2309	}
1522		2310
1523	($x, $y) = (-1, -1)	2311	($x, $y) = (-1, -1)
…		…
1526	# use -1 or undef as default coordinates, not 0, 0	2314	# use -1 or undef as default coordinates, not 0, 0
1527	($x, $y) = ($map->enter_x, $map->enter_y)	2315	($x, $y) = ($map->enter_x, $map->enter_y)
1528	if $x <=0 && $y <= 0;	2316	if $x <=0 && $y <= 0;
1529		2317
1530	$map->load;	2318	$map->load;
		2319	$map->load_neighbours;
1531		2320
		2321	return unless $self->contr->active;
1532	$self->activate_recursive;	2322	$self->activate_recursive;
		2323
		2324	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1533	$self->enter_map ($map, $x, $y);	2325	$self->enter_map ($map, $x, $y);
1534	}	2326	}
1535		2327
1536	cf::player->attach (	2328	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1537	on_logout => sub {
1538	my ($pl) = @_;
1539		2329
1540	# abort map switching before logout	2330	Moves the player to the given map-path and coordinates by first freezing
1541	if ($pl->ob->{_link_pos}) {	2331	her, loading and preparing them map, calling the provided $check callback
1542	cf::sync_job {	2332	that has to return the map if sucecssful, and then unfreezes the player on
1543	$pl->ob->leave_link	2333	the new (success) or old (failed) map position. In either case, $done will
1544	};	2334	be called at the end of this process.
1545	}
1546	},
1547	on_login => sub {
1548	my ($pl) = @_;
1549		2335
1550	# try to abort aborted map switching on player login :)
1551	# should happen only on crashes
1552	if ($pl->ob->{_link_pos}) {
1553	$pl->ob->enter_link;
1554	cf::async {
1555	# we need this sleep as the login has a concurrent enter_exit running
1556	# and this sleep increases chances of the player not ending up in scorn
1557	Coro::Timer::sleep 1;
1558	$pl->ob->leave_link;
1559	};
1560	}
1561	},
1562	);
1563
1564	=item $player_object->goto_map ($path, $x, $y)
1565
1566	=cut	2336	=cut
1567		2337
		2338	our $GOTOGEN;
		2339
1568	sub cf::object::player::goto_map {	2340	sub cf::object::player::goto {
1569	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;
1570		2345
1571	$self->enter_link;	2346	$self->enter_link;
1572		2347
1573	(cf::async {	2348	(async {
1574	$path = new cf::path $path;	2349	my $map = eval {
1575
1576	my $map = cf::map::find_map $path->as_string;	2350	my $map = cf::map::find $path;
		2351
		2352	if ($map) {
1577	$map = $map->customise_for ($self) if $map;	2353	$map = $map->customise_for ($self);
1578		2354	$map = $check->($map) if $check && $map;
1579	# warn "entering ", $map->path, " at ($x, $y)\n"	2355	} else {
1580	# if $map;
1581
1582	$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	}
1583		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};
1584	$self->leave_link ($map, $x, $y);	2369	$self->leave_link ($map, $x, $y);
		2370	}
		2371
		2372	$done->() if $done;
1585	})->prio (1);	2373	})->prio (1);
1586	}	2374	}
1587		2375
1588	=item $player_object->enter_exit ($exit_object)	2376	=item $player_object->enter_exit ($exit_object)
1589		2377
…		…
1591		2379
1592	sub parse_random_map_params {	2380	sub parse_random_map_params {
1593	my ($spec) = @_;	2381	my ($spec) = @_;
1594		2382
1595	my $rmp = { # defaults	2383	my $rmp = { # defaults
1596	xsize => 10,	2384	xsize => (cf::rndm 15, 40),
1597	ysize => 10,	2385	ysize => (cf::rndm 15, 40),
		2386	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2387	#layout => string,
1598	};	2388	};
1599		2389
1600	for (split /\n/, $spec) {	2390	for (split /\n/, $spec) {
1601	my ($k, $v) = split /\s+/, $_, 2;	2391	my ($k, $v) = split /\s+/, $_, 2;
1602		2392
…		…
1606	$rmp	2396	$rmp
1607	}	2397	}
1608		2398
1609	sub prepare_random_map {	2399	sub prepare_random_map {
1610	my ($exit) = @_;	2400	my ($exit) = @_;
		2401
		2402	my $guard = cf::lock_acquire "exit_prepare:$exit";
1611		2403
1612	# all this does is basically replace the /! path by	2404	# all this does is basically replace the /! path by
1613	# a new random map path (?random/...) with a seed	2405	# a new random map path (?random/...) with a seed
1614	# that depends on the exit object	2406	# that depends on the exit object
1615		2407
1616	my $rmp = parse_random_map_params $exit->msg;	2408	my $rmp = parse_random_map_params $exit->msg;
1617		2409
1618	if ($exit->map) {	2410	if ($exit->map) {
1619	$rmp->{region} = $exit->map->region_name;	2411	$rmp->{region} = $exit->region->name;
1620	$rmp->{origin_map} = $exit->map->path;	2412	$rmp->{origin_map} = $exit->map->path;
1621	$rmp->{origin_x} = $exit->x;	2413	$rmp->{origin_x} = $exit->x;
1622	$rmp->{origin_y} = $exit->y;	2414	$rmp->{origin_y} = $exit->y;
1623	}	2415	}
1624		2416
1625	$rmp->{random_seed} ||= $exit->random_seed;	2417	$rmp->{random_seed} ||= $exit->random_seed;
1626		2418
1627	my $data = cf::to_json $rmp;	2419	my $data = cf::to_json $rmp;
1628	my $md5 = Digest::MD5::md5_hex $data;	2420	my $md5 = Digest::MD5::md5_hex $data;
		2421	my $meta = "$RANDOMDIR/$md5.meta";
1629		2422
1630	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) {
1631	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;
1632		2427
1633	$exit->slaying ("?random/$md5");	2428	$exit->slaying ("?random/$md5");
1634	$exit->msg (undef);	2429	$exit->msg (undef);
1635	}	2430	}
1636	}	2431	}
…		…
1638	sub cf::object::player::enter_exit {	2433	sub cf::object::player::enter_exit {
1639	my ($self, $exit) = @_;	2434	my ($self, $exit) = @_;
1640		2435
1641	return unless $self->type == cf::PLAYER;	2436	return unless $self->type == cf::PLAYER;
1642		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
1643	$self->enter_link;	2449	$self->enter_link;
1644		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
1645	(cf::async {	2455	(async {
		2456	$self->deactivate_recursive; # just to be sure
1646	unless (eval {	2457	unless (eval {
1647	prepare_random_map $exit	2458	$self->goto ($slaying, $hp, $sp);
1648	if $exit->slaying eq "/!";
1649
1650	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1651	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1652		2459
1653	1;	2460	1;
1654	}) {	2461	}) {
1655	$self->message ("Something went wrong deep within the crossfire server. "	2462	$self->message ("Something went wrong deep within the crossfire server. "
1656	. "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. "
1657	. "Please report this to the dungeon master",	2464	. "Please report this to the dungeon master!",
1658	cf::NDI_UNIQUE | cf::NDI_RED);	2465	cf::NDI_UNIQUE | cf::NDI_RED);
1659		2466
1660	warn "ERROR in enter_exit: $@";	2467	warn "ERROR in enter_exit: $@";
1661	$self->leave_link;	2468	$self->leave_link;
1662	}	2469	}
1663	})->prio (1);	2470	})->prio (1);
…		…
1676		2483
1677	sub cf::client::send_drawinfo {	2484	sub cf::client::send_drawinfo {
1678	my ($self, $text, $flags) = @_;	2485	my ($self, $text, $flags) = @_;
1679		2486
1680	utf8::encode $text;	2487	utf8::encode $text;
1681	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2488	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1682	}	2489	}
1683		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	}
1684		2571
1685	=item $success = $client->query ($flags, "text", \&cb)	2572	=item $success = $client->query ($flags, "text", \&cb)
1686		2573
1687	Queues a query to the client, calling the given callback with	2574	Queues a query to the client, calling the given callback with
1688	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>,
1689	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>.
1690		2577
1691	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
1692	reliable at some point in the future.	2579	become reliable at some point in the future.
1693		2580
1694	=cut	2581	=cut
1695		2582
1696	sub cf::client::query {	2583	sub cf::client::query {
1697	my ($self, $flags, $text, $cb) = @_;	2584	my ($self, $flags, $text, $cb) = @_;
…		…
1705	utf8::encode $text;	2592	utf8::encode $text;
1706	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2593	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1707		2594
1708	$self->send_packet ($self->{query_queue}[0][0])	2595	$self->send_packet ($self->{query_queue}[0][0])
1709	if @{ $self->{query_queue} } == 1;	2596	if @{ $self->{query_queue} } == 1;
		2597
		2598	1
1710	}	2599	}
1711		2600
1712	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	},
1713	on_reply => sub {	2607	on_reply => sub {
1714	my ($ns, $msg) = @_;	2608	my ($ns, $msg) = @_;
1715		2609
1716	# this weird shuffling is so that direct followup queries	2610	# this weird shuffling is so that direct followup queries
1717	# get handled first	2611	# get handled first
1718	my $queue = delete $ns->{query_queue}	2612	my $queue = delete $ns->{query_queue}
1719	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
1720		2614
1721	(shift @$queue)->[1]->($msg);	2615	(shift @$queue)->[1]->($msg);
		2616	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1722		2617
1723	push @{ $ns->{query_queue} }, @$queue;	2618	push @{ $ns->{query_queue} }, @$queue;
1724		2619
1725	if (@{ $ns->{query_queue} } == @$queue) {	2620	if (@{ $ns->{query_queue} } == @$queue) {
1726	if (@$queue) {	2621	if (@$queue) {
…		…
1728	} else {	2623	} else {
1729	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2624	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1730	}	2625	}
1731	}	2626	}
1732	},	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	},
1733	);	2651	);
1734		2652
1735	=item $client->coro (\&cb)	2653	=item $client->async (\&cb)
1736		2654
1737	Create a new coroutine, running the specified callback. The coroutine will	2655	Create a new coroutine, running the specified callback. The coroutine will
1738	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,
1739	or loss of connection).	2657	or loss of connection).
1740		2658
1741	=cut	2659	=cut
1742		2660
1743	sub cf::client::coro {	2661	sub cf::client::async {
1744	my ($self, $cb) = @_;	2662	my ($self, $cb) = @_;
1745		2663
1746	my $coro = &cf::async ($cb);	2664	my $coro = &Coro::async ($cb);
1747		2665
1748	$coro->on_destroy (sub {	2666	$coro->on_destroy (sub {
1749	delete $self->{_coro}{$coro+0};	2667	delete $self->{_coro}{$coro+0};
1750	});	2668	});
1751		2669
…		…
1778	our $safe = new Safe "safe";	2696	our $safe = new Safe "safe";
1779	our $safe_hole = new Safe::Hole;	2697	our $safe_hole = new Safe::Hole;
1780		2698
1781	$SIG{FPE} = 'IGNORE';	2699	$SIG{FPE} = 'IGNORE';
1782		2700
1783	$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	));
1784		2706
1785	# here we export the classes and methods available to script code	2707	# here we export the classes and methods available to script code
1786		2708
1787	=pod	2709	=pod
1788		2710
1789	The following fucntions and emthods are available within a safe environment:	2711	The following functions and methods are available within a safe environment:
1790		2712
1791	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
1792	cf::object::player player	2717	cf::object::player
1793	cf::player peaceful	2718	player
1794	cf::map trigger	2719
		2720	cf::player
		2721	peaceful
		2722
		2723	cf::map
		2724	trigger
1795		2725
1796	=cut	2726	=cut
1797		2727
1798	for (	2728	for (
1799	["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)],
1800	["cf::object::player" => qw(player)],	2731	["cf::object::player" => qw(player)],
1801	["cf::player" => qw(peaceful)],	2732	["cf::player" => qw(peaceful)],
1802	["cf::map" => qw(trigger)],	2733	["cf::map" => qw(trigger)],
1803	) {	2734	) {
1804	no strict 'refs';	2735	no strict 'refs';
…		…
1875	=back	2806	=back
1876		2807
1877	=cut	2808	=cut
1878		2809
1879	#############################################################################	2810	#############################################################################
		2811	# the server's init and main functions
1880		2812
1881	=head2 EXTENSION DATABASE SUPPORT	2813	sub load_facedata($) {
		2814	my ($path) = @_;
1882		2815
1883	Crossfire maintains a very simple database for extension use. It can	2816	my $enc = JSON::XS->new->utf8->canonical;
1884	currently store anything that can be serialised using Storable, which
1885	excludes objects.
1886		2817
1887	The parameter C<$family> should best start with the name of the extension	2818	warn "loading facedata from $path\n";
1888	using it, it should be unique.
1889		2819
1890	=over 4	2820	my $facedata;
		2821	0 < aio_load $path, $facedata
		2822	or die "$path: $!";
1891		2823
1892	=item $hashref = cf::db_get $family	2824	$facedata = Coro::Storable::thaw $facedata;
1893		2825
1894	Return a hashref for use by the extension C<$family>, which can be	2826	$facedata->{version} == 2
1895	modified. After modifications, you have to call C<cf::db_dirty> or	2827	or cf::cleanup "$path: version mismatch, cannot proceed.";
1896	C<cf::db_sync>.
1897		2828
1898	=item $value = cf::db_get $family => $key	2829	# patch in the exptable
1899		2830	$facedata->{resource}{"res/exp_table"} = {
1900	Returns a single value from the database	2831	type => FT_RSRC,
1901		2832	data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
1902	=item cf::db_put $family => $hashref
1903
1904	Stores the given family hashref into the database. Updates are delayed, if
1905	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1906
1907	=item cf::db_put $family => $key => $value
1908
1909	Stores the given C<$value> in the family hash. Updates are delayed, if you
1910	want the data to be synced to disk immediately, use C<cf::db_sync>.
1911
1912	=item cf::db_dirty
1913
1914	Marks the database as dirty, to be updated at a later time.
1915
1916	=item cf::db_sync
1917
1918	Immediately write the database to disk I<if it is dirty>.
1919
1920	=cut
1921
1922	our $DB;
1923
1924	{
1925	my $path = cf::localdir . "/database.pst";
1926
1927	sub db_load() {
1928	$DB = stat $path ? Storable::retrieve $path : { };
1929	}
1930
1931	my $pid;
1932
1933	sub db_save() {
1934	waitpid $pid, 0 if $pid;
1935	if (0 == ($pid = fork)) {
1936	$DB->{_meta}{version} = 1;
1937	Storable::nstore $DB, "$path~";
1938	rename "$path~", $path;
1939	cf::_exit 0 if defined $pid;
1940	}
1941	}
1942
1943	my $dirty;
1944
1945	sub db_sync() {
1946	db_save if $dirty;
1947	undef $dirty;
1948	}
1949
1950	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1951	db_sync;
1952	});	2833	};
		2834	cf::cede_to_tick;
1953		2835
1954	sub db_dirty() {
1955	$dirty = 1;
1956	$idle->start;
1957	}	2836	{
		2837	my $faces = $facedata->{faceinfo};
1958		2838
1959	sub db_get($;$) {	2839	while (my ($face, $info) = each %$faces) {
1960	@_ >= 2	2840	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1961	? $DB->{$_[0]}{$_[1]}	2841	cf::face::set_visibility $idx, $info->{visibility};
1962	: ($DB->{$_[0]} ||= { })	2842	cf::face::set_magicmap $idx, $info->{magicmap};
1963	}	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};
1964		2845
1965	sub db_put($$;$) {	2846	cf::cede_to_tick;
1966	if (@_ >= 3) {
1967	$DB->{$_[0]}{$_[1]} = $_[2];
1968	} else {
1969	$DB->{$_[0]} = $_[1];
1970	}
1971	db_dirty;
1972	}
1973
1974	cf::global->attach (
1975	prio => 10000,
1976	on_cleanup => sub {
1977	db_sync;
1978	},	2847	}
1979	);
1980	}
1981		2848
1982	#############################################################################	2849	while (my ($face, $info) = each %$faces) {
1983	# 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	}
1984		2978
1985	sub cfg_load {	2979	sub cfg_load {
1986	open my $fh, "<:utf8", cf::confdir . "/config"	2980	open my $fh, "<:utf8", "$CONFDIR/config"
1987	or return;	2981	or return;
1988		2982
1989	local $/;	2983	local $/;
1990	*CFG = YAML::Syck::Load <$fh>;	2984	*CFG = YAML::Syck::Load <$fh>;
		2985
		2986	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		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
		2991	if (exists $CFG{mlockall}) {
		2992	eval {
		2993	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2994	and die "WARNING: m(un)lockall failed: $!\n";
		2995	};
		2996	warn $@ if $@;
		2997	}
1991	}	2998	}
1992		2999
1993	sub main {	3000	sub main {
1994	# we must not ever block the main coroutine	3001	# we must not ever block the main coroutine
1995	local $Coro::idle = sub {	3002	local $Coro::idle = sub {
1996	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#
1997	(Coro::unblock_sub {	3004	(async {
1998	Event::one_event;	3005	Event::one_event;
1999	})->();	3006	})->prio (Coro::PRIO_MAX);
2000	};	3007	};
2001		3008
2002	cfg_load;	3009	cfg_load;
2003	db_load;	3010	db_init;
2004	load_extensions;	3011	load_extensions;
		3012
		3013	$TICK_WATCHER->start;
2005	Event::loop;	3014	Event::loop;
2006	}	3015	}
2007		3016
2008	#############################################################################	3017	#############################################################################
2009	# initialisation	3018	# initialisation and cleanup
2010		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
2011	sub reload() {	3113	sub do_reload_perl() {
2012	# can/must only be called in main	3114	# can/must only be called in main
2013	if ($Coro::current != $Coro::main) {	3115	if ($Coro::current != $Coro::main) {
2014	warn "can only reload from main coroutine\n";	3116	warn "can only reload from main coroutine";
2015	return;	3117	return;
2016	}	3118	}
2017		3119
2018	warn "reloading...";	3120	warn "reloading...";
2019		3121
2020	local $FREEZE = 1;	3122	warn "entering sync_job";
		3123
		3124	cf::sync_job {
		3125	cf::write_runtime; # external watchdog should not bark
2021	cf::emergency_save;	3126	cf::emergency_save;
		3127	cf::write_runtime; # external watchdog should not bark
2022		3128
2023	eval {	3129	warn "syncing database to disk";
		3130	BDB::db_env_txn_checkpoint $DB_ENV;
		3131
2024	# 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
2025		3133
2026	# cancel all watchers	3134	warn "cancelling all WF_AUTOCANCEL watchers";
2027	for (Event::all_watchers) {	3135	for (Event::all_watchers) {
2028	$_->cancel if $_->data & WF_AUTOCANCEL;	3136	$_->cancel if $_->data & WF_AUTOCANCEL;
2029	}	3137	}
2030		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
2031	# cancel all extension coros	3150	warn "cancelling all extension coros";
2032	$_->cancel for values %EXT_CORO;	3151	$_->cancel for values %EXT_CORO;
2033	%EXT_CORO = ();	3152	%EXT_CORO = ();
2034		3153
2035	# unload all extensions	3154	warn "removing commands";
2036	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) {
2037	warn "unloading <$_>";	3163	warn "... unloading $pkg";
2038	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: $@";
2039	}	3170	}
2040		3171
		3172	warn "... nuking $pkg";
		3173	Symbol::delete_package $pkg;
		3174	}
		3175
2041	# unload all modules loaded from $LIBDIR	3176	warn "unloading all perl modules loaded from $LIBDIR";
2042	while (my ($k, $v) = each %INC) {	3177	while (my ($k, $v) = each %INC) {
2043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3178	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2044		3179
2045	warn "removing <$k>";	3180	warn "... unloading $k";
2046	delete $INC{$k};	3181	delete $INC{$k};
2047		3182
2048	$k =~ s/\.pm$//;	3183	$k =~ s/\.pm$//;
2049	$k =~ s/\//::/g;	3184	$k =~ s/\//::/g;
2050		3185
…		…
2053	}	3188	}
2054		3189
2055	Symbol::delete_package $k;	3190	Symbol::delete_package $k;
2056	}	3191	}
2057		3192
2058	# sync database to disk
2059	cf::db_sync;
2060	IO::AIO::flush;
2061
2062	# get rid of safe::, as good as possible	3193	warn "getting rid of safe::, as good as possible";
2063	Symbol::delete_package "safe::$_"	3194	Symbol::delete_package "safe::$_"
2064	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);
2065		3196
2066	# remove register_script_function callbacks
2067	# TODO
2068
2069	# unload cf.pm "a bit"	3197	warn "unloading cf.pm \"a bit\"";
2070	delete $INC{"cf.pm"};	3198	delete $INC{"cf.pm"};
		3199	delete $INC{"cf/pod.pm"};
2071		3200
2072	# don't, removes xs symbols, too,	3201	# don't, removes xs symbols, too,
2073	# and global variables created in xs	3202	# and global variables created in xs
2074	#Symbol::delete_package __PACKAGE__;	3203	#Symbol::delete_package __PACKAGE__;
2075		3204
2076	# reload cf.pm	3205	warn "unload completed, starting to reload now";
		3206
2077	warn "reloading cf.pm";	3207	warn "reloading cf.pm";
2078	require cf;	3208	require cf;
2079	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3209	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2080		3210
2081	# load config and database again	3211	warn "loading config and database again";
2082	cf::cfg_load;	3212	cf::cfg_load;
2083	cf::db_load;
2084		3213
2085	# load extensions
2086	warn "load extensions";	3214	warn "loading extensions";
2087	cf::load_extensions;	3215	cf::load_extensions;
2088		3216
2089	# reattach attachments to objects	3217	warn "reattaching attachments to objects/players";
2090	warn "reattach";	3218	_global_reattach; # objects, sockets
2091	_global_reattach;	3219	warn "reattaching attachments to maps";
2092	};	3220	reattach $_ for values %MAP;
		3221	warn "reattaching attachments to players";
		3222	reattach $_ for values %PLAYER;
2093		3223
2094	if ($@) {	3224	warn "leaving sync_job";
		3225
		3226	1
		3227	} or do {
2095	warn $@;	3228	warn $@;
2096	warn "error while reloading, exiting.";	3229	warn "error while reloading, exiting.";
2097	exit 1;	3230	exit 1;
2098	}	3231	};
2099		3232
2100	warn "reloaded successfully";	3233	warn "reloaded";
2101	};	3234	};
2102		3235
2103	#############################################################################	3236	our $RELOAD_WATCHER; # used only during reload
2104		3237
2105	unless ($LINK_MAP) {	3238	sub reload_perl() {
2106	$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.
2107		3241
2108	$LINK_MAP->width (41);	3242	$RELOAD_WATCHER ||= Event->timer (
2109	$LINK_MAP->height (41);	3243	reentrant => 0,
2110	$LINK_MAP->alloc;
2111	$LINK_MAP->path ("{link}");
2112	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2113	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2114
2115	# dirty hack because... archetypes are not yet loaded
2116	Event->timer (
2117	after => 2,	3244	after => 0,
		3245	data => WF_AUTOCANCEL,
2118	cb => sub {	3246	cb => sub {
2119	$_[0]->w->cancel;	3247	do_reload_perl;
2120		3248	undef $RELOAD_WATCHER;
2121	# provide some exits "home"
2122	my $exit = cf::object::new "exit";
2123
2124	$exit->slaying ($EMERGENCY_POSITION->[0]);
2125	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2126	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2127
2128	$LINK_MAP->insert ($exit->clone, 19, 19);
2129	$LINK_MAP->insert ($exit->clone, 19, 20);
2130	$LINK_MAP->insert ($exit->clone, 19, 21);
2131	$LINK_MAP->insert ($exit->clone, 20, 19);
2132	$LINK_MAP->insert ($exit->clone, 20, 21);
2133	$LINK_MAP->insert ($exit->clone, 21, 19);
2134	$LINK_MAP->insert ($exit->clone, 21, 20);
2135	$LINK_MAP->insert ($exit->clone, 21, 21);
2136
2137	$exit->destroy;
2138	});	3249	},
2139		3250	);
2140	$LINK_MAP->{deny_save} = 1;
2141	$LINK_MAP->{deny_reset} = 1;
2142
2143	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2144	}	3251	}
2145
2146	register "<global>", __PACKAGE__;
2147		3252
2148	register_command "reload" => sub {	3253	register_command "reload" => sub {
2149	my ($who, $arg) = @_;	3254	my ($who, $arg) = @_;
2150		3255
2151	if ($who->flag (FLAG_WIZ)) {	3256	if ($who->flag (FLAG_WIZ)) {
2152	$who->message ("start of reload.");
2153	reload;
2154	$who->message ("end of reload.");	3257	$who->message ("reloading server.");
		3258	async { reload_perl };
2155	}	3259	}
2156	};	3260	};
2157		3261
2158	unshift @INC, $LIBDIR;	3262	unshift @INC, $LIBDIR;
2159		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;
2160	$TICK_WATCHER = Event->timer (	3289	$TICK_WATCHER = Event->timer (
2161	reentrant => 0,	3290	reentrant => 0,
		3291	parked => 1,
2162	prio => 0,	3292	prio => 0,
2163	at => $NEXT_TICK || $TICK,	3293	at => $NEXT_TICK || $TICK,
2164	data => WF_AUTOCANCEL,	3294	data => WF_AUTOCANCEL,
2165	cb => sub {	3295	cb => sub {
2166	unless ($FREEZE) {	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
2167	cf::server_tick; # one server iteration	3304	cf::server_tick; # one server iteration
2168	$RUNTIME += $TICK;	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
2169	}	3327	};
2170		3328
		3329	$RUNTIME += $TICK;
2171	$NEXT_TICK += $TICK;	3330	$NEXT_TICK += $TICK;
2172		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
2173	# 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
2174	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3353	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2175		3354
2176	$TICK_WATCHER->at ($NEXT_TICK);	3355	$TICK_WATCHER->at ($NEXT_TICK);
2177	$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
2178	},	3364	},
2179	);	3365	);
2180		3366
		3367	{
2181	IO::AIO::max_poll_time $TICK * 0.2;	3368	BDB::max_poll_time $TICK * 0.1;
2182		3369	$BDB_POLL_WATCHER = Event->io (
2183	Event->io (	3370	reentrant => 0,
2184	fd => IO::AIO::poll_fileno,	3371	fd => BDB::poll_fileno,
2185	poll => 'r',	3372	poll => 'r',
2186	prio => 5,	3373	prio => 0,
2187	data => WF_AUTOCANCEL,
2188	cb => \&IO::AIO::poll_cb,
2189	);
2190
2191	Event->timer (
2192	data => WF_AUTOCANCEL,	3374	data => WF_AUTOCANCEL,
2193	after => 0,	3375	cb => \&BDB::poll_cb,
2194	interval => 10,	3376	);
2195	cb => sub {	3377	BDB::min_parallel 8;
2196	(Coro::unblock_sub {	3378
2197	write_runtime	3379	BDB::set_sync_prepare {
2198	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 $@;
2199	})->();	3413	};
2200	},	3414	}
2201	);	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;
2202		3472
2203	END { cf::emergency_save }	3473	END { cf::emergency_save }
2204		3474
2205	1	3475	1
2206		3476

Diff Legend

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