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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.571 by root, Wed May 4 19:04:45 2011 UTC

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

Diff Legend

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