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

Diff Legend

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