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

Diff Legend

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