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

Diff Legend

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