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.119 by root, Tue Jan 2 08:26:42 2007 UTC vs.
Revision 1.624 by root, Sat Nov 17 23:40:02 2018 UTC

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

Diff Legend

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