ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.296 by root, Wed Jul 4 07:09:06 2007 UTC

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

Diff Legend

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