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.165 by root, Fri Jan 12 22:09:22 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 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
478	$path
479	}
480
481	# the original (read-only) location
482	sub load_path {
483	my ($self) = @_;
484
485	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
486	}
487
488	# the temporary/swap location
489	sub save_path {
490	my ($self) = @_;
491
492	$self->{user_rel}
493	? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
494	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
495	}
496
497	# the unique path, undef == no special unique path
498	sub uniq_path {
499	my ($self) = @_;
500
501	$self->{user_rel} || $self->{ext}
502	? undef
503	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
504	}
505
506	sub customise_for {
507	my ($self, $map, $ob) = @_;
508
509	if ($map->per_player) {
510	return cf::map::find ("~" . $ob->name . "/" . $map->{path}{path});
511	}
512
513	$map
514	}
515
516	# this is somewhat ugly, but style maps do need special treatment
517	sub is_style_map {
518	$_[0]{path} =~ m{^/styles/}
519	}
520
521	sub load_orig {
522	my ($self) = @_;
523
524	&cf::map::load_map_header ($self->load_path)
525	}
526
527	sub load_temp {
528	my ($self) = @_;
529
530	&cf::map::load_map_header ($self->save_path)
531	}
532
533	sub unlink_save {
534	my ($self) = @_;
535
536	utf8::encode (my $save = $self->save_path);
537	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
538	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
539	}
540
541	package cf;
542		572
543	#############################################################################	573	#############################################################################
544		574
545	=head2 ATTACHABLE OBJECTS	575	=head2 ATTACHABLE OBJECTS
546		576
…		…
548	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")
549	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
550		580
551	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>
552	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
553	crossfire+).	583	Crossfire TRT).
554		584
555	=over 4	585	=over 4
556		586
557	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
558		588
…		…
672	our @CB_TYPE = (); # registry for type (cf-object class) based events	702	our @CB_TYPE = (); # registry for type (cf-object class) based events
673	our @CB_MAP = ();	703	our @CB_MAP = ();
674		704
675	my %attachment;	705	my %attachment;
676		706
		707	sub cf::attachable::thawer_merge {
		708	# simply override everything except _meta
		709	local $_[0]{_meta};
		710	%{$_[0]} = %{$_[1]};
		711	}
		712
677	sub _attach_cb($$$$) {	713	sub _attach_cb($$$$) {
678	my ($registry, $event, $prio, $cb) = @_;	714	my ($registry, $event, $prio, $cb) = @_;
679		715
680	use sort 'stable';	716	use sort 'stable';
681		717
…		…
715	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
716		752
717	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
718	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
719	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
720	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
721		757
722	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
723	my $pkg = shift @arg;	759	my $pkg = shift @arg;
724		760
725	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
754	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
755	}	791	}
756		792
757	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
758	} else {	794	} else {
759	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
760	}	796	}
761		797
762	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
763	}	799	}
764		800
…		…
766	if (ref $_[0]) {	802	if (ref $_[0]) {
767	_object_attach @_;	803	_object_attach @_;
768	} else {	804	} else {
769	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
770	}	806	}
		807	_recalc_want;
771	};	808	};
772		809
773	# all those should be optimised	810	# all those should be optimised
774	sub cf::attachable::detach {	811	sub cf::attachable::detach {
775	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
778	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
779	reattach ($obj);	816	reattach ($obj);
780	} else {	817	} else {
781	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
782	}	819	}
		820	_recalc_want;
783	};	821	};
784		822
785	sub cf::attachable::attached {	823	sub cf::attachable::attached {
786	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
787		825
…		…
852	# object support	890	# object support
853		891
854	sub reattach {	892	sub reattach {
855	# basically do the same as instantiate, without calling instantiate	893	# basically do the same as instantiate, without calling instantiate
856	my ($obj) = @_;	894	my ($obj) = @_;
		895
		896	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
857		897
858	my $registry = $obj->registry;	898	my $registry = $obj->registry;
859		899
860	@$registry = ();	900	@$registry = ();
861		901
…		…
908	$filename, length $$rdata, scalar @$objs;	948	$filename, length $$rdata, scalar @$objs;
909		949
910	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	950	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
911	chmod SAVE_MODE, $fh;	951	chmod SAVE_MODE, $fh;
912	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	952	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
913	aio_fsync $fh;	953	aio_fsync $fh if $cf::USE_FSYNC;
914	close $fh;	954	close $fh;
915		955
916	if (@$objs) {	956	if (@$objs) {
917	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) {
918	chmod SAVE_MODE, $fh;	958	chmod SAVE_MODE, $fh;
919	my $data = Storable::nfreeze { version => 1, objs => $objs };	959	my $data = Storable::nfreeze { version => 1, objs => $objs };
920	aio_write $fh, 0, (length $data), $data, 0;	960	aio_write $fh, 0, (length $data), $data, 0;
921	aio_fsync $fh;	961	aio_fsync $fh if $cf::USE_FSYNC;
922	close $fh;	962	close $fh;
923	aio_rename "$filename.pst~", "$filename.pst";	963	aio_rename "$filename.pst~", "$filename.pst";
924	}	964	}
925	} else {	965	} else {
926	aio_unlink "$filename.pst";	966	aio_unlink "$filename.pst";
…		…
958	or return;	998	or return;
959	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
960	}	1000	}
961		1001
962	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
963	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
964	return ($data, $av);	1004	return ($data, $av);
965	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
966		1012
967	#############################################################################	1013	#############################################################################
968	# command handling &c	1014	# command handling &c
969		1015
970	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
983	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
984	}	1030	}
985		1031
986	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
987		1033
988	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.
989		1035
990	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
991	called.	1037	called.
992		1038
993	=cut	1039	=cut
…		…
1028		1074
1029	cf::override;	1075	cf::override;
1030	},	1076	},
1031	);	1077	);
1032		1078
1033	sub load_extension {
1034	my ($path) = @_;
1035
1036	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
1037	my $base = $1;
1038	my $pkg = $1;
1039	$pkg =~ s/[^[:word:]]/_/g;
1040	$pkg = "ext::$pkg";
1041
1042	warn "... loading '$path' into '$pkg'\n";
1043
1044	open my $fh, "<:utf8", $path
1045	or die "$path: $!";
1046
1047	my $source =
1048	"package $pkg; use strict; use utf8;\n"
1049	. "#line 1 \"$path\"\n{\n"
1050	. (do { local $/; <$fh> })
1051	. "\n};\n1";
1052
1053	eval $source
1054	or die $@ ? "$path: $@\n"
1055	: "extension disabled.\n";
1056
1057	push @EXTS, $pkg;
1058	}
1059
1060	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
1061	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
1062	next unless -r $ext;	1084	next unless -r $path;
1063	eval {	1085
1064	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;
1065	1	1143	}
1066	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
1067	}	1149	};
1068	}	1150	}
1069		1151
1070	#############################################################################	1152	#############################################################################
1071	# load/save/clean perl data associated with a map
1072		1153
1073	*cf::mapsupport::on_clean = sub {	1154	=back
1074	my ($map) = @_;
1075
1076	my $path = $map->tmpname;
1077	defined $path or return;
1078
1079	unlink "$path.pst";
1080	};
1081
1082	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1083
1084	#############################################################################
1085		1155
1086	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
1087		1157
1088	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
1089		1159
…		…
1102	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
1103		1173
1104	=cut	1174	=cut
1105		1175
1106	sub playerdir($) {	1176	sub playerdir($) {
1107	cf::localdir	1177	"$PLAYERDIR/"
1108	. "/"
1109	. cf::playerdir
1110	. "/"
1111	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1112	}	1179	}
1113		1180
1114	sub path($) {	1181	sub path($) {
1115	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1116		1183
1117	(playerdir $login) . "/$login.pl"	1184	(playerdir $login) . "/playerdata"
1118	}	1185	}
1119		1186
1120	sub find_active($) {	1187	sub find_active($) {
1121	$cf::PLAYER{$_[0]}	1188	$cf::PLAYER{$_[0]}
1122	and $cf::PLAYER{$_[0]}->active	1189	and $cf::PLAYER{$_[0]}->active
…		…
1125		1192
1126	sub exists($) {	1193	sub exists($) {
1127	my ($login) = @_;	1194	my ($login) = @_;
1128		1195
1129	$cf::PLAYER{$login}	1196	$cf::PLAYER{$login}
1130	or cf::sync_job { !aio_stat $login }	1197	or cf::sync_job { !aio_stat path $login }
1131	}	1198	}
1132		1199
1133	sub find($) {	1200	sub find($) {
1134	return $cf::PLAYER{$_[0]} || do {	1201	return $cf::PLAYER{$_[0]} || do {
1135	my $login = $_[0];	1202	my $login = $_[0];
1136		1203
1137	my $guard = cf::lock_acquire "user_find:$login";	1204	my $guard = cf::lock_acquire "user_find:$login";
1138		1205
1139	$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
1140	my $pl = load_pl path $login	1214	my $pl = load_pl path $login
1141	or return;	1215	or return;
1142	$cf::PLAYER{$login} = $pl	1216	$cf::PLAYER{$login} = $pl
1143	}	1217	}
1144	}	1218	}
…		…
1181		1255
1182	=cut	1256	=cut
1183		1257
1184	sub quit_character {	1258	sub quit_character {
1185	my ($pl) = @_;	1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
1186		1262
1187	$pl->{deny_save} = 1;	1263	$pl->{deny_save} = 1;
1188	$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
1189		1265
1190	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1195	my $path = playerdir $pl;	1271	my $path = playerdir $pl;
1196	my $temp = "$path~$cf::RUNTIME~deleting~";	1272	my $temp = "$path~$cf::RUNTIME~deleting~";
1197	aio_rename $path, $temp;	1273	aio_rename $path, $temp;
1198	delete $cf::PLAYER{$pl->ob->name};	1274	delete $cf::PLAYER{$pl->ob->name};
1199	$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
1200	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;
1201	}	1297	}
1202		1298
1203	=item cf::player::list_logins	1299	=item cf::player::list_logins
1204		1300
1205	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
1206	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1207		1303
1208	=cut	1304	=cut
1209		1305
1210	sub list_logins {	1306	sub list_logins {
1211	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1212	or return [];	1308	or return [];
1213		1309
1214	my @logins;	1310	my @logins;
1215		1311
1216	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1225	\@logins	1321	\@logins
1226	}	1322	}
1227		1323
1228	=item $player->maps	1324	=item $player->maps
1229		1325
1230	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
1231	player. May block.	1327	player. May block.
1232		1328
1233	=cut	1329	=cut
1234		1330
1235	sub maps($) {	1331	sub maps($) {
1236	my ($pl) = @_;	1332	my ($pl) = @_;
		1333
		1334	$pl = ref $pl ? $pl->ob->name : $pl;
1237		1335
1238	my $files = aio_readdir playerdir $pl	1336	my $files = aio_readdir playerdir $pl
1239	or return;	1337	or return;
1240		1338
1241	my @paths;	1339	my @paths;
…		…
1243	for (@$files) {	1341	for (@$files) {
1244	utf8::decode $_;	1342	utf8::decode $_;
1245	next if /\.(?:pl|pst)$/;	1343	next if /\.(?:pl|pst)$/;
1246	next unless /^$PATH_SEP/o;	1344	next unless /^$PATH_SEP/o;
1247		1345
1248	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1346	push @paths, cf::map::normalise "~$pl/$_";
1249	}	1347	}
1250		1348
1251	\@paths	1349	\@paths
1252	}	1350	}
1253		1351
1254	=item $player->ext_reply ($msgid, $msgtype, %msg)	1352	=item $player->ext_reply ($msgid, %msg)
1255		1353
1256	Sends an ext reply to the player.	1354	Sends an ext reply to the player.
1257		1355
1258	=cut	1356	=cut
1259		1357
1260	sub ext_reply($$$%) {	1358	sub ext_reply($$%) {
1261	my ($self, $id, %msg) = @_;	1359	my ($self, $id, %msg) = @_;
1262		1360
1263	$msg{msgid} = $id;	1361	$msg{msgid} = $id;
1264		1362
1265	$self->send ("ext " . cf::to_json \%msg);	1363	$self->send ("ext " . cf::to_json \%msg);
1266	}	1364	}
1267		1365
1268	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	}
1269		1406
1270	=back	1407	=back
1271
1272		1408
1273	=head3 cf::map	1409	=head3 cf::map
1274		1410
1275	=over 4	1411	=over 4
1276		1412
…		…
1279	package cf::map;	1415	package cf::map;
1280		1416
1281	use Fcntl;	1417	use Fcntl;
1282	use Coro::AIO;	1418	use Coro::AIO;
1283		1419
		1420	use overload
		1421	'""' => \&as_string,
		1422	fallback => 1;
		1423
1284	our $MAX_RESET = 3600;	1424	our $MAX_RESET = 3600;
1285	our $DEFAULT_RESET = 3000;	1425	our $DEFAULT_RESET = 3000;
1286		1426
1287	sub generate_random_map {	1427	sub generate_random_map {
1288	my ($path, $rmp) = @_;	1428	my ($self, $rmp) = @_;
1289
1290	# mit "rum" bekleckern, nicht	1429	# mit "rum" bekleckern, nicht
1291	cf::map::_create_random_map (	1430	$self->_create_random_map (
1292	$path,
1293	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1431	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1294	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1432	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1295	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1433	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1296	$rmp->{exit_on_final_map},	1434	$rmp->{exit_on_final_map},
1297	$rmp->{xsize}, $rmp->{ysize},	1435	$rmp->{xsize}, $rmp->{ysize},
…		…
1302	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1440	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1303	(cf::region::find $rmp->{region}), $rmp->{custom}	1441	(cf::region::find $rmp->{region}), $rmp->{custom}
1304	)	1442	)
1305	}	1443	}
1306		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"
		1570	}
		1571
1307	# and all this just because we cannot iterate over	1572	# and all this just because we cannot iterate over
1308	# all maps in C++...	1573	# all maps in C++...
1309	sub change_all_map_light {	1574	sub change_all_map_light {
1310	my ($change) = @_;	1575	my ($change) = @_;
1311		1576
1312	$_->change_map_light ($change)	1577	$_->change_map_light ($change)
1313	for grep $_->outdoor, values %cf::MAP;	1578	for grep $_->outdoor, values %cf::MAP;
1314	}	1579	}
1315		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
1316	sub load_map_header($) {	1597	sub load_header_from($) {
1317	my ($path) = @_;	1598	my ($self, $path) = @_;
1318		1599
1319	utf8::encode $path;	1600	utf8::encode $path;
1320	aio_open $path, O_RDONLY, 0	1601	#aio_open $path, O_RDONLY, 0
		1602	# or return;
		1603
		1604	$self->_load_header ($path)
1321	or return;	1605	or return;
1322		1606
1323	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
1324	or return;	1650	or return;
		1651	$self->prepare_orig;
		1652	}
1325		1653
1326	# for better error messages only, will be overwritten later	1654	$self->{deny_reset} = 1
1327	$map->path ($path);	1655	if $self->no_reset;
1328		1656
1329	$map->load_header ($path)	1657	$self->default_region (cf::region::find_by_path $self->{path})
1330	or return;	1658	unless $self->default_region;
1331		1659
1332	$map->{load_path} = $path;	1660	1
1333
1334	$map
1335	}	1661	}
1336		1662
1337	sub find;	1663	sub find;
1338	sub find {	1664	sub find {
1339	my ($path, $origin) = @_;	1665	my ($path, $origin) = @_;
1340		1666
1341	#warn "find<$path,$origin>\n";#d#
1342
1343	$path = new cf::path $path, $origin && $origin->path;	1667	$path = normalise $path, $origin && $origin->path;
1344	my $key = $path->as_string;
1345		1668
1346	cf::lock_wait "map_find:$key";	1669	cf::lock_wait "map_find:$path";
1347		1670
1348	$cf::MAP{$key} || do {	1671	$cf::MAP{$path} || do {
1349	my $guard = cf::lock_acquire "map_find:$key";	1672	my $guard = cf::lock_acquire "map_find:$path";
1350		1673	my $map = new_from_path cf::map $path
1351	# do it the slow way
1352	my $map = $path->load_temp;
1353
1354	Coro::cede;
1355
1356	if ($map) {
1357	$map->last_access ((delete $map->{last_access})
1358	|| $cf::RUNTIME); #d#
1359	# safety
1360	$map->{instantiate_time} = $cf::RUNTIME
1361	if $map->{instantiate_time} > $cf::RUNTIME;
1362	} else {
1363	$map = $path->load_orig
1364	or return;	1674	or return;
1365		1675
1366	$map->{load_original} = 1;
1367	$map->{instantiate_time} = $cf::RUNTIME;
1368	$map->last_access ($cf::RUNTIME);
1369	$map->instantiate;
1370
1371	# per-player maps become, after loading, normal maps
1372	$map->per_player (0) if $path->{user_rel};
1373	}
1374
1375	$map->path ($key);
1376	$map->{path} = $path;
1377	$map->{last_save} = $cf::RUNTIME;	1676	$map->{last_save} = $cf::RUNTIME;
1378		1677
1379	Coro::cede;	1678	$map->load_header
		1679	or return;
1380		1680
1381	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;
1382	$map->reset;	1684	$map->reset;
1383	undef $guard;	1685	undef $guard;
1384	$map = find $path	1686	return find $path;
1385	or return;
1386	}	1687	}
1387		1688
1388	$cf::MAP{$key} = $map	1689	$cf::MAP{$path} = $map
1389	}	1690	}
1390	}	1691	}
		1692
		1693	sub pre_load { }
		1694	sub post_load { }
1391		1695
1392	sub load {	1696	sub load {
1393	my ($self) = @_;	1697	my ($self) = @_;
1394		1698
		1699	local $self->{deny_reset} = 1; # loading can take a long time
		1700
1395	my $path = $self->{path};	1701	my $path = $self->{path};
		1702
		1703	{
1396	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1704	my $guard = cf::lock_acquire "map_load:$path";
1397		1705
1398	return if $self->in_memory != cf::MAP_SWAPPED;	1706	return if $self->in_memory != cf::MAP_SWAPPED;
1399		1707
1400	$self->in_memory (cf::MAP_LOADING);	1708	$self->in_memory (cf::MAP_LOADING);
1401		1709
1402	$self->alloc;	1710	$self->alloc;
		1711
		1712	$self->pre_load;
		1713	Coro::cede;
		1714
1403	$self->load_objects ($self->{load_path}, 1)	1715	$self->_load_objects ($self->{load_path}, 1)
1404	or return;	1716	or return;
1405		1717
1406	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1718	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1407	if delete $self->{load_original};	1719	if delete $self->{load_original};
1408		1720
1409	if (my $uniq = $path->uniq_path) {	1721	if (my $uniq = $self->uniq_path) {
1410	utf8::encode $uniq;	1722	utf8::encode $uniq;
1411	if (aio_open $uniq, O_RDONLY, 0) {	1723	if (aio_open $uniq, O_RDONLY, 0) {
1412	$self->clear_unique_items;	1724	$self->clear_unique_items;
1413	$self->load_objects ($uniq, 0);	1725	$self->_load_objects ($uniq, 0);
1414	}	1726	}
1415	}	1727	}
1416		1728
1417	Coro::cede;	1729	Coro::cede;
1418
1419	# now do the right thing for maps	1730	# now do the right thing for maps
1420	$self->link_multipart_objects;	1731	$self->link_multipart_objects;
1421
1422	if ($self->{path}->is_style_map) {
1423	$self->{deny_save} = 1;
1424	$self->{deny_reset} = 1;
1425	} else {
1426	$self->decay_objects;
1427	$self->fix_auto_apply;
1428	$self->update_buttons;
1429	$self->set_darkness_map;
1430	$self->difficulty ($self->estimate_difficulty)	1732	$self->difficulty ($self->estimate_difficulty)
1431	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;
1432	$self->activate;	1743	$self->activate;
1433	}	1744	}
1434		1745
1435	Coro::cede;
1436
1437	$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
1438	}	1762	}
1439		1763
1440	# 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
1441	sub load_diag {	1765	sub load_diag {
1442	my ($map) = @_;	1766	my ($map) = @_;
…		…
1472		1796
1473	cf::sync_job { $map->load };	1797	cf::sync_job { $map->load };
1474	}	1798	}
1475		1799
1476	our %MAP_PREFETCH;	1800	our %MAP_PREFETCH;
1477	our $MAP_PREFETCHER = Coro::async {	1801	our $MAP_PREFETCHER = undef;
1478	while () {
1479	while (%MAP_PREFETCH) {
1480	my $key = each %MAP_PREFETCH
1481	or next;
1482	my $path = delete $MAP_PREFETCH{$key};
1483
1484	my $map = find $path
1485	or next;
1486	$map->load;
1487	}
1488	Coro::schedule;
1489	}
1490	};
1491		1802
1492	sub find_async {	1803	sub find_async {
1493	my ($path, $origin) = @_;	1804	my ($path, $origin) = @_;
1494		1805
1495	$path = new cf::path $path, $origin && $origin->path;	1806	$path = normalise $path, $origin && $origin->{path};
1496	my $key = $path->as_string;
1497		1807
1498	if (my $map = $cf::MAP{$key}) {	1808	if (my $map = $cf::MAP{$path}) {
1499	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1809	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1500	}	1810	}
1501		1811
1502	$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	};
1503	$MAP_PREFETCHER->ready;	1825	$MAP_PREFETCHER->prio (6);
1504		1826
1505	()	1827	()
1506	}	1828	}
1507		1829
1508	sub save {	1830	sub save {
…		…
1512		1834
1513	$self->{last_save} = $cf::RUNTIME;	1835	$self->{last_save} = $cf::RUNTIME;
1514		1836
1515	return unless $self->dirty;	1837	return unless $self->dirty;
1516		1838
1517	my $save = $self->{path}->save_path; utf8::encode $save;	1839	my $save = $self->save_path; utf8::encode $save;
1518	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1840	my $uniq = $self->uniq_path; utf8::encode $uniq;
1519		1841
1520	$self->{load_path} = $save;	1842	$self->{load_path} = $save;
1521		1843
1522	return if $self->{deny_save};	1844	return if $self->{deny_save};
1523		1845
…		…
1526	cf::async {	1848	cf::async {
1527	$_->contr->save for $self->players;	1849	$_->contr->save for $self->players;
1528	};	1850	};
1529		1851
1530	if ($uniq) {	1852	if ($uniq) {
1531	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1853	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1532	$self->save_objects ($uniq, cf::IO_UNIQUES);	1854	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1533	} else {	1855	} else {
1534	$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);
1535	}	1857	}
1536	}	1858	}
1537		1859
1538	sub swap_out {	1860	sub swap_out {
1539	my ($self) = @_;	1861	my ($self) = @_;
…		…
1553		1875
1554	sub reset_at {	1876	sub reset_at {
1555	my ($self) = @_;	1877	my ($self) = @_;
1556		1878
1557	# TODO: safety, remove and allow resettable per-player maps	1879	# TODO: safety, remove and allow resettable per-player maps
1558	return 1e99 if $self->{path}{user_rel};
1559	return 1e99 if $self->{deny_reset};	1880	return 1e99 if $self->{deny_reset};
1560		1881
1561	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1882	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1562	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;
1563		1884
…		…
1568	my ($self) = @_;	1889	my ($self) = @_;
1569		1890
1570	$self->reset_at <= $cf::RUNTIME	1891	$self->reset_at <= $cf::RUNTIME
1571	}	1892	}
1572		1893
1573	sub rename {
1574	my ($self, $new_path) = @_;
1575
1576	$self->{path}->unlink_save;
1577
1578	delete $cf::MAP{$self->path};
1579	$self->{path} = new cf::path $new_path;
1580	$self->path ($self->{path}->as_string);
1581	$cf::MAP{$self->path} = $self;
1582
1583	$self->save;
1584	}
1585
1586	sub reset {	1894	sub reset {
1587	my ($self) = @_;	1895	my ($self) = @_;
1588		1896
1589	my $lock = cf::lock_acquire "map_data:" . $self->path;	1897	my $lock = cf::lock_acquire "map_data:$self->{path}";
1590		1898
1591	return if $self->players;	1899	return if $self->players;
1592	return if $self->{path}{user_rel};#d#
1593		1900
1594	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	}
1595		1912
1596	delete $cf::MAP{$self->path};	1913	delete $cf::MAP{$self->path};
1597		1914
		1915	$self->clear;
		1916
1598	$_->clear_links_to ($self) for values %cf::MAP;	1917	$_->clear_links_to ($self) for values %cf::MAP;
1599		1918
1600	$self->{path}->unlink_save;	1919	$self->unlink_save;
1601	$self->destroy;	1920	$self->destroy;
1602	}	1921	}
1603		1922
1604	my $nuke_counter = "aaaa";	1923	my $nuke_counter = "aaaa";
1605		1924
1606	sub nuke {	1925	sub nuke {
1607	my ($self) = @_;	1926	my ($self) = @_;
1608		1927
		1928	delete $cf::MAP{$self->path};
		1929
		1930	$self->unlink_save;
		1931
		1932	bless $self, "cf::map";
		1933	delete $self->{deny_reset};
1609	$self->{deny_save} = 1;	1934	$self->{deny_save} = 1;
1610	$self->reset_timeout (1);	1935	$self->reset_timeout (1);
1611	$self->rename ("{nuke}/" . ($nuke_counter++));	1936	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1937
		1938	$cf::MAP{$self->path} = $self;
		1939
1612	$self->reset; # polite request, might not happen	1940	$self->reset; # polite request, might not happen
1613	}	1941	}
1614		1942
		1943	=item $maps = cf::map::tmp_maps
		1944
		1945	Returns an arrayref with all map paths of currently instantiated and saved
		1946	maps. May block.
		1947
		1948	=cut
		1949
		1950	sub tmp_maps() {
		1951	[
		1952	map {
		1953	utf8::decode $_;
		1954	/\.map$/
		1955	? normalise $_
		1956	: ()
		1957	} @{ aio_readdir $TMPDIR or [] }
		1958	]
		1959	}
		1960
		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	]
		1977	}
		1978
1615	=item cf::map::unique_maps	1979	=item cf::map::unique_maps
1616		1980
1617	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
1618	instantiated unique items. May block.	1982	instantiated unique items. May block.
1619		1983
1620	=cut	1984	=cut
1621		1985
1622	sub unique_maps() {	1986	sub unique_maps() {
1623	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	1987	[
1624	or return;	1988	map {
1625
1626	my @paths;
1627
1628	for (@$files) {
1629	utf8::decode $_;	1989	utf8::decode $_;
1630	next if /\.pst$/;	1990	/\.map$/
1631	next unless /^$PATH_SEP/o;	1991	? normalise $_
1632		1992	: ()
1633	push @paths, new cf::path $_;	1993	} @{ aio_readdir $UNIQUEDIR or [] }
1634	}	1994	]
1635
1636	\@paths
1637	}	1995	}
1638		1996
1639	package cf;	1997	package cf;
1640		1998
1641	=back	1999	=back
…		…
1687		2045
1688	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2046	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1689		2047
1690	if ($self->{record_replies}) {	2048	if ($self->{record_replies}) {
1691	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2049	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2050
1692	} else {	2051	} else {
		2052	my $pl = $self->contr;
		2053
		2054	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2055	my $diag = $pl->{npc_dialog};
		2056	$diag->{pl}->ext_reply (
		2057	$diag->{id}, msgtype => "reply", msg => $msg, add_topics => []
		2058	);
		2059
		2060	} else {
1693	$msg = $npc->name . " says: $msg" if $npc;	2061	$msg = $npc->name . " says: $msg" if $npc;
1694	$self->message ($msg, $flags);	2062	$self->message ($msg, $flags);
		2063	}
1695	}	2064	}
1696	}	2065	}
1697		2066
1698	=item $player_object->may ("access")	2067	=item $player_object->may ("access")
1699		2068
…		…
1713		2082
1714	=item $player_object->enter_link	2083	=item $player_object->enter_link
1715		2084
1716	Freezes the player and moves him/her to a special map (C<{link}>).	2085	Freezes the player and moves him/her to a special map (C<{link}>).
1717		2086
1718	The player should be reaosnably safe there for short amounts of time. You	2087	The player should be reasonably safe there for short amounts of time. You
1719	I<MUST> call C<leave_link> as soon as possible, though.	2088	I<MUST> call C<leave_link> as soon as possible, though.
1720		2089
		2090	Will never block.
		2091
1721	=item $player_object->leave_link ($map, $x, $y)	2092	=item $player_object->leave_link ($map, $x, $y)
1722		2093
1723	Moves the player out of the specila link map onto the given map. If the	2094	Moves the player out of the special C<{link}> map onto the specified
1724	map is not valid (or omitted), the player will be moved back to the	2095	map. If the map is not valid (or omitted), the player will be moved back
1725	location he/she was before the call to C<enter_link>, or, if that fails,	2096	to the location he/she was before the call to C<enter_link>, or, if that
1726	to the emergency map position.	2097	fails, to the emergency map position.
1727		2098
1728	Might block.	2099	Might block.
1729		2100
1730	=cut	2101	=cut
		2102
		2103	sub link_map {
		2104	unless ($LINK_MAP) {
		2105	$LINK_MAP = cf::map::find "{link}"
		2106	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2107	$LINK_MAP->load;
		2108	}
		2109
		2110	$LINK_MAP
		2111	}
1731		2112
1732	sub cf::object::player::enter_link {	2113	sub cf::object::player::enter_link {
1733	my ($self) = @_;	2114	my ($self) = @_;
1734		2115
1735	$self->deactivate_recursive;	2116	$self->deactivate_recursive;
1736		2117
1737	return if $self->map == $LINK_MAP;	2118	return if UNIVERSAL::isa $self->map, "ext::map_link";
1738		2119
1739	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2120	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1740	if $self->map;	2121	if $self->map && $self->map->{path} ne "{link}";
1741		2122
1742	$self->enter_map ($LINK_MAP, 20, 20);	2123	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1743	}	2124	}
1744		2125
1745	sub cf::object::player::leave_link {	2126	sub cf::object::player::leave_link {
1746	my ($self, $map, $x, $y) = @_;	2127	my ($self, $map, $x, $y) = @_;
		2128
		2129	return unless $self->contr->active;
1747		2130
1748	my $link_pos = delete $self->{_link_pos};	2131	my $link_pos = delete $self->{_link_pos};
1749		2132
1750	unless ($map) {	2133	unless ($map) {
1751	# restore original map position	2134	# restore original map position
…		…
1769	$map->load;	2152	$map->load;
1770	$map->load_diag;	2153	$map->load_diag;
1771		2154
1772	return unless $self->contr->active;	2155	return unless $self->contr->active;
1773	$self->activate_recursive;	2156	$self->activate_recursive;
		2157
		2158	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1774	$self->enter_map ($map, $x, $y);	2159	$self->enter_map ($map, $x, $y);
1775	}	2160	}
1776		2161
1777	cf::player->attach (
1778	on_logout => sub {
1779	my ($pl) = @_;
1780
1781	# abort map switching before logout
1782	if ($pl->ob->{_link_pos}) {
1783	cf::sync_job {
1784	$pl->ob->leave_link
1785	};
1786	}
1787	},
1788	on_login => sub {
1789	my ($pl) = @_;
1790
1791	# try to abort aborted map switching on player login :)
1792	# should happen only on crashes
1793	if ($pl->ob->{_link_pos}) {
1794	$pl->ob->enter_link;
1795	(async {
1796	# we need this sleep as the login has a concurrent enter_exit running
1797	# and this sleep increases chances of the player not ending up in scorn
1798	$pl->ob->reply (undef,
1799	"There was an internal problem at your last logout, "
1800	. "the server will try to bring you to your intended destination in a second.",
1801	cf::NDI_RED);
1802	Coro::Timer::sleep 1;
1803	$pl->ob->leave_link;
1804	})->prio (2);
1805	}
1806	},
1807	);
1808
1809	=item $player_object->goto ($path, $x, $y)	2162	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1810		2163
		2164	Moves the player to the given map-path and coordinates by first freezing
		2165	her, loading and preparing them map, calling the provided $check callback
		2166	that has to return the map if sucecssful, and then unfreezes the player on
		2167	the new (success) or old (failed) map position.
		2168
1811	=cut	2169	=cut
		2170
		2171	our $GOTOGEN;
1812		2172
1813	sub cf::object::player::goto {	2173	sub cf::object::player::goto {
1814	my ($self, $path, $x, $y) = @_;	2174	my ($self, $path, $x, $y, $check) = @_;
1815		2175
1816	$path = new cf::path $path;	2176	# do generation counting so two concurrent goto's will be executed in-order
		2177	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1817		2178
1818	$self->enter_link;	2179	$self->enter_link;
1819		2180
1820	(async {	2181	(async {
		2182	my $map = eval {
1821	my $map = cf::map::find $path->as_string;	2183	my $map = cf::map::find $path;
1822	$map = $map->{path}->customise_for ($map, $self) if $map;
1823		2184
1824	# warn "entering ", $map->path, " at ($x, $y)\n"
1825	# if $map;	2185	if ($map) {
1826		2186	$map = $map->customise_for ($self);
		2187	$map = $check->($map) if $check && $map;
		2188	} else {
1827	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2189	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2190	}
1828		2191
		2192	$map
		2193	};
		2194
		2195	if ($@) {
		2196	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2197	LOG llevError | logBacktrace, Carp::longmess $@;
		2198	}
		2199
		2200	if ($gen == $self->{_goto_generation}) {
		2201	delete $self->{_goto_generation};
1829	$self->leave_link ($map, $x, $y);	2202	$self->leave_link ($map, $x, $y);
		2203	}
1830	})->prio (1);	2204	})->prio (1);
1831	}	2205	}
1832		2206
1833	=item $player_object->enter_exit ($exit_object)	2207	=item $player_object->enter_exit ($exit_object)
1834		2208
…		…
1836		2210
1837	sub parse_random_map_params {	2211	sub parse_random_map_params {
1838	my ($spec) = @_;	2212	my ($spec) = @_;
1839		2213
1840	my $rmp = { # defaults	2214	my $rmp = { # defaults
1841	xsize => 10,	2215	xsize => (cf::rndm 15, 40),
1842	ysize => 10,	2216	ysize => (cf::rndm 15, 40),
		2217	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2218	#layout => string,
1843	};	2219	};
1844		2220
1845	for (split /\n/, $spec) {	2221	for (split /\n/, $spec) {
1846	my ($k, $v) = split /\s+/, $_, 2;	2222	my ($k, $v) = split /\s+/, $_, 2;
1847		2223
…		…
1851	$rmp	2227	$rmp
1852	}	2228	}
1853		2229
1854	sub prepare_random_map {	2230	sub prepare_random_map {
1855	my ($exit) = @_;	2231	my ($exit) = @_;
		2232
		2233	my $guard = cf::lock_acquire "exit_prepare:$exit";
1856		2234
1857	# all this does is basically replace the /! path by	2235	# all this does is basically replace the /! path by
1858	# a new random map path (?random/...) with a seed	2236	# a new random map path (?random/...) with a seed
1859	# that depends on the exit object	2237	# that depends on the exit object
1860		2238
1861	my $rmp = parse_random_map_params $exit->msg;	2239	my $rmp = parse_random_map_params $exit->msg;
1862		2240
1863	if ($exit->map) {	2241	if ($exit->map) {
1864	$rmp->{region} = $exit->map->region_name;	2242	$rmp->{region} = $exit->region->name;
1865	$rmp->{origin_map} = $exit->map->path;	2243	$rmp->{origin_map} = $exit->map->path;
1866	$rmp->{origin_x} = $exit->x;	2244	$rmp->{origin_x} = $exit->x;
1867	$rmp->{origin_y} = $exit->y;	2245	$rmp->{origin_y} = $exit->y;
1868	}	2246	}
1869		2247
1870	$rmp->{random_seed} ||= $exit->random_seed;	2248	$rmp->{random_seed} ||= $exit->random_seed;
1871		2249
1872	my $data = cf::to_json $rmp;	2250	my $data = cf::to_json $rmp;
1873	my $md5 = Digest::MD5::md5_hex $data;	2251	my $md5 = Digest::MD5::md5_hex $data;
		2252	my $meta = "$RANDOMDIR/$md5.meta";
1874		2253
1875	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2254	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1876	aio_write $fh, 0, (length $data), $data, 0;	2255	aio_write $fh, 0, (length $data), $data, 0;
		2256	undef $fh;
		2257	aio_rename "$meta~", $meta;
1877		2258
1878	$exit->slaying ("?random/$md5");	2259	$exit->slaying ("?random/$md5");
1879	$exit->msg (undef);	2260	$exit->msg (undef);
1880	}	2261	}
1881	}	2262	}
1882		2263
1883	sub cf::object::player::enter_exit {	2264	sub cf::object::player::enter_exit {
1884	my ($self, $exit) = @_;	2265	my ($self, $exit) = @_;
1885		2266
1886	return unless $self->type == cf::PLAYER;	2267	return unless $self->type == cf::PLAYER;
		2268
		2269	if ($exit->slaying eq "/!") {
		2270	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2271	# the problem is that $exit might not survive long enough
		2272	# so it needs to be done right now, right here
		2273	cf::sync_job { prepare_random_map $exit };
		2274	}
		2275
		2276	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2277	my $hp = $exit->stats->hp;
		2278	my $sp = $exit->stats->sp;
1887		2279
1888	$self->enter_link;	2280	$self->enter_link;
1889		2281
1890	(async {	2282	(async {
1891	$self->deactivate_recursive; # just to be sure	2283	$self->deactivate_recursive; # just to be sure
1892	unless (eval {	2284	unless (eval {
1893	prepare_random_map $exit	2285	$self->goto ($slaying, $hp, $sp);
1894	if $exit->slaying eq "/!";
1895
1896	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1897	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1898		2286
1899	1;	2287	1;
1900	}) {	2288	}) {
1901	$self->message ("Something went wrong deep within the crossfire server. "	2289	$self->message ("Something went wrong deep within the crossfire server. "
1902	. "I'll try to bring you back to the map you were before. "	2290	. "I'll try to bring you back to the map you were before. "
1903	. "Please report this to the dungeon master!",	2291	. "Please report this to the dungeon master!",
1904	cf::NDI_UNIQUE | cf::NDI_RED);	2292	cf::NDI_UNIQUE | cf::NDI_RED);
1905		2293
1906	warn "ERROR in enter_exit: $@";	2294	warn "ERROR in enter_exit: $@";
1907	$self->leave_link;	2295	$self->leave_link;
1908	}	2296	}
1909	})->prio (1);	2297	})->prio (1);
…		…
1922		2310
1923	sub cf::client::send_drawinfo {	2311	sub cf::client::send_drawinfo {
1924	my ($self, $text, $flags) = @_;	2312	my ($self, $text, $flags) = @_;
1925		2313
1926	utf8::encode $text;	2314	utf8::encode $text;
1927	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2315	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1928	}	2316	}
1929		2317
		2318	=item $client->ext_event ($type, %msg)
		2319
		2320	Sends an exti event to the client.
		2321
		2322	=cut
		2323
		2324	sub cf::client::ext_event($$%) {
		2325	my ($self, $type, %msg) = @_;
		2326
		2327	$msg{msgtype} = "event_$type";
		2328	$self->send_packet ("ext " . cf::to_json \%msg);
		2329	}
1930		2330
1931	=item $success = $client->query ($flags, "text", \&cb)	2331	=item $success = $client->query ($flags, "text", \&cb)
1932		2332
1933	Queues a query to the client, calling the given callback with	2333	Queues a query to the client, calling the given callback with
1934	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2334	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1963	# get handled first	2363	# get handled first
1964	my $queue = delete $ns->{query_queue}	2364	my $queue = delete $ns->{query_queue}
1965	or return; # be conservative, not sure how that can happen, but we saw a crash here	2365	or return; # be conservative, not sure how that can happen, but we saw a crash here
1966		2366
1967	(shift @$queue)->[1]->($msg);	2367	(shift @$queue)->[1]->($msg);
		2368	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1968		2369
1969	push @{ $ns->{query_queue} }, @$queue;	2370	push @{ $ns->{query_queue} }, @$queue;
1970		2371
1971	if (@{ $ns->{query_queue} } == @$queue) {	2372	if (@{ $ns->{query_queue} } == @$queue) {
1972	if (@$queue) {	2373	if (@$queue) {
…		…
2030		2431
2031	# here we export the classes and methods available to script code	2432	# here we export the classes and methods available to script code
2032		2433
2033	=pod	2434	=pod
2034		2435
2035	The following fucntions and emthods are available within a safe environment:	2436	The following functions and methods are available within a safe environment:
2036		2437
2037	cf::object contr pay_amount pay_player map	2438	cf::object contr pay_amount pay_player map
2038	cf::object::player player	2439	cf::object::player player
2039	cf::player peaceful	2440	cf::player peaceful
2040	cf::map trigger	2441	cf::map trigger
…		…
2121	=back	2522	=back
2122		2523
2123	=cut	2524	=cut
2124		2525
2125	#############################################################################	2526	#############################################################################
		2527	# the server's init and main functions
2126		2528
2127	=head2 EXTENSION DATABASE SUPPORT	2529	sub load_facedata($) {
		2530	my ($path) = @_;
2128		2531
2129	Crossfire maintains a very simple database for extension use. It can	2532	warn "loading facedata from $path\n";
2130	currently store anything that can be serialised using Storable, which
2131	excludes objects.
2132		2533
2133	The parameter C<$family> should best start with the name of the extension	2534	my $facedata;
2134	using it, it should be unique.	2535	0 < aio_load $path, $facedata
		2536	or die "$path: $!";
2135		2537
2136	=over 4	2538	$facedata = Coro::Storable::thaw $facedata;
2137		2539
2138	=item $hashref = cf::db_get $family	2540	$facedata->{version} == 2
		2541	or cf::cleanup "$path: version mismatch, cannot proceed.";
2139		2542
2140	Return a hashref for use by the extension C<$family>, which can be
2141	modified. After modifications, you have to call C<cf::db_dirty> or
2142	C<cf::db_sync>.
2143
2144	=item $value = cf::db_get $family => $key
2145
2146	Returns a single value from the database
2147
2148	=item cf::db_put $family => $hashref
2149
2150	Stores the given family hashref into the database. Updates are delayed, if
2151	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2152
2153	=item cf::db_put $family => $key => $value
2154
2155	Stores the given C<$value> in the family hash. Updates are delayed, if you
2156	want the data to be synced to disk immediately, use C<cf::db_sync>.
2157
2158	=item cf::db_dirty
2159
2160	Marks the database as dirty, to be updated at a later time.
2161
2162	=item cf::db_sync
2163
2164	Immediately write the database to disk I<if it is dirty>.
2165
2166	=cut
2167
2168	our $DB;
2169
2170	{
2171	my $path = cf::localdir . "/database.pst";
2172
2173	sub db_load() {
2174	$DB = stat $path ? Storable::retrieve $path : { };
2175	}	2543	{
		2544	my $faces = $facedata->{faceinfo};
2176		2545
2177	my $pid;	2546	while (my ($face, $info) = each %$faces) {
2178		2547	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2179	sub db_save() {	2548	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2180	waitpid $pid, 0 if $pid;	2549	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2181	if (0 == ($pid = fork)) {	2550	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2182	$DB->{_meta}{version} = 1;	2551	Coro::cede;
2183	Storable::nstore $DB, "$path~";
2184	rename "$path~", $path;
2185	cf::_exit 0 if defined $pid;
2186	}
2187	}
2188
2189	my $dirty;
2190
2191	sub db_sync() {
2192	db_save if $dirty;
2193	undef $dirty;
2194	}
2195
2196	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2197	db_sync;
2198	});
2199
2200	sub db_dirty() {
2201	$dirty = 1;
2202	$idle->start;
2203	}
2204
2205	sub db_get($;$) {
2206	@_ >= 2
2207	? $DB->{$_[0]}{$_[1]}
2208	: ($DB->{$_[0]} ||= { })
2209	}
2210
2211	sub db_put($$;$) {
2212	if (@_ >= 3) {
2213	$DB->{$_[0]}{$_[1]} = $_[2];
2214	} else {
2215	$DB->{$_[0]} = $_[1];
2216	}
2217	db_dirty;
2218	}
2219
2220	cf::global->attach (
2221	prio => 10000,
2222	on_cleanup => sub {
2223	db_sync;
2224	},	2552	}
2225	);
2226	}
2227		2553
2228	#############################################################################	2554	while (my ($face, $info) = each %$faces) {
2229	# the server's main()	2555	next unless $info->{smooth};
		2556	my $idx = cf::face::find $face
		2557	or next;
		2558	if (my $smooth = cf::face::find $info->{smooth}) {
		2559	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2560	} else {
		2561	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2562	}
		2563	Coro::cede;
		2564	}
		2565	}
		2566
		2567	{
		2568	my $anims = $facedata->{animinfo};
		2569
		2570	while (my ($anim, $info) = each %$anims) {
		2571	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2572	Coro::cede;
		2573	}
		2574
		2575	cf::anim::invalidate_all; # d'oh
		2576	}
		2577
		2578	1
		2579	}
		2580
		2581	sub reload_regions {
		2582	load_resource_file "$MAPDIR/regions"
		2583	or die "unable to load regions file\n";
		2584	}
		2585
		2586	sub reload_facedata {
		2587	load_facedata "$DATADIR/facedata"
		2588	or die "unable to load facedata\n";
		2589	}
		2590
		2591	sub reload_archetypes {
		2592	load_resource_file "$DATADIR/archetypes"
		2593	or die "unable to load archetypes\n";
		2594	}
		2595
		2596	sub reload_treasures {
		2597	load_resource_file "$DATADIR/treasures"
		2598	or die "unable to load treasurelists\n";
		2599	}
		2600
		2601	sub reload_resources {
		2602	warn "reloading resource files...\n";
		2603
		2604	reload_regions;
		2605	reload_facedata;
		2606	#reload_archetypes;#d#
		2607	reload_archetypes;
		2608	reload_treasures;
		2609
		2610	warn "finished reloading resource files\n";
		2611	}
		2612
		2613	sub init {
		2614	reload_resources;
		2615	}
2230		2616
2231	sub cfg_load {	2617	sub cfg_load {
2232	open my $fh, "<:utf8", cf::confdir . "/config"	2618	open my $fh, "<:utf8", "$CONFDIR/config"
2233	or return;	2619	or return;
2234		2620
2235	local $/;	2621	local $/;
2236	*CFG = YAML::Syck::Load <$fh>;	2622	*CFG = YAML::Syck::Load <$fh>;
2237		2623
…		…
2251		2637
2252	sub main {	2638	sub main {
2253	# we must not ever block the main coroutine	2639	# we must not ever block the main coroutine
2254	local $Coro::idle = sub {	2640	local $Coro::idle = sub {
2255	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2641	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2642	(async {
2256	async { Event::one_event };	2643	Event::one_event;
		2644	})->prio (Coro::PRIO_MAX);
2257	};	2645	};
2258		2646
2259	cfg_load;	2647	cfg_load;
2260	db_load;	2648	db_init;
2261	load_extensions;	2649	load_extensions;
		2650
		2651	$TICK_WATCHER->start;
2262	Event::loop;	2652	Event::loop;
2263	}	2653	}
2264		2654
2265	#############################################################################	2655	#############################################################################
2266	# initialisation and cleanup	2656	# initialisation and cleanup
2267		2657
2268	# install some emergency cleanup handlers	2658	# install some emergency cleanup handlers
2269	BEGIN {	2659	BEGIN {
2270	for my $signal (qw(INT HUP TERM)) {	2660	for my $signal (qw(INT HUP TERM)) {
2271	Event->signal (	2661	Event->signal (
		2662	reentrant => 0,
2272	data => WF_AUTOCANCEL,	2663	data => WF_AUTOCANCEL,
2273	signal => $signal,	2664	signal => $signal,
		2665	prio => 0,
2274	cb => sub {	2666	cb => sub {
2275	cf::cleanup "SIG$signal";	2667	cf::cleanup "SIG$signal";
2276	},	2668	},
2277	);	2669	);
2278	}	2670	}
2279	}	2671	}
2280		2672
		2673	sub write_runtime {
		2674	my $runtime = "$LOCALDIR/runtime";
		2675
		2676	# first touch the runtime file to show we are still running:
		2677	# the fsync below can take a very very long time.
		2678
		2679	IO::AIO::aio_utime $runtime, undef, undef;
		2680
		2681	my $guard = cf::lock_acquire "write_runtime";
		2682
		2683	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2684	or return;
		2685
		2686	my $value = $cf::RUNTIME + 90 + 10;
		2687	# 10 is the runtime save interval, for a monotonic clock
		2688	# 60 allows for the watchdog to kill the server.
		2689
		2690	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2691	and return;
		2692
		2693	# always fsync - this file is important
		2694	aio_fsync $fh
		2695	and return;
		2696
		2697	# touch it again to show we are up-to-date
		2698	aio_utime $fh, undef, undef;
		2699
		2700	close $fh
		2701	or return;
		2702
		2703	aio_rename "$runtime~", $runtime
		2704	and return;
		2705
		2706	warn "runtime file written.\n";
		2707
		2708	1
		2709	}
		2710
2281	sub emergency_save() {	2711	sub emergency_save() {
2282	my $freeze_guard = cf::freeze_mainloop;	2712	my $freeze_guard = cf::freeze_mainloop;
2283		2713
2284	warn "enter emergency perl save\n";	2714	warn "enter emergency perl save\n";
2285		2715
2286	cf::sync_job {	2716	cf::sync_job {
2287	# use a peculiar iteration method to avoid tripping on perl	2717	# use a peculiar iteration method to avoid tripping on perl
2288	# refcount bugs in for. also avoids problems with players	2718	# refcount bugs in for. also avoids problems with players
2289	# and maps saved/Destroyed asynchronously.	2719	# and maps saved/destroyed asynchronously.
2290	warn "begin emergency player save\n";	2720	warn "begin emergency player save\n";
2291	for my $login (keys %cf::PLAYER) {	2721	for my $login (keys %cf::PLAYER) {
2292	my $pl = $cf::PLAYER{$login} or next;	2722	my $pl = $cf::PLAYER{$login} or next;
2293	$pl->valid or next;	2723	$pl->valid or next;
2294	$pl->save;	2724	$pl->save;
…		…
2300	my $map = $cf::MAP{$path} or next;	2730	my $map = $cf::MAP{$path} or next;
2301	$map->valid or next;	2731	$map->valid or next;
2302	$map->save;	2732	$map->save;
2303	}	2733	}
2304	warn "end emergency map save\n";	2734	warn "end emergency map save\n";
		2735
		2736	warn "begin emergency database checkpoint\n";
		2737	BDB::db_env_txn_checkpoint $DB_ENV;
		2738	warn "end emergency database checkpoint\n";
2305	};	2739	};
2306		2740
2307	warn "leave emergency perl save\n";	2741	warn "leave emergency perl save\n";
2308	}	2742	}
2309		2743
		2744	sub post_cleanup {
		2745	my ($make_core) = @_;
		2746
		2747	warn Carp::longmess "post_cleanup backtrace"
		2748	if $make_core;
		2749	}
		2750
2310	sub reload() {	2751	sub do_reload_perl() {
2311	# can/must only be called in main	2752	# can/must only be called in main
2312	if ($Coro::current != $Coro::main) {	2753	if ($Coro::current != $Coro::main) {
2313	warn "can only reload from main coroutine\n";	2754	warn "can only reload from main coroutine";
2314	return;	2755	return;
2315	}	2756	}
2316		2757
2317	warn "reloading...";	2758	warn "reloading...";
2318		2759
2319	warn "freezing server";	2760	warn "entering sync_job";
2320	my $guard = freeze_mainloop;	2761
		2762	cf::sync_job {
		2763	cf::write_runtime; # external watchdog should not bark
2321	cf::emergency_save;	2764	cf::emergency_save;
		2765	cf::write_runtime; # external watchdog should not bark
2322		2766
2323	warn "sync database to disk";	2767	warn "syncing database to disk";
2324	cf::db_sync;	2768	BDB::db_env_txn_checkpoint $DB_ENV;
2325	IO::AIO::flush;
2326		2769
2327	eval {
2328	# if anything goes wrong in here, we should simply crash as we already saved	2770	# if anything goes wrong in here, we should simply crash as we already saved
2329		2771
2330	warn "cancel all watchers";	2772	warn "cancelling all WF_AUTOCANCEL watchers";
2331	for (Event::all_watchers) {	2773	for (Event::all_watchers) {
2332	$_->cancel if $_->data & WF_AUTOCANCEL;	2774	$_->cancel if $_->data & WF_AUTOCANCEL;
2333	}	2775	}
2334		2776
		2777	warn "flushing outstanding aio requests";
		2778	for (;;) {
		2779	BDB::flush;
		2780	IO::AIO::flush;
		2781	Coro::cede;
		2782	last unless IO::AIO::nreqs || BDB::nreqs;
		2783	warn "iterate...";
		2784	}
		2785
		2786	++$RELOAD;
		2787
2335	warn "cancel all extension coros";	2788	warn "cancelling all extension coros";
2336	$_->cancel for values %EXT_CORO;	2789	$_->cancel for values %EXT_CORO;
2337	%EXT_CORO = ();	2790	%EXT_CORO = ();
2338		2791
2339	warn "remove commands";	2792	warn "removing commands";
2340	%COMMAND = ();	2793	%COMMAND = ();
2341		2794
2342	warn "remove ext commands";	2795	warn "removing ext commands";
2343	%EXTCMD = ();	2796	%EXTCMD = ();
2344		2797
2345	warn "unload/nuke all extensions";	2798	warn "unloading/nuking all extensions";
2346	for my $pkg (@EXTS) {	2799	for my $pkg (@EXTS) {
2347	warn "... unloading $pkg";	2800	warn "... unloading $pkg";
2348		2801
2349	if (my $cb = $pkg->can ("unload")) {	2802	if (my $cb = $pkg->can ("unload")) {
2350	eval {	2803	eval {
…		…
2355		2808
2356	warn "... nuking $pkg";	2809	warn "... nuking $pkg";
2357	Symbol::delete_package $pkg;	2810	Symbol::delete_package $pkg;
2358	}	2811	}
2359		2812
2360	warn "unload all perl modules loaded from $LIBDIR";	2813	warn "unloading all perl modules loaded from $LIBDIR";
2361	while (my ($k, $v) = each %INC) {	2814	while (my ($k, $v) = each %INC) {
2362	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2815	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2363		2816
2364	warn "removing <$k>";	2817	warn "... unloading $k";
2365	delete $INC{$k};	2818	delete $INC{$k};
2366		2819
2367	$k =~ s/\.pm$//;	2820	$k =~ s/\.pm$//;
2368	$k =~ s/\//::/g;	2821	$k =~ s/\//::/g;
2369		2822
…		…
2372	}	2825	}
2373		2826
2374	Symbol::delete_package $k;	2827	Symbol::delete_package $k;
2375	}	2828	}
2376		2829
2377	warn "get rid of safe::, as good as possible";	2830	warn "getting rid of safe::, as good as possible";
2378	Symbol::delete_package "safe::$_"	2831	Symbol::delete_package "safe::$_"
2379	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2832	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2380		2833
2381	warn "unload cf.pm \"a bit\"";	2834	warn "unloading cf.pm \"a bit\"";
2382	delete $INC{"cf.pm"};	2835	delete $INC{"cf.pm"};
		2836	delete $INC{"cf/pod.pm"};
2383		2837
2384	# don't, removes xs symbols, too,	2838	# don't, removes xs symbols, too,
2385	# and global variables created in xs	2839	# and global variables created in xs
2386	#Symbol::delete_package __PACKAGE__;	2840	#Symbol::delete_package __PACKAGE__;
2387		2841
		2842	warn "unload completed, starting to reload now";
		2843
2388	warn "reloading cf.pm";	2844	warn "reloading cf.pm";
2389	require cf;	2845	require cf;
2390	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2846	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2391		2847
2392	warn "load config and database again";	2848	warn "loading config and database again";
2393	cf::cfg_load;	2849	cf::cfg_load;
2394	cf::db_load;
2395		2850
2396	warn "load extensions";	2851	warn "loading extensions";
2397	cf::load_extensions;	2852	cf::load_extensions;
2398		2853
2399	warn "reattach attachments to objects/players";	2854	warn "reattaching attachments to objects/players";
2400	_global_reattach;	2855	_global_reattach; # objects, sockets
2401	warn "reattach attachments to maps";	2856	warn "reattaching attachments to maps";
2402	reattach $_ for values %MAP;	2857	reattach $_ for values %MAP;
2403	};	2858	warn "reattaching attachments to players";
		2859	reattach $_ for values %PLAYER;
2404		2860
2405	if ($@) {	2861	warn "leaving sync_job";
		2862
		2863	1
		2864	} or do {
2406	warn $@;	2865	warn $@;
2407	warn "error while reloading, exiting.";	2866	warn "error while reloading, exiting.";
2408	exit 1;	2867	exit 1;
2409	}	2868	};
2410		2869
2411	warn "reloaded";	2870	warn "reloaded";
2412	};	2871	};
2413		2872
2414	#############################################################################	2873	our $RELOAD_WATCHER; # used only during reload
2415		2874
2416	unless ($LINK_MAP) {	2875	sub reload_perl() {
2417	$LINK_MAP = cf::map::new;	2876	# doing reload synchronously and two reloads happen back-to-back,
		2877	# coro crashes during coro_state_free->destroy here.
2418		2878
2419	$LINK_MAP->width (41);	2879	$RELOAD_WATCHER ||= Event->timer (
2420	$LINK_MAP->height (41);	2880	reentrant => 0,
2421	$LINK_MAP->alloc;
2422	$LINK_MAP->path ("{link}");
2423	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2424	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2425
2426	# dirty hack because... archetypes are not yet loaded
2427	Event->timer (
2428	after => 10,	2881	after => 0,
		2882	data => WF_AUTOCANCEL,
2429	cb => sub {	2883	cb => sub {
2430	$_[0]->w->cancel;	2884	do_reload_perl;
2431		2885	undef $RELOAD_WATCHER;
2432	# provide some exits "home"
2433	my $exit = cf::object::new "exit";
2434
2435	$exit->slaying ($EMERGENCY_POSITION->[0]);
2436	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2437	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2438
2439	$LINK_MAP->insert ($exit->clone, 19, 19);
2440	$LINK_MAP->insert ($exit->clone, 19, 20);
2441	$LINK_MAP->insert ($exit->clone, 19, 21);
2442	$LINK_MAP->insert ($exit->clone, 20, 19);
2443	$LINK_MAP->insert ($exit->clone, 20, 21);
2444	$LINK_MAP->insert ($exit->clone, 21, 19);
2445	$LINK_MAP->insert ($exit->clone, 21, 20);
2446	$LINK_MAP->insert ($exit->clone, 21, 21);
2447
2448	$exit->destroy;
2449	});	2886	},
2450		2887	);
2451	$LINK_MAP->{deny_save} = 1;
2452	$LINK_MAP->{deny_reset} = 1;
2453
2454	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2455	}	2888	}
2456		2889
2457	register_command "reload" => sub {	2890	register_command "reload" => sub {
2458	my ($who, $arg) = @_;	2891	my ($who, $arg) = @_;
2459		2892
2460	if ($who->flag (FLAG_WIZ)) {	2893	if ($who->flag (FLAG_WIZ)) {
2461	$who->message ("start of reload.");
2462	reload;
2463	$who->message ("end of reload.");	2894	$who->message ("reloading server.");
		2895	async { reload_perl };
2464	}	2896	}
2465	};	2897	};
2466		2898
2467	unshift @INC, $LIBDIR;	2899	unshift @INC, $LIBDIR;
2468		2900
		2901	my $bug_warning = 0;
		2902
		2903	our @WAIT_FOR_TICK;
		2904	our @WAIT_FOR_TICK_BEGIN;
		2905
		2906	sub wait_for_tick {
		2907	return unless $TICK_WATCHER->is_active;
		2908	return if $Coro::current == $Coro::main;
		2909
		2910	my $signal = new Coro::Signal;
		2911	push @WAIT_FOR_TICK, $signal;
		2912	$signal->wait;
		2913	}
		2914
		2915	sub wait_for_tick_begin {
		2916	return unless $TICK_WATCHER->is_active;
		2917	return if $Coro::current == $Coro::main;
		2918
		2919	my $signal = new Coro::Signal;
		2920	push @WAIT_FOR_TICK_BEGIN, $signal;
		2921	$signal->wait;
		2922	}
		2923
		2924	my $min = 1e6;#d#
		2925	my $avg = 10;
2469	$TICK_WATCHER = Event->timer (	2926	$TICK_WATCHER = Event->timer (
2470	reentrant => 0,	2927	reentrant => 0,
		2928	parked => 1,
2471	prio => 0,	2929	prio => 0,
2472	at => $NEXT_TICK || $TICK,	2930	at => $NEXT_TICK || $TICK,
2473	data => WF_AUTOCANCEL,	2931	data => WF_AUTOCANCEL,
2474	cb => sub {	2932	cb => sub {
		2933	if ($Coro::current != $Coro::main) {
		2934	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2935	unless ++$bug_warning > 10;
		2936	return;
		2937	}
		2938
2475	$NOW = Event::time;	2939	$NOW = $tick_start = Event::time;
2476		2940
2477	cf::server_tick; # one server iteration	2941	cf::server_tick; # one server iteration
		2942
		2943	0 && sync_job {#d#
		2944	for(1..10) {
		2945	my $t = Event::time;
		2946	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2947	or die;
		2948
		2949	$map->width (50);
		2950	$map->height (50);
		2951	$map->alloc;
		2952	$map->_load_objects ("/tmp/x.map", 1);
		2953	my $t = Event::time - $t;
		2954
		2955	#next unless $t < 0.0013;#d#
		2956	if ($t < $min) {
		2957	$min = $t;
		2958	}
		2959	$avg = $avg * 0.99 + $t * 0.01;
		2960	}
		2961	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2962	exit 0;
		2963	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		2964	};
		2965
2478	$RUNTIME += $TICK;	2966	$RUNTIME += $TICK;
2479	$NEXT_TICK += $TICK;	2967	$NEXT_TICK += $TICK;
2480		2968
2481	$WAIT_FOR_TICK->broadcast;	2969	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2482	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	2970	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2971	Coro::async_pool {
		2972	write_runtime
		2973	or warn "ERROR: unable to write runtime file: $!";
		2974	};
		2975	}
		2976
		2977	# my $AFTER = Event::time;
		2978	# warn $AFTER - $NOW;#d#
		2979
		2980	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2981	$sig->send;
		2982	}
		2983	while (my $sig = shift @WAIT_FOR_TICK) {
		2984	$sig->send;
		2985	}
		2986
		2987	$NOW = Event::time;
2483		2988
2484	# if we are delayed by four ticks or more, skip them all	2989	# if we are delayed by four ticks or more, skip them all
2485	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2990	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2486		2991
2487	$TICK_WATCHER->at ($NEXT_TICK);	2992	$TICK_WATCHER->at ($NEXT_TICK);
2488	$TICK_WATCHER->start;	2993	$TICK_WATCHER->start;
		2994
		2995	$LOAD = ($NOW - $tick_start) / $TICK;
		2996	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2997
		2998	_post_tick;
		2999
		3000
2489	},	3001	},
2490	);	3002	);
2491		3003
		3004	{
2492	IO::AIO::max_poll_time $TICK * 0.2;	3005	BDB::max_poll_time $TICK * 0.1;
2493		3006	$BDB_POLL_WATCHER = Event->io (
2494	Event->io (	3007	reentrant => 0,
2495	fd => IO::AIO::poll_fileno,	3008	fd => BDB::poll_fileno,
2496	poll => 'r',	3009	poll => 'r',
2497	prio => 5,	3010	prio => 0,
2498	data => WF_AUTOCANCEL,
2499	cb => \&IO::AIO::poll_cb,
2500	);
2501
2502	Event->timer (
2503	data => WF_AUTOCANCEL,	3011	data => WF_AUTOCANCEL,
2504	after => 0,	3012	cb => \&BDB::poll_cb,
2505	interval => 10,	3013	);
2506	cb => sub {	3014	BDB::min_parallel 8;
2507	(Coro::unblock_sub {	3015
2508	write_runtime	3016	BDB::set_sync_prepare {
2509	or warn "ERROR: unable to write runtime file: $!";	3017	my $status;
		3018	my $current = $Coro::current;
		3019	(
		3020	sub {
		3021	$status = $!;
		3022	$current->ready; undef $current;
		3023	},
		3024	sub {
		3025	Coro::schedule while defined $current;
		3026	$! = $status;
		3027	},
		3028	)
		3029	};
		3030
		3031	unless ($DB_ENV) {
		3032	$DB_ENV = BDB::db_env_create;
		3033
		3034	cf::sync_job {
		3035	eval {
		3036	BDB::db_env_open
		3037	$DB_ENV,
		3038	$BDBDIR,
		3039	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3040	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3041	0666;
		3042
		3043	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3044
		3045	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3046	$DB_ENV->set_lk_detect;
		3047	};
		3048
		3049	cf::cleanup "db_env_open(db): $@" if $@;
2510	})->();	3050	};
2511	},	3051	}
2512	);	3052	}
		3053
		3054	{
		3055	IO::AIO::min_parallel 8;
		3056
		3057	undef $Coro::AIO::WATCHER;
		3058	IO::AIO::max_poll_time $TICK * 0.1;
		3059	$AIO_POLL_WATCHER = Event->io (
		3060	reentrant => 0,
		3061	data => WF_AUTOCANCEL,
		3062	fd => IO::AIO::poll_fileno,
		3063	poll => 'r',
		3064	prio => 6,
		3065	cb => \&IO::AIO::poll_cb,
		3066	);
		3067	}
		3068
		3069	my $_log_backtrace;
		3070
		3071	sub _log_backtrace {
		3072	my ($msg, @addr) = @_;
		3073
		3074	$msg =~ s/\n//;
		3075
		3076	# limit the # of concurrent backtraces
		3077	if ($_log_backtrace < 2) {
		3078	++$_log_backtrace;
		3079	async {
		3080	my @bt = fork_call {
		3081	@addr = map { sprintf "%x", $_ } @addr;
		3082	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3083	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3084	or die "addr2line: $!";
		3085
		3086	my @funcs;
		3087	my @res = <$fh>;
		3088	chomp for @res;
		3089	while (@res) {
		3090	my ($func, $line) = splice @res, 0, 2, ();
		3091	push @funcs, "[$func] $line";
		3092	}
		3093
		3094	@funcs
		3095	};
		3096
		3097	LOG llevInfo, "[ABT] $msg\n";
		3098	LOG llevInfo, "[ABT] $_\n" for @bt;
		3099	--$_log_backtrace;
		3100	};
		3101	} else {
		3102	LOG llevInfo, "[ABT] $msg\n";
		3103	LOG llevInfo, "[ABT] [suppressed]\n";
		3104	}
		3105	}
		3106
		3107	# load additional modules
		3108	use cf::pod;
2513		3109
2514	END { cf::emergency_save }	3110	END { cf::emergency_save }
2515		3111
2516	1	3112	1
2517		3113

Diff Legend

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