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.127 by root, Wed Jan 3 00:05:26 2007 UTC vs.
Revision 1.614 by root, Mon Nov 26 15:12:16 2012 UTC

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

Diff Legend

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