ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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