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

Diff Legend

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