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

Diff Legend

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