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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.458 by root, Sat Dec 13 20:34:37 2008 UTC

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

Diff Legend

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