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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.613 by root, Mon Nov 26 13:12:16 2012 UTC

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

Diff Legend

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