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.298 by root, Sun Jul 8 14:50:07 2007 UTC

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

Diff Legend

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