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.134 by root, Thu Jan 4 17:28:49 2007 UTC vs.
Revision 1.577 by root, Tue Jan 3 11:25:33 2012 UTC

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

Diff Legend

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