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

Diff Legend

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