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

Diff Legend

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