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

Diff Legend

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