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

Diff Legend

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