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.132 by root, Thu Jan 4 01:35:56 2007 UTC vs.
Revision 1.466 by root, Thu Jan 8 03:03:24 2009 UTC

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

Diff Legend

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