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.186 by root, Sat Jan 20 01:12:39 2007 UTC vs.
Revision 1.595 by root, Fri Nov 9 16:27:55 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 ();
		62	use IO::AIO ();
25	use Time::HiRes;	63	use Time::HiRes;
		64	use Compress::LZF;
		65	use Digest::MD5 ();
26		66
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	67	AnyEvent::detect;
		68
		69	# configure various modules to our taste
		70	#
		71	$Storable::canonical = 1; # reduce rsync transfers
		72	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		73
		74	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		75
		76	# make sure c-lzf reinitialises itself
		77	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		78	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		79
		80	# strictly for debugging
		81	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
28		82
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	83	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		84
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	85	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		86
36	our %COMMAND = ();	87	our %COMMAND = ();
37	our %COMMAND_TIME = ();	88	our %COMMAND_TIME = ();
38		89
39	our @EXTS = (); # list of extension package names	90	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	91	our %EXTCMD = ();
		92	our %EXTACMD = ();
		93	our %EXTICMD = ();
		94	our %EXTIACMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	95	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	96	our %EXT_MAP = (); # pluggable maps
43		97
		98	our $RELOAD; # number of reloads so far, non-zero while in reload
44	our @EVENT;	99	our @EVENT;
45	our $LIBDIR = datadir . "/ext";	100	our @REFLECT; # set by XS
		101	our %REFLECT; # set by us
46		102
47	our $TICK = MAX_TIME * 1e-6;	103	our $CONFDIR = confdir;
48	our $TICK_WATCHER;	104
49	our $AIO_POLL_WATCHER;	105	our $DATADIR = datadir;
50	our $WRITE_RUNTIME_WATCHER;	106	our $LIBDIR = "$DATADIR/ext";
		107	our $PODDIR = "$DATADIR/pod";
		108	our $MAPDIR = "$DATADIR/" . mapdir;
		109
		110	our $LOCALDIR = localdir;
		111	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		112	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		113	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		114	our $RANDOMDIR = "$LOCALDIR/random";
		115	our $BDBDIR = "$LOCALDIR/db";
		116	our $PIDFILE = "$LOCALDIR/pid";
		117	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		118
		119	#our %RESOURCE; # unused
		120
		121	our $OUTPUT_RATE_MIN = 3000;
		122	our $OUTPUT_RATE_MAX = 1000000;
		123
		124	our $MAX_LINKS = 32; # how many chained exits to follow
		125	our $VERBOSE_IO = 1;
		126
		127	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		128	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	129	our $NEXT_TICK;
		130	our $USE_FSYNC = 1; # use fsync to write maps - default on
		131
		132	our $BDB_DEADLOCK_WATCHER;
		133	our $BDB_CHECKPOINT_WATCHER;
		134	our $BDB_TRICKLE_WATCHER;
		135	our $DB_ENV;
		136
		137	our @EXTRA_MODULES = qw(pod match mapscript incloader);
		138
		139	our %CFG;
		140	our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
		141
		142	our $UPTIME; $UPTIME ||= time;
		143	our $RUNTIME = 0;
		144	our $SERVER_TICK = 0;
52	our $NOW;	145	our $NOW;
53		146
54	our %CFG;	147	our (%PLAYER, %PLAYER_LOADING); # all users
55		148	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	149	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		150
67	# used to convert map paths into valid unix filenames by replacing / by ∕	151	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	152	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		153
		154	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		155	our $LOADAVG; # same thing, but with alpha-smoothing
		156	our $JITTER; # average jitter
		157	our $TICK_START; # for load detecting purposes
		158
		159	our @POST_INIT;
		160
		161	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		162	our $REALLY_UNLOOP; # never set to true, please :)
		163
		164	our $WAIT_FOR_TICK = new Coro::Signal;
		165	our @WAIT_FOR_TICK_BEGIN;
		166
70	binmode STDOUT;	167	binmode STDOUT;
71	binmode STDERR;	168	binmode STDERR;
72		169
73	# read virtual server time, if available	170	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	171	unless ($RUNTIME || !-e $RUNTIMEFILE) {
75	open my $fh, "<", cf::localdir . "/runtime"	172	open my $fh, "<", $RUNTIMEFILE
76	or die "unable to read runtime file: $!";	173	or die "unable to read $RUNTIMEFILE file: $!";
77	$RUNTIME = <$fh> + 0.;	174	$RUNTIME = <$fh> + 0.;
78	}	175	}
79		176
80	mkdir cf::localdir;	177	eval "sub TICK() { $TICK } 1" or die;
81	mkdir cf::localdir . "/" . cf::playerdir;	178
82	mkdir cf::localdir . "/" . cf::tmpdir;	179	mkdir $_
83	mkdir cf::localdir . "/" . cf::uniquedir;	180	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
84	mkdir $RANDOM_MAPS;
85		181
86	our $EMERGENCY_POSITION;	182	our $EMERGENCY_POSITION;
87		183
		184	sub cf::map::normalise;
		185
		186	sub in_main() {
		187	$Coro::current == $Coro::main
		188	}
		189
88	#############################################################################	190	#############################################################################
89		191
		192	%REFLECT = ();
		193	for (@REFLECT) {
		194	my $reflect = JSON::XS::decode_json $_;
		195	$REFLECT{$reflect->{class}} = $reflect;
		196	}
		197
		198	# this is decidedly evil
		199	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		200
		201	#############################################################################
		202
90	=head2 GLOBAL VARIABLES	203	=head2 GLOBAL VARIABLES
91		204
92	=over 4	205	=over 4
93		206
94	=item $cf::UPTIME	207	=item $cf::UPTIME
95		208
96	The timestamp of the server start (so not actually an uptime).	209	The timestamp of the server start (so not actually an "uptime").
		210
		211	=item $cf::SERVER_TICK
		212
		213	An unsigned integer that starts at zero when the server is started and is
		214	incremented on every tick.
		215
		216	=item $cf::NOW
		217
		218	The (real) time of the last (current) server tick - updated before and
		219	after tick processing, so this is useful only as a rough "what time is it
		220	now" estimate.
		221
		222	=item $cf::TICK
		223
		224	The interval between each server tick, in seconds.
97		225
98	=item $cf::RUNTIME	226	=item $cf::RUNTIME
99		227
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	228	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	229	every server tick.
102		230
103	=item $cf::LIBDIR	231	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		232	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		233	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		234
105	The perl library directory, where extensions and cf-specific modules can	235	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	236	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		237	unique-items directory, player file directory, random maps directory and
		238	database environment.
107		239
		240	=item $cf::LOADAVG
		241
		242	The current CPU load on the server (alpha-smoothed), as a value between 0
		243	(none) and 1 (overloaded), indicating how much time is spent on processing
		244	objects per tick. Healthy values are < 0.5.
		245
108	=item $cf::NOW	246	=item $cf::LOAD
109		247
110	The time of the last (current) server tick.	248	The raw value load value from the last tick.
111
112	=item $cf::TICK
113
114	The interval between server ticks, in seconds.
115		249
116	=item %cf::CFG	250	=item %cf::CFG
117		251
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	252	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	253	from wherever your confdir points to.
120		254
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	255	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		256
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	257	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	258	returns directly I<after> the tick processing (and consequently, can only wake one thread
125	processing has been done. Call C<< ->wait >> on them to maximise the	259	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	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 + 90 + 10;	735	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		736
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	737	sub post_fork {
359	and return;	738	reset_signals;
		739	}
360		740
361	aio_fsync $fh	741	sub fork_call(&@) {
362	and return;	742	my ($cb, @args) = @_;
363		743
364	close $fh	744	# we seemingly have to make a local copy of the whole thing,
365	or return;	745	# otherwise perl prematurely frees the stuff :/
		746	# TODO: investigate and fix (likely this will be rather laborious)
366		747
367	aio_rename "$runtime~", $runtime	748	my @res = Coro::Util::fork_eval {
368	and return;	749	cf::post_fork;
		750	&$cb
		751	} @args;
369		752
		753	wantarray ? @res : $res[-1]
		754	}
		755
		756	sub objinfo {
370	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 = Time::HiRes::time;
		907	my $data = $process->(\@data);
		908	my $t2 = Time::HiRes::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 });
371	}	931	}
372		932
373	=back	933	=back
374		934
375	=cut	935	=cut
376		936
377	#############################################################################	937	#############################################################################
378		938
379	=head2 ATTACHABLE OBJECTS	939	=head2 ATTACHABLE OBJECTS
380		940
381	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
382	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")
383	to it. All such attachable objects support the following methods.	943	to it. All such attachable objects support the following methods.
384		944
385	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>
386	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
387	crossfire+).	947	Deliantra).
388		948
389	=over 4	949	=over 4
390		950
391	=item $attachable->attach ($attachment, key => $value...)	951	=item $attachable->attach ($attachment, key => $value...)
392		952
…		…
436	=item cf::CLASS::attachment $name, ...	996	=item cf::CLASS::attachment $name, ...
437		997
438	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
439	given CLASS can refer to this attachment.	999	given CLASS can refer to this attachment.
440		1000
441	Some classes such as crossfire maps and objects can specify attachments	1001	Some classes such as deliantra maps and objects can specify attachments
442	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.
443		1003
444	These calls expect any number of the following handler/hook descriptions:	1004	These calls expect any number of the following handler/hook descriptions:
445		1005
446	=over 4	1006	=over 4
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	1115	$registry = $CB_TYPE[$object_type] ||= [];
556		1116
557	} elsif ($type eq "subtype") {	1117	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	1118	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	1119	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1120	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		1121
562	} elsif ($type eq "package") {	1122	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	1123	my $pkg = shift @arg;
564		1124
565	while (my ($name, $id) = each %cb_id) {	1125	while (my ($name, $id) = each %cb_id) {
…		…
570		1130
571	} elsif (exists $cb_id{$type}) {	1131	} elsif (exists $cb_id{$type}) {
572	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1132	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
573		1133
574	} elsif (ref $type) {	1134	} elsif (ref $type) {
575	warn "attaching objects not supported, ignoring.\n";	1135	error "attaching objects not supported, ignoring.\n";
576		1136
577	} else {	1137	} else {
578	shift @arg;	1138	shift @arg;
579	warn "attach argument '$type' not supported, ignoring.\n";	1139	error "attach argument '$type' not supported, ignoring.\n";
580	}	1140	}
581	}	1141	}
582	}	1142	}
583		1143
584	sub _object_attach {	1144	sub _object_attach {
…		…
594	_attach $registry, $klass, @attach;	1154	_attach $registry, $klass, @attach;
595	}	1155	}
596		1156
597	$obj->{$name} = \%arg;	1157	$obj->{$name} = \%arg;
598	} else {	1158	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	1159	info "object uses attachment '$name' which is not available, postponing.\n";
600	}	1160	}
601		1161
602	$obj->{_attachment}{$name} = undef;	1162	$obj->{_attachment}{$name} = undef;
603	}	1163	}
604		1164
…		…
606	if (ref $_[0]) {	1166	if (ref $_[0]) {
607	_object_attach @_;	1167	_object_attach @_;
608	} else {	1168	} else {
609	_attach shift->_attach_registry, @_;	1169	_attach shift->_attach_registry, @_;
610	}	1170	}
		1171	_recalc_want;
611	};	1172	};
612		1173
613	# all those should be optimised	1174	# all those should be optimised
614	sub cf::attachable::detach {	1175	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	1176	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	1179	delete $obj->{_attachment}{$name};
619	reattach ($obj);	1180	reattach ($obj);
620	} else {	1181	} else {
621	Carp::croak "cannot, currently, detach class attachments";	1182	Carp::croak "cannot, currently, detach class attachments";
622	}	1183	}
		1184	_recalc_want;
623	};	1185	};
624		1186
625	sub cf::attachable::attached {	1187	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	1188	my ($obj, $name) = @_;
627		1189
…		…
642	";	1204	";
643	die if $@;	1205	die if $@;
644	}	1206	}
645		1207
646	our $override;	1208	our $override;
647	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?
648		1210
649	sub override {	1211	sub override {
650	$override = 1;	1212	$override = 1;
651	@invoke_results = ();	1213	@INVOKE_RESULTS = (@_);
652	}	1214	}
653		1215
654	sub do_invoke {	1216	sub do_invoke {
655	my $event = shift;	1217	my $event = shift;
656	my $callbacks = shift;	1218	my $callbacks = shift;
657		1219
658	@invoke_results = ();	1220	@INVOKE_RESULTS = ();
659		1221
660	local $override;	1222	local $override;
661		1223
662	for (@$callbacks) {	1224	for (@$callbacks) {
663	eval { &{$_->[1]} };	1225	eval { &{$_->[1]} };
664		1226
665	if ($@) {	1227	if ($@) {
666	warn "$@";
667	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1228	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
668	override;	1229	override;
669	}	1230	}
670		1231
671	return 1 if $override;	1232	return 1 if $override;
672	}	1233	}
673		1234
674	0	1235	0
675	}	1236	}
676		1237
677	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1238	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
678		1239
679	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1240	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
680		1241
681	Generate an object-specific event with the given arguments.	1242	Generate an object-specific event with the given arguments.
682		1243
683	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
684	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
685	results (if you must, access C<@cf::invoke_results> directly).	1246	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		1247
687	=back	1248	=back
688		1249
689	=cut	1250	=cut
690		1251
691	#############################################################################	1252	#############################################################################
692	# 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	}
693		1296
694	sub reattach {	1297	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	1298	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	1299	my ($obj) = @_;
697		1300
		1301	# no longer needed after getting rid of delete_package?
698	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
699		1303
700	my $registry = $obj->registry;	1304	my $registry = $obj->registry;
701		1305
702	@$registry = ();	1306	@$registry = ();
703		1307
…		…
708	for (@$attach) {	1312	for (@$attach) {
709	my ($klass, @attach) = @$_;	1313	my ($klass, @attach) = @$_;
710	_attach $registry, $klass, @attach;	1314	_attach $registry, $klass, @attach;
711	}	1315	}
712	} else {	1316	} else {
713	warn "object uses attachment '$name' that is not available, postponing.\n";	1317	info "object uses attachment '$name' that is not available, postponing.\n";
714	}	1318	}
715	}	1319	}
716	}	1320	}
717		1321
718	cf::attachable->attach (	1322	cf::attachable->attach (
719	prio => -1000000,	1323	prio => -1000000,
720	on_instantiate => sub {	1324	on_instantiate => sub {
721	my ($obj, $data) = @_;	1325	my ($obj, $data) = @_;
722		1326
723	$data = from_json $data;	1327	$data = decode_json $data;
724		1328
725	for (@$data) {	1329	for (@$data) {
726	my ($name, $args) = @$_;	1330	my ($name, $args) = @$_;
727		1331
728	$obj->attach ($name, %{$args || {} });	1332	$obj->attach ($name, %{$args || {} });
…		…
744	sub object_freezer_save {	1348	sub object_freezer_save {
745	my ($filename, $rdata, $objs) = @_;	1349	my ($filename, $rdata, $objs) = @_;
746		1350
747	sync_job {	1351	sync_job {
748	if (length $$rdata) {	1352	if (length $$rdata) {
		1353	utf8::decode (my $decname = $filename);
749	warn sprintf "saving %s (%d,%d)\n",	1354	trace sprintf "saving %s (%d,%d)\n",
750	$filename, length $$rdata, scalar @$objs;	1355	$decname, length $$rdata, scalar @$objs
		1356	if $VERBOSE_IO;
751		1357
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1358	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1359	aio_chmod $fh, SAVE_MODE;
754	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;
755	aio_fsync $fh;	1363	aio_fsync $fh;
		1364	}
756	close $fh;	1365	aio_close $fh;
757		1366
758	if (@$objs) {	1367	if (@$objs) {
759	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) {
760	chmod SAVE_MODE, $fh;	1369	aio_chmod $fh, SAVE_MODE;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1370	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
762	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;
763	aio_fsync $fh;	1374	aio_fsync $fh;
		1375	}
764	close $fh;	1376	aio_close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1377	aio_rename "$filename.pst~", "$filename.pst";
766	}	1378	}
767	} else {	1379	} else {
768	aio_unlink "$filename.pst";	1380	aio_unlink "$filename.pst";
769	}	1381	}
770		1382
771	aio_rename "$filename~", $filename;	1383	aio_rename "$filename~", $filename;
		1384
		1385	$filename =~ s%/[^/]+$%%;
		1386	aio_pathsync $filename if $cf::USE_FSYNC;
772	} else {	1387	} else {
773	warn "FATAL: $filename~: $!\n";	1388	error "unable to save objects: $filename~: $!\n";
774	}	1389	}
775	} else {	1390	} else {
776	aio_unlink $filename;	1391	aio_unlink $filename;
777	aio_unlink "$filename.pst";	1392	aio_unlink "$filename.pst";
778	}	1393	}
779	}	1394	};
780	}	1395	}
781		1396
782	sub object_freezer_as_string {	1397	sub object_freezer_as_string {
783	my ($rdata, $objs) = @_;	1398	my ($rdata, $objs) = @_;
784		1399
…		…
796	or return;	1411	or return;
797		1412
798	unless (aio_stat "$filename.pst") {	1413	unless (aio_stat "$filename.pst") {
799	(aio_load "$filename.pst", $av) >= 0	1414	(aio_load "$filename.pst", $av) >= 0
800	or return;	1415	or return;
		1416
801	$av = eval { (Storable::thaw $av)->{objs} };	1417	my $st = eval { Coro::Storable::thaw $av };
		1418	$av = $st->{objs};
802	}	1419	}
803		1420
		1421	utf8::decode (my $decname = $filename);
804	warn sprintf "loading %s (%d)\n",	1422	trace sprintf "loading %s (%d,%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1423	$decname, length $data, scalar @{$av || []}
		1424	if $VERBOSE_IO;
		1425
806	return ($data, $av);	1426	($data, $av)
807	}	1427	}
		1428
		1429	=head2 COMMAND CALLBACKS
		1430
		1431	=over 4
		1432
		1433	=cut
808		1434
809	#############################################################################	1435	#############################################################################
810	# command handling &c	1436	# command handling &c
811		1437
812	=item cf::register_command $name => \&callback($ob,$args);	1438	=item cf::register_command $name => \&callback($ob,$args)
813		1439
814	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
815	$name.	1441	$name.
816		1442
817	=cut	1443	=cut
…		…
823	#warn "registering command '$name/$time' to '$caller'";	1449	#warn "registering command '$name/$time' to '$caller'";
824		1450
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1451	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1452	}
827		1453
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1454	=item cf::register_extcmd $name => \&callback($pl,@args)
829		1455
830	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.
831		1461
832	If the callback returns something, it is sent back as if reply was being	1462	The values will be sent back to the client.
833	called.
834		1463
835	=cut	1464	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
836		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
837	sub register_extcmd {	1486	sub register_extcmd($$) {
838	my ($name, $cb) = @_;	1487	my ($name, $cb) = @_;
839		1488
840	$EXTCMD{$name} = $cb;	1489	$EXTCMD{$name} = $cb;
841	}	1490	}
842		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
843	cf::player->attach (	1512	cf::player->attach (
844	on_command => sub {	1513	on_unknown_command => sub {
845	my ($pl, $name, $params) = @_;	1514	my ($pl, $name, $params) = @_;
846		1515
847	my $cb = $COMMAND{$name}	1516	my $cb = $COMMAND{$name}
848	or return;	1517	or return;
849		1518
…		…
854	cf::override;	1523	cf::override;
855	},	1524	},
856	on_extcmd => sub {	1525	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1526	my ($pl, $buf) = @_;
858		1527
859	my $msg = eval { from_json $buf };	1528	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1529
861	if (ref $msg) {	1530	if (ref $msg) {
		1531	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1532
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1533	if (my $cb = $EXTACMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1534	$cb->(
864	$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);
865	}	1547	}
		1548
		1549	$pl->ext_msg ("reply-$reply", @reply)
		1550	if $reply;
866	}	1551	}
		1552
867	} else {	1553	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1554	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1555	}
870		1556
871	cf::override;	1557	cf::override;
872	},	1558	},
873	);	1559	);
874		1560
		1561	# "readahead" all extensions
875	sub load_extension {	1562	sub cache_extensions {
876	my ($path) = @_;	1563	my $grp = IO::AIO::aio_group;
877		1564
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1565	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
879	my $base = $1;	1566	for (grep /\.ext$/, @{$_[0]}) {
880	my $pkg = $1;	1567	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}	1568	}
903	die $@;
904	}	1569	};
905		1570
906	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;
907	}	1583	}
908		1584
909	sub load_extensions {	1585	sub load_extensions {
		1586	info "loading extensions...";
		1587
		1588	%EXT_CFG = ();
		1589
		1590	cf::sync_job {
		1591	my %todo;
		1592
910	for my $ext (<$LIBDIR/*.ext>) {	1593	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1594	next unless -r $path;
912	eval {	1595
913	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	}
914	1	1668	}
915	} 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	}
916	}	1681	};
917	}	1682	}
918		1683
919	#############################################################################	1684	#############################################################################
920		1685
		1686	=back
		1687
921	=head2 CORE EXTENSIONS	1688	=head2 CORE EXTENSIONS
922		1689
923	Functions and methods that extend core crossfire objects.	1690	Functions and methods that extend core deliantra objects.
924		1691
925	=cut	1692	=cut
926		1693
927	package cf::player;	1694	package cf::player;
928		1695
…		…
930		1697
931	=head3 cf::player	1698	=head3 cf::player
932		1699
933	=over 4	1700	=over 4
934		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
935	=item cf::player::find $login	1716	=item cf::player::find $login
936		1717
937	Returns the given player object, loading it if necessary (might block).	1718	Returns the given player object, loading it if necessary (might block).
938		1719
939	=cut	1720	=cut
940		1721
941	sub playerdir($) {	1722	sub playerdir($) {
942	cf::localdir	1723	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1724	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1725	}
948		1726
949	sub path($) {	1727	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1728	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1729
952	(playerdir $login) . "/$login.pl"	1730	(playerdir $login) . "/playerdata"
953	}	1731	}
954		1732
955	sub find_active($) {	1733	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1734	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1735	and $cf::PLAYER{$_[0]}->active
…		…
960		1738
961	sub exists($) {	1739	sub exists($) {
962	my ($login) = @_;	1740	my ($login) = @_;
963		1741
964	$cf::PLAYER{$login}	1742	$cf::PLAYER{$login}
965	or cf::sync_job { !aio_stat path $login }	1743	or !aio_stat path $login
966	}	1744	}
967		1745
968	sub find($) {	1746	sub find($) {
969	return $cf::PLAYER{$_[0]} || do {	1747	return $cf::PLAYER{$_[0]} || do {
970	my $login = $_[0];	1748	my $login = $_[0];
971		1749
972	my $guard = cf::lock_acquire "user_find:$login";	1750	my $guard = cf::lock_acquire "user_find:$login";
973		1751
974	$cf::PLAYER{$_[0]} || do {	1752	$cf::PLAYER{$_[0]} || do {
975	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
976	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;
977	$cf::PLAYER{$login} = $pl	1768	$cf::PLAYER{$login} = $pl
978	}	1769	}
979	}	1770	}
980	}	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	);
981		1785
982	sub save($) {	1786	sub save($) {
983	my ($pl) = @_;	1787	my ($pl) = @_;
984		1788
985	return if $pl->{deny_save};	1789	return if $pl->{deny_save};
…		…
990	return if $pl->{deny_save};	1794	return if $pl->{deny_save};
991		1795
992	aio_mkdir playerdir $pl, 0770;	1796	aio_mkdir playerdir $pl, 0770;
993	$pl->{last_save} = $cf::RUNTIME;	1797	$pl->{last_save} = $cf::RUNTIME;
994		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
995	$pl->save_pl ($path);	1804	$pl->save_pl ($path);
996	Coro::cede;	1805	cf::cede_to_tick;
997	}	1806	}
998		1807
999	sub new($) {	1808	sub new($) {
1000	my ($login) = @_;	1809	my ($login) = @_;
1001		1810
…		…
1007	$cf::PLAYER{$login} = $self;	1816	$cf::PLAYER{$login} = $self;
1008		1817
1009	$self	1818	$self
1010	}	1819	}
1011		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
1012	=item $pl->quit_character	1831	=item $pl->quit_character
1013		1832
1014	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
1015	be destroyed. May block for a long time.	1834	be destroyed. May block for a long time.
1016		1835
1017	=cut	1836	=cut
1018		1837
1019	sub quit_character {	1838	sub quit_character {
1020	my ($pl) = @_;	1839	my ($pl) = @_;
1021		1840
		1841	my $name = $pl->ob->name;
		1842
1022	$pl->{deny_save} = 1;	1843	$pl->{deny_save} = 1;
1023	$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
1024		1845
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1846	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1026	$pl->deactivate;	1847	$pl->deactivate;
		1848
		1849	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1027	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1850	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1851	ext::highscore::check ($pl->ob);
		1852
1028	$pl->ns->destroy if $pl->ns;	1853	$pl->ns->destroy if $pl->ns;
1029		1854
1030	my $path = playerdir $pl;	1855	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1856	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1857	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1858	delete $cf::PLAYER{$pl->ob->name};
1034	$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
1035	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;
1036	}	1881	}
1037		1882
1038	=item cf::player::list_logins	1883	=item cf::player::list_logins
1039		1884
1040	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
1041	while and may block, so not sync_job-capable, ever.	1886	while and may block, so not sync_job-capable, ever.
1042		1887
1043	=cut	1888	=cut
1044		1889
1045	sub list_logins {	1890	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1891	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1892	or return [];
1048		1893
1049	my @logins;	1894	my @logins;
1050		1895
1051	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") {
1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1902	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1053	aio_read $fh, 0, 512, my $buf, 0 or next;	1903	aio_read $fh, 0, 512, my $buf, 0 or next;
1054	$buf !~ /^password -------------$/m or next; # official not-valid tag	1904	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1905	}
1055		1906
1056	utf8::decode $login;	1907	utf8::decode $login;
1057	push @logins, $login;	1908	push @logins, $login;
1058	}	1909	}
1059		1910
1060	\@logins	1911	\@logins
1061	}	1912	}
1062		1913
1063	=item $player->maps	1914	=item $player->maps
1064		1915
		1916	=item cf::player::maps $login
		1917
1065	Returns an arrayref of map paths that are private for this	1918	Returns an arrayref of map paths that are private for this
1066	player. May block.	1919	player. May block.
1067		1920
1068	=cut	1921	=cut
1069		1922
1070	sub maps($) {	1923	sub maps($) {
1071	my ($pl) = @_;	1924	my ($pl) = @_;
		1925
		1926	$pl = ref $pl ? $pl->ob->name : $pl;
1072		1927
1073	my $files = aio_readdir playerdir $pl	1928	my $files = aio_readdir playerdir $pl
1074	or return;	1929	or return;
1075		1930
1076	my @paths;	1931	my @paths;
…		…
1078	for (@$files) {	1933	for (@$files) {
1079	utf8::decode $_;	1934	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1935	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1936	next unless /^$PATH_SEP/o;
1082		1937
1083	s/\.map$//;	1938	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1939	}
1086		1940
1087	\@paths	1941	\@paths
1088	}	1942	}
1089		1943
		1944	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1945
		1946	Expand deliantra pod fragments into protocol xml.
		1947
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1948	=item $player->ext_msg ($type, @msg)
1091		1949
1092	Sends an ext reply to the player.	1950	Sends an ext event to the client.
1093		1951
1094	=cut	1952	=cut
1095		1953
1096	sub ext_reply($$$%) {	1954	sub ext_msg($$@) {
1097	my ($self, $id, %msg) = @_;	1955	my ($self, $type, @msg) = @_;
1098		1956
1099	$msg{msgid} = $id;	1957	$self->ns->ext_msg ($type, @msg);
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1958	}
1103		1959
1104	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	}
1105		1990
1106	=back	1991	=back
1107
1108		1992
1109	=head3 cf::map	1993	=head3 cf::map
1110		1994
1111	=over 4	1995	=over 4
1112		1996
…		…
1124	our $MAX_RESET = 3600;	2008	our $MAX_RESET = 3600;
1125	our $DEFAULT_RESET = 3000;	2009	our $DEFAULT_RESET = 3000;
1126		2010
1127	sub generate_random_map {	2011	sub generate_random_map {
1128	my ($self, $rmp) = @_;	2012	my ($self, $rmp) = @_;
1129	# mit "rum" bekleckern, nicht	2013
		2014	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		2015
1130	$self->_create_random_map (	2016	$self->_create_random_map ($rmp);
1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134	$rmp->{exit_on_final_map},
1135	$rmp->{xsize}, $rmp->{ysize},
1136	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1138	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1139	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(cf::region::find $rmp->{region}), $rmp->{custom}
1142	)
1143	}	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
1144		2026
1145	sub register {	2027	sub register {
1146	my (undef, $regex) = @_;	2028	my (undef, $regex, $prio) = @_;
1147	my $pkg = caller;	2029	my $pkg = caller;
1148		2030
1149	no strict;
1150	push @{"$pkg\::ISA"}, __PACKAGE__;	2031	push @{"$pkg\::ISA"}, __PACKAGE__;
1151		2032
1152	$EXT_MAP{$pkg} = qr<$regex>;	2033	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1153	}	2034	}
1154		2035
1155	# also paths starting with '/'	2036	# also paths starting with '/'
1156	$EXT_MAP{"cf::map"} = qr{^(?=/)};	2037	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1157		2038
1158	sub thawer_merge {	2039	sub thawer_merge {
1159	my ($self, $merge) = @_;	2040	my ($self, $merge) = @_;
1160		2041
1161	# we have to keep some variables in memory intact	2042	# we have to keep some variables in memory intact
1162	local $self->{path};	2043	local $self->{path};
1163	local $self->{load_path};	2044	local $self->{load_path};
1164	local $self->{deny_save};
1165	local $self->{deny_reset};
1166		2045
1167	$self->SUPER::thawer_merge ($merge);	2046	$self->SUPER::thawer_merge ($merge);
1168	}	2047	}
1169		2048
1170	sub normalise {	2049	sub normalise {
1171	my ($path, $base) = @_;	2050	my ($path, $base) = @_;
		2051
		2052	$path = "$path"; # make sure it's a string
		2053
		2054	$path =~ s/\.map$//;
1172		2055
1173	# map plan:	2056	# map plan:
1174	#	2057	#
1175	# /! non-realised random map exit (special hack!)	2058	# /! non-realised random map exit (special hack!)
1176	# {... are special paths that are not being touched	2059	# {... are special paths that are not being touched
…		…
1189	$base =~ s{[^/]+/?$}{};	2072	$base =~ s{[^/]+/?$}{};
1190	$path = "$base/$path";	2073	$path = "$base/$path";
1191	}	2074	}
1192		2075
1193	for ($path) {	2076	for ($path) {
1194	redo if s{//}{/};
1195	redo if s{/\.?/}{/};	2077	redo if s{/\.?/}{/};
1196	redo if s{/[^/]+/\.\./}{/};	2078	redo if s{/[^/]+/\.\./}{/};
1197	}	2079	}
1198		2080
1199	$path	2081	$path
…		…
1204		2086
1205	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
1206		2088
1207	$path = normalise $path, $base;	2089	$path = normalise $path, $base;
1208		2090
1209	for my $pkg (keys %EXT_MAP) {	2091	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1210	if ($path =~ $EXT_MAP{$pkg}) {	2092	if ($path =~ $EXT_MAP{$pkg}[1]) {
1211	my $self = bless cf::map::new, $pkg;	2093	my $self = bless cf::map::new, $pkg;
1212	$self->{path} = $path; $self->path ($path);	2094	$self->{path} = $path; $self->path ($path);
1213	$self->init; # pass $1 etc.	2095	$self->init; # pass $1 etc.
1214	return $self;	2096	return $self;
1215	}	2097	}
1216	}	2098	}
1217		2099
1218	Carp::carp "unable to resolve path '$path'.";	2100	Carp::cluck "unable to resolve path '$path' (base '$base')";
1219	()	2101	()
1220	}	2102	}
1221		2103
		2104	# may re-bless or do other evil things
1222	sub init {	2105	sub init {
1223	my ($self) = @_;	2106	my ($self) = @_;
1224		2107
1225	$self	2108	$self
1226	}	2109	}
…		…
1238		2121
1239	# the original (read-only) location	2122	# the original (read-only) location
1240	sub load_path {	2123	sub load_path {
1241	my ($self) = @_;	2124	my ($self) = @_;
1242		2125
1243	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	2126	"$MAPDIR/$self->{path}.map"
1244	}	2127	}
1245		2128
1246	# the temporary/swap location	2129	# the temporary/swap location
1247	sub save_path {	2130	sub save_path {
1248	my ($self) = @_;	2131	my ($self) = @_;
1249		2132
1250	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2133	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1251	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	2134	"$TMPDIR/$path.map"
1252	}	2135	}
1253		2136
1254	# the unique path, undef == no special unique path	2137	# the unique path, undef == no special unique path
1255	sub uniq_path {	2138	sub uniq_path {
1256	my ($self) = @_;	2139	my ($self) = @_;
1257		2140
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2141	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1259	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	2142	"$UNIQUEDIR/$path"
1260	}	2143	}
1261		2144
1262	# and all this just because we cannot iterate over	2145	sub decay_objects {
1263	# all maps in C++...
1264	sub change_all_map_light {
1265	my ($change) = @_;	2146	my ($self) = @_;
1266		2147
1267	$_->change_map_light ($change)	2148	return if $self->{deny_reset};
1268	for grep $_->outdoor, values %cf::MAP;	2149
		2150	$self->do_decay_objects;
1269	}	2151	}
1270		2152
1271	sub unlink_save {	2153	sub unlink_save {
1272	my ($self) = @_;	2154	my ($self) = @_;
1273		2155
…		…
1278		2160
1279	sub load_header_from($) {	2161	sub load_header_from($) {
1280	my ($self, $path) = @_;	2162	my ($self, $path) = @_;
1281		2163
1282	utf8::encode $path;	2164	utf8::encode $path;
1283	aio_open $path, O_RDONLY, 0	2165	my $f = new_from_file cf::object::thawer $path
1284	or return;	2166	or return;
1285		2167
1286	$self->_load_header ($path)	2168	$self->_load_header ($f)
1287	or return;	2169	or return;
1288		2170
		2171	local $MAP_LOADING{$self->{path}} = $self;
		2172	$f->resolve_delayed_derefs;
		2173
1289	$self->{load_path} = $path;	2174	$self->{load_path} = $path;
1290		2175
1291	1	2176	1
1292	}	2177	}
1293		2178
		2179	# used to laod the header of an original map
1294	sub load_orig {	2180	sub load_header_orig {
1295	my ($self) = @_;	2181	my ($self) = @_;
1296		2182
1297	$self->load_header_from ($self->load_path)	2183	$self->load_header_from ($self->load_path)
1298	}	2184	}
1299		2185
		2186	# used to laod the header of an instantiated map
1300	sub load_temp {	2187	sub load_header_temp {
1301	my ($self) = @_;	2188	my ($self) = @_;
1302		2189
1303	$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;
1304	}	2212	}
1305		2213
1306	sub load_header {	2214	sub load_header {
1307	my ($self) = @_;	2215	my ($self) = @_;
1308		2216
1309	if ($self->load_temp) {	2217	if ($self->load_header_temp) {
1310	$self->last_access ((delete $self->{last_access})	2218	$self->prepare_temp;
1311	|| $cf::RUNTIME); #d#
1312	# safety
1313	$self->{instantiate_time} = $cf::RUNTIME
1314	if $self->{instantiate_time} > $cf::RUNTIME;
1315	} else {	2219	} else {
1316	$self->load_orig	2220	$self->load_header_orig
1317	or return;	2221	or return;
1318		2222	$self->prepare_orig;
1319	$self->{load_original} = 1;
1320	$self->{instantiate_time} = $cf::RUNTIME;
1321	$self->last_access ($cf::RUNTIME);
1322	$self->instantiate;
1323	}	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;
1324		2230
1325	1	2231	1
1326	}	2232	}
1327		2233
1328	sub find;	2234	sub find;
1329	sub find {	2235	sub find {
1330	my ($path, $origin) = @_;	2236	my ($path, $origin) = @_;
1331		2237
		2238	cf::cede_to_tick;
		2239
1332	$path = normalise $path, $origin && $origin->path;	2240	$path = normalise $path, $origin;
1333		2241
		2242	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1334	cf::lock_wait "map_find:$path";	2243	my $guard2 = cf::lock_acquire "map_find:$path";
1335		2244
1336	$cf::MAP{$path} || do {	2245	$cf::MAP{$path} || do {
1337	my $guard = cf::lock_acquire "map_find:$path";
1338	my $map = new_from_path cf::map $path	2246	my $map = new_from_path cf::map $path
1339	or return;	2247	or return;
1340		2248
1341	$map->{last_save} = $cf::RUNTIME;	2249	$map->{last_save} = $cf::RUNTIME;
1342		2250
1343	$map->load_header	2251	$map->load_header
1344	or return;	2252	or return;
1345		2253
1346	if ($map->should_reset) {	2254	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1347	# doing this can freeze the server in a sync job, obviously	2255	# doing this can freeze the server in a sync job, obviously
1348	#$cf::WAIT_FOR_TICK->wait;	2256	#$cf::WAIT_FOR_TICK->wait;
		2257	undef $guard2;
		2258	undef $guard1;
1349	$map->reset;	2259	$map->reset;
1350	undef $guard;
1351	$map = find $path	2260	return find $path;
1352	or return;
1353	}	2261	}
1354		2262
1355	$cf::MAP{$path} = $map	2263	$cf::MAP{$path} = $map
1356	}	2264	}
1357	}	2265	}
		2266
		2267	sub pre_load { }
		2268	#sub post_load { } # XS
1358		2269
1359	sub load {	2270	sub load {
1360	my ($self) = @_;	2271	my ($self) = @_;
1361		2272
		2273	local $self->{deny_reset} = 1; # loading can take a long time
		2274
1362	my $path = $self->{path};	2275	my $path = $self->{path};
		2276
		2277	{
1363	my $guard = cf::lock_acquire "map_load:$path";	2278	my $guard = cf::lock_acquire "map_data:$path";
1364		2279
1365	return if $self->in_memory != cf::MAP_SWAPPED;	2280	return unless $self->valid;
		2281	return unless $self->state == cf::MAP_SWAPPED;
1366		2282
1367	$self->in_memory (cf::MAP_LOADING);
1368
1369	$self->alloc;	2283	$self->alloc;
1370	$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)
1371	or return;	2292	or return;
1372		2293
1373	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2294	$self->post_load_original
1374	if delete $self->{load_original};	2295	if delete $self->{load_original};
1375		2296
1376	if (my $uniq = $self->uniq_path) {	2297	if (my $uniq = $self->uniq_path) {
1377	utf8::encode $uniq;	2298	utf8::encode $uniq;
1378	if (aio_open $uniq, O_RDONLY, 0) {	2299	unless (aio_stat $uniq) {
		2300	if (my $f = new_from_file cf::object::thawer $uniq) {
1379	$self->clear_unique_items;	2301	$self->clear_unique_items;
1380	$self->_load_objects ($uniq, 0);	2302	$self->_load_objects ($f);
		2303	$f->resolve_delayed_derefs;
		2304	}
		2305	}
1381	}	2306	}
1382	}
1383		2307
1384	Coro::cede;	2308	$f->resolve_delayed_derefs;
		2309	} else {
		2310	$self->post_load_original
		2311	if delete $self->{load_original};
		2312	}
1385		2313
		2314	$self->state (cf::MAP_INACTIVE);
		2315
		2316	cf::cede_to_tick;
1386	# now do the right thing for maps	2317	# now do the right thing for maps
1387	$self->link_multipart_objects;	2318	$self->link_multipart_objects;
1388
1389	unless ($self->{deny_activate}) {
1390	$self->decay_objects;
1391	$self->fix_auto_apply;
1392	$self->update_buttons;
1393	Coro::cede;
1394	$self->set_darkness_map;
1395	$self->difficulty ($self->estimate_difficulty)	2319	$self->difficulty ($self->estimate_difficulty)
1396	unless $self->difficulty;	2320	unless $self->difficulty;
1397	Coro::cede;	2321	cf::cede_to_tick;
1398	$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
1399	}	2337	1
1400
1401	$self->in_memory (cf::MAP_IN_MEMORY);
1402	}	2338	}
1403		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
1404	sub customise_for {	2343	sub customise_for {
1405	my ($self, $ob) = @_;	2344	my ($self, $ob) = @_;
1406		2345
1407	return find "~" . $ob->name . "/" . $self->{path}	2346	return find "~" . $ob->name . "/" . $self->{path}
1408	if $self->per_player;	2347	if $self->per_player;
1409		2348
		2349	# return find "?party/" . $ob->name . "/" . $self->{path}
		2350	# if $self->per_party;
		2351
1410	$self	2352	$self
1411	}
1412
1413	# find and load all maps in the 3x3 area around a map
1414	sub load_diag {
1415	my ($map) = @_;
1416
1417	my @diag; # diagonal neighbours
1418
1419	for (0 .. 3) {
1420	my $neigh = $map->tile_path ($_)
1421	or next;
1422	$neigh = find $neigh, $map
1423	or next;
1424	$neigh->load;
1425
1426	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1427	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1428	}
1429
1430	for (@diag) {
1431	my $neigh = find @$_
1432	or next;
1433	$neigh->load;
1434	}
1435	}	2353	}
1436		2354
1437	sub find_sync {	2355	sub find_sync {
1438	my ($path, $origin) = @_;	2356	my ($path, $origin) = @_;
1439		2357
1440	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
1441	}	2363	}
1442		2364
1443	sub do_load_sync {	2365	sub do_load_sync {
1444	my ($map) = @_;	2366	my ($map) = @_;
1445		2367
1446	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;
1447	}	2373	}
1448		2374
1449	our %MAP_PREFETCH;	2375	our %MAP_PREFETCH;
1450	our $MAP_PREFETCHER = undef;	2376	our $MAP_PREFETCHER = undef;
1451		2377
1452	sub find_async {	2378	sub find_async {
1453	my ($path, $origin) = @_;	2379	my ($path, $origin, $load) = @_;
1454		2380
1455	$path = normalise $path, $origin && $origin->{path};	2381	$path = normalise $path, $origin;
1456		2382
1457	if (my $map = $cf::MAP{$path}) {	2383	if (my $map = $cf::MAP{$path}) {
1458	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2384	return $map if !$load || $map->linkable;
1459	}	2385	}
1460		2386
1461	undef $MAP_PREFETCH{$path};	2387	$MAP_PREFETCH{$path} |= $load;
		2388
1462	$MAP_PREFETCHER ||= cf::async {	2389	$MAP_PREFETCHER ||= cf::async {
		2390	$Coro::current->{desc} = "map prefetcher";
		2391
1463	while (%MAP_PREFETCH) {	2392	while (%MAP_PREFETCH) {
1464	for my $path (keys %MAP_PREFETCH) {	2393	while (my ($k, $v) = each %MAP_PREFETCH) {
1465	my $map = find $path	2394	if (my $map = find $k) {
1466	or next;
1467	$map->load;	2395	$map->load if $v;
		2396	}
1468		2397
1469	delete $MAP_PREFETCH{$path};	2398	delete $MAP_PREFETCH{$k};
1470	}	2399	}
1471	}	2400	}
1472	undef $MAP_PREFETCHER;	2401	undef $MAP_PREFETCHER;
1473	};	2402	};
		2403	$MAP_PREFETCHER->prio (6);
1474		2404
1475	()	2405	()
1476	}	2406	}
1477		2407
		2408	# common code, used by both ->save and ->swapout
1478	sub save {	2409	sub _save {
1479	my ($self) = @_;	2410	my ($self) = @_;
1480
1481	my $lock = cf::lock_acquire "map_data:" . $self->path;
1482		2411
1483	$self->{last_save} = $cf::RUNTIME;	2412	$self->{last_save} = $cf::RUNTIME;
1484		2413
1485	return unless $self->dirty;	2414	return unless $self->dirty;
1486		2415
…		…
1492	return if $self->{deny_save};	2421	return if $self->{deny_save};
1493		2422
1494	local $self->{last_access} = $self->last_access;#d#	2423	local $self->{last_access} = $self->last_access;#d#
1495		2424
1496	cf::async {	2425	cf::async {
		2426	$Coro::current->{desc} = "map player save";
1497	$_->contr->save for $self->players;	2427	$_->contr->save for $self->players;
1498	};	2428	};
		2429
		2430	cf::get_slot 0.02;
1499		2431
1500	if ($uniq) {	2432	if ($uniq) {
1501	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2433	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1502	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2434	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1503	} else {	2435	} else {
1504	$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);
1505	}	2437	}
1506	}	2438	}
1507		2439
		2440	sub save {
		2441	my ($self) = @_;
		2442
		2443	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2444
		2445	$self->_save;
		2446	}
		2447
1508	sub swap_out {	2448	sub swap_out {
1509	my ($self) = @_;	2449	my ($self) = @_;
1510		2450
1511	# save first because save cedes
1512	$self->save;
1513
1514	my $lock = cf::lock_acquire "map_data:" . $self->path;	2451	my $lock = cf::lock_acquire "map_data:$self->{path}";
1515		2452
		2453	return if !$self->linkable;
		2454	return if $self->{deny_save};
1516	return if $self->players;	2455	return if $self->players;
1517	return if $self->in_memory != cf::MAP_IN_MEMORY;
1518	return if $self->{deny_save};
1519		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
1520	$self->clear;	2466	$self->clear;
1521	$self->in_memory (cf::MAP_SWAPPED);
1522	}	2467	}
1523		2468
1524	sub reset_at {	2469	sub reset_at {
1525	my ($self) = @_;	2470	my ($self) = @_;
1526		2471
1527	# TODO: safety, remove and allow resettable per-player maps	2472	# TODO: safety, remove and allow resettable per-player maps
1528	return 1e99 if $self->isa ("ext::map_per_player");#d#
1529	return 1e99 if $self->{deny_reset};	2473	return 1e99 if $self->{deny_reset};
1530		2474
1531	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2475	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1532	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;
1533		2477
…		…
1544	my ($self) = @_;	2488	my ($self) = @_;
1545		2489
1546	my $lock = cf::lock_acquire "map_data:$self->{path}";	2490	my $lock = cf::lock_acquire "map_data:$self->{path}";
1547		2491
1548	return if $self->players;	2492	return if $self->players;
1549	return if $self->isa ("ext::map_per_player");#d#
1550		2493
1551	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	}
1552		2505
1553	delete $cf::MAP{$self->path};	2506	delete $cf::MAP{$self->path};
1554		2507
1555	$self->in_memory (cf::MAP_SWAPPED);	2508	$self->deactivate;
		2509	$_->clear_links_to ($self) for values %cf::MAP;
1556	$self->clear;	2510	$self->clear;
1557
1558	$_->clear_links_to ($self) for values %cf::MAP;
1559		2511
1560	$self->unlink_save;	2512	$self->unlink_save;
1561	$self->destroy;	2513	$self->destroy;
1562	}	2514	}
1563		2515
1564	my $nuke_counter = "aaaa";	2516	my $nuke_counter = "aaaa";
1565		2517
1566	sub nuke {	2518	sub nuke {
1567	my ($self) = @_;	2519	my ($self) = @_;
1568		2520
		2521	{
		2522	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2523
1569	delete $cf::MAP{$self->path};	2524	delete $cf::MAP{$self->path};
1570		2525
1571	$self->unlink_save;	2526	$self->unlink_save;
1572		2527
1573	bless $self, "cf::map";	2528	bless $self, "cf::map::wrap";
1574	delete $self->{deny_reset};	2529	delete $self->{deny_reset};
1575	$self->{deny_save} = 1;	2530	$self->{deny_save} = 1;
1576	$self->reset_timeout (1);	2531	$self->reset_timeout (1);
1577	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2532	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1578		2533
1579	$cf::MAP{$self->path} = $self;	2534	$cf::MAP{$self->path} = $self;
		2535	}
1580		2536
1581	$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	]
1582	}	2574	}
1583		2575
1584	=item cf::map::unique_maps	2576	=item cf::map::unique_maps
1585		2577
1586	Returns an arrayref of paths of all shared maps that have	2578	Returns an arrayref of paths of all shared maps that have
1587	instantiated unique items. May block.	2579	instantiated unique items. May block.
1588		2580
1589	=cut	2581	=cut
1590		2582
1591	sub unique_maps() {	2583	sub unique_maps() {
1592	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2584	[
1593	or return;	2585	map {
1594
1595	my @paths;
1596
1597	for (@$files) {
1598	utf8::decode $_;	2586	utf8::decode $_;
1599	next if /\.pst$/;	2587	s/\.map$//; # TODO future compatibility hack
1600	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	}
1601		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) {
1602	s/\.map$//;	2616	s/\.map$// or next;
1603	push @paths, $_;	2617	utf8::decode $_;
1604	}	2618	push @maps, "$dir/$_";
		2619	}
1605		2620
1606	\@paths	2621	push @dirs, map "$dir/$_", @$dirs;
1607	}	2622	}
1608		2623
1609	package cf;	2624	\@maps
		2625	}
1610		2626
1611	=back	2627	=back
1612		2628
1613	=head3 cf::object	2629	=head3 cf::object
1614		2630
…		…
1618		2634
1619	=over 4	2635	=over 4
1620		2636
1621	=item $ob->inv_recursive	2637	=item $ob->inv_recursive
1622		2638
1623	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.
1624		2641
1625	=cut	2642	=cut
1626		2643
1627	sub inv_recursive_;	2644	sub inv_recursive_;
1628	sub inv_recursive_ {	2645	sub inv_recursive_ {
…		…
1631		2648
1632	sub inv_recursive {	2649	sub inv_recursive {
1633	inv_recursive_ inv $_[0]	2650	inv_recursive_ inv $_[0]
1634	}	2651	}
1635		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 cnanot 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
1636	package cf;	2681	package cf;
1637		2682
1638	=back	2683	=back
1639		2684
1640	=head3 cf::object::player	2685	=head3 cf::object::player
…		…
1646	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>
1647	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
1648	dialogue with the given NPC character.	2693	dialogue with the given NPC character.
1649		2694
1650	=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	};
1651		2710
1652	# rough implementation of a future "reply" method that works	2711	# rough implementation of a future "reply" method that works
1653	# with dialog boxes.	2712	# with dialog boxes.
1654	#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
1655	sub cf::object::player::reply($$$;$) {	2714	sub cf::object::player::reply($$$;$) {
…		…
1657		2716
1658	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2717	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1659		2718
1660	if ($self->{record_replies}) {	2719	if ($self->{record_replies}) {
1661	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2720	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2721
1662	} 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 {
1663	$msg = $npc->name . " says: $msg" if $npc;	2730	$msg = $npc->name . " says: $msg" if $npc;
1664	$self->message ($msg, $flags);	2731	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2732	}
1665	}	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 (@_);
1666	}	2744	}
1667		2745
1668	=item $player_object->may ("access")	2746	=item $player_object->may ("access")
1669		2747
1670	Returns wether the given player is authorized to access resource "access"	2748	Returns wether the given player is authorized to access resource "access"
…		…
1683		2761
1684	=item $player_object->enter_link	2762	=item $player_object->enter_link
1685		2763
1686	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}>).
1687		2765
1688	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.
1689	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.
1690		2770
1691	Will never block.	2771	Will never block.
1692		2772
1693	=item $player_object->leave_link ($map, $x, $y)	2773	=item $player_object->leave_link ($map, $x, $y)
1694		2774
…		…
1702	=cut	2782	=cut
1703		2783
1704	sub link_map {	2784	sub link_map {
1705	unless ($LINK_MAP) {	2785	unless ($LINK_MAP) {
1706	$LINK_MAP = cf::map::find "{link}"	2786	$LINK_MAP = cf::map::find "{link}"
1707	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2787	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1708	$LINK_MAP->load;	2788	$LINK_MAP->load;
1709	}	2789	}
1710		2790
1711	$LINK_MAP	2791	$LINK_MAP
1712	}	2792	}
…		…
1714	sub cf::object::player::enter_link {	2794	sub cf::object::player::enter_link {
1715	my ($self) = @_;	2795	my ($self) = @_;
1716		2796
1717	$self->deactivate_recursive;	2797	$self->deactivate_recursive;
1718		2798
		2799	++$self->{_link_recursion};
		2800
1719	return if UNIVERSAL::isa $self->map, "ext::map_link";	2801	return if UNIVERSAL::isa $self->map, "ext::map_link";
1720		2802
1721	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2803	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1722	if $self->map;	2804	if $self->map && $self->map->{path} ne "{link}";
1723		2805
1724	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2806	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1725	}	2807	}
1726		2808
1727	sub cf::object::player::leave_link {	2809	sub cf::object::player::leave_link {
1728	my ($self, $map, $x, $y) = @_;	2810	my ($self, $map, $x, $y) = @_;
		2811
		2812	return unless $self->contr->active;
1729		2813
1730	my $link_pos = delete $self->{_link_pos};	2814	my $link_pos = delete $self->{_link_pos};
1731		2815
1732	unless ($map) {	2816	unless ($map) {
1733	# restore original map position	2817	# restore original map position
…		…
1744	($x, $y) = (-1, -1)	2828	($x, $y) = (-1, -1)
1745	unless (defined $x) && (defined $y);	2829	unless (defined $x) && (defined $y);
1746		2830
1747	# use -1 or undef as default coordinates, not 0, 0	2831	# use -1 or undef as default coordinates, not 0, 0
1748	($x, $y) = ($map->enter_x, $map->enter_y)	2832	($x, $y) = ($map->enter_x, $map->enter_y)
1749	if $x <=0 && $y <= 0;	2833	if $x <= 0 && $y <= 0;
1750		2834
1751	$map->load;	2835	$map->load;
1752	$map->load_diag;
1753		2836
1754	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
1755	$self->activate_recursive;	2844	$self->activate_recursive;
1756	$self->enter_map ($map, $x, $y);
1757	}
1758
1759	cf::player->attach (
1760	on_logout => sub {
1761	my ($pl) = @_;
1762
1763	# abort map switching before logout
1764	if ($pl->ob->{_link_pos}) {
1765	cf::sync_job {
1766	$pl->ob->leave_link
1767	};
1768	}
1769	},	2845	}
1770	on_login => sub {
1771	my ($pl) = @_;
1772		2846
1773	# try to abort aborted map switching on player login :)	2847	}
1774	# should happen only on crashes
1775	if ($pl->ob->{_link_pos}) {
1776	$pl->ob->enter_link;
1777	(async {
1778	# we need this sleep as the login has a concurrent enter_exit running
1779	# and this sleep increases chances of the player not ending up in scorn
1780	$pl->ob->reply (undef,
1781	"There was an internal problem at your last logout, "
1782	. "the server will try to bring you to your intended destination in a second.",
1783	cf::NDI_RED);
1784	Coro::Timer::sleep 1;
1785	$pl->ob->leave_link;
1786	})->prio (2);
1787	}
1788	},
1789	);
1790		2848
1791	=item $player_object->goto ($path, $x, $y)	2849	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1792		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
1793	=cut	2860	=cut
		2861
		2862	our $GOTOGEN;
1794		2863
1795	sub cf::object::player::goto {	2864	sub cf::object::player::goto {
1796	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;
1797		2875
1798	$self->enter_link;	2876	$self->enter_link;
1799		2877
1800	(async {	2878	(async {
1801	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) {
1802	$map = $map->customise_for ($self) if $map;	2904	$map = $map->customise_for ($self);
1803		2905	$map = $check->($map, $x, $y, $self) if $check && $map;
1804	# warn "entering ", $map->path, " at ($x, $y)\n"	2906	} else {
1805	# if $map;
1806
1807	$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	}
1808		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};
1809	$self->leave_link ($map, $x, $y);	2920	$self->leave_link ($map, $x, $y);
		2921	}
		2922
		2923	$done->($self) if $done;
1810	})->prio (1);	2924	})->prio (1);
1811	}	2925	}
1812		2926
1813	=item $player_object->enter_exit ($exit_object)	2927	=item $player_object->enter_exit ($exit_object)
1814		2928
…		…
1834	}	2948	}
1835		2949
1836	sub prepare_random_map {	2950	sub prepare_random_map {
1837	my ($exit) = @_;	2951	my ($exit) = @_;
1838		2952
1839	my $guard = cf::lock_acquire "exit_prepare:$exit";
1840
1841	# all this does is basically replace the /! path by	2953	# all this does is basically replace the /! path by
1842	# a new random map path (?random/...) with a seed	2954	# a new random map path (?random/...) with a seed
1843	# that depends on the exit object	2955	# that depends on the exit object
1844		2956
1845	my $rmp = parse_random_map_params $exit->msg;	2957	my $rmp = parse_random_map_params $exit->msg;
1846		2958
1847	if ($exit->map) {	2959	if ($exit->map) {
1848	$rmp->{region} = $exit->map->region_name;	2960	$rmp->{region} = $exit->region->name;
1849	$rmp->{origin_map} = $exit->map->path;	2961	$rmp->{origin_map} = $exit->map->path;
1850	$rmp->{origin_x} = $exit->x;	2962	$rmp->{origin_x} = $exit->x;
1851	$rmp->{origin_y} = $exit->y;	2963	$rmp->{origin_y} = $exit->y;
		2964
		2965	$exit->map->touch;
1852	}	2966	}
1853		2967
1854	$rmp->{random_seed} ||= $exit->random_seed;	2968	$rmp->{random_seed} ||= $exit->random_seed;
1855		2969
1856	my $data = cf::to_json $rmp;	2970	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1857	my $md5 = Digest::MD5::md5_hex $data;	2971	my $md5 = Digest::MD5::md5_hex $data;
1858	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2972	my $meta = "$RANDOMDIR/$md5.meta";
1859		2973
1860	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2974	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1861	aio_write $fh, 0, (length $data), $data, 0;	2975	aio_write $fh, 0, (length $data), $data, 0;
1862	undef $fh;	2976	undef $fh;
1863	aio_rename "$meta~", $meta;	2977	aio_rename "$meta~", $meta;
1864		2978
		2979	my $slaying = "?random/$md5";
		2980
		2981	if ($exit->valid) {
1865	$exit->slaying ("?random/$md5");	2982	$exit->slaying ("?random/$md5");
1866	$exit->msg (undef);	2983	$exit->msg (undef);
		2984	}
1867	}	2985	}
1868	}	2986	}
1869		2987
1870	sub cf::object::player::enter_exit {	2988	sub cf::object::player::enter_exit {
1871	my ($self, $exit) = @_;	2989	my ($self, $exit) = @_;
…		…
1873	return unless $self->type == cf::PLAYER;	2991	return unless $self->type == cf::PLAYER;
1874		2992
1875	$self->enter_link;	2993	$self->enter_link;
1876		2994
1877	(async {	2995	(async {
1878	$self->deactivate_recursive; # just to be sure	2996	$Coro::current->{desc} = "enter_exit";
		2997
1879	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
1880	prepare_random_map $exit	3012	prepare_random_map $exit
		3013	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3014
1881	if $exit->slaying eq "/!";	3015	$map = $exit->slaying;
1882		3016
1883	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;	3017	} elsif ($slaying eq '!up') {
1884	$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;
1885		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
1886	1;	3034	1
1887	}) {	3035	}) {
1888	$self->message ("Something went wrong deep within the crossfire server. "	3036	$self->message ("Something went wrong deep within the deliantra server. "
1889	. "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. "
1890	. "Please report this to the dungeon master!",	3038	. "Please report this to the dungeon master!",
1891	cf::NDI_UNIQUE | cf::NDI_RED);	3039	cf::NDI_UNIQUE | cf::NDI_RED);
1892		3040
1893	warn "ERROR in enter_exit: $@";	3041	error "ERROR in enter_exit: $@";
1894	$self->leave_link;	3042	$self->leave_link;
1895	}	3043	}
1896	})->prio (1);	3044	})->prio (1);
1897	}	3045	}
1898		3046
…		…
1909		3057
1910	sub cf::client::send_drawinfo {	3058	sub cf::client::send_drawinfo {
1911	my ($self, $text, $flags) = @_;	3059	my ($self, $text, $flags) = @_;
1912		3060
1913	utf8::encode $text;	3061	utf8::encode $text;
1914	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	3062	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1915	}	3063	}
1916		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	}
1917		3263
1918	=item $success = $client->query ($flags, "text", \&cb)	3264	=item $success = $client->query ($flags, "text", \&cb)
1919		3265
1920	Queues a query to the client, calling the given callback with	3266	Queues a query to the client, calling the given callback with
1921	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>,
1922	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>.
1923		3269
1924	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
1925	reliable at some point in the future.	3271	become reliable at some point in the future.
1926		3272
1927	=cut	3273	=cut
1928		3274
1929	sub cf::client::query {	3275	sub cf::client::query {
1930	my ($self, $flags, $text, $cb) = @_;	3276	my ($self, $flags, $text, $cb) = @_;
…		…
1938	utf8::encode $text;	3284	utf8::encode $text;
1939	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3285	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1940		3286
1941	$self->send_packet ($self->{query_queue}[0][0])	3287	$self->send_packet ($self->{query_queue}[0][0])
1942	if @{ $self->{query_queue} } == 1;	3288	if @{ $self->{query_queue} } == 1;
		3289
		3290	1
1943	}	3291	}
1944		3292
1945	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	},
1946	on_reply => sub {	3299	on_reply => sub {
1947	my ($ns, $msg) = @_;	3300	my ($ns, $msg) = @_;
1948		3301
1949	# this weird shuffling is so that direct followup queries	3302	# this weird shuffling is so that direct followup queries
1950	# get handled first	3303	# get handled first
1951	my $queue = delete $ns->{query_queue}	3304	my $queue = delete $ns->{query_queue}
1952	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
1953		3306
1954	(shift @$queue)->[1]->($msg);	3307	(shift @$queue)->[1]->($msg);
		3308	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1955		3309
1956	push @{ $ns->{query_queue} }, @$queue;	3310	push @{ $ns->{query_queue} }, @$queue;
1957		3311
1958	if (@{ $ns->{query_queue} } == @$queue) {	3312	if (@{ $ns->{query_queue} } == @$queue) {
1959	if (@$queue) {	3313	if (@$queue) {
…		…
1961	} else {	3315	} else {
1962	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3316	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1963	}	3317	}
1964	}	3318	}
1965	},	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	},
1966	);	3353	);
1967		3354
1968	=item $client->async (\&cb)	3355	=item $client->async (\&cb)
1969		3356
1970	Create a new coroutine, running the specified callback. The coroutine will	3357	Create a new coroutine, running the specified callback. The coroutine will
…		…
1986		3373
1987	$coro	3374	$coro
1988	}	3375	}
1989		3376
1990	cf::client->attach (	3377	cf::client->attach (
1991	on_destroy => sub {	3378	on_client_destroy => sub {
1992	my ($ns) = @_;	3379	my ($ns) = @_;
1993		3380
1994	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3381	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1995	},	3382	},
1996	);	3383	);
…		…
2011	our $safe = new Safe "safe";	3398	our $safe = new Safe "safe";
2012	our $safe_hole = new Safe::Hole;	3399	our $safe_hole = new Safe::Hole;
2013		3400
2014	$SIG{FPE} = 'IGNORE';	3401	$SIG{FPE} = 'IGNORE';
2015		3402
2016	$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	));
2017		3408
2018	# here we export the classes and methods available to script code	3409	# here we export the classes and methods available to script code
2019		3410
2020	=pod	3411	=pod
2021		3412
2022	The following fucntions and emthods are available within a safe environment:	3413	The following functions and methods are available within a safe environment:
2023		3414
2024	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
2025	cf::object::player player	3420	cf::object::player
2026	cf::player peaceful	3421	player
2027	cf::map trigger	3422
		3423	cf::player
		3424	peaceful
		3425
		3426	cf::map
		3427	trigger
2028		3428
2029	=cut	3429	=cut
2030		3430
2031	for (	3431	for (
2032	["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)],
2033	["cf::object::player" => qw(player)],	3435	["cf::object::player" => qw(player)],
2034	["cf::player" => qw(peaceful)],	3436	["cf::player" => qw(peaceful send_msg)],
2035	["cf::map" => qw(trigger)],	3437	["cf::map" => qw(trigger)],
2036	) {	3438	) {
2037	no strict 'refs';
2038	my ($pkg, @funs) = @$_;	3439	my ($pkg, @funs) = @$_;
2039	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3440	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2040	for @funs;	3441	for @funs;
2041	}	3442	}
2042		3443
…		…
2057		3458
2058	my $qcode = $code;	3459	my $qcode = $code;
2059	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3460	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2060	$qcode =~ s/\n/\\n/g;	3461	$qcode =~ s/\n/\\n/g;
2061		3462
		3463	%vars = (_dummy => 0) unless %vars;
		3464
		3465	my @res;
2062	local $_;	3466	local $_;
2063	local @safe::cf::_safe_eval_args = values %vars;
2064		3467
2065	my $eval =	3468	my $eval =
2066	"do {\n"	3469	"do {\n"
2067	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3470	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2068	. "#line 0 \"{$qcode}\"\n"	3471	. "#line 0 \"{$qcode}\"\n"
2069	. $code	3472	. $code
2070	. "\n}"	3473	. "\n}"
2071	;	3474	;
2072		3475
		3476	if ($CFG{safe_eval}) {
2073	sub_generation_inc;	3477	sub_generation_inc;
		3478	local @safe::cf::_safe_eval_args = values %vars;
2074	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3479	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2075	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	}
2076		3485
2077	if ($@) {	3486	if ($@) {
2078	warn "$@";	3487	warn "$@",
2079	warn "while executing safe code '$code'\n";	3488	"while executing safe code '$code'\n",
2080	warn "with arguments " . (join " ", %vars) . "\n";	3489	"with arguments " . (join " ", %vars) . "\n";
2081	}	3490	}
2082		3491
2083	wantarray ? @res : $res[0]	3492	wantarray ? @res : $res[0]
2084	}	3493	}
2085		3494
…		…
2099	=cut	3508	=cut
2100		3509
2101	sub register_script_function {	3510	sub register_script_function {
2102	my ($fun, $cb) = @_;	3511	my ($fun, $cb) = @_;
2103		3512
2104	no strict 'refs';	3513	$fun = "safe::$fun" if $CFG{safe_eval};
2105	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3514	*$fun = $safe_hole->wrap ($cb);
2106	}	3515	}
2107		3516
2108	=back	3517	=back
2109		3518
2110	=cut	3519	=cut
2111		3520
2112	#############################################################################	3521	#############################################################################
		3522	# the server's init and main functions
2113		3523
2114	=head2 EXTENSION DATABASE SUPPORT	3524	our %FACEHASH; # hash => idx, #d# HACK for http server
2115		3525
2116	Crossfire maintains a very simple database for extension use. It can	3526	# internal api, not fianlised
2117	currently store anything that can be serialised using Storable, which	3527	sub add_face {
2118	excludes objects.	3528	my ($name, $type, $data) = @_;
2119		3529
2120	The parameter C<$family> should best start with the name of the extension	3530	my $idx = cf::face::find $name;
2121	using it, it should be unique.
2122		3531
2123	=over 4	3532	if ($idx) {
2124		3533	delete $FACEHASH{cf::face::get_chksum $idx};
2125	=item $hashref = cf::db_get $family
2126
2127	Return a hashref for use by the extension C<$family>, which can be
2128	modified. After modifications, you have to call C<cf::db_dirty> or
2129	C<cf::db_sync>.
2130
2131	=item $value = cf::db_get $family => $key
2132
2133	Returns a single value from the database
2134
2135	=item cf::db_put $family => $hashref
2136
2137	Stores the given family hashref into the database. Updates are delayed, if
2138	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2139
2140	=item cf::db_put $family => $key => $value
2141
2142	Stores the given C<$value> in the family hash. Updates are delayed, if you
2143	want the data to be synced to disk immediately, use C<cf::db_sync>.
2144
2145	=item cf::db_dirty
2146
2147	Marks the database as dirty, to be updated at a later time.
2148
2149	=item cf::db_sync
2150
2151	Immediately write the database to disk I<if it is dirty>.
2152
2153	=cut
2154
2155	our $DB;
2156
2157	{
2158	my $path = cf::localdir . "/database.pst";
2159
2160	sub db_load() {
2161	$DB = stat $path ? Storable::retrieve $path : { };
2162	}
2163
2164	my $pid;
2165
2166	sub db_save() {
2167	waitpid $pid, 0 if $pid;
2168	if (0 == ($pid = fork)) {
2169	$DB->{_meta}{version} = 1;
2170	Storable::nstore $DB, "$path~";
2171	rename "$path~", $path;
2172	cf::_exit 0 if defined $pid;
2173	}
2174	}
2175
2176	my $dirty;
2177
2178	sub db_sync() {
2179	db_save if $dirty;
2180	undef $dirty;
2181	}
2182
2183	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2184	db_sync;
2185	});
2186
2187	sub db_dirty() {
2188	$dirty = 1;
2189	$idle->start;
2190	}
2191
2192	sub db_get($;$) {
2193	@_ >= 2
2194	? $DB->{$_[0]}{$_[1]}
2195	: ($DB->{$_[0]} ||= { })
2196	}
2197
2198	sub db_put($$;$) {
2199	if (@_ >= 3) {
2200	$DB->{$_[0]}{$_[1]} = $_[2];
2201	} else {	3534	} else {
2202	$DB->{$_[0]} = $_[1];	3535	$idx = cf::face::alloc $name;
2203	}	3536	}
2204	db_dirty;	3537
		3538	my $hash = cf::face::mangle_chksum Digest::MD5::md5 $data;
		3539
		3540	cf::face::set_type $idx, $type;
		3541	cf::face::set_data $idx, 0, $data, $hash;
		3542	cf::face::set_meta $idx, $type & 1 ? undef : undef;
		3543	$FACEHASH{$hash} = $idx;#d#
		3544
		3545	$idx
		3546	}
		3547
		3548	sub load_facedata($) {
		3549	my ($path) = @_;
		3550
		3551	# HACK to clear player env face cache, we need some signal framework
		3552	# for this (global event?)
		3553	%ext::player_env::MUSIC_FACE_CACHE = ();
		3554
		3555	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3556
		3557	trace "loading facedata from $path\n";
		3558
		3559	my $facedata = decode_storable load_file $path;
		3560
		3561	$facedata->{version} == 2
		3562	or cf::cleanup "$path: version mismatch, cannot proceed.";
		3563
		3564	cf::cede_to_tick;
		3565
2205	}	3566	{
		3567	my $faces = $facedata->{faceinfo};
2206		3568
2207	cf::global->attach (	3569	for my $face (sort keys %$faces) {
2208	prio => 10000,	3570	my $info = $faces->{$face};
2209	on_cleanup => sub {	3571	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2210	db_sync;	3572
		3573	cf::face::set_visibility $idx, $info->{visibility};
		3574	cf::face::set_magicmap $idx, $info->{magicmap};
		3575	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
		3576	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
		3577	cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
		3578	$FACEHASH{$info->{hash64}} = $idx;#d#
		3579
		3580	cf::cede_to_tick;
2211	},	3581	}
2212	);
2213	}
2214		3582
2215	#############################################################################	3583	while (my ($face, $info) = each %$faces) {
2216	# the server's main()	3584	next unless $info->{smooth};
2217		3585
2218	sub cfg_load {	3586	my $idx = cf::face::find $face
2219	open my $fh, "<:utf8", cf::confdir . "/config"	3587	or next;
2220	or return;
2221		3588
2222	local $/;	3589	if (my $smooth = cf::face::find $info->{smooth}) {
2223	*CFG = YAML::Syck::Load <$fh>;	3590	cf::face::set_smooth $idx, $smooth;
		3591	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3592	} else {
		3593	error "smooth face '$info->{smooth}' not found for face '$face'";
		3594	}
2224		3595
		3596	cf::cede_to_tick;
		3597	}
		3598	}
		3599
		3600	{
		3601	my $anims = $facedata->{animinfo};
		3602
		3603	while (my ($anim, $info) = each %$anims) {
		3604	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3605	cf::cede_to_tick;
		3606	}
		3607
		3608	cf::anim::invalidate_all; # d'oh
		3609	}
		3610
		3611	{
		3612	my $res = $facedata->{resource};
		3613
		3614	while (my ($name, $info) = each %$res) {
		3615	if (defined (my $type = $info->{type})) {
		3616	# TODO: different hash - must free and use new index, or cache ixface data queue
		3617	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3618
		3619	cf::face::set_type $idx, $type;
		3620	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3621	cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3622	$FACEHASH{$info->{hash}} = $idx;#d#
		3623	} else {
		3624	# $RESOURCE{$name} = $info; # unused
		3625	}
		3626
		3627	cf::cede_to_tick;
		3628	}
		3629	}
		3630
		3631	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3632
		3633	1
		3634	}
		3635
		3636	register_exticmd fx_want => sub {
		3637	my ($ns, $want) = @_;
		3638
		3639	while (my ($k, $v) = each %$want) {
		3640	$ns->fx_want ($k, $v);
		3641	}
		3642	};
		3643
		3644	sub load_resource_file($) {
		3645	my $guard = lock_acquire "load_resource_file";
		3646
		3647	my $status = load_resource_file_ $_[0];
		3648	get_slot 0.1, 100;
		3649	cf::arch::commit_load;
		3650
		3651	$status
		3652	}
		3653
		3654	sub reload_exp_table {
		3655	_reload_exp_table;
		3656
		3657	add_face "res/exp_table" => FT_RSRC,
		3658	JSON::XS->new->utf8->canonical->encode (
		3659	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
		3660	);
		3661	}
		3662
		3663	sub reload_materials {
		3664	_reload_materials;
		3665	}
		3666
		3667	sub reload_regions {
		3668	# HACK to clear player env face cache, we need some signal framework
		3669	# for this (global event?)
		3670	%ext::player_env::MUSIC_FACE_CACHE = ();
		3671
		3672	load_resource_file "$MAPDIR/regions"
		3673	or die "unable to load regions file\n";
		3674
		3675	for (cf::region::list) {
		3676	$_->{match} = qr/$_->{match}/
		3677	if exists $_->{match};
		3678	}
		3679	}
		3680
		3681	sub reload_facedata {
		3682	load_facedata "$DATADIR/facedata"
		3683	or die "unable to load facedata\n";
		3684	}
		3685
		3686	sub reload_archetypes {
		3687	load_resource_file "$DATADIR/archetypes"
		3688	or die "unable to load archetypes\n";
		3689
		3690	add_face "res/skill_info" => FT_RSRC,
		3691	JSON::XS->new->utf8->canonical->encode (
		3692	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3693	);
		3694	add_face "res/spell_paths" => FT_RSRC,
		3695	JSON::XS->new->utf8->canonical->encode (
		3696	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3697	);
		3698	}
		3699
		3700	sub reload_treasures {
		3701	load_resource_file "$DATADIR/treasures"
		3702	or die "unable to load treasurelists\n";
		3703	}
		3704
		3705	sub reload_sound {
		3706	trace "loading sound config from $DATADIR/sound\n";
		3707
		3708	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3709
		3710	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3711	my $sound = $soundconf->{compat}[$_]
		3712	or next;
		3713
		3714	my $face = cf::face::find "sound/$sound->[1]";
		3715	cf::sound::set $sound->[0] => $face;
		3716	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3717	}
		3718
		3719	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3720	my $face = cf::face::find "sound/$v";
		3721	cf::sound::set $k => $face;
		3722	}
		3723	}
		3724
		3725	sub reload_resources {
		3726	trace "reloading resource files...\n";
		3727
		3728	reload_materials;
		3729	reload_facedata;
		3730	reload_exp_table;
		3731	reload_sound;
		3732	reload_archetypes;
		3733	reload_regions;
		3734	reload_treasures;
		3735
		3736	trace "finished reloading resource files\n";
		3737	}
		3738
		3739	sub reload_config {
		3740	trace "reloading config file...\n";
		3741
		3742	my $config = load_file "$CONFDIR/config";
		3743	utf8::decode $config;
		3744	*CFG = decode_yaml $config;
		3745
2225	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3746	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2226		3747
2227	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3748	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2228	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3749	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2229		3750
2230	if (exists $CFG{mlockall}) {	3751	if (exists $CFG{mlockall}) {
…		…
2234	};	3755	};
2235	warn $@ if $@;	3756	warn $@ if $@;
2236	}	3757	}
2237	}	3758	}
2238		3759
		3760	sub pidfile() {
		3761	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3762	or die "$PIDFILE: $!";
		3763	flock $fh, &Fcntl::LOCK_EX
		3764	or die "$PIDFILE: flock: $!";
		3765	$fh
		3766	}
		3767
		3768	# make sure only one server instance is running at any one time
		3769	sub atomic {
		3770	my $fh = pidfile;
		3771
		3772	my $pid = <$fh>;
		3773	kill 9, $pid if $pid > 0;
		3774
		3775	seek $fh, 0, 0;
		3776	print $fh $$;
		3777	}
		3778
		3779	sub main_loop {
		3780	trace "EV::loop starting\n";
		3781	if (1) {
		3782	EV::loop;
		3783	}
		3784	trace "EV::loop returned\n";
		3785	goto &main_loop unless $REALLY_UNLOOP;
		3786	}
		3787
2239	sub main {	3788	sub main {
		3789	cf::init_globals; # initialise logging
		3790
		3791	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3792	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3793	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3794	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3795
		3796	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3797
2240	# we must not ever block the main coroutine	3798	# we must not ever block the main coroutine
2241	local $Coro::idle = sub {	3799	$Coro::idle = sub {
2242	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3800	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2243	(async {	3801	(async {
2244	Event::one_event;	3802	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3803	EV::loop EV::LOOP_ONESHOT;
2245	})->prio (Coro::PRIO_MAX);	3804	})->prio (Coro::PRIO_MAX);
2246	};	3805	};
2247		3806
2248	cfg_load;	3807	evthread_start IO::AIO::poll_fileno;
2249	db_load;	3808
		3809	cf::sync_job {
		3810	cf::incloader::init ();
		3811
		3812	db_init;
		3813
		3814	cf::init_anim;
		3815	cf::init_attackmess;
		3816	cf::init_dynamic;
		3817
		3818	cf::load_settings;
		3819
		3820	reload_resources;
		3821	reload_config;
		3822
		3823	cf::init_uuid;
		3824	cf::init_signals;
		3825	cf::init_skills;
		3826
		3827	cf::init_beforeplay;
		3828
		3829	atomic;
		3830
2250	load_extensions;	3831	load_extensions;
2251		3832
2252	$TICK_WATCHER->start;	3833	utime time, time, $RUNTIMEFILE;
2253	Event::loop;	3834
		3835	# no (long-running) fork's whatsoever before this point(!)
		3836	use POSIX ();
		3837	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3838
		3839	cf::_post_init 0;
		3840	};
		3841
		3842	cf::object::thawer::errors_are_fatal 0;
		3843	info "parse errors in files are no longer fatal from this point on.\n";
		3844
		3845	AE::postpone {
		3846	undef &main; # free gobs of memory :)
		3847	};
		3848
		3849	goto &main_loop;
2254	}	3850	}
2255		3851
2256	#############################################################################	3852	#############################################################################
2257	# initialisation and cleanup	3853	# initialisation and cleanup
2258		3854
2259	# install some emergency cleanup handlers	3855	# install some emergency cleanup handlers
2260	BEGIN {	3856	BEGIN {
		3857	our %SIGWATCHER = ();
2261	for my $signal (qw(INT HUP TERM)) {	3858	for my $signal (qw(INT HUP TERM)) {
2262	Event->signal (	3859	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2263	data => WF_AUTOCANCEL,
2264	signal => $signal,
2265	cb => sub {
2266	cf::cleanup "SIG$signal";	3860	cf::cleanup "SIG$signal";
2267	},
2268	);	3861	};
		3862	}
		3863	}
		3864
		3865	sub write_runtime_sync {
		3866	my $t0 = AE::time;
		3867
		3868	# first touch the runtime file to show we are still running:
		3869	# the fsync below can take a very very long time.
		3870
		3871	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3872
		3873	my $guard = cf::lock_acquire "write_runtime";
		3874
		3875	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3876	or return;
		3877
		3878	my $value = $cf::RUNTIME + 90 + 10;
		3879	# 10 is the runtime save interval, for a monotonic clock
		3880	# 60 allows for the watchdog to kill the server.
		3881
		3882	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3883	and return;
		3884
		3885	# always fsync - this file is important
		3886	aio_fsync $fh
		3887	and return;
		3888
		3889	# touch it again to show we are up-to-date
		3890	aio_utime $fh, undef, undef;
		3891
		3892	close $fh
		3893	or return;
		3894
		3895	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3896	and return;
		3897
		3898	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3899
2269	}	3900	1
		3901	}
		3902
		3903	our $uuid_lock;
		3904	our $uuid_skip;
		3905
		3906	sub write_uuid_sync($) {
		3907	$uuid_skip ||= $_[0];
		3908
		3909	return if $uuid_lock;
		3910	local $uuid_lock = 1;
		3911
		3912	my $uuid = "$LOCALDIR/uuid";
		3913
		3914	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3915	or return;
		3916
		3917	my $value = uuid_seq uuid_cur;
		3918
		3919	unless ($value) {
		3920	info "cowardly refusing to write zero uuid value!\n";
		3921	return;
		3922	}
		3923
		3924	my $value = uuid_str $value + $uuid_skip;
		3925	$uuid_skip = 0;
		3926
		3927	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3928	and return;
		3929
		3930	# always fsync - this file is important
		3931	aio_fsync $fh
		3932	and return;
		3933
		3934	close $fh
		3935	or return;
		3936
		3937	aio_rename "$uuid~", $uuid
		3938	and return;
		3939
		3940	trace "uuid file written ($value).\n";
		3941
		3942	1
		3943
		3944	}
		3945
		3946	sub write_uuid($$) {
		3947	my ($skip, $sync) = @_;
		3948
		3949	$sync ? write_uuid_sync $skip
		3950	: async { write_uuid_sync $skip };
2270	}	3951	}
2271		3952
2272	sub emergency_save() {	3953	sub emergency_save() {
2273	my $freeze_guard = cf::freeze_mainloop;	3954	my $freeze_guard = cf::freeze_mainloop;
2274		3955
2275	warn "enter emergency perl save\n";	3956	info "emergency_perl_save: enter\n";
		3957
		3958	# this is a trade-off: we want to be very quick here, so
		3959	# save all maps without fsync, and later call a global sync
		3960	# (which in turn might be very very slow)
		3961	local $USE_FSYNC = 0;
2276		3962
2277	cf::sync_job {	3963	cf::sync_job {
		3964	cf::write_runtime_sync; # external watchdog should not bark
		3965
2278	# use a peculiar iteration method to avoid tripping on perl	3966	# use a peculiar iteration method to avoid tripping on perl
2279	# refcount bugs in for. also avoids problems with players	3967	# refcount bugs in for. also avoids problems with players
2280	# and maps saved/destroyed asynchronously.	3968	# and maps saved/destroyed asynchronously.
2281	warn "begin emergency player save\n";	3969	info "emergency_perl_save: begin player save\n";
2282	for my $login (keys %cf::PLAYER) {	3970	for my $login (keys %cf::PLAYER) {
2283	my $pl = $cf::PLAYER{$login} or next;	3971	my $pl = $cf::PLAYER{$login} or next;
2284	$pl->valid or next;	3972	$pl->valid or next;
		3973	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2285	$pl->save;	3974	$pl->save;
2286	}	3975	}
2287	warn "end emergency player save\n";	3976	info "emergency_perl_save: end player save\n";
2288		3977
2289	warn "begin emergency map save\n";	3978	cf::write_runtime_sync; # external watchdog should not bark
		3979
		3980	info "emergency_perl_save: begin map save\n";
2290	for my $path (keys %cf::MAP) {	3981	for my $path (keys %cf::MAP) {
2291	my $map = $cf::MAP{$path} or next;	3982	my $map = $cf::MAP{$path} or next;
2292	$map->valid or next;	3983	$map->valid or next;
2293	$map->save;	3984	$map->save;
2294	}	3985	}
2295	warn "end emergency map save\n";	3986	info "emergency_perl_save: end map save\n";
		3987
		3988	cf::write_runtime_sync; # external watchdog should not bark
		3989
		3990	info "emergency_perl_save: begin database checkpoint\n";
		3991	BDB::db_env_txn_checkpoint $DB_ENV;
		3992	info "emergency_perl_save: end database checkpoint\n";
		3993
		3994	info "emergency_perl_save: begin write uuid\n";
		3995	write_uuid_sync 1;
		3996	info "emergency_perl_save: end write uuid\n";
		3997
		3998	cf::write_runtime_sync; # external watchdog should not bark
		3999
		4000	trace "emergency_perl_save: syncing database to disk";
		4001	BDB::db_env_txn_checkpoint $DB_ENV;
		4002
		4003	info "emergency_perl_save: starting sync\n";
		4004	IO::AIO::aio_sync sub {
		4005	info "emergency_perl_save: finished sync\n";
		4006	};
		4007
		4008	cf::write_runtime_sync; # external watchdog should not bark
		4009
		4010	trace "emergency_perl_save: flushing outstanding aio requests";
		4011	while (IO::AIO::nreqs || BDB::nreqs) {
		4012	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4013	}
		4014
		4015	cf::write_runtime_sync; # external watchdog should not bark
2296	};	4016	};
2297		4017
2298	warn "leave emergency perl save\n";	4018	info "emergency_perl_save: leave\n";
2299	}	4019	}
2300		4020
		4021	sub post_cleanup {
		4022	my ($make_core) = @_;
		4023
		4024	IO::AIO::flush;
		4025
		4026	error Carp::longmess "post_cleanup backtrace"
		4027	if $make_core;
		4028
		4029	my $fh = pidfile;
		4030	unlink $PIDFILE if <$fh> == $$;
		4031	}
		4032
		4033	# a safer delete_package, copied from Symbol
		4034	sub clear_package($) {
		4035	my $pkg = shift;
		4036
		4037	# expand to full symbol table name if needed
		4038	unless ($pkg =~ /^main::.*::$/) {
		4039	$pkg = "main$pkg" if $pkg =~ /^::/;
		4040	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4041	$pkg .= '::' unless $pkg =~ /::$/;
		4042	}
		4043
		4044	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4045	my $stem_symtab = *{$stem}{HASH};
		4046
		4047	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4048	or return;
		4049
		4050	# clear all symbols
		4051	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4052	for my $name (keys %$leaf_symtab) {
		4053	_gv_clear *{"$pkg$name"};
		4054	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4055	}
		4056	}
		4057
2301	sub reload() {	4058	sub do_reload_perl() {
2302	# can/must only be called in main	4059	# can/must only be called in main
2303	if ($Coro::current != $Coro::main) {	4060	unless (in_main) {
2304	warn "can only reload from main coroutine";	4061	error "can only reload from main coroutine";
2305	return;	4062	return;
2306	}	4063	}
2307		4064
2308	warn "reloading...";	4065	return if $RELOAD++;
2309		4066
2310	warn "cancelling server ticker";	4067	my $t1 = AE::time;
2311	$TICK_WATCHER->cancel;
2312		4068
		4069	while ($RELOAD) {
		4070	cf::get_slot 0.1, -1, "reload_perl";
		4071	info "perl_reload: reloading...";
		4072
		4073	trace "perl_reload: entering sync_job";
		4074
		4075	cf::sync_job {
2313	cf::emergency_save;	4076	#cf::emergency_save;
2314		4077
2315	eval {
2316	# if anything goes wrong in here, we should simply crash as we already saved
2317
2318	warn "syncing database to disk";
2319	cf::db_sync;
2320
2321	warn "cancelling all WF_AUTOCANCEL watchers";
2322	for (Event::all_watchers) {
2323	$_->cancel if $_->data & WF_AUTOCANCEL;
2324	}
2325
2326	warn "flushing outstanding aio requests";
2327	for (;;) {
2328	IO::AIO::flush;
2329	Coro::cede;
2330	last unless IO::AIO::nreqs;
2331	warn "iterate...";
2332	}
2333
2334	warn "cancelling all extension coros";	4078	trace "perl_reload: cancelling all extension coros";
2335	$_->cancel for values %EXT_CORO;	4079	$_->cancel for values %EXT_CORO;
2336	%EXT_CORO = ();	4080	%EXT_CORO = ();
2337		4081
2338	warn "removing commands";	4082	trace "perl_reload: removing commands";
2339	%COMMAND = ();	4083	%COMMAND = ();
2340		4084
2341	warn "removing ext commands";	4085	trace "perl_reload: removing ext/exti commands";
2342	%EXTCMD = ();	4086	%EXTCMD = ();
		4087	%EXTICMD = ();
2343		4088
2344	warn "unloading/nuking all extensions";	4089	trace "perl_reload: unloading/nuking all extensions";
2345	for my $pkg (@EXTS) {	4090	for my $pkg (@EXTS) {
2346	warn "... unloading $pkg";	4091	trace "... unloading $pkg";
2347		4092
2348	if (my $cb = $pkg->can ("unload")) {	4093	if (my $cb = $pkg->can ("unload")) {
2349	eval {	4094	eval {
2350	$cb->($pkg);	4095	$cb->($pkg);
2351	1	4096	1
2352	} or warn "$pkg unloaded, but with errors: $@";	4097	} or error "$pkg unloaded, but with errors: $@";
		4098	}
		4099
		4100	trace "... clearing $pkg";
		4101	clear_package $pkg;
2353	}	4102	}
2354		4103
2355	warn "... nuking $pkg";
2356	Symbol::delete_package $pkg;
2357	}
2358
2359	warn "unloading all perl modules loaded from $LIBDIR";	4104	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2360	while (my ($k, $v) = each %INC) {	4105	while (my ($k, $v) = each %INC) {
2361	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4106	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2362		4107
2363	warn "... unloading $k";	4108	trace "... unloading $k";
2364	delete $INC{$k};	4109	delete $INC{$k};
2365		4110
2366	$k =~ s/\.pm$//;	4111	$k =~ s/\.pm$//;
2367	$k =~ s/\//::/g;	4112	$k =~ s/\//::/g;
2368		4113
2369	if (my $cb = $k->can ("unload_module")) {	4114	if (my $cb = $k->can ("unload_module")) {
2370	$cb->();	4115	$cb->();
		4116	}
		4117
		4118	clear_package $k;
2371	}	4119	}
2372		4120
2373	Symbol::delete_package $k;
2374	}
2375
2376	warn "getting rid of safe::, as good as possible";	4121	trace "perl_reload: getting rid of safe::, as good as possible";
2377	Symbol::delete_package "safe::$_"	4122	clear_package "safe::$_"
2378	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4123	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2379		4124
2380	warn "unloading cf.pm \"a bit\"";	4125	trace "perl_reload: unloading cf.pm \"a bit\"";
2381	delete $INC{"cf.pm"};	4126	delete $INC{"cf.pm"};
		4127	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2382		4128
2383	# don't, removes xs symbols, too,	4129	# don't, removes xs symbols, too,
2384	# and global variables created in xs	4130	# and global variables created in xs
2385	#Symbol::delete_package __PACKAGE__;	4131	#clear_package __PACKAGE__;
2386		4132
2387	warn "unload completed, starting to reload now";	4133	info "perl_reload: unload completed, starting to reload now";
2388		4134
2389	warn "reloading cf.pm";	4135	trace "perl_reload: reloading cf.pm";
2390	require cf;	4136	require cf;
2391	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4137	cf::_connect_to_perl_1;
2392		4138
2393	warn "loading config and database again";	4139	trace "perl_reload: loading config and database again";
2394	cf::cfg_load;	4140	cf::reload_config;
2395	cf::db_load;
2396		4141
2397	warn "loading extensions";	4142	trace "perl_reload: loading extensions";
2398	cf::load_extensions;	4143	cf::load_extensions;
2399		4144
		4145	if ($REATTACH_ON_RELOAD) {
2400	warn "reattaching attachments to objects/players";	4146	trace "perl_reload: reattaching attachments to objects/players";
2401	_global_reattach;	4147	_global_reattach; # objects, sockets
2402	warn "reattaching attachments to maps";	4148	trace "perl_reload: reattaching attachments to maps";
2403	reattach $_ for values %MAP;	4149	reattach $_ for values %MAP;
		4150	trace "perl_reload: reattaching attachments to players";
		4151	reattach $_ for values %PLAYER;
		4152	}
2404		4153
2405	warn "restarting server ticker";	4154	cf::_post_init 1;
2406		4155
2407	$TICK_WATCHER->start;	4156	trace "perl_reload: leaving sync_job";
		4157
		4158	1
		4159	} or do {
		4160	error $@;
		4161	cf::cleanup "perl_reload: error, exiting.";
		4162	};
		4163
		4164	--$RELOAD;
		4165	}
		4166
		4167	$t1 = AE::time - $t1;
		4168	info "perl_reload: completed in ${t1}s\n";
		4169	};
		4170
		4171	our $RELOAD_WATCHER; # used only during reload
		4172
		4173	sub reload_perl() {
		4174	# doing reload synchronously and two reloads happen back-to-back,
		4175	# coro crashes during coro_state_free->destroy here.
		4176
		4177	$RELOAD_WATCHER ||= cf::async {
		4178	Coro::AIO::aio_wait cache_extensions;
		4179
		4180	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4181	do_reload_perl;
		4182	undef $RELOAD_WATCHER;
		4183	};
2408	};	4184	};
2409		4185	}
2410	if ($@) {
2411	warn $@;
2412	warn "error while reloading, exiting.";
2413	exit 1;
2414	}
2415
2416	warn "reloaded";
2417	};
2418
2419	our $RELOAD_WATCHER; # used only during reload
2420		4186
2421	register_command "reload" => sub {	4187	register_command "reload" => sub {
2422	my ($who, $arg) = @_;	4188	my ($who, $arg) = @_;
2423		4189
2424	if ($who->flag (FLAG_WIZ)) {	4190	if ($who->flag (FLAG_WIZ)) {
2425	$who->message ("reloading server.");	4191	$who->message ("reloading server.");
2426		4192	async {
2427	# doing reload synchronously and two reloads happen back-to-back,	4193	$Coro::current->{desc} = "perl_reload";
2428	# coro crashes during coro_state_free->destroy here.
2429
2430	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2431	reload;	4194	reload_perl;
2432	undef $RELOAD_WATCHER;
2433	});	4195	};
2434	}	4196	}
2435	};	4197	};
2436		4198
2437	unshift @INC, $LIBDIR;	4199	#############################################################################
2438		4200
2439	my $bug_warning = 0;	4201	my $bug_warning = 0;
2440		4202
2441	$TICK_WATCHER = Event->timer (	4203	sub wait_for_tick() {
2442	reentrant => 0,	4204	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2443	parked => 1,	4205
2444	prio => 0,	4206	$WAIT_FOR_TICK->wait;
2445	at => $NEXT_TICK || $TICK,	4207	}
2446	data => WF_AUTOCANCEL,	4208
2447	cb => sub {	4209	sub wait_for_tick_begin() {
		4210	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4211
		4212	my $signal = new Coro::Signal;
		4213	push @WAIT_FOR_TICK_BEGIN, $signal;
		4214	$signal->wait;
		4215	}
		4216
		4217	sub tick {
2448	if ($Coro::current != $Coro::main) {	4218	if ($Coro::current != $Coro::main) {
2449	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	4219	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2450	unless ++$bug_warning > 10;	4220	unless ++$bug_warning > 10;
2451	return;	4221	return;
		4222	}
		4223
		4224	cf::one_tick; # one server iteration
		4225
		4226	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		4227
		4228	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		4229	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		4230	Coro::async_pool {
		4231	$Coro::current->{desc} = "runtime saver";
		4232	write_runtime_sync
		4233	or error "ERROR: unable to write runtime file: $!";
2452	}	4234	};
		4235	}
2453		4236
2454	$NOW = Event::time;	4237	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2455		4238	$sig->send;
2456	cf::server_tick; # one server iteration	4239	}
2457	$RUNTIME += $TICK;
2458	$NEXT_TICK += $TICK;
2459
2460	$WAIT_FOR_TICK->broadcast;	4240	$WAIT_FOR_TICK->broadcast;
2461	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2462		4241
2463	# if we are delayed by four ticks or more, skip them all	4242	$LOAD = ($NOW - $TICK_START) / $TICK;
2464	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4243	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2465		4244
2466	$TICK_WATCHER->at ($NEXT_TICK);	4245	if (0) {
2467	$TICK_WATCHER->start;	4246	if ($NEXT_TICK) {
		4247	my $jitter = $TICK_START - $NEXT_TICK;
		4248	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4249	debug "jitter $JITTER\n";#d#
		4250	}
2468	},	4251	}
2469	);	4252	}
2470		4253
		4254	{
		4255	# configure BDB
		4256	info "initialising database";
		4257
		4258	BDB::min_parallel 16;
		4259	BDB::max_poll_reqs $TICK * 0.1;
		4260	#$AnyEvent::BDB::WATCHER->priority (1);
		4261
		4262	unless ($DB_ENV) {
		4263	$DB_ENV = BDB::db_env_create;
		4264	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4265	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4266	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4267	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4268	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4269
		4270	cf::sync_job {
		4271	eval {
		4272	BDB::db_env_open
		4273	$DB_ENV,
		4274	$BDBDIR,
		4275	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4276	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4277	0666;
		4278
		4279	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4280	};
		4281
		4282	cf::cleanup "db_env_open(db): $@" if $@;
		4283	};
		4284	}
		4285
		4286	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4287	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4288	};
		4289	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4290	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4291	};
		4292	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4293	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4294	};
		4295
		4296	info "database initialised";
		4297	}
		4298
		4299	{
		4300	# configure IO::AIO
		4301
		4302	info "initialising aio";
		4303	IO::AIO::min_parallel 8;
2471	IO::AIO::max_poll_time $TICK * 0.2;	4304	IO::AIO::max_poll_time $TICK * 0.1;
		4305	undef $AnyEvent::AIO::WATCHER;
		4306	info "aio initialised";
		4307	}
2472		4308
2473	$AIO_POLL_WATCHER = Event->io (	4309	our $_log_backtrace;
2474	fd => IO::AIO::poll_fileno,	4310	our $_log_backtrace_last;
2475	poll => 'r',
2476	prio => 5,
2477	data => WF_AUTOCANCEL,
2478	cb => \&IO::AIO::poll_cb,
2479	);
2480		4311
2481	$WRITE_RUNTIME_WATCHER = Event->timer (	4312	sub _log_backtrace {
2482	data => WF_AUTOCANCEL,	4313	my ($msg, @addr) = @_;
2483	after => 1,	4314
2484	interval => 10,	4315	$msg =~ s/\n$//;
2485	prio => 6, # keep it lowest so it acts like a watchdog	4316
2486	cb => Coro::unblock_sub {	4317	if ($_log_backtrace_last eq $msg) {
2487	write_runtime	4318	LOG llevInfo, "[ABT] $msg\n";
2488	or warn "ERROR: unable to write runtime file: $!";	4319	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4320	# limit the # of concurrent backtraces
		4321	} elsif ($_log_backtrace < 2) {
		4322	$_log_backtrace_last = $msg;
		4323	++$_log_backtrace;
		4324	my $perl_bt = Carp::longmess $msg;
		4325	async {
		4326	$Coro::current->{desc} = "abt $msg";
		4327
		4328	my @bt = fork_call {
		4329	@addr = map { sprintf "%x", $_ } @addr;
		4330	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4331	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4332	or die "addr2line: $!";
		4333
		4334	my @funcs;
		4335	my @res = <$fh>;
		4336	chomp for @res;
		4337	while (@res) {
		4338	my ($func, $line) = splice @res, 0, 2, ();
		4339	push @funcs, "[$func] $line";
		4340	}
		4341
		4342	@funcs
		4343	};
		4344
		4345	LOG llevInfo, "[ABT] $perl_bt\n";
		4346	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4347	LOG llevInfo, "[ABT] $_\n" for @bt;
		4348	--$_log_backtrace;
		4349	};
		4350	} else {
		4351	LOG llevInfo, "[ABT] $msg\n";
		4352	LOG llevInfo, "[ABT] [overload, suppressed]\n";
2489	},	4353	}
2490	);	4354	}
		4355
		4356	# load additional modules
		4357	require "cf/$_.pm" for @EXTRA_MODULES;
		4358	cf::_connect_to_perl_2;
2491		4359
2492	END { cf::emergency_save }	4360	END { cf::emergency_save }
2493		4361
2494	1	4362	1
2495		4363

Diff Legend

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