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.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.309 by elmex, Mon Jul 16 15:27:06 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
…		…
637	our $override;	870	our $override;
638	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	871	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
639		872
640	sub override {	873	sub override {
641	$override = 1;	874	$override = 1;
642	@invoke_results = ();	875	@invoke_results = (@_);
643	}	876	}
644		877
645	sub do_invoke {	878	sub do_invoke {
646	my $event = shift;	879	my $event = shift;
647	my $callbacks = shift;	880	my $callbacks = shift;
…		…
741	$filename, length $$rdata, scalar @$objs;	974	$filename, length $$rdata, scalar @$objs;
742		975
743	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	976	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
744	chmod SAVE_MODE, $fh;	977	chmod SAVE_MODE, $fh;
745	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	978	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
746	aio_fsync $fh;	979	aio_fsync $fh if $cf::USE_FSYNC;
747	close $fh;	980	close $fh;
748		981
749	if (@$objs) {	982	if (@$objs) {
750	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) {
751	chmod SAVE_MODE, $fh;	984	chmod SAVE_MODE, $fh;
752	my $data = Storable::nfreeze { version => 1, objs => $objs };	985	my $data = Storable::nfreeze { version => 1, objs => $objs };
753	aio_write $fh, 0, (length $data), $data, 0;	986	aio_write $fh, 0, (length $data), $data, 0;
754	aio_fsync $fh;	987	aio_fsync $fh if $cf::USE_FSYNC;
755	close $fh;	988	close $fh;
756	aio_rename "$filename.pst~", "$filename.pst";	989	aio_rename "$filename.pst~", "$filename.pst";
757	}	990	}
758	} else {	991	} else {
759	aio_unlink "$filename.pst";	992	aio_unlink "$filename.pst";
…		…
791	or return;	1024	or return;
792	$av = eval { (Storable::thaw $av)->{objs} };	1025	$av = eval { (Storable::thaw $av)->{objs} };
793	}	1026	}
794		1027
795	warn sprintf "loading %s (%d)\n",	1028	warn sprintf "loading %s (%d)\n",
796	$filename, length $data, scalar @{$av || []};#d#	1029	$filename, length $data, scalar @{$av || []};
797	return ($data, $av);	1030	return ($data, $av);
798	}	1031	}
		1032
		1033	=head2 COMMAND CALLBACKS
		1034
		1035	=over 4
		1036
		1037	=cut
799		1038
800	#############################################################################	1039	#############################################################################
801	# command handling &c	1040	# command handling &c
802		1041
803	=item cf::register_command $name => \&callback($ob,$args);	1042	=item cf::register_command $name => \&callback($ob,$args);
…		…
816	push @{ $COMMAND{$name} }, [$caller, $cb];	1055	push @{ $COMMAND{$name} }, [$caller, $cb];
817	}	1056	}
818		1057
819	=item cf::register_extcmd $name => \&callback($pl,$packet);	1058	=item cf::register_extcmd $name => \&callback($pl,$packet);
820		1059
821	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.
822		1065
823	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
824	called.	1067	called.
825		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
826	=cut	1080	=cut
827		1081
828	sub register_extcmd {	1082	sub register_extcmd {
829	my ($name, $cb) = @_;	1083	my ($name, $cb) = @_;
830		1084
831	$EXTCMD{$name} = $cb;	1085	$EXTCMD{$name} = $cb;
		1086	}
		1087
		1088	sub register_exticmd {
		1089	my ($name, $cb) = @_;
		1090
		1091	$EXTICMD{$name} = $cb;
832	}	1092	}
833		1093
834	cf::player->attach (	1094	cf::player->attach (
835	on_command => sub {	1095	on_command => sub {
836	my ($pl, $name, $params) = @_;	1096	my ($pl, $name, $params) = @_;
…		…
845	cf::override;	1105	cf::override;
846	},	1106	},
847	on_extcmd => sub {	1107	on_extcmd => sub {
848	my ($pl, $buf) = @_;	1108	my ($pl, $buf) = @_;
849		1109
850	my $msg = eval { from_json $buf };	1110	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
851		1111
852	if (ref $msg) {	1112	if (ref $msg) {
853	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1113	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
854	if (my %reply = $cb->($pl, $msg)) {	1114	if (my %reply = $cb->($pl, $msg)) {
855	$pl->ext_reply ($msg->{msgid}, %reply);	1115	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
861		1121
862	cf::override;	1122	cf::override;
863	},	1123	},
864	);	1124	);
865		1125
866	sub load_extension {
867	my ($path) = @_;
868
869	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
870	my $base = $1;
871	my $pkg = $1;
872	$pkg =~ s/[^[:word:]]/_/g;
873	$pkg = "ext::$pkg";
874
875	warn "... loading '$path' into '$pkg'\n";
876
877	open my $fh, "<:utf8", $path
878	or die "$path: $!";
879
880	my $source =
881	"package $pkg; use strict; use utf8;\n"
882	. "#line 1 \"$path\"\n{\n"
883	. (do { local $/; <$fh> })
884	. "\n};\n1";
885
886	unless (eval $source) {
887	my $msg = $@ ? "$path: $@\n"
888	: "extension disabled.\n";
889	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
890	warn $@;
891	warn "mandatory extension failed to load, exiting.\n";
892	exit 1;
893	}
894	die $@;
895	}
896
897	push @EXTS, $pkg;
898	}
899
900	sub load_extensions {	1126	sub load_extensions {
		1127	cf::sync_job {
		1128	my %todo;
		1129
901	for my $ext (<$LIBDIR/*.ext>) {	1130	for my $path (<$LIBDIR/*.ext>) {
902	next unless -r $ext;	1131	next unless -r $path;
903	eval {	1132
904	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;
905	1	1190	}
906	} or warn "$ext not loaded: $@";	1191
		1192	skip:
		1193	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1194	unless $progress;
		1195	}
907	}	1196	};
908	}	1197	}
909		1198
910	#############################################################################	1199	#############################################################################
911		1200
		1201	=back
		1202
912	=head2 CORE EXTENSIONS	1203	=head2 CORE EXTENSIONS
913		1204
914	Functions and methods that extend core crossfire objects.	1205	Functions and methods that extend core crossfire objects.
915		1206
916	=cut	1207	=cut
…		…
928	Returns the given player object, loading it if necessary (might block).	1219	Returns the given player object, loading it if necessary (might block).
929		1220
930	=cut	1221	=cut
931		1222
932	sub playerdir($) {	1223	sub playerdir($) {
933	cf::localdir	1224	"$PLAYERDIR/"
934	. "/"
935	. cf::playerdir
936	. "/"
937	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1225	. (ref $_[0] ? $_[0]->ob->name : $_[0])
938	}	1226	}
939		1227
940	sub path($) {	1228	sub path($) {
941	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1229	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
942		1230
943	(playerdir $login) . "/$login.pl"	1231	(playerdir $login) . "/playerdata"
944	}	1232	}
945		1233
946	sub find_active($) {	1234	sub find_active($) {
947	$cf::PLAYER{$_[0]}	1235	$cf::PLAYER{$_[0]}
948	and $cf::PLAYER{$_[0]}->active	1236	and $cf::PLAYER{$_[0]}->active
…		…
951		1239
952	sub exists($) {	1240	sub exists($) {
953	my ($login) = @_;	1241	my ($login) = @_;
954		1242
955	$cf::PLAYER{$login}	1243	$cf::PLAYER{$login}
956	or cf::sync_job { !aio_stat $login }	1244	or cf::sync_job { !aio_stat path $login }
957	}	1245	}
958		1246
959	sub find($) {	1247	sub find($) {
960	return $cf::PLAYER{$_[0]} || do {	1248	return $cf::PLAYER{$_[0]} || do {
961	my $login = $_[0];	1249	my $login = $_[0];
962		1250
963	my $guard = cf::lock_acquire "user_find:$login";	1251	my $guard = cf::lock_acquire "user_find:$login";
964		1252
965	$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
966	my $pl = load_pl path $login	1261	my $pl = load_pl path $login
967	or return;	1262	or return;
968	$cf::PLAYER{$login} = $pl	1263	$cf::PLAYER{$login} = $pl
969	}	1264	}
970	}	1265	}
…		…
1007		1302
1008	=cut	1303	=cut
1009		1304
1010	sub quit_character {	1305	sub quit_character {
1011	my ($pl) = @_;	1306	my ($pl) = @_;
		1307
		1308	my $name = $pl->ob->name;
1012		1309
1013	$pl->{deny_save} = 1;	1310	$pl->{deny_save} = 1;
1014	$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
1015		1312
1016	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1313	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1021	my $path = playerdir $pl;	1318	my $path = playerdir $pl;
1022	my $temp = "$path~$cf::RUNTIME~deleting~";	1319	my $temp = "$path~$cf::RUNTIME~deleting~";
1023	aio_rename $path, $temp;	1320	aio_rename $path, $temp;
1024	delete $cf::PLAYER{$pl->ob->name};	1321	delete $cf::PLAYER{$pl->ob->name};
1025	$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
1026	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;
1027	}	1344	}
1028		1345
1029	=item cf::player::list_logins	1346	=item cf::player::list_logins
1030		1347
1031	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
1032	while and may block, so not sync_job-capable, ever.	1349	while and may block, so not sync_job-capable, ever.
1033		1350
1034	=cut	1351	=cut
1035		1352
1036	sub list_logins {	1353	sub list_logins {
1037	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1354	my $dirs = aio_readdir $PLAYERDIR
1038	or return [];	1355	or return [];
1039		1356
1040	my @logins;	1357	my @logins;
1041		1358
1042	for my $login (@$dirs) {	1359	for my $login (@$dirs) {
…		…
1059	=cut	1376	=cut
1060		1377
1061	sub maps($) {	1378	sub maps($) {
1062	my ($pl) = @_;	1379	my ($pl) = @_;
1063		1380
		1381	$pl = ref $pl ? $pl->ob->name : $pl;
		1382
1064	my $files = aio_readdir playerdir $pl	1383	my $files = aio_readdir playerdir $pl
1065	or return;	1384	or return;
1066		1385
1067	my @paths;	1386	my @paths;
1068		1387
1069	for (@$files) {	1388	for (@$files) {
1070	utf8::decode $_;	1389	utf8::decode $_;
1071	next if /\.(?:pl|pst)$/;	1390	next if /\.(?:pl|pst)$/;
1072	next unless /^$PATH_SEP/o;	1391	next unless /^$PATH_SEP/o;
1073		1392
1074	s/\.map$//;	1393	push @paths, cf::map::normalise "~$pl/$_";
1075	push @paths, "~" . $pl->ob->name . "/" . $_;
1076	}	1394	}
1077		1395
1078	\@paths	1396	\@paths
1079	}	1397	}
1080		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
1081	=item $player->ext_reply ($msgid, $msgtype, %msg)	1449	=item $player->ext_reply ($msgid, %msg)
1082		1450
1083	Sends an ext reply to the player.	1451	Sends an ext reply to the player.
1084		1452
1085	=cut	1453	=cut
1086		1454
1087	sub ext_reply($$$%) {	1455	sub ext_reply($$%) {
1088	my ($self, $id, %msg) = @_;	1456	my ($self, $id, %msg) = @_;
1089		1457
1090	$msg{msgid} = $id;	1458	$msg{msgid} = $id;
1091		1459	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1092	$self->send ("ext " . cf::to_json \%msg);
1093	}	1460	}
1094		1461
1095	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	}
1096		1502
1097	=back	1503	=back
1098
1099		1504
1100	=head3 cf::map	1505	=head3 cf::map
1101		1506
1102	=over 4	1507	=over 4
1103		1508
…		…
1107		1512
1108	use Fcntl;	1513	use Fcntl;
1109	use Coro::AIO;	1514	use Coro::AIO;
1110		1515
1111	use overload	1516	use overload
1112	'""' => \&as_string;	1517	'""' => \&as_string,
		1518	fallback => 1;
1113		1519
1114	our $MAX_RESET = 3600;	1520	our $MAX_RESET = 3600;
1115	our $DEFAULT_RESET = 3000;	1521	our $DEFAULT_RESET = 3000;
1116		1522
1117	sub generate_random_map {	1523	sub generate_random_map {
1118	my ($self, $rmp) = @_;	1524	my ($self, $rmp) = @_;
1119
1120	# mit "rum" bekleckern, nicht	1525	# mit "rum" bekleckern, nicht
1121	$self->_create_random_map (	1526	$self->_create_random_map (
1122	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1527	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1123	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1528	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1124	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1529	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1131	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1536	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1132	(cf::region::find $rmp->{region}), $rmp->{custom}	1537	(cf::region::find $rmp->{region}), $rmp->{custom}
1133	)	1538	)
1134	}	1539	}
1135		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
1136	sub register {	1549	sub register {
1137	my (undef, $regex) = @_;	1550	my (undef, $regex, $prio) = @_;
1138	my $pkg = caller;	1551	my $pkg = caller;
1139		1552
1140	no strict;	1553	no strict;
1141	push @{"$pkg\::ISA"}, __PACKAGE__;	1554	push @{"$pkg\::ISA"}, __PACKAGE__;
1142		1555
1143	$EXT_MAP{$pkg} = qr<$regex>;	1556	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1144	}	1557	}
1145		1558
1146	# also paths starting with '/'	1559	# also paths starting with '/'
1147	$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	}
1148		1571
1149	sub normalise {	1572	sub normalise {
1150	my ($path, $base) = @_;	1573	my ($path, $base) = @_;
		1574
		1575	$path = "$path"; # make sure its a string
		1576
		1577	$path =~ s/\.map$//;
1151		1578
1152	# map plan:	1579	# map plan:
1153	#	1580	#
1154	# /! non-realised random map exit (special hack!)	1581	# /! non-realised random map exit (special hack!)
1155	# {... are special paths that are not being touched	1582	# {... are special paths that are not being touched
…		…
1183		1610
1184	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
1185		1612
1186	$path = normalise $path, $base;	1613	$path = normalise $path, $base;
1187		1614
1188	for my $pkg (keys %EXT_MAP) {	1615	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1189	if ($path =~ $EXT_MAP{$pkg}) {	1616	if ($path =~ $EXT_MAP{$pkg}[1]) {
1190	my $self = bless cf::map::new, $pkg;	1617	my $self = bless cf::map::new, $pkg;
1191	$self->{path} = $path; $self->path ($path);	1618	$self->{path} = $path; $self->path ($path);
1192	$self->init; # pass $1 etc.	1619	$self->init; # pass $1 etc.
1193	return $self;	1620	return $self;
1194	}	1621	}
1195	}	1622	}
1196		1623
1197	Carp::carp "unable to resolve path '$path'.";	1624	Carp::cluck "unable to resolve path '$path' (base '$base').";
1198	()	1625	()
1199	}	1626	}
1200		1627
1201	sub init {	1628	sub init {
1202	my ($self) = @_;	1629	my ($self) = @_;
…		…
1217		1644
1218	# the original (read-only) location	1645	# the original (read-only) location
1219	sub load_path {	1646	sub load_path {
1220	my ($self) = @_;	1647	my ($self) = @_;
1221		1648
1222	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1649	"$MAPDIR/$self->{path}.map"
1223	}	1650	}
1224		1651
1225	# the temporary/swap location	1652	# the temporary/swap location
1226	sub save_path {	1653	sub save_path {
1227	my ($self) = @_;	1654	my ($self) = @_;
1228		1655
1229	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1656	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1230	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1657	"$TMPDIR/$path.map"
1231	}	1658	}
1232		1659
1233	# the unique path, undef == no special unique path	1660	# the unique path, undef == no special unique path
1234	sub uniq_path {	1661	sub uniq_path {
1235	my ($self) = @_;	1662	my ($self) = @_;
1236		1663
1237	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1664	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1238	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1665	"$UNIQUEDIR/$path"
1239	}	1666	}
1240		1667
1241	# and all this just because we cannot iterate over	1668	# and all this just because we cannot iterate over
1242	# all maps in C++...	1669	# all maps in C++...
1243	sub change_all_map_light {	1670	sub change_all_map_light {
…		…
1245		1672
1246	$_->change_map_light ($change)	1673	$_->change_map_light ($change)
1247	for grep $_->outdoor, values %cf::MAP;	1674	for grep $_->outdoor, values %cf::MAP;
1248	}	1675	}
1249		1676
		1677	sub decay_objects {
		1678	my ($self) = @_;
		1679
		1680	return if $self->{deny_reset};
		1681
		1682	$self->do_decay_objects;
		1683	}
		1684
1250	sub unlink_save {	1685	sub unlink_save {
1251	my ($self) = @_;	1686	my ($self) = @_;
1252		1687
1253	utf8::encode (my $save = $self->save_path);	1688	utf8::encode (my $save = $self->save_path);
1254	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;	1689	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1255	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";	1690	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1256	}	1691	}
1257		1692
1258	sub load_header_from($) {	1693	sub load_header_from($) {
1259	my ($self, $path) = @_;	1694	my ($self, $path) = @_;
1260		1695
1261	utf8::encode $path;	1696	utf8::encode $path;
1262	aio_open $path, O_RDONLY, 0	1697	#aio_open $path, O_RDONLY, 0
1263	or return;	1698	# or return;
1264		1699
1265	$self->_load_header ($path)	1700	$self->_load_header ($path)
1266	or return;	1701	or return;
1267		1702
1268	$self->{load_path} = $path;	1703	$self->{load_path} = $path;
1269		1704
1270	1	1705	1
1271	}	1706	}
1272		1707
1273	sub load_orig {	1708	sub load_header_orig {
1274	my ($self) = @_;	1709	my ($self) = @_;
1275		1710
1276	$self->load_header_from ($self->load_path)	1711	$self->load_header_from ($self->load_path)
1277	}	1712	}
1278		1713
1279	sub load_temp {	1714	sub load_header_temp {
1280	my ($self) = @_;	1715	my ($self) = @_;
1281		1716
1282	$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;
1283	}	1737	}
1284		1738
1285	sub load_header {	1739	sub load_header {
1286	my ($self) = @_;	1740	my ($self) = @_;
1287		1741
1288	if ($self->load_temp) {	1742	if ($self->load_header_temp) {
1289	$self->last_access ((delete $self->{last_access})	1743	$self->prepare_temp;
1290	|| $cf::RUNTIME); #d#
1291	# safety
1292	$self->{instantiate_time} = $cf::RUNTIME
1293	if $self->{instantiate_time} > $cf::RUNTIME;
1294	} else {	1744	} else {
1295	$self->load_orig	1745	$self->load_header_orig
1296	or return;	1746	or return;
1297		1747	$self->prepare_orig;
1298	$self->{load_original} = 1;
1299	$self->{instantiate_time} = $cf::RUNTIME;
1300	$self->last_access ($cf::RUNTIME);
1301	$self->instantiate;
1302	}	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;
1303		1755
1304	1	1756	1
1305	}	1757	}
1306		1758
1307	sub find;	1759	sub find;
…		…
1320	$map->{last_save} = $cf::RUNTIME;	1772	$map->{last_save} = $cf::RUNTIME;
1321		1773
1322	$map->load_header	1774	$map->load_header
1323	or return;	1775	or return;
1324		1776
1325	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;
1326	$map->reset;	1780	$map->reset;
1327	undef $guard;	1781	undef $guard;
1328	$map = find $path	1782	return find $path;
1329	or return;
1330	}	1783	}
1331		1784
1332	$cf::MAP{$path} = $map	1785	$cf::MAP{$path} = $map
1333	}	1786	}
1334	}	1787	}
		1788
		1789	sub pre_load { }
		1790	sub post_load { }
1335		1791
1336	sub load {	1792	sub load {
1337	my ($self) = @_;	1793	my ($self) = @_;
1338		1794
		1795	local $self->{deny_reset} = 1; # loading can take a long time
		1796
1339	my $path = $self->{path};	1797	my $path = $self->{path};
		1798
		1799	{
1340	my $guard = cf::lock_acquire "map_load:$path";	1800	my $guard = cf::lock_acquire "map_load:$path";
1341		1801
1342	return if $self->in_memory != cf::MAP_SWAPPED;	1802	return if $self->in_memory != cf::MAP_SWAPPED;
1343		1803
1344	$self->in_memory (cf::MAP_LOADING);	1804	$self->in_memory (cf::MAP_LOADING);
1345		1805
1346	$self->alloc;	1806	$self->alloc;
1347	$self->_load_objects ($self->{load_path}, 1)
1348	or return;
1349		1807
1350	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1808	$self->pre_load;
1351	if delete $self->{load_original};
1352
1353	if (my $uniq = $self->uniq_path) {
1354	utf8::encode $uniq;
1355	if (aio_open $uniq, O_RDONLY, 0) {
1356	$self->clear_unique_items;
1357	$self->_load_objects ($uniq, 0);
1358	}
1359	}
1360
1361	Coro::cede;
1362
1363	# now do the right thing for maps
1364	$self->link_multipart_objects;
1365
1366	unless ($self->{deny_activate}) {
1367	$self->decay_objects;
1368	$self->fix_auto_apply;
1369	$self->update_buttons;
1370	Coro::cede;	1809	Coro::cede;
1371	$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;
1372	$self->difficulty ($self->estimate_difficulty)	1828	$self->difficulty ($self->estimate_difficulty)
1373	unless $self->difficulty;	1829	unless $self->difficulty;
1374	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;
1375	$self->activate;	1839	$self->activate;
1376	}	1840	}
1377		1841
1378	$self->in_memory (cf::MAP_IN_MEMORY);	1842	$self->in_memory (cf::MAP_IN_MEMORY);
		1843	}
		1844
		1845	$self->post_load;
1379	}	1846	}
1380		1847
1381	sub customise_for {	1848	sub customise_for {
1382	my ($self, $ob) = @_;	1849	my ($self, $ob) = @_;
1383		1850
1384	return find "~" . $ob->name . "/" . $self->{path}	1851	return find "~" . $ob->name . "/" . $self->{path}
1385	if $self->per_player;	1852	if $self->per_player;
		1853
		1854	# return find "?party/" . $ob->name . "/" . $self->{path}
		1855	# if $self->per_party;
1386		1856
1387	$self	1857	$self
1388	}	1858	}
1389		1859
1390	# 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
…		…
1422		1892
1423	cf::sync_job { $map->load };	1893	cf::sync_job { $map->load };
1424	}	1894	}
1425		1895
1426	our %MAP_PREFETCH;	1896	our %MAP_PREFETCH;
1427	our $MAP_PREFETCHER = Coro::async {	1897	our $MAP_PREFETCHER = undef;
1428	while () {
1429	for my $path (keys %MAP_PREFETCH) {
1430	my $map = find $path
1431	or next;
1432	$map->load;
1433
1434	delete $MAP_PREFETCH{$path};
1435	}
1436	Coro::schedule;
1437	}
1438	};
1439		1898
1440	sub find_async {	1899	sub find_async {
1441	my ($path, $origin) = @_;	1900	my ($path, $origin) = @_;
1442		1901
1443	$path = normalise $path, $origin && $origin->{path};	1902	$path = normalise $path, $origin && $origin->{path};
1444		1903
1445	if (my $map = $cf::MAP{$path}) {	1904	if (my $map = $cf::MAP{$path}) {
1446	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1905	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1447	}	1906	}
1448		1907
1449	$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	if (my $map = find $path) {
		1913	$map->load;
		1914	}
		1915
		1916	delete $MAP_PREFETCH{$path};
		1917	}
		1918	}
		1919	undef $MAP_PREFETCHER;
		1920	};
1450	$MAP_PREFETCHER->ready;	1921	$MAP_PREFETCHER->prio (6);
1451		1922
1452	()	1923	()
1453	}	1924	}
1454		1925
1455	sub save {	1926	sub save {
…		…
1500		1971
1501	sub reset_at {	1972	sub reset_at {
1502	my ($self) = @_;	1973	my ($self) = @_;
1503		1974
1504	# TODO: safety, remove and allow resettable per-player maps	1975	# TODO: safety, remove and allow resettable per-player maps
1505	return 1e99 if $self->isa ("ext::map_per_player");#d#
1506	return 1e99 if $self->{deny_reset};	1976	return 1e99 if $self->{deny_reset};
1507		1977
1508	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1978	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1509	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;
1510		1980
…		…
1515	my ($self) = @_;	1985	my ($self) = @_;
1516		1986
1517	$self->reset_at <= $cf::RUNTIME	1987	$self->reset_at <= $cf::RUNTIME
1518	}	1988	}
1519		1989
1520	sub rename {
1521	my ($self, $new_path) = @_;
1522
1523	normalise $new_path;
1524
1525	$self->unlink_save;
1526
1527	delete $cf::MAP{$self->path};
1528	$self->{path} = $new_path; $self->path ($self->{path});
1529	$cf::MAP{$self->path} = $self;
1530
1531	$self->save;
1532	}
1533
1534	sub reset {	1990	sub reset {
1535	my ($self) = @_;	1991	my ($self) = @_;
1536		1992
1537	my $lock = cf::lock_acquire "map_data:$self->{path}";	1993	my $lock = cf::lock_acquire "map_data:$self->{path}";
1538		1994
1539	return if $self->players;	1995	return if $self->players;
1540	return if $self->isa ("ext::map_per_player");#d#
1541		1996
1542	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	}
1543		2008
1544	delete $cf::MAP{$self->path};	2009	delete $cf::MAP{$self->path};
1545		2010
1546	$self->in_memory (cf::MAP_SWAPPED);
1547	$self->clear;	2011	$self->clear;
1548		2012
1549	$_->clear_links_to ($self) for values %cf::MAP;	2013	$_->clear_links_to ($self) for values %cf::MAP;
1550		2014
1551	$self->unlink_save;	2015	$self->unlink_save;
…		…
1555	my $nuke_counter = "aaaa";	2019	my $nuke_counter = "aaaa";
1556		2020
1557	sub nuke {	2021	sub nuke {
1558	my ($self) = @_;	2022	my ($self) = @_;
1559		2023
		2024	delete $cf::MAP{$self->path};
		2025
		2026	$self->unlink_save;
		2027
		2028	bless $self, "cf::map";
		2029	delete $self->{deny_reset};
1560	$self->{deny_save} = 1;	2030	$self->{deny_save} = 1;
1561	$self->reset_timeout (1);	2031	$self->reset_timeout (1);
1562	$self->rename ("{nuke}/" . ($nuke_counter++));	2032	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2033
		2034	$cf::MAP{$self->path} = $self;
		2035
1563	$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	]
1564	}	2073	}
1565		2074
1566	=item cf::map::unique_maps	2075	=item cf::map::unique_maps
1567		2076
1568	Returns an arrayref of paths of all shared maps that have	2077	Returns an arrayref of paths of all shared maps that have
1569	instantiated unique items. May block.	2078	instantiated unique items. May block.
1570		2079
1571	=cut	2080	=cut
1572		2081
1573	sub unique_maps() {	2082	sub unique_maps() {
1574	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2083	[
1575	or return;	2084	map {
1576
1577	my @paths;
1578
1579	for (@$files) {
1580	utf8::decode $_;	2085	utf8::decode $_;
1581	next if /\.pst$/;
1582	next unless /^$PATH_SEP/o;
1583
1584	s/\.map$//;	2086	/\.map$/
1585	push @paths, $_;	2087	? normalise $_
		2088	: ()
		2089	} @{ aio_readdir $UNIQUEDIR or [] }
1586	}	2090	]
1587
1588	\@paths
1589	}	2091	}
1590		2092
1591	package cf;	2093	package cf;
1592		2094
1593	=back	2095	=back
…		…
1639		2141
1640	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2142	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1641		2143
1642	if ($self->{record_replies}) {	2144	if ($self->{record_replies}) {
1643	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2145	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2146
1644	} 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 {
1645	$msg = $npc->name . " says: $msg" if $npc;	2160	$msg = $npc->name . " says: $msg" if $npc;
1646	$self->message ($msg, $flags);	2161	$self->message ($msg, $flags);
		2162	}
1647	}	2163	}
1648	}	2164	}
1649		2165
1650	=item $player_object->may ("access")	2166	=item $player_object->may ("access")
1651		2167
…		…
1684	=cut	2200	=cut
1685		2201
1686	sub link_map {	2202	sub link_map {
1687	unless ($LINK_MAP) {	2203	unless ($LINK_MAP) {
1688	$LINK_MAP = cf::map::find "{link}"	2204	$LINK_MAP = cf::map::find "{link}"
1689	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2205	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1690	$LINK_MAP->load;	2206	$LINK_MAP->load;
1691	}	2207	}
1692		2208
1693	$LINK_MAP	2209	$LINK_MAP
1694	}	2210	}
…		…
1699	$self->deactivate_recursive;	2215	$self->deactivate_recursive;
1700		2216
1701	return if UNIVERSAL::isa $self->map, "ext::map_link";	2217	return if UNIVERSAL::isa $self->map, "ext::map_link";
1702		2218
1703	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2219	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1704	if $self->map;	2220	if $self->map && $self->map->{path} ne "{link}";
1705		2221
1706	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2222	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1707	}	2223	}
1708		2224
1709	sub cf::object::player::leave_link {	2225	sub cf::object::player::leave_link {
1710	my ($self, $map, $x, $y) = @_;	2226	my ($self, $map, $x, $y) = @_;
		2227
		2228	return unless $self->contr->active;
1711		2229
1712	my $link_pos = delete $self->{_link_pos};	2230	my $link_pos = delete $self->{_link_pos};
1713		2231
1714	unless ($map) {	2232	unless ($map) {
1715	# restore original map position	2233	# restore original map position
…		…
1733	$map->load;	2251	$map->load;
1734	$map->load_diag;	2252	$map->load_diag;
1735		2253
1736	return unless $self->contr->active;	2254	return unless $self->contr->active;
1737	$self->activate_recursive;	2255	$self->activate_recursive;
		2256
		2257	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1738	$self->enter_map ($map, $x, $y);	2258	$self->enter_map ($map, $x, $y);
1739	}	2259	}
1740		2260
1741	cf::player->attach (	2261	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1742	on_logout => sub {
1743	my ($pl) = @_;
1744		2262
1745	# abort map switching before logout	2263	Moves the player to the given map-path and coordinates by first freezing
1746	if ($pl->ob->{_link_pos}) {	2264	her, loading and preparing them map, calling the provided $check callback
1747	cf::sync_job {	2265	that has to return the map if sucecssful, and then unfreezes the player on
1748	$pl->ob->leave_link	2266	the new (success) or old (failed) map position. In either case, $done will
1749	};	2267	be called at the end of this process.
1750	}
1751	},
1752	on_login => sub {
1753	my ($pl) = @_;
1754		2268
1755	# try to abort aborted map switching on player login :)
1756	# should happen only on crashes
1757	if ($pl->ob->{_link_pos}) {
1758	$pl->ob->enter_link;
1759	(async {
1760	# we need this sleep as the login has a concurrent enter_exit running
1761	# and this sleep increases chances of the player not ending up in scorn
1762	$pl->ob->reply (undef,
1763	"There was an internal problem at your last logout, "
1764	. "the server will try to bring you to your intended destination in a second.",
1765	cf::NDI_RED);
1766	Coro::Timer::sleep 1;
1767	$pl->ob->leave_link;
1768	})->prio (2);
1769	}
1770	},
1771	);
1772
1773	=item $player_object->goto ($path, $x, $y)
1774
1775	=cut	2269	=cut
		2270
		2271	our $GOTOGEN;
1776		2272
1777	sub cf::object::player::goto {	2273	sub cf::object::player::goto {
1778	my ($self, $path, $x, $y) = @_;	2274	my ($self, $path, $x, $y, $check, $done) = @_;
		2275
		2276	# do generation counting so two concurrent goto's will be executed in-order
		2277	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1779		2278
1780	$self->enter_link;	2279	$self->enter_link;
1781		2280
1782	(async {	2281	(async {
		2282	my $map = eval {
1783	my $map = cf::map::find $path;	2283	my $map = cf::map::find $path;
		2284
		2285	if ($map) {
1784	$map = $map->customise_for ($self) if $map;	2286	$map = $map->customise_for ($self);
1785		2287	$map = $check->($map) if $check && $map;
1786	# warn "entering ", $map->path, " at ($x, $y)\n"	2288	} else {
1787	# if $map;
1788
1789	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2289	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2290	}
1790		2291
		2292	$map
		2293	};
		2294
		2295	if ($@) {
		2296	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2297	LOG llevError | logBacktrace, Carp::longmess $@;
		2298	}
		2299
		2300	if ($gen == $self->{_goto_generation}) {
		2301	delete $self->{_goto_generation};
1791	$self->leave_link ($map, $x, $y);	2302	$self->leave_link ($map, $x, $y);
		2303	}
		2304
		2305	$done->() if $done;
1792	})->prio (1);	2306	})->prio (1);
1793	}	2307	}
1794		2308
1795	=item $player_object->enter_exit ($exit_object)	2309	=item $player_object->enter_exit ($exit_object)
1796		2310
…		…
1798		2312
1799	sub parse_random_map_params {	2313	sub parse_random_map_params {
1800	my ($spec) = @_;	2314	my ($spec) = @_;
1801		2315
1802	my $rmp = { # defaults	2316	my $rmp = { # defaults
1803	xsize => 10,	2317	xsize => (cf::rndm 15, 40),
1804	ysize => 10,	2318	ysize => (cf::rndm 15, 40),
		2319	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2320	#layout => string,
1805	};	2321	};
1806		2322
1807	for (split /\n/, $spec) {	2323	for (split /\n/, $spec) {
1808	my ($k, $v) = split /\s+/, $_, 2;	2324	my ($k, $v) = split /\s+/, $_, 2;
1809		2325
…		…
1813	$rmp	2329	$rmp
1814	}	2330	}
1815		2331
1816	sub prepare_random_map {	2332	sub prepare_random_map {
1817	my ($exit) = @_;	2333	my ($exit) = @_;
		2334
		2335	my $guard = cf::lock_acquire "exit_prepare:$exit";
1818		2336
1819	# all this does is basically replace the /! path by	2337	# all this does is basically replace the /! path by
1820	# a new random map path (?random/...) with a seed	2338	# a new random map path (?random/...) with a seed
1821	# that depends on the exit object	2339	# that depends on the exit object
1822		2340
1823	my $rmp = parse_random_map_params $exit->msg;	2341	my $rmp = parse_random_map_params $exit->msg;
1824		2342
1825	if ($exit->map) {	2343	if ($exit->map) {
1826	$rmp->{region} = $exit->map->region_name;	2344	$rmp->{region} = $exit->region->name;
1827	$rmp->{origin_map} = $exit->map->path;	2345	$rmp->{origin_map} = $exit->map->path;
1828	$rmp->{origin_x} = $exit->x;	2346	$rmp->{origin_x} = $exit->x;
1829	$rmp->{origin_y} = $exit->y;	2347	$rmp->{origin_y} = $exit->y;
1830	}	2348	}
1831		2349
1832	$rmp->{random_seed} ||= $exit->random_seed;	2350	$rmp->{random_seed} ||= $exit->random_seed;
1833		2351
1834	my $data = cf::to_json $rmp;	2352	my $data = cf::to_json $rmp;
1835	my $md5 = Digest::MD5::md5_hex $data;	2353	my $md5 = Digest::MD5::md5_hex $data;
		2354	my $meta = "$RANDOMDIR/$md5.meta";
1836		2355
1837	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2356	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1838	aio_write $fh, 0, (length $data), $data, 0;	2357	aio_write $fh, 0, (length $data), $data, 0;
		2358	undef $fh;
		2359	aio_rename "$meta~", $meta;
1839		2360
1840	$exit->slaying ("?random/$md5");	2361	$exit->slaying ("?random/$md5");
1841	$exit->msg (undef);	2362	$exit->msg (undef);
1842	}	2363	}
1843	}	2364	}
…		…
1845	sub cf::object::player::enter_exit {	2366	sub cf::object::player::enter_exit {
1846	my ($self, $exit) = @_;	2367	my ($self, $exit) = @_;
1847		2368
1848	return unless $self->type == cf::PLAYER;	2369	return unless $self->type == cf::PLAYER;
1849		2370
		2371	if ($exit->slaying eq "/!") {
		2372	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2373	# the problem is that $exit might not survive long enough
		2374	# so it needs to be done right now, right here
		2375	cf::sync_job { prepare_random_map $exit };
		2376	}
		2377
		2378	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2379	my $hp = $exit->stats->hp;
		2380	my $sp = $exit->stats->sp;
		2381
1850	$self->enter_link;	2382	$self->enter_link;
		2383
		2384	# if exit is damned, update players death & WoR home-position
		2385	$self->contr->savebed ($slaying, $hp, $sp)
		2386	if $exit->flag (FLAG_DAMNED);
1851		2387
1852	(async {	2388	(async {
1853	$self->deactivate_recursive; # just to be sure	2389	$self->deactivate_recursive; # just to be sure
1854	unless (eval {	2390	unless (eval {
1855	prepare_random_map $exit	2391	$self->goto ($slaying, $hp, $sp);
1856	if $exit->slaying eq "/!";
1857
1858	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1859	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1860		2392
1861	1;	2393	1;
1862	}) {	2394	}) {
1863	$self->message ("Something went wrong deep within the crossfire server. "	2395	$self->message ("Something went wrong deep within the crossfire server. "
1864	. "I'll try to bring you back to the map you were before. "	2396	. "I'll try to bring you back to the map you were before. "
1865	. "Please report this to the dungeon master!",	2397	. "Please report this to the dungeon master!",
1866	cf::NDI_UNIQUE | cf::NDI_RED);	2398	cf::NDI_UNIQUE | cf::NDI_RED);
1867		2399
1868	warn "ERROR in enter_exit: $@";	2400	warn "ERROR in enter_exit: $@";
1869	$self->leave_link;	2401	$self->leave_link;
1870	}	2402	}
1871	})->prio (1);	2403	})->prio (1);
…		…
1884		2416
1885	sub cf::client::send_drawinfo {	2417	sub cf::client::send_drawinfo {
1886	my ($self, $text, $flags) = @_;	2418	my ($self, $text, $flags) = @_;
1887		2419
1888	utf8::encode $text;	2420	utf8::encode $text;
1889	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2421	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1890	}	2422	}
1891		2423
		2424	=item $client->send_msg ($color, $type, $msg, [extra...])
		2425
		2426	Send a drawinfo or msg packet to the client, formatting the msg for the
		2427	client if neccessary. C<$type> should be a string identifying the type of
		2428	the message, with C<log> being the default. If C<$color> is negative, suppress
		2429	the message unless the client supports the msg packet.
		2430
		2431	=cut
		2432
		2433	sub cf::client::send_msg {
		2434	my ($self, $color, $type, $msg, @extra) = @_;
		2435
		2436	$msg = $self->pl->expand_cfpod ($msg);
		2437
		2438	return unless @extra || length $msg;
		2439
		2440	if ($self->can_msg) {
		2441	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2442	} else {
		2443	# replace some tags by gcfclient-compatible ones
		2444	for ($msg) {
		2445	1 while
		2446	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2447	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2448	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2449	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2450	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2451	}
		2452
		2453	if ($color >= 0) {
		2454	if (0 && $msg =~ /\[/) {
		2455	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2456	} else {
		2457	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2458	$self->send_packet ("drawinfo $color $msg")
		2459	}
		2460	}
		2461	}
		2462	}
		2463
		2464	=item $client->ext_event ($type, %msg)
		2465
		2466	Sends an ext event to the client.
		2467
		2468	=cut
		2469
		2470	sub cf::client::ext_event($$%) {
		2471	my ($self, $type, %msg) = @_;
		2472
		2473	return unless $self->extcmd;
		2474
		2475	$msg{msgtype} = "event_$type";
		2476	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
		2477	}
1892		2478
1893	=item $success = $client->query ($flags, "text", \&cb)	2479	=item $success = $client->query ($flags, "text", \&cb)
1894		2480
1895	Queues a query to the client, calling the given callback with	2481	Queues a query to the client, calling the given callback with
1896	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2482	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1897	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2483	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1898		2484
1899	Queries can fail, so check the return code. Or don't, as queries will become	2485	Queries can fail, so check the return code. Or don't, as queries will
1900	reliable at some point in the future.	2486	become reliable at some point in the future.
1901		2487
1902	=cut	2488	=cut
1903		2489
1904	sub cf::client::query {	2490	sub cf::client::query {
1905	my ($self, $flags, $text, $cb) = @_;	2491	my ($self, $flags, $text, $cb) = @_;
…		…
1913	utf8::encode $text;	2499	utf8::encode $text;
1914	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2500	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1915		2501
1916	$self->send_packet ($self->{query_queue}[0][0])	2502	$self->send_packet ($self->{query_queue}[0][0])
1917	if @{ $self->{query_queue} } == 1;	2503	if @{ $self->{query_queue} } == 1;
		2504
		2505	1
1918	}	2506	}
1919		2507
1920	cf::client->attach (	2508	cf::client->attach (
		2509	on_connect => sub {
		2510	my ($ns) = @_;
		2511
		2512	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2513	},
1921	on_reply => sub {	2514	on_reply => sub {
1922	my ($ns, $msg) = @_;	2515	my ($ns, $msg) = @_;
1923		2516
1924	# this weird shuffling is so that direct followup queries	2517	# this weird shuffling is so that direct followup queries
1925	# get handled first	2518	# get handled first
1926	my $queue = delete $ns->{query_queue}	2519	my $queue = delete $ns->{query_queue}
1927	or return; # be conservative, not sure how that can happen, but we saw a crash here	2520	or return; # be conservative, not sure how that can happen, but we saw a crash here
1928		2521
1929	(shift @$queue)->[1]->($msg);	2522	(shift @$queue)->[1]->($msg);
		2523	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1930		2524
1931	push @{ $ns->{query_queue} }, @$queue;	2525	push @{ $ns->{query_queue} }, @$queue;
1932		2526
1933	if (@{ $ns->{query_queue} } == @$queue) {	2527	if (@{ $ns->{query_queue} } == @$queue) {
1934	if (@$queue) {	2528	if (@$queue) {
…		…
1936	} else {	2530	} else {
1937	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2531	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1938	}	2532	}
1939	}	2533	}
1940	},	2534	},
		2535	on_exticmd => sub {
		2536	my ($ns, $buf) = @_;
		2537
		2538	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2539
		2540	if (ref $msg) {
		2541	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2542	if (my %reply = $cb->($ns, $msg)) {
		2543	$reply{msgid} = $msg->{msgid};
		2544	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2545	}
		2546	}
		2547	} else {
		2548	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2549	}
		2550
		2551	cf::override;
		2552	},
1941	);	2553	);
1942		2554
1943	=item $client->async (\&cb)	2555	=item $client->async (\&cb)
1944		2556
1945	Create a new coroutine, running the specified callback. The coroutine will	2557	Create a new coroutine, running the specified callback. The coroutine will
…		…
1992		2604
1993	# here we export the classes and methods available to script code	2605	# here we export the classes and methods available to script code
1994		2606
1995	=pod	2607	=pod
1996		2608
1997	The following fucntions and emthods are available within a safe environment:	2609	The following functions and methods are available within a safe environment:
1998		2610
1999	cf::object contr pay_amount pay_player map	2611	cf::object
		2612	contr pay_amount pay_player map x y force_find force_add
		2613	insert remove
		2614
2000	cf::object::player player	2615	cf::object::player
2001	cf::player peaceful	2616	player
2002	cf::map trigger	2617
		2618	cf::player
		2619	peaceful
		2620
		2621	cf::map
		2622	trigger
2003		2623
2004	=cut	2624	=cut
2005		2625
2006	for (	2626	for (
2007	["cf::object" => qw(contr pay_amount pay_player map)],	2627	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2628	insert remove)],
2008	["cf::object::player" => qw(player)],	2629	["cf::object::player" => qw(player)],
2009	["cf::player" => qw(peaceful)],	2630	["cf::player" => qw(peaceful)],
2010	["cf::map" => qw(trigger)],	2631	["cf::map" => qw(trigger)],
2011	) {	2632	) {
2012	no strict 'refs';	2633	no strict 'refs';
…		…
2083	=back	2704	=back
2084		2705
2085	=cut	2706	=cut
2086		2707
2087	#############################################################################	2708	#############################################################################
		2709	# the server's init and main functions
2088		2710
2089	=head2 EXTENSION DATABASE SUPPORT	2711	sub load_facedata($) {
		2712	my ($path) = @_;
2090		2713
2091	Crossfire maintains a very simple database for extension use. It can	2714	warn "loading facedata from $path\n";
2092	currently store anything that can be serialised using Storable, which
2093	excludes objects.
2094		2715
2095	The parameter C<$family> should best start with the name of the extension	2716	my $facedata;
2096	using it, it should be unique.	2717	0 < aio_load $path, $facedata
		2718	or die "$path: $!";
2097		2719
2098	=over 4	2720	$facedata = Coro::Storable::thaw $facedata;
2099		2721
2100	=item $hashref = cf::db_get $family	2722	$facedata->{version} == 2
		2723	or cf::cleanup "$path: version mismatch, cannot proceed.";
2101		2724
2102	Return a hashref for use by the extension C<$family>, which can be
2103	modified. After modifications, you have to call C<cf::db_dirty> or
2104	C<cf::db_sync>.
2105
2106	=item $value = cf::db_get $family => $key
2107
2108	Returns a single value from the database
2109
2110	=item cf::db_put $family => $hashref
2111
2112	Stores the given family hashref into the database. Updates are delayed, if
2113	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2114
2115	=item cf::db_put $family => $key => $value
2116
2117	Stores the given C<$value> in the family hash. Updates are delayed, if you
2118	want the data to be synced to disk immediately, use C<cf::db_sync>.
2119
2120	=item cf::db_dirty
2121
2122	Marks the database as dirty, to be updated at a later time.
2123
2124	=item cf::db_sync
2125
2126	Immediately write the database to disk I<if it is dirty>.
2127
2128	=cut
2129
2130	our $DB;
2131
2132	{
2133	my $path = cf::localdir . "/database.pst";
2134
2135	sub db_load() {
2136	$DB = stat $path ? Storable::retrieve $path : { };
2137	}	2725	{
		2726	my $faces = $facedata->{faceinfo};
2138		2727
2139	my $pid;	2728	while (my ($face, $info) = each %$faces) {
		2729	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2730	cf::face::set_visibility $idx, $info->{visibility};
		2731	cf::face::set_magicmap $idx, $info->{magicmap};
		2732	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2733	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2140		2734
2141	sub db_save() {	2735	cf::cede_to_tick;
2142	waitpid $pid, 0 if $pid;
2143	if (0 == ($pid = fork)) {
2144	$DB->{_meta}{version} = 1;
2145	Storable::nstore $DB, "$path~";
2146	rename "$path~", $path;
2147	cf::_exit 0 if defined $pid;
2148	}
2149	}
2150
2151	my $dirty;
2152
2153	sub db_sync() {
2154	db_save if $dirty;
2155	undef $dirty;
2156	}
2157
2158	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2159	db_sync;
2160	});
2161
2162	sub db_dirty() {
2163	$dirty = 1;
2164	$idle->start;
2165	}
2166
2167	sub db_get($;$) {
2168	@_ >= 2
2169	? $DB->{$_[0]}{$_[1]}
2170	: ($DB->{$_[0]} ||= { })
2171	}
2172
2173	sub db_put($$;$) {
2174	if (@_ >= 3) {
2175	$DB->{$_[0]}{$_[1]} = $_[2];
2176	} else {
2177	$DB->{$_[0]} = $_[1];
2178	}
2179	db_dirty;
2180	}
2181
2182	cf::global->attach (
2183	prio => 10000,
2184	on_cleanup => sub {
2185	db_sync;
2186	},	2736	}
2187	);
2188	}
2189		2737
2190	#############################################################################	2738	while (my ($face, $info) = each %$faces) {
2191	# the server's main()	2739	next unless $info->{smooth};
		2740	my $idx = cf::face::find $face
		2741	or next;
		2742	if (my $smooth = cf::face::find $info->{smooth}) {
		2743	cf::face::set_smooth $idx, $smooth;
		2744	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2745	} else {
		2746	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2747	}
		2748
		2749	cf::cede_to_tick;
		2750	}
		2751	}
		2752
		2753	{
		2754	my $anims = $facedata->{animinfo};
		2755
		2756	while (my ($anim, $info) = each %$anims) {
		2757	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2758	cf::cede_to_tick;
		2759	}
		2760
		2761	cf::anim::invalidate_all; # d'oh
		2762	}
		2763
		2764	{
		2765	# TODO: for gcfclient pleasure, we should give resources
		2766	# that gcfclient doesn't grok a >10000 face index.
		2767	my $res = $facedata->{resource};
		2768	my $enc = JSON::XS->new->utf8->canonical;
		2769
		2770	while (my ($name, $info) = each %$res) {
		2771	my $meta = $enc->encode ({
		2772	name => $name,
		2773	type => $info->{type},
		2774	copyright => $info->{copyright}, #TODO#
		2775	});
		2776
		2777	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2778
		2779	if ($name =~ /\.jpg$/) {
		2780	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2781	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2782	} else {
		2783	my $data = pack "(w/a*)*", $meta, $info->{data};
		2784	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2785
		2786	cf::face::set_type $idx, 1;
		2787	cf::face::set_data $idx, 0, $data, $chk;
		2788	}
		2789
		2790	cf::cede_to_tick;
		2791	}
		2792	}
		2793
		2794	1
		2795	}
		2796
		2797	sub reload_regions {
		2798	load_resource_file "$MAPDIR/regions"
		2799	or die "unable to load regions file\n";
		2800
		2801	for (cf::region::list) {
		2802	$_->{match} = qr/$_->{match}/
		2803	if exists $_->{match};
		2804	}
		2805	}
		2806
		2807	sub reload_facedata {
		2808	load_facedata "$DATADIR/facedata"
		2809	or die "unable to load facedata\n";
		2810	}
		2811
		2812	sub reload_archetypes {
		2813	load_resource_file "$DATADIR/archetypes"
		2814	or die "unable to load archetypes\n";
		2815	#d# NEED to laod twice to resolve forward references
		2816	# this really needs to be done in an extra post-pass
		2817	# (which needs to be synchronous, so solve it differently)
		2818	load_resource_file "$DATADIR/archetypes"
		2819	or die "unable to load archetypes\n";
		2820	}
		2821
		2822	sub reload_treasures {
		2823	load_resource_file "$DATADIR/treasures"
		2824	or die "unable to load treasurelists\n";
		2825	}
		2826
		2827	sub reload_resources {
		2828	warn "reloading resource files...\n";
		2829
		2830	reload_regions;
		2831	reload_facedata;
		2832	#reload_archetypes;#d#
		2833	reload_archetypes;
		2834	reload_treasures;
		2835
		2836	warn "finished reloading resource files\n";
		2837	}
		2838
		2839	sub init {
		2840	reload_resources;
		2841	}
2192		2842
2193	sub cfg_load {	2843	sub cfg_load {
2194	open my $fh, "<:utf8", cf::confdir . "/config"	2844	open my $fh, "<:utf8", "$CONFDIR/config"
2195	or return;	2845	or return;
2196		2846
2197	local $/;	2847	local $/;
2198	*CFG = YAML::Syck::Load <$fh>;	2848	*CFG = YAML::Syck::Load <$fh>;
2199		2849
…		…
2213		2863
2214	sub main {	2864	sub main {
2215	# we must not ever block the main coroutine	2865	# we must not ever block the main coroutine
2216	local $Coro::idle = sub {	2866	local $Coro::idle = sub {
2217	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2867	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2868	(async {
2218	async { Event::one_event };	2869	Event::one_event;
		2870	})->prio (Coro::PRIO_MAX);
2219	};	2871	};
2220		2872
2221	cfg_load;	2873	cfg_load;
2222	db_load;	2874	db_init;
2223	load_extensions;	2875	load_extensions;
		2876
		2877	$TICK_WATCHER->start;
2224	Event::loop;	2878	Event::loop;
2225	}	2879	}
2226		2880
2227	#############################################################################	2881	#############################################################################
2228	# initialisation and cleanup	2882	# initialisation and cleanup
2229		2883
2230	# install some emergency cleanup handlers	2884	# install some emergency cleanup handlers
2231	BEGIN {	2885	BEGIN {
2232	for my $signal (qw(INT HUP TERM)) {	2886	for my $signal (qw(INT HUP TERM)) {
2233	Event->signal (	2887	Event->signal (
		2888	reentrant => 0,
2234	data => WF_AUTOCANCEL,	2889	data => WF_AUTOCANCEL,
2235	signal => $signal,	2890	signal => $signal,
		2891	prio => 0,
2236	cb => sub {	2892	cb => sub {
2237	cf::cleanup "SIG$signal";	2893	cf::cleanup "SIG$signal";
2238	},	2894	},
2239	);	2895	);
2240	}	2896	}
		2897	}
		2898
		2899	sub write_runtime {
		2900	my $runtime = "$LOCALDIR/runtime";
		2901
		2902	# first touch the runtime file to show we are still running:
		2903	# the fsync below can take a very very long time.
		2904
		2905	IO::AIO::aio_utime $runtime, undef, undef;
		2906
		2907	my $guard = cf::lock_acquire "write_runtime";
		2908
		2909	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2910	or return;
		2911
		2912	my $value = $cf::RUNTIME + 90 + 10;
		2913	# 10 is the runtime save interval, for a monotonic clock
		2914	# 60 allows for the watchdog to kill the server.
		2915
		2916	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2917	and return;
		2918
		2919	# always fsync - this file is important
		2920	aio_fsync $fh
		2921	and return;
		2922
		2923	# touch it again to show we are up-to-date
		2924	aio_utime $fh, undef, undef;
		2925
		2926	close $fh
		2927	or return;
		2928
		2929	aio_rename "$runtime~", $runtime
		2930	and return;
		2931
		2932	warn "runtime file written.\n";
		2933
		2934	1
2241	}	2935	}
2242		2936
2243	sub emergency_save() {	2937	sub emergency_save() {
2244	my $freeze_guard = cf::freeze_mainloop;	2938	my $freeze_guard = cf::freeze_mainloop;
2245		2939
…		…
2262	my $map = $cf::MAP{$path} or next;	2956	my $map = $cf::MAP{$path} or next;
2263	$map->valid or next;	2957	$map->valid or next;
2264	$map->save;	2958	$map->save;
2265	}	2959	}
2266	warn "end emergency map save\n";	2960	warn "end emergency map save\n";
		2961
		2962	warn "begin emergency database checkpoint\n";
		2963	BDB::db_env_txn_checkpoint $DB_ENV;
		2964	warn "end emergency database checkpoint\n";
2267	};	2965	};
2268		2966
2269	warn "leave emergency perl save\n";	2967	warn "leave emergency perl save\n";
2270	}	2968	}
2271		2969
		2970	sub post_cleanup {
		2971	my ($make_core) = @_;
		2972
		2973	warn Carp::longmess "post_cleanup backtrace"
		2974	if $make_core;
		2975	}
		2976
2272	sub reload() {	2977	sub do_reload_perl() {
2273	# can/must only be called in main	2978	# can/must only be called in main
2274	if ($Coro::current != $Coro::main) {	2979	if ($Coro::current != $Coro::main) {
2275	warn "can only reload from main coroutine\n";	2980	warn "can only reload from main coroutine";
2276	return;	2981	return;
2277	}	2982	}
2278		2983
2279	warn "reloading...";	2984	warn "reloading...";
2280		2985
2281	warn "freezing server";	2986	warn "entering sync_job";
2282	my $guard = freeze_mainloop;	2987
		2988	cf::sync_job {
		2989	cf::write_runtime; # external watchdog should not bark
2283	cf::emergency_save;	2990	cf::emergency_save;
		2991	cf::write_runtime; # external watchdog should not bark
2284		2992
2285	warn "sync database to disk";	2993	warn "syncing database to disk";
2286	cf::db_sync;	2994	BDB::db_env_txn_checkpoint $DB_ENV;
2287	IO::AIO::flush;
2288		2995
2289	eval {
2290	# if anything goes wrong in here, we should simply crash as we already saved	2996	# if anything goes wrong in here, we should simply crash as we already saved
2291		2997
2292	warn "cancel all watchers";	2998	warn "cancelling all WF_AUTOCANCEL watchers";
2293	for (Event::all_watchers) {	2999	for (Event::all_watchers) {
2294	$_->cancel if $_->data & WF_AUTOCANCEL;	3000	$_->cancel if $_->data & WF_AUTOCANCEL;
2295	}	3001	}
2296		3002
		3003	warn "flushing outstanding aio requests";
		3004	for (;;) {
		3005	BDB::flush;
		3006	IO::AIO::flush;
		3007	Coro::cede;
		3008	last unless IO::AIO::nreqs || BDB::nreqs;
		3009	warn "iterate...";
		3010	}
		3011
		3012	++$RELOAD;
		3013
2297	warn "cancel all extension coros";	3014	warn "cancelling all extension coros";
2298	$_->cancel for values %EXT_CORO;	3015	$_->cancel for values %EXT_CORO;
2299	%EXT_CORO = ();	3016	%EXT_CORO = ();
2300		3017
2301	warn "remove commands";	3018	warn "removing commands";
2302	%COMMAND = ();	3019	%COMMAND = ();
2303		3020
2304	warn "remove ext commands";	3021	warn "removing ext/exti commands";
2305	%EXTCMD = ();	3022	%EXTCMD = ();
		3023	%EXTICMD = ();
2306		3024
2307	warn "unload/nuke all extensions";	3025	warn "unloading/nuking all extensions";
2308	for my $pkg (@EXTS) {	3026	for my $pkg (@EXTS) {
2309	warn "... unloading $pkg";	3027	warn "... unloading $pkg";
2310		3028
2311	if (my $cb = $pkg->can ("unload")) {	3029	if (my $cb = $pkg->can ("unload")) {
2312	eval {	3030	eval {
…		…
2317		3035
2318	warn "... nuking $pkg";	3036	warn "... nuking $pkg";
2319	Symbol::delete_package $pkg;	3037	Symbol::delete_package $pkg;
2320	}	3038	}
2321		3039
2322	warn "unload all perl modules loaded from $LIBDIR";	3040	warn "unloading all perl modules loaded from $LIBDIR";
2323	while (my ($k, $v) = each %INC) {	3041	while (my ($k, $v) = each %INC) {
2324	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3042	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2325		3043
2326	warn "removing <$k>";	3044	warn "... unloading $k";
2327	delete $INC{$k};	3045	delete $INC{$k};
2328		3046
2329	$k =~ s/\.pm$//;	3047	$k =~ s/\.pm$//;
2330	$k =~ s/\//::/g;	3048	$k =~ s/\//::/g;
2331		3049
…		…
2334	}	3052	}
2335		3053
2336	Symbol::delete_package $k;	3054	Symbol::delete_package $k;
2337	}	3055	}
2338		3056
2339	warn "get rid of safe::, as good as possible";	3057	warn "getting rid of safe::, as good as possible";
2340	Symbol::delete_package "safe::$_"	3058	Symbol::delete_package "safe::$_"
2341	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3059	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2342		3060
2343	warn "unload cf.pm \"a bit\"";	3061	warn "unloading cf.pm \"a bit\"";
2344	delete $INC{"cf.pm"};	3062	delete $INC{"cf.pm"};
		3063	delete $INC{"cf/pod.pm"};
2345		3064
2346	# don't, removes xs symbols, too,	3065	# don't, removes xs symbols, too,
2347	# and global variables created in xs	3066	# and global variables created in xs
2348	#Symbol::delete_package __PACKAGE__;	3067	#Symbol::delete_package __PACKAGE__;
2349		3068
		3069	warn "unload completed, starting to reload now";
		3070
2350	warn "reloading cf.pm";	3071	warn "reloading cf.pm";
2351	require cf;	3072	require cf;
2352	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3073	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2353		3074
2354	warn "load config and database again";	3075	warn "loading config and database again";
2355	cf::cfg_load;	3076	cf::cfg_load;
2356	cf::db_load;
2357		3077
2358	warn "load extensions";	3078	warn "loading extensions";
2359	cf::load_extensions;	3079	cf::load_extensions;
2360		3080
2361	warn "reattach attachments to objects/players";	3081	warn "reattaching attachments to objects/players";
2362	_global_reattach;	3082	_global_reattach; # objects, sockets
2363	warn "reattach attachments to maps";	3083	warn "reattaching attachments to maps";
2364	reattach $_ for values %MAP;	3084	reattach $_ for values %MAP;
2365	};	3085	warn "reattaching attachments to players";
		3086	reattach $_ for values %PLAYER;
2366		3087
2367	if ($@) {	3088	warn "leaving sync_job";
		3089
		3090	1
		3091	} or do {
2368	warn $@;	3092	warn $@;
2369	warn "error while reloading, exiting.";	3093	warn "error while reloading, exiting.";
2370	exit 1;	3094	exit 1;
2371	}	3095	};
2372		3096
2373	warn "reloaded";	3097	warn "reloaded";
2374	};	3098	};
2375		3099
		3100	our $RELOAD_WATCHER; # used only during reload
		3101
		3102	sub reload_perl() {
		3103	# doing reload synchronously and two reloads happen back-to-back,
		3104	# coro crashes during coro_state_free->destroy here.
		3105
		3106	$RELOAD_WATCHER ||= Event->timer (
		3107	reentrant => 0,
		3108	after => 0,
		3109	data => WF_AUTOCANCEL,
		3110	cb => sub {
		3111	do_reload_perl;
		3112	undef $RELOAD_WATCHER;
		3113	},
		3114	);
		3115	}
		3116
2376	register_command "reload" => sub {	3117	register_command "reload" => sub {
2377	my ($who, $arg) = @_;	3118	my ($who, $arg) = @_;
2378		3119
2379	if ($who->flag (FLAG_WIZ)) {	3120	if ($who->flag (FLAG_WIZ)) {
2380	$who->message ("start of reload.");
2381	reload;
2382	$who->message ("end of reload.");	3121	$who->message ("reloading server.");
		3122	async { reload_perl };
2383	}	3123	}
2384	};	3124	};
2385		3125
2386	unshift @INC, $LIBDIR;	3126	unshift @INC, $LIBDIR;
2387		3127
		3128	my $bug_warning = 0;
		3129
		3130	our @WAIT_FOR_TICK;
		3131	our @WAIT_FOR_TICK_BEGIN;
		3132
		3133	sub wait_for_tick {
		3134	return unless $TICK_WATCHER->is_active;
		3135	return if $Coro::current == $Coro::main;
		3136
		3137	my $signal = new Coro::Signal;
		3138	push @WAIT_FOR_TICK, $signal;
		3139	$signal->wait;
		3140	}
		3141
		3142	sub wait_for_tick_begin {
		3143	return unless $TICK_WATCHER->is_active;
		3144	return if $Coro::current == $Coro::main;
		3145
		3146	my $signal = new Coro::Signal;
		3147	push @WAIT_FOR_TICK_BEGIN, $signal;
		3148	$signal->wait;
		3149	}
		3150
		3151	my $min = 1e6;#d#
		3152	my $avg = 10;
2388	$TICK_WATCHER = Event->timer (	3153	$TICK_WATCHER = Event->timer (
2389	reentrant => 0,	3154	reentrant => 0,
		3155	parked => 1,
2390	prio => 0,	3156	prio => 0,
2391	at => $NEXT_TICK || $TICK,	3157	at => $NEXT_TICK || $TICK,
2392	data => WF_AUTOCANCEL,	3158	data => WF_AUTOCANCEL,
2393	cb => sub {	3159	cb => sub {
		3160	if ($Coro::current != $Coro::main) {
		3161	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3162	unless ++$bug_warning > 10;
		3163	return;
		3164	}
		3165
2394	$NOW = Event::time;	3166	$NOW = $tick_start = Event::time;
2395		3167
2396	cf::server_tick; # one server iteration	3168	cf::server_tick; # one server iteration
		3169
		3170	0 && sync_job {#d#
		3171	for(1..10) {
		3172	my $t = Event::time;
		3173	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3174	or die;
		3175
		3176	$map->width (50);
		3177	$map->height (50);
		3178	$map->alloc;
		3179	$map->_load_objects ("/tmp/x.map", 1);
		3180	my $t = Event::time - $t;
		3181
		3182	#next unless $t < 0.0013;#d#
		3183	if ($t < $min) {
		3184	$min = $t;
		3185	}
		3186	$avg = $avg * 0.99 + $t * 0.01;
		3187	}
		3188	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3189	exit 0;
		3190	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3191	};
		3192
2397	$RUNTIME += $TICK;	3193	$RUNTIME += $TICK;
2398	$NEXT_TICK += $TICK;	3194	$NEXT_TICK += $TICK;
2399		3195
2400	$WAIT_FOR_TICK->broadcast;	3196	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2401	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3197	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3198	Coro::async_pool {
		3199	write_runtime
		3200	or warn "ERROR: unable to write runtime file: $!";
		3201	};
		3202	}
		3203
		3204	# my $AFTER = Event::time;
		3205	# warn $AFTER - $NOW;#d#
		3206
		3207	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3208	$sig->send;
		3209	}
		3210	while (my $sig = shift @WAIT_FOR_TICK) {
		3211	$sig->send;
		3212	}
		3213
		3214	$NOW = Event::time;
2402		3215
2403	# if we are delayed by four ticks or more, skip them all	3216	# if we are delayed by four ticks or more, skip them all
2404	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3217	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2405		3218
2406	$TICK_WATCHER->at ($NEXT_TICK);	3219	$TICK_WATCHER->at ($NEXT_TICK);
2407	$TICK_WATCHER->start;	3220	$TICK_WATCHER->start;
		3221
		3222	$LOAD = ($NOW - $tick_start) / $TICK;
		3223	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3224
		3225	_post_tick;
		3226
		3227
2408	},	3228	},
2409	);	3229	);
2410		3230
		3231	{
		3232	BDB::max_poll_time $TICK * 0.1;
		3233	$BDB_POLL_WATCHER = Event->io (
		3234	reentrant => 0,
		3235	fd => BDB::poll_fileno,
		3236	poll => 'r',
		3237	prio => 0,
		3238	data => WF_AUTOCANCEL,
		3239	cb => \&BDB::poll_cb,
		3240	);
		3241	BDB::min_parallel 8;
		3242
		3243	BDB::set_sync_prepare {
		3244	my $status;
		3245	my $current = $Coro::current;
		3246	(
		3247	sub {
		3248	$status = $!;
		3249	$current->ready; undef $current;
		3250	},
		3251	sub {
		3252	Coro::schedule while defined $current;
		3253	$! = $status;
		3254	},
		3255	)
		3256	};
		3257
		3258	unless ($DB_ENV) {
		3259	$DB_ENV = BDB::db_env_create;
		3260
		3261	cf::sync_job {
		3262	eval {
		3263	BDB::db_env_open
		3264	$DB_ENV,
		3265	$BDBDIR,
		3266	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3267	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3268	0666;
		3269
		3270	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3271
		3272	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3273	$DB_ENV->set_lk_detect;
		3274	};
		3275
		3276	cf::cleanup "db_env_open(db): $@" if $@;
		3277	};
		3278	}
		3279	}
		3280
		3281	{
		3282	IO::AIO::min_parallel 8;
		3283
		3284	undef $Coro::AIO::WATCHER;
2411	IO::AIO::max_poll_time $TICK * 0.2;	3285	IO::AIO::max_poll_time $TICK * 0.1;
2412
2413	$AIO_POLL_WATCHER = Event->io (	3286	$AIO_POLL_WATCHER = Event->io (
2414	fd => IO::AIO::poll_fileno,	3287	reentrant => 0,
2415	poll => 'r',
2416	prio => 5,
2417	data => WF_AUTOCANCEL,
2418	cb => \&IO::AIO::poll_cb,
2419	);
2420
2421	$WRITE_RUNTIME_WATCHER = Event->timer (
2422	data => WF_AUTOCANCEL,	3288	data => WF_AUTOCANCEL,
2423	after => 0,	3289	fd => IO::AIO::poll_fileno,
2424	interval => 10,	3290	poll => 'r',
2425	cb => sub {	3291	prio => 6,
2426	(Coro::unblock_sub {	3292	cb => \&IO::AIO::poll_cb,
2427	write_runtime	3293	);
2428	or warn "ERROR: unable to write runtime file: $!";	3294	}
		3295
		3296	my $_log_backtrace;
		3297
		3298	sub _log_backtrace {
		3299	my ($msg, @addr) = @_;
		3300
		3301	$msg =~ s/\n//;
		3302
		3303	# limit the # of concurrent backtraces
		3304	if ($_log_backtrace < 2) {
		3305	++$_log_backtrace;
		3306	async {
		3307	my @bt = fork_call {
		3308	@addr = map { sprintf "%x", $_ } @addr;
		3309	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3310	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3311	or die "addr2line: $!";
		3312
		3313	my @funcs;
		3314	my @res = <$fh>;
		3315	chomp for @res;
		3316	while (@res) {
		3317	my ($func, $line) = splice @res, 0, 2, ();
		3318	push @funcs, "[$func] $line";
		3319	}
		3320
		3321	@funcs
		3322	};
		3323
		3324	LOG llevInfo, "[ABT] $msg\n";
		3325	LOG llevInfo, "[ABT] $_\n" for @bt;
		3326	--$_log_backtrace;
2429	})->();	3327	};
		3328	} else {
		3329	LOG llevInfo, "[ABT] $msg\n";
		3330	LOG llevInfo, "[ABT] [suppressed]\n";
2430	},	3331	}
2431	);	3332	}
		3333
		3334	# load additional modules
		3335	use cf::pod;
2432		3336
2433	END { cf::emergency_save }	3337	END { cf::emergency_save }
2434		3338
2435	1	3339	1
2436		3340

Diff Legend

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