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.151 by root, Mon Jan 8 20:59:15 2007 UTC vs.
Revision 1.449 by root, Sat Sep 20 00:09:27 2008 UTC

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

Diff Legend

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