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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.440 by root, Mon Aug 11 23:23:41 2008 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
2		23
3	use utf8;	24	use utf8;
4	use strict;	25	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
12		35
13	use Coro 3.3 ();	36	use Coro ();
		37	use Coro::State;
		38	use Coro::Handle;
14	use Coro::Event;	39	use Coro::AnyEvent;
15	use Coro::Timer;	40	use Coro::Timer;
16	use Coro::Signal;	41	use Coro::Signal;
17	use Coro::Semaphore;	42	use Coro::Semaphore;
		43	use Coro::AnyEvent;
18	use Coro::AIO;	44	use Coro::AIO;
		45	use Coro::BDB 1.6;
		46	use Coro::Storable;
		47	use Coro::Util ();
19		48
		49	use JSON::XS 2.01 ();
		50	use BDB ();
		51	use Data::Dumper;
20	use Digest::MD5;	52	use Digest::MD5;
21	use Fcntl;	53	use Fcntl;
		54	use YAML ();
22	use IO::AIO 2.31 ();	55	use IO::AIO ();
23	use YAML::Syck ();
24	use Time::HiRes;	56	use Time::HiRes;
		57	use Compress::LZF;
		58	use Digest::MD5 ();
25		59
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	60	AnyEvent::detect;
27		61
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	62	# configure various modules to our taste
29	$YAML::Syck::ImplicitUnicode = 1;	63	#
		64	$Storable::canonical = 1; # reduce rsync transfers
		65	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		66	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		67
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	68	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		69
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	70	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		71
35	our %COMMAND = ();	72	our %COMMAND = ();
36	our %COMMAND_TIME = ();	73	our %COMMAND_TIME = ();
		74
		75	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	76	our %EXTCMD = ();
		77	our %EXTICMD = ();
		78	our %EXT_CORO = (); # coroutines bound to extensions
		79	our %EXT_MAP = (); # pluggable maps
38		80
		81	our $RELOAD; # number of reloads so far
39	our @EVENT;	82	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		83
42	our $TICK = MAX_TIME * 1e-6;	84	our $CONFDIR = confdir;
43	our $TICK_WATCHER;	85	our $DATADIR = datadir;
		86	our $LIBDIR = "$DATADIR/ext";
		87	our $PODDIR = "$DATADIR/pod";
		88	our $MAPDIR = "$DATADIR/" . mapdir;
		89	our $LOCALDIR = localdir;
		90	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		91	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		92	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		93	our $RANDOMDIR = "$LOCALDIR/random";
		94	our $BDBDIR = "$LOCALDIR/db";
		95	our %RESOURCE;
		96
		97	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		98	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	99	our $NEXT_TICK;
45	our $NOW;	100	our $USE_FSYNC = 1; # use fsync to write maps - default off
		101
		102	our $BDB_DEADLOCK_WATCHER;
		103	our $BDB_CHECKPOINT_WATCHER;
		104	our $BDB_TRICKLE_WATCHER;
		105	our $DB_ENV;
46		106
47	our %CFG;	107	our %CFG;
48		108
49	our $UPTIME; $UPTIME ||= time;	109	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	110	our $RUNTIME;
		111	our $NOW;
51		112
52	our %MAP; # all maps	113	our (%PLAYER, %PLAYER_LOADING); # all users
53	our $LINK_MAP; # the special {link} map	114	our (%MAP, %MAP_LOADING ); # all maps
54	our $RANDOM_MAPS = cf::localdir . "/random";	115	our $LINK_MAP; # the special {link} map, which is always available
55	our %EXT_CORO;	116
		117	# used to convert map paths into valid unix filenames by replacing / by ∕
		118	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		119
		120	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		121	our $LOADAVG; # same thing, but with alpha-smoothing
		122	our $JITTER; # average jitter
		123	our $TICK_START; # for load detecting purposes
56		124
57	binmode STDOUT;	125	binmode STDOUT;
58	binmode STDERR;	126	binmode STDERR;
59		127
60	# read virtual server time, if available	128	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	129	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62	open my $fh, "<", cf::localdir . "/runtime"	130	open my $fh, "<", "$LOCALDIR/runtime"
63	or die "unable to read runtime file: $!";	131	or die "unable to read runtime file: $!";
64	$RUNTIME = <$fh> + 0.;	132	$RUNTIME = <$fh> + 0.;
65	}	133	}
66		134
67	mkdir cf::localdir;	135	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	136	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		137
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	138	our $EMERGENCY_POSITION;
		139
		140	sub cf::map::normalise;
76		141
77	#############################################################################	142	#############################################################################
78		143
79	=head2 GLOBAL VARIABLES	144	=head2 GLOBAL VARIABLES
80		145
…		…
87	=item $cf::RUNTIME	152	=item $cf::RUNTIME
88		153
89	The time this server has run, starts at 0 and is increased by $cf::TICK on	154	The time this server has run, starts at 0 and is increased by $cf::TICK on
90	every server tick.	155	every server tick.
91		156
92	=item $cf::LIBDIR	157	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		158	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		159	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
93		160
94	The perl library directory, where extensions and cf-specific modules can	161	Various directories - "/etc", read-only install directory, perl-library
95	be found. It will be added to C<@INC> automatically.	162	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		163	unique-items directory, player file directory, random maps directory and
		164	database environment.
96		165
97	=item $cf::NOW	166	=item $cf::NOW
98		167
99	The time of the last (current) server tick.	168	The time of the last (current) server tick.
100		169
101	=item $cf::TICK	170	=item $cf::TICK
102		171
103	The interval between server ticks, in seconds.	172	The interval between server ticks, in seconds.
104		173
		174	=item $cf::LOADAVG
		175
		176	The current CPU load on the server (alpha-smoothed), as a value between 0
		177	(none) and 1 (overloaded), indicating how much time is spent on processing
		178	objects per tick. Healthy values are < 0.5.
		179
		180	=item $cf::LOAD
		181
		182	The raw value load value from the last tick.
		183
105	=item %cf::CFG	184	=item %cf::CFG
106		185
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	186	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	from wherever your confdir points to.	187	from wherever your confdir points to.
		188
		189	=item cf::wait_for_tick, cf::wait_for_tick_begin
		190
		191	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		192	returns directly I<after> the tick processing (and consequently, can only wake one process
		193	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		194
		195	=item @cf::INVOKE_RESULTS
		196
		197	This array contains the results of the last C<invoke ()> call. When
		198	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		199	that call.
109		200
110	=back	201	=back
111		202
112	=cut	203	=cut
113		204
114	BEGIN {	205	BEGIN {
115	*CORE::GLOBAL::warn = sub {	206	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	207	my $msg = join "", @_;
117	utf8::encode $msg;
118		208
119	$msg .= "\n"	209	$msg .= "\n"
120	unless $msg =~ /\n$/;	210	unless $msg =~ /\n$/;
121		211
		212	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		213
122	LOG llevError, "cfperl: $msg";	214	LOG llevError, $msg;
123	};	215	};
124	}	216	}
		217
		218	$Coro::State::DIEHOOK = sub {
		219	return unless $^S eq 0; # "eq", not "=="
		220
		221	if ($Coro::current == $Coro::main) {#d#
		222	warn "DIEHOOK called in main context, Coro bug?\n";#d#
		223	return;#d#
		224	}#d#
		225
		226	# kill coroutine otherwise
		227	warn Carp::longmess $_[0];
		228	Coro::terminate
		229	};
		230
		231	$SIG{__DIE__} = sub { }; #d#?
125		232
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	233	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	234	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	235	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	236	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	237	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		238	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	239	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
132		240
133	# we bless all objects into (empty) derived classes to force a method lookup	241	# we bless all objects into (empty) derived classes to force a method lookup
134	# within the Safe compartment.	242	# within the Safe compartment.
135	for my $pkg (qw(	243	for my $pkg (qw(
136	cf::global cf::attachable	244	cf::global cf::attachable
137	cf::object cf::object::player	245	cf::object cf::object::player
138	cf::client cf::player	246	cf::client cf::player
139	cf::arch cf::living	247	cf::arch cf::living
		248	cf::map cf::mapspace
140	cf::map cf::party cf::region	249	cf::party cf::region
141	)) {	250	)) {
142	no strict 'refs';	251	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	252	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	253	}
145		254
146	$Event::DIED = sub {	255	$EV::DIED = sub {
147	warn "error in event callback: @_";	256	warn "error in event callback: @_";
148	};	257	};
149		258
150	my %ext_pkg;	259	#############################################################################
151	my @exts;
152	my @hook;
153		260
154	=head2 UTILITY FUNCTIONS	261	=head2 UTILITY FUNCTIONS
155		262
156	=over 4	263	=over 4
157		264
158	=cut	265	=item dumpval $ref
159		266
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	267	=cut
161		268
		269	sub dumpval {
		270	eval {
		271	local $SIG{__DIE__};
		272	my $d;
		273	if (1) {
		274	$d = new Data::Dumper([$_[0]], ["*var"]);
		275	$d->Terse(1);
		276	$d->Indent(2);
		277	$d->Quotekeys(0);
		278	$d->Useqq(1);
		279	#$d->Bless(...);
		280	$d->Seen($_[1]) if @_ > 1;
		281	$d = $d->Dump();
		282	}
		283	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		284	$d
		285	} || "[unable to dump $_[0]: '$@']";
		286	}
		287
162	=item $ref = cf::from_json $json	288	=item $ref = cf::decode_json $json
163		289
164	Converts a JSON string into the corresponding perl data structure.	290	Converts a JSON string into the corresponding perl data structure.
165		291
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	292	=item $json = cf::encode_json $ref
174		293
175	Converts a perl data structure into its JSON representation.	294	Converts a perl data structure into its JSON representation.
176		295
177	=cut	296	=cut
178		297
179	sub to_json($) {	298	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	299
181	JSON::Syck::Dump $_[0]	300	sub encode_json($) { $json_coder->encode ($_[0]) }
182	}	301	sub decode_json($) { $json_coder->decode ($_[0]) }
183		302
184	=item cf::lock_wait $string	303	=item cf::lock_wait $string
185		304
186	Wait until the given lock is available. See cf::lock_acquire.	305	Wait until the given lock is available. See cf::lock_acquire.
187		306
…		…
190	Wait until the given lock is available and then acquires it and returns	309	Wait until the given lock is available and then acquires it and returns
191	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	310	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
192	for example when the coroutine gets canceled), the lock is automatically	311	for example when the coroutine gets canceled), the lock is automatically
193	returned.	312	returned.
194		313
		314	Locks are *not* recursive, locking from the same coro twice results in a
		315	deadlocked coro.
		316
195	Lock names should begin with a unique identifier (for example, cf::map::find	317	Lock names should begin with a unique identifier (for example, cf::map::find
196	uses map_find and cf::map::load uses map_load).	318	uses map_find and cf::map::load uses map_load).
197		319
		320	=item $locked = cf::lock_active $string
		321
		322	Return true if the lock is currently active, i.e. somebody has locked it.
		323
198	=cut	324	=cut
199		325
200	our %LOCK;	326	our %LOCK;
		327	our %LOCKER;#d#
201		328
202	sub lock_wait($) {	329	sub lock_wait($) {
203	my ($key) = @_;	330	my ($key) = @_;
		331
		332	if ($LOCKER{$key} == $Coro::current) {#d#
		333	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		334	return;#d#
		335	}#d#
204		336
205	# wait for lock, if any	337	# wait for lock, if any
206	while ($LOCK{$key}) {	338	while ($LOCK{$key}) {
207	push @{ $LOCK{$key} }, $Coro::current;	339	push @{ $LOCK{$key} }, $Coro::current;
208	Coro::schedule;	340	Coro::schedule;
…		…
214		346
215	# wait, to be sure we are not locked	347	# wait, to be sure we are not locked
216	lock_wait $key;	348	lock_wait $key;
217		349
218	$LOCK{$key} = [];	350	$LOCK{$key} = [];
		351	$LOCKER{$key} = $Coro::current;#d#
219		352
220	Coro::guard {	353	Coro::guard {
		354	delete $LOCKER{$key};#d#
221	# wake up all waiters, to be on the safe side	355	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };	356	$_->ready for @{ delete $LOCK{$key} };
223	}	357	}
224	}	358	}
225		359
		360	sub lock_active($) {
		361	my ($key) = @_;
		362
		363	! ! $LOCK{$key}
		364	}
		365
		366	sub freeze_mainloop {
		367	tick_inhibit_inc;
		368
		369	Coro::guard \&tick_inhibit_dec;
		370	}
		371
		372	=item cf::periodic $interval, $cb
		373
		374	Like EV::periodic, but randomly selects a starting point so that the actions
		375	get spread over timer.
		376
		377	=cut
		378
		379	sub periodic($$) {
		380	my ($interval, $cb) = @_;
		381
		382	my $start = rand List::Util::min 180, $interval;
		383
		384	EV::periodic $start, $interval, 0, $cb
		385	}
		386
		387	=item cf::get_slot $time[, $priority[, $name]]
		388
		389	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		390	This call blocks and returns only when you have at least C<$time> seconds
		391	of cpu time till the next tick. The slot is only valid till the next cede.
		392
		393	The optional C<$name> can be used to identify the job to run. It might be
		394	used for statistical purposes and should identify the same time-class.
		395
		396	Useful for short background jobs.
		397
		398	=cut
		399
		400	our @SLOT_QUEUE;
		401	our $SLOT_QUEUE;
		402
		403	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		404	$SLOT_QUEUE = Coro::async {
		405	$Coro::current->desc ("timeslot manager");
		406
		407	my $signal = new Coro::Signal;
		408
		409	while () {
		410	next_job:
		411	my $avail = cf::till_tick;
		412	if ($avail > 0.01) {
		413	for (0 .. $#SLOT_QUEUE) {
		414	if ($SLOT_QUEUE[$_][0] < $avail) {
		415	my $job = splice @SLOT_QUEUE, $_, 1, ();
		416	$job->[2]->send;
		417	Coro::cede;
		418	goto next_job;
		419	}
		420	}
		421	}
		422
		423	if (@SLOT_QUEUE) {
		424	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		425	push @cf::WAIT_FOR_TICK, $signal;
		426	$signal->wait;
		427	} else {
		428	Coro::schedule;
		429	}
		430	}
		431	};
		432
		433	sub get_slot($;$$) {
		434	return if tick_inhibit || $Coro::current == $Coro::main;
		435
		436	my ($time, $pri, $name) = @_;
		437
		438	$time = $TICK * .6 if $time > $TICK * .6;
		439	my $sig = new Coro::Signal;
		440
		441	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		442	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		443	$SLOT_QUEUE->ready;
		444	$sig->wait;
		445	}
		446
226	=item cf::async { BLOCK }	447	=item cf::async { BLOCK }
227		448
228	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the	449	Currently the same as Coro::async_pool, meaning you cannot use
229	error instead of exiting the server in case of a problem.	450	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		451	thing you are allowed to do is call C<prio> on it.
230		452
231	=cut	453	=cut
232		454
233	sub async(&) {	455	BEGIN { *async = \&Coro::async_pool }
234	my ($cb) = @_;
235
236	Coro::async {
237	eval { $cb->() };
238	warn $@ if $@;
239	}
240	}
241
242	sub freeze_mainloop {
243	return unless $TICK_WATCHER->is_active;
244
245	my $guard = Coro::guard { $TICK_WATCHER->start };
246	$TICK_WATCHER->stop;
247	$guard
248	}
249		456
250	=item cf::sync_job { BLOCK }	457	=item cf::sync_job { BLOCK }
251		458
252	The design of crossfire+ requires that the main coro ($Coro::main) is	459	The design of Deliantra requires that the main coroutine ($Coro::main)
253	always able to handle events or runnable, as crossfire+ is only partly	460	is always able to handle events or runnable, as Deliantra is only
254	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	461	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		462	acceptable.
255		463
256	If it must be done, put the blocking parts into C<sync_job>. This will run	464	If it must be done, put the blocking parts into C<sync_job>. This will run
257	the given BLOCK in another coroutine while waiting for the result. The	465	the given BLOCK in another coroutine while waiting for the result. The
258	server will be frozen during this time, so the block should either finish	466	server will be frozen during this time, so the block should either finish
259	fast or be very important.	467	fast or be very important.
…		…
262		470
263	sub sync_job(&) {	471	sub sync_job(&) {
264	my ($job) = @_;	472	my ($job) = @_;
265		473
266	if ($Coro::current == $Coro::main) {	474	if ($Coro::current == $Coro::main) {
		475	my $time = EV::time;
		476
267	# this is the main coro, too bad, we have to block	477	# this is the main coro, too bad, we have to block
268	# till the operation succeeds, freezing the server :/	478	# till the operation succeeds, freezing the server :/
269		479
270	# TODO: use suspend/resume instead	480	LOG llevError, Carp::longmess "sync job";#d#
271	# (but this is cancel-safe)	481
272	my $freeze_guard = freeze_mainloop;	482	my $freeze_guard = freeze_mainloop;
273		483
274	my $busy = 1;	484	my $busy = 1;
275	my @res;	485	my @res;
276		486
277	(Coro::async {	487	(async {
		488	$Coro::current->desc ("sync job coro");
278	@res = eval { $job->() };	489	@res = eval { $job->() };
279	warn $@ if $@;	490	warn $@ if $@;
280	undef $busy;	491	undef $busy;
281	})->prio (Coro::PRIO_MAX);	492	})->prio (Coro::PRIO_MAX);
282		493
283	while ($busy) {	494	while ($busy) {
		495	if (Coro::nready) {
284	Coro::cede_notself;	496	Coro::cede_notself;
285	Event::one_event unless Coro::nready;	497	} else {
		498	EV::loop EV::LOOP_ONESHOT;
286	}	499	}
		500	}
		501
		502	my $time = EV::time - $time;
		503
		504	$TICK_START += $time; # do not account sync jobs to server load
287		505
288	wantarray ? @res : $res[0]	506	wantarray ? @res : $res[0]
289	} else {	507	} else {
290	# we are in another coroutine, how wonderful, everything just works	508	# we are in another coroutine, how wonderful, everything just works
291		509
292	$job->()	510	$job->()
293	}	511	}
294	}	512	}
295		513
296	=item $coro = cf::coro { BLOCK }	514	=item $coro = cf::async_ext { BLOCK }
297		515
298	Creates and returns a new coro. This coro is automcatially being canceled	516	Like async, but this coro is automatically being canceled when the
299	when the extension calling this is being unloaded.	517	extension calling this is being unloaded.
300		518
301	=cut	519	=cut
302		520
303	sub coro(&) {	521	sub async_ext(&) {
304	my $cb = shift;	522	my $cb = shift;
305		523
306	my $coro = &cf::async ($cb);	524	my $coro = &Coro::async ($cb);
307		525
308	$coro->on_destroy (sub {	526	$coro->on_destroy (sub {
309	delete $EXT_CORO{$coro+0};	527	delete $EXT_CORO{$coro+0};
310	});	528	});
311	$EXT_CORO{$coro+0} = $coro;	529	$EXT_CORO{$coro+0} = $coro;
312		530
313	$coro	531	$coro
314	}	532	}
315		533
316	sub write_runtime {	534	=item fork_call { }, $args
317	my $runtime = cf::localdir . "/runtime";
318		535
319	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	536	Executes the given code block with the given arguments in a seperate
320	or return;	537	process, returning the results. Everything must be serialisable with
		538	Coro::Storable. May, of course, block. Note that the executed sub may
		539	never block itself or use any form of event handling.
321		540
322	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	541	=cut
323	(aio_write $fh, 0, (length $value), $value, 0) <= 0
324	and return;
325		542
326	aio_fsync $fh	543	sub fork_call(&@) {
327	and return;	544	my ($cb, @args) = @_;
328		545
329	close $fh	546	# we seemingly have to make a local copy of the whole thing,
330	or return;	547	# otherwise perl prematurely frees the stuff :/
		548	# TODO: investigate and fix (likely this will be rather laborious)
331		549
332	aio_rename "$runtime~", $runtime	550	my @res = Coro::Util::fork_eval {
333	and return;	551	reset_signals;
		552	&$cb
		553	}, @args;
334		554
		555	wantarray ? @res : $res[-1]
		556	}
		557
		558	=item $coin = coin_from_name $name
		559
		560	=cut
		561
		562	our %coin_alias = (
		563	"silver" => "silvercoin",
		564	"silvercoin" => "silvercoin",
		565	"silvercoins" => "silvercoin",
		566	"gold" => "goldcoin",
		567	"goldcoin" => "goldcoin",
		568	"goldcoins" => "goldcoin",
		569	"platinum" => "platinacoin",
		570	"platinumcoin" => "platinacoin",
		571	"platinumcoins" => "platinacoin",
		572	"platina" => "platinacoin",
		573	"platinacoin" => "platinacoin",
		574	"platinacoins" => "platinacoin",
		575	"royalty" => "royalty",
		576	"royalties" => "royalty",
		577	);
		578
		579	sub coin_from_name($) {
		580	$coin_alias{$_[0]}
		581	? cf::arch::find $coin_alias{$_[0]}
		582	: undef
		583	}
		584
		585	=item $value = cf::db_get $family => $key
		586
		587	Returns a single value from the environment database.
		588
		589	=item cf::db_put $family => $key => $value
		590
		591	Stores the given C<$value> in the family. It can currently store binary
		592	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		593
		594	=item $db = cf::db_table "name"
		595
		596	Create and/or open a new database table. The string must not be "db" and must be unique
		597	within each server.
		598
		599	=cut
		600
		601	sub db_table($) {
		602	my ($name) = @_;
		603	my $db = BDB::db_create $DB_ENV;
		604
		605	eval {
		606	$db->set_flags (BDB::CHKSUM);
		607
		608	utf8::encode $name;
		609	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		610	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		611	cf::cleanup "db_open(db): $!" if $!;
		612	};
		613	cf::cleanup "db_open(db): $@" if $@;
		614
		615	$db
		616	}
		617
		618	our $DB;
		619
		620	sub db_init {
		621	cf::sync_job {
		622	$DB ||= db_table "db";
		623	};
		624	}
		625
		626	sub db_get($$) {
		627	my $key = "$_[0]/$_[1]";
		628
		629	cf::sync_job {
		630	BDB::db_get $DB, undef, $key, my $data;
		631
		632	$! ? ()
		633	: $data
335	1	634	}
		635	}
		636
		637	sub db_put($$$) {
		638	BDB::dbreq_pri 4;
		639	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		640	}
		641
		642	=item cf::cache $id => [$paths...], $processversion => $process
		643
		644	Generic caching function that returns the value of the resource $id,
		645	caching and regenerating as required.
		646
		647	This function can block.
		648
		649	=cut
		650
		651	sub cache {
		652	my ($id, $src, $processversion, $process) = @_;
		653
		654	my $meta =
		655	join "\x00",
		656	$processversion,
		657	map {
		658	aio_stat $_
		659	and Carp::croak "$_: $!";
		660
		661	($_, (stat _)[7,9])
		662	} @$src;
		663
		664	my $dbmeta = db_get cache => "$id/meta";
		665	if ($dbmeta ne $meta) {
		666	# changed, we may need to process
		667
		668	my @data;
		669	my $md5;
		670
		671	for (0 .. $#$src) {
		672	0 <= aio_load $src->[$_], $data[$_]
		673	or Carp::croak "$src->[$_]: $!";
		674	}
		675
		676	# if processing is expensive, check
		677	# checksum first
		678	if (1) {
		679	$md5 =
		680	join "\x00",
		681	$processversion,
		682	map {
		683	cf::cede_to_tick;
		684	($src->[$_], Digest::MD5::md5_hex $data[$_])
		685	} 0.. $#$src;
		686
		687
		688	my $dbmd5 = db_get cache => "$id/md5";
		689	if ($dbmd5 eq $md5) {
		690	db_put cache => "$id/meta", $meta;
		691
		692	return db_get cache => "$id/data";
		693	}
		694	}
		695
		696	my $t1 = Time::HiRes::time;
		697	my $data = $process->(\@data);
		698	my $t2 = Time::HiRes::time;
		699
		700	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		701
		702	db_put cache => "$id/data", $data;
		703	db_put cache => "$id/md5" , $md5;
		704	db_put cache => "$id/meta", $meta;
		705
		706	return $data;
		707	}
		708
		709	db_get cache => "$id/data"
		710	}
		711
		712	=item cf::datalog type => key => value, ...
		713
		714	Log a datalog packet of the given type with the given key-value pairs.
		715
		716	=cut
		717
		718	sub datalog($@) {
		719	my ($type, %kv) = @_;
		720	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
336	}	721	}
337		722
338	=back	723	=back
339		724
340	=cut	725	=cut
341
342	#############################################################################
343
344	package cf::path;
345
346	sub new {
347	my ($class, $path, $base) = @_;
348
349	$path = $path->as_string if ref $path;
350
351	my $self = bless { }, $class;
352
353	# {... are special paths that are not touched
354	# ?xxx/... are special absolute paths
355	# ?random/... random maps
356	# /! non-realised random map exit
357	# /... normal maps
358	# ~/... per-player maps without a specific player (DO NOT USE)
359	# ~user/... per-player map of a specific user
360
361	if ($path =~ /^{/) {
362	# fine as it is
363	} elsif ($path =~ s{^\?random/}{}) {
364	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365	$self->{random} = cf::from_json $data;
366	} else {
367	if ($path =~ s{^~([^/]+)?}{}) {
368	$self->{user_rel} = 1;
369
370	if (defined $1) {
371	$self->{user} = $1;
372	} elsif ($base =~ m{^~([^/]+)/}) {
373	$self->{user} = $1;
374	} else {
375	warn "cannot resolve user-relative path without user <$path,$base>\n";
376	}
377	} elsif ($path =~ /^\//) {
378	# already absolute
379	} else {
380	$base =~ s{[^/]+/?$}{};
381	return $class->new ("$base/$path");
382	}
383
384	for ($path) {
385	redo if s{/\.?/}{/};
386	redo if s{/[^/]+/\.\./}{/};
387	}
388	}
389
390	$self->{path} = $path;
391
392	$self
393	}
394
395	# the name / primary key / in-game path
396	sub as_string {
397	my ($self) = @_;
398
399	$self->{user_rel} ? "~$self->{user}$self->{path}"
400	: $self->{random} ? "?random/$self->{path}"
401	: $self->{path}
402	}
403
404	# the displayed name, this is a one way mapping
405	sub visible_name {
406	my ($self) = @_;
407
408	# if (my $rmp = $self->{random}) {
409	# # todo: be more intelligent about this
410	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411	# } else {
412	$self->as_string
413	# }
414	}
415
416	# escape the /'s in the path
417	sub _escaped_path {
418	# ∕ is U+2215
419	(my $path = $_[0]{path}) =~ s/\//∕/g;
420	$path
421	}
422
423	# the original (read-only) location
424	sub load_path {
425	my ($self) = @_;
426
427	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428	}
429
430	# the temporary/swap location
431	sub save_path {
432	my ($self) = @_;
433
434	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437	}
438
439	# the unique path, might be eq to save_path
440	sub uniq_path {
441	my ($self) = @_;
442
443	$self->{user_rel} || $self->{random}
444	? undef
445	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446	}
447
448	# return random map parameters, or undef
449	sub random_map_params {
450	my ($self) = @_;
451
452	$self->{random}
453	}
454
455	# this is somewhat ugly, but style maps do need special treatment
456	sub is_style_map {
457	$_[0]{path} =~ m{^/styles/}
458	}
459
460	package cf;
461		726
462	#############################################################################	727	#############################################################################
463		728
464	=head2 ATTACHABLE OBJECTS	729	=head2 ATTACHABLE OBJECTS
465		730
…		…
467	attach callbacks/event handlers (a collection of which is called an "attachment")	732	attach callbacks/event handlers (a collection of which is called an "attachment")
468	to it. All such attachable objects support the following methods.	733	to it. All such attachable objects support the following methods.
469		734
470	In the following description, CLASS can be any of C<global>, C<object>	735	In the following description, CLASS can be any of C<global>, C<object>
471	C<player>, C<client> or C<map> (i.e. the attachable objects in	736	C<player>, C<client> or C<map> (i.e. the attachable objects in
472	crossfire+).	737	Deliantra).
473		738
474	=over 4	739	=over 4
475		740
476	=item $attachable->attach ($attachment, key => $value...)	741	=item $attachable->attach ($attachment, key => $value...)
477		742
…		…
591	our @CB_TYPE = (); # registry for type (cf-object class) based events	856	our @CB_TYPE = (); # registry for type (cf-object class) based events
592	our @CB_MAP = ();	857	our @CB_MAP = ();
593		858
594	my %attachment;	859	my %attachment;
595		860
		861	sub cf::attachable::thawer_merge {
		862	# simply override everything except _meta
		863	local $_[0]{_meta};
		864	%{$_[0]} = %{$_[1]};
		865	}
		866
596	sub _attach_cb($$$$) {	867	sub _attach_cb($$$$) {
597	my ($registry, $event, $prio, $cb) = @_;	868	my ($registry, $event, $prio, $cb) = @_;
598		869
599	use sort 'stable';	870	use sort 'stable';
600		871
…		…
634	$registry = $CB_TYPE[$object_type] ||= [];	905	$registry = $CB_TYPE[$object_type] ||= [];
635		906
636	} elsif ($type eq "subtype") {	907	} elsif ($type eq "subtype") {
637	defined $object_type or Carp::croak "subtype specified without type";	908	defined $object_type or Carp::croak "subtype specified without type";
638	my $object_subtype = shift @arg;	909	my $object_subtype = shift @arg;
639	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	910	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
640		911
641	} elsif ($type eq "package") {	912	} elsif ($type eq "package") {
642	my $pkg = shift @arg;	913	my $pkg = shift @arg;
643		914
644	while (my ($name, $id) = each %cb_id) {	915	while (my ($name, $id) = each %cb_id) {
…		…
673	_attach $registry, $klass, @attach;	944	_attach $registry, $klass, @attach;
674	}	945	}
675		946
676	$obj->{$name} = \%arg;	947	$obj->{$name} = \%arg;
677	} else {	948	} else {
678	warn "object uses attachment '$name' that is not available, postponing.\n";	949	warn "object uses attachment '$name' which is not available, postponing.\n";
679	}	950	}
680		951
681	$obj->{_attachment}{$name} = undef;	952	$obj->{_attachment}{$name} = undef;
682	}	953	}
683		954
…		…
685	if (ref $_[0]) {	956	if (ref $_[0]) {
686	_object_attach @_;	957	_object_attach @_;
687	} else {	958	} else {
688	_attach shift->_attach_registry, @_;	959	_attach shift->_attach_registry, @_;
689	}	960	}
		961	_recalc_want;
690	};	962	};
691		963
692	# all those should be optimised	964	# all those should be optimised
693	sub cf::attachable::detach {	965	sub cf::attachable::detach {
694	my ($obj, $name) = @_;	966	my ($obj, $name) = @_;
…		…
697	delete $obj->{_attachment}{$name};	969	delete $obj->{_attachment}{$name};
698	reattach ($obj);	970	reattach ($obj);
699	} else {	971	} else {
700	Carp::croak "cannot, currently, detach class attachments";	972	Carp::croak "cannot, currently, detach class attachments";
701	}	973	}
		974	_recalc_want;
702	};	975	};
703		976
704	sub cf::attachable::attached {	977	sub cf::attachable::attached {
705	my ($obj, $name) = @_;	978	my ($obj, $name) = @_;
706		979
…		…
721	";	994	";
722	die if $@;	995	die if $@;
723	}	996	}
724		997
725	our $override;	998	our $override;
726	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	999	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
727		1000
728	sub override {	1001	sub override {
729	$override = 1;	1002	$override = 1;
730	@invoke_results = ();	1003	@INVOKE_RESULTS = (@_);
731	}	1004	}
732		1005
733	sub do_invoke {	1006	sub do_invoke {
734	my $event = shift;	1007	my $event = shift;
735	my $callbacks = shift;	1008	my $callbacks = shift;
736		1009
737	@invoke_results = ();	1010	@INVOKE_RESULTS = ();
738		1011
739	local $override;	1012	local $override;
740		1013
741	for (@$callbacks) {	1014	for (@$callbacks) {
742	eval { &{$_->[1]} };	1015	eval { &{$_->[1]} };
…		…
751	}	1024	}
752		1025
753	0	1026	0
754	}	1027	}
755		1028
756	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1029	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
757		1030
758	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1031	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
759		1032
760	Generate an object-specific event with the given arguments.	1033	Generate an object-specific event with the given arguments.
761		1034
762	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1035	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
763	removed in future versions), and there is no public API to access override	1036	removed in future versions), and there is no public API to access override
764	results (if you must, access C<@cf::invoke_results> directly).	1037	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
765		1038
766	=back	1039	=back
767		1040
768	=cut	1041	=cut
769		1042
770	#############################################################################	1043	#############################################################################
771	# object support	1044	# object support
		1045
		1046	sub _object_equal($$);
		1047	sub _object_equal($$) {
		1048	my ($a, $b) = @_;
		1049
		1050	return 0 unless (ref $a) eq (ref $b);
		1051
		1052	if ("HASH" eq ref $a) {
		1053	my @ka = keys %$a;
		1054	my @kb = keys %$b;
		1055
		1056	return 0 if @ka != @kb;
		1057
		1058	for (0 .. $#ka) {
		1059	return 0 unless $ka[$_] eq $kb[$_];
		1060	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1061	}
		1062
		1063	} elsif ("ARRAY" eq ref $a) {
		1064
		1065	return 0 if @$a != @$b;
		1066
		1067	for (0 .. $#$a) {
		1068	return 0 unless _object_equal $a->[$_], $b->[$_];
		1069	}
		1070
		1071	} elsif ($a ne $b) {
		1072	return 0;
		1073	}
		1074
		1075	1
		1076	}
		1077
		1078	our $SLOW_MERGES;#d#
		1079	sub _can_merge {
		1080	my ($ob1, $ob2) = @_;
		1081
		1082	++$SLOW_MERGES;#d#
		1083
		1084	# we do the slow way here
		1085	return _object_equal $ob1, $ob2
		1086	}
772		1087
773	sub reattach {	1088	sub reattach {
774	# basically do the same as instantiate, without calling instantiate	1089	# basically do the same as instantiate, without calling instantiate
775	my ($obj) = @_;	1090	my ($obj) = @_;
		1091
		1092	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
776		1093
777	my $registry = $obj->registry;	1094	my $registry = $obj->registry;
778		1095
779	@$registry = ();	1096	@$registry = ();
780		1097
…		…
795	cf::attachable->attach (	1112	cf::attachable->attach (
796	prio => -1000000,	1113	prio => -1000000,
797	on_instantiate => sub {	1114	on_instantiate => sub {
798	my ($obj, $data) = @_;	1115	my ($obj, $data) = @_;
799		1116
800	$data = from_json $data;	1117	$data = decode_json $data;
801		1118
802	for (@$data) {	1119	for (@$data) {
803	my ($name, $args) = @$_;	1120	my ($name, $args) = @$_;
804		1121
805	$obj->attach ($name, %{$args || {} });	1122	$obj->attach ($name, %{$args || {} });
…		…
821	sub object_freezer_save {	1138	sub object_freezer_save {
822	my ($filename, $rdata, $objs) = @_;	1139	my ($filename, $rdata, $objs) = @_;
823		1140
824	sync_job {	1141	sync_job {
825	if (length $$rdata) {	1142	if (length $$rdata) {
		1143	utf8::decode (my $decname = $filename);
826	warn sprintf "saving %s (%d,%d)\n",	1144	warn sprintf "saving %s (%d,%d)\n",
827	$filename, length $$rdata, scalar @$objs;	1145	$decname, length $$rdata, scalar @$objs;
828		1146
829	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1147	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830	chmod SAVE_MODE, $fh;	1148	aio_chmod $fh, SAVE_MODE;
831	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1149	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
832	aio_fsync $fh;	1150	aio_fsync $fh if $cf::USE_FSYNC;
833	close $fh;	1151	aio_close $fh;
834		1152
835	if (@$objs) {	1153	if (@$objs) {
836	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1154	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
837	chmod SAVE_MODE, $fh;	1155	aio_chmod $fh, SAVE_MODE;
838	my $data = Storable::nfreeze { version => 1, objs => $objs };	1156	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
839	aio_write $fh, 0, (length $data), $data, 0;	1157	aio_write $fh, 0, (length $data), $data, 0;
840	aio_fsync $fh;	1158	aio_fsync $fh if $cf::USE_FSYNC;
841	close $fh;	1159	aio_close $fh;
842	aio_rename "$filename.pst~", "$filename.pst";	1160	aio_rename "$filename.pst~", "$filename.pst";
843	}	1161	}
844	} else {	1162	} else {
845	aio_unlink "$filename.pst";	1163	aio_unlink "$filename.pst";
846	}	1164	}
…		…
851	}	1169	}
852	} else {	1170	} else {
853	aio_unlink $filename;	1171	aio_unlink $filename;
854	aio_unlink "$filename.pst";	1172	aio_unlink "$filename.pst";
855	}	1173	}
856	}	1174	};
857	}	1175	}
858		1176
859	sub object_freezer_as_string {	1177	sub object_freezer_as_string {
860	my ($rdata, $objs) = @_;	1178	my ($rdata, $objs) = @_;
861		1179
…		…
873	or return;	1191	or return;
874		1192
875	unless (aio_stat "$filename.pst") {	1193	unless (aio_stat "$filename.pst") {
876	(aio_load "$filename.pst", $av) >= 0	1194	(aio_load "$filename.pst", $av) >= 0
877	or return;	1195	or return;
		1196
878	$av = eval { (Storable::thaw $av)->{objs} };	1197	my $st = eval { Coro::Storable::thaw $av };
		1198	$av = $st->{objs};
879	}	1199	}
880		1200
		1201	utf8::decode (my $decname = $filename);
881	warn sprintf "loading %s (%d)\n",	1202	warn sprintf "loading %s (%d,%d)\n",
882	$filename, length $data, scalar @{$av || []};#d#	1203	$decname, length $data, scalar @{$av || []};
		1204
883	return ($data, $av);	1205	($data, $av)
884	}	1206	}
		1207
		1208	=head2 COMMAND CALLBACKS
		1209
		1210	=over 4
		1211
		1212	=cut
885		1213
886	#############################################################################	1214	#############################################################################
887	# command handling &c	1215	# command handling &c
888		1216
889	=item cf::register_command $name => \&callback($ob,$args);	1217	=item cf::register_command $name => \&callback($ob,$args);
…		…
902	push @{ $COMMAND{$name} }, [$caller, $cb];	1230	push @{ $COMMAND{$name} }, [$caller, $cb];
903	}	1231	}
904		1232
905	=item cf::register_extcmd $name => \&callback($pl,$packet);	1233	=item cf::register_extcmd $name => \&callback($pl,$packet);
906		1234
907	Register a callbackf ro execution when the client sends an extcmd packet.	1235	Register a callback for execution when the client sends an (synchronous)
		1236	extcmd packet. Ext commands will be processed in the order they are
		1237	received by the server, like other user commands. The first argument is
		1238	the logged-in player. Ext commands can only be processed after a player
		1239	has logged in successfully.
908		1240
909	If the callback returns something, it is sent back as if reply was being	1241	If the callback returns something, it is sent back as if reply was being
910	called.	1242	called.
911		1243
		1244	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1245
		1246	Register a callback for execution when the client sends an (asynchronous)
		1247	exticmd packet. Exti commands are processed by the server as soon as they
		1248	are received, i.e. out of order w.r.t. other commands. The first argument
		1249	is a client socket. Exti commands can be received anytime, even before
		1250	log-in.
		1251
		1252	If the callback returns something, it is sent back as if reply was being
		1253	called.
		1254
912	=cut	1255	=cut
913		1256
914	sub register_extcmd {	1257	sub register_extcmd {
915	my ($name, $cb) = @_;	1258	my ($name, $cb) = @_;
916		1259
917	my $caller = caller;
918	#warn "registering extcmd '$name' to '$caller'";
919
920	$EXTCMD{$name} = [$cb, $caller];	1260	$EXTCMD{$name} = $cb;
		1261	}
		1262
		1263	sub register_exticmd {
		1264	my ($name, $cb) = @_;
		1265
		1266	$EXTICMD{$name} = $cb;
921	}	1267	}
922		1268
923	cf::player->attach (	1269	cf::player->attach (
924	on_command => sub {	1270	on_command => sub {
925	my ($pl, $name, $params) = @_;	1271	my ($pl, $name, $params) = @_;
…		…
934	cf::override;	1280	cf::override;
935	},	1281	},
936	on_extcmd => sub {	1282	on_extcmd => sub {
937	my ($pl, $buf) = @_;	1283	my ($pl, $buf) = @_;
938		1284
939	my $msg = eval { from_json $buf };	1285	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
940		1286
941	if (ref $msg) {	1287	if (ref $msg) {
		1288	my ($type, $reply, @payload) =
		1289	"ARRAY" eq ref $msg
		1290	? @$msg
		1291	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1292
		1293	my @reply;
		1294
942	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1295	if (my $cb = $EXTCMD{$type}) {
943	if (my %reply = $cb->[0]->($pl, $msg)) {	1296	@reply = $cb->($pl, @payload);
944	$pl->ext_reply ($msg->{msgid}, %reply);
945	}
946	}	1297	}
		1298
		1299	$pl->ext_reply ($reply, @reply)
		1300	if $reply;
		1301
947	} else {	1302	} else {
948	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1303	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
949	}	1304	}
950		1305
951	cf::override;	1306	cf::override;
952	},	1307	},
953	);	1308	);
954		1309
955	sub register {
956	my ($base, $pkg) = @_;
957
958	#TODO
959	}
960
961	sub load_extension {	1310	sub load_extensions {
		1311	cf::sync_job {
		1312	my %todo;
		1313
		1314	for my $path (<$LIBDIR/*.ext>) {
		1315	next unless -r $path;
		1316
		1317	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1318	my $base = $1;
		1319	my $pkg = $1;
		1320	$pkg =~ s/[^[:word:]]/_/g;
		1321	$pkg = "ext::$pkg";
		1322
		1323	open my $fh, "<:utf8", $path
		1324	or die "$path: $!";
		1325
		1326	my $source = do { local $/; <$fh> };
		1327
		1328	my %ext = (
		1329	path => $path,
		1330	base => $base,
		1331	pkg => $pkg,
		1332	);
		1333
		1334	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1335	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1336
		1337	$ext{source} =
		1338	"package $pkg; use strict; use utf8;\n"
		1339	. "#line 1 \"$path\"\n{\n"
		1340	. $source
		1341	. "\n};\n1";
		1342
		1343	$todo{$base} = \%ext;
		1344	}
		1345
		1346	my %done;
		1347	while (%todo) {
		1348	my $progress;
		1349
		1350	while (my ($k, $v) = each %todo) {
		1351	for (split /,\s*/, $v->{meta}{depends}) {
		1352	goto skip
		1353	unless exists $done{$_};
		1354	}
		1355
		1356	warn "... loading '$k' into '$v->{pkg}'\n";
		1357
		1358	unless (eval $v->{source}) {
		1359	my $msg = $@ ? "$v->{path}: $@\n"
		1360	: "$v->{base}: extension inactive.\n";
		1361
		1362	if (exists $v->{meta}{mandatory}) {
		1363	warn $msg;
		1364	cf::cleanup "mandatory extension failed to load, exiting.";
		1365	}
		1366
		1367	warn $msg;
		1368	}
		1369
		1370	$done{$k} = delete $todo{$k};
		1371	push @EXTS, $v->{pkg};
		1372	$progress = 1;
		1373	}
		1374
		1375	skip:
		1376	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1377	unless $progress;
		1378	}
		1379	};
		1380	}
		1381
		1382	#############################################################################
		1383
		1384	=back
		1385
		1386	=head2 CORE EXTENSIONS
		1387
		1388	Functions and methods that extend core crossfire objects.
		1389
		1390	=cut
		1391
		1392	package cf::player;
		1393
		1394	use Coro::AIO;
		1395
		1396	=head3 cf::player
		1397
		1398	=over 4
		1399
		1400	=item cf::player::num_playing
		1401
		1402	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1403
		1404	=cut
		1405
		1406	sub num_playing {
		1407	scalar grep
		1408	$_->ob->map
		1409	&& !$_->hidden
		1410	&& !$_->ob->flag (cf::FLAG_WIZ),
		1411	cf::player::list
		1412	}
		1413
		1414	=item cf::player::find $login
		1415
		1416	Returns the given player object, loading it if necessary (might block).
		1417
		1418	=cut
		1419
		1420	sub playerdir($) {
		1421	"$PLAYERDIR/"
		1422	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1423	}
		1424
		1425	sub path($) {
		1426	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1427
		1428	(playerdir $login) . "/playerdata"
		1429	}
		1430
		1431	sub find_active($) {
		1432	$cf::PLAYER{$_[0]}
		1433	and $cf::PLAYER{$_[0]}->active
		1434	and $cf::PLAYER{$_[0]}
		1435	}
		1436
		1437	sub exists($) {
		1438	my ($login) = @_;
		1439
		1440	$cf::PLAYER{$login}
		1441	or cf::sync_job { !aio_stat path $login }
		1442	}
		1443
		1444	sub find($) {
		1445	return $cf::PLAYER{$_[0]} || do {
		1446	my $login = $_[0];
		1447
		1448	my $guard = cf::lock_acquire "user_find:$login";
		1449
		1450	$cf::PLAYER{$_[0]} || do {
		1451	# rename old playerfiles to new ones
		1452	#TODO: remove when no longer required
		1453	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1454	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1455	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1456	aio_unlink +(playerdir $login) . "/$login.pl";
		1457
		1458	my $f = new_from_file cf::object::thawer path $login
		1459	or return;
		1460
		1461	my $pl = cf::player::load_pl $f
		1462	or return;
		1463
		1464	local $cf::PLAYER_LOADING{$login} = $pl;
		1465	$f->resolve_delayed_derefs;
		1466	$cf::PLAYER{$login} = $pl
		1467	}
		1468	}
		1469	}
		1470
		1471	sub save($) {
		1472	my ($pl) = @_;
		1473
		1474	return if $pl->{deny_save};
		1475
		1476	my $path = path $pl;
		1477	my $guard = cf::lock_acquire "user_save:$path";
		1478
		1479	return if $pl->{deny_save};
		1480
		1481	aio_mkdir playerdir $pl, 0770;
		1482	$pl->{last_save} = $cf::RUNTIME;
		1483
		1484	cf::get_slot 0.01;
		1485
		1486	$pl->save_pl ($path);
		1487	cf::cede_to_tick;
		1488	}
		1489
		1490	sub new($) {
		1491	my ($login) = @_;
		1492
		1493	my $self = create;
		1494
		1495	$self->ob->name ($login);
		1496	$self->{deny_save} = 1;
		1497
		1498	$cf::PLAYER{$login} = $self;
		1499
		1500	$self
		1501	}
		1502
		1503	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1504
		1505	=cut
		1506
		1507	sub send_msg {
		1508	my $ns = shift->ns
		1509	or return;
		1510	$ns->send_msg (@_);
		1511	}
		1512
		1513	=item $pl->quit_character
		1514
		1515	Nukes the player without looking back. If logged in, the connection will
		1516	be destroyed. May block for a long time.
		1517
		1518	=cut
		1519
		1520	sub quit_character {
		1521	my ($pl) = @_;
		1522
		1523	my $name = $pl->ob->name;
		1524
		1525	$pl->{deny_save} = 1;
		1526	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1527
		1528	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1529	$pl->deactivate;
		1530	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1531	$pl->ob->check_score;
		1532	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1533	$pl->ns->destroy if $pl->ns;
		1534
		1535	my $path = playerdir $pl;
		1536	my $temp = "$path~$cf::RUNTIME~deleting~";
		1537	aio_rename $path, $temp;
		1538	delete $cf::PLAYER{$pl->ob->name};
		1539	$pl->destroy;
		1540
		1541	my $prefix = qr<^~\Q$name\E/>;
		1542
		1543	# nuke player maps
		1544	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1545
		1546	IO::AIO::aio_rmtree $temp;
		1547	}
		1548
		1549	=item $pl->kick
		1550
		1551	Kicks a player out of the game. This destroys the connection.
		1552
		1553	=cut
		1554
		1555	sub kick {
		1556	my ($pl, $kicker) = @_;
		1557
		1558	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1559	$pl->killer ("kicked");
		1560	$pl->ns->destroy;
		1561	}
		1562
		1563	=item cf::player::list_logins
		1564
		1565	Returns am arrayref of all valid playernames in the system, can take a
		1566	while and may block, so not sync_job-capable, ever.
		1567
		1568	=cut
		1569
		1570	sub list_logins {
		1571	my $dirs = aio_readdir $PLAYERDIR
		1572	or return [];
		1573
		1574	my @logins;
		1575
		1576	for my $login (@$dirs) {
		1577	my $path = path $login;
		1578
		1579	# a .pst is a dead give-away for a valid player
		1580	# if no pst file found, open and chekc for blocked users
		1581	if (aio_stat "$path.pst") {
		1582	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1583	aio_read $fh, 0, 512, my $buf, 0 or next;
		1584	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1585	}
		1586
		1587	utf8::decode $login;
		1588	push @logins, $login;
		1589	}
		1590
		1591	\@logins
		1592	}
		1593
		1594	=item $player->maps
		1595
		1596	Returns an arrayref of map paths that are private for this
		1597	player. May block.
		1598
		1599	=cut
		1600
		1601	sub maps($) {
		1602	my ($pl) = @_;
		1603
		1604	$pl = ref $pl ? $pl->ob->name : $pl;
		1605
		1606	my $files = aio_readdir playerdir $pl
		1607	or return;
		1608
		1609	my @paths;
		1610
		1611	for (@$files) {
		1612	utf8::decode $_;
		1613	next if /\.(?:pl|pst)$/;
		1614	next unless /^$PATH_SEP/o;
		1615
		1616	push @paths, cf::map::normalise "~$pl/$_";
		1617	}
		1618
		1619	\@paths
		1620	}
		1621
		1622	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1623
		1624	Expand crossfire pod fragments into protocol xml.
		1625
		1626	=cut
		1627
		1628	use re 'eval';
		1629
		1630	my $group;
		1631	my $interior; $interior = qr{
		1632	# match a pod interior sequence sans C<< >>
		1633	(?:
		1634	\ (.*?)\ (?{ $group = $^N })
		1635	| < (??{$interior}) >
		1636	)
		1637	}x;
		1638
		1639	sub expand_cfpod {
		1640	my ($self, $pod) = @_;
		1641
		1642	my $xml;
		1643
		1644	while () {
		1645	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1646	$group = $1;
		1647
		1648	$group =~ s/&/&amp;/g;
		1649	$group =~ s/</&lt;/g;
		1650
		1651	$xml .= $group;
		1652	} elsif ($pod =~ m%\G
		1653	([BCGHITU])
		1654	<
		1655	(?:
		1656	([^<>]*) (?{ $group = $^N })
		1657	| < $interior >
		1658	)
		1659	>
		1660	%gcsx
		1661	) {
		1662	my ($code, $data) = ($1, $group);
		1663
		1664	if ($code eq "B") {
		1665	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1666	} elsif ($code eq "I") {
		1667	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1668	} elsif ($code eq "U") {
		1669	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1670	} elsif ($code eq "C") {
		1671	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1672	} elsif ($code eq "T") {
		1673	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1674	} elsif ($code eq "G") {
		1675	my ($male, $female) = split /\|/, $data;
		1676	$data = $self->gender ? $female : $male;
		1677	$xml .= expand_cfpod ($self, $data);
		1678	} elsif ($code eq "H") {
		1679	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1680	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1681	"")
		1682	[$self->{hintmode}];
		1683	} else {
		1684	$xml .= "error processing '$code($data)' directive";
		1685	}
		1686	} else {
		1687	if ($pod =~ /\G(.+)/) {
		1688	warn "parse error while expanding $pod (at $1)";
		1689	}
		1690	last;
		1691	}
		1692	}
		1693
		1694	for ($xml) {
		1695	# create single paragraphs (very hackish)
		1696	s/(?<=\S)\n(?=\w)/ /g;
		1697
		1698	# compress some whitespace
		1699	s/\s+\n/\n/g; # ws line-ends
		1700	s/\n\n+/\n/g; # double lines
		1701	s/^\n+//; # beginning lines
		1702	s/\n+$//; # ending lines
		1703	}
		1704
		1705	$xml
		1706	}
		1707
		1708	no re 'eval';
		1709
		1710	sub hintmode {
		1711	$_[0]{hintmode} = $_[1] if @_ > 1;
		1712	$_[0]{hintmode}
		1713	}
		1714
		1715	=item $player->ext_reply ($msgid, @msg)
		1716
		1717	Sends an ext reply to the player.
		1718
		1719	=cut
		1720
		1721	sub ext_reply($$@) {
		1722	my ($self, $id, @msg) = @_;
		1723
		1724	$self->ns->ext_reply ($id, @msg)
		1725	}
		1726
		1727	=item $player->ext_msg ($type, @msg)
		1728
		1729	Sends an ext event to the client.
		1730
		1731	=cut
		1732
		1733	sub ext_msg($$@) {
		1734	my ($self, $type, @msg) = @_;
		1735
		1736	$self->ns->ext_msg ($type, @msg);
		1737	}
		1738
		1739	=head3 cf::region
		1740
		1741	=over 4
		1742
		1743	=cut
		1744
		1745	package cf::region;
		1746
		1747	=item cf::region::find_by_path $path
		1748
		1749	Tries to decuce the likely region for a map knowing only its path.
		1750
		1751	=cut
		1752
		1753	sub find_by_path($) {
962	my ($path) = @_;	1754	my ($path) = @_;
963		1755
964	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1756	my ($match, $specificity);
965	my $base = $1;
966	my $pkg = $1;
967	$pkg =~ s/[^[:word:]]/_/g;
968	$pkg = "ext::$pkg";
969		1757
970	warn "loading '$path' into '$pkg'\n";	1758	for my $region (list) {
971		1759	if ($region->{match} && $path =~ $region->{match}) {
972	open my $fh, "<:utf8", $path	1760	($match, $specificity) = ($region, $region->specificity)
973	or die "$path: $!";	1761	if $region->specificity > $specificity;
974		1762	}
975	my $source =
976	"package $pkg; use strict; use utf8;\n"
977	. "#line 1 \"$path\"\n{\n"
978	. (do { local $/; <$fh> })
979	. "\n};\n1";
980
981	eval $source
982	or die $@ ? "$path: $@\n"
983	: "extension disabled.\n";
984
985	push @exts, $pkg;
986	$ext_pkg{$base} = $pkg;
987
988	# no strict 'refs';
989	# @{"$pkg\::ISA"} = ext::;
990
991	register $base, $pkg;
992	}
993
994	sub unload_extension {
995	my ($pkg) = @_;
996
997	warn "removing extension $pkg\n";
998
999	# remove hooks
1000	#TODO
1001	# for my $idx (0 .. $#PLUGIN_EVENT) {
1002	# delete $hook[$idx]{$pkg};
1003	# }	1763	}
1004		1764
1005	# remove commands	1765	$match
1006	for my $name (keys %COMMAND) {
1007	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1008
1009	if (@cb) {
1010	$COMMAND{$name} = \@cb;
1011	} else {
1012	delete $COMMAND{$name};
1013	}
1014	}
1015
1016	# remove extcmds
1017	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1018	delete $EXTCMD{$name};
1019	}
1020
1021	if (my $cb = $pkg->can ("unload")) {
1022	eval {
1023	$cb->($pkg);
1024	1
1025	} or warn "$pkg unloaded, but with errors: $@";
1026	}
1027
1028	Symbol::delete_package $pkg;
1029	}
1030
1031	sub load_extensions {
1032	for my $ext (<$LIBDIR/*.ext>) {
1033	next unless -r $ext;
1034	eval {
1035	load_extension $ext;
1036	1
1037	} or warn "$ext not loaded: $@";
1038	}
1039	}
1040
1041	#############################################################################
1042	# load/save/clean perl data associated with a map
1043
1044	*cf::mapsupport::on_clean = sub {
1045	my ($map) = @_;
1046
1047	my $path = $map->tmpname;
1048	defined $path or return;
1049
1050	unlink "$path.pst";
1051	};
1052
1053	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1054
1055	#############################################################################
1056	# load/save perl data associated with player->ob objects
1057
1058	sub all_objects(@) {
1059	@_, map all_objects ($_->inv), @_
1060	}
1061
1062	# TODO: compatibility cruft, remove when no longer needed
1063	cf::player->attach (
1064	on_load => sub {
1065	my ($pl, $path) = @_;
1066
1067	for my $o (all_objects $pl->ob) {
1068	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1069	$o->set_ob_key_value ("_perl_data");
1070
1071	%$o = %{ Storable::thaw pack "H*", $value };
1072	}
1073	}
1074	},
1075	);
1076
1077	#############################################################################
1078
1079	=head2 CORE EXTENSIONS
1080
1081	Functions and methods that extend core crossfire objects.
1082
1083	=head3 cf::player
1084
1085	=over 4
1086
1087	=item cf::player::exists $login
1088
1089	Returns true when the given account exists.
1090
1091	=cut
1092
1093	sub cf::player::exists($) {
1094	cf::player::find $_[0]
1095	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1096	}
1097
1098	=item $player->ext_reply ($msgid, $msgtype, %msg)
1099
1100	Sends an ext reply to the player.
1101
1102	=cut
1103
1104	sub cf::player::ext_reply($$$%) {
1105	my ($self, $id, %msg) = @_;
1106
1107	$msg{msgid} = $id;
1108
1109	$self->send ("ext " . to_json \%msg);
1110	}	1766	}
1111		1767
1112	=back	1768	=back
1113
1114		1769
1115	=head3 cf::map	1770	=head3 cf::map
1116		1771
1117	=over 4	1772	=over 4
1118		1773
…		…
1121	package cf::map;	1776	package cf::map;
1122		1777
1123	use Fcntl;	1778	use Fcntl;
1124	use Coro::AIO;	1779	use Coro::AIO;
1125		1780
		1781	use overload
		1782	'""' => \&as_string,
		1783	fallback => 1;
		1784
1126	our $MAX_RESET = 3600;	1785	our $MAX_RESET = 3600;
1127	our $DEFAULT_RESET = 3000;	1786	our $DEFAULT_RESET = 3000;
1128		1787
1129	sub generate_random_map {	1788	sub generate_random_map {
1130	my ($path, $rmp) = @_;	1789	my ($self, $rmp) = @_;
		1790
		1791	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1131		1792
1132	# mit "rum" bekleckern, nicht	1793	# mit "rum" bekleckern, nicht
1133	cf::map::_create_random_map	1794	$self->_create_random_map (
1134	$path,
1135	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1795	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1796	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1137	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1797	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138	$rmp->{exit_on_final_map},	1798	$rmp->{exit_on_final_map},
1139	$rmp->{xsize}, $rmp->{ysize},	1799	$rmp->{xsize}, $rmp->{ysize},
1140	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1800	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1801	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1802	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1803	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1144	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1804	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145	(cf::region::find $rmp->{region})	1805	(cf::region::find $rmp->{region}), $rmp->{custom}
		1806	)
		1807	}
		1808
		1809	=item cf::map->register ($regex, $prio)
		1810
		1811	Register a handler for the map path matching the given regex at the
		1812	givne priority (higher is better, built-in handlers have priority 0, the
		1813	default).
		1814
		1815	=cut
		1816
		1817	sub register {
		1818	my (undef, $regex, $prio) = @_;
		1819	my $pkg = caller;
		1820
		1821	no strict;
		1822	push @{"$pkg\::ISA"}, __PACKAGE__;
		1823
		1824	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1825	}
		1826
		1827	# also paths starting with '/'
		1828	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1829
		1830	sub thawer_merge {
		1831	my ($self, $merge) = @_;
		1832
		1833	# we have to keep some variables in memory intact
		1834	local $self->{path};
		1835	local $self->{load_path};
		1836
		1837	$self->SUPER::thawer_merge ($merge);
		1838	}
		1839
		1840	sub normalise {
		1841	my ($path, $base) = @_;
		1842
		1843	$path = "$path"; # make sure its a string
		1844
		1845	$path =~ s/\.map$//;
		1846
		1847	# map plan:
		1848	#
		1849	# /! non-realised random map exit (special hack!)
		1850	# {... are special paths that are not being touched
		1851	# ?xxx/... are special absolute paths
		1852	# ?random/... random maps
		1853	# /... normal maps
		1854	# ~user/... per-player map of a specific user
		1855
		1856	$path =~ s/$PATH_SEP/\//go;
		1857
		1858	# treat it as relative path if it starts with
		1859	# something that looks reasonable
		1860	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1861	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1862
		1863	$base =~ s{[^/]+/?$}{};
		1864	$path = "$base/$path";
		1865	}
		1866
		1867	for ($path) {
		1868	redo if s{//}{/};
		1869	redo if s{/\.?/}{/};
		1870	redo if s{/[^/]+/\.\./}{/};
		1871	}
		1872
		1873	$path
		1874	}
		1875
		1876	sub new_from_path {
		1877	my (undef, $path, $base) = @_;
		1878
		1879	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1880
		1881	$path = normalise $path, $base;
		1882
		1883	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1884	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1885	my $self = bless cf::map::new, $pkg;
		1886	$self->{path} = $path; $self->path ($path);
		1887	$self->init; # pass $1 etc.
		1888	return $self;
		1889	}
		1890	}
		1891
		1892	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1893	()
		1894	}
		1895
		1896	sub init {
		1897	my ($self) = @_;
		1898
		1899	$self
		1900	}
		1901
		1902	sub as_string {
		1903	my ($self) = @_;
		1904
		1905	"$self->{path}"
		1906	}
		1907
		1908	# the displayed name, this is a one way mapping
		1909	sub visible_name {
		1910	&as_string
		1911	}
		1912
		1913	# the original (read-only) location
		1914	sub load_path {
		1915	my ($self) = @_;
		1916
		1917	"$MAPDIR/$self->{path}.map"
		1918	}
		1919
		1920	# the temporary/swap location
		1921	sub save_path {
		1922	my ($self) = @_;
		1923
		1924	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1925	"$TMPDIR/$path.map"
		1926	}
		1927
		1928	# the unique path, undef == no special unique path
		1929	sub uniq_path {
		1930	my ($self) = @_;
		1931
		1932	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1933	"$UNIQUEDIR/$path"
1146	}	1934	}
1147		1935
1148	# and all this just because we cannot iterate over	1936	# and all this just because we cannot iterate over
1149	# all maps in C++...	1937	# all maps in C++...
1150	sub change_all_map_light {	1938	sub change_all_map_light {
…		…
1152		1940
1153	$_->change_map_light ($change)	1941	$_->change_map_light ($change)
1154	for grep $_->outdoor, values %cf::MAP;	1942	for grep $_->outdoor, values %cf::MAP;
1155	}	1943	}
1156		1944
		1945	sub decay_objects {
		1946	my ($self) = @_;
		1947
		1948	return if $self->{deny_reset};
		1949
		1950	$self->do_decay_objects;
		1951	}
		1952
		1953	sub unlink_save {
		1954	my ($self) = @_;
		1955
		1956	utf8::encode (my $save = $self->save_path);
		1957	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1958	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1959	}
		1960
1157	sub try_load_header($) {	1961	sub load_header_from($) {
1158	my ($path) = @_;	1962	my ($self, $path) = @_;
1159		1963
1160	utf8::encode $path;	1964	utf8::encode $path;
1161	aio_open $path, O_RDONLY, 0	1965	my $f = new_from_file cf::object::thawer $path
1162	or return;	1966	or return;
1163		1967
1164	my $map = cf::map::new	1968	$self->_load_header ($f)
1165	or return;	1969	or return;
1166		1970
1167	# for better error messages only, will be overwritten	1971	local $MAP_LOADING{$self->{path}} = $self;
1168	$map->path ($path);	1972	$f->resolve_delayed_derefs;
1169		1973
1170	$map->load_header ($path)	1974	$self->{load_path} = $path;
		1975
		1976	1
		1977	}
		1978
		1979	sub load_header_orig {
		1980	my ($self) = @_;
		1981
		1982	$self->load_header_from ($self->load_path)
		1983	}
		1984
		1985	sub load_header_temp {
		1986	my ($self) = @_;
		1987
		1988	$self->load_header_from ($self->save_path)
		1989	}
		1990
		1991	sub prepare_temp {
		1992	my ($self) = @_;
		1993
		1994	$self->last_access ((delete $self->{last_access})
		1995	|| $cf::RUNTIME); #d#
		1996	# safety
		1997	$self->{instantiate_time} = $cf::RUNTIME
		1998	if $self->{instantiate_time} > $cf::RUNTIME;
		1999	}
		2000
		2001	sub prepare_orig {
		2002	my ($self) = @_;
		2003
		2004	$self->{load_original} = 1;
		2005	$self->{instantiate_time} = $cf::RUNTIME;
		2006	$self->last_access ($cf::RUNTIME);
		2007	$self->instantiate;
		2008	}
		2009
		2010	sub load_header {
		2011	my ($self) = @_;
		2012
		2013	if ($self->load_header_temp) {
		2014	$self->prepare_temp;
		2015	} else {
		2016	$self->load_header_orig
1171	or return;	2017	or return;
		2018	$self->prepare_orig;
		2019	}
1172		2020
1173	$map->{load_path} = $path;	2021	$self->{deny_reset} = 1
		2022	if $self->no_reset;
1174		2023
1175	$map	2024	$self->default_region (cf::region::find_by_path $self->{path})
		2025	unless $self->default_region;
		2026
		2027	1
1176	}	2028	}
1177		2029
1178	sub find;	2030	sub find;
1179	sub find {	2031	sub find {
1180	my ($path, $origin) = @_;	2032	my ($path, $origin) = @_;
1181		2033
1182	#warn "find<$path,$origin>\n";#d#
1183
1184	$path = new cf::path $path, $origin && $origin->path;	2034	$path = normalise $path, $origin && $origin->path;
1185	my $key = $path->as_string;
1186		2035
		2036	cf::lock_wait "map_data:$path";#d#remove
1187	cf::lock_wait "map_find:$key";	2037	cf::lock_wait "map_find:$path";
1188		2038
1189	$cf::MAP{$key} || do {	2039	$cf::MAP{$path} || do {
		2040	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1190	my $guard = cf::lock_acquire "map_find:$key";	2041	my $guard2 = cf::lock_acquire "map_find:$path";
1191		2042
1192	# do it the slow way	2043	my $map = new_from_path cf::map $path
1193	my $map = try_load_header $path->save_path;
1194
1195	Coro::cede;
1196
1197	if ($map) {
1198	$map->last_access ((delete $map->{last_access})
1199	|| $cf::RUNTIME); #d#
1200	# safety
1201	$map->{instantiate_time} = $cf::RUNTIME
1202	if $map->{instantiate_time} > $cf::RUNTIME;
1203	} else {
1204	if (my $rmp = $path->random_map_params) {
1205	$map = generate_random_map $key, $rmp;
1206	} else {
1207	$map = try_load_header $path->load_path;
1208	}
1209
1210	$map or return;	2044	or return;
1211		2045
1212	$map->{load_original} = 1;
1213	$map->{instantiate_time} = $cf::RUNTIME;
1214	$map->last_access ($cf::RUNTIME);
1215	$map->instantiate;
1216
1217	# per-player maps become, after loading, normal maps
1218	$map->per_player (0) if $path->{user_rel};
1219	}
1220
1221	$map->path ($key);
1222	$map->{path} = $path;
1223	$map->{last_save} = $cf::RUNTIME;	2046	$map->{last_save} = $cf::RUNTIME;
1224		2047
1225	Coro::cede;	2048	$map->load_header
		2049	or return;
1226		2050
1227	if ($map->should_reset) {	2051	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2052	# doing this can freeze the server in a sync job, obviously
		2053	#$cf::WAIT_FOR_TICK->wait;
		2054	undef $guard2;
		2055	undef $guard1;
1228	$map->reset;	2056	$map->reset;
1229	undef $guard;
1230	$map = find $path	2057	return find $path;
1231	or return;
1232	}	2058	}
1233		2059
1234	$cf::MAP{$key} = $map	2060	$cf::MAP{$path} = $map
1235	}	2061	}
1236	}	2062	}
		2063
		2064	sub pre_load { }
		2065	sub post_load { }
1237		2066
1238	sub load {	2067	sub load {
1239	my ($self) = @_;	2068	my ($self) = @_;
1240		2069
		2070	local $self->{deny_reset} = 1; # loading can take a long time
		2071
1241	my $path = $self->{path};	2072	my $path = $self->{path};
		2073
		2074	{
1242	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2075	my $guard = cf::lock_acquire "map_data:$path";
1243		2076
		2077	return unless $self->valid;
1244	return if $self->in_memory != cf::MAP_SWAPPED;	2078	return unless $self->in_memory == cf::MAP_SWAPPED;
1245		2079
1246	$self->in_memory (cf::MAP_LOADING);	2080	$self->in_memory (cf::MAP_LOADING);
1247		2081
1248	$self->alloc;	2082	$self->alloc;
1249	$self->load_objects ($self->{load_path}, 1)	2083
		2084	$self->pre_load;
		2085	cf::cede_to_tick;
		2086
		2087	my $f = new_from_file cf::object::thawer $self->{load_path};
		2088	$f->skip_block;
		2089	$self->_load_objects ($f)
1250	or return;	2090	or return;
1251		2091
1252	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2092	$self->post_load_original
1253	if delete $self->{load_original};	2093	if delete $self->{load_original};
1254		2094
1255	if (my $uniq = $path->uniq_path) {	2095	if (my $uniq = $self->uniq_path) {
1256	utf8::encode $uniq;	2096	utf8::encode $uniq;
1257	if (aio_open $uniq, O_RDONLY, 0) {	2097	unless (aio_stat $uniq) {
		2098	if (my $f = new_from_file cf::object::thawer $uniq) {
1258	$self->clear_unique_items;	2099	$self->clear_unique_items;
1259	$self->load_objects ($uniq, 0);	2100	$self->_load_objects ($f);
		2101	$f->resolve_delayed_derefs;
		2102	}
1260	}	2103	}
1261	}	2104	}
1262		2105
1263	Coro::cede;	2106	$f->resolve_delayed_derefs;
1264		2107
		2108	cf::cede_to_tick;
1265	# now do the right thing for maps	2109	# now do the right thing for maps
1266	$self->link_multipart_objects;	2110	$self->link_multipart_objects;
1267
1268	if ($self->{path}->is_style_map) {
1269	$self->{deny_save} = 1;
1270	$self->{deny_reset} = 1;
1271	} else {
1272	$self->fix_auto_apply;
1273	$self->decay_objects;
1274	$self->update_buttons;
1275	$self->set_darkness_map;
1276	$self->difficulty ($self->estimate_difficulty)	2111	$self->difficulty ($self->estimate_difficulty)
1277	unless $self->difficulty;	2112	unless $self->difficulty;
		2113	cf::cede_to_tick;
		2114
		2115	unless ($self->{deny_activate}) {
		2116	$self->decay_objects;
		2117	$self->fix_auto_apply;
		2118	$self->update_buttons;
		2119	cf::cede_to_tick;
		2120	$self->set_darkness_map;
		2121	cf::cede_to_tick;
1278	$self->activate;	2122	$self->activate;
1279	}	2123	}
1280		2124
1281	Coro::cede;	2125	$self->{last_save} = $cf::RUNTIME;
		2126	$self->last_access ($cf::RUNTIME);
1282		2127
1283	$self->in_memory (cf::MAP_IN_MEMORY);	2128	$self->in_memory (cf::MAP_ACTIVE);
		2129	}
		2130
		2131	$self->post_load;
		2132	}
		2133
		2134	sub customise_for {
		2135	my ($self, $ob) = @_;
		2136
		2137	return find "~" . $ob->name . "/" . $self->{path}
		2138	if $self->per_player;
		2139
		2140	# return find "?party/" . $ob->name . "/" . $self->{path}
		2141	# if $self->per_party;
		2142
		2143	$self
		2144	}
		2145
		2146	# find and load all maps in the 3x3 area around a map
		2147	sub load_neighbours {
		2148	my ($map) = @_;
		2149
		2150	my @neigh; # diagonal neighbours
		2151
		2152	for (0 .. 3) {
		2153	my $neigh = $map->tile_path ($_)
		2154	or next;
		2155	$neigh = find $neigh, $map
		2156	or next;
		2157	$neigh->load;
		2158
		2159	push @neigh,
		2160	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2161	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2162	}
		2163
		2164	for (grep defined $_->[0], @neigh) {
		2165	my ($path, $origin) = @$_;
		2166	my $neigh = find $path, $origin
		2167	or next;
		2168	$neigh->load;
		2169	}
1284	}	2170	}
1285		2171
1286	sub find_sync {	2172	sub find_sync {
1287	my ($path, $origin) = @_;	2173	my ($path, $origin) = @_;
1288		2174
1289	cf::sync_job { cf::map::find $path, $origin }	2175	cf::sync_job { find $path, $origin }
1290	}	2176	}
1291		2177
1292	sub do_load_sync {	2178	sub do_load_sync {
1293	my ($map) = @_;	2179	my ($map) = @_;
1294		2180
		2181	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2182	if $Coro::current == $Coro::main;
		2183
1295	cf::sync_job { $map->load };	2184	cf::sync_job { $map->load };
		2185	}
		2186
		2187	our %MAP_PREFETCH;
		2188	our $MAP_PREFETCHER = undef;
		2189
		2190	sub find_async {
		2191	my ($path, $origin, $load) = @_;
		2192
		2193	$path = normalise $path, $origin && $origin->{path};
		2194
		2195	if (my $map = $cf::MAP{$path}) {
		2196	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2197	}
		2198
		2199	$MAP_PREFETCH{$path} |= $load;
		2200
		2201	$MAP_PREFETCHER ||= cf::async {
		2202	$Coro::current->{desc} = "map prefetcher";
		2203
		2204	while (%MAP_PREFETCH) {
		2205	while (my ($k, $v) = each %MAP_PREFETCH) {
		2206	if (my $map = find $k) {
		2207	$map->load if $v;
		2208	}
		2209
		2210	delete $MAP_PREFETCH{$k};
		2211	}
		2212	}
		2213	undef $MAP_PREFETCHER;
		2214	};
		2215	$MAP_PREFETCHER->prio (6);
		2216
		2217	()
1296	}	2218	}
1297		2219
1298	sub save {	2220	sub save {
1299	my ($self) = @_;	2221	my ($self) = @_;
1300		2222
1301	my $lock = cf::lock_acquire "map_data:" . $self->path;	2223	my $lock = cf::lock_acquire "map_data:$self->{path}";
1302		2224
1303	$self->{last_save} = $cf::RUNTIME;	2225	$self->{last_save} = $cf::RUNTIME;
1304		2226
1305	return unless $self->dirty;	2227	return unless $self->dirty;
1306		2228
1307	my $save = $self->{path}->save_path; utf8::encode $save;	2229	my $save = $self->save_path; utf8::encode $save;
1308	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2230	my $uniq = $self->uniq_path; utf8::encode $uniq;
1309		2231
1310	$self->{load_path} = $save;	2232	$self->{load_path} = $save;
1311		2233
1312	return if $self->{deny_save};	2234	return if $self->{deny_save};
1313		2235
1314	local $self->{last_access} = $self->last_access;#d#	2236	local $self->{last_access} = $self->last_access;#d#
1315		2237
		2238	cf::async {
		2239	$Coro::current->{desc} = "map player save";
		2240	$_->contr->save for $self->players;
		2241	};
		2242
		2243	cf::get_slot 0.02;
		2244
1316	if ($uniq) {	2245	if ($uniq) {
1317	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2246	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318	$self->save_objects ($uniq, cf::IO_UNIQUES);	2247	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1319	} else {	2248	} else {
1320	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2249	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1321	}	2250	}
1322	}	2251	}
1323		2252
1324	sub swap_out {	2253	sub swap_out {
1325	my ($self) = @_;	2254	my ($self) = @_;
1326		2255
1327	# save first because save cedes	2256	# save first because save cedes
1328	$self->save;	2257	$self->save;
1329		2258
1330	my $lock = cf::lock_acquire "map_data:" . $self->path;	2259	my $lock = cf::lock_acquire "map_data:$self->{path}";
1331		2260
1332	return if $self->players;	2261	return if $self->players;
1333	return if $self->in_memory != cf::MAP_IN_MEMORY;	2262	return if $self->in_memory != cf::MAP_ACTIVE;
1334	return if $self->{deny_save};	2263	return if $self->{deny_save};
1335		2264
		2265	$self->in_memory (cf::MAP_SWAPPED);
		2266
		2267	$self->deactivate;
		2268	$_->clear_links_to ($self) for values %cf::MAP;
1336	$self->clear;	2269	$self->clear;
1337	$self->in_memory (cf::MAP_SWAPPED);
1338	}	2270	}
1339		2271
1340	sub reset_at {	2272	sub reset_at {
1341	my ($self) = @_;	2273	my ($self) = @_;
1342		2274
1343	# TODO: safety, remove and allow resettable per-player maps	2275	# TODO: safety, remove and allow resettable per-player maps
1344	return 1e99 if $self->{path}{user_rel};
1345	return 1e99 if $self->{deny_reset};	2276	return 1e99 if $self->{deny_reset};
1346		2277
1347	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2278	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1348	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2279	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1349		2280
…		…
1354	my ($self) = @_;	2285	my ($self) = @_;
1355		2286
1356	$self->reset_at <= $cf::RUNTIME	2287	$self->reset_at <= $cf::RUNTIME
1357	}	2288	}
1358		2289
1359	sub unlink_save {
1360	my ($self) = @_;
1361
1362	utf8::encode (my $save = $self->{path}->save_path);
1363	aioreq_pri 3; IO::AIO::aio_unlink $save;
1364	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1365	}
1366
1367	sub rename {
1368	my ($self, $new_path) = @_;
1369
1370	$self->unlink_save;
1371
1372	delete $cf::MAP{$self->path};
1373	$self->{path} = new cf::path $new_path;
1374	$self->path ($self->{path}->as_string);
1375	$cf::MAP{$self->path} = $self;
1376
1377	$self->save;
1378	}
1379
1380	sub reset {	2290	sub reset {
1381	my ($self) = @_;	2291	my ($self) = @_;
1382		2292
1383	my $lock = cf::lock_acquire "map_data:" . $self->path;	2293	my $lock = cf::lock_acquire "map_data:$self->{path}";
1384		2294
1385	return if $self->players;	2295	return if $self->players;
1386	return if $self->{path}{user_rel};#d#
1387		2296
1388	warn "resetting map ", $self->path;#d#	2297	warn "resetting map ", $self->path;
		2298
		2299	$self->in_memory (cf::MAP_SWAPPED);
		2300
		2301	# need to save uniques path
		2302	unless ($self->{deny_save}) {
		2303	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2304
		2305	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2306	if $uniq;
		2307	}
1389		2308
1390	delete $cf::MAP{$self->path};	2309	delete $cf::MAP{$self->path};
1391		2310
		2311	$self->deactivate;
1392	$_->clear_links_to ($self) for values %cf::MAP;	2312	$_->clear_links_to ($self) for values %cf::MAP;
		2313	$self->clear;
1393		2314
1394	$self->unlink_save;	2315	$self->unlink_save;
1395	$self->destroy;	2316	$self->destroy;
1396	}	2317	}
1397		2318
1398	my $nuke_counter = "aaaa";	2319	my $nuke_counter = "aaaa";
1399		2320
1400	sub nuke {	2321	sub nuke {
1401	my ($self) = @_;	2322	my ($self) = @_;
1402		2323
		2324	{
		2325	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2326
		2327	delete $cf::MAP{$self->path};
		2328
		2329	$self->unlink_save;
		2330
		2331	bless $self, "cf::map";
		2332	delete $self->{deny_reset};
1403	$self->{deny_save} = 1;	2333	$self->{deny_save} = 1;
1404	$self->reset_timeout (1);	2334	$self->reset_timeout (1);
1405	$self->rename ("{nuke}/" . ($nuke_counter++));	2335	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2336
		2337	$cf::MAP{$self->path} = $self;
		2338	}
		2339
1406	$self->reset; # polite request, might not happen	2340	$self->reset; # polite request, might not happen
1407	}	2341	}
1408		2342
1409	sub customise_for {	2343	=item $maps = cf::map::tmp_maps
1410	my ($map, $ob) = @_;
1411		2344
1412	if ($map->per_player) {	2345	Returns an arrayref with all map paths of currently instantiated and saved
1413	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2346	maps. May block.
		2347
		2348	=cut
		2349
		2350	sub tmp_maps() {
1414	}	2351	[
1415		2352	map {
1416	$map	2353	utf8::decode $_;
		2354	/\.map$/
		2355	? normalise $_
		2356	: ()
		2357	} @{ aio_readdir $TMPDIR or [] }
		2358	]
1417	}	2359	}
1418		2360
1419	sub emergency_save {	2361	=item $maps = cf::map::random_maps
1420	my $freeze_guard = cf::freeze_mainloop;
1421		2362
1422	warn "enter emergency map save\n";	2363	Returns an arrayref with all map paths of currently instantiated and saved
		2364	random maps. May block.
1423		2365
1424	cf::sync_job {	2366	=cut
1425	warn "begin emergency map save\n";	2367
1426	$_->save for values %cf::MAP;	2368	sub random_maps() {
		2369	[
		2370	map {
		2371	utf8::decode $_;
		2372	/\.map$/
		2373	? normalise "?random/$_"
		2374	: ()
		2375	} @{ aio_readdir $RANDOMDIR or [] }
		2376	]
		2377	}
		2378
		2379	=item cf::map::unique_maps
		2380
		2381	Returns an arrayref of paths of all shared maps that have
		2382	instantiated unique items. May block.
		2383
		2384	=cut
		2385
		2386	sub unique_maps() {
		2387	[
		2388	map {
		2389	utf8::decode $_;
		2390	s/\.map$//; # TODO future compatibility hack
		2391	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2392	? ()
		2393	: normalise $_
		2394	} @{ aio_readdir $UNIQUEDIR or [] }
		2395	]
		2396	}
		2397
		2398	=back
		2399
		2400	=head3 cf::object
		2401
		2402	=cut
		2403
		2404	package cf::object;
		2405
		2406	=over 4
		2407
		2408	=item $ob->inv_recursive
		2409
		2410	Returns the inventory of the object I<and> their inventories, recursively,
		2411	but I<not> the object itself.
		2412
		2413	=cut
		2414
		2415	sub inv_recursive_;
		2416	sub inv_recursive_ {
		2417	map { $_, inv_recursive_ $_->inv } @_
		2418	}
		2419
		2420	sub inv_recursive {
		2421	inv_recursive_ inv $_[0]
		2422	}
		2423
		2424	=item $ref = $ob->ref
		2425
		2426	Creates and returns a persistent reference to an object that can be stored as a string.
		2427
		2428	=item $ob = cf::object::deref ($refstring)
		2429
		2430	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2431	even if the object actually exists. May block.
		2432
		2433	=cut
		2434
		2435	sub deref {
		2436	my ($ref) = @_;
		2437
		2438	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2439	my ($uuid, $name) = ($1, $2);
		2440	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2441	or return;
		2442	$pl->ob->uuid eq $uuid
		2443	or return;
		2444
		2445	$pl->ob
		2446	} else {
		2447	warn "$ref: cannot resolve object reference\n";
		2448	undef
1427	};	2449	}
1428
1429	warn "end emergency map save\n";
1430	}	2450	}
1431		2451
1432	package cf;	2452	package cf;
1433		2453
1434	=back	2454	=back
1435
1436		2455
1437	=head3 cf::object::player	2456	=head3 cf::object::player
1438		2457
1439	=over 4	2458	=over 4
1440		2459
…		…
1443	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2462	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1444	can be C<undef>. Does the right thing when the player is currently in a	2463	can be C<undef>. Does the right thing when the player is currently in a
1445	dialogue with the given NPC character.	2464	dialogue with the given NPC character.
1446		2465
1447	=cut	2466	=cut
		2467
		2468	our $SAY_CHANNEL = {
		2469	id => "say",
		2470	title => "Map",
		2471	reply => "say ",
		2472	tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
		2473	};
		2474
		2475	our $CHAT_CHANNEL = {
		2476	id => "chat",
		2477	title => "Chat",
		2478	reply => "chat ",
		2479	tooltip => "Player chat and shouts, global to the server.",
		2480	};
1448		2481
1449	# rough implementation of a future "reply" method that works	2482	# rough implementation of a future "reply" method that works
1450	# with dialog boxes.	2483	# with dialog boxes.
1451	#TODO: the first argument must go, split into a $npc->reply_to ( method	2484	#TODO: the first argument must go, split into a $npc->reply_to ( method
1452	sub cf::object::player::reply($$$;$) {	2485	sub cf::object::player::reply($$$;$) {
…		…
1454		2487
1455	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2488	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1456		2489
1457	if ($self->{record_replies}) {	2490	if ($self->{record_replies}) {
1458	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2491	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2492
1459	} else {	2493	} else {
		2494	my $pl = $self->contr;
		2495
		2496	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2497	my $dialog = $pl->{npc_dialog};
		2498	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2499
		2500	} else {
1460	$msg = $npc->name . " says: $msg" if $npc;	2501	$msg = $npc->name . " says: $msg" if $npc;
1461	$self->message ($msg, $flags);	2502	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2503	}
1462	}	2504	}
		2505	}
		2506
		2507	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2508
		2509	=cut
		2510
		2511	sub cf::object::send_msg {
		2512	my $pl = shift->contr
		2513	or return;
		2514	$pl->send_msg (@_);
1463	}	2515	}
1464		2516
1465	=item $player_object->may ("access")	2517	=item $player_object->may ("access")
1466		2518
1467	Returns wether the given player is authorized to access resource "access"	2519	Returns wether the given player is authorized to access resource "access"
…		…
1480		2532
1481	=item $player_object->enter_link	2533	=item $player_object->enter_link
1482		2534
1483	Freezes the player and moves him/her to a special map (C<{link}>).	2535	Freezes the player and moves him/her to a special map (C<{link}>).
1484		2536
1485	The player should be reaosnably safe there for short amounts of time. You	2537	The player should be reasonably safe there for short amounts of time. You
1486	I<MUST> call C<leave_link> as soon as possible, though.	2538	I<MUST> call C<leave_link> as soon as possible, though.
1487		2539
		2540	Will never block.
		2541
1488	=item $player_object->leave_link ($map, $x, $y)	2542	=item $player_object->leave_link ($map, $x, $y)
1489		2543
1490	Moves the player out of the specila link map onto the given map. If the	2544	Moves the player out of the special C<{link}> map onto the specified
1491	map is not valid (or omitted), the player will be moved back to the	2545	map. If the map is not valid (or omitted), the player will be moved back
1492	location he/she was before the call to C<enter_link>, or, if that fails,	2546	to the location he/she was before the call to C<enter_link>, or, if that
1493	to the emergency map position.	2547	fails, to the emergency map position.
1494		2548
1495	Might block.	2549	Might block.
1496		2550
1497	=cut	2551	=cut
		2552
		2553	sub link_map {
		2554	unless ($LINK_MAP) {
		2555	$LINK_MAP = cf::map::find "{link}"
		2556	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2557	$LINK_MAP->load;
		2558	}
		2559
		2560	$LINK_MAP
		2561	}
1498		2562
1499	sub cf::object::player::enter_link {	2563	sub cf::object::player::enter_link {
1500	my ($self) = @_;	2564	my ($self) = @_;
1501		2565
1502	$self->deactivate_recursive;	2566	$self->deactivate_recursive;
1503		2567
1504	return if $self->map == $LINK_MAP;	2568	return if UNIVERSAL::isa $self->map, "ext::map_link";
1505		2569
1506	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2570	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1507	if $self->map;	2571	if $self->map && $self->map->{path} ne "{link}";
1508		2572
1509	$self->enter_map ($LINK_MAP, 20, 20);	2573	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1510	}	2574	}
1511		2575
1512	sub cf::object::player::leave_link {	2576	sub cf::object::player::leave_link {
1513	my ($self, $map, $x, $y) = @_;	2577	my ($self, $map, $x, $y) = @_;
		2578
		2579	return unless $self->contr->active;
1514		2580
1515	my $link_pos = delete $self->{_link_pos};	2581	my $link_pos = delete $self->{_link_pos};
1516		2582
1517	unless ($map) {	2583	unless ($map) {
1518	# restore original map position	2584	# restore original map position
…		…
1532	# use -1 or undef as default coordinates, not 0, 0	2598	# use -1 or undef as default coordinates, not 0, 0
1533	($x, $y) = ($map->enter_x, $map->enter_y)	2599	($x, $y) = ($map->enter_x, $map->enter_y)
1534	if $x <=0 && $y <= 0;	2600	if $x <=0 && $y <= 0;
1535		2601
1536	$map->load;	2602	$map->load;
		2603	$map->load_neighbours;
1537		2604
		2605	return unless $self->contr->active;
1538	$self->activate_recursive;	2606	$self->activate_recursive;
		2607
		2608	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1539	$self->enter_map ($map, $x, $y);	2609	$self->enter_map ($map, $x, $y);
1540	}	2610	}
1541		2611
1542	cf::player->attach (	2612	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1543	on_logout => sub {
1544	my ($pl) = @_;
1545		2613
1546	# abort map switching before logout	2614	Moves the player to the given map-path and coordinates by first freezing
1547	if ($pl->ob->{_link_pos}) {	2615	her, loading and preparing them map, calling the provided $check callback
1548	cf::sync_job {	2616	that has to return the map if sucecssful, and then unfreezes the player on
1549	$pl->ob->leave_link	2617	the new (success) or old (failed) map position. In either case, $done will
1550	};	2618	be called at the end of this process.
1551	}
1552	},
1553	on_login => sub {
1554	my ($pl) = @_;
1555		2619
1556	# try to abort aborted map switching on player login :)	2620	Note that $check will be called with a potentially non-loaded map, so if
1557	# should happen only on crashes	2621	it needs a loaded map it has to call C<< ->load >>.
1558	if ($pl->ob->{_link_pos}) {
1559	$pl->ob->enter_link;
1560	cf::async {
1561	# we need this sleep as the login has a concurrent enter_exit running
1562	# and this sleep increases chances of the player not ending up in scorn
1563	Coro::Timer::sleep 1;
1564	$pl->ob->leave_link;
1565	};
1566	}
1567	},
1568	);
1569		2622
1570	=item $player_object->goto ($path, $x, $y)
1571
1572	=cut	2623	=cut
		2624
		2625	our $GOTOGEN;
1573		2626
1574	sub cf::object::player::goto {	2627	sub cf::object::player::goto {
1575	my ($self, $path, $x, $y) = @_;	2628	my ($self, $path, $x, $y, $check, $done) = @_;
		2629
		2630	# do generation counting so two concurrent goto's will be executed in-order
		2631	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1576		2632
1577	$self->enter_link;	2633	$self->enter_link;
1578		2634
1579	(cf::async {	2635	(async {
1580	$path = new cf::path $path;	2636	$Coro::current->{desc} = "player::goto $path $x $y";
1581		2637
1582	my $map = cf::map::find $path->as_string;	2638	# *tag paths override both path and x|y
		2639	if ($path =~ /^\*(.*)$/) {
		2640	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2641	my $ob = $obs[rand @obs];
		2642
		2643	# see if we actually can go there
		2644	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2645	$ob = $obs[rand @obs];
		2646	} else {
		2647	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2648	}
		2649	# else put us there anyways for now #d#
		2650
		2651	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2652	} else {
		2653	($path, $x, $y) = (undef, undef, undef);
		2654	}
		2655	}
		2656
		2657	my $map = eval {
		2658	my $map = defined $path ? cf::map::find $path : undef;
		2659
		2660	if ($map) {
1583	$map = $map->customise_for ($self) if $map;	2661	$map = $map->customise_for ($self);
1584		2662	$map = $check->($map) if $check && $map;
1585	# warn "entering ", $map->path, " at ($x, $y)\n"	2663	} else {
1586	# if $map;
1587
1588	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2664	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2665	}
1589		2666
		2667	$map
		2668	};
		2669
		2670	if ($@) {
		2671	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2672	LOG llevError | logBacktrace, Carp::longmess $@;
		2673	}
		2674
		2675	if ($gen == $self->{_goto_generation}) {
		2676	delete $self->{_goto_generation};
1590	$self->leave_link ($map, $x, $y);	2677	$self->leave_link ($map, $x, $y);
		2678	}
		2679
		2680	$done->() if $done;
1591	})->prio (1);	2681	})->prio (1);
1592	}	2682	}
1593		2683
1594	=item $player_object->enter_exit ($exit_object)	2684	=item $player_object->enter_exit ($exit_object)
1595		2685
…		…
1597		2687
1598	sub parse_random_map_params {	2688	sub parse_random_map_params {
1599	my ($spec) = @_;	2689	my ($spec) = @_;
1600		2690
1601	my $rmp = { # defaults	2691	my $rmp = { # defaults
1602	xsize => 10,	2692	xsize => (cf::rndm 15, 40),
1603	ysize => 10,	2693	ysize => (cf::rndm 15, 40),
		2694	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2695	#layout => string,
1604	};	2696	};
1605		2697
1606	for (split /\n/, $spec) {	2698	for (split /\n/, $spec) {
1607	my ($k, $v) = split /\s+/, $_, 2;	2699	my ($k, $v) = split /\s+/, $_, 2;
1608		2700
…		…
1620	# that depends on the exit object	2712	# that depends on the exit object
1621		2713
1622	my $rmp = parse_random_map_params $exit->msg;	2714	my $rmp = parse_random_map_params $exit->msg;
1623		2715
1624	if ($exit->map) {	2716	if ($exit->map) {
1625	$rmp->{region} = $exit->map->region_name;	2717	$rmp->{region} = $exit->region->name;
1626	$rmp->{origin_map} = $exit->map->path;	2718	$rmp->{origin_map} = $exit->map->path;
1627	$rmp->{origin_x} = $exit->x;	2719	$rmp->{origin_x} = $exit->x;
1628	$rmp->{origin_y} = $exit->y;	2720	$rmp->{origin_y} = $exit->y;
		2721
		2722	$exit->map->touch;
1629	}	2723	}
1630		2724
1631	$rmp->{random_seed} ||= $exit->random_seed;	2725	$rmp->{random_seed} ||= $exit->random_seed;
1632		2726
1633	my $data = cf::to_json $rmp;	2727	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1634	my $md5 = Digest::MD5::md5_hex $data;	2728	my $md5 = Digest::MD5::md5_hex $data;
		2729	my $meta = "$RANDOMDIR/$md5.meta";
1635		2730
1636	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2731	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1637	aio_write $fh, 0, (length $data), $data, 0;	2732	aio_write $fh, 0, (length $data), $data, 0;
		2733	undef $fh;
		2734	aio_rename "$meta~", $meta;
1638		2735
		2736	my $slaying = "?random/$md5";
		2737
		2738	if ($exit->valid) {
1639	$exit->slaying ("?random/$md5");	2739	$exit->slaying ("?random/$md5");
1640	$exit->msg (undef);	2740	$exit->msg (undef);
		2741	}
1641	}	2742	}
1642	}	2743	}
1643		2744
1644	sub cf::object::player::enter_exit {	2745	sub cf::object::player::enter_exit {
1645	my ($self, $exit) = @_;	2746	my ($self, $exit) = @_;
1646		2747
1647	return unless $self->type == cf::PLAYER;	2748	return unless $self->type == cf::PLAYER;
1648		2749
1649	$self->enter_link;	2750	$self->enter_link;
1650		2751
1651	(cf::async {	2752	(async {
1652	$self->deactivate_recursive; # just to be sure	2753	$Coro::current->{desc} = "enter_exit";
		2754
1653	unless (eval {	2755	unless (eval {
		2756	$self->deactivate_recursive; # just to be sure
		2757
		2758	# random map handling
		2759	{
		2760	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2761
1654	prepare_random_map $exit	2762	prepare_random_map $exit
1655	if $exit->slaying eq "/!";	2763	if $exit->slaying eq "/!";
		2764	}
1656		2765
1657	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2766	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1658	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2767	my $x = $exit->stats->hp;
		2768	my $y = $exit->stats->sp;
1659		2769
		2770	$self->goto ($map, $x, $y);
		2771
		2772	# if exit is damned, update players death & WoR home-position
		2773	$self->contr->savebed ($map, $x, $y)
		2774	if $exit->flag (cf::FLAG_DAMNED);
		2775
1660	1;	2776	1
1661	}) {	2777	}) {
1662	$self->message ("Something went wrong deep within the crossfire server. "	2778	$self->message ("Something went wrong deep within the crossfire server. "
1663	. "I'll try to bring you back to the map you were before. "	2779	. "I'll try to bring you back to the map you were before. "
1664	. "Please report this to the dungeon master",	2780	. "Please report this to the dungeon master!",
1665	cf::NDI_UNIQUE | cf::NDI_RED);	2781	cf::NDI_UNIQUE | cf::NDI_RED);
1666		2782
1667	warn "ERROR in enter_exit: $@";	2783	warn "ERROR in enter_exit: $@";
1668	$self->leave_link;	2784	$self->leave_link;
1669	}	2785	}
1670	})->prio (1);	2786	})->prio (1);
…		…
1683		2799
1684	sub cf::client::send_drawinfo {	2800	sub cf::client::send_drawinfo {
1685	my ($self, $text, $flags) = @_;	2801	my ($self, $text, $flags) = @_;
1686		2802
1687	utf8::encode $text;	2803	utf8::encode $text;
1688	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2804	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1689	}	2805	}
1690		2806
		2807	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2808
		2809	Send a drawinfo or msg packet to the client, formatting the msg for the
		2810	client if neccessary. C<$type> should be a string identifying the type of
		2811	the message, with C<log> being the default. If C<$color> is negative, suppress
		2812	the message unless the client supports the msg packet.
		2813
		2814	=cut
		2815
		2816	# non-persistent channels (usually the info channel)
		2817	our %CHANNEL = (
		2818	"c/identify" => {
		2819	id => "infobox",
		2820	title => "Identify",
		2821	reply => undef,
		2822	tooltip => "Items recently identified",
		2823	},
		2824	"c/examine" => {
		2825	id => "infobox",
		2826	title => "Examine",
		2827	reply => undef,
		2828	tooltip => "Signs and other items you examined",
		2829	},
		2830	"c/book" => {
		2831	id => "infobox",
		2832	title => "Book",
		2833	reply => undef,
		2834	tooltip => "The contents of a note or book",
		2835	},
		2836	"c/lookat" => {
		2837	id => "infobox",
		2838	title => "Look",
		2839	reply => undef,
		2840	tooltip => "What you saw there",
		2841	},
		2842	"c/who" => {
		2843	id => "infobox",
		2844	title => "Players",
		2845	reply => undef,
		2846	tooltip => "Shows players who are currently online",
		2847	},
		2848	"c/body" => {
		2849	id => "infobox",
		2850	title => "Body Parts",
		2851	reply => undef,
		2852	tooltip => "Shows which body parts you posess and are available",
		2853	},
		2854	"c/uptime" => {
		2855	id => "infobox",
		2856	title => "Uptime",
		2857	reply => undef,
		2858	tooltip => "How long the server has been running since last restart",
		2859	},
		2860	"c/mapinfo" => {
		2861	id => "infobox",
		2862	title => "Map Info",
		2863	reply => undef,
		2864	tooltip => "Information related to the maps",
		2865	},
		2866	"c/party" => {
		2867	id => "party",
		2868	title => "Party",
		2869	reply => "gsay ",
		2870	tooltip => "Messages and chat related to your party",
		2871	},
		2872	);
		2873
		2874	sub cf::client::send_msg {
		2875	my ($self, $channel, $msg, $color, @extra) = @_;
		2876
		2877	$msg = $self->pl->expand_cfpod ($msg);
		2878
		2879	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2880
		2881	# check predefined channels, for the benefit of C
		2882	if ($CHANNEL{$channel}) {
		2883	$channel = $CHANNEL{$channel};
		2884
		2885	$self->ext_msg (channel_info => $channel)
		2886	if $self->can_msg;
		2887
		2888	$channel = $channel->{id};
		2889
		2890	} elsif (ref $channel) {
		2891	# send meta info to client, if not yet sent
		2892	unless (exists $self->{channel}{$channel->{id}}) {
		2893	$self->{channel}{$channel->{id}} = $channel;
		2894	$self->ext_msg (channel_info => $channel)
		2895	if $self->can_msg;
		2896	}
		2897
		2898	$channel = $channel->{id};
		2899	}
		2900
		2901	return unless @extra || length $msg;
		2902
		2903	if ($self->can_msg) {
		2904	# default colour, mask it out
		2905	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2906	if $color & cf::NDI_DEF;
		2907
		2908	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2909	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2910	} else {
		2911	if ($color >= 0) {
		2912	# replace some tags by gcfclient-compatible ones
		2913	for ($msg) {
		2914	1 while
		2915	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2916	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2917	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2918	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2919	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2920	}
		2921
		2922	$color &= cf::NDI_COLOR_MASK;
		2923
		2924	utf8::encode $msg;
		2925
		2926	if (0 && $msg =~ /\[/) {
		2927	# COMMAND/INFO
		2928	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2929	} else {
		2930	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2931	$self->send_packet ("drawinfo $color $msg")
		2932	}
		2933	}
		2934	}
		2935	}
		2936
		2937	=item $client->ext_msg ($type, @msg)
		2938
		2939	Sends an ext event to the client.
		2940
		2941	=cut
		2942
		2943	sub cf::client::ext_msg($$@) {
		2944	my ($self, $type, @msg) = @_;
		2945
		2946	if ($self->extcmd == 2) {
		2947	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2948	} elsif ($self->extcmd == 1) { # TODO: remove
		2949	push @msg, msgtype => "event_$type";
		2950	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2951	}
		2952	}
		2953
		2954	=item $client->ext_reply ($msgid, @msg)
		2955
		2956	Sends an ext reply to the client.
		2957
		2958	=cut
		2959
		2960	sub cf::client::ext_reply($$@) {
		2961	my ($self, $id, @msg) = @_;
		2962
		2963	if ($self->extcmd == 2) {
		2964	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2965	} elsif ($self->extcmd == 1) {
		2966	#TODO: version 1, remove
		2967	unshift @msg, msgtype => "reply", msgid => $id;
		2968	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2969	}
		2970	}
1691		2971
1692	=item $success = $client->query ($flags, "text", \&cb)	2972	=item $success = $client->query ($flags, "text", \&cb)
1693		2973
1694	Queues a query to the client, calling the given callback with	2974	Queues a query to the client, calling the given callback with
1695	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2975	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1696	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2976	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1697		2977
1698	Queries can fail, so check the return code. Or don't, as queries will become	2978	Queries can fail, so check the return code. Or don't, as queries will
1699	reliable at some point in the future.	2979	become reliable at some point in the future.
1700		2980
1701	=cut	2981	=cut
1702		2982
1703	sub cf::client::query {	2983	sub cf::client::query {
1704	my ($self, $flags, $text, $cb) = @_;	2984	my ($self, $flags, $text, $cb) = @_;
…		…
1712	utf8::encode $text;	2992	utf8::encode $text;
1713	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2993	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1714		2994
1715	$self->send_packet ($self->{query_queue}[0][0])	2995	$self->send_packet ($self->{query_queue}[0][0])
1716	if @{ $self->{query_queue} } == 1;	2996	if @{ $self->{query_queue} } == 1;
		2997
		2998	1
1717	}	2999	}
1718		3000
1719	cf::client->attach (	3001	cf::client->attach (
		3002	on_connect => sub {
		3003	my ($ns) = @_;
		3004
		3005	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3006	},
1720	on_reply => sub {	3007	on_reply => sub {
1721	my ($ns, $msg) = @_;	3008	my ($ns, $msg) = @_;
1722		3009
1723	# this weird shuffling is so that direct followup queries	3010	# this weird shuffling is so that direct followup queries
1724	# get handled first	3011	# get handled first
1725	my $queue = delete $ns->{query_queue}	3012	my $queue = delete $ns->{query_queue}
1726	or return; # be conservative, not sure how that can happen, but we saw a crash here	3013	or return; # be conservative, not sure how that can happen, but we saw a crash here
1727		3014
1728	(shift @$queue)->[1]->($msg);	3015	(shift @$queue)->[1]->($msg);
		3016	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1729		3017
1730	push @{ $ns->{query_queue} }, @$queue;	3018	push @{ $ns->{query_queue} }, @$queue;
1731		3019
1732	if (@{ $ns->{query_queue} } == @$queue) {	3020	if (@{ $ns->{query_queue} } == @$queue) {
1733	if (@$queue) {	3021	if (@$queue) {
…		…
1735	} else {	3023	} else {
1736	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3024	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1737	}	3025	}
1738	}	3026	}
1739	},	3027	},
		3028	on_exticmd => sub {
		3029	my ($ns, $buf) = @_;
		3030
		3031	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3032
		3033	if (ref $msg) {
		3034	my ($type, $reply, @payload) =
		3035	"ARRAY" eq ref $msg
		3036	? @$msg
		3037	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3038
		3039	my @reply;
		3040
		3041	if (my $cb = $EXTICMD{$type}) {
		3042	@reply = $cb->($ns, @payload);
		3043	}
		3044
		3045	$ns->ext_reply ($reply, @reply)
		3046	if $reply;
		3047
		3048	} else {
		3049	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3050	}
		3051
		3052	cf::override;
		3053	},
1740	);	3054	);
1741		3055
1742	=item $client->coro (\&cb)	3056	=item $client->async (\&cb)
1743		3057
1744	Create a new coroutine, running the specified callback. The coroutine will	3058	Create a new coroutine, running the specified callback. The coroutine will
1745	be automatically cancelled when the client gets destroyed (e.g. on logout,	3059	be automatically cancelled when the client gets destroyed (e.g. on logout,
1746	or loss of connection).	3060	or loss of connection).
1747		3061
1748	=cut	3062	=cut
1749		3063
1750	sub cf::client::coro {	3064	sub cf::client::async {
1751	my ($self, $cb) = @_;	3065	my ($self, $cb) = @_;
1752		3066
1753	my $coro = &cf::async ($cb);	3067	my $coro = &Coro::async ($cb);
1754		3068
1755	$coro->on_destroy (sub {	3069	$coro->on_destroy (sub {
1756	delete $self->{_coro}{$coro+0};	3070	delete $self->{_coro}{$coro+0};
1757	});	3071	});
1758		3072
…		…
1785	our $safe = new Safe "safe";	3099	our $safe = new Safe "safe";
1786	our $safe_hole = new Safe::Hole;	3100	our $safe_hole = new Safe::Hole;
1787		3101
1788	$SIG{FPE} = 'IGNORE';	3102	$SIG{FPE} = 'IGNORE';
1789		3103
1790	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3104	$safe->permit_only (Opcode::opset qw(
		3105	:base_core :base_mem :base_orig :base_math
		3106	grepstart grepwhile mapstart mapwhile
		3107	sort time
		3108	));
1791		3109
1792	# here we export the classes and methods available to script code	3110	# here we export the classes and methods available to script code
1793		3111
1794	=pod	3112	=pod
1795		3113
1796	The following fucntions and emthods are available within a safe environment:	3114	The following functions and methods are available within a safe environment:
1797		3115
1798	cf::object contr pay_amount pay_player map	3116	cf::object
		3117	contr pay_amount pay_player map x y force_find force_add destroy
		3118	insert remove name archname title slaying race decrease split
		3119
1799	cf::object::player player	3120	cf::object::player
1800	cf::player peaceful	3121	player
1801	cf::map trigger	3122
		3123	cf::player
		3124	peaceful
		3125
		3126	cf::map
		3127	trigger
1802		3128
1803	=cut	3129	=cut
1804		3130
1805	for (	3131	for (
1806	["cf::object" => qw(contr pay_amount pay_player map)],	3132	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3133	insert remove inv nrof name archname title slaying race
		3134	decrease split destroy change_exp)],
1807	["cf::object::player" => qw(player)],	3135	["cf::object::player" => qw(player)],
1808	["cf::player" => qw(peaceful)],	3136	["cf::player" => qw(peaceful)],
1809	["cf::map" => qw(trigger)],	3137	["cf::map" => qw(trigger)],
1810	) {	3138	) {
1811	no strict 'refs';	3139	no strict 'refs';
…		…
1882	=back	3210	=back
1883		3211
1884	=cut	3212	=cut
1885		3213
1886	#############################################################################	3214	#############################################################################
		3215	# the server's init and main functions
1887		3216
1888	=head2 EXTENSION DATABASE SUPPORT	3217	sub load_facedata($) {
		3218	my ($path) = @_;
1889		3219
1890	Crossfire maintains a very simple database for extension use. It can	3220	# HACK to clear player env face cache, we need some signal framework
1891	currently store anything that can be serialised using Storable, which	3221	# for this (global event?)
1892	excludes objects.	3222	%ext::player_env::MUSIC_FACE_CACHE = ();
1893		3223
1894	The parameter C<$family> should best start with the name of the extension	3224	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1895	using it, it should be unique.
1896		3225
1897	=over 4	3226	warn "loading facedata from $path\n";
1898		3227
1899	=item $hashref = cf::db_get $family	3228	my $facedata;
		3229	0 < aio_load $path, $facedata
		3230	or die "$path: $!";
1900		3231
1901	Return a hashref for use by the extension C<$family>, which can be	3232	$facedata = Coro::Storable::thaw $facedata;
1902	modified. After modifications, you have to call C<cf::db_dirty> or
1903	C<cf::db_sync>.
1904		3233
1905	=item $value = cf::db_get $family => $key	3234	$facedata->{version} == 2
		3235	or cf::cleanup "$path: version mismatch, cannot proceed.";
1906		3236
1907	Returns a single value from the database	3237	# patch in the exptable
1908		3238	$facedata->{resource}{"res/exp_table"} = {
1909	=item cf::db_put $family => $hashref	3239	type => FT_RSRC,
1910		3240	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1911	Stores the given family hashref into the database. Updates are delayed, if
1912	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1913
1914	=item cf::db_put $family => $key => $value
1915
1916	Stores the given C<$value> in the family hash. Updates are delayed, if you
1917	want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919	=item cf::db_dirty
1920
1921	Marks the database as dirty, to be updated at a later time.
1922
1923	=item cf::db_sync
1924
1925	Immediately write the database to disk I<if it is dirty>.
1926
1927	=cut
1928
1929	our $DB;
1930
1931	{
1932	my $path = cf::localdir . "/database.pst";
1933
1934	sub db_load() {
1935	$DB = stat $path ? Storable::retrieve $path : { };
1936	}
1937
1938	my $pid;
1939
1940	sub db_save() {
1941	waitpid $pid, 0 if $pid;
1942	if (0 == ($pid = fork)) {
1943	$DB->{_meta}{version} = 1;
1944	Storable::nstore $DB, "$path~";
1945	rename "$path~", $path;
1946	cf::_exit 0 if defined $pid;
1947	}
1948	}
1949
1950	my $dirty;
1951
1952	sub db_sync() {
1953	db_save if $dirty;
1954	undef $dirty;
1955	}
1956
1957	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1958	db_sync;
1959	});	3241	};
		3242	cf::cede_to_tick;
1960		3243
1961	sub db_dirty() {
1962	$dirty = 1;
1963	$idle->start;
1964	}	3244	{
		3245	my $faces = $facedata->{faceinfo};
1965		3246
1966	sub db_get($;$) {	3247	while (my ($face, $info) = each %$faces) {
1967	@_ >= 2	3248	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1968	? $DB->{$_[0]}{$_[1]}
1969	: ($DB->{$_[0]} ||= { })
1970	}
1971		3249
1972	sub db_put($$;$) {	3250	cf::face::set_visibility $idx, $info->{visibility};
1973	if (@_ >= 3) {	3251	cf::face::set_magicmap $idx, $info->{magicmap};
1974	$DB->{$_[0]}{$_[1]} = $_[2];	3252	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1975	} else {	3253	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1976	$DB->{$_[0]} = $_[1];
1977	}
1978	db_dirty;
1979	}
1980		3254
1981	cf::global->attach (	3255	cf::cede_to_tick;
1982	prio => 10000,
1983	on_cleanup => sub {
1984	db_sync;
1985	},	3256	}
1986	);
1987	}
1988		3257
1989	#############################################################################	3258	while (my ($face, $info) = each %$faces) {
1990	# the server's main()	3259	next unless $info->{smooth};
1991		3260
1992	sub cfg_load {	3261	my $idx = cf::face::find $face
		3262	or next;
		3263
		3264	if (my $smooth = cf::face::find $info->{smooth}) {
		3265	cf::face::set_smooth $idx, $smooth;
		3266	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3267	} else {
		3268	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3269	}
		3270
		3271	cf::cede_to_tick;
		3272	}
		3273	}
		3274
		3275	{
		3276	my $anims = $facedata->{animinfo};
		3277
		3278	while (my ($anim, $info) = each %$anims) {
		3279	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3280	cf::cede_to_tick;
		3281	}
		3282
		3283	cf::anim::invalidate_all; # d'oh
		3284	}
		3285
		3286	{
		3287	# TODO: for gcfclient pleasure, we should give resources
		3288	# that gcfclient doesn't grok a >10000 face index.
		3289	my $res = $facedata->{resource};
		3290
		3291	while (my ($name, $info) = each %$res) {
		3292	if (defined $info->{type}) {
		3293	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3294	my $data;
		3295
		3296	if ($info->{type} & 1) {
		3297	# prepend meta info
		3298
		3299	my $meta = $enc->encode ({
		3300	name => $name,
		3301	%{ $info->{meta} || {} },
		3302	});
		3303
		3304	$data = pack "(w/a*)*", $meta, $info->{data};
		3305	} else {
		3306	$data = $info->{data};
		3307	}
		3308
		3309	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3310	cf::face::set_type $idx, $info->{type};
		3311	} else {
		3312	$RESOURCE{$name} = $info;
		3313	}
		3314
		3315	cf::cede_to_tick;
		3316	}
		3317	}
		3318
		3319	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3320
		3321	1
		3322	}
		3323
		3324	cf::global->attach (on_resource_update => sub {
		3325	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3326	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3327
		3328	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3329	my $sound = $soundconf->{compat}[$_]
		3330	or next;
		3331
		3332	my $face = cf::face::find "sound/$sound->[1]";
		3333	cf::sound::set $sound->[0] => $face;
		3334	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3335	}
		3336
		3337	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3338	my $face = cf::face::find "sound/$v";
		3339	cf::sound::set $k => $face;
		3340	}
		3341	}
		3342	});
		3343
		3344	register_exticmd fx_want => sub {
		3345	my ($ns, $want) = @_;
		3346
		3347	while (my ($k, $v) = each %$want) {
		3348	$ns->fx_want ($k, $v);
		3349	}
		3350	};
		3351
		3352	sub load_resource_file($) {
		3353	my $guard = lock_acquire "load_resource_file";
		3354
		3355	my $status = load_resource_file_ $_[0];
		3356	get_slot 0.1, 100;
		3357	cf::arch::commit_load;
		3358
		3359	$status
		3360	}
		3361
		3362	sub reload_regions {
		3363	# HACK to clear player env face cache, we need some signal framework
		3364	# for this (global event?)
		3365	%ext::player_env::MUSIC_FACE_CACHE = ();
		3366
		3367	load_resource_file "$MAPDIR/regions"
		3368	or die "unable to load regions file\n";
		3369
		3370	for (cf::region::list) {
		3371	$_->{match} = qr/$_->{match}/
		3372	if exists $_->{match};
		3373	}
		3374	}
		3375
		3376	sub reload_facedata {
		3377	load_facedata "$DATADIR/facedata"
		3378	or die "unable to load facedata\n";
		3379	}
		3380
		3381	sub reload_archetypes {
		3382	load_resource_file "$DATADIR/archetypes"
		3383	or die "unable to load archetypes\n";
		3384	}
		3385
		3386	sub reload_treasures {
		3387	load_resource_file "$DATADIR/treasures"
		3388	or die "unable to load treasurelists\n";
		3389	}
		3390
		3391	sub reload_resources {
		3392	warn "reloading resource files...\n";
		3393
		3394	reload_facedata;
		3395	reload_archetypes;
		3396	reload_regions;
		3397	reload_treasures;
		3398
		3399	warn "finished reloading resource files\n";
		3400	}
		3401
		3402	sub init {
		3403	my $guard = freeze_mainloop;
		3404
		3405	evthread_start IO::AIO::poll_fileno;
		3406
		3407	reload_resources;
		3408	}
		3409
		3410	sub reload_config {
1993	open my $fh, "<:utf8", cf::confdir . "/config"	3411	open my $fh, "<:utf8", "$CONFDIR/config"
1994	or return;	3412	or return;
1995		3413
1996	local $/;	3414	local $/;
1997	*CFG = YAML::Syck::Load <$fh>;	3415	*CFG = YAML::Load <$fh>;
1998		3416
1999	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3417	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3418
		3419	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3420	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2000		3421
2001	if (exists $CFG{mlockall}) {	3422	if (exists $CFG{mlockall}) {
2002	eval {	3423	eval {
2003	$CFG{mlockall} ? &mlockall : &munlockall	3424	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2004	and die "WARNING: m(un)lockall failed: $!\n";	3425	and die "WARNING: m(un)lockall failed: $!\n";
2005	};	3426	};
2006	warn $@ if $@;	3427	warn $@ if $@;
2007	}	3428	}
2008	}	3429	}
2009		3430
2010	sub main {	3431	sub main {
2011	# we must not ever block the main coroutine	3432	# we must not ever block the main coroutine
2012	local $Coro::idle = sub {	3433	local $Coro::idle = sub {
2013	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3434	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2014	(Coro::unblock_sub {	3435	(async {
2015	Event::one_event;	3436	$Coro::current->{desc} = "IDLE BUG HANDLER";
2016	})->();	3437	EV::loop EV::LOOP_ONESHOT;
		3438	})->prio (Coro::PRIO_MAX);
2017	};	3439	};
2018		3440
2019	cfg_load;	3441	{
2020	db_load;	3442	my $guard = freeze_mainloop;
		3443	reload_config;
		3444	db_init;
2021	load_extensions;	3445	load_extensions;
		3446
		3447	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3448	}
		3449
2022	Event::loop;	3450	EV::loop;
2023	}	3451	}
2024		3452
2025	#############################################################################	3453	#############################################################################
2026	# initialisation	3454	# initialisation and cleanup
2027		3455
		3456	# install some emergency cleanup handlers
		3457	BEGIN {
		3458	our %SIGWATCHER = ();
		3459	for my $signal (qw(INT HUP TERM)) {
		3460	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3461	cf::cleanup "SIG$signal";
		3462	};
		3463	}
		3464	}
		3465
		3466	sub write_runtime_sync {
		3467	my $runtime = "$LOCALDIR/runtime";
		3468
		3469	# first touch the runtime file to show we are still running:
		3470	# the fsync below can take a very very long time.
		3471
		3472	IO::AIO::aio_utime $runtime, undef, undef;
		3473
		3474	my $guard = cf::lock_acquire "write_runtime";
		3475
		3476	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3477	or return;
		3478
		3479	my $value = $cf::RUNTIME + 90 + 10;
		3480	# 10 is the runtime save interval, for a monotonic clock
		3481	# 60 allows for the watchdog to kill the server.
		3482
		3483	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3484	and return;
		3485
		3486	# always fsync - this file is important
		3487	aio_fsync $fh
		3488	and return;
		3489
		3490	# touch it again to show we are up-to-date
		3491	aio_utime $fh, undef, undef;
		3492
		3493	close $fh
		3494	or return;
		3495
		3496	aio_rename "$runtime~", $runtime
		3497	and return;
		3498
		3499	warn "runtime file written.\n";
		3500
		3501	1
		3502	}
		3503
		3504	our $uuid_lock;
		3505	our $uuid_skip;
		3506
		3507	sub write_uuid_sync($) {
		3508	$uuid_skip ||= $_[0];
		3509
		3510	return if $uuid_lock;
		3511	local $uuid_lock = 1;
		3512
		3513	my $uuid = "$LOCALDIR/uuid";
		3514
		3515	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3516	or return;
		3517
		3518	my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
		3519	$uuid_skip = 0;
		3520
		3521	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3522	and return;
		3523
		3524	# always fsync - this file is important
		3525	aio_fsync $fh
		3526	and return;
		3527
		3528	close $fh
		3529	or return;
		3530
		3531	aio_rename "$uuid~", $uuid
		3532	and return;
		3533
		3534	warn "uuid file written ($value).\n";
		3535
		3536	1
		3537
		3538	}
		3539
		3540	sub write_uuid($$) {
		3541	my ($skip, $sync) = @_;
		3542
		3543	$sync ? write_uuid_sync $skip
		3544	: async { write_uuid_sync $skip };
		3545	}
		3546
		3547	sub emergency_save() {
		3548	my $freeze_guard = cf::freeze_mainloop;
		3549
		3550	warn "enter emergency perl save\n";
		3551
		3552	cf::sync_job {
		3553	# use a peculiar iteration method to avoid tripping on perl
		3554	# refcount bugs in for. also avoids problems with players
		3555	# and maps saved/destroyed asynchronously.
		3556	warn "begin emergency player save\n";
		3557	for my $login (keys %cf::PLAYER) {
		3558	my $pl = $cf::PLAYER{$login} or next;
		3559	$pl->valid or next;
		3560	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3561	$pl->save;
		3562	}
		3563	warn "end emergency player save\n";
		3564
		3565	warn "begin emergency map save\n";
		3566	for my $path (keys %cf::MAP) {
		3567	my $map = $cf::MAP{$path} or next;
		3568	$map->valid or next;
		3569	$map->save;
		3570	}
		3571	warn "end emergency map save\n";
		3572
		3573	warn "begin emergency database checkpoint\n";
		3574	BDB::db_env_txn_checkpoint $DB_ENV;
		3575	warn "end emergency database checkpoint\n";
		3576
		3577	warn "begin write uuid\n";
		3578	write_uuid_sync 1;
		3579	warn "end write uuid\n";
		3580	};
		3581
		3582	warn "leave emergency perl save\n";
		3583	}
		3584
		3585	sub post_cleanup {
		3586	my ($make_core) = @_;
		3587
		3588	warn Carp::longmess "post_cleanup backtrace"
		3589	if $make_core;
		3590	}
		3591
2028	sub reload() {	3592	sub do_reload_perl() {
2029	# can/must only be called in main	3593	# can/must only be called in main
2030	if ($Coro::current != $Coro::main) {	3594	if ($Coro::current != $Coro::main) {
2031	warn "can only reload from main coroutine\n";	3595	warn "can only reload from main coroutine";
2032	return;	3596	return;
2033	}	3597	}
2034		3598
2035	warn "reloading...";	3599	warn "reloading...";
2036		3600
2037	my $guard = freeze_mainloop;	3601	warn "entering sync_job";
		3602
		3603	cf::sync_job {
		3604	cf::write_runtime_sync; # external watchdog should not bark
2038	cf::emergency_save;	3605	cf::emergency_save;
		3606	cf::write_runtime_sync; # external watchdog should not bark
2039		3607
2040	eval {	3608	warn "syncing database to disk";
		3609	BDB::db_env_txn_checkpoint $DB_ENV;
		3610
2041	# if anything goes wrong in here, we should simply crash as we already saved	3611	# if anything goes wrong in here, we should simply crash as we already saved
2042		3612
2043	# cancel all watchers	3613	warn "flushing outstanding aio requests";
2044	for (Event::all_watchers) {	3614	for (;;) {
2045	$_->cancel if $_->data & WF_AUTOCANCEL;	3615	BDB::flush;
		3616	IO::AIO::flush;
		3617	Coro::cede_notself;
		3618	last unless IO::AIO::nreqs || BDB::nreqs;
		3619	warn "iterate...";
2046	}	3620	}
2047		3621
		3622	++$RELOAD;
		3623
2048	# cancel all extension coros	3624	warn "cancelling all extension coros";
2049	$_->cancel for values %EXT_CORO;	3625	$_->cancel for values %EXT_CORO;
2050	%EXT_CORO = ();	3626	%EXT_CORO = ();
2051		3627
2052	# unload all extensions	3628	warn "removing commands";
2053	for (@exts) {	3629	%COMMAND = ();
		3630
		3631	warn "removing ext/exti commands";
		3632	%EXTCMD = ();
		3633	%EXTICMD = ();
		3634
		3635	warn "unloading/nuking all extensions";
		3636	for my $pkg (@EXTS) {
2054	warn "unloading <$_>";	3637	warn "... unloading $pkg";
2055	unload_extension $_;	3638
		3639	if (my $cb = $pkg->can ("unload")) {
		3640	eval {
		3641	$cb->($pkg);
		3642	1
		3643	} or warn "$pkg unloaded, but with errors: $@";
2056	}	3644	}
2057		3645
		3646	warn "... nuking $pkg";
		3647	Symbol::delete_package $pkg;
		3648	}
		3649
2058	# unload all modules loaded from $LIBDIR	3650	warn "unloading all perl modules loaded from $LIBDIR";
2059	while (my ($k, $v) = each %INC) {	3651	while (my ($k, $v) = each %INC) {
2060	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3652	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2061		3653
2062	warn "removing <$k>";	3654	warn "... unloading $k";
2063	delete $INC{$k};	3655	delete $INC{$k};
2064		3656
2065	$k =~ s/\.pm$//;	3657	$k =~ s/\.pm$//;
2066	$k =~ s/\//::/g;	3658	$k =~ s/\//::/g;
2067		3659
…		…
2070	}	3662	}
2071		3663
2072	Symbol::delete_package $k;	3664	Symbol::delete_package $k;
2073	}	3665	}
2074		3666
2075	# sync database to disk
2076	cf::db_sync;
2077	IO::AIO::flush;
2078
2079	# get rid of safe::, as good as possible	3667	warn "getting rid of safe::, as good as possible";
2080	Symbol::delete_package "safe::$_"	3668	Symbol::delete_package "safe::$_"
2081	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3669	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2082		3670
2083	# remove register_script_function callbacks
2084	# TODO
2085
2086	# unload cf.pm "a bit"	3671	warn "unloading cf.pm \"a bit\"";
2087	delete $INC{"cf.pm"};	3672	delete $INC{"cf.pm"};
		3673	delete $INC{"cf/pod.pm"};
2088		3674
2089	# don't, removes xs symbols, too,	3675	# don't, removes xs symbols, too,
2090	# and global variables created in xs	3676	# and global variables created in xs
2091	#Symbol::delete_package __PACKAGE__;	3677	#Symbol::delete_package __PACKAGE__;
2092		3678
2093	# reload cf.pm	3679	warn "unload completed, starting to reload now";
		3680
2094	warn "reloading cf.pm";	3681	warn "reloading cf.pm";
2095	require cf;	3682	require cf;
2096	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3683	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2097		3684
2098	# load config and database again	3685	warn "loading config and database again";
2099	cf::cfg_load;	3686	cf::reload_config;
2100	cf::db_load;
2101		3687
2102	# load extensions
2103	warn "load extensions";	3688	warn "loading extensions";
2104	cf::load_extensions;	3689	cf::load_extensions;
2105		3690
2106	# reattach attachments to objects	3691	warn "reattaching attachments to objects/players";
2107	warn "reattach";	3692	_global_reattach; # objects, sockets
2108	_global_reattach;	3693	warn "reattaching attachments to maps";
		3694	reattach $_ for values %MAP;
		3695	warn "reattaching attachments to players";
		3696	reattach $_ for values %PLAYER;
		3697
		3698	warn "leaving sync_job";
		3699
		3700	1
		3701	} or do {
		3702	warn $@;
		3703	cf::cleanup "error while reloading, exiting.";
2109	};	3704	};
2110		3705
2111	if ($@) {	3706	warn "reloaded";
2112	warn $@;
2113	warn "error while reloading, exiting.";
2114	exit 1;
2115	}
2116
2117	warn "reloaded successfully";
2118	};	3707	};
2119		3708
2120	#############################################################################	3709	our $RELOAD_WATCHER; # used only during reload
2121		3710
2122	unless ($LINK_MAP) {	3711	sub reload_perl() {
2123	$LINK_MAP = cf::map::new;	3712	# doing reload synchronously and two reloads happen back-to-back,
		3713	# coro crashes during coro_state_free->destroy here.
2124		3714
2125	$LINK_MAP->width (41);	3715	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2126	$LINK_MAP->height (41);	3716	do_reload_perl;
2127	$LINK_MAP->alloc;	3717	undef $RELOAD_WATCHER;
2128	$LINK_MAP->path ("{link}");	3718	};
2129	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2130	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2131
2132	# dirty hack because... archetypes are not yet loaded
2133	Event->timer (
2134	after => 2,
2135	cb => sub {
2136	$_[0]->w->cancel;
2137
2138	# provide some exits "home"
2139	my $exit = cf::object::new "exit";
2140
2141	$exit->slaying ($EMERGENCY_POSITION->[0]);
2142	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2143	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2144
2145	$LINK_MAP->insert ($exit->clone, 19, 19);
2146	$LINK_MAP->insert ($exit->clone, 19, 20);
2147	$LINK_MAP->insert ($exit->clone, 19, 21);
2148	$LINK_MAP->insert ($exit->clone, 20, 19);
2149	$LINK_MAP->insert ($exit->clone, 20, 21);
2150	$LINK_MAP->insert ($exit->clone, 21, 19);
2151	$LINK_MAP->insert ($exit->clone, 21, 20);
2152	$LINK_MAP->insert ($exit->clone, 21, 21);
2153
2154	$exit->destroy;
2155	});
2156
2157	$LINK_MAP->{deny_save} = 1;
2158	$LINK_MAP->{deny_reset} = 1;
2159
2160	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2161	}	3719	}
2162
2163	register "<global>", __PACKAGE__;
2164		3720
2165	register_command "reload" => sub {	3721	register_command "reload" => sub {
2166	my ($who, $arg) = @_;	3722	my ($who, $arg) = @_;
2167		3723
2168	if ($who->flag (FLAG_WIZ)) {	3724	if ($who->flag (FLAG_WIZ)) {
2169	$who->message ("start of reload.");
2170	reload;
2171	$who->message ("end of reload.");	3725	$who->message ("reloading server.");
		3726	async {
		3727	$Coro::current->{desc} = "perl_reload";
		3728	reload_perl;
		3729	};
2172	}	3730	}
2173	};	3731	};
2174		3732
2175	unshift @INC, $LIBDIR;	3733	unshift @INC, $LIBDIR;
2176		3734
2177	$TICK_WATCHER = Event->timer (	3735	my $bug_warning = 0;
2178	reentrant => 0,	3736
2179	prio => 0,	3737	our @WAIT_FOR_TICK;
2180	at => $NEXT_TICK || $TICK,	3738	our @WAIT_FOR_TICK_BEGIN;
2181	data => WF_AUTOCANCEL,	3739
2182	cb => sub {	3740	sub wait_for_tick {
		3741	return if tick_inhibit || $Coro::current == $Coro::main;
		3742
		3743	my $signal = new Coro::Signal;
		3744	push @WAIT_FOR_TICK, $signal;
		3745	$signal->wait;
		3746	}
		3747
		3748	sub wait_for_tick_begin {
		3749	return if tick_inhibit || $Coro::current == $Coro::main;
		3750
		3751	my $signal = new Coro::Signal;
		3752	push @WAIT_FOR_TICK_BEGIN, $signal;
		3753	$signal->wait;
		3754	}
		3755
		3756	sub tick {
		3757	if ($Coro::current != $Coro::main) {
		3758	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3759	unless ++$bug_warning > 10;
		3760	return;
		3761	}
		3762
2183	cf::server_tick; # one server iteration	3763	cf::server_tick; # one server iteration
2184	$RUNTIME += $TICK;
2185	$NEXT_TICK += $TICK;
2186		3764
2187	# if we are delayed by four ticks or more, skip them all	3765	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2188	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3766	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2189		3767	Coro::async_pool {
2190	$TICK_WATCHER->at ($NEXT_TICK);	3768	$Coro::current->{desc} = "runtime saver";
2191	$TICK_WATCHER->start;
2192	},
2193	);
2194
2195	IO::AIO::max_poll_time $TICK * 0.2;
2196
2197	Event->io (
2198	fd => IO::AIO::poll_fileno,
2199	poll => 'r',
2200	prio => 5,
2201	data => WF_AUTOCANCEL,
2202	cb => \&IO::AIO::poll_cb,
2203	);
2204
2205	Event->timer (
2206	data => WF_AUTOCANCEL,
2207	after => 0,
2208	interval => 10,
2209	cb => sub {
2210	(Coro::unblock_sub {
2211	write_runtime	3769	write_runtime_sync
2212	or warn "ERROR: unable to write runtime file: $!";	3770	or warn "ERROR: unable to write runtime file: $!";
2213	})->();	3771	};
2214	},	3772	}
2215	);	3773
		3774	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3775	$sig->send;
		3776	}
		3777	while (my $sig = shift @WAIT_FOR_TICK) {
		3778	$sig->send;
		3779	}
		3780
		3781	$LOAD = ($NOW - $TICK_START) / $TICK;
		3782	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3783
		3784	if (0) {
		3785	if ($NEXT_TICK) {
		3786	my $jitter = $TICK_START - $NEXT_TICK;
		3787	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3788	warn "jitter $JITTER\n";#d#
		3789	}
		3790	}
		3791	}
		3792
		3793	{
		3794	# configure BDB
		3795
		3796	BDB::min_parallel 8;
		3797	BDB::max_poll_reqs $TICK * 0.1;
		3798	$AnyEvent::BDB::WATCHER->priority (1);
		3799
		3800	unless ($DB_ENV) {
		3801	$DB_ENV = BDB::db_env_create;
		3802	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3803	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3804	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3805	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3806	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3807
		3808	cf::sync_job {
		3809	eval {
		3810	BDB::db_env_open
		3811	$DB_ENV,
		3812	$BDBDIR,
		3813	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3814	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3815	0666;
		3816
		3817	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3818	};
		3819
		3820	cf::cleanup "db_env_open(db): $@" if $@;
		3821	};
		3822	}
		3823
		3824	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3825	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3826	};
		3827	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3828	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3829	};
		3830	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3831	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3832	};
		3833	}
		3834
		3835	{
		3836	# configure IO::AIO
		3837
		3838	IO::AIO::min_parallel 8;
		3839	IO::AIO::max_poll_time $TICK * 0.1;
		3840	undef $AnyEvent::AIO::WATCHER;
		3841	}
		3842
		3843	my $_log_backtrace;
		3844
		3845	sub _log_backtrace {
		3846	my ($msg, @addr) = @_;
		3847
		3848	$msg =~ s/\n//;
		3849
		3850	# limit the # of concurrent backtraces
		3851	if ($_log_backtrace < 2) {
		3852	++$_log_backtrace;
		3853	async {
		3854	$Coro::current->{desc} = "abt $msg";
		3855
		3856	my @bt = fork_call {
		3857	@addr = map { sprintf "%x", $_ } @addr;
		3858	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3859	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3860	or die "addr2line: $!";
		3861
		3862	my @funcs;
		3863	my @res = <$fh>;
		3864	chomp for @res;
		3865	while (@res) {
		3866	my ($func, $line) = splice @res, 0, 2, ();
		3867	push @funcs, "[$func] $line";
		3868	}
		3869
		3870	@funcs
		3871	};
		3872
		3873	LOG llevInfo, "[ABT] $msg\n";
		3874	LOG llevInfo, "[ABT] $_\n" for @bt;
		3875	--$_log_backtrace;
		3876	};
		3877	} else {
		3878	LOG llevInfo, "[ABT] $msg\n";
		3879	LOG llevInfo, "[ABT] [suppressed]\n";
		3880	}
		3881	}
		3882
		3883	# load additional modules
		3884	use cf::pod;
2216		3885
2217	END { cf::emergency_save }	3886	END { cf::emergency_save }
2218		3887
2219	1	3888	1
2220		3889

Diff Legend

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