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

Diff Legend

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