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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.598 by root, Sun Nov 11 02:38:10 2012 UTC

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

Diff Legend

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