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.126 by root, Tue Jan 2 23:12:47 2007 UTC vs.
Revision 1.598 by root, Sun Nov 11 02:38:10 2012 UTC

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

Diff Legend

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