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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.462 by root, Tue Dec 23 06:58:23 2008 UTC

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

Diff Legend

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