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

Diff Legend

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