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.191 by root, Tue Jan 23 01:05:18 2007 UTC vs.
Revision 1.615 by root, Sat Feb 23 22:37:39 2013 UTC

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

Diff Legend

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