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

Diff Legend

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