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

Diff Legend

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