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

Diff Legend

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