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

Diff Legend

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