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

Diff Legend

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