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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.620 by root, Tue Aug 11 02:13:26 2015 UTC

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

Diff Legend

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