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.143 by root, Sun Jan 7 02:39:14 2007 UTC vs.
Revision 1.594 by root, Fri Nov 9 02:50:50 2012 UTC

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

Diff Legend

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