ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.139 by root, Fri Jan 5 19:12:03 2007 UTC vs.
Revision 1.330 by elmex, Fri Aug 10 10:35:07 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 $player->send_msg ($channel, $msg, $color, [extra...])
		1378
		1379	=cut
		1380
		1381	sub send_msg {
		1382	my $ns = shift->ns
		1383	or return;
		1384	$ns->send_msg (@_);
		1385	}
		1386
		1387	=item $pl->quit_character
		1388
		1389	Nukes the player without looking back. If logged in, the connection will
		1390	be destroyed. May block for a long time.
		1391
		1392	=cut
		1393
		1394	sub quit_character {
		1395	my ($pl) = @_;
		1396
		1397	my $name = $pl->ob->name;
		1398
		1399	$pl->{deny_save} = 1;
		1400	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1401
		1402	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1403	$pl->deactivate;
		1404	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1405	$pl->ns->destroy if $pl->ns;
		1406
		1407	my $path = playerdir $pl;
		1408	my $temp = "$path~$cf::RUNTIME~deleting~";
		1409	aio_rename $path, $temp;
		1410	delete $cf::PLAYER{$pl->ob->name};
		1411	$pl->destroy;
		1412
		1413	my $prefix = qr<^~\Q$name\E/>;
		1414
		1415	# nuke player maps
		1416	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1417
		1418	IO::AIO::aio_rmtree $temp;
		1419	}
		1420
		1421	=item $pl->kick
		1422
		1423	Kicks a player out of the game. This destroys the connection.
		1424
		1425	=cut
		1426
		1427	sub kick {
		1428	my ($pl, $kicker) = @_;
		1429
		1430	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1431	$pl->killer ("kicked");
		1432	$pl->ns->destroy;
		1433	}
		1434
		1435	=item cf::player::list_logins
		1436
		1437	Returns am arrayref of all valid playernames in the system, can take a
		1438	while and may block, so not sync_job-capable, ever.
		1439
		1440	=cut
		1441
		1442	sub list_logins {
		1443	my $dirs = aio_readdir $PLAYERDIR
		1444	or return [];
		1445
		1446	my @logins;
		1447
		1448	for my $login (@$dirs) {
		1449	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1450	aio_read $fh, 0, 512, my $buf, 0 or next;
		1451	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1452
		1453	utf8::decode $login;
		1454	push @logins, $login;
		1455	}
		1456
		1457	\@logins
		1458	}
		1459
		1460	=item $player->maps
		1461
		1462	Returns an arrayref of map paths that are private for this
		1463	player. May block.
		1464
		1465	=cut
		1466
		1467	sub maps($) {
		1468	my ($pl) = @_;
		1469
		1470	$pl = ref $pl ? $pl->ob->name : $pl;
		1471
		1472	my $files = aio_readdir playerdir $pl
		1473	or return;
		1474
		1475	my @paths;
		1476
		1477	for (@$files) {
		1478	utf8::decode $_;
		1479	next if /\.(?:pl|pst)$/;
		1480	next unless /^$PATH_SEP/o;
		1481
		1482	push @paths, cf::map::normalise "~$pl/$_";
		1483	}
		1484
		1485	\@paths
		1486	}
		1487
		1488	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1489
		1490	Expand crossfire pod fragments into protocol xml.
		1491
		1492	=cut
		1493
		1494	sub expand_cfpod {
		1495	((my $self), (local $_)) = @_;
		1496
		1497	# escape & and <
		1498	s/&/&amp;/g;
		1499	s/(?<![BIUGH])</&lt;/g;
		1500
		1501	# this is buggy, it needs to properly take care of nested <'s
		1502
		1503	1 while
		1504	# replace B<>, I<>, U<> etc.
		1505	s/B<([^\>]*)>/<b>$1<\/b>/
		1506	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1507	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1508	# replace G<male|female> tags
		1509	|| s{G<([^>|]*)\|([^>]*)>}{
		1510	$self->gender ? $2 : $1
		1511	}ge
		1512	# replace H<hint text>
		1513	|| s{H<([^\>]*)>}
		1514	{
		1515	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1516	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1517	"")
		1518	[$self->{hintmode}]
		1519	}ge;
		1520
		1521	# create single paragraphs (very hackish)
		1522	s/(?<=\S)\n(?=\w)/ /g;
		1523
		1524	# compress some whitespace
		1525	s/\s+\n/\n/g; # ws line-ends
		1526	s/\n\n+/\n/g; # double lines
		1527	s/^\n+//; # beginning lines
		1528	s/\n+$//; # ending lines
		1529
		1530	$_
		1531	}
		1532
		1533	sub hintmode {
		1534	$_[0]{hintmode} = $_[1] if @_ > 1;
		1535	$_[0]{hintmode}
		1536	}
		1537
		1538	=item $player->ext_reply ($msgid, @msg)
		1539
		1540	Sends an ext reply to the player.
		1541
		1542	=cut
		1543
		1544	sub ext_reply($$@) {
		1545	my ($self, $id, @msg) = @_;
		1546
		1547	if ($self->ns->extcmd == 2) {
		1548	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
		1549	} elsif ($self->ns->extcmd == 1) {
		1550	#TODO: version 1, remove
		1551	unshift @msg, msgtype => "reply", msgid => $id;
		1552	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1553	}
		1554	}
		1555
		1556	=item $player->ext_msg ($type, @msg)
		1557
		1558	Sends an ext event to the client.
		1559
		1560	=cut
		1561
		1562	sub ext_msg($$@) {
		1563	my ($self, $type, @msg) = @_;
		1564
		1565	$self->ns->ext_msg ($type, @msg);
		1566	}
		1567
		1568	=head3 cf::region
		1569
		1570	=over 4
		1571
		1572	=cut
		1573
		1574	package cf::region;
		1575
		1576	=item cf::region::find_by_path $path
		1577
		1578	Tries to decuce the likely region for a map knowing only its path.
		1579
		1580	=cut
		1581
		1582	sub find_by_path($) {
948	my ($path) = @_;	1583	my ($path) = @_;
949		1584
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1585	my ($match, $specificity);
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955		1586
956	warn "loading '$path' into '$pkg'\n";	1587	for my $region (list) {
957		1588	if ($region->{match} && $path =~ $region->{match}) {
958	open my $fh, "<:utf8", $path	1589	($match, $specificity) = ($region, $region->specificity)
959	or die "$path: $!";	1590	if $region->specificity > $specificity;
960		1591	}
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	# }	1592	}
990		1593
991	# remove commands	1594	$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	}	1595	}
1097		1596
1098	=back	1597	=back
1099
1100		1598
1101	=head3 cf::map	1599	=head3 cf::map
1102		1600
1103	=over 4	1601	=over 4
1104		1602
…		…
1107	package cf::map;	1605	package cf::map;
1108		1606
1109	use Fcntl;	1607	use Fcntl;
1110	use Coro::AIO;	1608	use Coro::AIO;
1111		1609
		1610	use overload
		1611	'""' => \&as_string,
		1612	fallback => 1;
		1613
1112	our $MAX_RESET = 3600;	1614	our $MAX_RESET = 3600;
1113	our $DEFAULT_RESET = 3000;	1615	our $DEFAULT_RESET = 3000;
1114		1616
1115	sub generate_random_map {	1617	sub generate_random_map {
1116	my ($path, $rmp) = @_;	1618	my ($self, $rmp) = @_;
1117
1118	# mit "rum" bekleckern, nicht	1619	# mit "rum" bekleckern, nicht
1119	cf::map::_create_random_map	1620	$self->_create_random_map (
1120	$path,
1121	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1621	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1122	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1622	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1123	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1623	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1124	$rmp->{exit_on_final_map},	1624	$rmp->{exit_on_final_map},
1125	$rmp->{xsize}, $rmp->{ysize},	1625	$rmp->{xsize}, $rmp->{ysize},
1126	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1626	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1127	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1627	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1128	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1628	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1129	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1629	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1130	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1630	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1131	(cf::region::find $rmp->{region})	1631	(cf::region::find $rmp->{region}), $rmp->{custom}
		1632	)
		1633	}
		1634
		1635	=item cf::map->register ($regex, $prio)
		1636
		1637	Register a handler for the map path matching the given regex at the
		1638	givne priority (higher is better, built-in handlers have priority 0, the
		1639	default).
		1640
		1641	=cut
		1642
		1643	sub register {
		1644	my (undef, $regex, $prio) = @_;
		1645	my $pkg = caller;
		1646
		1647	no strict;
		1648	push @{"$pkg\::ISA"}, __PACKAGE__;
		1649
		1650	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1651	}
		1652
		1653	# also paths starting with '/'
		1654	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1655
		1656	sub thawer_merge {
		1657	my ($self, $merge) = @_;
		1658
		1659	# we have to keep some variables in memory intact
		1660	local $self->{path};
		1661	local $self->{load_path};
		1662
		1663	$self->SUPER::thawer_merge ($merge);
		1664	}
		1665
		1666	sub normalise {
		1667	my ($path, $base) = @_;
		1668
		1669	$path = "$path"; # make sure its a string
		1670
		1671	$path =~ s/\.map$//;
		1672
		1673	# map plan:
		1674	#
		1675	# /! non-realised random map exit (special hack!)
		1676	# {... are special paths that are not being touched
		1677	# ?xxx/... are special absolute paths
		1678	# ?random/... random maps
		1679	# /... normal maps
		1680	# ~user/... per-player map of a specific user
		1681
		1682	$path =~ s/$PATH_SEP/\//go;
		1683
		1684	# treat it as relative path if it starts with
		1685	# something that looks reasonable
		1686	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1687	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1688
		1689	$base =~ s{[^/]+/?$}{};
		1690	$path = "$base/$path";
		1691	}
		1692
		1693	for ($path) {
		1694	redo if s{//}{/};
		1695	redo if s{/\.?/}{/};
		1696	redo if s{/[^/]+/\.\./}{/};
		1697	}
		1698
		1699	$path
		1700	}
		1701
		1702	sub new_from_path {
		1703	my (undef, $path, $base) = @_;
		1704
		1705	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1706
		1707	$path = normalise $path, $base;
		1708
		1709	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1710	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1711	my $self = bless cf::map::new, $pkg;
		1712	$self->{path} = $path; $self->path ($path);
		1713	$self->init; # pass $1 etc.
		1714	return $self;
		1715	}
		1716	}
		1717
		1718	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1719	()
		1720	}
		1721
		1722	sub init {
		1723	my ($self) = @_;
		1724
		1725	$self
		1726	}
		1727
		1728	sub as_string {
		1729	my ($self) = @_;
		1730
		1731	"$self->{path}"
		1732	}
		1733
		1734	# the displayed name, this is a one way mapping
		1735	sub visible_name {
		1736	&as_string
		1737	}
		1738
		1739	# the original (read-only) location
		1740	sub load_path {
		1741	my ($self) = @_;
		1742
		1743	"$MAPDIR/$self->{path}.map"
		1744	}
		1745
		1746	# the temporary/swap location
		1747	sub save_path {
		1748	my ($self) = @_;
		1749
		1750	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1751	"$TMPDIR/$path.map"
		1752	}
		1753
		1754	# the unique path, undef == no special unique path
		1755	sub uniq_path {
		1756	my ($self) = @_;
		1757
		1758	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1759	"$UNIQUEDIR/$path"
1132	}	1760	}
1133		1761
1134	# and all this just because we cannot iterate over	1762	# and all this just because we cannot iterate over
1135	# all maps in C++...	1763	# all maps in C++...
1136	sub change_all_map_light {	1764	sub change_all_map_light {
…		…
1138		1766
1139	$_->change_map_light ($change)	1767	$_->change_map_light ($change)
1140	for grep $_->outdoor, values %cf::MAP;	1768	for grep $_->outdoor, values %cf::MAP;
1141	}	1769	}
1142		1770
		1771	sub decay_objects {
		1772	my ($self) = @_;
		1773
		1774	return if $self->{deny_reset};
		1775
		1776	$self->do_decay_objects;
		1777	}
		1778
		1779	sub unlink_save {
		1780	my ($self) = @_;
		1781
		1782	utf8::encode (my $save = $self->save_path);
		1783	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1784	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1785	}
		1786
1143	sub try_load_header($) {	1787	sub load_header_from($) {
1144	my ($path) = @_;	1788	my ($self, $path) = @_;
1145		1789
1146	utf8::encode $path;	1790	utf8::encode $path;
1147	aio_open $path, O_RDONLY, 0	1791	#aio_open $path, O_RDONLY, 0
		1792	# or return;
		1793
		1794	$self->_load_header ($path)
1148	or return;	1795	or return;
1149		1796
1150	my $map = cf::map::new	1797	$self->{load_path} = $path;
		1798
		1799	1
		1800	}
		1801
		1802	sub load_header_orig {
		1803	my ($self) = @_;
		1804
		1805	$self->load_header_from ($self->load_path)
		1806	}
		1807
		1808	sub load_header_temp {
		1809	my ($self) = @_;
		1810
		1811	$self->load_header_from ($self->save_path)
		1812	}
		1813
		1814	sub prepare_temp {
		1815	my ($self) = @_;
		1816
		1817	$self->last_access ((delete $self->{last_access})
		1818	|| $cf::RUNTIME); #d#
		1819	# safety
		1820	$self->{instantiate_time} = $cf::RUNTIME
		1821	if $self->{instantiate_time} > $cf::RUNTIME;
		1822	}
		1823
		1824	sub prepare_orig {
		1825	my ($self) = @_;
		1826
		1827	$self->{load_original} = 1;
		1828	$self->{instantiate_time} = $cf::RUNTIME;
		1829	$self->last_access ($cf::RUNTIME);
		1830	$self->instantiate;
		1831	}
		1832
		1833	sub load_header {
		1834	my ($self) = @_;
		1835
		1836	if ($self->load_header_temp) {
		1837	$self->prepare_temp;
		1838	} else {
		1839	$self->load_header_orig
1151	or return;	1840	or return;
		1841	$self->prepare_orig;
		1842	}
1152		1843
1153	# for better error messages only, will be overwritten	1844	$self->{deny_reset} = 1
1154	$map->path ($path);	1845	if $self->no_reset;
1155		1846
1156	$map->load_header ($path)	1847	$self->default_region (cf::region::find_by_path $self->{path})
1157	or return;	1848	unless $self->default_region;
1158		1849
1159	$map->{load_path} = $path;	1850	1
1160
1161	$map
1162	}	1851	}
1163		1852
1164	sub find;	1853	sub find;
1165	sub find {	1854	sub find {
1166	my ($path, $origin) = @_;	1855	my ($path, $origin) = @_;
1167		1856
1168	#warn "find<$path,$origin>\n";#d#
1169
1170	$path = new cf::path $path, $origin && $origin->path;	1857	$path = normalise $path, $origin && $origin->path;
1171	my $key = $path->as_string;
1172		1858
1173	cf::lock_wait "map_find:$key";	1859	cf::lock_wait "map_find:$path";
1174		1860
1175	$cf::MAP{$key} || do {	1861	$cf::MAP{$path} || do {
1176	my $guard = cf::lock_acquire "map_find:$key";	1862	my $guard = cf::lock_acquire "map_find:$path";
1177		1863	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;	1864	or return;
1197		1865
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;	1866	$map->{last_save} = $cf::RUNTIME;
1210		1867
1211	Coro::cede;	1868	$map->load_header
		1869	or return;
1212		1870
1213	if ($map->should_reset) {	1871	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1872	# doing this can freeze the server in a sync job, obviously
		1873	#$cf::WAIT_FOR_TICK->wait;
1214	$map->reset;	1874	$map->reset;
1215	undef $guard;	1875	undef $guard;
1216	$map = find $path	1876	return find $path;
1217	or return;
1218	}	1877	}
1219		1878
1220	$cf::MAP{$key} = $map	1879	$cf::MAP{$path} = $map
1221	}	1880	}
1222	}	1881	}
		1882
		1883	sub pre_load { }
		1884	sub post_load { }
1223		1885
1224	sub load {	1886	sub load {
1225	my ($self) = @_;	1887	my ($self) = @_;
1226		1888
		1889	local $self->{deny_reset} = 1; # loading can take a long time
		1890
1227	my $path = $self->{path};	1891	my $path = $self->{path};
		1892
		1893	{
1228	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1894	my $guard = cf::lock_acquire "map_load:$path";
1229		1895
1230	return if $self->in_memory != cf::MAP_SWAPPED;	1896	return if $self->in_memory != cf::MAP_SWAPPED;
1231		1897
1232	$self->in_memory (cf::MAP_LOADING);	1898	$self->in_memory (cf::MAP_LOADING);
1233		1899
1234	$self->alloc;	1900	$self->alloc;
		1901
		1902	$self->pre_load;
		1903	Coro::cede;
		1904
1235	$self->load_objects ($self->{load_path}, 1)	1905	$self->_load_objects ($self->{load_path}, 1)
1236	or return;	1906	or return;
1237		1907
1238	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1908	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1239	if delete $self->{load_original};	1909	if delete $self->{load_original};
1240		1910
1241	if (my $uniq = $path->uniq_path) {	1911	if (my $uniq = $self->uniq_path) {
1242	utf8::encode $uniq;	1912	utf8::encode $uniq;
1243	if (aio_open $uniq, O_RDONLY, 0) {	1913	if (aio_open $uniq, O_RDONLY, 0) {
1244	$self->clear_unique_items;	1914	$self->clear_unique_items;
1245	$self->load_objects ($uniq, 0);	1915	$self->_load_objects ($uniq, 0);
1246	}	1916	}
1247	}	1917	}
1248		1918
1249	Coro::cede;	1919	Coro::cede;
1250
1251	# now do the right thing for maps	1920	# now do the right thing for maps
1252	$self->link_multipart_objects;	1921	$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)	1922	$self->difficulty ($self->estimate_difficulty)
1263	unless $self->difficulty;	1923	unless $self->difficulty;
		1924	Coro::cede;
		1925
		1926	unless ($self->{deny_activate}) {
		1927	$self->decay_objects;
		1928	$self->fix_auto_apply;
		1929	$self->update_buttons;
		1930	Coro::cede;
		1931	$self->set_darkness_map;
		1932	Coro::cede;
1264	$self->activate;	1933	$self->activate;
1265	}	1934	}
1266		1935
1267	Coro::cede;	1936	$self->{last_save} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
1268		1938
1269	$self->in_memory (cf::MAP_IN_MEMORY);	1939	$self->in_memory (cf::MAP_IN_MEMORY);
		1940	}
		1941
		1942	$self->post_load;
		1943	}
		1944
		1945	sub customise_for {
		1946	my ($self, $ob) = @_;
		1947
		1948	return find "~" . $ob->name . "/" . $self->{path}
		1949	if $self->per_player;
		1950
		1951	# return find "?party/" . $ob->name . "/" . $self->{path}
		1952	# if $self->per_party;
		1953
		1954	$self
		1955	}
		1956
		1957	# find and load all maps in the 3x3 area around a map
		1958	sub load_diag {
		1959	my ($map) = @_;
		1960
		1961	my @diag; # diagonal neighbours
		1962
		1963	for (0 .. 3) {
		1964	my $neigh = $map->tile_path ($_)
		1965	or next;
		1966	$neigh = find $neigh, $map
		1967	or next;
		1968	$neigh->load;
		1969
		1970	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1971	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1972	}
		1973
		1974	for (@diag) {
		1975	my $neigh = find @$_
		1976	or next;
		1977	$neigh->load;
		1978	}
1270	}	1979	}
1271		1980
1272	sub find_sync {	1981	sub find_sync {
1273	my ($path, $origin) = @_;	1982	my ($path, $origin) = @_;
1274		1983
1275	cf::sync_job {	1984	cf::sync_job { find $path, $origin }
1276	my $map = cf::map::find $path, $origin;
1277	$map
1278	}
1279	}	1985	}
1280		1986
1281	sub do_load_sync {	1987	sub do_load_sync {
1282	my ($map) = @_;	1988	my ($map) = @_;
1283		1989
1284	cf::sync_job { $map->load };	1990	cf::sync_job { $map->load };
1285	}	1991	}
1286		1992
		1993	our %MAP_PREFETCH;
		1994	our $MAP_PREFETCHER = undef;
		1995
		1996	sub find_async {
		1997	my ($path, $origin) = @_;
		1998
		1999	$path = normalise $path, $origin && $origin->{path};
		2000
		2001	if (my $map = $cf::MAP{$path}) {
		2002	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		2003	}
		2004
		2005	undef $MAP_PREFETCH{$path};
		2006	$MAP_PREFETCHER ||= cf::async {
		2007	while (%MAP_PREFETCH) {
		2008	for my $path (keys %MAP_PREFETCH) {
		2009	if (my $map = find $path) {
		2010	$map->load;
		2011	}
		2012
		2013	delete $MAP_PREFETCH{$path};
		2014	}
		2015	}
		2016	undef $MAP_PREFETCHER;
		2017	};
		2018	$MAP_PREFETCHER->prio (6);
		2019
		2020	()
		2021	}
		2022
1287	sub save {	2023	sub save {
1288	my ($self) = @_;	2024	my ($self) = @_;
1289		2025
1290	my $lock = cf::lock_acquire "map_data:" . $self->path;	2026	my $lock = cf::lock_acquire "map_data:" . $self->path;
1291		2027
1292	$self->{last_save} = $cf::RUNTIME;	2028	$self->{last_save} = $cf::RUNTIME;
1293		2029
1294	return unless $self->dirty;	2030	return unless $self->dirty;
1295		2031
1296	my $save = $self->{path}->save_path; utf8::encode $save;	2032	my $save = $self->save_path; utf8::encode $save;
1297	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2033	my $uniq = $self->uniq_path; utf8::encode $uniq;
1298		2034
1299	$self->{load_path} = $save;	2035	$self->{load_path} = $save;
1300		2036
1301	return if $self->{deny_save};	2037	return if $self->{deny_save};
1302		2038
1303	local $self->{last_access} = $self->last_access;#d#	2039	local $self->{last_access} = $self->last_access;#d#
1304		2040
		2041	cf::async {
		2042	$_->contr->save for $self->players;
		2043	};
		2044
1305	if ($uniq) {	2045	if ($uniq) {
1306	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2046	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1307	$self->save_objects ($uniq, cf::IO_UNIQUES);	2047	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1308	} else {	2048	} else {
1309	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2049	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1310	}	2050	}
1311	}	2051	}
1312		2052
1313	sub swap_out {	2053	sub swap_out {
1314	my ($self) = @_;	2054	my ($self) = @_;
…		…
1328		2068
1329	sub reset_at {	2069	sub reset_at {
1330	my ($self) = @_;	2070	my ($self) = @_;
1331		2071
1332	# TODO: safety, remove and allow resettable per-player maps	2072	# TODO: safety, remove and allow resettable per-player maps
1333	return 1e99 if $self->{path}{user_rel};
1334	return 1e99 if $self->{deny_reset};	2073	return 1e99 if $self->{deny_reset};
1335		2074
1336	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2075	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1337	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2076	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1338		2077
…		…
1343	my ($self) = @_;	2082	my ($self) = @_;
1344		2083
1345	$self->reset_at <= $cf::RUNTIME	2084	$self->reset_at <= $cf::RUNTIME
1346	}	2085	}
1347		2086
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 {	2087	sub reset {
1370	my ($self) = @_;	2088	my ($self) = @_;
1371		2089
1372	my $lock = cf::lock_acquire "map_data:" . $self->path;	2090	my $lock = cf::lock_acquire "map_data:$self->{path}";
1373		2091
1374	return if $self->players;	2092	return if $self->players;
1375	return if $self->{path}{user_rel};#d#
1376		2093
1377	warn "resetting map ", $self->path;#d#	2094	warn "resetting map ", $self->path;
		2095
		2096	$self->in_memory (cf::MAP_SWAPPED);
		2097
		2098	# need to save uniques path
		2099	unless ($self->{deny_save}) {
		2100	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2101
		2102	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2103	if $uniq;
		2104	}
1378		2105
1379	delete $cf::MAP{$self->path};	2106	delete $cf::MAP{$self->path};
		2107
		2108	$self->clear;
1380		2109
1381	$_->clear_links_to ($self) for values %cf::MAP;	2110	$_->clear_links_to ($self) for values %cf::MAP;
1382		2111
1383	$self->unlink_save;	2112	$self->unlink_save;
1384	$self->destroy;	2113	$self->destroy;
…		…
1387	my $nuke_counter = "aaaa";	2116	my $nuke_counter = "aaaa";
1388		2117
1389	sub nuke {	2118	sub nuke {
1390	my ($self) = @_;	2119	my ($self) = @_;
1391		2120
		2121	delete $cf::MAP{$self->path};
		2122
		2123	$self->unlink_save;
		2124
		2125	bless $self, "cf::map";
		2126	delete $self->{deny_reset};
1392	$self->{deny_save} = 1;	2127	$self->{deny_save} = 1;
1393	$self->reset_timeout (1);	2128	$self->reset_timeout (1);
1394	$self->rename ("{nuke}/" . ($nuke_counter++));	2129	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2130
		2131	$cf::MAP{$self->path} = $self;
		2132
1395	$self->reset; # polite request, might not happen	2133	$self->reset; # polite request, might not happen
1396	}	2134	}
1397		2135
1398	sub customise_for {	2136	=item $maps = cf::map::tmp_maps
1399	my ($map, $ob) = @_;
1400		2137
1401	if ($map->per_player) {	2138	Returns an arrayref with all map paths of currently instantiated and saved
1402	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2139	maps. May block.
		2140
		2141	=cut
		2142
		2143	sub tmp_maps() {
1403	}	2144	[
1404		2145	map {
1405	$map	2146	utf8::decode $_;
		2147	/\.map$/
		2148	? normalise $_
		2149	: ()
		2150	} @{ aio_readdir $TMPDIR or [] }
		2151	]
1406	}	2152	}
1407		2153
1408	sub emergency_save {	2154	=item $maps = cf::map::random_maps
1409	my $freeze_guard = cf::freeze_mainloop;
1410		2155
1411	warn "enter emergency map save\n";	2156	Returns an arrayref with all map paths of currently instantiated and saved
		2157	random maps. May block.
1412		2158
1413	cf::sync_job {	2159	=cut
1414	warn "begin emergency map save\n";
1415	$_->save for values %cf::MAP;
1416	};
1417		2160
1418	warn "end emergency map save\n";	2161	sub random_maps() {
		2162	[
		2163	map {
		2164	utf8::decode $_;
		2165	/\.map$/
		2166	? normalise "?random/$_"
		2167	: ()
		2168	} @{ aio_readdir $RANDOMDIR or [] }
		2169	]
		2170	}
		2171
		2172	=item cf::map::unique_maps
		2173
		2174	Returns an arrayref of paths of all shared maps that have
		2175	instantiated unique items. May block.
		2176
		2177	=cut
		2178
		2179	sub unique_maps() {
		2180	[
		2181	map {
		2182	utf8::decode $_;
		2183	/\.map$/
		2184	? normalise $_
		2185	: ()
		2186	} @{ aio_readdir $UNIQUEDIR or [] }
		2187	]
1419	}	2188	}
1420		2189
1421	package cf;	2190	package cf;
1422		2191
1423	=back	2192	=back
1424		2193
		2194	=head3 cf::object
		2195
		2196	=cut
		2197
		2198	package cf::object;
		2199
		2200	=over 4
		2201
		2202	=item $ob->inv_recursive
		2203
		2204	Returns the inventory of the object _and_ their inventories, recursively.
		2205
		2206	=cut
		2207
		2208	sub inv_recursive_;
		2209	sub inv_recursive_ {
		2210	map { $_, inv_recursive_ $_->inv } @_
		2211	}
		2212
		2213	sub inv_recursive {
		2214	inv_recursive_ inv $_[0]
		2215	}
		2216
		2217	package cf;
		2218
		2219	=back
1425		2220
1426	=head3 cf::object::player	2221	=head3 cf::object::player
1427		2222
1428	=over 4	2223	=over 4
1429		2224
…		…
1443		2238
1444	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2239	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1445		2240
1446	if ($self->{record_replies}) {	2241	if ($self->{record_replies}) {
1447	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2242	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2243
1448	} else {	2244	} else {
		2245	my $pl = $self->contr;
		2246
		2247	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2248	my $dialog = $pl->{npc_dialog};
		2249	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2250
		2251	} else {
1449	$msg = $npc->name . " says: $msg" if $npc;	2252	$msg = $npc->name . " says: $msg" if $npc;
1450	$self->message ($msg, $flags);	2253	$self->message ($msg, $flags);
		2254	}
1451	}	2255	}
		2256	}
		2257
		2258	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2259
		2260	=cut
		2261
		2262	sub cf::object::send_msg {
		2263	my $pl = shift->contr
		2264	or return;
		2265	$pl->send_msg (@_);
1452	}	2266	}
1453		2267
1454	=item $player_object->may ("access")	2268	=item $player_object->may ("access")
1455		2269
1456	Returns wether the given player is authorized to access resource "access"	2270	Returns wether the given player is authorized to access resource "access"
…		…
1469		2283
1470	=item $player_object->enter_link	2284	=item $player_object->enter_link
1471		2285
1472	Freezes the player and moves him/her to a special map (C<{link}>).	2286	Freezes the player and moves him/her to a special map (C<{link}>).
1473		2287
1474	The player should be reaosnably safe there for short amounts of time. You	2288	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.	2289	I<MUST> call C<leave_link> as soon as possible, though.
1476		2290
		2291	Will never block.
		2292
1477	=item $player_object->leave_link ($map, $x, $y)	2293	=item $player_object->leave_link ($map, $x, $y)
1478		2294
1479	Moves the player out of the specila link map onto the given map. If the	2295	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	2296	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,	2297	to the location he/she was before the call to C<enter_link>, or, if that
1482	to the emergency map position.	2298	fails, to the emergency map position.
1483		2299
1484	Might block.	2300	Might block.
1485		2301
1486	=cut	2302	=cut
		2303
		2304	sub link_map {
		2305	unless ($LINK_MAP) {
		2306	$LINK_MAP = cf::map::find "{link}"
		2307	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2308	$LINK_MAP->load;
		2309	}
		2310
		2311	$LINK_MAP
		2312	}
1487		2313
1488	sub cf::object::player::enter_link {	2314	sub cf::object::player::enter_link {
1489	my ($self) = @_;	2315	my ($self) = @_;
1490		2316
1491	$self->deactivate_recursive;	2317	$self->deactivate_recursive;
1492		2318
1493	return if $self->map == $LINK_MAP;	2319	return if UNIVERSAL::isa $self->map, "ext::map_link";
1494		2320
1495	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2321	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1496	if $self->map;	2322	if $self->map && $self->map->{path} ne "{link}";
1497		2323
1498	$self->enter_map ($LINK_MAP, 20, 20);	2324	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1499	}	2325	}
1500		2326
1501	sub cf::object::player::leave_link {	2327	sub cf::object::player::leave_link {
1502	my ($self, $map, $x, $y) = @_;	2328	my ($self, $map, $x, $y) = @_;
		2329
		2330	return unless $self->contr->active;
1503		2331
1504	my $link_pos = delete $self->{_link_pos};	2332	my $link_pos = delete $self->{_link_pos};
1505		2333
1506	unless ($map) {	2334	unless ($map) {
1507	# restore original map position	2335	# restore original map position
…		…
1521	# use -1 or undef as default coordinates, not 0, 0	2349	# use -1 or undef as default coordinates, not 0, 0
1522	($x, $y) = ($map->enter_x, $map->enter_y)	2350	($x, $y) = ($map->enter_x, $map->enter_y)
1523	if $x <=0 && $y <= 0;	2351	if $x <=0 && $y <= 0;
1524		2352
1525	$map->load;	2353	$map->load;
		2354	$map->load_diag;
1526		2355
		2356	return unless $self->contr->active;
1527	$self->activate_recursive;	2357	$self->activate_recursive;
		2358
		2359	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1528	$self->enter_map ($map, $x, $y);	2360	$self->enter_map ($map, $x, $y);
1529	}	2361	}
1530		2362
1531	cf::player->attach (	2363	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1532	on_logout => sub {
1533	my ($pl) = @_;
1534		2364
1535	# abort map switching before logout	2365	Moves the player to the given map-path and coordinates by first freezing
1536	if ($pl->ob->{_link_pos}) {	2366	her, loading and preparing them map, calling the provided $check callback
1537	cf::sync_job {	2367	that has to return the map if sucecssful, and then unfreezes the player on
1538	$pl->ob->leave_link	2368	the new (success) or old (failed) map position. In either case, $done will
1539	};	2369	be called at the end of this process.
1540	}
1541	},
1542	on_login => sub {
1543	my ($pl) = @_;
1544		2370
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	2371	=cut
		2372
		2373	our $GOTOGEN;
1563		2374
1564	sub cf::object::player::goto {	2375	sub cf::object::player::goto {
1565	my ($self, $path, $x, $y) = @_;	2376	my ($self, $path, $x, $y, $check, $done) = @_;
		2377
		2378	# do generation counting so two concurrent goto's will be executed in-order
		2379	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1566		2380
1567	$self->enter_link;	2381	$self->enter_link;
1568		2382
1569	(Coro::async_pool {	2383	(async {
1570	$path = new cf::path $path;	2384	my $map = eval {
1571
1572	my $map = cf::map::find $path->as_string;	2385	my $map = cf::map::find $path;
		2386
		2387	if ($map) {
1573	$map = $map->customise_for ($self) if $map;	2388	$map = $map->customise_for ($self);
1574		2389	$map = $check->($map) if $check && $map;
1575	# warn "entering ", $map->path, " at ($x, $y)\n"	2390	} else {
1576	# if $map;
1577
1578	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2391	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2392	}
1579		2393
		2394	$map
		2395	};
		2396
		2397	if ($@) {
		2398	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2399	LOG llevError | logBacktrace, Carp::longmess $@;
		2400	}
		2401
		2402	if ($gen == $self->{_goto_generation}) {
		2403	delete $self->{_goto_generation};
1580	$self->leave_link ($map, $x, $y);	2404	$self->leave_link ($map, $x, $y);
		2405	}
		2406
		2407	$done->() if $done;
1581	})->prio (1);	2408	})->prio (1);
1582	}	2409	}
1583		2410
1584	=item $player_object->enter_exit ($exit_object)	2411	=item $player_object->enter_exit ($exit_object)
1585		2412
…		…
1587		2414
1588	sub parse_random_map_params {	2415	sub parse_random_map_params {
1589	my ($spec) = @_;	2416	my ($spec) = @_;
1590		2417
1591	my $rmp = { # defaults	2418	my $rmp = { # defaults
1592	xsize => 10,	2419	xsize => (cf::rndm 15, 40),
1593	ysize => 10,	2420	ysize => (cf::rndm 15, 40),
		2421	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2422	#layout => string,
1594	};	2423	};
1595		2424
1596	for (split /\n/, $spec) {	2425	for (split /\n/, $spec) {
1597	my ($k, $v) = split /\s+/, $_, 2;	2426	my ($k, $v) = split /\s+/, $_, 2;
1598		2427
…		…
1602	$rmp	2431	$rmp
1603	}	2432	}
1604		2433
1605	sub prepare_random_map {	2434	sub prepare_random_map {
1606	my ($exit) = @_;	2435	my ($exit) = @_;
		2436
		2437	my $guard = cf::lock_acquire "exit_prepare:$exit";
1607		2438
1608	# all this does is basically replace the /! path by	2439	# all this does is basically replace the /! path by
1609	# a new random map path (?random/...) with a seed	2440	# a new random map path (?random/...) with a seed
1610	# that depends on the exit object	2441	# that depends on the exit object
1611		2442
1612	my $rmp = parse_random_map_params $exit->msg;	2443	my $rmp = parse_random_map_params $exit->msg;
1613		2444
1614	if ($exit->map) {	2445	if ($exit->map) {
1615	$rmp->{region} = $exit->map->region_name;	2446	$rmp->{region} = $exit->region->name;
1616	$rmp->{origin_map} = $exit->map->path;	2447	$rmp->{origin_map} = $exit->map->path;
1617	$rmp->{origin_x} = $exit->x;	2448	$rmp->{origin_x} = $exit->x;
1618	$rmp->{origin_y} = $exit->y;	2449	$rmp->{origin_y} = $exit->y;
1619	}	2450	}
1620		2451
1621	$rmp->{random_seed} ||= $exit->random_seed;	2452	$rmp->{random_seed} ||= $exit->random_seed;
1622		2453
1623	my $data = cf::to_json $rmp;	2454	my $data = cf::to_json $rmp;
1624	my $md5 = Digest::MD5::md5_hex $data;	2455	my $md5 = Digest::MD5::md5_hex $data;
		2456	my $meta = "$RANDOMDIR/$md5.meta";
1625		2457
1626	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2458	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1627	aio_write $fh, 0, (length $data), $data, 0;	2459	aio_write $fh, 0, (length $data), $data, 0;
		2460	undef $fh;
		2461	aio_rename "$meta~", $meta;
1628		2462
1629	$exit->slaying ("?random/$md5");	2463	$exit->slaying ("?random/$md5");
1630	$exit->msg (undef);	2464	$exit->msg (undef);
1631	}	2465	}
1632	}	2466	}
…		…
1634	sub cf::object::player::enter_exit {	2468	sub cf::object::player::enter_exit {
1635	my ($self, $exit) = @_;	2469	my ($self, $exit) = @_;
1636		2470
1637	return unless $self->type == cf::PLAYER;	2471	return unless $self->type == cf::PLAYER;
1638		2472
		2473	if ($exit->slaying eq "/!") {
		2474	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2475	# the problem is that $exit might not survive long enough
		2476	# so it needs to be done right now, right here
		2477	cf::sync_job { prepare_random_map $exit };
		2478	}
		2479
		2480	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2481	my $hp = $exit->stats->hp;
		2482	my $sp = $exit->stats->sp;
		2483
1639	$self->enter_link;	2484	$self->enter_link;
1640		2485
1641	(Coro::async_pool {	2486	# if exit is damned, update players death & WoR home-position
		2487	$self->contr->savebed ($slaying, $hp, $sp)
		2488	if $exit->flag (FLAG_DAMNED);
		2489
		2490	(async {
1642	$self->deactivate_recursive; # just to be sure	2491	$self->deactivate_recursive; # just to be sure
1643	unless (eval {	2492	unless (eval {
1644	prepare_random_map $exit	2493	$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		2494
1650	1;	2495	1;
1651	}) {	2496	}) {
1652	$self->message ("Something went wrong deep within the crossfire server. "	2497	$self->message ("Something went wrong deep within the crossfire server. "
1653	. "I'll try to bring you back to the map you were before. "	2498	. "I'll try to bring you back to the map you were before. "
1654	. "Please report this to the dungeon master",	2499	. "Please report this to the dungeon master!",
1655	cf::NDI_UNIQUE | cf::NDI_RED);	2500	cf::NDI_UNIQUE | cf::NDI_RED);
1656		2501
1657	warn "ERROR in enter_exit: $@";	2502	warn "ERROR in enter_exit: $@";
1658	$self->leave_link;	2503	$self->leave_link;
1659	}	2504	}
1660	})->prio (1);	2505	})->prio (1);
…		…
1673		2518
1674	sub cf::client::send_drawinfo {	2519	sub cf::client::send_drawinfo {
1675	my ($self, $text, $flags) = @_;	2520	my ($self, $text, $flags) = @_;
1676		2521
1677	utf8::encode $text;	2522	utf8::encode $text;
1678	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2523	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1679	}	2524	}
1680		2525
		2526	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2527
		2528	Send a drawinfo or msg packet to the client, formatting the msg for the
		2529	client if neccessary. C<$type> should be a string identifying the type of
		2530	the message, with C<log> being the default. If C<$color> is negative, suppress
		2531	the message unless the client supports the msg packet.
		2532
		2533	=cut
		2534
		2535	sub cf::client::send_msg {
		2536	my ($self, $channel, $msg, $color, @extra) = @_;
		2537
		2538	$msg = $self->pl->expand_cfpod ($msg);
		2539
		2540	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2541
		2542	if (ref $channel) {
		2543	# send meta info to client, if not yet sent
		2544	unless (exists $self->{channel}{$channel->{id}}) {
		2545	$self->{channel}{$channel->{id}} = $channel;
		2546	$self->ext_msg (channel_info => $channel);
		2547	}
		2548
		2549	$channel = $channel->{id};
		2550	}
		2551
		2552	return unless @extra || length $msg;
		2553
		2554	if ($self->can_msg) {
		2555	# default colour, mask it out
		2556	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2557	if $color & cf::NDI_DEF;
		2558
		2559	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2560	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2561	} else {
		2562	if ($color >= 0) {
		2563	# replace some tags by gcfclient-compatible ones
		2564	for ($msg) {
		2565	1 while
		2566	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2567	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2568	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2569	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2570	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2571	}
		2572
		2573	$color &= cf::NDI_COLOR_MASK;
		2574
		2575	utf8::encode $msg;
		2576
		2577	if (0 && $msg =~ /\[/) {
		2578	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2579	} else {
		2580	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2581	$self->send_packet ("drawinfo $color $msg")
		2582	}
		2583	}
		2584	}
		2585	}
		2586
		2587	=item $client->ext_msg ($type, @msg)
		2588
		2589	Sends an ext event to the client.
		2590
		2591	=cut
		2592
		2593	sub cf::client::ext_msg($$@) {
		2594	my ($self, $type, @msg) = @_;
		2595
		2596	my $extcmd = $self->extcmd;
		2597
		2598	if ($extcmd == 2) {
		2599	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2600	} elsif ($extcmd == 1) { # TODO: remove
		2601	push @msg, msgtype => "event_$type";
		2602	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2603	}
		2604	}
1681		2605
1682	=item $success = $client->query ($flags, "text", \&cb)	2606	=item $success = $client->query ($flags, "text", \&cb)
1683		2607
1684	Queues a query to the client, calling the given callback with	2608	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>,	2609	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>.	2610	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1687		2611
1688	Queries can fail, so check the return code. Or don't, as queries will become	2612	Queries can fail, so check the return code. Or don't, as queries will
1689	reliable at some point in the future.	2613	become reliable at some point in the future.
1690		2614
1691	=cut	2615	=cut
1692		2616
1693	sub cf::client::query {	2617	sub cf::client::query {
1694	my ($self, $flags, $text, $cb) = @_;	2618	my ($self, $flags, $text, $cb) = @_;
…		…
1702	utf8::encode $text;	2626	utf8::encode $text;
1703	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2627	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1704		2628
1705	$self->send_packet ($self->{query_queue}[0][0])	2629	$self->send_packet ($self->{query_queue}[0][0])
1706	if @{ $self->{query_queue} } == 1;	2630	if @{ $self->{query_queue} } == 1;
		2631
		2632	1
1707	}	2633	}
1708		2634
1709	cf::client->attach (	2635	cf::client->attach (
		2636	on_connect => sub {
		2637	my ($ns) = @_;
		2638
		2639	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2640	},
1710	on_reply => sub {	2641	on_reply => sub {
1711	my ($ns, $msg) = @_;	2642	my ($ns, $msg) = @_;
1712		2643
1713	# this weird shuffling is so that direct followup queries	2644	# this weird shuffling is so that direct followup queries
1714	# get handled first	2645	# get handled first
1715	my $queue = delete $ns->{query_queue}	2646	my $queue = delete $ns->{query_queue}
1716	or return; # be conservative, not sure how that can happen, but we saw a crash here	2647	or return; # be conservative, not sure how that can happen, but we saw a crash here
1717		2648
1718	(shift @$queue)->[1]->($msg);	2649	(shift @$queue)->[1]->($msg);
		2650	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1719		2651
1720	push @{ $ns->{query_queue} }, @$queue;	2652	push @{ $ns->{query_queue} }, @$queue;
1721		2653
1722	if (@{ $ns->{query_queue} } == @$queue) {	2654	if (@{ $ns->{query_queue} } == @$queue) {
1723	if (@$queue) {	2655	if (@$queue) {
…		…
1725	} else {	2657	} else {
1726	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2658	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1727	}	2659	}
1728	}	2660	}
1729	},	2661	},
		2662	on_exticmd => sub {
		2663	my ($ns, $buf) = @_;
		2664
		2665	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2666
		2667	if (ref $msg) {
		2668	my ($type, $reply, @payload) =
		2669	"ARRAY" eq ref $msg
		2670	? @$msg
		2671	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2672
		2673	if (my $cb = $EXTICMD{$type}) {
		2674	my @reply = $cb->($ns, @payload);
		2675
		2676	$ns->ext_reply ($reply, @reply)
		2677	if $reply;
		2678	}
		2679	} else {
		2680	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2681	}
		2682
		2683	cf::override;
		2684	},
1730	);	2685	);
1731		2686
1732	=item $client->coro (\&cb)	2687	=item $client->async (\&cb)
1733		2688
1734	Create a new coroutine, running the specified callback. The coroutine will	2689	Create a new coroutine, running the specified callback. The coroutine will
1735	be automatically cancelled when the client gets destroyed (e.g. on logout,	2690	be automatically cancelled when the client gets destroyed (e.g. on logout,
1736	or loss of connection).	2691	or loss of connection).
1737		2692
1738	=cut	2693	=cut
1739		2694
1740	sub cf::client::coro {	2695	sub cf::client::async {
1741	my ($self, $cb) = @_;	2696	my ($self, $cb) = @_;
1742		2697
1743	my $coro = &Coro::async_pool ($cb);	2698	my $coro = &Coro::async ($cb);
1744		2699
1745	$coro->on_destroy (sub {	2700	$coro->on_destroy (sub {
1746	delete $self->{_coro}{$coro+0};	2701	delete $self->{_coro}{$coro+0};
1747	});	2702	});
1748		2703
…		…
1775	our $safe = new Safe "safe";	2730	our $safe = new Safe "safe";
1776	our $safe_hole = new Safe::Hole;	2731	our $safe_hole = new Safe::Hole;
1777		2732
1778	$SIG{FPE} = 'IGNORE';	2733	$SIG{FPE} = 'IGNORE';
1779		2734
1780	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2735	$safe->permit_only (Opcode::opset qw(
		2736	:base_core :base_mem :base_orig :base_math
		2737	grepstart grepwhile mapstart mapwhile
		2738	sort time
		2739	));
1781		2740
1782	# here we export the classes and methods available to script code	2741	# here we export the classes and methods available to script code
1783		2742
1784	=pod	2743	=pod
1785		2744
1786	The following fucntions and emthods are available within a safe environment:	2745	The following functions and methods are available within a safe environment:
1787		2746
1788	cf::object contr pay_amount pay_player map	2747	cf::object
		2748	contr pay_amount pay_player map x y force_find force_add
		2749	insert remove name archname title slaying race
		2750
1789	cf::object::player player	2751	cf::object::player
1790	cf::player peaceful	2752	player
1791	cf::map trigger	2753
		2754	cf::player
		2755	peaceful
		2756
		2757	cf::map
		2758	trigger
1792		2759
1793	=cut	2760	=cut
1794		2761
1795	for (	2762	for (
1796	["cf::object" => qw(contr pay_amount pay_player map)],	2763	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2764	insert remove inv name archname title slaying race)],
1797	["cf::object::player" => qw(player)],	2765	["cf::object::player" => qw(player)],
1798	["cf::player" => qw(peaceful)],	2766	["cf::player" => qw(peaceful)],
1799	["cf::map" => qw(trigger)],	2767	["cf::map" => qw(trigger)],
1800	) {	2768	) {
1801	no strict 'refs';	2769	no strict 'refs';
…		…
1872	=back	2840	=back
1873		2841
1874	=cut	2842	=cut
1875		2843
1876	#############################################################################	2844	#############################################################################
		2845	# the server's init and main functions
1877		2846
1878	=head2 EXTENSION DATABASE SUPPORT	2847	sub load_facedata($) {
		2848	my ($path) = @_;
1879		2849
1880	Crossfire maintains a very simple database for extension use. It can	2850	warn "loading facedata from $path\n";
1881	currently store anything that can be serialised using Storable, which
1882	excludes objects.
1883		2851
1884	The parameter C<$family> should best start with the name of the extension	2852	my $facedata;
1885	using it, it should be unique.	2853	0 < aio_load $path, $facedata
		2854	or die "$path: $!";
1886		2855
1887	=over 4	2856	$facedata = Coro::Storable::thaw $facedata;
1888		2857
1889	=item $hashref = cf::db_get $family	2858	$facedata->{version} == 2
		2859	or cf::cleanup "$path: version mismatch, cannot proceed.";
1890		2860
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	}	2861	{
		2862	my $faces = $facedata->{faceinfo};
1927		2863
1928	my $pid;	2864	while (my ($face, $info) = each %$faces) {
		2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2866	cf::face::set_visibility $idx, $info->{visibility};
		2867	cf::face::set_magicmap $idx, $info->{magicmap};
		2868	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2869	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1929		2870
1930	sub db_save() {	2871	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	},	2872	}
1976	);
1977	}
1978		2873
1979	#############################################################################	2874	while (my ($face, $info) = each %$faces) {
1980	# the server's main()	2875	next unless $info->{smooth};
		2876	my $idx = cf::face::find $face
		2877	or next;
		2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
		2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2881	} else {
		2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2883	}
		2884
		2885	cf::cede_to_tick;
		2886	}
		2887	}
		2888
		2889	{
		2890	my $anims = $facedata->{animinfo};
		2891
		2892	while (my ($anim, $info) = each %$anims) {
		2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2894	cf::cede_to_tick;
		2895	}
		2896
		2897	cf::anim::invalidate_all; # d'oh
		2898	}
		2899
		2900	{
		2901	# TODO: for gcfclient pleasure, we should give resources
		2902	# that gcfclient doesn't grok a >10000 face index.
		2903	my $res = $facedata->{resource};
		2904	my $enc = JSON::XS->new->utf8->canonical;
		2905
		2906	my $soundconf = delete $res->{"res/sound.conf"};
		2907
		2908	while (my ($name, $info) = each %$res) {
		2909	my $meta = $enc->encode ({
		2910	name => $name,
		2911	%{ $info->{meta} || {} },
		2912	});
		2913
		2914	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2915
		2916	if ($info->{type} & 1) {
		2917	# prepend meta info
		2918
		2919	my $data = pack "(w/a*)*", $meta, $info->{data};
		2920	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2921
		2922	cf::face::set_data $idx, 0, $data, $chk;
		2923	} else {
		2924	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2925	}
		2926
		2927	cf::face::set_type $idx, $info->{type};
		2928
		2929	cf::cede_to_tick;
		2930	}
		2931
		2932	if ($soundconf) {
		2933	$soundconf = $enc->decode (delete $soundconf->{data});
		2934
		2935	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2936	my $sound = $soundconf->{compat}[$_]
		2937	or next;
		2938
		2939	my $face = cf::face::find "sound/$sound->[1]";
		2940	cf::sound::set $sound->[0] => $face;
		2941	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2942	}
		2943
		2944	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2945	my $face = cf::face::find "sound/$v";
		2946	cf::sound::set $k => $face;
		2947	}
		2948	}
		2949	}
		2950
		2951	1
		2952	}
		2953
		2954	register_exticmd fx_want => sub {
		2955	my ($ns, $want) = @_;
		2956
		2957	while (my ($k, $v) = each %$want) {
		2958	$ns->fx_want ($k, $v);
		2959	}
		2960	};
		2961
		2962	sub reload_regions {
		2963	load_resource_file "$MAPDIR/regions"
		2964	or die "unable to load regions file\n";
		2965
		2966	for (cf::region::list) {
		2967	$_->{match} = qr/$_->{match}/
		2968	if exists $_->{match};
		2969	}
		2970	}
		2971
		2972	sub reload_facedata {
		2973	load_facedata "$DATADIR/facedata"
		2974	or die "unable to load facedata\n";
		2975	}
		2976
		2977	sub reload_archetypes {
		2978	load_resource_file "$DATADIR/archetypes"
		2979	or die "unable to load archetypes\n";
		2980	#d# NEED to laod twice to resolve forward references
		2981	# this really needs to be done in an extra post-pass
		2982	# (which needs to be synchronous, so solve it differently)
		2983	load_resource_file "$DATADIR/archetypes"
		2984	or die "unable to load archetypes\n";
		2985	}
		2986
		2987	sub reload_treasures {
		2988	load_resource_file "$DATADIR/treasures"
		2989	or die "unable to load treasurelists\n";
		2990	}
		2991
		2992	sub reload_resources {
		2993	warn "reloading resource files...\n";
		2994
		2995	reload_regions;
		2996	reload_facedata;
		2997	#reload_archetypes;#d#
		2998	reload_archetypes;
		2999	reload_treasures;
		3000
		3001	warn "finished reloading resource files\n";
		3002	}
		3003
		3004	sub init {
		3005	reload_resources;
		3006	}
1981		3007
1982	sub cfg_load {	3008	sub cfg_load {
1983	open my $fh, "<:utf8", cf::confdir . "/config"	3009	open my $fh, "<:utf8", "$CONFDIR/config"
1984	or return;	3010	or return;
1985		3011
1986	local $/;	3012	local $/;
1987	*CFG = YAML::Syck::Load <$fh>;	3013	*CFG = YAML::Syck::Load <$fh>;
1988		3014
…		…
1991	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3017	$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};	3018	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
1993		3019
1994	if (exists $CFG{mlockall}) {	3020	if (exists $CFG{mlockall}) {
1995	eval {	3021	eval {
1996	$CFG{mlockall} ? &mlockall : &munlockall	3022	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1997	and die "WARNING: m(un)lockall failed: $!\n";	3023	and die "WARNING: m(un)lockall failed: $!\n";
1998	};	3024	};
1999	warn $@ if $@;	3025	warn $@ if $@;
2000	}	3026	}
2001	}	3027	}
2002		3028
2003	sub main {	3029	sub main {
2004	# we must not ever block the main coroutine	3030	# we must not ever block the main coroutine
2005	local $Coro::idle = sub {	3031	local $Coro::idle = sub {
2006	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3032	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2007	Coro::async_pool { Event::one_event };	3033	(async {
		3034	Event::one_event;
		3035	})->prio (Coro::PRIO_MAX);
2008	};	3036	};
2009		3037
2010	cfg_load;	3038	cfg_load;
2011	db_load;	3039	db_init;
2012	load_extensions;	3040	load_extensions;
		3041
		3042	$TICK_WATCHER->start;
2013	Event::loop;	3043	Event::loop;
2014	}	3044	}
2015		3045
2016	#############################################################################	3046	#############################################################################
2017	# initialisation	3047	# initialisation and cleanup
2018		3048
		3049	# install some emergency cleanup handlers
		3050	BEGIN {
		3051	for my $signal (qw(INT HUP TERM)) {
		3052	Event->signal (
		3053	reentrant => 0,
		3054	data => WF_AUTOCANCEL,
		3055	signal => $signal,
		3056	prio => 0,
		3057	cb => sub {
		3058	cf::cleanup "SIG$signal";
		3059	},
		3060	);
		3061	}
		3062	}
		3063
		3064	sub write_runtime {
		3065	my $runtime = "$LOCALDIR/runtime";
		3066
		3067	# first touch the runtime file to show we are still running:
		3068	# the fsync below can take a very very long time.
		3069
		3070	IO::AIO::aio_utime $runtime, undef, undef;
		3071
		3072	my $guard = cf::lock_acquire "write_runtime";
		3073
		3074	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3075	or return;
		3076
		3077	my $value = $cf::RUNTIME + 90 + 10;
		3078	# 10 is the runtime save interval, for a monotonic clock
		3079	# 60 allows for the watchdog to kill the server.
		3080
		3081	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3082	and return;
		3083
		3084	# always fsync - this file is important
		3085	aio_fsync $fh
		3086	and return;
		3087
		3088	# touch it again to show we are up-to-date
		3089	aio_utime $fh, undef, undef;
		3090
		3091	close $fh
		3092	or return;
		3093
		3094	aio_rename "$runtime~", $runtime
		3095	and return;
		3096
		3097	warn "runtime file written.\n";
		3098
		3099	1
		3100	}
		3101
		3102	sub emergency_save() {
		3103	my $freeze_guard = cf::freeze_mainloop;
		3104
		3105	warn "enter emergency perl save\n";
		3106
		3107	cf::sync_job {
		3108	# use a peculiar iteration method to avoid tripping on perl
		3109	# refcount bugs in for. also avoids problems with players
		3110	# and maps saved/destroyed asynchronously.
		3111	warn "begin emergency player save\n";
		3112	for my $login (keys %cf::PLAYER) {
		3113	my $pl = $cf::PLAYER{$login} or next;
		3114	$pl->valid or next;
		3115	$pl->save;
		3116	}
		3117	warn "end emergency player save\n";
		3118
		3119	warn "begin emergency map save\n";
		3120	for my $path (keys %cf::MAP) {
		3121	my $map = $cf::MAP{$path} or next;
		3122	$map->valid or next;
		3123	$map->save;
		3124	}
		3125	warn "end emergency map save\n";
		3126
		3127	warn "begin emergency database checkpoint\n";
		3128	BDB::db_env_txn_checkpoint $DB_ENV;
		3129	warn "end emergency database checkpoint\n";
		3130	};
		3131
		3132	warn "leave emergency perl save\n";
		3133	}
		3134
		3135	sub post_cleanup {
		3136	my ($make_core) = @_;
		3137
		3138	warn Carp::longmess "post_cleanup backtrace"
		3139	if $make_core;
		3140	}
		3141
2019	sub reload() {	3142	sub do_reload_perl() {
2020	# can/must only be called in main	3143	# can/must only be called in main
2021	if ($Coro::current != $Coro::main) {	3144	if ($Coro::current != $Coro::main) {
2022	warn "can only reload from main coroutine\n";	3145	warn "can only reload from main coroutine";
2023	return;	3146	return;
2024	}	3147	}
2025		3148
2026	warn "reloading...";	3149	warn "reloading...";
2027		3150
2028	my $guard = freeze_mainloop;	3151	warn "entering sync_job";
		3152
		3153	cf::sync_job {
		3154	cf::write_runtime; # external watchdog should not bark
2029	cf::emergency_save;	3155	cf::emergency_save;
		3156	cf::write_runtime; # external watchdog should not bark
2030		3157
2031	eval {	3158	warn "syncing database to disk";
		3159	BDB::db_env_txn_checkpoint $DB_ENV;
		3160
2032	# if anything goes wrong in here, we should simply crash as we already saved	3161	# if anything goes wrong in here, we should simply crash as we already saved
2033		3162
2034	# cancel all watchers	3163	warn "cancelling all WF_AUTOCANCEL watchers";
2035	for (Event::all_watchers) {	3164	for (Event::all_watchers) {
2036	$_->cancel if $_->data & WF_AUTOCANCEL;	3165	$_->cancel if $_->data & WF_AUTOCANCEL;
2037	}	3166	}
2038		3167
		3168	warn "flushing outstanding aio requests";
		3169	for (;;) {
		3170	BDB::flush;
		3171	IO::AIO::flush;
		3172	Coro::cede;
		3173	last unless IO::AIO::nreqs || BDB::nreqs;
		3174	warn "iterate...";
		3175	}
		3176
		3177	++$RELOAD;
		3178
2039	# cancel all extension coros	3179	warn "cancelling all extension coros";
2040	$_->cancel for values %EXT_CORO;	3180	$_->cancel for values %EXT_CORO;
2041	%EXT_CORO = ();	3181	%EXT_CORO = ();
2042		3182
2043	# unload all extensions	3183	warn "removing commands";
2044	for (@exts) {	3184	%COMMAND = ();
		3185
		3186	warn "removing ext/exti commands";
		3187	%EXTCMD = ();
		3188	%EXTICMD = ();
		3189
		3190	warn "unloading/nuking all extensions";
		3191	for my $pkg (@EXTS) {
2045	warn "unloading <$_>";	3192	warn "... unloading $pkg";
2046	unload_extension $_;	3193
		3194	if (my $cb = $pkg->can ("unload")) {
		3195	eval {
		3196	$cb->($pkg);
		3197	1
		3198	} or warn "$pkg unloaded, but with errors: $@";
2047	}	3199	}
2048		3200
		3201	warn "... nuking $pkg";
		3202	Symbol::delete_package $pkg;
		3203	}
		3204
2049	# unload all modules loaded from $LIBDIR	3205	warn "unloading all perl modules loaded from $LIBDIR";
2050	while (my ($k, $v) = each %INC) {	3206	while (my ($k, $v) = each %INC) {
2051	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3207	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2052		3208
2053	warn "removing <$k>";	3209	warn "... unloading $k";
2054	delete $INC{$k};	3210	delete $INC{$k};
2055		3211
2056	$k =~ s/\.pm$//;	3212	$k =~ s/\.pm$//;
2057	$k =~ s/\//::/g;	3213	$k =~ s/\//::/g;
2058		3214
…		…
2061	}	3217	}
2062		3218
2063	Symbol::delete_package $k;	3219	Symbol::delete_package $k;
2064	}	3220	}
2065		3221
2066	# sync database to disk
2067	cf::db_sync;
2068	IO::AIO::flush;
2069
2070	# get rid of safe::, as good as possible	3222	warn "getting rid of safe::, as good as possible";
2071	Symbol::delete_package "safe::$_"	3223	Symbol::delete_package "safe::$_"
2072	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3224	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2073		3225
2074	# remove register_script_function callbacks
2075	# TODO
2076
2077	# unload cf.pm "a bit"	3226	warn "unloading cf.pm \"a bit\"";
2078	delete $INC{"cf.pm"};	3227	delete $INC{"cf.pm"};
		3228	delete $INC{"cf/pod.pm"};
2079		3229
2080	# don't, removes xs symbols, too,	3230	# don't, removes xs symbols, too,
2081	# and global variables created in xs	3231	# and global variables created in xs
2082	#Symbol::delete_package __PACKAGE__;	3232	#Symbol::delete_package __PACKAGE__;
2083		3233
2084	# reload cf.pm	3234	warn "unload completed, starting to reload now";
		3235
2085	warn "reloading cf.pm";	3236	warn "reloading cf.pm";
2086	require cf;	3237	require cf;
2087	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3238	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2088		3239
2089	# load config and database again	3240	warn "loading config and database again";
2090	cf::cfg_load;	3241	cf::cfg_load;
2091	cf::db_load;
2092		3242
2093	# load extensions
2094	warn "load extensions";	3243	warn "loading extensions";
2095	cf::load_extensions;	3244	cf::load_extensions;
2096		3245
2097	# reattach attachments to objects	3246	warn "reattaching attachments to objects/players";
2098	warn "reattach";	3247	_global_reattach; # objects, sockets
2099	_global_reattach;	3248	warn "reattaching attachments to maps";
2100	};	3249	reattach $_ for values %MAP;
		3250	warn "reattaching attachments to players";
		3251	reattach $_ for values %PLAYER;
2101		3252
2102	if ($@) {	3253	warn "leaving sync_job";
		3254
		3255	1
		3256	} or do {
2103	warn $@;	3257	warn $@;
2104	warn "error while reloading, exiting.";	3258	warn "error while reloading, exiting.";
2105	exit 1;	3259	exit 1;
2106	}	3260	};
2107		3261
2108	warn "reloaded successfully";	3262	warn "reloaded";
2109	};	3263	};
2110		3264
2111	#############################################################################	3265	our $RELOAD_WATCHER; # used only during reload
2112		3266
2113	unless ($LINK_MAP) {	3267	sub reload_perl() {
2114	$LINK_MAP = cf::map::new;	3268	# doing reload synchronously and two reloads happen back-to-back,
		3269	# coro crashes during coro_state_free->destroy here.
2115		3270
2116	$LINK_MAP->width (41);	3271	$RELOAD_WATCHER ||= Event->timer (
2117	$LINK_MAP->height (41);	3272	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,	3273	after => 0,
		3274	data => WF_AUTOCANCEL,
2126	cb => sub {	3275	cb => sub {
2127	$_[0]->w->cancel;	3276	do_reload_perl;
2128		3277	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	});	3278	},
2147		3279	);
2148	$LINK_MAP->{deny_save} = 1;
2149	$LINK_MAP->{deny_reset} = 1;
2150
2151	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2152	}	3280	}
2153
2154	register "<global>", __PACKAGE__;
2155		3281
2156	register_command "reload" => sub {	3282	register_command "reload" => sub {
2157	my ($who, $arg) = @_;	3283	my ($who, $arg) = @_;
2158		3284
2159	if ($who->flag (FLAG_WIZ)) {	3285	if ($who->flag (FLAG_WIZ)) {
2160	$who->message ("start of reload.");
2161	reload;
2162	$who->message ("end of reload.");	3286	$who->message ("reloading server.");
		3287	async { reload_perl };
2163	}	3288	}
2164	};	3289	};
2165		3290
2166	unshift @INC, $LIBDIR;	3291	unshift @INC, $LIBDIR;
2167		3292
		3293	my $bug_warning = 0;
		3294
		3295	our @WAIT_FOR_TICK;
		3296	our @WAIT_FOR_TICK_BEGIN;
		3297
		3298	sub wait_for_tick {
		3299	return unless $TICK_WATCHER->is_active;
		3300	return if $Coro::current == $Coro::main;
		3301
		3302	my $signal = new Coro::Signal;
		3303	push @WAIT_FOR_TICK, $signal;
		3304	$signal->wait;
		3305	}
		3306
		3307	sub wait_for_tick_begin {
		3308	return unless $TICK_WATCHER->is_active;
		3309	return if $Coro::current == $Coro::main;
		3310
		3311	my $signal = new Coro::Signal;
		3312	push @WAIT_FOR_TICK_BEGIN, $signal;
		3313	$signal->wait;
		3314	}
		3315
		3316	my $min = 1e6;#d#
		3317	my $avg = 10;
2168	$TICK_WATCHER = Event->timer (	3318	$TICK_WATCHER = Event->timer (
2169	reentrant => 0,	3319	reentrant => 0,
		3320	parked => 1,
2170	prio => 0,	3321	prio => 0,
2171	at => $NEXT_TICK || $TICK,	3322	at => $NEXT_TICK || $TICK,
2172	data => WF_AUTOCANCEL,	3323	data => WF_AUTOCANCEL,
2173	cb => sub {	3324	cb => sub {
		3325	if ($Coro::current != $Coro::main) {
		3326	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3327	unless ++$bug_warning > 10;
		3328	return;
		3329	}
		3330
		3331	$NOW = $tick_start = Event::time;
		3332
2174	cf::server_tick; # one server iteration	3333	cf::server_tick; # one server iteration
		3334
		3335	0 && sync_job {#d#
		3336	for(1..10) {
		3337	my $t = Event::time;
		3338	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3339	or die;
		3340
		3341	$map->width (50);
		3342	$map->height (50);
		3343	$map->alloc;
		3344	$map->_load_objects ("/tmp/x.map", 1);
		3345	my $t = Event::time - $t;
		3346
		3347	#next unless $t < 0.0013;#d#
		3348	if ($t < $min) {
		3349	$min = $t;
		3350	}
		3351	$avg = $avg * 0.99 + $t * 0.01;
		3352	}
		3353	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3354	exit 0;
		3355	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3356	};
		3357
2175	$RUNTIME += $TICK;	3358	$RUNTIME += $TICK;
2176	$NEXT_TICK += $TICK;	3359	$NEXT_TICK += $TICK;
2177		3360
		3361	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3362	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3363	Coro::async_pool {
		3364	write_runtime
		3365	or warn "ERROR: unable to write runtime file: $!";
		3366	};
		3367	}
		3368
		3369	# my $AFTER = Event::time;
		3370	# warn $AFTER - $NOW;#d#
		3371
		3372	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3373	$sig->send;
		3374	}
		3375	while (my $sig = shift @WAIT_FOR_TICK) {
		3376	$sig->send;
		3377	}
		3378
		3379	$NOW = Event::time;
		3380
2178	# if we are delayed by four ticks or more, skip them all	3381	# if we are delayed by four ticks or more, skip them all
2179	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3382	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2180		3383
2181	$TICK_WATCHER->at ($NEXT_TICK);	3384	$TICK_WATCHER->at ($NEXT_TICK);
2182	$TICK_WATCHER->start;	3385	$TICK_WATCHER->start;
		3386
		3387	$LOAD = ($NOW - $tick_start) / $TICK;
		3388	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3389
		3390	_post_tick;
		3391
		3392
2183	},	3393	},
2184	);	3394	);
2185		3395
		3396	{
2186	IO::AIO::max_poll_time $TICK * 0.2;	3397	BDB::max_poll_time $TICK * 0.1;
2187		3398	$BDB_POLL_WATCHER = Event->io (
2188	Event->io (	3399	reentrant => 0,
2189	fd => IO::AIO::poll_fileno,	3400	fd => BDB::poll_fileno,
2190	poll => 'r',	3401	poll => 'r',
2191	prio => 5,	3402	prio => 0,
2192	data => WF_AUTOCANCEL,
2193	cb => \&IO::AIO::poll_cb,
2194	);
2195
2196	Event->timer (
2197	data => WF_AUTOCANCEL,	3403	data => WF_AUTOCANCEL,
2198	after => 0,	3404	cb => \&BDB::poll_cb,
2199	interval => 10,	3405	);
2200	cb => sub {	3406	BDB::min_parallel 8;
2201	(Coro::unblock_sub {	3407
2202	write_runtime	3408	BDB::set_sync_prepare {
2203	or warn "ERROR: unable to write runtime file: $!";	3409	my $status;
		3410	my $current = $Coro::current;
		3411	(
		3412	sub {
		3413	$status = $!;
		3414	$current->ready; undef $current;
		3415	},
		3416	sub {
		3417	Coro::schedule while defined $current;
		3418	$! = $status;
		3419	},
		3420	)
		3421	};
		3422
		3423	unless ($DB_ENV) {
		3424	$DB_ENV = BDB::db_env_create;
		3425
		3426	cf::sync_job {
		3427	eval {
		3428	BDB::db_env_open
		3429	$DB_ENV,
		3430	$BDBDIR,
		3431	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3432	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3433	0666;
		3434
		3435	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3436
		3437	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3438	$DB_ENV->set_lk_detect;
		3439	};
		3440
		3441	cf::cleanup "db_env_open(db): $@" if $@;
2204	})->();	3442	};
2205	},	3443	}
2206	);	3444	}
		3445
		3446	{
		3447	IO::AIO::min_parallel 8;
		3448
		3449	undef $Coro::AIO::WATCHER;
		3450	IO::AIO::max_poll_time $TICK * 0.1;
		3451	$AIO_POLL_WATCHER = Event->io (
		3452	reentrant => 0,
		3453	data => WF_AUTOCANCEL,
		3454	fd => IO::AIO::poll_fileno,
		3455	poll => 'r',
		3456	prio => 6,
		3457	cb => \&IO::AIO::poll_cb,
		3458	);
		3459	}
		3460
		3461	my $_log_backtrace;
		3462
		3463	sub _log_backtrace {
		3464	my ($msg, @addr) = @_;
		3465
		3466	$msg =~ s/\n//;
		3467
		3468	# limit the # of concurrent backtraces
		3469	if ($_log_backtrace < 2) {
		3470	++$_log_backtrace;
		3471	async {
		3472	my @bt = fork_call {
		3473	@addr = map { sprintf "%x", $_ } @addr;
		3474	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3475	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3476	or die "addr2line: $!";
		3477
		3478	my @funcs;
		3479	my @res = <$fh>;
		3480	chomp for @res;
		3481	while (@res) {
		3482	my ($func, $line) = splice @res, 0, 2, ();
		3483	push @funcs, "[$func] $line";
		3484	}
		3485
		3486	@funcs
		3487	};
		3488
		3489	LOG llevInfo, "[ABT] $msg\n";
		3490	LOG llevInfo, "[ABT] $_\n" for @bt;
		3491	--$_log_backtrace;
		3492	};
		3493	} else {
		3494	LOG llevInfo, "[ABT] $msg\n";
		3495	LOG llevInfo, "[ABT] [suppressed]\n";
		3496	}
		3497	}
		3498
		3499	# load additional modules
		3500	use cf::pod;
2207		3501
2208	END { cf::emergency_save }	3502	END { cf::emergency_save }
2209		3503
2210	1	3504	1
2211		3505

Diff Legend

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