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.187 by root, Sat Jan 20 21:06:52 2007 UTC vs.
Revision 1.612 by root, Wed Nov 21 12:47:09 2012 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
12		36
		37	use AnyEvent ();
		38	use AnyEvent::IO ();
		39	use AnyEvent::DNS ();
		40
13	use Coro 3.4 ();	41	use Coro ();
		42	use Coro::State;
		43	use Coro::Handle;
		44	use Coro::EV;
14	use Coro::Event;	45	use Coro::AnyEvent;
15	use Coro::Timer;	46	use Coro::Timer;
16	use Coro::Signal;	47	use Coro::Signal;
17	use Coro::Semaphore;	48	use Coro::Semaphore;
		49	use Coro::SemaphoreSet;
		50	use Coro::AnyEvent;
18	use Coro::AIO;	51	use Coro::AIO;
		52	use Coro::BDB 1.6;
		53	use Coro::Storable;
		54	use Coro::Util ();
19		55
		56	use Guard ();
		57	use JSON::XS 2.01 ();
		58	use BDB ();
20	use Data::Dumper;	59	use Data::Dumper;
21	use Digest::MD5;
22	use Fcntl;	60	use Fcntl;
23	use IO::AIO 2.32 ();
24	use YAML::Syck ();	61	use YAML::XS ();
25	use Time::HiRes;	62	use IO::AIO ();
		63	use Compress::LZF;
		64	use Digest::MD5 ();
26		65
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	66	AnyEvent::detect;
		67
		68	# configure various modules to our taste
		69	#
		70	$Storable::canonical = 1; # reduce rsync transfers
		71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		72
		73	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		74
		75	# make sure c-lzf reinitialises itself
		76	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		77	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		78
		79	# strictly for debugging
		80	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
28		81
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30		83
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	84	our @ORIG_INC;
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		85
36	our %COMMAND = ();	86	our %COMMAND = ();
37	our %COMMAND_TIME = ();	87	our %COMMAND_TIME = ();
38		88
39	our @EXTS = (); # list of extension package names	89	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	90	our %EXTCMD = ();
		91	our %EXTACMD = ();
		92	our %EXTICMD = ();
		93	our %EXTIACMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	94	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	95	our %EXT_MAP = (); # pluggable maps
43		96
		97	our $RELOAD; # number of reloads so far, non-zero while in reload
44	our @EVENT;	98	our @EVENT;
45	our $LIBDIR = datadir . "/ext";	99	our @REFLECT; # set by XS
		100	our %REFLECT; # set by us
46		101
47	our $TICK = MAX_TIME * 1e-6;	102	our $CONFDIR = confdir;
48	our $TICK_WATCHER;	103
49	our $AIO_POLL_WATCHER;	104	our $DATADIR = datadir;
50	our $WRITE_RUNTIME_WATCHER;	105	our $LIBDIR = "$DATADIR/ext";
		106	our $PODDIR = "$DATADIR/pod";
		107	our $MAPDIR = "$DATADIR/" . mapdir;
		108
		109	our $LOCALDIR = localdir;
		110	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		111	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		112	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		113	our $RANDOMDIR = "$LOCALDIR/random";
		114	our $BDBDIR = "$LOCALDIR/db";
		115	our $PIDFILE = "$LOCALDIR/pid";
		116	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		117
		118	#our %RESOURCE; # unused
		119
		120	our $OUTPUT_RATE_MIN = 3000;
		121	our $OUTPUT_RATE_MAX = 1000000;
		122
		123	our $MAX_LINKS = 32; # how many chained exits to follow
		124	our $VERBOSE_IO = 1;
		125
		126	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		127	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	128	our $NEXT_TICK;
		129	our $USE_FSYNC = 1; # use fsync to write maps - default on
		130
		131	our $BDB_DEADLOCK_WATCHER;
		132	our $BDB_CHECKPOINT_WATCHER;
		133	our $BDB_TRICKLE_WATCHER;
		134	our $DB_ENV;
		135
		136	our @EXTRA_MODULES = qw(pod match mapscript incloader);
		137
		138	our %CFG;
		139	our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
		140
		141	our $UPTIME; $UPTIME ||= time;
		142	our $RUNTIME = 0;
		143	our $SERVER_TICK = 0;
52	our $NOW;	144	our $NOW;
53		145
54	our %CFG;	146	our (%PLAYER, %PLAYER_LOADING); # all users
55		147	our (%MAP, %MAP_LOADING ); # all maps
56	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;
58
59	our %PLAYER; # all users
60	our %MAP; # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	148	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		149
67	# used to convert map paths into valid unix filenames by replacing / by ∕	150	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	151	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		152
		153	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		154	our $LOADAVG; # same thing, but with alpha-smoothing
		155	our $JITTER; # average jitter
		156	our $TICK_START; # for load detecting purposes
		157
		158	our @POST_INIT;
		159
		160	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		161	our $REALLY_UNLOOP; # never set to true, please :)
		162
		163	our $WAIT_FOR_TICK = new Coro::Signal;
		164	our @WAIT_FOR_TICK_BEGIN;
		165
70	binmode STDOUT;	166	binmode STDOUT;
71	binmode STDERR;	167	binmode STDERR;
72		168
73	# read virtual server time, if available	169	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	170	unless ($RUNTIME || !-e $RUNTIMEFILE) {
75	open my $fh, "<", cf::localdir . "/runtime"	171	open my $fh, "<", $RUNTIMEFILE
76	or die "unable to read runtime file: $!";	172	or die "unable to read $RUNTIMEFILE file: $!";
77	$RUNTIME = <$fh> + 0.;	173	$RUNTIME = <$fh> + 0.;
78	}	174	}
79		175
80	mkdir cf::localdir;	176	eval "sub TICK() { $TICK } 1" or die;
81	mkdir cf::localdir . "/" . cf::playerdir;	177
82	mkdir cf::localdir . "/" . cf::tmpdir;	178	mkdir $_
83	mkdir cf::localdir . "/" . cf::uniquedir;	179	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
84	mkdir $RANDOM_MAPS;
85		180
86	our $EMERGENCY_POSITION;	181	our $EMERGENCY_POSITION;
87		182
		183	sub cf::map::normalise;
		184
		185	sub in_main() {
		186	$Coro::current == $Coro::main
		187	}
		188
88	#############################################################################	189	#############################################################################
89		190
		191	%REFLECT = ();
		192	for (@REFLECT) {
		193	my $reflect = JSON::XS::decode_json $_;
		194	$REFLECT{$reflect->{class}} = $reflect;
		195	}
		196
		197	# this is decidedly evil
		198	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		199
		200	#############################################################################
		201
90	=head2 GLOBAL VARIABLES	202	=head2 GLOBAL VARIABLES
91		203
92	=over 4	204	=over 4
93		205
94	=item $cf::UPTIME	206	=item $cf::UPTIME
95		207
96	The timestamp of the server start (so not actually an uptime).	208	The timestamp of the server start (so not actually an "uptime").
		209
		210	=item $cf::SERVER_TICK
		211
		212	An unsigned integer that starts at zero when the server is started and is
		213	incremented on every tick.
		214
		215	=item $cf::NOW
		216
		217	The (real) time of the last (current) server tick - updated before and
		218	after tick processing, so this is useful only as a rough "what time is it
		219	now" estimate.
		220
		221	=item $cf::TICK
		222
		223	The interval between each server tick, in seconds.
97		224
98	=item $cf::RUNTIME	225	=item $cf::RUNTIME
99		226
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	227	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	228	every server tick.
102		229
103	=item $cf::LIBDIR	230	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		231	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		232	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		233
105	The perl library directory, where extensions and cf-specific modules can	234	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	235	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		236	unique-items directory, player file directory, random maps directory and
		237	database environment.
107		238
		239	=item $cf::LOADAVG
		240
		241	The current CPU load on the server (alpha-smoothed), as a value between 0
		242	(none) and 1 (overloaded), indicating how much time is spent on processing
		243	objects per tick. Healthy values are < 0.5.
		244
108	=item $cf::NOW	245	=item $cf::LOAD
109		246
110	The time of the last (current) server tick.	247	The raw value load value from the last tick.
111
112	=item $cf::TICK
113
114	The interval between server ticks, in seconds.
115		248
116	=item %cf::CFG	249	=item %cf::CFG
117		250
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	252	from wherever your confdir points to.
120		253
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	254	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		255
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	256	These are functions that inhibit the current coroutine one tick.
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	257	cf::wait_for_tick_begin only returns directly I<after> the tick
125	processing has been done. Call C<< ->wait >> on them to maximise the	258	processing (and consequently, can only wake one thread per tick), while
126	window of cpu time available, or simply to synchronise to the server tick.	259	cf::wait_for_tick wakes up all waiters after tick processing.
		260
		261	Note that cf::wait_for_tick will immediately return when the server is not
		262	ticking, making it suitable for small pauses in threads that need to run
		263	when the server is paused. If that is not applicable (i.e. you I<really>
		264	want to wait, use C<$cf::WAIT_FOR_TICK>).
		265
		266	=item $cf::WAIT_FOR_TICK
		267
		268	Note that C<cf::wait_for_tick> is probably the correct thing to use. This
		269	variable contains a L<Coro::Signal> that is broadcats after every server
		270	tick. Calling C<< ->wait >> on it will suspend the caller until after the
		271	next server tick.
		272
		273	=cut
		274
		275	sub wait_for_tick();
		276	sub wait_for_tick_begin();
		277
		278	=item @cf::INVOKE_RESULTS
		279
		280	This array contains the results of the last C<invoke ()> call. When
		281	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		282	that call.
		283
		284	=item %cf::REFLECT
		285
		286	Contains, for each (C++) class name, a hash reference with information
		287	about object members (methods, scalars, arrays and flags) and other
		288	metadata, which is useful for introspection.
127		289
128	=back	290	=back
129		291
130	=cut	292	=cut
131		293
132	BEGIN {	294	sub error(@) { LOG llevError, join "", @_ }
133	*CORE::GLOBAL::warn = sub {	295	sub warn (@) { LOG llevWarn , join "", @_ }
		296	sub info (@) { LOG llevInfo , join "", @_ }
		297	sub debug(@) { LOG llevDebug, join "", @_ }
		298	sub trace(@) { LOG llevTrace, join "", @_ }
		299
		300	$Coro::State::WARNHOOK = sub {
134	my $msg = join "", @_;	301	my $msg = join "", @_;
135	utf8::encode $msg;
136		302
137	$msg .= "\n"	303	$msg .= "\n"
138	unless $msg =~ /\n$/;	304	unless $msg =~ /\n$/;
139		305
		306	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		307
140	LOG llevError, $msg;	308	LOG llevWarn, $msg;
141	};	309	};
142	}	310
		311	$Coro::State::DIEHOOK = sub {
		312	return unless $^S eq 0; # "eq", not "=="
		313
		314	error Carp::longmess $_[0];
		315
		316	if (in_main) {#d#
		317	error "DIEHOOK called in main context, Coro bug?\n";#d#
		318	return;#d#
		319	}#d#
		320
		321	# kill coroutine otherwise
		322	Coro::terminate
		323	};
143		324
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	325	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	326	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	327	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	328	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	329	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		330	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	331	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		332
151	# we bless all objects into (empty) derived classes to force a method lookup	333	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	334	# within the Safe compartment.
153	for my $pkg (qw(	335	for my $pkg (qw(
154	cf::global cf::attachable	336	cf::global cf::attachable
155	cf::object cf::object::player	337	cf::object cf::object::player
156	cf::client cf::player	338	cf::client cf::player
157	cf::arch cf::living	339	cf::arch cf::living
		340	cf::map cf::mapspace
158	cf::map cf::party cf::region	341	cf::party cf::region
159	)) {	342	)) {
160	no strict 'refs';
161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	343	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162	}	344	}
163		345
164	$Event::DIED = sub {	346	$EV::DIED = sub {
165	warn "error in event callback: @_";	347	warn "error in event callback: $@";
166	};	348	};
		349
		350	#############################################################################
		351
		352	sub fork_call(&@);
		353	sub get_slot($;$$);
		354
		355	#############################################################################
167		356
168	=head2 UTILITY FUNCTIONS	357	=head2 UTILITY FUNCTIONS
169		358
170	=over 4	359	=over 4
171		360
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	379	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	380	$d
192	} || "[unable to dump $_[0]: '$@']";	381	} || "[unable to dump $_[0]: '$@']";
193	}	382	}
194		383
195	use JSON::Syck (); # TODO# replace by JSON::PC once working	384	=item $scalar = cf::load_file $path
196		385
		386	Loads the given file from path and returns its contents. Croaks on error
		387	and can block.
		388
		389	=cut
		390
		391	sub load_file($) {
		392	0 <= aio_load $_[0], my $data
		393	or Carp::croak "$_[0]: $!";
		394
		395	$data
		396	}
		397
		398	=item $success = cf::replace_file $path, $data, $sync
		399
		400	Atomically replaces the file at the given $path with new $data, and
		401	optionally $sync the data to disk before replacing the file.
		402
		403	=cut
		404
		405	sub replace_file($$;$) {
		406	my ($path, $data, $sync) = @_;
		407
		408	my $lock = cf::lock_acquire ("replace_file:$path");
		409
		410	my $fh = aio_open "$path~", Fcntl::O_WRONLY | Fcntl::O_CREAT | Fcntl::O_TRUNC, 0644
		411	or return;
		412
		413	$data = $data->() if ref $data;
		414
		415	length $data == aio_write $fh, 0, (length $data), $data, 0
		416	or return;
		417
		418	!$sync
		419	or !aio_fsync $fh
		420	or return;
		421
		422	aio_close $fh
		423	and return;
		424
		425	aio_rename "$path~", $path
		426	and return;
		427
		428	if ($sync) {
		429	$path =~ s%/[^/]*$%%;
		430	aio_pathsync $path;
		431	}
		432
		433	1
		434	}
		435
197	=item $ref = cf::from_json $json	436	=item $ref = cf::decode_json $json
198		437
199	Converts a JSON string into the corresponding perl data structure.	438	Converts a JSON string into the corresponding perl data structure.
200		439
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	440	=item $json = cf::encode_json $ref
209		441
210	Converts a perl data structure into its JSON representation.	442	Converts a perl data structure into its JSON representation.
211		443
212	=cut	444	=cut
213		445
214	sub to_json($) {	446	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	447
216	JSON::Syck::Dump $_[0]	448	sub encode_json($) { $json_coder->encode ($_[0]) }
		449	sub decode_json($) { $json_coder->decode ($_[0]) }
		450
		451	=item $ref = cf::decode_storable $scalar
		452
		453	Same as Coro::Storable::thaw, so blocks.
		454
		455	=cut
		456
		457	BEGIN { *decode_storable = \&Coro::Storable::thaw }
		458
		459	=item $ref = cf::decode_yaml $scalar
		460
		461	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
		462
		463	=cut
		464
		465	sub decode_yaml($) {
		466	fork_call { YAML::XS::Load $_[0] } @_
		467	}
		468
		469	=item $scalar = cf::unlzf $scalar
		470
		471	Same as Compress::LZF::compress, but takes server ticks into account, so
		472	blocks.
		473
		474	=cut
		475
		476	sub unlzf($) {
		477	# we assume 100mb/s minimum decompression speed (noncompressible data on a ~2ghz machine)
		478	cf::get_slot +(length $_[0]) / 100_000_000, 0, "unlzf";
		479	Compress::LZF::decompress $_[0]
		480	}
		481
		482	=item cf::post_init { BLOCK }
		483
		484	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
		485	but I<before> the server starts ticking again.
		486
		487	The codeblock will have a single boolean argument to indicate whether this
		488	is a reload or not.
		489
		490	=cut
		491
		492	sub post_init(&) {
		493	push @POST_INIT, shift;
		494	}
		495
		496	sub _post_init {
		497	trace "running post_init jobs";
		498
		499	# run them in parallel...
		500
		501	my @join;
		502
		503	while () {
		504	push @join, map &Coro::async ($_, 0), @POST_INIT;
		505	@POST_INIT = ();
		506
		507	@join or last;
		508
		509	(pop @join)->join;
		510	}
217	}	511	}
218		512
219	=item cf::lock_wait $string	513	=item cf::lock_wait $string
220		514
221	Wait until the given lock is available. See cf::lock_acquire.	515	Wait until the given lock is available. See cf::lock_acquire.
222		516
223	=item my $lock = cf::lock_acquire $string	517	=item my $lock = cf::lock_acquire $string
224		518
225	Wait until the given lock is available and then acquires it and returns	519	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	520	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	521	for example when the coroutine gets canceled), the lock is automatically
228	returned.	522	returned.
229		523
		524	Locks are *not* recursive, locking from the same coro twice results in a
		525	deadlocked coro.
		526
230	Lock names should begin with a unique identifier (for example, cf::map::find	527	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	528	uses map_find and cf::map::load uses map_load).
232		529
233	=cut	530	=item $locked = cf::lock_active $string
234		531
235	our %LOCK;	532	Return true if the lock is currently active, i.e. somebody has locked it.
		533
		534	=cut
		535
		536	our $LOCKS = new Coro::SemaphoreSet;
236		537
237	sub lock_wait($) {	538	sub lock_wait($) {
238	my ($key) = @_;	539	$LOCKS->wait ($_[0]);
239
240	# wait for lock, if any
241	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;
244	}
245	}	540	}
246		541
247	sub lock_acquire($) {	542	sub lock_acquire($) {
248	my ($key) = @_;	543	$LOCKS->guard ($_[0])
		544	}
249		545
250	# wait, to be sure we are not locked	546	sub lock_active($) {
251	lock_wait $key;	547	$LOCKS->count ($_[0]) < 1
252
253	$LOCK{$key} = [];
254
255	Coro::guard {
256	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };
258	}
259	}	548	}
260		549
261	sub freeze_mainloop {	550	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	551	tick_inhibit_inc;
263		552
264	my $guard = Coro::guard {	553	&Guard::guard (\&tick_inhibit_dec);
265	$TICK_WATCHER->start;	554	}
266	$WRITE_RUNTIME_WATCHER->start;	555
		556	=item cf::periodic $interval, $cb
		557
		558	Like EV::periodic, but randomly selects a starting point so that the actions
		559	get spread over time.
		560
		561	=cut
		562
		563	sub periodic($$) {
		564	my ($interval, $cb) = @_;
		565
		566	my $start = rand List::Util::min 180, $interval;
		567
		568	EV::periodic $start, $interval, 0, $cb
		569	}
		570
		571	=item cf::get_slot $time[, $priority[, $name]]
		572
		573	Allocate $time seconds of blocking CPU time at priority C<$priority>
		574	(default: 0): This call blocks and returns only when you have at least
		575	C<$time> seconds of cpu time till the next tick. The slot is only valid
		576	till the next cede.
		577
		578	Background jobs should use a priority less than zero, interactive jobs
		579	should use 100 or more.
		580
		581	The optional C<$name> can be used to identify the job to run. It might be
		582	used for statistical purposes and should identify the same time-class.
		583
		584	Useful for short background jobs.
		585
		586	=cut
		587
		588	our @SLOT_QUEUE;
		589	our $SLOT_QUEUE;
		590	our $SLOT_DECAY = 0.9;
		591
		592	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		593	$SLOT_QUEUE = Coro::async {
		594	$Coro::current->desc ("timeslot manager");
		595
		596	my $signal = new Coro::Signal;
		597	my $busy;
		598
		599	while () {
		600	next_job:
		601
		602	Coro::cede;
		603
		604	my $avail = cf::till_tick;
		605
		606	for (0 .. $#SLOT_QUEUE) {
		607	if ($SLOT_QUEUE[$_][0] <= $avail) {
		608	$busy = 0;
		609	my $job = splice @SLOT_QUEUE, $_, 1, ();
		610	$job->[2]->send;
		611	goto next_job;
		612	} else {
		613	$SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
		614	}
		615	}
		616
		617	if (@SLOT_QUEUE) {
		618	wait_for_tick;
		619	} else {
		620	$busy = 0;
		621	Coro::schedule;
		622	}
267	};	623	}
268	$WRITE_RUNTIME_WATCHER->stop;	624	};
269	$TICK_WATCHER->stop;	625
270	$guard	626	sub get_slot($;$$) {
		627	return if tick_inhibit || $Coro::current == $Coro::main;
		628
		629	my ($time, $pri, $name) = @_;
		630
		631	$time = clamp $time, 0.01, $TICK * .6;
		632
		633	my $sig = new Coro::Signal;
		634
		635	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		636	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		637	$SLOT_QUEUE->ready;
		638	$sig->wait;
271	}	639	}
272		640
273	=item cf::async { BLOCK }	641	=item cf::async { BLOCK }
274		642
275	Currently the same as Coro::async_pool, meaning you cannot use	643	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		648
281	BEGIN { *async = \&Coro::async_pool }	649	BEGIN { *async = \&Coro::async_pool }
282		650
283	=item cf::sync_job { BLOCK }	651	=item cf::sync_job { BLOCK }
284		652
285	The design of crossfire+ requires that the main coro ($Coro::main) is	653	The design of Deliantra requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	654	is always able to handle events or runnable, as Deliantra is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	655	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		656	acceptable.
288		657
289	If it must be done, put the blocking parts into C<sync_job>. This will run	658	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	659	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	660	server will be frozen during this time, so the block should either finish
292	fast or be very important.	661	fast or be very important.
…		…
294	=cut	663	=cut
295		664
296	sub sync_job(&) {	665	sub sync_job(&) {
297	my ($job) = @_;	666	my ($job) = @_;
298		667
299	if ($Coro::current == $Coro::main) {	668	if (in_main) {
		669	my $time = AE::time;
		670
300	# this is the main coro, too bad, we have to block	671	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	672	# till the operation succeeds, freezing the server :/
302		673
303	# TODO: use suspend/resume instead	674	#LOG llevError, Carp::longmess "sync job";#d#
304	# (but this is cancel-safe)	675
305	my $freeze_guard = freeze_mainloop;	676	my $freeze_guard = freeze_mainloop;
306		677
307	my $busy = 1;	678	my $busy = 1;
308	my @res;	679	my @res;
309		680
310	(async {	681	(async {
		682	$Coro::current->desc ("sync job coro");
311	@res = eval { $job->() };	683	@res = eval { $job->() };
312	warn $@ if $@;	684	error $@ if $@;
313	undef $busy;	685	undef $busy;
314	})->prio (Coro::PRIO_MAX);	686	})->prio (Coro::PRIO_MAX);
315		687
316	while ($busy) {	688	while ($busy) {
317	Coro::cede or Event::one_event;	689	if (Coro::nready) {
		690	Coro::cede_notself;
		691	} else {
		692	EV::loop EV::LOOP_ONESHOT;
318	}	693	}
		694	}
		695
		696	my $time = AE::time - $time;
		697
		698	$TICK_START += $time; # do not account sync jobs to server load
319		699
320	wantarray ? @res : $res[0]	700	wantarray ? @res : $res[0]
321	} else {	701	} else {
322	# we are in another coroutine, how wonderful, everything just works	702	# we are in another coroutine, how wonderful, everything just works
323		703
…		…
343	$EXT_CORO{$coro+0} = $coro;	723	$EXT_CORO{$coro+0} = $coro;
344		724
345	$coro	725	$coro
346	}	726	}
347		727
348	sub write_runtime {	728	=item fork_call { }, @args
349	my $runtime = cf::localdir . "/runtime";
350		729
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	730	Executes the given code block with the given arguments in a seperate
352	or return;	731	process, returning the results. Everything must be serialisable with
		732	Coro::Storable. May, of course, block. Note that the executed sub may
		733	never block itself or use any form of event handling.
353		734
354	my $value = $cf::RUNTIME + 90 + 10;	735	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		736
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	737	sub post_fork {
359	and return;	738	reset_signals;
		739	}
360		740
361	aio_fsync $fh	741	sub fork_call(&@) {
362	and return;	742	my ($cb, @args) = @_;
363		743
364	close $fh	744	my @res = Coro::Util::fork_eval {
365	or return;	745	cf::post_fork;
		746	&$cb
		747	} @args;
366		748
367	aio_rename "$runtime~", $runtime	749	wantarray ? @res : $res[-1]
368	and return;	750	}
369		751
		752	sub objinfo {
370	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 });
371	}	927	}
372		928
373	=back	929	=back
374		930
375	=cut	931	=cut
376		932
377	#############################################################################	933	#############################################################################
378		934
379	=head2 ATTACHABLE OBJECTS	935	=head2 ATTACHABLE OBJECTS
380		936
381	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
382	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")
383	to it. All such attachable objects support the following methods.	939	to it. All such attachable objects support the following methods.
384		940
385	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>
386	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
387	crossfire+).	943	Deliantra).
388		944
389	=over 4	945	=over 4
390		946
391	=item $attachable->attach ($attachment, key => $value...)	947	=item $attachable->attach ($attachment, key => $value...)
392		948
…		…
436	=item cf::CLASS::attachment $name, ...	992	=item cf::CLASS::attachment $name, ...
437		993
438	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
439	given CLASS can refer to this attachment.	995	given CLASS can refer to this attachment.
440		996
441	Some classes such as crossfire maps and objects can specify attachments	997	Some classes such as deliantra maps and objects can specify attachments
442	that are attached at load/instantiate time, thus the need for a name.	998	that are attached at load/instantiate time, thus the need for a name.
443		999
444	These calls expect any number of the following handler/hook descriptions:	1000	These calls expect any number of the following handler/hook descriptions:
445		1001
446	=over 4	1002	=over 4
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	1111	$registry = $CB_TYPE[$object_type] ||= [];
556		1112
557	} elsif ($type eq "subtype") {	1113	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	1114	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	1115	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1116	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		1117
562	} elsif ($type eq "package") {	1118	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	1119	my $pkg = shift @arg;
564		1120
565	while (my ($name, $id) = each %cb_id) {	1121	while (my ($name, $id) = each %cb_id) {
…		…
570		1126
571	} elsif (exists $cb_id{$type}) {	1127	} elsif (exists $cb_id{$type}) {
572	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1128	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
573		1129
574	} elsif (ref $type) {	1130	} elsif (ref $type) {
575	warn "attaching objects not supported, ignoring.\n";	1131	error "attaching objects not supported, ignoring.\n";
576		1132
577	} else {	1133	} else {
578	shift @arg;	1134	shift @arg;
579	warn "attach argument '$type' not supported, ignoring.\n";	1135	error "attach argument '$type' not supported, ignoring.\n";
580	}	1136	}
581	}	1137	}
582	}	1138	}
583		1139
584	sub _object_attach {	1140	sub _object_attach {
…		…
594	_attach $registry, $klass, @attach;	1150	_attach $registry, $klass, @attach;
595	}	1151	}
596		1152
597	$obj->{$name} = \%arg;	1153	$obj->{$name} = \%arg;
598	} else {	1154	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	1155	info "object uses attachment '$name' which is not available, postponing.\n";
600	}	1156	}
601		1157
602	$obj->{_attachment}{$name} = undef;	1158	$obj->{_attachment}{$name} = undef;
603	}	1159	}
604		1160
…		…
606	if (ref $_[0]) {	1162	if (ref $_[0]) {
607	_object_attach @_;	1163	_object_attach @_;
608	} else {	1164	} else {
609	_attach shift->_attach_registry, @_;	1165	_attach shift->_attach_registry, @_;
610	}	1166	}
		1167	_recalc_want;
611	};	1168	};
612		1169
613	# all those should be optimised	1170	# all those should be optimised
614	sub cf::attachable::detach {	1171	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	1172	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	1175	delete $obj->{_attachment}{$name};
619	reattach ($obj);	1176	reattach ($obj);
620	} else {	1177	} else {
621	Carp::croak "cannot, currently, detach class attachments";	1178	Carp::croak "cannot, currently, detach class attachments";
622	}	1179	}
		1180	_recalc_want;
623	};	1181	};
624		1182
625	sub cf::attachable::attached {	1183	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	1184	my ($obj, $name) = @_;
627		1185
…		…
642	";	1200	";
643	die if $@;	1201	die if $@;
644	}	1202	}
645		1203
646	our $override;	1204	our $override;
647	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?
648		1206
649	sub override {	1207	sub override {
650	$override = 1;	1208	$override = 1;
651	@invoke_results = ();	1209	@INVOKE_RESULTS = (@_);
652	}	1210	}
653		1211
654	sub do_invoke {	1212	sub do_invoke {
655	my $event = shift;	1213	my $event = shift;
656	my $callbacks = shift;	1214	my $callbacks = shift;
657		1215
658	@invoke_results = ();	1216	@INVOKE_RESULTS = ();
659		1217
660	local $override;	1218	local $override;
661		1219
662	for (@$callbacks) {	1220	for (@$callbacks) {
663	eval { &{$_->[1]} };	1221	eval { &{$_->[1]} };
664		1222
665	if ($@) {	1223	if ($@) {
666	warn "$@";
667	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1224	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
668	override;	1225	override;
669	}	1226	}
670		1227
671	return 1 if $override;	1228	return 1 if $override;
672	}	1229	}
673		1230
674	0	1231	0
675	}	1232	}
676		1233
677	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
678		1235
679	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1236	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
680		1237
681	Generate an object-specific event with the given arguments.	1238	Generate an object-specific event with the given arguments.
682		1239
683	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
684	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
685	results (if you must, access C<@cf::invoke_results> directly).	1242	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		1243
687	=back	1244	=back
688		1245
689	=cut	1246	=cut
690		1247
691	#############################################################################	1248	#############################################################################
692	# 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	}
693		1292
694	sub reattach {	1293	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	1294	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	1295	my ($obj) = @_;
697		1296
		1297	# no longer needed after getting rid of delete_package?
698	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
699		1299
700	my $registry = $obj->registry;	1300	my $registry = $obj->registry;
701		1301
702	@$registry = ();	1302	@$registry = ();
703		1303
…		…
708	for (@$attach) {	1308	for (@$attach) {
709	my ($klass, @attach) = @$_;	1309	my ($klass, @attach) = @$_;
710	_attach $registry, $klass, @attach;	1310	_attach $registry, $klass, @attach;
711	}	1311	}
712	} else {	1312	} else {
713	warn "object uses attachment '$name' that is not available, postponing.\n";	1313	info "object uses attachment '$name' that is not available, postponing.\n";
714	}	1314	}
715	}	1315	}
716	}	1316	}
717		1317
718	cf::attachable->attach (	1318	cf::attachable->attach (
719	prio => -1000000,	1319	prio => -1000000,
720	on_instantiate => sub {	1320	on_instantiate => sub {
721	my ($obj, $data) = @_;	1321	my ($obj, $data) = @_;
722		1322
723	$data = from_json $data;	1323	$data = decode_json $data;
724		1324
725	for (@$data) {	1325	for (@$data) {
726	my ($name, $args) = @$_;	1326	my ($name, $args) = @$_;
727		1327
728	$obj->attach ($name, %{$args || {} });	1328	$obj->attach ($name, %{$args || {} });
…		…
744	sub object_freezer_save {	1344	sub object_freezer_save {
745	my ($filename, $rdata, $objs) = @_;	1345	my ($filename, $rdata, $objs) = @_;
746		1346
747	sync_job {	1347	sync_job {
748	if (length $$rdata) {	1348	if (length $$rdata) {
		1349	utf8::decode (my $decname = $filename);
749	warn sprintf "saving %s (%d,%d)\n",	1350	trace sprintf "saving %s (%d,%d)\n",
750	$filename, length $$rdata, scalar @$objs;	1351	$decname, length $$rdata, scalar @$objs
		1352	if $VERBOSE_IO;
751		1353
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1354	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1355	aio_chmod $fh, SAVE_MODE;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1356	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1357	if ($cf::USE_FSYNC) {
		1358	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
755	aio_fsync $fh;	1359	aio_fsync $fh;
		1360	}
756	close $fh;	1361	aio_close $fh;
757		1362
758	if (@$objs) {	1363	if (@$objs) {
759	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) {
760	chmod SAVE_MODE, $fh;	1365	aio_chmod $fh, SAVE_MODE;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1366	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1367	aio_write $fh, 0, (length $data), $data, 0;
		1368	if ($cf::USE_FSYNC) {
		1369	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
763	aio_fsync $fh;	1370	aio_fsync $fh;
		1371	}
764	close $fh;	1372	aio_close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1373	aio_rename "$filename.pst~", "$filename.pst";
766	}	1374	}
767	} else {	1375	} else {
768	aio_unlink "$filename.pst";	1376	aio_unlink "$filename.pst";
769	}	1377	}
770		1378
771	aio_rename "$filename~", $filename;	1379	aio_rename "$filename~", $filename;
		1380
		1381	$filename =~ s%/[^/]+$%%;
		1382	aio_pathsync $filename if $cf::USE_FSYNC;
772	} else {	1383	} else {
773	warn "FATAL: $filename~: $!\n";	1384	error "unable to save objects: $filename~: $!\n";
774	}	1385	}
775	} else {	1386	} else {
776	aio_unlink $filename;	1387	aio_unlink $filename;
777	aio_unlink "$filename.pst";	1388	aio_unlink "$filename.pst";
778	}	1389	}
779	}	1390	};
780	}	1391	}
781		1392
782	sub object_freezer_as_string {	1393	sub object_freezer_as_string {
783	my ($rdata, $objs) = @_;	1394	my ($rdata, $objs) = @_;
784		1395
…		…
796	or return;	1407	or return;
797		1408
798	unless (aio_stat "$filename.pst") {	1409	unless (aio_stat "$filename.pst") {
799	(aio_load "$filename.pst", $av) >= 0	1410	(aio_load "$filename.pst", $av) >= 0
800	or return;	1411	or return;
		1412
801	$av = eval { (Storable::thaw $av)->{objs} };	1413	my $st = eval { Coro::Storable::thaw $av };
		1414	$av = $st->{objs};
802	}	1415	}
803		1416
		1417	utf8::decode (my $decname = $filename);
804	warn sprintf "loading %s (%d)\n",	1418	trace sprintf "loading %s (%d,%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1419	$decname, length $data, scalar @{$av || []}
		1420	if $VERBOSE_IO;
		1421
806	return ($data, $av);	1422	($data, $av)
807	}	1423	}
		1424
		1425	=head2 COMMAND CALLBACKS
		1426
		1427	=over 4
		1428
		1429	=cut
808		1430
809	#############################################################################	1431	#############################################################################
810	# command handling &c	1432	# command handling &c
811		1433
812	=item cf::register_command $name => \&callback($ob,$args);	1434	=item cf::register_command $name => \&callback($ob,$args)
813		1435
814	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
815	$name.	1437	$name.
816		1438
817	=cut	1439	=cut
…		…
823	#warn "registering command '$name/$time' to '$caller'";	1445	#warn "registering command '$name/$time' to '$caller'";
824		1446
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1447	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1448	}
827		1449
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1450	=item cf::register_extcmd $name => \&callback($pl,@args)
829		1451
830	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.
831		1457
832	If the callback returns something, it is sent back as if reply was being	1458	The values will be sent back to the client.
833	called.
834		1459
835	=cut	1460	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
836		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
837	sub register_extcmd {	1482	sub register_extcmd($$) {
838	my ($name, $cb) = @_;	1483	my ($name, $cb) = @_;
839		1484
840	$EXTCMD{$name} = $cb;	1485	$EXTCMD{$name} = $cb;
841	}	1486	}
842		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
843	cf::player->attach (	1508	cf::player->attach (
844	on_command => sub {	1509	on_unknown_command => sub {
845	my ($pl, $name, $params) = @_;	1510	my ($pl, $name, $params) = @_;
846		1511
847	my $cb = $COMMAND{$name}	1512	my $cb = $COMMAND{$name}
848	or return;	1513	or return;
849		1514
…		…
854	cf::override;	1519	cf::override;
855	},	1520	},
856	on_extcmd => sub {	1521	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1522	my ($pl, $buf) = @_;
858		1523
859	my $msg = eval { from_json $buf };	1524	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1525
861	if (ref $msg) {	1526	if (ref $msg) {
		1527	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1528
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1529	if (my $cb = $EXTACMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1530	$cb->(
864	$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);
865	}	1543	}
		1544
		1545	$pl->ext_msg ("reply-$reply", @reply)
		1546	if $reply;
866	}	1547	}
		1548
867	} else {	1549	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1550	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1551	}
870		1552
871	cf::override;	1553	cf::override;
872	},	1554	},
873	);	1555	);
874		1556
		1557	# "readahead" all extensions
875	sub load_extension {	1558	sub cache_extensions {
876	my ($path) = @_;	1559	my $grp = IO::AIO::aio_group;
877		1560
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1561	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
879	my $base = $1;	1562	for (grep /\.ext$/, @{$_[0]}) {
880	my $pkg = $1;	1563	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}	1564	}
903	die $@;
904	}	1565	};
905		1566
906	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;
907	}	1579	}
908		1580
909	sub load_extensions {	1581	sub load_extensions {
		1582	info "loading extensions...";
		1583
		1584	%EXT_CFG = ();
		1585
		1586	cf::sync_job {
		1587	my %todo;
		1588
910	for my $ext (<$LIBDIR/*.ext>) {	1589	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1590	next unless -r $path;
912	eval {	1591
913	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	}
914	1	1664	}
915	} 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	}
916	}	1677	};
917	}	1678	}
918		1679
919	#############################################################################	1680	#############################################################################
920		1681
		1682	=back
		1683
921	=head2 CORE EXTENSIONS	1684	=head2 CORE EXTENSIONS
922		1685
923	Functions and methods that extend core crossfire objects.	1686	Functions and methods that extend core deliantra objects.
924		1687
925	=cut	1688	=cut
926		1689
927	package cf::player;	1690	package cf::player;
928		1691
…		…
930		1693
931	=head3 cf::player	1694	=head3 cf::player
932		1695
933	=over 4	1696	=over 4
934		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
935	=item cf::player::find $login	1712	=item cf::player::find $login
936		1713
937	Returns the given player object, loading it if necessary (might block).	1714	Returns the given player object, loading it if necessary (might block).
938		1715
939	=cut	1716	=cut
940		1717
941	sub playerdir($) {	1718	sub playerdir($) {
942	cf::localdir	1719	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1720	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1721	}
948		1722
949	sub path($) {	1723	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1724	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1725
952	(playerdir $login) . "/$login.pl"	1726	(playerdir $login) . "/playerdata"
953	}	1727	}
954		1728
955	sub find_active($) {	1729	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1730	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1731	and $cf::PLAYER{$_[0]}->active
…		…
960		1734
961	sub exists($) {	1735	sub exists($) {
962	my ($login) = @_;	1736	my ($login) = @_;
963		1737
964	$cf::PLAYER{$login}	1738	$cf::PLAYER{$login}
965	or cf::sync_job { !aio_stat path $login }	1739	or !aio_stat path $login
966	}	1740	}
967		1741
968	sub find($) {	1742	sub find($) {
969	return $cf::PLAYER{$_[0]} || do {	1743	return $cf::PLAYER{$_[0]} || do {
970	my $login = $_[0];	1744	my $login = $_[0];
971		1745
972	my $guard = cf::lock_acquire "user_find:$login";	1746	my $guard = cf::lock_acquire "user_find:$login";
973		1747
974	$cf::PLAYER{$_[0]} || do {	1748	$cf::PLAYER{$_[0]} || do {
975	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
976	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;
977	$cf::PLAYER{$login} = $pl	1764	$cf::PLAYER{$login} = $pl
978	}	1765	}
979	}	1766	}
980	}	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	);
981		1781
982	sub save($) {	1782	sub save($) {
983	my ($pl) = @_;	1783	my ($pl) = @_;
984		1784
985	return if $pl->{deny_save};	1785	return if $pl->{deny_save};
…		…
990	return if $pl->{deny_save};	1790	return if $pl->{deny_save};
991		1791
992	aio_mkdir playerdir $pl, 0770;	1792	aio_mkdir playerdir $pl, 0770;
993	$pl->{last_save} = $cf::RUNTIME;	1793	$pl->{last_save} = $cf::RUNTIME;
994		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
995	$pl->save_pl ($path);	1800	$pl->save_pl ($path);
996	Coro::cede;	1801	cf::cede_to_tick;
997	}	1802	}
998		1803
999	sub new($) {	1804	sub new($) {
1000	my ($login) = @_;	1805	my ($login) = @_;
1001		1806
…		…
1007	$cf::PLAYER{$login} = $self;	1812	$cf::PLAYER{$login} = $self;
1008		1813
1009	$self	1814	$self
1010	}	1815	}
1011		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
1012	=item $pl->quit_character	1827	=item $pl->quit_character
1013		1828
1014	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
1015	be destroyed. May block for a long time.	1830	be destroyed. May block for a long time.
1016		1831
1017	=cut	1832	=cut
1018		1833
1019	sub quit_character {	1834	sub quit_character {
1020	my ($pl) = @_;	1835	my ($pl) = @_;
1021		1836
		1837	my $name = $pl->ob->name;
		1838
1022	$pl->{deny_save} = 1;	1839	$pl->{deny_save} = 1;
1023	$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
1024		1841
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1842	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1026	$pl->deactivate;	1843	$pl->deactivate;
		1844
		1845	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1027	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1846	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1847	ext::highscore::check ($pl->ob);
		1848
1028	$pl->ns->destroy if $pl->ns;	1849	$pl->ns->destroy if $pl->ns;
1029		1850
1030	my $path = playerdir $pl;	1851	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1852	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1853	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1854	delete $cf::PLAYER{$pl->ob->name};
1034	$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
1035	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;
1036	}	1877	}
1037		1878
1038	=item cf::player::list_logins	1879	=item cf::player::list_logins
1039		1880
1040	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
1041	while and may block, so not sync_job-capable, ever.	1882	while and may block, so not sync_job-capable, ever.
1042		1883
1043	=cut	1884	=cut
1044		1885
1045	sub list_logins {	1886	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1887	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1888	or return [];
1048		1889
1049	my @logins;	1890	my @logins;
1050		1891
1051	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") {
1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1898	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1053	aio_read $fh, 0, 512, my $buf, 0 or next;	1899	aio_read $fh, 0, 512, my $buf, 0 or next;
1054	$buf !~ /^password -------------$/m or next; # official not-valid tag	1900	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1901	}
1055		1902
1056	utf8::decode $login;	1903	utf8::decode $login;
1057	push @logins, $login;	1904	push @logins, $login;
1058	}	1905	}
1059		1906
1060	\@logins	1907	\@logins
1061	}	1908	}
1062		1909
1063	=item $player->maps	1910	=item $player->maps
1064		1911
		1912	=item cf::player::maps $login
		1913
1065	Returns an arrayref of map paths that are private for this	1914	Returns an arrayref of map paths that are private for this
1066	player. May block.	1915	player. May block.
1067		1916
1068	=cut	1917	=cut
1069		1918
1070	sub maps($) {	1919	sub maps($) {
1071	my ($pl) = @_;	1920	my ($pl) = @_;
		1921
		1922	$pl = ref $pl ? $pl->ob->name : $pl;
1072		1923
1073	my $files = aio_readdir playerdir $pl	1924	my $files = aio_readdir playerdir $pl
1074	or return;	1925	or return;
1075		1926
1076	my @paths;	1927	my @paths;
…		…
1078	for (@$files) {	1929	for (@$files) {
1079	utf8::decode $_;	1930	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1931	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1932	next unless /^$PATH_SEP/o;
1082		1933
1083	s/\.map$//;	1934	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1935	}
1086		1936
1087	\@paths	1937	\@paths
1088	}	1938	}
1089		1939
		1940	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1941
		1942	Expand deliantra pod fragments into protocol xml.
		1943
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1944	=item $player->ext_msg ($type, @msg)
1091		1945
1092	Sends an ext reply to the player.	1946	Sends an ext event to the client.
1093		1947
1094	=cut	1948	=cut
1095		1949
1096	sub ext_reply($$$%) {	1950	sub ext_msg($$@) {
1097	my ($self, $id, %msg) = @_;	1951	my ($self, $type, @msg) = @_;
1098		1952
1099	$msg{msgid} = $id;	1953	$self->ns->ext_msg ($type, @msg);
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1954	}
1103		1955
1104	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	}
1105		1986
1106	=back	1987	=back
1107
1108		1988
1109	=head3 cf::map	1989	=head3 cf::map
1110		1990
1111	=over 4	1991	=over 4
1112		1992
…		…
1124	our $MAX_RESET = 3600;	2004	our $MAX_RESET = 3600;
1125	our $DEFAULT_RESET = 3000;	2005	our $DEFAULT_RESET = 3000;
1126		2006
1127	sub generate_random_map {	2007	sub generate_random_map {
1128	my ($self, $rmp) = @_;	2008	my ($self, $rmp) = @_;
1129	# mit "rum" bekleckern, nicht	2009
		2010	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		2011
1130	$self->_create_random_map (	2012	$self->_create_random_map ($rmp);
1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134	$rmp->{exit_on_final_map},
1135	$rmp->{xsize}, $rmp->{ysize},
1136	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1138	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1139	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(cf::region::find $rmp->{region}), $rmp->{custom}
1142	)
1143	}	2013	}
1144		2014
1145	=item cf::map->register ($regex, $prio)	2015	=item cf::map->register ($regex, $prio)
1146		2016
1147	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
…		…
1152		2022
1153	sub register {	2023	sub register {
1154	my (undef, $regex, $prio) = @_;	2024	my (undef, $regex, $prio) = @_;
1155	my $pkg = caller;	2025	my $pkg = caller;
1156		2026
1157	no strict;
1158	push @{"$pkg\::ISA"}, __PACKAGE__;	2027	push @{"$pkg\::ISA"}, __PACKAGE__;
1159		2028
1160	$EXT_MAP{$pkg} = [$prio, qr<$regex>];	2029	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1161	}	2030	}
1162		2031
1163	# also paths starting with '/'	2032	# also paths starting with '/'
1164	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];	2033	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1165		2034
1166	sub thawer_merge {	2035	sub thawer_merge {
1167	my ($self, $merge) = @_;	2036	my ($self, $merge) = @_;
1168		2037
1169	# we have to keep some variables in memory intact	2038	# we have to keep some variables in memory intact
1170	local $self->{path};	2039	local $self->{path};
1171	local $self->{load_path};	2040	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		2041
1175	$self->SUPER::thawer_merge ($merge);	2042	$self->SUPER::thawer_merge ($merge);
1176	}	2043	}
1177		2044
1178	sub normalise {	2045	sub normalise {
1179	my ($path, $base) = @_;	2046	my ($path, $base) = @_;
		2047
		2048	$path = "$path"; # make sure it's a string
		2049
		2050	$path =~ s/\.map$//;
1180		2051
1181	# map plan:	2052	# map plan:
1182	#	2053	#
1183	# /! non-realised random map exit (special hack!)	2054	# /! non-realised random map exit (special hack!)
1184	# {... are special paths that are not being touched	2055	# {... are special paths that are not being touched
…		…
1197	$base =~ s{[^/]+/?$}{};	2068	$base =~ s{[^/]+/?$}{};
1198	$path = "$base/$path";	2069	$path = "$base/$path";
1199	}	2070	}
1200		2071
1201	for ($path) {	2072	for ($path) {
1202	redo if s{//}{/};
1203	redo if s{/\.?/}{/};	2073	redo if s{/\.?/}{/};
1204	redo if s{/[^/]+/\.\./}{/};	2074	redo if s{/[^/]+/\.\./}{/};
1205	}	2075	}
1206		2076
1207	$path	2077	$path
…		…
1221	$self->init; # pass $1 etc.	2091	$self->init; # pass $1 etc.
1222	return $self;	2092	return $self;
1223	}	2093	}
1224	}	2094	}
1225		2095
1226	Carp::carp "unable to resolve path '$path'.";	2096	Carp::cluck "unable to resolve path '$path' (base '$base')";
1227	()	2097	()
1228	}	2098	}
1229		2099
		2100	# may re-bless or do other evil things
1230	sub init {	2101	sub init {
1231	my ($self) = @_;	2102	my ($self) = @_;
1232		2103
1233	$self	2104	$self
1234	}	2105	}
…		…
1246		2117
1247	# the original (read-only) location	2118	# the original (read-only) location
1248	sub load_path {	2119	sub load_path {
1249	my ($self) = @_;	2120	my ($self) = @_;
1250		2121
1251	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	2122	"$MAPDIR/$self->{path}.map"
1252	}	2123	}
1253		2124
1254	# the temporary/swap location	2125	# the temporary/swap location
1255	sub save_path {	2126	sub save_path {
1256	my ($self) = @_;	2127	my ($self) = @_;
1257		2128
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2129	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1259	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	2130	"$TMPDIR/$path.map"
1260	}	2131	}
1261		2132
1262	# the unique path, undef == no special unique path	2133	# the unique path, undef == no special unique path
1263	sub uniq_path {	2134	sub uniq_path {
1264	my ($self) = @_;	2135	my ($self) = @_;
1265		2136
1266	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2137	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1267	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	2138	"$UNIQUEDIR/$path"
1268	}	2139	}
1269		2140
1270	# and all this just because we cannot iterate over	2141	sub decay_objects {
1271	# all maps in C++...
1272	sub change_all_map_light {
1273	my ($change) = @_;	2142	my ($self) = @_;
1274		2143
1275	$_->change_map_light ($change)	2144	return if $self->{deny_reset};
1276	for grep $_->outdoor, values %cf::MAP;	2145
		2146	$self->do_decay_objects;
1277	}	2147	}
1278		2148
1279	sub unlink_save {	2149	sub unlink_save {
1280	my ($self) = @_;	2150	my ($self) = @_;
1281		2151
…		…
1286		2156
1287	sub load_header_from($) {	2157	sub load_header_from($) {
1288	my ($self, $path) = @_;	2158	my ($self, $path) = @_;
1289		2159
1290	utf8::encode $path;	2160	utf8::encode $path;
1291	aio_open $path, O_RDONLY, 0	2161	my $f = new_from_file cf::object::thawer $path
1292	or return;	2162	or return;
1293		2163
1294	$self->_load_header ($path)	2164	$self->_load_header ($f)
1295	or return;	2165	or return;
1296		2166
		2167	local $MAP_LOADING{$self->{path}} = $self;
		2168	$f->resolve_delayed_derefs;
		2169
1297	$self->{load_path} = $path;	2170	$self->{load_path} = $path;
1298		2171
1299	1	2172	1
1300	}	2173	}
1301		2174
		2175	# used to laod the header of an original map
1302	sub load_orig {	2176	sub load_header_orig {
1303	my ($self) = @_;	2177	my ($self) = @_;
1304		2178
1305	$self->load_header_from ($self->load_path)	2179	$self->load_header_from ($self->load_path)
1306	}	2180	}
1307		2181
		2182	# used to laod the header of an instantiated map
1308	sub load_temp {	2183	sub load_header_temp {
1309	my ($self) = @_;	2184	my ($self) = @_;
1310		2185
1311	$self->load_header_from ($self->save_path)	2186	$self->load_header_from ($self->save_path)
		2187	}
		2188
		2189	# called after loading the header from an instantiated map
		2190	sub prepare_temp {
		2191	my ($self) = @_;
		2192
		2193	$self->last_access ((delete $self->{last_access})
		2194	|| $cf::RUNTIME); #d#
		2195	# safety
		2196	$self->{instantiate_time} = $cf::RUNTIME
		2197	if $self->{instantiate_time} > $cf::RUNTIME;
		2198	}
		2199
		2200	# called after loading the header from an original map
		2201	sub prepare_orig {
		2202	my ($self) = @_;
		2203
		2204	$self->{load_original} = 1;
		2205	$self->{instantiate_time} = $cf::RUNTIME;
		2206	$self->last_access ($cf::RUNTIME);
		2207	$self->instantiate;
1312	}	2208	}
1313		2209
1314	sub load_header {	2210	sub load_header {
1315	my ($self) = @_;	2211	my ($self) = @_;
1316		2212
1317	if ($self->load_temp) {	2213	if ($self->load_header_temp) {
1318	$self->last_access ((delete $self->{last_access})	2214	$self->prepare_temp;
1319	|| $cf::RUNTIME); #d#
1320	# safety
1321	$self->{instantiate_time} = $cf::RUNTIME
1322	if $self->{instantiate_time} > $cf::RUNTIME;
1323	} else {	2215	} else {
1324	$self->load_orig	2216	$self->load_header_orig
1325	or return;	2217	or return;
1326		2218	$self->prepare_orig;
1327	$self->{load_original} = 1;
1328	$self->{instantiate_time} = $cf::RUNTIME;
1329	$self->last_access ($cf::RUNTIME);
1330	$self->instantiate;
1331	}	2219	}
		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;
1332		2226
1333	1	2227	1
1334	}	2228	}
1335		2229
1336	sub find;	2230	sub find;
1337	sub find {	2231	sub find {
1338	my ($path, $origin) = @_;	2232	my ($path, $origin) = @_;
1339		2233
		2234	cf::cede_to_tick;
		2235
1340	$path = normalise $path, $origin && $origin->path;	2236	$path = normalise $path, $origin;
1341		2237
		2238	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1342	cf::lock_wait "map_find:$path";	2239	my $guard2 = cf::lock_acquire "map_find:$path";
1343		2240
1344	$cf::MAP{$path} || do {	2241	$cf::MAP{$path} || do {
1345	my $guard = cf::lock_acquire "map_find:$path";
1346	my $map = new_from_path cf::map $path	2242	my $map = new_from_path cf::map $path
1347	or return;	2243	or return;
1348		2244
1349	$map->{last_save} = $cf::RUNTIME;	2245	$map->{last_save} = $cf::RUNTIME;
1350		2246
1351	$map->load_header	2247	$map->load_header
1352	or return;	2248	or return;
1353		2249
1354	if ($map->should_reset) {	2250	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1355	# doing this can freeze the server in a sync job, obviously	2251	# doing this can freeze the server in a sync job, obviously
1356	#$cf::WAIT_FOR_TICK->wait;	2252	#$cf::WAIT_FOR_TICK->wait;
		2253	undef $guard2;
		2254	undef $guard1;
1357	$map->reset;	2255	$map->reset;
1358	undef $guard;
1359	$map = find $path	2256	return find $path;
1360	or return;
1361	}	2257	}
1362		2258
1363	$cf::MAP{$path} = $map	2259	$cf::MAP{$path} = $map
1364	}	2260	}
1365	}	2261	}
		2262
		2263	sub pre_load { }
		2264	#sub post_load { } # XS
1366		2265
1367	sub load {	2266	sub load {
1368	my ($self) = @_;	2267	my ($self) = @_;
1369		2268
		2269	local $self->{deny_reset} = 1; # loading can take a long time
		2270
1370	my $path = $self->{path};	2271	my $path = $self->{path};
		2272
		2273	{
1371	my $guard = cf::lock_acquire "map_load:$path";	2274	my $guard = cf::lock_acquire "map_data:$path";
1372		2275
1373	return if $self->in_memory != cf::MAP_SWAPPED;	2276	return unless $self->valid;
		2277	return unless $self->state == cf::MAP_SWAPPED;
1374		2278
1375	$self->in_memory (cf::MAP_LOADING);
1376
1377	$self->alloc;	2279	$self->alloc;
1378	$self->_load_objects ($self->{load_path}, 1)	2280
		2281	$self->pre_load;
		2282	cf::cede_to_tick;
		2283
		2284	if (exists $self->{load_path}) {
		2285	my $f = new_from_file cf::object::thawer $self->{load_path};
		2286	$f->skip_block;
		2287	$self->_load_objects ($f)
1379	or return;	2288	or return;
1380		2289
1381	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2290	$self->post_load_original
1382	if delete $self->{load_original};	2291	if delete $self->{load_original};
1383		2292
1384	if (my $uniq = $self->uniq_path) {	2293	if (my $uniq = $self->uniq_path) {
1385	utf8::encode $uniq;	2294	utf8::encode $uniq;
1386	if (aio_open $uniq, O_RDONLY, 0) {	2295	unless (aio_stat $uniq) {
		2296	if (my $f = new_from_file cf::object::thawer $uniq) {
1387	$self->clear_unique_items;	2297	$self->clear_unique_items;
1388	$self->_load_objects ($uniq, 0);	2298	$self->_load_objects ($f);
		2299	$f->resolve_delayed_derefs;
		2300	}
		2301	}
1389	}	2302	}
1390	}
1391		2303
1392	Coro::cede;	2304	$f->resolve_delayed_derefs;
		2305	} else {
		2306	$self->post_load_original
		2307	if delete $self->{load_original};
		2308	}
1393		2309
		2310	$self->state (cf::MAP_INACTIVE);
		2311
		2312	cf::cede_to_tick;
1394	# now do the right thing for maps	2313	# now do the right thing for maps
1395	$self->link_multipart_objects;	2314	$self->link_multipart_objects;
1396
1397	unless ($self->{deny_activate}) {
1398	$self->decay_objects;
1399	$self->fix_auto_apply;
1400	$self->update_buttons;
1401	Coro::cede;
1402	$self->set_darkness_map;
1403	$self->difficulty ($self->estimate_difficulty)	2315	$self->difficulty ($self->estimate_difficulty)
1404	unless $self->difficulty;	2316	unless $self->difficulty;
1405	Coro::cede;	2317	cf::cede_to_tick;
1406	$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);
		2329	}
		2330
		2331	$self->post_load;
		2332
1407	}	2333	1
1408
1409	$self->in_memory (cf::MAP_IN_MEMORY);
1410	}	2334	}
1411		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
1412	sub customise_for {	2339	sub customise_for {
1413	my ($self, $ob) = @_;	2340	my ($self, $ob) = @_;
1414		2341
1415	return find "~" . $ob->name . "/" . $self->{path}	2342	return find "~" . $ob->name . "/" . $self->{path}
1416	if $self->per_player;	2343	if $self->per_player;
1417		2344
		2345	# return find "?party/" . $ob->name . "/" . $self->{path}
		2346	# if $self->per_party;
		2347
1418	$self	2348	$self
1419	}
1420
1421	# find and load all maps in the 3x3 area around a map
1422	sub load_diag {
1423	my ($map) = @_;
1424
1425	my @diag; # diagonal neighbours
1426
1427	for (0 .. 3) {
1428	my $neigh = $map->tile_path ($_)
1429	or next;
1430	$neigh = find $neigh, $map
1431	or next;
1432	$neigh->load;
1433
1434	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1435	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1436	}
1437
1438	for (@diag) {
1439	my $neigh = find @$_
1440	or next;
1441	$neigh->load;
1442	}
1443	}	2349	}
1444		2350
1445	sub find_sync {	2351	sub find_sync {
1446	my ($path, $origin) = @_;	2352	my ($path, $origin) = @_;
1447		2353
1448	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
1449	}	2359	}
1450		2360
1451	sub do_load_sync {	2361	sub do_load_sync {
1452	my ($map) = @_;	2362	my ($map) = @_;
1453		2363
1454	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;
1455	}	2369	}
1456		2370
1457	our %MAP_PREFETCH;	2371	our %MAP_PREFETCH;
1458	our $MAP_PREFETCHER = undef;	2372	our $MAP_PREFETCHER = undef;
1459		2373
1460	sub find_async {	2374	sub find_async {
1461	my ($path, $origin) = @_;	2375	my ($path, $origin, $load) = @_;
1462		2376
1463	$path = normalise $path, $origin && $origin->{path};	2377	$path = normalise $path, $origin;
1464		2378
1465	if (my $map = $cf::MAP{$path}) {	2379	if (my $map = $cf::MAP{$path}) {
1466	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2380	return $map if !$load || $map->linkable;
1467	}	2381	}
1468		2382
1469	undef $MAP_PREFETCH{$path};	2383	$MAP_PREFETCH{$path} |= $load;
		2384
1470	$MAP_PREFETCHER ||= cf::async {	2385	$MAP_PREFETCHER ||= cf::async {
		2386	$Coro::current->{desc} = "map prefetcher";
		2387
1471	while (%MAP_PREFETCH) {	2388	while (%MAP_PREFETCH) {
1472	for my $path (keys %MAP_PREFETCH) {	2389	while (my ($k, $v) = each %MAP_PREFETCH) {
1473	my $map = find $path	2390	if (my $map = find $k) {
1474	or next;
1475	$map->load;	2391	$map->load if $v;
		2392	}
1476		2393
1477	delete $MAP_PREFETCH{$path};	2394	delete $MAP_PREFETCH{$k};
1478	}	2395	}
1479	}	2396	}
1480	undef $MAP_PREFETCHER;	2397	undef $MAP_PREFETCHER;
1481	};	2398	};
		2399	$MAP_PREFETCHER->prio (6);
1482		2400
1483	()	2401	()
1484	}	2402	}
1485		2403
		2404	# common code, used by both ->save and ->swapout
1486	sub save {	2405	sub _save {
1487	my ($self) = @_;	2406	my ($self) = @_;
1488
1489	my $lock = cf::lock_acquire "map_data:" . $self->path;
1490		2407
1491	$self->{last_save} = $cf::RUNTIME;	2408	$self->{last_save} = $cf::RUNTIME;
1492		2409
1493	return unless $self->dirty;	2410	return unless $self->dirty;
1494		2411
…		…
1500	return if $self->{deny_save};	2417	return if $self->{deny_save};
1501		2418
1502	local $self->{last_access} = $self->last_access;#d#	2419	local $self->{last_access} = $self->last_access;#d#
1503		2420
1504	cf::async {	2421	cf::async {
		2422	$Coro::current->{desc} = "map player save";
1505	$_->contr->save for $self->players;	2423	$_->contr->save for $self->players;
1506	};	2424	};
		2425
		2426	cf::get_slot 0.02;
1507		2427
1508	if ($uniq) {	2428	if ($uniq) {
1509	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2429	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1510	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2430	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1511	} else {	2431	} else {
1512	$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);
1513	}	2433	}
1514	}	2434	}
1515		2435
		2436	sub save {
		2437	my ($self) = @_;
		2438
		2439	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2440
		2441	$self->_save;
		2442	}
		2443
1516	sub swap_out {	2444	sub swap_out {
1517	my ($self) = @_;	2445	my ($self) = @_;
1518		2446
1519	# save first because save cedes
1520	$self->save;
1521
1522	my $lock = cf::lock_acquire "map_data:" . $self->path;	2447	my $lock = cf::lock_acquire "map_data:$self->{path}";
1523		2448
		2449	return if !$self->linkable;
		2450	return if $self->{deny_save};
1524	return if $self->players;	2451	return if $self->players;
1525	return if $self->in_memory != cf::MAP_IN_MEMORY;
1526	return if $self->{deny_save};
1527		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
1528	$self->clear;	2462	$self->clear;
1529	$self->in_memory (cf::MAP_SWAPPED);
1530	}	2463	}
1531		2464
1532	sub reset_at {	2465	sub reset_at {
1533	my ($self) = @_;	2466	my ($self) = @_;
1534		2467
1535	# TODO: safety, remove and allow resettable per-player maps	2468	# TODO: safety, remove and allow resettable per-player maps
1536	return 1e99 if $self->isa ("ext::map_per_player");#d#
1537	return 1e99 if $self->{deny_reset};	2469	return 1e99 if $self->{deny_reset};
1538		2470
1539	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2471	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1540	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;
1541		2473
…		…
1552	my ($self) = @_;	2484	my ($self) = @_;
1553		2485
1554	my $lock = cf::lock_acquire "map_data:$self->{path}";	2486	my $lock = cf::lock_acquire "map_data:$self->{path}";
1555		2487
1556	return if $self->players;	2488	return if $self->players;
1557	return if $self->isa ("ext::map_per_player");#d#
1558		2489
1559	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	}
1560		2501
1561	delete $cf::MAP{$self->path};	2502	delete $cf::MAP{$self->path};
1562		2503
1563	$self->in_memory (cf::MAP_SWAPPED);	2504	$self->deactivate;
		2505	$_->clear_links_to ($self) for values %cf::MAP;
1564	$self->clear;	2506	$self->clear;
1565
1566	$_->clear_links_to ($self) for values %cf::MAP;
1567		2507
1568	$self->unlink_save;	2508	$self->unlink_save;
1569	$self->destroy;	2509	$self->destroy;
1570	}	2510	}
1571		2511
1572	my $nuke_counter = "aaaa";	2512	my $nuke_counter = "aaaa";
1573		2513
1574	sub nuke {	2514	sub nuke {
1575	my ($self) = @_;	2515	my ($self) = @_;
1576		2516
		2517	{
		2518	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2519
1577	delete $cf::MAP{$self->path};	2520	delete $cf::MAP{$self->path};
1578		2521
1579	$self->unlink_save;	2522	$self->unlink_save;
1580		2523
1581	bless $self, "cf::map";	2524	bless $self, "cf::map::wrap";
1582	delete $self->{deny_reset};	2525	delete $self->{deny_reset};
1583	$self->{deny_save} = 1;	2526	$self->{deny_save} = 1;
1584	$self->reset_timeout (1);	2527	$self->reset_timeout (1);
1585	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2528	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1586		2529
1587	$cf::MAP{$self->path} = $self;	2530	$cf::MAP{$self->path} = $self;
		2531	}
1588		2532
1589	$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	]
1590	}	2570	}
1591		2571
1592	=item cf::map::unique_maps	2572	=item cf::map::unique_maps
1593		2573
1594	Returns an arrayref of paths of all shared maps that have	2574	Returns an arrayref of paths of all shared maps that have
1595	instantiated unique items. May block.	2575	instantiated unique items. May block.
1596		2576
1597	=cut	2577	=cut
1598		2578
1599	sub unique_maps() {	2579	sub unique_maps() {
1600	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2580	[
1601	or return;	2581	map {
1602
1603	my @paths;
1604
1605	for (@$files) {
1606	utf8::decode $_;	2582	utf8::decode $_;
1607	next if /\.pst$/;	2583	s/\.map$//; # TODO future compatibility hack
1608	next unless /^$PATH_SEP/o;	2584	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2585	? ()
		2586	: normalise $_
		2587	} @{ aio_readdir $UNIQUEDIR or [] }
		2588	]
		2589	}
1609		2590
		2591	=item cf::map::static_maps
		2592
		2593	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2594	file in the shared directory excluding F</styles> and F</editor>). May
		2595	block.
		2596
		2597	=cut
		2598
		2599	sub static_maps() {
		2600	my @dirs = "";
		2601	my @maps;
		2602
		2603	while (@dirs) {
		2604	my $dir = shift @dirs;
		2605
		2606	next if $dir eq "/styles" || $dir eq "/editor";
		2607
		2608	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2609	or return;
		2610
		2611	for (@$files) {
1610	s/\.map$//;	2612	s/\.map$// or next;
1611	push @paths, $_;	2613	utf8::decode $_;
1612	}	2614	push @maps, "$dir/$_";
		2615	}
1613		2616
1614	\@paths	2617	push @dirs, map "$dir/$_", @$dirs;
1615	}	2618	}
1616		2619
1617	package cf;	2620	\@maps
		2621	}
1618		2622
1619	=back	2623	=back
1620		2624
1621	=head3 cf::object	2625	=head3 cf::object
1622		2626
…		…
1626		2630
1627	=over 4	2631	=over 4
1628		2632
1629	=item $ob->inv_recursive	2633	=item $ob->inv_recursive
1630		2634
1631	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.
1632		2637
1633	=cut	2638	=cut
1634		2639
1635	sub inv_recursive_;	2640	sub inv_recursive_;
1636	sub inv_recursive_ {	2641	sub inv_recursive_ {
…		…
1639		2644
1640	sub inv_recursive {	2645	sub inv_recursive {
1641	inv_recursive_ inv $_[0]	2646	inv_recursive_ inv $_[0]
1642	}	2647	}
1643		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
1644	package cf;	2677	package cf;
1645		2678
1646	=back	2679	=back
1647		2680
1648	=head3 cf::object::player	2681	=head3 cf::object::player
…		…
1654	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>
1655	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
1656	dialogue with the given NPC character.	2689	dialogue with the given NPC character.
1657		2690
1658	=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	};
1659		2706
1660	# rough implementation of a future "reply" method that works	2707	# rough implementation of a future "reply" method that works
1661	# with dialog boxes.	2708	# with dialog boxes.
1662	#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
1663	sub cf::object::player::reply($$$;$) {	2710	sub cf::object::player::reply($$$;$) {
…		…
1665		2712
1666	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1667		2714
1668	if ($self->{record_replies}) {	2715	if ($self->{record_replies}) {
1669	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2717
1670	} 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 {
1671	$msg = $npc->name . " says: $msg" if $npc;	2726	$msg = $npc->name . " says: $msg" if $npc;
1672	$self->message ($msg, $flags);	2727	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2728	}
1673	}	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 (@_);
1674	}	2740	}
1675		2741
1676	=item $player_object->may ("access")	2742	=item $player_object->may ("access")
1677		2743
1678	Returns wether the given player is authorized to access resource "access"	2744	Returns wether the given player is authorized to access resource "access"
…		…
1691		2757
1692	=item $player_object->enter_link	2758	=item $player_object->enter_link
1693		2759
1694	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}>).
1695		2761
1696	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.
1697	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.
1698		2766
1699	Will never block.	2767	Will never block.
1700		2768
1701	=item $player_object->leave_link ($map, $x, $y)	2769	=item $player_object->leave_link ($map, $x, $y)
1702		2770
…		…
1710	=cut	2778	=cut
1711		2779
1712	sub link_map {	2780	sub link_map {
1713	unless ($LINK_MAP) {	2781	unless ($LINK_MAP) {
1714	$LINK_MAP = cf::map::find "{link}"	2782	$LINK_MAP = cf::map::find "{link}"
1715	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2783	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1716	$LINK_MAP->load;	2784	$LINK_MAP->load;
1717	}	2785	}
1718		2786
1719	$LINK_MAP	2787	$LINK_MAP
1720	}	2788	}
…		…
1722	sub cf::object::player::enter_link {	2790	sub cf::object::player::enter_link {
1723	my ($self) = @_;	2791	my ($self) = @_;
1724		2792
1725	$self->deactivate_recursive;	2793	$self->deactivate_recursive;
1726		2794
		2795	++$self->{_link_recursion};
		2796
1727	return if UNIVERSAL::isa $self->map, "ext::map_link";	2797	return if UNIVERSAL::isa $self->map, "ext::map_link";
1728		2798
1729	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1730	if $self->map;	2800	if $self->map && $self->map->{path} ne "{link}";
1731		2801
1732	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2802	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1733	}	2803	}
1734		2804
1735	sub cf::object::player::leave_link {	2805	sub cf::object::player::leave_link {
1736	my ($self, $map, $x, $y) = @_;	2806	my ($self, $map, $x, $y) = @_;
		2807
		2808	return unless $self->contr->active;
1737		2809
1738	my $link_pos = delete $self->{_link_pos};	2810	my $link_pos = delete $self->{_link_pos};
1739		2811
1740	unless ($map) {	2812	unless ($map) {
1741	# restore original map position	2813	# restore original map position
…		…
1752	($x, $y) = (-1, -1)	2824	($x, $y) = (-1, -1)
1753	unless (defined $x) && (defined $y);	2825	unless (defined $x) && (defined $y);
1754		2826
1755	# use -1 or undef as default coordinates, not 0, 0	2827	# use -1 or undef as default coordinates, not 0, 0
1756	($x, $y) = ($map->enter_x, $map->enter_y)	2828	($x, $y) = ($map->enter_x, $map->enter_y)
1757	if $x <=0 && $y <= 0;	2829	if $x <= 0 && $y <= 0;
1758		2830
1759	$map->load;	2831	$map->load;
1760	$map->load_diag;
1761		2832
1762	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
1763	$self->activate_recursive;	2840	$self->activate_recursive;
1764	$self->enter_map ($map, $x, $y);
1765	}
1766
1767	cf::player->attach (
1768	on_logout => sub {
1769	my ($pl) = @_;
1770
1771	# abort map switching before logout
1772	if ($pl->ob->{_link_pos}) {
1773	cf::sync_job {
1774	$pl->ob->leave_link
1775	};
1776	}
1777	},	2841	}
1778	on_login => sub {
1779	my ($pl) = @_;
1780		2842
1781	# try to abort aborted map switching on player login :)	2843	}
1782	# should happen only on crashes
1783	if ($pl->ob->{_link_pos}) {
1784	$pl->ob->enter_link;
1785	(async {
1786	# we need this sleep as the login has a concurrent enter_exit running
1787	# and this sleep increases chances of the player not ending up in scorn
1788	$pl->ob->reply (undef,
1789	"There was an internal problem at your last logout, "
1790	. "the server will try to bring you to your intended destination in a second.",
1791	cf::NDI_RED);
1792	Coro::Timer::sleep 1;
1793	$pl->ob->leave_link;
1794	})->prio (2);
1795	}
1796	},
1797	);
1798		2844
1799	=item $player_object->goto ($path, $x, $y)	2845	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1800		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
1801	=cut	2856	=cut
		2857
		2858	our $GOTOGEN;
1802		2859
1803	sub cf::object::player::goto {	2860	sub cf::object::player::goto {
1804	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;
1805		2871
1806	$self->enter_link;	2872	$self->enter_link;
1807		2873
1808	(async {	2874	(async {
1809	my $map = cf::map::find $path;	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
		2896	my $map = eval {
		2897	my $map = defined $path ? cf::map::find $path, $self->map : undef;
		2898
		2899	if ($map) {
1810	$map = $map->customise_for ($self) if $map;	2900	$map = $map->customise_for ($self);
1811		2901	$map = $check->($map, $x, $y, $self) if $check && $map;
1812	# warn "entering ", $map->path, " at ($x, $y)\n"	2902	} else {
1813	# if $map;
1814
1815	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2903	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2904	}
1816		2905
		2906	$map
		2907	};
		2908
		2909	if ($@) {
		2910	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2911	LOG llevError | logBacktrace, Carp::longmess $@;
		2912	}
		2913
		2914	if ($gen == $self->{_goto_generation}) {
		2915	delete $self->{_goto_generation};
1817	$self->leave_link ($map, $x, $y);	2916	$self->leave_link ($map, $x, $y);
		2917	}
		2918
		2919	$done->($self) if $done;
1818	})->prio (1);	2920	})->prio (1);
1819	}	2921	}
1820		2922
1821	=item $player_object->enter_exit ($exit_object)	2923	=item $player_object->enter_exit ($exit_object)
1822		2924
…		…
1842	}	2944	}
1843		2945
1844	sub prepare_random_map {	2946	sub prepare_random_map {
1845	my ($exit) = @_;	2947	my ($exit) = @_;
1846		2948
1847	my $guard = cf::lock_acquire "exit_prepare:$exit";
1848
1849	# all this does is basically replace the /! path by	2949	# all this does is basically replace the /! path by
1850	# a new random map path (?random/...) with a seed	2950	# a new random map path (?random/...) with a seed
1851	# that depends on the exit object	2951	# that depends on the exit object
1852		2952
1853	my $rmp = parse_random_map_params $exit->msg;	2953	my $rmp = parse_random_map_params $exit->msg;
1854		2954
1855	if ($exit->map) {	2955	if ($exit->map) {
1856	$rmp->{region} = $exit->map->region_name;	2956	$rmp->{region} = $exit->region->name;
1857	$rmp->{origin_map} = $exit->map->path;	2957	$rmp->{origin_map} = $exit->map->path;
1858	$rmp->{origin_x} = $exit->x;	2958	$rmp->{origin_x} = $exit->x;
1859	$rmp->{origin_y} = $exit->y;	2959	$rmp->{origin_y} = $exit->y;
		2960
		2961	$exit->map->touch;
1860	}	2962	}
1861		2963
1862	$rmp->{random_seed} ||= $exit->random_seed;	2964	$rmp->{random_seed} ||= $exit->random_seed;
1863		2965
1864	my $data = cf::to_json $rmp;	2966	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1865	my $md5 = Digest::MD5::md5_hex $data;	2967	my $md5 = Digest::MD5::md5_hex $data;
1866	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2968	my $meta = "$RANDOMDIR/$md5.meta";
1867		2969
1868	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2970	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1869	aio_write $fh, 0, (length $data), $data, 0;	2971	aio_write $fh, 0, (length $data), $data, 0;
1870	undef $fh;	2972	undef $fh;
1871	aio_rename "$meta~", $meta;	2973	aio_rename "$meta~", $meta;
1872		2974
		2975	my $slaying = "?random/$md5";
		2976
		2977	if ($exit->valid) {
1873	$exit->slaying ("?random/$md5");	2978	$exit->slaying ("?random/$md5");
1874	$exit->msg (undef);	2979	$exit->msg (undef);
		2980	}
1875	}	2981	}
1876	}	2982	}
1877		2983
1878	sub cf::object::player::enter_exit {	2984	sub cf::object::player::enter_exit {
1879	my ($self, $exit) = @_;	2985	my ($self, $exit) = @_;
…		…
1881	return unless $self->type == cf::PLAYER;	2987	return unless $self->type == cf::PLAYER;
1882		2988
1883	$self->enter_link;	2989	$self->enter_link;
1884		2990
1885	(async {	2991	(async {
1886	$self->deactivate_recursive; # just to be sure	2992	$Coro::current->{desc} = "enter_exit";
		2993
1887	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
1888	prepare_random_map $exit	3008	prepare_random_map $exit
		3009	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3010
1889	if $exit->slaying eq "/!";	3011	$map = $exit->slaying;
1890		3012
1891	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;	3013	} elsif ($slaying eq '!up') {
1892	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	3014	$map = $exit->map->tile_path (cf::TILE_UP);
		3015	$x = $exit->x;
		3016	$y = $exit->y;
1893		3017
		3018	} elsif ($slaying eq '!down') {
		3019	$map = $exit->map->tile_path (cf::TILE_DOWN);
		3020	$x = $exit->x;
		3021	$y = $exit->y;
		3022	}
		3023
		3024	$self->goto ($map, $x, $y);
		3025
		3026	# if exit is damned, update players death & WoR home-position
		3027	$self->contr->savebed ($map, $x, $y)
		3028	if $exit->flag (cf::FLAG_DAMNED);
		3029
1894	1;	3030	1
1895	}) {	3031	}) {
1896	$self->message ("Something went wrong deep within the crossfire server. "	3032	$self->message ("Something went wrong deep within the deliantra server. "
1897	. "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. "
1898	. "Please report this to the dungeon master!",	3034	. "Please report this to the dungeon master!",
1899	cf::NDI_UNIQUE | cf::NDI_RED);	3035	cf::NDI_UNIQUE | cf::NDI_RED);
1900		3036
1901	warn "ERROR in enter_exit: $@";	3037	error "ERROR in enter_exit: $@";
1902	$self->leave_link;	3038	$self->leave_link;
1903	}	3039	}
1904	})->prio (1);	3040	})->prio (1);
1905	}	3041	}
1906		3042
1907	=head3 cf::client	3043	=head3 cf::client
1908		3044
1909	=over 4	3045	=over 4
1910		3046
1911	=item $client->send_drawinfo ($text, $flags)	3047	=item $client->send_big_packet ($pkt)
1912		3048
1913	Sends a drawinfo packet to the client. Circumvents output buffering so	3049	Like C<send_packet>, but tries to compress large packets, and fragments
1914	should not be used under normal circumstances.	3050	them as required.
1915		3051
1916	=cut	3052	=cut
1917		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
1918	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($$@) {
1919	my ($self, $text, $flags) = @_;	3247	my ($self, $type, @msg) = @_;
1920		3248
1921	utf8::encode $text;	3249	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
1922	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1923	}	3250	}
1924
1925		3251
1926	=item $success = $client->query ($flags, "text", \&cb)	3252	=item $success = $client->query ($flags, "text", \&cb)
1927		3253
1928	Queues a query to the client, calling the given callback with	3254	Queues a query to the client, calling the given callback with
1929	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>,
1930	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>.
1931		3257
1932	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
1933	reliable at some point in the future.	3259	become reliable at some point in the future.
1934		3260
1935	=cut	3261	=cut
1936		3262
1937	sub cf::client::query {	3263	sub cf::client::query {
1938	my ($self, $flags, $text, $cb) = @_;	3264	my ($self, $flags, $text, $cb) = @_;
…		…
1946	utf8::encode $text;	3272	utf8::encode $text;
1947	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3273	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1948		3274
1949	$self->send_packet ($self->{query_queue}[0][0])	3275	$self->send_packet ($self->{query_queue}[0][0])
1950	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;
1951	}	3317	}
1952		3318
1953	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	},
1954	on_reply => sub {	3325	on_reply => sub {
1955	my ($ns, $msg) = @_;	3326	my ($ns, $msg) = @_;
1956		3327
1957	# this weird shuffling is so that direct followup queries	3328	# this weird shuffling is so that direct followup queries
1958	# get handled first	3329	# get handled first
1959	my $queue = delete $ns->{query_queue}	3330	my $queue = delete $ns->{query_queue}
1960	or return; # be conservative, not sure how that can happen, but we saw a crash here	3331	or return; # be conservative, not sure how that can happen, but we saw a crash here
1961		3332
1962	(shift @$queue)->[1]->($msg);	3333	(shift @$queue)->[1]->($msg);
		3334	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1963		3335
1964	push @{ $ns->{query_queue} }, @$queue;	3336	push @{ $ns->{query_queue} }, @$queue;
1965		3337
1966	if (@{ $ns->{query_queue} } == @$queue) {	3338	if (@{ $ns->{query_queue} } == @$queue) {
1967	if (@$queue) {	3339	if (@$queue) {
…		…
1969	} else {	3341	} else {
1970	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3342	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1971	}	3343	}
1972	}	3344	}
1973	},	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	},
1974	);	3379	);
1975		3380
1976	=item $client->async (\&cb)	3381	=item $client->async (\&cb)
1977		3382
1978	Create a new coroutine, running the specified callback. The coroutine will	3383	Create a new coroutine, running the specified callback. The coroutine will
…		…
1994		3399
1995	$coro	3400	$coro
1996	}	3401	}
1997		3402
1998	cf::client->attach (	3403	cf::client->attach (
1999	on_destroy => sub {	3404	on_client_destroy => sub {
2000	my ($ns) = @_;	3405	my ($ns) = @_;
2001		3406
2002	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3407	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2003	},	3408	},
2004	);	3409	);
…		…
2019	our $safe = new Safe "safe";	3424	our $safe = new Safe "safe";
2020	our $safe_hole = new Safe::Hole;	3425	our $safe_hole = new Safe::Hole;
2021		3426
2022	$SIG{FPE} = 'IGNORE';	3427	$SIG{FPE} = 'IGNORE';
2023		3428
2024	$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	));
2025		3434
2026	# here we export the classes and methods available to script code	3435	# here we export the classes and methods available to script code
2027		3436
2028	=pod	3437	=pod
2029		3438
2030	The following fucntions and emthods are available within a safe environment:	3439	The following functions and methods are available within a safe environment:
2031		3440
2032	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
2033	cf::object::player player	3446	cf::object::player
2034	cf::player peaceful	3447	player
2035	cf::map trigger	3448
		3449	cf::player
		3450	peaceful
		3451
		3452	cf::map
		3453	trigger
2036		3454
2037	=cut	3455	=cut
2038		3456
2039	for (	3457	for (
2040	["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)],
2041	["cf::object::player" => qw(player)],	3461	["cf::object::player" => qw(player)],
2042	["cf::player" => qw(peaceful)],	3462	["cf::player" => qw(peaceful send_msg)],
2043	["cf::map" => qw(trigger)],	3463	["cf::map" => qw(trigger)],
2044	) {	3464	) {
2045	no strict 'refs';
2046	my ($pkg, @funs) = @$_;	3465	my ($pkg, @funs) = @$_;
2047	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3466	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2048	for @funs;	3467	for @funs;
2049	}	3468	}
2050		3469
…		…
2065		3484
2066	my $qcode = $code;	3485	my $qcode = $code;
2067	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3486	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2068	$qcode =~ s/\n/\\n/g;	3487	$qcode =~ s/\n/\\n/g;
2069		3488
		3489	%vars = (_dummy => 0) unless %vars;
		3490
		3491	my @res;
2070	local $_;	3492	local $_;
2071	local @safe::cf::_safe_eval_args = values %vars;
2072		3493
2073	my $eval =	3494	my $eval =
2074	"do {\n"	3495	"do {\n"
2075	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3496	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2076	. "#line 0 \"{$qcode}\"\n"	3497	. "#line 0 \"{$qcode}\"\n"
2077	. $code	3498	. $code
2078	. "\n}"	3499	. "\n}"
2079	;	3500	;
2080		3501
		3502	if ($CFG{safe_eval}) {
2081	sub_generation_inc;	3503	sub_generation_inc;
		3504	local @safe::cf::_safe_eval_args = values %vars;
2082	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3505	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2083	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	}
2084		3511
2085	if ($@) {	3512	if ($@) {
2086	warn "$@";	3513	warn "$@",
2087	warn "while executing safe code '$code'\n";	3514	"while executing safe code '$code'\n",
2088	warn "with arguments " . (join " ", %vars) . "\n";	3515	"with arguments " . (join " ", %vars) . "\n";
2089	}	3516	}
2090		3517
2091	wantarray ? @res : $res[0]	3518	wantarray ? @res : $res[0]
2092	}	3519	}
2093		3520
…		…
2107	=cut	3534	=cut
2108		3535
2109	sub register_script_function {	3536	sub register_script_function {
2110	my ($fun, $cb) = @_;	3537	my ($fun, $cb) = @_;
2111		3538
2112	no strict 'refs';	3539	$fun = "safe::$fun" if $CFG{safe_eval};
2113	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3540	*$fun = $safe_hole->wrap ($cb);
2114	}	3541	}
2115		3542
2116	=back	3543	=back
2117		3544
2118	=cut	3545	=cut
2119		3546
2120	#############################################################################	3547	#############################################################################
2121		3548	# the server's init and main functions
2122	=head2 EXTENSION DATABASE SUPPORT
2123
2124	Crossfire maintains a very simple database for extension use. It can
2125	currently store anything that can be serialised using Storable, which
2126	excludes objects.
2127
2128	The parameter C<$family> should best start with the name of the extension
2129	using it, it should be unique.
2130
2131	=over 4
2132
2133	=item $hashref = cf::db_get $family
2134
2135	Return a hashref for use by the extension C<$family>, which can be
2136	modified. After modifications, you have to call C<cf::db_dirty> or
2137	C<cf::db_sync>.
2138
2139	=item $value = cf::db_get $family => $key
2140
2141	Returns a single value from the database
2142
2143	=item cf::db_put $family => $hashref
2144
2145	Stores the given family hashref into the database. Updates are delayed, if
2146	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2147
2148	=item cf::db_put $family => $key => $value
2149
2150	Stores the given C<$value> in the family hash. Updates are delayed, if you
2151	want the data to be synced to disk immediately, use C<cf::db_sync>.
2152
2153	=item cf::db_dirty
2154
2155	Marks the database as dirty, to be updated at a later time.
2156
2157	=item cf::db_sync
2158
2159	Immediately write the database to disk I<if it is dirty>.
2160
2161	=cut
2162
2163	our $DB;
2164		3549
2165	{	3550	{
2166	my $path = cf::localdir . "/database.pst";	3551	package cf::face;
2167		3552
2168	sub db_load() {	3553	our %HASH; # hash => idx
2169	$DB = stat $path ? Storable::retrieve $path : { };	3554	our @DATA; # dynamically-created facedata, only faceste 0 used
2170	}	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
2171		3559
2172	my $pid;	3560	# internal api, not finalised
		3561	sub set {
		3562	my ($name, $type, $data) = @_;
2173		3563
2174	sub db_save() {	3564	my $idx = cf::face::find $name;
2175	waitpid $pid, 0 if $pid;
2176	if (0 == ($pid = fork)) {
2177	$DB->{_meta}{version} = 1;
2178	Storable::nstore $DB, "$path~";
2179	rename "$path~", $path;
2180	cf::_exit 0 if defined $pid;
2181	}
2182	}
2183		3565
2184	my $dirty;	3566	if ($idx) {
2185		3567	delete $HASH{cf::face::get_csum $idx};
2186	sub db_sync() {
2187	db_save if $dirty;
2188	undef $dirty;
2189	}
2190
2191	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2192	db_sync;
2193	});
2194
2195	sub db_dirty() {
2196	$dirty = 1;
2197	$idle->start;
2198	}
2199
2200	sub db_get($;$) {
2201	@_ >= 2
2202	? $DB->{$_[0]}{$_[1]}
2203	: ($DB->{$_[0]} ||= { })
2204	}
2205
2206	sub db_put($$;$) {
2207	if (@_ >= 3) {
2208	$DB->{$_[0]}{$_[1]} = $_[2];
2209	} else {	3568	} else {
2210	$DB->{$_[0]} = $_[1];	3569	$idx = cf::face::alloc $name;
2211	}
2212	db_dirty;
2213	}
2214
2215	cf::global->attach (
2216	prio => 10000,
2217	on_cleanup => sub {
2218	db_sync;
2219	},	3570	}
		3571
		3572	my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
		3573
		3574	cf::face::set_type $idx, $type;
		3575	cf::face::set_csum $idx, 0, $hash;
		3576
		3577	# we need to destroy the SV itself, not just modify it, as a running ix
		3578	# might hold a reference to it: "delete" achieves that.
		3579	delete $FOFS[0][$idx];
		3580	delete $DATA[0][$idx];
		3581	$DATA[0][$idx] = $data;
		3582	$SIZE[0][$idx] = length $data;
		3583	delete $META[$idx];
		3584	$HASH{$hash} = $idx;#d#
		3585
		3586	$idx
		3587	}
		3588
		3589	sub _get_data($$$) {
		3590	my ($idx, $set, $cb) = @_;
		3591
		3592	if (defined $DATA[$set][$idx]) {
		3593	$cb->($DATA[$set][$idx]);
		3594	} elsif (my $fofs = $FOFS[$set][$idx]) {
		3595	my $size = $SIZE[$set][$idx];
		3596	my $buf;
		3597	IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
		3598	if ($_[0] == $size) {
		3599	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3600	$cb->($buf);
		3601	} else {
		3602	cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
		3603	}
		3604	};
		3605	} else {
		3606	cf::error "requested facedata for unknown face $idx#$set, ignoring.";
		3607	}
		3608	}
		3609
		3610	# rather ineffient
		3611	sub cf::face::get_data($;$) {
		3612	my ($idx, $set) = @_;
		3613
		3614	_get_data $idx, $set, Coro::rouse_cb;
		3615	Coro::rouse_wait
		3616	}
		3617
		3618	sub cf::face::ix {
		3619	my ($ns, $set, $idx, $pri) = @_;
		3620
		3621	_get_data $idx, $set, sub {
		3622	$ns->ix_send ($idx, $pri, $_[0]);
		3623	};
		3624	}
		3625	}
		3626
		3627	sub load_facedata($) {
		3628	my ($path) = @_;
		3629
		3630	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3631
		3632	trace "loading facedata from $path\n";
		3633
		3634	my $facedata = decode_storable load_file "$path/faceinfo";
		3635
		3636	$facedata->{version} == 2
		3637	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3638
		3639	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3640	or cf::cleanup "$path/facedata: $!, cannot proceed.";
		3641
		3642	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3643
		3644	# BEGIN ATOMIC
		3645	# from here on, everything must be atomic - no thread switch allowed
		3646	my $t1 = EV::time;
		3647
		3648	{
		3649	my $faces = $facedata->{faceinfo};
		3650
		3651	for my $face (sort keys %$faces) {
		3652	my $info = $faces->{$face};
		3653	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3654
		3655	cf::face::set_visibility $idx, $info->{visibility};
		3656	cf::face::set_magicmap $idx, $info->{magicmap};
		3657	cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
		3658	cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
		3659	cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
		3660	$cf::face::HASH{$info->{hash64}} = $idx;
		3661	delete $cf::face::META[$idx];
		3662	}
		3663
		3664	while (my ($face, $info) = each %$faces) {
		3665	next unless $info->{smooth};
		3666
		3667	my $idx = cf::face::find $face
		3668	or next;
		3669
		3670	if (my $smooth = cf::face::find $info->{smooth}) {
		3671	cf::face::set_smooth $idx, $smooth;
		3672	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3673	} else {
		3674	error "smooth face '$info->{smooth}' not found for face '$face'";
		3675	}
		3676	}
		3677	}
		3678
		3679	{
		3680	my $anims = $facedata->{animinfo};
		3681
		3682	while (my ($anim, $info) = each %$anims) {
		3683	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3684	}
		3685
		3686	cf::anim::invalidate_all; # d'oh
		3687	}
		3688
		3689	{
		3690	my $res = $facedata->{resource};
		3691
		3692	while (my ($name, $info) = each %$res) {
		3693	if (defined (my $type = $info->{type})) {
		3694	# TODO: different hash - must free and use new index, or cache ixface data queue
		3695	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3696
		3697	cf::face::set_type $idx, $type;
		3698	cf::face::set_csum $idx, 0, $info->{hash};
		3699	$cf::face::SIZE[0][$idx] = $info->{size};
		3700	$cf::face::FOFS[0][$idx] = $info->{fofs};
		3701	$cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3702	$cf::face::HASH{$info->{hash}} = $idx;
		3703	} else {
		3704	# $RESOURCE{$name} = $info; # unused
		3705	}
		3706	}
		3707	}
		3708
		3709	($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
		3710
		3711	# HACK to clear player env face cache, we need some signal framework
		3712	# for this (global event?)
		3713	%ext::player_env::MUSIC_FACE_CACHE = ();
		3714
		3715	# END ATOMIC
		3716
		3717	cf::debug "facedata atomic update time ", EV::time - $t1;
		3718
		3719	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3720
		3721	aio_close $fh if $fh; # close old facedata
		3722
		3723	1
		3724	}
		3725
		3726	register_exticmd fx_want => sub {
		3727	my ($ns, $want) = @_;
		3728
		3729	while (my ($k, $v) = each %$want) {
		3730	$ns->fx_want ($k, $v);
		3731	}
		3732	};
		3733
		3734	sub load_resource_file($) {
		3735	my $guard = lock_acquire "load_resource_file";
		3736
		3737	my $status = load_resource_file_ $_[0];
		3738	get_slot 0.1, 100;
		3739	cf::arch::commit_load;
		3740
		3741	$status
		3742	}
		3743
		3744	sub reload_exp_table {
		3745	_reload_exp_table;
		3746
		3747	cf::face::set
		3748	"res/exp_table" => FT_RSRC,
		3749	JSON::XS->new->utf8->canonical->encode (
		3750	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
2220	);	3751	);
2221	}	3752	}
2222		3753
2223	#############################################################################	3754	sub reload_materials {
2224	# the server's main()	3755	_reload_materials;
		3756	}
2225		3757
2226	sub cfg_load {	3758	sub reload_regions {
2227	open my $fh, "<:utf8", cf::confdir . "/config"	3759	# HACK to clear player env face cache, we need some signal framework
2228	or return;	3760	# for this (global event?)
		3761	%ext::player_env::MUSIC_FACE_CACHE = ();
2229		3762
2230	local $/;	3763	load_resource_file "$MAPDIR/regions"
2231	*CFG = YAML::Syck::Load <$fh>;	3764	or die "unable to load regions file\n";
2232		3765
		3766	for (cf::region::list) {
		3767	$_->{match} = qr/$_->{match}/
		3768	if exists $_->{match};
		3769	}
		3770	}
		3771
		3772	sub reload_facedata {
		3773	load_facedata $DATADIR
		3774	or die "unable to load facedata\n";
		3775	}
		3776
		3777	sub reload_archetypes {
		3778	load_resource_file "$DATADIR/archetypes"
		3779	or die "unable to load archetypes\n";
		3780
		3781	cf::face::set
		3782	"res/skill_info" => FT_RSRC,
		3783	JSON::XS->new->utf8->canonical->encode (
		3784	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3785	);
		3786
		3787	cf::face::set
		3788	"res/spell_paths" => FT_RSRC,
		3789	JSON::XS->new->utf8->canonical->encode (
		3790	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3791	);
		3792
		3793	# command completion
		3794	my @commands;
		3795
		3796	for (0..cf::arch::skillvec_size - 1) {
		3797	my $skill = cf::arch::skillvec $_;
		3798	my $name = $skill->name;
		3799	my $flags = cf::skill_flags $skill->subtype;
		3800
		3801	push @commands, "ready_skill $name" if $flags & (SF_COMBAT | SF_RANGED | SF_GRACE);
		3802	push @commands, "use_skill $name" if $flags & (SF_USE | SF_AUTARK | SF_GRACE);
		3803	}
		3804
		3805	cf::client::set_command_face skill => \@commands;
		3806	}
		3807
		3808	sub reload_treasures {
		3809	load_resource_file "$DATADIR/treasures"
		3810	or die "unable to load treasurelists\n";
		3811	}
		3812
		3813	sub reload_sound {
		3814	trace "loading sound config from $DATADIR/sound\n";
		3815
		3816	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3817
		3818	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3819	my $sound = $soundconf->{compat}[$_]
		3820	or next;
		3821
		3822	my $face = cf::face::find "sound/$sound->[1]";
		3823	cf::sound::set $sound->[0] => $face;
		3824	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3825	}
		3826
		3827	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3828	my $face = cf::face::find "sound/$v";
		3829	cf::sound::set $k => $face;
		3830	}
		3831	}
		3832
		3833	sub reload_resources {
		3834	trace "reloading resource files...\n";
		3835
		3836	reload_materials;
		3837	reload_facedata;
		3838	reload_exp_table;
		3839	reload_sound;
		3840	reload_archetypes;
		3841	reload_regions;
		3842	reload_treasures;
		3843
		3844	trace "finished reloading resource files\n";
		3845	}
		3846
		3847	sub reload_config {
		3848	trace "reloading config file...\n";
		3849
		3850	my $config = load_file "$CONFDIR/config";
		3851	utf8::decode $config;
		3852	*CFG = decode_yaml $config;
		3853
2233	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3854	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2234		3855
2235	$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};
2236	$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};
2237		3858
2238	if (exists $CFG{mlockall}) {	3859	if (exists $CFG{mlockall}) {
…		…
2242	};	3863	};
2243	warn $@ if $@;	3864	warn $@ if $@;
2244	}	3865	}
2245	}	3866	}
2246		3867
		3868	sub pidfile() {
		3869	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3870	or die "$PIDFILE: $!";
		3871	flock $fh, &Fcntl::LOCK_EX
		3872	or die "$PIDFILE: flock: $!";
		3873	$fh
		3874	}
		3875
		3876	# make sure only one server instance is running at any one time
		3877	sub atomic {
		3878	my $fh = pidfile;
		3879
		3880	my $pid = <$fh>;
		3881	kill 9, $pid if $pid > 0;
		3882
		3883	seek $fh, 0, 0;
		3884	print $fh $$;
		3885	}
		3886
		3887	sub main_loop {
		3888	trace "EV::loop starting\n";
		3889	if (1) {
		3890	EV::loop;
		3891	}
		3892	trace "EV::loop returned\n";
		3893	goto &main_loop unless $REALLY_UNLOOP;
		3894	}
		3895
2247	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
2248	# we must not ever block the main coroutine	3906	# we must not ever block the main coroutine
2249	local $Coro::idle = sub {	3907	$Coro::idle = sub {
2250	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#
2251	(async {	3909	(async {
2252	Event::one_event;	3910	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3911	EV::loop EV::LOOP_ONESHOT;
2253	})->prio (Coro::PRIO_MAX);	3912	})->prio (Coro::PRIO_MAX);
2254	};	3913	};
2255		3914
2256	cfg_load;	3915	evthread_start IO::AIO::poll_fileno;
2257	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
2258	load_extensions;	3939	load_extensions;
2259		3940
2260	$TICK_WATCHER->start;	3941	utime time, time, $RUNTIMEFILE;
2261	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;
2262	}	3958	}
2263		3959
2264	#############################################################################	3960	#############################################################################
2265	# initialisation and cleanup	3961	# initialisation and cleanup
2266		3962
2267	# install some emergency cleanup handlers	3963	# install some emergency cleanup handlers
2268	BEGIN {	3964	BEGIN {
		3965	our %SIGWATCHER = ();
2269	for my $signal (qw(INT HUP TERM)) {	3966	for my $signal (qw(INT HUP TERM)) {
2270	Event->signal (	3967	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2271	data => WF_AUTOCANCEL,
2272	signal => $signal,
2273	cb => sub {
2274	cf::cleanup "SIG$signal";	3968	cf::cleanup "SIG$signal";
2275	},
2276	);	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
2277	}	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 };
2278	}	4059	}
2279		4060
2280	sub emergency_save() {	4061	sub emergency_save() {
2281	my $freeze_guard = cf::freeze_mainloop;	4062	my $freeze_guard = cf::freeze_mainloop;
2282		4063
2283	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;
2284		4070
2285	cf::sync_job {	4071	cf::sync_job {
		4072	cf::write_runtime_sync; # external watchdog should not bark
		4073
2286	# use a peculiar iteration method to avoid tripping on perl	4074	# use a peculiar iteration method to avoid tripping on perl
2287	# refcount bugs in for. also avoids problems with players	4075	# refcount bugs in for. also avoids problems with players
2288	# and maps saved/destroyed asynchronously.	4076	# and maps saved/destroyed asynchronously.
2289	warn "begin emergency player save\n";	4077	info "emergency_perl_save: begin player save\n";
2290	for my $login (keys %cf::PLAYER) {	4078	for my $login (keys %cf::PLAYER) {
2291	my $pl = $cf::PLAYER{$login} or next;	4079	my $pl = $cf::PLAYER{$login} or next;
2292	$pl->valid or next;	4080	$pl->valid or next;
		4081	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2293	$pl->save;	4082	$pl->save;
2294	}	4083	}
2295	warn "end emergency player save\n";	4084	info "emergency_perl_save: end player save\n";
2296		4085
2297	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";
2298	for my $path (keys %cf::MAP) {	4089	for my $path (keys %cf::MAP) {
2299	my $map = $cf::MAP{$path} or next;	4090	my $map = $cf::MAP{$path} or next;
2300	$map->valid or next;	4091	$map->valid or next;
2301	$map->save;	4092	$map->save;
2302	}	4093	}
2303	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
2304	};	4124	};
2305		4125
2306	warn "leave emergency perl save\n";	4126	info "emergency_perl_save: leave\n";
2307	}	4127	}
2308		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
2309	sub reload() {	4166	sub do_reload_perl() {
2310	# can/must only be called in main	4167	# can/must only be called in main
2311	if ($Coro::current != $Coro::main) {	4168	unless (in_main) {
2312	warn "can only reload from main coroutine";	4169	error "can only reload from main coroutine";
2313	return;	4170	return;
2314	}	4171	}
2315		4172
2316	warn "reloading...";	4173	return if $RELOAD++;
2317		4174
2318	warn "cancelling server ticker";	4175	my $t1 = AE::time;
2319	$TICK_WATCHER->cancel;
2320		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 {
2321	cf::emergency_save;	4184	#cf::emergency_save;
2322		4185
2323	eval {
2324	# if anything goes wrong in here, we should simply crash as we already saved
2325
2326	warn "syncing database to disk";
2327	cf::db_sync;
2328
2329	warn "cancelling all WF_AUTOCANCEL watchers";
2330	for (Event::all_watchers) {
2331	$_->cancel if $_->data & WF_AUTOCANCEL;
2332	}
2333
2334	warn "flushing outstanding aio requests";
2335	for (;;) {
2336	IO::AIO::flush;
2337	Coro::cede;
2338	last unless IO::AIO::nreqs;
2339	warn "iterate...";
2340	}
2341
2342	warn "cancelling all extension coros";	4186	trace "perl_reload: cancelling all extension coros";
2343	$_->cancel for values %EXT_CORO;	4187	$_->cancel for values %EXT_CORO;
2344	%EXT_CORO = ();	4188	%EXT_CORO = ();
2345		4189
2346	warn "removing commands";	4190	trace "perl_reload: removing commands";
2347	%COMMAND = ();	4191	%COMMAND = ();
2348		4192
2349	warn "removing ext commands";	4193	trace "perl_reload: removing ext/exti commands";
2350	%EXTCMD = ();	4194	%EXTCMD = ();
		4195	%EXTICMD = ();
2351		4196
2352	warn "unloading/nuking all extensions";	4197	trace "perl_reload: unloading/nuking all extensions";
2353	for my $pkg (@EXTS) {	4198	for my $pkg (@EXTS) {
2354	warn "... unloading $pkg";	4199	trace "... unloading $pkg";
2355		4200
2356	if (my $cb = $pkg->can ("unload")) {	4201	if (my $cb = $pkg->can ("unload")) {
2357	eval {	4202	eval {
2358	$cb->($pkg);	4203	$cb->($pkg);
2359	1	4204	1
2360	} 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;
2361	}	4210	}
2362		4211
2363	warn "... nuking $pkg";
2364	Symbol::delete_package $pkg;
2365	}
2366
2367	warn "unloading all perl modules loaded from $LIBDIR";	4212	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2368	while (my ($k, $v) = each %INC) {	4213	while (my ($k, $v) = each %INC) {
2369	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4214	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2370		4215
2371	warn "... unloading $k";	4216	trace "... unloading $k";
2372	delete $INC{$k};	4217	delete $INC{$k};
2373		4218
2374	$k =~ s/\.pm$//;	4219	$k =~ s/\.pm$//;
2375	$k =~ s/\//::/g;	4220	$k =~ s/\//::/g;
2376		4221
2377	if (my $cb = $k->can ("unload_module")) {	4222	if (my $cb = $k->can ("unload_module")) {
2378	$cb->();	4223	$cb->();
		4224	}
		4225
		4226	clear_package $k;
2379	}	4227	}
2380		4228
2381	Symbol::delete_package $k;
2382	}
2383
2384	warn "getting rid of safe::, as good as possible";	4229	trace "perl_reload: getting rid of safe::, as good as possible";
2385	Symbol::delete_package "safe::$_"	4230	clear_package "safe::$_"
2386	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);
2387		4232
2388	warn "unloading cf.pm \"a bit\"";	4233	trace "perl_reload: unloading cf.pm \"a bit\"";
2389	delete $INC{"cf.pm"};	4234	delete $INC{"cf.pm"};
		4235	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2390		4236
2391	# don't, removes xs symbols, too,	4237	# don't, removes xs symbols, too,
2392	# and global variables created in xs	4238	# and global variables created in xs
2393	#Symbol::delete_package __PACKAGE__;	4239	#clear_package __PACKAGE__;
2394		4240
2395	warn "unload completed, starting to reload now";	4241	info "perl_reload: unload completed, starting to reload now";
2396		4242
2397	warn "reloading cf.pm";	4243	trace "perl_reload: reloading cf.pm";
2398	require cf;	4244	require cf;
2399	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4245	cf::_connect_to_perl_1;
2400		4246
2401	warn "loading config and database again";	4247	trace "perl_reload: loading config and database again";
2402	cf::cfg_load;	4248	cf::reload_config;
2403	cf::db_load;
2404		4249
2405	warn "loading extensions";	4250	trace "perl_reload: loading extensions";
2406	cf::load_extensions;	4251	cf::load_extensions;
2407		4252
		4253	if ($REATTACH_ON_RELOAD) {
2408	warn "reattaching attachments to objects/players";	4254	trace "perl_reload: reattaching attachments to objects/players";
2409	_global_reattach;	4255	_global_reattach; # objects, sockets
2410	warn "reattaching attachments to maps";	4256	trace "perl_reload: reattaching attachments to maps";
2411	reattach $_ for values %MAP;	4257	reattach $_ for values %MAP;
		4258	trace "perl_reload: reattaching attachments to players";
		4259	reattach $_ for values %PLAYER;
		4260	}
2412		4261
2413	warn "restarting server ticker";	4262	cf::_post_init 1;
2414		4263
2415	$TICK_WATCHER->start;	4264	trace "perl_reload: leaving sync_job";
		4265
		4266	1
		4267	} or do {
		4268	error $@;
		4269	cf::cleanup "perl_reload: error, exiting.";
		4270	};
		4271
		4272	--$RELOAD;
		4273	}
		4274
		4275	$t1 = AE::time - $t1;
		4276	info "perl_reload: completed in ${t1}s\n";
		4277	};
		4278
		4279	our $RELOAD_WATCHER; # used only during reload
		4280
		4281	sub reload_perl() {
		4282	# doing reload synchronously and two reloads happen back-to-back,
		4283	# coro crashes during coro_state_free->destroy here.
		4284
		4285	$RELOAD_WATCHER ||= cf::async {
		4286	Coro::AIO::aio_wait cache_extensions;
		4287
		4288	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4289	do_reload_perl;
		4290	undef $RELOAD_WATCHER;
		4291	};
2416	};	4292	};
2417		4293	}
2418	if ($@) {
2419	warn $@;
2420	warn "error while reloading, exiting.";
2421	exit 1;
2422	}
2423
2424	warn "reloaded";
2425	};
2426
2427	our $RELOAD_WATCHER; # used only during reload
2428		4294
2429	register_command "reload" => sub {	4295	register_command "reload" => sub {
2430	my ($who, $arg) = @_;	4296	my ($who, $arg) = @_;
2431		4297
2432	if ($who->flag (FLAG_WIZ)) {	4298	if ($who->flag (FLAG_WIZ)) {
2433	$who->message ("reloading server.");	4299	$who->message ("reloading server.");
2434		4300	async {
2435	# doing reload synchronously and two reloads happen back-to-back,	4301	$Coro::current->{desc} = "perl_reload";
2436	# coro crashes during coro_state_free->destroy here.
2437
2438	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2439	reload;	4302	reload_perl;
2440	undef $RELOAD_WATCHER;
2441	});	4303	};
2442	}	4304	}
2443	};	4305	};
2444		4306
2445	unshift @INC, $LIBDIR;	4307	#############################################################################
2446		4308
2447	my $bug_warning = 0;	4309	my $bug_warning = 0;
2448		4310
2449	$TICK_WATCHER = Event->timer (	4311	sub wait_for_tick() {
2450	reentrant => 0,	4312	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2451	parked => 1,	4313
2452	prio => 0,	4314	$WAIT_FOR_TICK->wait;
2453	at => $NEXT_TICK || $TICK,	4315	}
2454	data => WF_AUTOCANCEL,	4316
2455	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 {
2456	if ($Coro::current != $Coro::main) {	4326	if ($Coro::current != $Coro::main) {
2457	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"
2458	unless ++$bug_warning > 10;	4328	unless ++$bug_warning > 10;
2459	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: $!";
2460	}	4342	};
		4343	}
2461		4344
2462	$NOW = Event::time;	4345	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2463		4346	$sig->send;
2464	cf::server_tick; # one server iteration	4347	}
2465	$RUNTIME += $TICK;
2466	$NEXT_TICK += $TICK;
2467
2468	$WAIT_FOR_TICK->broadcast;	4348	$WAIT_FOR_TICK->broadcast;
2469	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2470		4349
2471	# if we are delayed by four ticks or more, skip them all	4350	$LOAD = ($NOW - $TICK_START) / $TICK;
2472	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4351	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2473		4352
2474	$TICK_WATCHER->at ($NEXT_TICK);	4353	if (0) {
2475	$TICK_WATCHER->start;	4354	if ($NEXT_TICK) {
		4355	my $jitter = $TICK_START - $NEXT_TICK;
		4356	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4357	debug "jitter $JITTER\n";#d#
		4358	}
2476	},	4359	}
2477	);	4360	}
2478		4361
		4362	{
		4363	# configure BDB
		4364	info "initialising database";
		4365
		4366	BDB::min_parallel 16;
		4367	BDB::max_poll_reqs $TICK * 0.1;
		4368	#$AnyEvent::BDB::WATCHER->priority (1);
		4369
		4370	unless ($DB_ENV) {
		4371	$DB_ENV = BDB::db_env_create;
		4372	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4373	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4374	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4375	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4376	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4377
		4378	cf::sync_job {
		4379	eval {
		4380	BDB::db_env_open
		4381	$DB_ENV,
		4382	$BDBDIR,
		4383	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4384	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4385	0666;
		4386
		4387	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4388	};
		4389
		4390	cf::cleanup "db_env_open(db): $@" if $@;
		4391	};
		4392	}
		4393
		4394	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4395	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4396	};
		4397	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4398	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4399	};
		4400	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4401	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4402	};
		4403
		4404	info "database initialised";
		4405	}
		4406
		4407	{
		4408	# configure IO::AIO
		4409
		4410	info "initialising aio";
		4411	IO::AIO::min_parallel 8;
2479	IO::AIO::max_poll_time $TICK * 0.2;	4412	IO::AIO::max_poll_time $TICK * 0.1;
		4413	undef $AnyEvent::AIO::WATCHER;
		4414	info "aio initialised";
		4415	}
2480		4416
2481	$AIO_POLL_WATCHER = Event->io (	4417	our $_log_backtrace;
2482	fd => IO::AIO::poll_fileno,	4418	our $_log_backtrace_last;
2483	poll => 'r',
2484	prio => 5,
2485	data => WF_AUTOCANCEL,
2486	cb => \&IO::AIO::poll_cb,
2487	);
2488		4419
2489	$WRITE_RUNTIME_WATCHER = Event->timer (	4420	sub _log_backtrace {
2490	data => WF_AUTOCANCEL,	4421	my ($msg, @addr) = @_;
2491	after => 1,	4422
2492	interval => 10,	4423	$msg =~ s/\n$//;
2493	prio => 6, # keep it lowest so it acts like a watchdog	4424
2494	cb => Coro::unblock_sub {	4425	if ($_log_backtrace_last eq $msg) {
2495	write_runtime	4426	LOG llevInfo, "[ABT] $msg\n";
2496	or warn "ERROR: unable to write runtime file: $!";	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";
2497	},	4461	}
2498	);	4462	}
		4463
		4464	# load additional modules
		4465	require "cf/$_.pm" for @EXTRA_MODULES;
		4466	cf::_connect_to_perl_2;
2499		4467
2500	END { cf::emergency_save }	4468	END { cf::emergency_save }
2501		4469
2502	1	4470	1
2503		4471

Diff Legend

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