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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.613 by root, Mon Nov 26 13:12:16 2012 UTC

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

Diff Legend

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