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

Diff Legend

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