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

Diff Legend

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