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

Diff Legend

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