ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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