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

Diff Legend

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