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.249 by root, Wed Apr 18 12:43:54 2007 UTC vs.
Revision 1.608 by root, Sun Nov 18 09:53:57 2012 UTC

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

Diff Legend

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