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.138 by root, Fri Jan 5 17:07:17 2007 UTC vs.
Revision 1.464 by root, Thu Jan 1 18:35:48 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 (2); # 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 %MAP; # all maps	123	our (%PLAYER, %PLAYER_LOADING); # all users
53	our $LINK_MAP; # the special {link} map	124	our (%MAP, %MAP_LOADING ); # all maps
54	our $RANDOM_MAPS = cf::localdir . "/random";	125	our $LINK_MAP; # the special {link} map, which is always available
55	our %EXT_CORO;	126
		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)
56		138
57	binmode STDOUT;	139	binmode STDOUT;
58	binmode STDERR;	140	binmode STDERR;
59		141
60	# read virtual server time, if available	142	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	143	unless ($RUNTIME || !-e $RUNTIMEFILE) {
62	open my $fh, "<", cf::localdir . "/runtime"	144	open my $fh, "<", $RUNTIMEFILE
63	or die "unable to read runtime file: $!";	145	or die "unable to read $RUNTIMEFILE file: $!";
64	$RUNTIME = <$fh> + 0.;	146	$RUNTIME = <$fh> + 0.;
65	}	147	}
66		148
67	mkdir cf::localdir;	149	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	150	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		151
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	152	our $EMERGENCY_POSITION;
		153
		154	sub cf::map::normalise;
76		155
77	#############################################################################	156	#############################################################################
78		157
79	=head2 GLOBAL VARIABLES	158	=head2 GLOBAL VARIABLES
80		159
…		…
87	=item $cf::RUNTIME	166	=item $cf::RUNTIME
88		167
89	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
90	every server tick.	169	every server tick.
91		170
92	=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
93		174
94	The perl library directory, where extensions and cf-specific modules can	175	Various directories - "/etc", read-only install directory, perl-library
95	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.
96		179
97	=item $cf::NOW	180	=item $cf::NOW
98		181
99	The time of the last (current) server tick.	182	The time of the last (current) server tick.
100		183
101	=item $cf::TICK	184	=item $cf::TICK
102		185
103	The interval between server ticks, in seconds.	186	The interval between server ticks, in seconds.
104		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
105	=item %cf::CFG	198	=item %cf::CFG
106		199
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	200	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	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.
109		214
110	=back	215	=back
111		216
112	=cut	217	=cut
113		218
114	BEGIN {	219	BEGIN {
115	*CORE::GLOBAL::warn = sub {	220	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	221	my $msg = join "", @_;
117	utf8::encode $msg;
118		222
119	$msg .= "\n"	223	$msg .= "\n"
120	unless $msg =~ /\n$/;	224	unless $msg =~ /\n$/;
121		225
		226	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		227
122	LOG llevError, "cfperl: $msg";	228	LOG llevError, $msg;
123	};	229	};
124	}	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#?
125		246
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	247	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	248	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	249	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	250	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		254
133	# 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
134	# within the Safe compartment.	256	# within the Safe compartment.
135	for my $pkg (qw(	257	for my $pkg (qw(
136	cf::global cf::attachable	258	cf::global cf::attachable
137	cf::object cf::object::player	259	cf::object cf::object::player
138	cf::client cf::player	260	cf::client cf::player
139	cf::arch cf::living	261	cf::arch cf::living
		262	cf::map cf::mapspace
140	cf::map cf::party cf::region	263	cf::party cf::region
141	)) {	264	)) {
142	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	265	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	266	}
145		267
146	$Event::DIED = sub {	268	$EV::DIED = sub {
147	warn "error in event callback: @_";	269	warn "error in event callback: @_";
148	};	270	};
149		271
150	my %ext_pkg;	272	#############################################################################
151	my @exts;
152	my @hook;
153		273
154	=head2 UTILITY FUNCTIONS	274	=head2 UTILITY FUNCTIONS
155		275
156	=over 4	276	=over 4
157		277
158	=cut	278	=item dumpval $ref
159		279
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	280	=cut
161		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
162	=item $ref = cf::from_json $json	301	=item $ref = cf::decode_json $json
163		302
164	Converts a JSON string into the corresponding perl data structure.	303	Converts a JSON string into the corresponding perl data structure.
165		304
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	305	=item $json = cf::encode_json $ref
174		306
175	Converts a perl data structure into its JSON representation.	307	Converts a perl data structure into its JSON representation.
176		308
177	=cut	309	=cut
178		310
179	sub to_json($) {	311	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	312
181	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;
182	}	328	}
183		329
184	=item cf::lock_wait $string	330	=item cf::lock_wait $string
185		331
186	Wait until the given lock is available. See cf::lock_acquire.	332	Wait until the given lock is available. See cf::lock_acquire.
187		333
188	=item my $lock = cf::lock_acquire $string	334	=item my $lock = cf::lock_acquire $string
189		335
190	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
191	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,
192	for example when the coroutine gets canceled), the lock is automatically	338	for example when the coroutine gets canceled), the lock is automatically
193	returned.	339	returned.
194		340
		341	Locks are *not* recursive, locking from the same coro twice results in a
		342	deadlocked coro.
		343
195	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
196	uses map_find and cf::map::load uses map_load).	345	uses map_find and cf::map::load uses map_load).
197		346
198	=cut	347	=item $locked = cf::lock_active $string
199		348
200	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;
201		354
202	sub lock_wait($) {	355	sub lock_wait($) {
203	my ($key) = @_;	356	$LOCKS->wait ($_[0]);
204
205	# wait for lock, if any
206	while ($LOCK{$key}) {
207	push @{ $LOCK{$key} }, $Coro::current;
208	Coro::schedule;
209	}
210	}	357	}
211		358
212	sub lock_acquire($) {	359	sub lock_acquire($) {
213	my ($key) = @_;	360	$LOCKS->guard ($_[0])
		361	}
214		362
215	# wait, to be sure we are not locked	363	sub lock_active($) {
216	lock_wait $key;	364	$LOCKS->count ($_[0]) < 1
217
218	$LOCK{$key} = [];
219
220	Coro::guard {
221	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };
223	}
224	}	365	}
225		366
226	sub freeze_mainloop {	367	sub freeze_mainloop {
227	return unless $TICK_WATCHER->is_active;	368	tick_inhibit_inc;
228		369
229	my $guard = Coro::guard { $TICK_WATCHER->start };	370	&Guard::guard (\&tick_inhibit_dec);
230	$TICK_WATCHER->stop;
231	$guard
232	}	371	}
		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;
		446	}
		447
		448	=item cf::async { BLOCK }
		449
		450	Currently the same as Coro::async_pool, meaning you cannot use
		451	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		452	thing you are allowed to do is call C<prio> on it.
		453
		454	=cut
		455
		456	BEGIN { *async = \&Coro::async_pool }
233		457
234	=item cf::sync_job { BLOCK }	458	=item cf::sync_job { BLOCK }
235		459
236	The design of crossfire+ requires that the main coro ($Coro::main) is	460	The design of Deliantra requires that the main coroutine ($Coro::main)
237	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
238	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.
239		464
240	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
241	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
242	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
243	fast or be very important.	468	fast or be very important.
…		…
246		471
247	sub sync_job(&) {	472	sub sync_job(&) {
248	my ($job) = @_;	473	my ($job) = @_;
249		474
250	if ($Coro::current == $Coro::main) {	475	if ($Coro::current == $Coro::main) {
		476	my $time = EV::time;
		477
251	# this is the main coro, too bad, we have to block	478	# this is the main coro, too bad, we have to block
252	# till the operation succeeds, freezing the server :/	479	# till the operation succeeds, freezing the server :/
253		480
254	# TODO: use suspend/resume instead	481	LOG llevError, Carp::longmess "sync job";#d#
255	# (but this is cancel-safe)	482
256	my $freeze_guard = freeze_mainloop;	483	my $freeze_guard = freeze_mainloop;
257		484
258	my $busy = 1;	485	my $busy = 1;
259	my @res;	486	my @res;
260		487
261	(Coro::async_pool {	488	(async {
		489	$Coro::current->desc ("sync job coro");
262	@res = eval { $job->() };	490	@res = eval { $job->() };
263	warn $@ if $@;	491	warn $@ if $@;
264	undef $busy;	492	undef $busy;
265	})->prio (Coro::PRIO_MAX);	493	})->prio (Coro::PRIO_MAX);
266		494
267	while ($busy) {	495	while ($busy) {
		496	if (Coro::nready) {
268	Coro::cede_notself;	497	Coro::cede_notself;
269	Event::one_event unless Coro::nready;	498	} else {
		499	EV::loop EV::LOOP_ONESHOT;
270	}	500	}
		501	}
		502
		503	my $time = EV::time - $time;
		504
		505	$TICK_START += $time; # do not account sync jobs to server load
271		506
272	wantarray ? @res : $res[0]	507	wantarray ? @res : $res[0]
273	} else {	508	} else {
274	# we are in another coroutine, how wonderful, everything just works	509	# we are in another coroutine, how wonderful, everything just works
275		510
276	$job->()	511	$job->()
277	}	512	}
278	}	513	}
279		514
280	=item $coro = cf::coro { BLOCK }	515	=item $coro = cf::async_ext { BLOCK }
281		516
282	Creates (and readies) and returns a new coro. This coro is automcatially	517	Like async, but this coro is automatically being canceled when the
283	being canceled when the extension calling this is being unloaded.	518	extension calling this is being unloaded.
284		519
285	=cut	520	=cut
286		521
287	sub coro(&) {	522	sub async_ext(&) {
288	my $cb = shift;	523	my $cb = shift;
289		524
290	my $coro = &Coro::async_pool ($cb);	525	my $coro = &Coro::async ($cb);
291		526
292	$coro->on_destroy (sub {	527	$coro->on_destroy (sub {
293	delete $EXT_CORO{$coro+0};	528	delete $EXT_CORO{$coro+0};
294	});	529	});
295	$EXT_CORO{$coro+0} = $coro;	530	$EXT_CORO{$coro+0} = $coro;
296		531
297	$coro	532	$coro
298	}	533	}
299		534
300	sub write_runtime {	535	=item fork_call { }, $args
301	my $runtime = cf::localdir . "/runtime";
302		536
303	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	537	Executes the given code block with the given arguments in a seperate
304	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.
305		541
306	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	542	=cut
307	(aio_write $fh, 0, (length $value), $value, 0) <= 0
308	and return;
309		543
310	aio_fsync $fh	544	sub fork_call(&@) {
311	and return;	545	my ($cb, @args) = @_;
312		546
313	close $fh	547	# we seemingly have to make a local copy of the whole thing,
314	or return;	548	# otherwise perl prematurely frees the stuff :/
		549	# TODO: investigate and fix (likely this will be rather laborious)
315		550
316	aio_rename "$runtime~", $runtime	551	my @res = Coro::Util::fork_eval {
317	and return;	552	reset_signals;
		553	&$cb
		554	}, @args;
318		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
319	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 });
320	}	722	}
321		723
322	=back	724	=back
323		725
324	=cut	726	=cut
325		727
326	#############################################################################	728	#############################################################################
327		729
328	package cf::path;
329
330	sub new {
331	my ($class, $path, $base) = @_;
332
333	$path = $path->as_string if ref $path;
334
335	my $self = bless { }, $class;
336
337	# {... are special paths that are not touched
338	# ?xxx/... are special absolute paths
339	# ?random/... random maps
340	# /! non-realised random map exit
341	# /... normal maps
342	# ~/... per-player maps without a specific player (DO NOT USE)
343	# ~user/... per-player map of a specific user
344
345	if ($path =~ /^{/) {
346	# fine as it is
347	} elsif ($path =~ s{^\?random/}{}) {
348	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
349	$self->{random} = cf::from_json $data;
350	} else {
351	if ($path =~ s{^~([^/]+)?}{}) {
352	$self->{user_rel} = 1;
353
354	if (defined $1) {
355	$self->{user} = $1;
356	} elsif ($base =~ m{^~([^/]+)/}) {
357	$self->{user} = $1;
358	} else {
359	warn "cannot resolve user-relative path without user <$path,$base>\n";
360	}
361	} elsif ($path =~ /^\//) {
362	# already absolute
363	} else {
364	$base =~ s{[^/]+/?$}{};
365	return $class->new ("$base/$path");
366	}
367
368	for ($path) {
369	redo if s{/\.?/}{/};
370	redo if s{/[^/]+/\.\./}{/};
371	}
372	}
373
374	$self->{path} = $path;
375
376	$self
377	}
378
379	# the name / primary key / in-game path
380	sub as_string {
381	my ($self) = @_;
382
383	$self->{user_rel} ? "~$self->{user}$self->{path}"
384	: $self->{random} ? "?random/$self->{path}"
385	: $self->{path}
386	}
387
388	# the displayed name, this is a one way mapping
389	sub visible_name {
390	my ($self) = @_;
391
392	# if (my $rmp = $self->{random}) {
393	# # todo: be more intelligent about this
394	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
395	# } else {
396	$self->as_string
397	# }
398	}
399
400	# escape the /'s in the path
401	sub _escaped_path {
402	# ∕ is U+2215
403	(my $path = $_[0]{path}) =~ s/\//∕/g;
404	$path
405	}
406
407	# the original (read-only) location
408	sub load_path {
409	my ($self) = @_;
410
411	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
412	}
413
414	# the temporary/swap location
415	sub save_path {
416	my ($self) = @_;
417
418	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
419	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
420	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
421	}
422
423	# the unique path, might be eq to save_path
424	sub uniq_path {
425	my ($self) = @_;
426
427	$self->{user_rel} || $self->{random}
428	? undef
429	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
430	}
431
432	# return random map parameters, or undef
433	sub random_map_params {
434	my ($self) = @_;
435
436	$self->{random}
437	}
438
439	# this is somewhat ugly, but style maps do need special treatment
440	sub is_style_map {
441	$_[0]{path} =~ m{^/styles/}
442	}
443
444	package cf;
445
446	#############################################################################
447
448	=head2 ATTACHABLE OBJECTS	730	=head2 ATTACHABLE OBJECTS
449		731
450	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
451	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")
452	to it. All such attachable objects support the following methods.	734	to it. All such attachable objects support the following methods.
453		735
454	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>
455	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
456	crossfire+).	738	Deliantra).
457		739
458	=over 4	740	=over 4
459		741
460	=item $attachable->attach ($attachment, key => $value...)	742	=item $attachable->attach ($attachment, key => $value...)
461		743
…		…
505	=item cf::CLASS::attachment $name, ...	787	=item cf::CLASS::attachment $name, ...
506		788
507	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
508	given CLASS can refer to this attachment.	790	given CLASS can refer to this attachment.
509		791
510	Some classes such as crossfire maps and objects can specify attachments	792	Some classes such as deliantra maps and objects can specify attachments
511	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.
512		794
513	These calls expect any number of the following handler/hook descriptions:	795	These calls expect any number of the following handler/hook descriptions:
514		796
515	=over 4	797	=over 4
…		…
575	our @CB_TYPE = (); # registry for type (cf-object class) based events	857	our @CB_TYPE = (); # registry for type (cf-object class) based events
576	our @CB_MAP = ();	858	our @CB_MAP = ();
577		859
578	my %attachment;	860	my %attachment;
579		861
		862	sub cf::attachable::thawer_merge {
		863	# simply override everything except _meta
		864	local $_[0]{_meta};
		865	%{$_[0]} = %{$_[1]};
		866	}
		867
580	sub _attach_cb($$$$) {	868	sub _attach_cb($$$$) {
581	my ($registry, $event, $prio, $cb) = @_;	869	my ($registry, $event, $prio, $cb) = @_;
582		870
583	use sort 'stable';	871	use sort 'stable';
584		872
…		…
618	$registry = $CB_TYPE[$object_type] ||= [];	906	$registry = $CB_TYPE[$object_type] ||= [];
619		907
620	} elsif ($type eq "subtype") {	908	} elsif ($type eq "subtype") {
621	defined $object_type or Carp::croak "subtype specified without type";	909	defined $object_type or Carp::croak "subtype specified without type";
622	my $object_subtype = shift @arg;	910	my $object_subtype = shift @arg;
623	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	911	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
624		912
625	} elsif ($type eq "package") {	913	} elsif ($type eq "package") {
626	my $pkg = shift @arg;	914	my $pkg = shift @arg;
627		915
628	while (my ($name, $id) = each %cb_id) {	916	while (my ($name, $id) = each %cb_id) {
…		…
657	_attach $registry, $klass, @attach;	945	_attach $registry, $klass, @attach;
658	}	946	}
659		947
660	$obj->{$name} = \%arg;	948	$obj->{$name} = \%arg;
661	} else {	949	} else {
662	warn "object uses attachment '$name' that is not available, postponing.\n";	950	warn "object uses attachment '$name' which is not available, postponing.\n";
663	}	951	}
664		952
665	$obj->{_attachment}{$name} = undef;	953	$obj->{_attachment}{$name} = undef;
666	}	954	}
667		955
…		…
669	if (ref $_[0]) {	957	if (ref $_[0]) {
670	_object_attach @_;	958	_object_attach @_;
671	} else {	959	} else {
672	_attach shift->_attach_registry, @_;	960	_attach shift->_attach_registry, @_;
673	}	961	}
		962	_recalc_want;
674	};	963	};
675		964
676	# all those should be optimised	965	# all those should be optimised
677	sub cf::attachable::detach {	966	sub cf::attachable::detach {
678	my ($obj, $name) = @_;	967	my ($obj, $name) = @_;
…		…
681	delete $obj->{_attachment}{$name};	970	delete $obj->{_attachment}{$name};
682	reattach ($obj);	971	reattach ($obj);
683	} else {	972	} else {
684	Carp::croak "cannot, currently, detach class attachments";	973	Carp::croak "cannot, currently, detach class attachments";
685	}	974	}
		975	_recalc_want;
686	};	976	};
687		977
688	sub cf::attachable::attached {	978	sub cf::attachable::attached {
689	my ($obj, $name) = @_;	979	my ($obj, $name) = @_;
690		980
…		…
705	";	995	";
706	die if $@;	996	die if $@;
707	}	997	}
708		998
709	our $override;	999	our $override;
710	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?
711		1001
712	sub override {	1002	sub override {
713	$override = 1;	1003	$override = 1;
714	@invoke_results = ();	1004	@INVOKE_RESULTS = (@_);
715	}	1005	}
716		1006
717	sub do_invoke {	1007	sub do_invoke {
718	my $event = shift;	1008	my $event = shift;
719	my $callbacks = shift;	1009	my $callbacks = shift;
720		1010
721	@invoke_results = ();	1011	@INVOKE_RESULTS = ();
722		1012
723	local $override;	1013	local $override;
724		1014
725	for (@$callbacks) {	1015	for (@$callbacks) {
726	eval { &{$_->[1]} };	1016	eval { &{$_->[1]} };
…		…
735	}	1025	}
736		1026
737	0	1027	0
738	}	1028	}
739		1029
740	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1030	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
741		1031
742	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1032	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
743		1033
744	Generate an object-specific event with the given arguments.	1034	Generate an object-specific event with the given arguments.
745		1035
746	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
747	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
748	results (if you must, access C<@cf::invoke_results> directly).	1038	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
749		1039
750	=back	1040	=back
751		1041
752	=cut	1042	=cut
753		1043
754	#############################################################################	1044	#############################################################################
755	# 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	}
756		1088
757	sub reattach {	1089	sub reattach {
758	# basically do the same as instantiate, without calling instantiate	1090	# basically do the same as instantiate, without calling instantiate
759	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
760		1095
761	my $registry = $obj->registry;	1096	my $registry = $obj->registry;
762		1097
763	@$registry = ();	1098	@$registry = ();
764		1099
…		…
779	cf::attachable->attach (	1114	cf::attachable->attach (
780	prio => -1000000,	1115	prio => -1000000,
781	on_instantiate => sub {	1116	on_instantiate => sub {
782	my ($obj, $data) = @_;	1117	my ($obj, $data) = @_;
783		1118
784	$data = from_json $data;	1119	$data = decode_json $data;
785		1120
786	for (@$data) {	1121	for (@$data) {
787	my ($name, $args) = @$_;	1122	my ($name, $args) = @$_;
788		1123
789	$obj->attach ($name, %{$args || {} });	1124	$obj->attach ($name, %{$args || {} });
…		…
805	sub object_freezer_save {	1140	sub object_freezer_save {
806	my ($filename, $rdata, $objs) = @_;	1141	my ($filename, $rdata, $objs) = @_;
807		1142
808	sync_job {	1143	sync_job {
809	if (length $$rdata) {	1144	if (length $$rdata) {
		1145	utf8::decode (my $decname = $filename);
810	warn sprintf "saving %s (%d,%d)\n",	1146	warn sprintf "saving %s (%d,%d)\n",
811	$filename, length $$rdata, scalar @$objs;	1147	$decname, length $$rdata, scalar @$objs;
812		1148
813	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1149	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
814	chmod SAVE_MODE, $fh;	1150	aio_chmod $fh, SAVE_MODE;
815	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1151	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
816	aio_fsync $fh;	1152	aio_fsync $fh if $cf::USE_FSYNC;
817	close $fh;	1153	aio_close $fh;
818		1154
819	if (@$objs) {	1155	if (@$objs) {
820	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) {
821	chmod SAVE_MODE, $fh;	1157	aio_chmod $fh, SAVE_MODE;
822	my $data = Storable::nfreeze { version => 1, objs => $objs };	1158	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
823	aio_write $fh, 0, (length $data), $data, 0;	1159	aio_write $fh, 0, (length $data), $data, 0;
824	aio_fsync $fh;	1160	aio_fsync $fh if $cf::USE_FSYNC;
825	close $fh;	1161	aio_close $fh;
826	aio_rename "$filename.pst~", "$filename.pst";	1162	aio_rename "$filename.pst~", "$filename.pst";
827	}	1163	}
828	} else {	1164	} else {
829	aio_unlink "$filename.pst";	1165	aio_unlink "$filename.pst";
830	}	1166	}
831		1167
832	aio_rename "$filename~", $filename;	1168	aio_rename "$filename~", $filename;
		1169
		1170	$filename =~ s%/[^/]+$%%;
		1171	aio_pathsync $filename if $cf::USE_FSYNC;
833	} else {	1172	} else {
834	warn "FATAL: $filename~: $!\n";	1173	warn "unable to save objects: $filename~: $!\n";
835	}	1174	}
836	} else {	1175	} else {
837	aio_unlink $filename;	1176	aio_unlink $filename;
838	aio_unlink "$filename.pst";	1177	aio_unlink "$filename.pst";
839	}	1178	}
840	}	1179	};
841	}	1180	}
842		1181
843	sub object_freezer_as_string {	1182	sub object_freezer_as_string {
844	my ($rdata, $objs) = @_;	1183	my ($rdata, $objs) = @_;
845		1184
…		…
857	or return;	1196	or return;
858		1197
859	unless (aio_stat "$filename.pst") {	1198	unless (aio_stat "$filename.pst") {
860	(aio_load "$filename.pst", $av) >= 0	1199	(aio_load "$filename.pst", $av) >= 0
861	or return;	1200	or return;
		1201
862	$av = eval { (Storable::thaw $av)->{objs} };	1202	my $st = eval { Coro::Storable::thaw $av };
		1203	$av = $st->{objs};
863	}	1204	}
864		1205
		1206	utf8::decode (my $decname = $filename);
865	warn sprintf "loading %s (%d)\n",	1207	warn sprintf "loading %s (%d,%d)\n",
866	$filename, length $data, scalar @{$av || []};#d#	1208	$decname, length $data, scalar @{$av || []};
		1209
867	return ($data, $av);	1210	($data, $av)
868	}	1211	}
		1212
		1213	=head2 COMMAND CALLBACKS
		1214
		1215	=over 4
		1216
		1217	=cut
869		1218
870	#############################################################################	1219	#############################################################################
871	# command handling &c	1220	# command handling &c
872		1221
873	=item cf::register_command $name => \&callback($ob,$args);	1222	=item cf::register_command $name => \&callback($ob,$args);
…		…
886	push @{ $COMMAND{$name} }, [$caller, $cb];	1235	push @{ $COMMAND{$name} }, [$caller, $cb];
887	}	1236	}
888		1237
889	=item cf::register_extcmd $name => \&callback($pl,$packet);	1238	=item cf::register_extcmd $name => \&callback($pl,$packet);
890		1239
891	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.
892		1245
893	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
894	called.	1247	called.
895		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
896	=cut	1260	=cut
897		1261
898	sub register_extcmd {	1262	sub register_extcmd {
899	my ($name, $cb) = @_;	1263	my ($name, $cb) = @_;
900		1264
901	my $caller = caller;
902	#warn "registering extcmd '$name' to '$caller'";
903
904	$EXTCMD{$name} = [$cb, $caller];	1265	$EXTCMD{$name} = $cb;
905	}	1266	}
		1267
		1268	sub register_exticmd {
		1269	my ($name, $cb) = @_;
		1270
		1271	$EXTICMD{$name} = $cb;
		1272	}
		1273
		1274	use File::Glob ();
906		1275
907	cf::player->attach (	1276	cf::player->attach (
908	on_command => sub {	1277	on_command => sub {
909	my ($pl, $name, $params) = @_;	1278	my ($pl, $name, $params) = @_;
910		1279
…		…
918	cf::override;	1287	cf::override;
919	},	1288	},
920	on_extcmd => sub {	1289	on_extcmd => sub {
921	my ($pl, $buf) = @_;	1290	my ($pl, $buf) = @_;
922		1291
923	my $msg = eval { from_json $buf };	1292	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
924		1293
925	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
926	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1302	if (my $cb = $EXTCMD{$type}) {
927	if (my %reply = $cb->[0]->($pl, $msg)) {	1303	@reply = $cb->($pl, @payload);
928	$pl->ext_reply ($msg->{msgid}, %reply);
929	}
930	}	1304	}
		1305
		1306	$pl->ext_reply ($reply, @reply)
		1307	if $reply;
		1308
931	} else {	1309	} else {
932	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1310	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
933	}	1311	}
934		1312
935	cf::override;	1313	cf::override;
936	},	1314	},
937	);	1315	);
938		1316
939	sub register {	1317	# "readahead" all extensions
940	my ($base, $pkg) = @_;	1318	sub cache_extensions {
		1319	my $grp = IO::AIO::aio_group;
941		1320
942	#TODO	1321	add $grp IO::AIO::aio_readdir $LIBDIR, sub {
943	}	1322	for (grep /\.ext$/, @{$_[0]}) {
		1323	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
		1324	}
		1325	};
944		1326
		1327	$grp
		1328	}
		1329
945	sub load_extension {	1330	sub load_extensions {
		1331	cf::sync_job {
		1332	my %todo;
		1333
		1334	for my $path (<$LIBDIR/*.ext>) {
		1335	next unless -r $path;
		1336
		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;
		1393	}
		1394
		1395	skip:
		1396	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1397	unless $progress;
		1398	}
		1399	};
		1400	}
		1401
		1402	#############################################################################
		1403
		1404	=back
		1405
		1406	=head2 CORE EXTENSIONS
		1407
		1408	Functions and methods that extend core deliantra objects.
		1409
		1410	=cut
		1411
		1412	package cf::player;
		1413
		1414	use Coro::AIO;
		1415
		1416	=head3 cf::player
		1417
		1418	=over 4
		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
		1434	=item cf::player::find $login
		1435
		1436	Returns the given player object, loading it if necessary (might block).
		1437
		1438	=cut
		1439
		1440	sub playerdir($) {
		1441	"$PLAYERDIR/"
		1442	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1443	}
		1444
		1445	sub path($) {
		1446	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1447
		1448	(playerdir $login) . "/playerdata"
		1449	}
		1450
		1451	sub find_active($) {
		1452	$cf::PLAYER{$_[0]}
		1453	and $cf::PLAYER{$_[0]}->active
		1454	and $cf::PLAYER{$_[0]}
		1455	}
		1456
		1457	sub exists($) {
		1458	my ($login) = @_;
		1459
		1460	$cf::PLAYER{$login}
		1461	or !aio_stat path $login
		1462	}
		1463
		1464	sub find($) {
		1465	return $cf::PLAYER{$_[0]} || do {
		1466	my $login = $_[0];
		1467
		1468	my $guard = cf::lock_acquire "user_find:$login";
		1469
		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	}
		1488	}
		1489	}
		1490
		1491	sub save($) {
		1492	my ($pl) = @_;
		1493
		1494	return if $pl->{deny_save};
		1495
		1496	my $path = path $pl;
		1497	my $guard = cf::lock_acquire "user_save:$path";
		1498
		1499	return if $pl->{deny_save};
		1500
		1501	aio_mkdir playerdir $pl, 0770;
		1502	$pl->{last_save} = $cf::RUNTIME;
		1503
		1504	cf::get_slot 0.01;
		1505
		1506	$pl->save_pl ($path);
		1507	cf::cede_to_tick;
		1508	}
		1509
		1510	sub new($) {
		1511	my ($login) = @_;
		1512
		1513	my $self = create;
		1514
		1515	$self->ob->name ($login);
		1516	$self->{deny_save} = 1;
		1517
		1518	$cf::PLAYER{$login} = $self;
		1519
		1520	$self
		1521	}
		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
		1646	=item $player->ext_reply ($msgid, @msg)
		1647
		1648	Sends an ext reply to the player.
		1649
		1650	=cut
		1651
		1652	sub ext_reply($$@) {
		1653	my ($self, $id, @msg) = @_;
		1654
		1655	$self->ns->ext_reply ($id, @msg)
		1656	}
		1657
		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($) {
946	my ($path) = @_;	1685	my ($path) = @_;
947		1686
948	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1687	my ($match, $specificity);
949	my $base = $1;
950	my $pkg = $1;
951	$pkg =~ s/[^[:word:]]/_/g;
952	$pkg = "ext::$pkg";
953		1688
954	warn "loading '$path' into '$pkg'\n";	1689	for my $region (list) {
955		1690	if ($region->{match} && $path =~ $region->{match}) {
956	open my $fh, "<:utf8", $path	1691	($match, $specificity) = ($region, $region->specificity)
957	or die "$path: $!";	1692	if $region->specificity > $specificity;
958		1693	}
959	my $source =
960	"package $pkg; use strict; use utf8;\n"
961	. "#line 1 \"$path\"\n{\n"
962	. (do { local $/; <$fh> })
963	. "\n};\n1";
964
965	eval $source
966	or die $@ ? "$path: $@\n"
967	: "extension disabled.\n";
968
969	push @exts, $pkg;
970	$ext_pkg{$base} = $pkg;
971
972	# no strict 'refs';
973	# @{"$pkg\::ISA"} = ext::;
974
975	register $base, $pkg;
976	}
977
978	sub unload_extension {
979	my ($pkg) = @_;
980
981	warn "removing extension $pkg\n";
982
983	# remove hooks
984	#TODO
985	# for my $idx (0 .. $#PLUGIN_EVENT) {
986	# delete $hook[$idx]{$pkg};
987	# }	1694	}
988		1695
989	# remove commands	1696	$match
990	for my $name (keys %COMMAND) {
991	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
992
993	if (@cb) {
994	$COMMAND{$name} = \@cb;
995	} else {
996	delete $COMMAND{$name};
997	}
998	}
999
1000	# remove extcmds
1001	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1002	delete $EXTCMD{$name};
1003	}
1004
1005	if (my $cb = $pkg->can ("unload")) {
1006	eval {
1007	$cb->($pkg);
1008	1
1009	} or warn "$pkg unloaded, but with errors: $@";
1010	}
1011
1012	Symbol::delete_package $pkg;
1013	}
1014
1015	sub load_extensions {
1016	for my $ext (<$LIBDIR/*.ext>) {
1017	next unless -r $ext;
1018	eval {
1019	load_extension $ext;
1020	1
1021	} or warn "$ext not loaded: $@";
1022	}
1023	}
1024
1025	#############################################################################
1026	# load/save/clean perl data associated with a map
1027
1028	*cf::mapsupport::on_clean = sub {
1029	my ($map) = @_;
1030
1031	my $path = $map->tmpname;
1032	defined $path or return;
1033
1034	unlink "$path.pst";
1035	};
1036
1037	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1038
1039	#############################################################################
1040	# load/save perl data associated with player->ob objects
1041
1042	sub all_objects(@) {
1043	@_, map all_objects ($_->inv), @_
1044	}
1045
1046	# TODO: compatibility cruft, remove when no longer needed
1047	cf::player->attach (
1048	on_load => sub {
1049	my ($pl, $path) = @_;
1050
1051	for my $o (all_objects $pl->ob) {
1052	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1053	$o->set_ob_key_value ("_perl_data");
1054
1055	%$o = %{ Storable::thaw pack "H*", $value };
1056	}
1057	}
1058	},
1059	);
1060
1061	#############################################################################
1062
1063	=head2 CORE EXTENSIONS
1064
1065	Functions and methods that extend core crossfire objects.
1066
1067	=head3 cf::player
1068
1069	=over 4
1070
1071	=item cf::player::exists $login
1072
1073	Returns true when the given account exists.
1074
1075	=cut
1076
1077	sub cf::player::exists($) {
1078	cf::player::find $_[0]
1079	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1080	}
1081
1082	=item $player->ext_reply ($msgid, $msgtype, %msg)
1083
1084	Sends an ext reply to the player.
1085
1086	=cut
1087
1088	sub cf::player::ext_reply($$$%) {
1089	my ($self, $id, %msg) = @_;
1090
1091	$msg{msgid} = $id;
1092
1093	$self->send ("ext " . to_json \%msg);
1094	}	1697	}
1095		1698
1096	=back	1699	=back
1097
1098		1700
1099	=head3 cf::map	1701	=head3 cf::map
1100		1702
1101	=over 4	1703	=over 4
1102		1704
…		…
1105	package cf::map;	1707	package cf::map;
1106		1708
1107	use Fcntl;	1709	use Fcntl;
1108	use Coro::AIO;	1710	use Coro::AIO;
1109		1711
		1712	use overload
		1713	'""' => \&as_string,
		1714	fallback => 1;
		1715
1110	our $MAX_RESET = 3600;	1716	our $MAX_RESET = 3600;
1111	our $DEFAULT_RESET = 3000;	1717	our $DEFAULT_RESET = 3000;
1112		1718
1113	sub generate_random_map {	1719	sub generate_random_map {
1114	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
1115		1723
1116	# mit "rum" bekleckern, nicht	1724	# mit "rum" bekleckern, nicht
1117	cf::map::_create_random_map	1725	$self->_create_random_map (
1118	$path,
1119	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1726	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1120	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1727	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1121	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1728	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1122	$rmp->{exit_on_final_map},	1729	$rmp->{exit_on_final_map},
1123	$rmp->{xsize}, $rmp->{ysize},	1730	$rmp->{xsize}, $rmp->{ysize},
1124	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1731	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1125	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1732	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1126	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1733	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1127	$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},
1128	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1735	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1129	(cf::region::find $rmp->{region})	1736	(cf::region::find $rmp->{region}), $rmp->{custom}
		1737	)
1130	}	1738	}
1131		1739
1132	# and all this just because we cannot iterate over	1740	=item cf::map->register ($regex, $prio)
1133	# all maps in C++...
1134	sub change_all_map_light {
1135	my ($change) = @_;
1136		1741
1137	$_->change_map_light ($change)	1742	Register a handler for the map path matching the given regex at the
1138	for grep $_->outdoor, values %cf::MAP;	1743	givne priority (higher is better, built-in handlers have priority 0, the
1139	}	1744	default).
1140		1745
1141	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 {
1142	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) = @_;
1143		1885
1144	utf8::encode $path;	1886	utf8::encode $path;
1145	aio_open $path, O_RDONLY, 0	1887	my $f = new_from_file cf::object::thawer $path
1146	or return;	1888	or return;
1147		1889
1148	my $map = cf::map::new	1890	$self->_load_header ($f)
1149	or return;	1891	or return;
1150		1892
1151	# for better error messages only, will be overwritten	1893	local $MAP_LOADING{$self->{path}} = $self;
1152	$map->path ($path);	1894	$f->resolve_delayed_derefs;
1153		1895
1154	$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
1155	or return;	1939	or return;
		1940	$self->prepare_orig;
		1941	}
1156		1942
1157	$map->{load_path} = $path;	1943	$self->{deny_reset} = 1
		1944	if $self->no_reset;
1158		1945
1159	$map	1946	$self->default_region (cf::region::find_by_path $self->{path})
		1947	unless $self->default_region;
		1948
		1949	1
1160	}	1950	}
1161		1951
1162	sub find;	1952	sub find;
1163	sub find {	1953	sub find {
1164	my ($path, $origin) = @_;	1954	my ($path, $origin) = @_;
1165		1955
1166	#warn "find<$path,$origin>\n";#d#
1167
1168	$path = new cf::path $path, $origin && $origin->path;	1956	$path = normalise $path, $origin && $origin->path;
1169	my $key = $path->as_string;
1170		1957
1171	cf::lock_wait "map_find:$key";	1958	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1172
1173	$cf::MAP{$key} || do {
1174	my $guard = cf::lock_acquire "map_find:$key";	1959	my $guard2 = cf::lock_acquire "map_find:$path";
1175		1960
1176	# do it the slow way	1961	$cf::MAP{$path} || do {
1177	my $map = try_load_header $path->save_path;	1962	my $map = new_from_path cf::map $path
1178
1179	Coro::cede;
1180
1181	if ($map) {
1182	$map->last_access ((delete $map->{last_access})
1183	|| $cf::RUNTIME); #d#
1184	# safety
1185	$map->{instantiate_time} = $cf::RUNTIME
1186	if $map->{instantiate_time} > $cf::RUNTIME;
1187	} else {
1188	if (my $rmp = $path->random_map_params) {
1189	$map = generate_random_map $key, $rmp;
1190	} else {
1191	$map = try_load_header $path->load_path;
1192	}
1193
1194	$map or return;	1963	or return;
1195		1964
1196	$map->{load_original} = 1;
1197	$map->{instantiate_time} = $cf::RUNTIME;
1198	$map->last_access ($cf::RUNTIME);
1199	$map->instantiate;
1200
1201	# per-player maps become, after loading, normal maps
1202	$map->per_player (0) if $path->{user_rel};
1203	}
1204
1205	$map->path ($key);
1206	$map->{path} = $path;
1207	$map->{last_save} = $cf::RUNTIME;	1965	$map->{last_save} = $cf::RUNTIME;
1208		1966
1209	Coro::cede;	1967	$map->load_header
		1968	or return;
1210		1969
1211	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;
1212	$map->reset;	1975	$map->reset;
1213	undef $guard;
1214	$map = find $path	1976	return find $path;
1215	or return;
1216	}	1977	}
1217		1978
1218	$cf::MAP{$key} = $map	1979	$cf::MAP{$path} = $map
1219	}	1980	}
1220	}	1981	}
		1982
		1983	sub pre_load { }
		1984	sub post_load { }
1221		1985
1222	sub load {	1986	sub load {
1223	my ($self) = @_;	1987	my ($self) = @_;
1224		1988
		1989	local $self->{deny_reset} = 1; # loading can take a long time
		1990
1225	my $path = $self->{path};	1991	my $path = $self->{path};
		1992
		1993	{
1226	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1994	my $guard = cf::lock_acquire "map_data:$path";
1227		1995
		1996	return unless $self->valid;
1228	return if $self->in_memory != cf::MAP_SWAPPED;	1997	return unless $self->in_memory == cf::MAP_SWAPPED;
1229		1998
1230	$self->in_memory (cf::MAP_LOADING);	1999	$self->in_memory (cf::MAP_LOADING);
1231		2000
1232	$self->alloc;	2001	$self->alloc;
1233	$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)
1234	or return;	2009	or return;
1235		2010
1236	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2011	$self->post_load_original
1237	if delete $self->{load_original};	2012	if delete $self->{load_original};
1238		2013
1239	if (my $uniq = $path->uniq_path) {	2014	if (my $uniq = $self->uniq_path) {
1240	utf8::encode $uniq;	2015	utf8::encode $uniq;
1241	if (aio_open $uniq, O_RDONLY, 0) {	2016	unless (aio_stat $uniq) {
		2017	if (my $f = new_from_file cf::object::thawer $uniq) {
1242	$self->clear_unique_items;	2018	$self->clear_unique_items;
1243	$self->load_objects ($uniq, 0);	2019	$self->_load_objects ($f);
		2020	$f->resolve_delayed_derefs;
		2021	}
1244	}	2022	}
1245	}	2023	}
1246		2024
1247	Coro::cede;	2025	$f->resolve_delayed_derefs;
1248		2026
		2027	cf::cede_to_tick;
1249	# now do the right thing for maps	2028	# now do the right thing for maps
1250	$self->link_multipart_objects;	2029	$self->link_multipart_objects;
1251
1252	if ($self->{path}->is_style_map) {
1253	$self->{deny_save} = 1;
1254	$self->{deny_reset} = 1;
1255	} else {
1256	$self->fix_auto_apply;
1257	$self->decay_objects;
1258	$self->update_buttons;
1259	$self->set_darkness_map;
1260	$self->difficulty ($self->estimate_difficulty)	2030	$self->difficulty ($self->estimate_difficulty)
1261	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;
1262	$self->activate;	2039	$self->activate;
1263	}	2040	}
1264		2041
1265	Coro::cede;	2042	$self->{last_save} = $cf::RUNTIME;
		2043	$self->last_access ($cf::RUNTIME);
1266		2044
1267	$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	}
1268	}	2087	}
1269		2088
1270	sub find_sync {	2089	sub find_sync {
1271	my ($path, $origin) = @_;	2090	my ($path, $origin) = @_;
1272		2091
1273	cf::sync_job { cf::map::find $path, $origin }	2092	cf::sync_job { find $path, $origin }
1274	}	2093	}
1275		2094
1276	sub do_load_sync {	2095	sub do_load_sync {
1277	my ($map) = @_;	2096	my ($map) = @_;
1278		2097
		2098	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2099	if $Coro::current == $Coro::main;
		2100
1279	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	()
1280	}	2135	}
1281		2136
1282	sub save {	2137	sub save {
1283	my ($self) = @_;	2138	my ($self) = @_;
1284		2139
1285	my $lock = cf::lock_acquire "map_data:" . $self->path;	2140	my $lock = cf::lock_acquire "map_data:$self->{path}";
1286		2141
1287	$self->{last_save} = $cf::RUNTIME;	2142	$self->{last_save} = $cf::RUNTIME;
1288		2143
1289	return unless $self->dirty;	2144	return unless $self->dirty;
1290		2145
1291	my $save = $self->{path}->save_path; utf8::encode $save;	2146	my $save = $self->save_path; utf8::encode $save;
1292	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2147	my $uniq = $self->uniq_path; utf8::encode $uniq;
1293		2148
1294	$self->{load_path} = $save;	2149	$self->{load_path} = $save;
1295		2150
1296	return if $self->{deny_save};	2151	return if $self->{deny_save};
1297		2152
1298	local $self->{last_access} = $self->last_access;#d#	2153	local $self->{last_access} = $self->last_access;#d#
1299		2154
		2155	cf::async {
		2156	$Coro::current->{desc} = "map player save";
		2157	$_->contr->save for $self->players;
		2158	};
		2159
		2160	cf::get_slot 0.02;
		2161
1300	if ($uniq) {	2162	if ($uniq) {
1301	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2163	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1302	$self->save_objects ($uniq, cf::IO_UNIQUES);	2164	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1303	} else {	2165	} else {
1304	$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);
1305	}	2167	}
1306	}	2168	}
1307		2169
1308	sub swap_out {	2170	sub swap_out {
1309	my ($self) = @_;	2171	my ($self) = @_;
1310		2172
1311	# save first because save cedes	2173	# save first because save cedes
1312	$self->save;	2174	$self->save;
1313		2175
1314	my $lock = cf::lock_acquire "map_data:" . $self->path;	2176	my $lock = cf::lock_acquire "map_data:$self->{path}";
1315		2177
1316	return if $self->players;	2178	return if $self->players;
1317	return if $self->in_memory != cf::MAP_IN_MEMORY;	2179	return if $self->in_memory != cf::MAP_ACTIVE;
1318	return if $self->{deny_save};	2180	return if $self->{deny_save};
1319		2181
		2182	$self->in_memory (cf::MAP_SWAPPED);
		2183
		2184	$self->deactivate;
		2185	$_->clear_links_to ($self) for values %cf::MAP;
1320	$self->clear;	2186	$self->clear;
1321	$self->in_memory (cf::MAP_SWAPPED);
1322	}	2187	}
1323		2188
1324	sub reset_at {	2189	sub reset_at {
1325	my ($self) = @_;	2190	my ($self) = @_;
1326		2191
1327	# TODO: safety, remove and allow resettable per-player maps	2192	# TODO: safety, remove and allow resettable per-player maps
1328	return 1e99 if $self->{path}{user_rel};
1329	return 1e99 if $self->{deny_reset};	2193	return 1e99 if $self->{deny_reset};
1330		2194
1331	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2195	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1332	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;
1333		2197
…		…
1338	my ($self) = @_;	2202	my ($self) = @_;
1339		2203
1340	$self->reset_at <= $cf::RUNTIME	2204	$self->reset_at <= $cf::RUNTIME
1341	}	2205	}
1342		2206
1343	sub unlink_save {
1344	my ($self) = @_;
1345
1346	utf8::encode (my $save = $self->{path}->save_path);
1347	aioreq_pri 3; IO::AIO::aio_unlink $save;
1348	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1349	}
1350
1351	sub rename {
1352	my ($self, $new_path) = @_;
1353
1354	$self->unlink_save;
1355
1356	delete $cf::MAP{$self->path};
1357	$self->{path} = new cf::path $new_path;
1358	$self->path ($self->{path}->as_string);
1359	$cf::MAP{$self->path} = $self;
1360
1361	$self->save;
1362	}
1363
1364	sub reset {	2207	sub reset {
1365	my ($self) = @_;	2208	my ($self) = @_;
1366		2209
1367	my $lock = cf::lock_acquire "map_data:" . $self->path;	2210	my $lock = cf::lock_acquire "map_data:$self->{path}";
1368		2211
1369	return if $self->players;	2212	return if $self->players;
1370	return if $self->{path}{user_rel};#d#
1371		2213
1372	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	}
1373		2225
1374	delete $cf::MAP{$self->path};	2226	delete $cf::MAP{$self->path};
1375		2227
		2228	$self->deactivate;
1376	$_->clear_links_to ($self) for values %cf::MAP;	2229	$_->clear_links_to ($self) for values %cf::MAP;
		2230	$self->clear;
1377		2231
1378	$self->unlink_save;	2232	$self->unlink_save;
1379	$self->destroy;	2233	$self->destroy;
1380	}	2234	}
1381		2235
1382	my $nuke_counter = "aaaa";	2236	my $nuke_counter = "aaaa";
1383		2237
1384	sub nuke {	2238	sub nuke {
1385	my ($self) = @_;	2239	my ($self) = @_;
1386		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};
1387	$self->{deny_save} = 1;	2250	$self->{deny_save} = 1;
1388	$self->reset_timeout (1);	2251	$self->reset_timeout (1);
1389	$self->rename ("{nuke}/" . ($nuke_counter++));	2252	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2253
		2254	$cf::MAP{$self->path} = $self;
		2255	}
		2256
1390	$self->reset; # polite request, might not happen	2257	$self->reset; # polite request, might not happen
1391	}	2258	}
1392		2259
1393	sub customise_for {	2260	=item $maps = cf::map::tmp_maps
1394	my ($map, $ob) = @_;
1395		2261
1396	if ($map->per_player) {	2262	Returns an arrayref with all map paths of currently instantiated and saved
1397	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2263	maps. May block.
		2264
		2265	=cut
		2266
		2267	sub tmp_maps() {
1398	}	2268	[
1399		2269	map {
1400	$map	2270	utf8::decode $_;
		2271	/\.map$/
		2272	? normalise $_
		2273	: ()
		2274	} @{ aio_readdir $TMPDIR or [] }
		2275	]
1401	}	2276	}
1402		2277
1403	sub emergency_save {	2278	=item $maps = cf::map::random_maps
1404	my $freeze_guard = cf::freeze_mainloop;
1405		2279
1406	warn "enter emergency map save\n";	2280	Returns an arrayref with all map paths of currently instantiated and saved
		2281	random maps. May block.
1407		2282
1408	cf::sync_job {	2283	=cut
1409	warn "begin emergency map save\n";	2284
1410	$_->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
1411	};	2366	}
1412
1413	warn "end emergency map save\n";
1414	}	2367	}
1415		2368
1416	package cf;	2369	package cf;
1417		2370
1418	=back	2371	=back
1419
1420		2372
1421	=head3 cf::object::player	2373	=head3 cf::object::player
1422		2374
1423	=over 4	2375	=over 4
1424		2376
…		…
1427	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>
1428	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
1429	dialogue with the given NPC character.	2381	dialogue with the given NPC character.
1430		2382
1431	=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	};
1432		2398
1433	# rough implementation of a future "reply" method that works	2399	# rough implementation of a future "reply" method that works
1434	# with dialog boxes.	2400	# with dialog boxes.
1435	#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
1436	sub cf::object::player::reply($$$;$) {	2402	sub cf::object::player::reply($$$;$) {
…		…
1438		2404
1439	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2405	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1440		2406
1441	if ($self->{record_replies}) {	2407	if ($self->{record_replies}) {
1442	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2408	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2409
1443	} 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 {
1444	$msg = $npc->name . " says: $msg" if $npc;	2418	$msg = $npc->name . " says: $msg" if $npc;
1445	$self->message ($msg, $flags);	2419	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2420	}
1446	}	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 (@_);
1447	}	2432	}
1448		2433
1449	=item $player_object->may ("access")	2434	=item $player_object->may ("access")
1450		2435
1451	Returns wether the given player is authorized to access resource "access"	2436	Returns wether the given player is authorized to access resource "access"
…		…
1464		2449
1465	=item $player_object->enter_link	2450	=item $player_object->enter_link
1466		2451
1467	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}>).
1468		2453
1469	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.
1470	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.
1471		2460
1472	=item $player_object->leave_link ($map, $x, $y)	2461	=item $player_object->leave_link ($map, $x, $y)
1473		2462
1474	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
1475	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
1476	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
1477	to the emergency map position.	2466	fails, to the emergency map position.
1478		2467
1479	Might block.	2468	Might block.
1480		2469
1481	=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	}
1482		2481
1483	sub cf::object::player::enter_link {	2482	sub cf::object::player::enter_link {
1484	my ($self) = @_;	2483	my ($self) = @_;
1485		2484
1486	$self->deactivate_recursive;	2485	$self->deactivate_recursive;
1487		2486
1488	return if $self->map == $LINK_MAP;	2487	return if UNIVERSAL::isa $self->map, "ext::map_link";
1489		2488
1490	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2489	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1491	if $self->map;	2490	if $self->map && $self->map->{path} ne "{link}";
1492		2491
1493	$self->enter_map ($LINK_MAP, 20, 20);	2492	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1494	}	2493	}
1495		2494
1496	sub cf::object::player::leave_link {	2495	sub cf::object::player::leave_link {
1497	my ($self, $map, $x, $y) = @_;	2496	my ($self, $map, $x, $y) = @_;
		2497
		2498	return unless $self->contr->active;
1498		2499
1499	my $link_pos = delete $self->{_link_pos};	2500	my $link_pos = delete $self->{_link_pos};
1500		2501
1501	unless ($map) {	2502	unless ($map) {
1502	# restore original map position	2503	# restore original map position
…		…
1516	# use -1 or undef as default coordinates, not 0, 0	2517	# use -1 or undef as default coordinates, not 0, 0
1517	($x, $y) = ($map->enter_x, $map->enter_y)	2518	($x, $y) = ($map->enter_x, $map->enter_y)
1518	if $x <=0 && $y <= 0;	2519	if $x <=0 && $y <= 0;
1519		2520
1520	$map->load;	2521	$map->load;
		2522	$map->load_neighbours;
1521		2523
		2524	return unless $self->contr->active;
		2525	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1522	$self->activate_recursive;	2526	$self->activate_recursive;
		2527
		2528	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1523	$self->enter_map ($map, $x, $y);	2529	$self->enter_map ($map, $x, $y);
1524	}	2530	}
1525		2531
1526	cf::player->attach (	2532	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1527	on_logout => sub {
1528	my ($pl) = @_;
1529		2533
1530	# abort map switching before logout	2534	Moves the player to the given map-path and coordinates by first freezing
1531	if ($pl->ob->{_link_pos}) {	2535	her, loading and preparing them map, calling the provided $check callback
1532	cf::sync_job {	2536	that has to return the map if sucecssful, and then unfreezes the player on
1533	$pl->ob->leave_link	2537	the new (success) or old (failed) map position. In either case, $done will
1534	};	2538	be called at the end of this process.
1535	}
1536	},
1537	on_login => sub {
1538	my ($pl) = @_;
1539		2539
1540	# try to abort aborted map switching on player login :)	2540	Note that $check will be called with a potentially non-loaded map, so if
1541	# should happen only on crashes	2541	it needs a loaded map it has to call C<< ->load >>.
1542	if ($pl->ob->{_link_pos}) {
1543	$pl->ob->enter_link;
1544	Coro::async_pool {
1545	# we need this sleep as the login has a concurrent enter_exit running
1546	# and this sleep increases chances of the player not ending up in scorn
1547	Coro::Timer::sleep 1;
1548	$pl->ob->leave_link;
1549	};
1550	}
1551	},
1552	);
1553		2542
1554	=item $player_object->goto ($path, $x, $y)
1555
1556	=cut	2543	=cut
		2544
		2545	our $GOTOGEN;
1557		2546
1558	sub cf::object::player::goto {	2547	sub cf::object::player::goto {
1559	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;
1560		2552
1561	$self->enter_link;	2553	$self->enter_link;
1562		2554
1563	(Coro::async_pool {	2555	(async {
1564	$path = new cf::path $path;	2556	$Coro::current->{desc} = "player::goto $path $x $y";
1565		2557
1566	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) {
1567	$map = $map->customise_for ($self) if $map;	2581	$map = $map->customise_for ($self);
1568		2582	$map = $check->($map) if $check && $map;
1569	# warn "entering ", $map->path, " at ($x, $y)\n"	2583	} else {
1570	# if $map;
1571
1572	$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	}
1573		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};
1574	$self->leave_link ($map, $x, $y);	2597	$self->leave_link ($map, $x, $y);
		2598	}
		2599
		2600	$done->() if $done;
1575	})->prio (1);	2601	})->prio (1);
1576	}	2602	}
1577		2603
1578	=item $player_object->enter_exit ($exit_object)	2604	=item $player_object->enter_exit ($exit_object)
1579		2605
…		…
1581		2607
1582	sub parse_random_map_params {	2608	sub parse_random_map_params {
1583	my ($spec) = @_;	2609	my ($spec) = @_;
1584		2610
1585	my $rmp = { # defaults	2611	my $rmp = { # defaults
1586	xsize => 10,	2612	xsize => (cf::rndm 15, 40),
1587	ysize => 10,	2613	ysize => (cf::rndm 15, 40),
		2614	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2615	#layout => string,
1588	};	2616	};
1589		2617
1590	for (split /\n/, $spec) {	2618	for (split /\n/, $spec) {
1591	my ($k, $v) = split /\s+/, $_, 2;	2619	my ($k, $v) = split /\s+/, $_, 2;
1592		2620
…		…
1604	# that depends on the exit object	2632	# that depends on the exit object
1605		2633
1606	my $rmp = parse_random_map_params $exit->msg;	2634	my $rmp = parse_random_map_params $exit->msg;
1607		2635
1608	if ($exit->map) {	2636	if ($exit->map) {
1609	$rmp->{region} = $exit->map->region_name;	2637	$rmp->{region} = $exit->region->name;
1610	$rmp->{origin_map} = $exit->map->path;	2638	$rmp->{origin_map} = $exit->map->path;
1611	$rmp->{origin_x} = $exit->x;	2639	$rmp->{origin_x} = $exit->x;
1612	$rmp->{origin_y} = $exit->y;	2640	$rmp->{origin_y} = $exit->y;
		2641
		2642	$exit->map->touch;
1613	}	2643	}
1614		2644
1615	$rmp->{random_seed} ||= $exit->random_seed;	2645	$rmp->{random_seed} ||= $exit->random_seed;
1616		2646
1617	my $data = cf::to_json $rmp;	2647	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1618	my $md5 = Digest::MD5::md5_hex $data;	2648	my $md5 = Digest::MD5::md5_hex $data;
		2649	my $meta = "$RANDOMDIR/$md5.meta";
1619		2650
1620	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) {
1621	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;
1622		2655
		2656	my $slaying = "?random/$md5";
		2657
		2658	if ($exit->valid) {
1623	$exit->slaying ("?random/$md5");	2659	$exit->slaying ("?random/$md5");
1624	$exit->msg (undef);	2660	$exit->msg (undef);
		2661	}
1625	}	2662	}
1626	}	2663	}
1627		2664
1628	sub cf::object::player::enter_exit {	2665	sub cf::object::player::enter_exit {
1629	my ($self, $exit) = @_;	2666	my ($self, $exit) = @_;
1630		2667
1631	return unless $self->type == cf::PLAYER;	2668	return unless $self->type == cf::PLAYER;
1632		2669
1633	$self->enter_link;	2670	$self->enter_link;
1634		2671
1635	(Coro::async_pool {	2672	(async {
1636	$self->deactivate_recursive; # just to be sure	2673	$Coro::current->{desc} = "enter_exit";
		2674
1637	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
1638	prepare_random_map $exit	2682	prepare_random_map $exit
1639	if $exit->slaying eq "/!";	2683	if $exit->slaying eq "/!";
		2684	}
1640		2685
1641	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;
1642	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2687	my $x = $exit->stats->hp;
		2688	my $y = $exit->stats->sp;
1643		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
1644	1;	2696	1
1645	}) {	2697	}) {
1646	$self->message ("Something went wrong deep within the crossfire server. "	2698	$self->message ("Something went wrong deep within the deliantra server. "
1647	. "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. "
1648	. "Please report this to the dungeon master",	2700	. "Please report this to the dungeon master!",
1649	cf::NDI_UNIQUE | cf::NDI_RED);	2701	cf::NDI_UNIQUE | cf::NDI_RED);
1650		2702
1651	warn "ERROR in enter_exit: $@";	2703	warn "ERROR in enter_exit: $@";
1652	$self->leave_link;	2704	$self->leave_link;
1653	}	2705	}
1654	})->prio (1);	2706	})->prio (1);
…		…
1667		2719
1668	sub cf::client::send_drawinfo {	2720	sub cf::client::send_drawinfo {
1669	my ($self, $text, $flags) = @_;	2721	my ($self, $text, $flags) = @_;
1670		2722
1671	utf8::encode $text;	2723	utf8::encode $text;
1672	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2724	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1673	}	2725	}
1674		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/skills" => {
		2775	id => "infobox",
		2776	title => "Skills",
		2777	reply => undef,
		2778	tooltip => "Shows your experience per skill and item power",
		2779	},
		2780	"c/uptime" => {
		2781	id => "infobox",
		2782	title => "Uptime",
		2783	reply => undef,
		2784	tooltip => "How long the server has been running since last restart",
		2785	},
		2786	"c/mapinfo" => {
		2787	id => "infobox",
		2788	title => "Map Info",
		2789	reply => undef,
		2790	tooltip => "Information related to the maps",
		2791	},
		2792	"c/party" => {
		2793	id => "party",
		2794	title => "Party",
		2795	reply => "gsay ",
		2796	tooltip => "Messages and chat related to your party",
		2797	},
		2798	"c/death" => {
		2799	id => "death",
		2800	title => "Death",
		2801	reply => undef,
		2802	tooltip => "Reason for and more info about your most recent death",
		2803	},
		2804	"c/say" => $SAY_CHANNEL,
		2805	"c/chat" => $CHAT_CHANNEL,
		2806	);
		2807
		2808	sub cf::client::send_msg {
		2809	my ($self, $channel, $msg, $color, @extra) = @_;
		2810
		2811	$msg = $self->pl->expand_cfpod ($msg)
		2812	unless $color & cf::NDI_VERBATIM;
		2813
		2814	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2815
		2816	# check predefined channels, for the benefit of C
		2817	if ($CHANNEL{$channel}) {
		2818	$channel = $CHANNEL{$channel};
		2819
		2820	$self->ext_msg (channel_info => $channel);
		2821	$channel = $channel->{id};
		2822
		2823	} elsif (ref $channel) {
		2824	# send meta info to client, if not yet sent
		2825	unless (exists $self->{channel}{$channel->{id}}) {
		2826	$self->{channel}{$channel->{id}} = $channel;
		2827	$self->ext_msg (channel_info => $channel);
		2828	}
		2829
		2830	$channel = $channel->{id};
		2831	}
		2832
		2833	return unless @extra || length $msg;
		2834
		2835	# default colour, mask it out
		2836	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2837	if $color & cf::NDI_DEF;
		2838
		2839	my $pkt = "msg "
		2840	. $self->{json_coder}->encode (
		2841	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2842	);
		2843
		2844	# try lzf for large packets
		2845	$pkt = "lzf " . Compress::LZF::compress $pkt
		2846	if 1024 <= length $pkt and $self->{can_lzf};
		2847
		2848	# split very large packets
		2849	if (8192 < length $pkt and $self->{can_lzf}) {
		2850	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2851	$pkt = "frag";
		2852	}
		2853
		2854	$self->send_packet ($pkt);
		2855	}
		2856
		2857	=item $client->ext_msg ($type, @msg)
		2858
		2859	Sends an ext event to the client.
		2860
		2861	=cut
		2862
		2863	sub cf::client::ext_msg($$@) {
		2864	my ($self, $type, @msg) = @_;
		2865
		2866	if ($self->extcmd == 2) {
		2867	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2868	} elsif ($self->extcmd == 1) { # TODO: remove
		2869	push @msg, msgtype => "event_$type";
		2870	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2871	}
		2872	}
		2873
		2874	=item $client->ext_reply ($msgid, @msg)
		2875
		2876	Sends an ext reply to the client.
		2877
		2878	=cut
		2879
		2880	sub cf::client::ext_reply($$@) {
		2881	my ($self, $id, @msg) = @_;
		2882
		2883	if ($self->extcmd == 2) {
		2884	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2885	} elsif ($self->extcmd == 1) {
		2886	#TODO: version 1, remove
		2887	unshift @msg, msgtype => "reply", msgid => $id;
		2888	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2889	}
		2890	}
1675		2891
1676	=item $success = $client->query ($flags, "text", \&cb)	2892	=item $success = $client->query ($flags, "text", \&cb)
1677		2893
1678	Queues a query to the client, calling the given callback with	2894	Queues a query to the client, calling the given callback with
1679	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2895	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1680	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2896	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1681		2897
1682	Queries can fail, so check the return code. Or don't, as queries will become	2898	Queries can fail, so check the return code. Or don't, as queries will
1683	reliable at some point in the future.	2899	become reliable at some point in the future.
1684		2900
1685	=cut	2901	=cut
1686		2902
1687	sub cf::client::query {	2903	sub cf::client::query {
1688	my ($self, $flags, $text, $cb) = @_;	2904	my ($self, $flags, $text, $cb) = @_;
…		…
1696	utf8::encode $text;	2912	utf8::encode $text;
1697	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2913	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1698		2914
1699	$self->send_packet ($self->{query_queue}[0][0])	2915	$self->send_packet ($self->{query_queue}[0][0])
1700	if @{ $self->{query_queue} } == 1;	2916	if @{ $self->{query_queue} } == 1;
		2917
		2918	1
1701	}	2919	}
1702		2920
1703	cf::client->attach (	2921	cf::client->attach (
		2922	on_connect => sub {
		2923	my ($ns) = @_;
		2924
		2925	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2926	},
1704	on_reply => sub {	2927	on_reply => sub {
1705	my ($ns, $msg) = @_;	2928	my ($ns, $msg) = @_;
1706		2929
1707	# this weird shuffling is so that direct followup queries	2930	# this weird shuffling is so that direct followup queries
1708	# get handled first	2931	# get handled first
1709	my $queue = delete $ns->{query_queue}	2932	my $queue = delete $ns->{query_queue}
1710	or return; # be conservative, not sure how that can happen, but we saw a crash here	2933	or return; # be conservative, not sure how that can happen, but we saw a crash here
1711		2934
1712	(shift @$queue)->[1]->($msg);	2935	(shift @$queue)->[1]->($msg);
		2936	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1713		2937
1714	push @{ $ns->{query_queue} }, @$queue;	2938	push @{ $ns->{query_queue} }, @$queue;
1715		2939
1716	if (@{ $ns->{query_queue} } == @$queue) {	2940	if (@{ $ns->{query_queue} } == @$queue) {
1717	if (@$queue) {	2941	if (@$queue) {
…		…
1719	} else {	2943	} else {
1720	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2944	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1721	}	2945	}
1722	}	2946	}
1723	},	2947	},
		2948	on_exticmd => sub {
		2949	my ($ns, $buf) = @_;
		2950
		2951	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2952
		2953	if (ref $msg) {
		2954	my ($type, $reply, @payload) =
		2955	"ARRAY" eq ref $msg
		2956	? @$msg
		2957	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2958
		2959	my @reply;
		2960
		2961	if (my $cb = $EXTICMD{$type}) {
		2962	@reply = $cb->($ns, @payload);
		2963	}
		2964
		2965	$ns->ext_reply ($reply, @reply)
		2966	if $reply;
		2967
		2968	} else {
		2969	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2970	}
		2971
		2972	cf::override;
		2973	},
1724	);	2974	);
1725		2975
1726	=item $client->coro (\&cb)	2976	=item $client->async (\&cb)
1727		2977
1728	Create a new coroutine, running the specified callback. The coroutine will	2978	Create a new coroutine, running the specified callback. The coroutine will
1729	be automatically cancelled when the client gets destroyed (e.g. on logout,	2979	be automatically cancelled when the client gets destroyed (e.g. on logout,
1730	or loss of connection).	2980	or loss of connection).
1731		2981
1732	=cut	2982	=cut
1733		2983
1734	sub cf::client::coro {	2984	sub cf::client::async {
1735	my ($self, $cb) = @_;	2985	my ($self, $cb) = @_;
1736		2986
1737	my $coro = &Coro::async_pool ($cb);	2987	my $coro = &Coro::async ($cb);
1738		2988
1739	$coro->on_destroy (sub {	2989	$coro->on_destroy (sub {
1740	delete $self->{_coro}{$coro+0};	2990	delete $self->{_coro}{$coro+0};
1741	});	2991	});
1742		2992
…		…
1769	our $safe = new Safe "safe";	3019	our $safe = new Safe "safe";
1770	our $safe_hole = new Safe::Hole;	3020	our $safe_hole = new Safe::Hole;
1771		3021
1772	$SIG{FPE} = 'IGNORE';	3022	$SIG{FPE} = 'IGNORE';
1773		3023
1774	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3024	$safe->permit_only (Opcode::opset qw(
		3025	:base_core :base_mem :base_orig :base_math
		3026	grepstart grepwhile mapstart mapwhile
		3027	sort time
		3028	));
1775		3029
1776	# here we export the classes and methods available to script code	3030	# here we export the classes and methods available to script code
1777		3031
1778	=pod	3032	=pod
1779		3033
1780	The following fucntions and emthods are available within a safe environment:	3034	The following functions and methods are available within a safe environment:
1781		3035
1782	cf::object contr pay_amount pay_player map	3036	cf::object
		3037	contr pay_amount pay_player map x y force_find force_add destroy
		3038	insert remove name archname title slaying race decrease split
		3039
1783	cf::object::player player	3040	cf::object::player
1784	cf::player peaceful	3041	player
1785	cf::map trigger	3042
		3043	cf::player
		3044	peaceful
		3045
		3046	cf::map
		3047	trigger
1786		3048
1787	=cut	3049	=cut
1788		3050
1789	for (	3051	for (
1790	["cf::object" => qw(contr pay_amount pay_player map)],	3052	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3053	insert remove inv nrof name archname title slaying race
		3054	decrease split destroy change_exp)],
1791	["cf::object::player" => qw(player)],	3055	["cf::object::player" => qw(player)],
1792	["cf::player" => qw(peaceful)],	3056	["cf::player" => qw(peaceful)],
1793	["cf::map" => qw(trigger)],	3057	["cf::map" => qw(trigger)],
1794	) {	3058	) {
1795	no strict 'refs';	3059	no strict 'refs';
…		…
1866	=back	3130	=back
1867		3131
1868	=cut	3132	=cut
1869		3133
1870	#############################################################################	3134	#############################################################################
		3135	# the server's init and main functions
1871		3136
1872	=head2 EXTENSION DATABASE SUPPORT	3137	sub load_facedata($) {
		3138	my ($path) = @_;
1873		3139
1874	Crossfire maintains a very simple database for extension use. It can	3140	# HACK to clear player env face cache, we need some signal framework
1875	currently store anything that can be serialised using Storable, which	3141	# for this (global event?)
1876	excludes objects.	3142	%ext::player_env::MUSIC_FACE_CACHE = ();
1877		3143
1878	The parameter C<$family> should best start with the name of the extension	3144	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1879	using it, it should be unique.
1880		3145
1881	=over 4	3146	warn "loading facedata from $path\n";
1882		3147
1883	=item $hashref = cf::db_get $family	3148	my $facedata;
		3149	0 < aio_load $path, $facedata
		3150	or die "$path: $!";
1884		3151
1885	Return a hashref for use by the extension C<$family>, which can be	3152	$facedata = Coro::Storable::thaw $facedata;
1886	modified. After modifications, you have to call C<cf::db_dirty> or
1887	C<cf::db_sync>.
1888		3153
1889	=item $value = cf::db_get $family => $key	3154	$facedata->{version} == 2
		3155	or cf::cleanup "$path: version mismatch, cannot proceed.";
1890		3156
1891	Returns a single value from the database	3157	# patch in the exptable
1892		3158	$facedata->{resource}{"res/exp_table"} = {
1893	=item cf::db_put $family => $hashref	3159	type => FT_RSRC,
1894		3160	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1895	Stores the given family hashref into the database. Updates are delayed, if
1896	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1897
1898	=item cf::db_put $family => $key => $value
1899
1900	Stores the given C<$value> in the family hash. Updates are delayed, if you
1901	want the data to be synced to disk immediately, use C<cf::db_sync>.
1902
1903	=item cf::db_dirty
1904
1905	Marks the database as dirty, to be updated at a later time.
1906
1907	=item cf::db_sync
1908
1909	Immediately write the database to disk I<if it is dirty>.
1910
1911	=cut
1912
1913	our $DB;
1914
1915	{
1916	my $path = cf::localdir . "/database.pst";
1917
1918	sub db_load() {
1919	$DB = stat $path ? Storable::retrieve $path : { };
1920	}
1921
1922	my $pid;
1923
1924	sub db_save() {
1925	waitpid $pid, 0 if $pid;
1926	if (0 == ($pid = fork)) {
1927	$DB->{_meta}{version} = 1;
1928	Storable::nstore $DB, "$path~";
1929	rename "$path~", $path;
1930	cf::_exit 0 if defined $pid;
1931	}
1932	}
1933
1934	my $dirty;
1935
1936	sub db_sync() {
1937	db_save if $dirty;
1938	undef $dirty;
1939	}
1940
1941	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1942	db_sync;
1943	});	3161	};
		3162	cf::cede_to_tick;
1944		3163
1945	sub db_dirty() {
1946	$dirty = 1;
1947	$idle->start;
1948	}	3164	{
		3165	my $faces = $facedata->{faceinfo};
1949		3166
1950	sub db_get($;$) {	3167	while (my ($face, $info) = each %$faces) {
1951	@_ >= 2	3168	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1952	? $DB->{$_[0]}{$_[1]}
1953	: ($DB->{$_[0]} ||= { })
1954	}
1955		3169
1956	sub db_put($$;$) {	3170	cf::face::set_visibility $idx, $info->{visibility};
1957	if (@_ >= 3) {	3171	cf::face::set_magicmap $idx, $info->{magicmap};
1958	$DB->{$_[0]}{$_[1]} = $_[2];	3172	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1959	} else {	3173	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1960	$DB->{$_[0]} = $_[1];
1961	}
1962	db_dirty;
1963	}
1964		3174
1965	cf::global->attach (	3175	cf::cede_to_tick;
1966	prio => 10000,
1967	on_cleanup => sub {
1968	db_sync;
1969	},	3176	}
1970	);
1971	}
1972		3177
1973	#############################################################################	3178	while (my ($face, $info) = each %$faces) {
1974	# the server's main()	3179	next unless $info->{smooth};
1975		3180
1976	sub cfg_load {	3181	my $idx = cf::face::find $face
		3182	or next;
		3183
		3184	if (my $smooth = cf::face::find $info->{smooth}) {
		3185	cf::face::set_smooth $idx, $smooth;
		3186	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3187	} else {
		3188	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3189	}
		3190
		3191	cf::cede_to_tick;
		3192	}
		3193	}
		3194
		3195	{
		3196	my $anims = $facedata->{animinfo};
		3197
		3198	while (my ($anim, $info) = each %$anims) {
		3199	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3200	cf::cede_to_tick;
		3201	}
		3202
		3203	cf::anim::invalidate_all; # d'oh
		3204	}
		3205
		3206	{
		3207	# TODO: for gcfclient pleasure, we should give resources
		3208	# that gcfclient doesn't grok a >10000 face index.
		3209	my $res = $facedata->{resource};
		3210
		3211	while (my ($name, $info) = each %$res) {
		3212	if (defined $info->{type}) {
		3213	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3214	my $data;
		3215
		3216	if ($info->{type} & 1) {
		3217	# prepend meta info
		3218
		3219	my $meta = $enc->encode ({
		3220	name => $name,
		3221	%{ $info->{meta} || {} },
		3222	});
		3223
		3224	$data = pack "(w/a*)*", $meta, $info->{data};
		3225	} else {
		3226	$data = $info->{data};
		3227	}
		3228
		3229	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3230	cf::face::set_type $idx, $info->{type};
		3231	} else {
		3232	$RESOURCE{$name} = $info;
		3233	}
		3234
		3235	cf::cede_to_tick;
		3236	}
		3237	}
		3238
		3239	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3240
		3241	1
		3242	}
		3243
		3244	cf::global->attach (on_resource_update => sub {
		3245	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3246	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3247
		3248	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3249	my $sound = $soundconf->{compat}[$_]
		3250	or next;
		3251
		3252	my $face = cf::face::find "sound/$sound->[1]";
		3253	cf::sound::set $sound->[0] => $face;
		3254	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3255	}
		3256
		3257	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3258	my $face = cf::face::find "sound/$v";
		3259	cf::sound::set $k => $face;
		3260	}
		3261	}
		3262	});
		3263
		3264	register_exticmd fx_want => sub {
		3265	my ($ns, $want) = @_;
		3266
		3267	while (my ($k, $v) = each %$want) {
		3268	$ns->fx_want ($k, $v);
		3269	}
		3270	};
		3271
		3272	sub load_resource_file($) {
		3273	my $guard = lock_acquire "load_resource_file";
		3274
		3275	my $status = load_resource_file_ $_[0];
		3276	get_slot 0.1, 100;
		3277	cf::arch::commit_load;
		3278
		3279	$status
		3280	}
		3281
		3282	sub reload_regions {
		3283	# HACK to clear player env face cache, we need some signal framework
		3284	# for this (global event?)
		3285	%ext::player_env::MUSIC_FACE_CACHE = ();
		3286
		3287	load_resource_file "$MAPDIR/regions"
		3288	or die "unable to load regions file\n";
		3289
		3290	for (cf::region::list) {
		3291	$_->{match} = qr/$_->{match}/
		3292	if exists $_->{match};
		3293	}
		3294	}
		3295
		3296	sub reload_facedata {
		3297	load_facedata "$DATADIR/facedata"
		3298	or die "unable to load facedata\n";
		3299	}
		3300
		3301	sub reload_archetypes {
		3302	load_resource_file "$DATADIR/archetypes"
		3303	or die "unable to load archetypes\n";
		3304	}
		3305
		3306	sub reload_treasures {
		3307	load_resource_file "$DATADIR/treasures"
		3308	or die "unable to load treasurelists\n";
		3309	}
		3310
		3311	sub reload_resources {
		3312	warn "reloading resource files...\n";
		3313
		3314	reload_facedata;
		3315	reload_archetypes;
		3316	reload_regions;
		3317	reload_treasures;
		3318
		3319	warn "finished reloading resource files\n";
		3320	}
		3321
		3322	sub reload_config {
1977	open my $fh, "<:utf8", cf::confdir . "/config"	3323	open my $fh, "<:utf8", "$CONFDIR/config"
1978	or return;	3324	or return;
1979		3325
1980	local $/;	3326	local $/;
1981	*CFG = YAML::Syck::Load <$fh>;	3327	*CFG = YAML::Load <$fh>;
1982		3328
1983	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3329	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3330
		3331	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3332	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
1984		3333
1985	if (exists $CFG{mlockall}) {	3334	if (exists $CFG{mlockall}) {
1986	eval {	3335	eval {
1987	$CFG{mlockall} ? &mlockall : &munlockall	3336	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1988	and die "WARNING: m(un)lockall failed: $!\n";	3337	and die "WARNING: m(un)lockall failed: $!\n";
1989	};	3338	};
1990	warn $@ if $@;	3339	warn $@ if $@;
1991	}	3340	}
1992	}	3341	}
1993		3342
		3343	sub pidfile() {
		3344	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3345	or die "$PIDFILE: $!";
		3346	flock $fh, &Fcntl::LOCK_EX
		3347	or die "$PIDFILE: flock: $!";
		3348	$fh
		3349	}
		3350
		3351	# make sure only one server instance is running at any one time
		3352	sub atomic {
		3353	my $fh = pidfile;
		3354
		3355	my $pid = <$fh>;
		3356	kill 9, $pid if $pid > 0;
		3357
		3358	seek $fh, 0, 0;
		3359	print $fh $$;
		3360	}
		3361
1994	sub main {	3362	sub main {
		3363	cf::init_globals; # initialise logging
		3364
		3365	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3366	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3367	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3368	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3369
		3370	cf::init_experience;
		3371	cf::init_anim;
		3372	cf::init_attackmess;
		3373	cf::init_dynamic;
		3374
		3375	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3376
1995	# we must not ever block the main coroutine	3377	# we must not ever block the main coroutine
1996	local $Coro::idle = sub {	3378	local $Coro::idle = sub {
1997	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3379	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1998	(Coro::unblock_sub {	3380	(async {
1999	Event::one_event;	3381	$Coro::current->{desc} = "IDLE BUG HANDLER";
2000	})->();	3382	EV::loop EV::LOOP_ONESHOT;
		3383	})->prio (Coro::PRIO_MAX);
2001	};	3384	};
2002		3385
2003	cfg_load;	3386	evthread_start IO::AIO::poll_fileno;
2004	db_load;	3387
		3388	cf::sync_job {
		3389	reload_resources;
		3390	reload_config;
		3391	db_init;
		3392
		3393	cf::load_settings;
		3394	cf::load_materials;
		3395	cf::init_uuid;
		3396	cf::init_signals;
		3397	cf::init_commands;
		3398	cf::init_skills;
		3399
		3400	cf::init_beforeplay;
		3401
		3402	atomic;
		3403
2005	load_extensions;	3404	load_extensions;
		3405
		3406	utime time, time, $RUNTIMEFILE;
		3407
		3408	# no (long-running) fork's whatsoever before this point(!)
		3409	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3410
		3411	(pop @POST_INIT)->(0) while @POST_INIT;
		3412	};
		3413
2006	Event::loop;	3414	EV::loop;
2007	}	3415	}
2008		3416
2009	#############################################################################	3417	#############################################################################
2010	# initialisation	3418	# initialisation and cleanup
2011		3419
		3420	# install some emergency cleanup handlers
		3421	BEGIN {
		3422	our %SIGWATCHER = ();
		3423	for my $signal (qw(INT HUP TERM)) {
		3424	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3425	cf::cleanup "SIG$signal";
		3426	};
		3427	}
		3428	}
		3429
		3430	sub write_runtime_sync {
		3431	# first touch the runtime file to show we are still running:
		3432	# the fsync below can take a very very long time.
		3433
		3434	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3435
		3436	my $guard = cf::lock_acquire "write_runtime";
		3437
		3438	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3439	or return;
		3440
		3441	my $value = $cf::RUNTIME + 90 + 10;
		3442	# 10 is the runtime save interval, for a monotonic clock
		3443	# 60 allows for the watchdog to kill the server.
		3444
		3445	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3446	and return;
		3447
		3448	# always fsync - this file is important
		3449	aio_fsync $fh
		3450	and return;
		3451
		3452	# touch it again to show we are up-to-date
		3453	aio_utime $fh, undef, undef;
		3454
		3455	close $fh
		3456	or return;
		3457
		3458	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3459	and return;
		3460
		3461	warn "runtime file written.\n";
		3462
		3463	1
		3464	}
		3465
		3466	our $uuid_lock;
		3467	our $uuid_skip;
		3468
		3469	sub write_uuid_sync($) {
		3470	$uuid_skip ||= $_[0];
		3471
		3472	return if $uuid_lock;
		3473	local $uuid_lock = 1;
		3474
		3475	my $uuid = "$LOCALDIR/uuid";
		3476
		3477	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3478	or return;
		3479
		3480	my $value = uuid_seq uuid_cur;
		3481
		3482	unless ($value) {
		3483	warn "cowardly refusing to write zero uuid value!\n";
		3484	return;
		3485	}
		3486
		3487	my $value = uuid_str $value + $uuid_skip;
		3488	$uuid_skip = 0;
		3489
		3490	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3491	and return;
		3492
		3493	# always fsync - this file is important
		3494	aio_fsync $fh
		3495	and return;
		3496
		3497	close $fh
		3498	or return;
		3499
		3500	aio_rename "$uuid~", $uuid
		3501	and return;
		3502
		3503	warn "uuid file written ($value).\n";
		3504
		3505	1
		3506
		3507	}
		3508
		3509	sub write_uuid($$) {
		3510	my ($skip, $sync) = @_;
		3511
		3512	$sync ? write_uuid_sync $skip
		3513	: async { write_uuid_sync $skip };
		3514	}
		3515
		3516	sub emergency_save() {
		3517	my $freeze_guard = cf::freeze_mainloop;
		3518
		3519	warn "emergency_perl_save: enter\n";
		3520
		3521	cf::sync_job {
		3522	# this is a trade-off: we want to be very quick here, so
		3523	# save all maps without fsync, and later call a global sync
		3524	# (which in turn might be very very slow)
		3525	local $USE_FSYNC = 0;
		3526
		3527	# use a peculiar iteration method to avoid tripping on perl
		3528	# refcount bugs in for. also avoids problems with players
		3529	# and maps saved/destroyed asynchronously.
		3530	warn "emergency_perl_save: begin player save\n";
		3531	for my $login (keys %cf::PLAYER) {
		3532	my $pl = $cf::PLAYER{$login} or next;
		3533	$pl->valid or next;
		3534	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3535	$pl->save;
		3536	}
		3537	warn "emergency_perl_save: end player save\n";
		3538
		3539	warn "emergency_perl_save: begin map save\n";
		3540	for my $path (keys %cf::MAP) {
		3541	my $map = $cf::MAP{$path} or next;
		3542	$map->valid or next;
		3543	$map->save;
		3544	}
		3545	warn "emergency_perl_save: end map save\n";
		3546
		3547	warn "emergency_perl_save: begin database checkpoint\n";
		3548	BDB::db_env_txn_checkpoint $DB_ENV;
		3549	warn "emergency_perl_save: end database checkpoint\n";
		3550
		3551	warn "emergency_perl_save: begin write uuid\n";
		3552	write_uuid_sync 1;
		3553	warn "emergency_perl_save: end write uuid\n";
		3554	};
		3555
		3556	warn "emergency_perl_save: starting sync()\n";
		3557	IO::AIO::aio_sync sub {
		3558	warn "emergency_perl_save: finished sync()\n";
		3559	};
		3560
		3561	warn "emergency_perl_save: leave\n";
		3562	}
		3563
		3564	sub post_cleanup {
		3565	my ($make_core) = @_;
		3566
		3567	warn Carp::longmess "post_cleanup backtrace"
		3568	if $make_core;
		3569
		3570	my $fh = pidfile;
		3571	unlink $PIDFILE if <$fh> == $$;
		3572	}
		3573
		3574	# a safer delete_package, copied from Symbol
		3575	sub clear_package($) {
		3576	my $pkg = shift;
		3577
		3578	# expand to full symbol table name if needed
		3579	unless ($pkg =~ /^main::.*::$/) {
		3580	$pkg = "main$pkg" if $pkg =~ /^::/;
		3581	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3582	$pkg .= '::' unless $pkg =~ /::$/;
		3583	}
		3584
		3585	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3586	my $stem_symtab = *{$stem}{HASH};
		3587
		3588	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3589	or return;
		3590
		3591	# clear all symbols
		3592	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3593	for my $name (keys %$leaf_symtab) {
		3594	_gv_clear *{"$pkg$name"};
		3595	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3596	}
		3597	warn "cleared package $pkg\n";#d#
		3598	}
		3599
2012	sub reload() {	3600	sub do_reload_perl() {
2013	# can/must only be called in main	3601	# can/must only be called in main
2014	if ($Coro::current != $Coro::main) {	3602	if ($Coro::current != $Coro::main) {
2015	warn "can only reload from main coroutine\n";	3603	warn "can only reload from main coroutine";
2016	return;	3604	return;
2017	}	3605	}
2018		3606
		3607	return if $RELOAD++;
		3608
		3609	my $t1 = EV::time;
		3610
		3611	while ($RELOAD) {
2019	warn "reloading...";	3612	warn "reloading...";
2020		3613
2021	my $guard = freeze_mainloop;	3614	warn "entering sync_job";
		3615
		3616	cf::sync_job {
		3617	cf::write_runtime_sync; # external watchdog should not bark
2022	cf::emergency_save;	3618	cf::emergency_save;
		3619	cf::write_runtime_sync; # external watchdog should not bark
2023		3620
2024	eval {	3621	warn "syncing database to disk";
		3622	BDB::db_env_txn_checkpoint $DB_ENV;
		3623
2025	# if anything goes wrong in here, we should simply crash as we already saved	3624	# if anything goes wrong in here, we should simply crash as we already saved
2026		3625
2027	# cancel all watchers	3626	warn "flushing outstanding aio requests";
2028	for (Event::all_watchers) {	3627	while (IO::AIO::nreqs || BDB::nreqs) {
2029	$_->cancel if $_->data & WF_AUTOCANCEL;	3628	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2030	}
2031
2032	# cancel all extension coros
2033	$_->cancel for values %EXT_CORO;
2034	%EXT_CORO = ();
2035
2036	# unload all extensions
2037	for (@exts) {
2038	warn "unloading <$_>";
2039	unload_extension $_;
2040	}
2041
2042	# unload all modules loaded from $LIBDIR
2043	while (my ($k, $v) = each %INC) {
2044	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2045
2046	warn "removing <$k>";
2047	delete $INC{$k};
2048
2049	$k =~ s/\.pm$//;
2050	$k =~ s/\//::/g;
2051
2052	if (my $cb = $k->can ("unload_module")) {
2053	$cb->();
2054	}	3629	}
2055		3630
2056	Symbol::delete_package $k;	3631	warn "cancelling all extension coros";
		3632	$_->cancel for values %EXT_CORO;
		3633	%EXT_CORO = ();
		3634
		3635	warn "removing commands";
		3636	%COMMAND = ();
		3637
		3638	warn "removing ext/exti commands";
		3639	%EXTCMD = ();
		3640	%EXTICMD = ();
		3641
		3642	warn "unloading/nuking all extensions";
		3643	for my $pkg (@EXTS) {
		3644	warn "... unloading $pkg";
		3645
		3646	if (my $cb = $pkg->can ("unload")) {
		3647	eval {
		3648	$cb->($pkg);
		3649	1
		3650	} or warn "$pkg unloaded, but with errors: $@";
		3651	}
		3652
		3653	warn "... clearing $pkg";
		3654	clear_package $pkg;
2057	}	3655	}
2058		3656
2059	# sync database to disk	3657	warn "unloading all perl modules loaded from $LIBDIR";
2060	cf::db_sync;	3658	while (my ($k, $v) = each %INC) {
2061	IO::AIO::flush;	3659	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2062		3660
		3661	warn "... unloading $k";
		3662	delete $INC{$k};
		3663
		3664	$k =~ s/\.pm$//;
		3665	$k =~ s/\//::/g;
		3666
		3667	if (my $cb = $k->can ("unload_module")) {
		3668	$cb->();
		3669	}
		3670
		3671	clear_package $k;
		3672	}
		3673
2063	# get rid of safe::, as good as possible	3674	warn "getting rid of safe::, as good as possible";
2064	Symbol::delete_package "safe::$_"	3675	clear_package "safe::$_"
2065	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3676	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2066		3677
2067	# remove register_script_function callbacks	3678	warn "unloading cf.pm \"a bit\"";
2068	# TODO
2069
2070	# unload cf.pm "a bit"
2071	delete $INC{"cf.pm"};	3679	delete $INC{"cf.pm"};
		3680	delete $INC{"cf/pod.pm"};
2072		3681
2073	# don't, removes xs symbols, too,	3682	# don't, removes xs symbols, too,
2074	# and global variables created in xs	3683	# and global variables created in xs
2075	#Symbol::delete_package __PACKAGE__;	3684	#clear_package __PACKAGE__;
2076		3685
2077	# reload cf.pm	3686	warn "unload completed, starting to reload now";
		3687
2078	warn "reloading cf.pm";	3688	warn "reloading cf.pm";
2079	require cf;	3689	require cf;
2080	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3690	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2081		3691
2082	# load config and database again	3692	warn "loading config and database again";
2083	cf::cfg_load;	3693	cf::reload_config;
2084	cf::db_load;
2085		3694
2086	# load extensions
2087	warn "load extensions";	3695	warn "loading extensions";
2088	cf::load_extensions;	3696	cf::load_extensions;
2089		3697
2090	# reattach attachments to objects	3698	if ($REATTACH_ON_RELOAD) {
		3699	warn "reattaching attachments to objects/players";
		3700	_global_reattach; # objects, sockets
		3701	warn "reattaching attachments to maps";
		3702	reattach $_ for values %MAP;
		3703	warn "reattaching attachments to players";
		3704	reattach $_ for values %PLAYER;
		3705	}
		3706
		3707	warn "running post_init jobs";
		3708	(pop @POST_INIT)->(1) while @POST_INIT;
		3709
		3710	warn "leaving sync_job";
		3711
		3712	1
		3713	} or do {
		3714	warn $@;
		3715	cf::cleanup "error while reloading, exiting.";
		3716	};
		3717
2091	warn "reattach";	3718	warn "reloaded";
2092	_global_reattach;	3719	--$RELOAD;
		3720	}
		3721
		3722	$t1 = EV::time - $t1;
		3723	warn "reload completed in ${t1}s\n";
		3724	};
		3725
		3726	our $RELOAD_WATCHER; # used only during reload
		3727
		3728	sub reload_perl() {
		3729	# doing reload synchronously and two reloads happen back-to-back,
		3730	# coro crashes during coro_state_free->destroy here.
		3731
		3732	$RELOAD_WATCHER ||= cf::async {
		3733	Coro::AIO::aio_wait cache_extensions;
		3734
		3735	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3736	do_reload_perl;
		3737	undef $RELOAD_WATCHER;
		3738	};
2093	};	3739	};
2094
2095	if ($@) {
2096	warn $@;
2097	warn "error while reloading, exiting.";
2098	exit 1;
2099	}
2100
2101	warn "reloaded successfully";
2102	};
2103
2104	#############################################################################
2105
2106	unless ($LINK_MAP) {
2107	$LINK_MAP = cf::map::new;
2108
2109	$LINK_MAP->width (41);
2110	$LINK_MAP->height (41);
2111	$LINK_MAP->alloc;
2112	$LINK_MAP->path ("{link}");
2113	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2114	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2115
2116	# dirty hack because... archetypes are not yet loaded
2117	Event->timer (
2118	after => 2,
2119	cb => sub {
2120	$_[0]->w->cancel;
2121
2122	# provide some exits "home"
2123	my $exit = cf::object::new "exit";
2124
2125	$exit->slaying ($EMERGENCY_POSITION->[0]);
2126	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2127	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2128
2129	$LINK_MAP->insert ($exit->clone, 19, 19);
2130	$LINK_MAP->insert ($exit->clone, 19, 20);
2131	$LINK_MAP->insert ($exit->clone, 19, 21);
2132	$LINK_MAP->insert ($exit->clone, 20, 19);
2133	$LINK_MAP->insert ($exit->clone, 20, 21);
2134	$LINK_MAP->insert ($exit->clone, 21, 19);
2135	$LINK_MAP->insert ($exit->clone, 21, 20);
2136	$LINK_MAP->insert ($exit->clone, 21, 21);
2137
2138	$exit->destroy;
2139	});
2140
2141	$LINK_MAP->{deny_save} = 1;
2142	$LINK_MAP->{deny_reset} = 1;
2143
2144	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2145	}	3740	}
2146
2147	register "<global>", __PACKAGE__;
2148		3741
2149	register_command "reload" => sub {	3742	register_command "reload" => sub {
2150	my ($who, $arg) = @_;	3743	my ($who, $arg) = @_;
2151		3744
2152	if ($who->flag (FLAG_WIZ)) {	3745	if ($who->flag (FLAG_WIZ)) {
2153	$who->message ("start of reload.");
2154	reload;
2155	$who->message ("end of reload.");	3746	$who->message ("reloading server.");
		3747	async {
		3748	$Coro::current->{desc} = "perl_reload";
		3749	reload_perl;
		3750	};
2156	}	3751	}
2157	};	3752	};
2158		3753
2159	unshift @INC, $LIBDIR;	3754	unshift @INC, $LIBDIR;
2160		3755
2161	$TICK_WATCHER = Event->timer (	3756	my $bug_warning = 0;
2162	reentrant => 0,	3757
2163	prio => 0,	3758	our @WAIT_FOR_TICK;
2164	at => $NEXT_TICK || $TICK,	3759	our @WAIT_FOR_TICK_BEGIN;
2165	data => WF_AUTOCANCEL,	3760
2166	cb => sub {	3761	sub wait_for_tick {
		3762	return if tick_inhibit || $Coro::current == $Coro::main;
		3763
		3764	my $signal = new Coro::Signal;
		3765	push @WAIT_FOR_TICK, $signal;
		3766	$signal->wait;
		3767	}
		3768
		3769	sub wait_for_tick_begin {
		3770	return if tick_inhibit || $Coro::current == $Coro::main;
		3771
		3772	my $signal = new Coro::Signal;
		3773	push @WAIT_FOR_TICK_BEGIN, $signal;
		3774	$signal->wait;
		3775	}
		3776
		3777	sub tick {
		3778	if ($Coro::current != $Coro::main) {
		3779	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3780	unless ++$bug_warning > 10;
		3781	return;
		3782	}
		3783
2167	cf::server_tick; # one server iteration	3784	cf::server_tick; # one server iteration
2168	$RUNTIME += $TICK;
2169	$NEXT_TICK += $TICK;
2170		3785
2171	# if we are delayed by four ticks or more, skip them all	3786	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2172	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3787	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2173		3788	Coro::async_pool {
2174	$TICK_WATCHER->at ($NEXT_TICK);	3789	$Coro::current->{desc} = "runtime saver";
2175	$TICK_WATCHER->start;
2176	},
2177	);
2178
2179	IO::AIO::max_poll_time $TICK * 0.2;
2180
2181	Event->io (
2182	fd => IO::AIO::poll_fileno,
2183	poll => 'r',
2184	prio => 5,
2185	data => WF_AUTOCANCEL,
2186	cb => \&IO::AIO::poll_cb,
2187	);
2188
2189	Event->timer (
2190	data => WF_AUTOCANCEL,
2191	after => 0,
2192	interval => 10,
2193	cb => sub {
2194	(Coro::unblock_sub {
2195	write_runtime	3790	write_runtime_sync
2196	or warn "ERROR: unable to write runtime file: $!";	3791	or warn "ERROR: unable to write runtime file: $!";
2197	})->();	3792	};
2198	},	3793	}
2199	);	3794
		3795	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3796	$sig->send;
		3797	}
		3798	while (my $sig = shift @WAIT_FOR_TICK) {
		3799	$sig->send;
		3800	}
		3801
		3802	$LOAD = ($NOW - $TICK_START) / $TICK;
		3803	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3804
		3805	if (0) {
		3806	if ($NEXT_TICK) {
		3807	my $jitter = $TICK_START - $NEXT_TICK;
		3808	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3809	warn "jitter $JITTER\n";#d#
		3810	}
		3811	}
		3812	}
		3813
		3814	{
		3815	# configure BDB
		3816
		3817	BDB::min_parallel 8;
		3818	BDB::max_poll_reqs $TICK * 0.1;
		3819	$AnyEvent::BDB::WATCHER->priority (1);
		3820
		3821	unless ($DB_ENV) {
		3822	$DB_ENV = BDB::db_env_create;
		3823	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3824	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3825	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3826	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3827	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3828
		3829	cf::sync_job {
		3830	eval {
		3831	BDB::db_env_open
		3832	$DB_ENV,
		3833	$BDBDIR,
		3834	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3835	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3836	0666;
		3837
		3838	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3839	};
		3840
		3841	cf::cleanup "db_env_open(db): $@" if $@;
		3842	};
		3843	}
		3844
		3845	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3846	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3847	};
		3848	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3849	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3850	};
		3851	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3852	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3853	};
		3854	}
		3855
		3856	{
		3857	# configure IO::AIO
		3858
		3859	IO::AIO::min_parallel 8;
		3860	IO::AIO::max_poll_time $TICK * 0.1;
		3861	undef $AnyEvent::AIO::WATCHER;
		3862	}
		3863
		3864	my $_log_backtrace;
		3865
		3866	sub _log_backtrace {
		3867	my ($msg, @addr) = @_;
		3868
		3869	$msg =~ s/\n//;
		3870
		3871	# limit the # of concurrent backtraces
		3872	if ($_log_backtrace < 2) {
		3873	++$_log_backtrace;
		3874	my $perl_bt = Carp::longmess $msg;
		3875	async {
		3876	$Coro::current->{desc} = "abt $msg";
		3877
		3878	my @bt = fork_call {
		3879	@addr = map { sprintf "%x", $_ } @addr;
		3880	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3881	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3882	or die "addr2line: $!";
		3883
		3884	my @funcs;
		3885	my @res = <$fh>;
		3886	chomp for @res;
		3887	while (@res) {
		3888	my ($func, $line) = splice @res, 0, 2, ();
		3889	push @funcs, "[$func] $line";
		3890	}
		3891
		3892	@funcs
		3893	};
		3894
		3895	LOG llevInfo, "[ABT] $perl_bt\n";
		3896	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		3897	LOG llevInfo, "[ABT] $_\n" for @bt;
		3898	--$_log_backtrace;
		3899	};
		3900	} else {
		3901	LOG llevInfo, "[ABT] $msg\n";
		3902	LOG llevInfo, "[ABT] [suppressed]\n";
		3903	}
		3904	}
		3905
		3906	# load additional modules
		3907	use cf::pod;
2200		3908
2201	END { cf::emergency_save }	3909	END { cf::emergency_save }
2202		3910
2203	1	3911	1
2204		3912

Diff Legend

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