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

Diff Legend

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