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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.572 by root, Sun May 8 11:44:43 2011 UTC

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

Diff Legend

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