ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.587 by root, Wed Oct 31 19:09:47 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
42	our %EXT_MAP = (); # pluggable maps	94	our %EXT_MAP = (); # pluggable maps
43		95
		96	our $RELOAD; # number of reloads so far, non-zero while in reload
44	our @EVENT;	97	our @EVENT;
45	our $LIBDIR = datadir . "/ext";	98	our @REFLECT; # set by XS
		99	our %REFLECT; # set by us
46		100
47	our $TICK = MAX_TIME * 1e-6;	101	our $CONFDIR = confdir;
48	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
49	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;
50	our $NOW;	143	our $NOW;
51		144
52	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
53		148
54	our $UPTIME; $UPTIME ||= time;	149	# used to convert map paths into valid unix filenames by replacing / by ∕
55	our $RUNTIME;	150	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
56		151
57	our %PLAYER; # all users	152	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
58	our %MAP; # all maps	153	our $LOADAVG; # same thing, but with alpha-smoothing
59	our $LINK_MAP; # the special {link} map	154	our $JITTER; # average jitter
60	our $RANDOM_MAPS = cf::localdir . "/random";	155	our $TICK_START; # for load detecting purposes
61		156
62	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	157	our @POST_INIT;
63	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;
64		164
65	binmode STDOUT;	165	binmode STDOUT;
66	binmode STDERR;	166	binmode STDERR;
67		167
68	# read virtual server time, if available	168	# read virtual server time, if available
69	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	169	unless ($RUNTIME || !-e $RUNTIMEFILE) {
70	open my $fh, "<", cf::localdir . "/runtime"	170	open my $fh, "<", $RUNTIMEFILE
71	or die "unable to read runtime file: $!";	171	or die "unable to read $RUNTIMEFILE file: $!";
72	$RUNTIME = <$fh> + 0.;	172	$RUNTIME = <$fh> + 0.;
73	}	173	}
74		174
75	mkdir cf::localdir;	175	eval "sub TICK() { $TICK } 1" or die;
76	mkdir cf::localdir . "/" . cf::playerdir;
77	mkdir cf::localdir . "/" . cf::tmpdir;
78	mkdir cf::localdir . "/" . cf::uniquedir;
79	mkdir $RANDOM_MAPS;
80		176
81	# a special map that is always available	177	mkdir $_
82	our $LINK_MAP;	178	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		179
83	our $EMERGENCY_POSITION;	180	our $EMERGENCY_POSITION;
84		181
		182	sub cf::map::normalise;
		183
		184	sub in_main() {
		185	$Coro::current == $Coro::main
		186	}
		187
85	#############################################################################	188	#############################################################################
86		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
87	=head2 GLOBAL VARIABLES	201	=head2 GLOBAL VARIABLES
88		202
89	=over 4	203	=over 4
90		204
91	=item $cf::UPTIME	205	=item $cf::UPTIME
92		206
93	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.
94		223
95	=item $cf::RUNTIME	224	=item $cf::RUNTIME
96		225
97	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
98	every server tick.	227	every server tick.
99		228
100	=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
101		232
102	The perl library directory, where extensions and cf-specific modules can	233	Various directories - "/etc", read-only install directory, perl-library
103	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.
104		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
105	=item $cf::NOW	244	=item $cf::LOAD
106		245
107	The time of the last (current) server tick.	246	The raw value load value from the last tick.
108
109	=item $cf::TICK
110
111	The interval between server ticks, in seconds.
112		247
113	=item %cf::CFG	248	=item %cf::CFG
114		249
115	Configuration for the server, loaded from C</etc/crossfire/config>, or	250	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
116	from wherever your confdir points to.	251	from wherever your confdir points to.
117		252
118	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	253	=item cf::wait_for_tick, cf::wait_for_tick_begin
119		254
120	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
121	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
122	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.
123	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.
124		287
125	=back	288	=back
126		289
127	=cut	290	=cut
128		291
129	BEGIN {	292	sub error(@) { LOG llevError, join "", @_ }
130	*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 {
131	my $msg = join "", @_;	299	my $msg = join "", @_;
132	utf8::encode $msg;
133		300
134	$msg .= "\n"	301	$msg .= "\n"
135	unless $msg =~ /\n$/;	302	unless $msg =~ /\n$/;
136		303
		304	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		305
137	LOG llevError, $msg;	306	LOG llevWarn, $msg;
138	};	307	};
139	}	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	};
140		322
141	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	323	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
142	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	324	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
143	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	325	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
144	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	326	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
145	@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';
146	@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)
147		330
148	# 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
149	# within the Safe compartment.	332	# within the Safe compartment.
150	for my $pkg (qw(	333	for my $pkg (qw(
151	cf::global cf::attachable	334	cf::global cf::attachable
152	cf::object cf::object::player	335	cf::object cf::object::player
153	cf::client cf::player	336	cf::client cf::player
154	cf::arch cf::living	337	cf::arch cf::living
		338	cf::map cf::mapspace
155	cf::map cf::party cf::region	339	cf::party cf::region
156	)) {	340	)) {
157	no strict 'refs';
158	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	341	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
159	}	342	}
160		343
161	$Event::DIED = sub {	344	$EV::DIED = sub {
162	warn "error in event callback: @_";	345	warn "error in event callback: $@";
163	};	346	};
		347
		348	#############################################################################
		349
		350	sub fork_call(&@);
		351	sub get_slot($;$$);
		352
		353	#############################################################################
164		354
165	=head2 UTILITY FUNCTIONS	355	=head2 UTILITY FUNCTIONS
166		356
167	=over 4	357	=over 4
168		358
…		…
187	$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;
188	$d	378	$d
189	} || "[unable to dump $_[0]: '$@']";	379	} || "[unable to dump $_[0]: '$@']";
190	}	380	}
191		381
192	use JSON::Syck (); # TODO# replace by JSON::PC once working	382	=item $scalar = cf::load_file $path
193		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
194	=item $ref = cf::from_json $json	434	=item $ref = cf::decode_json $json
195		435
196	Converts a JSON string into the corresponding perl data structure.	436	Converts a JSON string into the corresponding perl data structure.
197		437
198	=cut
199
200	sub from_json($) {
201	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
202	JSON::Syck::Load $_[0]
203	}
204
205	=item $json = cf::to_json $ref	438	=item $json = cf::encode_json $ref
206		439
207	Converts a perl data structure into its JSON representation.	440	Converts a perl data structure into its JSON representation.
208		441
209	=cut	442	=cut
210		443
211	sub to_json($) {	444	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
212	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	445
213	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	}
214	}	509	}
215		510
216	=item cf::lock_wait $string	511	=item cf::lock_wait $string
217		512
218	Wait until the given lock is available. See cf::lock_acquire.	513	Wait until the given lock is available. See cf::lock_acquire.
219		514
220	=item my $lock = cf::lock_acquire $string	515	=item my $lock = cf::lock_acquire $string
221		516
222	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
223	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,
224	for example when the coroutine gets canceled), the lock is automatically	519	for example when the coroutine gets canceled), the lock is automatically
225	returned.	520	returned.
226		521
		522	Locks are *not* recursive, locking from the same coro twice results in a
		523	deadlocked coro.
		524
227	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
228	uses map_find and cf::map::load uses map_load).	526	uses map_find and cf::map::load uses map_load).
229		527
230	=cut	528	=item $locked = cf::lock_active $string
231		529
232	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;
233		535
234	sub lock_wait($) {	536	sub lock_wait($) {
235	my ($key) = @_;	537	$LOCKS->wait ($_[0]);
236
237	# wait for lock, if any
238	while ($LOCK{$key}) {
239	push @{ $LOCK{$key} }, $Coro::current;
240	Coro::schedule;
241	}
242	}	538	}
243		539
244	sub lock_acquire($) {	540	sub lock_acquire($) {
245	my ($key) = @_;	541	$LOCKS->guard ($_[0])
		542	}
246		543
247	# wait, to be sure we are not locked	544	sub lock_active($) {
248	lock_wait $key;	545	$LOCKS->count ($_[0]) < 1
249
250	$LOCK{$key} = [];
251
252	Coro::guard {
253	# wake up all waiters, to be on the safe side
254	$_->ready for @{ delete $LOCK{$key} };
255	}
256	}	546	}
257		547
258	sub freeze_mainloop {	548	sub freeze_mainloop {
259	return unless $TICK_WATCHER->is_active;	549	tick_inhibit_inc;
260		550
261	my $guard = Coro::guard { $TICK_WATCHER->start };	551	&Guard::guard (\&tick_inhibit_dec);
262	$TICK_WATCHER->stop;	552	}
263	$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;
264	}	637	}
265		638
266	=item cf::async { BLOCK }	639	=item cf::async { BLOCK }
267		640
268	Currently the same as Coro::async_pool, meaning you cannot use	641	Currently the same as Coro::async_pool, meaning you cannot use
…		…
273		646
274	BEGIN { *async = \&Coro::async_pool }	647	BEGIN { *async = \&Coro::async_pool }
275		648
276	=item cf::sync_job { BLOCK }	649	=item cf::sync_job { BLOCK }
277		650
278	The design of crossfire+ requires that the main coro ($Coro::main) is	651	The design of Deliantra requires that the main coroutine ($Coro::main)
279	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
280	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.
281		655
282	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
283	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
284	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
285	fast or be very important.	659	fast or be very important.
…		…
287	=cut	661	=cut
288		662
289	sub sync_job(&) {	663	sub sync_job(&) {
290	my ($job) = @_;	664	my ($job) = @_;
291		665
292	if ($Coro::current == $Coro::main) {	666	if (in_main) {
		667	my $time = AE::time;
		668
293	# this is the main coro, too bad, we have to block	669	# this is the main coro, too bad, we have to block
294	# till the operation succeeds, freezing the server :/	670	# till the operation succeeds, freezing the server :/
295		671
296	# TODO: use suspend/resume instead	672	#LOG llevError, Carp::longmess "sync job";#d#
297	# (but this is cancel-safe)	673
298	my $freeze_guard = freeze_mainloop;	674	my $freeze_guard = freeze_mainloop;
299		675
300	my $busy = 1;	676	my $busy = 1;
301	my @res;	677	my @res;
302		678
303	(async {	679	(async {
		680	$Coro::current->desc ("sync job coro");
304	@res = eval { $job->() };	681	@res = eval { $job->() };
305	warn $@ if $@;	682	error $@ if $@;
306	undef $busy;	683	undef $busy;
307	})->prio (Coro::PRIO_MAX);	684	})->prio (Coro::PRIO_MAX);
308		685
309	while ($busy) {	686	while ($busy) {
310	Coro::cede or Event::one_event;	687	if (Coro::nready) {
		688	Coro::cede_notself;
		689	} else {
		690	EV::loop EV::LOOP_ONESHOT;
311	}	691	}
		692	}
		693
		694	my $time = AE::time - $time;
		695
		696	$TICK_START += $time; # do not account sync jobs to server load
312		697
313	wantarray ? @res : $res[0]	698	wantarray ? @res : $res[0]
314	} else {	699	} else {
315	# we are in another coroutine, how wonderful, everything just works	700	# we are in another coroutine, how wonderful, everything just works
316		701
…		…
336	$EXT_CORO{$coro+0} = $coro;	721	$EXT_CORO{$coro+0} = $coro;
337		722
338	$coro	723	$coro
339	}	724	}
340		725
341	sub write_runtime {	726	=item fork_call { }, @args
342	my $runtime = cf::localdir . "/runtime";
343		727
344	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	728	Executes the given code block with the given arguments in a seperate
345	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.
346		732
347	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	733	=cut
348	(aio_write $fh, 0, (length $value), $value, 0) <= 0
349	and return;
350		734
351	aio_fsync $fh	735	sub post_fork {
352	and return;	736	reset_signals;
		737	}
353		738
354	close $fh	739	sub fork_call(&@) {
355	or return;	740	my ($cb, @args) = @_;
356		741
357	aio_rename "$runtime~", $runtime	742	# we seemingly have to make a local copy of the whole thing,
358	and return;	743	# otherwise perl prematurely frees the stuff :/
		744	# TODO: investigate and fix (likely this will be rather laborious)
359		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 {
360	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 });
361	}	929	}
362		930
363	=back	931	=back
364		932
365	=cut	933	=cut
366		934
367	#############################################################################	935	#############################################################################
368		936
369	package cf::path;
370
371	use overload
372	'""' => \&as_string;
373
374	# used to convert map paths into valid unix filenames by repalcing / by ∕
375	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
376
377	sub register {
378	my ($pkg, $prefix) = @_;
379
380	$EXT_MAP{$prefix} = $pkg;
381	}
382
383	sub new {
384	my ($class, $path, $base) = @_;
385
386	return $path if ref $path;
387
388	my $self = {};
389
390	# {... are special paths that are not being touched
391	# ?xxx/... are special absolute paths
392	# ?random/... random maps
393	# /! non-realised random map exit
394	# /... normal maps
395	# ~/... per-player maps without a specific player (DO NOT USE)
396	# ~user/... per-player map of a specific user
397
398	$path =~ s/$PATH_SEP/\//go;
399
400	if ($path =~ /^{/) {
401	# fine as it is
402	} else {
403	if ($path =~ s{^~([^/]+)?}{}) {
404	# ~user
405	$self->{user_rel} = 1;
406
407	if (defined $1) {
408	$self->{user} = $1;
409	} elsif ($base =~ m{^~([^/]+)/}) {
410	$self->{user} = $1;
411	} else {
412	warn "cannot resolve user-relative path without user <$path,$base>\n";
413	}
414	} elsif ($path =~ s{^\?([^/]+)/}{}) {
415	# ?...
416	$self->{ext} = $1;
417	if (my $ext = $EXT_MAP{$1}) {
418	bless $self, $ext;
419	}
420	} elsif ($path =~ /^\//) {
421	# /...
422	# already absolute
423	} else {
424	# relative
425	$base =~ s{[^/]+/?$}{};
426	return $class->new ("$base/$path");
427	}
428
429	for ($path) {
430	redo if s{/\.?/}{/};
431	redo if s{/[^/]+/\.\./}{/};
432	}
433	}
434
435	$self->{path} = $path;
436
437	if ("HASH" eq ref $self) {
438	bless $self, $class;
439	} else {
440	$self->init;
441	}
442
443	for my $ext (values %EXT_MAP) {
444	if (my $subst = $ext->substitute ($self)) {
445	return $subst;
446	}
447	}
448
449	$self
450	}
451
452	sub init {
453	# nop
454	}
455
456	sub substitute {
457	()
458	}
459
460	# the name / primary key / in-game path
461	sub as_string {
462	my ($self) = @_;
463
464	$self->{user_rel} ? "~$self->{user}$self->{path}"
465	: $self->{ext} ? "?$self->{ext}/$self->{path}"
466	: $self->{path}
467	}
468
469	# the displayed name, this is a one way mapping
470	sub visible_name {
471	&as_string
472	}
473
474	# escape the /'s in the path
475	sub _escaped_path {
476	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
477	$path
478	}
479
480	# the original (read-only) location
481	sub load_path {
482	my ($self) = @_;
483
484	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
485	}
486
487	# the temporary/swap location
488	sub save_path {
489	my ($self) = @_;
490
491	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
492	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
493	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
494	}
495
496	# the unique path, undef == no special unique path
497	sub uniq_path {
498	my ($self) = @_;
499
500	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
501	}
502
503	# this is somewhat ugly, but style maps do need special treatment
504	sub is_style_map {
505	$_[0]{path} =~ m{^/styles/}
506	}
507
508	sub load_orig {
509	my ($self) = @_;
510
511	&cf::map::load_map_header ($self->load_path)
512	}
513
514	sub load_temp {
515	my ($self) = @_;
516
517	&cf::map::load_map_header ($self->save_path)
518	}
519
520	package cf;
521
522	#############################################################################
523
524	=head2 ATTACHABLE OBJECTS	937	=head2 ATTACHABLE OBJECTS
525		938
526	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
527	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")
528	to it. All such attachable objects support the following methods.	941	to it. All such attachable objects support the following methods.
529		942
530	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>
531	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
532	crossfire+).	945	Deliantra).
533		946
534	=over 4	947	=over 4
535		948
536	=item $attachable->attach ($attachment, key => $value...)	949	=item $attachable->attach ($attachment, key => $value...)
537		950
…		…
581	=item cf::CLASS::attachment $name, ...	994	=item cf::CLASS::attachment $name, ...
582		995
583	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
584	given CLASS can refer to this attachment.	997	given CLASS can refer to this attachment.
585		998
586	Some classes such as crossfire maps and objects can specify attachments	999	Some classes such as deliantra maps and objects can specify attachments
587	that are attached at load/instantiate time, thus the need for a name.	1000	that are attached at load/instantiate time, thus the need for a name.
588		1001
589	These calls expect any number of the following handler/hook descriptions:	1002	These calls expect any number of the following handler/hook descriptions:
590		1003
591	=over 4	1004	=over 4
…		…
651	our @CB_TYPE = (); # registry for type (cf-object class) based events	1064	our @CB_TYPE = (); # registry for type (cf-object class) based events
652	our @CB_MAP = ();	1065	our @CB_MAP = ();
653		1066
654	my %attachment;	1067	my %attachment;
655		1068
		1069	sub cf::attachable::thawer_merge {
		1070	# simply override everything except _meta
		1071	local $_[0]{_meta};
		1072	%{$_[0]} = %{$_[1]};
		1073	}
		1074
656	sub _attach_cb($$$$) {	1075	sub _attach_cb($$$$) {
657	my ($registry, $event, $prio, $cb) = @_;	1076	my ($registry, $event, $prio, $cb) = @_;
658		1077
659	use sort 'stable';	1078	use sort 'stable';
660		1079
…		…
694	$registry = $CB_TYPE[$object_type] ||= [];	1113	$registry = $CB_TYPE[$object_type] ||= [];
695		1114
696	} elsif ($type eq "subtype") {	1115	} elsif ($type eq "subtype") {
697	defined $object_type or Carp::croak "subtype specified without type";	1116	defined $object_type or Carp::croak "subtype specified without type";
698	my $object_subtype = shift @arg;	1117	my $object_subtype = shift @arg;
699	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1118	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
700		1119
701	} elsif ($type eq "package") {	1120	} elsif ($type eq "package") {
702	my $pkg = shift @arg;	1121	my $pkg = shift @arg;
703		1122
704	while (my ($name, $id) = each %cb_id) {	1123	while (my ($name, $id) = each %cb_id) {
…		…
709		1128
710	} elsif (exists $cb_id{$type}) {	1129	} elsif (exists $cb_id{$type}) {
711	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1130	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
712		1131
713	} elsif (ref $type) {	1132	} elsif (ref $type) {
714	warn "attaching objects not supported, ignoring.\n";	1133	error "attaching objects not supported, ignoring.\n";
715		1134
716	} else {	1135	} else {
717	shift @arg;	1136	shift @arg;
718	warn "attach argument '$type' not supported, ignoring.\n";	1137	error "attach argument '$type' not supported, ignoring.\n";
719	}	1138	}
720	}	1139	}
721	}	1140	}
722		1141
723	sub _object_attach {	1142	sub _object_attach {
…		…
733	_attach $registry, $klass, @attach;	1152	_attach $registry, $klass, @attach;
734	}	1153	}
735		1154
736	$obj->{$name} = \%arg;	1155	$obj->{$name} = \%arg;
737	} else {	1156	} else {
738	warn "object uses attachment '$name' that is not available, postponing.\n";	1157	info "object uses attachment '$name' which is not available, postponing.\n";
739	}	1158	}
740		1159
741	$obj->{_attachment}{$name} = undef;	1160	$obj->{_attachment}{$name} = undef;
742	}	1161	}
743		1162
…		…
745	if (ref $_[0]) {	1164	if (ref $_[0]) {
746	_object_attach @_;	1165	_object_attach @_;
747	} else {	1166	} else {
748	_attach shift->_attach_registry, @_;	1167	_attach shift->_attach_registry, @_;
749	}	1168	}
		1169	_recalc_want;
750	};	1170	};
751		1171
752	# all those should be optimised	1172	# all those should be optimised
753	sub cf::attachable::detach {	1173	sub cf::attachable::detach {
754	my ($obj, $name) = @_;	1174	my ($obj, $name) = @_;
…		…
757	delete $obj->{_attachment}{$name};	1177	delete $obj->{_attachment}{$name};
758	reattach ($obj);	1178	reattach ($obj);
759	} else {	1179	} else {
760	Carp::croak "cannot, currently, detach class attachments";	1180	Carp::croak "cannot, currently, detach class attachments";
761	}	1181	}
		1182	_recalc_want;
762	};	1183	};
763		1184
764	sub cf::attachable::attached {	1185	sub cf::attachable::attached {
765	my ($obj, $name) = @_;	1186	my ($obj, $name) = @_;
766		1187
…		…
781	";	1202	";
782	die if $@;	1203	die if $@;
783	}	1204	}
784		1205
785	our $override;	1206	our $override;
786	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?
787		1208
788	sub override {	1209	sub override {
789	$override = 1;	1210	$override = 1;
790	@invoke_results = ();	1211	@INVOKE_RESULTS = (@_);
791	}	1212	}
792		1213
793	sub do_invoke {	1214	sub do_invoke {
794	my $event = shift;	1215	my $event = shift;
795	my $callbacks = shift;	1216	my $callbacks = shift;
796		1217
797	@invoke_results = ();	1218	@INVOKE_RESULTS = ();
798		1219
799	local $override;	1220	local $override;
800		1221
801	for (@$callbacks) {	1222	for (@$callbacks) {
802	eval { &{$_->[1]} };	1223	eval { &{$_->[1]} };
803		1224
804	if ($@) {	1225	if ($@) {
805	warn "$@";
806	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1226	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
807	override;	1227	override;
808	}	1228	}
809		1229
810	return 1 if $override;	1230	return 1 if $override;
811	}	1231	}
812		1232
813	0	1233	0
814	}	1234	}
815		1235
816	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1236	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
817		1237
818	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1238	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
819		1239
820	Generate an object-specific event with the given arguments.	1240	Generate an object-specific event with the given arguments.
821		1241
822	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
823	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
824	results (if you must, access C<@cf::invoke_results> directly).	1244	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
825		1245
826	=back	1246	=back
827		1247
828	=cut	1248	=cut
829		1249
830	#############################################################################	1250	#############################################################################
831	# 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	}
832		1294
833	sub reattach {	1295	sub reattach {
834	# basically do the same as instantiate, without calling instantiate	1296	# basically do the same as instantiate, without calling instantiate
835	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
836		1301
837	my $registry = $obj->registry;	1302	my $registry = $obj->registry;
838		1303
839	@$registry = ();	1304	@$registry = ();
840		1305
…		…
845	for (@$attach) {	1310	for (@$attach) {
846	my ($klass, @attach) = @$_;	1311	my ($klass, @attach) = @$_;
847	_attach $registry, $klass, @attach;	1312	_attach $registry, $klass, @attach;
848	}	1313	}
849	} else {	1314	} else {
850	warn "object uses attachment '$name' that is not available, postponing.\n";	1315	info "object uses attachment '$name' that is not available, postponing.\n";
851	}	1316	}
852	}	1317	}
853	}	1318	}
854		1319
855	cf::attachable->attach (	1320	cf::attachable->attach (
856	prio => -1000000,	1321	prio => -1000000,
857	on_instantiate => sub {	1322	on_instantiate => sub {
858	my ($obj, $data) = @_;	1323	my ($obj, $data) = @_;
859		1324
860	$data = from_json $data;	1325	$data = decode_json $data;
861		1326
862	for (@$data) {	1327	for (@$data) {
863	my ($name, $args) = @$_;	1328	my ($name, $args) = @$_;
864		1329
865	$obj->attach ($name, %{$args || {} });	1330	$obj->attach ($name, %{$args || {} });
…		…
881	sub object_freezer_save {	1346	sub object_freezer_save {
882	my ($filename, $rdata, $objs) = @_;	1347	my ($filename, $rdata, $objs) = @_;
883		1348
884	sync_job {	1349	sync_job {
885	if (length $$rdata) {	1350	if (length $$rdata) {
		1351	utf8::decode (my $decname = $filename);
886	warn sprintf "saving %s (%d,%d)\n",	1352	trace sprintf "saving %s (%d,%d)\n",
887	$filename, length $$rdata, scalar @$objs;	1353	$decname, length $$rdata, scalar @$objs
		1354	if $VERBOSE_IO;
888		1355
889	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1356	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
890	chmod SAVE_MODE, $fh;	1357	aio_chmod $fh, SAVE_MODE;
891	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;
892	aio_fsync $fh;	1361	aio_fsync $fh;
		1362	}
893	close $fh;	1363	aio_close $fh;
894		1364
895	if (@$objs) {	1365	if (@$objs) {
896	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) {
897	chmod SAVE_MODE, $fh;	1367	aio_chmod $fh, SAVE_MODE;
898	my $data = Storable::nfreeze { version => 1, objs => $objs };	1368	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
899	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;
900	aio_fsync $fh;	1372	aio_fsync $fh;
		1373	}
901	close $fh;	1374	aio_close $fh;
902	aio_rename "$filename.pst~", "$filename.pst";	1375	aio_rename "$filename.pst~", "$filename.pst";
903	}	1376	}
904	} else {	1377	} else {
905	aio_unlink "$filename.pst";	1378	aio_unlink "$filename.pst";
906	}	1379	}
907		1380
908	aio_rename "$filename~", $filename;	1381	aio_rename "$filename~", $filename;
		1382
		1383	$filename =~ s%/[^/]+$%%;
		1384	aio_pathsync $filename if $cf::USE_FSYNC;
909	} else {	1385	} else {
910	warn "FATAL: $filename~: $!\n";	1386	error "unable to save objects: $filename~: $!\n";
911	}	1387	}
912	} else {	1388	} else {
913	aio_unlink $filename;	1389	aio_unlink $filename;
914	aio_unlink "$filename.pst";	1390	aio_unlink "$filename.pst";
915	}	1391	}
916	}	1392	};
917	}	1393	}
918		1394
919	sub object_freezer_as_string {	1395	sub object_freezer_as_string {
920	my ($rdata, $objs) = @_;	1396	my ($rdata, $objs) = @_;
921		1397
…		…
933	or return;	1409	or return;
934		1410
935	unless (aio_stat "$filename.pst") {	1411	unless (aio_stat "$filename.pst") {
936	(aio_load "$filename.pst", $av) >= 0	1412	(aio_load "$filename.pst", $av) >= 0
937	or return;	1413	or return;
		1414
938	$av = eval { (Storable::thaw $av)->{objs} };	1415	my $st = eval { Coro::Storable::thaw $av };
		1416	$av = $st->{objs};
939	}	1417	}
940		1418
		1419	utf8::decode (my $decname = $filename);
941	warn sprintf "loading %s (%d)\n",	1420	trace sprintf "loading %s (%d,%d)\n",
942	$filename, length $data, scalar @{$av || []};#d#	1421	$decname, length $data, scalar @{$av || []}
		1422	if $VERBOSE_IO;
		1423
943	return ($data, $av);	1424	($data, $av)
944	}	1425	}
		1426
		1427	=head2 COMMAND CALLBACKS
		1428
		1429	=over 4
		1430
		1431	=cut
945		1432
946	#############################################################################	1433	#############################################################################
947	# command handling &c	1434	# command handling &c
948		1435
949	=item cf::register_command $name => \&callback($ob,$args);	1436	=item cf::register_command $name => \&callback($ob,$args);
…		…
962	push @{ $COMMAND{$name} }, [$caller, $cb];	1449	push @{ $COMMAND{$name} }, [$caller, $cb];
963	}	1450	}
964		1451
965	=item cf::register_extcmd $name => \&callback($pl,$packet);	1452	=item cf::register_extcmd $name => \&callback($pl,$packet);
966		1453
967	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.
968		1459
969	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
970	called.	1461	called.
971		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
972	=cut	1474	=cut
973		1475
974	sub register_extcmd {	1476	sub register_extcmd {
975	my ($name, $cb) = @_;	1477	my ($name, $cb) = @_;
976		1478
977	$EXTCMD{$name} = $cb;	1479	$EXTCMD{$name} = $cb;
978	}	1480	}
979		1481
		1482	sub register_exticmd {
		1483	my ($name, $cb) = @_;
		1484
		1485	$EXTICMD{$name} = $cb;
		1486	}
		1487
		1488	use File::Glob ();
		1489
980	cf::player->attach (	1490	cf::player->attach (
981	on_command => sub {	1491	on_unknown_command => sub {
982	my ($pl, $name, $params) = @_;	1492	my ($pl, $name, $params) = @_;
983		1493
984	my $cb = $COMMAND{$name}	1494	my $cb = $COMMAND{$name}
985	or return;	1495	or return;
986		1496
…		…
991	cf::override;	1501	cf::override;
992	},	1502	},
993	on_extcmd => sub {	1503	on_extcmd => sub {
994	my ($pl, $buf) = @_;	1504	my ($pl, $buf) = @_;
995		1505
996	my $msg = eval { from_json $buf };	1506	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
997		1507
998	if (ref $msg) {	1508	if (ref $msg) {
		1509	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1510
		1511	my @reply;
		1512
999	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1513	if (my $cb = $EXTCMD{$type}) {
1000	if (my %reply = $cb->($pl, $msg)) {	1514	@reply = $cb->($pl, @payload);
1001	$pl->ext_reply ($msg->{msgid}, %reply);
1002	}
1003	}	1515	}
		1516
		1517	$pl->ext_reply ($reply, @reply)
		1518	if $reply;
		1519
1004	} else {	1520	} else {
1005	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1521	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1006	}	1522	}
1007		1523
1008	cf::override;	1524	cf::override;
1009	},	1525	},
1010	);	1526	);
1011		1527
		1528	# "readahead" all extensions
1012	sub load_extension {	1529	sub cache_extensions {
1013	my ($path) = @_;	1530	my $grp = IO::AIO::aio_group;
1014		1531
1015	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1532	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
1016	my $base = $1;	1533	for (grep /\.ext$/, @{$_[0]}) {
1017	my $pkg = $1;	1534	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
1018	$pkg =~ s/[^[:word:]]/_/g;	1535	}
1019	$pkg = "ext::$pkg";	1536	};
1020		1537
1021	warn "... loading '$path' into '$pkg'\n";	1538	$grp
		1539	}
1022		1540
1023	open my $fh, "<:utf8", $path	1541	sub _ext_cfg_reg($$$$) {
1024	or die "$path: $!";	1542	my ($rvar, $varname, $cfgname, $default) = @_;
1025		1543
1026	my $source =	1544	$cfgname = lc $varname
1027	"package $pkg; use strict; use utf8;\n"	1545	unless length $cfgname;
1028	. "#line 1 \"$path\"\n{\n"
1029	. (do { local $/; <$fh> })
1030	. "\n};\n1";
1031		1546
1032	eval $source	1547	$EXT_CFG{$cfgname} = [$rvar, $default];
1033	or die $@ ? "$path: $@\n"
1034	: "extension disabled.\n";
1035		1548
1036	push @EXTS, $pkg;	1549	$$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
1037	}	1550	}
1038		1551
1039	sub load_extensions {	1552	sub load_extensions {
		1553	info "loading extensions...";
		1554
		1555	%EXT_CFG = ();
		1556
		1557	cf::sync_job {
		1558	my %todo;
		1559
1040	for my $ext (<$LIBDIR/*.ext>) {	1560	for my $path (<$LIBDIR/*.ext>) {
1041	next unless -r $ext;	1561	next unless -r $path;
1042	eval {	1562
1043	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	}
1044	1	1635	}
1045	} 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	}
1046	}	1648	};
1047	}	1649	}
1048		1650
1049	#############################################################################	1651	#############################################################################
1050	# load/save/clean perl data associated with a map
1051		1652
1052	*cf::mapsupport::on_clean = sub {	1653	=back
1053	my ($map) = @_;
1054
1055	my $path = $map->tmpname;
1056	defined $path or return;
1057
1058	unlink "$path.pst";
1059	};
1060
1061	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1062
1063	#############################################################################
1064		1654
1065	=head2 CORE EXTENSIONS	1655	=head2 CORE EXTENSIONS
1066		1656
1067	Functions and methods that extend core crossfire objects.	1657	Functions and methods that extend core deliantra objects.
1068		1658
1069	=cut	1659	=cut
1070		1660
1071	package cf::player;	1661	package cf::player;
1072		1662
…		…
1074		1664
1075	=head3 cf::player	1665	=head3 cf::player
1076		1666
1077	=over 4	1667	=over 4
1078		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
1079	=item cf::player::find $login	1683	=item cf::player::find $login
1080		1684
1081	Returns the given player object, loading it if necessary (might block).	1685	Returns the given player object, loading it if necessary (might block).
1082		1686
1083	=cut	1687	=cut
1084		1688
1085	sub playerdir($) {	1689	sub playerdir($) {
1086	cf::localdir	1690	"$PLAYERDIR/"
1087	. "/"
1088	. cf::playerdir
1089	. "/"
1090	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1691	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1091	}	1692	}
1092		1693
1093	sub path($) {	1694	sub path($) {
1094	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1695	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1095		1696
1096	(playerdir $login) . "/$login.pl"	1697	(playerdir $login) . "/playerdata"
1097	}	1698	}
1098		1699
1099	sub find_active($) {	1700	sub find_active($) {
1100	$cf::PLAYER{$_[0]}	1701	$cf::PLAYER{$_[0]}
1101	and $cf::PLAYER{$_[0]}->active	1702	and $cf::PLAYER{$_[0]}->active
…		…
1104		1705
1105	sub exists($) {	1706	sub exists($) {
1106	my ($login) = @_;	1707	my ($login) = @_;
1107		1708
1108	$cf::PLAYER{$login}	1709	$cf::PLAYER{$login}
1109	or cf::sync_job { !aio_stat $login }	1710	or !aio_stat path $login
1110	}	1711	}
1111		1712
1112	sub find($) {	1713	sub find($) {
1113	return $cf::PLAYER{$_[0]} || do {	1714	return $cf::PLAYER{$_[0]} || do {
1114	my $login = $_[0];	1715	my $login = $_[0];
1115		1716
1116	my $guard = cf::lock_acquire "user_find:$login";	1717	my $guard = cf::lock_acquire "user_find:$login";
1117		1718
1118	$cf::PLAYER{$_[0]} || do {	1719	$cf::PLAYER{$_[0]} || do {
1119	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
1120	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;
1121	$cf::PLAYER{$login} = $pl	1735	$cf::PLAYER{$login} = $pl
1122	}	1736	}
1123	}	1737	}
1124	}	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	);
1125		1752
1126	sub save($) {	1753	sub save($) {
1127	my ($pl) = @_;	1754	my ($pl) = @_;
1128		1755
1129	return if $pl->{deny_save};	1756	return if $pl->{deny_save};
…		…
1134	return if $pl->{deny_save};	1761	return if $pl->{deny_save};
1135		1762
1136	aio_mkdir playerdir $pl, 0770;	1763	aio_mkdir playerdir $pl, 0770;
1137	$pl->{last_save} = $cf::RUNTIME;	1764	$pl->{last_save} = $cf::RUNTIME;
1138		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
1139	$pl->save_pl ($path);	1771	$pl->save_pl ($path);
1140	Coro::cede;	1772	cf::cede_to_tick;
1141	}	1773	}
1142		1774
1143	sub new($) {	1775	sub new($) {
1144	my ($login) = @_;	1776	my ($login) = @_;
1145		1777
…		…
1151	$cf::PLAYER{$login} = $self;	1783	$cf::PLAYER{$login} = $self;
1152		1784
1153	$self	1785	$self
1154	}	1786	}
1155		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
1156	=item $pl->quit_character	1798	=item $pl->quit_character
1157		1799
1158	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
1159	be destroyed. May block for a long time.	1801	be destroyed. May block for a long time.
1160		1802
1161	=cut	1803	=cut
1162		1804
1163	sub quit_character {	1805	sub quit_character {
1164	my ($pl) = @_;	1806	my ($pl) = @_;
1165		1807
		1808	my $name = $pl->ob->name;
		1809
1166	$pl->{deny_save} = 1;	1810	$pl->{deny_save} = 1;
1167	$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
1168		1812
1169	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1813	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1170	$pl->deactivate;	1814	$pl->deactivate;
		1815
		1816	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1171	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1817	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1818	ext::highscore::check ($pl->ob);
		1819
1172	$pl->ns->destroy if $pl->ns;	1820	$pl->ns->destroy if $pl->ns;
1173		1821
1174	my $path = playerdir $pl;	1822	my $path = playerdir $pl;
1175	my $temp = "$path~$cf::RUNTIME~deleting~";	1823	my $temp = "$path~$cf::RUNTIME~deleting~";
1176	aio_rename $path, $temp;	1824	aio_rename $path, $temp;
1177	delete $cf::PLAYER{$pl->ob->name};	1825	delete $cf::PLAYER{$pl->ob->name};
1178	$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
1179	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;
1180	}	1848	}
1181		1849
1182	=item cf::player::list_logins	1850	=item cf::player::list_logins
1183		1851
1184	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
1185	while and may block, so not sync_job-capable, ever.	1853	while and may block, so not sync_job-capable, ever.
1186		1854
1187	=cut	1855	=cut
1188		1856
1189	sub list_logins {	1857	sub list_logins {
1190	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1858	my $dirs = aio_readdir $PLAYERDIR
1191	or return [];	1859	or return [];
1192		1860
1193	my @logins;	1861	my @logins;
1194		1862
1195	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") {
1196	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1869	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1197	aio_read $fh, 0, 512, my $buf, 0 or next;	1870	aio_read $fh, 0, 512, my $buf, 0 or next;
1198	$buf !~ /^password -------------$/m or next; # official not-valid tag	1871	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1872	}
1199		1873
1200	utf8::decode $login;	1874	utf8::decode $login;
1201	push @logins, $login;	1875	push @logins, $login;
1202	}	1876	}
1203		1877
1204	\@logins	1878	\@logins
1205	}	1879	}
1206		1880
1207	=item $player->maps	1881	=item $player->maps
1208		1882
		1883	=item cf::player::maps $login
		1884
1209	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
1210	player. May block.	1886	player. May block.
1211		1887
1212	=cut	1888	=cut
1213		1889
1214	sub maps($) {	1890	sub maps($) {
1215	my ($pl) = @_;	1891	my ($pl) = @_;
		1892
		1893	$pl = ref $pl ? $pl->ob->name : $pl;
1216		1894
1217	my $files = aio_readdir playerdir $pl	1895	my $files = aio_readdir playerdir $pl
1218	or return;	1896	or return;
1219		1897
1220	my @paths;	1898	my @paths;
…		…
1222	for (@$files) {	1900	for (@$files) {
1223	utf8::decode $_;	1901	utf8::decode $_;
1224	next if /\.(?:pl|pst)$/;	1902	next if /\.(?:pl|pst)$/;
1225	next unless /^$PATH_SEP/o;	1903	next unless /^$PATH_SEP/o;
1226		1904
1227	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1905	push @paths, cf::map::normalise "~$pl/$_";
1228	}	1906	}
1229		1907
1230	\@paths	1908	\@paths
1231	}	1909	}
1232		1910
		1911	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1912
		1913	Expand deliantra pod fragments into protocol xml.
		1914
1233	=item $player->ext_reply ($msgid, $msgtype, %msg)	1915	=item $player->ext_reply ($msgid, @msg)
1234		1916
1235	Sends an ext reply to the player.	1917	Sends an ext reply to the player.
1236		1918
1237	=cut	1919	=cut
1238		1920
1239	sub ext_reply($$$%) {	1921	sub ext_reply($$@) {
1240	my ($self, $id, %msg) = @_;	1922	my ($self, $id, @msg) = @_;
1241		1923
1242	$msg{msgid} = $id;	1924	$self->ns->ext_reply ($id, @msg)
1243
1244	$self->send ("ext " . cf::to_json \%msg);
1245	}	1925	}
1246		1926
1247	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	}
1248		1969
1249	=back	1970	=back
1250
1251		1971
1252	=head3 cf::map	1972	=head3 cf::map
1253		1973
1254	=over 4	1974	=over 4
1255		1975
…		…
1258	package cf::map;	1978	package cf::map;
1259		1979
1260	use Fcntl;	1980	use Fcntl;
1261	use Coro::AIO;	1981	use Coro::AIO;
1262		1982
		1983	use overload
		1984	'""' => \&as_string,
		1985	fallback => 1;
		1986
1263	our $MAX_RESET = 3600;	1987	our $MAX_RESET = 3600;
1264	our $DEFAULT_RESET = 3000;	1988	our $DEFAULT_RESET = 3000;
1265		1989
1266	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 {
1267	my ($path, $rmp) = @_;	2029	my ($path, $base) = @_;
1268		2030
1269	# mit "rum" bekleckern, nicht	2031	$path = "$path"; # make sure it's a string
1270	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
1271	$path,	2060	$path
1272	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1273	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1274	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1275	$rmp->{exit_on_final_map},
1276	$rmp->{xsize}, $rmp->{ysize},
1277	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1278	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1279	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1280	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1281	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1282	(cf::region::find $rmp->{region})
1283	}	2061	}
1284		2062
1285	# and all this just because we cannot iterate over	2063	sub new_from_path {
1286	# all maps in C++...	2064	my (undef, $path, $base) = @_;
1287	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 {
1288	my ($change) = @_;	2085	my ($self) = @_;
1289		2086
1290	$_->change_map_light ($change)	2087	$self
1291	for grep $_->outdoor, values %cf::MAP;
1292	}	2088	}
1293		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
1294	sub load_map_header($) {	2140	sub load_header_from($) {
1295	my ($path) = @_;	2141	my ($self, $path) = @_;
1296		2142
1297	utf8::encode $path;	2143	utf8::encode $path;
1298	aio_open $path, O_RDONLY, 0	2144	my $f = new_from_file cf::object::thawer $path
1299	or return;	2145	or return;
1300		2146
1301	my $map = cf::map::new	2147	$self->_load_header ($f)
1302	or return;	2148	or return;
1303		2149
1304	# for better error messages only, will be overwritten later	2150	local $MAP_LOADING{$self->{path}} = $self;
1305	$map->path ($path);	2151	$f->resolve_delayed_derefs;
1306		2152
1307	$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
1308	or return;	2200	or return;
		2201	$self->prepare_orig;
		2202	}
1309		2203
1310	$map->{load_path} = $path;	2204	$self->{deny_reset} = 1
		2205	if $self->no_reset;
1311		2206
1312	$map	2207	$self->default_region (cf::region::find_by_path $self->{path})
		2208	unless $self->default_region;
		2209
		2210	1
1313	}	2211	}
1314		2212
1315	sub find;	2213	sub find;
1316	sub find {	2214	sub find {
1317	my ($path, $origin) = @_;	2215	my ($path, $origin) = @_;
1318		2216
1319	#warn "find<$path,$origin>\n";#d#	2217	cf::cede_to_tick;
1320		2218
1321	$path = new cf::path $path, $origin && $origin->path;	2219	$path = normalise $path, $origin;
1322	my $key = $path->as_string;
1323		2220
1324	cf::lock_wait "map_find:$key";	2221	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1325
1326	$cf::MAP{$key} || do {
1327	my $guard = cf::lock_acquire "map_find:$key";	2222	my $guard2 = cf::lock_acquire "map_find:$path";
1328		2223
1329	# do it the slow way	2224	$cf::MAP{$path} || do {
1330	my $map = $path->load_temp;	2225	my $map = new_from_path cf::map $path
1331
1332	Coro::cede;
1333
1334	if ($map) {
1335	$map->last_access ((delete $map->{last_access})
1336	|| $cf::RUNTIME); #d#
1337	# safety
1338	$map->{instantiate_time} = $cf::RUNTIME
1339	if $map->{instantiate_time} > $cf::RUNTIME;
1340	} else {
1341	$map = $path->load_orig
1342	or return;	2226	or return;
1343		2227
1344	$map->{load_original} = 1;
1345	$map->{instantiate_time} = $cf::RUNTIME;
1346	$map->last_access ($cf::RUNTIME);
1347	$map->instantiate;
1348
1349	# per-player maps become, after loading, normal maps
1350	$map->per_player (0) if $path->{user_rel};
1351	}
1352
1353	$map->path ($key);
1354	$map->{path} = $path;
1355	$map->{last_save} = $cf::RUNTIME;	2228	$map->{last_save} = $cf::RUNTIME;
1356		2229
1357	Coro::cede;	2230	$map->load_header
		2231	or return;
1358		2232
1359	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;
1360	$map->reset;	2238	$map->reset;
1361	undef $guard;
1362	$map = find $path	2239	return find $path;
1363	or return;
1364	}	2240	}
1365		2241
1366	$cf::MAP{$key} = $map	2242	$cf::MAP{$path} = $map
1367	}	2243	}
1368	}	2244	}
		2245
		2246	sub pre_load { }
		2247	#sub post_load { } # XS
1369		2248
1370	sub load {	2249	sub load {
1371	my ($self) = @_;	2250	my ($self) = @_;
1372		2251
		2252	local $self->{deny_reset} = 1; # loading can take a long time
		2253
1373	my $path = $self->{path};	2254	my $path = $self->{path};
		2255
		2256	{
1374	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2257	my $guard = cf::lock_acquire "map_data:$path";
1375		2258
1376	return if $self->in_memory != cf::MAP_SWAPPED;	2259	return unless $self->valid;
		2260	return unless $self->state == cf::MAP_SWAPPED;
1377		2261
1378	$self->in_memory (cf::MAP_LOADING);
1379
1380	$self->alloc;	2262	$self->alloc;
1381	$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)
1382	or return;	2271	or return;
1383		2272
1384	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2273	$self->post_load_original
1385	if delete $self->{load_original};	2274	if delete $self->{load_original};
1386		2275
1387	if (my $uniq = $path->uniq_path) {	2276	if (my $uniq = $self->uniq_path) {
1388	utf8::encode $uniq;	2277	utf8::encode $uniq;
1389	if (aio_open $uniq, O_RDONLY, 0) {	2278	unless (aio_stat $uniq) {
		2279	if (my $f = new_from_file cf::object::thawer $uniq) {
1390	$self->clear_unique_items;	2280	$self->clear_unique_items;
1391	$self->load_objects ($uniq, 0);	2281	$self->_load_objects ($f);
		2282	$f->resolve_delayed_derefs;
		2283	}
		2284	}
1392	}	2285	}
1393	}
1394		2286
1395	Coro::cede;	2287	$f->resolve_delayed_derefs;
		2288	} else {
		2289	$self->post_load_original
		2290	if delete $self->{load_original};
		2291	}
1396		2292
		2293	$self->state (cf::MAP_INACTIVE);
		2294
		2295	cf::cede_to_tick;
1397	# now do the right thing for maps	2296	# now do the right thing for maps
1398	$self->link_multipart_objects;	2297	$self->link_multipart_objects;
1399
1400	if ($self->{path}->is_style_map) {
1401	$self->{deny_save} = 1;
1402	$self->{deny_reset} = 1;
1403	} else {
1404	$self->fix_auto_apply;
1405	$self->decay_objects;
1406	$self->update_buttons;
1407	$self->set_darkness_map;
1408	$self->difficulty ($self->estimate_difficulty)	2298	$self->difficulty ($self->estimate_difficulty)
1409	unless $self->difficulty;	2299	unless $self->difficulty;
1410	$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
1411	}	2316	1
1412
1413	Coro::cede;
1414
1415	$self->in_memory (cf::MAP_IN_MEMORY);
1416	}	2317	}
1417		2318
1418	# find and load all maps in the 3x3 area around a map	2319	# customize the map for a given player, i.e.
1419	sub load_diag {	2320	# return the _real_ map. used by e.g. per-player
1420	my ($map) = @_;	2321	# maps to change the path to ~playername/mappath
		2322	sub customise_for {
		2323	my ($self, $ob) = @_;
1421		2324
1422	my @diag; # diagonal neighbours	2325	return find "~" . $ob->name . "/" . $self->{path}
		2326	if $self->per_player;
1423		2327
1424	for (0 .. 3) {	2328	# return find "?party/" . $ob->name . "/" . $self->{path}
1425	my $neigh = $map->tile_path ($_)	2329	# if $self->per_party;
1426	or next;
1427	$neigh = find $neigh, $map
1428	or next;
1429	$neigh->load;
1430		2330
1431	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2331	$self
1432	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1433	}
1434
1435	for (@diag) {
1436	my $neigh = find @$_
1437	or next;
1438	$neigh->load;
1439	}
1440	}	2332	}
1441		2333
1442	sub find_sync {	2334	sub find_sync {
1443	my ($path, $origin) = @_;	2335	my ($path, $origin) = @_;
1444		2336
1445	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
1446	}	2342	}
1447		2343
1448	sub do_load_sync {	2344	sub do_load_sync {
1449	my ($map) = @_;	2345	my ($map) = @_;
1450		2346
1451	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;
1452	}	2352	}
1453		2353
1454	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
1455	our $MAP_PREFETCHER = Coro::async {	2368	$MAP_PREFETCHER ||= cf::async {
1456	while () {	2369	$Coro::current->{desc} = "map prefetcher";
		2370
1457	while (%MAP_PREFETCH) {	2371	while (%MAP_PREFETCH) {
1458	my $key = each %MAP_PREFETCH	2372	while (my ($k, $v) = each %MAP_PREFETCH) {
1459	or next;	2373	if (my $map = find $k) {
		2374	$map->load if $v;
		2375	}
		2376
1460	my $path = delete $MAP_PREFETCH{$key};	2377	delete $MAP_PREFETCH{$k};
1461
1462	my $map = find $path
1463	or next;
1464	$map->load;
1465	}	2378	}
1466	Coro::schedule;	2379	}
		2380	undef $MAP_PREFETCHER;
1467	}	2381	};
1468	};
1469
1470	sub find_async {
1471	my ($path, $origin) = @_;
1472
1473	$path = new cf::path $path, $origin && $origin->path;
1474	my $key = $path->as_string;
1475
1476	if (my $map = $cf::MAP{$key}) {
1477	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1478	}
1479
1480	$MAP_PREFETCH{$key} = $path;
1481	$MAP_PREFETCHER->ready;	2382	$MAP_PREFETCHER->prio (6);
1482		2383
1483	()	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	}
1484	}	2417	}
1485		2418
1486	sub save {	2419	sub save {
1487	my ($self) = @_;	2420	my ($self) = @_;
1488		2421
1489	my $lock = cf::lock_acquire "map_data:" . $self->path;	2422	my $lock = cf::lock_acquire "map_data:$self->{path}";
1490		2423
1491	$self->{last_save} = $cf::RUNTIME;	2424	$self->_save;
1492
1493	return unless $self->dirty;
1494
1495	my $save = $self->{path}->save_path; utf8::encode $save;
1496	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1497
1498	$self->{load_path} = $save;
1499
1500	return if $self->{deny_save};
1501
1502	local $self->{last_access} = $self->last_access;#d#
1503
1504	cf::async {
1505	$_->contr->save for $self->players;
1506	};
1507
1508	if ($uniq) {
1509	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1510	$self->save_objects ($uniq, cf::IO_UNIQUES);
1511	} else {
1512	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1513	}
1514	}	2425	}
1515		2426
1516	sub swap_out {	2427	sub swap_out {
1517	my ($self) = @_;	2428	my ($self) = @_;
1518		2429
1519	# save first because save cedes
1520	$self->save;
1521
1522	my $lock = cf::lock_acquire "map_data:" . $self->path;	2430	my $lock = cf::lock_acquire "map_data:$self->{path}";
1523		2431
		2432	return if !$self->linkable;
		2433	return if $self->{deny_save};
1524	return if $self->players;	2434	return if $self->players;
1525	return if $self->in_memory != cf::MAP_IN_MEMORY;
1526	return if $self->{deny_save};
1527		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
1528	$self->clear;	2445	$self->clear;
1529	$self->in_memory (cf::MAP_SWAPPED);
1530	}	2446	}
1531		2447
1532	sub reset_at {	2448	sub reset_at {
1533	my ($self) = @_;	2449	my ($self) = @_;
1534		2450
1535	# TODO: safety, remove and allow resettable per-player maps	2451	# TODO: safety, remove and allow resettable per-player maps
1536	return 1e99 if $self->{path}{user_rel};
1537	return 1e99 if $self->{deny_reset};	2452	return 1e99 if $self->{deny_reset};
1538		2453
1539	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2454	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1540	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;
1541		2456
…		…
1546	my ($self) = @_;	2461	my ($self) = @_;
1547		2462
1548	$self->reset_at <= $cf::RUNTIME	2463	$self->reset_at <= $cf::RUNTIME
1549	}	2464	}
1550		2465
1551	sub unlink_save {
1552	my ($self) = @_;
1553
1554	utf8::encode (my $save = $self->{path}->save_path);
1555	aioreq_pri 3; IO::AIO::aio_unlink $save;
1556	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1557	}
1558
1559	sub rename {
1560	my ($self, $new_path) = @_;
1561
1562	$self->unlink_save;
1563
1564	delete $cf::MAP{$self->path};
1565	$self->{path} = new cf::path $new_path;
1566	$self->path ($self->{path}->as_string);
1567	$cf::MAP{$self->path} = $self;
1568
1569	$self->save;
1570	}
1571
1572	sub reset {	2466	sub reset {
1573	my ($self) = @_;	2467	my ($self) = @_;
1574		2468
1575	my $lock = cf::lock_acquire "map_data:" . $self->path;	2469	my $lock = cf::lock_acquire "map_data:$self->{path}";
1576		2470
1577	return if $self->players;	2471	return if $self->players;
1578	return if $self->{path}{user_rel};#d#
1579		2472
1580	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	}
1581		2484
1582	delete $cf::MAP{$self->path};	2485	delete $cf::MAP{$self->path};
1583		2486
		2487	$self->deactivate;
1584	$_->clear_links_to ($self) for values %cf::MAP;	2488	$_->clear_links_to ($self) for values %cf::MAP;
		2489	$self->clear;
1585		2490
1586	$self->unlink_save;	2491	$self->unlink_save;
1587	$self->destroy;	2492	$self->destroy;
1588	}	2493	}
1589		2494
1590	my $nuke_counter = "aaaa";	2495	my $nuke_counter = "aaaa";
1591		2496
1592	sub nuke {	2497	sub nuke {
1593	my ($self) = @_;	2498	my ($self) = @_;
1594		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};
1595	$self->{deny_save} = 1;	2509	$self->{deny_save} = 1;
1596	$self->reset_timeout (1);	2510	$self->reset_timeout (1);
1597	$self->rename ("{nuke}/" . ($nuke_counter++));	2511	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2512
		2513	$cf::MAP{$self->path} = $self;
		2514	}
		2515
1598	$self->reset; # polite request, might not happen	2516	$self->reset; # polite request, might not happen
1599	}	2517	}
1600		2518
1601	sub customise_for {	2519	=item $maps = cf::map::tmp_maps
1602	my ($map, $ob) = @_;
1603		2520
1604	if ($map->per_player) {	2521	Returns an arrayref with all map paths of currently instantiated and saved
1605	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2522	maps. May block.
		2523
		2524	=cut
		2525
		2526	sub tmp_maps() {
1606	}	2527	[
		2528	map {
		2529	utf8::decode $_;
		2530	/\.map$/
		2531	? normalise $_
		2532	: ()
		2533	} @{ aio_readdir $TMPDIR or [] }
		2534	]
		2535	}
1607		2536
1608	$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	]
1609	}	2553	}
1610		2554
1611	=item cf::map::unique_maps	2555	=item cf::map::unique_maps
1612		2556
1613	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
1614	instantiated unique items. May block.	2558	instantiated unique items. May block.
1615		2559
1616	=cut	2560	=cut
1617		2561
1618	sub unique_maps() {	2562	sub unique_maps() {
1619	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2563	[
1620	or return;	2564	map {
1621
1622	my @paths;
1623
1624	for (@$files) {
1625	utf8::decode $_;	2565	utf8::decode $_;
1626	next if /\.pst$/;	2566	s/\.map$//; # TODO future compatibility hack
1627	next unless /^$PATH_SEP/o;	2567	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1628		2568	? ()
1629	push @paths, new cf::path $_;	2569	: normalise $_
		2570	} @{ aio_readdir $UNIQUEDIR or [] }
1630	}	2571	]
1631
1632	\@paths
1633	}	2572	}
1634		2573
1635	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	}
1636		2605
1637	=back	2606	=back
1638		2607
1639	=head3 cf::object	2608	=head3 cf::object
1640		2609
…		…
1644		2613
1645	=over 4	2614	=over 4
1646		2615
1647	=item $ob->inv_recursive	2616	=item $ob->inv_recursive
1648		2617
1649	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.
1650		2620
1651	=cut	2621	=cut
1652		2622
1653	sub inv_recursive_;	2623	sub inv_recursive_;
1654	sub inv_recursive_ {	2624	sub inv_recursive_ {
…		…
1657		2627
1658	sub inv_recursive {	2628	sub inv_recursive {
1659	inv_recursive_ inv $_[0]	2629	inv_recursive_ inv $_[0]
1660	}	2630	}
1661		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
1662	package cf;	2660	package cf;
1663		2661
1664	=back	2662	=back
1665		2663
1666	=head3 cf::object::player	2664	=head3 cf::object::player
…		…
1672	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>
1673	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
1674	dialogue with the given NPC character.	2672	dialogue with the given NPC character.
1675		2673
1676	=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	};
1677		2689
1678	# rough implementation of a future "reply" method that works	2690	# rough implementation of a future "reply" method that works
1679	# with dialog boxes.	2691	# with dialog boxes.
1680	#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
1681	sub cf::object::player::reply($$$;$) {	2693	sub cf::object::player::reply($$$;$) {
…		…
1683		2695
1684	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2696	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1685		2697
1686	if ($self->{record_replies}) {	2698	if ($self->{record_replies}) {
1687	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2699	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2700
1688	} 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 {
1689	$msg = $npc->name . " says: $msg" if $npc;	2709	$msg = $npc->name . " says: $msg" if $npc;
1690	$self->message ($msg, $flags);	2710	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2711	}
1691	}	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 (@_);
1692	}	2723	}
1693		2724
1694	=item $player_object->may ("access")	2725	=item $player_object->may ("access")
1695		2726
1696	Returns wether the given player is authorized to access resource "access"	2727	Returns wether the given player is authorized to access resource "access"
…		…
1709		2740
1710	=item $player_object->enter_link	2741	=item $player_object->enter_link
1711		2742
1712	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}>).
1713		2744
1714	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.
1715	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.
1716		2751
1717	=item $player_object->leave_link ($map, $x, $y)	2752	=item $player_object->leave_link ($map, $x, $y)
1718		2753
1719	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
1720	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
1721	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
1722	to the emergency map position.	2757	fails, to the emergency map position.
1723		2758
1724	Might block.	2759	Might block.
1725		2760
1726	=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	}
1727		2772
1728	sub cf::object::player::enter_link {	2773	sub cf::object::player::enter_link {
1729	my ($self) = @_;	2774	my ($self) = @_;
1730		2775
1731	$self->deactivate_recursive;	2776	$self->deactivate_recursive;
1732		2777
1733	return if $self->map == $LINK_MAP;	2778	++$self->{_link_recursion};
		2779
		2780	return if UNIVERSAL::isa $self->map, "ext::map_link";
1734		2781
1735	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2782	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1736	if $self->map;	2783	if $self->map && $self->map->{path} ne "{link}";
1737		2784
1738	$self->enter_map ($LINK_MAP, 20, 20);	2785	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1739	}	2786	}
1740		2787
1741	sub cf::object::player::leave_link {	2788	sub cf::object::player::leave_link {
1742	my ($self, $map, $x, $y) = @_;	2789	my ($self, $map, $x, $y) = @_;
		2790
		2791	return unless $self->contr->active;
1743		2792
1744	my $link_pos = delete $self->{_link_pos};	2793	my $link_pos = delete $self->{_link_pos};
1745		2794
1746	unless ($map) {	2795	unless ($map) {
1747	# restore original map position	2796	# restore original map position
…		…
1758	($x, $y) = (-1, -1)	2807	($x, $y) = (-1, -1)
1759	unless (defined $x) && (defined $y);	2808	unless (defined $x) && (defined $y);
1760		2809
1761	# use -1 or undef as default coordinates, not 0, 0	2810	# use -1 or undef as default coordinates, not 0, 0
1762	($x, $y) = ($map->enter_x, $map->enter_y)	2811	($x, $y) = ($map->enter_x, $map->enter_y)
1763	if $x <=0 && $y <= 0;	2812	if $x <= 0 && $y <= 0;
1764		2813
1765	$map->load;	2814	$map->load;
1766	$map->load_diag;
1767		2815
1768	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
1769	$self->activate_recursive;	2823	$self->activate_recursive;
1770	$self->enter_map ($map, $x, $y);
1771	}
1772
1773	cf::player->attach (
1774	on_logout => sub {
1775	my ($pl) = @_;
1776
1777	# abort map switching before logout
1778	if ($pl->ob->{_link_pos}) {
1779	cf::sync_job {
1780	$pl->ob->leave_link
1781	};
1782	}
1783	},	2824	}
1784	on_login => sub {
1785	my ($pl) = @_;
1786		2825
1787	# try to abort aborted map switching on player login :)	2826	}
1788	# should happen only on crashes
1789	if ($pl->ob->{_link_pos}) {
1790	$pl->ob->enter_link;
1791	(async {
1792	# we need this sleep as the login has a concurrent enter_exit running
1793	# and this sleep increases chances of the player not ending up in scorn
1794	$pl->ob->reply (undef,
1795	"There was an internal problem at your last logout, "
1796	. "the server will try to bring you to your intended destination in a second.",
1797	cf::NDI_RED);
1798	Coro::Timer::sleep 1;
1799	$pl->ob->leave_link;
1800	})->prio (2);
1801	}
1802	},
1803	);
1804		2827
1805	=item $player_object->goto ($path, $x, $y)	2828	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1806		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
1807	=cut	2839	=cut
		2840
		2841	our $GOTOGEN;
1808		2842
1809	sub cf::object::player::goto {	2843	sub cf::object::player::goto {
1810	my ($self, $path, $x, $y) = @_;	2844	my ($self, $path, $x, $y, $check, $done) = @_;
1811		2845
1812	$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;
1813		2854
1814	$self->enter_link;	2855	$self->enter_link;
1815		2856
1816	(async {	2857	(async {
1817	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) {
1818	$map = $map->customise_for ($self) if $map;	2883	$map = $map->customise_for ($self);
1819		2884	$map = $check->($map, $x, $y, $self) if $check && $map;
1820	# warn "entering ", $map->path, " at ($x, $y)\n"	2885	} else {
1821	# if $map;
1822
1823	$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	}
1824		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};
1825	$self->leave_link ($map, $x, $y);	2899	$self->leave_link ($map, $x, $y);
		2900	}
		2901
		2902	$done->($self) if $done;
1826	})->prio (1);	2903	})->prio (1);
1827	}	2904	}
1828		2905
1829	=item $player_object->enter_exit ($exit_object)	2906	=item $player_object->enter_exit ($exit_object)
1830		2907
…		…
1832		2909
1833	sub parse_random_map_params {	2910	sub parse_random_map_params {
1834	my ($spec) = @_;	2911	my ($spec) = @_;
1835		2912
1836	my $rmp = { # defaults	2913	my $rmp = { # defaults
1837	xsize => 10,	2914	xsize => (cf::rndm 15, 40),
1838	ysize => 10,	2915	ysize => (cf::rndm 15, 40),
		2916	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2917	#layout => string,
1839	};	2918	};
1840		2919
1841	for (split /\n/, $spec) {	2920	for (split /\n/, $spec) {
1842	my ($k, $v) = split /\s+/, $_, 2;	2921	my ($k, $v) = split /\s+/, $_, 2;
1843		2922
…		…
1855	# that depends on the exit object	2934	# that depends on the exit object
1856		2935
1857	my $rmp = parse_random_map_params $exit->msg;	2936	my $rmp = parse_random_map_params $exit->msg;
1858		2937
1859	if ($exit->map) {	2938	if ($exit->map) {
1860	$rmp->{region} = $exit->map->region_name;	2939	$rmp->{region} = $exit->region->name;
1861	$rmp->{origin_map} = $exit->map->path;	2940	$rmp->{origin_map} = $exit->map->path;
1862	$rmp->{origin_x} = $exit->x;	2941	$rmp->{origin_x} = $exit->x;
1863	$rmp->{origin_y} = $exit->y;	2942	$rmp->{origin_y} = $exit->y;
		2943
		2944	$exit->map->touch;
1864	}	2945	}
1865		2946
1866	$rmp->{random_seed} ||= $exit->random_seed;	2947	$rmp->{random_seed} ||= $exit->random_seed;
1867		2948
1868	my $data = cf::to_json $rmp;	2949	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1869	my $md5 = Digest::MD5::md5_hex $data;	2950	my $md5 = Digest::MD5::md5_hex $data;
		2951	my $meta = "$RANDOMDIR/$md5.meta";
1870		2952
1871	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) {
1872	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;
1873		2957
		2958	my $slaying = "?random/$md5";
		2959
		2960	if ($exit->valid) {
1874	$exit->slaying ("?random/$md5");	2961	$exit->slaying ("?random/$md5");
1875	$exit->msg (undef);	2962	$exit->msg (undef);
		2963	}
1876	}	2964	}
1877	}	2965	}
1878		2966
1879	sub cf::object::player::enter_exit {	2967	sub cf::object::player::enter_exit {
1880	my ($self, $exit) = @_;	2968	my ($self, $exit) = @_;
…		…
1882	return unless $self->type == cf::PLAYER;	2970	return unless $self->type == cf::PLAYER;
1883		2971
1884	$self->enter_link;	2972	$self->enter_link;
1885		2973
1886	(async {	2974	(async {
1887	$self->deactivate_recursive; # just to be sure	2975	$Coro::current->{desc} = "enter_exit";
		2976
1888	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
1889	prepare_random_map $exit	2991	prepare_random_map $exit
		2992	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		2993
1890	if $exit->slaying eq "/!";	2994	$map = $exit->slaying;
1891		2995
1892	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2996	} elsif ($slaying eq '!up') {
1893	$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;
1894		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
1895	1;	3013	1
1896	}) {	3014	}) {
1897	$self->message ("Something went wrong deep within the crossfire server. "	3015	$self->message ("Something went wrong deep within the deliantra server. "
1898	. "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. "
1899	. "Please report this to the dungeon master!",	3017	. "Please report this to the dungeon master!",
1900	cf::NDI_UNIQUE | cf::NDI_RED);	3018	cf::NDI_UNIQUE | cf::NDI_RED);
1901		3019
1902	warn "ERROR in enter_exit: $@";	3020	error "ERROR in enter_exit: $@";
1903	$self->leave_link;	3021	$self->leave_link;
1904	}	3022	}
1905	})->prio (1);	3023	})->prio (1);
1906	}	3024	}
1907		3025
…		…
1918		3036
1919	sub cf::client::send_drawinfo {	3037	sub cf::client::send_drawinfo {
1920	my ($self, $text, $flags) = @_;	3038	my ($self, $text, $flags) = @_;
1921		3039
1922	utf8::encode $text;	3040	utf8::encode $text;
1923	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	3041	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1924	}	3042	}
1925		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	}
1926		3261
1927	=item $success = $client->query ($flags, "text", \&cb)	3262	=item $success = $client->query ($flags, "text", \&cb)
1928		3263
1929	Queues a query to the client, calling the given callback with	3264	Queues a query to the client, calling the given callback with
1930	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3265	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1931	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3266	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1932		3267
1933	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
1934	reliable at some point in the future.	3269	become reliable at some point in the future.
1935		3270
1936	=cut	3271	=cut
1937		3272
1938	sub cf::client::query {	3273	sub cf::client::query {
1939	my ($self, $flags, $text, $cb) = @_;	3274	my ($self, $flags, $text, $cb) = @_;
…		…
1947	utf8::encode $text;	3282	utf8::encode $text;
1948	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3283	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1949		3284
1950	$self->send_packet ($self->{query_queue}[0][0])	3285	$self->send_packet ($self->{query_queue}[0][0])
1951	if @{ $self->{query_queue} } == 1;	3286	if @{ $self->{query_queue} } == 1;
		3287
		3288	1
1952	}	3289	}
1953		3290
1954	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	},
1955	on_reply => sub {	3297	on_reply => sub {
1956	my ($ns, $msg) = @_;	3298	my ($ns, $msg) = @_;
1957		3299
1958	# this weird shuffling is so that direct followup queries	3300	# this weird shuffling is so that direct followup queries
1959	# get handled first	3301	# get handled first
1960	my $queue = delete $ns->{query_queue}	3302	my $queue = delete $ns->{query_queue}
1961	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
1962		3304
1963	(shift @$queue)->[1]->($msg);	3305	(shift @$queue)->[1]->($msg);
		3306	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1964		3307
1965	push @{ $ns->{query_queue} }, @$queue;	3308	push @{ $ns->{query_queue} }, @$queue;
1966		3309
1967	if (@{ $ns->{query_queue} } == @$queue) {	3310	if (@{ $ns->{query_queue} } == @$queue) {
1968	if (@$queue) {	3311	if (@$queue) {
…		…
1970	} else {	3313	} else {
1971	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3314	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1972	}	3315	}
1973	}	3316	}
1974	},	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	},
1975	);	3341	);
1976		3342
1977	=item $client->async (\&cb)	3343	=item $client->async (\&cb)
1978		3344
1979	Create a new coroutine, running the specified callback. The coroutine will	3345	Create a new coroutine, running the specified callback. The coroutine will
…		…
1995		3361
1996	$coro	3362	$coro
1997	}	3363	}
1998		3364
1999	cf::client->attach (	3365	cf::client->attach (
2000	on_destroy => sub {	3366	on_client_destroy => sub {
2001	my ($ns) = @_;	3367	my ($ns) = @_;
2002		3368
2003	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3369	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2004	},	3370	},
2005	);	3371	);
…		…
2020	our $safe = new Safe "safe";	3386	our $safe = new Safe "safe";
2021	our $safe_hole = new Safe::Hole;	3387	our $safe_hole = new Safe::Hole;
2022		3388
2023	$SIG{FPE} = 'IGNORE';	3389	$SIG{FPE} = 'IGNORE';
2024		3390
2025	$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	));
2026		3396
2027	# here we export the classes and methods available to script code	3397	# here we export the classes and methods available to script code
2028		3398
2029	=pod	3399	=pod
2030		3400
2031	The following fucntions and emthods are available within a safe environment:	3401	The following functions and methods are available within a safe environment:
2032		3402
2033	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
2034	cf::object::player player	3408	cf::object::player
2035	cf::player peaceful	3409	player
2036	cf::map trigger	3410
		3411	cf::player
		3412	peaceful
		3413
		3414	cf::map
		3415	trigger
2037		3416
2038	=cut	3417	=cut
2039		3418
2040	for (	3419	for (
2041	["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)],
2042	["cf::object::player" => qw(player)],	3423	["cf::object::player" => qw(player)],
2043	["cf::player" => qw(peaceful)],	3424	["cf::player" => qw(peaceful send_msg)],
2044	["cf::map" => qw(trigger)],	3425	["cf::map" => qw(trigger)],
2045	) {	3426	) {
2046	no strict 'refs';
2047	my ($pkg, @funs) = @$_;	3427	my ($pkg, @funs) = @$_;
2048	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3428	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2049	for @funs;	3429	for @funs;
2050	}	3430	}
2051		3431
…		…
2066		3446
2067	my $qcode = $code;	3447	my $qcode = $code;
2068	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3448	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2069	$qcode =~ s/\n/\\n/g;	3449	$qcode =~ s/\n/\\n/g;
2070		3450
		3451	%vars = (_dummy => 0) unless %vars;
		3452
		3453	my @res;
2071	local $_;	3454	local $_;
2072	local @safe::cf::_safe_eval_args = values %vars;
2073		3455
2074	my $eval =	3456	my $eval =
2075	"do {\n"	3457	"do {\n"
2076	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3458	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2077	. "#line 0 \"{$qcode}\"\n"	3459	. "#line 0 \"{$qcode}\"\n"
2078	. $code	3460	. $code
2079	. "\n}"	3461	. "\n}"
2080	;	3462	;
2081		3463
		3464	if ($CFG{safe_eval}) {
2082	sub_generation_inc;	3465	sub_generation_inc;
		3466	local @safe::cf::_safe_eval_args = values %vars;
2083	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3467	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2084	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	}
2085		3473
2086	if ($@) {	3474	if ($@) {
2087	warn "$@";	3475	warn "$@",
2088	warn "while executing safe code '$code'\n";	3476	"while executing safe code '$code'\n",
2089	warn "with arguments " . (join " ", %vars) . "\n";	3477	"with arguments " . (join " ", %vars) . "\n";
2090	}	3478	}
2091		3479
2092	wantarray ? @res : $res[0]	3480	wantarray ? @res : $res[0]
2093	}	3481	}
2094		3482
…		…
2108	=cut	3496	=cut
2109		3497
2110	sub register_script_function {	3498	sub register_script_function {
2111	my ($fun, $cb) = @_;	3499	my ($fun, $cb) = @_;
2112		3500
2113	no strict 'refs';	3501	$fun = "safe::$fun" if $CFG{safe_eval};
2114	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3502	*$fun = $safe_hole->wrap ($cb);
2115	}	3503	}
2116		3504
2117	=back	3505	=back
2118		3506
2119	=cut	3507	=cut
2120		3508
2121	#############################################################################	3509	#############################################################################
		3510	# the server's init and main functions
2122		3511
2123	=head2 EXTENSION DATABASE SUPPORT	3512	our %FACEHASH; # hash => idx, #d# HACK for http server
2124		3513
2125	Crossfire maintains a very simple database for extension use. It can	3514	sub load_facedata($) {
2126	currently store anything that can be serialised using Storable, which	3515	my ($path) = @_;
2127	excludes objects.
2128		3516
2129	The parameter C<$family> should best start with the name of the extension	3517	# HACK to clear player env face cache, we need some signal framework
2130	using it, it should be unique.	3518	# for this (global event?)
		3519	%ext::player_env::MUSIC_FACE_CACHE = ();
2131		3520
2132	=over 4	3521	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2133		3522
2134	=item $hashref = cf::db_get $family	3523	trace "loading facedata from $path\n";
2135		3524
2136	Return a hashref for use by the extension C<$family>, which can be	3525	my $facedata = decode_storable load_file $path;
2137	modified. After modifications, you have to call C<cf::db_dirty> or
2138	C<cf::db_sync>.
2139		3526
2140	=item $value = cf::db_get $family => $key	3527	$facedata->{version} == 2
		3528	or cf::cleanup "$path: version mismatch, cannot proceed.";
2141		3529
2142	Returns a single value from the database	3530	# patch in the exptable
2143		3531	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
2144	=item cf::db_put $family => $hashref	3532	$facedata->{resource}{"res/exp_table"} = {
2145		3533	type => FT_RSRC,
2146	Stores the given family hashref into the database. Updates are delayed, if	3534	data => $exp_table,
2147	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3535	hash => (Digest::MD5::md5 $exp_table),
2148
2149	=item cf::db_put $family => $key => $value
2150
2151	Stores the given C<$value> in the family hash. Updates are delayed, if you
2152	want the data to be synced to disk immediately, use C<cf::db_sync>.
2153
2154	=item cf::db_dirty
2155
2156	Marks the database as dirty, to be updated at a later time.
2157
2158	=item cf::db_sync
2159
2160	Immediately write the database to disk I<if it is dirty>.
2161
2162	=cut
2163
2164	our $DB;
2165
2166	{
2167	my $path = cf::localdir . "/database.pst";
2168
2169	sub db_load() {
2170	$DB = stat $path ? Storable::retrieve $path : { };
2171	}
2172
2173	my $pid;
2174
2175	sub db_save() {
2176	waitpid $pid, 0 if $pid;
2177	if (0 == ($pid = fork)) {
2178	$DB->{_meta}{version} = 1;
2179	Storable::nstore $DB, "$path~";
2180	rename "$path~", $path;
2181	cf::_exit 0 if defined $pid;
2182	}
2183	}
2184
2185	my $dirty;
2186
2187	sub db_sync() {
2188	db_save if $dirty;
2189	undef $dirty;
2190	}
2191
2192	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2193	db_sync;
2194	});	3536	};
		3537	cf::cede_to_tick;
2195		3538
2196	sub db_dirty() {
2197	$dirty = 1;
2198	$idle->start;
2199	}	3539	{
		3540	my $faces = $facedata->{faceinfo};
2200		3541
2201	sub db_get($;$) {	3542	for my $face (sort keys %$faces) {
2202	@_ >= 2	3543	my $info = $faces->{$face};
2203	? $DB->{$_[0]}{$_[1]}	3544	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2204	: ($DB->{$_[0]} ||= { })
2205	}
2206		3545
2207	sub db_put($$;$) {	3546	cf::face::set_visibility $idx, $info->{visibility};
2208	if (@_ >= 3) {	3547	cf::face::set_magicmap $idx, $info->{magicmap};
2209	$DB->{$_[0]}{$_[1]} = $_[2];	3548	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2210	} else {	3549	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2211	$DB->{$_[0]} = $_[1];	3550	cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
2212	}	3551	$FACEHASH{$info->{hash64}} = $idx;#d#
2213	db_dirty;
2214	}
2215		3552
2216	cf::global->attach (	3553	cf::cede_to_tick;
2217	prio => 10000,
2218	on_cleanup => sub {
2219	db_sync;
2220	},	3554	}
2221	);
2222	}
2223		3555
2224	#############################################################################	3556	while (my ($face, $info) = each %$faces) {
2225	# the server's main()	3557	next unless $info->{smooth};
2226		3558
2227	sub cfg_load {	3559	my $idx = cf::face::find $face
2228	open my $fh, "<:utf8", cf::confdir . "/config"	3560	or next;
2229	or return;
2230		3561
2231	local $/;	3562	if (my $smooth = cf::face::find $info->{smooth}) {
2232	*CFG = YAML::Syck::Load <$fh>;	3563	cf::face::set_smooth $idx, $smooth;
		3564	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3565	} else {
		3566	error "smooth face '$info->{smooth}' not found for face '$face'";
		3567	}
2233		3568
		3569	cf::cede_to_tick;
		3570	}
		3571	}
		3572
		3573	{
		3574	my $anims = $facedata->{animinfo};
		3575
		3576	while (my ($anim, $info) = each %$anims) {
		3577	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3578	cf::cede_to_tick;
		3579	}
		3580
		3581	cf::anim::invalidate_all; # d'oh
		3582	}
		3583
		3584	{
		3585	my $res = $facedata->{resource};
		3586
		3587	while (my ($name, $info) = each %$res) {
		3588	if (defined (my $type = $info->{type})) {
		3589	# TODO: different hash - must free and use new index, or cache ixface data queue
		3590	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3591
		3592	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3593	cf::face::set_type $idx, $type;
		3594	cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3595	$FACEHASH{$info->{hash}} = $idx;#d#
		3596	} else {
		3597	# $RESOURCE{$name} = $info; # unused
		3598	}
		3599
		3600	cf::cede_to_tick;
		3601	}
		3602	}
		3603
		3604	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3605
		3606	1
		3607	}
		3608
		3609	register_exticmd fx_want => sub {
		3610	my ($ns, $want) = @_;
		3611
		3612	while (my ($k, $v) = each %$want) {
		3613	$ns->fx_want ($k, $v);
		3614	}
		3615	};
		3616
		3617	sub load_resource_file($) {
		3618	my $guard = lock_acquire "load_resource_file";
		3619
		3620	my $status = load_resource_file_ $_[0];
		3621	get_slot 0.1, 100;
		3622	cf::arch::commit_load;
		3623
		3624	$status
		3625	}
		3626
		3627	sub reload_regions {
		3628	# HACK to clear player env face cache, we need some signal framework
		3629	# for this (global event?)
		3630	%ext::player_env::MUSIC_FACE_CACHE = ();
		3631
		3632	load_resource_file "$MAPDIR/regions"
		3633	or die "unable to load regions file\n";
		3634
		3635	for (cf::region::list) {
		3636	$_->{match} = qr/$_->{match}/
		3637	if exists $_->{match};
		3638	}
		3639	}
		3640
		3641	sub reload_facedata {
		3642	load_facedata "$DATADIR/facedata"
		3643	or die "unable to load facedata\n";
		3644	}
		3645
		3646	sub reload_archetypes {
		3647	load_resource_file "$DATADIR/archetypes"
		3648	or die "unable to load archetypes\n";
		3649	}
		3650
		3651	sub reload_treasures {
		3652	load_resource_file "$DATADIR/treasures"
		3653	or die "unable to load treasurelists\n";
		3654	}
		3655
		3656	sub reload_sound {
		3657	trace "loading sound config from $DATADIR/sound\n";
		3658
		3659	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3660
		3661	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3662	my $sound = $soundconf->{compat}[$_]
		3663	or next;
		3664
		3665	my $face = cf::face::find "sound/$sound->[1]";
		3666	cf::sound::set $sound->[0] => $face;
		3667	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3668	}
		3669
		3670	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3671	my $face = cf::face::find "sound/$v";
		3672	cf::sound::set $k => $face;
		3673	}
		3674	}
		3675
		3676	sub reload_resources {
		3677	trace "reloading resource files...\n";
		3678
		3679	reload_exp_table;
		3680	reload_materials;
		3681	reload_facedata;
		3682	reload_sound;
		3683	reload_archetypes;
		3684	reload_regions;
		3685	reload_treasures;
		3686
		3687	trace "finished reloading resource files\n";
		3688	}
		3689
		3690	sub reload_config {
		3691	trace "reloading config file...\n";
		3692
		3693	my $config = load_file "$CONFDIR/config";
		3694	utf8::decode $config;
		3695	*CFG = decode_yaml $config;
		3696
2234	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3697	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2235		3698
2236	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3699	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2237	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3700	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2238		3701
2239	if (exists $CFG{mlockall}) {	3702	if (exists $CFG{mlockall}) {
…		…
2243	};	3706	};
2244	warn $@ if $@;	3707	warn $@ if $@;
2245	}	3708	}
2246	}	3709	}
2247		3710
		3711	sub pidfile() {
		3712	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3713	or die "$PIDFILE: $!";
		3714	flock $fh, &Fcntl::LOCK_EX
		3715	or die "$PIDFILE: flock: $!";
		3716	$fh
		3717	}
		3718
		3719	# make sure only one server instance is running at any one time
		3720	sub atomic {
		3721	my $fh = pidfile;
		3722
		3723	my $pid = <$fh>;
		3724	kill 9, $pid if $pid > 0;
		3725
		3726	seek $fh, 0, 0;
		3727	print $fh $$;
		3728	}
		3729
		3730	sub main_loop {
		3731	trace "EV::loop starting\n";
		3732	if (1) {
		3733	EV::loop;
		3734	}
		3735	trace "EV::loop returned\n";
		3736	goto &main_loop unless $REALLY_UNLOOP;
		3737	}
		3738
2248	sub main {	3739	sub main {
		3740	cf::init_globals; # initialise logging
		3741
		3742	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3743	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3744	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3745	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3746
		3747	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3748
2249	# we must not ever block the main coroutine	3749	# we must not ever block the main coroutine
2250	local $Coro::idle = sub {	3750	$Coro::idle = sub {
2251	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3751	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2252	async { Event::one_event };	3752	(async {
		3753	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3754	EV::loop EV::LOOP_ONESHOT;
		3755	})->prio (Coro::PRIO_MAX);
2253	};	3756	};
2254		3757
2255	cfg_load;	3758	evthread_start IO::AIO::poll_fileno;
2256	db_load;	3759
		3760	cf::sync_job {
		3761	cf::incloader::init ();
		3762
		3763	cf::init_anim;
		3764	cf::init_attackmess;
		3765	cf::init_dynamic;
		3766
		3767	cf::load_settings;
		3768
		3769	reload_resources;
		3770	reload_config;
		3771	db_init;
		3772
		3773	cf::init_uuid;
		3774	cf::init_signals;
		3775	cf::init_skills;
		3776
		3777	cf::init_beforeplay;
		3778
		3779	atomic;
		3780
2257	load_extensions;	3781	load_extensions;
2258	Event::loop;	3782
		3783	utime time, time, $RUNTIMEFILE;
		3784
		3785	# no (long-running) fork's whatsoever before this point(!)
		3786	use POSIX ();
		3787	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3788
		3789	cf::_post_init 0;
		3790	};
		3791
		3792	cf::object::thawer::errors_are_fatal 0;
		3793	info "parse errors in files are no longer fatal from this point on.\n";
		3794
		3795	AE::postpone {
		3796	undef &main; # free gobs of memory :)
		3797	};
		3798
		3799	goto &main_loop;
2259	}	3800	}
2260		3801
2261	#############################################################################	3802	#############################################################################
2262	# initialisation and cleanup	3803	# initialisation and cleanup
2263		3804
2264	# install some emergency cleanup handlers	3805	# install some emergency cleanup handlers
2265	BEGIN {	3806	BEGIN {
		3807	our %SIGWATCHER = ();
2266	for my $signal (qw(INT HUP TERM)) {	3808	for my $signal (qw(INT HUP TERM)) {
2267	Event->signal (	3809	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2268	data => WF_AUTOCANCEL,
2269	signal => $signal,
2270	cb => sub {
2271	cf::cleanup "SIG$signal";	3810	cf::cleanup "SIG$signal";
2272	},
2273	);	3811	};
		3812	}
		3813	}
		3814
		3815	sub write_runtime_sync {
		3816	my $t0 = AE::time;
		3817
		3818	# first touch the runtime file to show we are still running:
		3819	# the fsync below can take a very very long time.
		3820
		3821	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3822
		3823	my $guard = cf::lock_acquire "write_runtime";
		3824
		3825	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3826	or return;
		3827
		3828	my $value = $cf::RUNTIME + 90 + 10;
		3829	# 10 is the runtime save interval, for a monotonic clock
		3830	# 60 allows for the watchdog to kill the server.
		3831
		3832	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3833	and return;
		3834
		3835	# always fsync - this file is important
		3836	aio_fsync $fh
		3837	and return;
		3838
		3839	# touch it again to show we are up-to-date
		3840	aio_utime $fh, undef, undef;
		3841
		3842	close $fh
		3843	or return;
		3844
		3845	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3846	and return;
		3847
		3848	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3849
2274	}	3850	1
		3851	}
		3852
		3853	our $uuid_lock;
		3854	our $uuid_skip;
		3855
		3856	sub write_uuid_sync($) {
		3857	$uuid_skip ||= $_[0];
		3858
		3859	return if $uuid_lock;
		3860	local $uuid_lock = 1;
		3861
		3862	my $uuid = "$LOCALDIR/uuid";
		3863
		3864	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3865	or return;
		3866
		3867	my $value = uuid_seq uuid_cur;
		3868
		3869	unless ($value) {
		3870	info "cowardly refusing to write zero uuid value!\n";
		3871	return;
		3872	}
		3873
		3874	my $value = uuid_str $value + $uuid_skip;
		3875	$uuid_skip = 0;
		3876
		3877	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3878	and return;
		3879
		3880	# always fsync - this file is important
		3881	aio_fsync $fh
		3882	and return;
		3883
		3884	close $fh
		3885	or return;
		3886
		3887	aio_rename "$uuid~", $uuid
		3888	and return;
		3889
		3890	trace "uuid file written ($value).\n";
		3891
		3892	1
		3893
		3894	}
		3895
		3896	sub write_uuid($$) {
		3897	my ($skip, $sync) = @_;
		3898
		3899	$sync ? write_uuid_sync $skip
		3900	: async { write_uuid_sync $skip };
2275	}	3901	}
2276		3902
2277	sub emergency_save() {	3903	sub emergency_save() {
2278	my $freeze_guard = cf::freeze_mainloop;	3904	my $freeze_guard = cf::freeze_mainloop;
2279		3905
2280	warn "enter emergency perl save\n";	3906	info "emergency_perl_save: enter\n";
		3907
		3908	# this is a trade-off: we want to be very quick here, so
		3909	# save all maps without fsync, and later call a global sync
		3910	# (which in turn might be very very slow)
		3911	local $USE_FSYNC = 0;
2281		3912
2282	cf::sync_job {	3913	cf::sync_job {
		3914	cf::write_runtime_sync; # external watchdog should not bark
		3915
2283	# use a peculiar iteration method to avoid tripping on perl	3916	# use a peculiar iteration method to avoid tripping on perl
2284	# refcount bugs in for. also avoids problems with players	3917	# refcount bugs in for. also avoids problems with players
2285	# and maps saved/Destroyed asynchronously.	3918	# and maps saved/destroyed asynchronously.
2286	warn "begin emergency player save\n";	3919	info "emergency_perl_save: begin player save\n";
2287	for my $login (keys %cf::PLAYER) {	3920	for my $login (keys %cf::PLAYER) {
2288	my $pl = $cf::PLAYER{$login} or next;	3921	my $pl = $cf::PLAYER{$login} or next;
2289	$pl->valid or next;	3922	$pl->valid or next;
		3923	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2290	$pl->save;	3924	$pl->save;
2291	}	3925	}
2292	warn "end emergency player save\n";	3926	info "emergency_perl_save: end player save\n";
2293		3927
2294	warn "begin emergency map save\n";	3928	cf::write_runtime_sync; # external watchdog should not bark
		3929
		3930	info "emergency_perl_save: begin map save\n";
2295	for my $path (keys %cf::MAP) {	3931	for my $path (keys %cf::MAP) {
2296	my $map = $cf::MAP{$path} or next;	3932	my $map = $cf::MAP{$path} or next;
2297	$map->valid or next;	3933	$map->valid or next;
2298	$map->save;	3934	$map->save;
2299	}	3935	}
2300	warn "end emergency map save\n";	3936	info "emergency_perl_save: end map save\n";
		3937
		3938	cf::write_runtime_sync; # external watchdog should not bark
		3939
		3940	info "emergency_perl_save: begin database checkpoint\n";
		3941	BDB::db_env_txn_checkpoint $DB_ENV;
		3942	info "emergency_perl_save: end database checkpoint\n";
		3943
		3944	info "emergency_perl_save: begin write uuid\n";
		3945	write_uuid_sync 1;
		3946	info "emergency_perl_save: end write uuid\n";
		3947
		3948	cf::write_runtime_sync; # external watchdog should not bark
		3949
		3950	trace "emergency_perl_save: syncing database to disk";
		3951	BDB::db_env_txn_checkpoint $DB_ENV;
		3952
		3953	info "emergency_perl_save: starting sync\n";
		3954	IO::AIO::aio_sync sub {
		3955	info "emergency_perl_save: finished sync\n";
		3956	};
		3957
		3958	cf::write_runtime_sync; # external watchdog should not bark
		3959
		3960	trace "emergency_perl_save: flushing outstanding aio requests";
		3961	while (IO::AIO::nreqs || BDB::nreqs) {
		3962	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		3963	}
		3964
		3965	cf::write_runtime_sync; # external watchdog should not bark
2301	};	3966	};
2302		3967
2303	warn "leave emergency perl save\n";	3968	info "emergency_perl_save: leave\n";
2304	}	3969	}
2305		3970
		3971	sub post_cleanup {
		3972	my ($make_core) = @_;
		3973
		3974	IO::AIO::flush;
		3975
		3976	error Carp::longmess "post_cleanup backtrace"
		3977	if $make_core;
		3978
		3979	my $fh = pidfile;
		3980	unlink $PIDFILE if <$fh> == $$;
		3981	}
		3982
		3983	# a safer delete_package, copied from Symbol
		3984	sub clear_package($) {
		3985	my $pkg = shift;
		3986
		3987	# expand to full symbol table name if needed
		3988	unless ($pkg =~ /^main::.*::$/) {
		3989	$pkg = "main$pkg" if $pkg =~ /^::/;
		3990	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3991	$pkg .= '::' unless $pkg =~ /::$/;
		3992	}
		3993
		3994	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3995	my $stem_symtab = *{$stem}{HASH};
		3996
		3997	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3998	or return;
		3999
		4000	# clear all symbols
		4001	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4002	for my $name (keys %$leaf_symtab) {
		4003	_gv_clear *{"$pkg$name"};
		4004	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4005	}
		4006	}
		4007
2306	sub reload() {	4008	sub do_reload_perl() {
2307	# can/must only be called in main	4009	# can/must only be called in main
2308	if ($Coro::current != $Coro::main) {	4010	unless (in_main) {
2309	warn "can only reload from main coroutine\n";	4011	error "can only reload from main coroutine";
2310	return;	4012	return;
2311	}	4013	}
2312		4014
2313	warn "reloading...";	4015	return if $RELOAD++;
2314		4016
2315	warn "freezing server";	4017	my $t1 = AE::time;
2316	my $guard = freeze_mainloop;	4018
		4019	while ($RELOAD) {
		4020	cf::get_slot 0.1, -1, "reload_perl";
		4021	info "perl_reload: reloading...";
		4022
		4023	trace "perl_reload: entering sync_job";
		4024
		4025	cf::sync_job {
2317	cf::emergency_save;	4026	#cf::emergency_save;
2318		4027
2319	warn "sync database to disk";	4028	trace "perl_reload: cancelling all extension coros";
2320	cf::db_sync;
2321	IO::AIO::flush;
2322
2323	eval {
2324	# if anything goes wrong in here, we should simply crash as we already saved
2325
2326	warn "cancel all watchers";
2327	for (Event::all_watchers) {
2328	$_->cancel if $_->data & WF_AUTOCANCEL;
2329	}
2330
2331	warn "cancel all extension coros";
2332	$_->cancel for values %EXT_CORO;	4029	$_->cancel for values %EXT_CORO;
2333	%EXT_CORO = ();	4030	%EXT_CORO = ();
2334		4031
2335	warn "remove commands";	4032	trace "perl_reload: removing commands";
2336	%COMMAND = ();	4033	%COMMAND = ();
2337		4034
2338	warn "remove ext commands";	4035	trace "perl_reload: removing ext/exti commands";
2339	%EXTCMD = ();	4036	%EXTCMD = ();
		4037	%EXTICMD = ();
2340		4038
2341	warn "unload/nuke all extensions";	4039	trace "perl_reload: unloading/nuking all extensions";
2342	for my $pkg (@EXTS) {	4040	for my $pkg (@EXTS) {
2343	warn "... unloading $pkg";	4041	trace "... unloading $pkg";
2344		4042
2345	if (my $cb = $pkg->can ("unload")) {	4043	if (my $cb = $pkg->can ("unload")) {
2346	eval {	4044	eval {
2347	$cb->($pkg);	4045	$cb->($pkg);
2348	1	4046	1
2349	} or warn "$pkg unloaded, but with errors: $@";	4047	} or error "$pkg unloaded, but with errors: $@";
		4048	}
		4049
		4050	trace "... clearing $pkg";
		4051	clear_package $pkg;
2350	}	4052	}
2351		4053
2352	warn "... nuking $pkg";
2353	Symbol::delete_package $pkg;
2354	}
2355
2356	warn "unload all perl modules loaded from $LIBDIR";	4054	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2357	while (my ($k, $v) = each %INC) {	4055	while (my ($k, $v) = each %INC) {
2358	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4056	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2359		4057
2360	warn "removing <$k>";	4058	trace "... unloading $k";
2361	delete $INC{$k};	4059	delete $INC{$k};
2362		4060
2363	$k =~ s/\.pm$//;	4061	$k =~ s/\.pm$//;
2364	$k =~ s/\//::/g;	4062	$k =~ s/\//::/g;
2365		4063
2366	if (my $cb = $k->can ("unload_module")) {	4064	if (my $cb = $k->can ("unload_module")) {
2367	$cb->();	4065	$cb->();
		4066	}
		4067
		4068	clear_package $k;
2368	}	4069	}
2369		4070
2370	Symbol::delete_package $k;
2371	}
2372
2373	warn "get rid of safe::, as good as possible";	4071	trace "perl_reload: getting rid of safe::, as good as possible";
2374	Symbol::delete_package "safe::$_"	4072	clear_package "safe::$_"
2375	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4073	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2376		4074
2377	warn "unload cf.pm \"a bit\"";	4075	trace "perl_reload: unloading cf.pm \"a bit\"";
2378	delete $INC{"cf.pm"};	4076	delete $INC{"cf.pm"};
		4077	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2379		4078
2380	# don't, removes xs symbols, too,	4079	# don't, removes xs symbols, too,
2381	# and global variables created in xs	4080	# and global variables created in xs
2382	#Symbol::delete_package __PACKAGE__;	4081	#clear_package __PACKAGE__;
2383		4082
2384	warn "reloading cf.pm";	4083	info "perl_reload: unload completed, starting to reload now";
		4084
		4085	trace "perl_reload: reloading cf.pm";
2385	require cf;	4086	require cf;
2386	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4087	cf::_connect_to_perl_1;
2387		4088
2388	warn "load config and database again";	4089	trace "perl_reload: loading config and database again";
2389	cf::cfg_load;	4090	cf::reload_config;
2390	cf::db_load;
2391		4091
2392	warn "load extensions";	4092	trace "perl_reload: loading extensions";
2393	cf::load_extensions;	4093	cf::load_extensions;
2394		4094
		4095	if ($REATTACH_ON_RELOAD) {
2395	warn "reattach attachments to objects/players";	4096	trace "perl_reload: reattaching attachments to objects/players";
2396	_global_reattach;	4097	_global_reattach; # objects, sockets
2397	warn "reattach attachments to maps";	4098	trace "perl_reload: reattaching attachments to maps";
2398	reattach $_ for values %MAP;	4099	reattach $_ for values %MAP;
		4100	trace "perl_reload: reattaching attachments to players";
		4101	reattach $_ for values %PLAYER;
		4102	}
		4103
		4104	cf::_post_init 1;
		4105
		4106	trace "perl_reload: leaving sync_job";
		4107
		4108	1
		4109	} or do {
		4110	error $@;
		4111	cf::cleanup "perl_reload: error, exiting.";
		4112	};
		4113
		4114	--$RELOAD;
		4115	}
		4116
		4117	$t1 = AE::time - $t1;
		4118	info "perl_reload: completed in ${t1}s\n";
		4119	};
		4120
		4121	our $RELOAD_WATCHER; # used only during reload
		4122
		4123	sub reload_perl() {
		4124	# doing reload synchronously and two reloads happen back-to-back,
		4125	# coro crashes during coro_state_free->destroy here.
		4126
		4127	$RELOAD_WATCHER ||= cf::async {
		4128	Coro::AIO::aio_wait cache_extensions;
		4129
		4130	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4131	do_reload_perl;
		4132	undef $RELOAD_WATCHER;
		4133	};
2399	};	4134	};
2400
2401	if ($@) {
2402	warn $@;
2403	warn "error while reloading, exiting.";
2404	exit 1;
2405	}
2406
2407	warn "reloaded";
2408	};
2409
2410	#############################################################################
2411
2412	unless ($LINK_MAP) {
2413	$LINK_MAP = cf::map::new;
2414
2415	$LINK_MAP->width (41);
2416	$LINK_MAP->height (41);
2417	$LINK_MAP->alloc;
2418	$LINK_MAP->path ("{link}");
2419	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2420	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2421
2422	# dirty hack because... archetypes are not yet loaded
2423	Event->timer (
2424	after => 10,
2425	cb => sub {
2426	$_[0]->w->cancel;
2427
2428	# provide some exits "home"
2429	my $exit = cf::object::new "exit";
2430
2431	$exit->slaying ($EMERGENCY_POSITION->[0]);
2432	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2433	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2434
2435	$LINK_MAP->insert ($exit->clone, 19, 19);
2436	$LINK_MAP->insert ($exit->clone, 19, 20);
2437	$LINK_MAP->insert ($exit->clone, 19, 21);
2438	$LINK_MAP->insert ($exit->clone, 20, 19);
2439	$LINK_MAP->insert ($exit->clone, 20, 21);
2440	$LINK_MAP->insert ($exit->clone, 21, 19);
2441	$LINK_MAP->insert ($exit->clone, 21, 20);
2442	$LINK_MAP->insert ($exit->clone, 21, 21);
2443
2444	$exit->destroy;
2445	});
2446
2447	$LINK_MAP->{deny_save} = 1;
2448	$LINK_MAP->{deny_reset} = 1;
2449
2450	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2451	}	4135	}
2452		4136
2453	register_command "reload" => sub {	4137	register_command "reload" => sub {
2454	my ($who, $arg) = @_;	4138	my ($who, $arg) = @_;
2455		4139
2456	if ($who->flag (FLAG_WIZ)) {	4140	if ($who->flag (FLAG_WIZ)) {
2457	$who->message ("start of reload.");
2458	reload;
2459	$who->message ("end of reload.");	4141	$who->message ("reloading server.");
		4142	async {
		4143	$Coro::current->{desc} = "perl_reload";
		4144	reload_perl;
		4145	};
2460	}	4146	}
2461	};	4147	};
2462		4148
2463	unshift @INC, $LIBDIR;	4149	#############################################################################
2464		4150
2465	$TICK_WATCHER = Event->timer (	4151	my $bug_warning = 0;
2466	reentrant => 0,
2467	prio => 0,
2468	at => $NEXT_TICK || $TICK,
2469	data => WF_AUTOCANCEL,
2470	cb => sub {
2471	cf::server_tick; # one server iteration
2472	$RUNTIME += $TICK;
2473	$NEXT_TICK += $TICK;
2474		4152
		4153	sub wait_for_tick() {
		4154	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4155
		4156	$WAIT_FOR_TICK->wait;
		4157	}
		4158
		4159	sub wait_for_tick_begin() {
		4160	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4161
		4162	my $signal = new Coro::Signal;
		4163	push @WAIT_FOR_TICK_BEGIN, $signal;
		4164	$signal->wait;
		4165	}
		4166
		4167	sub tick {
		4168	if ($Coro::current != $Coro::main) {
		4169	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4170	unless ++$bug_warning > 10;
		4171	return;
		4172	}
		4173
		4174	cf::one_tick; # one server iteration
		4175
		4176	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		4177
		4178	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		4179	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		4180	Coro::async_pool {
		4181	$Coro::current->{desc} = "runtime saver";
		4182	write_runtime_sync
		4183	or error "ERROR: unable to write runtime file: $!";
		4184	};
		4185	}
		4186
		4187	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4188	$sig->send;
		4189	}
2475	$WAIT_FOR_TICK->broadcast;	4190	$WAIT_FOR_TICK->broadcast;
2476	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2477		4191
2478	# if we are delayed by four ticks or more, skip them all	4192	$LOAD = ($NOW - $TICK_START) / $TICK;
2479	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4193	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2480		4194
2481	$TICK_WATCHER->at ($NEXT_TICK);	4195	if (0) {
2482	$TICK_WATCHER->start;	4196	if ($NEXT_TICK) {
		4197	my $jitter = $TICK_START - $NEXT_TICK;
		4198	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4199	debug "jitter $JITTER\n";#d#
		4200	}
2483	},	4201	}
2484	);	4202	}
2485		4203
		4204	{
		4205	# configure BDB
		4206
		4207	BDB::min_parallel 16;
		4208	BDB::max_poll_reqs $TICK * 0.1;
		4209	#$AnyEvent::BDB::WATCHER->priority (1);
		4210
		4211	unless ($DB_ENV) {
		4212	$DB_ENV = BDB::db_env_create;
		4213	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4214	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4215	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4216	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4217	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4218
		4219	cf::sync_job {
		4220	eval {
		4221	BDB::db_env_open
		4222	$DB_ENV,
		4223	$BDBDIR,
		4224	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4225	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4226	0666;
		4227
		4228	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4229	};
		4230
		4231	cf::cleanup "db_env_open(db): $@" if $@;
		4232	};
		4233	}
		4234
		4235	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4236	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4237	};
		4238	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4239	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4240	};
		4241	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4242	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4243	};
		4244	}
		4245
		4246	{
		4247	# configure IO::AIO
		4248
		4249	IO::AIO::min_parallel 8;
2486	IO::AIO::max_poll_time $TICK * 0.2;	4250	IO::AIO::max_poll_time $TICK * 0.1;
		4251	undef $AnyEvent::AIO::WATCHER;
		4252	}
2487		4253
2488	Event->io (	4254	our $_log_backtrace;
2489	fd => IO::AIO::poll_fileno,	4255	our $_log_backtrace_last;
2490	poll => 'r',
2491	prio => 5,
2492	data => WF_AUTOCANCEL,
2493	cb => \&IO::AIO::poll_cb,
2494	);
2495		4256
2496	Event->timer (	4257	sub _log_backtrace {
2497	data => WF_AUTOCANCEL,	4258	my ($msg, @addr) = @_;
2498	after => 0,	4259
2499	interval => 10,	4260	$msg =~ s/\n$//;
2500	cb => sub {	4261
2501	(Coro::unblock_sub {	4262	if ($_log_backtrace_last eq $msg) {
2502	write_runtime	4263	LOG llevInfo, "[ABT] $msg\n";
2503	or warn "ERROR: unable to write runtime file: $!";	4264	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4265	# limit the # of concurrent backtraces
		4266	} elsif ($_log_backtrace < 2) {
		4267	$_log_backtrace_last = $msg;
		4268	++$_log_backtrace;
		4269	my $perl_bt = Carp::longmess $msg;
		4270	async {
		4271	$Coro::current->{desc} = "abt $msg";
		4272
		4273	my @bt = fork_call {
		4274	@addr = map { sprintf "%x", $_ } @addr;
		4275	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4276	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4277	or die "addr2line: $!";
		4278
		4279	my @funcs;
		4280	my @res = <$fh>;
		4281	chomp for @res;
		4282	while (@res) {
		4283	my ($func, $line) = splice @res, 0, 2, ();
		4284	push @funcs, "[$func] $line";
		4285	}
		4286
		4287	@funcs
		4288	};
		4289
		4290	LOG llevInfo, "[ABT] $perl_bt\n";
		4291	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4292	LOG llevInfo, "[ABT] $_\n" for @bt;
		4293	--$_log_backtrace;
2504	})->();	4294	};
		4295	} else {
		4296	LOG llevInfo, "[ABT] $msg\n";
		4297	LOG llevInfo, "[ABT] [overload, suppressed]\n";
2505	},	4298	}
2506	);	4299	}
		4300
		4301	# load additional modules
		4302	require "cf/$_.pm" for @EXTRA_MODULES;
		4303	cf::_connect_to_perl_2;
2507		4304
2508	END { cf::emergency_save }	4305	END { cf::emergency_save }
2509		4306
2510	1	4307	1
2511		4308

Diff Legend

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