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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.611 by root, Tue Nov 20 14:54:17 2012 UTC

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

Diff Legend

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