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.140 by root, Fri Jan 5 20:04:02 2007 UTC vs.
Revision 1.613 by root, Mon Nov 26 13:12:16 2012 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
3	use utf8;	25	use common::sense;
4	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
		35	use Carp ();
12		36
		37	use AnyEvent ();
		38	use AnyEvent::IO ();
		39	use AnyEvent::DNS ();
		40
13	use Coro 3.3 ();	41	use Coro ();
		42	use Coro::State;
		43	use Coro::Handle;
		44	use Coro::EV;
14	use Coro::Event;	45	use Coro::AnyEvent;
15	use Coro::Timer;	46	use Coro::Timer;
16	use Coro::Signal;	47	use Coro::Signal;
17	use Coro::Semaphore;	48	use Coro::Semaphore;
		49	use Coro::SemaphoreSet;
		50	use Coro::AnyEvent;
18	use Coro::AIO;	51	use Coro::AIO;
		52	use Coro::BDB 1.6;
		53	use Coro::Storable;
		54	use Coro::Util ();
19		55
20	use Digest::MD5;	56	use Guard ();
		57	use JSON::XS 2.01 ();
		58	use BDB ();
		59	use Data::Dumper;
21	use Fcntl;	60	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	61	use YAML::XS ();
24	use Time::HiRes;	62	use IO::AIO ();
		63	use Compress::LZF;
		64	use Digest::MD5 ();
25		65
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	66	AnyEvent::detect;
27		67
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	68	# configure various modules to our taste
29	$YAML::Syck::ImplicitUnicode = 1;	69	#
		70	$Storable::canonical = 1; # reduce rsync transfers
		71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
30		72
31	$Coro::main->prio (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 %MAP; # all maps	153	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
53	our $LINK_MAP; # the special {link} map	154	our $LOADAVG; # same thing, but with alpha-smoothing
54	our $RANDOM_MAPS = cf::localdir . "/random";	155	our $JITTER; # average jitter
55	our %EXT_CORO;	156	our $TICK_START; # for load detecting purposes
		157
		158	our @POST_INIT;
		159
		160	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		161	our $REALLY_UNLOOP; # never set to true, please :)
		162
		163	our $WAIT_FOR_TICK = new Coro::Signal;
		164	our @WAIT_FOR_TICK_BEGIN;
56		165
57	binmode STDOUT;	166	binmode STDOUT;
58	binmode STDERR;	167	binmode STDERR;
59		168
60	# read virtual server time, if available	169	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	170	unless ($RUNTIME || !-e $RUNTIMEFILE) {
62	open my $fh, "<", cf::localdir . "/runtime"	171	open my $fh, "<", $RUNTIMEFILE
63	or die "unable to read runtime file: $!";	172	or die "unable to read $RUNTIMEFILE file: $!";
64	$RUNTIME = <$fh> + 0.;	173	$RUNTIME = <$fh> + 0.;
65	}	174	}
66		175
67	mkdir cf::localdir;	176	eval "sub TICK() { $TICK } 1" or die;
68	mkdir cf::localdir . "/" . cf::playerdir;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		177
73	# a special map that is always available	178	mkdir $_
74	our $LINK_MAP;	179	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		180
75	our $EMERGENCY_POSITION;	181	our $EMERGENCY_POSITION;
76		182
		183	sub cf::map::normalise;
		184
		185	sub in_main() {
		186	$Coro::current == $Coro::main
		187	}
		188
77	#############################################################################	189	#############################################################################
78		190
		191	%REFLECT = ();
		192	for (@REFLECT) {
		193	my $reflect = JSON::XS::decode_json $_;
		194	$REFLECT{$reflect->{class}} = $reflect;
		195	}
		196
		197	# this is decidedly evil
		198	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		199
		200	#############################################################################
		201
79	=head2 GLOBAL VARIABLES	202	=head2 GLOBAL VARIABLES
80		203
81	=over 4	204	=over 4
82		205
83	=item $cf::UPTIME	206	=item $cf::UPTIME
84		207
85	The timestamp of the server start (so not actually an uptime).	208	The timestamp of the server start (so not actually an "uptime").
		209
		210	=item $cf::SERVER_TICK
		211
		212	An unsigned integer that starts at zero when the server is started and is
		213	incremented on every tick.
		214
		215	=item $cf::NOW
		216
		217	The (real) time of the last (current) server tick - updated before and
		218	after tick processing, so this is useful only as a rough "what time is it
		219	now" estimate.
		220
		221	=item $cf::TICK
		222
		223	The interval between each server tick, in seconds.
86		224
87	=item $cf::RUNTIME	225	=item $cf::RUNTIME
88		226
89	The time this server has run, starts at 0 and is increased by $cf::TICK on	227	The time this server has run, starts at 0 and is increased by $cf::TICK on
90	every server tick.	228	every server tick.
91		229
92	=item $cf::LIBDIR	230	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		231	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		232	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
93		233
94	The perl library directory, where extensions and cf-specific modules can	234	Various directories - "/etc", read-only install directory, perl-library
95	be found. It will be added to C<@INC> automatically.	235	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		236	unique-items directory, player file directory, random maps directory and
		237	database environment.
96		238
		239	=item $cf::LOADAVG
		240
		241	The current CPU load on the server (alpha-smoothed), as a value between 0
		242	(none) and 1 (overloaded), indicating how much time is spent on processing
		243	objects per tick. Healthy values are < 0.5.
		244
97	=item $cf::NOW	245	=item $cf::LOAD
98		246
99	The time of the last (current) server tick.	247	The raw value load value from the last tick.
100
101	=item $cf::TICK
102
103	The interval between server ticks, in seconds.
104		248
105	=item %cf::CFG	249	=item %cf::CFG
106		250
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	251	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108	from wherever your confdir points to.	252	from wherever your confdir points to.
109		253
		254	=item cf::wait_for_tick, cf::wait_for_tick_begin
		255
		256	These are functions that inhibit the current coroutine one tick.
		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
110	=back	290	=back
111		291
112	=cut	292	=cut
113		293
114	BEGIN {	294	sub error(@) { LOG llevError, join "", @_ }
115	*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 {
116	my $msg = join "", @_;	301	my $msg = join "", @_;
117	utf8::encode $msg;
118		302
119	$msg .= "\n"	303	$msg .= "\n"
120	unless $msg =~ /\n$/;	304	unless $msg =~ /\n$/;
121		305
122	LOG llevError, "cfperl: $msg";	306	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
123	};	307
124	}	308	LOG llevWarn, $msg;
		309	};
		310
		311	$Coro::State::DIEHOOK = sub {
		312	return unless $^S eq 0; # "eq", not "=="
		313
		314	error Carp::longmess $_[0];
		315
		316	if (in_main) {#d#
		317	error "DIEHOOK called in main context, Coro bug?\n";#d#
		318	return;#d#
		319	}#d#
		320
		321	# kill coroutine otherwise
		322	Coro::terminate
		323	};
125		324
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	325	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	326	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	327	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	328	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@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';
131	@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)
132		332
133	# 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
134	# within the Safe compartment.	334	# within the Safe compartment.
135	for my $pkg (qw(	335	for my $pkg (qw(
136	cf::global cf::attachable	336	cf::global cf::attachable
137	cf::object cf::object::player	337	cf::object cf::object::player
138	cf::client cf::player	338	cf::client cf::player
139	cf::arch cf::living	339	cf::arch cf::living
		340	cf::map cf::mapspace
140	cf::map cf::party cf::region	341	cf::party cf::region
141	)) {	342	)) {
142	no strict 'refs';
143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	343	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144	}	344	}
145		345
146	$Event::DIED = sub {	346	$EV::DIED = sub {
147	warn "error in event callback: @_";	347	warn "error in event callback: $@";
148	};	348	};
149		349
150	my %ext_pkg;	350	#############################################################################
151	my @exts;	351
152	my @hook;	352	sub fork_call(&@);
		353	sub get_slot($;$$);
		354
		355	#############################################################################
153		356
154	=head2 UTILITY FUNCTIONS	357	=head2 UTILITY FUNCTIONS
155		358
156	=over 4	359	=over 4
157		360
158	=cut	361	=item dumpval $ref
159		362
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	363	=cut
161		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
162	=item $ref = cf::from_json $json	436	=item $ref = cf::decode_json $json
163		437
164	Converts a JSON string into the corresponding perl data structure.	438	Converts a JSON string into the corresponding perl data structure.
165		439
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	440	=item $json = cf::encode_json $ref
174		441
175	Converts a perl data structure into its JSON representation.	442	Converts a perl data structure into its JSON representation.
176		443
177	=cut	444	=cut
178		445
179	sub to_json($) {	446	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	447
181	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	}
182	}	511	}
183		512
184	=item cf::lock_wait $string	513	=item cf::lock_wait $string
185		514
186	Wait until the given lock is available. See cf::lock_acquire.	515	Wait until the given lock is available. See cf::lock_acquire.
187		516
188	=item my $lock = cf::lock_acquire $string	517	=item my $lock = cf::lock_acquire $string
189		518
190	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
191	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,
192	for example when the coroutine gets canceled), the lock is automatically	521	for example when the coroutine gets canceled), the lock is automatically
193	returned.	522	returned.
194		523
		524	Locks are *not* recursive, locking from the same coro twice results in a
		525	deadlocked coro.
		526
195	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
196	uses map_find and cf::map::load uses map_load).	528	uses map_find and cf::map::load uses map_load).
197		529
198	=cut	530	=item $locked = cf::lock_active $string
199		531
200	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;
201		537
202	sub lock_wait($) {	538	sub lock_wait($) {
203	my ($key) = @_;	539	$LOCKS->wait ($_[0]);
204
205	# wait for lock, if any
206	while ($LOCK{$key}) {
207	push @{ $LOCK{$key} }, $Coro::current;
208	Coro::schedule;
209	}
210	}	540	}
211		541
212	sub lock_acquire($) {	542	sub lock_acquire($) {
213	my ($key) = @_;	543	$LOCKS->guard ($_[0])
		544	}
214		545
215	# wait, to be sure we are not locked	546	sub lock_active($) {
216	lock_wait $key;	547	$LOCKS->count ($_[0]) < 1
217
218	$LOCK{$key} = [];
219
220	Coro::guard {
221	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };
223	}
224	}	548	}
225		549
226	sub freeze_mainloop {	550	sub freeze_mainloop {
227	return unless $TICK_WATCHER->is_active;	551	tick_inhibit_inc;
228		552
229	my $guard = Coro::guard { $TICK_WATCHER->start };	553	&Guard::guard (\&tick_inhibit_dec);
230	$TICK_WATCHER->stop;	554	}
231	$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	Coro::cede;
		603
		604	my $avail = cf::till_tick;
		605
		606	for (0 .. $#SLOT_QUEUE) {
		607	if ($SLOT_QUEUE[$_][0] <= $avail) {
		608	$busy = 0;
		609	my $job = splice @SLOT_QUEUE, $_, 1, ();
		610	$job->[2]->send;
		611	goto next_job;
		612	} else {
		613	$SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
		614	}
		615	}
		616
		617	if (@SLOT_QUEUE) {
		618	wait_for_tick;
		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;
232	}	639	}
233		640
234	=item cf::async { BLOCK }	641	=item cf::async { BLOCK }
235		642
236	Currently the same as Coro::async_pool, meaning you cannot use	643	Currently the same as Coro::async_pool, meaning you cannot use
…		…
241		648
242	BEGIN { *async = \&Coro::async_pool }	649	BEGIN { *async = \&Coro::async_pool }
243		650
244	=item cf::sync_job { BLOCK }	651	=item cf::sync_job { BLOCK }
245		652
246	The design of crossfire+ requires that the main coro ($Coro::main) is	653	The design of Deliantra requires that the main coroutine ($Coro::main)
247	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
248	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.
249		657
250	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
251	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
252	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
253	fast or be very important.	661	fast or be very important.
…		…
255	=cut	663	=cut
256		664
257	sub sync_job(&) {	665	sub sync_job(&) {
258	my ($job) = @_;	666	my ($job) = @_;
259		667
260	if ($Coro::current == $Coro::main) {	668	if (in_main) {
		669	my $time = AE::time;
		670
261	# this is the main coro, too bad, we have to block	671	# this is the main coro, too bad, we have to block
262	# till the operation succeeds, freezing the server :/	672	# till the operation succeeds, freezing the server :/
263		673
264	# TODO: use suspend/resume instead	674	#LOG llevError, Carp::longmess "sync job";#d#
265	# (but this is cancel-safe)	675
266	my $freeze_guard = freeze_mainloop;	676	my $freeze_guard = freeze_mainloop;
267		677
268	my $busy = 1;	678	my $busy = 1;
269	my @res;	679	my @res;
270		680
271	(async {	681	(async {
		682	$Coro::current->desc ("sync job coro");
272	@res = eval { $job->() };	683	@res = eval { $job->() };
273	warn $@ if $@;	684	error $@ if $@;
274	undef $busy;	685	undef $busy;
275	})->prio (Coro::PRIO_MAX);	686	})->prio (Coro::PRIO_MAX);
276		687
277	while ($busy) {	688	while ($busy) {
278	unless (Coro::cede) {	689	if (Coro::nready) {
279	Coro::nready ? Event::one_event 0 : Event::one_event;
280	Coro::cede_notself unless Coro::cede;	690	Coro::cede_notself;
		691	} else {
		692	EV::loop EV::LOOP_ONESHOT;
281	}	693	}
282	}	694	}
		695
		696	my $time = AE::time - $time;
		697
		698	$TICK_START += $time; # do not account sync jobs to server load
283		699
284	wantarray ? @res : $res[0]	700	wantarray ? @res : $res[0]
285	} else {	701	} else {
286	# we are in another coroutine, how wonderful, everything just works	702	# we are in another coroutine, how wonderful, everything just works
287		703
…		…
289	}	705	}
290	}	706	}
291		707
292	=item $coro = cf::async_ext { BLOCK }	708	=item $coro = cf::async_ext { BLOCK }
293		709
294	Like async, but this coro is automcatially being canceled when the	710	Like async, but this coro is automatically being canceled when the
295	extension calling this is being unloaded.	711	extension calling this is being unloaded.
296		712
297	=cut	713	=cut
298		714
299	sub async_ext(&) {	715	sub async_ext(&) {
…		…
307	$EXT_CORO{$coro+0} = $coro;	723	$EXT_CORO{$coro+0} = $coro;
308		724
309	$coro	725	$coro
310	}	726	}
311		727
312	sub write_runtime {	728	=item fork_call { }, @args
313	my $runtime = cf::localdir . "/runtime";
314		729
315	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	730	Executes the given code block with the given arguments in a seperate
316	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.
317		734
318	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	735	=cut
319	(aio_write $fh, 0, (length $value), $value, 0) <= 0
320	and return;
321		736
322	aio_fsync $fh	737	sub post_fork {
323	and return;	738	reset_signals;
		739	}
324		740
325	close $fh	741	sub fork_call(&@) {
326	or return;	742	my ($cb, @args) = @_;
327		743
328	aio_rename "$runtime~", $runtime	744	my @res = Coro::Util::fork_eval {
329	and return;	745	cf::post_fork;
		746	&$cb
		747	} @args;
330		748
		749	wantarray ? @res : $res[-1]
		750	}
		751
		752	sub objinfo {
331	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 });
332	}	927	}
333		928
334	=back	929	=back
335		930
336	=cut	931	=cut
337		932
338	#############################################################################	933	#############################################################################
339		934
340	package cf::path;
341
342	sub new {
343	my ($class, $path, $base) = @_;
344
345	$path = $path->as_string if ref $path;
346
347	my $self = bless { }, $class;
348
349	# {... are special paths that are not touched
350	# ?xxx/... are special absolute paths
351	# ?random/... random maps
352	# /! non-realised random map exit
353	# /... normal maps
354	# ~/... per-player maps without a specific player (DO NOT USE)
355	# ~user/... per-player map of a specific user
356
357	if ($path =~ /^{/) {
358	# fine as it is
359	} elsif ($path =~ s{^\?random/}{}) {
360	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
361	$self->{random} = cf::from_json $data;
362	} else {
363	if ($path =~ s{^~([^/]+)?}{}) {
364	$self->{user_rel} = 1;
365
366	if (defined $1) {
367	$self->{user} = $1;
368	} elsif ($base =~ m{^~([^/]+)/}) {
369	$self->{user} = $1;
370	} else {
371	warn "cannot resolve user-relative path without user <$path,$base>\n";
372	}
373	} elsif ($path =~ /^\//) {
374	# already absolute
375	} else {
376	$base =~ s{[^/]+/?$}{};
377	return $class->new ("$base/$path");
378	}
379
380	for ($path) {
381	redo if s{/\.?/}{/};
382	redo if s{/[^/]+/\.\./}{/};
383	}
384	}
385
386	$self->{path} = $path;
387
388	$self
389	}
390
391	# the name / primary key / in-game path
392	sub as_string {
393	my ($self) = @_;
394
395	$self->{user_rel} ? "~$self->{user}$self->{path}"
396	: $self->{random} ? "?random/$self->{path}"
397	: $self->{path}
398	}
399
400	# the displayed name, this is a one way mapping
401	sub visible_name {
402	my ($self) = @_;
403
404	# if (my $rmp = $self->{random}) {
405	# # todo: be more intelligent about this
406	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
407	# } else {
408	$self->as_string
409	# }
410	}
411
412	# escape the /'s in the path
413	sub _escaped_path {
414	# ∕ is U+2215
415	(my $path = $_[0]{path}) =~ s/\//∕/g;
416	$path
417	}
418
419	# the original (read-only) location
420	sub load_path {
421	my ($self) = @_;
422
423	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
424	}
425
426	# the temporary/swap location
427	sub save_path {
428	my ($self) = @_;
429
430	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
431	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
432	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
433	}
434
435	# the unique path, might be eq to save_path
436	sub uniq_path {
437	my ($self) = @_;
438
439	$self->{user_rel} || $self->{random}
440	? undef
441	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
442	}
443
444	# return random map parameters, or undef
445	sub random_map_params {
446	my ($self) = @_;
447
448	$self->{random}
449	}
450
451	# this is somewhat ugly, but style maps do need special treatment
452	sub is_style_map {
453	$_[0]{path} =~ m{^/styles/}
454	}
455
456	package cf;
457
458	#############################################################################
459
460	=head2 ATTACHABLE OBJECTS	935	=head2 ATTACHABLE OBJECTS
461		936
462	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
463	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")
464	to it. All such attachable objects support the following methods.	939	to it. All such attachable objects support the following methods.
465		940
466	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>
467	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
468	crossfire+).	943	Deliantra).
469		944
470	=over 4	945	=over 4
471		946
472	=item $attachable->attach ($attachment, key => $value...)	947	=item $attachable->attach ($attachment, key => $value...)
473		948
…		…
517	=item cf::CLASS::attachment $name, ...	992	=item cf::CLASS::attachment $name, ...
518		993
519	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
520	given CLASS can refer to this attachment.	995	given CLASS can refer to this attachment.
521		996
522	Some classes such as crossfire maps and objects can specify attachments	997	Some classes such as deliantra maps and objects can specify attachments
523	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.
524		999
525	These calls expect any number of the following handler/hook descriptions:	1000	These calls expect any number of the following handler/hook descriptions:
526		1001
527	=over 4	1002	=over 4
…		…
587	our @CB_TYPE = (); # registry for type (cf-object class) based events	1062	our @CB_TYPE = (); # registry for type (cf-object class) based events
588	our @CB_MAP = ();	1063	our @CB_MAP = ();
589		1064
590	my %attachment;	1065	my %attachment;
591		1066
		1067	sub cf::attachable::thawer_merge {
		1068	# simply override everything except _meta
		1069	local $_[0]{_meta};
		1070	%{$_[0]} = %{$_[1]};
		1071	}
		1072
592	sub _attach_cb($$$$) {	1073	sub _attach_cb($$$$) {
593	my ($registry, $event, $prio, $cb) = @_;	1074	my ($registry, $event, $prio, $cb) = @_;
594		1075
595	use sort 'stable';	1076	use sort 'stable';
596		1077
…		…
630	$registry = $CB_TYPE[$object_type] ||= [];	1111	$registry = $CB_TYPE[$object_type] ||= [];
631		1112
632	} elsif ($type eq "subtype") {	1113	} elsif ($type eq "subtype") {
633	defined $object_type or Carp::croak "subtype specified without type";	1114	defined $object_type or Carp::croak "subtype specified without type";
634	my $object_subtype = shift @arg;	1115	my $object_subtype = shift @arg;
635	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1116	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
636		1117
637	} elsif ($type eq "package") {	1118	} elsif ($type eq "package") {
638	my $pkg = shift @arg;	1119	my $pkg = shift @arg;
639		1120
640	while (my ($name, $id) = each %cb_id) {	1121	while (my ($name, $id) = each %cb_id) {
…		…
645		1126
646	} elsif (exists $cb_id{$type}) {	1127	} elsif (exists $cb_id{$type}) {
647	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1128	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
648		1129
649	} elsif (ref $type) {	1130	} elsif (ref $type) {
650	warn "attaching objects not supported, ignoring.\n";	1131	error "attaching objects not supported, ignoring.\n";
651		1132
652	} else {	1133	} else {
653	shift @arg;	1134	shift @arg;
654	warn "attach argument '$type' not supported, ignoring.\n";	1135	error "attach argument '$type' not supported, ignoring.\n";
655	}	1136	}
656	}	1137	}
657	}	1138	}
658		1139
659	sub _object_attach {	1140	sub _object_attach {
…		…
669	_attach $registry, $klass, @attach;	1150	_attach $registry, $klass, @attach;
670	}	1151	}
671		1152
672	$obj->{$name} = \%arg;	1153	$obj->{$name} = \%arg;
673	} else {	1154	} else {
674	warn "object uses attachment '$name' that is not available, postponing.\n";	1155	info "object uses attachment '$name' which is not available, postponing.\n";
675	}	1156	}
676		1157
677	$obj->{_attachment}{$name} = undef;	1158	$obj->{_attachment}{$name} = undef;
678	}	1159	}
679		1160
…		…
681	if (ref $_[0]) {	1162	if (ref $_[0]) {
682	_object_attach @_;	1163	_object_attach @_;
683	} else {	1164	} else {
684	_attach shift->_attach_registry, @_;	1165	_attach shift->_attach_registry, @_;
685	}	1166	}
		1167	_recalc_want;
686	};	1168	};
687		1169
688	# all those should be optimised	1170	# all those should be optimised
689	sub cf::attachable::detach {	1171	sub cf::attachable::detach {
690	my ($obj, $name) = @_;	1172	my ($obj, $name) = @_;
…		…
693	delete $obj->{_attachment}{$name};	1175	delete $obj->{_attachment}{$name};
694	reattach ($obj);	1176	reattach ($obj);
695	} else {	1177	} else {
696	Carp::croak "cannot, currently, detach class attachments";	1178	Carp::croak "cannot, currently, detach class attachments";
697	}	1179	}
		1180	_recalc_want;
698	};	1181	};
699		1182
700	sub cf::attachable::attached {	1183	sub cf::attachable::attached {
701	my ($obj, $name) = @_;	1184	my ($obj, $name) = @_;
702		1185
…		…
717	";	1200	";
718	die if $@;	1201	die if $@;
719	}	1202	}
720		1203
721	our $override;	1204	our $override;
722	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?
723		1206
724	sub override {	1207	sub override {
725	$override = 1;	1208	$override = 1;
726	@invoke_results = ();	1209	@INVOKE_RESULTS = (@_);
727	}	1210	}
728		1211
729	sub do_invoke {	1212	sub do_invoke {
730	my $event = shift;	1213	my $event = shift;
731	my $callbacks = shift;	1214	my $callbacks = shift;
732		1215
733	@invoke_results = ();	1216	@INVOKE_RESULTS = ();
734		1217
735	local $override;	1218	local $override;
736		1219
737	for (@$callbacks) {	1220	for (@$callbacks) {
738	eval { &{$_->[1]} };	1221	eval { &{$_->[1]} };
739		1222
740	if ($@) {	1223	if ($@) {
741	warn "$@";
742	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1224	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
743	override;	1225	override;
744	}	1226	}
745		1227
746	return 1 if $override;	1228	return 1 if $override;
747	}	1229	}
748		1230
749	0	1231	0
750	}	1232	}
751		1233
752	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
753		1235
754	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1236	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
755		1237
756	Generate an object-specific event with the given arguments.	1238	Generate an object-specific event with the given arguments.
757		1239
758	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
759	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
760	results (if you must, access C<@cf::invoke_results> directly).	1242	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
761		1243
762	=back	1244	=back
763		1245
764	=cut	1246	=cut
765		1247
766	#############################################################################	1248	#############################################################################
767	# 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	}
768		1292
769	sub reattach {	1293	sub reattach {
770	# basically do the same as instantiate, without calling instantiate	1294	# basically do the same as instantiate, without calling instantiate
771	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
772		1299
773	my $registry = $obj->registry;	1300	my $registry = $obj->registry;
774		1301
775	@$registry = ();	1302	@$registry = ();
776		1303
…		…
781	for (@$attach) {	1308	for (@$attach) {
782	my ($klass, @attach) = @$_;	1309	my ($klass, @attach) = @$_;
783	_attach $registry, $klass, @attach;	1310	_attach $registry, $klass, @attach;
784	}	1311	}
785	} else {	1312	} else {
786	warn "object uses attachment '$name' that is not available, postponing.\n";	1313	info "object uses attachment '$name' that is not available, postponing.\n";
787	}	1314	}
788	}	1315	}
789	}	1316	}
790		1317
791	cf::attachable->attach (	1318	cf::attachable->attach (
792	prio => -1000000,	1319	prio => -1000000,
793	on_instantiate => sub {	1320	on_instantiate => sub {
794	my ($obj, $data) = @_;	1321	my ($obj, $data) = @_;
795		1322
796	$data = from_json $data;	1323	$data = decode_json $data;
797		1324
798	for (@$data) {	1325	for (@$data) {
799	my ($name, $args) = @$_;	1326	my ($name, $args) = @$_;
800		1327
801	$obj->attach ($name, %{$args || {} });	1328	$obj->attach ($name, %{$args || {} });
…		…
817	sub object_freezer_save {	1344	sub object_freezer_save {
818	my ($filename, $rdata, $objs) = @_;	1345	my ($filename, $rdata, $objs) = @_;
819		1346
820	sync_job {	1347	sync_job {
821	if (length $$rdata) {	1348	if (length $$rdata) {
		1349	utf8::decode (my $decname = $filename);
822	warn sprintf "saving %s (%d,%d)\n",	1350	trace sprintf "saving %s (%d,%d)\n",
823	$filename, length $$rdata, scalar @$objs;	1351	$decname, length $$rdata, scalar @$objs
		1352	if $VERBOSE_IO;
824		1353
825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1354	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826	chmod SAVE_MODE, $fh;	1355	aio_chmod $fh, SAVE_MODE;
827	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;
828	aio_fsync $fh;	1359	aio_fsync $fh;
		1360	}
829	close $fh;	1361	aio_close $fh;
830		1362
831	if (@$objs) {	1363	if (@$objs) {
832	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) {
833	chmod SAVE_MODE, $fh;	1365	aio_chmod $fh, SAVE_MODE;
834	my $data = Storable::nfreeze { version => 1, objs => $objs };	1366	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
835	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;
836	aio_fsync $fh;	1370	aio_fsync $fh;
		1371	}
837	close $fh;	1372	aio_close $fh;
838	aio_rename "$filename.pst~", "$filename.pst";	1373	aio_rename "$filename.pst~", "$filename.pst";
839	}	1374	}
840	} else {	1375	} else {
841	aio_unlink "$filename.pst";	1376	aio_unlink "$filename.pst";
842	}	1377	}
843		1378
844	aio_rename "$filename~", $filename;	1379	aio_rename "$filename~", $filename;
		1380
		1381	$filename =~ s%/[^/]+$%%;
		1382	aio_pathsync $filename if $cf::USE_FSYNC;
845	} else {	1383	} else {
846	warn "FATAL: $filename~: $!\n";	1384	error "unable to save objects: $filename~: $!\n";
847	}	1385	}
848	} else {	1386	} else {
849	aio_unlink $filename;	1387	aio_unlink $filename;
850	aio_unlink "$filename.pst";	1388	aio_unlink "$filename.pst";
851	}	1389	}
852	}	1390	};
853	}	1391	}
854		1392
855	sub object_freezer_as_string {	1393	sub object_freezer_as_string {
856	my ($rdata, $objs) = @_;	1394	my ($rdata, $objs) = @_;
857		1395
…		…
869	or return;	1407	or return;
870		1408
871	unless (aio_stat "$filename.pst") {	1409	unless (aio_stat "$filename.pst") {
872	(aio_load "$filename.pst", $av) >= 0	1410	(aio_load "$filename.pst", $av) >= 0
873	or return;	1411	or return;
		1412
874	$av = eval { (Storable::thaw $av)->{objs} };	1413	my $st = eval { Coro::Storable::thaw $av };
		1414	$av = $st->{objs};
875	}	1415	}
876		1416
		1417	utf8::decode (my $decname = $filename);
877	warn sprintf "loading %s (%d)\n",	1418	trace sprintf "loading %s (%d,%d)\n",
878	$filename, length $data, scalar @{$av || []};#d#	1419	$decname, length $data, scalar @{$av || []}
		1420	if $VERBOSE_IO;
		1421
879	return ($data, $av);	1422	($data, $av)
880	}	1423	}
		1424
		1425	=head2 COMMAND CALLBACKS
		1426
		1427	=over 4
		1428
		1429	=cut
881		1430
882	#############################################################################	1431	#############################################################################
883	# command handling &c	1432	# command handling &c
884		1433
885	=item cf::register_command $name => \&callback($ob,$args);	1434	=item cf::register_command $name => \&callback($ob,$args)
886		1435
887	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
888	$name.	1437	$name.
889		1438
890	=cut	1439	=cut
…		…
896	#warn "registering command '$name/$time' to '$caller'";	1445	#warn "registering command '$name/$time' to '$caller'";
897		1446
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1447	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1448	}
900		1449
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1450	=item cf::register_extcmd $name => \&callback($pl,@args)
902		1451
903	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.
904		1457
905	If the callback returns something, it is sent back as if reply was being	1458	The values will be sent back to the client.
906	called.
907		1459
908	=cut	1460	=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
909		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
910	sub register_extcmd {	1482	sub register_extcmd($$) {
911	my ($name, $cb) = @_;	1483	my ($name, $cb) = @_;
912		1484
913	my $caller = caller;
914	#warn "registering extcmd '$name' to '$caller'";
915
916	$EXTCMD{$name} = [$cb, $caller];	1485	$EXTCMD{$name} = $cb;
917	}	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 ();
918		1507
919	cf::player->attach (	1508	cf::player->attach (
920	on_command => sub {	1509	on_unknown_command => sub {
921	my ($pl, $name, $params) = @_;	1510	my ($pl, $name, $params) = @_;
922		1511
923	my $cb = $COMMAND{$name}	1512	my $cb = $COMMAND{$name}
924	or return;	1513	or return;
925		1514
…		…
930	cf::override;	1519	cf::override;
931	},	1520	},
932	on_extcmd => sub {	1521	on_extcmd => sub {
933	my ($pl, $buf) = @_;	1522	my ($pl, $buf) = @_;
934		1523
935	my $msg = eval { from_json $buf };	1524	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
936		1525
937	if (ref $msg) {	1526	if (ref $msg) {
		1527	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1528
938	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1529	if (my $cb = $EXTACMD{$type}) {
939	if (my %reply = $cb->[0]->($pl, $msg)) {	1530	$cb->(
940	$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);
941	}	1543	}
		1544
		1545	$pl->ext_msg ("reply-$reply", @reply)
		1546	if $reply;
942	}	1547	}
		1548
943	} else {	1549	} else {
944	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1550	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
945	}	1551	}
946		1552
947	cf::override;	1553	cf::override;
948	},	1554	},
949	);	1555	);
950		1556
951	sub register {	1557	# "readahead" all extensions
952	my ($base, $pkg) = @_;
953
954	#TODO
955	}
956
957	sub load_extension {	1558	sub cache_extensions {
958	my ($path) = @_;	1559	my $grp = IO::AIO::aio_group;
959		1560
960	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1561	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
961	my $base = $1;	1562	for (grep /\.ext$/, @{$_[0]}) {
962	my $pkg = $1;	1563	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
963	$pkg =~ s/[^[:word:]]/_/g;
964	$pkg = "ext::$pkg";
965
966	warn "loading '$path' into '$pkg'\n";
967
968	open my $fh, "<:utf8", $path
969	or die "$path: $!";
970
971	my $source =
972	"package $pkg; use strict; use utf8;\n"
973	. "#line 1 \"$path\"\n{\n"
974	. (do { local $/; <$fh> })
975	. "\n};\n1";
976
977	eval $source
978	or die $@ ? "$path: $@\n"
979	: "extension disabled.\n";
980
981	push @exts, $pkg;
982	$ext_pkg{$base} = $pkg;
983
984	# no strict 'refs';
985	# @{"$pkg\::ISA"} = ext::;
986
987	register $base, $pkg;
988	}
989
990	sub unload_extension {
991	my ($pkg) = @_;
992
993	warn "removing extension $pkg\n";
994
995	# remove hooks
996	#TODO
997	# for my $idx (0 .. $#PLUGIN_EVENT) {
998	# delete $hook[$idx]{$pkg};
999	# }
1000
1001	# remove commands
1002	for my $name (keys %COMMAND) {
1003	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1004
1005	if (@cb) {
1006	$COMMAND{$name} = \@cb;
1007	} else {
1008	delete $COMMAND{$name};
1009	}	1564	}
1010	}	1565	};
1011		1566
1012	# remove extcmds	1567	$grp
1013	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1568	}
1014	delete $EXTCMD{$name};
1015	}
1016		1569
1017	if (my $cb = $pkg->can ("unload")) {	1570	sub _ext_cfg_reg($$$$) {
1018	eval {	1571	my ($rvar, $varname, $cfgname, $default) = @_;
1019	$cb->($pkg);
1020	1
1021	} or warn "$pkg unloaded, but with errors: $@";
1022	}
1023		1572
1024	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;
1025	}	1579	}
1026		1580
1027	sub load_extensions {	1581	sub load_extensions {
		1582	info "loading extensions...";
		1583
		1584	%EXT_CFG = ();
		1585
		1586	cf::sync_job {
		1587	my %todo;
		1588
1028	for my $ext (<$LIBDIR/*.ext>) {	1589	for my $path (<$LIBDIR/*.ext>) {
1029	next unless -r $ext;	1590	next unless -r $path;
1030	eval {	1591
1031	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	}
1032	1	1664	}
1033	} 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	}
1034	}	1677	};
1035	}	1678	}
1036		1679
1037	#############################################################################	1680	#############################################################################
1038	# load/save/clean perl data associated with a map
1039		1681
1040	*cf::mapsupport::on_clean = sub {	1682	=back
		1683
		1684	=head2 CORE EXTENSIONS
		1685
		1686	Functions and methods that extend core deliantra objects.
		1687
		1688	=cut
		1689
		1690	package cf::player;
		1691
		1692	use Coro::AIO;
		1693
		1694	=head3 cf::player
		1695
		1696	=over 4
		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
		1712	=item cf::player::find $login
		1713
		1714	Returns the given player object, loading it if necessary (might block).
		1715
		1716	=cut
		1717
		1718	sub playerdir($) {
		1719	"$PLAYERDIR/"
		1720	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1721	}
		1722
		1723	sub path($) {
		1724	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1725
		1726	(playerdir $login) . "/playerdata"
		1727	}
		1728
		1729	sub find_active($) {
		1730	$cf::PLAYER{$_[0]}
		1731	and $cf::PLAYER{$_[0]}->active
		1732	and $cf::PLAYER{$_[0]}
		1733	}
		1734
		1735	sub exists($) {
1041	my ($map) = @_;	1736	my ($login) = @_;
1042		1737
1043	my $path = $map->tmpname;	1738	$cf::PLAYER{$login}
1044	defined $path or return;	1739	or !aio_stat path $login
1045
1046	unlink "$path.pst";
1047	};
1048
1049	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1050
1051	#############################################################################
1052	# load/save perl data associated with player->ob objects
1053
1054	sub all_objects(@) {
1055	@_, map all_objects ($_->inv), @_
1056	}	1740	}
1057		1741
1058	# TODO: compatibility cruft, remove when no longer needed	1742	sub find($) {
		1743	return $cf::PLAYER{$_[0]} || do {
		1744	my $login = $_[0];
		1745
		1746	my $guard = cf::lock_acquire "user_find:$login";
		1747
		1748	$cf::PLAYER{$_[0]} || do {
		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
		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;
		1764	$cf::PLAYER{$login} = $pl
		1765	}
		1766	}
		1767	}
		1768
1059	cf::player->attach (	1769	cf::player->attach (
1060	on_load => sub {	1770	on_load => sub {
1061	my ($pl, $path) = @_;	1771	my ($pl, $path) = @_;
1062		1772
1063	for my $o (all_objects $pl->ob) {	1773	# restore slots saved in save, below
1064	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1774	my $slots = delete $pl->{_slots};
1065	$o->set_ob_key_value ("_perl_data");
1066		1775
1067	%$o = %{ Storable::thaw pack "H*", $value };	1776	$pl->ob->current_weapon ($slots->[0]);
1068	}	1777	$pl->combat_ob ($slots->[1]);
1069	}	1778	$pl->ranged_ob ($slots->[2]);
1070	},	1779	},
1071	);	1780	);
1072		1781
1073	#############################################################################	1782	sub save($) {
		1783	my ($pl) = @_;
1074		1784
1075	=head2 CORE EXTENSIONS	1785	return if $pl->{deny_save};
1076		1786
1077	Functions and methods that extend core crossfire objects.	1787	my $path = path $pl;
		1788	my $guard = cf::lock_acquire "user_save:$path";
1078		1789
1079	=head3 cf::player	1790	return if $pl->{deny_save};
		1791
		1792	aio_mkdir playerdir $pl, 0770;
		1793	$pl->{last_save} = $cf::RUNTIME;
		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
		1800	$pl->save_pl ($path);
		1801	cf::cede_to_tick;
		1802	}
		1803
		1804	sub new($) {
		1805	my ($login) = @_;
		1806
		1807	my $self = create;
		1808
		1809	$self->ob->name ($login);
		1810	$self->{deny_save} = 1;
		1811
		1812	$cf::PLAYER{$login} = $self;
		1813
		1814	$self
		1815	}
		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
		1834	sub quit_character {
		1835	my ($pl) = @_;
		1836
		1837	my $name = $pl->ob->name;
		1838
		1839	$pl->{deny_save} = 1;
		1840	$pl->password ("*"); # this should lock out the player until we have nuked the dir
		1841
		1842	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
		1843	$pl->deactivate;
		1844
		1845	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1846	$pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
		1847	ext::highscore::check ($pl->ob);
		1848
		1849	$pl->ns->destroy if $pl->ns;
		1850
		1851	my $path = playerdir $pl;
		1852	my $temp = "$path~$cf::RUNTIME~deleting~";
		1853	aio_rename $path, $temp;
		1854	delete $cf::PLAYER{$pl->ob->name};
		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
		1862	IO::AIO::aio_rmtree $temp;
		1863	}
		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
		1944	=item $player->ext_msg ($type, @msg)
		1945
		1946	Sends an ext event to the client.
		1947
		1948	=cut
		1949
		1950	sub ext_msg($$@) {
		1951	my ($self, $type, @msg) = @_;
		1952
		1953	$self->ns->ext_msg ($type, @msg);
		1954	}
		1955
		1956	=head3 cf::region
1080		1957
1081	=over 4	1958	=over 4
1082		1959
1083	=item cf::player::exists $login
1084
1085	Returns true when the given account exists.
1086
1087	=cut	1960	=cut
1088		1961
1089	sub cf::player::exists($) {	1962	package cf::region;
1090	cf::player::find $_[0]
1091	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1092	}
1093		1963
1094	=item $player->ext_reply ($msgid, $msgtype, %msg)	1964	=item cf::region::find_by_path $path
1095		1965
1096	Sends an ext reply to the player.	1966	Tries to decuce the likely region for a map knowing only its path.
1097		1967
1098	=cut	1968	=cut
1099		1969
1100	sub cf::player::ext_reply($$$%) {	1970	sub find_by_path($) {
1101	my ($self, $id, %msg) = @_;	1971	my ($path) = @_;
1102		1972
1103	$msg{msgid} = $id;	1973	$path =~ s/^~[^\/]*//; # skip ~login
1104		1974
1105	$self->send ("ext " . to_json \%msg);	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
1106	}	1985	}
1107		1986
1108	=back	1987	=back
1109
1110		1988
1111	=head3 cf::map	1989	=head3 cf::map
1112		1990
1113	=over 4	1991	=over 4
1114		1992
…		…
1117	package cf::map;	1995	package cf::map;
1118		1996
1119	use Fcntl;	1997	use Fcntl;
1120	use Coro::AIO;	1998	use Coro::AIO;
1121		1999
		2000	use overload
		2001	'""' => \&as_string,
		2002	fallback => 1;
		2003
1122	our $MAX_RESET = 3600;	2004	our $MAX_RESET = 3600;
1123	our $DEFAULT_RESET = 3000;	2005	our $DEFAULT_RESET = 3000;
1124		2006
1125	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 {
1126	my ($path, $rmp) = @_;	2046	my ($path, $base) = @_;
1127		2047
1128	# mit "rum" bekleckern, nicht	2048	$path = "$path"; # make sure it's a string
1129	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
1130	$path,	2077	$path
1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134	$rmp->{exit_on_final_map},
1135	$rmp->{xsize}, $rmp->{ysize},
1136	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1138	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1139	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141	(cf::region::find $rmp->{region})
1142	}	2078	}
1143		2079
1144	# and all this just because we cannot iterate over	2080	sub new_from_path {
1145	# all maps in C++...	2081	my (undef, $path, $base) = @_;
1146	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 {
1147	my ($change) = @_;	2102	my ($self) = @_;
1148		2103
1149	$_->change_map_light ($change)	2104	$self
1150	for grep $_->outdoor, values %cf::MAP;
1151	}	2105	}
1152		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
1153	sub try_load_header($) {	2157	sub load_header_from($) {
1154	my ($path) = @_;	2158	my ($self, $path) = @_;
1155		2159
1156	utf8::encode $path;	2160	utf8::encode $path;
1157	aio_open $path, O_RDONLY, 0	2161	my $f = new_from_file cf::object::thawer $path
1158	or return;	2162	or return;
1159		2163
1160	my $map = cf::map::new	2164	$self->_load_header ($f)
1161	or return;	2165	or return;
1162		2166
1163	# for better error messages only, will be overwritten	2167	local $MAP_LOADING{$self->{path}} = $self;
1164	$map->path ($path);	2168	$f->resolve_delayed_derefs;
1165		2169
1166	$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
1167	or return;	2217	or return;
		2218	$self->prepare_orig;
		2219	}
1168		2220
1169	$map->{load_path} = $path;	2221	$self->{deny_reset} = 1
		2222	if $self->no_reset;
1170		2223
1171	$map	2224	$self->default_region (cf::region::find_by_path $self->{path})
		2225	unless $self->default_region;
		2226
		2227	1
1172	}	2228	}
1173		2229
1174	sub find;	2230	sub find;
1175	sub find {	2231	sub find {
1176	my ($path, $origin) = @_;	2232	my ($path, $origin) = @_;
1177		2233
1178	#warn "find<$path,$origin>\n";#d#	2234	cf::cede_to_tick;
1179		2235
1180	$path = new cf::path $path, $origin && $origin->path;	2236	$path = normalise $path, $origin;
1181	my $key = $path->as_string;
1182		2237
1183	cf::lock_wait "map_find:$key";	2238	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1184
1185	$cf::MAP{$key} || do {
1186	my $guard = cf::lock_acquire "map_find:$key";	2239	my $guard2 = cf::lock_acquire "map_find:$path";
1187		2240
1188	# do it the slow way	2241	$cf::MAP{$path} || do {
1189	my $map = try_load_header $path->save_path;	2242	my $map = new_from_path cf::map $path
1190
1191	Coro::cede;
1192
1193	if ($map) {
1194	$map->last_access ((delete $map->{last_access})
1195	|| $cf::RUNTIME); #d#
1196	# safety
1197	$map->{instantiate_time} = $cf::RUNTIME
1198	if $map->{instantiate_time} > $cf::RUNTIME;
1199	} else {
1200	if (my $rmp = $path->random_map_params) {
1201	$map = generate_random_map $key, $rmp;
1202	} else {
1203	$map = try_load_header $path->load_path;
1204	}
1205
1206	$map or return;	2243	or return;
1207		2244
1208	$map->{load_original} = 1;
1209	$map->{instantiate_time} = $cf::RUNTIME;
1210	$map->last_access ($cf::RUNTIME);
1211	$map->instantiate;
1212
1213	# per-player maps become, after loading, normal maps
1214	$map->per_player (0) if $path->{user_rel};
1215	}
1216
1217	$map->path ($key);
1218	$map->{path} = $path;
1219	$map->{last_save} = $cf::RUNTIME;	2245	$map->{last_save} = $cf::RUNTIME;
1220		2246
1221	Coro::cede;	2247	$map->load_header
		2248	or return;
1222		2249
1223	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;
1224	$map->reset;	2255	$map->reset;
1225	undef $guard;
1226	$map = find $path	2256	return find $path;
1227	or return;
1228	}	2257	}
1229		2258
1230	$cf::MAP{$key} = $map	2259	$cf::MAP{$path} = $map
1231	}	2260	}
1232	}	2261	}
		2262
		2263	sub pre_load { }
		2264	#sub post_load { } # XS
1233		2265
1234	sub load {	2266	sub load {
1235	my ($self) = @_;	2267	my ($self) = @_;
1236		2268
		2269	local $self->{deny_reset} = 1; # loading can take a long time
		2270
1237	my $path = $self->{path};	2271	my $path = $self->{path};
		2272
		2273	{
1238	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2274	my $guard = cf::lock_acquire "map_data:$path";
1239		2275
1240	return if $self->in_memory != cf::MAP_SWAPPED;	2276	return unless $self->valid;
		2277	return unless $self->state == cf::MAP_SWAPPED;
1241		2278
1242	$self->in_memory (cf::MAP_LOADING);
1243
1244	$self->alloc;	2279	$self->alloc;
1245	$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)
1246	or return;	2288	or return;
1247		2289
1248	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2290	$self->post_load_original
1249	if delete $self->{load_original};	2291	if delete $self->{load_original};
1250		2292
1251	if (my $uniq = $path->uniq_path) {	2293	if (my $uniq = $self->uniq_path) {
1252	utf8::encode $uniq;	2294	utf8::encode $uniq;
1253	if (aio_open $uniq, O_RDONLY, 0) {	2295	unless (aio_stat $uniq) {
		2296	if (my $f = new_from_file cf::object::thawer $uniq) {
1254	$self->clear_unique_items;	2297	$self->clear_unique_items;
1255	$self->load_objects ($uniq, 0);	2298	$self->_load_objects ($f);
		2299	$f->resolve_delayed_derefs;
		2300	}
		2301	}
1256	}	2302	}
1257	}
1258		2303
1259	Coro::cede;	2304	$f->resolve_delayed_derefs;
		2305	} else {
		2306	$self->post_load_original
		2307	if delete $self->{load_original};
		2308	}
1260		2309
		2310	$self->state (cf::MAP_INACTIVE);
		2311
		2312	cf::cede_to_tick;
1261	# now do the right thing for maps	2313	# now do the right thing for maps
1262	$self->link_multipart_objects;	2314	$self->link_multipart_objects;
1263
1264	if ($self->{path}->is_style_map) {
1265	$self->{deny_save} = 1;
1266	$self->{deny_reset} = 1;
1267	} else {
1268	$self->fix_auto_apply;
1269	$self->decay_objects;
1270	$self->update_buttons;
1271	$self->set_darkness_map;
1272	$self->difficulty ($self->estimate_difficulty)	2315	$self->difficulty ($self->estimate_difficulty)
1273	unless $self->difficulty;	2316	unless $self->difficulty;
1274	$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
1275	}	2333	1
		2334	}
1276		2335
1277	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) = @_;
1278		2341
1279	$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
1280	}	2349	}
1281		2350
1282	sub find_sync {	2351	sub find_sync {
1283	my ($path, $origin) = @_;	2352	my ($path, $origin) = @_;
1284		2353
1285	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
1286	}	2359	}
1287		2360
1288	sub do_load_sync {	2361	sub do_load_sync {
1289	my ($map) = @_;	2362	my ($map) = @_;
1290		2363
1291	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	}
1292	}	2434	}
1293		2435
1294	sub save {	2436	sub save {
1295	my ($self) = @_;	2437	my ($self) = @_;
1296		2438
1297	my $lock = cf::lock_acquire "map_data:" . $self->path;	2439	my $lock = cf::lock_acquire "map_data:$self->{path}";
1298		2440
1299	$self->{last_save} = $cf::RUNTIME;	2441	$self->_save;
1300
1301	return unless $self->dirty;
1302
1303	my $save = $self->{path}->save_path; utf8::encode $save;
1304	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1305
1306	$self->{load_path} = $save;
1307
1308	return if $self->{deny_save};
1309
1310	local $self->{last_access} = $self->last_access;#d#
1311
1312	if ($uniq) {
1313	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1314	$self->save_objects ($uniq, cf::IO_UNIQUES);
1315	} else {
1316	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1317	}
1318	}	2442	}
1319		2443
1320	sub swap_out {	2444	sub swap_out {
1321	my ($self) = @_;	2445	my ($self) = @_;
1322		2446
1323	# save first because save cedes
1324	$self->save;
1325
1326	my $lock = cf::lock_acquire "map_data:" . $self->path;	2447	my $lock = cf::lock_acquire "map_data:$self->{path}";
1327		2448
		2449	return if !$self->linkable;
		2450	return if $self->{deny_save};
1328	return if $self->players;	2451	return if $self->players;
1329	return if $self->in_memory != cf::MAP_IN_MEMORY;
1330	return if $self->{deny_save};
1331		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
1332	$self->clear;	2462	$self->clear;
1333	$self->in_memory (cf::MAP_SWAPPED);
1334	}	2463	}
1335		2464
1336	sub reset_at {	2465	sub reset_at {
1337	my ($self) = @_;	2466	my ($self) = @_;
1338		2467
1339	# TODO: safety, remove and allow resettable per-player maps	2468	# TODO: safety, remove and allow resettable per-player maps
1340	return 1e99 if $self->{path}{user_rel};
1341	return 1e99 if $self->{deny_reset};	2469	return 1e99 if $self->{deny_reset};
1342		2470
1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2471	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344	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;
1345		2473
…		…
1350	my ($self) = @_;	2478	my ($self) = @_;
1351		2479
1352	$self->reset_at <= $cf::RUNTIME	2480	$self->reset_at <= $cf::RUNTIME
1353	}	2481	}
1354		2482
1355	sub unlink_save {
1356	my ($self) = @_;
1357
1358	utf8::encode (my $save = $self->{path}->save_path);
1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361	}
1362
1363	sub rename {
1364	my ($self, $new_path) = @_;
1365
1366	$self->unlink_save;
1367
1368	delete $cf::MAP{$self->path};
1369	$self->{path} = new cf::path $new_path;
1370	$self->path ($self->{path}->as_string);
1371	$cf::MAP{$self->path} = $self;
1372
1373	$self->save;
1374	}
1375
1376	sub reset {	2483	sub reset {
1377	my ($self) = @_;	2484	my ($self) = @_;
1378		2485
1379	my $lock = cf::lock_acquire "map_data:" . $self->path;	2486	my $lock = cf::lock_acquire "map_data:$self->{path}";
1380		2487
1381	return if $self->players;	2488	return if $self->players;
1382	return if $self->{path}{user_rel};#d#
1383		2489
1384	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	}
1385		2501
1386	delete $cf::MAP{$self->path};	2502	delete $cf::MAP{$self->path};
1387		2503
		2504	$self->deactivate;
1388	$_->clear_links_to ($self) for values %cf::MAP;	2505	$_->clear_links_to ($self) for values %cf::MAP;
		2506	$self->clear;
1389		2507
1390	$self->unlink_save;	2508	$self->unlink_save;
1391	$self->destroy;	2509	$self->destroy;
1392	}	2510	}
1393		2511
1394	my $nuke_counter = "aaaa";	2512	my $nuke_counter = "aaaa";
1395		2513
1396	sub nuke {	2514	sub nuke {
1397	my ($self) = @_;	2515	my ($self) = @_;
1398		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};
1399	$self->{deny_save} = 1;	2526	$self->{deny_save} = 1;
1400	$self->reset_timeout (1);	2527	$self->reset_timeout (1);
1401	$self->rename ("{nuke}/" . ($nuke_counter++));	2528	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2529
		2530	$cf::MAP{$self->path} = $self;
		2531	}
		2532
1402	$self->reset; # polite request, might not happen	2533	$self->reset; # polite request, might not happen
1403	}	2534	}
1404		2535
1405	sub customise_for {	2536	=item $maps = cf::map::tmp_maps
1406	my ($map, $ob) = @_;
1407		2537
1408	if ($map->per_player) {	2538	Returns an arrayref with all map paths of currently instantiated and saved
1409	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2539	maps. May block.
		2540
		2541	=cut
		2542
		2543	sub tmp_maps() {
1410	}	2544	[
1411		2545	map {
1412	$map	2546	utf8::decode $_;
		2547	/\.map$/
		2548	? normalise $_
		2549	: ()
		2550	} @{ aio_readdir $TMPDIR or [] }
		2551	]
1413	}	2552	}
1414		2553
1415	sub emergency_save {	2554	=item $maps = cf::map::random_maps
1416	my $freeze_guard = cf::freeze_mainloop;
1417		2555
1418	warn "enter emergency map save\n";	2556	Returns an arrayref with all map paths of currently instantiated and saved
		2557	random maps. May block.
1419		2558
1420	cf::sync_job {	2559	=cut
1421	warn "begin emergency map save\n";	2560
1422	$_->save for values %cf::MAP;	2561	sub random_maps() {
		2562	[
		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;
1423	};	2618	}
1424		2619
1425	warn "end emergency map 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	}
1426	}	2675	}
1427		2676
1428	package cf;	2677	package cf;
1429		2678
1430	=back	2679	=back
1431
1432		2680
1433	=head3 cf::object::player	2681	=head3 cf::object::player
1434		2682
1435	=over 4	2683	=over 4
1436		2684
…		…
1439	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>
1440	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
1441	dialogue with the given NPC character.	2689	dialogue with the given NPC character.
1442		2690
1443	=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	};
1444		2706
1445	# rough implementation of a future "reply" method that works	2707	# rough implementation of a future "reply" method that works
1446	# with dialog boxes.	2708	# with dialog boxes.
1447	#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
1448	sub cf::object::player::reply($$$;$) {	2710	sub cf::object::player::reply($$$;$) {
…		…
1450		2712
1451	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2713	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1452		2714
1453	if ($self->{record_replies}) {	2715	if ($self->{record_replies}) {
1454	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2716	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2717
1455	} 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 {
1456	$msg = $npc->name . " says: $msg" if $npc;	2726	$msg = $npc->name . " says: $msg" if $npc;
1457	$self->message ($msg, $flags);	2727	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2728	}
1458	}	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 (@_);
1459	}	2740	}
1460		2741
1461	=item $player_object->may ("access")	2742	=item $player_object->may ("access")
1462		2743
1463	Returns wether the given player is authorized to access resource "access"	2744	Returns wether the given player is authorized to access resource "access"
…		…
1476		2757
1477	=item $player_object->enter_link	2758	=item $player_object->enter_link
1478		2759
1479	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}>).
1480		2761
1481	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.
1482	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.
1483		2768
1484	=item $player_object->leave_link ($map, $x, $y)	2769	=item $player_object->leave_link ($map, $x, $y)
1485		2770
1486	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
1487	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
1488	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
1489	to the emergency map position.	2774	fails, to the emergency map position.
1490		2775
1491	Might block.	2776	Might block.
1492		2777
1493	=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	}
1494		2789
1495	sub cf::object::player::enter_link {	2790	sub cf::object::player::enter_link {
1496	my ($self) = @_;	2791	my ($self) = @_;
1497		2792
1498	$self->deactivate_recursive;	2793	$self->deactivate_recursive;
1499		2794
1500	return if $self->map == $LINK_MAP;	2795	++$self->{_link_recursion};
		2796
		2797	return if UNIVERSAL::isa $self->map, "ext::map_link";
1501		2798
1502	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2799	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1503	if $self->map;	2800	if $self->map && $self->map->{path} ne "{link}";
1504		2801
1505	$self->enter_map ($LINK_MAP, 20, 20);	2802	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1506	}	2803	}
1507		2804
1508	sub cf::object::player::leave_link {	2805	sub cf::object::player::leave_link {
1509	my ($self, $map, $x, $y) = @_;	2806	my ($self, $map, $x, $y) = @_;
		2807
		2808	return unless $self->contr->active;
1510		2809
1511	my $link_pos = delete $self->{_link_pos};	2810	my $link_pos = delete $self->{_link_pos};
1512		2811
1513	unless ($map) {	2812	unless ($map) {
1514	# restore original map position	2813	# restore original map position
…		…
1525	($x, $y) = (-1, -1)	2824	($x, $y) = (-1, -1)
1526	unless (defined $x) && (defined $y);	2825	unless (defined $x) && (defined $y);
1527		2826
1528	# use -1 or undef as default coordinates, not 0, 0	2827	# use -1 or undef as default coordinates, not 0, 0
1529	($x, $y) = ($map->enter_x, $map->enter_y)	2828	($x, $y) = ($map->enter_x, $map->enter_y)
1530	if $x <=0 && $y <= 0;	2829	if $x <= 0 && $y <= 0;
1531		2830
1532	$map->load;	2831	$map->load;
1533		2832
		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
1534	$self->activate_recursive;	2840	$self->activate_recursive;
1535	$self->enter_map ($map, $x, $y);
1536	}
1537
1538	cf::player->attach (
1539	on_logout => sub {
1540	my ($pl) = @_;
1541
1542	# abort map switching before logout
1543	if ($pl->ob->{_link_pos}) {
1544	cf::sync_job {
1545	$pl->ob->leave_link
1546	};
1547	}
1548	},	2841	}
1549	on_login => sub {
1550	my ($pl) = @_;
1551		2842
1552	# try to abort aborted map switching on player login :)	2843	}
1553	# should happen only on crashes
1554	if ($pl->ob->{_link_pos}) {
1555		2844
1556	$pl->ob->enter_link;	2845	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1557	(async {
1558	# we need this sleep as the login has a concurrent enter_exit running
1559	# and this sleep increases chances of the player not ending up in scorn
1560	$pl->ob->reply (undef,
1561	"There was an internal problem at your last logout, "
1562	. "the server will try to bring you to your intended destination in a second.",
1563	cf::NDI_RED);
1564	Coro::Timer::sleep 1;
1565	$pl->ob->leave_link;
1566	})->prio (2);
1567	}
1568	},
1569	);
1570		2846
1571	=item $player_object->goto ($path, $x, $y)	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.
1572		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
1573	=cut	2856	=cut
		2857
		2858	our $GOTOGEN;
1574		2859
1575	sub cf::object::player::goto {	2860	sub cf::object::player::goto {
1576	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;
1577		2871
1578	$self->enter_link;	2872	$self->enter_link;
1579		2873
1580	(async {	2874	(async {
1581	$path = new cf::path $path;	2875	$Coro::current->{desc} = "player::goto $path $x $y";
1582		2876
1583	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) {
1584	$map = $map->customise_for ($self) if $map;	2900	$map = $map->customise_for ($self);
1585		2901	$map = $check->($map, $x, $y, $self) if $check && $map;
1586	# warn "entering ", $map->path, " at ($x, $y)\n"	2902	} else {
1587	# if $map;
1588
1589	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2903	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2904	}
1590		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};
1591	$self->leave_link ($map, $x, $y);	2916	$self->leave_link ($map, $x, $y);
		2917	}
		2918
		2919	$done->($self) if $done;
1592	})->prio (1);	2920	})->prio (1);
1593	}	2921	}
1594		2922
1595	=item $player_object->enter_exit ($exit_object)	2923	=item $player_object->enter_exit ($exit_object)
1596		2924
…		…
1598		2926
1599	sub parse_random_map_params {	2927	sub parse_random_map_params {
1600	my ($spec) = @_;	2928	my ($spec) = @_;
1601		2929
1602	my $rmp = { # defaults	2930	my $rmp = { # defaults
1603	xsize => 10,	2931	xsize => (cf::rndm 15, 40),
1604	ysize => 10,	2932	ysize => (cf::rndm 15, 40),
		2933	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2934	#layout => string,
1605	};	2935	};
1606		2936
1607	for (split /\n/, $spec) {	2937	for (split /\n/, $spec) {
1608	my ($k, $v) = split /\s+/, $_, 2;	2938	my ($k, $v) = split /\s+/, $_, 2;
1609		2939
…		…
1621	# that depends on the exit object	2951	# that depends on the exit object
1622		2952
1623	my $rmp = parse_random_map_params $exit->msg;	2953	my $rmp = parse_random_map_params $exit->msg;
1624		2954
1625	if ($exit->map) {	2955	if ($exit->map) {
1626	$rmp->{region} = $exit->map->region_name;	2956	$rmp->{region} = $exit->region->name;
1627	$rmp->{origin_map} = $exit->map->path;	2957	$rmp->{origin_map} = $exit->map->path;
1628	$rmp->{origin_x} = $exit->x;	2958	$rmp->{origin_x} = $exit->x;
1629	$rmp->{origin_y} = $exit->y;	2959	$rmp->{origin_y} = $exit->y;
		2960
		2961	$exit->map->touch;
1630	}	2962	}
1631		2963
1632	$rmp->{random_seed} ||= $exit->random_seed;	2964	$rmp->{random_seed} ||= $exit->random_seed;
1633		2965
1634	my $data = cf::to_json $rmp;	2966	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1635	my $md5 = Digest::MD5::md5_hex $data;	2967	my $md5 = Digest::MD5::md5_hex $data;
		2968	my $meta = "$RANDOMDIR/$md5.meta";
1636		2969
1637	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) {
1638	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;
1639		2974
		2975	my $slaying = "?random/$md5";
		2976
		2977	if ($exit->valid) {
1640	$exit->slaying ("?random/$md5");	2978	$exit->slaying ("?random/$md5");
1641	$exit->msg (undef);	2979	$exit->msg (undef);
		2980	}
1642	}	2981	}
1643	}	2982	}
1644		2983
1645	sub cf::object::player::enter_exit {	2984	sub cf::object::player::enter_exit {
1646	my ($self, $exit) = @_;	2985	my ($self, $exit) = @_;
…		…
1648	return unless $self->type == cf::PLAYER;	2987	return unless $self->type == cf::PLAYER;
1649		2988
1650	$self->enter_link;	2989	$self->enter_link;
1651		2990
1652	(async {	2991	(async {
1653	$self->deactivate_recursive; # just to be sure	2992	$Coro::current->{desc} = "enter_exit";
		2993
1654	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
1655	prepare_random_map $exit	3008	prepare_random_map $exit
		3009	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		3010
1656	if $exit->slaying eq "/!";	3011	$map = $exit->slaying;
1657		3012
1658	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	3013	} elsif ($slaying eq '!up') {
1659	$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;
1660		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
1661	1;	3030	1
1662	}) {	3031	}) {
1663	$self->message ("Something went wrong deep within the crossfire server. "	3032	$self->message ("Something went wrong deep within the deliantra server. "
1664	. "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. "
1665	. "Please report this to the dungeon master",	3034	. "Please report this to the dungeon master!",
1666	cf::NDI_UNIQUE | cf::NDI_RED);	3035	cf::NDI_UNIQUE | cf::NDI_RED);
1667		3036
1668	warn "ERROR in enter_exit: $@";	3037	error "ERROR in enter_exit: $@";
1669	$self->leave_link;	3038	$self->leave_link;
1670	}	3039	}
1671	})->prio (1);	3040	})->prio (1);
1672	}	3041	}
1673		3042
1674	=head3 cf::client	3043	=head3 cf::client
1675		3044
1676	=over 4	3045	=over 4
1677		3046
1678	=item $client->send_drawinfo ($text, $flags)	3047	=item $client->send_big_packet ($pkt)
1679		3048
1680	Sends a drawinfo packet to the client. Circumvents output buffering so	3049	Like C<send_packet>, but tries to compress large packets, and fragments
1681	should not be used under normal circumstances.	3050	them as required.
1682		3051
1683	=cut	3052	=cut
1684		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
1685	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($$@) {
1686	my ($self, $text, $flags) = @_;	3247	my ($self, $type, @msg) = @_;
1687		3248
1688	utf8::encode $text;	3249	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
1689	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1690	}	3250	}
1691
1692		3251
1693	=item $success = $client->query ($flags, "text", \&cb)	3252	=item $success = $client->query ($flags, "text", \&cb)
1694		3253
1695	Queues a query to the client, calling the given callback with	3254	Queues a query to the client, calling the given callback with
1696	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>,
1697	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>.
1698		3257
1699	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
1700	reliable at some point in the future.	3259	become reliable at some point in the future.
1701		3260
1702	=cut	3261	=cut
1703		3262
1704	sub cf::client::query {	3263	sub cf::client::query {
1705	my ($self, $flags, $text, $cb) = @_;	3264	my ($self, $flags, $text, $cb) = @_;
…		…
1713	utf8::encode $text;	3272	utf8::encode $text;
1714	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3273	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1715		3274
1716	$self->send_packet ($self->{query_queue}[0][0])	3275	$self->send_packet ($self->{query_queue}[0][0])
1717	if @{ $self->{query_queue} } == 1;	3276	if @{ $self->{query_queue} } == 1;
		3277
		3278	1
		3279	}
		3280
		3281	=item $client->update_command_faces
		3282
		3283	=cut
		3284
		3285	our %COMMAND_FACE;
		3286
		3287	sub cf::client::update_command_faces {
		3288	my ($self) = @_;
		3289
		3290	my @faces = grep $_,
		3291	$COMMAND_FACE{preferred},
		3292	$COMMAND_FACE{standard},
		3293	$COMMAND_FACE{skill},
		3294	$self->pl->ob->flag (cf::FLAG_WIZ) ? $COMMAND_FACE{dm} : (),
		3295	$COMMAND_FACE{emote},
		3296	;
		3297
		3298	$self->send_face ($_)
		3299	for @faces;
		3300	$self->flush_fx;
		3301
		3302	$self->ext_msg (command_list => @faces);
		3303	}
		3304
		3305	=item cf::client::set_command_face $type, $commands
		3306
		3307	=cut
		3308
		3309	sub cf::client::set_command_face {
		3310	my ($type, $list) = @_;
		3311
		3312	my $idx = &cf::face::set ( #d# ugly forward reference
		3313	"command_list/$type" => cf::FT_RSRC,
		3314	JSON::XS->new->utf8->encode ([ sort @$list ])
		3315	);
		3316
		3317	$COMMAND_FACE{$type} = $idx;
1718	}	3318	}
1719		3319
1720	cf::client->attach (	3320	cf::client->attach (
		3321	on_connect => sub {
		3322	my ($ns) = @_;
		3323
		3324	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3325	},
1721	on_reply => sub {	3326	on_reply => sub {
1722	my ($ns, $msg) = @_;	3327	my ($ns, $msg) = @_;
1723		3328
1724	# this weird shuffling is so that direct followup queries	3329	# this weird shuffling is so that direct followup queries
1725	# get handled first	3330	# get handled first
1726	my $queue = delete $ns->{query_queue}	3331	my $queue = delete $ns->{query_queue}
1727	or return; # be conservative, not sure how that can happen, but we saw a crash here	3332	or return; # be conservative, not sure how that can happen, but we saw a crash here
1728		3333
1729	(shift @$queue)->[1]->($msg);	3334	(shift @$queue)->[1]->($msg);
		3335	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1730		3336
1731	push @{ $ns->{query_queue} }, @$queue;	3337	push @{ $ns->{query_queue} }, @$queue;
1732		3338
1733	if (@{ $ns->{query_queue} } == @$queue) {	3339	if (@{ $ns->{query_queue} } == @$queue) {
1734	if (@$queue) {	3340	if (@$queue) {
…		…
1736	} else {	3342	} else {
1737	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3343	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1738	}	3344	}
1739	}	3345	}
1740	},	3346	},
		3347	on_exticmd => sub {
		3348	my ($ns, $buf) = @_;
		3349
		3350	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3351
		3352	if (ref $msg) {
		3353	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		3354
		3355	if (my $cb = $EXTIACMD{$type}) {
		3356	$cb->(
		3357	$ns,
		3358	sub {
		3359	$ns->ext_msg ("reply-$reply", @_)
		3360	if $reply;
		3361	},
		3362	@payload
		3363	);
		3364	} else {
		3365	my @reply;
		3366
		3367	if (my $cb = $EXTICMD{$type}) {
		3368	@reply = $cb->($ns, @payload);
		3369	}
		3370
		3371	$ns->ext_msg ("reply-$reply", @reply)
		3372	if $reply;
		3373	}
		3374	} else {
		3375	error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3376	}
		3377
		3378	cf::override;
		3379	},
1741	);	3380	);
1742		3381
1743	=item $client->async (\&cb)	3382	=item $client->async (\&cb)
1744		3383
1745	Create a new coroutine, running the specified callback. The coroutine will	3384	Create a new coroutine, running the specified callback. The coroutine will
…		…
1761		3400
1762	$coro	3401	$coro
1763	}	3402	}
1764		3403
1765	cf::client->attach (	3404	cf::client->attach (
1766	on_destroy => sub {	3405	on_client_destroy => sub {
1767	my ($ns) = @_;	3406	my ($ns) = @_;
1768		3407
1769	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3408	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1770	},	3409	},
1771	);	3410	);
…		…
1786	our $safe = new Safe "safe";	3425	our $safe = new Safe "safe";
1787	our $safe_hole = new Safe::Hole;	3426	our $safe_hole = new Safe::Hole;
1788		3427
1789	$SIG{FPE} = 'IGNORE';	3428	$SIG{FPE} = 'IGNORE';
1790		3429
1791	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3430	$safe->permit_only (Opcode::opset qw(
		3431	:base_core :base_mem :base_orig :base_math :base_loop
		3432	grepstart grepwhile mapstart mapwhile
		3433	sort time
		3434	));
1792		3435
1793	# here we export the classes and methods available to script code	3436	# here we export the classes and methods available to script code
1794		3437
1795	=pod	3438	=pod
1796		3439
1797	The following fucntions and emthods are available within a safe environment:	3440	The following functions and methods are available within a safe environment:
1798		3441
1799	cf::object contr pay_amount pay_player map	3442	cf::object
		3443	contr pay_amount pay_player map x y force_find force_add destroy
		3444	insert remove name archname title slaying race decrease split
		3445	value
		3446
1800	cf::object::player player	3447	cf::object::player
1801	cf::player peaceful	3448	player
1802	cf::map trigger	3449
		3450	cf::player
		3451	peaceful
		3452
		3453	cf::map
		3454	trigger
1803		3455
1804	=cut	3456	=cut
1805		3457
1806	for (	3458	for (
1807	["cf::object" => qw(contr pay_amount pay_player map)],	3459	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3460	insert remove inv nrof name archname title slaying race
		3461	decrease split destroy change_exp value msg lore send_msg)],
1808	["cf::object::player" => qw(player)],	3462	["cf::object::player" => qw(player)],
1809	["cf::player" => qw(peaceful)],	3463	["cf::player" => qw(peaceful send_msg)],
1810	["cf::map" => qw(trigger)],	3464	["cf::map" => qw(trigger)],
1811	) {	3465	) {
1812	no strict 'refs';
1813	my ($pkg, @funs) = @$_;	3466	my ($pkg, @funs) = @$_;
1814	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3467	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1815	for @funs;	3468	for @funs;
1816	}	3469	}
1817		3470
…		…
1832		3485
1833	my $qcode = $code;	3486	my $qcode = $code;
1834	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3487	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1835	$qcode =~ s/\n/\\n/g;	3488	$qcode =~ s/\n/\\n/g;
1836		3489
		3490	%vars = (_dummy => 0) unless %vars;
		3491
		3492	my @res;
1837	local $_;	3493	local $_;
1838	local @safe::cf::_safe_eval_args = values %vars;
1839		3494
1840	my $eval =	3495	my $eval =
1841	"do {\n"	3496	"do {\n"
1842	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3497	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1843	. "#line 0 \"{$qcode}\"\n"	3498	. "#line 0 \"{$qcode}\"\n"
1844	. $code	3499	. $code
1845	. "\n}"	3500	. "\n}"
1846	;	3501	;
1847		3502
		3503	if ($CFG{safe_eval}) {
1848	sub_generation_inc;	3504	sub_generation_inc;
		3505	local @safe::cf::_safe_eval_args = values %vars;
1849	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3506	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1850	sub_generation_inc;	3507	sub_generation_inc;
		3508	} else {
		3509	local @cf::_safe_eval_args = values %vars;
		3510	@res = wantarray ? eval eval : scalar eval $eval;
		3511	}
1851		3512
1852	if ($@) {	3513	if ($@) {
1853	warn "$@";	3514	warn "$@",
1854	warn "while executing safe code '$code'\n";	3515	"while executing safe code '$code'\n",
1855	warn "with arguments " . (join " ", %vars) . "\n";	3516	"with arguments " . (join " ", %vars) . "\n";
1856	}	3517	}
1857		3518
1858	wantarray ? @res : $res[0]	3519	wantarray ? @res : $res[0]
1859	}	3520	}
1860		3521
…		…
1874	=cut	3535	=cut
1875		3536
1876	sub register_script_function {	3537	sub register_script_function {
1877	my ($fun, $cb) = @_;	3538	my ($fun, $cb) = @_;
1878		3539
1879	no strict 'refs';	3540	$fun = "safe::$fun" if $CFG{safe_eval};
1880	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3541	*$fun = $safe_hole->wrap ($cb);
1881	}	3542	}
1882		3543
1883	=back	3544	=back
1884		3545
1885	=cut	3546	=cut
1886		3547
1887	#############################################################################	3548	#############################################################################
1888		3549	# the server's init and main functions
1889	=head2 EXTENSION DATABASE SUPPORT
1890
1891	Crossfire maintains a very simple database for extension use. It can
1892	currently store anything that can be serialised using Storable, which
1893	excludes objects.
1894
1895	The parameter C<$family> should best start with the name of the extension
1896	using it, it should be unique.
1897
1898	=over 4
1899
1900	=item $hashref = cf::db_get $family
1901
1902	Return a hashref for use by the extension C<$family>, which can be
1903	modified. After modifications, you have to call C<cf::db_dirty> or
1904	C<cf::db_sync>.
1905
1906	=item $value = cf::db_get $family => $key
1907
1908	Returns a single value from the database
1909
1910	=item cf::db_put $family => $hashref
1911
1912	Stores the given family hashref into the database. Updates are delayed, if
1913	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1914
1915	=item cf::db_put $family => $key => $value
1916
1917	Stores the given C<$value> in the family hash. Updates are delayed, if you
1918	want the data to be synced to disk immediately, use C<cf::db_sync>.
1919
1920	=item cf::db_dirty
1921
1922	Marks the database as dirty, to be updated at a later time.
1923
1924	=item cf::db_sync
1925
1926	Immediately write the database to disk I<if it is dirty>.
1927
1928	=cut
1929
1930	our $DB;
1931		3550
1932	{	3551	{
1933	my $path = cf::localdir . "/database.pst";	3552	package cf::face;
1934		3553
1935	sub db_load() {	3554	our %HASH; # hash => idx
1936	$DB = stat $path ? Storable::retrieve $path : { };	3555	our @DATA; # dynamically-created facedata, only faceste 0 used
1937	}	3556	our @FOFS; # file offset, if > 0
		3557	our @SIZE; # size of face, in octets
		3558	our @META; # meta hash of face, if any
		3559	our $DATAFH; # facedata filehandle
1938		3560
1939	my $pid;	3561	# internal api, not finalised
		3562	sub set {
		3563	my ($name, $type, $data) = @_;
1940		3564
1941	sub db_save() {	3565	my $idx = cf::face::find $name;
1942	waitpid $pid, 0 if $pid;
1943	if (0 == ($pid = fork)) {
1944	$DB->{_meta}{version} = 1;
1945	Storable::nstore $DB, "$path~";
1946	rename "$path~", $path;
1947	cf::_exit 0 if defined $pid;
1948	}
1949	}
1950		3566
1951	my $dirty;	3567	if ($idx) {
1952		3568	delete $HASH{cf::face::get_csum $idx};
1953	sub db_sync() {
1954	db_save if $dirty;
1955	undef $dirty;
1956	}
1957
1958	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1959	db_sync;
1960	});
1961
1962	sub db_dirty() {
1963	$dirty = 1;
1964	$idle->start;
1965	}
1966
1967	sub db_get($;$) {
1968	@_ >= 2
1969	? $DB->{$_[0]}{$_[1]}
1970	: ($DB->{$_[0]} ||= { })
1971	}
1972
1973	sub db_put($$;$) {
1974	if (@_ >= 3) {
1975	$DB->{$_[0]}{$_[1]} = $_[2];
1976	} else {	3569	} else {
1977	$DB->{$_[0]} = $_[1];	3570	$idx = cf::face::alloc $name;
1978	}
1979	db_dirty;
1980	}
1981
1982	cf::global->attach (
1983	prio => 10000,
1984	on_cleanup => sub {
1985	db_sync;
1986	},	3571	}
		3572
		3573	my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
		3574
		3575	cf::face::set_type $idx, $type;
		3576	cf::face::set_csum $idx, 0, $hash;
		3577
		3578	# we need to destroy the SV itself, not just modify it, as a running ix
		3579	# might hold a reference to it: "delete" achieves that.
		3580	delete $FOFS[0][$idx];
		3581	delete $DATA[0][$idx];
		3582	$DATA[0][$idx] = $data;
		3583	$SIZE[0][$idx] = length $data;
		3584	delete $META[$idx];
		3585	$HASH{$hash} = $idx;#d#
		3586
		3587	$idx
		3588	}
		3589
		3590	sub _get_data($$$) {
		3591	my ($idx, $set, $cb) = @_;
		3592
		3593	if (defined $DATA[$set][$idx]) {
		3594	$cb->($DATA[$set][$idx]);
		3595	} elsif (my $fofs = $FOFS[$set][$idx]) {
		3596	my $size = $SIZE[$set][$idx];
		3597	my $buf;
		3598	IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
		3599	if ($_[0] == $size) {
		3600	#cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
		3601	$cb->($buf);
		3602	} else {
		3603	cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
		3604	}
		3605	};
		3606	} else {
		3607	cf::error "requested facedata for unknown face $idx#$set, ignoring.";
		3608	}
		3609	}
		3610
		3611	# rather ineffient
		3612	sub cf::face::get_data($;$) {
		3613	my ($idx, $set) = @_;
		3614
		3615	_get_data $idx, $set, Coro::rouse_cb;
		3616	Coro::rouse_wait
		3617	}
		3618
		3619	sub cf::face::ix {
		3620	my ($ns, $set, $idx, $pri) = @_;
		3621
		3622	_get_data $idx, $set, sub {
		3623	$ns->ix_send ($idx, $pri, $_[0]);
		3624	};
		3625	}
		3626	}
		3627
		3628	sub load_facedata($) {
		3629	my ($path) = @_;
		3630
		3631	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		3632
		3633	trace "loading facedata from $path\n";
		3634
		3635	my $facedata = decode_storable load_file "$path/faceinfo";
		3636
		3637	$facedata->{version} == 2
		3638	or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
		3639
		3640	my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
		3641	or cf::cleanup "$path/facedata: $!, cannot proceed.";
		3642
		3643	get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
		3644
		3645	# BEGIN ATOMIC
		3646	# from here on, everything must be atomic - no thread switch allowed
		3647	my $t1 = EV::time;
		3648
		3649	{
		3650	my $faces = $facedata->{faceinfo};
		3651
		3652	for my $face (sort keys %$faces) {
		3653	my $info = $faces->{$face};
		3654	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3655
		3656	cf::face::set_visibility $idx, $info->{visibility};
		3657	cf::face::set_magicmap $idx, $info->{magicmap};
		3658	cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
		3659	cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
		3660	cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
		3661	$cf::face::HASH{$info->{hash64}} = $idx;
		3662	delete $cf::face::META[$idx];
		3663	}
		3664
		3665	while (my ($face, $info) = each %$faces) {
		3666	next unless $info->{smooth};
		3667
		3668	my $idx = cf::face::find $face
		3669	or next;
		3670
		3671	if (my $smooth = cf::face::find $info->{smooth}) {
		3672	cf::face::set_smooth $idx, $smooth;
		3673	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3674	} else {
		3675	error "smooth face '$info->{smooth}' not found for face '$face'";
		3676	}
		3677	}
		3678	}
		3679
		3680	{
		3681	my $anims = $facedata->{animinfo};
		3682
		3683	while (my ($anim, $info) = each %$anims) {
		3684	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3685	}
		3686
		3687	cf::anim::invalidate_all; # d'oh
		3688	}
		3689
		3690	{
		3691	my $res = $facedata->{resource};
		3692
		3693	while (my ($name, $info) = each %$res) {
		3694	if (defined (my $type = $info->{type})) {
		3695	# TODO: different hash - must free and use new index, or cache ixface data queue
		3696	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3697
		3698	cf::face::set_type $idx, $type;
		3699	cf::face::set_csum $idx, 0, $info->{hash};
		3700	$cf::face::SIZE[0][$idx] = $info->{size};
		3701	$cf::face::FOFS[0][$idx] = $info->{fofs};
		3702	$cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3703	$cf::face::HASH{$info->{hash}} = $idx;
		3704	} else {
		3705	# $RESOURCE{$name} = $info; # unused
		3706	}
		3707	}
		3708	}
		3709
		3710	($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
		3711
		3712	# HACK to clear player env face cache, we need some signal framework
		3713	# for this (global event?)
		3714	%ext::player_env::MUSIC_FACE_CACHE = ();
		3715
		3716	# END ATOMIC
		3717
		3718	cf::debug "facedata atomic update time ", EV::time - $t1;
		3719
		3720	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3721
		3722	aio_close $fh if $fh; # close old facedata
		3723
		3724	1
		3725	}
		3726
		3727	register_exticmd fx_want => sub {
		3728	my ($ns, $want) = @_;
		3729
		3730	while (my ($k, $v) = each %$want) {
		3731	$ns->fx_want ($k, $v);
		3732	}
		3733	};
		3734
		3735	sub load_resource_file($) {
		3736	my $guard = lock_acquire "load_resource_file";
		3737
		3738	my $status = load_resource_file_ $_[0];
		3739	get_slot 0.1, 100;
		3740	cf::arch::commit_load;
		3741
		3742	$status
		3743	}
		3744
		3745	sub reload_exp_table {
		3746	_reload_exp_table;
		3747
		3748	cf::face::set
		3749	"res/exp_table" => FT_RSRC,
		3750	JSON::XS->new->utf8->canonical->encode (
		3751	[map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
1987	);	3752	);
1988	}	3753	}
1989		3754
1990	#############################################################################	3755	sub reload_materials {
1991	# the server's main()	3756	_reload_materials;
		3757	}
1992		3758
1993	sub cfg_load {	3759	sub reload_regions {
1994	open my $fh, "<:utf8", cf::confdir . "/config"	3760	# HACK to clear player env face cache, we need some signal framework
1995	or return;	3761	# for this (global event?)
		3762	%ext::player_env::MUSIC_FACE_CACHE = ();
1996		3763
1997	local $/;	3764	load_resource_file "$MAPDIR/regions"
1998	*CFG = YAML::Syck::Load <$fh>;	3765	or die "unable to load regions file\n";
1999		3766
		3767	for (cf::region::list) {
		3768	$_->{match} = qr/$_->{match}/
		3769	if exists $_->{match};
		3770	}
		3771	}
		3772
		3773	sub reload_facedata {
		3774	load_facedata $DATADIR
		3775	or die "unable to load facedata\n";
		3776	}
		3777
		3778	sub reload_archetypes {
		3779	load_resource_file "$DATADIR/archetypes"
		3780	or die "unable to load archetypes\n";
		3781
		3782	cf::face::set
		3783	"res/skill_info" => FT_RSRC,
		3784	JSON::XS->new->utf8->canonical->encode (
		3785	[map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
		3786	);
		3787
		3788	cf::face::set
		3789	"res/spell_paths" => FT_RSRC,
		3790	JSON::XS->new->utf8->canonical->encode (
		3791	[map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
		3792	);
		3793
		3794	# command completion
		3795	my @commands;
		3796
		3797	for (0..cf::arch::skillvec_size - 1) {
		3798	my $skill = cf::arch::skillvec $_;
		3799	my $name = $skill->name;
		3800	my $flags = cf::skill_flags $skill->subtype;
		3801
		3802	push @commands, "ready_skill $name" if $flags & (SF_COMBAT | SF_RANGED | SF_GRACE);
		3803	push @commands, "use_skill $name" if $flags & (SF_USE | SF_AUTARK | SF_GRACE);
		3804	}
		3805
		3806	cf::client::set_command_face skill => \@commands;
		3807	}
		3808
		3809	sub reload_treasures {
		3810	load_resource_file "$DATADIR/treasures"
		3811	or die "unable to load treasurelists\n";
		3812	}
		3813
		3814	sub reload_sound {
		3815	trace "loading sound config from $DATADIR/sound\n";
		3816
		3817	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3818
		3819	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3820	my $sound = $soundconf->{compat}[$_]
		3821	or next;
		3822
		3823	my $face = cf::face::find "sound/$sound->[1]";
		3824	cf::sound::set $sound->[0] => $face;
		3825	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3826	}
		3827
		3828	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3829	my $face = cf::face::find "sound/$v";
		3830	cf::sound::set $k => $face;
		3831	}
		3832	}
		3833
		3834	sub reload_resources {
		3835	trace "reloading resource files...\n";
		3836
		3837	reload_materials;
		3838	reload_facedata;
		3839	reload_exp_table;
		3840	reload_sound;
		3841	reload_archetypes;
		3842	reload_regions;
		3843	reload_treasures;
		3844
		3845	trace "finished reloading resource files\n";
		3846	}
		3847
		3848	sub reload_config {
		3849	trace "reloading config file...\n";
		3850
		3851	my $config = load_file "$CONFDIR/config";
		3852	utf8::decode $config;
		3853	*CFG = decode_yaml $config;
		3854
2000	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3855	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2001		3856
2002	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3857	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2003	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3858	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2004		3859
2005	if (exists $CFG{mlockall}) {	3860	if (exists $CFG{mlockall}) {
2006	eval {	3861	eval {
2007	$CFG{mlockall} ? &mlockall : &munlockall	3862	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2008	and die "WARNING: m(un)lockall failed: $!\n";	3863	and die "WARNING: m(un)lockall failed: $!\n";
2009	};	3864	};
2010	warn $@ if $@;	3865	warn $@ if $@;
2011	}	3866	}
2012	}	3867	}
2013		3868
		3869	sub pidfile() {
		3870	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3871	or die "$PIDFILE: $!";
		3872	flock $fh, &Fcntl::LOCK_EX
		3873	or die "$PIDFILE: flock: $!";
		3874	$fh
		3875	}
		3876
		3877	# make sure only one server instance is running at any one time
		3878	sub atomic {
		3879	my $fh = pidfile;
		3880
		3881	my $pid = <$fh>;
		3882	kill 9, $pid if $pid > 0;
		3883
		3884	seek $fh, 0, 0;
		3885	print $fh $$;
		3886	}
		3887
		3888	sub main_loop {
		3889	trace "EV::loop starting\n";
		3890	if (1) {
		3891	EV::loop;
		3892	}
		3893	trace "EV::loop returned\n";
		3894	goto &main_loop unless $REALLY_UNLOOP;
		3895	}
		3896
2014	sub main {	3897	sub main {
		3898	cf::init_globals; # initialise logging
		3899
		3900	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3901	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3902	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3903	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3904
		3905	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3906
2015	# we must not ever block the main coroutine	3907	# we must not ever block the main coroutine
2016	local $Coro::idle = sub {	3908	$Coro::idle = sub {
2017	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3909	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2018	async { Event::one_event };	3910	(async {
		3911	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3912	EV::loop EV::LOOP_ONESHOT;
		3913	})->prio (Coro::PRIO_MAX);
2019	};	3914	};
2020		3915
2021	cfg_load;	3916	evthread_start IO::AIO::poll_fileno;
2022	db_load;	3917
		3918	cf::sync_job {
		3919	cf::incloader::init ();
		3920
		3921	db_init;
		3922
		3923	cf::init_anim;
		3924	cf::init_attackmess;
		3925	cf::init_dynamic;
		3926
		3927	cf::load_settings;
		3928
		3929	reload_resources;
		3930	reload_config;
		3931
		3932	cf::init_uuid;
		3933	cf::init_signals;
		3934	cf::init_skills;
		3935
		3936	cf::init_beforeplay;
		3937
		3938	atomic;
		3939
2023	load_extensions;	3940	load_extensions;
2024	Event::loop;	3941
		3942	utime time, time, $RUNTIMEFILE;
		3943
		3944	# no (long-running) fork's whatsoever before this point(!)
		3945	use POSIX ();
		3946	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3947
		3948	cf::_post_init 0;
		3949	};
		3950
		3951	cf::object::thawer::errors_are_fatal 0;
		3952	info "parse errors in files are no longer fatal from this point on.\n";
		3953
		3954	AE::postpone {
		3955	undef &main; # free gobs of memory :)
		3956	};
		3957
		3958	goto &main_loop;
2025	}	3959	}
2026		3960
2027	#############################################################################	3961	#############################################################################
2028	# initialisation	3962	# initialisation and cleanup
2029		3963
		3964	# install some emergency cleanup handlers
		3965	BEGIN {
		3966	our %SIGWATCHER = ();
		3967	for my $signal (qw(INT HUP TERM)) {
		3968	$SIGWATCHER{$signal} = AE::signal $signal, sub {
		3969	cf::cleanup "SIG$signal";
		3970	};
		3971	}
		3972	}
		3973
		3974	sub write_runtime_sync {
		3975	my $t0 = AE::time;
		3976
		3977	# first touch the runtime file to show we are still running:
		3978	# the fsync below can take a very very long time.
		3979
		3980	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3981
		3982	my $guard = cf::lock_acquire "write_runtime";
		3983
		3984	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3985	or return;
		3986
		3987	my $value = $cf::RUNTIME + 90 + 10;
		3988	# 10 is the runtime save interval, for a monotonic clock
		3989	# 60 allows for the watchdog to kill the server.
		3990
		3991	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3992	and return;
		3993
		3994	# always fsync - this file is important
		3995	aio_fsync $fh
		3996	and return;
		3997
		3998	# touch it again to show we are up-to-date
		3999	aio_utime $fh, undef, undef;
		4000
		4001	close $fh
		4002	or return;
		4003
		4004	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		4005	and return;
		4006
		4007	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		4008
		4009	1
		4010	}
		4011
		4012	our $uuid_lock;
		4013	our $uuid_skip;
		4014
		4015	sub write_uuid_sync($) {
		4016	$uuid_skip ||= $_[0];
		4017
		4018	return if $uuid_lock;
		4019	local $uuid_lock = 1;
		4020
		4021	my $uuid = "$LOCALDIR/uuid";
		4022
		4023	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		4024	or return;
		4025
		4026	my $value = uuid_seq uuid_cur;
		4027
		4028	unless ($value) {
		4029	info "cowardly refusing to write zero uuid value!\n";
		4030	return;
		4031	}
		4032
		4033	my $value = uuid_str $value + $uuid_skip;
		4034	$uuid_skip = 0;
		4035
		4036	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		4037	and return;
		4038
		4039	# always fsync - this file is important
		4040	aio_fsync $fh
		4041	and return;
		4042
		4043	close $fh
		4044	or return;
		4045
		4046	aio_rename "$uuid~", $uuid
		4047	and return;
		4048
		4049	trace "uuid file written ($value).\n";
		4050
		4051	1
		4052
		4053	}
		4054
		4055	sub write_uuid($$) {
		4056	my ($skip, $sync) = @_;
		4057
		4058	$sync ? write_uuid_sync $skip
		4059	: async { write_uuid_sync $skip };
		4060	}
		4061
		4062	sub emergency_save() {
		4063	my $freeze_guard = cf::freeze_mainloop;
		4064
		4065	info "emergency_perl_save: enter\n";
		4066
		4067	# this is a trade-off: we want to be very quick here, so
		4068	# save all maps without fsync, and later call a global sync
		4069	# (which in turn might be very very slow)
		4070	local $USE_FSYNC = 0;
		4071
		4072	cf::sync_job {
		4073	cf::write_runtime_sync; # external watchdog should not bark
		4074
		4075	# use a peculiar iteration method to avoid tripping on perl
		4076	# refcount bugs in for. also avoids problems with players
		4077	# and maps saved/destroyed asynchronously.
		4078	info "emergency_perl_save: begin player save\n";
		4079	for my $login (keys %cf::PLAYER) {
		4080	my $pl = $cf::PLAYER{$login} or next;
		4081	$pl->valid or next;
		4082	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		4083	$pl->save;
		4084	}
		4085	info "emergency_perl_save: end player save\n";
		4086
		4087	cf::write_runtime_sync; # external watchdog should not bark
		4088
		4089	info "emergency_perl_save: begin map save\n";
		4090	for my $path (keys %cf::MAP) {
		4091	my $map = $cf::MAP{$path} or next;
		4092	$map->valid or next;
		4093	$map->save;
		4094	}
		4095	info "emergency_perl_save: end map save\n";
		4096
		4097	cf::write_runtime_sync; # external watchdog should not bark
		4098
		4099	info "emergency_perl_save: begin database checkpoint\n";
		4100	BDB::db_env_txn_checkpoint $DB_ENV;
		4101	info "emergency_perl_save: end database checkpoint\n";
		4102
		4103	info "emergency_perl_save: begin write uuid\n";
		4104	write_uuid_sync 1;
		4105	info "emergency_perl_save: end write uuid\n";
		4106
		4107	cf::write_runtime_sync; # external watchdog should not bark
		4108
		4109	trace "emergency_perl_save: syncing database to disk";
		4110	BDB::db_env_txn_checkpoint $DB_ENV;
		4111
		4112	info "emergency_perl_save: starting sync\n";
		4113	IO::AIO::aio_sync sub {
		4114	info "emergency_perl_save: finished sync\n";
		4115	};
		4116
		4117	cf::write_runtime_sync; # external watchdog should not bark
		4118
		4119	trace "emergency_perl_save: flushing outstanding aio requests";
		4120	while (IO::AIO::nreqs || BDB::nreqs) {
		4121	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		4122	}
		4123
		4124	cf::write_runtime_sync; # external watchdog should not bark
		4125	};
		4126
		4127	info "emergency_perl_save: leave\n";
		4128	}
		4129
		4130	sub post_cleanup {
		4131	my ($make_core) = @_;
		4132
		4133	IO::AIO::flush;
		4134
		4135	error Carp::longmess "post_cleanup backtrace"
		4136	if $make_core;
		4137
		4138	my $fh = pidfile;
		4139	unlink $PIDFILE if <$fh> == $$;
		4140	}
		4141
		4142	# a safer delete_package, copied from Symbol
		4143	sub clear_package($) {
		4144	my $pkg = shift;
		4145
		4146	# expand to full symbol table name if needed
		4147	unless ($pkg =~ /^main::.*::$/) {
		4148	$pkg = "main$pkg" if $pkg =~ /^::/;
		4149	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		4150	$pkg .= '::' unless $pkg =~ /::$/;
		4151	}
		4152
		4153	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		4154	my $stem_symtab = *{$stem}{HASH};
		4155
		4156	defined $stem_symtab and exists $stem_symtab->{$leaf}
		4157	or return;
		4158
		4159	# clear all symbols
		4160	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		4161	for my $name (keys %$leaf_symtab) {
		4162	_gv_clear *{"$pkg$name"};
		4163	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4164	}
		4165	}
		4166
2030	sub reload() {	4167	sub do_reload_perl() {
2031	# can/must only be called in main	4168	# can/must only be called in main
2032	if ($Coro::current != $Coro::main) {	4169	unless (in_main) {
2033	warn "can only reload from main coroutine\n";	4170	error "can only reload from main coroutine";
2034	return;	4171	return;
2035	}	4172	}
2036		4173
2037	warn "reloading...";	4174	return if $RELOAD++;
2038		4175
2039	my $guard = freeze_mainloop;	4176	my $t1 = AE::time;
		4177
		4178	while ($RELOAD) {
		4179	cf::get_slot 0.1, -1, "reload_perl";
		4180	info "perl_reload: reloading...";
		4181
		4182	trace "perl_reload: entering sync_job";
		4183
		4184	cf::sync_job {
2040	cf::emergency_save;	4185	#cf::emergency_save;
2041		4186
2042	eval {	4187	trace "perl_reload: cancelling all extension coros";
2043	# if anything goes wrong in here, we should simply crash as we already saved
2044
2045	# cancel all watchers
2046	for (Event::all_watchers) {
2047	$_->cancel if $_->data & WF_AUTOCANCEL;
2048	}
2049
2050	# cancel all extension coros
2051	$_->cancel for values %EXT_CORO;	4188	$_->cancel for values %EXT_CORO;
2052	%EXT_CORO = ();	4189	%EXT_CORO = ();
2053		4190
2054	# unload all extensions	4191	trace "perl_reload: removing commands";
2055	for (@exts) {	4192	%COMMAND = ();
2056	warn "unloading <$_>";
2057	unload_extension $_;
2058	}
2059		4193
2060	# unload all modules loaded from $LIBDIR	4194	trace "perl_reload: removing ext/exti commands";
2061	while (my ($k, $v) = each %INC) {	4195	%EXTCMD = ();
2062	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4196	%EXTICMD = ();
2063		4197
2064	warn "removing <$k>";	4198	trace "perl_reload: unloading/nuking all extensions";
2065	delete $INC{$k};	4199	for my $pkg (@EXTS) {
		4200	trace "... unloading $pkg";
2066		4201
2067	$k =~ s/\.pm$//;
2068	$k =~ s/\//::/g;
2069
2070	if (my $cb = $k->can ("unload_module")) {	4202	if (my $cb = $pkg->can ("unload")) {
		4203	eval {
2071	$cb->();	4204	$cb->($pkg);
		4205	1
		4206	} or error "$pkg unloaded, but with errors: $@";
		4207	}
		4208
		4209	trace "... clearing $pkg";
		4210	clear_package $pkg;
2072	}	4211	}
2073		4212
2074	Symbol::delete_package $k;	4213	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
		4214	while (my ($k, $v) = each %INC) {
		4215	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		4216
		4217	trace "... unloading $k";
		4218	delete $INC{$k};
		4219
		4220	$k =~ s/\.pm$//;
		4221	$k =~ s/\//::/g;
		4222
		4223	if (my $cb = $k->can ("unload_module")) {
		4224	$cb->();
		4225	}
		4226
		4227	clear_package $k;
2075	}	4228	}
2076		4229
2077	# sync database to disk
2078	cf::db_sync;
2079	IO::AIO::flush;
2080
2081	# get rid of safe::, as good as possible	4230	trace "perl_reload: getting rid of safe::, as good as possible";
2082	Symbol::delete_package "safe::$_"	4231	clear_package "safe::$_"
2083	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4232	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2084		4233
2085	# remove register_script_function callbacks	4234	trace "perl_reload: unloading cf.pm \"a bit\"";
2086	# TODO
2087
2088	# unload cf.pm "a bit"
2089	delete $INC{"cf.pm"};	4235	delete $INC{"cf.pm"};
		4236	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2090		4237
2091	# don't, removes xs symbols, too,	4238	# don't, removes xs symbols, too,
2092	# and global variables created in xs	4239	# and global variables created in xs
2093	#Symbol::delete_package __PACKAGE__;	4240	#clear_package __PACKAGE__;
2094		4241
2095	# reload cf.pm	4242	info "perl_reload: unload completed, starting to reload now";
2096	warn "reloading cf.pm";	4243
		4244	trace "perl_reload: reloading cf.pm";
2097	require cf;	4245	require cf;
2098	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4246	cf::_connect_to_perl_1;
2099		4247
2100	# load config and database again	4248	trace "perl_reload: loading config and database again";
2101	cf::cfg_load;	4249	cf::reload_config;
2102	cf::db_load;
2103		4250
2104	# load extensions	4251	trace "perl_reload: loading extensions";
2105	warn "load extensions";
2106	cf::load_extensions;	4252	cf::load_extensions;
2107		4253
2108	# reattach attachments to objects	4254	if ($REATTACH_ON_RELOAD) {
2109	warn "reattach";	4255	trace "perl_reload: reattaching attachments to objects/players";
2110	_global_reattach;	4256	_global_reattach; # objects, sockets
		4257	trace "perl_reload: reattaching attachments to maps";
		4258	reattach $_ for values %MAP;
		4259	trace "perl_reload: reattaching attachments to players";
		4260	reattach $_ for values %PLAYER;
		4261	}
		4262
		4263	cf::_post_init 1;
		4264
		4265	trace "perl_reload: leaving sync_job";
		4266
		4267	1
		4268	} or do {
		4269	error $@;
		4270	cf::cleanup "perl_reload: error, exiting.";
		4271	};
		4272
		4273	--$RELOAD;
		4274	}
		4275
		4276	$t1 = AE::time - $t1;
		4277	info "perl_reload: completed in ${t1}s\n";
		4278	};
		4279
		4280	our $RELOAD_WATCHER; # used only during reload
		4281
		4282	sub reload_perl() {
		4283	# doing reload synchronously and two reloads happen back-to-back,
		4284	# coro crashes during coro_state_free->destroy here.
		4285
		4286	$RELOAD_WATCHER ||= cf::async {
		4287	Coro::AIO::aio_wait cache_extensions;
		4288
		4289	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4290	do_reload_perl;
		4291	undef $RELOAD_WATCHER;
		4292	};
2111	};	4293	};
2112
2113	if ($@) {
2114	warn $@;
2115	warn "error while reloading, exiting.";
2116	exit 1;
2117	}
2118
2119	warn "reloaded successfully";
2120	};
2121
2122	#############################################################################
2123
2124	unless ($LINK_MAP) {
2125	$LINK_MAP = cf::map::new;
2126
2127	$LINK_MAP->width (41);
2128	$LINK_MAP->height (41);
2129	$LINK_MAP->alloc;
2130	$LINK_MAP->path ("{link}");
2131	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2132	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2133
2134	# dirty hack because... archetypes are not yet loaded
2135	Event->timer (
2136	after => 2,
2137	cb => sub {
2138	$_[0]->w->cancel;
2139
2140	# provide some exits "home"
2141	my $exit = cf::object::new "exit";
2142
2143	$exit->slaying ($EMERGENCY_POSITION->[0]);
2144	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2145	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2146
2147	$LINK_MAP->insert ($exit->clone, 19, 19);
2148	$LINK_MAP->insert ($exit->clone, 19, 20);
2149	$LINK_MAP->insert ($exit->clone, 19, 21);
2150	$LINK_MAP->insert ($exit->clone, 20, 19);
2151	$LINK_MAP->insert ($exit->clone, 20, 21);
2152	$LINK_MAP->insert ($exit->clone, 21, 19);
2153	$LINK_MAP->insert ($exit->clone, 21, 20);
2154	$LINK_MAP->insert ($exit->clone, 21, 21);
2155
2156	$exit->destroy;
2157	});
2158
2159	$LINK_MAP->{deny_save} = 1;
2160	$LINK_MAP->{deny_reset} = 1;
2161
2162	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2163	}	4294	}
2164
2165	register "<global>", __PACKAGE__;
2166		4295
2167	register_command "reload" => sub {	4296	register_command "reload" => sub {
2168	my ($who, $arg) = @_;	4297	my ($who, $arg) = @_;
2169		4298
2170	if ($who->flag (FLAG_WIZ)) {	4299	if ($who->flag (FLAG_WIZ)) {
2171	$who->message ("start of reload.");
2172	reload;
2173	$who->message ("end of reload.");	4300	$who->message ("reloading server.");
		4301	async {
		4302	$Coro::current->{desc} = "perl_reload";
		4303	reload_perl;
		4304	};
2174	}	4305	}
2175	};	4306	};
2176		4307
2177	unshift @INC, $LIBDIR;	4308	#############################################################################
2178		4309
2179	$TICK_WATCHER = Event->timer (	4310	my $bug_warning = 0;
2180	reentrant => 0,
2181	prio => 0,
2182	at => $NEXT_TICK || $TICK,
2183	data => WF_AUTOCANCEL,
2184	cb => sub {
2185	cf::server_tick; # one server iteration
2186	$RUNTIME += $TICK;
2187	$NEXT_TICK += $TICK;
2188		4311
2189	# if we are delayed by four ticks or more, skip them all	4312	sub wait_for_tick() {
2190	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4313	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2191		4314
2192	$TICK_WATCHER->at ($NEXT_TICK);	4315	$WAIT_FOR_TICK->wait;
2193	$TICK_WATCHER->start;	4316	}
		4317
		4318	sub wait_for_tick_begin() {
		4319	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4320
		4321	my $signal = new Coro::Signal;
		4322	push @WAIT_FOR_TICK_BEGIN, $signal;
		4323	$signal->wait;
		4324	}
		4325
		4326	sub tick {
		4327	if ($Coro::current != $Coro::main) {
		4328	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4329	unless ++$bug_warning > 10;
		4330	return;
2194	},	4331	}
2195	);
2196		4332
2197	IO::AIO::max_poll_time $TICK * 0.2;	4333	cf::one_tick; # one server iteration
2198		4334
2199	Event->io (	4335	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2200	fd => IO::AIO::poll_fileno,
2201	poll => 'r',
2202	prio => 5,
2203	data => WF_AUTOCANCEL,
2204	cb => \&IO::AIO::poll_cb,
2205	);
2206		4336
2207	Event->timer (	4337	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2208	data => WF_AUTOCANCEL,	4338	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2209	after => 0,	4339	Coro::async_pool {
2210	interval => 10,	4340	$Coro::current->{desc} = "runtime saver";
2211	cb => sub {
2212	(Coro::unblock_sub {
2213	write_runtime	4341	write_runtime_sync
2214	or warn "ERROR: unable to write runtime file: $!";	4342	or error "ERROR: unable to write runtime file: $!";
2215	})->();	4343	};
2216	},	4344	}
2217	);	4345
		4346	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4347	$sig->send;
		4348	}
		4349	$WAIT_FOR_TICK->broadcast;
		4350
		4351	$LOAD = ($NOW - $TICK_START) / $TICK;
		4352	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4353
		4354	if (0) {
		4355	if ($NEXT_TICK) {
		4356	my $jitter = $TICK_START - $NEXT_TICK;
		4357	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4358	debug "jitter $JITTER\n";#d#
		4359	}
		4360	}
		4361	}
		4362
		4363	{
		4364	# configure BDB
		4365	info "initialising database";
		4366
		4367	BDB::min_parallel 16;
		4368	BDB::max_poll_reqs $TICK * 0.1;
		4369	#$AnyEvent::BDB::WATCHER->priority (1);
		4370
		4371	unless ($DB_ENV) {
		4372	$DB_ENV = BDB::db_env_create;
		4373	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4374	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4375	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4376	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4377	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4378
		4379	cf::sync_job {
		4380	eval {
		4381	BDB::db_env_open
		4382	$DB_ENV,
		4383	$BDBDIR,
		4384	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4385	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4386	0666;
		4387
		4388	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4389	};
		4390
		4391	cf::cleanup "db_env_open(db): $@" if $@;
		4392	};
		4393	}
		4394
		4395	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4396	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4397	};
		4398	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4399	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4400	};
		4401	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4402	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4403	};
		4404
		4405	info "database initialised";
		4406	}
		4407
		4408	{
		4409	# configure IO::AIO
		4410
		4411	info "initialising aio";
		4412	IO::AIO::min_parallel 8;
		4413	IO::AIO::max_poll_time $TICK * 0.1;
		4414	undef $AnyEvent::AIO::WATCHER;
		4415	info "aio initialised";
		4416	}
		4417
		4418	our $_log_backtrace;
		4419	our $_log_backtrace_last;
		4420
		4421	sub _log_backtrace {
		4422	my ($msg, @addr) = @_;
		4423
		4424	$msg =~ s/\n$//;
		4425
		4426	if ($_log_backtrace_last eq $msg) {
		4427	LOG llevInfo, "[ABT] $msg\n";
		4428	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4429	# limit the # of concurrent backtraces
		4430	} elsif ($_log_backtrace < 2) {
		4431	$_log_backtrace_last = $msg;
		4432	++$_log_backtrace;
		4433	my $perl_bt = Carp::longmess $msg;
		4434	async {
		4435	$Coro::current->{desc} = "abt $msg";
		4436
		4437	my @bt = fork_call {
		4438	@addr = map { sprintf "%x", $_ } @addr;
		4439	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4440	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4441	or die "addr2line: $!";
		4442
		4443	my @funcs;
		4444	my @res = <$fh>;
		4445	chomp for @res;
		4446	while (@res) {
		4447	my ($func, $line) = splice @res, 0, 2, ();
		4448	push @funcs, "[$func] $line";
		4449	}
		4450
		4451	@funcs
		4452	};
		4453
		4454	LOG llevInfo, "[ABT] $perl_bt\n";
		4455	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4456	LOG llevInfo, "[ABT] $_\n" for @bt;
		4457	--$_log_backtrace;
		4458	};
		4459	} else {
		4460	LOG llevInfo, "[ABT] $msg\n";
		4461	LOG llevInfo, "[ABT] [overload, suppressed]\n";
		4462	}
		4463	}
		4464
		4465	# load additional modules
		4466	require "cf/$_.pm" for @EXTRA_MODULES;
		4467	cf::_connect_to_perl_2;
2218		4468
2219	END { cf::emergency_save }	4469	END { cf::emergency_save }
2220		4470
2221	1	4471	1
2222		4472

Diff Legend

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