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.172 by root, Sun Jan 14 13:32:48 2007 UTC vs.
Revision 1.609 by root, Tue Nov 20 14:30:22 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.3 ();	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	my $avail = cf::till_tick;
		603
		604	for (0 .. $#SLOT_QUEUE) {
		605	if ($SLOT_QUEUE[$_][0] <= $avail) {
		606	$busy = 0;
		607	my $job = splice @SLOT_QUEUE, $_, 1, ();
		608	$job->[2]->send;
		609	Coro::cede;
		610	goto next_job;
		611	} else {
		612	$SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
		613	}
		614	}
		615
		616	if (@SLOT_QUEUE) {
		617	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		618	$WAIT_FOR_TICK->wait;
		619	} else {
		620	$busy = 0;
		621	Coro::schedule;
		622	}
267	};	623	}
268	$WRITE_RUNTIME_WATCHER->stop;	624	};
269	$TICK_WATCHER->stop;	625
270	$guard	626	sub get_slot($;$$) {
		627	return if tick_inhibit || $Coro::current == $Coro::main;
		628
		629	my ($time, $pri, $name) = @_;
		630
		631	$time = clamp $time, 0.01, $TICK * .6;
		632
		633	my $sig = new Coro::Signal;
		634
		635	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		636	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		637	$SLOT_QUEUE->ready;
		638	$sig->wait;
271	}	639	}
272		640
273	=item cf::async { BLOCK }	641	=item cf::async { BLOCK }
274		642
275	Currently the same as Coro::async_pool, meaning you cannot use	643	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		648
281	BEGIN { *async = \&Coro::async_pool }	649	BEGIN { *async = \&Coro::async_pool }
282		650
283	=item cf::sync_job { BLOCK }	651	=item cf::sync_job { BLOCK }
284		652
285	The design of crossfire+ requires that the main coro ($Coro::main) is	653	The design of Deliantra requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	654	is always able to handle events or runnable, as Deliantra is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	655	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		656	acceptable.
288		657
289	If it must be done, put the blocking parts into C<sync_job>. This will run	658	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	659	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	660	server will be frozen during this time, so the block should either finish
292	fast or be very important.	661	fast or be very important.
…		…
294	=cut	663	=cut
295		664
296	sub sync_job(&) {	665	sub sync_job(&) {
297	my ($job) = @_;	666	my ($job) = @_;
298		667
299	if ($Coro::current == $Coro::main) {	668	if (in_main) {
		669	my $time = AE::time;
		670
300	# this is the main coro, too bad, we have to block	671	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	672	# till the operation succeeds, freezing the server :/
302		673
303	# TODO: use suspend/resume instead	674	#LOG llevError, Carp::longmess "sync job";#d#
304	# (but this is cancel-safe)	675
305	my $freeze_guard = freeze_mainloop;	676	my $freeze_guard = freeze_mainloop;
306		677
307	my $busy = 1;	678	my $busy = 1;
308	my @res;	679	my @res;
309		680
310	(async {	681	(async {
		682	$Coro::current->desc ("sync job coro");
311	@res = eval { $job->() };	683	@res = eval { $job->() };
312	warn $@ if $@;	684	error $@ if $@;
313	undef $busy;	685	undef $busy;
314	})->prio (Coro::PRIO_MAX);	686	})->prio (Coro::PRIO_MAX);
315		687
316	while ($busy) {	688	while ($busy) {
317	Coro::cede or Event::one_event;	689	if (Coro::nready) {
		690	Coro::cede_notself;
		691	} else {
		692	EV::loop EV::LOOP_ONESHOT;
318	}	693	}
		694	}
		695
		696	my $time = AE::time - $time;
		697
		698	$TICK_START += $time; # do not account sync jobs to server load
319		699
320	wantarray ? @res : $res[0]	700	wantarray ? @res : $res[0]
321	} else {	701	} else {
322	# we are in another coroutine, how wonderful, everything just works	702	# we are in another coroutine, how wonderful, everything just works
323		703
…		…
343	$EXT_CORO{$coro+0} = $coro;	723	$EXT_CORO{$coro+0} = $coro;
344		724
345	$coro	725	$coro
346	}	726	}
347		727
348	sub write_runtime {	728	=item fork_call { }, @args
349	my $runtime = cf::localdir . "/runtime";
350		729
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	730	Executes the given code block with the given arguments in a seperate
352	or return;	731	process, returning the results. Everything must be serialisable with
		732	Coro::Storable. May, of course, block. Note that the executed sub may
		733	never block itself or use any form of event handling.
353		734
354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	735	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		736
358	aio_fsync $fh	737	sub post_fork {
359	and return;	738	reset_signals;
		739	}
360		740
361	close $fh	741	sub fork_call(&@) {
362	or return;	742	my ($cb, @args) = @_;
363		743
364	aio_rename "$runtime~", $runtime	744	my @res = Coro::Util::fork_eval {
365	and return;	745	cf::post_fork;
		746	&$cb
		747	} @args;
366		748
		749	wantarray ? @res : $res[-1]
		750	}
		751
		752	sub objinfo {
367	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 });
368	}	927	}
369		928
370	=back	929	=back
371		930
372	=cut	931	=cut
373		932
374	#############################################################################	933	#############################################################################
375		934
376	=head2 ATTACHABLE OBJECTS	935	=head2 ATTACHABLE OBJECTS
377		936
378	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
379	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")
380	to it. All such attachable objects support the following methods.	939	to it. All such attachable objects support the following methods.
381		940
382	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>
383	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
384	crossfire+).	943	Deliantra).
385		944
386	=over 4	945	=over 4
387		946
388	=item $attachable->attach ($attachment, key => $value...)	947	=item $attachable->attach ($attachment, key => $value...)
389		948
…		…
433	=item cf::CLASS::attachment $name, ...	992	=item cf::CLASS::attachment $name, ...
434		993
435	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
436	given CLASS can refer to this attachment.	995	given CLASS can refer to this attachment.
437		996
438	Some classes such as crossfire maps and objects can specify attachments	997	Some classes such as deliantra maps and objects can specify attachments
439	that are attached at load/instantiate time, thus the need for a name.	998	that are attached at load/instantiate time, thus the need for a name.
440		999
441	These calls expect any number of the following handler/hook descriptions:	1000	These calls expect any number of the following handler/hook descriptions:
442		1001
443	=over 4	1002	=over 4
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	1111	$registry = $CB_TYPE[$object_type] ||= [];
553		1112
554	} elsif ($type eq "subtype") {	1113	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	1114	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	1115	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1116	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		1117
559	} elsif ($type eq "package") {	1118	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	1119	my $pkg = shift @arg;
561		1120
562	while (my ($name, $id) = each %cb_id) {	1121	while (my ($name, $id) = each %cb_id) {
…		…
567		1126
568	} elsif (exists $cb_id{$type}) {	1127	} elsif (exists $cb_id{$type}) {
569	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1128	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
570		1129
571	} elsif (ref $type) {	1130	} elsif (ref $type) {
572	warn "attaching objects not supported, ignoring.\n";	1131	error "attaching objects not supported, ignoring.\n";
573		1132
574	} else {	1133	} else {
575	shift @arg;	1134	shift @arg;
576	warn "attach argument '$type' not supported, ignoring.\n";	1135	error "attach argument '$type' not supported, ignoring.\n";
577	}	1136	}
578	}	1137	}
579	}	1138	}
580		1139
581	sub _object_attach {	1140	sub _object_attach {
…		…
591	_attach $registry, $klass, @attach;	1150	_attach $registry, $klass, @attach;
592	}	1151	}
593		1152
594	$obj->{$name} = \%arg;	1153	$obj->{$name} = \%arg;
595	} else {	1154	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	1155	info "object uses attachment '$name' which is not available, postponing.\n";
597	}	1156	}
598		1157
599	$obj->{_attachment}{$name} = undef;	1158	$obj->{_attachment}{$name} = undef;
600	}	1159	}
601		1160
…		…
603	if (ref $_[0]) {	1162	if (ref $_[0]) {
604	_object_attach @_;	1163	_object_attach @_;
605	} else {	1164	} else {
606	_attach shift->_attach_registry, @_;	1165	_attach shift->_attach_registry, @_;
607	}	1166	}
		1167	_recalc_want;
608	};	1168	};
609		1169
610	# all those should be optimised	1170	# all those should be optimised
611	sub cf::attachable::detach {	1171	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	1172	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	1175	delete $obj->{_attachment}{$name};
616	reattach ($obj);	1176	reattach ($obj);
617	} else {	1177	} else {
618	Carp::croak "cannot, currently, detach class attachments";	1178	Carp::croak "cannot, currently, detach class attachments";
619	}	1179	}
		1180	_recalc_want;
620	};	1181	};
621		1182
622	sub cf::attachable::attached {	1183	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	1184	my ($obj, $name) = @_;
624		1185
…		…
639	";	1200	";
640	die if $@;	1201	die if $@;
641	}	1202	}
642		1203
643	our $override;	1204	our $override;
644	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?
645		1206
646	sub override {	1207	sub override {
647	$override = 1;	1208	$override = 1;
648	@invoke_results = ();	1209	@INVOKE_RESULTS = (@_);
649	}	1210	}
650		1211
651	sub do_invoke {	1212	sub do_invoke {
652	my $event = shift;	1213	my $event = shift;
653	my $callbacks = shift;	1214	my $callbacks = shift;
654		1215
655	@invoke_results = ();	1216	@INVOKE_RESULTS = ();
656		1217
657	local $override;	1218	local $override;
658		1219
659	for (@$callbacks) {	1220	for (@$callbacks) {
660	eval { &{$_->[1]} };	1221	eval { &{$_->[1]} };
661		1222
662	if ($@) {	1223	if ($@) {
663	warn "$@";
664	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1224	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
665	override;	1225	override;
666	}	1226	}
667		1227
668	return 1 if $override;	1228	return 1 if $override;
669	}	1229	}
670		1230
671	0	1231	0
672	}	1232	}
673		1233
674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
675		1235
676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1236	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
677		1237
678	Generate an object-specific event with the given arguments.	1238	Generate an object-specific event with the given arguments.
679		1239
680	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
681	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
682	results (if you must, access C<@cf::invoke_results> directly).	1242	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		1243
684	=back	1244	=back
685		1245
686	=cut	1246	=cut
687		1247
688	#############################################################################	1248	#############################################################################
689	# 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	}
690		1292
691	sub reattach {	1293	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	1294	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	1295	my ($obj) = @_;
694		1296
		1297	# no longer needed after getting rid of delete_package?
695	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
696		1299
697	my $registry = $obj->registry;	1300	my $registry = $obj->registry;
698		1301
699	@$registry = ();	1302	@$registry = ();
700		1303
…		…
705	for (@$attach) {	1308	for (@$attach) {
706	my ($klass, @attach) = @$_;	1309	my ($klass, @attach) = @$_;
707	_attach $registry, $klass, @attach;	1310	_attach $registry, $klass, @attach;
708	}	1311	}
709	} else {	1312	} else {
710	warn "object uses attachment '$name' that is not available, postponing.\n";	1313	info "object uses attachment '$name' that is not available, postponing.\n";
711	}	1314	}
712	}	1315	}
713	}	1316	}
714		1317
715	cf::attachable->attach (	1318	cf::attachable->attach (
716	prio => -1000000,	1319	prio => -1000000,
717	on_instantiate => sub {	1320	on_instantiate => sub {
718	my ($obj, $data) = @_;	1321	my ($obj, $data) = @_;
719		1322
720	$data = from_json $data;	1323	$data = decode_json $data;
721		1324
722	for (@$data) {	1325	for (@$data) {
723	my ($name, $args) = @$_;	1326	my ($name, $args) = @$_;
724		1327
725	$obj->attach ($name, %{$args || {} });	1328	$obj->attach ($name, %{$args || {} });
…		…
741	sub object_freezer_save {	1344	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1345	my ($filename, $rdata, $objs) = @_;
743		1346
744	sync_job {	1347	sync_job {
745	if (length $$rdata) {	1348	if (length $$rdata) {
		1349	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1350	trace sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1351	$decname, length $$rdata, scalar @$objs
		1352	if $VERBOSE_IO;
748		1353
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1354	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1355	aio_chmod $fh, SAVE_MODE;
751	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;
752	aio_fsync $fh;	1359	aio_fsync $fh;
		1360	}
753	close $fh;	1361	aio_close $fh;
754		1362
755	if (@$objs) {	1363	if (@$objs) {
756	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) {
757	chmod SAVE_MODE, $fh;	1365	aio_chmod $fh, SAVE_MODE;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1366	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
759	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;
760	aio_fsync $fh;	1370	aio_fsync $fh;
		1371	}
761	close $fh;	1372	aio_close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1373	aio_rename "$filename.pst~", "$filename.pst";
763	}	1374	}
764	} else {	1375	} else {
765	aio_unlink "$filename.pst";	1376	aio_unlink "$filename.pst";
766	}	1377	}
767		1378
768	aio_rename "$filename~", $filename;	1379	aio_rename "$filename~", $filename;
		1380
		1381	$filename =~ s%/[^/]+$%%;
		1382	aio_pathsync $filename if $cf::USE_FSYNC;
769	} else {	1383	} else {
770	warn "FATAL: $filename~: $!\n";	1384	error "unable to save objects: $filename~: $!\n";
771	}	1385	}
772	} else {	1386	} else {
773	aio_unlink $filename;	1387	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1388	aio_unlink "$filename.pst";
775	}	1389	}
776	}	1390	};
777	}	1391	}
778		1392
779	sub object_freezer_as_string {	1393	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1394	my ($rdata, $objs) = @_;
781		1395
…		…
793	or return;	1407	or return;
794		1408
795	unless (aio_stat "$filename.pst") {	1409	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1410	(aio_load "$filename.pst", $av) >= 0
797	or return;	1411	or return;
		1412
798	$av = eval { (Storable::thaw $av)->{objs} };	1413	my $st = eval { Coro::Storable::thaw $av };
		1414	$av = $st->{objs};
799	}	1415	}
800		1416
		1417	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1418	trace sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1419	$decname, length $data, scalar @{$av || []}
		1420	if $VERBOSE_IO;
		1421
803	return ($data, $av);	1422	($data, $av)
804	}	1423	}
		1424
		1425	=head2 COMMAND CALLBACKS
		1426
		1427	=over 4
		1428
		1429	=cut
805		1430
806	#############################################################################	1431	#############################################################################
807	# command handling &c	1432	# command handling &c
808		1433
809	=item cf::register_command $name => \&callback($ob,$args);	1434	=item cf::register_command $name => \&callback($ob,$args)
810		1435
811	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
812	$name.	1437	$name.
813		1438
814	=cut	1439	=cut
…		…
820	#warn "registering command '$name/$time' to '$caller'";	1445	#warn "registering command '$name/$time' to '$caller'";
821		1446
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1447	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1448	}
824		1449
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1450	=item cf::register_extcmd $name => \&callback($pl,@args)
826		1451
827	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.
828		1457
829	If the callback returns something, it is sent back as if reply was being	1458	The values will be sent back to the client.
830	called.
831		1459
832	=cut	1460	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
833		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
834	sub register_extcmd {	1482	sub register_extcmd($$) {
835	my ($name, $cb) = @_;	1483	my ($name, $cb) = @_;
836		1484
837	$EXTCMD{$name} = $cb;	1485	$EXTCMD{$name} = $cb;
838	}	1486	}
839		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
840	cf::player->attach (	1508	cf::player->attach (
841	on_command => sub {	1509	on_unknown_command => sub {
842	my ($pl, $name, $params) = @_;	1510	my ($pl, $name, $params) = @_;
843		1511
844	my $cb = $COMMAND{$name}	1512	my $cb = $COMMAND{$name}
845	or return;	1513	or return;
846		1514
…		…
851	cf::override;	1519	cf::override;
852	},	1520	},
853	on_extcmd => sub {	1521	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1522	my ($pl, $buf) = @_;
855		1523
856	my $msg = eval { from_json $buf };	1524	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1525
858	if (ref $msg) {	1526	if (ref $msg) {
		1527	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1528
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1529	if (my $cb = $EXTACMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1530	$cb->(
861	$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);
862	}	1543	}
		1544
		1545	$pl->ext_msg ("reply-$reply", @reply)
		1546	if $reply;
863	}	1547	}
		1548
864	} else {	1549	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1550	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1551	}
867		1552
868	cf::override;	1553	cf::override;
869	},	1554	},
870	);	1555	);
871		1556
		1557	# "readahead" all extensions
872	sub load_extension {	1558	sub cache_extensions {
873	my ($path) = @_;	1559	my $grp = IO::AIO::aio_group;
874		1560
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1561	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
876	my $base = $1;	1562	for (grep /\.ext$/, @{$_[0]}) {
877	my $pkg = $1;	1563	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}	1564	}
900	die $@;
901	}	1565	};
902		1566
903	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;
904	}	1579	}
905		1580
906	sub load_extensions {	1581	sub load_extensions {
		1582	info "loading extensions...";
		1583
		1584	%EXT_CFG = ();
		1585
		1586	cf::sync_job {
		1587	my %todo;
		1588
907	for my $ext (<$LIBDIR/*.ext>) {	1589	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1590	next unless -r $path;
909	eval {	1591
910	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	}
911	1	1664	}
912	} 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	}
913	}	1677	};
914	}	1678	}
915		1679
916	#############################################################################	1680	#############################################################################
917		1681
		1682	=back
		1683
918	=head2 CORE EXTENSIONS	1684	=head2 CORE EXTENSIONS
919		1685
920	Functions and methods that extend core crossfire objects.	1686	Functions and methods that extend core deliantra objects.
921		1687
922	=cut	1688	=cut
923		1689
924	package cf::player;	1690	package cf::player;
925		1691
…		…
927		1693
928	=head3 cf::player	1694	=head3 cf::player
929		1695
930	=over 4	1696	=over 4
931		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
932	=item cf::player::find $login	1712	=item cf::player::find $login
933		1713
934	Returns the given player object, loading it if necessary (might block).	1714	Returns the given player object, loading it if necessary (might block).
935		1715
936	=cut	1716	=cut
937		1717
938	sub playerdir($) {	1718	sub playerdir($) {
939	cf::localdir	1719	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1720	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1721	}
945		1722
946	sub path($) {	1723	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1724	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1725
949	(playerdir $login) . "/$login.pl"	1726	(playerdir $login) . "/playerdata"
950	}	1727	}
951		1728
952	sub find_active($) {	1729	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1730	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1731	and $cf::PLAYER{$_[0]}->active
…		…
957		1734
958	sub exists($) {	1735	sub exists($) {
959	my ($login) = @_;	1736	my ($login) = @_;
960		1737
961	$cf::PLAYER{$login}	1738	$cf::PLAYER{$login}
962	or cf::sync_job { !aio_stat $login }	1739	or !aio_stat path $login
963	}	1740	}
964		1741
965	sub find($) {	1742	sub find($) {
966	return $cf::PLAYER{$_[0]} || do {	1743	return $cf::PLAYER{$_[0]} || do {
967	my $login = $_[0];	1744	my $login = $_[0];
968		1745
969	my $guard = cf::lock_acquire "user_find:$login";	1746	my $guard = cf::lock_acquire "user_find:$login";
970		1747
971	$cf::PLAYER{$_[0]} || do {	1748	$cf::PLAYER{$_[0]} || do {
972	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
973	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;
974	$cf::PLAYER{$login} = $pl	1764	$cf::PLAYER{$login} = $pl
975	}	1765	}
976	}	1766	}
977	}	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	);
978		1781
979	sub save($) {	1782	sub save($) {
980	my ($pl) = @_;	1783	my ($pl) = @_;
981		1784
982	return if $pl->{deny_save};	1785	return if $pl->{deny_save};
…		…
987	return if $pl->{deny_save};	1790	return if $pl->{deny_save};
988		1791
989	aio_mkdir playerdir $pl, 0770;	1792	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1793	$pl->{last_save} = $cf::RUNTIME;
991		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
992	$pl->save_pl ($path);	1800	$pl->save_pl ($path);
993	Coro::cede;	1801	cf::cede_to_tick;
994	}	1802	}
995		1803
996	sub new($) {	1804	sub new($) {
997	my ($login) = @_;	1805	my ($login) = @_;
998		1806
…		…
1004	$cf::PLAYER{$login} = $self;	1812	$cf::PLAYER{$login} = $self;
1005		1813
1006	$self	1814	$self
1007	}	1815	}
1008		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
1009	=item $pl->quit_character	1827	=item $pl->quit_character
1010		1828
1011	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
1012	be destroyed. May block for a long time.	1830	be destroyed. May block for a long time.
1013		1831
1014	=cut	1832	=cut
1015		1833
1016	sub quit_character {	1834	sub quit_character {
1017	my ($pl) = @_;	1835	my ($pl) = @_;
1018		1836
		1837	my $name = $pl->ob->name;
		1838
1019	$pl->{deny_save} = 1;	1839	$pl->{deny_save} = 1;
1020	$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
1021		1841
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1842	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1023	$pl->deactivate;	1843	$pl->deactivate;
		1844
		1845	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1846	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1847	ext::highscore::check ($pl->ob);
		1848
1025	$pl->ns->destroy if $pl->ns;	1849	$pl->ns->destroy if $pl->ns;
1026		1850
1027	my $path = playerdir $pl;	1851	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1852	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1853	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1854	delete $cf::PLAYER{$pl->ob->name};
1031	$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
1032	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;
1033	}	1877	}
1034		1878
1035	=item cf::player::list_logins	1879	=item cf::player::list_logins
1036		1880
1037	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
1038	while and may block, so not sync_job-capable, ever.	1882	while and may block, so not sync_job-capable, ever.
1039		1883
1040	=cut	1884	=cut
1041		1885
1042	sub list_logins {	1886	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1887	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1888	or return [];
1045		1889
1046	my @logins;	1890	my @logins;
1047		1891
1048	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") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1898	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1899	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1900	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1901	}
1052		1902
1053	utf8::decode $login;	1903	utf8::decode $login;
1054	push @logins, $login;	1904	push @logins, $login;
1055	}	1905	}
1056		1906
1057	\@logins	1907	\@logins
1058	}	1908	}
1059		1909
1060	=item $player->maps	1910	=item $player->maps
1061		1911
		1912	=item cf::player::maps $login
		1913
1062	Returns an arrayref of map paths that are private for this	1914	Returns an arrayref of map paths that are private for this
1063	player. May block.	1915	player. May block.
1064		1916
1065	=cut	1917	=cut
1066		1918
1067	sub maps($) {	1919	sub maps($) {
1068	my ($pl) = @_;	1920	my ($pl) = @_;
		1921
		1922	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1923
1070	my $files = aio_readdir playerdir $pl	1924	my $files = aio_readdir playerdir $pl
1071	or return;	1925	or return;
1072		1926
1073	my @paths;	1927	my @paths;
…		…
1075	for (@$files) {	1929	for (@$files) {
1076	utf8::decode $_;	1930	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1931	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1932	next unless /^$PATH_SEP/o;
1079		1933
1080	s/\.map$//;	1934	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1935	}
1083		1936
1084	\@paths	1937	\@paths
1085	}	1938	}
1086		1939
		1940	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1941
		1942	Expand deliantra pod fragments into protocol xml.
		1943
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1944	=item $player->ext_msg ($type, @msg)
1088		1945
1089	Sends an ext reply to the player.	1946	Sends an ext event to the client.
1090		1947
1091	=cut	1948	=cut
1092		1949
1093	sub ext_reply($$$%) {	1950	sub ext_msg($$@) {
1094	my ($self, $id, %msg) = @_;	1951	my ($self, $type, @msg) = @_;
1095		1952
1096	$msg{msgid} = $id;	1953	$self->ns->ext_msg ($type, @msg);
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1954	}
1100		1955
1101	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	}
1102		1986
1103	=back	1987	=back
1104
1105		1988
1106	=head3 cf::map	1989	=head3 cf::map
1107		1990
1108	=over 4	1991	=over 4
1109		1992
…		…
1113		1996
1114	use Fcntl;	1997	use Fcntl;
1115	use Coro::AIO;	1998	use Coro::AIO;
1116		1999
1117	use overload	2000	use overload
1118	'""' => \&as_string;	2001	'""' => \&as_string,
		2002	fallback => 1;
1119		2003
1120	our $MAX_RESET = 3600;	2004	our $MAX_RESET = 3600;
1121	our $DEFAULT_RESET = 3000;	2005	our $DEFAULT_RESET = 3000;
1122		2006
1123	sub generate_random_map {	2007	sub generate_random_map {
1124	my ($self, $rmp) = @_;	2008	my ($self, $rmp) = @_;
1125		2009
1126	# mit "rum" bekleckern, nicht	2010	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		2011
1127	$self->_create_random_map (	2012	$self->_create_random_map ($rmp);
1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131	$rmp->{exit_on_final_map},
1132	$rmp->{xsize}, $rmp->{ysize},
1133	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1134	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1135	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1136	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)
1140	}	2013	}
		2014
		2015	=item cf::map->register ($regex, $prio)
		2016
		2017	Register a handler for the map path matching the given regex at the
		2018	givne priority (higher is better, built-in handlers have priority 0, the
		2019	default).
		2020
		2021	=cut
1141		2022
1142	sub register {	2023	sub register {
1143	my (undef, $regex) = @_;	2024	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	2025	my $pkg = caller;
1145		2026
1146	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	2027	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		2028
1149	$EXT_MAP{$pkg} = qr<$regex>;	2029	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	2030	}
1151		2031
1152	# also paths starting with '/'	2032	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	2033	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1154		2034
1155	sub thawer_merge {	2035	sub thawer_merge {
1156	my ($self, $merge) = @_;	2036	my ($self, $merge) = @_;
1157		2037
1158	# we have to keep some variables in memory intact	2038	# we have to keep some variables in memory intact
1159	local $self->{path};	2039	local $self->{path};
1160	local $self->{load_path};	2040	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		2041
1164	$self->SUPER::thawer_merge ($merge);	2042	$self->SUPER::thawer_merge ($merge);
1165	}	2043	}
1166		2044
1167	sub normalise {	2045	sub normalise {
1168	my ($path, $base) = @_;	2046	my ($path, $base) = @_;
		2047
		2048	$path = "$path"; # make sure it's a string
		2049
		2050	$path =~ s/\.map$//;
1169		2051
1170	# map plan:	2052	# map plan:
1171	#	2053	#
1172	# /! non-realised random map exit (special hack!)	2054	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	2055	# {... are special paths that are not being touched
…		…
1186	$base =~ s{[^/]+/?$}{};	2068	$base =~ s{[^/]+/?$}{};
1187	$path = "$base/$path";	2069	$path = "$base/$path";
1188	}	2070	}
1189		2071
1190	for ($path) {	2072	for ($path) {
1191	redo if s{//}{/};
1192	redo if s{/\.?/}{/};	2073	redo if s{/\.?/}{/};
1193	redo if s{/[^/]+/\.\./}{/};	2074	redo if s{/[^/]+/\.\./}{/};
1194	}	2075	}
1195		2076
1196	$path	2077	$path
…		…
1201		2082
1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	2083	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203		2084
1204	$path = normalise $path, $base;	2085	$path = normalise $path, $base;
1205		2086
1206	for my $pkg (keys %EXT_MAP) {	2087	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	2088	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	2089	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	2090	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	2091	$self->init; # pass $1 etc.
1211	return $self;	2092	return $self;
1212	}	2093	}
1213	}	2094	}
1214		2095
1215	Carp::carp "unable to resolve path '$path'.";	2096	Carp::cluck "unable to resolve path '$path' (base '$base')";
1216	()	2097	()
1217	}	2098	}
1218		2099
		2100	# may re-bless or do other evil things
1219	sub init {	2101	sub init {
1220	my ($self) = @_;	2102	my ($self) = @_;
1221		2103
1222	$self	2104	$self
1223	}	2105	}
…		…
1235		2117
1236	# the original (read-only) location	2118	# the original (read-only) location
1237	sub load_path {	2119	sub load_path {
1238	my ($self) = @_;	2120	my ($self) = @_;
1239		2121
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	2122	"$MAPDIR/$self->{path}.map"
1241	}	2123	}
1242		2124
1243	# the temporary/swap location	2125	# the temporary/swap location
1244	sub save_path {	2126	sub save_path {
1245	my ($self) = @_;	2127	my ($self) = @_;
1246		2128
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2129	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	2130	"$TMPDIR/$path.map"
1249	}	2131	}
1250		2132
1251	# the unique path, undef == no special unique path	2133	# the unique path, undef == no special unique path
1252	sub uniq_path {	2134	sub uniq_path {
1253	my ($self) = @_;	2135	my ($self) = @_;
1254		2136
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2137	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	2138	"$UNIQUEDIR/$path"
1257	}	2139	}
1258		2140
1259	# and all this just because we cannot iterate over	2141	sub decay_objects {
1260	# all maps in C++...
1261	sub change_all_map_light {
1262	my ($change) = @_;	2142	my ($self) = @_;
1263		2143
1264	$_->change_map_light ($change)	2144	return if $self->{deny_reset};
1265	for grep $_->outdoor, values %cf::MAP;	2145
		2146	$self->do_decay_objects;
1266	}	2147	}
1267		2148
1268	sub unlink_save {	2149	sub unlink_save {
1269	my ($self) = @_;	2150	my ($self) = @_;
1270		2151
…		…
1275		2156
1276	sub load_header_from($) {	2157	sub load_header_from($) {
1277	my ($self, $path) = @_;	2158	my ($self, $path) = @_;
1278		2159
1279	utf8::encode $path;	2160	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	2161	my $f = new_from_file cf::object::thawer $path
1281	or return;	2162	or return;
1282		2163
1283	$self->_load_header ($path)	2164	$self->_load_header ($f)
1284	or return;	2165	or return;
1285		2166
		2167	local $MAP_LOADING{$self->{path}} = $self;
		2168	$f->resolve_delayed_derefs;
		2169
1286	$self->{load_path} = $path;	2170	$self->{load_path} = $path;
1287		2171
1288	1	2172	1
1289	}	2173	}
1290		2174
		2175	# used to laod the header of an original map
1291	sub load_orig {	2176	sub load_header_orig {
1292	my ($self) = @_;	2177	my ($self) = @_;
1293		2178
1294	$self->load_header_from ($self->load_path)	2179	$self->load_header_from ($self->load_path)
1295	}	2180	}
1296		2181
		2182	# used to laod the header of an instantiated map
1297	sub load_temp {	2183	sub load_header_temp {
1298	my ($self) = @_;	2184	my ($self) = @_;
1299		2185
1300	$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;
1301	}	2208	}
1302		2209
1303	sub load_header {	2210	sub load_header {
1304	my ($self) = @_;	2211	my ($self) = @_;
1305		2212
1306	if ($self->load_temp) {	2213	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	2214	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	2215	} else {
1313	$self->load_orig	2216	$self->load_header_orig
1314	or return;	2217	or return;
1315		2218	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	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;
1321		2226
1322	1	2227	1
1323	}	2228	}
1324		2229
1325	sub find;	2230	sub find;
1326	sub find {	2231	sub find {
1327	my ($path, $origin) = @_;	2232	my ($path, $origin) = @_;
1328		2233
		2234	cf::cede_to_tick;
		2235
1329	$path = normalise $path, $origin && $origin->path;	2236	$path = normalise $path, $origin;
1330		2237
		2238	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	2239	my $guard2 = cf::lock_acquire "map_find:$path";
1332		2240
1333	$cf::MAP{$path} || do {	2241	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";
1335	my $map = new_from_path cf::map $path	2242	my $map = new_from_path cf::map $path
1336	or return;	2243	or return;
1337		2244
1338	$map->{last_save} = $cf::RUNTIME;	2245	$map->{last_save} = $cf::RUNTIME;
1339		2246
1340	$map->load_header	2247	$map->load_header
1341	or return;	2248	or return;
1342		2249
1343	if ($map->should_reset) {	2250	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2251	# doing this can freeze the server in a sync job, obviously
1344	$cf::WAIT_FOR_TICK->wait;	2252	#$cf::WAIT_FOR_TICK->wait;
		2253	undef $guard2;
		2254	undef $guard1;
1345	$map->reset;	2255	$map->reset;
1346	undef $guard;
1347	$map = find $path	2256	return find $path;
1348	or return;
1349	}	2257	}
1350		2258
1351	$cf::MAP{$path} = $map	2259	$cf::MAP{$path} = $map
1352	}	2260	}
1353	}	2261	}
		2262
		2263	sub pre_load { }
		2264	#sub post_load { } # XS
1354		2265
1355	sub load {	2266	sub load {
1356	my ($self) = @_;	2267	my ($self) = @_;
1357		2268
		2269	local $self->{deny_reset} = 1; # loading can take a long time
		2270
1358	my $path = $self->{path};	2271	my $path = $self->{path};
		2272
		2273	{
1359	my $guard = cf::lock_acquire "map_load:$path";	2274	my $guard = cf::lock_acquire "map_data:$path";
1360		2275
1361	return if $self->in_memory != cf::MAP_SWAPPED;	2276	return unless $self->valid;
		2277	return unless $self->state == cf::MAP_SWAPPED;
1362		2278
1363	$self->in_memory (cf::MAP_LOADING);
1364
1365	$self->alloc;	2279	$self->alloc;
1366	$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)
1367	or return;	2288	or return;
1368		2289
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2290	$self->post_load_original
1370	if delete $self->{load_original};	2291	if delete $self->{load_original};
1371		2292
1372	if (my $uniq = $self->uniq_path) {	2293	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;	2294	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {	2295	unless (aio_stat $uniq) {
		2296	if (my $f = new_from_file cf::object::thawer $uniq) {
1375	$self->clear_unique_items;	2297	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);	2298	$self->_load_objects ($f);
		2299	$f->resolve_delayed_derefs;
		2300	}
		2301	}
1377	}	2302	}
1378	}
1379		2303
1380	Coro::cede;	2304	$f->resolve_delayed_derefs;
		2305	} else {
		2306	$self->post_load_original
		2307	if delete $self->{load_original};
		2308	}
1381		2309
		2310	$self->state (cf::MAP_INACTIVE);
		2311
		2312	cf::cede_to_tick;
1382	# now do the right thing for maps	2313	# now do the right thing for maps
1383	$self->link_multipart_objects;	2314	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;
1390	$self->set_darkness_map;
1391	$self->difficulty ($self->estimate_difficulty)	2315	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	2316	unless $self->difficulty;
1393	Coro::cede;	2317	cf::cede_to_tick;
1394	$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
1395	}	2333	1
1396
1397	$self->in_memory (cf::MAP_IN_MEMORY);
1398	}	2334	}
1399		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
1400	sub customise_for {	2339	sub customise_for {
1401	my ($self, $ob) = @_;	2340	my ($self, $ob) = @_;
1402		2341
1403	return find "~" . $ob->name . "/" . $self->{path}	2342	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	2343	if $self->per_player;
1405		2344
		2345	# return find "?party/" . $ob->name . "/" . $self->{path}
		2346	# if $self->per_party;
		2347
1406	$self	2348	$self
1407	}
1408
1409	# find and load all maps in the 3x3 area around a map
1410	sub load_diag {
1411	my ($map) = @_;
1412
1413	my @diag; # diagonal neighbours
1414
1415	for (0 .. 3) {
1416	my $neigh = $map->tile_path ($_)
1417	or next;
1418	$neigh = find $neigh, $map
1419	or next;
1420	$neigh->load;
1421
1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1424	}
1425
1426	for (@diag) {
1427	my $neigh = find @$_
1428	or next;
1429	$neigh->load;
1430	}
1431	}	2349	}
1432		2350
1433	sub find_sync {	2351	sub find_sync {
1434	my ($path, $origin) = @_;	2352	my ($path, $origin) = @_;
1435		2353
1436	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
1437	}	2359	}
1438		2360
1439	sub do_load_sync {	2361	sub do_load_sync {
1440	my ($map) = @_;	2362	my ($map) = @_;
1441		2363
1442	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;
1443	}	2369	}
1444		2370
1445	our %MAP_PREFETCH;	2371	our %MAP_PREFETCH;
1446	our $MAP_PREFETCHER = Coro::async {	2372	our $MAP_PREFETCHER = undef;
1447	while () {
1448	for my $path (keys %MAP_PREFETCH) {
1449	my $map = find $path
1450	or next;
1451	$map->load;
1452
1453	delete $MAP_PREFETCH{$path};
1454	}
1455	Coro::schedule;
1456	}
1457	};
1458		2373
1459	sub find_async {	2374	sub find_async {
1460	my ($path, $origin) = @_;	2375	my ($path, $origin, $load) = @_;
1461		2376
1462	$path = normalise $path, $origin && $origin->{path};	2377	$path = normalise $path, $origin;
1463		2378
1464	if (my $map = $cf::MAP{$path}) {	2379	if (my $map = $cf::MAP{$path}) {
1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2380	return $map if !$load || $map->linkable;
		2381	}
		2382
		2383	$MAP_PREFETCH{$path} |= $load;
		2384
		2385	$MAP_PREFETCHER ||= cf::async {
		2386	$Coro::current->{desc} = "map prefetcher";
		2387
		2388	while (%MAP_PREFETCH) {
		2389	while (my ($k, $v) = each %MAP_PREFETCH) {
		2390	if (my $map = find $k) {
		2391	$map->load if $v;
		2392	}
		2393
		2394	delete $MAP_PREFETCH{$k};
		2395	}
		2396	}
		2397	undef $MAP_PREFETCHER;
1466	}	2398	};
1467
1468	$MAP_PREFETCH{$path} = 0;
1469	$MAP_PREFETCHER->ready;	2399	$MAP_PREFETCHER->prio (6);
1470		2400
1471	()	2401	()
1472	}	2402	}
1473		2403
		2404	# common code, used by both ->save and ->swapout
1474	sub save {	2405	sub _save {
1475	my ($self) = @_;	2406	my ($self) = @_;
1476
1477	my $lock = cf::lock_acquire "map_data:" . $self->path;
1478		2407
1479	$self->{last_save} = $cf::RUNTIME;	2408	$self->{last_save} = $cf::RUNTIME;
1480		2409
1481	return unless $self->dirty;	2410	return unless $self->dirty;
1482		2411
…		…
1488	return if $self->{deny_save};	2417	return if $self->{deny_save};
1489		2418
1490	local $self->{last_access} = $self->last_access;#d#	2419	local $self->{last_access} = $self->last_access;#d#
1491		2420
1492	cf::async {	2421	cf::async {
		2422	$Coro::current->{desc} = "map player save";
1493	$_->contr->save for $self->players;	2423	$_->contr->save for $self->players;
1494	};	2424	};
		2425
		2426	cf::get_slot 0.02;
1495		2427
1496	if ($uniq) {	2428	if ($uniq) {
1497	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2429	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2430	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1499	} else {	2431	} else {
1500	$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);
1501	}	2433	}
1502	}	2434	}
1503		2435
		2436	sub save {
		2437	my ($self) = @_;
		2438
		2439	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2440
		2441	$self->_save;
		2442	}
		2443
1504	sub swap_out {	2444	sub swap_out {
1505	my ($self) = @_;	2445	my ($self) = @_;
1506		2446
1507	# save first because save cedes
1508	$self->save;
1509
1510	my $lock = cf::lock_acquire "map_data:" . $self->path;	2447	my $lock = cf::lock_acquire "map_data:$self->{path}";
1511		2448
		2449	return if !$self->linkable;
		2450	return if $self->{deny_save};
1512	return if $self->players;	2451	return if $self->players;
1513	return if $self->in_memory != cf::MAP_IN_MEMORY;
1514	return if $self->{deny_save};
1515		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
1516	$self->clear;	2462	$self->clear;
1517	$self->in_memory (cf::MAP_SWAPPED);
1518	}	2463	}
1519		2464
1520	sub reset_at {	2465	sub reset_at {
1521	my ($self) = @_;	2466	my ($self) = @_;
1522		2467
1523	# TODO: safety, remove and allow resettable per-player maps	2468	# TODO: safety, remove and allow resettable per-player maps
1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
1525	return 1e99 if $self->{deny_reset};	2469	return 1e99 if $self->{deny_reset};
1526		2470
1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2471	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528	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;
1529		2473
…		…
1534	my ($self) = @_;	2478	my ($self) = @_;
1535		2479
1536	$self->reset_at <= $cf::RUNTIME	2480	$self->reset_at <= $cf::RUNTIME
1537	}	2481	}
1538		2482
1539	sub rename {
1540	my ($self, $new_path) = @_;
1541
1542	normalise $new_path;
1543
1544	$self->unlink_save;
1545
1546	delete $cf::MAP{$self->path};
1547	$self->{path} = $new_path; $self->path ($self->{path});
1548	$cf::MAP{$self->path} = $self;
1549
1550	$self->save;
1551	}
1552
1553	sub reset {	2483	sub reset {
1554	my ($self) = @_;	2484	my ($self) = @_;
1555		2485
1556	my $lock = cf::lock_acquire "map_data:$self->{path}";	2486	my $lock = cf::lock_acquire "map_data:$self->{path}";
1557		2487
1558	return if $self->players;	2488	return if $self->players;
1559	return if $self->isa ("ext::map_per_player");#d#
1560		2489
1561	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	}
1562		2501
1563	delete $cf::MAP{$self->path};	2502	delete $cf::MAP{$self->path};
1564		2503
1565	$self->in_memory (cf::MAP_SWAPPED);	2504	$self->deactivate;
		2505	$_->clear_links_to ($self) for values %cf::MAP;
1566	$self->clear;	2506	$self->clear;
1567
1568	$_->clear_links_to ($self) for values %cf::MAP;
1569		2507
1570	$self->unlink_save;	2508	$self->unlink_save;
1571	$self->destroy;	2509	$self->destroy;
1572	}	2510	}
1573		2511
1574	my $nuke_counter = "aaaa";	2512	my $nuke_counter = "aaaa";
1575		2513
1576	sub nuke {	2514	sub nuke {
1577	my ($self) = @_;	2515	my ($self) = @_;
1578		2516
		2517	{
		2518	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2519
		2520	delete $cf::MAP{$self->path};
		2521
		2522	$self->unlink_save;
		2523
		2524	bless $self, "cf::map::wrap";
		2525	delete $self->{deny_reset};
1579	$self->{deny_save} = 1;	2526	$self->{deny_save} = 1;
1580	$self->reset_timeout (1);	2527	$self->reset_timeout (1);
1581	$self->rename ("{nuke}/" . ($nuke_counter++));	2528	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2529
		2530	$cf::MAP{$self->path} = $self;
		2531	}
		2532
1582	$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	]
1583	}	2570	}
1584		2571
1585	=item cf::map::unique_maps	2572	=item cf::map::unique_maps
1586		2573
1587	Returns an arrayref of paths of all shared maps that have	2574	Returns an arrayref of paths of all shared maps that have
1588	instantiated unique items. May block.	2575	instantiated unique items. May block.
1589		2576
1590	=cut	2577	=cut
1591		2578
1592	sub unique_maps() {	2579	sub unique_maps() {
1593	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2580	[
1594	or return;	2581	map {
1595
1596	my @paths;
1597
1598	for (@$files) {
1599	utf8::decode $_;	2582	utf8::decode $_;
1600	next if /\.pst$/;	2583	s/\.map$//; # TODO future compatibility hack
1601	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	}
1602		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) {
1603	s/\.map$//;	2612	s/\.map$// or next;
1604	push @paths, $_;	2613	utf8::decode $_;
1605	}	2614	push @maps, "$dir/$_";
		2615	}
1606		2616
1607	\@paths	2617	push @dirs, map "$dir/$_", @$dirs;
1608	}	2618	}
1609		2619
1610	package cf;	2620	\@maps
		2621	}
1611		2622
1612	=back	2623	=back
1613		2624
1614	=head3 cf::object	2625	=head3 cf::object
1615		2626
…		…
1619		2630
1620	=over 4	2631	=over 4
1621		2632
1622	=item $ob->inv_recursive	2633	=item $ob->inv_recursive
1623		2634
1624	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.
1625		2637
1626	=cut	2638	=cut
1627		2639
1628	sub inv_recursive_;	2640	sub inv_recursive_;
1629	sub inv_recursive_ {	2641	sub inv_recursive_ {
…		…
1632		2644
1633	sub inv_recursive {	2645	sub inv_recursive {
1634	inv_recursive_ inv $_[0]	2646	inv_recursive_ inv $_[0]
1635	}	2647	}
1636		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
1637	package cf;	2677	package cf;
1638		2678
1639	=back	2679	=back
1640		2680
1641	=head3 cf::object::player	2681	=head3 cf::object::player
…		…
1647	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>
1648	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
1649	dialogue with the given NPC character.	2689	dialogue with the given NPC character.
1650		2690
1651	=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	};
1652		2706
1653	# rough implementation of a future "reply" method that works	2707	# rough implementation of a future "reply" method that works
1654	# with dialog boxes.	2708	# with dialog boxes.
1655	#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
1656	sub cf::object::player::reply($$$;$) {	2710	sub cf::object::player::reply($$$;$) {
…		…
1658		2712
1659	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1660		2714
1661	if ($self->{record_replies}) {	2715	if ($self->{record_replies}) {
1662	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2717
1663	} 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 {
1664	$msg = $npc->name . " says: $msg" if $npc;	2726	$msg = $npc->name . " says: $msg" if $npc;
1665	$self->message ($msg, $flags);	2727	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2728	}
1666	}	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 (@_);
1667	}	2740	}
1668		2741
1669	=item $player_object->may ("access")	2742	=item $player_object->may ("access")
1670		2743
1671	Returns wether the given player is authorized to access resource "access"	2744	Returns wether the given player is authorized to access resource "access"
…		…
1684		2757
1685	=item $player_object->enter_link	2758	=item $player_object->enter_link
1686		2759
1687	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}>).
1688		2761
1689	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.
1690	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.
1691		2766
1692	Will never block.	2767	Will never block.
1693		2768
1694	=item $player_object->leave_link ($map, $x, $y)	2769	=item $player_object->leave_link ($map, $x, $y)
1695		2770
…		…
1703	=cut	2778	=cut
1704		2779
1705	sub link_map {	2780	sub link_map {
1706	unless ($LINK_MAP) {	2781	unless ($LINK_MAP) {
1707	$LINK_MAP = cf::map::find "{link}"	2782	$LINK_MAP = cf::map::find "{link}"
1708	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2783	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1709	$LINK_MAP->load;	2784	$LINK_MAP->load;
1710	}	2785	}
1711		2786
1712	$LINK_MAP	2787	$LINK_MAP
1713	}	2788	}
…		…
1715	sub cf::object::player::enter_link {	2790	sub cf::object::player::enter_link {
1716	my ($self) = @_;	2791	my ($self) = @_;
1717		2792
1718	$self->deactivate_recursive;	2793	$self->deactivate_recursive;
1719		2794
		2795	++$self->{_link_recursion};
		2796
1720	return if UNIVERSAL::isa $self->map, "ext::map_link";	2797	return if UNIVERSAL::isa $self->map, "ext::map_link";
1721		2798
1722	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1723	if $self->map;	2800	if $self->map && $self->map->{path} ne "{link}";
1724		2801
1725	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2802	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1726	}	2803	}
1727		2804
1728	sub cf::object::player::leave_link {	2805	sub cf::object::player::leave_link {
1729	my ($self, $map, $x, $y) = @_;	2806	my ($self, $map, $x, $y) = @_;
		2807
		2808	return unless $self->contr->active;
1730		2809
1731	my $link_pos = delete $self->{_link_pos};	2810	my $link_pos = delete $self->{_link_pos};
1732		2811
1733	unless ($map) {	2812	unless ($map) {
1734	# restore original map position	2813	# restore original map position
…		…
1745	($x, $y) = (-1, -1)	2824	($x, $y) = (-1, -1)
1746	unless (defined $x) && (defined $y);	2825	unless (defined $x) && (defined $y);
1747		2826
1748	# use -1 or undef as default coordinates, not 0, 0	2827	# use -1 or undef as default coordinates, not 0, 0
1749	($x, $y) = ($map->enter_x, $map->enter_y)	2828	($x, $y) = ($map->enter_x, $map->enter_y)
1750	if $x <=0 && $y <= 0;	2829	if $x <= 0 && $y <= 0;
1751		2830
1752	$map->load;	2831	$map->load;
1753	$map->load_diag;
1754		2832
1755	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
1756	$self->activate_recursive;	2840	$self->activate_recursive;
1757	$self->enter_map ($map, $x, $y);
1758	}
1759
1760	cf::player->attach (
1761	on_logout => sub {
1762	my ($pl) = @_;
1763
1764	# abort map switching before logout
1765	if ($pl->ob->{_link_pos}) {
1766	cf::sync_job {
1767	$pl->ob->leave_link
1768	};
1769	}
1770	},	2841	}
1771	on_login => sub {
1772	my ($pl) = @_;
1773		2842
1774	# try to abort aborted map switching on player login :)	2843	}
1775	# should happen only on crashes
1776	if ($pl->ob->{_link_pos}) {
1777	$pl->ob->enter_link;
1778	(async {
1779	# we need this sleep as the login has a concurrent enter_exit running
1780	# and this sleep increases chances of the player not ending up in scorn
1781	$pl->ob->reply (undef,
1782	"There was an internal problem at your last logout, "
1783	. "the server will try to bring you to your intended destination in a second.",
1784	cf::NDI_RED);
1785	Coro::Timer::sleep 1;
1786	$pl->ob->leave_link;
1787	})->prio (2);
1788	}
1789	},
1790	);
1791		2844
1792	=item $player_object->goto ($path, $x, $y)	2845	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1793		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
1794	=cut	2856	=cut
		2857
		2858	our $GOTOGEN;
1795		2859
1796	sub cf::object::player::goto {	2860	sub cf::object::player::goto {
1797	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;
1798		2871
1799	$self->enter_link;	2872	$self->enter_link;
1800		2873
1801	(async {	2874	(async {
1802	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) {
1803	$map = $map->customise_for ($self) if $map;	2900	$map = $map->customise_for ($self);
1804		2901	$map = $check->($map, $x, $y, $self) if $check && $map;
1805	# warn "entering ", $map->path, " at ($x, $y)\n"	2902	} else {
1806	# if $map;
1807
1808	$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	}
1809		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};
1810	$self->leave_link ($map, $x, $y);	2916	$self->leave_link ($map, $x, $y);
		2917	}
		2918
		2919	$done->($self) if $done;
1811	})->prio (1);	2920	})->prio (1);
1812	}	2921	}
1813		2922
1814	=item $player_object->enter_exit ($exit_object)	2923	=item $player_object->enter_exit ($exit_object)
1815		2924
…		…
1817		2926
1818	sub parse_random_map_params {	2927	sub parse_random_map_params {
1819	my ($spec) = @_;	2928	my ($spec) = @_;
1820		2929
1821	my $rmp = { # defaults	2930	my $rmp = { # defaults
1822	xsize => 10,	2931	xsize => (cf::rndm 15, 40),
1823	ysize => 10,	2932	ysize => (cf::rndm 15, 40),
		2933	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2934	#layout => string,
1824	};	2935	};
1825		2936
1826	for (split /\n/, $spec) {	2937	for (split /\n/, $spec) {
1827	my ($k, $v) = split /\s+/, $_, 2;	2938	my ($k, $v) = split /\s+/, $_, 2;
1828		2939
…		…
1840	# that depends on the exit object	2951	# that depends on the exit object
1841		2952
1842	my $rmp = parse_random_map_params $exit->msg;	2953	my $rmp = parse_random_map_params $exit->msg;
1843		2954
1844	if ($exit->map) {	2955	if ($exit->map) {
1845	$rmp->{region} = $exit->map->region_name;	2956	$rmp->{region} = $exit->region->name;
1846	$rmp->{origin_map} = $exit->map->path;	2957	$rmp->{origin_map} = $exit->map->path;
1847	$rmp->{origin_x} = $exit->x;	2958	$rmp->{origin_x} = $exit->x;
1848	$rmp->{origin_y} = $exit->y;	2959	$rmp->{origin_y} = $exit->y;
		2960
		2961	$exit->map->touch;
1849	}	2962	}
1850		2963
1851	$rmp->{random_seed} ||= $exit->random_seed;	2964	$rmp->{random_seed} ||= $exit->random_seed;
1852		2965
1853	my $data = cf::to_json $rmp;	2966	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1854	my $md5 = Digest::MD5::md5_hex $data;	2967	my $md5 = Digest::MD5::md5_hex $data;
		2968	my $meta = "$RANDOMDIR/$md5.meta";
1855		2969
1856	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2970	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857	aio_write $fh, 0, (length $data), $data, 0;	2971	aio_write $fh, 0, (length $data), $data, 0;
		2972	undef $fh;
		2973	aio_rename "$meta~", $meta;
1858		2974
		2975	my $slaying = "?random/$md5";
		2976
		2977	if ($exit->valid) {
1859	$exit->slaying ("?random/$md5");	2978	$exit->slaying ("?random/$md5");
1860	$exit->msg (undef);	2979	$exit->msg (undef);
		2980	}
1861	}	2981	}
1862	}	2982	}
1863		2983
1864	sub cf::object::player::enter_exit {	2984	sub cf::object::player::enter_exit {
1865	my ($self, $exit) = @_;	2985	my ($self, $exit) = @_;
…		…
1867	return unless $self->type == cf::PLAYER;	2987	return unless $self->type == cf::PLAYER;
1868		2988
1869	$self->enter_link;	2989	$self->enter_link;
1870		2990
1871	(async {	2991	(async {
1872	$self->deactivate_recursive; # just to be sure	2992	$Coro::current->{desc} = "enter_exit";
		2993
1873	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
1874	prepare_random_map $exit	3008	prepare_random_map $exit
		3009	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3010
1875	if $exit->slaying eq "/!";	3011	$map = $exit->slaying;
1876		3012
1877	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;	3013	} elsif ($slaying eq '!up') {
1878	$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;
1879		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
1880	1;	3030	1
1881	}) {	3031	}) {
1882	$self->message ("Something went wrong deep within the crossfire server. "	3032	$self->message ("Something went wrong deep within the deliantra server. "
1883	. "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. "
1884	. "Please report this to the dungeon master!",	3034	. "Please report this to the dungeon master!",
1885	cf::NDI_UNIQUE | cf::NDI_RED);	3035	cf::NDI_UNIQUE | cf::NDI_RED);
1886		3036
1887	warn "ERROR in enter_exit: $@";	3037	error "ERROR in enter_exit: $@";
1888	$self->leave_link;	3038	$self->leave_link;
1889	}	3039	}
1890	})->prio (1);	3040	})->prio (1);
1891	}	3041	}
1892		3042
1893	=head3 cf::client	3043	=head3 cf::client
1894		3044
1895	=over 4	3045	=over 4
1896		3046
1897	=item $client->send_drawinfo ($text, $flags)	3047	=item $client->send_big_packet ($pkt)
1898		3048
1899	Sends a drawinfo packet to the client. Circumvents output buffering so	3049	Like C<send_packet>, but tries to compress large packets, and fragments
1900	should not be used under normal circumstances.	3050	them as required.
1901		3051
1902	=cut	3052	=cut
1903		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
1904	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($$@) {
1905	my ($self, $text, $flags) = @_;	3247	my ($self, $type, @msg) = @_;
1906		3248
1907	utf8::encode $text;	3249	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
1908	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1909	}	3250	}
1910
1911		3251
1912	=item $success = $client->query ($flags, "text", \&cb)	3252	=item $success = $client->query ($flags, "text", \&cb)
1913		3253
1914	Queues a query to the client, calling the given callback with	3254	Queues a query to the client, calling the given callback with
1915	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>,
1916	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>.
1917		3257
1918	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
1919	reliable at some point in the future.	3259	become reliable at some point in the future.
1920		3260
1921	=cut	3261	=cut
1922		3262
1923	sub cf::client::query {	3263	sub cf::client::query {
1924	my ($self, $flags, $text, $cb) = @_;	3264	my ($self, $flags, $text, $cb) = @_;
…		…
1932	utf8::encode $text;	3272	utf8::encode $text;
1933	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3273	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1934		3274
1935	$self->send_packet ($self->{query_queue}[0][0])	3275	$self->send_packet ($self->{query_queue}[0][0])
1936	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_FACES; # [normal commands, emotes, dm commands]
		3286
		3287	sub cf::client::update_command_faces {
		3288	my ($self) = @_;
		3289
		3290	my @faces = (
		3291	$COMMAND_FACES[0],
		3292	$COMMAND_FACES[1],
		3293	$self->pl->ob->flag (cf::FLAG_WIZ) ? $COMMAND_FACES[2] : ()
		3294	);
		3295
		3296	$self->send_face ($_)
		3297	for @faces;
		3298	$self->flush_fx;
		3299
		3300	$self->ext_msg (command_list => @faces);
		3301	}
		3302
		3303	=item cf::client::set_command_faces $normal_commands, $emotes, $dm_commands
		3304
		3305	=cut
		3306
		3307	sub cf::client::set_command_faces {
		3308	@COMMAND_FACES = @_;
1937	}	3309	}
1938		3310
1939	cf::client->attach (	3311	cf::client->attach (
		3312	on_connect => sub {
		3313	my ($ns) = @_;
		3314
		3315	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3316	},
1940	on_reply => sub {	3317	on_reply => sub {
1941	my ($ns, $msg) = @_;	3318	my ($ns, $msg) = @_;
1942		3319
1943	# this weird shuffling is so that direct followup queries	3320	# this weird shuffling is so that direct followup queries
1944	# get handled first	3321	# get handled first
1945	my $queue = delete $ns->{query_queue}	3322	my $queue = delete $ns->{query_queue}
1946	or return; # be conservative, not sure how that can happen, but we saw a crash here	3323	or return; # be conservative, not sure how that can happen, but we saw a crash here
1947		3324
1948	(shift @$queue)->[1]->($msg);	3325	(shift @$queue)->[1]->($msg);
		3326	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1949		3327
1950	push @{ $ns->{query_queue} }, @$queue;	3328	push @{ $ns->{query_queue} }, @$queue;
1951		3329
1952	if (@{ $ns->{query_queue} } == @$queue) {	3330	if (@{ $ns->{query_queue} } == @$queue) {
1953	if (@$queue) {	3331	if (@$queue) {
…		…
1955	} else {	3333	} else {
1956	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3334	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1957	}	3335	}
1958	}	3336	}
1959	},	3337	},
		3338	on_exticmd => sub {
		3339	my ($ns, $buf) = @_;
		3340
		3341	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3342
		3343	if (ref $msg) {
		3344	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3345
		3346	if (my $cb = $EXTIACMD{$type}) {
		3347	$cb->(
		3348	$ns,
		3349	sub {
		3350	$ns->ext_msg ("reply-$reply", @_)
		3351	if $reply;
		3352	},
		3353	@payload
		3354	);
		3355	} else {
		3356	my @reply;
		3357
		3358	if (my $cb = $EXTICMD{$type}) {
		3359	@reply = $cb->($ns, @payload);
		3360	}
		3361
		3362	$ns->ext_msg ("reply-$reply", @reply)
		3363	if $reply;
		3364	}
		3365	} else {
		3366	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3367	}
		3368
		3369	cf::override;
		3370	},
1960	);	3371	);
1961		3372
1962	=item $client->async (\&cb)	3373	=item $client->async (\&cb)
1963		3374
1964	Create a new coroutine, running the specified callback. The coroutine will	3375	Create a new coroutine, running the specified callback. The coroutine will
…		…
1980		3391
1981	$coro	3392	$coro
1982	}	3393	}
1983		3394
1984	cf::client->attach (	3395	cf::client->attach (
1985	on_destroy => sub {	3396	on_client_destroy => sub {
1986	my ($ns) = @_;	3397	my ($ns) = @_;
1987		3398
1988	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3399	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1989	},	3400	},
1990	);	3401	);
…		…
2005	our $safe = new Safe "safe";	3416	our $safe = new Safe "safe";
2006	our $safe_hole = new Safe::Hole;	3417	our $safe_hole = new Safe::Hole;
2007		3418
2008	$SIG{FPE} = 'IGNORE';	3419	$SIG{FPE} = 'IGNORE';
2009		3420
2010	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3421	$safe->permit_only (Opcode::opset qw(
		3422	:base_core :base_mem :base_orig :base_math :base_loop
		3423	grepstart grepwhile mapstart mapwhile
		3424	sort time
		3425	));
2011		3426
2012	# here we export the classes and methods available to script code	3427	# here we export the classes and methods available to script code
2013		3428
2014	=pod	3429	=pod
2015		3430
2016	The following fucntions and emthods are available within a safe environment:	3431	The following functions and methods are available within a safe environment:
2017		3432
2018	cf::object contr pay_amount pay_player map	3433	cf::object
		3434	contr pay_amount pay_player map x y force_find force_add destroy
		3435	insert remove name archname title slaying race decrease split
		3436	value
		3437
2019	cf::object::player player	3438	cf::object::player
2020	cf::player peaceful	3439	player
2021	cf::map trigger	3440
		3441	cf::player
		3442	peaceful
		3443
		3444	cf::map
		3445	trigger
2022		3446
2023	=cut	3447	=cut
2024		3448
2025	for (	3449	for (
2026	["cf::object" => qw(contr pay_amount pay_player map)],	3450	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3451	insert remove inv nrof name archname title slaying race
		3452	decrease split destroy change_exp value msg lore send_msg)],
2027	["cf::object::player" => qw(player)],	3453	["cf::object::player" => qw(player)],
2028	["cf::player" => qw(peaceful)],	3454	["cf::player" => qw(peaceful send_msg)],
2029	["cf::map" => qw(trigger)],	3455	["cf::map" => qw(trigger)],
2030	) {	3456	) {
2031	no strict 'refs';
2032	my ($pkg, @funs) = @$_;	3457	my ($pkg, @funs) = @$_;
2033	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3458	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2034	for @funs;	3459	for @funs;
2035	}	3460	}
2036		3461
…		…
2051		3476
2052	my $qcode = $code;	3477	my $qcode = $code;
2053	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3478	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2054	$qcode =~ s/\n/\\n/g;	3479	$qcode =~ s/\n/\\n/g;
2055		3480
		3481	%vars = (_dummy => 0) unless %vars;
		3482
		3483	my @res;
2056	local $_;	3484	local $_;
2057	local @safe::cf::_safe_eval_args = values %vars;
2058		3485
2059	my $eval =	3486	my $eval =
2060	"do {\n"	3487	"do {\n"
2061	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3488	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2062	. "#line 0 \"{$qcode}\"\n"	3489	. "#line 0 \"{$qcode}\"\n"
2063	. $code	3490	. $code
2064	. "\n}"	3491	. "\n}"
2065	;	3492	;
2066		3493
		3494	if ($CFG{safe_eval}) {
2067	sub_generation_inc;	3495	sub_generation_inc;
		3496	local @safe::cf::_safe_eval_args = values %vars;
2068	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3497	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2069	sub_generation_inc;	3498	sub_generation_inc;
		3499	} else {
		3500	local @cf::_safe_eval_args = values %vars;
		3501	@res = wantarray ? eval eval : scalar eval $eval;
		3502	}
2070		3503
2071	if ($@) {	3504	if ($@) {
2072	warn "$@";	3505	warn "$@",
2073	warn "while executing safe code '$code'\n";	3506	"while executing safe code '$code'\n",
2074	warn "with arguments " . (join " ", %vars) . "\n";	3507	"with arguments " . (join " ", %vars) . "\n";
2075	}	3508	}
2076		3509
2077	wantarray ? @res : $res[0]	3510	wantarray ? @res : $res[0]
2078	}	3511	}
2079		3512
…		…
2093	=cut	3526	=cut
2094		3527
2095	sub register_script_function {	3528	sub register_script_function {
2096	my ($fun, $cb) = @_;	3529	my ($fun, $cb) = @_;
2097		3530
2098	no strict 'refs';	3531	$fun = "safe::$fun" if $CFG{safe_eval};
2099	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3532	*$fun = $safe_hole->wrap ($cb);
2100	}	3533	}
2101		3534
2102	=back	3535	=back
2103		3536
2104	=cut	3537	=cut
2105		3538
2106	#############################################################################	3539	#############################################################################
2107		3540	# the server's init and main functions
2108	=head2 EXTENSION DATABASE SUPPORT
2109
2110	Crossfire maintains a very simple database for extension use. It can
2111	currently store anything that can be serialised using Storable, which
2112	excludes objects.
2113
2114	The parameter C<$family> should best start with the name of the extension
2115	using it, it should be unique.
2116
2117	=over 4
2118
2119	=item $hashref = cf::db_get $family
2120
2121	Return a hashref for use by the extension C<$family>, which can be
2122	modified. After modifications, you have to call C<cf::db_dirty> or
2123	C<cf::db_sync>.
2124
2125	=item $value = cf::db_get $family => $key
2126
2127	Returns a single value from the database
2128
2129	=item cf::db_put $family => $hashref
2130
2131	Stores the given family hashref into the database. Updates are delayed, if
2132	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2133
2134	=item cf::db_put $family => $key => $value
2135
2136	Stores the given C<$value> in the family hash. Updates are delayed, if you
2137	want the data to be synced to disk immediately, use C<cf::db_sync>.
2138
2139	=item cf::db_dirty
2140
2141	Marks the database as dirty, to be updated at a later time.
2142
2143	=item cf::db_sync
2144
2145	Immediately write the database to disk I<if it is dirty>.
2146
2147	=cut
2148
2149	our $DB;
2150		3541
2151	{	3542	{
2152	my $path = cf::localdir . "/database.pst";	3543	package cf::face;
2153		3544
2154	sub db_load() {	3545	our %HASH; # hash => idx
2155	$DB = stat $path ? Storable::retrieve $path : { };	3546	our @DATA; # dynamically-created facedata, only faceste 0 used
2156	}	3547	our @FOFS; # file offset, if > 0
		3548	our @SIZE; # size of face, in octets
		3549	our @META; # meta hash of face, if any
		3550	our $DATAFH; # facedata filehandle
2157		3551
2158	my $pid;	3552	# internal api, not finalised
		3553	sub set {
		3554	my ($name, $type, $data) = @_;
2159		3555
2160	sub db_save() {	3556	my $idx = cf::face::find $name;
2161	waitpid $pid, 0 if $pid;
2162	if (0 == ($pid = fork)) {
2163	$DB->{_meta}{version} = 1;
2164	Storable::nstore $DB, "$path~";
2165	rename "$path~", $path;
2166	cf::_exit 0 if defined $pid;
2167	}
2168	}
2169		3557
2170	my $dirty;	3558	if ($idx) {
2171		3559	delete $HASH{cf::face::get_csum $idx};
2172	sub db_sync() {
2173	db_save if $dirty;
2174	undef $dirty;
2175	}
2176
2177	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2178	db_sync;
2179	});
2180
2181	sub db_dirty() {
2182	$dirty = 1;
2183	$idle->start;
2184	}
2185
2186	sub db_get($;$) {
2187	@_ >= 2
2188	? $DB->{$_[0]}{$_[1]}
2189	: ($DB->{$_[0]} ||= { })
2190	}
2191
2192	sub db_put($$;$) {
2193	if (@_ >= 3) {
2194	$DB->{$_[0]}{$_[1]} = $_[2];
2195	} else {	3560	} else {
2196	$DB->{$_[0]} = $_[1];	3561	$idx = cf::face::alloc $name;
2197	}
2198	db_dirty;
2199	}
2200
2201	cf::global->attach (
2202	prio => 10000,
2203	on_cleanup => sub {
2204	db_sync;
2205	},	3562	}
		3563
		3564	my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
		3565
		3566	cf::face::set_type $idx, $type;
		3567	cf::face::set_csum $idx, 0, $hash;
		3568
		3569	# we need to destroy the SV itself, not just modify it, as a running ix
		3570	# might hold a reference to it: "delete" achieves that.
		3571	delete $FOFS[0][$idx];
		3572	delete $DATA[0][$idx];
		3573	$DATA[0][$idx] = $data;
		3574	$SIZE[0][$idx] = length $data;
		3575	delete $META[$idx];
		3576	$HASH{$hash} = $idx;#d#
		3577
		3578	$idx
		3579	}
		3580
		3581	sub _get_data($$$) {
		3582	my ($idx, $set, $cb) = @_;
		3583
		3584	if (defined $DATA[$set][$idx]) {
		3585	$cb->($DATA[$set][$idx]);
		3586	} elsif (my $fofs = $FOFS[$set][$idx]) {
		3587	my $size = $SIZE[$set][$idx];
		3588	my $buf;
		3589	IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
		3590	if ($_[0] == $size) {
		3591	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3592	$cb->($buf);
		3593	} else {
		3594	cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
		3595	}
		3596	};
		3597	} else {
		3598	cf::error "requested facedata for unknown face $idx#$set, ignoring.";
		3599	}
		3600	}
		3601
		3602	# rather ineffient
		3603	sub cf::face::get_data($;$) {
		3604	my ($idx, $set) = @_;
		3605
		3606	_get_data $idx, $set, Coro::rouse_cb;
		3607	Coro::rouse_wait
		3608	}
		3609
		3610	sub cf::face::ix {
		3611	my ($ns, $set, $idx, $pri) = @_;
		3612
		3613	_get_data $idx, $set, sub {
		3614	$ns->ix_send ($idx, $pri, $_[0]);
		3615	};
		3616	}
		3617	}
		3618
		3619	sub load_facedata($) {
		3620	my ($path) = @_;
		3621
		3622	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3623
		3624	trace "loading facedata from $path\n";
		3625
		3626	my $facedata = decode_storable load_file "$path/faceinfo";
		3627
		3628	$facedata->{version} == 2
		3629	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3630
		3631	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3632	or cf::cleanup "$path/facedata: $!, cannot proceed.";
		3633
		3634	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3635
		3636	# BEGIN ATOMIC
		3637	# from here on, everything must be atomic - no thread switch allowed
		3638	my $t1 = EV::time;
		3639
		3640	{
		3641	my $faces = $facedata->{faceinfo};
		3642
		3643	for my $face (sort keys %$faces) {
		3644	my $info = $faces->{$face};
		3645	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3646
		3647	cf::face::set_visibility $idx, $info->{visibility};
		3648	cf::face::set_magicmap $idx, $info->{magicmap};
		3649	cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
		3650	cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
		3651	cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
		3652	$cf::face::HASH{$info->{hash64}} = $idx;
		3653	delete $cf::face::META[$idx];
		3654	}
		3655
		3656	while (my ($face, $info) = each %$faces) {
		3657	next unless $info->{smooth};
		3658
		3659	my $idx = cf::face::find $face
		3660	or next;
		3661
		3662	if (my $smooth = cf::face::find $info->{smooth}) {
		3663	cf::face::set_smooth $idx, $smooth;
		3664	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3665	} else {
		3666	error "smooth face '$info->{smooth}' not found for face '$face'";
		3667	}
		3668	}
		3669	}
		3670
		3671	{
		3672	my $anims = $facedata->{animinfo};
		3673
		3674	while (my ($anim, $info) = each %$anims) {
		3675	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3676	}
		3677
		3678	cf::anim::invalidate_all; # d'oh
		3679	}
		3680
		3681	{
		3682	my $res = $facedata->{resource};
		3683
		3684	while (my ($name, $info) = each %$res) {
		3685	if (defined (my $type = $info->{type})) {
		3686	# TODO: different hash - must free and use new index, or cache ixface data queue
		3687	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3688
		3689	cf::face::set_type $idx, $type;
		3690	cf::face::set_csum $idx, 0, $info->{hash};
		3691	$cf::face::SIZE[0][$idx] = $info->{size};
		3692	$cf::face::FOFS[0][$idx] = $info->{fofs};
		3693	$cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3694	$cf::face::HASH{$info->{hash}} = $idx;
		3695	} else {
		3696	# $RESOURCE{$name} = $info; # unused
		3697	}
		3698	}
		3699	}
		3700
		3701	($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
		3702
		3703	# HACK to clear player env face cache, we need some signal framework
		3704	# for this (global event?)
		3705	%ext::player_env::MUSIC_FACE_CACHE = ();
		3706
		3707	# END ATOMIC
		3708
		3709	cf::debug "facedata atomic update time ", EV::time - $t1;
		3710
		3711	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3712
		3713	aio_close $fh if $fh; # close old facedata
		3714
		3715	1
		3716	}
		3717
		3718	register_exticmd fx_want => sub {
		3719	my ($ns, $want) = @_;
		3720
		3721	while (my ($k, $v) = each %$want) {
		3722	$ns->fx_want ($k, $v);
		3723	}
		3724	};
		3725
		3726	sub load_resource_file($) {
		3727	my $guard = lock_acquire "load_resource_file";
		3728
		3729	my $status = load_resource_file_ $_[0];
		3730	get_slot 0.1, 100;
		3731	cf::arch::commit_load;
		3732
		3733	$status
		3734	}
		3735
		3736	sub reload_exp_table {
		3737	_reload_exp_table;
		3738
		3739	cf::face::set
		3740	"res/exp_table" => FT_RSRC,
		3741	JSON::XS->new->utf8->canonical->encode (
		3742	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
2206	);	3743	);
2207	}	3744	}
2208		3745
2209	#############################################################################	3746	sub reload_materials {
2210	# the server's main()	3747	_reload_materials;
		3748	}
2211		3749
2212	sub cfg_load {	3750	sub reload_regions {
2213	open my $fh, "<:utf8", cf::confdir . "/config"	3751	# HACK to clear player env face cache, we need some signal framework
2214	or return;	3752	# for this (global event?)
		3753	%ext::player_env::MUSIC_FACE_CACHE = ();
2215		3754
2216	local $/;	3755	load_resource_file "$MAPDIR/regions"
2217	*CFG = YAML::Syck::Load <$fh>;	3756	or die "unable to load regions file\n";
2218		3757
		3758	for (cf::region::list) {
		3759	$_->{match} = qr/$_->{match}/
		3760	if exists $_->{match};
		3761	}
		3762	}
		3763
		3764	sub reload_facedata {
		3765	load_facedata $DATADIR
		3766	or die "unable to load facedata\n";
		3767	}
		3768
		3769	sub reload_archetypes {
		3770	load_resource_file "$DATADIR/archetypes"
		3771	or die "unable to load archetypes\n";
		3772
		3773	cf::face::set
		3774	"res/skill_info" => FT_RSRC,
		3775	JSON::XS->new->utf8->canonical->encode (
		3776	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3777	);
		3778
		3779	cf::face::set
		3780	"res/spell_paths" => FT_RSRC,
		3781	JSON::XS->new->utf8->canonical->encode (
		3782	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3783	);
		3784	}
		3785
		3786	sub reload_treasures {
		3787	load_resource_file "$DATADIR/treasures"
		3788	or die "unable to load treasurelists\n";
		3789	}
		3790
		3791	sub reload_sound {
		3792	trace "loading sound config from $DATADIR/sound\n";
		3793
		3794	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3795
		3796	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3797	my $sound = $soundconf->{compat}[$_]
		3798	or next;
		3799
		3800	my $face = cf::face::find "sound/$sound->[1]";
		3801	cf::sound::set $sound->[0] => $face;
		3802	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3803	}
		3804
		3805	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3806	my $face = cf::face::find "sound/$v";
		3807	cf::sound::set $k => $face;
		3808	}
		3809	}
		3810
		3811	sub reload_resources {
		3812	trace "reloading resource files...\n";
		3813
		3814	reload_materials;
		3815	reload_facedata;
		3816	reload_exp_table;
		3817	reload_sound;
		3818	reload_archetypes;
		3819	reload_regions;
		3820	reload_treasures;
		3821
		3822	trace "finished reloading resource files\n";
		3823	}
		3824
		3825	sub reload_config {
		3826	trace "reloading config file...\n";
		3827
		3828	my $config = load_file "$CONFDIR/config";
		3829	utf8::decode $config;
		3830	*CFG = decode_yaml $config;
		3831
2219	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3832	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2220		3833
2221	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3834	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2222	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3835	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2223		3836
2224	if (exists $CFG{mlockall}) {	3837	if (exists $CFG{mlockall}) {
…		…
2228	};	3841	};
2229	warn $@ if $@;	3842	warn $@ if $@;
2230	}	3843	}
2231	}	3844	}
2232		3845
		3846	sub pidfile() {
		3847	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3848	or die "$PIDFILE: $!";
		3849	flock $fh, &Fcntl::LOCK_EX
		3850	or die "$PIDFILE: flock: $!";
		3851	$fh
		3852	}
		3853
		3854	# make sure only one server instance is running at any one time
		3855	sub atomic {
		3856	my $fh = pidfile;
		3857
		3858	my $pid = <$fh>;
		3859	kill 9, $pid if $pid > 0;
		3860
		3861	seek $fh, 0, 0;
		3862	print $fh $$;
		3863	}
		3864
		3865	sub main_loop {
		3866	trace "EV::loop starting\n";
		3867	if (1) {
		3868	EV::loop;
		3869	}
		3870	trace "EV::loop returned\n";
		3871	goto &main_loop unless $REALLY_UNLOOP;
		3872	}
		3873
2233	sub main {	3874	sub main {
		3875	cf::init_globals; # initialise logging
		3876
		3877	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3878	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3879	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3880	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3881
		3882	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3883
2234	# we must not ever block the main coroutine	3884	# we must not ever block the main coroutine
2235	local $Coro::idle = sub {	3885	$Coro::idle = sub {
2236	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3886	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2237	async { Event::one_event };	3887	(async {
		3888	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3889	EV::loop EV::LOOP_ONESHOT;
		3890	})->prio (Coro::PRIO_MAX);
2238	};	3891	};
2239		3892
2240	cfg_load;	3893	evthread_start IO::AIO::poll_fileno;
2241	db_load;	3894
		3895	cf::sync_job {
		3896	cf::incloader::init ();
		3897
		3898	db_init;
		3899
		3900	cf::init_anim;
		3901	cf::init_attackmess;
		3902	cf::init_dynamic;
		3903
		3904	cf::load_settings;
		3905
		3906	reload_resources;
		3907	reload_config;
		3908
		3909	cf::init_uuid;
		3910	cf::init_signals;
		3911	cf::init_skills;
		3912
		3913	cf::init_beforeplay;
		3914
		3915	atomic;
		3916
2242	load_extensions;	3917	load_extensions;
2243	Event::loop;	3918
		3919	utime time, time, $RUNTIMEFILE;
		3920
		3921	# no (long-running) fork's whatsoever before this point(!)
		3922	use POSIX ();
		3923	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3924
		3925	cf::_post_init 0;
		3926	};
		3927
		3928	cf::object::thawer::errors_are_fatal 0;
		3929	info "parse errors in files are no longer fatal from this point on.\n";
		3930
		3931	AE::postpone {
		3932	undef &main; # free gobs of memory :)
		3933	};
		3934
		3935	goto &main_loop;
2244	}	3936	}
2245		3937
2246	#############################################################################	3938	#############################################################################
2247	# initialisation and cleanup	3939	# initialisation and cleanup
2248		3940
2249	# install some emergency cleanup handlers	3941	# install some emergency cleanup handlers
2250	BEGIN {	3942	BEGIN {
		3943	our %SIGWATCHER = ();
2251	for my $signal (qw(INT HUP TERM)) {	3944	for my $signal (qw(INT HUP TERM)) {
2252	Event->signal (	3945	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2253	data => WF_AUTOCANCEL,
2254	signal => $signal,
2255	cb => sub {
2256	cf::cleanup "SIG$signal";	3946	cf::cleanup "SIG$signal";
2257	},
2258	);	3947	};
		3948	}
		3949	}
		3950
		3951	sub write_runtime_sync {
		3952	my $t0 = AE::time;
		3953
		3954	# first touch the runtime file to show we are still running:
		3955	# the fsync below can take a very very long time.
		3956
		3957	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3958
		3959	my $guard = cf::lock_acquire "write_runtime";
		3960
		3961	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3962	or return;
		3963
		3964	my $value = $cf::RUNTIME + 90 + 10;
		3965	# 10 is the runtime save interval, for a monotonic clock
		3966	# 60 allows for the watchdog to kill the server.
		3967
		3968	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3969	and return;
		3970
		3971	# always fsync - this file is important
		3972	aio_fsync $fh
		3973	and return;
		3974
		3975	# touch it again to show we are up-to-date
		3976	aio_utime $fh, undef, undef;
		3977
		3978	close $fh
		3979	or return;
		3980
		3981	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3982	and return;
		3983
		3984	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3985
2259	}	3986	1
		3987	}
		3988
		3989	our $uuid_lock;
		3990	our $uuid_skip;
		3991
		3992	sub write_uuid_sync($) {
		3993	$uuid_skip ||= $_[0];
		3994
		3995	return if $uuid_lock;
		3996	local $uuid_lock = 1;
		3997
		3998	my $uuid = "$LOCALDIR/uuid";
		3999
		4000	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		4001	or return;
		4002
		4003	my $value = uuid_seq uuid_cur;
		4004
		4005	unless ($value) {
		4006	info "cowardly refusing to write zero uuid value!\n";
		4007	return;
		4008	}
		4009
		4010	my $value = uuid_str $value + $uuid_skip;
		4011	$uuid_skip = 0;
		4012
		4013	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		4014	and return;
		4015
		4016	# always fsync - this file is important
		4017	aio_fsync $fh
		4018	and return;
		4019
		4020	close $fh
		4021	or return;
		4022
		4023	aio_rename "$uuid~", $uuid
		4024	and return;
		4025
		4026	trace "uuid file written ($value).\n";
		4027
		4028	1
		4029
		4030	}
		4031
		4032	sub write_uuid($$) {
		4033	my ($skip, $sync) = @_;
		4034
		4035	$sync ? write_uuid_sync $skip
		4036	: async { write_uuid_sync $skip };
2260	}	4037	}
2261		4038
2262	sub emergency_save() {	4039	sub emergency_save() {
2263	my $freeze_guard = cf::freeze_mainloop;	4040	my $freeze_guard = cf::freeze_mainloop;
2264		4041
2265	warn "enter emergency perl save\n";	4042	info "emergency_perl_save: enter\n";
		4043
		4044	# this is a trade-off: we want to be very quick here, so
		4045	# save all maps without fsync, and later call a global sync
		4046	# (which in turn might be very very slow)
		4047	local $USE_FSYNC = 0;
2266		4048
2267	cf::sync_job {	4049	cf::sync_job {
		4050	cf::write_runtime_sync; # external watchdog should not bark
		4051
2268	# use a peculiar iteration method to avoid tripping on perl	4052	# use a peculiar iteration method to avoid tripping on perl
2269	# refcount bugs in for. also avoids problems with players	4053	# refcount bugs in for. also avoids problems with players
2270	# and maps saved/destroyed asynchronously.	4054	# and maps saved/destroyed asynchronously.
2271	warn "begin emergency player save\n";	4055	info "emergency_perl_save: begin player save\n";
2272	for my $login (keys %cf::PLAYER) {	4056	for my $login (keys %cf::PLAYER) {
2273	my $pl = $cf::PLAYER{$login} or next;	4057	my $pl = $cf::PLAYER{$login} or next;
2274	$pl->valid or next;	4058	$pl->valid or next;
		4059	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2275	$pl->save;	4060	$pl->save;
2276	}	4061	}
2277	warn "end emergency player save\n";	4062	info "emergency_perl_save: end player save\n";
2278		4063
2279	warn "begin emergency map save\n";	4064	cf::write_runtime_sync; # external watchdog should not bark
		4065
		4066	info "emergency_perl_save: begin map save\n";
2280	for my $path (keys %cf::MAP) {	4067	for my $path (keys %cf::MAP) {
2281	my $map = $cf::MAP{$path} or next;	4068	my $map = $cf::MAP{$path} or next;
2282	$map->valid or next;	4069	$map->valid or next;
2283	$map->save;	4070	$map->save;
2284	}	4071	}
2285	warn "end emergency map save\n";	4072	info "emergency_perl_save: end map save\n";
		4073
		4074	cf::write_runtime_sync; # external watchdog should not bark
		4075
		4076	info "emergency_perl_save: begin database checkpoint\n";
		4077	BDB::db_env_txn_checkpoint $DB_ENV;
		4078	info "emergency_perl_save: end database checkpoint\n";
		4079
		4080	info "emergency_perl_save: begin write uuid\n";
		4081	write_uuid_sync 1;
		4082	info "emergency_perl_save: end write uuid\n";
		4083
		4084	cf::write_runtime_sync; # external watchdog should not bark
		4085
		4086	trace "emergency_perl_save: syncing database to disk";
		4087	BDB::db_env_txn_checkpoint $DB_ENV;
		4088
		4089	info "emergency_perl_save: starting sync\n";
		4090	IO::AIO::aio_sync sub {
		4091	info "emergency_perl_save: finished sync\n";
		4092	};
		4093
		4094	cf::write_runtime_sync; # external watchdog should not bark
		4095
		4096	trace "emergency_perl_save: flushing outstanding aio requests";
		4097	while (IO::AIO::nreqs || BDB::nreqs) {
		4098	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4099	}
		4100
		4101	cf::write_runtime_sync; # external watchdog should not bark
2286	};	4102	};
2287		4103
2288	warn "leave emergency perl save\n";	4104	info "emergency_perl_save: leave\n";
2289	}	4105	}
2290		4106
		4107	sub post_cleanup {
		4108	my ($make_core) = @_;
		4109
		4110	IO::AIO::flush;
		4111
		4112	error Carp::longmess "post_cleanup backtrace"
		4113	if $make_core;
		4114
		4115	my $fh = pidfile;
		4116	unlink $PIDFILE if <$fh> == $$;
		4117	}
		4118
		4119	# a safer delete_package, copied from Symbol
		4120	sub clear_package($) {
		4121	my $pkg = shift;
		4122
		4123	# expand to full symbol table name if needed
		4124	unless ($pkg =~ /^main::.*::$/) {
		4125	$pkg = "main$pkg" if $pkg =~ /^::/;
		4126	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4127	$pkg .= '::' unless $pkg =~ /::$/;
		4128	}
		4129
		4130	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4131	my $stem_symtab = *{$stem}{HASH};
		4132
		4133	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4134	or return;
		4135
		4136	# clear all symbols
		4137	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4138	for my $name (keys %$leaf_symtab) {
		4139	_gv_clear *{"$pkg$name"};
		4140	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4141	}
		4142	}
		4143
2291	sub reload() {	4144	sub do_reload_perl() {
2292	# can/must only be called in main	4145	# can/must only be called in main
2293	if ($Coro::current != $Coro::main) {	4146	unless (in_main) {
2294	warn "can only reload from main coroutine\n";	4147	error "can only reload from main coroutine";
2295	return;	4148	return;
2296	}	4149	}
2297		4150
2298	warn "reloading...";	4151	return if $RELOAD++;
2299		4152
2300	warn "freezing server";	4153	my $t1 = AE::time;
2301	my $guard = freeze_mainloop;	4154
		4155	while ($RELOAD) {
		4156	cf::get_slot 0.1, -1, "reload_perl";
		4157	info "perl_reload: reloading...";
		4158
		4159	trace "perl_reload: entering sync_job";
		4160
		4161	cf::sync_job {
2302	cf::emergency_save;	4162	#cf::emergency_save;
2303		4163
2304	warn "sync database to disk";	4164	trace "perl_reload: cancelling all extension coros";
2305	cf::db_sync;
2306	IO::AIO::flush;
2307
2308	eval {
2309	# if anything goes wrong in here, we should simply crash as we already saved
2310
2311	warn "cancel all watchers";
2312	for (Event::all_watchers) {
2313	$_->cancel if $_->data & WF_AUTOCANCEL;
2314	}
2315
2316	warn "cancel all extension coros";
2317	$_->cancel for values %EXT_CORO;	4165	$_->cancel for values %EXT_CORO;
2318	%EXT_CORO = ();	4166	%EXT_CORO = ();
2319		4167
2320	warn "remove commands";	4168	trace "perl_reload: removing commands";
2321	%COMMAND = ();	4169	%COMMAND = ();
2322		4170
2323	warn "remove ext commands";	4171	trace "perl_reload: removing ext/exti commands";
2324	%EXTCMD = ();	4172	%EXTCMD = ();
		4173	%EXTICMD = ();
2325		4174
2326	warn "unload/nuke all extensions";	4175	trace "perl_reload: unloading/nuking all extensions";
2327	for my $pkg (@EXTS) {	4176	for my $pkg (@EXTS) {
2328	warn "... unloading $pkg";	4177	trace "... unloading $pkg";
2329		4178
2330	if (my $cb = $pkg->can ("unload")) {	4179	if (my $cb = $pkg->can ("unload")) {
2331	eval {	4180	eval {
2332	$cb->($pkg);	4181	$cb->($pkg);
2333	1	4182	1
2334	} or warn "$pkg unloaded, but with errors: $@";	4183	} or error "$pkg unloaded, but with errors: $@";
		4184	}
		4185
		4186	trace "... clearing $pkg";
		4187	clear_package $pkg;
2335	}	4188	}
2336		4189
2337	warn "... nuking $pkg";
2338	Symbol::delete_package $pkg;
2339	}
2340
2341	warn "unload all perl modules loaded from $LIBDIR";	4190	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2342	while (my ($k, $v) = each %INC) {	4191	while (my ($k, $v) = each %INC) {
2343	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4192	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2344		4193
2345	warn "removing <$k>";	4194	trace "... unloading $k";
2346	delete $INC{$k};	4195	delete $INC{$k};
2347		4196
2348	$k =~ s/\.pm$//;	4197	$k =~ s/\.pm$//;
2349	$k =~ s/\//::/g;	4198	$k =~ s/\//::/g;
2350		4199
2351	if (my $cb = $k->can ("unload_module")) {	4200	if (my $cb = $k->can ("unload_module")) {
2352	$cb->();	4201	$cb->();
		4202	}
		4203
		4204	clear_package $k;
2353	}	4205	}
2354		4206
2355	Symbol::delete_package $k;
2356	}
2357
2358	warn "get rid of safe::, as good as possible";	4207	trace "perl_reload: getting rid of safe::, as good as possible";
2359	Symbol::delete_package "safe::$_"	4208	clear_package "safe::$_"
2360	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4209	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2361		4210
2362	warn "unload cf.pm \"a bit\"";	4211	trace "perl_reload: unloading cf.pm \"a bit\"";
2363	delete $INC{"cf.pm"};	4212	delete $INC{"cf.pm"};
		4213	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2364		4214
2365	# don't, removes xs symbols, too,	4215	# don't, removes xs symbols, too,
2366	# and global variables created in xs	4216	# and global variables created in xs
2367	#Symbol::delete_package __PACKAGE__;	4217	#clear_package __PACKAGE__;
2368		4218
2369	warn "reloading cf.pm";	4219	info "perl_reload: unload completed, starting to reload now";
		4220
		4221	trace "perl_reload: reloading cf.pm";
2370	require cf;	4222	require cf;
2371	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4223	cf::_connect_to_perl_1;
2372		4224
2373	warn "load config and database again";	4225	trace "perl_reload: loading config and database again";
2374	cf::cfg_load;	4226	cf::reload_config;
2375	cf::db_load;
2376		4227
2377	warn "load extensions";	4228	trace "perl_reload: loading extensions";
2378	cf::load_extensions;	4229	cf::load_extensions;
2379		4230
		4231	if ($REATTACH_ON_RELOAD) {
2380	warn "reattach attachments to objects/players";	4232	trace "perl_reload: reattaching attachments to objects/players";
2381	_global_reattach;	4233	_global_reattach; # objects, sockets
2382	warn "reattach attachments to maps";	4234	trace "perl_reload: reattaching attachments to maps";
2383	reattach $_ for values %MAP;	4235	reattach $_ for values %MAP;
		4236	trace "perl_reload: reattaching attachments to players";
		4237	reattach $_ for values %PLAYER;
		4238	}
		4239
		4240	cf::_post_init 1;
		4241
		4242	trace "perl_reload: leaving sync_job";
		4243
		4244	1
		4245	} or do {
		4246	error $@;
		4247	cf::cleanup "perl_reload: error, exiting.";
		4248	};
		4249
		4250	--$RELOAD;
		4251	}
		4252
		4253	$t1 = AE::time - $t1;
		4254	info "perl_reload: completed in ${t1}s\n";
		4255	};
		4256
		4257	our $RELOAD_WATCHER; # used only during reload
		4258
		4259	sub reload_perl() {
		4260	# doing reload synchronously and two reloads happen back-to-back,
		4261	# coro crashes during coro_state_free->destroy here.
		4262
		4263	$RELOAD_WATCHER ||= cf::async {
		4264	Coro::AIO::aio_wait cache_extensions;
		4265
		4266	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4267	do_reload_perl;
		4268	undef $RELOAD_WATCHER;
		4269	};
2384	};	4270	};
2385		4271	}
2386	if ($@) {
2387	warn $@;
2388	warn "error while reloading, exiting.";
2389	exit 1;
2390	}
2391
2392	warn "reloaded";
2393	};
2394		4272
2395	register_command "reload" => sub {	4273	register_command "reload" => sub {
2396	my ($who, $arg) = @_;	4274	my ($who, $arg) = @_;
2397		4275
2398	if ($who->flag (FLAG_WIZ)) {	4276	if ($who->flag (FLAG_WIZ)) {
2399	$who->message ("start of reload.");
2400	reload;
2401	$who->message ("end of reload.");	4277	$who->message ("reloading server.");
		4278	async {
		4279	$Coro::current->{desc} = "perl_reload";
		4280	reload_perl;
		4281	};
2402	}	4282	}
2403	};	4283	};
2404		4284
2405	unshift @INC, $LIBDIR;	4285	#############################################################################
2406		4286
2407	$TICK_WATCHER = Event->timer (	4287	my $bug_warning = 0;
2408	reentrant => 0,
2409	prio => 0,
2410	at => $NEXT_TICK || $TICK,
2411	data => WF_AUTOCANCEL,
2412	cb => sub {
2413	$NOW = Event::time;
2414		4288
2415	cf::server_tick; # one server iteration	4289	sub wait_for_tick() {
2416	$RUNTIME += $TICK;	4290	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2417	$NEXT_TICK += $TICK;
2418		4291
		4292	$WAIT_FOR_TICK->wait;
		4293	}
		4294
		4295	sub wait_for_tick_begin() {
		4296	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4297
		4298	my $signal = new Coro::Signal;
		4299	push @WAIT_FOR_TICK_BEGIN, $signal;
		4300	$signal->wait;
		4301	}
		4302
		4303	sub tick {
		4304	if ($Coro::current != $Coro::main) {
		4305	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4306	unless ++$bug_warning > 10;
		4307	return;
		4308	}
		4309
		4310	cf::one_tick; # one server iteration
		4311
		4312	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		4313
		4314	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		4315	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		4316	Coro::async_pool {
		4317	$Coro::current->{desc} = "runtime saver";
		4318	write_runtime_sync
		4319	or error "ERROR: unable to write runtime file: $!";
		4320	};
		4321	}
		4322
		4323	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4324	$sig->send;
		4325	}
2419	$WAIT_FOR_TICK->broadcast;	4326	$WAIT_FOR_TICK->broadcast;
2420	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2421		4327
2422	# if we are delayed by four ticks or more, skip them all	4328	$LOAD = ($NOW - $TICK_START) / $TICK;
2423	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4329	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2424		4330
2425	$TICK_WATCHER->at ($NEXT_TICK);	4331	if (0) {
2426	$TICK_WATCHER->start;	4332	if ($NEXT_TICK) {
		4333	my $jitter = $TICK_START - $NEXT_TICK;
		4334	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4335	debug "jitter $JITTER\n";#d#
		4336	}
2427	},	4337	}
2428	);	4338	}
2429		4339
		4340	{
		4341	# configure BDB
		4342	info "initialising database";
		4343
		4344	BDB::min_parallel 16;
		4345	BDB::max_poll_reqs $TICK * 0.1;
		4346	#$AnyEvent::BDB::WATCHER->priority (1);
		4347
		4348	unless ($DB_ENV) {
		4349	$DB_ENV = BDB::db_env_create;
		4350	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4351	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4352	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4353	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4354	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4355
		4356	cf::sync_job {
		4357	eval {
		4358	BDB::db_env_open
		4359	$DB_ENV,
		4360	$BDBDIR,
		4361	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4362	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4363	0666;
		4364
		4365	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4366	};
		4367
		4368	cf::cleanup "db_env_open(db): $@" if $@;
		4369	};
		4370	}
		4371
		4372	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4373	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4374	};
		4375	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4376	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4377	};
		4378	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4379	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4380	};
		4381
		4382	info "database initialised";
		4383	}
		4384
		4385	{
		4386	# configure IO::AIO
		4387
		4388	info "initialising aio";
		4389	IO::AIO::min_parallel 8;
2430	IO::AIO::max_poll_time $TICK * 0.2;	4390	IO::AIO::max_poll_time $TICK * 0.1;
		4391	undef $AnyEvent::AIO::WATCHER;
		4392	info "aio initialised";
		4393	}
2431		4394
2432	$AIO_POLL_WATCHER = Event->io (	4395	our $_log_backtrace;
2433	fd => IO::AIO::poll_fileno,	4396	our $_log_backtrace_last;
2434	poll => 'r',
2435	prio => 5,
2436	data => WF_AUTOCANCEL,
2437	cb => \&IO::AIO::poll_cb,
2438	);
2439		4397
2440	$WRITE_RUNTIME_WATCHER = Event->timer (	4398	sub _log_backtrace {
2441	data => WF_AUTOCANCEL,	4399	my ($msg, @addr) = @_;
2442	after => 0,	4400
2443	interval => 10,	4401	$msg =~ s/\n$//;
2444	cb => sub {	4402
2445	(Coro::unblock_sub {	4403	if ($_log_backtrace_last eq $msg) {
2446	write_runtime	4404	LOG llevInfo, "[ABT] $msg\n";
2447	or warn "ERROR: unable to write runtime file: $!";	4405	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4406	# limit the # of concurrent backtraces
		4407	} elsif ($_log_backtrace < 2) {
		4408	$_log_backtrace_last = $msg;
		4409	++$_log_backtrace;
		4410	my $perl_bt = Carp::longmess $msg;
		4411	async {
		4412	$Coro::current->{desc} = "abt $msg";
		4413
		4414	my @bt = fork_call {
		4415	@addr = map { sprintf "%x", $_ } @addr;
		4416	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4417	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4418	or die "addr2line: $!";
		4419
		4420	my @funcs;
		4421	my @res = <$fh>;
		4422	chomp for @res;
		4423	while (@res) {
		4424	my ($func, $line) = splice @res, 0, 2, ();
		4425	push @funcs, "[$func] $line";
		4426	}
		4427
		4428	@funcs
		4429	};
		4430
		4431	LOG llevInfo, "[ABT] $perl_bt\n";
		4432	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4433	LOG llevInfo, "[ABT] $_\n" for @bt;
		4434	--$_log_backtrace;
2448	})->();	4435	};
		4436	} else {
		4437	LOG llevInfo, "[ABT] $msg\n";
		4438	LOG llevInfo, "[ABT] [overload, suppressed]\n";
2449	},	4439	}
2450	);	4440	}
		4441
		4442	# load additional modules
		4443	require "cf/$_.pm" for @EXTRA_MODULES;
		4444	cf::_connect_to_perl_2;
2451		4445
2452	END { cf::emergency_save }	4446	END { cf::emergency_save }
2453		4447
2454	1	4448	1
2455		4449

Diff Legend

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