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.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.298 by root, Sun Jul 8 14:50:07 2007 UTC

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

Diff Legend

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