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.138 by root, Fri Jan 5 17:07:17 2007 UTC vs.
Revision 1.623 by root, Wed Aug 30 14:18:51 2017 UTC

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

Diff Legend

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