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.123 by root, Tue Jan 2 19:18:33 2007 UTC vs.
Revision 1.585 by root, Tue Oct 30 20:18:00 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 $FREEZE;	150	our $JITTER; # average jitter
55	our $RANDOM_MAPS = cf::localdir . "/random";	151	our $TICK_START; # for load detecting purposes
56	our %EXT_CORO;	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;
57		160
58	binmode STDOUT;	161	binmode STDOUT;
59	binmode STDERR;	162	binmode STDERR;
60		163
61	# read virtual server time, if available	164	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	165	unless ($RUNTIME || !-e $RUNTIMEFILE) {
63	open my $fh, "<", cf::localdir . "/runtime"	166	open my $fh, "<", $RUNTIMEFILE
64	or die "unable to read runtime file: $!";	167	or die "unable to read $RUNTIMEFILE file: $!";
65	$RUNTIME = <$fh> + 0.;	168	$RUNTIME = <$fh> + 0.;
66	}	169	}
67		170
68	mkdir cf::localdir;	171	eval "sub TICK() { $TICK } 1" or die;
69	mkdir cf::localdir . "/" . cf::playerdir;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		172
74	# a special map that is always available	173	mkdir $_
75	our $LINK_MAP;	174	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
76		175
77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];	176	our $EMERGENCY_POSITION;
		177
		178	sub cf::map::normalise;
		179
		180	sub in_main() {
		181	$Coro::current == $Coro::main
		182	}
78		183
79	#############################################################################	184	#############################################################################
80		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
81	=head2 GLOBAL VARIABLES	197	=head2 GLOBAL VARIABLES
82		198
83	=over 4	199	=over 4
84		200
85	=item $cf::UPTIME	201	=item $cf::UPTIME
86		202
87	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.
88		219
89	=item $cf::RUNTIME	220	=item $cf::RUNTIME
90		221
91	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
92	every server tick.	223	every server tick.
93		224
94	=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
95		228
96	The perl library directory, where extensions and cf-specific modules can	229	Various directories - "/etc", read-only install directory, perl-library
97	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.
98		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
99	=item $cf::NOW	240	=item $cf::LOAD
100		241
101	The time of the last (current) server tick.	242	The raw value load value from the last tick.
102
103	=item $cf::TICK
104
105	The interval between server ticks, in seconds.
106		243
107	=item %cf::CFG	244	=item %cf::CFG
108		245
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	246	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
110	from wherever your confdir points to.	247	from wherever your confdir points to.
111		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
112	=back	284	=back
113		285
114	=cut	286	=cut
115		287
116	BEGIN {	288	sub error(@) { LOG llevError, join "", @_ }
117	*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 {
118	my $msg = join "", @_;	295	my $msg = join "", @_;
119	utf8::encode $msg;
120		296
121	$msg .= "\n"	297	$msg .= "\n"
122	unless $msg =~ /\n$/;	298	unless $msg =~ /\n$/;
123		299
124	LOG llevError, "cfperl: $msg";	300	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
125	};	301
126	}	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	};
127		318
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	319	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	320	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	321	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	322	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@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';
133	@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)
134		326
135	# 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
136	# within the Safe compartment.	328	# within the Safe compartment.
137	for my $pkg (qw(	329	for my $pkg (qw(
138	cf::global cf::attachable	330	cf::global cf::attachable
139	cf::object cf::object::player	331	cf::object cf::object::player
140	cf::client cf::player	332	cf::client cf::player
141	cf::arch cf::living	333	cf::arch cf::living
		334	cf::map cf::mapspace
142	cf::map cf::party cf::region	335	cf::party cf::region
143	)) {	336	)) {
144	no strict 'refs';
145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	337	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
146	}	338	}
147		339
148	$Event::DIED = sub {	340	$EV::DIED = sub {
149	warn "error in event callback: @_";	341	Carp::cluck "error in event callback: @_";
150	};	342	};
151		343
152	my %ext_pkg;	344	#############################################################################
153	my @exts;	345
154	my @hook;	346	sub fork_call(&@);
		347	sub get_slot($;$$);
		348
		349	#############################################################################
155		350
156	=head2 UTILITY FUNCTIONS	351	=head2 UTILITY FUNCTIONS
157		352
158	=over 4	353	=over 4
159		354
160	=cut	355	=item dumpval $ref
161		356
162	use JSON::Syck (); # TODO# replace by JSON::PC once working	357	=cut
163		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
164	=item $ref = cf::from_json $json	430	=item $ref = cf::decode_json $json
165		431
166	Converts a JSON string into the corresponding perl data structure.	432	Converts a JSON string into the corresponding perl data structure.
167		433
168	=cut
169
170	sub from_json($) {
171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172	JSON::Syck::Load $_[0]
173	}
174
175	=item $json = cf::to_json $ref	434	=item $json = cf::encode_json $ref
176		435
177	Converts a perl data structure into its JSON representation.	436	Converts a perl data structure into its JSON representation.
178		437
179	=cut	438	=cut
180		439
181	sub to_json($) {	440	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183	JSON::Syck::Dump $_[0]
184	}
185		441
186	=item my $guard = cf::guard { BLOCK }	442	sub encode_json($) { $json_coder->encode ($_[0]) }
		443	sub decode_json($) { $json_coder->decode ($_[0]) }
187		444
188	Run the given callback when the guard object gets destroyed (useful for	445	=item $ref = cf::decode_storable $scalar
189	coroutine cancellations).
190		446
191	You can call C<< ->cancel >> on the guard object to stop the block from	447	Same as Coro::Storable::thaw, so blocks.
192	being executed.
193		448
194	=cut	449	=cut
195		450
196	sub guard(&) {	451	BEGIN { *decode_storable = \&Coro::Storable::thaw }
197	bless \(my $cb = $_[0]), cf::guard::;
198	}
199		452
200	sub cf::guard::cancel {	453	=item $ref = cf::decode_yaml $scalar
201	${$_[0]} = sub { };
202	}
203		454
204	sub cf::guard::DESTROY {	455	Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
205	${$_[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	}
206	}	505	}
207		506
208	=item cf::lock_wait $string	507	=item cf::lock_wait $string
209		508
210	Wait until the given lock is available. See cf::lock_acquire.	509	Wait until the given lock is available. See cf::lock_acquire.
211		510
212	=item my $lock = cf::lock_acquire $string	511	=item my $lock = cf::lock_acquire $string
213		512
214	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
215	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,
216	for example when the coroutine gets canceled), the lock is automatically	515	for example when the coroutine gets canceled), the lock is automatically
217	returned.	516	returned.
218		517
		518	Locks are *not* recursive, locking from the same coro twice results in a
		519	deadlocked coro.
		520
219	Lock names should begin with a unique identifier (for example, find_map	521	Lock names should begin with a unique identifier (for example, cf::map::find
220	uses map_find and load_map uses map_load).	522	uses map_find and cf::map::load uses map_load).
221		523
222	=cut	524	=item $locked = cf::lock_active $string
223		525
224	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;
225		531
226	sub lock_wait($) {	532	sub lock_wait($) {
227	my ($key) = @_;	533	$LOCKS->wait ($_[0]);
228
229	# wait for lock, if any
230	while ($LOCK{$key}) {
231	push @{ $LOCK{$key} }, $Coro::current;
232	Coro::schedule;
233	}
234	}	534	}
235		535
236	sub lock_acquire($) {	536	sub lock_acquire($) {
237	my ($key) = @_;	537	$LOCKS->guard ($_[0])
238
239	# wait, to be sure we are not locked
240	lock_wait $key;
241
242	$LOCK{$key} = [];
243
244	cf::guard {
245	# wake up all waiters, to be on the safe side
246	$_->ready for @{ delete $LOCK{$key} };
247	}
248	}	538	}
		539
		540	sub lock_active($) {
		541	$LOCKS->count ($_[0]) < 1
		542	}
		543
		544	sub freeze_mainloop {
		545	tick_inhibit_inc;
		546
		547	&Guard::guard (\&tick_inhibit_dec);
		548	}
		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	}
		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;
		633	}
		634
		635	=item cf::async { BLOCK }
		636
		637	Currently the same as Coro::async_pool, meaning you cannot use
		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.
		640
		641	=cut
		642
		643	BEGIN { *async = \&Coro::async_pool }
249		644
250	=item cf::sync_job { BLOCK }	645	=item cf::sync_job { BLOCK }
251		646
252	The design of crossfire+ requires that the main coro ($Coro::main) is	647	The design of Deliantra requires that the main coroutine ($Coro::main)
253	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
254	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.
255		651
256	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
257	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
258	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
259	fast or be very important.	655	fast or be very important.
…		…
261	=cut	657	=cut
262		658
263	sub sync_job(&) {	659	sub sync_job(&) {
264	my ($job) = @_;	660	my ($job) = @_;
265		661
266	if ($Coro::current == $Coro::main) {	662	if (in_main) {
		663	my $time = AE::time;
		664
267	# this is the main coro, too bad, we have to block	665	# this is the main coro, too bad, we have to block
268	# till the operation succeeds, freezing the server :/	666	# till the operation succeeds, freezing the server :/
269		667
270	# TODO: use suspend/resume instead	668	#LOG llevError, Carp::longmess "sync job";#d#
271	# (but this is cancel-safe)	669
272	local $FREEZE = 1;	670	my $freeze_guard = freeze_mainloop;
273		671
274	my $busy = 1;	672	my $busy = 1;
275	my @res;	673	my @res;
276		674
277	(Coro::async {	675	(async {
		676	$Coro::current->desc ("sync job coro");
278	@res = eval { $job->() };	677	@res = eval { $job->() };
279	warn $@ if $@;	678	error $@ if $@;
280	undef $busy;	679	undef $busy;
281	})->prio (Coro::PRIO_MAX);	680	})->prio (Coro::PRIO_MAX);
282		681
283	while ($busy) {	682	while ($busy) {
		683	if (Coro::nready) {
284	Coro::cede_notself;	684	Coro::cede_notself;
285	Event::one_event unless Coro::nready;	685	} else {
		686	EV::loop EV::LOOP_ONESHOT;
286	}	687	}
		688	}
		689
		690	my $time = AE::time - $time;
		691
		692	$TICK_START += $time; # do not account sync jobs to server load
287		693
288	wantarray ? @res : $res[0]	694	wantarray ? @res : $res[0]
289	} else {	695	} else {
290	# we are in another coroutine, how wonderful, everything just works	696	# we are in another coroutine, how wonderful, everything just works
291		697
292	$job->()	698	$job->()
293	}	699	}
294	}	700	}
295		701
296	=item $coro = cf::coro { BLOCK }	702	=item $coro = cf::async_ext { BLOCK }
297		703
298	Creates and returns a new coro. This coro is automcatially being canceled	704	Like async, but this coro is automatically being canceled when the
299	when the extension calling this is being unloaded.	705	extension calling this is being unloaded.
300		706
301	=cut	707	=cut
302		708
303	sub coro(&) {	709	sub async_ext(&) {
304	my $cb = shift;	710	my $cb = shift;
305		711
306	my $coro; $coro = async {	712	my $coro = &Coro::async ($cb);
307	eval {
308	$cb->();
309	};
310	warn $@ if $@;
311	};
312		713
313	$coro->on_destroy (sub {	714	$coro->on_destroy (sub {
314	delete $EXT_CORO{$coro+0};	715	delete $EXT_CORO{$coro+0};
315	});	716	});
316	$EXT_CORO{$coro+0} = $coro;	717	$EXT_CORO{$coro+0} = $coro;
317		718
318	$coro	719	$coro
319	}	720	}
320		721
321	sub write_runtime {	722	=item fork_call { }, @args
322	my $runtime = cf::localdir . "/runtime";
323		723
324	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	724	Executes the given code block with the given arguments in a seperate
325	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.
326		728
327	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	729	=cut
328	(aio_write $fh, 0, (length $value), $value, 0) <= 0
329	and return;
330		730
331	aio_fsync $fh	731	sub post_fork {
332	and return;	732	reset_signals;
		733	}
333		734
334	close $fh	735	sub fork_call(&@) {
335	or return;	736	my ($cb, @args) = @_;
336		737
337	aio_rename "$runtime~", $runtime	738	# we seemingly have to make a local copy of the whole thing,
338	and return;	739	# otherwise perl prematurely frees the stuff :/
		740	# TODO: investigate and fix (likely this will be rather laborious)
339		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 {
340	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 });
341	}	925	}
342		926
343	=back	927	=back
344		928
345	=cut	929	=cut
346		930
347	#############################################################################	931	#############################################################################
348		932
349	package cf::path;
350
351	sub new {
352	my ($class, $path, $base) = @_;
353
354	$path = $path->as_string if ref $path;
355
356	my $self = bless { }, $class;
357
358	# {... are special paths that are not touched
359	# ?xxx/... are special absolute paths
360	# ?random/... random maps
361	# /! non-realised random map exit
362	# /... normal maps
363	# ~/... per-player maps without a specific player (DO NOT USE)
364	# ~user/... per-player map of a specific user
365
366	if ($path =~ /^{/) {
367	# fine as it is
368	} elsif ($path =~ s{^\?random/}{}) {
369	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370	$self->{random} = cf::from_json $data;
371	} else {
372	if ($path =~ s{^~([^/]+)?}{}) {
373	$self->{user_rel} = 1;
374
375	if (defined $1) {
376	$self->{user} = $1;
377	} elsif ($base =~ m{^~([^/]+)/}) {
378	$self->{user} = $1;
379	} else {
380	warn "cannot resolve user-relative path without user <$path,$base>\n";
381	}
382	} elsif ($path =~ /^\//) {
383	# already absolute
384	} else {
385	$base =~ s{[^/]+/?$}{};
386	return $class->new ("$base/$path");
387	}
388
389	for ($path) {
390	redo if s{/\.?/}{/};
391	redo if s{/[^/]+/\.\./}{/};
392	}
393	}
394
395	$self->{path} = $path;
396
397	$self
398	}
399
400	# the name / primary key / in-game path
401	sub as_string {
402	my ($self) = @_;
403
404	$self->{user_rel} ? "~$self->{user}$self->{path}"
405	: $self->{random} ? "?random/$self->{path}"
406	: $self->{path}
407	}
408
409	# the displayed name, this is a one way mapping
410	sub visible_name {
411	my ($self) = @_;
412
413	# if (my $rmp = $self->{random}) {
414	# # todo: be more intelligent about this
415	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416	# } else {
417	$self->as_string
418	# }
419	}
420
421	# escape the /'s in the path
422	sub _escaped_path {
423	# ∕ is U+2215
424	(my $path = $_[0]{path}) =~ s/\//∕/g;
425	$path
426	}
427
428	# the original (read-only) location
429	sub load_path {
430	my ($self) = @_;
431
432	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433	}
434
435	# the temporary/swap location
436	sub save_path {
437	my ($self) = @_;
438
439	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442	}
443
444	# the unique path, might be eq to save_path
445	sub uniq_path {
446	my ($self) = @_;
447
448	$self->{user_rel} || $self->{random}
449	? undef
450	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451	}
452
453	# return random map parameters, or undef
454	sub random_map_params {
455	my ($self) = @_;
456
457	$self->{random}
458	}
459
460	# this is somewhat ugly, but style maps do need special treatment
461	sub is_style_map {
462	$_[0]{path} =~ m{^/styles/}
463	}
464
465	package cf;
466
467	#############################################################################
468
469	=head2 ATTACHABLE OBJECTS	933	=head2 ATTACHABLE OBJECTS
470		934
471	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
472	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")
473	to it. All such attachable objects support the following methods.	937	to it. All such attachable objects support the following methods.
474		938
475	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>
476	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
477	crossfire+).	941	Deliantra).
478		942
479	=over 4	943	=over 4
480		944
481	=item $attachable->attach ($attachment, key => $value...)	945	=item $attachable->attach ($attachment, key => $value...)
482		946
…		…
526	=item cf::CLASS::attachment $name, ...	990	=item cf::CLASS::attachment $name, ...
527		991
528	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
529	given CLASS can refer to this attachment.	993	given CLASS can refer to this attachment.
530		994
531	Some classes such as crossfire maps and objects can specify attachments	995	Some classes such as deliantra maps and objects can specify attachments
532	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.
533		997
534	These calls expect any number of the following handler/hook descriptions:	998	These calls expect any number of the following handler/hook descriptions:
535		999
536	=over 4	1000	=over 4
…		…
596	our @CB_TYPE = (); # registry for type (cf-object class) based events	1060	our @CB_TYPE = (); # registry for type (cf-object class) based events
597	our @CB_MAP = ();	1061	our @CB_MAP = ();
598		1062
599	my %attachment;	1063	my %attachment;
600		1064
		1065	sub cf::attachable::thawer_merge {
		1066	# simply override everything except _meta
		1067	local $_[0]{_meta};
		1068	%{$_[0]} = %{$_[1]};
		1069	}
		1070
601	sub _attach_cb($$$$) {	1071	sub _attach_cb($$$$) {
602	my ($registry, $event, $prio, $cb) = @_;	1072	my ($registry, $event, $prio, $cb) = @_;
603		1073
604	use sort 'stable';	1074	use sort 'stable';
605		1075
…		…
639	$registry = $CB_TYPE[$object_type] ||= [];	1109	$registry = $CB_TYPE[$object_type] ||= [];
640		1110
641	} elsif ($type eq "subtype") {	1111	} elsif ($type eq "subtype") {
642	defined $object_type or Carp::croak "subtype specified without type";	1112	defined $object_type or Carp::croak "subtype specified without type";
643	my $object_subtype = shift @arg;	1113	my $object_subtype = shift @arg;
644	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	1114	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
645		1115
646	} elsif ($type eq "package") {	1116	} elsif ($type eq "package") {
647	my $pkg = shift @arg;	1117	my $pkg = shift @arg;
648		1118
649	while (my ($name, $id) = each %cb_id) {	1119	while (my ($name, $id) = each %cb_id) {
…		…
654		1124
655	} elsif (exists $cb_id{$type}) {	1125	} elsif (exists $cb_id{$type}) {
656	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;	1126	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
657		1127
658	} elsif (ref $type) {	1128	} elsif (ref $type) {
659	warn "attaching objects not supported, ignoring.\n";	1129	error "attaching objects not supported, ignoring.\n";
660		1130
661	} else {	1131	} else {
662	shift @arg;	1132	shift @arg;
663	warn "attach argument '$type' not supported, ignoring.\n";	1133	error "attach argument '$type' not supported, ignoring.\n";
664	}	1134	}
665	}	1135	}
666	}	1136	}
667		1137
668	sub _object_attach {	1138	sub _object_attach {
…		…
678	_attach $registry, $klass, @attach;	1148	_attach $registry, $klass, @attach;
679	}	1149	}
680		1150
681	$obj->{$name} = \%arg;	1151	$obj->{$name} = \%arg;
682	} else {	1152	} else {
683	warn "object uses attachment '$name' that is not available, postponing.\n";	1153	info "object uses attachment '$name' which is not available, postponing.\n";
684	}	1154	}
685		1155
686	$obj->{_attachment}{$name} = undef;	1156	$obj->{_attachment}{$name} = undef;
687	}	1157	}
688		1158
…		…
690	if (ref $_[0]) {	1160	if (ref $_[0]) {
691	_object_attach @_;	1161	_object_attach @_;
692	} else {	1162	} else {
693	_attach shift->_attach_registry, @_;	1163	_attach shift->_attach_registry, @_;
694	}	1164	}
		1165	_recalc_want;
695	};	1166	};
696		1167
697	# all those should be optimised	1168	# all those should be optimised
698	sub cf::attachable::detach {	1169	sub cf::attachable::detach {
699	my ($obj, $name) = @_;	1170	my ($obj, $name) = @_;
…		…
702	delete $obj->{_attachment}{$name};	1173	delete $obj->{_attachment}{$name};
703	reattach ($obj);	1174	reattach ($obj);
704	} else {	1175	} else {
705	Carp::croak "cannot, currently, detach class attachments";	1176	Carp::croak "cannot, currently, detach class attachments";
706	}	1177	}
		1178	_recalc_want;
707	};	1179	};
708		1180
709	sub cf::attachable::attached {	1181	sub cf::attachable::attached {
710	my ($obj, $name) = @_;	1182	my ($obj, $name) = @_;
711		1183
…		…
726	";	1198	";
727	die if $@;	1199	die if $@;
728	}	1200	}
729		1201
730	our $override;	1202	our $override;
731	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?
732		1204
733	sub override {	1205	sub override {
734	$override = 1;	1206	$override = 1;
735	@invoke_results = ();	1207	@INVOKE_RESULTS = (@_);
736	}	1208	}
737		1209
738	sub do_invoke {	1210	sub do_invoke {
739	my $event = shift;	1211	my $event = shift;
740	my $callbacks = shift;	1212	my $callbacks = shift;
741		1213
742	@invoke_results = ();	1214	@INVOKE_RESULTS = ();
743		1215
744	local $override;	1216	local $override;
745		1217
746	for (@$callbacks) {	1218	for (@$callbacks) {
747	eval { &{$_->[1]} };	1219	eval { &{$_->[1]} };
748		1220
749	if ($@) {	1221	if ($@) {
750	warn "$@";
751	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";	1222	error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
752	override;	1223	override;
753	}	1224	}
754		1225
755	return 1 if $override;	1226	return 1 if $override;
756	}	1227	}
757		1228
758	0	1229	0
759	}	1230	}
760		1231
761	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1232	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
762		1233
763	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1234	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
764		1235
765	Generate an object-specific event with the given arguments.	1236	Generate an object-specific event with the given arguments.
766		1237
767	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
768	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
769	results (if you must, access C<@cf::invoke_results> directly).	1240	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
770		1241
771	=back	1242	=back
772		1243
773	=cut	1244	=cut
774		1245
775	#############################################################################	1246	#############################################################################
776	# 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	}
777		1290
778	sub reattach {	1291	sub reattach {
779	# basically do the same as instantiate, without calling instantiate	1292	# basically do the same as instantiate, without calling instantiate
780	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
781		1297
782	my $registry = $obj->registry;	1298	my $registry = $obj->registry;
783		1299
784	@$registry = ();	1300	@$registry = ();
785		1301
…		…
790	for (@$attach) {	1306	for (@$attach) {
791	my ($klass, @attach) = @$_;	1307	my ($klass, @attach) = @$_;
792	_attach $registry, $klass, @attach;	1308	_attach $registry, $klass, @attach;
793	}	1309	}
794	} else {	1310	} else {
795	warn "object uses attachment '$name' that is not available, postponing.\n";	1311	info "object uses attachment '$name' that is not available, postponing.\n";
796	}	1312	}
797	}	1313	}
798	}	1314	}
799		1315
800	cf::attachable->attach (	1316	cf::attachable->attach (
801	prio => -1000000,	1317	prio => -1000000,
802	on_instantiate => sub {	1318	on_instantiate => sub {
803	my ($obj, $data) = @_;	1319	my ($obj, $data) = @_;
804		1320
805	$data = from_json $data;	1321	$data = decode_json $data;
806		1322
807	for (@$data) {	1323	for (@$data) {
808	my ($name, $args) = @$_;	1324	my ($name, $args) = @$_;
809		1325
810	$obj->attach ($name, %{$args || {} });	1326	$obj->attach ($name, %{$args || {} });
…		…
826	sub object_freezer_save {	1342	sub object_freezer_save {
827	my ($filename, $rdata, $objs) = @_;	1343	my ($filename, $rdata, $objs) = @_;
828		1344
829	sync_job {	1345	sync_job {
830	if (length $$rdata) {	1346	if (length $$rdata) {
		1347	utf8::decode (my $decname = $filename);
831	warn sprintf "saving %s (%d,%d)\n",	1348	trace sprintf "saving %s (%d,%d)\n",
832	$filename, length $$rdata, scalar @$objs;	1349	$decname, length $$rdata, scalar @$objs
		1350	if $VERBOSE_IO;
833		1351
834	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1352	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835	chmod SAVE_MODE, $fh;	1353	aio_chmod $fh, SAVE_MODE;
836	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;
837	aio_fsync $fh;	1357	aio_fsync $fh;
		1358	}
838	close $fh;	1359	aio_close $fh;
839		1360
840	if (@$objs) {	1361	if (@$objs) {
841	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) {
842	chmod SAVE_MODE, $fh;	1363	aio_chmod $fh, SAVE_MODE;
843	my $data = Storable::nfreeze { version => 1, objs => $objs };	1364	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
844	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;
845	aio_fsync $fh;	1368	aio_fsync $fh;
		1369	}
846	close $fh;	1370	aio_close $fh;
847	aio_rename "$filename.pst~", "$filename.pst";	1371	aio_rename "$filename.pst~", "$filename.pst";
848	}	1372	}
849	} else {	1373	} else {
850	aio_unlink "$filename.pst";	1374	aio_unlink "$filename.pst";
851	}	1375	}
852		1376
853	aio_rename "$filename~", $filename;	1377	aio_rename "$filename~", $filename;
		1378
		1379	$filename =~ s%/[^/]+$%%;
		1380	aio_pathsync $filename if $cf::USE_FSYNC;
854	} else {	1381	} else {
855	warn "FATAL: $filename~: $!\n";	1382	error "unable to save objects: $filename~: $!\n";
856	}	1383	}
857	} else {	1384	} else {
858	aio_unlink $filename;	1385	aio_unlink $filename;
859	aio_unlink "$filename.pst";	1386	aio_unlink "$filename.pst";
860	}	1387	}
861	}	1388	};
862	}	1389	}
863		1390
864	sub object_freezer_as_string {	1391	sub object_freezer_as_string {
865	my ($rdata, $objs) = @_;	1392	my ($rdata, $objs) = @_;
866		1393
…		…
878	or return;	1405	or return;
879		1406
880	unless (aio_stat "$filename.pst") {	1407	unless (aio_stat "$filename.pst") {
881	(aio_load "$filename.pst", $av) >= 0	1408	(aio_load "$filename.pst", $av) >= 0
882	or return;	1409	or return;
		1410
883	$av = eval { (Storable::thaw $av)->{objs} };	1411	my $st = eval { Coro::Storable::thaw $av };
		1412	$av = $st->{objs};
884	}	1413	}
885		1414
		1415	utf8::decode (my $decname = $filename);
886	warn sprintf "loading %s (%d)\n",	1416	trace sprintf "loading %s (%d,%d)\n",
887	$filename, length $data, scalar @{$av || []};#d#	1417	$decname, length $data, scalar @{$av || []}
		1418	if $VERBOSE_IO;
		1419
888	return ($data, $av);	1420	($data, $av)
889	}	1421	}
		1422
		1423	=head2 COMMAND CALLBACKS
		1424
		1425	=over 4
		1426
		1427	=cut
890		1428
891	#############################################################################	1429	#############################################################################
892	# command handling &c	1430	# command handling &c
893		1431
894	=item cf::register_command $name => \&callback($ob,$args);	1432	=item cf::register_command $name => \&callback($ob,$args);
…		…
907	push @{ $COMMAND{$name} }, [$caller, $cb];	1445	push @{ $COMMAND{$name} }, [$caller, $cb];
908	}	1446	}
909		1447
910	=item cf::register_extcmd $name => \&callback($pl,$packet);	1448	=item cf::register_extcmd $name => \&callback($pl,$packet);
911		1449
912	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.
913		1455
914	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
915	called.	1457	called.
916		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
917	=cut	1470	=cut
918		1471
919	sub register_extcmd {	1472	sub register_extcmd {
920	my ($name, $cb) = @_;	1473	my ($name, $cb) = @_;
921		1474
922	my $caller = caller;
923	#warn "registering extcmd '$name' to '$caller'";
924
925	$EXTCMD{$name} = [$cb, $caller];	1475	$EXTCMD{$name} = $cb;
926	}	1476	}
		1477
		1478	sub register_exticmd {
		1479	my ($name, $cb) = @_;
		1480
		1481	$EXTICMD{$name} = $cb;
		1482	}
		1483
		1484	use File::Glob ();
927		1485
928	cf::player->attach (	1486	cf::player->attach (
929	on_command => sub {	1487	on_unknown_command => sub {
930	my ($pl, $name, $params) = @_;	1488	my ($pl, $name, $params) = @_;
931		1489
932	my $cb = $COMMAND{$name}	1490	my $cb = $COMMAND{$name}
933	or return;	1491	or return;
934		1492
…		…
939	cf::override;	1497	cf::override;
940	},	1498	},
941	on_extcmd => sub {	1499	on_extcmd => sub {
942	my ($pl, $buf) = @_;	1500	my ($pl, $buf) = @_;
943		1501
944	my $msg = eval { from_json $buf };	1502	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
945		1503
946	if (ref $msg) {	1504	if (ref $msg) {
		1505	my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
		1506
		1507	my @reply;
		1508
947	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1509	if (my $cb = $EXTCMD{$type}) {
948	if (my %reply = $cb->[0]->($pl, $msg)) {	1510	@reply = $cb->($pl, @payload);
949	$pl->ext_reply ($msg->{msgid}, %reply);
950	}
951	}	1511	}
		1512
		1513	$pl->ext_reply ($reply, @reply)
		1514	if $reply;
		1515
952	} else {	1516	} else {
953	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1517	error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
954	}	1518	}
955		1519
956	cf::override;	1520	cf::override;
957	},	1521	},
958	);	1522	);
959		1523
960	sub register {	1524	# "readahead" all extensions
961	my ($base, $pkg) = @_;
962
963	#TODO
964	}
965
966	sub load_extension {	1525	sub cache_extensions {
967	my ($path) = @_;	1526	my $grp = IO::AIO::aio_group;
968		1527
969	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1528	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
970	my $base = $1;	1529	for (grep /\.ext$/, @{$_[0]}) {
971	my $pkg = $1;	1530	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
972	$pkg =~ s/[^[:word:]]/_/g;
973	$pkg = "ext::$pkg";
974
975	warn "loading '$path' into '$pkg'\n";
976
977	open my $fh, "<:utf8", $path
978	or die "$path: $!";
979
980	my $source =
981	"package $pkg; use strict; use utf8;\n"
982	. "#line 1 \"$path\"\n{\n"
983	. (do { local $/; <$fh> })
984	. "\n};\n1";
985
986	eval $source
987	or die $@ ? "$path: $@\n"
988	: "extension disabled.\n";
989
990	push @exts, $pkg;
991	$ext_pkg{$base} = $pkg;
992
993	# no strict 'refs';
994	# @{"$pkg\::ISA"} = ext::;
995
996	register $base, $pkg;
997	}
998
999	sub unload_extension {
1000	my ($pkg) = @_;
1001
1002	warn "removing extension $pkg\n";
1003
1004	# remove hooks
1005	#TODO
1006	# for my $idx (0 .. $#PLUGIN_EVENT) {
1007	# delete $hook[$idx]{$pkg};
1008	# }
1009
1010	# remove commands
1011	for my $name (keys %COMMAND) {
1012	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014	if (@cb) {
1015	$COMMAND{$name} = \@cb;
1016	} else {
1017	delete $COMMAND{$name};
1018	}	1531	}
1019	}	1532	};
1020		1533
1021	# remove extcmds	1534	$grp
1022	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1535	}
1023	delete $EXTCMD{$name};
1024	}
1025		1536
1026	if (my $cb = $pkg->can ("unload")) {	1537	sub _ext_cfg_reg($$$$) {
1027	eval {	1538	my ($rvar, $varname, $cfgname, $default) = @_;
1028	$cb->($pkg);
1029	1
1030	} or warn "$pkg unloaded, but with errors: $@";
1031	}
1032		1539
1033	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;
1034	}	1546	}
1035		1547
1036	sub load_extensions {	1548	sub load_extensions {
		1549	info "loading extensions...";
		1550
		1551	%EXT_CFG = ();
		1552
		1553	cf::sync_job {
		1554	my %todo;
		1555
1037	for my $ext (<$LIBDIR/*.ext>) {	1556	for my $path (<$LIBDIR/*.ext>) {
1038	next unless -r $ext;	1557	next unless -r $path;
1039	eval {	1558
1040	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	}
1041	1	1631	}
1042	} 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	}
1043	}	1644	};
1044	}	1645	}
1045		1646
1046	#############################################################################	1647	#############################################################################
1047	# load/save/clean perl data associated with a map
1048		1648
1049	*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($) {
1050	my ($map) = @_;	1703	my ($login) = @_;
1051		1704
1052	my $path = $map->tmpname;	1705	$cf::PLAYER{$login}
1053	defined $path or return;	1706	or !aio_stat path $login
1054
1055	unlink "$path.pst";
1056	};
1057
1058	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060	#############################################################################
1061	# load/save perl data associated with player->ob objects
1062
1063	sub all_objects(@) {
1064	@_, map all_objects ($_->inv), @_
1065	}	1707	}
1066		1708
1067	# 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
1068	cf::player->attach (	1736	cf::player->attach (
1069	on_load => sub {	1737	on_load => sub {
1070	my ($pl, $path) = @_;	1738	my ($pl, $path) = @_;
1071		1739
1072	for my $o (all_objects $pl->ob) {	1740	# restore slots saved in save, below
1073	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1741	my $slots = delete $pl->{_slots};
1074	$o->set_ob_key_value ("_perl_data");
1075		1742
1076	%$o = %{ Storable::thaw pack "H*", $value };	1743	$pl->ob->current_weapon ($slots->[0]);
1077	}	1744	$pl->combat_ob ($slots->[1]);
1078	}	1745	$pl->ranged_ob ($slots->[2]);
1079	},	1746	},
1080	);	1747	);
1081		1748
1082	#############################################################################	1749	sub save($) {
		1750	my ($pl) = @_;
1083		1751
1084	=head2 CORE EXTENSIONS	1752	return if $pl->{deny_save};
1085		1753
1086	Functions and methods that extend core crossfire objects.	1754	my $path = path $pl;
		1755	my $guard = cf::lock_acquire "user_save:$path";
1087		1756
1088	=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
1089		1936
1090	=over 4	1937	=over 4
1091		1938
1092	=item cf::player::exists $login
1093
1094	Returns true when the given account exists.
1095
1096	=cut	1939	=cut
1097		1940
1098	sub cf::player::exists($) {	1941	package cf::region;
1099	cf::player::find $_[0]
1100	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1101	}
1102		1942
1103	=item $player->ext_reply ($msgid, $msgtype, %msg)	1943	=item cf::region::find_by_path $path
1104		1944
1105	Sends an ext reply to the player.	1945	Tries to decuce the likely region for a map knowing only its path.
1106		1946
1107	=cut	1947	=cut
1108		1948
1109	sub cf::player::ext_reply($$$%) {	1949	sub find_by_path($) {
1110	my ($self, $id, %msg) = @_;	1950	my ($path) = @_;
1111		1951
1112	$msg{msgid} = $id;	1952	$path =~ s/^~[^\/]*//; # skip ~login
1113		1953
1114	$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
1115	}	1964	}
1116		1965
1117	=back	1966	=back
1118
1119		1967
1120	=head3 cf::map	1968	=head3 cf::map
1121		1969
1122	=over 4	1970	=over 4
1123		1971
…		…
1126	package cf::map;	1974	package cf::map;
1127		1975
1128	use Fcntl;	1976	use Fcntl;
1129	use Coro::AIO;	1977	use Coro::AIO;
1130		1978
		1979	use overload
		1980	'""' => \&as_string,
		1981	fallback => 1;
		1982
1131	our $MAX_RESET = 7200;	1983	our $MAX_RESET = 3600;
1132	our $DEFAULT_RESET = 3600;	1984	our $DEFAULT_RESET = 3000;
1133		1985
1134	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 {
1135	my ($path, $rmp) = @_;	2025	my ($path, $base) = @_;
1136		2026
1137	# mit "rum" bekleckern, nicht	2027	$path = "$path"; # make sure it's a string
1138	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
1139	$path,	2056	$path
1140	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143	$rmp->{exit_on_final_map},
1144	$rmp->{xsize}, $rmp->{ysize},
1145	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1149	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150	(cf::region::find $rmp->{region})
1151	}	2057	}
1152		2058
1153	# and all this just because we cannot iterate over	2059	sub new_from_path {
1154	# all maps in C++...	2060	my (undef, $path, $base) = @_;
1155	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 {
1156	my ($change) = @_;	2081	my ($self) = @_;
1157		2082
1158	$_->change_map_light ($change)	2083	$self
1159	for grep $_->outdoor, values %cf::MAP;
1160	}	2084	}
1161		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
1162	sub try_load_header($) {	2136	sub load_header_from($) {
1163	my ($path) = @_;	2137	my ($self, $path) = @_;
1164		2138
1165	utf8::encode $path;	2139	utf8::encode $path;
1166	aio_open $path, O_RDONLY, 0	2140	my $f = new_from_file cf::object::thawer $path
1167	or return;	2141	or return;
1168		2142
1169	my $map = cf::map::new	2143	$self->_load_header ($f)
1170	or return;	2144	or return;
1171		2145
1172	$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
1173	or return;	2196	or return;
		2197	$self->prepare_orig;
		2198	}
1174		2199
1175	$map->{load_path} = $path;	2200	$self->{deny_reset} = 1
		2201	if $self->no_reset;
1176		2202
1177	$map	2203	$self->default_region (cf::region::find_by_path $self->{path})
1178	}	2204	unless $self->default_region;
1179		2205
		2206	1
		2207	}
		2208
		2209	sub find;
1180	sub find_map {	2210	sub find {
1181	my ($path, $origin) = @_;	2211	my ($path, $origin) = @_;
1182		2212
1183	#warn "find_map<$path,$origin>\n";#d#	2213	cf::cede_to_tick;
1184		2214
1185	$path = new cf::path $path, $origin && $origin->path;	2215	$path = normalise $path, $origin;
1186	my $key = $path->as_string;
1187		2216
1188	cf::lock_wait "map_find:$key";	2217	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1189
1190	$cf::MAP{$key} || do {
1191	my $guard = cf::lock_acquire "map_find:$key";	2218	my $guard2 = cf::lock_acquire "map_find:$path";
1192		2219
1193	# do it the slow way	2220	$cf::MAP{$path} || do {
1194	my $map = try_load_header $path->save_path;	2221	my $map = new_from_path cf::map $path
1195
1196	if ($map) {
1197	# safety
1198	$map->{instantiate_time} = $cf::RUNTIME
1199	if $map->{instantiate_time} > $cf::RUNTIME;
1200	} else {
1201	if (my $rmp = $path->random_map_params) {
1202	$map = generate_random_map $key, $rmp;
1203	} else {
1204	$map = try_load_header $path->load_path;
1205	}
1206
1207	$map or return;	2222	or return;
1208		2223
1209	$map->{load_original} = 1;
1210	$map->{instantiate_time} = $cf::RUNTIME;
1211	$map->instantiate;
1212
1213	# per-player maps become, after loading, normal maps
1214	$map->per_player (0) if $path->{user_rel};
1215	}
1216
1217	$map->path ($key);
1218	$map->{path} = $path;
1219	$map->{last_save} = $cf::RUNTIME;	2224	$map->{last_save} = $cf::RUNTIME;
1220	$map->last_access ($cf::RUNTIME);
1221		2225
1222	if ($map->should_reset) {	2226	$map->load_header
		2227	or return;
		2228
		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;
1223	$map->reset;	2234	$map->reset;
1224	undef $guard;	2235	return find $path;
1225	$map = find_map $path;
1226	}	2236	}
1227		2237
1228	$cf::MAP{$key} = $map	2238	$cf::MAP{$path} = $map
1229	}	2239	}
1230	}	2240	}
		2241
		2242	sub pre_load { }
		2243	#sub post_load { } # XS
1231		2244
1232	sub load {	2245	sub load {
1233	my ($self) = @_;	2246	my ($self) = @_;
1234		2247
		2248	local $self->{deny_reset} = 1; # loading can take a long time
		2249
1235	my $path = $self->{path};	2250	my $path = $self->{path};
		2251
		2252	{
1236	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2253	my $guard = cf::lock_acquire "map_data:$path";
1237		2254
1238	return if $self->in_memory != cf::MAP_SWAPPED;	2255	return unless $self->valid;
		2256	return unless $self->state == cf::MAP_SWAPPED;
1239		2257
1240	$self->in_memory (cf::MAP_LOADING);
1241
1242	$self->alloc;	2258	$self->alloc;
1243	$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)
1244	or return;	2267	or return;
1245		2268
1246	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2269	$self->post_load_original
1247	if delete $self->{load_original};	2270	if delete $self->{load_original};
1248		2271
1249	if (my $uniq = $path->uniq_path) {	2272	if (my $uniq = $self->uniq_path) {
1250	utf8::encode $uniq;	2273	utf8::encode $uniq;
1251	if (aio_open $uniq, O_RDONLY, 0) {	2274	unless (aio_stat $uniq) {
		2275	if (my $f = new_from_file cf::object::thawer $uniq) {
1252	$self->clear_unique_items;	2276	$self->clear_unique_items;
1253	$self->load_objects ($uniq, 0);	2277	$self->_load_objects ($f);
		2278	$f->resolve_delayed_derefs;
		2279	}
		2280	}
1254	}	2281	}
1255	}
1256		2282
		2283	$f->resolve_delayed_derefs;
		2284	} else {
		2285	$self->post_load_original
		2286	if delete $self->{load_original};
		2287	}
		2288
		2289	$self->state (cf::MAP_INACTIVE);
		2290
		2291	cf::cede_to_tick;
1257	# now do the right thing for maps	2292	# now do the right thing for maps
1258	$self->link_multipart_objects;	2293	$self->link_multipart_objects;
1259
1260	if ($self->{path}->is_style_map) {
1261	$self->{deny_save} = 1;
1262	$self->{deny_reset} = 1;
1263	} else {
1264	$self->fix_auto_apply;
1265	$self->decay_objects;
1266	$self->update_buttons;
1267	$self->set_darkness_map;
1268	$self->difficulty ($self->estimate_difficulty)	2294	$self->difficulty ($self->estimate_difficulty)
1269	unless $self->difficulty;	2295	unless $self->difficulty;
1270	$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
1271	}	2312	1
1272
1273	$self->in_memory (cf::MAP_IN_MEMORY);
1274	}	2313	}
1275		2314
1276	sub load_map_sync {	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) = @_;
		2320
		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
		2328	}
		2329
		2330	sub find_sync {
1277	my ($path, $origin) = @_;	2331	my ($path, $origin) = @_;
1278		2332
1279	#warn "load_map_sync<$path, $origin>\n";#d#	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;
1280		2336
1281	cf::sync_job {	2337	find $path, $origin
1282	my $map = cf::map::find_map $path, $origin	2338	}
1283	or return;	2339
		2340	sub do_load_sync {
		2341	my ($map) = @_;
		2342
		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
1284	$map->load;	2347	$map->load;
1285	$map	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);
1286	}	2412	}
1287	}	2413	}
1288		2414
1289	sub save {	2415	sub save {
1290	my ($self) = @_;	2416	my ($self) = @_;
1291		2417
1292	$self->{last_save} = $cf::RUNTIME;	2418	my $lock = cf::lock_acquire "map_data:$self->{path}";
1293		2419
1294	return unless $self->dirty;	2420	$self->_save;
1295
1296	my $save = $self->{path}->save_path; utf8::encode $save;
1297	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1298
1299	$self->{load_path} = $save;
1300
1301	return if $self->{deny_save};
1302
1303	if ($uniq) {
1304	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1305	$self->save_objects ($uniq, cf::IO_UNIQUES);
1306	} else {
1307	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1308	}
1309	}	2421	}
1310		2422
1311	sub swap_out {	2423	sub swap_out {
1312	my ($self) = @_;	2424	my ($self) = @_;
1313		2425
		2426	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2427
		2428	return if !$self->linkable;
		2429	return if $self->{deny_save};
1314	return if $self->players;	2430	return if $self->players;
1315	return if $self->in_memory != cf::MAP_IN_MEMORY;
1316	return if $self->{deny_save};
1317		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
1318	$self->save;	2438	$self->_save;
		2439
		2440	# then free the map
1319	$self->clear;	2441	$self->clear;
1320	$self->in_memory (cf::MAP_SWAPPED);
1321	}	2442	}
1322		2443
1323	sub reset_at {	2444	sub reset_at {
1324	my ($self) = @_;	2445	my ($self) = @_;
1325		2446
1326	# TODO: safety, remove and allow resettable per-player maps	2447	# TODO: safety, remove and allow resettable per-player maps
1327	return 1e99 if $self->{path}{user_rel};
1328	return 1e99 if $self->{deny_reset};	2448	return 1e99 if $self->{deny_reset};
1329		2449
1330	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2450	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1331	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;
1332		2452
…		…
1337	my ($self) = @_;	2457	my ($self) = @_;
1338		2458
1339	$self->reset_at <= $cf::RUNTIME	2459	$self->reset_at <= $cf::RUNTIME
1340	}	2460	}
1341		2461
1342	sub unlink_save {
1343	my ($self) = @_;
1344
1345	utf8::encode (my $save = $self->{path}->save_path);
1346	aioreq_pri 3; IO::AIO::aio_unlink $save;
1347	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1348	}
1349
1350	sub rename {
1351	my ($self, $new_path) = @_;
1352
1353	$self->unlink_save;
1354
1355	delete $cf::MAP{$self->path};
1356	$self->{path} = new cf::path $new_path;
1357	$self->path ($self->{path}->as_string);
1358	$cf::MAP{$self->path} = $self;
1359
1360	$self->save;
1361	}
1362
1363	sub reset {	2462	sub reset {
1364	my ($self) = @_;	2463	my ($self) = @_;
1365		2464
		2465	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2466
1366	return if $self->players;	2467	return if $self->players;
1367	return if $self->{path}{user_rel};#d#
1368		2468
1369	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	}
1370		2480
1371	delete $cf::MAP{$self->path};	2481	delete $cf::MAP{$self->path};
1372		2482
		2483	$self->deactivate;
1373	$_->clear_links_to ($self) for values %cf::MAP;	2484	$_->clear_links_to ($self) for values %cf::MAP;
		2485	$self->clear;
1374		2486
1375	$self->unlink_save;	2487	$self->unlink_save;
1376	$self->destroy;	2488	$self->destroy;
1377	}	2489	}
1378		2490
1379	my $nuke_counter = "aaaa";	2491	my $nuke_counter = "aaaa";
1380		2492
1381	sub nuke {	2493	sub nuke {
1382	my ($self) = @_;	2494	my ($self) = @_;
1383		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};
1384	$self->{deny_save} = 1;	2505	$self->{deny_save} = 1;
1385	$self->reset_timeout (1);	2506	$self->reset_timeout (1);
1386	$self->rename ("{nuke}/" . ($nuke_counter++));	2507	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2508
		2509	$cf::MAP{$self->path} = $self;
		2510	}
		2511
1387	$self->reset; # polite request, might not happen	2512	$self->reset; # polite request, might not happen
1388	}	2513	}
1389		2514
1390	sub customise_for {	2515	=item $maps = cf::map::tmp_maps
1391	my ($map, $ob) = @_;
1392		2516
1393	if ($map->per_player) {	2517	Returns an arrayref with all map paths of currently instantiated and saved
1394	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2518	maps. May block.
		2519
		2520	=cut
		2521
		2522	sub tmp_maps() {
1395	}	2523	[
1396		2524	map {
1397	$map	2525	utf8::decode $_;
		2526	/\.map$/
		2527	? normalise $_
		2528	: ()
		2529	} @{ aio_readdir $TMPDIR or [] }
		2530	]
1398	}	2531	}
1399		2532
1400	sub emergency_save {	2533	=item $maps = cf::map::random_maps
1401	local $cf::FREEZE = 1;
1402		2534
1403	warn "enter emergency map save\n";	2535	Returns an arrayref with all map paths of currently instantiated and saved
		2536	random maps. May block.
1404		2537
1405	cf::sync_job {	2538	=cut
1406	warn "begin emergency map save\n";	2539
1407	$_->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;
1408	};	2597	}
1409		2598
1410	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	}
1411	}	2654	}
1412		2655
1413	package cf;	2656	package cf;
1414		2657
1415	=back	2658	=back
1416
1417		2659
1418	=head3 cf::object::player	2660	=head3 cf::object::player
1419		2661
1420	=over 4	2662	=over 4
1421		2663
…		…
1424	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>
1425	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
1426	dialogue with the given NPC character.	2668	dialogue with the given NPC character.
1427		2669
1428	=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	};
1429		2685
1430	# rough implementation of a future "reply" method that works	2686	# rough implementation of a future "reply" method that works
1431	# with dialog boxes.	2687	# with dialog boxes.
1432	#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
1433	sub cf::object::player::reply($$$;$) {	2689	sub cf::object::player::reply($$$;$) {
…		…
1435		2691
1436	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2692	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1437		2693
1438	if ($self->{record_replies}) {	2694	if ($self->{record_replies}) {
1439	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2695	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2696
1440	} 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 {
1441	$msg = $npc->name . " says: $msg" if $npc;	2705	$msg = $npc->name . " says: $msg" if $npc;
1442	$self->message ($msg, $flags);	2706	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2707	}
1443	}	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 (@_);
1444	}	2719	}
1445		2720
1446	=item $player_object->may ("access")	2721	=item $player_object->may ("access")
1447		2722
1448	Returns wether the given player is authorized to access resource "access"	2723	Returns wether the given player is authorized to access resource "access"
…		…
1461		2736
1462	=item $player_object->enter_link	2737	=item $player_object->enter_link
1463		2738
1464	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}>).
1465		2740
1466	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.
1467	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.
1468		2747
1469	=item $player_object->leave_link ($map, $x, $y)	2748	=item $player_object->leave_link ($map, $x, $y)
1470		2749
1471	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
1472	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
1473	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
1474	to the emergency map position.	2753	fails, to the emergency map position.
1475		2754
1476	Might block.	2755	Might block.
1477		2756
1478	=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	}
1479		2768
1480	sub cf::object::player::enter_link {	2769	sub cf::object::player::enter_link {
1481	my ($self) = @_;	2770	my ($self) = @_;
1482		2771
1483	$self->deactivate_recursive;	2772	$self->deactivate_recursive;
1484		2773
1485	return if $self->map == $LINK_MAP;	2774	++$self->{_link_recursion};
		2775
		2776	return if UNIVERSAL::isa $self->map, "ext::map_link";
1486		2777
1487	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2778	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1488	if $self->map;	2779	if $self->map && $self->map->{path} ne "{link}";
1489		2780
1490	$self->enter_map ($LINK_MAP, 20, 20);	2781	$self->enter_map ($LINK_MAP || link_map, 3, 3);
1491	}	2782	}
1492		2783
1493	sub cf::object::player::leave_link {	2784	sub cf::object::player::leave_link {
1494	my ($self, $map, $x, $y) = @_;	2785	my ($self, $map, $x, $y) = @_;
		2786
		2787	return unless $self->contr->active;
1495		2788
1496	my $link_pos = delete $self->{_link_pos};	2789	my $link_pos = delete $self->{_link_pos};
1497		2790
1498	unless ($map) {	2791	unless ($map) {
1499	# restore original map position	2792	# restore original map position
1500	($map, $x, $y) = @{ $link_pos || [] };	2793	($map, $x, $y) = @{ $link_pos || [] };
1501	$map = cf::map::find_map $map;	2794	$map = cf::map::find $map;
1502		2795
1503	unless ($map) {	2796	unless ($map) {
1504	($map, $x, $y) = @$EMERGENCY_POSITION;	2797	($map, $x, $y) = @$EMERGENCY_POSITION;
1505	$map = cf::map::find_map $map	2798	$map = cf::map::find $map
1506	or die "FATAL: cannot load emergency map\n";	2799	or die "FATAL: cannot load emergency map\n";
1507	}	2800	}
1508	}	2801	}
1509		2802
1510	($x, $y) = (-1, -1)	2803	($x, $y) = (-1, -1)
1511	unless (defined $x) && (defined $y);	2804	unless (defined $x) && (defined $y);
1512		2805
1513	# use -1 or undef as default coordinates, not 0, 0	2806	# use -1 or undef as default coordinates, not 0, 0
1514	($x, $y) = ($map->enter_x, $map->enter_y)	2807	($x, $y) = ($map->enter_x, $map->enter_y)
1515	if $x <=0 && $y <= 0;	2808	if $x <= 0 && $y <= 0;
1516		2809
1517	$map->load;	2810	$map->load;
1518		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
1519	$self->activate_recursive;	2819	$self->activate_recursive;
1520	$self->enter_map ($map, $x, $y);
1521	}
1522
1523	cf::player->attach (
1524	on_logout => sub {
1525	my ($pl) = @_;
1526
1527	# abort map switching before logout
1528	if ($pl->ob->{_link_pos}) {
1529	cf::sync_job {
1530	$pl->ob->leave_link
1531	};
1532	}
1533	},	2820	}
1534	on_login => sub {
1535	my ($pl) = @_;
1536		2821
1537	# try to abort aborted map switching on player login :)	2822	}
1538	# should happen only on crashes
1539	if ($pl->ob->{_link_pos}) {
1540	$pl->ob->enter_link;
1541	Coro::async {
1542	# we need this sleep as the login has a concurrent enter_exit running
1543	# and this sleep increases chances of the player not ending up in scorn
1544	Coro::Timer::sleep 1;
1545	$pl->ob->leave_link;
1546	};
1547	}
1548	},
1549	);
1550		2823
1551	=item $player_object->goto_map ($path, $x, $y)	2824	=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1552		2825
1553	=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.
1554		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
1555	sub cf::object::player::goto_map {	2839	sub cf::object::player::goto {
1556	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;
1557		2850
1558	$self->enter_link;	2851	$self->enter_link;
1559		2852
1560	(Coro::async {	2853	(async {
1561	$path = new cf::path $path;	2854	$Coro::current->{desc} = "player::goto $path $x $y";
1562		2855
1563	my $map = cf::map::find_map $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) {
1564	$map = $map->customise_for ($self) if $map;	2879	$map = $map->customise_for ($self);
1565		2880	$map = $check->($map, $x, $y, $self) if $check && $map;
1566	# warn "entering ", $map->path, " at ($x, $y)\n"	2881	} else {
1567	# if $map;
1568
1569	$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	}
1570		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};
1571	$self->leave_link ($map, $x, $y);	2895	$self->leave_link ($map, $x, $y);
		2896	}
		2897
		2898	$done->($self) if $done;
1572	})->prio (1);	2899	})->prio (1);
1573	}	2900	}
1574		2901
1575	=item $player_object->enter_exit ($exit_object)	2902	=item $player_object->enter_exit ($exit_object)
1576		2903
…		…
1578		2905
1579	sub parse_random_map_params {	2906	sub parse_random_map_params {
1580	my ($spec) = @_;	2907	my ($spec) = @_;
1581		2908
1582	my $rmp = { # defaults	2909	my $rmp = { # defaults
1583	xsize => 10,	2910	xsize => (cf::rndm 15, 40),
1584	ysize => 10,	2911	ysize => (cf::rndm 15, 40),
		2912	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2913	#layout => string,
1585	};	2914	};
1586		2915
1587	for (split /\n/, $spec) {	2916	for (split /\n/, $spec) {
1588	my ($k, $v) = split /\s+/, $_, 2;	2917	my ($k, $v) = split /\s+/, $_, 2;
1589		2918
…		…
1601	# that depends on the exit object	2930	# that depends on the exit object
1602		2931
1603	my $rmp = parse_random_map_params $exit->msg;	2932	my $rmp = parse_random_map_params $exit->msg;
1604		2933
1605	if ($exit->map) {	2934	if ($exit->map) {
1606	$rmp->{region} = $exit->map->region_name;	2935	$rmp->{region} = $exit->region->name;
1607	$rmp->{origin_map} = $exit->map->path;	2936	$rmp->{origin_map} = $exit->map->path;
1608	$rmp->{origin_x} = $exit->x;	2937	$rmp->{origin_x} = $exit->x;
1609	$rmp->{origin_y} = $exit->y;	2938	$rmp->{origin_y} = $exit->y;
		2939
		2940	$exit->map->touch;
1610	}	2941	}
1611		2942
1612	$rmp->{random_seed} ||= $exit->random_seed;	2943	$rmp->{random_seed} ||= $exit->random_seed;
1613		2944
1614	my $data = cf::to_json $rmp;	2945	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1615	my $md5 = Digest::MD5::md5_hex $data;	2946	my $md5 = Digest::MD5::md5_hex $data;
		2947	my $meta = "$RANDOMDIR/$md5.meta";
1616		2948
1617	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) {
1618	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;
1619		2953
		2954	my $slaying = "?random/$md5";
		2955
		2956	if ($exit->valid) {
1620	$exit->slaying ("?random/$md5");	2957	$exit->slaying ("?random/$md5");
1621	$exit->msg (undef);	2958	$exit->msg (undef);
		2959	}
1622	}	2960	}
1623	}	2961	}
1624		2962
1625	sub cf::object::player::enter_exit {	2963	sub cf::object::player::enter_exit {
1626	my ($self, $exit) = @_;	2964	my ($self, $exit) = @_;
1627		2965
1628	return unless $self->type == cf::PLAYER;	2966	return unless $self->type == cf::PLAYER;
1629		2967
1630	$self->enter_link;	2968	$self->enter_link;
1631		2969
1632	(Coro::async {	2970	(async {
		2971	$Coro::current->{desc} = "enter_exit";
		2972
1633	unless (eval {	2973	unless (eval {
		2974	$self->deactivate_recursive; # just to be sure
1634		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
1635	prepare_random_map $exit	2987	prepare_random_map $exit
		2988	if $exit->slaying eq "/!"; # need to re-check after getting the lock
		2989
1636	if $exit->slaying eq "/!";	2990	$map = $exit->slaying;
1637		2991
1638	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;	2992	} elsif ($slaying eq '!up') {
1639	$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;
1640		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
1641	1;	3009	1
1642	}) {	3010	}) {
1643	$self->message ("Something went wrong deep within the crossfire server. "	3011	$self->message ("Something went wrong deep within the deliantra server. "
1644	. "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. "
1645	. "Please report this to the dungeon master",	3013	. "Please report this to the dungeon master!",
1646	cf::NDI_UNIQUE | cf::NDI_RED);	3014	cf::NDI_UNIQUE | cf::NDI_RED);
1647		3015
1648	warn "ERROR in enter_exit: $@";	3016	error "ERROR in enter_exit: $@";
1649	$self->leave_link;	3017	$self->leave_link;
1650	}	3018	}
1651	})->prio (1);	3019	})->prio (1);
1652	}	3020	}
1653		3021
…		…
1664		3032
1665	sub cf::client::send_drawinfo {	3033	sub cf::client::send_drawinfo {
1666	my ($self, $text, $flags) = @_;	3034	my ($self, $text, $flags) = @_;
1667		3035
1668	utf8::encode $text;	3036	utf8::encode $text;
1669	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	3037	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1670	}	3038	}
1671		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	}
1672		3257
1673	=item $success = $client->query ($flags, "text", \&cb)	3258	=item $success = $client->query ($flags, "text", \&cb)
1674		3259
1675	Queues a query to the client, calling the given callback with	3260	Queues a query to the client, calling the given callback with
1676	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>,
1677	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>.
1678		3263
1679	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
1680	reliable at some point in the future.	3265	become reliable at some point in the future.
1681		3266
1682	=cut	3267	=cut
1683		3268
1684	sub cf::client::query {	3269	sub cf::client::query {
1685	my ($self, $flags, $text, $cb) = @_;	3270	my ($self, $flags, $text, $cb) = @_;
…		…
1693	utf8::encode $text;	3278	utf8::encode $text;
1694	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3279	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1695		3280
1696	$self->send_packet ($self->{query_queue}[0][0])	3281	$self->send_packet ($self->{query_queue}[0][0])
1697	if @{ $self->{query_queue} } == 1;	3282	if @{ $self->{query_queue} } == 1;
		3283
		3284	1
1698	}	3285	}
1699		3286
1700	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	},
1701	on_reply => sub {	3293	on_reply => sub {
1702	my ($ns, $msg) = @_;	3294	my ($ns, $msg) = @_;
1703		3295
1704	# this weird shuffling is so that direct followup queries	3296	# this weird shuffling is so that direct followup queries
1705	# get handled first	3297	# get handled first
1706	my $queue = delete $ns->{query_queue};	3298	my $queue = delete $ns->{query_queue}
		3299	or return; # be conservative, not sure how that can happen, but we saw a crash here
1707		3300
1708	(shift @$queue)->[1]->($msg);	3301	(shift @$queue)->[1]->($msg);
		3302	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1709		3303
1710	push @{ $ns->{query_queue} }, @$queue;	3304	push @{ $ns->{query_queue} }, @$queue;
1711		3305
1712	if (@{ $ns->{query_queue} } == @$queue) {	3306	if (@{ $ns->{query_queue} } == @$queue) {
1713	if (@$queue) {	3307	if (@$queue) {
…		…
1715	} else {	3309	} else {
1716	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3310	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1717	}	3311	}
1718	}	3312	}
1719	},	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	},
1720	);	3337	);
1721		3338
1722	=item $client->coro (\&cb)	3339	=item $client->async (\&cb)
1723		3340
1724	Create a new coroutine, running the specified callback. The coroutine will	3341	Create a new coroutine, running the specified callback. The coroutine will
1725	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,
1726	or loss of connection).	3343	or loss of connection).
1727		3344
1728	=cut	3345	=cut
1729		3346
1730	sub cf::client::coro {	3347	sub cf::client::async {
1731	my ($self, $cb) = @_;	3348	my ($self, $cb) = @_;
1732		3349
1733	my $coro; $coro = async {	3350	my $coro = &Coro::async ($cb);
1734	eval {
1735	$cb->();
1736	};
1737	warn $@ if $@;
1738	};
1739		3351
1740	$coro->on_destroy (sub {	3352	$coro->on_destroy (sub {
1741	delete $self->{_coro}{$coro+0};	3353	delete $self->{_coro}{$coro+0};
1742	});	3354	});
1743		3355
…		…
1745		3357
1746	$coro	3358	$coro
1747	}	3359	}
1748		3360
1749	cf::client->attach (	3361	cf::client->attach (
1750	on_destroy => sub {	3362	on_client_destroy => sub {
1751	my ($ns) = @_;	3363	my ($ns) = @_;
1752		3364
1753	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3365	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
1754	},	3366	},
1755	);	3367	);
…		…
1770	our $safe = new Safe "safe";	3382	our $safe = new Safe "safe";
1771	our $safe_hole = new Safe::Hole;	3383	our $safe_hole = new Safe::Hole;
1772		3384
1773	$SIG{FPE} = 'IGNORE';	3385	$SIG{FPE} = 'IGNORE';
1774		3386
1775	$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	));
1776		3392
1777	# here we export the classes and methods available to script code	3393	# here we export the classes and methods available to script code
1778		3394
1779	=pod	3395	=pod
1780		3396
1781	The following fucntions and emthods are available within a safe environment:	3397	The following functions and methods are available within a safe environment:
1782		3398
1783	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
1784	cf::object::player player	3404	cf::object::player
1785	cf::player peaceful	3405	player
1786	cf::map trigger	3406
		3407	cf::player
		3408	peaceful
		3409
		3410	cf::map
		3411	trigger
1787		3412
1788	=cut	3413	=cut
1789		3414
1790	for (	3415	for (
1791	["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)],
1792	["cf::object::player" => qw(player)],	3419	["cf::object::player" => qw(player)],
1793	["cf::player" => qw(peaceful)],	3420	["cf::player" => qw(peaceful send_msg)],
1794	["cf::map" => qw(trigger)],	3421	["cf::map" => qw(trigger)],
1795	) {	3422	) {
1796	no strict 'refs';
1797	my ($pkg, @funs) = @$_;	3423	my ($pkg, @funs) = @$_;
1798	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3424	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1799	for @funs;	3425	for @funs;
1800	}	3426	}
1801		3427
…		…
1816		3442
1817	my $qcode = $code;	3443	my $qcode = $code;
1818	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3444	$qcode =~ s/"/‟/g; # not allowed in #line filenames
1819	$qcode =~ s/\n/\\n/g;	3445	$qcode =~ s/\n/\\n/g;
1820		3446
		3447	%vars = (_dummy => 0) unless %vars;
		3448
		3449	my @res;
1821	local $_;	3450	local $_;
1822	local @safe::cf::_safe_eval_args = values %vars;
1823		3451
1824	my $eval =	3452	my $eval =
1825	"do {\n"	3453	"do {\n"
1826	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3454	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1827	. "#line 0 \"{$qcode}\"\n"	3455	. "#line 0 \"{$qcode}\"\n"
1828	. $code	3456	. $code
1829	. "\n}"	3457	. "\n}"
1830	;	3458	;
1831		3459
		3460	if ($CFG{safe_eval}) {
1832	sub_generation_inc;	3461	sub_generation_inc;
		3462	local @safe::cf::_safe_eval_args = values %vars;
1833	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3463	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1834	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	}
1835		3469
1836	if ($@) {	3470	if ($@) {
1837	warn "$@";	3471	warn "$@",
1838	warn "while executing safe code '$code'\n";	3472	"while executing safe code '$code'\n",
1839	warn "with arguments " . (join " ", %vars) . "\n";	3473	"with arguments " . (join " ", %vars) . "\n";
1840	}	3474	}
1841		3475
1842	wantarray ? @res : $res[0]	3476	wantarray ? @res : $res[0]
1843	}	3477	}
1844		3478
…		…
1858	=cut	3492	=cut
1859		3493
1860	sub register_script_function {	3494	sub register_script_function {
1861	my ($fun, $cb) = @_;	3495	my ($fun, $cb) = @_;
1862		3496
1863	no strict 'refs';	3497	$fun = "safe::$fun" if $CFG{safe_eval};
1864	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3498	*$fun = $safe_hole->wrap ($cb);
1865	}	3499	}
1866		3500
1867	=back	3501	=back
1868		3502
1869	=cut	3503	=cut
1870		3504
1871	#############################################################################	3505	#############################################################################
		3506	# the server's init and main functions
1872		3507
1873	=head2 EXTENSION DATABASE SUPPORT	3508	our %FACEHASH; # hash => idx, #d# HACK for http server
1874		3509
1875	Crossfire maintains a very simple database for extension use. It can	3510	sub load_facedata($) {
1876	currently store anything that can be serialised using Storable, which	3511	my ($path) = @_;
1877	excludes objects.
1878		3512
1879	The parameter C<$family> should best start with the name of the extension	3513	# HACK to clear player env face cache, we need some signal framework
1880	using it, it should be unique.	3514	# for this (global event?)
		3515	%ext::player_env::MUSIC_FACE_CACHE = ();
1881		3516
1882	=over 4	3517	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1883		3518
1884	=item $hashref = cf::db_get $family	3519	trace "loading facedata from $path\n";
1885		3520
1886	Return a hashref for use by the extension C<$family>, which can be	3521	my $facedata = decode_storable load_file $path;
1887	modified. After modifications, you have to call C<cf::db_dirty> or
1888	C<cf::db_sync>.
1889		3522
1890	=item $value = cf::db_get $family => $key	3523	$facedata->{version} == 2
		3524	or cf::cleanup "$path: version mismatch, cannot proceed.";
1891		3525
1892	Returns a single value from the database	3526	# patch in the exptable
1893		3527	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
1894	=item cf::db_put $family => $hashref	3528	$facedata->{resource}{"res/exp_table"} = {
1895		3529	type => FT_RSRC,
1896	Stores the given family hashref into the database. Updates are delayed, if	3530	data => $exp_table,
1897	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3531	hash => (Digest::MD5::md5 $exp_table),
1898
1899	=item cf::db_put $family => $key => $value
1900
1901	Stores the given C<$value> in the family hash. Updates are delayed, if you
1902	want the data to be synced to disk immediately, use C<cf::db_sync>.
1903
1904	=item cf::db_dirty
1905
1906	Marks the database as dirty, to be updated at a later time.
1907
1908	=item cf::db_sync
1909
1910	Immediately write the database to disk I<if it is dirty>.
1911
1912	=cut
1913
1914	our $DB;
1915
1916	{
1917	my $path = cf::localdir . "/database.pst";
1918
1919	sub db_load() {
1920	$DB = stat $path ? Storable::retrieve $path : { };
1921	}
1922
1923	my $pid;
1924
1925	sub db_save() {
1926	waitpid $pid, 0 if $pid;
1927	if (0 == ($pid = fork)) {
1928	$DB->{_meta}{version} = 1;
1929	Storable::nstore $DB, "$path~";
1930	rename "$path~", $path;
1931	cf::_exit 0 if defined $pid;
1932	}
1933	}
1934
1935	my $dirty;
1936
1937	sub db_sync() {
1938	db_save if $dirty;
1939	undef $dirty;
1940	}
1941
1942	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1943	db_sync;
1944	});	3532	};
		3533	cf::cede_to_tick;
1945		3534
1946	sub db_dirty() {
1947	$dirty = 1;
1948	$idle->start;
1949	}	3535	{
		3536	my $faces = $facedata->{faceinfo};
1950		3537
1951	sub db_get($;$) {	3538	for my $face (sort keys %$faces) {
1952	@_ >= 2	3539	my $info = $faces->{$face};
1953	? $DB->{$_[0]}{$_[1]}	3540	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1954	: ($DB->{$_[0]} ||= { })
1955	}
1956		3541
1957	sub db_put($$;$) {	3542	cf::face::set_visibility $idx, $info->{visibility};
1958	if (@_ >= 3) {	3543	cf::face::set_magicmap $idx, $info->{magicmap};
1959	$DB->{$_[0]}{$_[1]} = $_[2];	3544	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
1960	} else {	3545	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1961	$DB->{$_[0]} = $_[1];	3546	cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ;
1962	}	3547	$FACEHASH{$info->{hash64}} = $idx;#d#
1963	db_dirty;
1964	}
1965		3548
1966	cf::global->attach (	3549	cf::cede_to_tick;
1967	prio => 10000,
1968	on_cleanup => sub {
1969	db_sync;
1970	},	3550	}
1971	);
1972	}
1973		3551
1974	#############################################################################	3552	while (my ($face, $info) = each %$faces) {
1975	# the server's main()	3553	next unless $info->{smooth};
1976		3554
1977	sub cfg_load {	3555	my $idx = cf::face::find $face
1978	open my $fh, "<:utf8", cf::confdir . "/config"	3556	or next;
1979	or return;
1980		3557
1981	local $/;	3558	if (my $smooth = cf::face::find $info->{smooth}) {
1982	*CFG = YAML::Syck::Load <$fh>;	3559	cf::face::set_smooth $idx, $smooth;
		3560	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3561	} else {
		3562	error "smooth face '$info->{smooth}' not found for face '$face'";
		3563	}
		3564
		3565	cf::cede_to_tick;
		3566	}
		3567	}
		3568
		3569	{
		3570	my $anims = $facedata->{animinfo};
		3571
		3572	while (my ($anim, $info) = each %$anims) {
		3573	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3574	cf::cede_to_tick;
		3575	}
		3576
		3577	cf::anim::invalidate_all; # d'oh
		3578	}
		3579
		3580	{
		3581	my $res = $facedata->{resource};
		3582
		3583	while (my ($name, $info) = each %$res) {
		3584	if (defined (my $type = $info->{type})) {
		3585	# TODO: different hash - must free and use new index, or cache ixface data queue
		3586	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3587
		3588	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3589	cf::face::set_type $idx, $type;
		3590	cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
		3591	$FACEHASH{$info->{hash}} = $idx;#d#
		3592	} else {
		3593	# $RESOURCE{$name} = $info; # unused
		3594	}
		3595
		3596	cf::cede_to_tick;
		3597	}
		3598	}
		3599
		3600	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3601
		3602	1
		3603	}
		3604
		3605	register_exticmd fx_want => sub {
		3606	my ($ns, $want) = @_;
		3607
		3608	while (my ($k, $v) = each %$want) {
		3609	$ns->fx_want ($k, $v);
		3610	}
		3611	};
		3612
		3613	sub load_resource_file($) {
		3614	my $guard = lock_acquire "load_resource_file";
		3615
		3616	my $status = load_resource_file_ $_[0];
		3617	get_slot 0.1, 100;
		3618	cf::arch::commit_load;
		3619
		3620	$status
		3621	}
		3622
		3623	sub reload_regions {
		3624	# HACK to clear player env face cache, we need some signal framework
		3625	# for this (global event?)
		3626	%ext::player_env::MUSIC_FACE_CACHE = ();
		3627
		3628	load_resource_file "$MAPDIR/regions"
		3629	or die "unable to load regions file\n";
		3630
		3631	for (cf::region::list) {
		3632	$_->{match} = qr/$_->{match}/
		3633	if exists $_->{match};
		3634	}
		3635	}
		3636
		3637	sub reload_facedata {
		3638	load_facedata "$DATADIR/facedata"
		3639	or die "unable to load facedata\n";
		3640	}
		3641
		3642	sub reload_archetypes {
		3643	load_resource_file "$DATADIR/archetypes"
		3644	or die "unable to load archetypes\n";
		3645	}
		3646
		3647	sub reload_treasures {
		3648	load_resource_file "$DATADIR/treasures"
		3649	or die "unable to load treasurelists\n";
		3650	}
		3651
		3652	sub reload_sound {
		3653	trace "loading sound config from $DATADIR/sound\n";
		3654
		3655	my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
		3656
		3657	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3658	my $sound = $soundconf->{compat}[$_]
		3659	or next;
		3660
		3661	my $face = cf::face::find "sound/$sound->[1]";
		3662	cf::sound::set $sound->[0] => $face;
		3663	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3664	}
		3665
		3666	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3667	my $face = cf::face::find "sound/$v";
		3668	cf::sound::set $k => $face;
		3669	}
		3670	}
		3671
		3672	sub reload_resources {
		3673	trace "reloading resource files...\n";
		3674
		3675	reload_exp_table;
		3676	reload_materials;
		3677	reload_facedata;
		3678	reload_sound;
		3679	reload_archetypes;
		3680	reload_regions;
		3681	reload_treasures;
		3682
		3683	trace "finished reloading resource files\n";
		3684	}
		3685
		3686	sub reload_config {
		3687	trace "reloading config file...\n";
		3688
		3689	my $config = load_file "$CONFDIR/config";
		3690	utf8::decode $config;
		3691	*CFG = decode_yaml $config;
		3692
		3693	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
		3694
		3695	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3696	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3697
		3698	if (exists $CFG{mlockall}) {
		3699	eval {
		3700	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3701	and die "WARNING: m(un)lockall failed: $!\n";
		3702	};
		3703	warn $@ if $@;
		3704	}
		3705	}
		3706
		3707	sub pidfile() {
		3708	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3709	or die "$PIDFILE: $!";
		3710	flock $fh, &Fcntl::LOCK_EX
		3711	or die "$PIDFILE: flock: $!";
		3712	$fh
		3713	}
		3714
		3715	# make sure only one server instance is running at any one time
		3716	sub atomic {
		3717	my $fh = pidfile;
		3718
		3719	my $pid = <$fh>;
		3720	kill 9, $pid if $pid > 0;
		3721
		3722	seek $fh, 0, 0;
		3723	print $fh $$;
		3724	}
		3725
		3726	sub main_loop {
		3727	trace "EV::loop starting\n";
		3728	if (1) {
		3729	EV::loop;
		3730	}
		3731	trace "EV::loop returned\n";
		3732	goto &main_loop unless $REALLY_UNLOOP;
1983	}	3733	}
1984		3734
1985	sub main {	3735	sub main {
		3736	cf::init_globals; # initialise logging
		3737
		3738	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3739	LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3740	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3741	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3742
		3743	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3744
1986	# we must not ever block the main coroutine	3745	# we must not ever block the main coroutine
1987	local $Coro::idle = sub {	3746	local $Coro::idle = sub {
1988	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3747	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1989	(Coro::unblock_sub {	3748	(async {
1990	Event::one_event;	3749	$Coro::current->{desc} = "IDLE BUG HANDLER";
1991	})->();	3750	EV::loop EV::LOOP_ONESHOT;
		3751	})->prio (Coro::PRIO_MAX);
1992	};	3752	};
1993		3753
1994	cfg_load;	3754	evthread_start IO::AIO::poll_fileno;
1995	db_load;	3755
		3756	cf::sync_job {
		3757	cf::incloader::init ();
		3758
		3759	cf::init_anim;
		3760	cf::init_attackmess;
		3761	cf::init_dynamic;
		3762
		3763	cf::load_settings;
		3764
		3765	reload_resources;
		3766	reload_config;
		3767	db_init;
		3768
		3769	cf::init_uuid;
		3770	cf::init_signals;
		3771	cf::init_skills;
		3772
		3773	cf::init_beforeplay;
		3774
		3775	atomic;
		3776
1996	load_extensions;	3777	load_extensions;
1997	Event::loop;	3778
		3779	utime time, time, $RUNTIMEFILE;
		3780
		3781	# no (long-running) fork's whatsoever before this point(!)
		3782	use POSIX ();
		3783	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3784
		3785	cf::_post_init 0;
		3786	};
		3787
		3788	cf::object::thawer::errors_are_fatal 0;
		3789	info "parse errors in files are no longer fatal from this point on.\n";
		3790
		3791	AE::postpone {
		3792	undef &main; # free gobs of memory :)
		3793	};
		3794
		3795	goto &main_loop;
1998	}	3796	}
1999		3797
2000	#############################################################################	3798	#############################################################################
2001	# initialisation	3799	# initialisation and cleanup
2002		3800
		3801	# install some emergency cleanup handlers
		3802	BEGIN {
		3803	our %SIGWATCHER = ();
		3804	for my $signal (qw(INT HUP TERM)) {
		3805	$SIGWATCHER{$signal} = AE::signal $signal, sub {
		3806	cf::cleanup "SIG$signal";
		3807	};
		3808	}
		3809	}
		3810
		3811	sub write_runtime_sync {
		3812	my $t0 = AE::time;
		3813
		3814	# first touch the runtime file to show we are still running:
		3815	# the fsync below can take a very very long time.
		3816
		3817	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3818
		3819	my $guard = cf::lock_acquire "write_runtime";
		3820
		3821	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3822	or return;
		3823
		3824	my $value = $cf::RUNTIME + 90 + 10;
		3825	# 10 is the runtime save interval, for a monotonic clock
		3826	# 60 allows for the watchdog to kill the server.
		3827
		3828	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3829	and return;
		3830
		3831	# always fsync - this file is important
		3832	aio_fsync $fh
		3833	and return;
		3834
		3835	# touch it again to show we are up-to-date
		3836	aio_utime $fh, undef, undef;
		3837
		3838	close $fh
		3839	or return;
		3840
		3841	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3842	and return;
		3843
		3844	trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3845
		3846	1
		3847	}
		3848
		3849	our $uuid_lock;
		3850	our $uuid_skip;
		3851
		3852	sub write_uuid_sync($) {
		3853	$uuid_skip ||= $_[0];
		3854
		3855	return if $uuid_lock;
		3856	local $uuid_lock = 1;
		3857
		3858	my $uuid = "$LOCALDIR/uuid";
		3859
		3860	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3861	or return;
		3862
		3863	my $value = uuid_seq uuid_cur;
		3864
		3865	unless ($value) {
		3866	info "cowardly refusing to write zero uuid value!\n";
		3867	return;
		3868	}
		3869
		3870	my $value = uuid_str $value + $uuid_skip;
		3871	$uuid_skip = 0;
		3872
		3873	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3874	and return;
		3875
		3876	# always fsync - this file is important
		3877	aio_fsync $fh
		3878	and return;
		3879
		3880	close $fh
		3881	or return;
		3882
		3883	aio_rename "$uuid~", $uuid
		3884	and return;
		3885
		3886	trace "uuid file written ($value).\n";
		3887
		3888	1
		3889
		3890	}
		3891
		3892	sub write_uuid($$) {
		3893	my ($skip, $sync) = @_;
		3894
		3895	$sync ? write_uuid_sync $skip
		3896	: async { write_uuid_sync $skip };
		3897	}
		3898
		3899	sub emergency_save() {
		3900	my $freeze_guard = cf::freeze_mainloop;
		3901
		3902	info "emergency_perl_save: enter\n";
		3903
		3904	# this is a trade-off: we want to be very quick here, so
		3905	# save all maps without fsync, and later call a global sync
		3906	# (which in turn might be very very slow)
		3907	local $USE_FSYNC = 0;
		3908
		3909	cf::sync_job {
		3910	cf::write_runtime_sync; # external watchdog should not bark
		3911
		3912	# use a peculiar iteration method to avoid tripping on perl
		3913	# refcount bugs in for. also avoids problems with players
		3914	# and maps saved/destroyed asynchronously.
		3915	info "emergency_perl_save: begin player save\n";
		3916	for my $login (keys %cf::PLAYER) {
		3917	my $pl = $cf::PLAYER{$login} or next;
		3918	$pl->valid or next;
		3919	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3920	$pl->save;
		3921	}
		3922	info "emergency_perl_save: end player save\n";
		3923
		3924	cf::write_runtime_sync; # external watchdog should not bark
		3925
		3926	info "emergency_perl_save: begin map save\n";
		3927	for my $path (keys %cf::MAP) {
		3928	my $map = $cf::MAP{$path} or next;
		3929	$map->valid or next;
		3930	$map->save;
		3931	}
		3932	info "emergency_perl_save: end map save\n";
		3933
		3934	cf::write_runtime_sync; # external watchdog should not bark
		3935
		3936	info "emergency_perl_save: begin database checkpoint\n";
		3937	BDB::db_env_txn_checkpoint $DB_ENV;
		3938	info "emergency_perl_save: end database checkpoint\n";
		3939
		3940	info "emergency_perl_save: begin write uuid\n";
		3941	write_uuid_sync 1;
		3942	info "emergency_perl_save: end write uuid\n";
		3943
		3944	cf::write_runtime_sync; # external watchdog should not bark
		3945
		3946	trace "emergency_perl_save: syncing database to disk";
		3947	BDB::db_env_txn_checkpoint $DB_ENV;
		3948
		3949	info "emergency_perl_save: starting sync\n";
		3950	IO::AIO::aio_sync sub {
		3951	info "emergency_perl_save: finished sync\n";
		3952	};
		3953
		3954	cf::write_runtime_sync; # external watchdog should not bark
		3955
		3956	trace "emergency_perl_save: flushing outstanding aio requests";
		3957	while (IO::AIO::nreqs || BDB::nreqs) {
		3958	Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
		3959	}
		3960
		3961	cf::write_runtime_sync; # external watchdog should not bark
		3962	};
		3963
		3964	info "emergency_perl_save: leave\n";
		3965	}
		3966
		3967	sub post_cleanup {
		3968	my ($make_core) = @_;
		3969
		3970	IO::AIO::flush;
		3971
		3972	error Carp::longmess "post_cleanup backtrace"
		3973	if $make_core;
		3974
		3975	my $fh = pidfile;
		3976	unlink $PIDFILE if <$fh> == $$;
		3977	}
		3978
		3979	# a safer delete_package, copied from Symbol
		3980	sub clear_package($) {
		3981	my $pkg = shift;
		3982
		3983	# expand to full symbol table name if needed
		3984	unless ($pkg =~ /^main::.*::$/) {
		3985	$pkg = "main$pkg" if $pkg =~ /^::/;
		3986	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3987	$pkg .= '::' unless $pkg =~ /::$/;
		3988	}
		3989
		3990	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3991	my $stem_symtab = *{$stem}{HASH};
		3992
		3993	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3994	or return;
		3995
		3996	# clear all symbols
		3997	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3998	for my $name (keys %$leaf_symtab) {
		3999	_gv_clear *{"$pkg$name"};
		4000	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		4001	}
		4002	}
		4003
2003	sub reload() {	4004	sub do_reload_perl() {
2004	# can/must only be called in main	4005	# can/must only be called in main
2005	if ($Coro::current != $Coro::main) {	4006	unless (in_main) {
2006	warn "can only reload from main coroutine\n";	4007	error "can only reload from main coroutine";
2007	return;	4008	return;
2008	}	4009	}
2009		4010
2010	warn "reloading...";	4011	return if $RELOAD++;
2011		4012
2012	local $FREEZE = 1;	4013	my $t1 = AE::time;
		4014
		4015	while ($RELOAD) {
		4016	cf::get_slot 0.1, -1, "reload_perl";
		4017	info "perl_reload: reloading...";
		4018
		4019	trace "perl_reload: entering sync_job";
		4020
		4021	cf::sync_job {
2013	cf::emergency_save;	4022	#cf::emergency_save;
2014		4023
2015	eval {	4024	trace "perl_reload: cancelling all extension coros";
2016	# if anything goes wrong in here, we should simply crash as we already saved
2017
2018	# cancel all watchers
2019	for (Event::all_watchers) {
2020	$_->cancel if $_->data & WF_AUTOCANCEL;
2021	}
2022
2023	# cancel all extension coros
2024	$_->cancel for values %EXT_CORO;	4025	$_->cancel for values %EXT_CORO;
2025	%EXT_CORO = ();	4026	%EXT_CORO = ();
2026		4027
2027	# unload all extensions	4028	trace "perl_reload: removing commands";
2028	for (@exts) {	4029	%COMMAND = ();
2029	warn "unloading <$_>";
2030	unload_extension $_;
2031	}
2032		4030
2033	# unload all modules loaded from $LIBDIR	4031	trace "perl_reload: removing ext/exti commands";
2034	while (my ($k, $v) = each %INC) {	4032	%EXTCMD = ();
2035	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	4033	%EXTICMD = ();
2036		4034
2037	warn "removing <$k>";	4035	trace "perl_reload: unloading/nuking all extensions";
2038	delete $INC{$k};	4036	for my $pkg (@EXTS) {
		4037	trace "... unloading $pkg";
2039		4038
2040	$k =~ s/\.pm$//;
2041	$k =~ s/\//::/g;
2042
2043	if (my $cb = $k->can ("unload_module")) {	4039	if (my $cb = $pkg->can ("unload")) {
		4040	eval {
2044	$cb->();	4041	$cb->($pkg);
		4042	1
		4043	} or error "$pkg unloaded, but with errors: $@";
		4044	}
		4045
		4046	trace "... clearing $pkg";
		4047	clear_package $pkg;
2045	}	4048	}
2046		4049
2047	Symbol::delete_package $k;	4050	trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
		4051	while (my ($k, $v) = each %INC) {
		4052	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		4053
		4054	trace "... unloading $k";
		4055	delete $INC{$k};
		4056
		4057	$k =~ s/\.pm$//;
		4058	$k =~ s/\//::/g;
		4059
		4060	if (my $cb = $k->can ("unload_module")) {
		4061	$cb->();
		4062	}
		4063
		4064	clear_package $k;
2048	}	4065	}
2049		4066
2050	# sync database to disk
2051	cf::db_sync;
2052	IO::AIO::flush;
2053
2054	# get rid of safe::, as good as possible	4067	trace "perl_reload: getting rid of safe::, as good as possible";
2055	Symbol::delete_package "safe::$_"	4068	clear_package "safe::$_"
2056	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	4069	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2057		4070
2058	# remove register_script_function callbacks	4071	trace "perl_reload: unloading cf.pm \"a bit\"";
2059	# TODO
2060
2061	# unload cf.pm "a bit"
2062	delete $INC{"cf.pm"};	4072	delete $INC{"cf.pm"};
		4073	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2063		4074
2064	# don't, removes xs symbols, too,	4075	# don't, removes xs symbols, too,
2065	# and global variables created in xs	4076	# and global variables created in xs
2066	#Symbol::delete_package __PACKAGE__;	4077	#clear_package __PACKAGE__;
2067		4078
2068	# reload cf.pm	4079	info "perl_reload: unload completed, starting to reload now";
2069	warn "reloading cf.pm";	4080
		4081	trace "perl_reload: reloading cf.pm";
2070	require cf;	4082	require cf;
2071	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	4083	cf::_connect_to_perl_1;
2072		4084
2073	# load config and database again	4085	trace "perl_reload: loading config and database again";
2074	cf::cfg_load;	4086	cf::reload_config;
2075	cf::db_load;
2076		4087
2077	# load extensions	4088	trace "perl_reload: loading extensions";
2078	warn "load extensions";
2079	cf::load_extensions;	4089	cf::load_extensions;
2080		4090
2081	# reattach attachments to objects	4091	if ($REATTACH_ON_RELOAD) {
2082	warn "reattach";	4092	trace "perl_reload: reattaching attachments to objects/players";
2083	_global_reattach;	4093	_global_reattach; # objects, sockets
		4094	trace "perl_reload: reattaching attachments to maps";
		4095	reattach $_ for values %MAP;
		4096	trace "perl_reload: reattaching attachments to players";
		4097	reattach $_ for values %PLAYER;
		4098	}
		4099
		4100	cf::_post_init 1;
		4101
		4102	trace "perl_reload: leaving sync_job";
		4103
		4104	1
		4105	} or do {
		4106	error $@;
		4107	cf::cleanup "perl_reload: error, exiting.";
		4108	};
		4109
		4110	--$RELOAD;
		4111	}
		4112
		4113	$t1 = AE::time - $t1;
		4114	info "perl_reload: completed in ${t1}s\n";
		4115	};
		4116
		4117	our $RELOAD_WATCHER; # used only during reload
		4118
		4119	sub reload_perl() {
		4120	# doing reload synchronously and two reloads happen back-to-back,
		4121	# coro crashes during coro_state_free->destroy here.
		4122
		4123	$RELOAD_WATCHER ||= cf::async {
		4124	Coro::AIO::aio_wait cache_extensions;
		4125
		4126	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		4127	do_reload_perl;
		4128	undef $RELOAD_WATCHER;
		4129	};
2084	};	4130	};
2085
2086	if ($@) {
2087	warn $@;
2088	warn "error while reloading, exiting.";
2089	exit 1;
2090	}
2091
2092	warn "reloaded successfully";
2093	};
2094
2095	#############################################################################
2096
2097	unless ($LINK_MAP) {
2098	$LINK_MAP = cf::map::new;
2099
2100	$LINK_MAP->width (41);
2101	$LINK_MAP->height (41);
2102	$LINK_MAP->alloc;
2103	$LINK_MAP->path ("{link}");
2104	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2105	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2106
2107	# dirty hack because... archetypes are not yet loaded
2108	Event->timer (
2109	after => 2,
2110	cb => sub {
2111	$_[0]->w->cancel;
2112
2113	# provide some exits "home"
2114	my $exit = cf::object::new "exit";
2115
2116	$exit->slaying ($EMERGENCY_POSITION->[0]);
2117	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2118	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2119
2120	$LINK_MAP->insert ($exit->clone, 19, 19);
2121	$LINK_MAP->insert ($exit->clone, 19, 20);
2122	$LINK_MAP->insert ($exit->clone, 19, 21);
2123	$LINK_MAP->insert ($exit->clone, 20, 19);
2124	$LINK_MAP->insert ($exit->clone, 20, 21);
2125	$LINK_MAP->insert ($exit->clone, 21, 19);
2126	$LINK_MAP->insert ($exit->clone, 21, 20);
2127	$LINK_MAP->insert ($exit->clone, 21, 21);
2128
2129	$exit->destroy;
2130	});
2131
2132	$LINK_MAP->{deny_save} = 1;
2133	$LINK_MAP->{deny_reset} = 1;
2134
2135	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2136	}	4131	}
2137
2138	register "<global>", __PACKAGE__;
2139		4132
2140	register_command "reload" => sub {	4133	register_command "reload" => sub {
2141	my ($who, $arg) = @_;	4134	my ($who, $arg) = @_;
2142		4135
2143	if ($who->flag (FLAG_WIZ)) {	4136	if ($who->flag (FLAG_WIZ)) {
2144	$who->message ("start of reload.");
2145	reload;
2146	$who->message ("end of reload.");	4137	$who->message ("reloading server.");
		4138	async {
		4139	$Coro::current->{desc} = "perl_reload";
		4140	reload_perl;
		4141	};
2147	}	4142	}
2148	};	4143	};
2149		4144
2150	unshift @INC, $LIBDIR;	4145	#############################################################################
2151		4146
2152	$TICK_WATCHER = Event->timer (	4147	my $bug_warning = 0;
2153	reentrant => 0,
2154	prio => 0,
2155	at => $NEXT_TICK || $TICK,
2156	data => WF_AUTOCANCEL,
2157	cb => sub {
2158	unless ($FREEZE) {
2159	cf::server_tick; # one server iteration
2160	$RUNTIME += $TICK;
2161	}
2162		4148
2163	$NEXT_TICK += $TICK;	4149	sub wait_for_tick() {
		4150	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2164		4151
2165	# if we are delayed by four ticks or more, skip them all	4152	$WAIT_FOR_TICK->wait;
2166	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	4153	}
2167		4154
2168	$TICK_WATCHER->at ($NEXT_TICK);	4155	sub wait_for_tick_begin() {
2169	$TICK_WATCHER->start;	4156	return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
		4157
		4158	my $signal = new Coro::Signal;
		4159	push @WAIT_FOR_TICK_BEGIN, $signal;
		4160	$signal->wait;
		4161	}
		4162
		4163	sub tick {
		4164	if ($Coro::current != $Coro::main) {
		4165	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		4166	unless ++$bug_warning > 10;
		4167	return;
2170	},	4168	}
2171	);
2172		4169
2173	IO::AIO::max_poll_time $TICK * 0.2;	4170	cf::one_tick; # one server iteration
2174		4171
2175	Event->io (	4172	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2176	fd => IO::AIO::poll_fileno,
2177	poll => 'r',
2178	prio => 5,
2179	data => WF_AUTOCANCEL,
2180	cb => \&IO::AIO::poll_cb,
2181	);
2182		4173
2183	Event->timer (	4174	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2184	data => WF_AUTOCANCEL,	4175	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2185	after => 0,	4176	Coro::async_pool {
2186	interval => 10,	4177	$Coro::current->{desc} = "runtime saver";
2187	cb => sub {
2188	(Coro::unblock_sub {
2189	write_runtime	4178	write_runtime_sync
2190	or warn "ERROR: unable to write runtime file: $!";	4179	or error "ERROR: unable to write runtime file: $!";
2191	})->();	4180	};
2192	},	4181	}
2193	);	4182
		4183	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		4184	$sig->send;
		4185	}
		4186	$WAIT_FOR_TICK->broadcast;
		4187
		4188	$LOAD = ($NOW - $TICK_START) / $TICK;
		4189	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		4190
		4191	if (0) {
		4192	if ($NEXT_TICK) {
		4193	my $jitter = $TICK_START - $NEXT_TICK;
		4194	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		4195	debug "jitter $JITTER\n";#d#
		4196	}
		4197	}
		4198	}
		4199
		4200	{
		4201	# configure BDB
		4202
		4203	BDB::min_parallel 16;
		4204	BDB::max_poll_reqs $TICK * 0.1;
		4205	#$AnyEvent::BDB::WATCHER->priority (1);
		4206
		4207	unless ($DB_ENV) {
		4208	$DB_ENV = BDB::db_env_create;
		4209	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4210	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4211	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4212	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4213	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		4214
		4215	cf::sync_job {
		4216	eval {
		4217	BDB::db_env_open
		4218	$DB_ENV,
		4219	$BDBDIR,
		4220	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		4221	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		4222	0666;
		4223
		4224	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		4225	};
		4226
		4227	cf::cleanup "db_env_open(db): $@" if $@;
		4228	};
		4229	}
		4230
		4231	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4232	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4233	};
		4234	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4235	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4236	};
		4237	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4238	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4239	};
		4240	}
		4241
		4242	{
		4243	# configure IO::AIO
		4244
		4245	IO::AIO::min_parallel 8;
		4246	IO::AIO::max_poll_time $TICK * 0.1;
		4247	undef $AnyEvent::AIO::WATCHER;
		4248	}
		4249
		4250	our $_log_backtrace;
		4251	our $_log_backtrace_last;
		4252
		4253	sub _log_backtrace {
		4254	my ($msg, @addr) = @_;
		4255
		4256	$msg =~ s/\n$//;
		4257
		4258	if ($_log_backtrace_last eq $msg) {
		4259	LOG llevInfo, "[ABT] $msg\n";
		4260	LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
		4261	# limit the # of concurrent backtraces
		4262	} elsif ($_log_backtrace < 2) {
		4263	$_log_backtrace_last = $msg;
		4264	++$_log_backtrace;
		4265	my $perl_bt = Carp::longmess $msg;
		4266	async {
		4267	$Coro::current->{desc} = "abt $msg";
		4268
		4269	my @bt = fork_call {
		4270	@addr = map { sprintf "%x", $_ } @addr;
		4271	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4272	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4273	or die "addr2line: $!";
		4274
		4275	my @funcs;
		4276	my @res = <$fh>;
		4277	chomp for @res;
		4278	while (@res) {
		4279	my ($func, $line) = splice @res, 0, 2, ();
		4280	push @funcs, "[$func] $line";
		4281	}
		4282
		4283	@funcs
		4284	};
		4285
		4286	LOG llevInfo, "[ABT] $perl_bt\n";
		4287	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4288	LOG llevInfo, "[ABT] $_\n" for @bt;
		4289	--$_log_backtrace;
		4290	};
		4291	} else {
		4292	LOG llevInfo, "[ABT] $msg\n";
		4293	LOG llevInfo, "[ABT] [overload, suppressed]\n";
		4294	}
		4295	}
		4296
		4297	# load additional modules
		4298	require "cf/$_.pm" for @EXTRA_MODULES;
		4299	cf::_connect_to_perl_2;
		4300
		4301	END { cf::emergency_save }
2194		4302
2195	1	4303	1
2196		4304

Diff Legend

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