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.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.612 by root, Wed Nov 21 12:47:09 2012 UTC

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

Diff Legend

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