ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.134 by root, Thu Jan 4 17:28:49 2007 UTC vs.
Revision 1.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 $RANDOM_MAPS = cf::localdir . "/random";	155	our $JITTER; # average jitter
55	our %EXT_CORO;	156	our $TICK_START; # for load detecting purposes
		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;
56		165
57	binmode STDOUT;	166	binmode STDOUT;
58	binmode STDERR;	167	binmode STDERR;
59		168
60	# read virtual server time, if available	169	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	170	unless ($RUNTIME || !-e $RUNTIMEFILE) {
62	open my $fh, "<", cf::localdir . "/runtime"	171	open my $fh, "<", $RUNTIMEFILE
63	or die "unable to read runtime file: $!";	172	or die "unable to read $RUNTIMEFILE file: $!";
64	$RUNTIME = <$fh> + 0.;	173	$RUNTIME = <$fh> + 0.;
65	}	174	}
66		175
67	mkdir cf::localdir;	176	eval "sub TICK() { $TICK } 1" or die;
68	mkdir cf::localdir . "/" . cf::playerdir;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		177
73	# a special map that is always available	178	mkdir $_
74	our $LINK_MAP;	179	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		180
75	our $EMERGENCY_POSITION;	181	our $EMERGENCY_POSITION;
76		182
		183	sub cf::map::normalise;
		184
		185	sub in_main() {
		186	$Coro::current == $Coro::main
		187	}
		188
77	#############################################################################	189	#############################################################################
78		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
79	=head2 GLOBAL VARIABLES	202	=head2 GLOBAL VARIABLES
80		203
81	=over 4	204	=over 4
82		205
83	=item $cf::UPTIME	206	=item $cf::UPTIME
84		207
85	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.
86		224
87	=item $cf::RUNTIME	225	=item $cf::RUNTIME
88		226
89	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
90	every server tick.	228	every server tick.
91		229
92	=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
93		233
94	The perl library directory, where extensions and cf-specific modules can	234	Various directories - "/etc", read-only install directory, perl-library
95	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.
96		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
97	=item $cf::NOW	245	=item $cf::LOAD
98		246
99	The time of the last (current) server tick.	247	The raw value load value from the last tick.
100
101	=item $cf::TICK
102
103	The interval between server ticks, in seconds.
104		248
105	=item %cf::CFG	249	=item %cf::CFG
106		250
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	from wherever your confdir points to.	252	from wherever your confdir points to.
109		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
110	=back	289	=back
111		290
112	=cut	291	=cut
113		292
114	BEGIN {	293	sub error(@) { LOG llevError, join "", @_ }
115	*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 {
116	my $msg = join "", @_;	300	my $msg = join "", @_;
117	utf8::encode $msg;
118		301
119	$msg .= "\n"	302	$msg .= "\n"
120	unless $msg =~ /\n$/;	303	unless $msg =~ /\n$/;
121		304
122	LOG llevError, "cfperl: $msg";	305	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
123	};	306
124	}	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	};
125		323
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	324	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	325	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	326	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	327	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		331
133	# 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
134	# within the Safe compartment.	333	# within the Safe compartment.
135	for my $pkg (qw(	334	for my $pkg (qw(
136	cf::global cf::attachable	335	cf::global cf::attachable
137	cf::object cf::object::player	336	cf::object cf::object::player
138	cf::client cf::player	337	cf::client cf::player
139	cf::arch cf::living	338	cf::arch cf::living
		339	cf::map cf::mapspace
140	cf::map cf::party cf::region	340	cf::party cf::region
141	)) {	341	)) {
142	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	342	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	343	}
145		344
146	$Event::DIED = sub {	345	$EV::DIED = sub {
147	warn "error in event callback: @_";	346	warn "error in event callback: $@";
148	};	347	};
149		348
150	my %ext_pkg;	349	#############################################################################
151	my @exts;	350
152	my @hook;	351	sub fork_call(&@);
		352	sub get_slot($;$$);
		353
		354	#############################################################################
153		355
154	=head2 UTILITY FUNCTIONS	356	=head2 UTILITY FUNCTIONS
155		357
156	=over 4	358	=over 4
157		359
158	=cut	360	=item dumpval $ref
159		361
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	362	=cut
161		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
162	=item $ref = cf::from_json $json	435	=item $ref = cf::decode_json $json
163		436
164	Converts a JSON string into the corresponding perl data structure.	437	Converts a JSON string into the corresponding perl data structure.
165		438
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	439	=item $json = cf::encode_json $ref
174		440
175	Converts a perl data structure into its JSON representation.	441	Converts a perl data structure into its JSON representation.
176		442
177	=cut	443	=cut
178		444
179	sub to_json($) {	445	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181	JSON::Syck::Dump $_[0]
182	}
183		446
184	=item my $guard = cf::guard { BLOCK }	447	sub encode_json($) { $json_coder->encode ($_[0]) }
		448	sub decode_json($) { $json_coder->decode ($_[0]) }
185		449
186	Run the given callback when the guard object gets destroyed (useful for	450	=item $ref = cf::decode_storable $scalar
187	coroutine cancellations).
188		451
189	You can call C<< ->cancel >> on the guard object to stop the block from	452	Same as Coro::Storable::thaw, so blocks.
190	being executed.
191		453
192	=cut	454	=cut
193		455
194	sub guard(&) {	456	BEGIN { *decode_storable = \&Coro::Storable::thaw }
195	bless \(my $cb = $_[0]), cf::guard::;
196	}
197		457
198	sub cf::guard::cancel {	458	=item $ref = cf::decode_yaml $scalar
199	${$_[0]} = sub { };
200	}
201		459
202	sub cf::guard::DESTROY {	460	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
203	${$_[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	}
204	}	510	}
205		511
206	=item cf::lock_wait $string	512	=item cf::lock_wait $string
207		513
208	Wait until the given lock is available. See cf::lock_acquire.	514	Wait until the given lock is available. See cf::lock_acquire.
209		515
210	=item my $lock = cf::lock_acquire $string	516	=item my $lock = cf::lock_acquire $string
211		517
212	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
213	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,
214	for example when the coroutine gets canceled), the lock is automatically	520	for example when the coroutine gets canceled), the lock is automatically
215	returned.	521	returned.
216		522
		523	Locks are *not* recursive, locking from the same coro twice results in a
		524	deadlocked coro.
		525
217	Lock names should begin with a unique identifier (for example, cf::map::find	526	Lock names should begin with a unique identifier (for example, cf::map::find
218	uses map_find and cf::map::load uses map_load).	527	uses map_find and cf::map::load uses map_load).
219		528
220	=cut	529	=item $locked = cf::lock_active $string
221		530
222	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;
223		536
224	sub lock_wait($) {	537	sub lock_wait($) {
225	my ($key) = @_;	538	$LOCKS->wait ($_[0]);
226
227	# wait for lock, if any
228	while ($LOCK{$key}) {
229	push @{ $LOCK{$key} }, $Coro::current;
230	Coro::schedule;
231	}
232	}	539	}
233		540
234	sub lock_acquire($) {	541	sub lock_acquire($) {
235	my ($key) = @_;	542	$LOCKS->guard ($_[0])
		543	}
236		544
237	# wait, to be sure we are not locked	545	sub lock_active($) {
238	lock_wait $key;	546	$LOCKS->count ($_[0]) < 1
		547	}
239		548
240	$LOCK{$key} = [];	549	sub freeze_mainloop {
		550	tick_inhibit_inc;
241		551
242	cf::guard {	552	&Guard::guard (\&tick_inhibit_dec);
243	# wake up all waiters, to be on the safe side	553	}
244	$_->ready for @{ delete $LOCK{$key} };	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	}
245	}	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;
246	}	638	}
247		639
248	=item cf::async { BLOCK }	640	=item cf::async { BLOCK }
249		641
250	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the	642	Currently the same as Coro::async_pool, meaning you cannot use
251	error instead of exiting the server in case of a problem.	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.
252		645
253	=cut	646	=cut
254		647
255	sub async(&) {	648	BEGIN { *async = \&Coro::async_pool }
256	my ($cb) = @_;
257
258	Coro::async {
259	eval { $cb->() };
260	warn $@ if $@;
261	}
262	}
263
264	sub freeze_mainloop {
265	return unless $TICK_WATCHER->is_active;
266
267	my $guard = guard { $TICK_WATCHER->start };
268	$TICK_WATCHER->stop;
269	$guard
270	}
271		649
272	=item cf::sync_job { BLOCK }	650	=item cf::sync_job { BLOCK }
273		651
274	The design of crossfire+ requires that the main coro ($Coro::main) is	652	The design of Deliantra requires that the main coroutine ($Coro::main)
275	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
276	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.
277		656
278	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
279	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
280	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
281	fast or be very important.	660	fast or be very important.
…		…
283	=cut	662	=cut
284		663
285	sub sync_job(&) {	664	sub sync_job(&) {
286	my ($job) = @_;	665	my ($job) = @_;
287		666
288	if ($Coro::current == $Coro::main) {	667	if (in_main) {
		668	my $time = AE::time;
		669
289	# this is the main coro, too bad, we have to block	670	# this is the main coro, too bad, we have to block
290	# till the operation succeeds, freezing the server :/	671	# till the operation succeeds, freezing the server :/
291		672
292	# TODO: use suspend/resume instead	673	#LOG llevError, Carp::longmess "sync job";#d#
293	# (but this is cancel-safe)	674
294	my $freeze_guard = freeze_mainloop;	675	my $freeze_guard = freeze_mainloop;
295		676
296	my $busy = 1;	677	my $busy = 1;
297	my @res;	678	my @res;
298		679
299	(Coro::async {	680	(async {
		681	$Coro::current->desc ("sync job coro");
300	@res = eval { $job->() };	682	@res = eval { $job->() };
301	warn $@ if $@;	683	error $@ if $@;
302	undef $busy;	684	undef $busy;
303	})->prio (Coro::PRIO_MAX);	685	})->prio (Coro::PRIO_MAX);
304		686
305	while ($busy) {	687	while ($busy) {
		688	if (Coro::nready) {
306	Coro::cede_notself;	689	Coro::cede_notself;
307	Event::one_event unless Coro::nready;	690	} else {
		691	EV::loop EV::LOOP_ONESHOT;
308	}	692	}
		693	}
		694
		695	my $time = AE::time - $time;
		696
		697	$TICK_START += $time; # do not account sync jobs to server load
309		698
310	wantarray ? @res : $res[0]	699	wantarray ? @res : $res[0]
311	} else {	700	} else {
312	# we are in another coroutine, how wonderful, everything just works	701	# we are in another coroutine, how wonderful, everything just works
313		702
314	$job->()	703	$job->()
315	}	704	}
316	}	705	}
317		706
318	=item $coro = cf::coro { BLOCK }	707	=item $coro = cf::async_ext { BLOCK }
319		708
320	Creates and returns a new coro. This coro is automcatially being canceled	709	Like async, but this coro is automatically being canceled when the
321	when the extension calling this is being unloaded.	710	extension calling this is being unloaded.
322		711
323	=cut	712	=cut
324		713
325	sub coro(&) {	714	sub async_ext(&) {
326	my $cb = shift;	715	my $cb = shift;
327		716
328	my $coro = &cf::async ($cb);	717	my $coro = &Coro::async ($cb);
329		718
330	$coro->on_destroy (sub {	719	$coro->on_destroy (sub {
331	delete $EXT_CORO{$coro+0};	720	delete $EXT_CORO{$coro+0};
332	});	721	});
333	$EXT_CORO{$coro+0} = $coro;	722	$EXT_CORO{$coro+0} = $coro;
334		723
335	$coro	724	$coro
336	}	725	}
337		726
338	sub write_runtime {	727	=item fork_call { }, @args
339	my $runtime = cf::localdir . "/runtime";
340		728
341	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	729	Executes the given code block with the given arguments in a seperate
342	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.
343		733
344	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	734	=cut
345	(aio_write $fh, 0, (length $value), $value, 0) <= 0
346	and return;
347		735
348	aio_fsync $fh	736	sub post_fork {
349	and return;	737	reset_signals;
		738	}
350		739
351	close $fh	740	sub fork_call(&@) {
352	or return;	741	my ($cb, @args) = @_;
353		742
354	aio_rename "$runtime~", $runtime	743	# we seemingly have to make a local copy of the whole thing,
355	and return;	744	# otherwise perl prematurely frees the stuff :/
		745	# TODO: investigate and fix (likely this will be rather laborious)
356		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 {
357	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 });
358	}	930	}
359		931
360	=back	932	=back
361		933
362	=cut	934	=cut
363		935
364	#############################################################################	936	#############################################################################
365		937
366	package cf::path;
367
368	sub new {
369	my ($class, $path, $base) = @_;
370
371	$path = $path->as_string if ref $path;
372
373	my $self = bless { }, $class;
374
375	# {... are special paths that are not touched
376	# ?xxx/... are special absolute paths
377	# ?random/... random maps
378	# /! non-realised random map exit
379	# /... normal maps
380	# ~/... per-player maps without a specific player (DO NOT USE)
381	# ~user/... per-player map of a specific user
382
383	if ($path =~ /^{/) {
384	# fine as it is
385	} elsif ($path =~ s{^\?random/}{}) {
386	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
387	$self->{random} = cf::from_json $data;
388	} else {
389	if ($path =~ s{^~([^/]+)?}{}) {
390	$self->{user_rel} = 1;
391
392	if (defined $1) {
393	$self->{user} = $1;
394	} elsif ($base =~ m{^~([^/]+)/}) {
395	$self->{user} = $1;
396	} else {
397	warn "cannot resolve user-relative path without user <$path,$base>\n";
398	}
399	} elsif ($path =~ /^\//) {
400	# already absolute
401	} else {
402	$base =~ s{[^/]+/?$}{};
403	return $class->new ("$base/$path");
404	}
405
406	for ($path) {
407	redo if s{/\.?/}{/};
408	redo if s{/[^/]+/\.\./}{/};
409	}
410	}
411
412	$self->{path} = $path;
413
414	$self
415	}
416
417	# the name / primary key / in-game path
418	sub as_string {
419	my ($self) = @_;
420
421	$self->{user_rel} ? "~$self->{user}$self->{path}"
422	: $self->{random} ? "?random/$self->{path}"
423	: $self->{path}
424	}
425
426	# the displayed name, this is a one way mapping
427	sub visible_name {
428	my ($self) = @_;
429
430	# if (my $rmp = $self->{random}) {
431	# # todo: be more intelligent about this
432	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
433	# } else {
434	$self->as_string
435	# }
436	}
437
438	# escape the /'s in the path
439	sub _escaped_path {
440	# ∕ is U+2215
441	(my $path = $_[0]{path}) =~ s/\//∕/g;
442	$path
443	}
444
445	# the original (read-only) location
446	sub load_path {
447	my ($self) = @_;
448
449	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
450	}
451
452	# the temporary/swap location
453	sub save_path {
454	my ($self) = @_;
455
456	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
457	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
458	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
459	}
460
461	# the unique path, might be eq to save_path
462	sub uniq_path {
463	my ($self) = @_;
464
465	$self->{user_rel} || $self->{random}
466	? undef
467	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
468	}
469
470	# return random map parameters, or undef
471	sub random_map_params {
472	my ($self) = @_;
473
474	$self->{random}
475	}
476
477	# this is somewhat ugly, but style maps do need special treatment
478	sub is_style_map {
479	$_[0]{path} =~ m{^/styles/}
480	}
481
482	package cf;
483
484	#############################################################################
485
486	=head2 ATTACHABLE OBJECTS	938	=head2 ATTACHABLE OBJECTS
487		939
488	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
489	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")
490	to it. All such attachable objects support the following methods.	942	to it. All such attachable objects support the following methods.
491		943
492	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>
493	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
494	crossfire+).	946	Deliantra).
495		947
496	=over 4	948	=over 4
497		949
498	=item $attachable->attach ($attachment, key => $value...)	950	=item $attachable->attach ($attachment, key => $value...)
499		951
…		…
543	=item cf::CLASS::attachment $name, ...	995	=item cf::CLASS::attachment $name, ...
544		996
545	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
546	given CLASS can refer to this attachment.	998	given CLASS can refer to this attachment.
547		999
548	Some classes such as crossfire maps and objects can specify attachments	1000	Some classes such as deliantra maps and objects can specify attachments
549	that are attached at load/instantiate time, thus the need for a name.	1001	that are attached at load/instantiate time, thus the need for a name.
550		1002
551	These calls expect any number of the following handler/hook descriptions:	1003	These calls expect any number of the following handler/hook descriptions:
552		1004
553	=over 4	1005	=over 4
…		…
613	our @CB_TYPE = (); # registry for type (cf-object class) based events	1065	our @CB_TYPE = (); # registry for type (cf-object class) based events
614	our @CB_MAP = ();	1066	our @CB_MAP = ();
615		1067
616	my %attachment;	1068	my %attachment;
617		1069
		1070	sub cf::attachable::thawer_merge {
		1071	# simply override everything except _meta
		1072	local $_[0]{_meta};
		1073	%{$_[0]} = %{$_[1]};
		1074	}
		1075
618	sub _attach_cb($$$$) {	1076	sub _attach_cb($$$$) {
619	my ($registry, $event, $prio, $cb) = @_;	1077	my ($registry, $event, $prio, $cb) = @_;
620		1078
621	use sort 'stable';	1079	use sort 'stable';
622		1080
…		…
656	$registry = $CB_TYPE[$object_type] ||= [];	1114	$registry = $CB_TYPE[$object_type] ||= [];
657		1115
658	} elsif ($type eq "subtype") {	1116	} elsif ($type eq "subtype") {
659	defined $object_type or Carp::croak "subtype specified without type";	1117	defined $object_type or Carp::croak "subtype specified without type";
660	my $object_subtype = shift @arg;	1118	my $object_subtype = shift @arg;
661	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1119	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
662		1120
663	} elsif ($type eq "package") {	1121	} elsif ($type eq "package") {
664	my $pkg = shift @arg;	1122	my $pkg = shift @arg;
665		1123
666	while (my ($name, $id) = each %cb_id) {	1124	while (my ($name, $id) = each %cb_id) {
…		…
671		1129
672	} elsif (exists $cb_id{$type}) {	1130	} elsif (exists $cb_id{$type}) {
673	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1131	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
674		1132
675	} elsif (ref $type) {	1133	} elsif (ref $type) {
676	warn "attaching objects not supported, ignoring.\n";	1134	error "attaching objects not supported, ignoring.\n";
677		1135
678	} else {	1136	} else {
679	shift @arg;	1137	shift @arg;
680	warn "attach argument '$type' not supported, ignoring.\n";	1138	error "attach argument '$type' not supported, ignoring.\n";
681	}	1139	}
682	}	1140	}
683	}	1141	}
684		1142
685	sub _object_attach {	1143	sub _object_attach {
…		…
695	_attach $registry, $klass, @attach;	1153	_attach $registry, $klass, @attach;
696	}	1154	}
697		1155
698	$obj->{$name} = \%arg;	1156	$obj->{$name} = \%arg;
699	} else {	1157	} else {
700	warn "object uses attachment '$name' that is not available, postponing.\n";	1158	info "object uses attachment '$name' which is not available, postponing.\n";
701	}	1159	}
702		1160
703	$obj->{_attachment}{$name} = undef;	1161	$obj->{_attachment}{$name} = undef;
704	}	1162	}
705		1163
…		…
707	if (ref $_[0]) {	1165	if (ref $_[0]) {
708	_object_attach @_;	1166	_object_attach @_;
709	} else {	1167	} else {
710	_attach shift->_attach_registry, @_;	1168	_attach shift->_attach_registry, @_;
711	}	1169	}
		1170	_recalc_want;
712	};	1171	};
713		1172
714	# all those should be optimised	1173	# all those should be optimised
715	sub cf::attachable::detach {	1174	sub cf::attachable::detach {
716	my ($obj, $name) = @_;	1175	my ($obj, $name) = @_;
…		…
719	delete $obj->{_attachment}{$name};	1178	delete $obj->{_attachment}{$name};
720	reattach ($obj);	1179	reattach ($obj);
721	} else {	1180	} else {
722	Carp::croak "cannot, currently, detach class attachments";	1181	Carp::croak "cannot, currently, detach class attachments";
723	}	1182	}
		1183	_recalc_want;
724	};	1184	};
725		1185
726	sub cf::attachable::attached {	1186	sub cf::attachable::attached {
727	my ($obj, $name) = @_;	1187	my ($obj, $name) = @_;
728		1188
…		…
743	";	1203	";
744	die if $@;	1204	die if $@;
745	}	1205	}
746		1206
747	our $override;	1207	our $override;
748	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?
749		1209
750	sub override {	1210	sub override {
751	$override = 1;	1211	$override = 1;
752	@invoke_results = ();	1212	@INVOKE_RESULTS = (@_);
753	}	1213	}
754		1214
755	sub do_invoke {	1215	sub do_invoke {
756	my $event = shift;	1216	my $event = shift;
757	my $callbacks = shift;	1217	my $callbacks = shift;
758		1218
759	@invoke_results = ();	1219	@INVOKE_RESULTS = ();
760		1220
761	local $override;	1221	local $override;
762		1222
763	for (@$callbacks) {	1223	for (@$callbacks) {
764	eval { &{$_->[1]} };	1224	eval { &{$_->[1]} };
765		1225
766	if ($@) {	1226	if ($@) {
767	warn "$@";
768	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1227	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
769	override;	1228	override;
770	}	1229	}
771		1230
772	return 1 if $override;	1231	return 1 if $override;
773	}	1232	}
774		1233
775	0	1234	0
776	}	1235	}
777		1236
778	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1237	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
779		1238
780	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1239	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
781		1240
782	Generate an object-specific event with the given arguments.	1241	Generate an object-specific event with the given arguments.
783		1242
784	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
785	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
786	results (if you must, access C<@cf::invoke_results> directly).	1245	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
787		1246
788	=back	1247	=back
789		1248
790	=cut	1249	=cut
791		1250
792	#############################################################################	1251	#############################################################################
793	# 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	}
794		1295
795	sub reattach {	1296	sub reattach {
796	# basically do the same as instantiate, without calling instantiate	1297	# basically do the same as instantiate, without calling instantiate
797	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
798		1302
799	my $registry = $obj->registry;	1303	my $registry = $obj->registry;
800		1304
801	@$registry = ();	1305	@$registry = ();
802		1306
…		…
807	for (@$attach) {	1311	for (@$attach) {
808	my ($klass, @attach) = @$_;	1312	my ($klass, @attach) = @$_;
809	_attach $registry, $klass, @attach;	1313	_attach $registry, $klass, @attach;
810	}	1314	}
811	} else {	1315	} else {
812	warn "object uses attachment '$name' that is not available, postponing.\n";	1316	info "object uses attachment '$name' that is not available, postponing.\n";
813	}	1317	}
814	}	1318	}
815	}	1319	}
816		1320
817	cf::attachable->attach (	1321	cf::attachable->attach (
818	prio => -1000000,	1322	prio => -1000000,
819	on_instantiate => sub {	1323	on_instantiate => sub {
820	my ($obj, $data) = @_;	1324	my ($obj, $data) = @_;
821		1325
822	$data = from_json $data;	1326	$data = decode_json $data;
823		1327
824	for (@$data) {	1328	for (@$data) {
825	my ($name, $args) = @$_;	1329	my ($name, $args) = @$_;
826		1330
827	$obj->attach ($name, %{$args || {} });	1331	$obj->attach ($name, %{$args || {} });
…		…
843	sub object_freezer_save {	1347	sub object_freezer_save {
844	my ($filename, $rdata, $objs) = @_;	1348	my ($filename, $rdata, $objs) = @_;
845		1349
846	sync_job {	1350	sync_job {
847	if (length $$rdata) {	1351	if (length $$rdata) {
		1352	utf8::decode (my $decname = $filename);
848	warn sprintf "saving %s (%d,%d)\n",	1353	trace sprintf "saving %s (%d,%d)\n",
849	$filename, length $$rdata, scalar @$objs;	1354	$decname, length $$rdata, scalar @$objs
		1355	if $VERBOSE_IO;
850		1356
851	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1357	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
852	chmod SAVE_MODE, $fh;	1358	aio_chmod $fh, SAVE_MODE;
853	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;
854	aio_fsync $fh;	1362	aio_fsync $fh;
		1363	}
855	close $fh;	1364	aio_close $fh;
856		1365
857	if (@$objs) {	1366	if (@$objs) {
858	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) {
859	chmod SAVE_MODE, $fh;	1368	aio_chmod $fh, SAVE_MODE;
860	my $data = Storable::nfreeze { version => 1, objs => $objs };	1369	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
861	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;
862	aio_fsync $fh;	1373	aio_fsync $fh;
		1374	}
863	close $fh;	1375	aio_close $fh;
864	aio_rename "$filename.pst~", "$filename.pst";	1376	aio_rename "$filename.pst~", "$filename.pst";
865	}	1377	}
866	} else {	1378	} else {
867	aio_unlink "$filename.pst";	1379	aio_unlink "$filename.pst";
868	}	1380	}
869		1381
870	aio_rename "$filename~", $filename;	1382	aio_rename "$filename~", $filename;
		1383
		1384	$filename =~ s%/[^/]+$%%;
		1385	aio_pathsync $filename if $cf::USE_FSYNC;
871	} else {	1386	} else {
872	warn "FATAL: $filename~: $!\n";	1387	error "unable to save objects: $filename~: $!\n";
873	}	1388	}
874	} else {	1389	} else {
875	aio_unlink $filename;	1390	aio_unlink $filename;
876	aio_unlink "$filename.pst";	1391	aio_unlink "$filename.pst";
877	}	1392	}
878	}	1393	};
879	}	1394	}
880		1395
881	sub object_freezer_as_string {	1396	sub object_freezer_as_string {
882	my ($rdata, $objs) = @_;	1397	my ($rdata, $objs) = @_;
883		1398
…		…
895	or return;	1410	or return;
896		1411
897	unless (aio_stat "$filename.pst") {	1412	unless (aio_stat "$filename.pst") {
898	(aio_load "$filename.pst", $av) >= 0	1413	(aio_load "$filename.pst", $av) >= 0
899	or return;	1414	or return;
		1415
900	$av = eval { (Storable::thaw $av)->{objs} };	1416	my $st = eval { Coro::Storable::thaw $av };
		1417	$av = $st->{objs};
901	}	1418	}
902		1419
		1420	utf8::decode (my $decname = $filename);
903	warn sprintf "loading %s (%d)\n",	1421	trace sprintf "loading %s (%d,%d)\n",
904	$filename, length $data, scalar @{$av || []};#d#	1422	$decname, length $data, scalar @{$av || []}
		1423	if $VERBOSE_IO;
		1424
905	return ($data, $av);	1425	($data, $av)
906	}	1426	}
		1427
		1428	=head2 COMMAND CALLBACKS
		1429
		1430	=over 4
		1431
		1432	=cut
907		1433
908	#############################################################################	1434	#############################################################################
909	# command handling &c	1435	# command handling &c
910		1436
911	=item cf::register_command $name => \&callback($ob,$args);	1437	=item cf::register_command $name => \&callback($ob,$args)
912		1438
913	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
914	$name.	1440	$name.
915		1441
916	=cut	1442	=cut
…		…
922	#warn "registering command '$name/$time' to '$caller'";	1448	#warn "registering command '$name/$time' to '$caller'";
923		1449
924	push @{ $COMMAND{$name} }, [$caller, $cb];	1450	push @{ $COMMAND{$name} }, [$caller, $cb];
925	}	1451	}
926		1452
927	=item cf::register_extcmd $name => \&callback($pl,$packet);	1453	=item cf::register_extcmd $name => \&callback($pl,@args)
928		1454
929	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.
930		1460
931	If the callback returns something, it is sent back as if reply was being	1461	The values will be sent back to the client.
932	called.
933		1462
934	=cut	1463	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
935		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
936	sub register_extcmd {	1485	sub register_extcmd($$) {
937	my ($name, $cb) = @_;	1486	my ($name, $cb) = @_;
938		1487
939	my $caller = caller;
940	#warn "registering extcmd '$name' to '$caller'";
941
942	$EXTCMD{$name} = [$cb, $caller];	1488	$EXTCMD{$name} = $cb;
943	}	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 ();
944		1510
945	cf::player->attach (	1511	cf::player->attach (
946	on_command => sub {	1512	on_unknown_command => sub {
947	my ($pl, $name, $params) = @_;	1513	my ($pl, $name, $params) = @_;
948		1514
949	my $cb = $COMMAND{$name}	1515	my $cb = $COMMAND{$name}
950	or return;	1516	or return;
951		1517
…		…
956	cf::override;	1522	cf::override;
957	},	1523	},
958	on_extcmd => sub {	1524	on_extcmd => sub {
959	my ($pl, $buf) = @_;	1525	my ($pl, $buf) = @_;
960		1526
961	my $msg = eval { from_json $buf };	1527	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
962		1528
963	if (ref $msg) {	1529	if (ref $msg) {
		1530	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1531
964	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1532	if (my $cb = $EXTACMD{$type}) {
965	if (my %reply = $cb->[0]->($pl, $msg)) {	1533	$cb->(
966	$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);
967	}	1546	}
		1547
		1548	$pl->ext_msg ("reply-$reply", @reply)
		1549	if $reply;
968	}	1550	}
		1551
969	} else {	1552	} else {
970	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1553	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
971	}	1554	}
972		1555
973	cf::override;	1556	cf::override;
974	},	1557	},
975	);	1558	);
976		1559
977	sub register {	1560	# "readahead" all extensions
978	my ($base, $pkg) = @_;
979
980	#TODO
981	}
982
983	sub load_extension {	1561	sub cache_extensions {
984	my ($path) = @_;	1562	my $grp = IO::AIO::aio_group;
985		1563
986	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1564	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
987	my $base = $1;	1565	for (grep /\.ext$/, @{$_[0]}) {
988	my $pkg = $1;	1566	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
989	$pkg =~ s/[^[:word:]]/_/g;
990	$pkg = "ext::$pkg";
991
992	warn "loading '$path' into '$pkg'\n";
993
994	open my $fh, "<:utf8", $path
995	or die "$path: $!";
996
997	my $source =
998	"package $pkg; use strict; use utf8;\n"
999	. "#line 1 \"$path\"\n{\n"
1000	. (do { local $/; <$fh> })
1001	. "\n};\n1";
1002
1003	eval $source
1004	or die $@ ? "$path: $@\n"
1005	: "extension disabled.\n";
1006
1007	push @exts, $pkg;
1008	$ext_pkg{$base} = $pkg;
1009
1010	# no strict 'refs';
1011	# @{"$pkg\::ISA"} = ext::;
1012
1013	register $base, $pkg;
1014	}
1015
1016	sub unload_extension {
1017	my ($pkg) = @_;
1018
1019	warn "removing extension $pkg\n";
1020
1021	# remove hooks
1022	#TODO
1023	# for my $idx (0 .. $#PLUGIN_EVENT) {
1024	# delete $hook[$idx]{$pkg};
1025	# }
1026
1027	# remove commands
1028	for my $name (keys %COMMAND) {
1029	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1030
1031	if (@cb) {
1032	$COMMAND{$name} = \@cb;
1033	} else {
1034	delete $COMMAND{$name};
1035	}	1567	}
1036	}	1568	};
1037		1569
1038	# remove extcmds	1570	$grp
1039	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1571	}
1040	delete $EXTCMD{$name};
1041	}
1042		1572
1043	if (my $cb = $pkg->can ("unload")) {	1573	sub _ext_cfg_reg($$$$) {
1044	eval {	1574	my ($rvar, $varname, $cfgname, $default) = @_;
1045	$cb->($pkg);
1046	1
1047	} or warn "$pkg unloaded, but with errors: $@";
1048	}
1049		1575
1050	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;
1051	}	1582	}
1052		1583
1053	sub load_extensions {	1584	sub load_extensions {
		1585	info "loading extensions...";
		1586
		1587	%EXT_CFG = ();
		1588
		1589	cf::sync_job {
		1590	my %todo;
		1591
1054	for my $ext (<$LIBDIR/*.ext>) {	1592	for my $path (<$LIBDIR/*.ext>) {
1055	next unless -r $ext;	1593	next unless -r $path;
1056	eval {	1594
1057	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	}
1058	1	1667	}
1059	} 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	}
1060	}	1680	};
1061	}	1681	}
1062		1682
1063	#############################################################################	1683	#############################################################################
1064	# load/save/clean perl data associated with a map
1065		1684
1066	*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($) {
1067	my ($map) = @_;	1739	my ($login) = @_;
1068		1740
1069	my $path = $map->tmpname;	1741	$cf::PLAYER{$login}
1070	defined $path or return;	1742	or !aio_stat path $login
1071
1072	unlink "$path.pst";
1073	};
1074
1075	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1076
1077	#############################################################################
1078	# load/save perl data associated with player->ob objects
1079
1080	sub all_objects(@) {
1081	@_, map all_objects ($_->inv), @_
1082	}	1743	}
1083		1744
1084	# 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
1085	cf::player->attach (	1772	cf::player->attach (
1086	on_load => sub {	1773	on_load => sub {
1087	my ($pl, $path) = @_;	1774	my ($pl, $path) = @_;
1088		1775
1089	for my $o (all_objects $pl->ob) {	1776	# restore slots saved in save, below
1090	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1777	my $slots = delete $pl->{_slots};
1091	$o->set_ob_key_value ("_perl_data");
1092		1778
1093	%$o = %{ Storable::thaw pack "H*", $value };	1779	$pl->ob->current_weapon ($slots->[0]);
1094	}	1780	$pl->combat_ob ($slots->[1]);
1095	}	1781	$pl->ranged_ob ($slots->[2]);
1096	},	1782	},
1097	);	1783	);
1098		1784
1099	#############################################################################	1785	sub save($) {
		1786	my ($pl) = @_;
1100		1787
1101	=head2 CORE EXTENSIONS	1788	return if $pl->{deny_save};
1102		1789
1103	Functions and methods that extend core crossfire objects.	1790	my $path = path $pl;
		1791	my $guard = cf::lock_acquire "user_save:$path";
1104		1792
1105	=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
1106		1960
1107	=over 4	1961	=over 4
1108		1962
1109	=item cf::player::exists $login
1110
1111	Returns true when the given account exists.
1112
1113	=cut	1963	=cut
1114		1964
1115	sub cf::player::exists($) {	1965	package cf::region;
1116	cf::player::find $_[0]
1117	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1118	}
1119		1966
1120	=item $player->ext_reply ($msgid, $msgtype, %msg)	1967	=item cf::region::find_by_path $path
1121		1968
1122	Sends an ext reply to the player.	1969	Tries to decuce the likely region for a map knowing only its path.
1123		1970
1124	=cut	1971	=cut
1125		1972
1126	sub cf::player::ext_reply($$$%) {	1973	sub find_by_path($) {
1127	my ($self, $id, %msg) = @_;	1974	my ($path) = @_;
1128		1975
1129	$msg{msgid} = $id;	1976	$path =~ s/^~[^\/]*//; # skip ~login
1130		1977
1131	$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
1132	}	1988	}
1133		1989
1134	=back	1990	=back
1135
1136		1991
1137	=head3 cf::map	1992	=head3 cf::map
1138		1993
1139	=over 4	1994	=over 4
1140		1995
…		…
1143	package cf::map;	1998	package cf::map;
1144		1999
1145	use Fcntl;	2000	use Fcntl;
1146	use Coro::AIO;	2001	use Coro::AIO;
1147		2002
		2003	use overload
		2004	'""' => \&as_string,
		2005	fallback => 1;
		2006
1148	our $MAX_RESET = 3600;	2007	our $MAX_RESET = 3600;
1149	our $DEFAULT_RESET = 3000;	2008	our $DEFAULT_RESET = 3000;
1150		2009
1151	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 {
1152	my ($path, $rmp) = @_;	2049	my ($path, $base) = @_;
1153		2050
1154	# mit "rum" bekleckern, nicht	2051	$path = "$path"; # make sure it's a string
1155	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
1156	$path,	2080	$path
1157	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1158	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1159	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1160	$rmp->{exit_on_final_map},
1161	$rmp->{xsize}, $rmp->{ysize},
1162	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1163	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1164	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1165	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1166	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1167	(cf::region::find $rmp->{region})
1168	}	2081	}
1169		2082
1170	# and all this just because we cannot iterate over	2083	sub new_from_path {
1171	# all maps in C++...	2084	my (undef, $path, $base) = @_;
1172	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 {
1173	my ($change) = @_;	2105	my ($self) = @_;
1174		2106
1175	$_->change_map_light ($change)	2107	$self
1176	for grep $_->outdoor, values %cf::MAP;
1177	}	2108	}
1178		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
1179	sub try_load_header($) {	2160	sub load_header_from($) {
1180	my ($path) = @_;	2161	my ($self, $path) = @_;
1181		2162
1182	utf8::encode $path;	2163	utf8::encode $path;
1183	aio_open $path, O_RDONLY, 0	2164	my $f = new_from_file cf::object::thawer $path
1184	or return;	2165	or return;
1185		2166
1186	my $map = cf::map::new	2167	$self->_load_header ($f)
1187	or return;	2168	or return;
1188		2169
1189	$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
1190	or return;	2220	or return;
		2221	$self->prepare_orig;
		2222	}
1191		2223
1192	$map->{load_path} = $path;	2224	$self->{deny_reset} = 1
		2225	if $self->no_reset;
1193		2226
1194	$map	2227	$self->default_region (cf::region::find_by_path $self->{path})
		2228	unless $self->default_region;
		2229
		2230	1
1195	}	2231	}
1196		2232
1197	sub find;	2233	sub find;
1198	sub find {	2234	sub find {
1199	my ($path, $origin) = @_;	2235	my ($path, $origin) = @_;
1200		2236
1201	#warn "find<$path,$origin>\n";#d#	2237	cf::cede_to_tick;
1202		2238
1203	$path = new cf::path $path, $origin && $origin->path;	2239	$path = normalise $path, $origin;
1204	my $key = $path->as_string;
1205		2240
1206	cf::lock_wait "map_find:$key";	2241	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1207
1208	$cf::MAP{$key} || do {
1209	my $guard = cf::lock_acquire "map_find:$key";	2242	my $guard2 = cf::lock_acquire "map_find:$path";
1210		2243
1211	# do it the slow way	2244	$cf::MAP{$path} || do {
1212	my $map = try_load_header $path->save_path;	2245	my $map = new_from_path cf::map $path
1213
1214	Coro::cede;
1215
1216	if ($map) {
1217	$map->last_access ((delete $map->{last_access})
1218	|| $cf::RUNTIME); #d#
1219	# safety
1220	$map->{instantiate_time} = $cf::RUNTIME
1221	if $map->{instantiate_time} > $cf::RUNTIME;
1222	} else {
1223	if (my $rmp = $path->random_map_params) {
1224	$map = generate_random_map $key, $rmp;
1225	} else {
1226	$map = try_load_header $path->load_path;
1227	}
1228
1229	$map or return;	2246	or return;
1230		2247
1231	$map->{load_original} = 1;
1232	$map->{instantiate_time} = $cf::RUNTIME;
1233	$map->last_access ($cf::RUNTIME);
1234	$map->instantiate;
1235
1236	# per-player maps become, after loading, normal maps
1237	$map->per_player (0) if $path->{user_rel};
1238	}
1239
1240	$map->path ($key);
1241	$map->{path} = $path;
1242	$map->{last_save} = $cf::RUNTIME;	2248	$map->{last_save} = $cf::RUNTIME;
1243		2249
1244	Coro::cede;	2250	$map->load_header
		2251	or return;
1245		2252
1246	if ($map->should_reset) {	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;
1247	$map->reset;	2258	$map->reset;
1248	undef $guard;
1249	$map = find $path	2259	return find $path;
1250	or return;
1251	}	2260	}
1252		2261
1253	$cf::MAP{$key} = $map	2262	$cf::MAP{$path} = $map
1254	}	2263	}
1255	}	2264	}
		2265
		2266	sub pre_load { }
		2267	#sub post_load { } # XS
1256		2268
1257	sub load {	2269	sub load {
1258	my ($self) = @_;	2270	my ($self) = @_;
1259		2271
		2272	local $self->{deny_reset} = 1; # loading can take a long time
		2273
1260	my $path = $self->{path};	2274	my $path = $self->{path};
		2275
		2276	{
1261	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2277	my $guard = cf::lock_acquire "map_data:$path";
1262		2278
1263	return if $self->in_memory != cf::MAP_SWAPPED;	2279	return unless $self->valid;
		2280	return unless $self->state == cf::MAP_SWAPPED;
1264		2281
1265	$self->in_memory (cf::MAP_LOADING);
1266
1267	$self->alloc;	2282	$self->alloc;
1268	$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)
1269	or return;	2291	or return;
1270		2292
1271	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2293	$self->post_load_original
1272	if delete $self->{load_original};	2294	if delete $self->{load_original};
1273		2295
1274	if (my $uniq = $path->uniq_path) {	2296	if (my $uniq = $self->uniq_path) {
1275	utf8::encode $uniq;	2297	utf8::encode $uniq;
1276	if (aio_open $uniq, O_RDONLY, 0) {	2298	unless (aio_stat $uniq) {
		2299	if (my $f = new_from_file cf::object::thawer $uniq) {
1277	$self->clear_unique_items;	2300	$self->clear_unique_items;
1278	$self->load_objects ($uniq, 0);	2301	$self->_load_objects ($f);
		2302	$f->resolve_delayed_derefs;
		2303	}
		2304	}
1279	}	2305	}
1280	}
1281		2306
1282	Coro::cede;	2307	$f->resolve_delayed_derefs;
		2308	} else {
		2309	$self->post_load_original
		2310	if delete $self->{load_original};
		2311	}
1283		2312
		2313	$self->state (cf::MAP_INACTIVE);
		2314
		2315	cf::cede_to_tick;
1284	# now do the right thing for maps	2316	# now do the right thing for maps
1285	$self->link_multipart_objects;	2317	$self->link_multipart_objects;
1286
1287	if ($self->{path}->is_style_map) {
1288	$self->{deny_save} = 1;
1289	$self->{deny_reset} = 1;
1290	} else {
1291	$self->fix_auto_apply;
1292	$self->decay_objects;
1293	$self->update_buttons;
1294	$self->set_darkness_map;
1295	$self->difficulty ($self->estimate_difficulty)	2318	$self->difficulty ($self->estimate_difficulty)
1296	unless $self->difficulty;	2319	unless $self->difficulty;
1297	$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
1298	}	2336	1
		2337	}
1299		2338
1300	Coro::cede;	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) = @_;
1301		2344
1302	$self->in_memory (cf::MAP_IN_MEMORY);	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
1303	}	2352	}
1304		2353
1305	sub find_sync {	2354	sub find_sync {
1306	my ($path, $origin) = @_;	2355	my ($path, $origin) = @_;
1307		2356
1308	cf::sync_job { cf::map::find $path, $origin }	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;
		2360
		2361	find $path, $origin
1309	}	2362	}
1310		2363
1311	sub do_load_sync {	2364	sub do_load_sync {
1312	my ($map) = @_;	2365	my ($map) = @_;
1313		2366
1314	cf::sync_job { $map->load };	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
		2371	$map->load;
		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);
		2436	}
1315	}	2437	}
1316		2438
1317	sub save {	2439	sub save {
1318	my ($self) = @_;	2440	my ($self) = @_;
1319		2441
1320	$self->{last_save} = $cf::RUNTIME;	2442	my $lock = cf::lock_acquire "map_data:$self->{path}";
1321		2443
1322	return unless $self->dirty;	2444	$self->_save;
1323
1324	my $save = $self->{path}->save_path; utf8::encode $save;
1325	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1326
1327	$self->{load_path} = $save;
1328
1329	return if $self->{deny_save};
1330
1331	local $self->{last_access} = $self->last_access;#d#
1332
1333	if ($uniq) {
1334	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1335	$self->save_objects ($uniq, cf::IO_UNIQUES);
1336	} else {
1337	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1338	}
1339	}	2445	}
1340		2446
1341	sub swap_out {	2447	sub swap_out {
1342	my ($self) = @_;	2448	my ($self) = @_;
1343		2449
1344	# save first because save cedes	2450	my $lock = cf::lock_acquire "map_data:$self->{path}";
1345	$self->save;
1346		2451
		2452	return if !$self->linkable;
		2453	return if $self->{deny_save};
1347	return if $self->players;	2454	return if $self->players;
1348	return if $self->in_memory != cf::MAP_IN_MEMORY;
1349	return if $self->{deny_save};
1350		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
		2462	$self->_save;
		2463
		2464	# then free the map
1351	$self->clear;	2465	$self->clear;
1352	$self->in_memory (cf::MAP_SWAPPED);
1353	}	2466	}
1354		2467
1355	sub reset_at {	2468	sub reset_at {
1356	my ($self) = @_;	2469	my ($self) = @_;
1357		2470
1358	# TODO: safety, remove and allow resettable per-player maps	2471	# TODO: safety, remove and allow resettable per-player maps
1359	return 1e99 if $self->{path}{user_rel};
1360	return 1e99 if $self->{deny_reset};	2472	return 1e99 if $self->{deny_reset};
1361		2473
1362	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2474	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1363	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;
1364		2476
…		…
1369	my ($self) = @_;	2481	my ($self) = @_;
1370		2482
1371	$self->reset_at <= $cf::RUNTIME	2483	$self->reset_at <= $cf::RUNTIME
1372	}	2484	}
1373		2485
1374	sub unlink_save {
1375	my ($self) = @_;
1376
1377	utf8::encode (my $save = $self->{path}->save_path);
1378	aioreq_pri 3; IO::AIO::aio_unlink $save;
1379	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1380	}
1381
1382	sub rename {
1383	my ($self, $new_path) = @_;
1384
1385	$self->unlink_save;
1386
1387	delete $cf::MAP{$self->path};
1388	$self->{path} = new cf::path $new_path;
1389	$self->path ($self->{path}->as_string);
1390	$cf::MAP{$self->path} = $self;
1391
1392	$self->save;
1393	}
1394
1395	sub reset {	2486	sub reset {
1396	my ($self) = @_;	2487	my ($self) = @_;
1397		2488
		2489	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2490
1398	return if $self->players;	2491	return if $self->players;
1399	return if $self->{path}{user_rel};#d#
1400		2492
1401	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	}
1402		2504
1403	delete $cf::MAP{$self->path};	2505	delete $cf::MAP{$self->path};
1404		2506
		2507	$self->deactivate;
1405	$_->clear_links_to ($self) for values %cf::MAP;	2508	$_->clear_links_to ($self) for values %cf::MAP;
		2509	$self->clear;
1406		2510
1407	$self->unlink_save;	2511	$self->unlink_save;
1408	$self->destroy;	2512	$self->destroy;
1409	}	2513	}
1410		2514
1411	my $nuke_counter = "aaaa";	2515	my $nuke_counter = "aaaa";
1412		2516
1413	sub nuke {	2517	sub nuke {
1414	my ($self) = @_;	2518	my ($self) = @_;
1415		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};
1416	$self->{deny_save} = 1;	2529	$self->{deny_save} = 1;
1417	$self->reset_timeout (1);	2530	$self->reset_timeout (1);
1418	$self->rename ("{nuke}/" . ($nuke_counter++));	2531	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2532
		2533	$cf::MAP{$self->path} = $self;
		2534	}
		2535
1419	$self->reset; # polite request, might not happen	2536	$self->reset; # polite request, might not happen
1420	}	2537	}
1421		2538
1422	sub customise_for {	2539	=item $maps = cf::map::tmp_maps
1423	my ($map, $ob) = @_;
1424		2540
1425	if ($map->per_player) {	2541	Returns an arrayref with all map paths of currently instantiated and saved
1426	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2542	maps. May block.
		2543
		2544	=cut
		2545
		2546	sub tmp_maps() {
1427	}	2547	[
1428		2548	map {
1429	$map	2549	utf8::decode $_;
		2550	/\.map$/
		2551	? normalise $_
		2552	: ()
		2553	} @{ aio_readdir $TMPDIR or [] }
		2554	]
1430	}	2555	}
1431		2556
1432	sub emergency_save {	2557	=item $maps = cf::map::random_maps
1433	my $freeze_guard = cf::freeze_mainloop;
1434		2558
1435	warn "enter emergency map save\n";	2559	Returns an arrayref with all map paths of currently instantiated and saved
		2560	random maps. May block.
1436		2561
1437	cf::sync_job {	2562	=cut
1438	warn "begin emergency map save\n";	2563
1439	$_->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;
1440	};	2621	}
1441		2622
1442	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	}
1443	}	2678	}
1444		2679
1445	package cf;	2680	package cf;
1446		2681
1447	=back	2682	=back
1448
1449		2683
1450	=head3 cf::object::player	2684	=head3 cf::object::player
1451		2685
1452	=over 4	2686	=over 4
1453		2687
…		…
1456	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>
1457	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
1458	dialogue with the given NPC character.	2692	dialogue with the given NPC character.
1459		2693
1460	=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	};
1461		2709
1462	# rough implementation of a future "reply" method that works	2710	# rough implementation of a future "reply" method that works
1463	# with dialog boxes.	2711	# with dialog boxes.
1464	#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
1465	sub cf::object::player::reply($$$;$) {	2713	sub cf::object::player::reply($$$;$) {
…		…
1467		2715
1468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2716	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1469		2717
1470	if ($self->{record_replies}) {	2718	if ($self->{record_replies}) {
1471	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2719	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2720
1472	} 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 {
1473	$msg = $npc->name . " says: $msg" if $npc;	2729	$msg = $npc->name . " says: $msg" if $npc;
1474	$self->message ($msg, $flags);	2730	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2731	}
1475	}	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 (@_);
1476	}	2743	}
1477		2744
1478	=item $player_object->may ("access")	2745	=item $player_object->may ("access")
1479		2746
1480	Returns wether the given player is authorized to access resource "access"	2747	Returns wether the given player is authorized to access resource "access"
…		…
1493		2760
1494	=item $player_object->enter_link	2761	=item $player_object->enter_link
1495		2762
1496	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}>).
1497		2764
1498	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.
1499	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.
1500		2771
1501	=item $player_object->leave_link ($map, $x, $y)	2772	=item $player_object->leave_link ($map, $x, $y)
1502		2773
1503	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
1504	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
1505	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
1506	to the emergency map position.	2777	fails, to the emergency map position.
1507		2778
1508	Might block.	2779	Might block.
1509		2780
1510	=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	}
1511		2792
1512	sub cf::object::player::enter_link {	2793	sub cf::object::player::enter_link {
1513	my ($self) = @_;	2794	my ($self) = @_;
1514		2795
1515	$self->deactivate_recursive;	2796	$self->deactivate_recursive;
1516		2797
1517	return if $self->map == $LINK_MAP;	2798	++$self->{_link_recursion};
		2799
		2800	return if UNIVERSAL::isa $self->map, "ext::map_link";
1518		2801
1519	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2802	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1520	if $self->map;	2803	if $self->map && $self->map->{path} ne "{link}";
1521		2804
1522	$self->enter_map ($LINK_MAP, 20, 20);	2805	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1523	}	2806	}
1524		2807
1525	sub cf::object::player::leave_link {	2808	sub cf::object::player::leave_link {
1526	my ($self, $map, $x, $y) = @_;	2809	my ($self, $map, $x, $y) = @_;
		2810
		2811	return unless $self->contr->active;
1527		2812
1528	my $link_pos = delete $self->{_link_pos};	2813	my $link_pos = delete $self->{_link_pos};
1529		2814
1530	unless ($map) {	2815	unless ($map) {
1531	# restore original map position	2816	# restore original map position
…		…
1542	($x, $y) = (-1, -1)	2827	($x, $y) = (-1, -1)
1543	unless (defined $x) && (defined $y);	2828	unless (defined $x) && (defined $y);
1544		2829
1545	# use -1 or undef as default coordinates, not 0, 0	2830	# use -1 or undef as default coordinates, not 0, 0
1546	($x, $y) = ($map->enter_x, $map->enter_y)	2831	($x, $y) = ($map->enter_x, $map->enter_y)
1547	if $x <=0 && $y <= 0;	2832	if $x <= 0 && $y <= 0;
1548		2833
1549	$map->load;	2834	$map->load;
1550		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
1551	$self->activate_recursive;	2843	$self->activate_recursive;
1552	$self->enter_map ($map, $x, $y);
1553	}
1554
1555	cf::player->attach (
1556	on_logout => sub {
1557	my ($pl) = @_;
1558
1559	# abort map switching before logout
1560	if ($pl->ob->{_link_pos}) {
1561	cf::sync_job {
1562	$pl->ob->leave_link
1563	};
1564	}
1565	},	2844	}
1566	on_login => sub {
1567	my ($pl) = @_;
1568		2845
1569	# try to abort aborted map switching on player login :)	2846	}
1570	# should happen only on crashes
1571	if ($pl->ob->{_link_pos}) {
1572	$pl->ob->enter_link;
1573	cf::async {
1574	# we need this sleep as the login has a concurrent enter_exit running
1575	# and this sleep increases chances of the player not ending up in scorn
1576	Coro::Timer::sleep 1;
1577	$pl->ob->leave_link;
1578	};
1579	}
1580	},
1581	);
1582		2847
1583	=item $player_object->goto_map ($path, $x, $y)	2848	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1584		2849
1585	=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.
1586		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
1587	sub cf::object::player::goto_map {	2863	sub cf::object::player::goto {
1588	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;
1589		2874
1590	$self->enter_link;	2875	$self->enter_link;
1591		2876
1592	(cf::async {	2877	(async {
1593	$path = new cf::path $path;	2878	$Coro::current->{desc} = "player::goto $path $x $y";
1594		2879
1595	my $map = cf::map::find $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) {
1596	$map = $map->customise_for ($self) if $map;	2903	$map = $map->customise_for ($self);
1597		2904	$map = $check->($map, $x, $y, $self) if $check && $map;
1598	# warn "entering ", $map->path, " at ($x, $y)\n"	2905	} else {
1599	# if $map;
1600
1601	$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	}
1602		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};
1603	$self->leave_link ($map, $x, $y);	2919	$self->leave_link ($map, $x, $y);
		2920	}
		2921
		2922	$done->($self) if $done;
1604	})->prio (1);	2923	})->prio (1);
1605	}	2924	}
1606		2925
1607	=item $player_object->enter_exit ($exit_object)	2926	=item $player_object->enter_exit ($exit_object)
1608		2927
…		…
1610		2929
1611	sub parse_random_map_params {	2930	sub parse_random_map_params {
1612	my ($spec) = @_;	2931	my ($spec) = @_;
1613		2932
1614	my $rmp = { # defaults	2933	my $rmp = { # defaults
1615	xsize => 10,	2934	xsize => (cf::rndm 15, 40),
1616	ysize => 10,	2935	ysize => (cf::rndm 15, 40),
		2936	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2937	#layout => string,
1617	};	2938	};
1618		2939
1619	for (split /\n/, $spec) {	2940	for (split /\n/, $spec) {
1620	my ($k, $v) = split /\s+/, $_, 2;	2941	my ($k, $v) = split /\s+/, $_, 2;
1621		2942
…		…
1633	# that depends on the exit object	2954	# that depends on the exit object
1634		2955
1635	my $rmp = parse_random_map_params $exit->msg;	2956	my $rmp = parse_random_map_params $exit->msg;
1636		2957
1637	if ($exit->map) {	2958	if ($exit->map) {
1638	$rmp->{region} = $exit->map->region_name;	2959	$rmp->{region} = $exit->region->name;
1639	$rmp->{origin_map} = $exit->map->path;	2960	$rmp->{origin_map} = $exit->map->path;
1640	$rmp->{origin_x} = $exit->x;	2961	$rmp->{origin_x} = $exit->x;
1641	$rmp->{origin_y} = $exit->y;	2962	$rmp->{origin_y} = $exit->y;
		2963
		2964	$exit->map->touch;
1642	}	2965	}
1643		2966
1644	$rmp->{random_seed} ||= $exit->random_seed;	2967	$rmp->{random_seed} ||= $exit->random_seed;
1645		2968
1646	my $data = cf::to_json $rmp;	2969	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1647	my $md5 = Digest::MD5::md5_hex $data;	2970	my $md5 = Digest::MD5::md5_hex $data;
		2971	my $meta = "$RANDOMDIR/$md5.meta";
1648		2972
1649	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) {
1650	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;
1651		2977
		2978	my $slaying = "?random/$md5";
		2979
		2980	if ($exit->valid) {
1652	$exit->slaying ("?random/$md5");	2981	$exit->slaying ("?random/$md5");
1653	$exit->msg (undef);	2982	$exit->msg (undef);
		2983	}
1654	}	2984	}
1655	}	2985	}
1656		2986
1657	sub cf::object::player::enter_exit {	2987	sub cf::object::player::enter_exit {
1658	my ($self, $exit) = @_;	2988	my ($self, $exit) = @_;
1659		2989
1660	return unless $self->type == cf::PLAYER;	2990	return unless $self->type == cf::PLAYER;
1661		2991
1662	$self->enter_link;	2992	$self->enter_link;
1663		2993
1664	(cf::async {	2994	(async {
1665	$self->deactivate_recursive; # just to be sure	2995	$Coro::current->{desc} = "enter_exit";
		2996
1666	unless (eval {	2997	unless (eval {
		2998	$self->deactivate_recursive; # just to be sure
		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
1667	prepare_random_map $exit	3011	prepare_random_map $exit
		3012	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3013
1668	if $exit->slaying eq "/!";	3014	$map = $exit->slaying;
1669		3015
1670	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	3016	} elsif ($slaying eq '!up') {
1671	$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;
1672		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
1673	1;	3033	1
1674	}) {	3034	}) {
1675	$self->message ("Something went wrong deep within the crossfire server. "	3035	$self->message ("Something went wrong deep within the deliantra server. "
1676	. "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. "
1677	. "Please report this to the dungeon master",	3037	. "Please report this to the dungeon master!",
1678	cf::NDI_UNIQUE | cf::NDI_RED);	3038	cf::NDI_UNIQUE | cf::NDI_RED);
1679		3039
1680	warn "ERROR in enter_exit: $@";	3040	error "ERROR in enter_exit: $@";
1681	$self->leave_link;	3041	$self->leave_link;
1682	}	3042	}
1683	})->prio (1);	3043	})->prio (1);
1684	}	3044	}
1685		3045
…		…
1696		3056
1697	sub cf::client::send_drawinfo {	3057	sub cf::client::send_drawinfo {
1698	my ($self, $text, $flags) = @_;	3058	my ($self, $text, $flags) = @_;
1699		3059
1700	utf8::encode $text;	3060	utf8::encode $text;
1701	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	3061	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1702	}	3062	}
1703		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	}
1704		3262
1705	=item $success = $client->query ($flags, "text", \&cb)	3263	=item $success = $client->query ($flags, "text", \&cb)
1706		3264
1707	Queues a query to the client, calling the given callback with	3265	Queues a query to the client, calling the given callback with
1708	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3266	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1709	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3267	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1710		3268
1711	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
1712	reliable at some point in the future.	3270	become reliable at some point in the future.
1713		3271
1714	=cut	3272	=cut
1715		3273
1716	sub cf::client::query {	3274	sub cf::client::query {
1717	my ($self, $flags, $text, $cb) = @_;	3275	my ($self, $flags, $text, $cb) = @_;
…		…
1725	utf8::encode $text;	3283	utf8::encode $text;
1726	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3284	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1727		3285
1728	$self->send_packet ($self->{query_queue}[0][0])	3286	$self->send_packet ($self->{query_queue}[0][0])
1729	if @{ $self->{query_queue} } == 1;	3287	if @{ $self->{query_queue} } == 1;
		3288
		3289	1
1730	}	3290	}
1731		3291
1732	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	},
1733	on_reply => sub {	3298	on_reply => sub {
1734	my ($ns, $msg) = @_;	3299	my ($ns, $msg) = @_;
1735		3300
1736	# this weird shuffling is so that direct followup queries	3301	# this weird shuffling is so that direct followup queries
1737	# get handled first	3302	# get handled first
1738	my $queue = delete $ns->{query_queue}	3303	my $queue = delete $ns->{query_queue}
1739	or return; # be conservative, not sure how that can happen, but we saw a crash here	3304	or return; # be conservative, not sure how that can happen, but we saw a crash here
1740		3305
1741	(shift @$queue)->[1]->($msg);	3306	(shift @$queue)->[1]->($msg);
		3307	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1742		3308
1743	push @{ $ns->{query_queue} }, @$queue;	3309	push @{ $ns->{query_queue} }, @$queue;
1744		3310
1745	if (@{ $ns->{query_queue} } == @$queue) {	3311	if (@{ $ns->{query_queue} } == @$queue) {
1746	if (@$queue) {	3312	if (@$queue) {
…		…
1748	} else {	3314	} else {
1749	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3315	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1750	}	3316	}
1751	}	3317	}
1752	},	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	},
1753	);	3352	);
1754		3353
1755	=item $client->coro (\&cb)	3354	=item $client->async (\&cb)
1756		3355
1757	Create a new coroutine, running the specified callback. The coroutine will	3356	Create a new coroutine, running the specified callback. The coroutine will
1758	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,
1759	or loss of connection).	3358	or loss of connection).
1760		3359
1761	=cut	3360	=cut
1762		3361
1763	sub cf::client::coro {	3362	sub cf::client::async {
1764	my ($self, $cb) = @_;	3363	my ($self, $cb) = @_;
1765		3364
1766	my $coro = &cf::async ($cb);	3365	my $coro = &Coro::async ($cb);
1767		3366
1768	$coro->on_destroy (sub {	3367	$coro->on_destroy (sub {
1769	delete $self->{_coro}{$coro+0};	3368	delete $self->{_coro}{$coro+0};
1770	});	3369	});
1771		3370
…		…
1773		3372
1774	$coro	3373	$coro
1775	}	3374	}
1776		3375
1777	cf::client->attach (	3376	cf::client->attach (
1778	on_destroy => sub {	3377	on_client_destroy => sub {
1779	my ($ns) = @_;	3378	my ($ns) = @_;
1780		3379
1781	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3380	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1782	},	3381	},
1783	);	3382	);
…		…
1798	our $safe = new Safe "safe";	3397	our $safe = new Safe "safe";
1799	our $safe_hole = new Safe::Hole;	3398	our $safe_hole = new Safe::Hole;
1800		3399
1801	$SIG{FPE} = 'IGNORE';	3400	$SIG{FPE} = 'IGNORE';
1802		3401
1803	$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	));
1804		3407
1805	# here we export the classes and methods available to script code	3408	# here we export the classes and methods available to script code
1806		3409
1807	=pod	3410	=pod
1808		3411
1809	The following fucntions and emthods are available within a safe environment:	3412	The following functions and methods are available within a safe environment:
1810		3413
1811	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
1812	cf::object::player player	3419	cf::object::player
1813	cf::player peaceful	3420	player
1814	cf::map trigger	3421
		3422	cf::player
		3423	peaceful
		3424
		3425	cf::map
		3426	trigger
1815		3427
1816	=cut	3428	=cut
1817		3429
1818	for (	3430	for (
1819	["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)],
1820	["cf::object::player" => qw(player)],	3434	["cf::object::player" => qw(player)],
1821	["cf::player" => qw(peaceful)],	3435	["cf::player" => qw(peaceful send_msg)],
1822	["cf::map" => qw(trigger)],	3436	["cf::map" => qw(trigger)],
1823	) {	3437	) {
1824	no strict 'refs';
1825	my ($pkg, @funs) = @$_;	3438	my ($pkg, @funs) = @$_;
1826	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3439	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1827	for @funs;	3440	for @funs;
1828	}	3441	}
1829		3442
…		…
1844		3457
1845	my $qcode = $code;	3458	my $qcode = $code;
1846	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3459	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1847	$qcode =~ s/\n/\\n/g;	3460	$qcode =~ s/\n/\\n/g;
1848		3461
		3462	%vars = (_dummy => 0) unless %vars;
		3463
		3464	my @res;
1849	local $_;	3465	local $_;
1850	local @safe::cf::_safe_eval_args = values %vars;
1851		3466
1852	my $eval =	3467	my $eval =
1853	"do {\n"	3468	"do {\n"
1854	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3469	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1855	. "#line 0 \"{$qcode}\"\n"	3470	. "#line 0 \"{$qcode}\"\n"
1856	. $code	3471	. $code
1857	. "\n}"	3472	. "\n}"
1858	;	3473	;
1859		3474
		3475	if ($CFG{safe_eval}) {
1860	sub_generation_inc;	3476	sub_generation_inc;
		3477	local @safe::cf::_safe_eval_args = values %vars;
1861	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3478	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1862	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	}
1863		3484
1864	if ($@) {	3485	if ($@) {
1865	warn "$@";	3486	warn "$@",
1866	warn "while executing safe code '$code'\n";	3487	"while executing safe code '$code'\n",
1867	warn "with arguments " . (join " ", %vars) . "\n";	3488	"with arguments " . (join " ", %vars) . "\n";
1868	}	3489	}
1869		3490
1870	wantarray ? @res : $res[0]	3491	wantarray ? @res : $res[0]
1871	}	3492	}
1872		3493
…		…
1886	=cut	3507	=cut
1887		3508
1888	sub register_script_function {	3509	sub register_script_function {
1889	my ($fun, $cb) = @_;	3510	my ($fun, $cb) = @_;
1890		3511
1891	no strict 'refs';	3512	$fun = "safe::$fun" if $CFG{safe_eval};
1892	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3513	*$fun = $safe_hole->wrap ($cb);
1893	}	3514	}
1894		3515
1895	=back	3516	=back
1896		3517
1897	=cut	3518	=cut
1898		3519
1899	#############################################################################	3520	#############################################################################
		3521	# the server's init and main functions
1900		3522
1901	=head2 EXTENSION DATABASE SUPPORT	3523	our %FACEHASH; # hash => idx, #d# HACK for http server
1902		3524
1903	Crossfire maintains a very simple database for extension use. It can	3525	# internal api, not fianlised
1904	currently store anything that can be serialised using Storable, which	3526	sub set_face {
1905	excludes objects.	3527	my ($name, $type, $data) = @_;
1906		3528
1907	The parameter C<$family> should best start with the name of the extension	3529	my $idx = cf::face::find $name;
1908	using it, it should be unique.
1909		3530
1910	=over 4	3531	if ($idx) {
1911		3532	delete $FACEHASH{cf::face::get_chksum $idx};
1912	=item $hashref = cf::db_get $family
1913
1914	Return a hashref for use by the extension C<$family>, which can be
1915	modified. After modifications, you have to call C<cf::db_dirty> or
1916	C<cf::db_sync>.
1917
1918	=item $value = cf::db_get $family => $key
1919
1920	Returns a single value from the database
1921
1922	=item cf::db_put $family => $hashref
1923
1924	Stores the given family hashref into the database. Updates are delayed, if
1925	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1926
1927	=item cf::db_put $family => $key => $value
1928
1929	Stores the given C<$value> in the family hash. Updates are delayed, if you
1930	want the data to be synced to disk immediately, use C<cf::db_sync>.
1931
1932	=item cf::db_dirty
1933
1934	Marks the database as dirty, to be updated at a later time.
1935
1936	=item cf::db_sync
1937
1938	Immediately write the database to disk I<if it is dirty>.
1939
1940	=cut
1941
1942	our $DB;
1943
1944	{
1945	my $path = cf::localdir . "/database.pst";
1946
1947	sub db_load() {
1948	$DB = stat $path ? Storable::retrieve $path : { };
1949	}
1950
1951	my $pid;
1952
1953	sub db_save() {
1954	waitpid $pid, 0 if $pid;
1955	if (0 == ($pid = fork)) {
1956	$DB->{_meta}{version} = 1;
1957	Storable::nstore $DB, "$path~";
1958	rename "$path~", $path;
1959	cf::_exit 0 if defined $pid;
1960	}
1961	}
1962
1963	my $dirty;
1964
1965	sub db_sync() {
1966	db_save if $dirty;
1967	undef $dirty;
1968	}
1969
1970	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1971	db_sync;
1972	});
1973
1974	sub db_dirty() {
1975	$dirty = 1;
1976	$idle->start;
1977	}
1978
1979	sub db_get($;$) {
1980	@_ >= 2
1981	? $DB->{$_[0]}{$_[1]}
1982	: ($DB->{$_[0]} ||= { })
1983	}
1984
1985	sub db_put($$;$) {
1986	if (@_ >= 3) {
1987	$DB->{$_[0]}{$_[1]} = $_[2];
1988	} else {	3533	} else {
1989	$DB->{$_[0]} = $_[1];	3534	$idx = cf::face::alloc $name;
1990	}	3535	}
1991	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
1992	}	3565	{
		3566	my $faces = delete $facedata->{faceinfo};
1993		3567
1994	cf::global->attach (	3568	for my $face (sort keys %$faces) {
1995	prio => 10000,	3569	my $info = $faces->{$face};
1996	on_cleanup => sub {	3570	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1997	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;
1998	},	3580	}
1999	);
2000	}
2001		3581
2002	#############################################################################	3582	while (my ($face, $info) = each %$faces) {
2003	# the server's main()	3583	next unless $info->{smooth};
2004		3584
2005	sub cfg_load {	3585	my $idx = cf::face::find $face
2006	open my $fh, "<:utf8", cf::confdir . "/config"	3586	or next;
2007	or return;
2008		3587
2009	local $/;	3588	if (my $smooth = cf::face::find $info->{smooth}) {
2010	*CFG = YAML::Syck::Load <$fh>;	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	}
2011		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
2012	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	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};
2013		3749
2014	if (exists $CFG{mlockall}) {	3750	if (exists $CFG{mlockall}) {
2015	eval {	3751	eval {
2016	$CFG{mlockall} ? &mlockall : &munlockall	3752	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2017	and die "WARNING: m(un)lockall failed: $!\n";	3753	and die "WARNING: m(un)lockall failed: $!\n";
2018	};	3754	};
2019	warn $@ if $@;	3755	warn $@ if $@;
2020	}	3756	}
2021	}	3757	}
2022		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
2023	sub main {	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
2024	# we must not ever block the main coroutine	3797	# we must not ever block the main coroutine
2025	local $Coro::idle = sub {	3798	$Coro::idle = sub {
2026	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3799	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2027	(Coro::unblock_sub {	3800	(async {
2028	Event::one_event;	3801	$Coro::current->{desc} = "IDLE BUG HANDLER";
2029	})->();	3802	EV::loop EV::LOOP_ONESHOT;
		3803	})->prio (Coro::PRIO_MAX);
2030	};	3804	};
2031		3805
2032	cfg_load;	3806	evthread_start IO::AIO::poll_fileno;
2033	db_load;	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
2034	load_extensions;	3830	load_extensions;
2035	Event::loop;	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;
2036	}	3849	}
2037		3850
2038	#############################################################################	3851	#############################################################################
2039	# initialisation	3852	# initialisation and cleanup
2040		3853
		3854	# install some emergency cleanup handlers
		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
		3875	or return;
		3876
		3877	my $value = $cf::RUNTIME + 90 + 10;
		3878	# 10 is the runtime save interval, for a monotonic clock
		3879	# 60 allows for the watchdog to kill the server.
		3880
		3881	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3882	and return;
		3883
		3884	# always fsync - this file is important
		3885	aio_fsync $fh
		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";
		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
		4015	};
		4016
		4017	info "emergency_perl_save: leave\n";
		4018	}
		4019
		4020	sub post_cleanup {
		4021	my ($make_core) = @_;
		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
2041	sub reload() {	4057	sub do_reload_perl() {
2042	# can/must only be called in main	4058	# can/must only be called in main
2043	if ($Coro::current != $Coro::main) {	4059	unless (in_main) {
2044	warn "can only reload from main coroutine\n";	4060	error "can only reload from main coroutine";
2045	return;	4061	return;
2046	}	4062	}
2047		4063
2048	warn "reloading...";	4064	return if $RELOAD++;
2049		4065
2050	my $guard = freeze_mainloop;	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 {
2051	cf::emergency_save;	4075	#cf::emergency_save;
2052		4076
2053	eval {	4077	trace "perl_reload: cancelling all extension coros";
2054	# if anything goes wrong in here, we should simply crash as we already saved
2055
2056	# cancel all watchers
2057	for (Event::all_watchers) {
2058	$_->cancel if $_->data & WF_AUTOCANCEL;
2059	}
2060
2061	# cancel all extension coros
2062	$_->cancel for values %EXT_CORO;	4078	$_->cancel for values %EXT_CORO;
2063	%EXT_CORO = ();	4079	%EXT_CORO = ();
2064		4080
2065	# unload all extensions	4081	trace "perl_reload: removing commands";
2066	for (@exts) {	4082	%COMMAND = ();
2067	warn "unloading <$_>";
2068	unload_extension $_;
2069	}
2070		4083
2071	# unload all modules loaded from $LIBDIR	4084	trace "perl_reload: removing ext/exti commands";
2072	while (my ($k, $v) = each %INC) {	4085	%EXTCMD = ();
2073	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4086	%EXTICMD = ();
2074		4087
2075	warn "removing <$k>";	4088	trace "perl_reload: unloading/nuking all extensions";
2076	delete $INC{$k};	4089	for my $pkg (@EXTS) {
		4090	trace "... unloading $pkg";
2077		4091
2078	$k =~ s/\.pm$//;
2079	$k =~ s/\//::/g;
2080
2081	if (my $cb = $k->can ("unload_module")) {	4092	if (my $cb = $pkg->can ("unload")) {
		4093	eval {
2082	$cb->();	4094	$cb->($pkg);
		4095	1
		4096	} or error "$pkg unloaded, but with errors: $@";
		4097	}
		4098
		4099	trace "... clearing $pkg";
		4100	clear_package $pkg;
2083	}	4101	}
2084		4102
2085	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;
2086	}	4118	}
2087		4119
2088	# sync database to disk
2089	cf::db_sync;
2090	IO::AIO::flush;
2091
2092	# get rid of safe::, as good as possible	4120	trace "perl_reload: getting rid of safe::, as good as possible";
2093	Symbol::delete_package "safe::$_"	4121	clear_package "safe::$_"
2094	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);
2095		4123
2096	# remove register_script_function callbacks	4124	trace "perl_reload: unloading cf.pm \"a bit\"";
2097	# TODO
2098
2099	# unload cf.pm "a bit"
2100	delete $INC{"cf.pm"};	4125	delete $INC{"cf.pm"};
		4126	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2101		4127
2102	# don't, removes xs symbols, too,	4128	# don't, removes xs symbols, too,
2103	# and global variables created in xs	4129	# and global variables created in xs
2104	#Symbol::delete_package __PACKAGE__;	4130	#clear_package __PACKAGE__;
2105		4131
2106	# reload cf.pm	4132	info "perl_reload: unload completed, starting to reload now";
2107	warn "reloading cf.pm";	4133
		4134	trace "perl_reload: reloading cf.pm";
2108	require cf;	4135	require cf;
2109	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4136	cf::_connect_to_perl_1;
2110		4137
2111	# load config and database again	4138	trace "perl_reload: loading config and database again";
2112	cf::cfg_load;	4139	cf::reload_config;
2113	cf::db_load;
2114		4140
2115	# load extensions	4141	trace "perl_reload: loading extensions";
2116	warn "load extensions";
2117	cf::load_extensions;	4142	cf::load_extensions;
2118		4143
2119	# reattach attachments to objects	4144	if ($REATTACH_ON_RELOAD) {
2120	warn "reattach";	4145	trace "perl_reload: reattaching attachments to objects/players";
2121	_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	};
2122	};	4183	};
2123
2124	if ($@) {
2125	warn $@;
2126	warn "error while reloading, exiting.";
2127	exit 1;
2128	}
2129
2130	warn "reloaded successfully";
2131	};
2132
2133	#############################################################################
2134
2135	unless ($LINK_MAP) {
2136	$LINK_MAP = cf::map::new;
2137
2138	$LINK_MAP->width (41);
2139	$LINK_MAP->height (41);
2140	$LINK_MAP->alloc;
2141	$LINK_MAP->path ("{link}");
2142	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2143	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2144
2145	# dirty hack because... archetypes are not yet loaded
2146	Event->timer (
2147	after => 2,
2148	cb => sub {
2149	$_[0]->w->cancel;
2150
2151	# provide some exits "home"
2152	my $exit = cf::object::new "exit";
2153
2154	$exit->slaying ($EMERGENCY_POSITION->[0]);
2155	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2156	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2157
2158	$LINK_MAP->insert ($exit->clone, 19, 19);
2159	$LINK_MAP->insert ($exit->clone, 19, 20);
2160	$LINK_MAP->insert ($exit->clone, 19, 21);
2161	$LINK_MAP->insert ($exit->clone, 20, 19);
2162	$LINK_MAP->insert ($exit->clone, 20, 21);
2163	$LINK_MAP->insert ($exit->clone, 21, 19);
2164	$LINK_MAP->insert ($exit->clone, 21, 20);
2165	$LINK_MAP->insert ($exit->clone, 21, 21);
2166
2167	$exit->destroy;
2168	});
2169
2170	$LINK_MAP->{deny_save} = 1;
2171	$LINK_MAP->{deny_reset} = 1;
2172
2173	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2174	}	4184	}
2175
2176	register "<global>", __PACKAGE__;
2177		4185
2178	register_command "reload" => sub {	4186	register_command "reload" => sub {
2179	my ($who, $arg) = @_;	4187	my ($who, $arg) = @_;
2180		4188
2181	if ($who->flag (FLAG_WIZ)) {	4189	if ($who->flag (FLAG_WIZ)) {
2182	$who->message ("start of reload.");
2183	reload;
2184	$who->message ("end of reload.");	4190	$who->message ("reloading server.");
		4191	async {
		4192	$Coro::current->{desc} = "perl_reload";
		4193	reload_perl;
		4194	};
2185	}	4195	}
2186	};	4196	};
2187		4197
2188	unshift @INC, $LIBDIR;	4198	#############################################################################
2189		4199
2190	$TICK_WATCHER = Event->timer (	4200	my $bug_warning = 0;
2191	reentrant => 0,
2192	prio => 0,
2193	at => $NEXT_TICK || $TICK,
2194	data => WF_AUTOCANCEL,
2195	cb => sub {
2196	cf::server_tick; # one server iteration
2197	$RUNTIME += $TICK;
2198	$NEXT_TICK += $TICK;
2199		4201
2200	# if we are delayed by four ticks or more, skip them all	4202	sub wait_for_tick() {
2201	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4203	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2202		4204
2203	$TICK_WATCHER->at ($NEXT_TICK);	4205	$WAIT_FOR_TICK->wait;
2204	$TICK_WATCHER->start;	4206	}
		4207
		4208	sub wait_for_tick_begin() {
		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;
2205	},	4221	}
2206	);
2207		4222
2208	IO::AIO::max_poll_time $TICK * 0.2;	4223	cf::one_tick; # one server iteration
2209		4224
2210	Event->io (	4225	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2211	fd => IO::AIO::poll_fileno,
2212	poll => 'r',
2213	prio => 5,
2214	data => WF_AUTOCANCEL,
2215	cb => \&IO::AIO::poll_cb,
2216	);
2217		4226
2218	Event->timer (	4227	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2219	data => WF_AUTOCANCEL,	4228	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2220	after => 0,	4229	Coro::async_pool {
2221	interval => 10,	4230	$Coro::current->{desc} = "runtime saver";
2222	cb => sub {
2223	(Coro::unblock_sub {
2224	write_runtime	4231	write_runtime_sync
2225	or warn "ERROR: unable to write runtime file: $!";	4232	or error "ERROR: unable to write runtime file: $!";
2226	})->();	4233	};
2227	},	4234	}
2228	);	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;
2229		4358
2230	END { cf::emergency_save }	4359	END { cf::emergency_save }
2231		4360
2232	1	4361	1
2233		4362

Diff Legend

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