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.136 by root, Fri Jan 5 01:06:28 2007 UTC vs.
Revision 1.591 by root, Tue Nov 6 23:33:15 2012 UTC

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

Diff Legend

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