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

Diff Legend

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