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

Diff Legend

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