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.158 by root, Wed Jan 10 19:52:43 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 = ();
		74
		75	our @EXTS = (); # list of extension package names
38	our %EXTCMD = ();	76	our %EXTCMD = ();
		77	our %EXTICMD = ();
		78	our %EXT_CORO = (); # coroutines bound to extensions
		79	our %EXT_MAP = (); # pluggable maps
39		80
		81	our $RELOAD; # number of reloads so far
40	our @EVENT;	82	our @EVENT;
41	our $LIBDIR = datadir . "/ext";
42		83
43	our $TICK = MAX_TIME * 1e-6;	84	our $CONFDIR = confdir;
44	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
45	our $NEXT_TICK;	99	our $NEXT_TICK;
46	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;
47		106
48	our %CFG;	107	our %CFG;
49		108
50	our $UPTIME; $UPTIME ||= time;	109	our $UPTIME; $UPTIME ||= time;
51	our $RUNTIME;	110	our $RUNTIME;
		111	our $NOW;
52		112
53	our %PLAYER; # all users	113	our (%PLAYER, %PLAYER_LOADING); # all users
54	our %MAP; # all maps	114	our (%MAP, %MAP_LOADING ); # all maps
55	our $LINK_MAP; # the special {link} map	115	our $LINK_MAP; # the special {link} map, which is always available
56	our $RANDOM_MAPS = cf::localdir . "/random";
57	our %EXT_CORO; # coroutines bound to extensions
58		116
59	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;	117	# used to convert map paths into valid unix filenames by replacing / by ∕
60	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;	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
61		124
62	binmode STDOUT;	125	binmode STDOUT;
63	binmode STDERR;	126	binmode STDERR;
64		127
65	# read virtual server time, if available	128	# read virtual server time, if available
66	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	129	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
67	open my $fh, "<", cf::localdir . "/runtime"	130	open my $fh, "<", "$LOCALDIR/runtime"
68	or die "unable to read runtime file: $!";	131	or die "unable to read runtime file: $!";
69	$RUNTIME = <$fh> + 0.;	132	$RUNTIME = <$fh> + 0.;
70	}	133	}
71		134
72	mkdir cf::localdir;	135	mkdir $_
73	mkdir cf::localdir . "/" . cf::playerdir;	136	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
74	mkdir cf::localdir . "/" . cf::tmpdir;
75	mkdir cf::localdir . "/" . cf::uniquedir;
76	mkdir $RANDOM_MAPS;
77		137
78	# a special map that is always available
79	our $LINK_MAP;
80	our $EMERGENCY_POSITION;	138	our $EMERGENCY_POSITION;
		139
		140	sub cf::map::normalise;
81		141
82	#############################################################################	142	#############################################################################
83		143
84	=head2 GLOBAL VARIABLES	144	=head2 GLOBAL VARIABLES
85		145
…		…
92	=item $cf::RUNTIME	152	=item $cf::RUNTIME
93		153
94	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
95	every server tick.	155	every server tick.
96		156
97	=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
98		160
99	The perl library directory, where extensions and cf-specific modules can	161	Various directories - "/etc", read-only install directory, perl-library
100	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.
101		165
102	=item $cf::NOW	166	=item $cf::NOW
103		167
104	The time of the last (current) server tick.	168	The time of the last (current) server tick.
105		169
106	=item $cf::TICK	170	=item $cf::TICK
107		171
108	The interval between server ticks, in seconds.	172	The interval between server ticks, in seconds.
109		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
110	=item %cf::CFG	184	=item %cf::CFG
111		185
112	Configuration for the server, loaded from C</etc/crossfire/config>, or	186	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
113	from wherever your confdir points to.	187	from wherever your confdir points to.
114		188
115	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	189	=item cf::wait_for_tick, cf::wait_for_tick_begin
116		190
117	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
118	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
119	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.
120	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.
121		200
122	=back	201	=back
123		202
124	=cut	203	=cut
125		204
126	BEGIN {	205	BEGIN {
127	*CORE::GLOBAL::warn = sub {	206	*CORE::GLOBAL::warn = sub {
128	my $msg = join "", @_;	207	my $msg = join "", @_;
129	utf8::encode $msg;
130		208
131	$msg .= "\n"	209	$msg .= "\n"
132	unless $msg =~ /\n$/;	210	unless $msg =~ /\n$/;
133		211
		212	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		213
134	LOG llevError, $msg;	214	LOG llevError, $msg;
135	};	215	};
136	}	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#?
137		232
138	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	233	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
139	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	234	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
140	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	235	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
141	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	236	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
142	@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';
143	@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)
144		240
145	# 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
146	# within the Safe compartment.	242	# within the Safe compartment.
147	for my $pkg (qw(	243	for my $pkg (qw(
148	cf::global cf::attachable	244	cf::global cf::attachable
…		…
153	)) {	249	)) {
154	no strict 'refs';	250	no strict 'refs';
155	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	251	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
156	}	252	}
157		253
158	$Event::DIED = sub {	254	$EV::DIED = sub {
159	warn "error in event callback: @_";	255	warn "error in event callback: @_";
160	};	256	};
161		257
162	my %ext_pkg;	258	#############################################################################
163	my @exts;
164	my @hook;
165		259
166	=head2 UTILITY FUNCTIONS	260	=head2 UTILITY FUNCTIONS
167		261
168	=over 4	262	=over 4
169		263
…		…
188	$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;
189	$d	283	$d
190	} || "[unable to dump $_[0]: '$@']";	284	} || "[unable to dump $_[0]: '$@']";
191	}	285	}
192		286
193	use JSON::Syck (); # TODO# replace by JSON::PC once working
194
195	=item $ref = cf::from_json $json	287	=item $ref = cf::decode_json $json
196		288
197	Converts a JSON string into the corresponding perl data structure.	289	Converts a JSON string into the corresponding perl data structure.
198		290
199	=cut
200
201	sub from_json($) {
202	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
203	JSON::Syck::Load $_[0]
204	}
205
206	=item $json = cf::to_json $ref	291	=item $json = cf::encode_json $ref
207		292
208	Converts a perl data structure into its JSON representation.	293	Converts a perl data structure into its JSON representation.
209		294
210	=cut	295	=cut
211		296
212	sub to_json($) {	297	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
213	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	298
214	JSON::Syck::Dump $_[0]	299	sub encode_json($) { $json_coder->encode ($_[0]) }
215	}	300	sub decode_json($) { $json_coder->decode ($_[0]) }
216		301
217	=item cf::lock_wait $string	302	=item cf::lock_wait $string
218		303
219	Wait until the given lock is available. See cf::lock_acquire.	304	Wait until the given lock is available. See cf::lock_acquire.
220		305
…		…
223	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
224	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,
225	for example when the coroutine gets canceled), the lock is automatically	310	for example when the coroutine gets canceled), the lock is automatically
226	returned.	311	returned.
227		312
		313	Locks are *not* recursive, locking from the same coro twice results in a
		314	deadlocked coro.
		315
228	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
229	uses map_find and cf::map::load uses map_load).	317	uses map_find and cf::map::load uses map_load).
230		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
231	=cut	323	=cut
232		324
233	our %LOCK;	325	our %LOCK;
		326	our %LOCKER;#d#
234		327
235	sub lock_wait($) {	328	sub lock_wait($) {
236	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#
237		335
238	# wait for lock, if any	336	# wait for lock, if any
239	while ($LOCK{$key}) {	337	while ($LOCK{$key}) {
240	push @{ $LOCK{$key} }, $Coro::current;	338	push @{ $LOCK{$key} }, $Coro::current;
241	Coro::schedule;	339	Coro::schedule;
…		…
247		345
248	# wait, to be sure we are not locked	346	# wait, to be sure we are not locked
249	lock_wait $key;	347	lock_wait $key;
250		348
251	$LOCK{$key} = [];	349	$LOCK{$key} = [];
		350	$LOCKER{$key} = $Coro::current;#d#
252		351
253	Coro::guard {	352	Coro::guard {
		353	delete $LOCKER{$key};#d#
254	# wake up all waiters, to be on the safe side	354	# wake up all waiters, to be on the safe side
255	$_->ready for @{ delete $LOCK{$key} };	355	$_->ready for @{ delete $LOCK{$key} };
256	}	356	}
257	}	357	}
258		358
		359	sub lock_active($) {
		360	my ($key) = @_;
		361
		362	! ! $LOCK{$key}
		363	}
		364
259	sub freeze_mainloop {	365	sub freeze_mainloop {
260	return unless $TICK_WATCHER->is_active;	366	tick_inhibit_inc;
261		367
262	my $guard = Coro::guard { $TICK_WATCHER->start };	368	Coro::guard \&tick_inhibit_dec;
263	$TICK_WATCHER->stop;	369	}
264	$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;
265	}	444	}
266		445
267	=item cf::async { BLOCK }	446	=item cf::async { BLOCK }
268		447
269	Currently the same as Coro::async_pool, meaning you cannot use	448	Currently the same as Coro::async_pool, meaning you cannot use
…		…
274		453
275	BEGIN { *async = \&Coro::async_pool }	454	BEGIN { *async = \&Coro::async_pool }
276		455
277	=item cf::sync_job { BLOCK }	456	=item cf::sync_job { BLOCK }
278		457
279	The design of crossfire+ requires that the main coro ($Coro::main) is	458	The design of Deliantra requires that the main coroutine ($Coro::main)
280	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
281	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.
282		462
283	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
284	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
285	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
286	fast or be very important.	466	fast or be very important.
…		…
289		469
290	sub sync_job(&) {	470	sub sync_job(&) {
291	my ($job) = @_;	471	my ($job) = @_;
292		472
293	if ($Coro::current == $Coro::main) {	473	if ($Coro::current == $Coro::main) {
		474	my $time = EV::time;
		475
294	# this is the main coro, too bad, we have to block	476	# this is the main coro, too bad, we have to block
295	# till the operation succeeds, freezing the server :/	477	# till the operation succeeds, freezing the server :/
296		478
297	# TODO: use suspend/resume instead	479	LOG llevError, Carp::longmess "sync job";#d#
298	# (but this is cancel-safe)	480
299	my $freeze_guard = freeze_mainloop;	481	my $freeze_guard = freeze_mainloop;
300		482
301	my $busy = 1;	483	my $busy = 1;
302	my @res;	484	my @res;
303		485
304	(async {	486	(async {
		487	$Coro::current->desc ("sync job coro");
305	@res = eval { $job->() };	488	@res = eval { $job->() };
306	warn $@ if $@;	489	warn $@ if $@;
307	undef $busy;	490	undef $busy;
308	})->prio (Coro::PRIO_MAX);	491	})->prio (Coro::PRIO_MAX);
309		492
310	while ($busy) {	493	while ($busy) {
311	Coro::cede or Event::one_event;	494	if (Coro::nready) {
		495	Coro::cede_notself;
		496	} else {
		497	EV::loop EV::LOOP_ONESHOT;
312	}	498	}
		499	}
		500
		501	my $time = EV::time - $time;
		502
		503	$TICK_START += $time; # do not account sync jobs to server load
313		504
314	wantarray ? @res : $res[0]	505	wantarray ? @res : $res[0]
315	} else {	506	} else {
316	# we are in another coroutine, how wonderful, everything just works	507	# we are in another coroutine, how wonderful, everything just works
317		508
…		…
319	}	510	}
320	}	511	}
321		512
322	=item $coro = cf::async_ext { BLOCK }	513	=item $coro = cf::async_ext { BLOCK }
323		514
324	Like async, but this coro is automcatially being canceled when the	515	Like async, but this coro is automatically being canceled when the
325	extension calling this is being unloaded.	516	extension calling this is being unloaded.
326		517
327	=cut	518	=cut
328		519
329	sub async_ext(&) {	520	sub async_ext(&) {
…		…
337	$EXT_CORO{$coro+0} = $coro;	528	$EXT_CORO{$coro+0} = $coro;
338		529
339	$coro	530	$coro
340	}	531	}
341		532
342	sub write_runtime {	533	=item fork_call { }, $args
343	my $runtime = cf::localdir . "/runtime";
344		534
345	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	535	Executes the given code block with the given arguments in a seperate
346	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.
347		539
348	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	540	=cut
349	(aio_write $fh, 0, (length $value), $value, 0) <= 0
350	and return;
351		541
352	aio_fsync $fh	542	sub fork_call(&@) {
353	and return;	543	my ($cb, @args) = @_;
354		544
355	close $fh	545	# we seemingly have to make a local copy of the whole thing,
356	or return;	546	# otherwise perl prematurely frees the stuff :/
		547	# TODO: investigate and fix (likely this will be rather laborious)
357		548
358	aio_rename "$runtime~", $runtime	549	my @res = Coro::Util::fork_eval {
359	and return;	550	reset_signals;
		551	&$cb
		552	}, @args;
360		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
361	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 });
362	}	720	}
363		721
364	=back	722	=back
365		723
366	=cut	724	=cut
367
368	#############################################################################
369
370	package cf::path;
371
372	use overload
373	'""' => \&as_string;
374
375	# used to convert map paths into valid unix filenames by repalcing / by ∕
376	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
377
378	sub new {
379	my ($class, $path, $base) = @_;
380
381	$path = $path->as_string if ref $path;
382
383	my $self = bless { }, $class;
384
385	# {... are special paths that are not touched
386	# ?xxx/... are special absolute paths
387	# ?random/... random maps
388	# /! non-realised random map exit
389	# /... normal maps
390	# ~/... per-player maps without a specific player (DO NOT USE)
391	# ~user/... per-player map of a specific user
392
393	$path =~ s/$PATH_SEP/\//go;
394
395	if ($path =~ /^{/) {
396	# fine as it is
397	} elsif ($path =~ s{^\?random/}{}) {
398	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
399	$self->{random} = cf::from_json $data;
400	} else {
401	if ($path =~ s{^~([^/]+)?}{}) {
402	$self->{user_rel} = 1;
403
404	if (defined $1) {
405	$self->{user} = $1;
406	} elsif ($base =~ m{^~([^/]+)/}) {
407	$self->{user} = $1;
408	} else {
409	warn "cannot resolve user-relative path without user <$path,$base>\n";
410	}
411	} elsif ($path =~ /^\//) {
412	# already absolute
413	} else {
414	$base =~ s{[^/]+/?$}{};
415	return $class->new ("$base/$path");
416	}
417
418	for ($path) {
419	redo if s{/\.?/}{/};
420	redo if s{/[^/]+/\.\./}{/};
421	}
422	}
423
424	$self->{path} = $path;
425
426	$self
427	}
428
429	# the name / primary key / in-game path
430	sub as_string {
431	my ($self) = @_;
432
433	$self->{user_rel} ? "~$self->{user}$self->{path}"
434	: $self->{random} ? "?random/$self->{path}"
435	: $self->{path}
436	}
437
438	# the displayed name, this is a one way mapping
439	sub visible_name {
440	my ($self) = @_;
441
442	# if (my $rmp = $self->{random}) {
443	# # todo: be more intelligent about this
444	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
445	# } else {
446	$self->as_string
447	# }
448	}
449
450	# escape the /'s in the path
451	sub _escaped_path {
452	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
453	$path
454	}
455
456	# the original (read-only) location
457	sub load_path {
458	my ($self) = @_;
459
460	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
461	}
462
463	# the temporary/swap location
464	sub save_path {
465	my ($self) = @_;
466
467	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
468	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
469	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
470	}
471
472	# the unique path, might be eq to save_path
473	sub uniq_path {
474	my ($self) = @_;
475
476	$self->{user_rel} || $self->{random}
477	? undef
478	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
479	}
480
481	# return random map parameters, or undef
482	sub random_map_params {
483	my ($self) = @_;
484
485	$self->{random}
486	}
487
488	# this is somewhat ugly, but style maps do need special treatment
489	sub is_style_map {
490	$_[0]{path} =~ m{^/styles/}
491	}
492
493	package cf;
494		725
495	#############################################################################	726	#############################################################################
496		727
497	=head2 ATTACHABLE OBJECTS	728	=head2 ATTACHABLE OBJECTS
498		729
…		…
500	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")
501	to it. All such attachable objects support the following methods.	732	to it. All such attachable objects support the following methods.
502		733
503	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>
504	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
505	crossfire+).	736	Deliantra).
506		737
507	=over 4	738	=over 4
508		739
509	=item $attachable->attach ($attachment, key => $value...)	740	=item $attachable->attach ($attachment, key => $value...)
510		741
…		…
624	our @CB_TYPE = (); # registry for type (cf-object class) based events	855	our @CB_TYPE = (); # registry for type (cf-object class) based events
625	our @CB_MAP = ();	856	our @CB_MAP = ();
626		857
627	my %attachment;	858	my %attachment;
628		859
		860	sub cf::attachable::thawer_merge {
		861	# simply override everything except _meta
		862	local $_[0]{_meta};
		863	%{$_[0]} = %{$_[1]};
		864	}
		865
629	sub _attach_cb($$$$) {	866	sub _attach_cb($$$$) {
630	my ($registry, $event, $prio, $cb) = @_;	867	my ($registry, $event, $prio, $cb) = @_;
631		868
632	use sort 'stable';	869	use sort 'stable';
633		870
…		…
667	$registry = $CB_TYPE[$object_type] ||= [];	904	$registry = $CB_TYPE[$object_type] ||= [];
668		905
669	} elsif ($type eq "subtype") {	906	} elsif ($type eq "subtype") {
670	defined $object_type or Carp::croak "subtype specified without type";	907	defined $object_type or Carp::croak "subtype specified without type";
671	my $object_subtype = shift @arg;	908	my $object_subtype = shift @arg;
672	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	909	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
673		910
674	} elsif ($type eq "package") {	911	} elsif ($type eq "package") {
675	my $pkg = shift @arg;	912	my $pkg = shift @arg;
676		913
677	while (my ($name, $id) = each %cb_id) {	914	while (my ($name, $id) = each %cb_id) {
…		…
706	_attach $registry, $klass, @attach;	943	_attach $registry, $klass, @attach;
707	}	944	}
708		945
709	$obj->{$name} = \%arg;	946	$obj->{$name} = \%arg;
710	} else {	947	} else {
711	warn "object uses attachment '$name' that is not available, postponing.\n";	948	warn "object uses attachment '$name' which is not available, postponing.\n";
712	}	949	}
713		950
714	$obj->{_attachment}{$name} = undef;	951	$obj->{_attachment}{$name} = undef;
715	}	952	}
716		953
…		…
718	if (ref $_[0]) {	955	if (ref $_[0]) {
719	_object_attach @_;	956	_object_attach @_;
720	} else {	957	} else {
721	_attach shift->_attach_registry, @_;	958	_attach shift->_attach_registry, @_;
722	}	959	}
		960	_recalc_want;
723	};	961	};
724		962
725	# all those should be optimised	963	# all those should be optimised
726	sub cf::attachable::detach {	964	sub cf::attachable::detach {
727	my ($obj, $name) = @_;	965	my ($obj, $name) = @_;
…		…
730	delete $obj->{_attachment}{$name};	968	delete $obj->{_attachment}{$name};
731	reattach ($obj);	969	reattach ($obj);
732	} else {	970	} else {
733	Carp::croak "cannot, currently, detach class attachments";	971	Carp::croak "cannot, currently, detach class attachments";
734	}	972	}
		973	_recalc_want;
735	};	974	};
736		975
737	sub cf::attachable::attached {	976	sub cf::attachable::attached {
738	my ($obj, $name) = @_;	977	my ($obj, $name) = @_;
739		978
…		…
754	";	993	";
755	die if $@;	994	die if $@;
756	}	995	}
757		996
758	our $override;	997	our $override;
759	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?
760		999
761	sub override {	1000	sub override {
762	$override = 1;	1001	$override = 1;
763	@invoke_results = ();	1002	@INVOKE_RESULTS = (@_);
764	}	1003	}
765		1004
766	sub do_invoke {	1005	sub do_invoke {
767	my $event = shift;	1006	my $event = shift;
768	my $callbacks = shift;	1007	my $callbacks = shift;
769		1008
770	@invoke_results = ();	1009	@INVOKE_RESULTS = ();
771		1010
772	local $override;	1011	local $override;
773		1012
774	for (@$callbacks) {	1013	for (@$callbacks) {
775	eval { &{$_->[1]} };	1014	eval { &{$_->[1]} };
…		…
784	}	1023	}
785		1024
786	0	1025	0
787	}	1026	}
788		1027
789	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1028	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
790		1029
791	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1030	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
792		1031
793	Generate an object-specific event with the given arguments.	1032	Generate an object-specific event with the given arguments.
794		1033
795	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
796	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
797	results (if you must, access C<@cf::invoke_results> directly).	1036	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
798		1037
799	=back	1038	=back
800		1039
801	=cut	1040	=cut
802		1041
803	#############################################################################	1042	#############################################################################
804	# 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	}
805		1086
806	sub reattach {	1087	sub reattach {
807	# basically do the same as instantiate, without calling instantiate	1088	# basically do the same as instantiate, without calling instantiate
808	my ($obj) = @_;	1089	my ($obj) = @_;
		1090
		1091	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
809		1092
810	my $registry = $obj->registry;	1093	my $registry = $obj->registry;
811		1094
812	@$registry = ();	1095	@$registry = ();
813		1096
…		…
828	cf::attachable->attach (	1111	cf::attachable->attach (
829	prio => -1000000,	1112	prio => -1000000,
830	on_instantiate => sub {	1113	on_instantiate => sub {
831	my ($obj, $data) = @_;	1114	my ($obj, $data) = @_;
832		1115
833	$data = from_json $data;	1116	$data = decode_json $data;
834		1117
835	for (@$data) {	1118	for (@$data) {
836	my ($name, $args) = @$_;	1119	my ($name, $args) = @$_;
837		1120
838	$obj->attach ($name, %{$args || {} });	1121	$obj->attach ($name, %{$args || {} });
…		…
854	sub object_freezer_save {	1137	sub object_freezer_save {
855	my ($filename, $rdata, $objs) = @_;	1138	my ($filename, $rdata, $objs) = @_;
856		1139
857	sync_job {	1140	sync_job {
858	if (length $$rdata) {	1141	if (length $$rdata) {
		1142	utf8::decode (my $decname = $filename);
859	warn sprintf "saving %s (%d,%d)\n",	1143	warn sprintf "saving %s (%d,%d)\n",
860	$filename, length $$rdata, scalar @$objs;	1144	$decname, length $$rdata, scalar @$objs;
861		1145
862	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1146	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
863	chmod SAVE_MODE, $fh;	1147	aio_chmod $fh, SAVE_MODE;
864	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1148	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
865	aio_fsync $fh;	1149	aio_fsync $fh if $cf::USE_FSYNC;
866	close $fh;	1150	aio_close $fh;
867		1151
868	if (@$objs) {	1152	if (@$objs) {
869	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) {
870	chmod SAVE_MODE, $fh;	1154	aio_chmod $fh, SAVE_MODE;
871	my $data = Storable::nfreeze { version => 1, objs => $objs };	1155	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
872	aio_write $fh, 0, (length $data), $data, 0;	1156	aio_write $fh, 0, (length $data), $data, 0;
873	aio_fsync $fh;	1157	aio_fsync $fh if $cf::USE_FSYNC;
874	close $fh;	1158	aio_close $fh;
875	aio_rename "$filename.pst~", "$filename.pst";	1159	aio_rename "$filename.pst~", "$filename.pst";
876	}	1160	}
877	} else {	1161	} else {
878	aio_unlink "$filename.pst";	1162	aio_unlink "$filename.pst";
879	}	1163	}
…		…
884	}	1168	}
885	} else {	1169	} else {
886	aio_unlink $filename;	1170	aio_unlink $filename;
887	aio_unlink "$filename.pst";	1171	aio_unlink "$filename.pst";
888	}	1172	}
889	}	1173	};
890	}	1174	}
891		1175
892	sub object_freezer_as_string {	1176	sub object_freezer_as_string {
893	my ($rdata, $objs) = @_;	1177	my ($rdata, $objs) = @_;
894		1178
…		…
906	or return;	1190	or return;
907		1191
908	unless (aio_stat "$filename.pst") {	1192	unless (aio_stat "$filename.pst") {
909	(aio_load "$filename.pst", $av) >= 0	1193	(aio_load "$filename.pst", $av) >= 0
910	or return;	1194	or return;
		1195
911	$av = eval { (Storable::thaw $av)->{objs} };	1196	my $st = eval { Coro::Storable::thaw $av };
		1197	$av = $st->{objs};
912	}	1198	}
913		1199
		1200	utf8::decode (my $decname = $filename);
914	warn sprintf "loading %s (%d)\n",	1201	warn sprintf "loading %s (%d,%d)\n",
915	$filename, length $data, scalar @{$av || []};#d#	1202	$decname, length $data, scalar @{$av || []};
		1203
916	return ($data, $av);	1204	($data, $av)
917	}	1205	}
		1206
		1207	=head2 COMMAND CALLBACKS
		1208
		1209	=over 4
		1210
		1211	=cut
918		1212
919	#############################################################################	1213	#############################################################################
920	# command handling &c	1214	# command handling &c
921		1215
922	=item cf::register_command $name => \&callback($ob,$args);	1216	=item cf::register_command $name => \&callback($ob,$args);
…		…
935	push @{ $COMMAND{$name} }, [$caller, $cb];	1229	push @{ $COMMAND{$name} }, [$caller, $cb];
936	}	1230	}
937		1231
938	=item cf::register_extcmd $name => \&callback($pl,$packet);	1232	=item cf::register_extcmd $name => \&callback($pl,$packet);
939		1233
940	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.
941		1239
942	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
943	called.	1241	called.
944		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
945	=cut	1254	=cut
946		1255
947	sub register_extcmd {	1256	sub register_extcmd {
948	my ($name, $cb) = @_;	1257	my ($name, $cb) = @_;
949		1258
950	my $caller = caller;
951	#warn "registering extcmd '$name' to '$caller'";
952
953	$EXTCMD{$name} = [$cb, $caller];	1259	$EXTCMD{$name} = $cb;
		1260	}
		1261
		1262	sub register_exticmd {
		1263	my ($name, $cb) = @_;
		1264
		1265	$EXTICMD{$name} = $cb;
954	}	1266	}
955		1267
956	cf::player->attach (	1268	cf::player->attach (
957	on_command => sub {	1269	on_command => sub {
958	my ($pl, $name, $params) = @_;	1270	my ($pl, $name, $params) = @_;
…		…
967	cf::override;	1279	cf::override;
968	},	1280	},
969	on_extcmd => sub {	1281	on_extcmd => sub {
970	my ($pl, $buf) = @_;	1282	my ($pl, $buf) = @_;
971		1283
972	my $msg = eval { from_json $buf };	1284	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
973		1285
974	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
975	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1294	if (my $cb = $EXTCMD{$type}) {
976	if (my %reply = $cb->[0]->($pl, $msg)) {	1295	@reply = $cb->($pl, @payload);
977	$pl->ext_reply ($msg->{msgid}, %reply);
978	}
979	}	1296	}
		1297
		1298	$pl->ext_reply ($reply, @reply)
		1299	if $reply;
		1300
980	} else {	1301	} else {
981	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1302	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
982	}	1303	}
983		1304
984	cf::override;	1305	cf::override;
985	},	1306	},
986	);	1307	);
987		1308
988	sub register {
989	my ($base, $pkg) = @_;
990
991	#TODO
992	}
993
994	sub load_extension {
995	my ($path) = @_;
996
997	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
998	my $base = $1;
999	my $pkg = $1;
1000	$pkg =~ s/[^[:word:]]/_/g;
1001	$pkg = "ext::$pkg";
1002
1003	warn "loading '$path' into '$pkg'\n";
1004
1005	open my $fh, "<:utf8", $path
1006	or die "$path: $!";
1007
1008	my $source =
1009	"package $pkg; use strict; use utf8;\n"
1010	. "#line 1 \"$path\"\n{\n"
1011	. (do { local $/; <$fh> })
1012	. "\n};\n1";
1013
1014	eval $source
1015	or die $@ ? "$path: $@\n"
1016	: "extension disabled.\n";
1017
1018	push @exts, $pkg;
1019	$ext_pkg{$base} = $pkg;
1020
1021	# no strict 'refs';
1022	# @{"$pkg\::ISA"} = ext::;
1023
1024	register $base, $pkg;
1025	}
1026
1027	sub unload_extension {
1028	my ($pkg) = @_;
1029
1030	warn "removing extension $pkg\n";
1031
1032	# remove hooks
1033	#TODO
1034	# for my $idx (0 .. $#PLUGIN_EVENT) {
1035	# delete $hook[$idx]{$pkg};
1036	# }
1037
1038	# remove commands
1039	for my $name (keys %COMMAND) {
1040	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1041
1042	if (@cb) {
1043	$COMMAND{$name} = \@cb;
1044	} else {
1045	delete $COMMAND{$name};
1046	}
1047	}
1048
1049	# remove extcmds
1050	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1051	delete $EXTCMD{$name};
1052	}
1053
1054	if (my $cb = $pkg->can ("unload")) {
1055	eval {
1056	$cb->($pkg);
1057	1
1058	} or warn "$pkg unloaded, but with errors: $@";
1059	}
1060
1061	Symbol::delete_package $pkg;
1062	}
1063
1064	sub load_extensions {	1309	sub load_extensions {
		1310	cf::sync_job {
		1311	my %todo;
		1312
1065	for my $ext (<$LIBDIR/*.ext>) {	1313	for my $path (<$LIBDIR/*.ext>) {
1066	next unless -r $ext;	1314	next unless -r $path;
1067	eval {	1315
1068	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;
1069	1	1372	}
1070	} or warn "$ext not loaded: $@";	1373
		1374	skip:
		1375	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1376	unless $progress;
		1377	}
1071	}	1378	};
1072	}	1379	}
1073		1380
1074	#############################################################################	1381	#############################################################################
1075	# load/save/clean perl data associated with a map
1076		1382
1077	*cf::mapsupport::on_clean = sub {	1383	=back
1078	my ($map) = @_;
1079
1080	my $path = $map->tmpname;
1081	defined $path or return;
1082
1083	unlink "$path.pst";
1084	};
1085
1086	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1087
1088	#############################################################################
1089		1384
1090	=head2 CORE EXTENSIONS	1385	=head2 CORE EXTENSIONS
1091		1386
1092	Functions and methods that extend core crossfire objects.	1387	Functions and methods that extend core crossfire objects.
1093		1388
…		…
1099		1394
1100	=head3 cf::player	1395	=head3 cf::player
1101		1396
1102	=over 4	1397	=over 4
1103		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
1104	=item cf::player::find $login	1413	=item cf::player::find $login
1105		1414
1106	Returns the given player object, loading it if necessary (might block).	1415	Returns the given player object, loading it if necessary (might block).
1107		1416
1108	=cut	1417	=cut
1109		1418
1110	sub playerdir($) {	1419	sub playerdir($) {
1111	cf::localdir	1420	"$PLAYERDIR/"
1112	. "/"
1113	. cf::playerdir
1114	. "/"
1115	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1421	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1116	}	1422	}
1117		1423
1118	sub path($) {	1424	sub path($) {
1119	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1425	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1120		1426
1121	(playerdir $login) . "/$login.pl"	1427	(playerdir $login) . "/playerdata"
1122	}	1428	}
1123		1429
1124	sub find_active($) {	1430	sub find_active($) {
1125	$cf::PLAYER{$_[0]}	1431	$cf::PLAYER{$_[0]}
1126	and $cf::PLAYER{$_[0]}->active	1432	and $cf::PLAYER{$_[0]}->active
…		…
1129		1435
1130	sub exists($) {	1436	sub exists($) {
1131	my ($login) = @_;	1437	my ($login) = @_;
1132		1438
1133	$cf::PLAYER{$login}	1439	$cf::PLAYER{$login}
1134	or cf::sync_job { !aio_stat $login }	1440	or cf::sync_job { !aio_stat path $login }
1135	}	1441	}
1136		1442
1137	sub find($) {	1443	sub find($) {
1138	return $cf::PLAYER{$_[0]} || do {	1444	return $cf::PLAYER{$_[0]} || do {
1139	my $login = $_[0];	1445	my $login = $_[0];
1140		1446
1141	my $guard = cf::lock_acquire "user_find:$login";	1447	my $guard = cf::lock_acquire "user_find:$login";
1142		1448
1143	$cf::PLAYER{$_[0]} || do {	1449	$cf::PLAYER{$_[0]} || do {
1144	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
1145	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;
1146	$cf::PLAYER{$login} = $pl	1465	$cf::PLAYER{$login} = $pl
1147	}	1466	}
1148	}	1467	}
1149	}	1468	}
1150		1469
…		…
1159	return if $pl->{deny_save};	1478	return if $pl->{deny_save};
1160		1479
1161	aio_mkdir playerdir $pl, 0770;	1480	aio_mkdir playerdir $pl, 0770;
1162	$pl->{last_save} = $cf::RUNTIME;	1481	$pl->{last_save} = $cf::RUNTIME;
1163		1482
		1483	cf::get_slot 0.01;
		1484
1164	$pl->save_pl ($path);	1485	$pl->save_pl ($path);
1165	Coro::cede;	1486	cf::cede_to_tick;
1166	}	1487	}
1167		1488
1168	sub new($) {	1489	sub new($) {
1169	my ($login) = @_;	1490	my ($login) = @_;
1170		1491
…		…
1176	$cf::PLAYER{$login} = $self;	1497	$cf::PLAYER{$login} = $self;
1177		1498
1178	$self	1499	$self
1179	}	1500	}
1180		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
1181	=item $pl->quit_character	1512	=item $pl->quit_character
1182		1513
1183	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
1184	be destroyed. May block for a long time.	1515	be destroyed. May block for a long time.
1185		1516
1186	=cut	1517	=cut
1187		1518
1188	sub quit_character {	1519	sub quit_character {
1189	my ($pl) = @_;	1520	my ($pl) = @_;
1190		1521
		1522	my $name = $pl->ob->name;
		1523
1191	$pl->{deny_save} = 1;	1524	$pl->{deny_save} = 1;
1192	$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
1193		1526
1194	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1527	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1195	$pl->deactivate;	1528	$pl->deactivate;
		1529	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1530	$pl->ob->check_score;
1196	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1531	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1197	$pl->ns->destroy if $pl->ns;	1532	$pl->ns->destroy if $pl->ns;
1198		1533
1199	my $path = playerdir $pl;	1534	my $path = playerdir $pl;
1200	my $temp = "$path~$cf::RUNTIME~deleting~";	1535	my $temp = "$path~$cf::RUNTIME~deleting~";
1201	aio_rename $path, $temp;	1536	aio_rename $path, $temp;
1202	delete $cf::PLAYER{$pl->ob->name};	1537	delete $cf::PLAYER{$pl->ob->name};
1203	$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
1204	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;
1205	}	1560	}
1206		1561
1207	=item cf::player::list_logins	1562	=item cf::player::list_logins
1208		1563
1209	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
1210	while and may block, so not sync_job-capable, ever.	1565	while and may block, so not sync_job-capable, ever.
1211		1566
1212	=cut	1567	=cut
1213		1568
1214	sub list_logins {	1569	sub list_logins {
1215	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1570	my $dirs = aio_readdir $PLAYERDIR
1216	or return [];	1571	or return [];
1217		1572
1218	my @logins;	1573	my @logins;
1219		1574
1220	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") {
1221	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1581	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1222	aio_read $fh, 0, 512, my $buf, 0 or next;	1582	aio_read $fh, 0, 512, my $buf, 0 or next;
1223	$buf !~ /^password -------------$/m or next; # official not-valid tag	1583	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1584	}
1224		1585
1225	utf8::decode $login;	1586	utf8::decode $login;
1226	push @logins, $login;	1587	push @logins, $login;
1227	}	1588	}
1228		1589
1229	\@logins	1590	\@logins
1230	}	1591	}
1231		1592
1232	=item $player->maps	1593	=item $player->maps
1233		1594
1234	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
1235	player. May block.	1596	player. May block.
1236		1597
1237	=cut	1598	=cut
1238		1599
1239	sub maps($) {	1600	sub maps($) {
1240	my ($pl) = @_;	1601	my ($pl) = @_;
		1602
		1603	$pl = ref $pl ? $pl->ob->name : $pl;
1241		1604
1242	my $files = aio_readdir playerdir $pl	1605	my $files = aio_readdir playerdir $pl
1243	or return;	1606	or return;
1244		1607
1245	my @paths;	1608	my @paths;
…		…
1247	for (@$files) {	1610	for (@$files) {
1248	utf8::decode $_;	1611	utf8::decode $_;
1249	next if /\.(?:pl|pst)$/;	1612	next if /\.(?:pl|pst)$/;
1250	next unless /^$PATH_SEP/o;	1613	next unless /^$PATH_SEP/o;
1251		1614
1252	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;	1615	push @paths, cf::map::normalise "~$pl/$_";
1253	}	1616	}
1254		1617
1255	\@paths	1618	\@paths
1256	}	1619	}
1257		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
1258	=item $player->ext_reply ($msgid, $msgtype, %msg)	1714	=item $player->ext_reply ($msgid, @msg)
1259		1715
1260	Sends an ext reply to the player.	1716	Sends an ext reply to the player.
1261		1717
1262	=cut	1718	=cut
1263		1719
1264	sub ext_reply($$$%) {	1720	sub ext_reply($$@) {
1265	my ($self, $id, %msg) = @_;	1721	my ($self, $id, @msg) = @_;
1266		1722
1267	$msg{msgid} = $id;	1723	$self->ns->ext_reply ($id, @msg)
1268
1269	$self->send ("ext " . cf::to_json \%msg);
1270	}	1724	}
1271		1725
1272	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	}
1273		1766
1274	=back	1767	=back
1275
1276		1768
1277	=head3 cf::map	1769	=head3 cf::map
1278		1770
1279	=over 4	1771	=over 4
1280		1772
…		…
1283	package cf::map;	1775	package cf::map;
1284		1776
1285	use Fcntl;	1777	use Fcntl;
1286	use Coro::AIO;	1778	use Coro::AIO;
1287		1779
		1780	use overload
		1781	'""' => \&as_string,
		1782	fallback => 1;
		1783
1288	our $MAX_RESET = 3600;	1784	our $MAX_RESET = 3600;
1289	our $DEFAULT_RESET = 3000;	1785	our $DEFAULT_RESET = 3000;
1290		1786
1291	sub generate_random_map {	1787	sub generate_random_map {
1292	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
1293		1791
1294	# mit "rum" bekleckern, nicht	1792	# mit "rum" bekleckern, nicht
1295	cf::map::_create_random_map	1793	$self->_create_random_map (
1296	$path,
1297	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1794	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1298	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1795	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1299	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1796	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1300	$rmp->{exit_on_final_map},	1797	$rmp->{exit_on_final_map},
1301	$rmp->{xsize}, $rmp->{ysize},	1798	$rmp->{xsize}, $rmp->{ysize},
1302	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1799	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1303	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1800	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1304	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1801	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1305	$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},
1306	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1803	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1307	(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"
1308	}	1933	}
1309		1934
1310	# and all this just because we cannot iterate over	1935	# and all this just because we cannot iterate over
1311	# all maps in C++...	1936	# all maps in C++...
1312	sub change_all_map_light {	1937	sub change_all_map_light {
…		…
1314		1939
1315	$_->change_map_light ($change)	1940	$_->change_map_light ($change)
1316	for grep $_->outdoor, values %cf::MAP;	1941	for grep $_->outdoor, values %cf::MAP;
1317	}	1942	}
1318		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
1319	sub try_load_header($) {	1960	sub load_header_from($) {
1320	my ($path) = @_;	1961	my ($self, $path) = @_;
1321		1962
1322	utf8::encode $path;	1963	utf8::encode $path;
1323	aio_open $path, O_RDONLY, 0	1964	my $f = new_from_file cf::object::thawer $path
1324	or return;	1965	or return;
1325		1966
1326	my $map = cf::map::new	1967	$self->_load_header ($f)
1327	or return;	1968	or return;
1328		1969
1329	# for better error messages only, will be overwritten	1970	local $MAP_LOADING{$self->{path}} = $self;
1330	$map->path ($path);	1971	$f->resolve_delayed_derefs;
1331		1972
1332	$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
1333	or return;	2016	or return;
		2017	$self->prepare_orig;
		2018	}
1334		2019
1335	$map->{load_path} = $path;	2020	$self->{deny_reset} = 1
		2021	if $self->no_reset;
1336		2022
1337	$map	2023	$self->default_region (cf::region::find_by_path $self->{path})
		2024	unless $self->default_region;
		2025
		2026	1
1338	}	2027	}
1339		2028
1340	sub find;	2029	sub find;
1341	sub find {	2030	sub find {
1342	my ($path, $origin) = @_;	2031	my ($path, $origin) = @_;
1343		2032
1344	#warn "find<$path,$origin>\n";#d#
1345
1346	$path = new cf::path $path, $origin && $origin->path;	2033	$path = normalise $path, $origin && $origin->path;
1347	my $key = $path->as_string;
1348		2034
		2035	cf::lock_wait "map_data:$path";#d#remove
1349	cf::lock_wait "map_find:$key";	2036	cf::lock_wait "map_find:$path";
1350		2037
1351	$cf::MAP{$key} || do {	2038	$cf::MAP{$path} || do {
		2039	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1352	my $guard = cf::lock_acquire "map_find:$key";	2040	my $guard2 = cf::lock_acquire "map_find:$path";
1353		2041
1354	# do it the slow way	2042	my $map = new_from_path cf::map $path
1355	my $map = try_load_header $path->save_path;
1356
1357	Coro::cede;
1358
1359	if ($map) {
1360	$map->last_access ((delete $map->{last_access})
1361	|| $cf::RUNTIME); #d#
1362	# safety
1363	$map->{instantiate_time} = $cf::RUNTIME
1364	if $map->{instantiate_time} > $cf::RUNTIME;
1365	} else {
1366	if (my $rmp = $path->random_map_params) {
1367	$map = generate_random_map $key, $rmp;
1368	} else {
1369	$map = try_load_header $path->load_path;
1370	}
1371
1372	$map or return;	2043	or return;
1373		2044
1374	$map->{load_original} = 1;
1375	$map->{instantiate_time} = $cf::RUNTIME;
1376	$map->last_access ($cf::RUNTIME);
1377	$map->instantiate;
1378
1379	# per-player maps become, after loading, normal maps
1380	$map->per_player (0) if $path->{user_rel};
1381	}
1382
1383	$map->path ($key);
1384	$map->{path} = $path;
1385	$map->{last_save} = $cf::RUNTIME;	2045	$map->{last_save} = $cf::RUNTIME;
1386		2046
1387	Coro::cede;	2047	$map->load_header
		2048	or return;
1388		2049
1389	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;
1390	$map->reset;	2055	$map->reset;
1391	undef $guard;
1392	$map = find $path	2056	return find $path;
1393	or return;
1394	}	2057	}
1395		2058
1396	$cf::MAP{$key} = $map	2059	$cf::MAP{$path} = $map
1397	}	2060	}
1398	}	2061	}
		2062
		2063	sub pre_load { }
		2064	sub post_load { }
1399		2065
1400	sub load {	2066	sub load {
1401	my ($self) = @_;	2067	my ($self) = @_;
1402		2068
		2069	local $self->{deny_reset} = 1; # loading can take a long time
		2070
1403	my $path = $self->{path};	2071	my $path = $self->{path};
		2072
		2073	{
1404	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2074	my $guard = cf::lock_acquire "map_data:$path";
1405		2075
		2076	return unless $self->valid;
1406	return if $self->in_memory != cf::MAP_SWAPPED;	2077	return unless $self->in_memory == cf::MAP_SWAPPED;
1407		2078
1408	$self->in_memory (cf::MAP_LOADING);	2079	$self->in_memory (cf::MAP_LOADING);
1409		2080
1410	$self->alloc;	2081	$self->alloc;
1411	$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)
1412	or return;	2089	or return;
1413		2090
1414	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2091	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1415	if delete $self->{load_original};	2092	if delete $self->{load_original};
1416		2093
1417	if (my $uniq = $path->uniq_path) {	2094	if (my $uniq = $self->uniq_path) {
1418	utf8::encode $uniq;	2095	utf8::encode $uniq;
1419	if (aio_open $uniq, O_RDONLY, 0) {	2096	unless (aio_stat $uniq) {
		2097	if (my $f = new_from_file cf::object::thawer $uniq) {
1420	$self->clear_unique_items;	2098	$self->clear_unique_items;
1421	$self->load_objects ($uniq, 0);	2099	$self->_load_objects ($f);
		2100	$f->resolve_delayed_derefs;
		2101	}
1422	}	2102	}
1423	}	2103	}
1424		2104
1425	Coro::cede;	2105	$f->resolve_delayed_derefs;
1426		2106
		2107	cf::cede_to_tick;
1427	# now do the right thing for maps	2108	# now do the right thing for maps
1428	$self->link_multipart_objects;	2109	$self->link_multipart_objects;
1429
1430	if ($self->{path}->is_style_map) {
1431	$self->{deny_save} = 1;
1432	$self->{deny_reset} = 1;
1433	} else {
1434	$self->fix_auto_apply;
1435	$self->decay_objects;
1436	$self->update_buttons;
1437	$self->set_darkness_map;
1438	$self->difficulty ($self->estimate_difficulty)	2110	$self->difficulty ($self->estimate_difficulty)
1439	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;
1440	$self->activate;	2121	$self->activate;
1441	}	2122	}
1442		2123
1443	Coro::cede;	2124	$self->{last_save} = $cf::RUNTIME;
		2125	$self->last_access ($cf::RUNTIME);
1444		2126
1445	$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
1446	}	2143	}
1447		2144
1448	# 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
1449	sub load_diag {	2146	sub load_neighbours {
1450	my ($map) = @_;	2147	my ($map) = @_;
1451		2148
1452	my @diag; # diagonal neighbours	2149	my @neigh; # diagonal neighbours
1453		2150
1454	for (0 .. 3) {	2151	for (0 .. 3) {
1455	my $neigh = $map->tile_path ($_)	2152	my $neigh = $map->tile_path ($_)
1456	or next;	2153	or next;
1457	$neigh = find $neigh, $map	2154	$neigh = find $neigh, $map
1458	or next;	2155	or next;
1459	$neigh->load;	2156	$neigh->load;
1460		2157
		2158	push @neigh,
1461	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2159	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1462	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2160	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1463	}	2161	}
1464		2162
1465	for (@diag) {	2163	for (grep defined $_->[0], @neigh) {
		2164	my ($path, $origin) = @$_;
1466	my $neigh = find @$_	2165	my $neigh = find $path, $origin
1467	or next;	2166	or next;
1468	$neigh->load;	2167	$neigh->load;
1469	}	2168	}
1470	}	2169	}
1471		2170
…		…
1476	}	2175	}
1477		2176
1478	sub do_load_sync {	2177	sub do_load_sync {
1479	my ($map) = @_;	2178	my ($map) = @_;
1480		2179
		2180	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2181	if $Coro::current == $Coro::main;
		2182
1481	cf::sync_job { $map->load };	2183	cf::sync_job { $map->load };
1482	}	2184	}
1483		2185
1484	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
1485	our $MAP_PREFETCHER = Coro::async {	2200	$MAP_PREFETCHER ||= cf::async {
1486	while () {	2201	$Coro::current->{desc} = "map prefetcher";
		2202
1487	while (%MAP_PREFETCH) {	2203	while (%MAP_PREFETCH) {
1488	my $key = each %MAP_PREFETCH	2204	while (my ($k, $v) = each %MAP_PREFETCH) {
1489	or next;	2205	if (my $map = find $k) {
		2206	$map->load if $v;
		2207	}
		2208
1490	my $path = delete $MAP_PREFETCH{$key};	2209	delete $MAP_PREFETCH{$k};
1491
1492	my $map = find $path
1493	or next;
1494	$map->load;
1495	}	2210	}
1496	Coro::schedule;	2211	}
		2212	undef $MAP_PREFETCHER;
1497	}	2213	};
1498	};
1499
1500	sub find_async {
1501	my ($path, $origin) = @_;
1502
1503	$path = new cf::path $path, $origin && $origin->path;
1504	my $key = $path->as_string;
1505
1506	if (my $map = $cf::MAP{$key}) {
1507	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1508	}
1509
1510	$MAP_PREFETCH{$key} = $path;
1511	$MAP_PREFETCHER->ready;	2214	$MAP_PREFETCHER->prio (6);
1512		2215
1513	()	2216	()
1514	}	2217	}
1515		2218
1516	sub save {	2219	sub save {
1517	my ($self) = @_;	2220	my ($self) = @_;
1518		2221
1519	my $lock = cf::lock_acquire "map_data:" . $self->path;	2222	my $lock = cf::lock_acquire "map_data:$self->{path}";
1520		2223
1521	$self->{last_save} = $cf::RUNTIME;	2224	$self->{last_save} = $cf::RUNTIME;
1522		2225
1523	return unless $self->dirty;	2226	return unless $self->dirty;
1524		2227
1525	my $save = $self->{path}->save_path; utf8::encode $save;	2228	my $save = $self->save_path; utf8::encode $save;
1526	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2229	my $uniq = $self->uniq_path; utf8::encode $uniq;
1527		2230
1528	$self->{load_path} = $save;	2231	$self->{load_path} = $save;
1529		2232
1530	return if $self->{deny_save};	2233	return if $self->{deny_save};
1531		2234
1532	local $self->{last_access} = $self->last_access;#d#	2235	local $self->{last_access} = $self->last_access;#d#
1533		2236
1534	cf::async {	2237	cf::async {
		2238	$Coro::current->{desc} = "map player save";
1535	$_->contr->save for $self->players;	2239	$_->contr->save for $self->players;
1536	};	2240	};
1537		2241
		2242	cf::get_slot 0.02;
		2243
1538	if ($uniq) {	2244	if ($uniq) {
1539	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2245	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1540	$self->save_objects ($uniq, cf::IO_UNIQUES);	2246	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1541	} else {	2247	} else {
1542	$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);
1543	}	2249	}
1544	}	2250	}
1545		2251
1546	sub swap_out {	2252	sub swap_out {
1547	my ($self) = @_;	2253	my ($self) = @_;
1548		2254
1549	# save first because save cedes	2255	# save first because save cedes
1550	$self->save;	2256	$self->save;
1551		2257
1552	my $lock = cf::lock_acquire "map_data:" . $self->path;	2258	my $lock = cf::lock_acquire "map_data:$self->{path}";
1553		2259
1554	return if $self->players;	2260	return if $self->players;
1555	return if $self->in_memory != cf::MAP_IN_MEMORY;	2261	return if $self->in_memory != cf::MAP_ACTIVE;
1556	return if $self->{deny_save};	2262	return if $self->{deny_save};
1557		2263
		2264	$self->in_memory (cf::MAP_SWAPPED);
		2265
		2266	$self->deactivate;
		2267	$_->clear_links_to ($self) for values %cf::MAP;
1558	$self->clear;	2268	$self->clear;
1559	$self->in_memory (cf::MAP_SWAPPED);
1560	}	2269	}
1561		2270
1562	sub reset_at {	2271	sub reset_at {
1563	my ($self) = @_;	2272	my ($self) = @_;
1564		2273
1565	# TODO: safety, remove and allow resettable per-player maps	2274	# TODO: safety, remove and allow resettable per-player maps
1566	return 1e99 if $self->{path}{user_rel};
1567	return 1e99 if $self->{deny_reset};	2275	return 1e99 if $self->{deny_reset};
1568		2276
1569	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2277	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1570	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;
1571		2279
…		…
1576	my ($self) = @_;	2284	my ($self) = @_;
1577		2285
1578	$self->reset_at <= $cf::RUNTIME	2286	$self->reset_at <= $cf::RUNTIME
1579	}	2287	}
1580		2288
1581	sub unlink_save {
1582	my ($self) = @_;
1583
1584	utf8::encode (my $save = $self->{path}->save_path);
1585	aioreq_pri 3; IO::AIO::aio_unlink $save;
1586	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1587	}
1588
1589	sub rename {
1590	my ($self, $new_path) = @_;
1591
1592	$self->unlink_save;
1593
1594	delete $cf::MAP{$self->path};
1595	$self->{path} = new cf::path $new_path;
1596	$self->path ($self->{path}->as_string);
1597	$cf::MAP{$self->path} = $self;
1598
1599	$self->save;
1600	}
1601
1602	sub reset {	2289	sub reset {
1603	my ($self) = @_;	2290	my ($self) = @_;
1604		2291
1605	my $lock = cf::lock_acquire "map_data:" . $self->path;	2292	my $lock = cf::lock_acquire "map_data:$self->{path}";
1606		2293
1607	return if $self->players;	2294	return if $self->players;
1608	return if $self->{path}{user_rel};#d#
1609		2295
1610	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	}
1611		2307
1612	delete $cf::MAP{$self->path};	2308	delete $cf::MAP{$self->path};
1613		2309
		2310	$self->deactivate;
1614	$_->clear_links_to ($self) for values %cf::MAP;	2311	$_->clear_links_to ($self) for values %cf::MAP;
		2312	$self->clear;
1615		2313
1616	$self->unlink_save;	2314	$self->unlink_save;
1617	$self->destroy;	2315	$self->destroy;
1618	}	2316	}
1619		2317
1620	my $nuke_counter = "aaaa";	2318	my $nuke_counter = "aaaa";
1621		2319
1622	sub nuke {	2320	sub nuke {
1623	my ($self) = @_;	2321	my ($self) = @_;
1624		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};
1625	$self->{deny_save} = 1;	2332	$self->{deny_save} = 1;
1626	$self->reset_timeout (1);	2333	$self->reset_timeout (1);
1627	$self->rename ("{nuke}/" . ($nuke_counter++));	2334	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2335
		2336	$cf::MAP{$self->path} = $self;
		2337	}
		2338
1628	$self->reset; # polite request, might not happen	2339	$self->reset; # polite request, might not happen
1629	}	2340	}
1630		2341
1631	sub customise_for {	2342	=item $maps = cf::map::tmp_maps
1632	my ($map, $ob) = @_;
1633		2343
1634	if ($map->per_player) {	2344	Returns an arrayref with all map paths of currently instantiated and saved
1635	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2345	maps. May block.
		2346
		2347	=cut
		2348
		2349	sub tmp_maps() {
1636	}	2350	[
		2351	map {
		2352	utf8::decode $_;
		2353	/\.map$/
		2354	? normalise $_
		2355	: ()
		2356	} @{ aio_readdir $TMPDIR or [] }
		2357	]
		2358	}
1637		2359
1638	$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	]
1639	}	2376	}
1640		2377
1641	=item cf::map::unique_maps	2378	=item cf::map::unique_maps
1642		2379
1643	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
1644	instantiated unique items. May block.	2381	instantiated unique items. May block.
1645		2382
1646	=cut	2383	=cut
1647		2384
1648	sub unique_maps() {	2385	sub unique_maps() {
1649	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2386	[
1650	or return;	2387	map {
1651
1652	my @paths;
1653
1654	for (@$files) {
1655	utf8::decode $_;	2388	utf8::decode $_;
1656	next if /\.pst$/;	2389	s/\.map$//; # TODO future compatibility hack
1657	next unless /^$PATH_SEP/o;	2390	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1658		2391	? ()
1659	push @paths, new cf::path $_;	2392	: normalise $_
		2393	} @{ aio_readdir $UNIQUEDIR or [] }
1660	}	2394	]
1661
1662	\@paths
1663	}	2395	}
1664
1665	package cf;
1666		2396
1667	=back	2397	=back
1668		2398
1669	=head3 cf::object	2399	=head3 cf::object
1670		2400
…		…
1674		2404
1675	=over 4	2405	=over 4
1676		2406
1677	=item $ob->inv_recursive	2407	=item $ob->inv_recursive
1678		2408
1679	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.
1680		2411
1681	=cut	2412	=cut
1682		2413
1683	sub inv_recursive_;	2414	sub inv_recursive_;
1684	sub inv_recursive_ {	2415	sub inv_recursive_ {
…		…
1687		2418
1688	sub inv_recursive {	2419	sub inv_recursive {
1689	inv_recursive_ inv $_[0]	2420	inv_recursive_ inv $_[0]
1690	}	2421	}
1691		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
1692	package cf;	2451	package cf;
1693		2452
1694	=back	2453	=back
1695		2454
1696	=head3 cf::object::player	2455	=head3 cf::object::player
…		…
1702	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>
1703	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
1704	dialogue with the given NPC character.	2463	dialogue with the given NPC character.
1705		2464
1706	=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	};
1707		2480
1708	# rough implementation of a future "reply" method that works	2481	# rough implementation of a future "reply" method that works
1709	# with dialog boxes.	2482	# with dialog boxes.
1710	#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
1711	sub cf::object::player::reply($$$;$) {	2484	sub cf::object::player::reply($$$;$) {
…		…
1713		2486
1714	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2487	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1715		2488
1716	if ($self->{record_replies}) {	2489	if ($self->{record_replies}) {
1717	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2490	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2491
1718	} 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 {
1719	$msg = $npc->name . " says: $msg" if $npc;	2500	$msg = $npc->name . " says: $msg" if $npc;
1720	$self->message ($msg, $flags);	2501	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2502	}
1721	}	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 (@_);
1722	}	2514	}
1723		2515
1724	=item $player_object->may ("access")	2516	=item $player_object->may ("access")
1725		2517
1726	Returns wether the given player is authorized to access resource "access"	2518	Returns wether the given player is authorized to access resource "access"
…		…
1739		2531
1740	=item $player_object->enter_link	2532	=item $player_object->enter_link
1741		2533
1742	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}>).
1743		2535
1744	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
1745	I<MUST> call C<leave_link> as soon as possible, though.	2537	I<MUST> call C<leave_link> as soon as possible, though.
1746		2538
		2539	Will never block.
		2540
1747	=item $player_object->leave_link ($map, $x, $y)	2541	=item $player_object->leave_link ($map, $x, $y)
1748		2542
1749	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
1750	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
1751	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
1752	to the emergency map position.	2546	fails, to the emergency map position.
1753		2547
1754	Might block.	2548	Might block.
1755		2549
1756	=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	}
1757		2561
1758	sub cf::object::player::enter_link {	2562	sub cf::object::player::enter_link {
1759	my ($self) = @_;	2563	my ($self) = @_;
1760		2564
1761	$self->deactivate_recursive;	2565	$self->deactivate_recursive;
1762		2566
1763	return if $self->map == $LINK_MAP;	2567	return if UNIVERSAL::isa $self->map, "ext::map_link";
1764		2568
1765	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2569	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1766	if $self->map;	2570	if $self->map && $self->map->{path} ne "{link}";
1767		2571
1768	$self->enter_map ($LINK_MAP, 20, 20);	2572	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1769	}	2573	}
1770		2574
1771	sub cf::object::player::leave_link {	2575	sub cf::object::player::leave_link {
1772	my ($self, $map, $x, $y) = @_;	2576	my ($self, $map, $x, $y) = @_;
		2577
		2578	return unless $self->contr->active;
1773		2579
1774	my $link_pos = delete $self->{_link_pos};	2580	my $link_pos = delete $self->{_link_pos};
1775		2581
1776	unless ($map) {	2582	unless ($map) {
1777	# restore original map position	2583	# restore original map position
…		…
1791	# use -1 or undef as default coordinates, not 0, 0	2597	# use -1 or undef as default coordinates, not 0, 0
1792	($x, $y) = ($map->enter_x, $map->enter_y)	2598	($x, $y) = ($map->enter_x, $map->enter_y)
1793	if $x <=0 && $y <= 0;	2599	if $x <=0 && $y <= 0;
1794		2600
1795	$map->load;	2601	$map->load;
1796	$map->load_diag;	2602	$map->load_neighbours;
1797		2603
1798	return unless $self->contr->active;	2604	return unless $self->contr->active;
1799	$self->activate_recursive;	2605	$self->activate_recursive;
		2606
		2607	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1800	$self->enter_map ($map, $x, $y);	2608	$self->enter_map ($map, $x, $y);
1801	}	2609	}
1802		2610
1803	cf::player->attach (	2611	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1804	on_logout => sub {
1805	my ($pl) = @_;
1806		2612
1807	# abort map switching before logout	2613	Moves the player to the given map-path and coordinates by first freezing
1808	if ($pl->ob->{_link_pos}) {	2614	her, loading and preparing them map, calling the provided $check callback
1809	cf::sync_job {	2615	that has to return the map if sucecssful, and then unfreezes the player on
1810	$pl->ob->leave_link	2616	the new (success) or old (failed) map position. In either case, $done will
1811	};	2617	be called at the end of this process.
1812	}
1813	},
1814	on_login => sub {
1815	my ($pl) = @_;
1816		2618
1817	# try to abort aborted map switching on player login :)
1818	# should happen only on crashes
1819	if ($pl->ob->{_link_pos}) {
1820	$pl->ob->enter_link;
1821	(async {
1822	# we need this sleep as the login has a concurrent enter_exit running
1823	# and this sleep increases chances of the player not ending up in scorn
1824	$pl->ob->reply (undef,
1825	"There was an internal problem at your last logout, "
1826	. "the server will try to bring you to your intended destination in a second.",
1827	cf::NDI_RED);
1828	Coro::Timer::sleep 1;
1829	$pl->ob->leave_link;
1830	})->prio (2);
1831	}
1832	},
1833	);
1834
1835	=item $player_object->goto ($path, $x, $y)
1836
1837	=cut	2619	=cut
		2620
		2621	our $GOTOGEN;
1838		2622
1839	sub cf::object::player::goto {	2623	sub cf::object::player::goto {
1840	my ($self, $path, $x, $y) = @_;	2624	my ($self, $path, $x, $y, $check, $done) = @_;
1841		2625
1842	$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;
1843		2628
1844	$self->enter_link;	2629	$self->enter_link;
1845		2630
1846	(async {	2631	(async {
1847	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) {
1848	$map = $map->customise_for ($self) if $map;	2657	$map = $map->customise_for ($self);
1849		2658	$map = $check->($map) if $check && $map;
1850	# warn "entering ", $map->path, " at ($x, $y)\n"	2659	} else {
1851	# if $map;
1852
1853	$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	}
1854		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};
1855	$self->leave_link ($map, $x, $y);	2673	$self->leave_link ($map, $x, $y);
		2674	}
		2675
		2676	$done->() if $done;
1856	})->prio (1);	2677	})->prio (1);
1857	}	2678	}
1858		2679
1859	=item $player_object->enter_exit ($exit_object)	2680	=item $player_object->enter_exit ($exit_object)
1860		2681
…		…
1862		2683
1863	sub parse_random_map_params {	2684	sub parse_random_map_params {
1864	my ($spec) = @_;	2685	my ($spec) = @_;
1865		2686
1866	my $rmp = { # defaults	2687	my $rmp = { # defaults
1867	xsize => 10,	2688	xsize => (cf::rndm 15, 40),
1868	ysize => 10,	2689	ysize => (cf::rndm 15, 40),
		2690	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2691	#layout => string,
1869	};	2692	};
1870		2693
1871	for (split /\n/, $spec) {	2694	for (split /\n/, $spec) {
1872	my ($k, $v) = split /\s+/, $_, 2;	2695	my ($k, $v) = split /\s+/, $_, 2;
1873		2696
…		…
1885	# that depends on the exit object	2708	# that depends on the exit object
1886		2709
1887	my $rmp = parse_random_map_params $exit->msg;	2710	my $rmp = parse_random_map_params $exit->msg;
1888		2711
1889	if ($exit->map) {	2712	if ($exit->map) {
1890	$rmp->{region} = $exit->map->region_name;	2713	$rmp->{region} = $exit->region->name;
1891	$rmp->{origin_map} = $exit->map->path;	2714	$rmp->{origin_map} = $exit->map->path;
1892	$rmp->{origin_x} = $exit->x;	2715	$rmp->{origin_x} = $exit->x;
1893	$rmp->{origin_y} = $exit->y;	2716	$rmp->{origin_y} = $exit->y;
		2717
		2718	$exit->map->touch;
1894	}	2719	}
1895		2720
1896	$rmp->{random_seed} ||= $exit->random_seed;	2721	$rmp->{random_seed} ||= $exit->random_seed;
1897		2722
1898	my $data = cf::to_json $rmp;	2723	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1899	my $md5 = Digest::MD5::md5_hex $data;	2724	my $md5 = Digest::MD5::md5_hex $data;
		2725	my $meta = "$RANDOMDIR/$md5.meta";
1900		2726
1901	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) {
1902	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;
1903		2731
		2732	my $slaying = "?random/$md5";
		2733
		2734	if ($exit->valid) {
1904	$exit->slaying ("?random/$md5");	2735	$exit->slaying ("?random/$md5");
1905	$exit->msg (undef);	2736	$exit->msg (undef);
		2737	}
1906	}	2738	}
1907	}	2739	}
1908		2740
1909	sub cf::object::player::enter_exit {	2741	sub cf::object::player::enter_exit {
1910	my ($self, $exit) = @_;	2742	my ($self, $exit) = @_;
…		…
1912	return unless $self->type == cf::PLAYER;	2744	return unless $self->type == cf::PLAYER;
1913		2745
1914	$self->enter_link;	2746	$self->enter_link;
1915		2747
1916	(async {	2748	(async {
1917	$self->deactivate_recursive; # just to be sure	2749	$Coro::current->{desc} = "enter_exit";
		2750
1918	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
1919	prepare_random_map $exit	2758	prepare_random_map $exit
1920	if $exit->slaying eq "/!";	2759	if $exit->slaying eq "/!";
		2760	}
1921		2761
1922	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;
1923	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2763	my $x = $exit->stats->hp;
		2764	my $y = $exit->stats->sp;
1924		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
1925	1;	2772	1
1926	}) {	2773	}) {
1927	$self->message ("Something went wrong deep within the crossfire server. "	2774	$self->message ("Something went wrong deep within the crossfire server. "
1928	. "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. "
1929	. "Please report this to the dungeon master!",	2776	. "Please report this to the dungeon master!",
1930	cf::NDI_UNIQUE | cf::NDI_RED);	2777	cf::NDI_UNIQUE | cf::NDI_RED);
1931		2778
1932	warn "ERROR in enter_exit: $@";	2779	warn "ERROR in enter_exit: $@";
1933	$self->leave_link;	2780	$self->leave_link;
1934	}	2781	}
1935	})->prio (1);	2782	})->prio (1);
…		…
1948		2795
1949	sub cf::client::send_drawinfo {	2796	sub cf::client::send_drawinfo {
1950	my ($self, $text, $flags) = @_;	2797	my ($self, $text, $flags) = @_;
1951		2798
1952	utf8::encode $text;	2799	utf8::encode $text;
1953	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2800	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1954	}	2801	}
1955		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	}
1956		2967
1957	=item $success = $client->query ($flags, "text", \&cb)	2968	=item $success = $client->query ($flags, "text", \&cb)
1958		2969
1959	Queues a query to the client, calling the given callback with	2970	Queues a query to the client, calling the given callback with
1960	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>,
1961	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>.
1962		2973
1963	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
1964	reliable at some point in the future.	2975	become reliable at some point in the future.
1965		2976
1966	=cut	2977	=cut
1967		2978
1968	sub cf::client::query {	2979	sub cf::client::query {
1969	my ($self, $flags, $text, $cb) = @_;	2980	my ($self, $flags, $text, $cb) = @_;
…		…
1977	utf8::encode $text;	2988	utf8::encode $text;
1978	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2989	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1979		2990
1980	$self->send_packet ($self->{query_queue}[0][0])	2991	$self->send_packet ($self->{query_queue}[0][0])
1981	if @{ $self->{query_queue} } == 1;	2992	if @{ $self->{query_queue} } == 1;
		2993
		2994	1
1982	}	2995	}
1983		2996
1984	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	},
1985	on_reply => sub {	3003	on_reply => sub {
1986	my ($ns, $msg) = @_;	3004	my ($ns, $msg) = @_;
1987		3005
1988	# this weird shuffling is so that direct followup queries	3006	# this weird shuffling is so that direct followup queries
1989	# get handled first	3007	# get handled first
1990	my $queue = delete $ns->{query_queue}	3008	my $queue = delete $ns->{query_queue}
1991	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
1992		3010
1993	(shift @$queue)->[1]->($msg);	3011	(shift @$queue)->[1]->($msg);
		3012	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1994		3013
1995	push @{ $ns->{query_queue} }, @$queue;	3014	push @{ $ns->{query_queue} }, @$queue;
1996		3015
1997	if (@{ $ns->{query_queue} } == @$queue) {	3016	if (@{ $ns->{query_queue} } == @$queue) {
1998	if (@$queue) {	3017	if (@$queue) {
…		…
2000	} else {	3019	} else {
2001	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3020	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2002	}	3021	}
2003	}	3022	}
2004	},	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	},
2005	);	3050	);
2006		3051
2007	=item $client->async (\&cb)	3052	=item $client->async (\&cb)
2008		3053
2009	Create a new coroutine, running the specified callback. The coroutine will	3054	Create a new coroutine, running the specified callback. The coroutine will
…		…
2050	our $safe = new Safe "safe";	3095	our $safe = new Safe "safe";
2051	our $safe_hole = new Safe::Hole;	3096	our $safe_hole = new Safe::Hole;
2052		3097
2053	$SIG{FPE} = 'IGNORE';	3098	$SIG{FPE} = 'IGNORE';
2054		3099
2055	$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	));
2056		3105
2057	# here we export the classes and methods available to script code	3106	# here we export the classes and methods available to script code
2058		3107
2059	=pod	3108	=pod
2060		3109
2061	The following fucntions and emthods are available within a safe environment:	3110	The following functions and methods are available within a safe environment:
2062		3111
2063	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
2064	cf::object::player player	3116	cf::object::player
2065	cf::player peaceful	3117	player
2066	cf::map trigger	3118
		3119	cf::player
		3120	peaceful
		3121
		3122	cf::map
		3123	trigger
2067		3124
2068	=cut	3125	=cut
2069		3126
2070	for (	3127	for (
2071	["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)],
2072	["cf::object::player" => qw(player)],	3131	["cf::object::player" => qw(player)],
2073	["cf::player" => qw(peaceful)],	3132	["cf::player" => qw(peaceful)],
2074	["cf::map" => qw(trigger)],	3133	["cf::map" => qw(trigger)],
2075	) {	3134	) {
2076	no strict 'refs';	3135	no strict 'refs';
…		…
2147	=back	3206	=back
2148		3207
2149	=cut	3208	=cut
2150		3209
2151	#############################################################################	3210	#############################################################################
		3211	# the server's init and main functions
2152		3212
2153	=head2 EXTENSION DATABASE SUPPORT	3213	sub load_facedata($) {
		3214	my ($path) = @_;
2154		3215
2155	Crossfire maintains a very simple database for extension use. It can	3216	# HACK to clear player env face cache, we need some signal framework
2156	currently store anything that can be serialised using Storable, which	3217	# for this (global event?)
2157	excludes objects.	3218	%ext::player_env::MUSIC_FACE_CACHE = ();
2158		3219
2159	The parameter C<$family> should best start with the name of the extension	3220	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2160	using it, it should be unique.
2161		3221
2162	=over 4	3222	warn "loading facedata from $path\n";
2163		3223
2164	=item $hashref = cf::db_get $family	3224	my $facedata;
		3225	0 < aio_load $path, $facedata
		3226	or die "$path: $!";
2165		3227
2166	Return a hashref for use by the extension C<$family>, which can be	3228	$facedata = Coro::Storable::thaw $facedata;
2167	modified. After modifications, you have to call C<cf::db_dirty> or
2168	C<cf::db_sync>.
2169		3229
2170	=item $value = cf::db_get $family => $key	3230	$facedata->{version} == 2
		3231	or cf::cleanup "$path: version mismatch, cannot proceed.";
2171		3232
2172	Returns a single value from the database	3233	# patch in the exptable
2173		3234	$facedata->{resource}{"res/exp_table"} = {
2174	=item cf::db_put $family => $hashref	3235	type => FT_RSRC,
2175		3236	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2176	Stores the given family hashref into the database. Updates are delayed, if
2177	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2178
2179	=item cf::db_put $family => $key => $value
2180
2181	Stores the given C<$value> in the family hash. Updates are delayed, if you
2182	want the data to be synced to disk immediately, use C<cf::db_sync>.
2183
2184	=item cf::db_dirty
2185
2186	Marks the database as dirty, to be updated at a later time.
2187
2188	=item cf::db_sync
2189
2190	Immediately write the database to disk I<if it is dirty>.
2191
2192	=cut
2193
2194	our $DB;
2195
2196	{
2197	my $path = cf::localdir . "/database.pst";
2198
2199	sub db_load() {
2200	$DB = stat $path ? Storable::retrieve $path : { };
2201	}
2202
2203	my $pid;
2204
2205	sub db_save() {
2206	waitpid $pid, 0 if $pid;
2207	if (0 == ($pid = fork)) {
2208	$DB->{_meta}{version} = 1;
2209	Storable::nstore $DB, "$path~";
2210	rename "$path~", $path;
2211	cf::_exit 0 if defined $pid;
2212	}
2213	}
2214
2215	my $dirty;
2216
2217	sub db_sync() {
2218	db_save if $dirty;
2219	undef $dirty;
2220	}
2221
2222	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2223	db_sync;
2224	});	3237	};
		3238	cf::cede_to_tick;
2225		3239
2226	sub db_dirty() {
2227	$dirty = 1;
2228	$idle->start;
2229	}	3240	{
		3241	my $faces = $facedata->{faceinfo};
2230		3242
2231	sub db_get($;$) {	3243	while (my ($face, $info) = each %$faces) {
2232	@_ >= 2	3244	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2233	? $DB->{$_[0]}{$_[1]}
2234	: ($DB->{$_[0]} ||= { })
2235	}
2236		3245
2237	sub db_put($$;$) {	3246	cf::face::set_visibility $idx, $info->{visibility};
2238	if (@_ >= 3) {	3247	cf::face::set_magicmap $idx, $info->{magicmap};
2239	$DB->{$_[0]}{$_[1]} = $_[2];	3248	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2240	} else {	3249	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2241	$DB->{$_[0]} = $_[1];
2242	}
2243	db_dirty;
2244	}
2245		3250
2246	cf::global->attach (	3251	cf::cede_to_tick;
2247	prio => 10000,
2248	on_cleanup => sub {
2249	db_sync;
2250	},	3252	}
2251	);
2252	}
2253		3253
2254	#############################################################################	3254	while (my ($face, $info) = each %$faces) {
2255	# the server's main()	3255	next unless $info->{smooth};
2256		3256
2257	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 {
2258	open my $fh, "<:utf8", cf::confdir . "/config"	3407	open my $fh, "<:utf8", "$CONFDIR/config"
2259	or return;	3408	or return;
2260		3409
2261	local $/;	3410	local $/;
2262	*CFG = YAML::Syck::Load <$fh>;	3411	*CFG = YAML::Load <$fh>;
2263		3412
2264	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3413	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2265		3414
2266	$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};
2267	$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};
…		…
2277		3426
2278	sub main {	3427	sub main {
2279	# we must not ever block the main coroutine	3428	# we must not ever block the main coroutine
2280	local $Coro::idle = sub {	3429	local $Coro::idle = sub {
2281	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#
2282	async { Event::one_event };	3431	(async {
		3432	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3433	EV::loop EV::LOOP_ONESHOT;
		3434	})->prio (Coro::PRIO_MAX);
2283	};	3435	};
2284		3436
2285	cfg_load;	3437	{
2286	db_load;	3438	my $guard = freeze_mainloop;
		3439	reload_config;
		3440	db_init;
2287	load_extensions;	3441	load_extensions;
		3442
		3443	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3444	}
		3445
2288	Event::loop;	3446	EV::loop;
2289	}	3447	}
2290		3448
2291	#############################################################################	3449	#############################################################################
2292	# initialisation and cleanup	3450	# initialisation and cleanup
2293		3451
2294	# install some emergency cleanup handlers	3452	# install some emergency cleanup handlers
2295	BEGIN {	3453	BEGIN {
		3454	our %SIGWATCHER = ();
2296	for my $signal (qw(INT HUP TERM)) {	3455	for my $signal (qw(INT HUP TERM)) {
2297	Event->signal (	3456	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2298	data => WF_AUTOCANCEL,
2299	signal => $signal,
2300	cb => sub {
2301	cf::cleanup "SIG$signal";	3457	cf::cleanup "SIG$signal";
2302	},
2303	);	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
2304	}	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 };
2305	}	3541	}
2306		3542
2307	sub emergency_save() {	3543	sub emergency_save() {
2308	my $freeze_guard = cf::freeze_mainloop;	3544	my $freeze_guard = cf::freeze_mainloop;
2309		3545
2310	warn "enter emergency perl save\n";	3546	warn "enter emergency perl save\n";
2311		3547
2312	cf::sync_job {	3548	cf::sync_job {
2313	# use a peculiar iteration method to avoid tripping on perl	3549	# use a peculiar iteration method to avoid tripping on perl
2314	# refcount bugs in for. also avoids problems with players	3550	# refcount bugs in for. also avoids problems with players
2315	# and maps saved/Destroyed asynchronously.	3551	# and maps saved/destroyed asynchronously.
2316	warn "begin emergency player save\n";	3552	warn "begin emergency player save\n";
2317	for my $login (keys %cf::PLAYER) {	3553	for my $login (keys %cf::PLAYER) {
2318	my $pl = $cf::PLAYER{$login} or next;	3554	my $pl = $cf::PLAYER{$login} or next;
2319	$pl->valid or next;	3555	$pl->valid or next;
		3556	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2320	$pl->save;	3557	$pl->save;
2321	}	3558	}
2322	warn "end emergency player save\n";	3559	warn "end emergency player save\n";
2323		3560
2324	warn "begin emergency map save\n";	3561	warn "begin emergency map save\n";
…		…
2326	my $map = $cf::MAP{$path} or next;	3563	my $map = $cf::MAP{$path} or next;
2327	$map->valid or next;	3564	$map->valid or next;
2328	$map->save;	3565	$map->save;
2329	}	3566	}
2330	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";
2331	};	3576	};
2332		3577
2333	warn "leave emergency perl save\n";	3578	warn "leave emergency perl save\n";
2334	}	3579	}
2335		3580
		3581	sub post_cleanup {
		3582	my ($make_core) = @_;
		3583
		3584	warn Carp::longmess "post_cleanup backtrace"
		3585	if $make_core;
		3586	}
		3587
2336	sub reload() {	3588	sub do_reload_perl() {
2337	# can/must only be called in main	3589	# can/must only be called in main
2338	if ($Coro::current != $Coro::main) {	3590	if ($Coro::current != $Coro::main) {
2339	warn "can only reload from main coroutine\n";	3591	warn "can only reload from main coroutine";
2340	return;	3592	return;
2341	}	3593	}
2342		3594
2343	warn "reloading...";	3595	warn "reloading...";
2344		3596
2345	my $guard = freeze_mainloop;	3597	warn "entering sync_job";
		3598
		3599	cf::sync_job {
		3600	cf::write_runtime_sync; # external watchdog should not bark
2346	cf::emergency_save;	3601	cf::emergency_save;
		3602	cf::write_runtime_sync; # external watchdog should not bark
2347		3603
2348	eval {	3604	warn "syncing database to disk";
		3605	BDB::db_env_txn_checkpoint $DB_ENV;
		3606
2349	# 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
2350		3608
2351	# cancel all watchers	3609	warn "flushing outstanding aio requests";
2352	for (Event::all_watchers) {	3610	for (;;) {
2353	$_->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...";
2354	}	3616	}
2355		3617
		3618	++$RELOAD;
		3619
2356	# cancel all extension coros	3620	warn "cancelling all extension coros";
2357	$_->cancel for values %EXT_CORO;	3621	$_->cancel for values %EXT_CORO;
2358	%EXT_CORO = ();	3622	%EXT_CORO = ();
2359		3623
2360	# unload all extensions	3624	warn "removing commands";
2361	for (@exts) {	3625	%COMMAND = ();
		3626
		3627	warn "removing ext/exti commands";
		3628	%EXTCMD = ();
		3629	%EXTICMD = ();
		3630
		3631	warn "unloading/nuking all extensions";
		3632	for my $pkg (@EXTS) {
2362	warn "unloading <$_>";	3633	warn "... unloading $pkg";
2363	unload_extension $_;	3634
		3635	if (my $cb = $pkg->can ("unload")) {
		3636	eval {
		3637	$cb->($pkg);
		3638	1
		3639	} or warn "$pkg unloaded, but with errors: $@";
2364	}	3640	}
2365		3641
		3642	warn "... nuking $pkg";
		3643	Symbol::delete_package $pkg;
		3644	}
		3645
2366	# unload all modules loaded from $LIBDIR	3646	warn "unloading all perl modules loaded from $LIBDIR";
2367	while (my ($k, $v) = each %INC) {	3647	while (my ($k, $v) = each %INC) {
2368	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3648	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2369		3649
2370	warn "removing <$k>";	3650	warn "... unloading $k";
2371	delete $INC{$k};	3651	delete $INC{$k};
2372		3652
2373	$k =~ s/\.pm$//;	3653	$k =~ s/\.pm$//;
2374	$k =~ s/\//::/g;	3654	$k =~ s/\//::/g;
2375		3655
…		…
2378	}	3658	}
2379		3659
2380	Symbol::delete_package $k;	3660	Symbol::delete_package $k;
2381	}	3661	}
2382		3662
2383	# sync database to disk
2384	cf::db_sync;
2385	IO::AIO::flush;
2386
2387	# get rid of safe::, as good as possible	3663	warn "getting rid of safe::, as good as possible";
2388	Symbol::delete_package "safe::$_"	3664	Symbol::delete_package "safe::$_"
2389	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);
2390		3666
2391	# remove register_script_function callbacks
2392	# TODO
2393
2394	# unload cf.pm "a bit"	3667	warn "unloading cf.pm \"a bit\"";
2395	delete $INC{"cf.pm"};	3668	delete $INC{"cf.pm"};
		3669	delete $INC{"cf/pod.pm"};
2396		3670
2397	# don't, removes xs symbols, too,	3671	# don't, removes xs symbols, too,
2398	# and global variables created in xs	3672	# and global variables created in xs
2399	#Symbol::delete_package __PACKAGE__;	3673	#Symbol::delete_package __PACKAGE__;
2400		3674
2401	# reload cf.pm	3675	warn "unload completed, starting to reload now";
		3676
2402	warn "reloading cf.pm";	3677	warn "reloading cf.pm";
2403	require cf;	3678	require cf;
2404	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3679	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2405		3680
2406	# load config and database again	3681	warn "loading config and database again";
2407	cf::cfg_load;	3682	cf::reload_config;
2408	cf::db_load;
2409		3683
2410	# load extensions
2411	warn "load extensions";	3684	warn "loading extensions";
2412	cf::load_extensions;	3685	cf::load_extensions;
2413		3686
2414	# reattach attachments to objects	3687	warn "reattaching attachments to objects/players";
2415	warn "reattach";	3688	_global_reattach; # objects, sockets
2416	_global_reattach;	3689	warn "reattaching attachments to maps";
2417	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.";
2418	};	3700	};
2419		3701
2420	if ($@) {	3702	warn "reloaded";
2421	warn $@;
2422	warn "error while reloading, exiting.";
2423	exit 1;
2424	}
2425
2426	warn "reloaded successfully";
2427	};	3703	};
2428		3704
2429	#############################################################################	3705	our $RELOAD_WATCHER; # used only during reload
2430		3706
2431	unless ($LINK_MAP) {	3707	sub reload_perl() {
2432	$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.
2433		3710
2434	$LINK_MAP->width (41);	3711	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2435	$LINK_MAP->height (41);	3712	do_reload_perl;
2436	$LINK_MAP->alloc;	3713	undef $RELOAD_WATCHER;
2437	$LINK_MAP->path ("{link}");	3714	};
2438	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2439	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2440
2441	# dirty hack because... archetypes are not yet loaded
2442	Event->timer (
2443	after => 10,
2444	cb => sub {
2445	$_[0]->w->cancel;
2446
2447	# provide some exits "home"
2448	my $exit = cf::object::new "exit";
2449
2450	$exit->slaying ($EMERGENCY_POSITION->[0]);
2451	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2452	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2453
2454	$LINK_MAP->insert ($exit->clone, 19, 19);
2455	$LINK_MAP->insert ($exit->clone, 19, 20);
2456	$LINK_MAP->insert ($exit->clone, 19, 21);
2457	$LINK_MAP->insert ($exit->clone, 20, 19);
2458	$LINK_MAP->insert ($exit->clone, 20, 21);
2459	$LINK_MAP->insert ($exit->clone, 21, 19);
2460	$LINK_MAP->insert ($exit->clone, 21, 20);
2461	$LINK_MAP->insert ($exit->clone, 21, 21);
2462
2463	$exit->destroy;
2464	});
2465
2466	$LINK_MAP->{deny_save} = 1;
2467	$LINK_MAP->{deny_reset} = 1;
2468
2469	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2470	}	3715	}
2471
2472	register "<global>", __PACKAGE__;
2473		3716
2474	register_command "reload" => sub {	3717	register_command "reload" => sub {
2475	my ($who, $arg) = @_;	3718	my ($who, $arg) = @_;
2476		3719
2477	if ($who->flag (FLAG_WIZ)) {	3720	if ($who->flag (FLAG_WIZ)) {
2478	$who->message ("start of reload.");
2479	reload;
2480	$who->message ("end of reload.");	3721	$who->message ("reloading server.");
		3722	async {
		3723	$Coro::current->{desc} = "perl_reload";
		3724	reload_perl;
		3725	};
2481	}	3726	}
2482	};	3727	};
2483		3728
2484	unshift @INC, $LIBDIR;	3729	unshift @INC, $LIBDIR;
2485		3730
2486	$TICK_WATCHER = Event->timer (	3731	my $bug_warning = 0;
2487	reentrant => 0,	3732
2488	prio => 0,	3733	our @WAIT_FOR_TICK;
2489	at => $NEXT_TICK || $TICK,	3734	our @WAIT_FOR_TICK_BEGIN;
2490	data => WF_AUTOCANCEL,	3735
2491	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
2492	cf::server_tick; # one server iteration	3759	cf::server_tick; # one server iteration
2493	$RUNTIME += $TICK;
2494	$NEXT_TICK += $TICK;
2495		3760
2496	$WAIT_FOR_TICK->broadcast;	3761	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2497	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3762	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2498		3763	Coro::async_pool {
2499	# if we are delayed by four ticks or more, skip them all	3764	$Coro::current->{desc} = "runtime saver";
2500	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2501
2502	$TICK_WATCHER->at ($NEXT_TICK);
2503	$TICK_WATCHER->start;
2504	},
2505	);
2506
2507	IO::AIO::max_poll_time $TICK * 0.2;
2508
2509	Event->io (
2510	fd => IO::AIO::poll_fileno,
2511	poll => 'r',
2512	prio => 5,
2513	data => WF_AUTOCANCEL,
2514	cb => \&IO::AIO::poll_cb,
2515	);
2516
2517	Event->timer (
2518	data => WF_AUTOCANCEL,
2519	after => 0,
2520	interval => 10,
2521	cb => sub {
2522	(Coro::unblock_sub {
2523	write_runtime	3765	write_runtime_sync
2524	or warn "ERROR: unable to write runtime file: $!";	3766	or warn "ERROR: unable to write runtime file: $!";
2525	})->();	3767	};
2526	},	3768	}
2527	);	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;
2528		3880
2529	END { cf::emergency_save }	3881	END { cf::emergency_save }
2530		3882
2531	1	3883	1
2532		3884

Diff Legend

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