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

Diff Legend

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