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

Diff Legend

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