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

Diff Legend

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