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

Diff Legend

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