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

Diff Legend

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