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.461 by root, Fri Dec 19 22:47:29 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	)
		1738	}
		1739
		1740	=item cf::map->register ($regex, $prio)
		1741
		1742	Register a handler for the map path matching the given regex at the
		1743	givne priority (higher is better, built-in handlers have priority 0, the
		1744	default).
		1745
		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 {
		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"
1139	}	1865	}
1140		1866
1141	# and all this just because we cannot iterate over	1867	# and all this just because we cannot iterate over
1142	# all maps in C++...	1868	# all maps in C++...
1143	sub change_all_map_light {	1869	sub change_all_map_light {
…		…
1145		1871
1146	$_->change_map_light ($change)	1872	$_->change_map_light ($change)
1147	for grep $_->outdoor, values %cf::MAP;	1873	for grep $_->outdoor, values %cf::MAP;
1148	}	1874	}
1149		1875
		1876	sub decay_objects {
		1877	my ($self) = @_;
		1878
		1879	return if $self->{deny_reset};
		1880
		1881	$self->do_decay_objects;
		1882	}
		1883
		1884	sub unlink_save {
		1885	my ($self) = @_;
		1886
		1887	utf8::encode (my $save = $self->save_path);
		1888	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1889	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1890	}
		1891
1150	sub try_load_header($) {	1892	sub load_header_from($) {
1151	my ($path) = @_;	1893	my ($self, $path) = @_;
1152		1894
1153	utf8::encode $path;	1895	utf8::encode $path;
1154	aio_open $path, O_RDONLY, 0	1896	my $f = new_from_file cf::object::thawer $path
1155	or return;	1897	or return;
1156		1898
1157	my $map = cf::map::new	1899	$self->_load_header ($f)
1158	or return;	1900	or return;
1159		1901
1160	# for better error messages only, will be overwritten	1902	local $MAP_LOADING{$self->{path}} = $self;
1161	$map->path ($path);	1903	$f->resolve_delayed_derefs;
1162		1904
1163	$map->load_header ($path)	1905	$self->{load_path} = $path;
		1906
		1907	1
		1908	}
		1909
		1910	sub load_header_orig {
		1911	my ($self) = @_;
		1912
		1913	$self->load_header_from ($self->load_path)
		1914	}
		1915
		1916	sub load_header_temp {
		1917	my ($self) = @_;
		1918
		1919	$self->load_header_from ($self->save_path)
		1920	}
		1921
		1922	sub prepare_temp {
		1923	my ($self) = @_;
		1924
		1925	$self->last_access ((delete $self->{last_access})
		1926	|| $cf::RUNTIME); #d#
		1927	# safety
		1928	$self->{instantiate_time} = $cf::RUNTIME
		1929	if $self->{instantiate_time} > $cf::RUNTIME;
		1930	}
		1931
		1932	sub prepare_orig {
		1933	my ($self) = @_;
		1934
		1935	$self->{load_original} = 1;
		1936	$self->{instantiate_time} = $cf::RUNTIME;
		1937	$self->last_access ($cf::RUNTIME);
		1938	$self->instantiate;
		1939	}
		1940
		1941	sub load_header {
		1942	my ($self) = @_;
		1943
		1944	if ($self->load_header_temp) {
		1945	$self->prepare_temp;
		1946	} else {
		1947	$self->load_header_orig
1164	or return;	1948	or return;
		1949	$self->prepare_orig;
		1950	}
1165		1951
1166	$map->{load_path} = $path;	1952	$self->{deny_reset} = 1
		1953	if $self->no_reset;
1167		1954
1168	$map	1955	$self->default_region (cf::region::find_by_path $self->{path})
		1956	unless $self->default_region;
		1957
		1958	1
1169	}	1959	}
1170		1960
1171	sub find;	1961	sub find;
1172	sub find {	1962	sub find {
1173	my ($path, $origin) = @_;	1963	my ($path, $origin) = @_;
1174		1964
1175	#warn "find<$path,$origin>\n";#d#
1176
1177	$path = new cf::path $path, $origin && $origin->path;	1965	$path = normalise $path, $origin && $origin->path;
1178	my $key = $path->as_string;
1179		1966
1180	cf::lock_wait "map_find:$key";	1967	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";	1968	my $guard2 = cf::lock_acquire "map_find:$path";
1184		1969
1185	# do it the slow way	1970	$cf::MAP{$path} || do {
1186	my $map = try_load_header $path->save_path;	1971	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;	1972	or return;
1204		1973
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;	1974	$map->{last_save} = $cf::RUNTIME;
1217		1975
1218	Coro::cede;	1976	$map->load_header
		1977	or return;
1219		1978
1220	if ($map->should_reset) {	1979	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1980	# doing this can freeze the server in a sync job, obviously
		1981	#$cf::WAIT_FOR_TICK->wait;
		1982	undef $guard2;
		1983	undef $guard1;
1221	$map->reset;	1984	$map->reset;
1222	undef $guard;
1223	$map = find $path	1985	return find $path;
1224	or return;
1225	}	1986	}
1226		1987
1227	$cf::MAP{$key} = $map	1988	$cf::MAP{$path} = $map
1228	}	1989	}
1229	}	1990	}
		1991
		1992	sub pre_load { }
		1993	sub post_load { }
1230		1994
1231	sub load {	1995	sub load {
1232	my ($self) = @_;	1996	my ($self) = @_;
1233		1997
		1998	local $self->{deny_reset} = 1; # loading can take a long time
		1999
1234	my $path = $self->{path};	2000	my $path = $self->{path};
		2001
		2002	{
1235	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2003	my $guard = cf::lock_acquire "map_data:$path";
1236		2004
		2005	return unless $self->valid;
1237	return if $self->in_memory != cf::MAP_SWAPPED;	2006	return unless $self->in_memory == cf::MAP_SWAPPED;
1238		2007
1239	$self->in_memory (cf::MAP_LOADING);	2008	$self->in_memory (cf::MAP_LOADING);
1240		2009
1241	$self->alloc;	2010	$self->alloc;
1242	$self->load_objects ($self->{load_path}, 1)	2011
		2012	$self->pre_load;
		2013	cf::cede_to_tick;
		2014
		2015	my $f = new_from_file cf::object::thawer $self->{load_path};
		2016	$f->skip_block;
		2017	$self->_load_objects ($f)
1243	or return;	2018	or return;
1244		2019
1245	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2020	$self->post_load_original
1246	if delete $self->{load_original};	2021	if delete $self->{load_original};
1247		2022
1248	if (my $uniq = $path->uniq_path) {	2023	if (my $uniq = $self->uniq_path) {
1249	utf8::encode $uniq;	2024	utf8::encode $uniq;
1250	if (aio_open $uniq, O_RDONLY, 0) {	2025	unless (aio_stat $uniq) {
		2026	if (my $f = new_from_file cf::object::thawer $uniq) {
1251	$self->clear_unique_items;	2027	$self->clear_unique_items;
1252	$self->load_objects ($uniq, 0);	2028	$self->_load_objects ($f);
		2029	$f->resolve_delayed_derefs;
		2030	}
1253	}	2031	}
1254	}	2032	}
1255		2033
1256	Coro::cede;	2034	$f->resolve_delayed_derefs;
1257		2035
		2036	cf::cede_to_tick;
1258	# now do the right thing for maps	2037	# now do the right thing for maps
1259	$self->link_multipart_objects;	2038	$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)	2039	$self->difficulty ($self->estimate_difficulty)
1270	unless $self->difficulty;	2040	unless $self->difficulty;
		2041	cf::cede_to_tick;
		2042
		2043	unless ($self->{deny_activate}) {
		2044	$self->decay_objects;
		2045	$self->fix_auto_apply;
		2046	$self->update_buttons;
		2047	cf::cede_to_tick;
		2048	$self->set_darkness_map;
		2049	cf::cede_to_tick;
1271	$self->activate;	2050	$self->activate;
1272	}	2051	}
1273		2052
1274	Coro::cede;	2053	$self->{last_save} = $cf::RUNTIME;
		2054	$self->last_access ($cf::RUNTIME);
1275		2055
1276	$self->in_memory (cf::MAP_IN_MEMORY);	2056	$self->in_memory (cf::MAP_ACTIVE);
		2057	}
		2058
		2059	$self->post_load;
		2060	}
		2061
		2062	sub customise_for {
		2063	my ($self, $ob) = @_;
		2064
		2065	return find "~" . $ob->name . "/" . $self->{path}
		2066	if $self->per_player;
		2067
		2068	# return find "?party/" . $ob->name . "/" . $self->{path}
		2069	# if $self->per_party;
		2070
		2071	$self
		2072	}
		2073
		2074	# find and load all maps in the 3x3 area around a map
		2075	sub load_neighbours {
		2076	my ($map) = @_;
		2077
		2078	my @neigh; # diagonal neighbours
		2079
		2080	for (0 .. 3) {
		2081	my $neigh = $map->tile_path ($_)
		2082	or next;
		2083	$neigh = find $neigh, $map
		2084	or next;
		2085	$neigh->load;
		2086
		2087	push @neigh,
		2088	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2089	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2090	}
		2091
		2092	for (grep defined $_->[0], @neigh) {
		2093	my ($path, $origin) = @$_;
		2094	my $neigh = find $path, $origin
		2095	or next;
		2096	$neigh->load;
		2097	}
1277	}	2098	}
1278		2099
1279	sub find_sync {	2100	sub find_sync {
1280	my ($path, $origin) = @_;	2101	my ($path, $origin) = @_;
1281		2102
1282	cf::sync_job { cf::map::find $path, $origin }	2103	cf::sync_job { find $path, $origin }
1283	}	2104	}
1284		2105
1285	sub do_load_sync {	2106	sub do_load_sync {
1286	my ($map) = @_;	2107	my ($map) = @_;
1287		2108
		2109	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2110	if $Coro::current == $Coro::main;
		2111
1288	cf::sync_job { $map->load };	2112	cf::sync_job { $map->load };
		2113	}
		2114
		2115	our %MAP_PREFETCH;
		2116	our $MAP_PREFETCHER = undef;
		2117
		2118	sub find_async {
		2119	my ($path, $origin, $load) = @_;
		2120
		2121	$path = normalise $path, $origin && $origin->{path};
		2122
		2123	if (my $map = $cf::MAP{$path}) {
		2124	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2125	}
		2126
		2127	$MAP_PREFETCH{$path} |= $load;
		2128
		2129	$MAP_PREFETCHER ||= cf::async {
		2130	$Coro::current->{desc} = "map prefetcher";
		2131
		2132	while (%MAP_PREFETCH) {
		2133	while (my ($k, $v) = each %MAP_PREFETCH) {
		2134	if (my $map = find $k) {
		2135	$map->load if $v;
		2136	}
		2137
		2138	delete $MAP_PREFETCH{$k};
		2139	}
		2140	}
		2141	undef $MAP_PREFETCHER;
		2142	};
		2143	$MAP_PREFETCHER->prio (6);
		2144
		2145	()
1289	}	2146	}
1290		2147
1291	sub save {	2148	sub save {
1292	my ($self) = @_;	2149	my ($self) = @_;
1293		2150
1294	my $lock = cf::lock_acquire "map_data:" . $self->path;	2151	my $lock = cf::lock_acquire "map_data:$self->{path}";
1295		2152
1296	$self->{last_save} = $cf::RUNTIME;	2153	$self->{last_save} = $cf::RUNTIME;
1297		2154
1298	return unless $self->dirty;	2155	return unless $self->dirty;
1299		2156
1300	my $save = $self->{path}->save_path; utf8::encode $save;	2157	my $save = $self->save_path; utf8::encode $save;
1301	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2158	my $uniq = $self->uniq_path; utf8::encode $uniq;
1302		2159
1303	$self->{load_path} = $save;	2160	$self->{load_path} = $save;
1304		2161
1305	return if $self->{deny_save};	2162	return if $self->{deny_save};
1306		2163
1307	local $self->{last_access} = $self->last_access;#d#	2164	local $self->{last_access} = $self->last_access;#d#
1308		2165
		2166	cf::async {
		2167	$Coro::current->{desc} = "map player save";
		2168	$_->contr->save for $self->players;
		2169	};
		2170
		2171	cf::get_slot 0.02;
		2172
1309	if ($uniq) {	2173	if ($uniq) {
1310	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2174	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1311	$self->save_objects ($uniq, cf::IO_UNIQUES);	2175	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1312	} else {	2176	} else {
1313	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2177	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1314	}	2178	}
1315	}	2179	}
1316		2180
1317	sub swap_out {	2181	sub swap_out {
1318	my ($self) = @_;	2182	my ($self) = @_;
1319		2183
1320	# save first because save cedes	2184	# save first because save cedes
1321	$self->save;	2185	$self->save;
1322		2186
1323	my $lock = cf::lock_acquire "map_data:" . $self->path;	2187	my $lock = cf::lock_acquire "map_data:$self->{path}";
1324		2188
1325	return if $self->players;	2189	return if $self->players;
1326	return if $self->in_memory != cf::MAP_IN_MEMORY;	2190	return if $self->in_memory != cf::MAP_ACTIVE;
1327	return if $self->{deny_save};	2191	return if $self->{deny_save};
1328		2192
		2193	$self->in_memory (cf::MAP_SWAPPED);
		2194
		2195	$self->deactivate;
		2196	$_->clear_links_to ($self) for values %cf::MAP;
1329	$self->clear;	2197	$self->clear;
1330	$self->in_memory (cf::MAP_SWAPPED);
1331	}	2198	}
1332		2199
1333	sub reset_at {	2200	sub reset_at {
1334	my ($self) = @_;	2201	my ($self) = @_;
1335		2202
1336	# TODO: safety, remove and allow resettable per-player maps	2203	# TODO: safety, remove and allow resettable per-player maps
1337	return 1e99 if $self->{path}{user_rel};
1338	return 1e99 if $self->{deny_reset};	2204	return 1e99 if $self->{deny_reset};
1339		2205
1340	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2206	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1341	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2207	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1342		2208
…		…
1347	my ($self) = @_;	2213	my ($self) = @_;
1348		2214
1349	$self->reset_at <= $cf::RUNTIME	2215	$self->reset_at <= $cf::RUNTIME
1350	}	2216	}
1351		2217
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 {	2218	sub reset {
1374	my ($self) = @_;	2219	my ($self) = @_;
1375		2220
1376	my $lock = cf::lock_acquire "map_data:" . $self->path;	2221	my $lock = cf::lock_acquire "map_data:$self->{path}";
1377		2222
1378	return if $self->players;	2223	return if $self->players;
1379	return if $self->{path}{user_rel};#d#
1380		2224
1381	warn "resetting map ", $self->path;#d#	2225	warn "resetting map ", $self->path;
		2226
		2227	$self->in_memory (cf::MAP_SWAPPED);
		2228
		2229	# need to save uniques path
		2230	unless ($self->{deny_save}) {
		2231	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2232
		2233	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2234	if $uniq;
		2235	}
1382		2236
1383	delete $cf::MAP{$self->path};	2237	delete $cf::MAP{$self->path};
1384		2238
		2239	$self->deactivate;
1385	$_->clear_links_to ($self) for values %cf::MAP;	2240	$_->clear_links_to ($self) for values %cf::MAP;
		2241	$self->clear;
1386		2242
1387	$self->unlink_save;	2243	$self->unlink_save;
1388	$self->destroy;	2244	$self->destroy;
1389	}	2245	}
1390		2246
1391	my $nuke_counter = "aaaa";	2247	my $nuke_counter = "aaaa";
1392		2248
1393	sub nuke {	2249	sub nuke {
1394	my ($self) = @_;	2250	my ($self) = @_;
1395		2251
		2252	{
		2253	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2254
		2255	delete $cf::MAP{$self->path};
		2256
		2257	$self->unlink_save;
		2258
		2259	bless $self, "cf::map";
		2260	delete $self->{deny_reset};
1396	$self->{deny_save} = 1;	2261	$self->{deny_save} = 1;
1397	$self->reset_timeout (1);	2262	$self->reset_timeout (1);
1398	$self->rename ("{nuke}/" . ($nuke_counter++));	2263	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2264
		2265	$cf::MAP{$self->path} = $self;
		2266	}
		2267
1399	$self->reset; # polite request, might not happen	2268	$self->reset; # polite request, might not happen
1400	}	2269	}
1401		2270
1402	sub customise_for {	2271	=item $maps = cf::map::tmp_maps
1403	my ($map, $ob) = @_;
1404		2272
1405	if ($map->per_player) {	2273	Returns an arrayref with all map paths of currently instantiated and saved
1406	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2274	maps. May block.
		2275
		2276	=cut
		2277
		2278	sub tmp_maps() {
1407	}	2279	[
1408		2280	map {
1409	$map	2281	utf8::decode $_;
		2282	/\.map$/
		2283	? normalise $_
		2284	: ()
		2285	} @{ aio_readdir $TMPDIR or [] }
		2286	]
1410	}	2287	}
1411		2288
1412	sub emergency_save {	2289	=item $maps = cf::map::random_maps
1413	my $freeze_guard = cf::freeze_mainloop;
1414		2290
1415	warn "enter emergency map save\n";	2291	Returns an arrayref with all map paths of currently instantiated and saved
		2292	random maps. May block.
1416		2293
1417	cf::sync_job {	2294	=cut
1418	warn "begin emergency map save\n";	2295
1419	$_->save for values %cf::MAP;	2296	sub random_maps() {
		2297	[
		2298	map {
		2299	utf8::decode $_;
		2300	/\.map$/
		2301	? normalise "?random/$_"
		2302	: ()
		2303	} @{ aio_readdir $RANDOMDIR or [] }
		2304	]
		2305	}
		2306
		2307	=item cf::map::unique_maps
		2308
		2309	Returns an arrayref of paths of all shared maps that have
		2310	instantiated unique items. May block.
		2311
		2312	=cut
		2313
		2314	sub unique_maps() {
		2315	[
		2316	map {
		2317	utf8::decode $_;
		2318	s/\.map$//; # TODO future compatibility hack
		2319	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2320	? ()
		2321	: normalise $_
		2322	} @{ aio_readdir $UNIQUEDIR or [] }
		2323	]
		2324	}
		2325
		2326	=back
		2327
		2328	=head3 cf::object
		2329
		2330	=cut
		2331
		2332	package cf::object;
		2333
		2334	=over 4
		2335
		2336	=item $ob->inv_recursive
		2337
		2338	Returns the inventory of the object I<and> their inventories, recursively,
		2339	but I<not> the object itself.
		2340
		2341	=cut
		2342
		2343	sub inv_recursive_;
		2344	sub inv_recursive_ {
		2345	map { $_, inv_recursive_ $_->inv } @_
		2346	}
		2347
		2348	sub inv_recursive {
		2349	inv_recursive_ inv $_[0]
		2350	}
		2351
		2352	=item $ref = $ob->ref
		2353
		2354	Creates and returns a persistent reference to an object that can be stored as a string.
		2355
		2356	=item $ob = cf::object::deref ($refstring)
		2357
		2358	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2359	even if the object actually exists. May block.
		2360
		2361	=cut
		2362
		2363	sub deref {
		2364	my ($ref) = @_;
		2365
		2366	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2367	my ($uuid, $name) = ($1, $2);
		2368	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2369	or return;
		2370	$pl->ob->uuid eq $uuid
		2371	or return;
		2372
		2373	$pl->ob
		2374	} else {
		2375	warn "$ref: cannot resolve object reference\n";
		2376	undef
1420	};	2377	}
1421
1422	warn "end emergency map save\n";
1423	}	2378	}
1424		2379
1425	package cf;	2380	package cf;
1426		2381
1427	=back	2382	=back
1428
1429		2383
1430	=head3 cf::object::player	2384	=head3 cf::object::player
1431		2385
1432	=over 4	2386	=over 4
1433		2387
…		…
1436	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2390	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	2391	can be C<undef>. Does the right thing when the player is currently in a
1438	dialogue with the given NPC character.	2392	dialogue with the given NPC character.
1439		2393
1440	=cut	2394	=cut
		2395
		2396	our $SAY_CHANNEL = {
		2397	id => "say",
		2398	title => "Map",
		2399	reply => "say ",
		2400	tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
		2401	};
		2402
		2403	our $CHAT_CHANNEL = {
		2404	id => "chat",
		2405	title => "Chat",
		2406	reply => "chat ",
		2407	tooltip => "Player chat and shouts, global to the server.",
		2408	};
1441		2409
1442	# rough implementation of a future "reply" method that works	2410	# rough implementation of a future "reply" method that works
1443	# with dialog boxes.	2411	# with dialog boxes.
1444	#TODO: the first argument must go, split into a $npc->reply_to ( method	2412	#TODO: the first argument must go, split into a $npc->reply_to ( method
1445	sub cf::object::player::reply($$$;$) {	2413	sub cf::object::player::reply($$$;$) {
…		…
1447		2415
1448	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2416	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1449		2417
1450	if ($self->{record_replies}) {	2418	if ($self->{record_replies}) {
1451	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2419	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2420
1452	} else {	2421	} else {
		2422	my $pl = $self->contr;
		2423
		2424	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2425	my $dialog = $pl->{npc_dialog};
		2426	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2427
		2428	} else {
1453	$msg = $npc->name . " says: $msg" if $npc;	2429	$msg = $npc->name . " says: $msg" if $npc;
1454	$self->message ($msg, $flags);	2430	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2431	}
1455	}	2432	}
		2433	}
		2434
		2435	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2436
		2437	=cut
		2438
		2439	sub cf::object::send_msg {
		2440	my $pl = shift->contr
		2441	or return;
		2442	$pl->send_msg (@_);
1456	}	2443	}
1457		2444
1458	=item $player_object->may ("access")	2445	=item $player_object->may ("access")
1459		2446
1460	Returns wether the given player is authorized to access resource "access"	2447	Returns wether the given player is authorized to access resource "access"
…		…
1473		2460
1474	=item $player_object->enter_link	2461	=item $player_object->enter_link
1475		2462
1476	Freezes the player and moves him/her to a special map (C<{link}>).	2463	Freezes the player and moves him/her to a special map (C<{link}>).
1477		2464
1478	The player should be reaosnably safe there for short amounts of time. You	2465	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.	2466	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2467	though, as the palyer cannot control the character while it is on the link
		2468	map.
		2469
		2470	Will never block.
1480		2471
1481	=item $player_object->leave_link ($map, $x, $y)	2472	=item $player_object->leave_link ($map, $x, $y)
1482		2473
1483	Moves the player out of the specila link map onto the given map. If the	2474	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	2475	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,	2476	to the location he/she was before the call to C<enter_link>, or, if that
1486	to the emergency map position.	2477	fails, to the emergency map position.
1487		2478
1488	Might block.	2479	Might block.
1489		2480
1490	=cut	2481	=cut
		2482
		2483	sub link_map {
		2484	unless ($LINK_MAP) {
		2485	$LINK_MAP = cf::map::find "{link}"
		2486	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2487	$LINK_MAP->load;
		2488	}
		2489
		2490	$LINK_MAP
		2491	}
1491		2492
1492	sub cf::object::player::enter_link {	2493	sub cf::object::player::enter_link {
1493	my ($self) = @_;	2494	my ($self) = @_;
1494		2495
1495	$self->deactivate_recursive;	2496	$self->deactivate_recursive;
1496		2497
1497	return if $self->map == $LINK_MAP;	2498	return if UNIVERSAL::isa $self->map, "ext::map_link";
1498		2499
1499	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1500	if $self->map;	2501	if $self->map && $self->map->{path} ne "{link}";
1501		2502
1502	$self->enter_map ($LINK_MAP, 20, 20);	2503	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1503	}	2504	}
1504		2505
1505	sub cf::object::player::leave_link {	2506	sub cf::object::player::leave_link {
1506	my ($self, $map, $x, $y) = @_;	2507	my ($self, $map, $x, $y) = @_;
		2508
		2509	return unless $self->contr->active;
1507		2510
1508	my $link_pos = delete $self->{_link_pos};	2511	my $link_pos = delete $self->{_link_pos};
1509		2512
1510	unless ($map) {	2513	unless ($map) {
1511	# restore original map position	2514	# restore original map position
…		…
1525	# use -1 or undef as default coordinates, not 0, 0	2528	# use -1 or undef as default coordinates, not 0, 0
1526	($x, $y) = ($map->enter_x, $map->enter_y)	2529	($x, $y) = ($map->enter_x, $map->enter_y)
1527	if $x <=0 && $y <= 0;	2530	if $x <=0 && $y <= 0;
1528		2531
1529	$map->load;	2532	$map->load;
		2533	$map->load_neighbours;
1530		2534
		2535	return unless $self->contr->active;
		2536	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1531	$self->activate_recursive;	2537	$self->activate_recursive;
		2538
		2539	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1532	$self->enter_map ($map, $x, $y);	2540	$self->enter_map ($map, $x, $y);
1533	}	2541	}
1534		2542
1535	cf::player->attach (	2543	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1536	on_logout => sub {
1537	my ($pl) = @_;
1538		2544
1539	# abort map switching before logout	2545	Moves the player to the given map-path and coordinates by first freezing
1540	if ($pl->ob->{_link_pos}) {	2546	her, loading and preparing them map, calling the provided $check callback
1541	cf::sync_job {	2547	that has to return the map if sucecssful, and then unfreezes the player on
1542	$pl->ob->leave_link	2548	the new (success) or old (failed) map position. In either case, $done will
1543	};	2549	be called at the end of this process.
1544	}
1545	},
1546	on_login => sub {
1547	my ($pl) = @_;
1548		2550
1549	# try to abort aborted map switching on player login :)	2551	Note that $check will be called with a potentially non-loaded map, so if
1550	# should happen only on crashes	2552	it needs a loaded map it has to call C<< ->load >>.
1551	if ($pl->ob->{_link_pos}) {
1552		2553
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	2554	=cut
		2555
		2556	our $GOTOGEN;
1571		2557
1572	sub cf::object::player::goto {	2558	sub cf::object::player::goto {
1573	my ($self, $path, $x, $y) = @_;	2559	my ($self, $path, $x, $y, $check, $done) = @_;
		2560
		2561	# do generation counting so two concurrent goto's will be executed in-order
		2562	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1574		2563
1575	$self->enter_link;	2564	$self->enter_link;
1576		2565
1577	(async {	2566	(async {
1578	$path = new cf::path $path;	2567	$Coro::current->{desc} = "player::goto $path $x $y";
1579		2568
1580	my $map = cf::map::find $path->as_string;	2569	# *tag paths override both path and x|y
		2570	if ($path =~ /^\*(.*)$/) {
		2571	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2572	my $ob = $obs[rand @obs];
		2573
		2574	# see if we actually can go there
		2575	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2576	$ob = $obs[rand @obs];
		2577	} else {
		2578	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2579	}
		2580	# else put us there anyways for now #d#
		2581
		2582	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2583	} else {
		2584	($path, $x, $y) = (undef, undef, undef);
		2585	}
		2586	}
		2587
		2588	my $map = eval {
		2589	my $map = defined $path ? cf::map::find $path : undef;
		2590
		2591	if ($map) {
1581	$map = $map->customise_for ($self) if $map;	2592	$map = $map->customise_for ($self);
1582		2593	$map = $check->($map) if $check && $map;
1583	# warn "entering ", $map->path, " at ($x, $y)\n"	2594	} else {
1584	# if $map;
1585
1586	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2595	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2596	}
1587		2597
		2598	$map
		2599	};
		2600
		2601	if ($@) {
		2602	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2603	LOG llevError | logBacktrace, Carp::longmess $@;
		2604	}
		2605
		2606	if ($gen == $self->{_goto_generation}) {
		2607	delete $self->{_goto_generation};
1588	$self->leave_link ($map, $x, $y);	2608	$self->leave_link ($map, $x, $y);
		2609	}
		2610
		2611	$done->() if $done;
1589	})->prio (1);	2612	})->prio (1);
1590	}	2613	}
1591		2614
1592	=item $player_object->enter_exit ($exit_object)	2615	=item $player_object->enter_exit ($exit_object)
1593		2616
…		…
1595		2618
1596	sub parse_random_map_params {	2619	sub parse_random_map_params {
1597	my ($spec) = @_;	2620	my ($spec) = @_;
1598		2621
1599	my $rmp = { # defaults	2622	my $rmp = { # defaults
1600	xsize => 10,	2623	xsize => (cf::rndm 15, 40),
1601	ysize => 10,	2624	ysize => (cf::rndm 15, 40),
		2625	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2626	#layout => string,
1602	};	2627	};
1603		2628
1604	for (split /\n/, $spec) {	2629	for (split /\n/, $spec) {
1605	my ($k, $v) = split /\s+/, $_, 2;	2630	my ($k, $v) = split /\s+/, $_, 2;
1606		2631
…		…
1618	# that depends on the exit object	2643	# that depends on the exit object
1619		2644
1620	my $rmp = parse_random_map_params $exit->msg;	2645	my $rmp = parse_random_map_params $exit->msg;
1621		2646
1622	if ($exit->map) {	2647	if ($exit->map) {
1623	$rmp->{region} = $exit->map->region_name;	2648	$rmp->{region} = $exit->region->name;
1624	$rmp->{origin_map} = $exit->map->path;	2649	$rmp->{origin_map} = $exit->map->path;
1625	$rmp->{origin_x} = $exit->x;	2650	$rmp->{origin_x} = $exit->x;
1626	$rmp->{origin_y} = $exit->y;	2651	$rmp->{origin_y} = $exit->y;
		2652
		2653	$exit->map->touch;
1627	}	2654	}
1628		2655
1629	$rmp->{random_seed} ||= $exit->random_seed;	2656	$rmp->{random_seed} ||= $exit->random_seed;
1630		2657
1631	my $data = cf::to_json $rmp;	2658	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1632	my $md5 = Digest::MD5::md5_hex $data;	2659	my $md5 = Digest::MD5::md5_hex $data;
		2660	my $meta = "$RANDOMDIR/$md5.meta";
1633		2661
1634	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2662	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1635	aio_write $fh, 0, (length $data), $data, 0;	2663	aio_write $fh, 0, (length $data), $data, 0;
		2664	undef $fh;
		2665	aio_rename "$meta~", $meta;
1636		2666
		2667	my $slaying = "?random/$md5";
		2668
		2669	if ($exit->valid) {
1637	$exit->slaying ("?random/$md5");	2670	$exit->slaying ("?random/$md5");
1638	$exit->msg (undef);	2671	$exit->msg (undef);
		2672	}
1639	}	2673	}
1640	}	2674	}
1641		2675
1642	sub cf::object::player::enter_exit {	2676	sub cf::object::player::enter_exit {
1643	my ($self, $exit) = @_;	2677	my ($self, $exit) = @_;
…		…
1645	return unless $self->type == cf::PLAYER;	2679	return unless $self->type == cf::PLAYER;
1646		2680
1647	$self->enter_link;	2681	$self->enter_link;
1648		2682
1649	(async {	2683	(async {
1650	$self->deactivate_recursive; # just to be sure	2684	$Coro::current->{desc} = "enter_exit";
		2685
1651	unless (eval {	2686	unless (eval {
		2687	$self->deactivate_recursive; # just to be sure
		2688
		2689	# random map handling
		2690	{
		2691	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2692
1652	prepare_random_map $exit	2693	prepare_random_map $exit
1653	if $exit->slaying eq "/!";	2694	if $exit->slaying eq "/!";
		2695	}
1654		2696
1655	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2697	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1656	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2698	my $x = $exit->stats->hp;
		2699	my $y = $exit->stats->sp;
1657		2700
		2701	$self->goto ($map, $x, $y);
		2702
		2703	# if exit is damned, update players death & WoR home-position
		2704	$self->contr->savebed ($map, $x, $y)
		2705	if $exit->flag (cf::FLAG_DAMNED);
		2706
1658	1;	2707	1
1659	}) {	2708	}) {
1660	$self->message ("Something went wrong deep within the crossfire server. "	2709	$self->message ("Something went wrong deep within the deliantra server. "
1661	. "I'll try to bring you back to the map you were before. "	2710	. "I'll try to bring you back to the map you were before. "
1662	. "Please report this to the dungeon master",	2711	. "Please report this to the dungeon master!",
1663	cf::NDI_UNIQUE | cf::NDI_RED);	2712	cf::NDI_UNIQUE | cf::NDI_RED);
1664		2713
1665	warn "ERROR in enter_exit: $@";	2714	warn "ERROR in enter_exit: $@";
1666	$self->leave_link;	2715	$self->leave_link;
1667	}	2716	}
1668	})->prio (1);	2717	})->prio (1);
…		…
1681		2730
1682	sub cf::client::send_drawinfo {	2731	sub cf::client::send_drawinfo {
1683	my ($self, $text, $flags) = @_;	2732	my ($self, $text, $flags) = @_;
1684		2733
1685	utf8::encode $text;	2734	utf8::encode $text;
1686	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2735	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1687	}	2736	}
1688		2737
		2738	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2739
		2740	Send a drawinfo or msg packet to the client, formatting the msg for the
		2741	client if neccessary. C<$type> should be a string identifying the type of
		2742	the message, with C<log> being the default. If C<$color> is negative, suppress
		2743	the message unless the client supports the msg packet.
		2744
		2745	=cut
		2746
		2747	# non-persistent channels (usually the info channel)
		2748	our %CHANNEL = (
		2749	"c/identify" => {
		2750	id => "infobox",
		2751	title => "Identify",
		2752	reply => undef,
		2753	tooltip => "Items recently identified",
		2754	},
		2755	"c/examine" => {
		2756	id => "infobox",
		2757	title => "Examine",
		2758	reply => undef,
		2759	tooltip => "Signs and other items you examined",
		2760	},
		2761	"c/book" => {
		2762	id => "infobox",
		2763	title => "Book",
		2764	reply => undef,
		2765	tooltip => "The contents of a note or book",
		2766	},
		2767	"c/lookat" => {
		2768	id => "infobox",
		2769	title => "Look",
		2770	reply => undef,
		2771	tooltip => "What you saw there",
		2772	},
		2773	"c/who" => {
		2774	id => "infobox",
		2775	title => "Players",
		2776	reply => undef,
		2777	tooltip => "Shows players who are currently online",
		2778	},
		2779	"c/body" => {
		2780	id => "infobox",
		2781	title => "Body Parts",
		2782	reply => undef,
		2783	tooltip => "Shows which body parts you posess and are available",
		2784	},
		2785	"c/skills" => {
		2786	id => "infobox",
		2787	title => "Skills",
		2788	reply => undef,
		2789	tooltip => "Shows your experience per skill and item power",
		2790	},
		2791	"c/uptime" => {
		2792	id => "infobox",
		2793	title => "Uptime",
		2794	reply => undef,
		2795	tooltip => "How long the server has been running since last restart",
		2796	},
		2797	"c/mapinfo" => {
		2798	id => "infobox",
		2799	title => "Map Info",
		2800	reply => undef,
		2801	tooltip => "Information related to the maps",
		2802	},
		2803	"c/party" => {
		2804	id => "party",
		2805	title => "Party",
		2806	reply => "gsay ",
		2807	tooltip => "Messages and chat related to your party",
		2808	},
		2809	);
		2810
		2811	sub cf::client::send_msg {
		2812	my ($self, $channel, $msg, $color, @extra) = @_;
		2813
		2814	$msg = $self->pl->expand_cfpod ($msg)
		2815	unless $color & cf::NDI_VERBATIM;
		2816
		2817	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2818
		2819	# check predefined channels, for the benefit of C
		2820	if ($CHANNEL{$channel}) {
		2821	$channel = $CHANNEL{$channel};
		2822
		2823	$self->ext_msg (channel_info => $channel)
		2824	if $self->can_msg;
		2825
		2826	$channel = $channel->{id};
		2827
		2828	} elsif (ref $channel) {
		2829	# send meta info to client, if not yet sent
		2830	unless (exists $self->{channel}{$channel->{id}}) {
		2831	$self->{channel}{$channel->{id}} = $channel;
		2832	$self->ext_msg (channel_info => $channel)
		2833	if $self->can_msg;
		2834	}
		2835
		2836	$channel = $channel->{id};
		2837	}
		2838
		2839	return unless @extra || length $msg;
		2840
		2841	if ($self->can_msg) {
		2842	# default colour, mask it out
		2843	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2844	if $color & cf::NDI_DEF;
		2845
		2846	my $pkt = "msg "
		2847	. $self->{json_coder}->encode (
		2848	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2849	);
		2850
		2851	# try lzf for large packets
		2852	$pkt = "lzf " . Compress::LZF::compress $pkt
		2853	if 1024 <= length $pkt and $self->{can_lzf};
		2854
		2855	# split very large packets
		2856	if (8192 < length $pkt and $self->{can_lzf}) {
		2857	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2858	$pkt = "frag";
		2859	}
		2860
		2861	$self->send_packet ($pkt);
		2862	} else {
		2863	if ($color >= 0) {
		2864	# replace some tags by gcfclient-compatible ones
		2865	for ($msg) {
		2866	1 while
		2867	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2868	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2869	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2870	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2871	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2872	}
		2873
		2874	$color &= cf::NDI_COLOR_MASK;
		2875
		2876	utf8::encode $msg;
		2877
		2878	if (0 && $msg =~ /\[/) {
		2879	# COMMAND/INFO
		2880	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2881	} else {
		2882	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2883	$self->send_packet ("drawinfo $color $msg")
		2884	}
		2885	}
		2886	}
		2887	}
		2888
		2889	=item $client->ext_msg ($type, @msg)
		2890
		2891	Sends an ext event to the client.
		2892
		2893	=cut
		2894
		2895	sub cf::client::ext_msg($$@) {
		2896	my ($self, $type, @msg) = @_;
		2897
		2898	if ($self->extcmd == 2) {
		2899	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2900	} elsif ($self->extcmd == 1) { # TODO: remove
		2901	push @msg, msgtype => "event_$type";
		2902	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2903	}
		2904	}
		2905
		2906	=item $client->ext_reply ($msgid, @msg)
		2907
		2908	Sends an ext reply to the client.
		2909
		2910	=cut
		2911
		2912	sub cf::client::ext_reply($$@) {
		2913	my ($self, $id, @msg) = @_;
		2914
		2915	if ($self->extcmd == 2) {
		2916	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2917	} elsif ($self->extcmd == 1) {
		2918	#TODO: version 1, remove
		2919	unshift @msg, msgtype => "reply", msgid => $id;
		2920	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2921	}
		2922	}
1689		2923
1690	=item $success = $client->query ($flags, "text", \&cb)	2924	=item $success = $client->query ($flags, "text", \&cb)
1691		2925
1692	Queues a query to the client, calling the given callback with	2926	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>,	2927	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>.	2928	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1695		2929
1696	Queries can fail, so check the return code. Or don't, as queries will become	2930	Queries can fail, so check the return code. Or don't, as queries will
1697	reliable at some point in the future.	2931	become reliable at some point in the future.
1698		2932
1699	=cut	2933	=cut
1700		2934
1701	sub cf::client::query {	2935	sub cf::client::query {
1702	my ($self, $flags, $text, $cb) = @_;	2936	my ($self, $flags, $text, $cb) = @_;
…		…
1710	utf8::encode $text;	2944	utf8::encode $text;
1711	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2945	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1712		2946
1713	$self->send_packet ($self->{query_queue}[0][0])	2947	$self->send_packet ($self->{query_queue}[0][0])
1714	if @{ $self->{query_queue} } == 1;	2948	if @{ $self->{query_queue} } == 1;
		2949
		2950	1
1715	}	2951	}
1716		2952
1717	cf::client->attach (	2953	cf::client->attach (
		2954	on_connect => sub {
		2955	my ($ns) = @_;
		2956
		2957	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2958	},
1718	on_reply => sub {	2959	on_reply => sub {
1719	my ($ns, $msg) = @_;	2960	my ($ns, $msg) = @_;
1720		2961
1721	# this weird shuffling is so that direct followup queries	2962	# this weird shuffling is so that direct followup queries
1722	# get handled first	2963	# get handled first
1723	my $queue = delete $ns->{query_queue}	2964	my $queue = delete $ns->{query_queue}
1724	or return; # be conservative, not sure how that can happen, but we saw a crash here	2965	or return; # be conservative, not sure how that can happen, but we saw a crash here
1725		2966
1726	(shift @$queue)->[1]->($msg);	2967	(shift @$queue)->[1]->($msg);
		2968	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1727		2969
1728	push @{ $ns->{query_queue} }, @$queue;	2970	push @{ $ns->{query_queue} }, @$queue;
1729		2971
1730	if (@{ $ns->{query_queue} } == @$queue) {	2972	if (@{ $ns->{query_queue} } == @$queue) {
1731	if (@$queue) {	2973	if (@$queue) {
…		…
1733	} else {	2975	} else {
1734	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2976	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1735	}	2977	}
1736	}	2978	}
1737	},	2979	},
		2980	on_exticmd => sub {
		2981	my ($ns, $buf) = @_;
		2982
		2983	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2984
		2985	if (ref $msg) {
		2986	my ($type, $reply, @payload) =
		2987	"ARRAY" eq ref $msg
		2988	? @$msg
		2989	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2990
		2991	my @reply;
		2992
		2993	if (my $cb = $EXTICMD{$type}) {
		2994	@reply = $cb->($ns, @payload);
		2995	}
		2996
		2997	$ns->ext_reply ($reply, @reply)
		2998	if $reply;
		2999
		3000	} else {
		3001	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3002	}
		3003
		3004	cf::override;
		3005	},
1738	);	3006	);
1739		3007
1740	=item $client->async (\&cb)	3008	=item $client->async (\&cb)
1741		3009
1742	Create a new coroutine, running the specified callback. The coroutine will	3010	Create a new coroutine, running the specified callback. The coroutine will
…		…
1783	our $safe = new Safe "safe";	3051	our $safe = new Safe "safe";
1784	our $safe_hole = new Safe::Hole;	3052	our $safe_hole = new Safe::Hole;
1785		3053
1786	$SIG{FPE} = 'IGNORE';	3054	$SIG{FPE} = 'IGNORE';
1787		3055
1788	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3056	$safe->permit_only (Opcode::opset qw(
		3057	:base_core :base_mem :base_orig :base_math
		3058	grepstart grepwhile mapstart mapwhile
		3059	sort time
		3060	));
1789		3061
1790	# here we export the classes and methods available to script code	3062	# here we export the classes and methods available to script code
1791		3063
1792	=pod	3064	=pod
1793		3065
1794	The following fucntions and emthods are available within a safe environment:	3066	The following functions and methods are available within a safe environment:
1795		3067
1796	cf::object contr pay_amount pay_player map	3068	cf::object
		3069	contr pay_amount pay_player map x y force_find force_add destroy
		3070	insert remove name archname title slaying race decrease split
		3071
1797	cf::object::player player	3072	cf::object::player
1798	cf::player peaceful	3073	player
1799	cf::map trigger	3074
		3075	cf::player
		3076	peaceful
		3077
		3078	cf::map
		3079	trigger
1800		3080
1801	=cut	3081	=cut
1802		3082
1803	for (	3083	for (
1804	["cf::object" => qw(contr pay_amount pay_player map)],	3084	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3085	insert remove inv nrof name archname title slaying race
		3086	decrease split destroy change_exp)],
1805	["cf::object::player" => qw(player)],	3087	["cf::object::player" => qw(player)],
1806	["cf::player" => qw(peaceful)],	3088	["cf::player" => qw(peaceful)],
1807	["cf::map" => qw(trigger)],	3089	["cf::map" => qw(trigger)],
1808	) {	3090	) {
1809	no strict 'refs';	3091	no strict 'refs';
…		…
1880	=back	3162	=back
1881		3163
1882	=cut	3164	=cut
1883		3165
1884	#############################################################################	3166	#############################################################################
		3167	# the server's init and main functions
1885		3168
1886	=head2 EXTENSION DATABASE SUPPORT	3169	sub load_facedata($) {
		3170	my ($path) = @_;
1887		3171
1888	Crossfire maintains a very simple database for extension use. It can	3172	# HACK to clear player env face cache, we need some signal framework
1889	currently store anything that can be serialised using Storable, which	3173	# for this (global event?)
1890	excludes objects.	3174	%ext::player_env::MUSIC_FACE_CACHE = ();
1891		3175
1892	The parameter C<$family> should best start with the name of the extension	3176	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1893	using it, it should be unique.
1894		3177
1895	=over 4	3178	warn "loading facedata from $path\n";
1896		3179
1897	=item $hashref = cf::db_get $family	3180	my $facedata;
		3181	0 < aio_load $path, $facedata
		3182	or die "$path: $!";
1898		3183
1899	Return a hashref for use by the extension C<$family>, which can be	3184	$facedata = Coro::Storable::thaw $facedata;
1900	modified. After modifications, you have to call C<cf::db_dirty> or
1901	C<cf::db_sync>.
1902		3185
1903	=item $value = cf::db_get $family => $key	3186	$facedata->{version} == 2
		3187	or cf::cleanup "$path: version mismatch, cannot proceed.";
1904		3188
1905	Returns a single value from the database	3189	# patch in the exptable
1906		3190	$facedata->{resource}{"res/exp_table"} = {
1907	=item cf::db_put $family => $hashref	3191	type => FT_RSRC,
1908		3192	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	});	3193	};
		3194	cf::cede_to_tick;
1958		3195
1959	sub db_dirty() {
1960	$dirty = 1;
1961	$idle->start;
1962	}	3196	{
		3197	my $faces = $facedata->{faceinfo};
1963		3198
1964	sub db_get($;$) {	3199	while (my ($face, $info) = each %$faces) {
1965	@_ >= 2	3200	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1966	? $DB->{$_[0]}{$_[1]}
1967	: ($DB->{$_[0]} ||= { })
1968	}
1969		3201
1970	sub db_put($$;$) {	3202	cf::face::set_visibility $idx, $info->{visibility};
1971	if (@_ >= 3) {	3203	cf::face::set_magicmap $idx, $info->{magicmap};
1972	$DB->{$_[0]}{$_[1]} = $_[2];	3204	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1973	} else {	3205	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1974	$DB->{$_[0]} = $_[1];
1975	}
1976	db_dirty;
1977	}
1978		3206
1979	cf::global->attach (	3207	cf::cede_to_tick;
1980	prio => 10000,
1981	on_cleanup => sub {
1982	db_sync;
1983	},	3208	}
1984	);
1985	}
1986		3209
1987	#############################################################################	3210	while (my ($face, $info) = each %$faces) {
1988	# the server's main()	3211	next unless $info->{smooth};
1989		3212
1990	sub cfg_load {	3213	my $idx = cf::face::find $face
		3214	or next;
		3215
		3216	if (my $smooth = cf::face::find $info->{smooth}) {
		3217	cf::face::set_smooth $idx, $smooth;
		3218	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3219	} else {
		3220	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3221	}
		3222
		3223	cf::cede_to_tick;
		3224	}
		3225	}
		3226
		3227	{
		3228	my $anims = $facedata->{animinfo};
		3229
		3230	while (my ($anim, $info) = each %$anims) {
		3231	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3232	cf::cede_to_tick;
		3233	}
		3234
		3235	cf::anim::invalidate_all; # d'oh
		3236	}
		3237
		3238	{
		3239	# TODO: for gcfclient pleasure, we should give resources
		3240	# that gcfclient doesn't grok a >10000 face index.
		3241	my $res = $facedata->{resource};
		3242
		3243	while (my ($name, $info) = each %$res) {
		3244	if (defined $info->{type}) {
		3245	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3246	my $data;
		3247
		3248	if ($info->{type} & 1) {
		3249	# prepend meta info
		3250
		3251	my $meta = $enc->encode ({
		3252	name => $name,
		3253	%{ $info->{meta} || {} },
		3254	});
		3255
		3256	$data = pack "(w/a*)*", $meta, $info->{data};
		3257	} else {
		3258	$data = $info->{data};
		3259	}
		3260
		3261	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3262	cf::face::set_type $idx, $info->{type};
		3263	} else {
		3264	$RESOURCE{$name} = $info;
		3265	}
		3266
		3267	cf::cede_to_tick;
		3268	}
		3269	}
		3270
		3271	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3272
		3273	1
		3274	}
		3275
		3276	cf::global->attach (on_resource_update => sub {
		3277	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3278	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3279
		3280	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3281	my $sound = $soundconf->{compat}[$_]
		3282	or next;
		3283
		3284	my $face = cf::face::find "sound/$sound->[1]";
		3285	cf::sound::set $sound->[0] => $face;
		3286	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3287	}
		3288
		3289	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3290	my $face = cf::face::find "sound/$v";
		3291	cf::sound::set $k => $face;
		3292	}
		3293	}
		3294	});
		3295
		3296	register_exticmd fx_want => sub {
		3297	my ($ns, $want) = @_;
		3298
		3299	while (my ($k, $v) = each %$want) {
		3300	$ns->fx_want ($k, $v);
		3301	}
		3302	};
		3303
		3304	sub load_resource_file($) {
		3305	my $guard = lock_acquire "load_resource_file";
		3306
		3307	my $status = load_resource_file_ $_[0];
		3308	get_slot 0.1, 100;
		3309	cf::arch::commit_load;
		3310
		3311	$status
		3312	}
		3313
		3314	sub reload_regions {
		3315	# HACK to clear player env face cache, we need some signal framework
		3316	# for this (global event?)
		3317	%ext::player_env::MUSIC_FACE_CACHE = ();
		3318
		3319	load_resource_file "$MAPDIR/regions"
		3320	or die "unable to load regions file\n";
		3321
		3322	for (cf::region::list) {
		3323	$_->{match} = qr/$_->{match}/
		3324	if exists $_->{match};
		3325	}
		3326	}
		3327
		3328	sub reload_facedata {
		3329	load_facedata "$DATADIR/facedata"
		3330	or die "unable to load facedata\n";
		3331	}
		3332
		3333	sub reload_archetypes {
		3334	load_resource_file "$DATADIR/archetypes"
		3335	or die "unable to load archetypes\n";
		3336	}
		3337
		3338	sub reload_treasures {
		3339	load_resource_file "$DATADIR/treasures"
		3340	or die "unable to load treasurelists\n";
		3341	}
		3342
		3343	sub reload_resources {
		3344	warn "reloading resource files...\n";
		3345
		3346	reload_facedata;
		3347	reload_archetypes;
		3348	reload_regions;
		3349	reload_treasures;
		3350
		3351	warn "finished reloading resource files\n";
		3352	}
		3353
		3354	sub reload_config {
1991	open my $fh, "<:utf8", cf::confdir . "/config"	3355	open my $fh, "<:utf8", "$CONFDIR/config"
1992	or return;	3356	or return;
1993		3357
1994	local $/;	3358	local $/;
1995	*CFG = YAML::Syck::Load <$fh>;	3359	*CFG = YAML::Load <$fh>;
1996		3360
1997	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3361	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1998		3362
1999	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3363	$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};	3364	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2001		3365
2002	if (exists $CFG{mlockall}) {	3366	if (exists $CFG{mlockall}) {
2003	eval {	3367	eval {
2004	$CFG{mlockall} ? &mlockall : &munlockall	3368	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2005	and die "WARNING: m(un)lockall failed: $!\n";	3369	and die "WARNING: m(un)lockall failed: $!\n";
2006	};	3370	};
2007	warn $@ if $@;	3371	warn $@ if $@;
2008	}	3372	}
2009	}	3373	}
2010		3374
		3375	sub pidfile() {
		3376	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3377	or die "$PIDFILE: $!";
		3378	flock $fh, &Fcntl::LOCK_EX
		3379	or die "$PIDFILE: flock: $!";
		3380	$fh
		3381	}
		3382
		3383	# make sure only one server instance is running at any one time
		3384	sub atomic {
		3385	my $fh = pidfile;
		3386
		3387	my $pid = <$fh>;
		3388	kill 9, $pid if $pid > 0;
		3389
		3390	seek $fh, 0, 0;
		3391	print $fh $$;
		3392	}
		3393
2011	sub main {	3394	sub main {
		3395	cf::init_globals; # initialise logging
		3396
		3397	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3398	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3399	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3400	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3401
		3402	cf::init_experience;
		3403	cf::init_anim;
		3404	cf::init_attackmess;
		3405	cf::init_dynamic;
		3406
		3407	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3408
2012	# we must not ever block the main coroutine	3409	# we must not ever block the main coroutine
2013	local $Coro::idle = sub {	3410	local $Coro::idle = sub {
2014	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3411	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2015	async { Event::one_event };	3412	(async {
		3413	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3414	EV::loop EV::LOOP_ONESHOT;
		3415	})->prio (Coro::PRIO_MAX);
2016	};	3416	};
2017		3417
2018	cfg_load;	3418	evthread_start IO::AIO::poll_fileno;
2019	db_load;	3419
		3420	cf::sync_job {
		3421	reload_resources;
		3422	reload_config;
		3423	db_init;
		3424
		3425	cf::load_settings;
		3426	cf::load_materials;
		3427	cf::init_uuid;
		3428	cf::init_signals;
		3429	cf::init_commands;
		3430	cf::init_skills;
		3431
		3432	cf::init_beforeplay;
		3433
		3434	atomic;
		3435
2020	load_extensions;	3436	load_extensions;
		3437
		3438	utime time, time, $RUNTIMEFILE;
		3439
		3440	# no (long-running) fork's whatsoever before this point(!)
		3441	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3442
		3443	(pop @POST_INIT)->(0) while @POST_INIT;
		3444	};
		3445
2021	Event::loop;	3446	EV::loop;
2022	}	3447	}
2023		3448
2024	#############################################################################	3449	#############################################################################
2025	# initialisation	3450	# initialisation and cleanup
2026		3451
		3452	# install some emergency cleanup handlers
		3453	BEGIN {
		3454	our %SIGWATCHER = ();
		3455	for my $signal (qw(INT HUP TERM)) {
		3456	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3457	cf::cleanup "SIG$signal";
		3458	};
		3459	}
		3460	}
		3461
		3462	sub write_runtime_sync {
		3463	# first touch the runtime file to show we are still running:
		3464	# the fsync below can take a very very long time.
		3465
		3466	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3467
		3468	my $guard = cf::lock_acquire "write_runtime";
		3469
		3470	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3471	or return;
		3472
		3473	my $value = $cf::RUNTIME + 90 + 10;
		3474	# 10 is the runtime save interval, for a monotonic clock
		3475	# 60 allows for the watchdog to kill the server.
		3476
		3477	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3478	and return;
		3479
		3480	# always fsync - this file is important
		3481	aio_fsync $fh
		3482	and return;
		3483
		3484	# touch it again to show we are up-to-date
		3485	aio_utime $fh, undef, undef;
		3486
		3487	close $fh
		3488	or return;
		3489
		3490	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3491	and return;
		3492
		3493	warn "runtime file written.\n";
		3494
		3495	1
		3496	}
		3497
		3498	our $uuid_lock;
		3499	our $uuid_skip;
		3500
		3501	sub write_uuid_sync($) {
		3502	$uuid_skip ||= $_[0];
		3503
		3504	return if $uuid_lock;
		3505	local $uuid_lock = 1;
		3506
		3507	my $uuid = "$LOCALDIR/uuid";
		3508
		3509	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3510	or return;
		3511
		3512	my $value = uuid_seq uuid_cur;
		3513
		3514	unless ($value) {
		3515	warn "cowardly refusing to write zero uuid value!\n";
		3516	return;
		3517	}
		3518
		3519	my $value = uuid_str $value + $uuid_skip;
		3520	$uuid_skip = 0;
		3521
		3522	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3523	and return;
		3524
		3525	# always fsync - this file is important
		3526	aio_fsync $fh
		3527	and return;
		3528
		3529	close $fh
		3530	or return;
		3531
		3532	aio_rename "$uuid~", $uuid
		3533	and return;
		3534
		3535	warn "uuid file written ($value).\n";
		3536
		3537	1
		3538
		3539	}
		3540
		3541	sub write_uuid($$) {
		3542	my ($skip, $sync) = @_;
		3543
		3544	$sync ? write_uuid_sync $skip
		3545	: async { write_uuid_sync $skip };
		3546	}
		3547
		3548	sub emergency_save() {
		3549	my $freeze_guard = cf::freeze_mainloop;
		3550
		3551	warn "emergency_perl_save: enter\n";
		3552
		3553	cf::sync_job {
		3554	# this is a trade-off: we want to be very quick here, so
		3555	# save all maps without fsync, and later call a global sync
		3556	# (which in turn might be very very slow)
		3557	local $USE_FSYNC = 0;
		3558
		3559	# use a peculiar iteration method to avoid tripping on perl
		3560	# refcount bugs in for. also avoids problems with players
		3561	# and maps saved/destroyed asynchronously.
		3562	warn "emergency_perl_save: begin player save\n";
		3563	for my $login (keys %cf::PLAYER) {
		3564	my $pl = $cf::PLAYER{$login} or next;
		3565	$pl->valid or next;
		3566	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3567	$pl->save;
		3568	}
		3569	warn "emergency_perl_save: end player save\n";
		3570
		3571	warn "emergency_perl_save: begin map save\n";
		3572	for my $path (keys %cf::MAP) {
		3573	my $map = $cf::MAP{$path} or next;
		3574	$map->valid or next;
		3575	$map->save;
		3576	}
		3577	warn "emergency_perl_save: end map save\n";
		3578
		3579	warn "emergency_perl_save: begin database checkpoint\n";
		3580	BDB::db_env_txn_checkpoint $DB_ENV;
		3581	warn "emergency_perl_save: end database checkpoint\n";
		3582
		3583	warn "emergency_perl_save: begin write uuid\n";
		3584	write_uuid_sync 1;
		3585	warn "emergency_perl_save: end write uuid\n";
		3586	};
		3587
		3588	warn "emergency_perl_save: starting sync()\n";
		3589	IO::AIO::aio_sync sub {
		3590	warn "emergency_perl_save: finished sync()\n";
		3591	};
		3592
		3593	warn "emergency_perl_save: leave\n";
		3594	}
		3595
		3596	sub post_cleanup {
		3597	my ($make_core) = @_;
		3598
		3599	warn Carp::longmess "post_cleanup backtrace"
		3600	if $make_core;
		3601
		3602	my $fh = pidfile;
		3603	unlink $PIDFILE if <$fh> == $$;
		3604	}
		3605
		3606	# a safer delete_package, copied from Symbol
		3607	sub clear_package($) {
		3608	my $pkg = shift;
		3609
		3610	# expand to full symbol table name if needed
		3611	unless ($pkg =~ /^main::.*::$/) {
		3612	$pkg = "main$pkg" if $pkg =~ /^::/;
		3613	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3614	$pkg .= '::' unless $pkg =~ /::$/;
		3615	}
		3616
		3617	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3618	my $stem_symtab = *{$stem}{HASH};
		3619
		3620	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3621	or return;
		3622
		3623	# clear all symbols
		3624	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3625	for my $name (keys %$leaf_symtab) {
		3626	_gv_clear *{"$pkg$name"};
		3627	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3628	}
		3629	warn "cleared package $pkg\n";#d#
		3630	}
		3631
2027	sub reload() {	3632	sub do_reload_perl() {
2028	# can/must only be called in main	3633	# can/must only be called in main
2029	if ($Coro::current != $Coro::main) {	3634	if ($Coro::current != $Coro::main) {
2030	warn "can only reload from main coroutine\n";	3635	warn "can only reload from main coroutine";
2031	return;	3636	return;
2032	}	3637	}
2033		3638
		3639	return if $RELOAD++;
		3640
		3641	my $t1 = EV::time;
		3642
		3643	while ($RELOAD) {
2034	warn "reloading...";	3644	warn "reloading...";
2035		3645
2036	my $guard = freeze_mainloop;	3646	warn "entering sync_job";
		3647
		3648	cf::sync_job {
		3649	cf::write_runtime_sync; # external watchdog should not bark
2037	cf::emergency_save;	3650	cf::emergency_save;
		3651	cf::write_runtime_sync; # external watchdog should not bark
2038		3652
2039	eval {	3653	warn "syncing database to disk";
		3654	BDB::db_env_txn_checkpoint $DB_ENV;
		3655
2040	# if anything goes wrong in here, we should simply crash as we already saved	3656	# if anything goes wrong in here, we should simply crash as we already saved
2041		3657
2042	# cancel all watchers	3658	warn "flushing outstanding aio requests";
2043	for (Event::all_watchers) {	3659	while (IO::AIO::nreqs || BDB::nreqs) {
2044	$_->cancel if $_->data & WF_AUTOCANCEL;	3660	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	}	3661	}
2070		3662
2071	Symbol::delete_package $k;	3663	warn "cancelling all extension coros";
		3664	$_->cancel for values %EXT_CORO;
		3665	%EXT_CORO = ();
		3666
		3667	warn "removing commands";
		3668	%COMMAND = ();
		3669
		3670	warn "removing ext/exti commands";
		3671	%EXTCMD = ();
		3672	%EXTICMD = ();
		3673
		3674	warn "unloading/nuking all extensions";
		3675	for my $pkg (@EXTS) {
		3676	warn "... unloading $pkg";
		3677
		3678	if (my $cb = $pkg->can ("unload")) {
		3679	eval {
		3680	$cb->($pkg);
		3681	1
		3682	} or warn "$pkg unloaded, but with errors: $@";
		3683	}
		3684
		3685	warn "... clearing $pkg";
		3686	clear_package $pkg;
2072	}	3687	}
2073		3688
2074	# sync database to disk	3689	warn "unloading all perl modules loaded from $LIBDIR";
2075	cf::db_sync;	3690	while (my ($k, $v) = each %INC) {
2076	IO::AIO::flush;	3691	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2077		3692
		3693	warn "... unloading $k";
		3694	delete $INC{$k};
		3695
		3696	$k =~ s/\.pm$//;
		3697	$k =~ s/\//::/g;
		3698
		3699	if (my $cb = $k->can ("unload_module")) {
		3700	$cb->();
		3701	}
		3702
		3703	clear_package $k;
		3704	}
		3705
2078	# get rid of safe::, as good as possible	3706	warn "getting rid of safe::, as good as possible";
2079	Symbol::delete_package "safe::$_"	3707	clear_package "safe::$_"
2080	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3708	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2081		3709
2082	# remove register_script_function callbacks	3710	warn "unloading cf.pm \"a bit\"";
2083	# TODO
2084
2085	# unload cf.pm "a bit"
2086	delete $INC{"cf.pm"};	3711	delete $INC{"cf.pm"};
		3712	delete $INC{"cf/pod.pm"};
2087		3713
2088	# don't, removes xs symbols, too,	3714	# don't, removes xs symbols, too,
2089	# and global variables created in xs	3715	# and global variables created in xs
2090	#Symbol::delete_package __PACKAGE__;	3716	#clear_package __PACKAGE__;
2091		3717
2092	# reload cf.pm	3718	warn "unload completed, starting to reload now";
		3719
2093	warn "reloading cf.pm";	3720	warn "reloading cf.pm";
2094	require cf;	3721	require cf;
2095	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3722	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2096		3723
2097	# load config and database again	3724	warn "loading config and database again";
2098	cf::cfg_load;	3725	cf::reload_config;
2099	cf::db_load;
2100		3726
2101	# load extensions
2102	warn "load extensions";	3727	warn "loading extensions";
2103	cf::load_extensions;	3728	cf::load_extensions;
2104		3729
2105	# reattach attachments to objects	3730	if ($REATTACH_ON_RELOAD) {
		3731	warn "reattaching attachments to objects/players";
		3732	_global_reattach; # objects, sockets
		3733	warn "reattaching attachments to maps";
		3734	reattach $_ for values %MAP;
		3735	warn "reattaching attachments to players";
		3736	reattach $_ for values %PLAYER;
		3737	}
		3738
		3739	warn "running post_init jobs";
		3740	(pop @POST_INIT)->(1) while @POST_INIT;
		3741
		3742	warn "leaving sync_job";
		3743
		3744	1
		3745	} or do {
		3746	warn $@;
		3747	cf::cleanup "error while reloading, exiting.";
		3748	};
		3749
2106	warn "reattach";	3750	warn "reloaded";
2107	_global_reattach;	3751	--$RELOAD;
		3752	}
		3753
		3754	$t1 = EV::time - $t1;
		3755	warn "reload completed in ${t1}s\n";
		3756	};
		3757
		3758	our $RELOAD_WATCHER; # used only during reload
		3759
		3760	sub reload_perl() {
		3761	# doing reload synchronously and two reloads happen back-to-back,
		3762	# coro crashes during coro_state_free->destroy here.
		3763
		3764	$RELOAD_WATCHER ||= cf::async {
		3765	Coro::AIO::aio_wait cache_extensions;
		3766
		3767	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3768	do_reload_perl;
		3769	undef $RELOAD_WATCHER;
		3770	};
2108	};	3771	};
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	}	3772	}
2161
2162	register "<global>", __PACKAGE__;
2163		3773
2164	register_command "reload" => sub {	3774	register_command "reload" => sub {
2165	my ($who, $arg) = @_;	3775	my ($who, $arg) = @_;
2166		3776
2167	if ($who->flag (FLAG_WIZ)) {	3777	if ($who->flag (FLAG_WIZ)) {
2168	$who->message ("start of reload.");
2169	reload;
2170	$who->message ("end of reload.");	3778	$who->message ("reloading server.");
		3779	async {
		3780	$Coro::current->{desc} = "perl_reload";
		3781	reload_perl;
		3782	};
2171	}	3783	}
2172	};	3784	};
2173		3785
2174	unshift @INC, $LIBDIR;	3786	unshift @INC, $LIBDIR;
2175		3787
2176	$TICK_WATCHER = Event->timer (	3788	my $bug_warning = 0;
2177	reentrant => 0,	3789
2178	prio => 0,	3790	our @WAIT_FOR_TICK;
2179	at => $NEXT_TICK || $TICK,	3791	our @WAIT_FOR_TICK_BEGIN;
2180	data => WF_AUTOCANCEL,	3792
2181	cb => sub {	3793	sub wait_for_tick {
		3794	return if tick_inhibit || $Coro::current == $Coro::main;
		3795
		3796	my $signal = new Coro::Signal;
		3797	push @WAIT_FOR_TICK, $signal;
		3798	$signal->wait;
		3799	}
		3800
		3801	sub wait_for_tick_begin {
		3802	return if tick_inhibit || $Coro::current == $Coro::main;
		3803
		3804	my $signal = new Coro::Signal;
		3805	push @WAIT_FOR_TICK_BEGIN, $signal;
		3806	$signal->wait;
		3807	}
		3808
		3809	sub tick {
		3810	if ($Coro::current != $Coro::main) {
		3811	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3812	unless ++$bug_warning > 10;
		3813	return;
		3814	}
		3815
2182	cf::server_tick; # one server iteration	3816	cf::server_tick; # one server iteration
2183	$RUNTIME += $TICK;
2184	$NEXT_TICK += $TICK;
2185		3817
2186	# if we are delayed by four ticks or more, skip them all	3818	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2187	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3819	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2188		3820	Coro::async_pool {
2189	$TICK_WATCHER->at ($NEXT_TICK);	3821	$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	3822	write_runtime_sync
2211	or warn "ERROR: unable to write runtime file: $!";	3823	or warn "ERROR: unable to write runtime file: $!";
2212	})->();	3824	};
2213	},	3825	}
2214	);	3826
		3827	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3828	$sig->send;
		3829	}
		3830	while (my $sig = shift @WAIT_FOR_TICK) {
		3831	$sig->send;
		3832	}
		3833
		3834	$LOAD = ($NOW - $TICK_START) / $TICK;
		3835	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3836
		3837	if (0) {
		3838	if ($NEXT_TICK) {
		3839	my $jitter = $TICK_START - $NEXT_TICK;
		3840	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3841	warn "jitter $JITTER\n";#d#
		3842	}
		3843	}
		3844	}
		3845
		3846	{
		3847	# configure BDB
		3848
		3849	BDB::min_parallel 8;
		3850	BDB::max_poll_reqs $TICK * 0.1;
		3851	$AnyEvent::BDB::WATCHER->priority (1);
		3852
		3853	unless ($DB_ENV) {
		3854	$DB_ENV = BDB::db_env_create;
		3855	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3856	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3857	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3858	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3859	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3860
		3861	cf::sync_job {
		3862	eval {
		3863	BDB::db_env_open
		3864	$DB_ENV,
		3865	$BDBDIR,
		3866	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3867	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3868	0666;
		3869
		3870	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3871	};
		3872
		3873	cf::cleanup "db_env_open(db): $@" if $@;
		3874	};
		3875	}
		3876
		3877	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3878	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3879	};
		3880	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3881	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3882	};
		3883	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3884	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3885	};
		3886	}
		3887
		3888	{
		3889	# configure IO::AIO
		3890
		3891	IO::AIO::min_parallel 8;
		3892	IO::AIO::max_poll_time $TICK * 0.1;
		3893	undef $AnyEvent::AIO::WATCHER;
		3894	}
		3895
		3896	my $_log_backtrace;
		3897
		3898	sub _log_backtrace {
		3899	my ($msg, @addr) = @_;
		3900
		3901	$msg =~ s/\n//;
		3902
		3903	# limit the # of concurrent backtraces
		3904	if ($_log_backtrace < 2) {
		3905	++$_log_backtrace;
		3906	my $perl_bt = Carp::longmess $msg;
		3907	async {
		3908	$Coro::current->{desc} = "abt $msg";
		3909
		3910	my @bt = fork_call {
		3911	@addr = map { sprintf "%x", $_ } @addr;
		3912	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3913	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3914	or die "addr2line: $!";
		3915
		3916	my @funcs;
		3917	my @res = <$fh>;
		3918	chomp for @res;
		3919	while (@res) {
		3920	my ($func, $line) = splice @res, 0, 2, ();
		3921	push @funcs, "[$func] $line";
		3922	}
		3923
		3924	@funcs
		3925	};
		3926
		3927	LOG llevInfo, "[ABT] $perl_bt\n";
		3928	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		3929	LOG llevInfo, "[ABT] $_\n" for @bt;
		3930	--$_log_backtrace;
		3931	};
		3932	} else {
		3933	LOG llevInfo, "[ABT] $msg\n";
		3934	LOG llevInfo, "[ABT] [suppressed]\n";
		3935	}
		3936	}
		3937
		3938	# load additional modules
		3939	use cf::pod;
2215		3940
2216	END { cf::emergency_save }	3941	END { cf::emergency_save }
2217		3942
2218	1	3943	1
2219		3944

Diff Legend

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