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

Diff Legend

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