ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 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 BDB ();
20	use Data::Dumper;	26	use Data::Dumper;
21	use Digest::MD5;	27	use Digest::MD5;
22	use Fcntl;	28	use Fcntl;
		29	use YAML::Syck ();
23	use IO::AIO 2.32 ();	30	use IO::AIO 2.32 ();
24	use YAML::Syck ();
25	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
26		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
28
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		41
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
33		44
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		46
		47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
35		48
36	our %COMMAND = ();	49	our %COMMAND = ();
37	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
38		51
39	our @EXTS = (); # list of extension package names	52	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	53	our %EXTCMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	54	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	55	our %EXT_MAP = (); # pluggable maps
43		56
		57	our $RELOAD; # number of reloads so far
44	our @EVENT;	58	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		59
47	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
49	our $NEXT_TICK;	76	our $NEXT_TICK;
50	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
51		82
52	our %CFG;	83	our %CFG;
53		84
54	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
55	our $RUNTIME;	86	our $RUNTIME;
56		87
57	our %PLAYER; # all users	88	our %PLAYER; # all users
58	our %MAP; # all maps	89	our %MAP; # all maps
59	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
60	our $RANDOM_MAPS = cf::localdir . "/random";
61		91
62	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	92	# used to convert map paths into valid unix filenames by replacing / by ∕
63	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
64		98
65	binmode STDOUT;	99	binmode STDOUT;
66	binmode STDERR;	100	binmode STDERR;
67		101
68	# read virtual server time, if available	102	# read virtual server time, if available
69	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
70	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
71	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
72	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
73	}	107	}
74		108
75	mkdir cf::localdir;	109	mkdir $_
76	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
77	mkdir cf::localdir . "/" . cf::tmpdir;
78	mkdir cf::localdir . "/" . cf::uniquedir;
79	mkdir $RANDOM_MAPS;
80		111
81	# a special map that is always available
82	our $LINK_MAP;
83	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
		113
		114	sub cf::map::normalise;
84		115
85	#############################################################################	116	#############################################################################
86		117
87	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
88		119
…		…
95	=item $cf::RUNTIME	126	=item $cf::RUNTIME
96		127
97	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
98	every server tick.	129	every server tick.
99		130
100	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
101		134
102	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
103	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
104		139
105	=item $cf::NOW	140	=item $cf::NOW
106		141
107	The time of the last (current) server tick.	142	The time of the last (current) server tick.
108		143
109	=item $cf::TICK	144	=item $cf::TICK
110		145
111	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
112		157
113	=item %cf::CFG	158	=item %cf::CFG
114		159
115	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
116	from wherever your confdir points to.	161	from wherever your confdir points to.
117		162
118	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	163	=item cf::wait_for_tick, cf::wait_for_tick_begin
119		164
120	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
121	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	166	returns directly I<after> the tick processing (and consequently, can only wake one process
122	processing has been done. Call C<< ->wait >> on them to maximise the	167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
123	window of cpu time available, or simply to synchronise to the server tick.
124		168
125	=back	169	=back
126		170
127	=cut	171	=cut
128		172
129	BEGIN {	173	BEGIN {
130	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
131	my $msg = join "", @_;	175	my $msg = join "", @_;
132	utf8::encode $msg;
133		176
134	$msg .= "\n"	177	$msg .= "\n"
135	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
136		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
137	LOG llevError, $msg;	183	LOG llevError, $msg;
138	};	184	};
139	}	185	}
140		186
141	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
142	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
143	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
144	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
145	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
146	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
147		194
148	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
149	# within the Safe compartment.	196	# within the Safe compartment.
150	for my $pkg (qw(	197	for my $pkg (qw(
151	cf::global cf::attachable	198	cf::global cf::attachable
…		…
159	}	206	}
160		207
161	$Event::DIED = sub {	208	$Event::DIED = sub {
162	warn "error in event callback: @_";	209	warn "error in event callback: @_";
163	};	210	};
		211
		212	#############################################################################
164		213
165	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
166		215
167	=over 4	216	=over 4
168		217
…		…
187	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	236	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
188	$d	237	$d
189	} || "[unable to dump $_[0]: '$@']";	238	} || "[unable to dump $_[0]: '$@']";
190	}	239	}
191		240
192	use JSON::Syck (); # TODO# replace by JSON::PC once working	241	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
193		242
194	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
195		244
196	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
197		246
198	=cut
199
200	sub from_json($) {
201	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
202	JSON::Syck::Load $_[0]
203	}
204
205	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
206		248
207	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
208
209	=cut
210
211	sub to_json($) {
212	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
213	JSON::Syck::Dump $_[0]
214	}
215		250
216	=item cf::lock_wait $string	251	=item cf::lock_wait $string
217		252
218	Wait until the given lock is available. See cf::lock_acquire.	253	Wait until the given lock is available. See cf::lock_acquire.
219		254
…		…
225	returned.	260	returned.
226		261
227	Lock names should begin with a unique identifier (for example, cf::map::find	262	Lock names should begin with a unique identifier (for example, cf::map::find
228	uses map_find and cf::map::load uses map_load).	263	uses map_find and cf::map::load uses map_load).
229		264
		265	=item $locked = cf::lock_active $string
		266
		267	Return true if the lock is currently active, i.e. somebody has locked it.
		268
230	=cut	269	=cut
231		270
232	our %LOCK;	271	our %LOCK;
233		272
234	sub lock_wait($) {	273	sub lock_wait($) {
…		…
253	# wake up all waiters, to be on the safe side	292	# wake up all waiters, to be on the safe side
254	$_->ready for @{ delete $LOCK{$key} };	293	$_->ready for @{ delete $LOCK{$key} };
255	}	294	}
256	}	295	}
257		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
		301	}
		302
258	sub freeze_mainloop {	303	sub freeze_mainloop {
259	return unless $TICK_WATCHER->is_active;	304	return unless $TICK_WATCHER->is_active;
260		305
261	my $guard = Coro::guard { $TICK_WATCHER->start };	306	my $guard = Coro::guard {
		307	$TICK_WATCHER->start;
		308	};
262	$TICK_WATCHER->stop;	309	$TICK_WATCHER->stop;
263	$guard	310	$guard
264	}	311	}
265		312
266	=item cf::async { BLOCK }	313	=item cf::async { BLOCK }
…		…
273		320
274	BEGIN { *async = \&Coro::async_pool }	321	BEGIN { *async = \&Coro::async_pool }
275		322
276	=item cf::sync_job { BLOCK }	323	=item cf::sync_job { BLOCK }
277		324
278	The design of crossfire+ requires that the main coro ($Coro::main) is	325	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
279	always able to handle events or runnable, as crossfire+ is only partly	326	is always able to handle events or runnable, as Crossfire TRT is only
280	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	327	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		328	acceptable.
281		329
282	If it must be done, put the blocking parts into C<sync_job>. This will run	330	If it must be done, put the blocking parts into C<sync_job>. This will run
283	the given BLOCK in another coroutine while waiting for the result. The	331	the given BLOCK in another coroutine while waiting for the result. The
284	server will be frozen during this time, so the block should either finish	332	server will be frozen during this time, so the block should either finish
285	fast or be very important.	333	fast or be very important.
…		…
288		336
289	sub sync_job(&) {	337	sub sync_job(&) {
290	my ($job) = @_;	338	my ($job) = @_;
291		339
292	if ($Coro::current == $Coro::main) {	340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
293	# this is the main coro, too bad, we have to block	343	# this is the main coro, too bad, we have to block
294	# till the operation succeeds, freezing the server :/	344	# till the operation succeeds, freezing the server :/
295		345
296	# TODO: use suspend/resume instead	346	# TODO: use suspend/resume instead
297	# (but this is cancel-safe)	347	# (but this is cancel-safe)
…		…
308		358
309	while ($busy) {	359	while ($busy) {
310	Coro::cede or Event::one_event;	360	Coro::cede or Event::one_event;
311	}	361	}
312		362
		363	$time = Event::time - $time;
		364
		365	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		366	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		367
		368	$tick_start += $time; # do not account sync jobs to server load
		369
313	wantarray ? @res : $res[0]	370	wantarray ? @res : $res[0]
314	} else {	371	} else {
315	# we are in another coroutine, how wonderful, everything just works	372	# we are in another coroutine, how wonderful, everything just works
316		373
317	$job->()	374	$job->()
…		…
336	$EXT_CORO{$coro+0} = $coro;	393	$EXT_CORO{$coro+0} = $coro;
337		394
338	$coro	395	$coro
339	}	396	}
340		397
341	sub write_runtime {	398	=item fork_call { }, $args
342	my $runtime = cf::localdir . "/runtime";
343		399
344	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	400	Executes the given code block with the given arguments in a seperate
345	or return;	401	process, returning the results. Everything must be serialisable with
		402	Coro::Storable. May, of course, block. Note that the executed sub may
		403	never block itself or use any form of Event handling.
346		404
347	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	405	=cut
348	(aio_write $fh, 0, (length $value), $value, 0) <= 0
349	and return;
350		406
351	aio_fsync $fh	407	sub fork_call(&@) {
352	and return;	408	my ($cb, @args) = @_;
353		409
		410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		411	# or die "socketpair: $!";
		412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
		414
		415	if (my $pid = fork) {
354	close $fh	416	close $fh2;
355	or return;
356		417
357	aio_rename "$runtime~", $runtime	418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
358	and return;	419	$res = Coro::Storable::thaw $res;
359		420
		421	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		422
		423	die $$res unless "ARRAY" eq ref $res;
		424
		425	return wantarray ? @$res : $res->[-1];
		426	} else {
		427	reset_signals;
		428	local $SIG{__WARN__};
		429	local $SIG{__DIE__};
		430	eval {
		431	close $fh1;
		432
		433	my @res = eval { $cb->(@args) };
		434	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		435	};
		436
		437	warn $@ if $@;
		438	_exit 0;
360	1	439	}
		440	}
		441
		442	=item $value = cf::db_get $family => $key
		443
		444	Returns a single value from the environment database.
		445
		446	=item cf::db_put $family => $key => $value
		447
		448	Stores the given C<$value> in the family. It can currently store binary
		449	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		450
		451	=cut
		452
		453	our $DB;
		454
		455	sub db_init {
		456	unless ($DB) {
		457	$DB = BDB::db_create $DB_ENV;
		458
		459	cf::sync_job {
		460	eval {
		461	$DB->set_flags (BDB::CHKSUM);
		462
		463	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		464	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		465	cf::cleanup "db_open(db): $!" if $!;
		466	};
		467	cf::cleanup "db_open(db): $@" if $@;
		468	};
		469	}
		470	}
		471
		472	sub db_get($$) {
		473	my $key = "$_[0]/$_[1]";
		474
		475	cf::sync_job {
		476	BDB::db_get $DB, undef, $key, my $data;
		477
		478	$! ? ()
		479	: $data
		480	}
		481	}
		482
		483	sub db_put($$$) {
		484	BDB::dbreq_pri 4;
		485	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		486	}
		487
		488	=item cf::cache $id => [$paths...], $processversion => $process
		489
		490	Generic caching function that returns the value of the resource $id,
		491	caching and regenerating as required.
		492
		493	This function can block.
		494
		495	=cut
		496
		497	sub cache {
		498	my ($id, $src, $processversion, $process) = @_;
		499
		500	my $meta =
		501	join "\x00",
		502	$processversion,
		503	map {
		504	aio_stat $_
		505	and Carp::croak "$_: $!";
		506
		507	($_, (stat _)[7,9])
		508	} @$src;
		509
		510	my $dbmeta = db_get cache => "$id/meta";
		511	if ($dbmeta ne $meta) {
		512	# changed, we may need to process
		513
		514	my @data;
		515	my $md5;
		516
		517	for (0 .. $#$src) {
		518	0 <= aio_load $src->[$_], $data[$_]
		519	or Carp::croak "$src->[$_]: $!";
		520	}
		521
		522	# if processing is expensive, check
		523	# checksum first
		524	if (1) {
		525	$md5 =
		526	join "\x00",
		527	$processversion,
		528	map {
		529	Coro::cede;
		530	($src->[$_], Digest::MD5::md5_hex $data[$_])
		531	} 0.. $#$src;
		532
		533
		534	my $dbmd5 = db_get cache => "$id/md5";
		535	if ($dbmd5 eq $md5) {
		536	db_put cache => "$id/meta", $meta;
		537
		538	return db_get cache => "$id/data";
		539	}
		540	}
		541
		542	my $t1 = Time::HiRes::time;
		543	my $data = $process->(\@data);
		544	my $t2 = Time::HiRes::time;
		545
		546	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		547
		548	db_put cache => "$id/data", $data;
		549	db_put cache => "$id/md5" , $md5;
		550	db_put cache => "$id/meta", $meta;
		551
		552	return $data;
		553	}
		554
		555	db_get cache => "$id/data"
		556	}
		557
		558	=item cf::datalog type => key => value, ...
		559
		560	Log a datalog packet of the given type with the given key-value pairs.
		561
		562	=cut
		563
		564	sub datalog($@) {
		565	my ($type, %kv) = @_;
		566	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
361	}	567	}
362		568
363	=back	569	=back
364		570
365	=cut	571	=cut
366
367	#############################################################################
368
369	package cf::path;
370
371	use overload
372	'""' => \&as_string;
373
374	# used to convert map paths into valid unix filenames by repalcing / by ∕
375	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
376
377	sub register {
378	my ($pkg, $prefix) = @_;
379
380	$EXT_MAP{$prefix} = $pkg;
381	}
382
383	sub new {
384	my ($class, $path, $base) = @_;
385
386	return $path if ref $path;
387
388	my $self = {};
389
390	# {... are special paths that are not being touched
391	# ?xxx/... are special absolute paths
392	# ?random/... random maps
393	# /! non-realised random map exit
394	# /... normal maps
395	# ~/... per-player maps without a specific player (DO NOT USE)
396	# ~user/... per-player map of a specific user
397
398	$path =~ s/$PATH_SEP/\//go;
399
400	if ($path =~ /^{/) {
401	# fine as it is
402	} else {
403	if ($path =~ s{^~([^/]+)?}{}) {
404	# ~user
405	$self->{user_rel} = 1;
406
407	if (defined $1) {
408	$self->{user} = $1;
409	} elsif ($base =~ m{^~([^/]+)/}) {
410	$self->{user} = $1;
411	} else {
412	warn "cannot resolve user-relative path without user <$path,$base>\n";
413	}
414	} elsif ($path =~ s{^\?([^/]+)/}{}) {
415	# ?...
416	$self->{ext} = $1;
417	if (my $ext = $EXT_MAP{$1}) {
418	bless $self, $ext;
419	}
420	} elsif ($path =~ /^\//) {
421	# /...
422	# already absolute
423	} else {
424	# relative
425	$base =~ s{[^/]+/?$}{};
426	return $class->new ("$base/$path");
427	}
428
429	for ($path) {
430	redo if s{/\.?/}{/};
431	redo if s{/[^/]+/\.\./}{/};
432	}
433	}
434
435	$self->{path} = $path;
436
437	if ("HASH" eq ref $self) {
438	bless $self, $class;
439	} else {
440	$self->init;
441	}
442
443	for my $ext (values %EXT_MAP) {
444	if (my $subst = $ext->substitute ($self)) {
445	return $subst;
446	}
447	}
448
449	$self
450	}
451
452	sub init {
453	# nop
454	}
455
456	sub substitute {
457	()
458	}
459
460	# the name / primary key / in-game path
461	sub as_string {
462	my ($self) = @_;
463
464	$self->{user_rel} ? "~$self->{user}$self->{path}"
465	: $self->{ext} ? "?$self->{ext}/$self->{path}"
466	: $self->{path}
467	}
468
469	# the displayed name, this is a one way mapping
470	sub visible_name {
471	&as_string
472	}
473
474	# escape the /'s in the path
475	sub _escaped_path {
476	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
477	$path
478	}
479
480	# the original (read-only) location
481	sub load_path {
482	my ($self) = @_;
483
484	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
485	}
486
487	# the temporary/swap location
488	sub save_path {
489	my ($self) = @_;
490
491	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
492	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
493	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
494	}
495
496	# the unique path, undef == no special unique path
497	sub uniq_path {
498	my ($self) = @_;
499
500	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
501	}
502
503	# this is somewhat ugly, but style maps do need special treatment
504	sub is_style_map {
505	$_[0]{path} =~ m{^/styles/}
506	}
507
508	sub load_orig {
509	my ($self) = @_;
510
511	&cf::map::load_map_header ($self->load_path)
512	}
513
514	sub load_temp {
515	my ($self) = @_;
516
517	&cf::map::load_map_header ($self->save_path)
518	}
519
520	package cf;
521		572
522	#############################################################################	573	#############################################################################
523		574
524	=head2 ATTACHABLE OBJECTS	575	=head2 ATTACHABLE OBJECTS
525		576
…		…
527	attach callbacks/event handlers (a collection of which is called an "attachment")	578	attach callbacks/event handlers (a collection of which is called an "attachment")
528	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
529		580
530	In the following description, CLASS can be any of C<global>, C<object>	581	In the following description, CLASS can be any of C<global>, C<object>
531	C<player>, C<client> or C<map> (i.e. the attachable objects in	582	C<player>, C<client> or C<map> (i.e. the attachable objects in
532	crossfire+).	583	Crossfire TRT).
533		584
534	=over 4	585	=over 4
535		586
536	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
537		588
…		…
651	our @CB_TYPE = (); # registry for type (cf-object class) based events	702	our @CB_TYPE = (); # registry for type (cf-object class) based events
652	our @CB_MAP = ();	703	our @CB_MAP = ();
653		704
654	my %attachment;	705	my %attachment;
655		706
		707	sub cf::attachable::thawer_merge {
		708	# simply override everything except _meta
		709	local $_[0]{_meta};
		710	%{$_[0]} = %{$_[1]};
		711	}
		712
656	sub _attach_cb($$$$) {	713	sub _attach_cb($$$$) {
657	my ($registry, $event, $prio, $cb) = @_;	714	my ($registry, $event, $prio, $cb) = @_;
658		715
659	use sort 'stable';	716	use sort 'stable';
660		717
…		…
694	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
695		752
696	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
697	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
698	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
699	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
700		757
701	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
702	my $pkg = shift @arg;	759	my $pkg = shift @arg;
703		760
704	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
733	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
734	}	791	}
735		792
736	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
737	} else {	794	} else {
738	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
739	}	796	}
740		797
741	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
742	}	799	}
743		800
…		…
745	if (ref $_[0]) {	802	if (ref $_[0]) {
746	_object_attach @_;	803	_object_attach @_;
747	} else {	804	} else {
748	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
749	}	806	}
		807	_recalc_want;
750	};	808	};
751		809
752	# all those should be optimised	810	# all those should be optimised
753	sub cf::attachable::detach {	811	sub cf::attachable::detach {
754	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
757	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
758	reattach ($obj);	816	reattach ($obj);
759	} else {	817	} else {
760	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
761	}	819	}
		820	_recalc_want;
762	};	821	};
763		822
764	sub cf::attachable::attached {	823	sub cf::attachable::attached {
765	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
766		825
…		…
831	# object support	890	# object support
832		891
833	sub reattach {	892	sub reattach {
834	# basically do the same as instantiate, without calling instantiate	893	# basically do the same as instantiate, without calling instantiate
835	my ($obj) = @_;	894	my ($obj) = @_;
		895
		896	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
836		897
837	my $registry = $obj->registry;	898	my $registry = $obj->registry;
838		899
839	@$registry = ();	900	@$registry = ();
840		901
…		…
887	$filename, length $$rdata, scalar @$objs;	948	$filename, length $$rdata, scalar @$objs;
888		949
889	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	950	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
890	chmod SAVE_MODE, $fh;	951	chmod SAVE_MODE, $fh;
891	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	952	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
892	aio_fsync $fh;	953	aio_fsync $fh if $cf::USE_FSYNC;
893	close $fh;	954	close $fh;
894		955
895	if (@$objs) {	956	if (@$objs) {
896	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	957	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
897	chmod SAVE_MODE, $fh;	958	chmod SAVE_MODE, $fh;
898	my $data = Storable::nfreeze { version => 1, objs => $objs };	959	my $data = Storable::nfreeze { version => 1, objs => $objs };
899	aio_write $fh, 0, (length $data), $data, 0;	960	aio_write $fh, 0, (length $data), $data, 0;
900	aio_fsync $fh;	961	aio_fsync $fh if $cf::USE_FSYNC;
901	close $fh;	962	close $fh;
902	aio_rename "$filename.pst~", "$filename.pst";	963	aio_rename "$filename.pst~", "$filename.pst";
903	}	964	}
904	} else {	965	} else {
905	aio_unlink "$filename.pst";	966	aio_unlink "$filename.pst";
…		…
937	or return;	998	or return;
938	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
939	}	1000	}
940		1001
941	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
942	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
943	return ($data, $av);	1004	return ($data, $av);
944	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
945		1012
946	#############################################################################	1013	#############################################################################
947	# command handling &c	1014	# command handling &c
948		1015
949	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
962	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
963	}	1030	}
964		1031
965	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
966		1033
967	Register a callbackf ro execution when the client sends an extcmd packet.	1034	Register a callback fro execution when the client sends an extcmd packet.
968		1035
969	If the callback returns something, it is sent back as if reply was being	1036	If the callback returns something, it is sent back as if reply was being
970	called.	1037	called.
971		1038
972	=cut	1039	=cut
…		…
1007		1074
1008	cf::override;	1075	cf::override;
1009	},	1076	},
1010	);	1077	);
1011		1078
1012	sub load_extension {
1013	my ($path) = @_;
1014
1015	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
1016	my $base = $1;
1017	my $pkg = $1;
1018	$pkg =~ s/[^[:word:]]/_/g;
1019	$pkg = "ext::$pkg";
1020
1021	warn "... loading '$path' into '$pkg'\n";
1022
1023	open my $fh, "<:utf8", $path
1024	or die "$path: $!";
1025
1026	my $source =
1027	"package $pkg; use strict; use utf8;\n"
1028	. "#line 1 \"$path\"\n{\n"
1029	. (do { local $/; <$fh> })
1030	. "\n};\n1";
1031
1032	eval $source
1033	or die $@ ? "$path: $@\n"
1034	: "extension disabled.\n";
1035
1036	push @EXTS, $pkg;
1037	}
1038
1039	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
1040	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
1041	next unless -r $ext;	1084	next unless -r $path;
1042	eval {	1085
1043	load_extension $ext;	1086	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1087	my $base = $1;
		1088	my $pkg = $1;
		1089	$pkg =~ s/[^[:word:]]/_/g;
		1090	$pkg = "ext::$pkg";
		1091
		1092	open my $fh, "<:utf8", $path
		1093	or die "$path: $!";
		1094
		1095	my $source = do { local $/; <$fh> };
		1096
		1097	my %ext = (
		1098	path => $path,
		1099	base => $base,
		1100	pkg => $pkg,
		1101	);
		1102
		1103	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1104	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1105
		1106	$ext{source} =
		1107	"package $pkg; use strict; use utf8;\n"
		1108	. "#line 1 \"$path\"\n{\n"
		1109	. $source
		1110	. "\n};\n1";
		1111
		1112	$todo{$base} = \%ext;
		1113	}
		1114
		1115	my %done;
		1116	while (%todo) {
		1117	my $progress;
		1118
		1119	while (my ($k, $v) = each %todo) {
		1120	for (split /,\s*/, $v->{meta}{depends}) {
		1121	goto skip
		1122	unless exists $done{$_};
		1123	}
		1124
		1125	warn "... loading '$k' into '$v->{pkg}'\n";
		1126
		1127	unless (eval $v->{source}) {
		1128	my $msg = $@ ? "$v->{path}: $@\n"
		1129	: "$v->{base}: extension inactive.\n";
		1130
		1131	if (exists $v->{meta}{mandatory}) {
		1132	warn $msg;
		1133	warn "mandatory extension failed to load, exiting.\n";
		1134	exit 1;
		1135	}
		1136
		1137	warn $msg;
		1138	}
		1139
		1140	$done{$k} = delete $todo{$k};
		1141	push @EXTS, $v->{pkg};
		1142	$progress = 1;
1044	1	1143	}
1045	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
1046	}	1149	};
1047	}	1150	}
1048		1151
1049	#############################################################################	1152	#############################################################################
1050	# load/save/clean perl data associated with a map
1051		1153
1052	*cf::mapsupport::on_clean = sub {	1154	=back
1053	my ($map) = @_;
1054
1055	my $path = $map->tmpname;
1056	defined $path or return;
1057
1058	unlink "$path.pst";
1059	};
1060
1061	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1062
1063	#############################################################################
1064		1155
1065	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
1066		1157
1067	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
1068		1159
…		…
1081	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
1082		1173
1083	=cut	1174	=cut
1084		1175
1085	sub playerdir($) {	1176	sub playerdir($) {
1086	cf::localdir	1177	"$PLAYERDIR/"
1087	. "/"
1088	. cf::playerdir
1089	. "/"
1090	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1091	}	1179	}
1092		1180
1093	sub path($) {	1181	sub path($) {
1094	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1095		1183
1096	(playerdir $login) . "/$login.pl"	1184	(playerdir $login) . "/playerdata"
1097	}	1185	}
1098		1186
1099	sub find_active($) {	1187	sub find_active($) {
1100	$cf::PLAYER{$_[0]}	1188	$cf::PLAYER{$_[0]}
1101	and $cf::PLAYER{$_[0]}->active	1189	and $cf::PLAYER{$_[0]}->active
…		…
1104		1192
1105	sub exists($) {	1193	sub exists($) {
1106	my ($login) = @_;	1194	my ($login) = @_;
1107		1195
1108	$cf::PLAYER{$login}	1196	$cf::PLAYER{$login}
1109	or cf::sync_job { !aio_stat $login }	1197	or cf::sync_job { !aio_stat path $login }
1110	}	1198	}
1111		1199
1112	sub find($) {	1200	sub find($) {
1113	return $cf::PLAYER{$_[0]} || do {	1201	return $cf::PLAYER{$_[0]} || do {
1114	my $login = $_[0];	1202	my $login = $_[0];
1115		1203
1116	my $guard = cf::lock_acquire "user_find:$login";	1204	my $guard = cf::lock_acquire "user_find:$login";
1117		1205
1118	$cf::PLAYER{$_[0]} || do {	1206	$cf::PLAYER{$_[0]} || do {
		1207	# rename old playerfiles to new ones
		1208	#TODO: remove when no longer required
		1209	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1210	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1211	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1212	aio_unlink +(playerdir $login) . "/$login.pl";
		1213
1119	my $pl = load_pl path $login	1214	my $pl = load_pl path $login
1120	or return;	1215	or return;
1121	$cf::PLAYER{$login} = $pl	1216	$cf::PLAYER{$login} = $pl
1122	}	1217	}
1123	}	1218	}
…		…
1160		1255
1161	=cut	1256	=cut
1162		1257
1163	sub quit_character {	1258	sub quit_character {
1164	my ($pl) = @_;	1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
1165		1262
1166	$pl->{deny_save} = 1;	1263	$pl->{deny_save} = 1;
1167	$pl->password ("*"); # this should lock out the player until we nuked the dir	1264	$pl->password ("*"); # this should lock out the player until we nuked the dir
1168		1265
1169	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1174	my $path = playerdir $pl;	1271	my $path = playerdir $pl;
1175	my $temp = "$path~$cf::RUNTIME~deleting~";	1272	my $temp = "$path~$cf::RUNTIME~deleting~";
1176	aio_rename $path, $temp;	1273	aio_rename $path, $temp;
1177	delete $cf::PLAYER{$pl->ob->name};	1274	delete $cf::PLAYER{$pl->ob->name};
1178	$pl->destroy;	1275	$pl->destroy;
		1276
		1277	my $prefix = qr<^~\Q$name\E/>;
		1278
		1279	# nuke player maps
		1280	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1281
1179	IO::AIO::aio_rmtree $temp;	1282	IO::AIO::aio_rmtree $temp;
		1283	}
		1284
		1285	=item $pl->kick
		1286
		1287	Kicks a player out of the game. This destroys the connection.
		1288
		1289	=cut
		1290
		1291	sub kick {
		1292	my ($pl, $kicker) = @_;
		1293
		1294	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1295	$pl->killer ("kicked");
		1296	$pl->ns->destroy;
1180	}	1297	}
1181		1298
1182	=item cf::player::list_logins	1299	=item cf::player::list_logins
1183		1300
1184	Returns am arrayref of all valid playernames in the system, can take a	1301	Returns am arrayref of all valid playernames in the system, can take a
1185	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1186		1303
1187	=cut	1304	=cut
1188		1305
1189	sub list_logins {	1306	sub list_logins {
1190	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1191	or return [];	1308	or return [];
1192		1309
1193	my @logins;	1310	my @logins;
1194		1311
1195	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1204	\@logins	1321	\@logins
1205	}	1322	}
1206		1323
1207	=item $player->maps	1324	=item $player->maps
1208		1325
1209	Returns an arrayref of cf::path's of all maps that are private for this	1326	Returns an arrayref of map paths that are private for this
1210	player. May block.	1327	player. May block.
1211		1328
1212	=cut	1329	=cut
1213		1330
1214	sub maps($) {	1331	sub maps($) {
1215	my ($pl) = @_;	1332	my ($pl) = @_;
		1333
		1334	$pl = ref $pl ? $pl->ob->name : $pl;
1216		1335
1217	my $files = aio_readdir playerdir $pl	1336	my $files = aio_readdir playerdir $pl
1218	or return;	1337	or return;
1219		1338
1220	my @paths;	1339	my @paths;
…		…
1222	for (@$files) {	1341	for (@$files) {
1223	utf8::decode $_;	1342	utf8::decode $_;
1224	next if /\.(?:pl|pst)$/;	1343	next if /\.(?:pl|pst)$/;
1225	next unless /^$PATH_SEP/o;	1344	next unless /^$PATH_SEP/o;
1226		1345
1227	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1346	push @paths, cf::map::normalise "~$pl/$_";
1228	}	1347	}
1229		1348
1230	\@paths	1349	\@paths
1231	}	1350	}
1232		1351
1233	=item $player->ext_reply ($msgid, $msgtype, %msg)	1352	=item $player->ext_reply ($msgid, %msg)
1234		1353
1235	Sends an ext reply to the player.	1354	Sends an ext reply to the player.
1236		1355
1237	=cut	1356	=cut
1238		1357
1239	sub ext_reply($$$%) {	1358	sub ext_reply($$%) {
1240	my ($self, $id, %msg) = @_;	1359	my ($self, $id, %msg) = @_;
1241		1360
1242	$msg{msgid} = $id;	1361	$msg{msgid} = $id;
1243		1362
1244	$self->send ("ext " . cf::to_json \%msg);	1363	$self->send ("ext " . cf::to_json \%msg);
1245	}	1364	}
1246		1365
1247	package cf;	1366	=item $player->ext_event ($type, %msg)
		1367
		1368	Sends an ext event to the client.
		1369
		1370	=cut
		1371
		1372	sub ext_event($$%) {
		1373	my ($self, $type, %msg) = @_;
		1374
		1375	$self->ns->ext_event ($type, %msg);
		1376	}
		1377
		1378	=head3 cf::region
		1379
		1380	=over 4
		1381
		1382	=cut
		1383
		1384	package cf::region;
		1385
		1386	=item cf::region::find_by_path $path
		1387
		1388	Tries to decuce the likely region for a map knowing only its path.
		1389
		1390	=cut
		1391
		1392	sub find_by_path($) {
		1393	my ($path) = @_;
		1394
		1395	my ($match, $specificity);
		1396
		1397	for my $region (list) {
		1398	if ($region->match && $path =~ $region->match) {
		1399	($match, $specificity) = ($region, $region->specificity)
		1400	if $region->specificity > $specificity;
		1401	}
		1402	}
		1403
		1404	$match
		1405	}
1248		1406
1249	=back	1407	=back
1250
1251		1408
1252	=head3 cf::map	1409	=head3 cf::map
1253		1410
1254	=over 4	1411	=over 4
1255		1412
…		…
1258	package cf::map;	1415	package cf::map;
1259		1416
1260	use Fcntl;	1417	use Fcntl;
1261	use Coro::AIO;	1418	use Coro::AIO;
1262		1419
		1420	use overload
		1421	'""' => \&as_string,
		1422	fallback => 1;
		1423
1263	our $MAX_RESET = 3600;	1424	our $MAX_RESET = 3600;
1264	our $DEFAULT_RESET = 3000;	1425	our $DEFAULT_RESET = 3000;
1265		1426
1266	sub generate_random_map {	1427	sub generate_random_map {
1267	my ($path, $rmp) = @_;	1428	my ($self, $rmp) = @_;
1268
1269	# mit "rum" bekleckern, nicht	1429	# mit "rum" bekleckern, nicht
1270	cf::map::_create_random_map	1430	$self->_create_random_map (
1271	$path,
1272	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1431	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1273	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1432	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1274	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1433	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1275	$rmp->{exit_on_final_map},	1434	$rmp->{exit_on_final_map},
1276	$rmp->{xsize}, $rmp->{ysize},	1435	$rmp->{xsize}, $rmp->{ysize},
1277	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1436	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1278	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1437	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1279	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1438	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1280	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1439	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1281	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1440	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1282	(cf::region::find $rmp->{region})	1441	(cf::region::find $rmp->{region}), $rmp->{custom}
		1442	)
		1443	}
		1444
		1445	=item cf::map->register ($regex, $prio)
		1446
		1447	Register a handler for the map path matching the given regex at the
		1448	givne priority (higher is better, built-in handlers have priority 0, the
		1449	default).
		1450
		1451	=cut
		1452
		1453	sub register {
		1454	my (undef, $regex, $prio) = @_;
		1455	my $pkg = caller;
		1456
		1457	no strict;
		1458	push @{"$pkg\::ISA"}, __PACKAGE__;
		1459
		1460	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1461	}
		1462
		1463	# also paths starting with '/'
		1464	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1465
		1466	sub thawer_merge {
		1467	my ($self, $merge) = @_;
		1468
		1469	# we have to keep some variables in memory intact
		1470	local $self->{path};
		1471	local $self->{load_path};
		1472
		1473	$self->SUPER::thawer_merge ($merge);
		1474	}
		1475
		1476	sub normalise {
		1477	my ($path, $base) = @_;
		1478
		1479	$path = "$path"; # make sure its a string
		1480
		1481	$path =~ s/\.map$//;
		1482
		1483	# map plan:
		1484	#
		1485	# /! non-realised random map exit (special hack!)
		1486	# {... are special paths that are not being touched
		1487	# ?xxx/... are special absolute paths
		1488	# ?random/... random maps
		1489	# /... normal maps
		1490	# ~user/... per-player map of a specific user
		1491
		1492	$path =~ s/$PATH_SEP/\//go;
		1493
		1494	# treat it as relative path if it starts with
		1495	# something that looks reasonable
		1496	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1497	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1498
		1499	$base =~ s{[^/]+/?$}{};
		1500	$path = "$base/$path";
		1501	}
		1502
		1503	for ($path) {
		1504	redo if s{//}{/};
		1505	redo if s{/\.?/}{/};
		1506	redo if s{/[^/]+/\.\./}{/};
		1507	}
		1508
		1509	$path
		1510	}
		1511
		1512	sub new_from_path {
		1513	my (undef, $path, $base) = @_;
		1514
		1515	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1516
		1517	$path = normalise $path, $base;
		1518
		1519	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1520	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1521	my $self = bless cf::map::new, $pkg;
		1522	$self->{path} = $path; $self->path ($path);
		1523	$self->init; # pass $1 etc.
		1524	return $self;
		1525	}
		1526	}
		1527
		1528	Carp::carp "unable to resolve path '$path' (base '$base').";
		1529	()
		1530	}
		1531
		1532	sub init {
		1533	my ($self) = @_;
		1534
		1535	$self
		1536	}
		1537
		1538	sub as_string {
		1539	my ($self) = @_;
		1540
		1541	"$self->{path}"
		1542	}
		1543
		1544	# the displayed name, this is a one way mapping
		1545	sub visible_name {
		1546	&as_string
		1547	}
		1548
		1549	# the original (read-only) location
		1550	sub load_path {
		1551	my ($self) = @_;
		1552
		1553	"$MAPDIR/$self->{path}.map"
		1554	}
		1555
		1556	# the temporary/swap location
		1557	sub save_path {
		1558	my ($self) = @_;
		1559
		1560	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1561	"$TMPDIR/$path.map"
		1562	}
		1563
		1564	# the unique path, undef == no special unique path
		1565	sub uniq_path {
		1566	my ($self) = @_;
		1567
		1568	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1569	"$UNIQUEDIR/$path"
1283	}	1570	}
1284		1571
1285	# and all this just because we cannot iterate over	1572	# and all this just because we cannot iterate over
1286	# all maps in C++...	1573	# all maps in C++...
1287	sub change_all_map_light {	1574	sub change_all_map_light {
…		…
1289		1576
1290	$_->change_map_light ($change)	1577	$_->change_map_light ($change)
1291	for grep $_->outdoor, values %cf::MAP;	1578	for grep $_->outdoor, values %cf::MAP;
1292	}	1579	}
1293		1580
		1581	sub decay_objects {
		1582	my ($self) = @_;
		1583
		1584	return if $self->{deny_reset};
		1585
		1586	$self->do_decay_objects;
		1587	}
		1588
		1589	sub unlink_save {
		1590	my ($self) = @_;
		1591
		1592	utf8::encode (my $save = $self->save_path);
		1593	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1594	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1595	}
		1596
1294	sub load_map_header($) {	1597	sub load_header_from($) {
1295	my ($path) = @_;	1598	my ($self, $path) = @_;
1296		1599
1297	utf8::encode $path;	1600	utf8::encode $path;
1298	aio_open $path, O_RDONLY, 0	1601	#aio_open $path, O_RDONLY, 0
		1602	# or return;
		1603
		1604	$self->_load_header ($path)
1299	or return;	1605	or return;
1300		1606
1301	my $map = cf::map::new	1607	$self->{load_path} = $path;
		1608
		1609	1
		1610	}
		1611
		1612	sub load_header_orig {
		1613	my ($self) = @_;
		1614
		1615	$self->load_header_from ($self->load_path)
		1616	}
		1617
		1618	sub load_header_temp {
		1619	my ($self) = @_;
		1620
		1621	$self->load_header_from ($self->save_path)
		1622	}
		1623
		1624	sub prepare_temp {
		1625	my ($self) = @_;
		1626
		1627	$self->last_access ((delete $self->{last_access})
		1628	|| $cf::RUNTIME); #d#
		1629	# safety
		1630	$self->{instantiate_time} = $cf::RUNTIME
		1631	if $self->{instantiate_time} > $cf::RUNTIME;
		1632	}
		1633
		1634	sub prepare_orig {
		1635	my ($self) = @_;
		1636
		1637	$self->{load_original} = 1;
		1638	$self->{instantiate_time} = $cf::RUNTIME;
		1639	$self->last_access ($cf::RUNTIME);
		1640	$self->instantiate;
		1641	}
		1642
		1643	sub load_header {
		1644	my ($self) = @_;
		1645
		1646	if ($self->load_header_temp) {
		1647	$self->prepare_temp;
		1648	} else {
		1649	$self->load_header_orig
1302	or return;	1650	or return;
		1651	$self->prepare_orig;
		1652	}
1303		1653
1304	# for better error messages only, will be overwritten later	1654	$self->{deny_reset} = 1
1305	$map->path ($path);	1655	if $self->no_reset;
1306		1656
1307	$map->load_header ($path)	1657	$self->default_region (cf::region::find_by_path $self->{path})
1308	or return;	1658	unless $self->default_region;
1309		1659
1310	$map->{load_path} = $path;	1660	1
1311
1312	$map
1313	}	1661	}
1314		1662
1315	sub find;	1663	sub find;
1316	sub find {	1664	sub find {
1317	my ($path, $origin) = @_;	1665	my ($path, $origin) = @_;
1318		1666
1319	#warn "find<$path,$origin>\n";#d#
1320
1321	$path = new cf::path $path, $origin && $origin->path;	1667	$path = normalise $path, $origin && $origin->path;
1322	my $key = $path->as_string;
1323		1668
1324	cf::lock_wait "map_find:$key";	1669	cf::lock_wait "map_find:$path";
1325		1670
1326	$cf::MAP{$key} || do {	1671	$cf::MAP{$path} || do {
1327	my $guard = cf::lock_acquire "map_find:$key";	1672	my $guard = cf::lock_acquire "map_find:$path";
1328		1673	my $map = new_from_path cf::map $path
1329	# do it the slow way
1330	my $map = $path->load_temp;
1331
1332	Coro::cede;
1333
1334	if ($map) {
1335	$map->last_access ((delete $map->{last_access})
1336	|| $cf::RUNTIME); #d#
1337	# safety
1338	$map->{instantiate_time} = $cf::RUNTIME
1339	if $map->{instantiate_time} > $cf::RUNTIME;
1340	} else {
1341	$map = $path->load_orig
1342	or return;	1674	or return;
1343		1675
1344	$map->{load_original} = 1;
1345	$map->{instantiate_time} = $cf::RUNTIME;
1346	$map->last_access ($cf::RUNTIME);
1347	$map->instantiate;
1348
1349	# per-player maps become, after loading, normal maps
1350	$map->per_player (0) if $path->{user_rel};
1351	}
1352
1353	$map->path ($key);
1354	$map->{path} = $path;
1355	$map->{last_save} = $cf::RUNTIME;	1676	$map->{last_save} = $cf::RUNTIME;
1356		1677
1357	Coro::cede;	1678	$map->load_header
		1679	or return;
1358		1680
1359	if ($map->should_reset) {	1681	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1682	# doing this can freeze the server in a sync job, obviously
		1683	#$cf::WAIT_FOR_TICK->wait;
1360	$map->reset;	1684	$map->reset;
1361	undef $guard;	1685	undef $guard;
1362	$map = find $path	1686	return find $path;
1363	or return;
1364	}	1687	}
1365		1688
1366	$cf::MAP{$key} = $map	1689	$cf::MAP{$path} = $map
1367	}	1690	}
1368	}	1691	}
		1692
		1693	sub pre_load { }
		1694	sub post_load { }
1369		1695
1370	sub load {	1696	sub load {
1371	my ($self) = @_;	1697	my ($self) = @_;
1372		1698
		1699	local $self->{deny_reset} = 1; # loading can take a long time
		1700
1373	my $path = $self->{path};	1701	my $path = $self->{path};
		1702
		1703	{
1374	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1704	my $guard = cf::lock_acquire "map_load:$path";
1375		1705
1376	return if $self->in_memory != cf::MAP_SWAPPED;	1706	return if $self->in_memory != cf::MAP_SWAPPED;
1377		1707
1378	$self->in_memory (cf::MAP_LOADING);	1708	$self->in_memory (cf::MAP_LOADING);
1379		1709
1380	$self->alloc;	1710	$self->alloc;
		1711
		1712	$self->pre_load;
		1713	Coro::cede;
		1714
1381	$self->load_objects ($self->{load_path}, 1)	1715	$self->_load_objects ($self->{load_path}, 1)
1382	or return;	1716	or return;
1383		1717
1384	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1718	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1385	if delete $self->{load_original};	1719	if delete $self->{load_original};
1386		1720
1387	if (my $uniq = $path->uniq_path) {	1721	if (my $uniq = $self->uniq_path) {
1388	utf8::encode $uniq;	1722	utf8::encode $uniq;
1389	if (aio_open $uniq, O_RDONLY, 0) {	1723	if (aio_open $uniq, O_RDONLY, 0) {
1390	$self->clear_unique_items;	1724	$self->clear_unique_items;
1391	$self->load_objects ($uniq, 0);	1725	$self->_load_objects ($uniq, 0);
1392	}	1726	}
1393	}	1727	}
1394		1728
1395	Coro::cede;	1729	Coro::cede;
1396
1397	# now do the right thing for maps	1730	# now do the right thing for maps
1398	$self->link_multipart_objects;	1731	$self->link_multipart_objects;
1399
1400	if ($self->{path}->is_style_map) {
1401	$self->{deny_save} = 1;
1402	$self->{deny_reset} = 1;
1403	} else {
1404	$self->fix_auto_apply;
1405	$self->decay_objects;
1406	$self->update_buttons;
1407	$self->set_darkness_map;
1408	$self->difficulty ($self->estimate_difficulty)	1732	$self->difficulty ($self->estimate_difficulty)
1409	unless $self->difficulty;	1733	unless $self->difficulty;
		1734	Coro::cede;
		1735
		1736	unless ($self->{deny_activate}) {
		1737	$self->decay_objects;
		1738	$self->fix_auto_apply;
		1739	$self->update_buttons;
		1740	Coro::cede;
		1741	$self->set_darkness_map;
		1742	Coro::cede;
1410	$self->activate;	1743	$self->activate;
1411	}	1744	}
1412		1745
1413	Coro::cede;
1414
1415	$self->in_memory (cf::MAP_IN_MEMORY);	1746	$self->in_memory (cf::MAP_IN_MEMORY);
		1747	}
		1748
		1749	$self->post_load;
		1750	}
		1751
		1752	sub customise_for {
		1753	my ($self, $ob) = @_;
		1754
		1755	return find "~" . $ob->name . "/" . $self->{path}
		1756	if $self->per_player;
		1757
		1758	# return find "?party/" . $ob->name . "/" . $self->{path}
		1759	# if $self->per_party;
		1760
		1761	$self
1416	}	1762	}
1417		1763
1418	# find and load all maps in the 3x3 area around a map	1764	# find and load all maps in the 3x3 area around a map
1419	sub load_diag {	1765	sub load_diag {
1420	my ($map) = @_;	1766	my ($map) = @_;
…		…
1450		1796
1451	cf::sync_job { $map->load };	1797	cf::sync_job { $map->load };
1452	}	1798	}
1453		1799
1454	our %MAP_PREFETCH;	1800	our %MAP_PREFETCH;
1455	our $MAP_PREFETCHER = Coro::async {	1801	our $MAP_PREFETCHER = undef;
1456	while () {
1457	while (%MAP_PREFETCH) {
1458	my $key = each %MAP_PREFETCH
1459	or next;
1460	my $path = delete $MAP_PREFETCH{$key};
1461
1462	my $map = find $path
1463	or next;
1464	$map->load;
1465	}
1466	Coro::schedule;
1467	}
1468	};
1469		1802
1470	sub find_async {	1803	sub find_async {
1471	my ($path, $origin) = @_;	1804	my ($path, $origin) = @_;
1472		1805
1473	$path = new cf::path $path, $origin && $origin->path;	1806	$path = normalise $path, $origin && $origin->{path};
1474	my $key = $path->as_string;
1475		1807
1476	if (my $map = $cf::MAP{$key}) {	1808	if (my $map = $cf::MAP{$path}) {
1477	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1809	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1478	}	1810	}
1479		1811
1480	$MAP_PREFETCH{$key} = $path;	1812	undef $MAP_PREFETCH{$path};
		1813	$MAP_PREFETCHER ||= cf::async {
		1814	while (%MAP_PREFETCH) {
		1815	for my $path (keys %MAP_PREFETCH) {
		1816	my $map = find $path
		1817	or next;
		1818	$map->load;
		1819
		1820	delete $MAP_PREFETCH{$path};
		1821	}
		1822	}
		1823	undef $MAP_PREFETCHER;
		1824	};
1481	$MAP_PREFETCHER->ready;	1825	$MAP_PREFETCHER->prio (6);
1482		1826
1483	()	1827	()
1484	}	1828	}
1485		1829
1486	sub save {	1830	sub save {
…		…
1490		1834
1491	$self->{last_save} = $cf::RUNTIME;	1835	$self->{last_save} = $cf::RUNTIME;
1492		1836
1493	return unless $self->dirty;	1837	return unless $self->dirty;
1494		1838
1495	my $save = $self->{path}->save_path; utf8::encode $save;	1839	my $save = $self->save_path; utf8::encode $save;
1496	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1840	my $uniq = $self->uniq_path; utf8::encode $uniq;
1497		1841
1498	$self->{load_path} = $save;	1842	$self->{load_path} = $save;
1499		1843
1500	return if $self->{deny_save};	1844	return if $self->{deny_save};
1501		1845
…		…
1504	cf::async {	1848	cf::async {
1505	$_->contr->save for $self->players;	1849	$_->contr->save for $self->players;
1506	};	1850	};
1507		1851
1508	if ($uniq) {	1852	if ($uniq) {
1509	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1853	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1510	$self->save_objects ($uniq, cf::IO_UNIQUES);	1854	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1511	} else {	1855	} else {
1512	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1856	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1513	}	1857	}
1514	}	1858	}
1515		1859
1516	sub swap_out {	1860	sub swap_out {
1517	my ($self) = @_;	1861	my ($self) = @_;
…		…
1531		1875
1532	sub reset_at {	1876	sub reset_at {
1533	my ($self) = @_;	1877	my ($self) = @_;
1534		1878
1535	# TODO: safety, remove and allow resettable per-player maps	1879	# TODO: safety, remove and allow resettable per-player maps
1536	return 1e99 if $self->{path}{user_rel};
1537	return 1e99 if $self->{deny_reset};	1880	return 1e99 if $self->{deny_reset};
1538		1881
1539	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1882	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1540	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1883	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1541		1884
…		…
1546	my ($self) = @_;	1889	my ($self) = @_;
1547		1890
1548	$self->reset_at <= $cf::RUNTIME	1891	$self->reset_at <= $cf::RUNTIME
1549	}	1892	}
1550		1893
1551	sub unlink_save {
1552	my ($self) = @_;
1553
1554	utf8::encode (my $save = $self->{path}->save_path);
1555	aioreq_pri 3; IO::AIO::aio_unlink $save;
1556	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1557	}
1558
1559	sub rename {
1560	my ($self, $new_path) = @_;
1561
1562	$self->unlink_save;
1563
1564	delete $cf::MAP{$self->path};
1565	$self->{path} = new cf::path $new_path;
1566	$self->path ($self->{path}->as_string);
1567	$cf::MAP{$self->path} = $self;
1568
1569	$self->save;
1570	}
1571
1572	sub reset {	1894	sub reset {
1573	my ($self) = @_;	1895	my ($self) = @_;
1574		1896
1575	my $lock = cf::lock_acquire "map_data:" . $self->path;	1897	my $lock = cf::lock_acquire "map_data:$self->{path}";
1576		1898
1577	return if $self->players;	1899	return if $self->players;
1578	return if $self->{path}{user_rel};#d#
1579		1900
1580	warn "resetting map ", $self->path;#d#	1901	warn "resetting map ", $self->path;
		1902
		1903	$self->in_memory (cf::MAP_SWAPPED);
		1904
		1905	# need to save uniques path
		1906	unless ($self->{deny_save}) {
		1907	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1908
		1909	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1910	if $uniq;
		1911	}
1581		1912
1582	delete $cf::MAP{$self->path};	1913	delete $cf::MAP{$self->path};
		1914
		1915	$self->clear;
1583		1916
1584	$_->clear_links_to ($self) for values %cf::MAP;	1917	$_->clear_links_to ($self) for values %cf::MAP;
1585		1918
1586	$self->unlink_save;	1919	$self->unlink_save;
1587	$self->destroy;	1920	$self->destroy;
…		…
1590	my $nuke_counter = "aaaa";	1923	my $nuke_counter = "aaaa";
1591		1924
1592	sub nuke {	1925	sub nuke {
1593	my ($self) = @_;	1926	my ($self) = @_;
1594		1927
		1928	delete $cf::MAP{$self->path};
		1929
		1930	$self->unlink_save;
		1931
		1932	bless $self, "cf::map";
		1933	delete $self->{deny_reset};
1595	$self->{deny_save} = 1;	1934	$self->{deny_save} = 1;
1596	$self->reset_timeout (1);	1935	$self->reset_timeout (1);
1597	$self->rename ("{nuke}/" . ($nuke_counter++));	1936	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1937
		1938	$cf::MAP{$self->path} = $self;
		1939
1598	$self->reset; # polite request, might not happen	1940	$self->reset; # polite request, might not happen
1599	}	1941	}
1600		1942
1601	sub customise_for {	1943	=item $maps = cf::map::tmp_maps
1602	my ($map, $ob) = @_;
1603		1944
1604	if ($map->per_player) {	1945	Returns an arrayref with all map paths of currently instantiated and saved
1605	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	1946	maps. May block.
		1947
		1948	=cut
		1949
		1950	sub tmp_maps() {
1606	}	1951	[
		1952	map {
		1953	utf8::decode $_;
		1954	/\.map$/
		1955	? normalise $_
		1956	: ()
		1957	} @{ aio_readdir $TMPDIR or [] }
		1958	]
		1959	}
1607		1960
1608	$map	1961	=item $maps = cf::map::random_maps
		1962
		1963	Returns an arrayref with all map paths of currently instantiated and saved
		1964	random maps. May block.
		1965
		1966	=cut
		1967
		1968	sub random_maps() {
		1969	[
		1970	map {
		1971	utf8::decode $_;
		1972	/\.map$/
		1973	? normalise "?random/$_"
		1974	: ()
		1975	} @{ aio_readdir $RANDOMDIR or [] }
		1976	]
1609	}	1977	}
1610		1978
1611	=item cf::map::unique_maps	1979	=item cf::map::unique_maps
1612		1980
1613	Returns an arrayref of cf::path's of all shared maps that have	1981	Returns an arrayref of paths of all shared maps that have
1614	instantiated unique items. May block.	1982	instantiated unique items. May block.
1615		1983
1616	=cut	1984	=cut
1617		1985
1618	sub unique_maps() {	1986	sub unique_maps() {
1619	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	1987	[
1620	or return;	1988	map {
1621
1622	my @paths;
1623
1624	for (@$files) {
1625	utf8::decode $_;	1989	utf8::decode $_;
1626	next if /\.pst$/;	1990	/\.map$/
1627	next unless /^$PATH_SEP/o;	1991	? normalise $_
1628		1992	: ()
1629	push @paths, new cf::path $_;	1993	} @{ aio_readdir $UNIQUEDIR or [] }
1630	}	1994	]
1631
1632	\@paths
1633	}	1995	}
1634		1996
1635	package cf;	1997	package cf;
1636		1998
1637	=back	1999	=back
…		…
1709		2071
1710	=item $player_object->enter_link	2072	=item $player_object->enter_link
1711		2073
1712	Freezes the player and moves him/her to a special map (C<{link}>).	2074	Freezes the player and moves him/her to a special map (C<{link}>).
1713		2075
1714	The player should be reaosnably safe there for short amounts of time. You	2076	The player should be reasonably safe there for short amounts of time. You
1715	I<MUST> call C<leave_link> as soon as possible, though.	2077	I<MUST> call C<leave_link> as soon as possible, though.
1716		2078
		2079	Will never block.
		2080
1717	=item $player_object->leave_link ($map, $x, $y)	2081	=item $player_object->leave_link ($map, $x, $y)
1718		2082
1719	Moves the player out of the specila link map onto the given map. If the	2083	Moves the player out of the special C<{link}> map onto the specified
1720	map is not valid (or omitted), the player will be moved back to the	2084	map. If the map is not valid (or omitted), the player will be moved back
1721	location he/she was before the call to C<enter_link>, or, if that fails,	2085	to the location he/she was before the call to C<enter_link>, or, if that
1722	to the emergency map position.	2086	fails, to the emergency map position.
1723		2087
1724	Might block.	2088	Might block.
1725		2089
1726	=cut	2090	=cut
		2091
		2092	sub link_map {
		2093	unless ($LINK_MAP) {
		2094	$LINK_MAP = cf::map::find "{link}"
		2095	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2096	$LINK_MAP->load;
		2097	}
		2098
		2099	$LINK_MAP
		2100	}
1727		2101
1728	sub cf::object::player::enter_link {	2102	sub cf::object::player::enter_link {
1729	my ($self) = @_;	2103	my ($self) = @_;
1730		2104
1731	$self->deactivate_recursive;	2105	$self->deactivate_recursive;
1732		2106
1733	return if $self->map == $LINK_MAP;	2107	return if UNIVERSAL::isa $self->map, "ext::map_link";
1734		2108
1735	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2109	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1736	if $self->map;	2110	if $self->map && $self->map->{path} ne "{link}";
1737		2111
1738	$self->enter_map ($LINK_MAP, 20, 20);	2112	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1739	}	2113	}
1740		2114
1741	sub cf::object::player::leave_link {	2115	sub cf::object::player::leave_link {
1742	my ($self, $map, $x, $y) = @_;	2116	my ($self, $map, $x, $y) = @_;
		2117
		2118	return unless $self->contr->active;
1743		2119
1744	my $link_pos = delete $self->{_link_pos};	2120	my $link_pos = delete $self->{_link_pos};
1745		2121
1746	unless ($map) {	2122	unless ($map) {
1747	# restore original map position	2123	# restore original map position
…		…
1765	$map->load;	2141	$map->load;
1766	$map->load_diag;	2142	$map->load_diag;
1767		2143
1768	return unless $self->contr->active;	2144	return unless $self->contr->active;
1769	$self->activate_recursive;	2145	$self->activate_recursive;
		2146
		2147	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1770	$self->enter_map ($map, $x, $y);	2148	$self->enter_map ($map, $x, $y);
1771	}	2149	}
1772		2150
1773	cf::player->attach (
1774	on_logout => sub {
1775	my ($pl) = @_;
1776
1777	# abort map switching before logout
1778	if ($pl->ob->{_link_pos}) {
1779	cf::sync_job {
1780	$pl->ob->leave_link
1781	};
1782	}
1783	},
1784	on_login => sub {
1785	my ($pl) = @_;
1786
1787	# try to abort aborted map switching on player login :)
1788	# should happen only on crashes
1789	if ($pl->ob->{_link_pos}) {
1790	$pl->ob->enter_link;
1791	(async {
1792	# we need this sleep as the login has a concurrent enter_exit running
1793	# and this sleep increases chances of the player not ending up in scorn
1794	$pl->ob->reply (undef,
1795	"There was an internal problem at your last logout, "
1796	. "the server will try to bring you to your intended destination in a second.",
1797	cf::NDI_RED);
1798	Coro::Timer::sleep 1;
1799	$pl->ob->leave_link;
1800	})->prio (2);
1801	}
1802	},
1803	);
1804
1805	=item $player_object->goto ($path, $x, $y)	2151	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1806		2152
		2153	Moves the player to the given map-path and coordinates by first freezing
		2154	her, loading and preparing them map, calling the provided $check callback
		2155	that has to return the map if sucecssful, and then unfreezes the player on
		2156	the new (success) or old (failed) map position.
		2157
1807	=cut	2158	=cut
		2159
		2160	our $GOTOGEN;
1808		2161
1809	sub cf::object::player::goto {	2162	sub cf::object::player::goto {
1810	my ($self, $path, $x, $y) = @_;	2163	my ($self, $path, $x, $y, $check) = @_;
1811		2164
1812	$path = new cf::path $path;	2165	# do generation counting so two concurrent goto's will be executed in-order
		2166	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1813		2167
1814	$self->enter_link;	2168	$self->enter_link;
1815		2169
1816	(async {	2170	(async {
		2171	my $map = eval {
1817	my $map = cf::map::find $path->as_string;	2172	my $map = cf::map::find $path;
		2173
		2174	if ($map) {
1818	$map = $map->customise_for ($self) if $map;	2175	$map = $map->customise_for ($self);
1819		2176	$map = $check->($map) if $check && $map;
1820	# warn "entering ", $map->path, " at ($x, $y)\n"	2177	} else {
1821	# if $map;
1822
1823	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2178	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2179	}
1824		2180
		2181	$map
		2182	};
		2183
		2184	if ($@) {
		2185	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2186	LOG llevError | logBacktrace, Carp::longmess $@;
		2187	}
		2188
		2189	if ($gen == $self->{_goto_generation}) {
		2190	delete $self->{_goto_generation};
1825	$self->leave_link ($map, $x, $y);	2191	$self->leave_link ($map, $x, $y);
		2192	}
1826	})->prio (1);	2193	})->prio (1);
1827	}	2194	}
1828		2195
1829	=item $player_object->enter_exit ($exit_object)	2196	=item $player_object->enter_exit ($exit_object)
1830		2197
…		…
1832		2199
1833	sub parse_random_map_params {	2200	sub parse_random_map_params {
1834	my ($spec) = @_;	2201	my ($spec) = @_;
1835		2202
1836	my $rmp = { # defaults	2203	my $rmp = { # defaults
1837	xsize => 10,	2204	xsize => (cf::rndm 15, 40),
1838	ysize => 10,	2205	ysize => (cf::rndm 15, 40),
		2206	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2207	#layout => string,
1839	};	2208	};
1840		2209
1841	for (split /\n/, $spec) {	2210	for (split /\n/, $spec) {
1842	my ($k, $v) = split /\s+/, $_, 2;	2211	my ($k, $v) = split /\s+/, $_, 2;
1843		2212
…		…
1847	$rmp	2216	$rmp
1848	}	2217	}
1849		2218
1850	sub prepare_random_map {	2219	sub prepare_random_map {
1851	my ($exit) = @_;	2220	my ($exit) = @_;
		2221
		2222	my $guard = cf::lock_acquire "exit_prepare:$exit";
1852		2223
1853	# all this does is basically replace the /! path by	2224	# all this does is basically replace the /! path by
1854	# a new random map path (?random/...) with a seed	2225	# a new random map path (?random/...) with a seed
1855	# that depends on the exit object	2226	# that depends on the exit object
1856		2227
1857	my $rmp = parse_random_map_params $exit->msg;	2228	my $rmp = parse_random_map_params $exit->msg;
1858		2229
1859	if ($exit->map) {	2230	if ($exit->map) {
1860	$rmp->{region} = $exit->map->region_name;	2231	$rmp->{region} = $exit->region->name;
1861	$rmp->{origin_map} = $exit->map->path;	2232	$rmp->{origin_map} = $exit->map->path;
1862	$rmp->{origin_x} = $exit->x;	2233	$rmp->{origin_x} = $exit->x;
1863	$rmp->{origin_y} = $exit->y;	2234	$rmp->{origin_y} = $exit->y;
1864	}	2235	}
1865		2236
1866	$rmp->{random_seed} ||= $exit->random_seed;	2237	$rmp->{random_seed} ||= $exit->random_seed;
1867		2238
1868	my $data = cf::to_json $rmp;	2239	my $data = cf::to_json $rmp;
1869	my $md5 = Digest::MD5::md5_hex $data;	2240	my $md5 = Digest::MD5::md5_hex $data;
		2241	my $meta = "$RANDOMDIR/$md5.meta";
1870		2242
1871	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2243	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1872	aio_write $fh, 0, (length $data), $data, 0;	2244	aio_write $fh, 0, (length $data), $data, 0;
		2245	undef $fh;
		2246	aio_rename "$meta~", $meta;
1873		2247
1874	$exit->slaying ("?random/$md5");	2248	$exit->slaying ("?random/$md5");
1875	$exit->msg (undef);	2249	$exit->msg (undef);
1876	}	2250	}
1877	}	2251	}
1878		2252
1879	sub cf::object::player::enter_exit {	2253	sub cf::object::player::enter_exit {
1880	my ($self, $exit) = @_;	2254	my ($self, $exit) = @_;
1881		2255
1882	return unless $self->type == cf::PLAYER;	2256	return unless $self->type == cf::PLAYER;
		2257
		2258	if ($exit->slaying eq "/!") {
		2259	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2260	# the problem is that $exit might not survive long enough
		2261	# so it needs to be done right now, right here
		2262	cf::sync_job { prepare_random_map $exit };
		2263	}
		2264
		2265	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2266	my $hp = $exit->stats->hp;
		2267	my $sp = $exit->stats->sp;
1883		2268
1884	$self->enter_link;	2269	$self->enter_link;
1885		2270
1886	(async {	2271	(async {
1887	$self->deactivate_recursive; # just to be sure	2272	$self->deactivate_recursive; # just to be sure
1888	unless (eval {	2273	unless (eval {
1889	prepare_random_map $exit	2274	$self->goto ($slaying, $hp, $sp);
1890	if $exit->slaying eq "/!";
1891
1892	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1893	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1894		2275
1895	1;	2276	1;
1896	}) {	2277	}) {
1897	$self->message ("Something went wrong deep within the crossfire server. "	2278	$self->message ("Something went wrong deep within the crossfire server. "
1898	. "I'll try to bring you back to the map you were before. "	2279	. "I'll try to bring you back to the map you were before. "
1899	. "Please report this to the dungeon master!",	2280	. "Please report this to the dungeon master!",
1900	cf::NDI_UNIQUE | cf::NDI_RED);	2281	cf::NDI_UNIQUE | cf::NDI_RED);
1901		2282
1902	warn "ERROR in enter_exit: $@";	2283	warn "ERROR in enter_exit: $@";
1903	$self->leave_link;	2284	$self->leave_link;
1904	}	2285	}
1905	})->prio (1);	2286	})->prio (1);
…		…
1918		2299
1919	sub cf::client::send_drawinfo {	2300	sub cf::client::send_drawinfo {
1920	my ($self, $text, $flags) = @_;	2301	my ($self, $text, $flags) = @_;
1921		2302
1922	utf8::encode $text;	2303	utf8::encode $text;
1923	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2304	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1924	}	2305	}
1925		2306
		2307	=item $client->ext_event ($type, %msg)
		2308
		2309	Sends an exti event to the client.
		2310
		2311	=cut
		2312
		2313	sub cf::client::ext_event($$%) {
		2314	my ($self, $type, %msg) = @_;
		2315
		2316	$msg{msgtype} = "event_$type";
		2317	$self->send_packet ("ext " . cf::to_json \%msg);
		2318	}
1926		2319
1927	=item $success = $client->query ($flags, "text", \&cb)	2320	=item $success = $client->query ($flags, "text", \&cb)
1928		2321
1929	Queues a query to the client, calling the given callback with	2322	Queues a query to the client, calling the given callback with
1930	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2323	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1959	# get handled first	2352	# get handled first
1960	my $queue = delete $ns->{query_queue}	2353	my $queue = delete $ns->{query_queue}
1961	or return; # be conservative, not sure how that can happen, but we saw a crash here	2354	or return; # be conservative, not sure how that can happen, but we saw a crash here
1962		2355
1963	(shift @$queue)->[1]->($msg);	2356	(shift @$queue)->[1]->($msg);
		2357	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1964		2358
1965	push @{ $ns->{query_queue} }, @$queue;	2359	push @{ $ns->{query_queue} }, @$queue;
1966		2360
1967	if (@{ $ns->{query_queue} } == @$queue) {	2361	if (@{ $ns->{query_queue} } == @$queue) {
1968	if (@$queue) {	2362	if (@$queue) {
…		…
2026		2420
2027	# here we export the classes and methods available to script code	2421	# here we export the classes and methods available to script code
2028		2422
2029	=pod	2423	=pod
2030		2424
2031	The following fucntions and emthods are available within a safe environment:	2425	The following functions and methods are available within a safe environment:
2032		2426
2033	cf::object contr pay_amount pay_player map	2427	cf::object contr pay_amount pay_player map
2034	cf::object::player player	2428	cf::object::player player
2035	cf::player peaceful	2429	cf::player peaceful
2036	cf::map trigger	2430	cf::map trigger
…		…
2117	=back	2511	=back
2118		2512
2119	=cut	2513	=cut
2120		2514
2121	#############################################################################	2515	#############################################################################
		2516	# the server's init and main functions
2122		2517
2123	=head2 EXTENSION DATABASE SUPPORT	2518	sub load_facedata($) {
		2519	my ($path) = @_;
2124		2520
2125	Crossfire maintains a very simple database for extension use. It can	2521	warn "loading facedata from $path\n";
2126	currently store anything that can be serialised using Storable, which
2127	excludes objects.
2128		2522
2129	The parameter C<$family> should best start with the name of the extension	2523	my $facedata;
2130	using it, it should be unique.	2524	0 < aio_load $path, $facedata
		2525	or die "$path: $!";
2131		2526
2132	=over 4	2527	$facedata = Coro::Storable::thaw $facedata;
2133		2528
2134	=item $hashref = cf::db_get $family	2529	$facedata->{version} == 2
		2530	or cf::cleanup "$path: version mismatch, cannot proceed.";
2135		2531
2136	Return a hashref for use by the extension C<$family>, which can be
2137	modified. After modifications, you have to call C<cf::db_dirty> or
2138	C<cf::db_sync>.
2139
2140	=item $value = cf::db_get $family => $key
2141
2142	Returns a single value from the database
2143
2144	=item cf::db_put $family => $hashref
2145
2146	Stores the given family hashref into the database. Updates are delayed, if
2147	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2148
2149	=item cf::db_put $family => $key => $value
2150
2151	Stores the given C<$value> in the family hash. Updates are delayed, if you
2152	want the data to be synced to disk immediately, use C<cf::db_sync>.
2153
2154	=item cf::db_dirty
2155
2156	Marks the database as dirty, to be updated at a later time.
2157
2158	=item cf::db_sync
2159
2160	Immediately write the database to disk I<if it is dirty>.
2161
2162	=cut
2163
2164	our $DB;
2165
2166	{
2167	my $path = cf::localdir . "/database.pst";
2168
2169	sub db_load() {
2170	$DB = stat $path ? Storable::retrieve $path : { };
2171	}	2532	{
		2533	my $faces = $facedata->{faceinfo};
2172		2534
2173	my $pid;	2535	while (my ($face, $info) = each %$faces) {
2174		2536	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2175	sub db_save() {	2537	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2176	waitpid $pid, 0 if $pid;	2538	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2177	if (0 == ($pid = fork)) {	2539	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2178	$DB->{_meta}{version} = 1;	2540	Coro::cede;
2179	Storable::nstore $DB, "$path~";
2180	rename "$path~", $path;
2181	cf::_exit 0 if defined $pid;
2182	}
2183	}
2184
2185	my $dirty;
2186
2187	sub db_sync() {
2188	db_save if $dirty;
2189	undef $dirty;
2190	}
2191
2192	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2193	db_sync;
2194	});
2195
2196	sub db_dirty() {
2197	$dirty = 1;
2198	$idle->start;
2199	}
2200
2201	sub db_get($;$) {
2202	@_ >= 2
2203	? $DB->{$_[0]}{$_[1]}
2204	: ($DB->{$_[0]} ||= { })
2205	}
2206
2207	sub db_put($$;$) {
2208	if (@_ >= 3) {
2209	$DB->{$_[0]}{$_[1]} = $_[2];
2210	} else {
2211	$DB->{$_[0]} = $_[1];
2212	}
2213	db_dirty;
2214	}
2215
2216	cf::global->attach (
2217	prio => 10000,
2218	on_cleanup => sub {
2219	db_sync;
2220	},	2541	}
2221	);
2222	}
2223		2542
2224	#############################################################################	2543	while (my ($face, $info) = each %$faces) {
2225	# the server's main()	2544	next unless $info->{smooth};
		2545	my $idx = cf::face::find $face
		2546	or next;
		2547	if (my $smooth = cf::face::find $info->{smooth}) {
		2548	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2549	} else {
		2550	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2551	}
		2552	Coro::cede;
		2553	}
		2554	}
		2555
		2556	{
		2557	my $anims = $facedata->{animinfo};
		2558
		2559	while (my ($anim, $info) = each %$anims) {
		2560	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2561	Coro::cede;
		2562	}
		2563
		2564	cf::anim::invalidate_all; # d'oh
		2565	}
		2566
		2567	1
		2568	}
		2569
		2570	sub reload_regions {
		2571	load_resource_file "$MAPDIR/regions"
		2572	or die "unable to load regions file\n";
		2573	}
		2574
		2575	sub reload_facedata {
		2576	load_facedata "$DATADIR/facedata"
		2577	or die "unable to load facedata\n";
		2578	}
		2579
		2580	sub reload_archetypes {
		2581	load_resource_file "$DATADIR/archetypes"
		2582	or die "unable to load archetypes\n";
		2583	}
		2584
		2585	sub reload_treasures {
		2586	load_resource_file "$DATADIR/treasures"
		2587	or die "unable to load treasurelists\n";
		2588	}
		2589
		2590	sub reload_resources {
		2591	warn "reloading resource files...\n";
		2592
		2593	reload_regions;
		2594	reload_facedata;
		2595	#reload_archetypes;#d#
		2596	reload_archetypes;
		2597	reload_treasures;
		2598
		2599	warn "finished reloading resource files\n";
		2600	}
		2601
		2602	sub init {
		2603	reload_resources;
		2604	}
2226		2605
2227	sub cfg_load {	2606	sub cfg_load {
2228	open my $fh, "<:utf8", cf::confdir . "/config"	2607	open my $fh, "<:utf8", "$CONFDIR/config"
2229	or return;	2608	or return;
2230		2609
2231	local $/;	2610	local $/;
2232	*CFG = YAML::Syck::Load <$fh>;	2611	*CFG = YAML::Syck::Load <$fh>;
2233		2612
…		…
2247		2626
2248	sub main {	2627	sub main {
2249	# we must not ever block the main coroutine	2628	# we must not ever block the main coroutine
2250	local $Coro::idle = sub {	2629	local $Coro::idle = sub {
2251	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2630	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2631	(async {
2252	async { Event::one_event };	2632	Event::one_event;
		2633	})->prio (Coro::PRIO_MAX);
2253	};	2634	};
2254		2635
2255	cfg_load;	2636	cfg_load;
2256	db_load;	2637	db_init;
2257	load_extensions;	2638	load_extensions;
		2639
		2640	$TICK_WATCHER->start;
2258	Event::loop;	2641	Event::loop;
2259	}	2642	}
2260		2643
2261	#############################################################################	2644	#############################################################################
2262	# initialisation and cleanup	2645	# initialisation and cleanup
2263		2646
2264	# install some emergency cleanup handlers	2647	# install some emergency cleanup handlers
2265	BEGIN {	2648	BEGIN {
2266	for my $signal (qw(INT HUP TERM)) {	2649	for my $signal (qw(INT HUP TERM)) {
2267	Event->signal (	2650	Event->signal (
		2651	reentrant => 0,
2268	data => WF_AUTOCANCEL,	2652	data => WF_AUTOCANCEL,
2269	signal => $signal,	2653	signal => $signal,
		2654	prio => 0,
2270	cb => sub {	2655	cb => sub {
2271	cf::cleanup "SIG$signal";	2656	cf::cleanup "SIG$signal";
2272	},	2657	},
2273	);	2658	);
2274	}	2659	}
2275	}	2660	}
2276		2661
		2662	sub write_runtime {
		2663	my $runtime = "$LOCALDIR/runtime";
		2664
		2665	# first touch the runtime file to show we are still running:
		2666	# the fsync below can take a very very long time.
		2667
		2668	IO::AIO::aio_utime $runtime, undef, undef;
		2669
		2670	my $guard = cf::lock_acquire "write_runtime";
		2671
		2672	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2673	or return;
		2674
		2675	my $value = $cf::RUNTIME + 90 + 10;
		2676	# 10 is the runtime save interval, for a monotonic clock
		2677	# 60 allows for the watchdog to kill the server.
		2678
		2679	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2680	and return;
		2681
		2682	# always fsync - this file is important
		2683	aio_fsync $fh
		2684	and return;
		2685
		2686	# touch it again to show we are up-to-date
		2687	aio_utime $fh, undef, undef;
		2688
		2689	close $fh
		2690	or return;
		2691
		2692	aio_rename "$runtime~", $runtime
		2693	and return;
		2694
		2695	warn "runtime file written.\n";
		2696
		2697	1
		2698	}
		2699
2277	sub emergency_save() {	2700	sub emergency_save() {
2278	my $freeze_guard = cf::freeze_mainloop;	2701	my $freeze_guard = cf::freeze_mainloop;
2279		2702
2280	warn "enter emergency perl save\n";	2703	warn "enter emergency perl save\n";
2281		2704
2282	cf::sync_job {	2705	cf::sync_job {
2283	# use a peculiar iteration method to avoid tripping on perl	2706	# use a peculiar iteration method to avoid tripping on perl
2284	# refcount bugs in for. also avoids problems with players	2707	# refcount bugs in for. also avoids problems with players
2285	# and maps saved/Destroyed asynchronously.	2708	# and maps saved/destroyed asynchronously.
2286	warn "begin emergency player save\n";	2709	warn "begin emergency player save\n";
2287	for my $login (keys %cf::PLAYER) {	2710	for my $login (keys %cf::PLAYER) {
2288	my $pl = $cf::PLAYER{$login} or next;	2711	my $pl = $cf::PLAYER{$login} or next;
2289	$pl->valid or next;	2712	$pl->valid or next;
2290	$pl->save;	2713	$pl->save;
…		…
2296	my $map = $cf::MAP{$path} or next;	2719	my $map = $cf::MAP{$path} or next;
2297	$map->valid or next;	2720	$map->valid or next;
2298	$map->save;	2721	$map->save;
2299	}	2722	}
2300	warn "end emergency map save\n";	2723	warn "end emergency map save\n";
		2724
		2725	warn "begin emergency database checkpoint\n";
		2726	BDB::db_env_txn_checkpoint $DB_ENV;
		2727	warn "end emergency database checkpoint\n";
2301	};	2728	};
2302		2729
2303	warn "leave emergency perl save\n";	2730	warn "leave emergency perl save\n";
2304	}	2731	}
2305		2732
		2733	sub post_cleanup {
		2734	my ($make_core) = @_;
		2735
		2736	warn Carp::longmess "post_cleanup backtrace"
		2737	if $make_core;
		2738	}
		2739
2306	sub reload() {	2740	sub do_reload_perl() {
2307	# can/must only be called in main	2741	# can/must only be called in main
2308	if ($Coro::current != $Coro::main) {	2742	if ($Coro::current != $Coro::main) {
2309	warn "can only reload from main coroutine\n";	2743	warn "can only reload from main coroutine";
2310	return;	2744	return;
2311	}	2745	}
2312		2746
2313	warn "reloading...";	2747	warn "reloading...";
2314		2748
2315	warn "freezing server";	2749	warn "entering sync_job";
2316	my $guard = freeze_mainloop;	2750
		2751	cf::sync_job {
		2752	cf::write_runtime; # external watchdog should not bark
2317	cf::emergency_save;	2753	cf::emergency_save;
		2754	cf::write_runtime; # external watchdog should not bark
2318		2755
2319	warn "sync database to disk";	2756	warn "syncing database to disk";
2320	cf::db_sync;	2757	BDB::db_env_txn_checkpoint $DB_ENV;
2321	IO::AIO::flush;
2322		2758
2323	eval {
2324	# if anything goes wrong in here, we should simply crash as we already saved	2759	# if anything goes wrong in here, we should simply crash as we already saved
2325		2760
2326	warn "cancel all watchers";	2761	warn "cancelling all WF_AUTOCANCEL watchers";
2327	for (Event::all_watchers) {	2762	for (Event::all_watchers) {
2328	$_->cancel if $_->data & WF_AUTOCANCEL;	2763	$_->cancel if $_->data & WF_AUTOCANCEL;
2329	}	2764	}
2330		2765
		2766	warn "flushing outstanding aio requests";
		2767	for (;;) {
		2768	BDB::flush;
		2769	IO::AIO::flush;
		2770	Coro::cede;
		2771	last unless IO::AIO::nreqs || BDB::nreqs;
		2772	warn "iterate...";
		2773	}
		2774
		2775	++$RELOAD;
		2776
2331	warn "cancel all extension coros";	2777	warn "cancelling all extension coros";
2332	$_->cancel for values %EXT_CORO;	2778	$_->cancel for values %EXT_CORO;
2333	%EXT_CORO = ();	2779	%EXT_CORO = ();
2334		2780
2335	warn "remove commands";	2781	warn "removing commands";
2336	%COMMAND = ();	2782	%COMMAND = ();
2337		2783
2338	warn "remove ext commands";	2784	warn "removing ext commands";
2339	%EXTCMD = ();	2785	%EXTCMD = ();
2340		2786
2341	warn "unload/nuke all extensions";	2787	warn "unloading/nuking all extensions";
2342	for my $pkg (@EXTS) {	2788	for my $pkg (@EXTS) {
2343	warn "... unloading $pkg";	2789	warn "... unloading $pkg";
2344		2790
2345	if (my $cb = $pkg->can ("unload")) {	2791	if (my $cb = $pkg->can ("unload")) {
2346	eval {	2792	eval {
…		…
2351		2797
2352	warn "... nuking $pkg";	2798	warn "... nuking $pkg";
2353	Symbol::delete_package $pkg;	2799	Symbol::delete_package $pkg;
2354	}	2800	}
2355		2801
2356	warn "unload all perl modules loaded from $LIBDIR";	2802	warn "unloading all perl modules loaded from $LIBDIR";
2357	while (my ($k, $v) = each %INC) {	2803	while (my ($k, $v) = each %INC) {
2358	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2804	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2359		2805
2360	warn "removing <$k>";	2806	warn "... unloading $k";
2361	delete $INC{$k};	2807	delete $INC{$k};
2362		2808
2363	$k =~ s/\.pm$//;	2809	$k =~ s/\.pm$//;
2364	$k =~ s/\//::/g;	2810	$k =~ s/\//::/g;
2365		2811
…		…
2368	}	2814	}
2369		2815
2370	Symbol::delete_package $k;	2816	Symbol::delete_package $k;
2371	}	2817	}
2372		2818
2373	warn "get rid of safe::, as good as possible";	2819	warn "getting rid of safe::, as good as possible";
2374	Symbol::delete_package "safe::$_"	2820	Symbol::delete_package "safe::$_"
2375	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2821	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2376		2822
2377	warn "unload cf.pm \"a bit\"";	2823	warn "unloading cf.pm \"a bit\"";
2378	delete $INC{"cf.pm"};	2824	delete $INC{"cf.pm"};
		2825	delete $INC{"cf/pod.pm"};
2379		2826
2380	# don't, removes xs symbols, too,	2827	# don't, removes xs symbols, too,
2381	# and global variables created in xs	2828	# and global variables created in xs
2382	#Symbol::delete_package __PACKAGE__;	2829	#Symbol::delete_package __PACKAGE__;
2383		2830
		2831	warn "unload completed, starting to reload now";
		2832
2384	warn "reloading cf.pm";	2833	warn "reloading cf.pm";
2385	require cf;	2834	require cf;
2386	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2387		2836
2388	warn "load config and database again";	2837	warn "loading config and database again";
2389	cf::cfg_load;	2838	cf::cfg_load;
2390	cf::db_load;
2391		2839
2392	warn "load extensions";	2840	warn "loading extensions";
2393	cf::load_extensions;	2841	cf::load_extensions;
2394		2842
2395	warn "reattach attachments to objects/players";	2843	warn "reattaching attachments to objects/players";
2396	_global_reattach;	2844	_global_reattach; # objects, sockets
2397	warn "reattach attachments to maps";	2845	warn "reattaching attachments to maps";
2398	reattach $_ for values %MAP;	2846	reattach $_ for values %MAP;
2399	};	2847	warn "reattaching attachments to players";
		2848	reattach $_ for values %PLAYER;
2400		2849
2401	if ($@) {	2850	warn "leaving sync_job";
		2851
		2852	1
		2853	} or do {
2402	warn $@;	2854	warn $@;
2403	warn "error while reloading, exiting.";	2855	warn "error while reloading, exiting.";
2404	exit 1;	2856	exit 1;
2405	}	2857	};
2406		2858
2407	warn "reloaded";	2859	warn "reloaded";
2408	};	2860	};
2409		2861
2410	#############################################################################	2862	our $RELOAD_WATCHER; # used only during reload
2411		2863
2412	unless ($LINK_MAP) {	2864	sub reload_perl() {
2413	$LINK_MAP = cf::map::new;	2865	# doing reload synchronously and two reloads happen back-to-back,
		2866	# coro crashes during coro_state_free->destroy here.
2414		2867
2415	$LINK_MAP->width (41);	2868	$RELOAD_WATCHER ||= Event->timer (
2416	$LINK_MAP->height (41);	2869	reentrant => 0,
2417	$LINK_MAP->alloc;
2418	$LINK_MAP->path ("{link}");
2419	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2420	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2421
2422	# dirty hack because... archetypes are not yet loaded
2423	Event->timer (
2424	after => 10,	2870	after => 0,
		2871	data => WF_AUTOCANCEL,
2425	cb => sub {	2872	cb => sub {
2426	$_[0]->w->cancel;	2873	do_reload_perl;
2427		2874	undef $RELOAD_WATCHER;
2428	# provide some exits "home"
2429	my $exit = cf::object::new "exit";
2430
2431	$exit->slaying ($EMERGENCY_POSITION->[0]);
2432	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2433	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2434
2435	$LINK_MAP->insert ($exit->clone, 19, 19);
2436	$LINK_MAP->insert ($exit->clone, 19, 20);
2437	$LINK_MAP->insert ($exit->clone, 19, 21);
2438	$LINK_MAP->insert ($exit->clone, 20, 19);
2439	$LINK_MAP->insert ($exit->clone, 20, 21);
2440	$LINK_MAP->insert ($exit->clone, 21, 19);
2441	$LINK_MAP->insert ($exit->clone, 21, 20);
2442	$LINK_MAP->insert ($exit->clone, 21, 21);
2443
2444	$exit->destroy;
2445	});	2875	},
2446		2876	);
2447	$LINK_MAP->{deny_save} = 1;
2448	$LINK_MAP->{deny_reset} = 1;
2449
2450	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2451	}	2877	}
2452		2878
2453	register_command "reload" => sub {	2879	register_command "reload" => sub {
2454	my ($who, $arg) = @_;	2880	my ($who, $arg) = @_;
2455		2881
2456	if ($who->flag (FLAG_WIZ)) {	2882	if ($who->flag (FLAG_WIZ)) {
2457	$who->message ("start of reload.");
2458	reload;
2459	$who->message ("end of reload.");	2883	$who->message ("reloading server.");
		2884	async { reload_perl };
2460	}	2885	}
2461	};	2886	};
2462		2887
2463	unshift @INC, $LIBDIR;	2888	unshift @INC, $LIBDIR;
2464		2889
		2890	my $bug_warning = 0;
		2891
		2892	our @WAIT_FOR_TICK;
		2893	our @WAIT_FOR_TICK_BEGIN;
		2894
		2895	sub wait_for_tick {
		2896	return unless $TICK_WATCHER->is_active;
		2897	return if $Coro::current == $Coro::main;
		2898
		2899	my $signal = new Coro::Signal;
		2900	push @WAIT_FOR_TICK, $signal;
		2901	$signal->wait;
		2902	}
		2903
		2904	sub wait_for_tick_begin {
		2905	return unless $TICK_WATCHER->is_active;
		2906	return if $Coro::current == $Coro::main;
		2907
		2908	my $signal = new Coro::Signal;
		2909	push @WAIT_FOR_TICK_BEGIN, $signal;
		2910	$signal->wait;
		2911	}
		2912
		2913	my $min = 1e6;#d#
		2914	my $avg = 10;
2465	$TICK_WATCHER = Event->timer (	2915	$TICK_WATCHER = Event->timer (
2466	reentrant => 0,	2916	reentrant => 0,
		2917	parked => 1,
2467	prio => 0,	2918	prio => 0,
2468	at => $NEXT_TICK || $TICK,	2919	at => $NEXT_TICK || $TICK,
2469	data => WF_AUTOCANCEL,	2920	data => WF_AUTOCANCEL,
2470	cb => sub {	2921	cb => sub {
		2922	if ($Coro::current != $Coro::main) {
		2923	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2924	unless ++$bug_warning > 10;
		2925	return;
		2926	}
		2927
		2928	$NOW = $tick_start = Event::time;
		2929
2471	cf::server_tick; # one server iteration	2930	cf::server_tick; # one server iteration
		2931
		2932	0 && sync_job {#d#
		2933	for(1..10) {
		2934	my $t = Event::time;
		2935	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2936	or die;
		2937
		2938	$map->width (50);
		2939	$map->height (50);
		2940	$map->alloc;
		2941	$map->_load_objects ("/tmp/x.map", 1);
		2942	my $t = Event::time - $t;
		2943
		2944	#next unless $t < 0.0013;#d#
		2945	if ($t < $min) {
		2946	$min = $t;
		2947	}
		2948	$avg = $avg * 0.99 + $t * 0.01;
		2949	}
		2950	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2951	exit 0;
		2952	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		2953	};
		2954
2472	$RUNTIME += $TICK;	2955	$RUNTIME += $TICK;
2473	$NEXT_TICK += $TICK;	2956	$NEXT_TICK += $TICK;
2474		2957
2475	$WAIT_FOR_TICK->broadcast;	2958	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2476	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	2959	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2960	Coro::async_pool {
		2961	write_runtime
		2962	or warn "ERROR: unable to write runtime file: $!";
		2963	};
		2964	}
		2965
		2966	# my $AFTER = Event::time;
		2967	# warn $AFTER - $NOW;#d#
		2968
		2969	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2970	$sig->send;
		2971	}
		2972	while (my $sig = shift @WAIT_FOR_TICK) {
		2973	$sig->send;
		2974	}
		2975
		2976	$NOW = Event::time;
2477		2977
2478	# if we are delayed by four ticks or more, skip them all	2978	# if we are delayed by four ticks or more, skip them all
2479	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2979	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2480		2980
2481	$TICK_WATCHER->at ($NEXT_TICK);	2981	$TICK_WATCHER->at ($NEXT_TICK);
2482	$TICK_WATCHER->start;	2982	$TICK_WATCHER->start;
		2983
		2984	$LOAD = ($NOW - $tick_start) / $TICK;
		2985	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2986
		2987	_post_tick;
		2988
		2989
2483	},	2990	},
2484	);	2991	);
2485		2992
		2993	{
2486	IO::AIO::max_poll_time $TICK * 0.2;	2994	BDB::max_poll_time $TICK * 0.1;
2487		2995	$BDB_POLL_WATCHER = Event->io (
2488	Event->io (	2996	reentrant => 0,
2489	fd => IO::AIO::poll_fileno,	2997	fd => BDB::poll_fileno,
2490	poll => 'r',	2998	poll => 'r',
2491	prio => 5,	2999	prio => 0,
2492	data => WF_AUTOCANCEL,
2493	cb => \&IO::AIO::poll_cb,
2494	);
2495
2496	Event->timer (
2497	data => WF_AUTOCANCEL,	3000	data => WF_AUTOCANCEL,
2498	after => 0,	3001	cb => \&BDB::poll_cb,
2499	interval => 10,	3002	);
2500	cb => sub {	3003	BDB::min_parallel 8;
2501	(Coro::unblock_sub {	3004
2502	write_runtime	3005	BDB::set_sync_prepare {
2503	or warn "ERROR: unable to write runtime file: $!";	3006	my $status;
		3007	my $current = $Coro::current;
		3008	(
		3009	sub {
		3010	$status = $!;
		3011	$current->ready; undef $current;
		3012	},
		3013	sub {
		3014	Coro::schedule while defined $current;
		3015	$! = $status;
		3016	},
		3017	)
		3018	};
		3019
		3020	unless ($DB_ENV) {
		3021	$DB_ENV = BDB::db_env_create;
		3022
		3023	cf::sync_job {
		3024	eval {
		3025	BDB::db_env_open
		3026	$DB_ENV,
		3027	$BDBDIR,
		3028	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3029	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3030	0666;
		3031
		3032	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3033
		3034	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3035	$DB_ENV->set_lk_detect;
		3036	};
		3037
		3038	cf::cleanup "db_env_open(db): $@" if $@;
2504	})->();	3039	};
2505	},	3040	}
2506	);	3041	}
		3042
		3043	{
		3044	IO::AIO::min_parallel 8;
		3045
		3046	undef $Coro::AIO::WATCHER;
		3047	IO::AIO::max_poll_time $TICK * 0.1;
		3048	$AIO_POLL_WATCHER = Event->io (
		3049	reentrant => 0,
		3050	data => WF_AUTOCANCEL,
		3051	fd => IO::AIO::poll_fileno,
		3052	poll => 'r',
		3053	prio => 6,
		3054	cb => \&IO::AIO::poll_cb,
		3055	);
		3056	}
		3057
		3058	my $_log_backtrace;
		3059
		3060	sub _log_backtrace {
		3061	my ($msg, @addr) = @_;
		3062
		3063	$msg =~ s/\n//;
		3064
		3065	# limit the # of concurrent backtraces
		3066	if ($_log_backtrace < 2) {
		3067	++$_log_backtrace;
		3068	async {
		3069	my @bt = fork_call {
		3070	@addr = map { sprintf "%x", $_ } @addr;
		3071	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3072	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3073	or die "addr2line: $!";
		3074
		3075	my @funcs;
		3076	my @res = <$fh>;
		3077	chomp for @res;
		3078	while (@res) {
		3079	my ($func, $line) = splice @res, 0, 2, ();
		3080	push @funcs, "[$func] $line";
		3081	}
		3082
		3083	@funcs
		3084	};
		3085
		3086	LOG llevInfo, "[ABT] $msg\n";
		3087	LOG llevInfo, "[ABT] $_\n" for @bt;
		3088	--$_log_backtrace;
		3089	};
		3090	} else {
		3091	LOG llevInfo, "[ABT] $msg\n";
		3092	LOG llevInfo, "[ABT] [suppressed]\n";
		3093	}
		3094	}
		3095
		3096	# load additional modules
		3097	use cf::pod;
2507		3098
2508	END { cf::emergency_save }	3099	END { cf::emergency_save }
2509		3100
2510	1	3101	1
2511		3102

Diff Legend

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