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.251 by root, Wed Apr 18 14:45:13 2007 UTC vs.
Revision 1.587 by root, Wed Oct 31 19:09:47 2012 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use 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);
…		…
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_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
		1911	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1912
		1913	Expand deliantra pod fragments into protocol xml.
		1914
1138	=item $player->ext_reply ($msgid, %msg)	1915	=item $player->ext_reply ($msgid, @msg)
1139		1916
1140	Sends an ext reply to the player.	1917	Sends an ext reply to the player.
1141		1918
1142	=cut	1919	=cut
1143		1920
1144	sub ext_reply($$%) {	1921	sub ext_reply($$@) {
1145	my ($self, $id, %msg) = @_;	1922	my ($self, $id, @msg) = @_;
1146		1923
1147	$msg{msgid} = $id;	1924	$self->ns->ext_reply ($id, @msg)
1148
1149	$self->send ("ext " . cf::to_json \%msg);
1150	}	1925	}
1151		1926
1152	=item $player->ext_event ($type, %msg)	1927	=item $player->ext_msg ($type, @msg)
1153		1928
1154	Sends an ext event to the client.	1929	Sends an ext event to the client.
1155		1930
1156	=cut	1931	=cut
1157		1932
1158	sub ext_event($$%) {	1933	sub ext_msg($$@) {
1159	my ($self, $type, %msg) = @_;	1934	my ($self, $type, @msg) = @_;
1160		1935
1161	$self->ns->ext_event ($type, %msg);	1936	$self->ns->ext_msg ($type, @msg);
1162	}	1937	}
1163		1938
1164	=head3 cf::region	1939	=head3 cf::region
1165		1940
1166	=over 4	1941	=over 4
…		…
1169		1944
1170	package cf::region;	1945	package cf::region;
1171		1946
1172	=item cf::region::find_by_path $path	1947	=item cf::region::find_by_path $path
1173		1948
1174	Tries to decuce the probable region for a map knowing only its path.	1949	Tries to decuce the likely region for a map knowing only its path.
1175		1950
1176	=cut	1951	=cut
1177		1952
1178	sub find_by_path($) {	1953	sub find_by_path($) {
1179	my ($path) = @_;	1954	my ($path) = @_;
1180		1955
		1956	$path =~ s/^~[^\/]*//; # skip ~login
		1957
1181	my ($match, $specificity);	1958	my ($match, $specificity);
1182		1959
1183	for my $region (list) {	1960	for my $region (list) {
1184	if ($region->match && $path =~ $region->match) {	1961	if ($region->{match} && $path =~ $region->{match}) {
1185	($match, $specificity) = ($region, $region->specificity)	1962	($match, $specificity) = ($region, $region->specificity)
1186	if $region->specificity > $specificity;	1963	if $region->specificity > $specificity;
1187	}	1964	}
1188	}	1965	}
1189		1966
…		…
1210	our $MAX_RESET = 3600;	1987	our $MAX_RESET = 3600;
1211	our $DEFAULT_RESET = 3000;	1988	our $DEFAULT_RESET = 3000;
1212		1989
1213	sub generate_random_map {	1990	sub generate_random_map {
1214	my ($self, $rmp) = @_;	1991	my ($self, $rmp) = @_;
1215	# mit "rum" bekleckern, nicht	1992
		1993	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1994
1216	$self->_create_random_map (	1995	$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	}	1996	}
1230		1997
1231	=item cf::map->register ($regex, $prio)	1998	=item cf::map->register ($regex, $prio)
1232		1999
1233	Register a handler for the map path matching the given regex at the	2000	Register a handler for the map path matching the given regex at the
…		…
1238		2005
1239	sub register {	2006	sub register {
1240	my (undef, $regex, $prio) = @_;	2007	my (undef, $regex, $prio) = @_;
1241	my $pkg = caller;	2008	my $pkg = caller;
1242		2009
1243	no strict;
1244	push @{"$pkg\::ISA"}, __PACKAGE__;	2010	push @{"$pkg\::ISA"}, __PACKAGE__;
1245		2011
1246	$EXT_MAP{$pkg} = [$prio, qr<$regex>];	2012	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1247	}	2013	}
1248		2014
1249	# also paths starting with '/'	2015	# also paths starting with '/'
1250	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];	2016	$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1251		2017
1252	sub thawer_merge {	2018	sub thawer_merge {
1253	my ($self, $merge) = @_;	2019	my ($self, $merge) = @_;
1254		2020
1255	# we have to keep some variables in memory intact	2021	# we have to keep some variables in memory intact
1256	local $self->{path};	2022	local $self->{path};
1257	local $self->{load_path};	2023	local $self->{load_path};
1258	local $self->{deny_save};
1259	local $self->{deny_reset};
1260		2024
1261	$self->SUPER::thawer_merge ($merge);	2025	$self->SUPER::thawer_merge ($merge);
1262	}	2026	}
1263		2027
1264	sub normalise {	2028	sub normalise {
1265	my ($path, $base) = @_;	2029	my ($path, $base) = @_;
1266		2030
1267	$path = "$path"; # make sure its a string	2031	$path = "$path"; # make sure it's a string
1268		2032
1269	$path =~ s/\.map$//;	2033	$path =~ s/\.map$//;
1270		2034
1271	# map plan:	2035	# map plan:
1272	#	2036	#
…		…
1287	$base =~ s{[^/]+/?$}{};	2051	$base =~ s{[^/]+/?$}{};
1288	$path = "$base/$path";	2052	$path = "$base/$path";
1289	}	2053	}
1290		2054
1291	for ($path) {	2055	for ($path) {
1292	redo if s{//}{/};
1293	redo if s{/\.?/}{/};	2056	redo if s{/\.?/}{/};
1294	redo if s{/[^/]+/\.\./}{/};	2057	redo if s{/[^/]+/\.\./}{/};
1295	}	2058	}
1296		2059
1297	$path	2060	$path
…		…
1311	$self->init; # pass $1 etc.	2074	$self->init; # pass $1 etc.
1312	return $self;	2075	return $self;
1313	}	2076	}
1314	}	2077	}
1315		2078
1316	Carp::carp "unable to resolve path '$path' (base '$base').";	2079	Carp::cluck "unable to resolve path '$path' (base '$base')";
1317	()	2080	()
1318	}	2081	}
1319		2082
		2083	# may re-bless or do other evil things
1320	sub init {	2084	sub init {
1321	my ($self) = @_;	2085	my ($self) = @_;
1322		2086
1323	$self	2087	$self
1324	}	2088	}
…		…
1336		2100
1337	# the original (read-only) location	2101	# the original (read-only) location
1338	sub load_path {	2102	sub load_path {
1339	my ($self) = @_;	2103	my ($self) = @_;
1340		2104
1341	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	2105	"$MAPDIR/$self->{path}.map"
1342	}	2106	}
1343		2107
1344	# the temporary/swap location	2108	# the temporary/swap location
1345	sub save_path {	2109	sub save_path {
1346	my ($self) = @_;	2110	my ($self) = @_;
1347		2111
1348	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2112	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1349	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	2113	"$TMPDIR/$path.map"
1350	}	2114	}
1351		2115
1352	# the unique path, undef == no special unique path	2116	# the unique path, undef == no special unique path
1353	sub uniq_path {	2117	sub uniq_path {
1354	my ($self) = @_;	2118	my ($self) = @_;
1355		2119
1356	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	2120	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1357	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	2121	"$UNIQUEDIR/$path"
1358	}	2122	}
1359		2123
1360	# and all this just because we cannot iterate over	2124	sub decay_objects {
1361	# all maps in C++...
1362	sub change_all_map_light {
1363	my ($change) = @_;	2125	my ($self) = @_;
1364		2126
1365	$_->change_map_light ($change)	2127	return if $self->{deny_reset};
1366	for grep $_->outdoor, values %cf::MAP;	2128
		2129	$self->do_decay_objects;
1367	}	2130	}
1368		2131
1369	sub unlink_save {	2132	sub unlink_save {
1370	my ($self) = @_;	2133	my ($self) = @_;
1371		2134
…		…
1376		2139
1377	sub load_header_from($) {	2140	sub load_header_from($) {
1378	my ($self, $path) = @_;	2141	my ($self, $path) = @_;
1379		2142
1380	utf8::encode $path;	2143	utf8::encode $path;
1381	#aio_open $path, O_RDONLY, 0	2144	my $f = new_from_file cf::object::thawer $path
1382	# or return;
1383
1384	$self->_load_header ($path)
1385	or return;	2145	or return;
1386		2146
		2147	$self->_load_header ($f)
		2148	or return;
		2149
		2150	local $MAP_LOADING{$self->{path}} = $self;
		2151	$f->resolve_delayed_derefs;
		2152
1387	$self->{load_path} = $path;	2153	$self->{load_path} = $path;
1388		2154
1389	1	2155	1
1390	}	2156	}
1391		2157
		2158	# used to laod the header of an original map
1392	sub load_header_orig {	2159	sub load_header_orig {
1393	my ($self) = @_;	2160	my ($self) = @_;
1394		2161
1395	$self->load_header_from ($self->load_path)	2162	$self->load_header_from ($self->load_path)
1396	}	2163	}
1397		2164
		2165	# used to laod the header of an instantiated map
1398	sub load_header_temp {	2166	sub load_header_temp {
1399	my ($self) = @_;	2167	my ($self) = @_;
1400		2168
1401	$self->load_header_from ($self->save_path)	2169	$self->load_header_from ($self->save_path)
1402	}	2170	}
1403		2171
		2172	# called after loading the header from an instantiated map
1404	sub prepare_temp {	2173	sub prepare_temp {
1405	my ($self) = @_;	2174	my ($self) = @_;
1406		2175
1407	$self->last_access ((delete $self->{last_access})	2176	$self->last_access ((delete $self->{last_access})
1408	|| $cf::RUNTIME); #d#	2177	|| $cf::RUNTIME); #d#
1409	# safety	2178	# safety
1410	$self->{instantiate_time} = $cf::RUNTIME	2179	$self->{instantiate_time} = $cf::RUNTIME
1411	if $self->{instantiate_time} > $cf::RUNTIME;	2180	if $self->{instantiate_time} > $cf::RUNTIME;
1412	}	2181	}
1413		2182
		2183	# called after loading the header from an original map
1414	sub prepare_orig {	2184	sub prepare_orig {
1415	my ($self) = @_;	2185	my ($self) = @_;
1416		2186
1417	$self->{load_original} = 1;	2187	$self->{load_original} = 1;
1418	$self->{instantiate_time} = $cf::RUNTIME;	2188	$self->{instantiate_time} = $cf::RUNTIME;
…		…
1429	$self->load_header_orig	2199	$self->load_header_orig
1430	or return;	2200	or return;
1431	$self->prepare_orig;	2201	$self->prepare_orig;
1432	}	2202	}
1433		2203
		2204	$self->{deny_reset} = 1
		2205	if $self->no_reset;
		2206
1434	$self->default_region (cf::region::find_by_path $self->{path})	2207	$self->default_region (cf::region::find_by_path $self->{path})
1435	unless $self->default_region;	2208	unless $self->default_region;
1436		2209
1437	1	2210	1
1438	}	2211	}
1439		2212
1440	sub find;	2213	sub find;
1441	sub find {	2214	sub find {
1442	my ($path, $origin) = @_;	2215	my ($path, $origin) = @_;
1443		2216
		2217	cf::cede_to_tick;
		2218
1444	$path = normalise $path, $origin && $origin->path;	2219	$path = normalise $path, $origin;
1445		2220
		2221	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1446	cf::lock_wait "map_find:$path";	2222	my $guard2 = cf::lock_acquire "map_find:$path";
1447		2223
1448	$cf::MAP{$path} || do {	2224	$cf::MAP{$path} || do {
1449	my $guard = cf::lock_acquire "map_find:$path";
1450	my $map = new_from_path cf::map $path	2225	my $map = new_from_path cf::map $path
1451	or return;	2226	or return;
1452		2227
1453	$map->{last_save} = $cf::RUNTIME;	2228	$map->{last_save} = $cf::RUNTIME;
1454		2229
1455	$map->load_header	2230	$map->load_header
1456	or return;	2231	or return;
1457		2232
1458	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2233	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459	# doing this can freeze the server in a sync job, obviously	2234	# doing this can freeze the server in a sync job, obviously
1460	#$cf::WAIT_FOR_TICK->wait;	2235	#$cf::WAIT_FOR_TICK->wait;
		2236	undef $guard2;
		2237	undef $guard1;
1461	$map->reset;	2238	$map->reset;
1462	undef $guard;
1463	return find $path;	2239	return find $path;
1464	}	2240	}
1465		2241
1466	$cf::MAP{$path} = $map	2242	$cf::MAP{$path} = $map
1467	}	2243	}
1468	}	2244	}
1469		2245
1470	sub pre_load { }	2246	sub pre_load { }
1471	sub post_load { }	2247	#sub post_load { } # XS
1472		2248
1473	sub load {	2249	sub load {
1474	my ($self) = @_;	2250	my ($self) = @_;
1475		2251
1476	local $self->{deny_reset} = 1; # loading can take a long time	2252	local $self->{deny_reset} = 1; # loading can take a long time
1477		2253
1478	my $path = $self->{path};	2254	my $path = $self->{path};
		2255
		2256	{
1479	my $guard = cf::lock_acquire "map_load:$path";	2257	my $guard = cf::lock_acquire "map_data:$path";
1480		2258
1481	return if $self->in_memory != cf::MAP_SWAPPED;	2259	return unless $self->valid;
		2260	return unless $self->state == cf::MAP_SWAPPED;
1482		2261
1483	$self->in_memory (cf::MAP_LOADING);
1484
1485	$self->alloc;	2262	$self->alloc;
1486		2263
1487	$self->pre_load;	2264	$self->pre_load;
1488	Coro::cede;	2265	cf::cede_to_tick;
1489		2266
1490	$self->_load_objects ($self->{load_path}, 1)	2267	if (exists $self->{load_path}) {
		2268	my $f = new_from_file cf::object::thawer $self->{load_path};
		2269	$f->skip_block;
		2270	$self->_load_objects ($f)
1491	or return;	2271	or return;
1492		2272
1493	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2273	$self->post_load_original
1494	if delete $self->{load_original};	2274	if delete $self->{load_original};
1495		2275
1496	if (my $uniq = $self->uniq_path) {	2276	if (my $uniq = $self->uniq_path) {
1497	utf8::encode $uniq;	2277	utf8::encode $uniq;
1498	if (aio_open $uniq, O_RDONLY, 0) {	2278	unless (aio_stat $uniq) {
		2279	if (my $f = new_from_file cf::object::thawer $uniq) {
1499	$self->clear_unique_items;	2280	$self->clear_unique_items;
1500	$self->_load_objects ($uniq, 0);	2281	$self->_load_objects ($f);
		2282	$f->resolve_delayed_derefs;
		2283	}
		2284	}
1501	}	2285	}
1502	}
1503		2286
1504	Coro::cede;	2287	$f->resolve_delayed_derefs;
		2288	} else {
		2289	$self->post_load_original
		2290	if delete $self->{load_original};
		2291	}
		2292
		2293	$self->state (cf::MAP_INACTIVE);
		2294
		2295	cf::cede_to_tick;
1505	# now do the right thing for maps	2296	# now do the right thing for maps
1506	$self->link_multipart_objects;	2297	$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)	2298	$self->difficulty ($self->estimate_difficulty)
1516	unless $self->difficulty;	2299	unless $self->difficulty;
1517	Coro::cede;	2300	cf::cede_to_tick;
1518	$self->activate;	2301
1519	Coro::cede;	2302	unless ($self->{deny_activate}) {
		2303	$self->decay_objects;
		2304	$self->fix_auto_apply;
		2305	$self->update_buttons;
		2306	cf::cede_to_tick;
		2307	#$self->activate; # no longer activate maps automatically
		2308	}
		2309
		2310	$self->{last_save} = $cf::RUNTIME;
		2311	$self->last_access ($cf::RUNTIME);
1520	}	2312	}
1521		2313
1522	$self->post_load;	2314	$self->post_load;
1523	Coro::cede;
1524		2315
1525	$self->in_memory (cf::MAP_IN_MEMORY);	2316	1
1526	}	2317	}
1527		2318
		2319	# customize the map for a given player, i.e.
		2320	# return the _real_ map. used by e.g. per-player
		2321	# maps to change the path to ~playername/mappath
1528	sub customise_for {	2322	sub customise_for {
1529	my ($self, $ob) = @_;	2323	my ($self, $ob) = @_;
1530		2324
1531	return find "~" . $ob->name . "/" . $self->{path}	2325	return find "~" . $ob->name . "/" . $self->{path}
1532	if $self->per_player;	2326	if $self->per_player;
1533		2327
		2328	# return find "?party/" . $ob->name . "/" . $self->{path}
		2329	# if $self->per_party;
		2330
1534	$self	2331	$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	}	2332	}
1560		2333
1561	sub find_sync {	2334	sub find_sync {
1562	my ($path, $origin) = @_;	2335	my ($path, $origin) = @_;
1563		2336
1564	cf::sync_job { find $path, $origin }	2337	# it's a bug to call this from the main context
		2338	return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
		2339	if $Coro::current == $Coro::main;
		2340
		2341	find $path, $origin
1565	}	2342	}
1566		2343
1567	sub do_load_sync {	2344	sub do_load_sync {
1568	my ($map) = @_;	2345	my ($map) = @_;
1569		2346
1570	cf::sync_job { $map->load };	2347	# it's a bug to call this from the main context
		2348	return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
		2349	if $Coro::current == $Coro::main;
		2350
		2351	$map->load;
1571	}	2352	}
1572		2353
1573	our %MAP_PREFETCH;	2354	our %MAP_PREFETCH;
1574	our $MAP_PREFETCHER = undef;	2355	our $MAP_PREFETCHER = undef;
1575		2356
1576	sub find_async {	2357	sub find_async {
1577	my ($path, $origin) = @_;	2358	my ($path, $origin, $load) = @_;
1578		2359
1579	$path = normalise $path, $origin && $origin->{path};	2360	$path = normalise $path, $origin;
1580		2361
1581	if (my $map = $cf::MAP{$path}) {	2362	if (my $map = $cf::MAP{$path}) {
1582	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2363	return $map if !$load || $map->linkable;
1583	}	2364	}
1584		2365
1585	undef $MAP_PREFETCH{$path};	2366	$MAP_PREFETCH{$path} |= $load;
		2367
1586	$MAP_PREFETCHER ||= cf::async {	2368	$MAP_PREFETCHER ||= cf::async {
		2369	$Coro::current->{desc} = "map prefetcher";
		2370
1587	while (%MAP_PREFETCH) {	2371	while (%MAP_PREFETCH) {
1588	for my $path (keys %MAP_PREFETCH) {	2372	while (my ($k, $v) = each %MAP_PREFETCH) {
1589	my $map = find $path	2373	if (my $map = find $k) {
1590	or next;
1591	$map->load;	2374	$map->load if $v;
		2375	}
1592		2376
1593	delete $MAP_PREFETCH{$path};	2377	delete $MAP_PREFETCH{$k};
1594	}	2378	}
1595	}	2379	}
1596	undef $MAP_PREFETCHER;	2380	undef $MAP_PREFETCHER;
1597	};	2381	};
1598	$MAP_PREFETCHER->prio (6);	2382	$MAP_PREFETCHER->prio (6);
1599		2383
1600	()	2384	()
1601	}	2385	}
1602		2386
		2387	# common code, used by both ->save and ->swapout
1603	sub save {	2388	sub _save {
1604	my ($self) = @_;	2389	my ($self) = @_;
1605
1606	my $lock = cf::lock_acquire "map_data:" . $self->path;
1607		2390
1608	$self->{last_save} = $cf::RUNTIME;	2391	$self->{last_save} = $cf::RUNTIME;
1609		2392
1610	return unless $self->dirty;	2393	return unless $self->dirty;
1611		2394
…		…
1617	return if $self->{deny_save};	2400	return if $self->{deny_save};
1618		2401
1619	local $self->{last_access} = $self->last_access;#d#	2402	local $self->{last_access} = $self->last_access;#d#
1620		2403
1621	cf::async {	2404	cf::async {
		2405	$Coro::current->{desc} = "map player save";
1622	$_->contr->save for $self->players;	2406	$_->contr->save for $self->players;
1623	};	2407	};
		2408
		2409	cf::get_slot 0.02;
1624		2410
1625	if ($uniq) {	2411	if ($uniq) {
1626	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2412	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1627	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2413	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1628	} else {	2414	} else {
1629	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2415	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1630	}	2416	}
1631	}	2417	}
1632		2418
		2419	sub save {
		2420	my ($self) = @_;
		2421
		2422	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2423
		2424	$self->_save;
		2425	}
		2426
1633	sub swap_out {	2427	sub swap_out {
1634	my ($self) = @_;	2428	my ($self) = @_;
1635		2429
1636	# save first because save cedes
1637	$self->save;
1638
1639	my $lock = cf::lock_acquire "map_data:" . $self->path;	2430	my $lock = cf::lock_acquire "map_data:$self->{path}";
1640		2431
		2432	return if !$self->linkable;
		2433	return if $self->{deny_save};
1641	return if $self->players;	2434	return if $self->players;
1642	return if $self->in_memory != cf::MAP_IN_MEMORY;
1643	return if $self->{deny_save};
1644		2435
		2436	# first deactivate the map and "unlink" it from the core
		2437	$self->deactivate;
		2438	$_->clear_links_to ($self) for values %cf::MAP;
		2439	$self->state (cf::MAP_SWAPPED);
		2440
		2441	# then atomically save
		2442	$self->_save;
		2443
		2444	# then free the map
1645	$self->clear;	2445	$self->clear;
1646	$self->in_memory (cf::MAP_SWAPPED);
1647	}	2446	}
1648		2447
1649	sub reset_at {	2448	sub reset_at {
1650	my ($self) = @_;	2449	my ($self) = @_;
1651		2450
1652	# TODO: safety, remove and allow resettable per-player maps	2451	# 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};	2452	return 1e99 if $self->{deny_reset};
1655		2453
1656	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2454	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1657	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2455	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1658		2456
…		…
1669	my ($self) = @_;	2467	my ($self) = @_;
1670		2468
1671	my $lock = cf::lock_acquire "map_data:$self->{path}";	2469	my $lock = cf::lock_acquire "map_data:$self->{path}";
1672		2470
1673	return if $self->players;	2471	return if $self->players;
1674	return if $self->isa ("ext::map_per_player");#d#
1675		2472
1676	warn "resetting map ", $self->path;#d#	2473	cf::trace "resetting map ", $self->path, "\n";
1677		2474
1678	$self->in_memory (cf::MAP_SWAPPED);	2475	$self->state (cf::MAP_SWAPPED);
1679		2476
1680	# need to save uniques path	2477	# need to save uniques path
1681	unless ($self->{deny_save}) {	2478	unless ($self->{deny_save}) {
1682	my $uniq = $self->uniq_path; utf8::encode $uniq;	2479	my $uniq = $self->uniq_path; utf8::encode $uniq;
1683		2480
…		…
1685	if $uniq;	2482	if $uniq;
1686	}	2483	}
1687		2484
1688	delete $cf::MAP{$self->path};	2485	delete $cf::MAP{$self->path};
1689		2486
		2487	$self->deactivate;
		2488	$_->clear_links_to ($self) for values %cf::MAP;
1690	$self->clear;	2489	$self->clear;
1691
1692	$_->clear_links_to ($self) for values %cf::MAP;
1693		2490
1694	$self->unlink_save;	2491	$self->unlink_save;
1695	$self->destroy;	2492	$self->destroy;
1696	}	2493	}
1697		2494
1698	my $nuke_counter = "aaaa";	2495	my $nuke_counter = "aaaa";
1699		2496
1700	sub nuke {	2497	sub nuke {
1701	my ($self) = @_;	2498	my ($self) = @_;
1702		2499
		2500	{
		2501	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2502
1703	delete $cf::MAP{$self->path};	2503	delete $cf::MAP{$self->path};
1704		2504
1705	$self->unlink_save;	2505	$self->unlink_save;
1706		2506
1707	bless $self, "cf::map";	2507	bless $self, "cf::map::wrap";
1708	delete $self->{deny_reset};	2508	delete $self->{deny_reset};
1709	$self->{deny_save} = 1;	2509	$self->{deny_save} = 1;
1710	$self->reset_timeout (1);	2510	$self->reset_timeout (1);
1711	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2511	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1712		2512
1713	$cf::MAP{$self->path} = $self;	2513	$cf::MAP{$self->path} = $self;
		2514	}
1714		2515
1715	$self->reset; # polite request, might not happen	2516	$self->reset; # polite request, might not happen
		2517	}
		2518
		2519	=item $maps = cf::map::tmp_maps
		2520
		2521	Returns an arrayref with all map paths of currently instantiated and saved
		2522	maps. May block.
		2523
		2524	=cut
		2525
		2526	sub tmp_maps() {
		2527	[
		2528	map {
		2529	utf8::decode $_;
		2530	/\.map$/
		2531	? normalise $_
		2532	: ()
		2533	} @{ aio_readdir $TMPDIR or [] }
		2534	]
		2535	}
		2536
		2537	=item $maps = cf::map::random_maps
		2538
		2539	Returns an arrayref with all map paths of currently instantiated and saved
		2540	random maps. May block.
		2541
		2542	=cut
		2543
		2544	sub random_maps() {
		2545	[
		2546	map {
		2547	utf8::decode $_;
		2548	/\.map$/
		2549	? normalise "?random/$_"
		2550	: ()
		2551	} @{ aio_readdir $RANDOMDIR or [] }
		2552	]
1716	}	2553	}
1717		2554
1718	=item cf::map::unique_maps	2555	=item cf::map::unique_maps
1719		2556
1720	Returns an arrayref of paths of all shared maps that have	2557	Returns an arrayref of paths of all shared maps that have
1721	instantiated unique items. May block.	2558	instantiated unique items. May block.
1722		2559
1723	=cut	2560	=cut
1724		2561
1725	sub unique_maps() {	2562	sub unique_maps() {
1726	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2563	[
1727	or return;	2564	map {
1728
1729	my @paths;
1730
1731	for (@$files) {
1732	utf8::decode $_;	2565	utf8::decode $_;
1733	next if /\.pst$/;	2566	s/\.map$//; # TODO future compatibility hack
1734	next unless /^$PATH_SEP/o;	2567	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1735		2568	? ()
1736	push @paths, cf::map::normalise $_;	2569	: normalise $_
		2570	} @{ aio_readdir $UNIQUEDIR or [] }
1737	}	2571	]
1738
1739	\@paths
1740	}	2572	}
1741		2573
1742	package cf;	2574	=item cf::map::static_maps
		2575
		2576	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2577	file in the shared directory excluding F</styles> and F</editor>). May
		2578	block.
		2579
		2580	=cut
		2581
		2582	sub static_maps() {
		2583	my @dirs = "";
		2584	my @maps;
		2585
		2586	while (@dirs) {
		2587	my $dir = shift @dirs;
		2588
		2589	next if $dir eq "/styles" || $dir eq "/editor";
		2590
		2591	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2592	or return;
		2593
		2594	for (@$files) {
		2595	s/\.map$// or next;
		2596	utf8::decode $_;
		2597	push @maps, "$dir/$_";
		2598	}
		2599
		2600	push @dirs, map "$dir/$_", @$dirs;
		2601	}
		2602
		2603	\@maps
		2604	}
1743		2605
1744	=back	2606	=back
1745		2607
1746	=head3 cf::object	2608	=head3 cf::object
1747		2609
…		…
1751		2613
1752	=over 4	2614	=over 4
1753		2615
1754	=item $ob->inv_recursive	2616	=item $ob->inv_recursive
1755		2617
1756	Returns the inventory of the object _and_ their inventories, recursively.	2618	Returns the inventory of the object I<and> their inventories, recursively,
		2619	but I<not> the object itself.
1757		2620
1758	=cut	2621	=cut
1759		2622
1760	sub inv_recursive_;	2623	sub inv_recursive_;
1761	sub inv_recursive_ {	2624	sub inv_recursive_ {
…		…
1764		2627
1765	sub inv_recursive {	2628	sub inv_recursive {
1766	inv_recursive_ inv $_[0]	2629	inv_recursive_ inv $_[0]
1767	}	2630	}
1768		2631
		2632	=item $ref = $ob->ref
		2633
		2634	Creates and returns a persistent reference to an object that can be stored as a string.
		2635
		2636	=item $ob = cf::object::deref ($refstring)
		2637
		2638	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2639	even if the object actually exists. May block.
		2640
		2641	=cut
		2642
		2643	sub deref {
		2644	my ($ref) = @_;
		2645
		2646	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2647	my ($uuid, $name) = ($1, $2);
		2648	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2649	or return;
		2650	$pl->ob->uuid eq $uuid
		2651	or return;
		2652
		2653	$pl->ob
		2654	} else {
		2655	warn "$ref: cannot resolve object reference\n";
		2656	undef
		2657	}
		2658	}
		2659
1769	package cf;	2660	package cf;
1770		2661
1771	=back	2662	=back
1772		2663
1773	=head3 cf::object::player	2664	=head3 cf::object::player
…		…
1779	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2670	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1780	can be C<undef>. Does the right thing when the player is currently in a	2671	can be C<undef>. Does the right thing when the player is currently in a
1781	dialogue with the given NPC character.	2672	dialogue with the given NPC character.
1782		2673
1783	=cut	2674	=cut
		2675
		2676	our $SAY_CHANNEL = {
		2677	id => "say",
		2678	title => "Map",
		2679	reply => "say ",
		2680	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2681	};
		2682
		2683	our $CHAT_CHANNEL = {
		2684	id => "chat",
		2685	title => "Chat",
		2686	reply => "chat ",
		2687	tooltip => "Player chat and shouts, global to the server.",
		2688	};
1784		2689
1785	# rough implementation of a future "reply" method that works	2690	# rough implementation of a future "reply" method that works
1786	# with dialog boxes.	2691	# with dialog boxes.
1787	#TODO: the first argument must go, split into a $npc->reply_to ( method	2692	#TODO: the first argument must go, split into a $npc->reply_to ( method
1788	sub cf::object::player::reply($$$;$) {	2693	sub cf::object::player::reply($$$;$) {
…		…
1790		2695
1791	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2696	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1792		2697
1793	if ($self->{record_replies}) {	2698	if ($self->{record_replies}) {
1794	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2699	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2700
1795	} else {	2701	} else {
		2702	my $pl = $self->contr;
		2703
		2704	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2705	my $dialog = $pl->{npc_dialog};
		2706	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2707
		2708	} else {
1796	$msg = $npc->name . " says: $msg" if $npc;	2709	$msg = $npc->name . " says: $msg" if $npc;
1797	$self->message ($msg, $flags);	2710	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2711	}
1798	}	2712	}
		2713	}
		2714
		2715	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2716
		2717	=cut
		2718
		2719	sub cf::object::send_msg {
		2720	my $pl = shift->contr
		2721	or return;
		2722	$pl->send_msg (@_);
1799	}	2723	}
1800		2724
1801	=item $player_object->may ("access")	2725	=item $player_object->may ("access")
1802		2726
1803	Returns wether the given player is authorized to access resource "access"	2727	Returns wether the given player is authorized to access resource "access"
…		…
1816		2740
1817	=item $player_object->enter_link	2741	=item $player_object->enter_link
1818		2742
1819	Freezes the player and moves him/her to a special map (C<{link}>).	2743	Freezes the player and moves him/her to a special map (C<{link}>).
1820		2744
1821	The player should be reasonably safe there for short amounts of time. You	2745	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.	2746	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2747	though, as the player cannot control the character while it is on the link
		2748	map.
1823		2749
1824	Will never block.	2750	Will never block.
1825		2751
1826	=item $player_object->leave_link ($map, $x, $y)	2752	=item $player_object->leave_link ($map, $x, $y)
1827		2753
…		…
1847	sub cf::object::player::enter_link {	2773	sub cf::object::player::enter_link {
1848	my ($self) = @_;	2774	my ($self) = @_;
1849		2775
1850	$self->deactivate_recursive;	2776	$self->deactivate_recursive;
1851		2777
		2778	++$self->{_link_recursion};
		2779
1852	return if UNIVERSAL::isa $self->map, "ext::map_link";	2780	return if UNIVERSAL::isa $self->map, "ext::map_link";
1853		2781
1854	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2782	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1855	if $self->map;	2783	if $self->map && $self->map->{path} ne "{link}";
1856		2784
1857	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2785	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1858	}	2786	}
1859		2787
1860	sub cf::object::player::leave_link {	2788	sub cf::object::player::leave_link {
1861	my ($self, $map, $x, $y) = @_;	2789	my ($self, $map, $x, $y) = @_;
		2790
		2791	return unless $self->contr->active;
1862		2792
1863	my $link_pos = delete $self->{_link_pos};	2793	my $link_pos = delete $self->{_link_pos};
1864		2794
1865	unless ($map) {	2795	unless ($map) {
1866	# restore original map position	2796	# restore original map position
…		…
1877	($x, $y) = (-1, -1)	2807	($x, $y) = (-1, -1)
1878	unless (defined $x) && (defined $y);	2808	unless (defined $x) && (defined $y);
1879		2809
1880	# use -1 or undef as default coordinates, not 0, 0	2810	# use -1 or undef as default coordinates, not 0, 0
1881	($x, $y) = ($map->enter_x, $map->enter_y)	2811	($x, $y) = ($map->enter_x, $map->enter_y)
1882	if $x <=0 && $y <= 0;	2812	if $x <= 0 && $y <= 0;
1883		2813
1884	$map->load;	2814	$map->load;
1885	$map->load_diag;
1886		2815
1887	return unless $self->contr->active;	2816	return unless $self->contr->active;
1888	$self->activate_recursive;
1889		2817
1890	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2818	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1891	$self->enter_map ($map, $x, $y);	2819	if ($self->enter_map ($map, $x, $y)) {
1892	}	2820	# entering was successful
1893		2821	delete $self->{_link_recursion};
1894	cf::player->attach (	2822	# only activate afterwards, to support waiting in hooks
1895	on_logout => sub {	2823	$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	},	2824	}
1905	on_login => sub {
1906	my ($pl) = @_;
1907		2825
1908	# try to abort aborted map switching on player login :)	2826	}
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		2827
1926	=item $player_object->goto ($path, $x, $y)	2828	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1927		2829
		2830	Moves the player to the given map-path and coordinates by first freezing
		2831	her, loading and preparing them map, calling the provided $check callback
		2832	that has to return the map if sucecssful, and then unfreezes the player on
		2833	the new (success) or old (failed) map position. In either case, $done will
		2834	be called at the end of this process.
		2835
		2836	Note that $check will be called with a potentially non-loaded map, so if
		2837	it needs a loaded map it has to call C<< ->load >>.
		2838
1928	=cut	2839	=cut
		2840
		2841	our $GOTOGEN;
1929		2842
1930	sub cf::object::player::goto {	2843	sub cf::object::player::goto {
1931	my ($self, $path, $x, $y) = @_;	2844	my ($self, $path, $x, $y, $check, $done) = @_;
		2845
		2846	if ($self->{_link_recursion} >= $MAX_LINKS) {
		2847	error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
		2848	$self->failmsg ("Something went wrong inside the server - please contact an administrator!");
		2849	($path, $x, $y) = @$EMERGENCY_POSITION;
		2850	}
		2851
		2852	# do generation counting so two concurrent goto's will be executed in-order
		2853	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1932		2854
1933	$self->enter_link;	2855	$self->enter_link;
1934		2856
1935	(async {	2857	(async {
		2858	$Coro::current->{desc} = "player::goto $path $x $y";
		2859
		2860	# *tag paths override both path and x|y
		2861	if ($path =~ /^\*(.*)$/) {
		2862	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2863	my $ob = $obs[rand @obs];
		2864
		2865	# see if we actually can go there
		2866	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2867	$ob = $obs[rand @obs];
		2868	} else {
		2869	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2870	}
		2871	# else put us there anyways for now #d#
		2872
		2873	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2874	} else {
		2875	($path, $x, $y) = (undef, undef, undef);
		2876	}
		2877	}
		2878
1936	my $map = eval {	2879	my $map = eval {
1937	my $map = cf::map::find $path;	2880	my $map = defined $path ? cf::map::find $path, $self->map : undef;
		2881
		2882	if ($map) {
1938	$map = $map->customise_for ($self) if $map;	2883	$map = $map->customise_for ($self);
		2884	$map = $check->($map, $x, $y, $self) if $check && $map;
		2885	} else {
		2886	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2887	}
		2888
1939	$map	2889	$map
		2890	};
		2891
		2892	if ($@) {
		2893	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2894	LOG llevError | logBacktrace, Carp::longmess $@;
1940	} or	2895	}
1941	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1942		2896
		2897	if ($gen == $self->{_goto_generation}) {
		2898	delete $self->{_goto_generation};
1943	$self->leave_link ($map, $x, $y);	2899	$self->leave_link ($map, $x, $y);
		2900	}
		2901
		2902	$done->($self) if $done;
1944	})->prio (1);	2903	})->prio (1);
1945	}	2904	}
1946		2905
1947	=item $player_object->enter_exit ($exit_object)	2906	=item $player_object->enter_exit ($exit_object)
1948		2907
…		…
1968	}	2927	}
1969		2928
1970	sub prepare_random_map {	2929	sub prepare_random_map {
1971	my ($exit) = @_;	2930	my ($exit) = @_;
1972		2931
1973	my $guard = cf::lock_acquire "exit_prepare:$exit";
1974
1975	# all this does is basically replace the /! path by	2932	# all this does is basically replace the /! path by
1976	# a new random map path (?random/...) with a seed	2933	# a new random map path (?random/...) with a seed
1977	# that depends on the exit object	2934	# that depends on the exit object
1978		2935
1979	my $rmp = parse_random_map_params $exit->msg;	2936	my $rmp = parse_random_map_params $exit->msg;
…		…
1981	if ($exit->map) {	2938	if ($exit->map) {
1982	$rmp->{region} = $exit->region->name;	2939	$rmp->{region} = $exit->region->name;
1983	$rmp->{origin_map} = $exit->map->path;	2940	$rmp->{origin_map} = $exit->map->path;
1984	$rmp->{origin_x} = $exit->x;	2941	$rmp->{origin_x} = $exit->x;
1985	$rmp->{origin_y} = $exit->y;	2942	$rmp->{origin_y} = $exit->y;
		2943
		2944	$exit->map->touch;
1986	}	2945	}
1987		2946
1988	$rmp->{random_seed} ||= $exit->random_seed;	2947	$rmp->{random_seed} ||= $exit->random_seed;
1989		2948
1990	my $data = cf::to_json $rmp;	2949	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1991	my $md5 = Digest::MD5::md5_hex $data;	2950	my $md5 = Digest::MD5::md5_hex $data;
1992	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2951	my $meta = "$RANDOMDIR/$md5.meta";
1993		2952
1994	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2953	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1995	aio_write $fh, 0, (length $data), $data, 0;	2954	aio_write $fh, 0, (length $data), $data, 0;
1996	undef $fh;	2955	undef $fh;
1997	aio_rename "$meta~", $meta;	2956	aio_rename "$meta~", $meta;
1998		2957
		2958	my $slaying = "?random/$md5";
		2959
		2960	if ($exit->valid) {
1999	$exit->slaying ("?random/$md5");	2961	$exit->slaying ("?random/$md5");
2000	$exit->msg (undef);	2962	$exit->msg (undef);
		2963	}
2001	}	2964	}
2002	}	2965	}
2003		2966
2004	sub cf::object::player::enter_exit {	2967	sub cf::object::player::enter_exit {
2005	my ($self, $exit) = @_;	2968	my ($self, $exit) = @_;
2006		2969
2007	return unless $self->type == cf::PLAYER;	2970	return unless $self->type == cf::PLAYER;
2008		2971
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;	2972	$self->enter_link;
2021		2973
2022	(async {	2974	(async {
2023	$self->deactivate_recursive; # just to be sure	2975	$Coro::current->{desc} = "enter_exit";
		2976
2024	unless (eval {	2977	unless (eval {
		2978	$self->deactivate_recursive; # just to be sure
		2979
		2980	my $map = cf::map::normalise $exit->slaying, $exit->map;
		2981	my $x = $exit->stats->hp;
		2982	my $y = $exit->stats->sp;
		2983
		2984	# special map handling
		2985	my $slaying = $exit->slaying;
		2986
		2987	# special map handling
		2988	if ($slaying eq "/!") {
		2989	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2990
		2991	prepare_random_map $exit
		2992	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		2993
		2994	$map = $exit->slaying;
		2995
		2996	} elsif ($slaying eq '!up') {
		2997	$map = $exit->map->tile_path (cf::TILE_UP);
		2998	$x = $exit->x;
		2999	$y = $exit->y;
		3000
		3001	} elsif ($slaying eq '!down') {
		3002	$map = $exit->map->tile_path (cf::TILE_DOWN);
		3003	$x = $exit->x;
		3004	$y = $exit->y;
		3005	}
		3006
2025	$self->goto ($slaying, $hp, $sp);	3007	$self->goto ($map, $x, $y);
2026		3008
		3009	# if exit is damned, update players death & WoR home-position
		3010	$self->contr->savebed ($map, $x, $y)
		3011	if $exit->flag (cf::FLAG_DAMNED);
		3012
2027	1;	3013	1
2028	}) {	3014	}) {
2029	$self->message ("Something went wrong deep within the crossfire server. "	3015	$self->message ("Something went wrong deep within the deliantra server. "
2030	. "I'll try to bring you back to the map you were before. "	3016	. "I'll try to bring you back to the map you were before. "
2031	. "Please report this to the dungeon master!",	3017	. "Please report this to the dungeon master!",
2032	cf::NDI_UNIQUE | cf::NDI_RED);	3018	cf::NDI_UNIQUE | cf::NDI_RED);
2033		3019
2034	warn "ERROR in enter_exit: $@";	3020	error "ERROR in enter_exit: $@";
2035	$self->leave_link;	3021	$self->leave_link;
2036	}	3022	}
2037	})->prio (1);	3023	})->prio (1);
2038	}	3024	}
2039		3025
…		…
2053		3039
2054	utf8::encode $text;	3040	utf8::encode $text;
2055	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	3041	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2056	}	3042	}
2057		3043
		3044	=item $client->send_big_packet ($pkt)
		3045
		3046	Like C<send_packet>, but tries to compress large packets, and fragments
		3047	them as required.
		3048
		3049	=cut
		3050
		3051	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		3052
		3053	sub cf::client::send_big_packet {
		3054	my ($self, $pkt) = @_;
		3055
		3056	# try lzf for large packets
		3057	$pkt = "lzf " . Compress::LZF::compress $pkt
		3058	if 1024 <= length $pkt and $self->{can_lzf};
		3059
		3060	# split very large packets
		3061	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		3062	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		3063	$pkt = "frag";
		3064	}
		3065
		3066	$self->send_packet ($pkt);
		3067	}
		3068
		3069	=item $client->send_msg ($channel, $msg, $color, [extra...])
		3070
		3071	Send a drawinfo or msg packet to the client, formatting the msg for the
		3072	client if neccessary. C<$type> should be a string identifying the type of
		3073	the message, with C<log> being the default. If C<$color> is negative, suppress
		3074	the message unless the client supports the msg packet.
		3075
		3076	=cut
		3077
		3078	# non-persistent channels (usually the info channel)
		3079	our %CHANNEL = (
		3080	"c/motd" => {
		3081	id => "infobox",
		3082	title => "MOTD",
		3083	reply => undef,
		3084	tooltip => "The message of the day",
		3085	},
		3086	"c/identify" => {
		3087	id => "infobox",
		3088	title => "Identify",
		3089	reply => undef,
		3090	tooltip => "Items recently identified",
		3091	},
		3092	"c/examine" => {
		3093	id => "infobox",
		3094	title => "Examine",
		3095	reply => undef,
		3096	tooltip => "Signs and other items you examined",
		3097	},
		3098	"c/shopinfo" => {
		3099	id => "infobox",
		3100	title => "Shop Info",
		3101	reply => undef,
		3102	tooltip => "What your bargaining skill tells you about the shop",
		3103	},
		3104	"c/book" => {
		3105	id => "infobox",
		3106	title => "Book",
		3107	reply => undef,
		3108	tooltip => "The contents of a note or book",
		3109	},
		3110	"c/lookat" => {
		3111	id => "infobox",
		3112	title => "Look",
		3113	reply => undef,
		3114	tooltip => "What you saw there",
		3115	},
		3116	"c/who" => {
		3117	id => "infobox",
		3118	title => "Players",
		3119	reply => undef,
		3120	tooltip => "Shows players who are currently online",
		3121	},
		3122	"c/body" => {
		3123	id => "infobox",
		3124	title => "Body Parts",
		3125	reply => undef,
		3126	tooltip => "Shows which body parts you posess and are available",
		3127	},
		3128	"c/statistics" => {
		3129	id => "infobox",
		3130	title => "Statistics",
		3131	reply => undef,
		3132	tooltip => "Shows your primary statistics",
		3133	},
		3134	"c/skills" => {
		3135	id => "infobox",
		3136	title => "Skills",
		3137	reply => undef,
		3138	tooltip => "Shows your experience per skill and item power",
		3139	},
		3140	"c/shopitems" => {
		3141	id => "infobox",
		3142	title => "Shop Items",
		3143	reply => undef,
		3144	tooltip => "Shows the items currently for sale in this shop",
		3145	},
		3146	"c/resistances" => {
		3147	id => "infobox",
		3148	title => "Resistances",
		3149	reply => undef,
		3150	tooltip => "Shows your resistances",
		3151	},
		3152	"c/pets" => {
		3153	id => "infobox",
		3154	title => "Pets",
		3155	reply => undef,
		3156	tooltip => "Shows information abotu your pets/a specific pet",
		3157	},
		3158	"c/perceiveself" => {
		3159	id => "infobox",
		3160	title => "Perceive Self",
		3161	reply => undef,
		3162	tooltip => "You gained detailed knowledge about yourself",
		3163	},
		3164	"c/uptime" => {
		3165	id => "infobox",
		3166	title => "Uptime",
		3167	reply => undef,
		3168	tooltip => "How long the server has been running since last restart",
		3169	},
		3170	"c/mapinfo" => {
		3171	id => "infobox",
		3172	title => "Map Info",
		3173	reply => undef,
		3174	tooltip => "Information related to the maps",
		3175	},
		3176	"c/party" => {
		3177	id => "party",
		3178	title => "Party",
		3179	reply => "gsay ",
		3180	tooltip => "Messages and chat related to your party",
		3181	},
		3182	"c/death" => {
		3183	id => "death",
		3184	title => "Death",
		3185	reply => undef,
		3186	tooltip => "Reason for and more info about your most recent death",
		3187	},
		3188	"c/say" => $SAY_CHANNEL,
		3189	"c/chat" => $CHAT_CHANNEL,
		3190	);
		3191
		3192	sub cf::client::send_msg {
		3193	my ($self, $channel, $msg, $color, @extra) = @_;
		3194
		3195	$msg = $self->pl->expand_cfpod ($msg)
		3196	unless $color & cf::NDI_VERBATIM;
		3197
		3198	$color &= cf::NDI_CLIENT_MASK; # just in case...
		3199
		3200	# check predefined channels, for the benefit of C
		3201	if ($CHANNEL{$channel}) {
		3202	$channel = $CHANNEL{$channel};
		3203
		3204	$self->ext_msg (channel_info => $channel);
		3205	$channel = $channel->{id};
		3206
		3207	} elsif (ref $channel) {
		3208	# send meta info to client, if not yet sent
		3209	unless (exists $self->{channel}{$channel->{id}}) {
		3210	$self->{channel}{$channel->{id}} = $channel;
		3211	$self->ext_msg (channel_info => $channel);
		3212	}
		3213
		3214	$channel = $channel->{id};
		3215	}
		3216
		3217	return unless @extra || length $msg;
		3218
		3219	# default colour, mask it out
		3220	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3221	if $color & cf::NDI_DEF;
		3222
		3223	my $pkt = "msg "
		3224	. $self->{json_coder}->encode (
		3225	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3226	);
		3227
		3228	$self->send_big_packet ($pkt);
		3229	}
		3230
2058	=item $client->ext_event ($type, %msg)	3231	=item $client->ext_msg ($type, @msg)
2059		3232
2060	Sends an exti event to the client.	3233	Sends an ext event to the client.
2061		3234
2062	=cut	3235	=cut
2063		3236
2064	sub cf::client::ext_event($$%) {	3237	sub cf::client::ext_msg($$@) {
2065	my ($self, $type, %msg) = @_;	3238	my ($self, $type, @msg) = @_;
2066		3239
		3240	if ($self->extcmd == 2) {
		3241	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		3242	} elsif ($self->extcmd == 1) { # TODO: remove
2067	$msg{msgtype} = "event_$type";	3243	push @msg, msgtype => "event_$type";
2068	$self->send_packet ("ext " . cf::to_json \%msg);	3244	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3245	}
		3246	}
		3247
		3248	=item $client->ext_reply ($msgid, @msg)
		3249
		3250	Sends an ext reply to the client.
		3251
		3252	=cut
		3253
		3254	sub cf::client::ext_reply($$@) {
		3255	my ($self, $id, @msg) = @_;
		3256
		3257	return unless $self->extcmd == 2;
		3258
		3259	$self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2069	}	3260	}
2070		3261
2071	=item $success = $client->query ($flags, "text", \&cb)	3262	=item $success = $client->query ($flags, "text", \&cb)
2072		3263
2073	Queues a query to the client, calling the given callback with	3264	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>,	3265	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>.	3266	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2076		3267
2077	Queries can fail, so check the return code. Or don't, as queries will become	3268	Queries can fail, so check the return code. Or don't, as queries will
2078	reliable at some point in the future.	3269	become reliable at some point in the future.
2079		3270
2080	=cut	3271	=cut
2081		3272
2082	sub cf::client::query {	3273	sub cf::client::query {
2083	my ($self, $flags, $text, $cb) = @_;	3274	my ($self, $flags, $text, $cb) = @_;
…		…
2091	utf8::encode $text;	3282	utf8::encode $text;
2092	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3283	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2093		3284
2094	$self->send_packet ($self->{query_queue}[0][0])	3285	$self->send_packet ($self->{query_queue}[0][0])
2095	if @{ $self->{query_queue} } == 1;	3286	if @{ $self->{query_queue} } == 1;
		3287
		3288	1
2096	}	3289	}
2097		3290
2098	cf::client->attach (	3291	cf::client->attach (
		3292	on_connect => sub {
		3293	my ($ns) = @_;
		3294
		3295	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3296	},
2099	on_reply => sub {	3297	on_reply => sub {
2100	my ($ns, $msg) = @_;	3298	my ($ns, $msg) = @_;
2101		3299
2102	# this weird shuffling is so that direct followup queries	3300	# this weird shuffling is so that direct followup queries
2103	# get handled first	3301	# get handled first
…		…
2115	} else {	3313	} else {
2116	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3314	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2117	}	3315	}
2118	}	3316	}
2119	},	3317	},
		3318	on_exticmd => sub {
		3319	my ($ns, $buf) = @_;
		3320
		3321	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3322
		3323	if (ref $msg) {
		3324	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3325
		3326	my @reply;
		3327
		3328	if (my $cb = $EXTICMD{$type}) {
		3329	@reply = $cb->($ns, @payload);
		3330	}
		3331
		3332	$ns->ext_reply ($reply, @reply)
		3333	if $reply;
		3334
		3335	} else {
		3336	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3337	}
		3338
		3339	cf::override;
		3340	},
2120	);	3341	);
2121		3342
2122	=item $client->async (\&cb)	3343	=item $client->async (\&cb)
2123		3344
2124	Create a new coroutine, running the specified callback. The coroutine will	3345	Create a new coroutine, running the specified callback. The coroutine will
…		…
2140		3361
2141	$coro	3362	$coro
2142	}	3363	}
2143		3364
2144	cf::client->attach (	3365	cf::client->attach (
2145	on_destroy => sub {	3366	on_client_destroy => sub {
2146	my ($ns) = @_;	3367	my ($ns) = @_;
2147		3368
2148	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3369	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2149	},	3370	},
2150	);	3371	);
…		…
2165	our $safe = new Safe "safe";	3386	our $safe = new Safe "safe";
2166	our $safe_hole = new Safe::Hole;	3387	our $safe_hole = new Safe::Hole;
2167		3388
2168	$SIG{FPE} = 'IGNORE';	3389	$SIG{FPE} = 'IGNORE';
2169		3390
2170	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3391	$safe->permit_only (Opcode::opset qw(
		3392	:base_core :base_mem :base_orig :base_math :base_loop
		3393	grepstart grepwhile mapstart mapwhile
		3394	sort time
		3395	));
2171		3396
2172	# here we export the classes and methods available to script code	3397	# here we export the classes and methods available to script code
2173		3398
2174	=pod	3399	=pod
2175		3400
2176	The following functions and methods are available within a safe environment:	3401	The following functions and methods are available within a safe environment:
2177		3402
2178	cf::object contr pay_amount pay_player map	3403	cf::object
		3404	contr pay_amount pay_player map x y force_find force_add destroy
		3405	insert remove name archname title slaying race decrease split
		3406	value
		3407
2179	cf::object::player player	3408	cf::object::player
2180	cf::player peaceful	3409	player
2181	cf::map trigger	3410
		3411	cf::player
		3412	peaceful
		3413
		3414	cf::map
		3415	trigger
2182		3416
2183	=cut	3417	=cut
2184		3418
2185	for (	3419	for (
2186	["cf::object" => qw(contr pay_amount pay_player map)],	3420	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3421	insert remove inv nrof name archname title slaying race
		3422	decrease split destroy change_exp value msg lore send_msg)],
2187	["cf::object::player" => qw(player)],	3423	["cf::object::player" => qw(player)],
2188	["cf::player" => qw(peaceful)],	3424	["cf::player" => qw(peaceful send_msg)],
2189	["cf::map" => qw(trigger)],	3425	["cf::map" => qw(trigger)],
2190	) {	3426	) {
2191	no strict 'refs';
2192	my ($pkg, @funs) = @$_;	3427	my ($pkg, @funs) = @$_;
2193	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3428	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2194	for @funs;	3429	for @funs;
2195	}	3430	}
2196		3431
…		…
2211		3446
2212	my $qcode = $code;	3447	my $qcode = $code;
2213	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3448	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2214	$qcode =~ s/\n/\\n/g;	3449	$qcode =~ s/\n/\\n/g;
2215		3450
		3451	%vars = (_dummy => 0) unless %vars;
		3452
		3453	my @res;
2216	local $_;	3454	local $_;
2217	local @safe::cf::_safe_eval_args = values %vars;
2218		3455
2219	my $eval =	3456	my $eval =
2220	"do {\n"	3457	"do {\n"
2221	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3458	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2222	. "#line 0 \"{$qcode}\"\n"	3459	. "#line 0 \"{$qcode}\"\n"
2223	. $code	3460	. $code
2224	. "\n}"	3461	. "\n}"
2225	;	3462	;
2226		3463
		3464	if ($CFG{safe_eval}) {
2227	sub_generation_inc;	3465	sub_generation_inc;
		3466	local @safe::cf::_safe_eval_args = values %vars;
2228	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3467	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2229	sub_generation_inc;	3468	sub_generation_inc;
		3469	} else {
		3470	local @cf::_safe_eval_args = values %vars;
		3471	@res = wantarray ? eval eval : scalar eval $eval;
		3472	}
2230		3473
2231	if ($@) {	3474	if ($@) {
2232	warn "$@";	3475	warn "$@",
2233	warn "while executing safe code '$code'\n";	3476	"while executing safe code '$code'\n",
2234	warn "with arguments " . (join " ", %vars) . "\n";	3477	"with arguments " . (join " ", %vars) . "\n";
2235	}	3478	}
2236		3479
2237	wantarray ? @res : $res[0]	3480	wantarray ? @res : $res[0]
2238	}	3481	}
2239		3482
…		…
2253	=cut	3496	=cut
2254		3497
2255	sub register_script_function {	3498	sub register_script_function {
2256	my ($fun, $cb) = @_;	3499	my ($fun, $cb) = @_;
2257		3500
2258	no strict 'refs';	3501	$fun = "safe::$fun" if $CFG{safe_eval};
2259	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3502	*$fun = $safe_hole->wrap ($cb);
2260	}	3503	}
2261		3504
2262	=back	3505	=back
2263		3506
2264	=cut	3507	=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	local $SIG{__WARN__};
2420	eval {
2421	local $SIG{__DIE__};
2422	close $fh1;
2423
2424	my @res = eval { $cb->(@args) };
2425	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2426	};
2427
2428	warn $@ if $@;
2429	_exit 0;
2430	}
2431	}
2432
2433
2434		3508
2435	#############################################################################	3509	#############################################################################
2436	# the server's init and main functions	3510	# the server's init and main functions
2437		3511
		3512	our %FACEHASH; # hash => idx, #d# HACK for http server
		3513
2438	sub load_facedata($) {	3514	sub load_facedata($) {
2439	my ($path) = @_;	3515	my ($path) = @_;
2440		3516
		3517	# HACK to clear player env face cache, we need some signal framework
		3518	# for this (global event?)
		3519	%ext::player_env::MUSIC_FACE_CACHE = ();
		3520
		3521	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3522
2441	warn "loading facedata from $path\n";	3523	trace "loading facedata from $path\n";
2442		3524
2443	my $facedata;	3525	my $facedata = decode_storable load_file $path;
2444	0 < aio_load $path, $facedata
2445	or die "$path: $!";
2446
2447	$facedata = Coro::Storable::thaw $facedata;
2448		3526
2449	$facedata->{version} == 2	3527	$facedata->{version} == 2
2450	or cf::cleanup "$path: version mismatch, cannot proceed.";	3528	or cf::cleanup "$path: version mismatch, cannot proceed.";
2451		3529
		3530	# patch in the exptable
		3531	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
		3532	$facedata->{resource}{"res/exp_table"} = {
		3533	type => FT_RSRC,
		3534	data => $exp_table,
		3535	hash => (Digest::MD5::md5 $exp_table),
		3536	};
		3537	cf::cede_to_tick;
		3538
2452	{	3539	{
2453	my $faces = $facedata->{faceinfo};	3540	my $faces = $facedata->{faceinfo};
2454		3541
2455	while (my ($face, $info) = each %$faces) {	3542	for my $face (sort keys %$faces) {
		3543	my $info = $faces->{$face};
2456	my $idx = (cf::face::find $face) || cf::face::alloc $face;	3544	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3545
2457	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	3546	cf::face::set_visibility $idx, $info->{visibility};
		3547	cf::face::set_magicmap $idx, $info->{magicmap};
2458	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3548	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2459	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3549	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2460	Coro::cede;	3550	cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
		3551	$FACEHASH{$info->{hash64}} = $idx;#d#
		3552
		3553	cf::cede_to_tick;
2461	}	3554	}
2462		3555
2463	while (my ($face, $info) = each %$faces) {	3556	while (my ($face, $info) = each %$faces) {
2464	next unless $info->{smooth};	3557	next unless $info->{smooth};
		3558
2465	my $idx = cf::face::find $face	3559	my $idx = cf::face::find $face
2466	or next;	3560	or next;
		3561
2467	if (my $smooth = cf::face::find $info->{smooth}) {	3562	if (my $smooth = cf::face::find $info->{smooth}) {
		3563	cf::face::set_smooth $idx, $smooth;
2468	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	3564	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2469	} else {	3565	} else {
2470	warn "smooth face '$info->{smooth}' not found for face '$face'";	3566	error "smooth face '$info->{smooth}' not found for face '$face'";
2471	}	3567	}
2472	Coro::cede;	3568
		3569	cf::cede_to_tick;
2473	}	3570	}
2474	}	3571	}
2475		3572
2476	{	3573	{
2477	my $anims = $facedata->{animinfo};	3574	my $anims = $facedata->{animinfo};
2478		3575
2479	while (my ($anim, $info) = each %$anims) {	3576	while (my ($anim, $info) = each %$anims) {
2480	cf::anim::set $anim, $info->{frames}, $info->{facings};	3577	cf::anim::set $anim, $info->{frames}, $info->{facings};
2481	Coro::cede;	3578	cf::cede_to_tick;
2482	}	3579	}
2483		3580
2484	cf::anim::invalidate_all; # d'oh	3581	cf::anim::invalidate_all; # d'oh
2485	}	3582	}
2486		3583
		3584	{
		3585	my $res = $facedata->{resource};
		3586
		3587	while (my ($name, $info) = each %$res) {
		3588	if (defined (my $type = $info->{type})) {
		3589	# TODO: different hash - must free and use new index, or cache ixface data queue
		3590	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3591
		3592	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3593	cf::face::set_type $idx, $type;
		3594	cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3595	$FACEHASH{$info->{hash}} = $idx;#d#
		3596	} else {
		3597	# $RESOURCE{$name} = $info; # unused
		3598	}
		3599
		3600	cf::cede_to_tick;
		3601	}
		3602	}
		3603
		3604	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3605
2487	1	3606	1
2488	}	3607	}
2489		3608
		3609	register_exticmd fx_want => sub {
		3610	my ($ns, $want) = @_;
		3611
		3612	while (my ($k, $v) = each %$want) {
		3613	$ns->fx_want ($k, $v);
		3614	}
		3615	};
		3616
		3617	sub load_resource_file($) {
		3618	my $guard = lock_acquire "load_resource_file";
		3619
		3620	my $status = load_resource_file_ $_[0];
		3621	get_slot 0.1, 100;
		3622	cf::arch::commit_load;
		3623
		3624	$status
		3625	}
		3626
		3627	sub reload_regions {
		3628	# HACK to clear player env face cache, we need some signal framework
		3629	# for this (global event?)
		3630	%ext::player_env::MUSIC_FACE_CACHE = ();
		3631
		3632	load_resource_file "$MAPDIR/regions"
		3633	or die "unable to load regions file\n";
		3634
		3635	for (cf::region::list) {
		3636	$_->{match} = qr/$_->{match}/
		3637	if exists $_->{match};
		3638	}
		3639	}
		3640
2490	sub reload_facedata {	3641	sub reload_facedata {
2491	load_facedata sprintf "%s/facedata", cf::datadir	3642	load_facedata "$DATADIR/facedata"
2492	or die "unable to load facedata\n";	3643	or die "unable to load facedata\n";
2493	}	3644	}
2494		3645
2495	sub reload_regions {
2496	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2497	or die "unable to load regions file\n";
2498	}
2499
2500	sub reload_archetypes {	3646	sub reload_archetypes {
2501	load_resource_file sprintf "%s/archetypes", cf::datadir	3647	load_resource_file "$DATADIR/archetypes"
2502	or die "unable to load archetypes\n";	3648	or die "unable to load archetypes\n";
2503	}	3649	}
2504		3650
2505	sub reload_treasures {	3651	sub reload_treasures {
2506	load_resource_file sprintf "%s/treasures", cf::datadir	3652	load_resource_file "$DATADIR/treasures"
2507	or die "unable to load treasurelists\n";	3653	or die "unable to load treasurelists\n";
2508	}	3654	}
2509		3655
		3656	sub reload_sound {
		3657	trace "loading sound config from $DATADIR/sound\n";
		3658
		3659	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3660
		3661	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3662	my $sound = $soundconf->{compat}[$_]
		3663	or next;
		3664
		3665	my $face = cf::face::find "sound/$sound->[1]";
		3666	cf::sound::set $sound->[0] => $face;
		3667	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3668	}
		3669
		3670	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3671	my $face = cf::face::find "sound/$v";
		3672	cf::sound::set $k => $face;
		3673	}
		3674	}
		3675
2510	sub reload_resources {	3676	sub reload_resources {
2511	warn "reloading resource files...\n";	3677	trace "reloading resource files...\n";
2512		3678
		3679	reload_exp_table;
		3680	reload_materials;
		3681	reload_facedata;
		3682	reload_sound;
		3683	reload_archetypes;
2513	reload_regions;	3684	reload_regions;
2514	reload_facedata;
2515	reload_archetypes;
2516	reload_treasures;	3685	reload_treasures;
2517		3686
2518	warn "finished reloading resource files\n";	3687	trace "finished reloading resource files\n";
2519	}	3688	}
2520		3689
2521	sub init {	3690	sub reload_config {
2522	reload_resources;	3691	trace "reloading config file...\n";
2523	}
2524		3692
2525	sub cfg_load {	3693	my $config = load_file "$CONFDIR/config";
2526	open my $fh, "<:utf8", cf::confdir . "/config"	3694	utf8::decode $config;
2527	or return;	3695	*CFG = decode_yaml $config;
2528		3696
2529	local $/;
2530	*CFG = YAML::Syck::Load <$fh>;
2531
2532	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3697	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2533		3698
2534	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3699	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2535	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3700	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2536		3701
2537	if (exists $CFG{mlockall}) {	3702	if (exists $CFG{mlockall}) {
…		…
2541	};	3706	};
2542	warn $@ if $@;	3707	warn $@ if $@;
2543	}	3708	}
2544	}	3709	}
2545		3710
		3711	sub pidfile() {
		3712	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3713	or die "$PIDFILE: $!";
		3714	flock $fh, &Fcntl::LOCK_EX
		3715	or die "$PIDFILE: flock: $!";
		3716	$fh
		3717	}
		3718
		3719	# make sure only one server instance is running at any one time
		3720	sub atomic {
		3721	my $fh = pidfile;
		3722
		3723	my $pid = <$fh>;
		3724	kill 9, $pid if $pid > 0;
		3725
		3726	seek $fh, 0, 0;
		3727	print $fh $$;
		3728	}
		3729
		3730	sub main_loop {
		3731	trace "EV::loop starting\n";
		3732	if (1) {
		3733	EV::loop;
		3734	}
		3735	trace "EV::loop returned\n";
		3736	goto &main_loop unless $REALLY_UNLOOP;
		3737	}
		3738
2546	sub main {	3739	sub main {
		3740	cf::init_globals; # initialise logging
		3741
		3742	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3743	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3744	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3745	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3746
		3747	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3748
2547	# we must not ever block the main coroutine	3749	# we must not ever block the main coroutine
2548	local $Coro::idle = sub {	3750	$Coro::idle = sub {
2549	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3751	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2550	(async {	3752	(async {
2551	Event::one_event;	3753	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3754	EV::loop EV::LOOP_ONESHOT;
2552	})->prio (Coro::PRIO_MAX);	3755	})->prio (Coro::PRIO_MAX);
2553	};	3756	};
2554		3757
2555	cfg_load;	3758	evthread_start IO::AIO::poll_fileno;
		3759
		3760	cf::sync_job {
		3761	cf::incloader::init ();
		3762
		3763	cf::init_anim;
		3764	cf::init_attackmess;
		3765	cf::init_dynamic;
		3766
		3767	cf::load_settings;
		3768
		3769	reload_resources;
		3770	reload_config;
2556	db_init;	3771	db_init;
		3772
		3773	cf::init_uuid;
		3774	cf::init_signals;
		3775	cf::init_skills;
		3776
		3777	cf::init_beforeplay;
		3778
		3779	atomic;
		3780
2557	load_extensions;	3781	load_extensions;
2558		3782
2559	$TICK_WATCHER->start;	3783	utime time, time, $RUNTIMEFILE;
2560	Event::loop;	3784
		3785	# no (long-running) fork's whatsoever before this point(!)
		3786	use POSIX ();
		3787	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3788
		3789	cf::_post_init 0;
		3790	};
		3791
		3792	cf::object::thawer::errors_are_fatal 0;
		3793	info "parse errors in files are no longer fatal from this point on.\n";
		3794
		3795	AE::postpone {
		3796	undef &main; # free gobs of memory :)
		3797	};
		3798
		3799	goto &main_loop;
2561	}	3800	}
2562		3801
2563	#############################################################################	3802	#############################################################################
2564	# initialisation and cleanup	3803	# initialisation and cleanup
2565		3804
2566	# install some emergency cleanup handlers	3805	# install some emergency cleanup handlers
2567	BEGIN {	3806	BEGIN {
		3807	our %SIGWATCHER = ();
2568	for my $signal (qw(INT HUP TERM)) {	3808	for my $signal (qw(INT HUP TERM)) {
2569	Event->signal (	3809	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2570	reentrant => 0,
2571	data => WF_AUTOCANCEL,
2572	signal => $signal,
2573	prio => 0,
2574	cb => sub {
2575	cf::cleanup "SIG$signal";	3810	cf::cleanup "SIG$signal";
2576	},
2577	);	3811	};
		3812	}
		3813	}
		3814
		3815	sub write_runtime_sync {
		3816	my $t0 = AE::time;
		3817
		3818	# first touch the runtime file to show we are still running:
		3819	# the fsync below can take a very very long time.
		3820
		3821	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3822
		3823	my $guard = cf::lock_acquire "write_runtime";
		3824
		3825	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3826	or return;
		3827
		3828	my $value = $cf::RUNTIME + 90 + 10;
		3829	# 10 is the runtime save interval, for a monotonic clock
		3830	# 60 allows for the watchdog to kill the server.
		3831
		3832	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3833	and return;
		3834
		3835	# always fsync - this file is important
		3836	aio_fsync $fh
		3837	and return;
		3838
		3839	# touch it again to show we are up-to-date
		3840	aio_utime $fh, undef, undef;
		3841
		3842	close $fh
		3843	or return;
		3844
		3845	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3846	and return;
		3847
		3848	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3849
2578	}	3850	1
		3851	}
		3852
		3853	our $uuid_lock;
		3854	our $uuid_skip;
		3855
		3856	sub write_uuid_sync($) {
		3857	$uuid_skip ||= $_[0];
		3858
		3859	return if $uuid_lock;
		3860	local $uuid_lock = 1;
		3861
		3862	my $uuid = "$LOCALDIR/uuid";
		3863
		3864	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3865	or return;
		3866
		3867	my $value = uuid_seq uuid_cur;
		3868
		3869	unless ($value) {
		3870	info "cowardly refusing to write zero uuid value!\n";
		3871	return;
		3872	}
		3873
		3874	my $value = uuid_str $value + $uuid_skip;
		3875	$uuid_skip = 0;
		3876
		3877	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3878	and return;
		3879
		3880	# always fsync - this file is important
		3881	aio_fsync $fh
		3882	and return;
		3883
		3884	close $fh
		3885	or return;
		3886
		3887	aio_rename "$uuid~", $uuid
		3888	and return;
		3889
		3890	trace "uuid file written ($value).\n";
		3891
		3892	1
		3893
		3894	}
		3895
		3896	sub write_uuid($$) {
		3897	my ($skip, $sync) = @_;
		3898
		3899	$sync ? write_uuid_sync $skip
		3900	: async { write_uuid_sync $skip };
2579	}	3901	}
2580		3902
2581	sub emergency_save() {	3903	sub emergency_save() {
2582	my $freeze_guard = cf::freeze_mainloop;	3904	my $freeze_guard = cf::freeze_mainloop;
2583		3905
2584	warn "enter emergency perl save\n";	3906	info "emergency_perl_save: enter\n";
		3907
		3908	# this is a trade-off: we want to be very quick here, so
		3909	# save all maps without fsync, and later call a global sync
		3910	# (which in turn might be very very slow)
		3911	local $USE_FSYNC = 0;
2585		3912
2586	cf::sync_job {	3913	cf::sync_job {
		3914	cf::write_runtime_sync; # external watchdog should not bark
		3915
2587	# use a peculiar iteration method to avoid tripping on perl	3916	# use a peculiar iteration method to avoid tripping on perl
2588	# refcount bugs in for. also avoids problems with players	3917	# refcount bugs in for. also avoids problems with players
2589	# and maps saved/destroyed asynchronously.	3918	# and maps saved/destroyed asynchronously.
2590	warn "begin emergency player save\n";	3919	info "emergency_perl_save: begin player save\n";
2591	for my $login (keys %cf::PLAYER) {	3920	for my $login (keys %cf::PLAYER) {
2592	my $pl = $cf::PLAYER{$login} or next;	3921	my $pl = $cf::PLAYER{$login} or next;
2593	$pl->valid or next;	3922	$pl->valid or next;
		3923	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2594	$pl->save;	3924	$pl->save;
2595	}	3925	}
2596	warn "end emergency player save\n";	3926	info "emergency_perl_save: end player save\n";
2597		3927
2598	warn "begin emergency map save\n";	3928	cf::write_runtime_sync; # external watchdog should not bark
		3929
		3930	info "emergency_perl_save: begin map save\n";
2599	for my $path (keys %cf::MAP) {	3931	for my $path (keys %cf::MAP) {
2600	my $map = $cf::MAP{$path} or next;	3932	my $map = $cf::MAP{$path} or next;
2601	$map->valid or next;	3933	$map->valid or next;
2602	$map->save;	3934	$map->save;
2603	}	3935	}
2604	warn "end emergency map save\n";	3936	info "emergency_perl_save: end map save\n";
2605		3937
2606	warn "begin emergency database checkpoint\n";	3938	cf::write_runtime_sync; # external watchdog should not bark
		3939
		3940	info "emergency_perl_save: begin database checkpoint\n";
2607	BDB::db_env_txn_checkpoint $DB_ENV;	3941	BDB::db_env_txn_checkpoint $DB_ENV;
2608	warn "end emergency database checkpoint\n";	3942	info "emergency_perl_save: end database checkpoint\n";
		3943
		3944	info "emergency_perl_save: begin write uuid\n";
		3945	write_uuid_sync 1;
		3946	info "emergency_perl_save: end write uuid\n";
		3947
		3948	cf::write_runtime_sync; # external watchdog should not bark
		3949
		3950	trace "emergency_perl_save: syncing database to disk";
		3951	BDB::db_env_txn_checkpoint $DB_ENV;
		3952
		3953	info "emergency_perl_save: starting sync\n";
		3954	IO::AIO::aio_sync sub {
		3955	info "emergency_perl_save: finished sync\n";
		3956	};
		3957
		3958	cf::write_runtime_sync; # external watchdog should not bark
		3959
		3960	trace "emergency_perl_save: flushing outstanding aio requests";
		3961	while (IO::AIO::nreqs || BDB::nreqs) {
		3962	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		3963	}
		3964
		3965	cf::write_runtime_sync; # external watchdog should not bark
2609	};	3966	};
2610		3967
2611	warn "leave emergency perl save\n";	3968	info "emergency_perl_save: leave\n";
2612	}	3969	}
2613		3970
2614	sub post_cleanup {	3971	sub post_cleanup {
2615	my ($make_core) = @_;	3972	my ($make_core) = @_;
2616		3973
		3974	IO::AIO::flush;
		3975
2617	warn Carp::longmess "post_cleanup backtrace"	3976	error Carp::longmess "post_cleanup backtrace"
2618	if $make_core;	3977	if $make_core;
		3978
		3979	my $fh = pidfile;
		3980	unlink $PIDFILE if <$fh> == $$;
		3981	}
		3982
		3983	# a safer delete_package, copied from Symbol
		3984	sub clear_package($) {
		3985	my $pkg = shift;
		3986
		3987	# expand to full symbol table name if needed
		3988	unless ($pkg =~ /^main::.*::$/) {
		3989	$pkg = "main$pkg" if $pkg =~ /^::/;
		3990	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3991	$pkg .= '::' unless $pkg =~ /::$/;
		3992	}
		3993
		3994	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3995	my $stem_symtab = *{$stem}{HASH};
		3996
		3997	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3998	or return;
		3999
		4000	# clear all symbols
		4001	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4002	for my $name (keys %$leaf_symtab) {
		4003	_gv_clear *{"$pkg$name"};
		4004	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4005	}
2619	}	4006	}
2620		4007
2621	sub do_reload_perl() {	4008	sub do_reload_perl() {
2622	# can/must only be called in main	4009	# can/must only be called in main
2623	if ($Coro::current != $Coro::main) {	4010	unless (in_main) {
2624	warn "can only reload from main coroutine";	4011	error "can only reload from main coroutine";
2625	return;	4012	return;
2626	}	4013	}
2627		4014
2628	warn "reloading...";	4015	return if $RELOAD++;
2629		4016
2630	warn "entering sync_job";	4017	my $t1 = AE::time;
2631		4018
		4019	while ($RELOAD) {
		4020	cf::get_slot 0.1, -1, "reload_perl";
		4021	info "perl_reload: reloading...";
		4022
		4023	trace "perl_reload: entering sync_job";
		4024
2632	cf::sync_job {	4025	cf::sync_job {
2633	cf::write_runtime; # external watchdog should not bark
2634	cf::emergency_save;	4026	#cf::emergency_save;
2635	cf::write_runtime; # external watchdog should not bark
2636		4027
2637	warn "syncing database to disk";
2638	BDB::db_env_txn_checkpoint $DB_ENV;
2639
2640	# if anything goes wrong in here, we should simply crash as we already saved
2641
2642	warn "cancelling all WF_AUTOCANCEL watchers";
2643	for (Event::all_watchers) {
2644	$_->cancel if $_->data & WF_AUTOCANCEL;
2645	}
2646
2647	warn "flushing outstanding aio requests";
2648	for (;;) {
2649	BDB::flush;
2650	IO::AIO::flush;
2651	Coro::cede;
2652	last unless IO::AIO::nreqs || BDB::nreqs;
2653	warn "iterate...";
2654	}
2655
2656	++$RELOAD;
2657
2658	warn "cancelling all extension coros";	4028	trace "perl_reload: cancelling all extension coros";
2659	$_->cancel for values %EXT_CORO;	4029	$_->cancel for values %EXT_CORO;
2660	%EXT_CORO = ();	4030	%EXT_CORO = ();
2661		4031
2662	warn "removing commands";	4032	trace "perl_reload: removing commands";
2663	%COMMAND = ();	4033	%COMMAND = ();
2664		4034
2665	warn "removing ext commands";	4035	trace "perl_reload: removing ext/exti commands";
2666	%EXTCMD = ();	4036	%EXTCMD = ();
		4037	%EXTICMD = ();
2667		4038
2668	warn "unloading/nuking all extensions";	4039	trace "perl_reload: unloading/nuking all extensions";
2669	for my $pkg (@EXTS) {	4040	for my $pkg (@EXTS) {
2670	warn "... unloading $pkg";	4041	trace "... unloading $pkg";
2671		4042
2672	if (my $cb = $pkg->can ("unload")) {	4043	if (my $cb = $pkg->can ("unload")) {
2673	eval {	4044	eval {
2674	$cb->($pkg);	4045	$cb->($pkg);
2675	1	4046	1
2676	} or warn "$pkg unloaded, but with errors: $@";	4047	} or error "$pkg unloaded, but with errors: $@";
		4048	}
		4049
		4050	trace "... clearing $pkg";
		4051	clear_package $pkg;
2677	}	4052	}
2678		4053
2679	warn "... nuking $pkg";
2680	Symbol::delete_package $pkg;
2681	}
2682
2683	warn "unloading all perl modules loaded from $LIBDIR";	4054	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2684	while (my ($k, $v) = each %INC) {	4055	while (my ($k, $v) = each %INC) {
2685	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4056	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2686		4057
2687	warn "... unloading $k";	4058	trace "... unloading $k";
2688	delete $INC{$k};	4059	delete $INC{$k};
2689		4060
2690	$k =~ s/\.pm$//;	4061	$k =~ s/\.pm$//;
2691	$k =~ s/\//::/g;	4062	$k =~ s/\//::/g;
2692		4063
2693	if (my $cb = $k->can ("unload_module")) {	4064	if (my $cb = $k->can ("unload_module")) {
2694	$cb->();	4065	$cb->();
		4066	}
		4067
		4068	clear_package $k;
2695	}	4069	}
2696		4070
2697	Symbol::delete_package $k;
2698	}
2699
2700	warn "getting rid of safe::, as good as possible";	4071	trace "perl_reload: getting rid of safe::, as good as possible";
2701	Symbol::delete_package "safe::$_"	4072	clear_package "safe::$_"
2702	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4073	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2703		4074
2704	warn "unloading cf.pm \"a bit\"";	4075	trace "perl_reload: unloading cf.pm \"a bit\"";
2705	delete $INC{"cf.pm"};	4076	delete $INC{"cf.pm"};
		4077	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2706		4078
2707	# don't, removes xs symbols, too,	4079	# don't, removes xs symbols, too,
2708	# and global variables created in xs	4080	# and global variables created in xs
2709	#Symbol::delete_package __PACKAGE__;	4081	#clear_package __PACKAGE__;
2710		4082
2711	warn "unload completed, starting to reload now";	4083	info "perl_reload: unload completed, starting to reload now";
2712		4084
2713	warn "reloading cf.pm";	4085	trace "perl_reload: reloading cf.pm";
2714	require cf;	4086	require cf;
2715	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4087	cf::_connect_to_perl_1;
2716		4088
2717	warn "loading config and database again";	4089	trace "perl_reload: loading config and database again";
2718	cf::cfg_load;	4090	cf::reload_config;
2719		4091
2720	warn "loading extensions";	4092	trace "perl_reload: loading extensions";
2721	cf::load_extensions;	4093	cf::load_extensions;
2722		4094
		4095	if ($REATTACH_ON_RELOAD) {
2723	warn "reattaching attachments to objects/players";	4096	trace "perl_reload: reattaching attachments to objects/players";
2724	_global_reattach; # objects, sockets	4097	_global_reattach; # objects, sockets
2725	warn "reattaching attachments to maps";	4098	trace "perl_reload: reattaching attachments to maps";
2726	reattach $_ for values %MAP;	4099	reattach $_ for values %MAP;
2727	warn "reattaching attachments to players";	4100	trace "perl_reload: reattaching attachments to players";
2728	reattach $_ for values %PLAYER;	4101	reattach $_ for values %PLAYER;
		4102	}
2729		4103
2730	warn "leaving sync_job";	4104	cf::_post_init 1;
2731		4105
		4106	trace "perl_reload: leaving sync_job";
		4107
2732	1	4108	1
2733	} or do {	4109	} or do {
2734	warn $@;	4110	error $@;
2735	warn "error while reloading, exiting.";	4111	cf::cleanup "perl_reload: error, exiting.";
2736	exit 1;	4112	};
		4113
		4114	--$RELOAD;
2737	};	4115	}
2738		4116
2739	warn "reloaded";	4117	$t1 = AE::time - $t1;
		4118	info "perl_reload: completed in ${t1}s\n";
2740	};	4119	};
2741		4120
2742	our $RELOAD_WATCHER; # used only during reload	4121	our $RELOAD_WATCHER; # used only during reload
2743		4122
2744	sub reload_perl() {	4123	sub reload_perl() {
2745	# doing reload synchronously and two reloads happen back-to-back,	4124	# doing reload synchronously and two reloads happen back-to-back,
2746	# coro crashes during coro_state_free->destroy here.	4125	# coro crashes during coro_state_free->destroy here.
2747		4126
2748	$RELOAD_WATCHER ||= Event->timer (	4127	$RELOAD_WATCHER ||= cf::async {
2749	reentrant => 0,	4128	Coro::AIO::aio_wait cache_extensions;
2750	after => 0,	4129
2751	data => WF_AUTOCANCEL,	4130	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
2752	cb => sub {
2753	do_reload_perl;	4131	do_reload_perl;
2754	undef $RELOAD_WATCHER;	4132	undef $RELOAD_WATCHER;
2755	},	4133	};
2756	);	4134	};
2757	}	4135	}
2758		4136
2759	register_command "reload" => sub {	4137	register_command "reload" => sub {
2760	my ($who, $arg) = @_;	4138	my ($who, $arg) = @_;
2761		4139
2762	if ($who->flag (FLAG_WIZ)) {	4140	if ($who->flag (FLAG_WIZ)) {
2763	$who->message ("reloading server.");	4141	$who->message ("reloading server.");
		4142	async {
		4143	$Coro::current->{desc} = "perl_reload";
2764	async { reload_perl };	4144	reload_perl;
		4145	};
2765	}	4146	}
2766	};	4147	};
2767		4148
2768	unshift @INC, $LIBDIR;	4149	#############################################################################
2769		4150
2770	my $bug_warning = 0;	4151	my $bug_warning = 0;
2771		4152
2772	our @WAIT_FOR_TICK;
2773	our @WAIT_FOR_TICK_BEGIN;
2774
2775	sub wait_for_tick {	4153	sub wait_for_tick() {
2776	return unless $TICK_WATCHER->is_active;	4154	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2777	return if $Coro::current == $Coro::main;
2778		4155
2779	my $signal = new Coro::Signal;	4156	$WAIT_FOR_TICK->wait;
2780	push @WAIT_FOR_TICK, $signal;
2781	$signal->wait;
2782	}	4157	}
2783		4158
2784	sub wait_for_tick_begin {	4159	sub wait_for_tick_begin() {
2785	return unless $TICK_WATCHER->is_active;	4160	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2786	return if $Coro::current == $Coro::main;
2787		4161
2788	my $signal = new Coro::Signal;	4162	my $signal = new Coro::Signal;
2789	push @WAIT_FOR_TICK_BEGIN, $signal;	4163	push @WAIT_FOR_TICK_BEGIN, $signal;
2790	$signal->wait;	4164	$signal->wait;
2791	}	4165	}
2792		4166
2793	$TICK_WATCHER = Event->timer (	4167	sub tick {
2794	reentrant => 0,
2795	parked => 1,
2796	prio => 0,
2797	at => $NEXT_TICK || $TICK,
2798	data => WF_AUTOCANCEL,
2799	cb => sub {
2800	if ($Coro::current != $Coro::main) {	4168	if ($Coro::current != $Coro::main) {
2801	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	4169	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2802	unless ++$bug_warning > 10;	4170	unless ++$bug_warning > 10;
2803	return;	4171	return;
2804	}	4172	}
2805		4173
2806	$NOW = Event::time;	4174	cf::one_tick; # one server iteration
2807		4175
2808	cf::server_tick; # one server iteration	4176	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2809		4177
2810	$RUNTIME += $TICK;
2811	$NEXT_TICK += $TICK;
2812
2813	if ($NOW >= $NEXT_RUNTIME_WRITE) {	4178	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2814	$NEXT_RUNTIME_WRITE = $NOW + 10;	4179	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2815	Coro::async_pool {	4180	Coro::async_pool {
		4181	$Coro::current->{desc} = "runtime saver";
2816	write_runtime	4182	write_runtime_sync
2817	or warn "ERROR: unable to write runtime file: $!";	4183	or error "ERROR: unable to write runtime file: $!";
2818	};
2819	}	4184	};
		4185	}
2820		4186
2821	# my $AFTER = Event::time;
2822	# warn $AFTER - $NOW;#d#
2823
2824	# if we are delayed by four ticks or more, skip them all
2825	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2826
2827	$TICK_WATCHER->at ($NEXT_TICK);
2828	$TICK_WATCHER->start;
2829
2830	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {	4187	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2831	$sig->send;	4188	$sig->send;
2832	}
2833	while (my $sig = shift @WAIT_FOR_TICK) {
2834	$sig->send;
2835	}
2836
2837	_post_tick;
2838	},	4189	}
2839	);	4190	$WAIT_FOR_TICK->broadcast;
		4191
		4192	$LOAD = ($NOW - $TICK_START) / $TICK;
		4193	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4194
		4195	if (0) {
		4196	if ($NEXT_TICK) {
		4197	my $jitter = $TICK_START - $NEXT_TICK;
		4198	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4199	debug "jitter $JITTER\n";#d#
		4200	}
		4201	}
		4202	}
2840		4203
2841	{	4204	{
2842	BDB::max_poll_time $TICK * 0.1;	4205	# configure BDB
2843	$BDB_POLL_WATCHER = Event->io (	4206
2844	reentrant => 0,
2845	fd => BDB::poll_fileno,
2846	poll => 'r',
2847	prio => 0,
2848	data => WF_AUTOCANCEL,
2849	cb => \&BDB::poll_cb,
2850	);
2851	BDB::min_parallel 8;	4207	BDB::min_parallel 16;
2852		4208	BDB::max_poll_reqs $TICK * 0.1;
2853	BDB::set_sync_prepare {	4209	#$AnyEvent::BDB::WATCHER->priority (1);
2854	my $status;
2855	my $current = $Coro::current;
2856	(
2857	sub {
2858	$status = $!;
2859	$current->ready; undef $current;
2860	},
2861	sub {
2862	Coro::schedule while defined $current;
2863	$! = $status;
2864	},
2865	)
2866	};
2867		4210
2868	unless ($DB_ENV) {	4211	unless ($DB_ENV) {
2869	$DB_ENV = BDB::db_env_create;	4212	$DB_ENV = BDB::db_env_create;
		4213	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4214	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4215	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4216	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4217	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2870		4218
2871	cf::sync_job {	4219	cf::sync_job {
2872	eval {	4220	eval {
2873	BDB::db_env_open	4221	BDB::db_env_open
2874	$DB_ENV,	4222	$DB_ENV,
2875	$BDB_ENV_DIR,	4223	$BDBDIR,
2876	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	4224	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2877	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	4225	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2878	0666;	4226	0666;
2879		4227
2880	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	4228	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2881
2882	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2883	$DB_ENV->set_lk_detect;
2884	};	4229	};
2885		4230
2886	cf::cleanup "db_env_open(db): $@" if $@;	4231	cf::cleanup "db_env_open(db): $@" if $@;
2887	};	4232	};
2888	}	4233	}
		4234
		4235	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4236	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4237	};
		4238	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4239	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4240	};
		4241	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4242	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4243	};
2889	}	4244	}
2890		4245
2891	{	4246	{
		4247	# configure IO::AIO
		4248
2892	IO::AIO::min_parallel 8;	4249	IO::AIO::min_parallel 8;
2893
2894	undef $Coro::AIO::WATCHER;
2895	IO::AIO::max_poll_time $TICK * 0.1;	4250	IO::AIO::max_poll_time $TICK * 0.1;
2896	$AIO_POLL_WATCHER = Event->io (	4251	undef $AnyEvent::AIO::WATCHER;
2897	reentrant => 0,	4252	}
2898	data => WF_AUTOCANCEL,	4253
2899	fd => IO::AIO::poll_fileno,	4254	our $_log_backtrace;
2900	poll => 'r',	4255	our $_log_backtrace_last;
2901	prio => 6,	4256
2902	cb => \&IO::AIO::poll_cb,	4257	sub _log_backtrace {
2903	);	4258	my ($msg, @addr) = @_;
		4259
		4260	$msg =~ s/\n$//;
		4261
		4262	if ($_log_backtrace_last eq $msg) {
		4263	LOG llevInfo, "[ABT] $msg\n";
		4264	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4265	# limit the # of concurrent backtraces
		4266	} elsif ($_log_backtrace < 2) {
		4267	$_log_backtrace_last = $msg;
		4268	++$_log_backtrace;
		4269	my $perl_bt = Carp::longmess $msg;
		4270	async {
		4271	$Coro::current->{desc} = "abt $msg";
		4272
		4273	my @bt = fork_call {
		4274	@addr = map { sprintf "%x", $_ } @addr;
		4275	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4276	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4277	or die "addr2line: $!";
		4278
		4279	my @funcs;
		4280	my @res = <$fh>;
		4281	chomp for @res;
		4282	while (@res) {
		4283	my ($func, $line) = splice @res, 0, 2, ();
		4284	push @funcs, "[$func] $line";
		4285	}
		4286
		4287	@funcs
		4288	};
		4289
		4290	LOG llevInfo, "[ABT] $perl_bt\n";
		4291	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4292	LOG llevInfo, "[ABT] $_\n" for @bt;
		4293	--$_log_backtrace;
		4294	};
		4295	} else {
		4296	LOG llevInfo, "[ABT] $msg\n";
		4297	LOG llevInfo, "[ABT] [overload, suppressed]\n";
		4298	}
2904	}	4299	}
2905		4300
2906	# load additional modules	4301	# load additional modules
2907	use cf::pod;	4302	require "cf/$_.pm" for @EXTRA_MODULES;
		4303	cf::_connect_to_perl_2;
2908		4304
2909	END { cf::emergency_save }	4305	END { cf::emergency_save }
2910		4306
2911	1	4307	1
2912		4308

Diff Legend

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