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

Diff Legend

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