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.130 by root, Thu Jan 4 00:08:08 2007 UTC vs.
Revision 1.413 by root, Sun Apr 6 16:13:20 2008 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
2		23
3	use utf8;	24	use utf8;
4	use strict;	25	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV 3.2;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
12		35
13	use Coro 3.3 ();	36	use Coro 4.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 $FREEZE;	114	our $LINK_MAP; # the special {link} map, which is always available
55	our $RANDOM_MAPS = cf::localdir . "/random";	115
56	our %EXT_CORO;	116	# used to convert map paths into valid unix filenames by replacing / by ∕
		117	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		118
		119	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		120	our $LOADAVG; # same thing, but with alpha-smoothing
		121	our $JITTER; # average jitter
		122	our $TICK_START; # for load detecting purposes
57		123
58	binmode STDOUT;	124	binmode STDOUT;
59	binmode STDERR;	125	binmode STDERR;
60		126
61	# read virtual server time, if available	127	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	128	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	129	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	130	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	131	$RUNTIME = <$fh> + 0.;
66	}	132	}
67		133
68	mkdir cf::localdir;	134	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	135	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		136
74	# a special map that is always available	137	our $EMERGENCY_POSITION;
75	our $LINK_MAP;
76		138
77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];	139	sub cf::map::normalise;
78		140
79	#############################################################################	141	#############################################################################
80		142
81	=head2 GLOBAL VARIABLES	143	=head2 GLOBAL VARIABLES
82		144
…		…
89	=item $cf::RUNTIME	151	=item $cf::RUNTIME
90		152
91	The time this server has run, starts at 0 and is increased by $cf::TICK on	153	The time this server has run, starts at 0 and is increased by $cf::TICK on
92	every server tick.	154	every server tick.
93		155
94	=item $cf::LIBDIR	156	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		157	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		158	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95		159
96	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
97	be found. It will be added to C<@INC> automatically.	161	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		162	unique-items directory, player file directory, random maps directory and
		163	database environment.
98		164
99	=item $cf::NOW	165	=item $cf::NOW
100		166
101	The time of the last (current) server tick.	167	The time of the last (current) server tick.
102		168
103	=item $cf::TICK	169	=item $cf::TICK
104		170
105	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
106		172
		173	=item $cf::LOADAVG
		174
		175	The current CPU load on the server (alpha-smoothed), as a value between 0
		176	(none) and 1 (overloaded), indicating how much time is spent on processing
		177	objects per tick. Healthy values are < 0.5.
		178
		179	=item $cf::LOAD
		180
		181	The raw value load value from the last tick.
		182
107	=item %cf::CFG	183	=item %cf::CFG
108		184
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
110	from wherever your confdir points to.	186	from wherever your confdir points to.
		187
		188	=item cf::wait_for_tick, cf::wait_for_tick_begin
		189
		190	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		191	returns directly I<after> the tick processing (and consequently, can only wake one process
		192	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		193
		194	=item @cf::INVOKE_RESULTS
		195
		196	This array contains the results of the last C<invoke ()> call. When
		197	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		198	that call.
111		199
112	=back	200	=back
113		201
114	=cut	202	=cut
115		203
116	BEGIN {	204	BEGIN {
117	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
118	my $msg = join "", @_;	206	my $msg = join "", @_;
119	utf8::encode $msg;
120		207
121	$msg .= "\n"	208	$msg .= "\n"
122	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
123		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
124	LOG llevError, "cfperl: $msg";	213	LOG llevError, $msg;
125	};	214	};
126	}	215	}
		216
		217	$Coro::State::DIEHOOK = sub {
		218	return unless $^S eq 0; # "eq", not "=="
		219
		220	if ($Coro::current == $Coro::main) {#d#
		221	warn "DIEHOOK called in main context, Coro bug?\n";#d#
		222	return;#d#
		223	}#d#
		224
		225	# kill coroutine otherwise
		226	warn Carp::longmess $_[0];
		227	Coro::terminate
		228	};
		229
		230	$SIG{__DIE__} = sub { }; #d#?
127		231
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	236	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		237	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	238	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134		239
135	# we bless all objects into (empty) derived classes to force a method lookup	240	# we bless all objects into (empty) derived classes to force a method lookup
136	# within the Safe compartment.	241	# within the Safe compartment.
137	for my $pkg (qw(	242	for my $pkg (qw(
138	cf::global cf::attachable	243	cf::global cf::attachable
…		…
143	)) {	248	)) {
144	no strict 'refs';	249	no strict 'refs';
145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
146	}	251	}
147		252
148	$Event::DIED = sub {	253	$EV::DIED = sub {
149	warn "error in event callback: @_";	254	warn "error in event callback: @_";
150	};	255	};
151		256
152	my %ext_pkg;	257	#############################################################################
153	my @exts;
154	my @hook;
155		258
156	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
157		260
158	=over 4	261	=over 4
159		262
160	=cut	263	=item dumpval $ref
161		264
162	use JSON::Syck (); # TODO# replace by JSON::PC once working	265	=cut
163		266
		267	sub dumpval {
		268	eval {
		269	local $SIG{__DIE__};
		270	my $d;
		271	if (1) {
		272	$d = new Data::Dumper([$_[0]], ["*var"]);
		273	$d->Terse(1);
		274	$d->Indent(2);
		275	$d->Quotekeys(0);
		276	$d->Useqq(1);
		277	#$d->Bless(...);
		278	$d->Seen($_[1]) if @_ > 1;
		279	$d = $d->Dump();
		280	}
		281	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		282	$d
		283	} || "[unable to dump $_[0]: '$@']";
		284	}
		285
164	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
165		287
166	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
167		289
168	=cut
169
170	sub from_json($) {
171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172	JSON::Syck::Load $_[0]
173	}
174
175	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
176		291
177	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
178		293
179	=cut	294	=cut
180		295
181	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183	JSON::Syck::Dump $_[0]
184	}
185		297
186	=item my $guard = cf::guard { BLOCK }	298	sub encode_json($) { $json_coder->encode ($_[0]) }
187		299	sub decode_json($) { $json_coder->decode ($_[0]) }
188	Run the given callback when the guard object gets destroyed (useful for
189	coroutine cancellations).
190
191	You can call C<< ->cancel >> on the guard object to stop the block from
192	being executed.
193
194	=cut
195
196	sub guard(&) {
197	bless \(my $cb = $_[0]), cf::guard::;
198	}
199
200	sub cf::guard::cancel {
201	${$_[0]} = sub { };
202	}
203
204	sub cf::guard::DESTROY {
205	${$_[0]}->();
206	}
207		300
208	=item cf::lock_wait $string	301	=item cf::lock_wait $string
209		302
210	Wait until the given lock is available. See cf::lock_acquire.	303	Wait until the given lock is available. See cf::lock_acquire.
211		304
212	=item my $lock = cf::lock_acquire $string	305	=item my $lock = cf::lock_acquire $string
213		306
214	Wait until the given lock is available and then acquires it and returns	307	Wait until the given lock is available and then acquires it and returns
215	a guard object. If the guard object gets destroyed (goes out of scope,	308	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216	for example when the coroutine gets canceled), the lock is automatically	309	for example when the coroutine gets canceled), the lock is automatically
217	returned.	310	returned.
218		311
		312	Locks are *not* recursive, locking from the same coro twice results in a
		313	deadlocked coro.
		314
219	Lock names should begin with a unique identifier (for example, find_map	315	Lock names should begin with a unique identifier (for example, cf::map::find
220	uses map_find and load_map uses map_load).	316	uses map_find and cf::map::load uses map_load).
		317
		318	=item $locked = cf::lock_active $string
		319
		320	Return true if the lock is currently active, i.e. somebody has locked it.
221		321
222	=cut	322	=cut
223		323
224	our %LOCK;	324	our %LOCK;
		325	our %LOCKER;#d#
225		326
226	sub lock_wait($) {	327	sub lock_wait($) {
227	my ($key) = @_;	328	my ($key) = @_;
		329
		330	if ($LOCKER{$key} == $Coro::current) {#d#
		331	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		332	return;#d#
		333	}#d#
228		334
229	# wait for lock, if any	335	# wait for lock, if any
230	while ($LOCK{$key}) {	336	while ($LOCK{$key}) {
231	push @{ $LOCK{$key} }, $Coro::current;	337	push @{ $LOCK{$key} }, $Coro::current;
232	Coro::schedule;	338	Coro::schedule;
…		…
238		344
239	# wait, to be sure we are not locked	345	# wait, to be sure we are not locked
240	lock_wait $key;	346	lock_wait $key;
241		347
242	$LOCK{$key} = [];	348	$LOCK{$key} = [];
		349	$LOCKER{$key} = $Coro::current;#d#
243		350
244	cf::guard {	351	Coro::guard {
		352	delete $LOCKER{$key};#d#
245	# wake up all waiters, to be on the safe side	353	# wake up all waiters, to be on the safe side
246	$_->ready for @{ delete $LOCK{$key} };	354	$_->ready for @{ delete $LOCK{$key} };
247	}	355	}
248	}	356	}
249		357
		358	sub lock_active($) {
		359	my ($key) = @_;
		360
		361	! ! $LOCK{$key}
		362	}
		363
		364	sub freeze_mainloop {
		365	tick_inhibit_inc;
		366
		367	Coro::guard \&tick_inhibit_dec;
		368	}
		369
		370	=item cf::periodic $interval, $cb
		371
		372	Like EV::periodic, but randomly selects a starting point so that the actions
		373	get spread over timer.
		374
		375	=cut
		376
		377	sub periodic($$) {
		378	my ($interval, $cb) = @_;
		379
		380	my $start = rand List::Util::min 180, $interval;
		381
		382	EV::periodic $start, $interval, 0, $cb
		383	}
		384
		385	=item cf::get_slot $time[, $priority[, $name]]
		386
		387	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		388	This call blocks and returns only when you have at least C<$time> seconds
		389	of cpu time till the next tick. The slot is only valid till the next cede.
		390
		391	The optional C<$name> can be used to identify the job to run. It might be
		392	used for statistical purposes and should identify the same time-class.
		393
		394	Useful for short background jobs.
		395
		396	=cut
		397
		398	our @SLOT_QUEUE;
		399	our $SLOT_QUEUE;
		400
		401	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		402	$SLOT_QUEUE = Coro::async {
		403	$Coro::current->desc ("timeslot manager");
		404
		405	my $signal = new Coro::Signal;
		406
		407	while () {
		408	next_job:
		409	my $avail = cf::till_tick;
		410	if ($avail > 0.01) {
		411	for (0 .. $#SLOT_QUEUE) {
		412	if ($SLOT_QUEUE[$_][0] < $avail) {
		413	my $job = splice @SLOT_QUEUE, $_, 1, ();
		414	$job->[2]->send;
		415	Coro::cede;
		416	goto next_job;
		417	}
		418	}
		419	}
		420
		421	if (@SLOT_QUEUE) {
		422	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		423	push @cf::WAIT_FOR_TICK, $signal;
		424	$signal->wait;
		425	} else {
		426	Coro::schedule;
		427	}
		428	}
		429	};
		430
		431	sub get_slot($;$$) {
		432	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
250	=item cf::async { BLOCK }	443	=item cf::async { BLOCK }
251		444
252	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
253	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.
254		448
255	=cut	449	=cut
256		450
257	sub async(&) {	451	BEGIN { *async = \&Coro::async_pool }
258	my ($cb) = @_;
259
260	Coro::async {
261	eval { $cb->() };
262	warn $@ if $@;
263	}
264	}
265		452
266	=item cf::sync_job { BLOCK }	453	=item cf::sync_job { BLOCK }
267		454
268	The design of crossfire+ requires that the main coro ($Coro::main) is	455	The design of Deliantra requires that the main coroutine ($Coro::main)
269	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
270	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.
271		459
272	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
273	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
274	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
275	fast or be very important.	463	fast or be very important.
…		…
278		466
279	sub sync_job(&) {	467	sub sync_job(&) {
280	my ($job) = @_;	468	my ($job) = @_;
281		469
282	if ($Coro::current == $Coro::main) {	470	if ($Coro::current == $Coro::main) {
		471	my $time = EV::time;
		472
283	# this is the main coro, too bad, we have to block	473	# this is the main coro, too bad, we have to block
284	# till the operation succeeds, freezing the server :/	474	# till the operation succeeds, freezing the server :/
285		475
286	# TODO: use suspend/resume instead	476	LOG llevError, Carp::longmess "sync job";#d#
287	# (but this is cancel-safe)	477
288	local $FREEZE = 1;	478	my $freeze_guard = freeze_mainloop;
289		479
290	my $busy = 1;	480	my $busy = 1;
291	my @res;	481	my @res;
292		482
293	(Coro::async {	483	(async {
		484	$Coro::current->desc ("sync job coro");
294	@res = eval { $job->() };	485	@res = eval { $job->() };
295	warn $@ if $@;	486	warn $@ if $@;
296	undef $busy;	487	undef $busy;
297	})->prio (Coro::PRIO_MAX);	488	})->prio (Coro::PRIO_MAX);
298		489
299	while ($busy) {	490	while ($busy) {
		491	if (Coro::nready) {
300	Coro::cede_notself;	492	Coro::cede_notself;
301	Event::one_event unless Coro::nready;	493	} else {
		494	EV::loop EV::LOOP_ONESHOT;
302	}	495	}
		496	}
		497
		498	my $time = EV::time - $time;
		499
		500	$TICK_START += $time; # do not account sync jobs to server load
303		501
304	wantarray ? @res : $res[0]	502	wantarray ? @res : $res[0]
305	} else {	503	} else {
306	# we are in another coroutine, how wonderful, everything just works	504	# we are in another coroutine, how wonderful, everything just works
307		505
308	$job->()	506	$job->()
309	}	507	}
310	}	508	}
311		509
312	=item $coro = cf::coro { BLOCK }	510	=item $coro = cf::async_ext { BLOCK }
313		511
314	Creates and returns a new coro. This coro is automcatially being canceled	512	Like async, but this coro is automatically being canceled when the
315	when the extension calling this is being unloaded.	513	extension calling this is being unloaded.
316		514
317	=cut	515	=cut
318		516
319	sub coro(&) {	517	sub async_ext(&) {
320	my $cb = shift;	518	my $cb = shift;
321		519
322	my $coro = &cf::async ($cb);	520	my $coro = &Coro::async ($cb);
323		521
324	$coro->on_destroy (sub {	522	$coro->on_destroy (sub {
325	delete $EXT_CORO{$coro+0};	523	delete $EXT_CORO{$coro+0};
326	});	524	});
327	$EXT_CORO{$coro+0} = $coro;	525	$EXT_CORO{$coro+0} = $coro;
328		526
329	$coro	527	$coro
330	}	528	}
331		529
332	sub write_runtime {	530	=item fork_call { }, $args
333	my $runtime = cf::localdir . "/runtime";
334		531
335	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	532	Executes the given code block with the given arguments in a seperate
336	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.
337		536
338	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	537	=cut
339	(aio_write $fh, 0, (length $value), $value, 0) <= 0
340	and return;
341		538
342	aio_fsync $fh	539	sub fork_call(&@) {
343	and return;	540	my ($cb, @args) = @_;
344		541
345	close $fh	542	# we seemingly have to make a local copy of the whole thing,
346	or return;	543	# otherwise perl prematurely frees the stuff :/
		544	# TODO: investigate and fix (likely this will be rather laborious)
347		545
348	aio_rename "$runtime~", $runtime	546	my @res = Coro::Util::fork_eval {
349	and return;	547	reset_signals;
		548	&$cb
		549	}, @args;
350		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
351	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 });
352	}	690	}
353		691
354	=back	692	=back
355		693
356	=cut	694	=cut
357
358	#############################################################################
359
360	package cf::path;
361
362	sub new {
363	my ($class, $path, $base) = @_;
364
365	$path = $path->as_string if ref $path;
366
367	my $self = bless { }, $class;
368
369	# {... are special paths that are not touched
370	# ?xxx/... are special absolute paths
371	# ?random/... random maps
372	# /! non-realised random map exit
373	# /... normal maps
374	# ~/... per-player maps without a specific player (DO NOT USE)
375	# ~user/... per-player map of a specific user
376
377	if ($path =~ /^{/) {
378	# fine as it is
379	} elsif ($path =~ s{^\?random/}{}) {
380	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
381	$self->{random} = cf::from_json $data;
382	} else {
383	if ($path =~ s{^~([^/]+)?}{}) {
384	$self->{user_rel} = 1;
385
386	if (defined $1) {
387	$self->{user} = $1;
388	} elsif ($base =~ m{^~([^/]+)/}) {
389	$self->{user} = $1;
390	} else {
391	warn "cannot resolve user-relative path without user <$path,$base>\n";
392	}
393	} elsif ($path =~ /^\//) {
394	# already absolute
395	} else {
396	$base =~ s{[^/]+/?$}{};
397	return $class->new ("$base/$path");
398	}
399
400	for ($path) {
401	redo if s{/\.?/}{/};
402	redo if s{/[^/]+/\.\./}{/};
403	}
404	}
405
406	$self->{path} = $path;
407
408	$self
409	}
410
411	# the name / primary key / in-game path
412	sub as_string {
413	my ($self) = @_;
414
415	$self->{user_rel} ? "~$self->{user}$self->{path}"
416	: $self->{random} ? "?random/$self->{path}"
417	: $self->{path}
418	}
419
420	# the displayed name, this is a one way mapping
421	sub visible_name {
422	my ($self) = @_;
423
424	# if (my $rmp = $self->{random}) {
425	# # todo: be more intelligent about this
426	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
427	# } else {
428	$self->as_string
429	# }
430	}
431
432	# escape the /'s in the path
433	sub _escaped_path {
434	# ∕ is U+2215
435	(my $path = $_[0]{path}) =~ s/\//∕/g;
436	$path
437	}
438
439	# the original (read-only) location
440	sub load_path {
441	my ($self) = @_;
442
443	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
444	}
445
446	# the temporary/swap location
447	sub save_path {
448	my ($self) = @_;
449
450	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
451	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
452	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
453	}
454
455	# the unique path, might be eq to save_path
456	sub uniq_path {
457	my ($self) = @_;
458
459	$self->{user_rel} || $self->{random}
460	? undef
461	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
462	}
463
464	# return random map parameters, or undef
465	sub random_map_params {
466	my ($self) = @_;
467
468	$self->{random}
469	}
470
471	# this is somewhat ugly, but style maps do need special treatment
472	sub is_style_map {
473	$_[0]{path} =~ m{^/styles/}
474	}
475
476	package cf;
477		695
478	#############################################################################	696	#############################################################################
479		697
480	=head2 ATTACHABLE OBJECTS	698	=head2 ATTACHABLE OBJECTS
481		699
…		…
483	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")
484	to it. All such attachable objects support the following methods.	702	to it. All such attachable objects support the following methods.
485		703
486	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>
487	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
488	crossfire+).	706	Deliantra).
489		707
490	=over 4	708	=over 4
491		709
492	=item $attachable->attach ($attachment, key => $value...)	710	=item $attachable->attach ($attachment, key => $value...)
493		711
…		…
607	our @CB_TYPE = (); # registry for type (cf-object class) based events	825	our @CB_TYPE = (); # registry for type (cf-object class) based events
608	our @CB_MAP = ();	826	our @CB_MAP = ();
609		827
610	my %attachment;	828	my %attachment;
611		829
		830	sub cf::attachable::thawer_merge {
		831	# simply override everything except _meta
		832	local $_[0]{_meta};
		833	%{$_[0]} = %{$_[1]};
		834	}
		835
612	sub _attach_cb($$$$) {	836	sub _attach_cb($$$$) {
613	my ($registry, $event, $prio, $cb) = @_;	837	my ($registry, $event, $prio, $cb) = @_;
614		838
615	use sort 'stable';	839	use sort 'stable';
616		840
…		…
650	$registry = $CB_TYPE[$object_type] ||= [];	874	$registry = $CB_TYPE[$object_type] ||= [];
651		875
652	} elsif ($type eq "subtype") {	876	} elsif ($type eq "subtype") {
653	defined $object_type or Carp::croak "subtype specified without type";	877	defined $object_type or Carp::croak "subtype specified without type";
654	my $object_subtype = shift @arg;	878	my $object_subtype = shift @arg;
655	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	879	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
656		880
657	} elsif ($type eq "package") {	881	} elsif ($type eq "package") {
658	my $pkg = shift @arg;	882	my $pkg = shift @arg;
659		883
660	while (my ($name, $id) = each %cb_id) {	884	while (my ($name, $id) = each %cb_id) {
…		…
689	_attach $registry, $klass, @attach;	913	_attach $registry, $klass, @attach;
690	}	914	}
691		915
692	$obj->{$name} = \%arg;	916	$obj->{$name} = \%arg;
693	} else {	917	} else {
694	warn "object uses attachment '$name' that is not available, postponing.\n";	918	warn "object uses attachment '$name' which is not available, postponing.\n";
695	}	919	}
696		920
697	$obj->{_attachment}{$name} = undef;	921	$obj->{_attachment}{$name} = undef;
698	}	922	}
699		923
…		…
701	if (ref $_[0]) {	925	if (ref $_[0]) {
702	_object_attach @_;	926	_object_attach @_;
703	} else {	927	} else {
704	_attach shift->_attach_registry, @_;	928	_attach shift->_attach_registry, @_;
705	}	929	}
		930	_recalc_want;
706	};	931	};
707		932
708	# all those should be optimised	933	# all those should be optimised
709	sub cf::attachable::detach {	934	sub cf::attachable::detach {
710	my ($obj, $name) = @_;	935	my ($obj, $name) = @_;
…		…
713	delete $obj->{_attachment}{$name};	938	delete $obj->{_attachment}{$name};
714	reattach ($obj);	939	reattach ($obj);
715	} else {	940	} else {
716	Carp::croak "cannot, currently, detach class attachments";	941	Carp::croak "cannot, currently, detach class attachments";
717	}	942	}
		943	_recalc_want;
718	};	944	};
719		945
720	sub cf::attachable::attached {	946	sub cf::attachable::attached {
721	my ($obj, $name) = @_;	947	my ($obj, $name) = @_;
722		948
…		…
737	";	963	";
738	die if $@;	964	die if $@;
739	}	965	}
740		966
741	our $override;	967	our $override;
742	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?
743		969
744	sub override {	970	sub override {
745	$override = 1;	971	$override = 1;
746	@invoke_results = ();	972	@INVOKE_RESULTS = (@_);
747	}	973	}
748		974
749	sub do_invoke {	975	sub do_invoke {
750	my $event = shift;	976	my $event = shift;
751	my $callbacks = shift;	977	my $callbacks = shift;
752		978
753	@invoke_results = ();	979	@INVOKE_RESULTS = ();
754		980
755	local $override;	981	local $override;
756		982
757	for (@$callbacks) {	983	for (@$callbacks) {
758	eval { &{$_->[1]} };	984	eval { &{$_->[1]} };
…		…
767	}	993	}
768		994
769	0	995	0
770	}	996	}
771		997
772	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	998	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
773		999
774	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1000	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
775		1001
776	Generate an object-specific event with the given arguments.	1002	Generate an object-specific event with the given arguments.
777		1003
778	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
779	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
780	results (if you must, access C<@cf::invoke_results> directly).	1006	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
781		1007
782	=back	1008	=back
783		1009
784	=cut	1010	=cut
785		1011
786	#############################################################################	1012	#############################################################################
787	# 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	}
788		1056
789	sub reattach {	1057	sub reattach {
790	# basically do the same as instantiate, without calling instantiate	1058	# basically do the same as instantiate, without calling instantiate
791	my ($obj) = @_;	1059	my ($obj) = @_;
		1060
		1061	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
792		1062
793	my $registry = $obj->registry;	1063	my $registry = $obj->registry;
794		1064
795	@$registry = ();	1065	@$registry = ();
796		1066
…		…
811	cf::attachable->attach (	1081	cf::attachable->attach (
812	prio => -1000000,	1082	prio => -1000000,
813	on_instantiate => sub {	1083	on_instantiate => sub {
814	my ($obj, $data) = @_;	1084	my ($obj, $data) = @_;
815		1085
816	$data = from_json $data;	1086	$data = decode_json $data;
817		1087
818	for (@$data) {	1088	for (@$data) {
819	my ($name, $args) = @$_;	1089	my ($name, $args) = @$_;
820		1090
821	$obj->attach ($name, %{$args || {} });	1091	$obj->attach ($name, %{$args || {} });
…		…
837	sub object_freezer_save {	1107	sub object_freezer_save {
838	my ($filename, $rdata, $objs) = @_;	1108	my ($filename, $rdata, $objs) = @_;
839		1109
840	sync_job {	1110	sync_job {
841	if (length $$rdata) {	1111	if (length $$rdata) {
		1112	utf8::decode (my $decname = $filename);
842	warn sprintf "saving %s (%d,%d)\n",	1113	warn sprintf "saving %s (%d,%d)\n",
843	$filename, length $$rdata, scalar @$objs;	1114	$decname, length $$rdata, scalar @$objs;
844		1115
845	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1116	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
846	chmod SAVE_MODE, $fh;	1117	chmod SAVE_MODE, $fh;
847	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1118	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
848	aio_fsync $fh;	1119	aio_fsync $fh if $cf::USE_FSYNC;
849	close $fh;	1120	close $fh;
850		1121
851	if (@$objs) {	1122	if (@$objs) {
852	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) {
853	chmod SAVE_MODE, $fh;	1124	chmod SAVE_MODE, $fh;
854	my $data = Storable::nfreeze { version => 1, objs => $objs };	1125	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
855	aio_write $fh, 0, (length $data), $data, 0;	1126	aio_write $fh, 0, (length $data), $data, 0;
856	aio_fsync $fh;	1127	aio_fsync $fh if $cf::USE_FSYNC;
857	close $fh;	1128	close $fh;
858	aio_rename "$filename.pst~", "$filename.pst";	1129	aio_rename "$filename.pst~", "$filename.pst";
859	}	1130	}
860	} else {	1131	} else {
861	aio_unlink "$filename.pst";	1132	aio_unlink "$filename.pst";
…		…
867	}	1138	}
868	} else {	1139	} else {
869	aio_unlink $filename;	1140	aio_unlink $filename;
870	aio_unlink "$filename.pst";	1141	aio_unlink "$filename.pst";
871	}	1142	}
872	}	1143	};
873	}	1144	}
874		1145
875	sub object_freezer_as_string {	1146	sub object_freezer_as_string {
876	my ($rdata, $objs) = @_;	1147	my ($rdata, $objs) = @_;
877		1148
…		…
889	or return;	1160	or return;
890		1161
891	unless (aio_stat "$filename.pst") {	1162	unless (aio_stat "$filename.pst") {
892	(aio_load "$filename.pst", $av) >= 0	1163	(aio_load "$filename.pst", $av) >= 0
893	or return;	1164	or return;
		1165
894	$av = eval { (Storable::thaw $av)->{objs} };	1166	my $st = eval { Coro::Storable::thaw $av };
		1167	$av = $st->{objs};
895	}	1168	}
896		1169
		1170	utf8::decode (my $decname = $filename);
897	warn sprintf "loading %s (%d)\n",	1171	warn sprintf "loading %s (%d,%d)\n",
898	$filename, length $data, scalar @{$av || []};#d#	1172	$decname, length $data, scalar @{$av || []};
		1173
899	return ($data, $av);	1174	($data, $av)
900	}	1175	}
		1176
		1177	=head2 COMMAND CALLBACKS
		1178
		1179	=over 4
		1180
		1181	=cut
901		1182
902	#############################################################################	1183	#############################################################################
903	# command handling &c	1184	# command handling &c
904		1185
905	=item cf::register_command $name => \&callback($ob,$args);	1186	=item cf::register_command $name => \&callback($ob,$args);
…		…
918	push @{ $COMMAND{$name} }, [$caller, $cb];	1199	push @{ $COMMAND{$name} }, [$caller, $cb];
919	}	1200	}
920		1201
921	=item cf::register_extcmd $name => \&callback($pl,$packet);	1202	=item cf::register_extcmd $name => \&callback($pl,$packet);
922		1203
923	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.
924		1209
925	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
926	called.	1211	called.
927		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
928	=cut	1224	=cut
929		1225
930	sub register_extcmd {	1226	sub register_extcmd {
931	my ($name, $cb) = @_;	1227	my ($name, $cb) = @_;
932		1228
933	my $caller = caller;
934	#warn "registering extcmd '$name' to '$caller'";
935
936	$EXTCMD{$name} = [$cb, $caller];	1229	$EXTCMD{$name} = $cb;
		1230	}
		1231
		1232	sub register_exticmd {
		1233	my ($name, $cb) = @_;
		1234
		1235	$EXTICMD{$name} = $cb;
937	}	1236	}
938		1237
939	cf::player->attach (	1238	cf::player->attach (
940	on_command => sub {	1239	on_command => sub {
941	my ($pl, $name, $params) = @_;	1240	my ($pl, $name, $params) = @_;
…		…
950	cf::override;	1249	cf::override;
951	},	1250	},
952	on_extcmd => sub {	1251	on_extcmd => sub {
953	my ($pl, $buf) = @_;	1252	my ($pl, $buf) = @_;
954		1253
955	my $msg = eval { from_json $buf };	1254	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
956		1255
957	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
958	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1264	if (my $cb = $EXTCMD{$type}) {
959	if (my %reply = $cb->[0]->($pl, $msg)) {	1265	@reply = $cb->($pl, @payload);
960	$pl->ext_reply ($msg->{msgid}, %reply);
961	}
962	}	1266	}
		1267
		1268	$pl->ext_reply ($reply, @reply)
		1269	if $reply;
		1270
963	} else {	1271	} else {
964	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1272	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
965	}	1273	}
966		1274
967	cf::override;	1275	cf::override;
968	},	1276	},
969	);	1277	);
970		1278
971	sub register {
972	my ($base, $pkg) = @_;
973
974	#TODO
975	}
976
977	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($) {
978	my ($path) = @_;	1717	my ($path) = @_;
979		1718
980	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1719	my ($match, $specificity);
981	my $base = $1;
982	my $pkg = $1;
983	$pkg =~ s/[^[:word:]]/_/g;
984	$pkg = "ext::$pkg";
985		1720
986	warn "loading '$path' into '$pkg'\n";	1721	for my $region (list) {
987		1722	if ($region->{match} && $path =~ $region->{match}) {
988	open my $fh, "<:utf8", $path	1723	($match, $specificity) = ($region, $region->specificity)
989	or die "$path: $!";	1724	if $region->specificity > $specificity;
990		1725	}
991	my $source =
992	"package $pkg; use strict; use utf8;\n"
993	. "#line 1 \"$path\"\n{\n"
994	. (do { local $/; <$fh> })
995	. "\n};\n1";
996
997	eval $source
998	or die $@ ? "$path: $@\n"
999	: "extension disabled.\n";
1000
1001	push @exts, $pkg;
1002	$ext_pkg{$base} = $pkg;
1003
1004	# no strict 'refs';
1005	# @{"$pkg\::ISA"} = ext::;
1006
1007	register $base, $pkg;
1008	}
1009
1010	sub unload_extension {
1011	my ($pkg) = @_;
1012
1013	warn "removing extension $pkg\n";
1014
1015	# remove hooks
1016	#TODO
1017	# for my $idx (0 .. $#PLUGIN_EVENT) {
1018	# delete $hook[$idx]{$pkg};
1019	# }	1726	}
1020		1727
1021	# remove commands	1728	$match
1022	for my $name (keys %COMMAND) {
1023	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1024
1025	if (@cb) {
1026	$COMMAND{$name} = \@cb;
1027	} else {
1028	delete $COMMAND{$name};
1029	}
1030	}
1031
1032	# remove extcmds
1033	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1034	delete $EXTCMD{$name};
1035	}
1036
1037	if (my $cb = $pkg->can ("unload")) {
1038	eval {
1039	$cb->($pkg);
1040	1
1041	} or warn "$pkg unloaded, but with errors: $@";
1042	}
1043
1044	Symbol::delete_package $pkg;
1045	}
1046
1047	sub load_extensions {
1048	for my $ext (<$LIBDIR/*.ext>) {
1049	next unless -r $ext;
1050	eval {
1051	load_extension $ext;
1052	1
1053	} or warn "$ext not loaded: $@";
1054	}
1055	}
1056
1057	#############################################################################
1058	# load/save/clean perl data associated with a map
1059
1060	*cf::mapsupport::on_clean = sub {
1061	my ($map) = @_;
1062
1063	my $path = $map->tmpname;
1064	defined $path or return;
1065
1066	unlink "$path.pst";
1067	};
1068
1069	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1070
1071	#############################################################################
1072	# load/save perl data associated with player->ob objects
1073
1074	sub all_objects(@) {
1075	@_, map all_objects ($_->inv), @_
1076	}
1077
1078	# TODO: compatibility cruft, remove when no longer needed
1079	cf::player->attach (
1080	on_load => sub {
1081	my ($pl, $path) = @_;
1082
1083	for my $o (all_objects $pl->ob) {
1084	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1085	$o->set_ob_key_value ("_perl_data");
1086
1087	%$o = %{ Storable::thaw pack "H*", $value };
1088	}
1089	}
1090	},
1091	);
1092
1093	#############################################################################
1094
1095	=head2 CORE EXTENSIONS
1096
1097	Functions and methods that extend core crossfire objects.
1098
1099	=head3 cf::player
1100
1101	=over 4
1102
1103	=item cf::player::exists $login
1104
1105	Returns true when the given account exists.
1106
1107	=cut
1108
1109	sub cf::player::exists($) {
1110	cf::player::find $_[0]
1111	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1112	}
1113
1114	=item $player->ext_reply ($msgid, $msgtype, %msg)
1115
1116	Sends an ext reply to the player.
1117
1118	=cut
1119
1120	sub cf::player::ext_reply($$$%) {
1121	my ($self, $id, %msg) = @_;
1122
1123	$msg{msgid} = $id;
1124
1125	$self->send ("ext " . to_json \%msg);
1126	}	1729	}
1127		1730
1128	=back	1731	=back
1129
1130		1732
1131	=head3 cf::map	1733	=head3 cf::map
1132		1734
1133	=over 4	1735	=over 4
1134		1736
…		…
1137	package cf::map;	1739	package cf::map;
1138		1740
1139	use Fcntl;	1741	use Fcntl;
1140	use Coro::AIO;	1742	use Coro::AIO;
1141		1743
		1744	use overload
		1745	'""' => \&as_string,
		1746	fallback => 1;
		1747
1142	our $MAX_RESET = 7200;	1748	our $MAX_RESET = 3600;
1143	our $DEFAULT_RESET = 3600;	1749	our $DEFAULT_RESET = 3000;
1144		1750
1145	sub generate_random_map {	1751	sub generate_random_map {
1146	my ($path, $rmp) = @_;	1752	my ($self, $rmp) = @_;
1147
1148	# mit "rum" bekleckern, nicht	1753	# mit "rum" bekleckern, nicht
1149	cf::map::_create_random_map	1754	$self->_create_random_map (
1150	$path,
1151	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1755	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1756	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1757	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154	$rmp->{exit_on_final_map},	1758	$rmp->{exit_on_final_map},
1155	$rmp->{xsize}, $rmp->{ysize},	1759	$rmp->{xsize}, $rmp->{ysize},
1156	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1760	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1761	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1158	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1762	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1159	$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},
1160	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1764	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1161	(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"
1162	}	1894	}
1163		1895
1164	# and all this just because we cannot iterate over	1896	# and all this just because we cannot iterate over
1165	# all maps in C++...	1897	# all maps in C++...
1166	sub change_all_map_light {	1898	sub change_all_map_light {
…		…
1168		1900
1169	$_->change_map_light ($change)	1901	$_->change_map_light ($change)
1170	for grep $_->outdoor, values %cf::MAP;	1902	for grep $_->outdoor, values %cf::MAP;
1171	}	1903	}
1172		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
1173	sub try_load_header($) {	1921	sub load_header_from($) {
1174	my ($path) = @_;	1922	my ($self, $path) = @_;
1175		1923
1176	utf8::encode $path;	1924	utf8::encode $path;
1177	aio_open $path, O_RDONLY, 0	1925	my $f = new_from_file cf::object::thawer $path
1178	or return;	1926	or return;
1179		1927
1180	my $map = cf::map::new	1928	$self->_load_header ($f)
1181	or return;	1929	or return;
1182		1930
1183	$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
1184	or return;	1977	or return;
		1978	$self->prepare_orig;
		1979	}
1185		1980
1186	$map->{load_path} = $path;	1981	$self->{deny_reset} = 1
		1982	if $self->no_reset;
1187		1983
1188	$map	1984	$self->default_region (cf::region::find_by_path $self->{path})
1189	}	1985	unless $self->default_region;
1190		1986
		1987	1
		1988	}
		1989
1191	sub find_map;	1990	sub find;
1192	sub find_map {	1991	sub find {
1193	my ($path, $origin) = @_;	1992	my ($path, $origin) = @_;
1194		1993
1195	#warn "find_map<$path,$origin>\n";#d#
1196
1197	$path = new cf::path $path, $origin && $origin->path;	1994	$path = normalise $path, $origin && $origin->path;
1198	my $key = $path->as_string;
1199		1995
		1996	cf::lock_wait "map_data:$path";#d#remove
1200	cf::lock_wait "map_find:$key";	1997	cf::lock_wait "map_find:$path";
1201		1998
1202	$cf::MAP{$key} || do {	1999	$cf::MAP{$path} || do {
1203	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
1204		2002
1205	# do it the slow way	2003	my $map = new_from_path cf::map $path
1206	my $map = try_load_header $path->save_path;
1207
1208	if ($map) {
1209	# safety
1210	$map->{instantiate_time} = $cf::RUNTIME
1211	if $map->{instantiate_time} > $cf::RUNTIME;
1212	} else {
1213	if (my $rmp = $path->random_map_params) {
1214	$map = generate_random_map $key, $rmp;
1215	} else {
1216	$map = try_load_header $path->load_path;
1217	}
1218
1219	$map or return;	2004	or return;
1220		2005
1221	$map->{load_original} = 1;
1222	$map->{instantiate_time} = $cf::RUNTIME;
1223	$map->instantiate;
1224
1225	# per-player maps become, after loading, normal maps
1226	$map->per_player (0) if $path->{user_rel};
1227	}
1228
1229	$map->path ($key);
1230	$map->{path} = $path;
1231	$map->{last_save} = $cf::RUNTIME;	2006	$map->{last_save} = $cf::RUNTIME;
1232	$map->last_access ($cf::RUNTIME);
1233		2007
1234	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;
1235	$map->reset;	2016	$map->reset;
1236	undef $guard;	2017	return find $path;
1237	$map = find_map $path
1238	or return;
1239	}	2018	}
1240		2019
1241	$cf::MAP{$key} = $map	2020	$cf::MAP{$path} = $map
1242	}	2021	}
1243	}	2022	}
		2023
		2024	sub pre_load { }
		2025	sub post_load { }
1244		2026
1245	sub load {	2027	sub load {
1246	my ($self) = @_;	2028	my ($self) = @_;
1247		2029
		2030	local $self->{deny_reset} = 1; # loading can take a long time
		2031
1248	my $path = $self->{path};	2032	my $path = $self->{path};
		2033
		2034	{
1249	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	2035	my $guard = cf::lock_acquire "map_data:$path";
1250		2036
		2037	return unless $self->valid;
1251	return if $self->in_memory != cf::MAP_SWAPPED;	2038	return unless $self->in_memory == cf::MAP_SWAPPED;
1252		2039
1253	$self->in_memory (cf::MAP_LOADING);	2040	$self->in_memory (cf::MAP_LOADING);
1254		2041
1255	$self->alloc;	2042	$self->alloc;
1256	$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)
1257	or return;	2050	or return;
1258		2051
1259	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2052	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1260	if delete $self->{load_original};	2053	if delete $self->{load_original};
1261		2054
1262	if (my $uniq = $path->uniq_path) {	2055	if (my $uniq = $self->uniq_path) {
1263	utf8::encode $uniq;	2056	utf8::encode $uniq;
1264	if (aio_open $uniq, O_RDONLY, 0) {	2057	unless (aio_stat $uniq) {
		2058	if (my $f = new_from_file cf::object::thawer $uniq) {
1265	$self->clear_unique_items;	2059	$self->clear_unique_items;
1266	$self->load_objects ($uniq, 0);	2060	$self->_load_objects ($f);
		2061	$f->resolve_delayed_derefs;
		2062	}
1267	}	2063	}
1268	}	2064	}
1269		2065
		2066	$f->resolve_delayed_derefs;
		2067
		2068	cf::cede_to_tick;
1270	# now do the right thing for maps	2069	# now do the right thing for maps
1271	$self->link_multipart_objects;	2070	$self->link_multipart_objects;
1272
1273	if ($self->{path}->is_style_map) {
1274	$self->{deny_save} = 1;
1275	$self->{deny_reset} = 1;
1276	} else {
1277	$self->fix_auto_apply;
1278	$self->decay_objects;
1279	$self->update_buttons;
1280	$self->set_darkness_map;
1281	$self->difficulty ($self->estimate_difficulty)	2071	$self->difficulty ($self->estimate_difficulty)
1282	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;
1283	$self->activate;	2082	$self->activate;
1284	}	2083	}
1285		2084
		2085	$self->{last_save} = $cf::RUNTIME;
		2086	$self->last_access ($cf::RUNTIME);
		2087
1286	$self->in_memory (cf::MAP_IN_MEMORY);	2088	$self->in_memory (cf::MAP_IN_MEMORY);
1287	}	2089	}
1288		2090
1289	sub load_map_sync {	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	}
		2130	}
		2131
		2132	sub find_sync {
1290	my ($path, $origin) = @_;	2133	my ($path, $origin) = @_;
1291		2134
1292	#warn "load_map_sync<$path, $origin>\n";#d#	2135	cf::sync_job { find $path, $origin }
		2136	}
1293		2137
1294	cf::sync_job {	2138	sub do_load_sync {
1295	my $map = cf::map::find_map $path, $origin	2139	my ($map) = @_;
1296	or return;	2140
1297	$map->load;	2141	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1298	$map	2142	if $Coro::current == $Coro::main;
		2143
		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;
1299	}	2174	};
		2175	$MAP_PREFETCHER->prio (6);
		2176
		2177	()
1300	}	2178	}
1301		2179
1302	sub save {	2180	sub save {
1303	my ($self) = @_;	2181	my ($self) = @_;
1304		2182
		2183	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2184
1305	$self->{last_save} = $cf::RUNTIME;	2185	$self->{last_save} = $cf::RUNTIME;
1306		2186
1307	return unless $self->dirty;	2187	return unless $self->dirty;
1308		2188
1309	my $save = $self->{path}->save_path; utf8::encode $save;	2189	my $save = $self->save_path; utf8::encode $save;
1310	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2190	my $uniq = $self->uniq_path; utf8::encode $uniq;
1311		2191
1312	$self->{load_path} = $save;	2192	$self->{load_path} = $save;
1313		2193
1314	return if $self->{deny_save};	2194	return if $self->{deny_save};
1315		2195
		2196	local $self->{last_access} = $self->last_access;#d#
		2197
		2198	cf::async {
		2199	$Coro::current->{desc} = "map player save";
		2200	$_->contr->save for $self->players;
		2201	};
		2202
1316	if ($uniq) {	2203	if ($uniq) {
1317	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2204	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318	$self->save_objects ($uniq, cf::IO_UNIQUES);	2205	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1319	} else {	2206	} else {
1320	$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);
1321	}	2208	}
1322	}	2209	}
1323		2210
1324	sub swap_out {	2211	sub swap_out {
1325	my ($self) = @_;	2212	my ($self) = @_;
1326		2213
1327	# save first because save cedes	2214	# save first because save cedes
1328	$self->save;	2215	$self->save;
		2216
		2217	my $lock = cf::lock_acquire "map_data:$self->{path}";
1329		2218
1330	return if $self->players;	2219	return if $self->players;
1331	return if $self->in_memory != cf::MAP_IN_MEMORY;	2220	return if $self->in_memory != cf::MAP_IN_MEMORY;
1332	return if $self->{deny_save};	2221	return if $self->{deny_save};
1333		2222
		2223	$self->in_memory (cf::MAP_SWAPPED);
		2224
		2225	$self->deactivate;
		2226	$_->clear_links_to ($self) for values %cf::MAP;
1334	$self->clear;	2227	$self->clear;
1335	$self->in_memory (cf::MAP_SWAPPED);
1336	}	2228	}
1337		2229
1338	sub reset_at {	2230	sub reset_at {
1339	my ($self) = @_;	2231	my ($self) = @_;
1340		2232
1341	# TODO: safety, remove and allow resettable per-player maps	2233	# TODO: safety, remove and allow resettable per-player maps
1342	return 1e99 if $self->{path}{user_rel};
1343	return 1e99 if $self->{deny_reset};	2234	return 1e99 if $self->{deny_reset};
1344		2235
1345	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2236	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1346	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;
1347		2238
…		…
1352	my ($self) = @_;	2243	my ($self) = @_;
1353		2244
1354	$self->reset_at <= $cf::RUNTIME	2245	$self->reset_at <= $cf::RUNTIME
1355	}	2246	}
1356		2247
1357	sub unlink_save {
1358	my ($self) = @_;
1359
1360	utf8::encode (my $save = $self->{path}->save_path);
1361	aioreq_pri 3; IO::AIO::aio_unlink $save;
1362	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1363	}
1364
1365	sub rename {
1366	my ($self, $new_path) = @_;
1367
1368	$self->unlink_save;
1369
1370	delete $cf::MAP{$self->path};
1371	$self->{path} = new cf::path $new_path;
1372	$self->path ($self->{path}->as_string);
1373	$cf::MAP{$self->path} = $self;
1374
1375	$self->save;
1376	}
1377
1378	sub reset {	2248	sub reset {
1379	my ($self) = @_;	2249	my ($self) = @_;
1380		2250
		2251	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2252
1381	return if $self->players;	2253	return if $self->players;
1382	return if $self->{path}{user_rel};#d#
1383		2254
1384	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	}
1385		2266
1386	delete $cf::MAP{$self->path};	2267	delete $cf::MAP{$self->path};
1387		2268
		2269	$self->deactivate;
1388	$_->clear_links_to ($self) for values %cf::MAP;	2270	$_->clear_links_to ($self) for values %cf::MAP;
		2271	$self->clear;
1389		2272
1390	$self->unlink_save;	2273	$self->unlink_save;
1391	$self->destroy;	2274	$self->destroy;
1392	}	2275	}
1393		2276
1394	my $nuke_counter = "aaaa";	2277	my $nuke_counter = "aaaa";
1395		2278
1396	sub nuke {	2279	sub nuke {
1397	my ($self) = @_;	2280	my ($self) = @_;
1398		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};
1399	$self->{deny_save} = 1;	2291	$self->{deny_save} = 1;
1400	$self->reset_timeout (1);	2292	$self->reset_timeout (1);
1401	$self->rename ("{nuke}/" . ($nuke_counter++));	2293	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2294
		2295	$cf::MAP{$self->path} = $self;
		2296	}
		2297
1402	$self->reset; # polite request, might not happen	2298	$self->reset; # polite request, might not happen
1403	}	2299	}
1404		2300
1405	sub customise_for {	2301	=item $maps = cf::map::tmp_maps
1406	my ($map, $ob) = @_;
1407		2302
1408	if ($map->per_player) {	2303	Returns an arrayref with all map paths of currently instantiated and saved
1409	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	2304	maps. May block.
		2305
		2306	=cut
		2307
		2308	sub tmp_maps() {
1410	}	2309	[
1411		2310	map {
1412	$map	2311	utf8::decode $_;
		2312	/\.map$/
		2313	? normalise $_
		2314	: ()
		2315	} @{ aio_readdir $TMPDIR or [] }
		2316	]
1413	}	2317	}
1414		2318
1415	sub emergency_save {	2319	=item $maps = cf::map::random_maps
1416	local $cf::FREEZE = 1;
1417		2320
1418	warn "enter emergency map save\n";	2321	Returns an arrayref with all map paths of currently instantiated and saved
		2322	random maps. May block.
1419		2323
1420	cf::sync_job {	2324	=cut
1421	warn "begin emergency map save\n";
1422	$_->save for values %cf::MAP;
1423	};
1424		2325
1425	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	]
1426	}	2353	}
1427		2354
1428	package cf;	2355	package cf;
1429		2356
1430	=back	2357	=back
1431		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
1432		2413
1433	=head3 cf::object::player	2414	=head3 cf::object::player
1434		2415
1435	=over 4	2416	=over 4
1436		2417
…		…
1450		2431
1451	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2432	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1452		2433
1453	if ($self->{record_replies}) {	2434	if ($self->{record_replies}) {
1454	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2435	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2436
1455	} 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 {
1456	$msg = $npc->name . " says: $msg" if $npc;	2445	$msg = $npc->name . " says: $msg" if $npc;
1457	$self->message ($msg, $flags);	2446	$self->message ($msg, $flags);
		2447	}
1458	}	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 (@_);
1459	}	2459	}
1460		2460
1461	=item $player_object->may ("access")	2461	=item $player_object->may ("access")
1462		2462
1463	Returns wether the given player is authorized to access resource "access"	2463	Returns wether the given player is authorized to access resource "access"
…		…
1476		2476
1477	=item $player_object->enter_link	2477	=item $player_object->enter_link
1478		2478
1479	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}>).
1480		2480
1481	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
1482	I<MUST> call C<leave_link> as soon as possible, though.	2482	I<MUST> call C<leave_link> as soon as possible, though.
1483		2483
		2484	Will never block.
		2485
1484	=item $player_object->leave_link ($map, $x, $y)	2486	=item $player_object->leave_link ($map, $x, $y)
1485		2487
1486	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
1487	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
1488	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
1489	to the emergency map position.	2491	fails, to the emergency map position.
1490		2492
1491	Might block.	2493	Might block.
1492		2494
1493	=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	}
1494		2506
1495	sub cf::object::player::enter_link {	2507	sub cf::object::player::enter_link {
1496	my ($self) = @_;	2508	my ($self) = @_;
1497		2509
1498	$self->deactivate_recursive;	2510	$self->deactivate_recursive;
1499		2511
1500	return if $self->map == $LINK_MAP;	2512	return if UNIVERSAL::isa $self->map, "ext::map_link";
1501		2513
1502	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2514	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1503	if $self->map;	2515	if $self->map && $self->map->{path} ne "{link}";
1504		2516
1505	$self->enter_map ($LINK_MAP, 20, 20);	2517	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1506	}	2518	}
1507		2519
1508	sub cf::object::player::leave_link {	2520	sub cf::object::player::leave_link {
1509	my ($self, $map, $x, $y) = @_;	2521	my ($self, $map, $x, $y) = @_;
		2522
		2523	return unless $self->contr->active;
1510		2524
1511	my $link_pos = delete $self->{_link_pos};	2525	my $link_pos = delete $self->{_link_pos};
1512		2526
1513	unless ($map) {	2527	unless ($map) {
1514	# restore original map position	2528	# restore original map position
1515	($map, $x, $y) = @{ $link_pos || [] };	2529	($map, $x, $y) = @{ $link_pos || [] };
1516	$map = cf::map::find_map $map;	2530	$map = cf::map::find $map;
1517		2531
1518	unless ($map) {	2532	unless ($map) {
1519	($map, $x, $y) = @$EMERGENCY_POSITION;	2533	($map, $x, $y) = @$EMERGENCY_POSITION;
1520	$map = cf::map::find_map $map	2534	$map = cf::map::find $map
1521	or die "FATAL: cannot load emergency map\n";	2535	or die "FATAL: cannot load emergency map\n";
1522	}	2536	}
1523	}	2537	}
1524		2538
1525	($x, $y) = (-1, -1)	2539	($x, $y) = (-1, -1)
…		…
1528	# use -1 or undef as default coordinates, not 0, 0	2542	# use -1 or undef as default coordinates, not 0, 0
1529	($x, $y) = ($map->enter_x, $map->enter_y)	2543	($x, $y) = ($map->enter_x, $map->enter_y)
1530	if $x <=0 && $y <= 0;	2544	if $x <=0 && $y <= 0;
1531		2545
1532	$map->load;	2546	$map->load;
		2547	$map->load_neighbours;
1533		2548
		2549	return unless $self->contr->active;
1534	$self->activate_recursive;	2550	$self->activate_recursive;
		2551
		2552	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1535	$self->enter_map ($map, $x, $y);	2553	$self->enter_map ($map, $x, $y);
1536	}	2554	}
1537		2555
1538	cf::player->attach (	2556	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1539	on_logout => sub {
1540	my ($pl) = @_;
1541		2557
1542	# abort map switching before logout	2558	Moves the player to the given map-path and coordinates by first freezing
1543	if ($pl->ob->{_link_pos}) {	2559	her, loading and preparing them map, calling the provided $check callback
1544	cf::sync_job {	2560	that has to return the map if sucecssful, and then unfreezes the player on
1545	$pl->ob->leave_link	2561	the new (success) or old (failed) map position. In either case, $done will
1546	};	2562	be called at the end of this process.
1547	}
1548	},
1549	on_login => sub {
1550	my ($pl) = @_;
1551		2563
1552	# try to abort aborted map switching on player login :)
1553	# should happen only on crashes
1554	if ($pl->ob->{_link_pos}) {
1555	$pl->ob->enter_link;
1556	cf::async {
1557	# we need this sleep as the login has a concurrent enter_exit running
1558	# and this sleep increases chances of the player not ending up in scorn
1559	Coro::Timer::sleep 1;
1560	$pl->ob->leave_link;
1561	};
1562	}
1563	},
1564	);
1565
1566	=item $player_object->goto_map ($path, $x, $y)
1567
1568	=cut	2564	=cut
1569		2565
		2566	our $GOTOGEN;
		2567
1570	sub cf::object::player::goto_map {	2568	sub cf::object::player::goto {
1571	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;
1572		2573
1573	$self->enter_link;	2574	$self->enter_link;
1574		2575
1575	(cf::async {	2576	(async {
1576	$path = new cf::path $path;	2577	$Coro::current->{desc} = "player::goto $path $x $y";
1577		2578
1578	my $map = cf::map::find_map $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) {
1579	$map = $map->customise_for ($self) if $map;	2602	$map = $map->customise_for ($self);
1580		2603	$map = $check->($map) if $check && $map;
1581	# warn "entering ", $map->path, " at ($x, $y)\n"	2604	} else {
1582	# if $map;
1583
1584	$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	}
1585		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};
1586	$self->leave_link ($map, $x, $y);	2618	$self->leave_link ($map, $x, $y);
		2619	}
		2620
		2621	$done->() if $done;
1587	})->prio (1);	2622	})->prio (1);
1588	}	2623	}
1589		2624
1590	=item $player_object->enter_exit ($exit_object)	2625	=item $player_object->enter_exit ($exit_object)
1591		2626
…		…
1593		2628
1594	sub parse_random_map_params {	2629	sub parse_random_map_params {
1595	my ($spec) = @_;	2630	my ($spec) = @_;
1596		2631
1597	my $rmp = { # defaults	2632	my $rmp = { # defaults
1598	xsize => 10,	2633	xsize => (cf::rndm 15, 40),
1599	ysize => 10,	2634	ysize => (cf::rndm 15, 40),
		2635	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2636	#layout => string,
1600	};	2637	};
1601		2638
1602	for (split /\n/, $spec) {	2639	for (split /\n/, $spec) {
1603	my ($k, $v) = split /\s+/, $_, 2;	2640	my ($k, $v) = split /\s+/, $_, 2;
1604		2641
…		…
1608	$rmp	2645	$rmp
1609	}	2646	}
1610		2647
1611	sub prepare_random_map {	2648	sub prepare_random_map {
1612	my ($exit) = @_;	2649	my ($exit) = @_;
		2650
		2651	my $guard = cf::lock_acquire "exit_prepare:$exit";
1613		2652
1614	# all this does is basically replace the /! path by	2653	# all this does is basically replace the /! path by
1615	# a new random map path (?random/...) with a seed	2654	# a new random map path (?random/...) with a seed
1616	# that depends on the exit object	2655	# that depends on the exit object
1617		2656
1618	my $rmp = parse_random_map_params $exit->msg;	2657	my $rmp = parse_random_map_params $exit->msg;
1619		2658
1620	if ($exit->map) {	2659	if ($exit->map) {
1621	$rmp->{region} = $exit->map->region_name;	2660	$rmp->{region} = $exit->region->name;
1622	$rmp->{origin_map} = $exit->map->path;	2661	$rmp->{origin_map} = $exit->map->path;
1623	$rmp->{origin_x} = $exit->x;	2662	$rmp->{origin_x} = $exit->x;
1624	$rmp->{origin_y} = $exit->y;	2663	$rmp->{origin_y} = $exit->y;
1625	}	2664	}
1626		2665
1627	$rmp->{random_seed} ||= $exit->random_seed;	2666	$rmp->{random_seed} ||= $exit->random_seed;
1628		2667
1629	my $data = cf::to_json $rmp;	2668	my $data = cf::encode_json $rmp;
1630	my $md5 = Digest::MD5::md5_hex $data;	2669	my $md5 = Digest::MD5::md5_hex $data;
		2670	my $meta = "$RANDOMDIR/$md5.meta";
1631		2671
1632	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) {
1633	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;
1634		2676
1635	$exit->slaying ("?random/$md5");	2677	$exit->slaying ("?random/$md5");
1636	$exit->msg (undef);	2678	$exit->msg (undef);
1637	}	2679	}
1638	}	2680	}
…		…
1640	sub cf::object::player::enter_exit {	2682	sub cf::object::player::enter_exit {
1641	my ($self, $exit) = @_;	2683	my ($self, $exit) = @_;
1642		2684
1643	return unless $self->type == cf::PLAYER;	2685	return unless $self->type == cf::PLAYER;
1644		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
1645	$self->enter_link;	2698	$self->enter_link;
1646		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
1647	(cf::async {	2704	(async {
		2705	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2706
		2707	$self->deactivate_recursive; # just to be sure
1648	unless (eval {	2708	unless (eval {
1649	prepare_random_map $exit	2709	$self->goto ($slaying, $hp, $sp);
1650	if $exit->slaying eq "/!";
1651
1652	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1653	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1654		2710
1655	1;	2711	1;
1656	}) {	2712	}) {
1657	$self->message ("Something went wrong deep within the crossfire server. "	2713	$self->message ("Something went wrong deep within the crossfire server. "
1658	. "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. "
1659	. "Please report this to the dungeon master",	2715	. "Please report this to the dungeon master!",
1660	cf::NDI_UNIQUE | cf::NDI_RED);	2716	cf::NDI_UNIQUE | cf::NDI_RED);
1661		2717
1662	warn "ERROR in enter_exit: $@";	2718	warn "ERROR in enter_exit: $@";
1663	$self->leave_link;	2719	$self->leave_link;
1664	}	2720	}
1665	})->prio (1);	2721	})->prio (1);
…		…
1678		2734
1679	sub cf::client::send_drawinfo {	2735	sub cf::client::send_drawinfo {
1680	my ($self, $text, $flags) = @_;	2736	my ($self, $text, $flags) = @_;
1681		2737
1682	utf8::encode $text;	2738	utf8::encode $text;
1683	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2739	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1684	}	2740	}
1685		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	}
1686		2900
1687	=item $success = $client->query ($flags, "text", \&cb)	2901	=item $success = $client->query ($flags, "text", \&cb)
1688		2902
1689	Queues a query to the client, calling the given callback with	2903	Queues a query to the client, calling the given callback with
1690	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>,
1691	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>.
1692		2906
1693	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
1694	reliable at some point in the future.	2908	become reliable at some point in the future.
1695		2909
1696	=cut	2910	=cut
1697		2911
1698	sub cf::client::query {	2912	sub cf::client::query {
1699	my ($self, $flags, $text, $cb) = @_;	2913	my ($self, $flags, $text, $cb) = @_;
…		…
1707	utf8::encode $text;	2921	utf8::encode $text;
1708	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2922	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1709		2923
1710	$self->send_packet ($self->{query_queue}[0][0])	2924	$self->send_packet ($self->{query_queue}[0][0])
1711	if @{ $self->{query_queue} } == 1;	2925	if @{ $self->{query_queue} } == 1;
		2926
		2927	1
1712	}	2928	}
1713		2929
1714	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	},
1715	on_reply => sub {	2936	on_reply => sub {
1716	my ($ns, $msg) = @_;	2937	my ($ns, $msg) = @_;
1717		2938
1718	# this weird shuffling is so that direct followup queries	2939	# this weird shuffling is so that direct followup queries
1719	# get handled first	2940	# get handled first
1720	my $queue = delete $ns->{query_queue}	2941	my $queue = delete $ns->{query_queue}
1721	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
1722		2943
1723	(shift @$queue)->[1]->($msg);	2944	(shift @$queue)->[1]->($msg);
		2945	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1724		2946
1725	push @{ $ns->{query_queue} }, @$queue;	2947	push @{ $ns->{query_queue} }, @$queue;
1726		2948
1727	if (@{ $ns->{query_queue} } == @$queue) {	2949	if (@{ $ns->{query_queue} } == @$queue) {
1728	if (@$queue) {	2950	if (@$queue) {
…		…
1730	} else {	2952	} else {
1731	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2953	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1732	}	2954	}
1733	}	2955	}
1734	},	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	},
1735	);	2983	);
1736		2984
1737	=item $client->coro (\&cb)	2985	=item $client->async (\&cb)
1738		2986
1739	Create a new coroutine, running the specified callback. The coroutine will	2987	Create a new coroutine, running the specified callback. The coroutine will
1740	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,
1741	or loss of connection).	2989	or loss of connection).
1742		2990
1743	=cut	2991	=cut
1744		2992
1745	sub cf::client::coro {	2993	sub cf::client::async {
1746	my ($self, $cb) = @_;	2994	my ($self, $cb) = @_;
1747		2995
1748	my $coro = &cf::async ($cb);	2996	my $coro = &Coro::async ($cb);
1749		2997
1750	$coro->on_destroy (sub {	2998	$coro->on_destroy (sub {
1751	delete $self->{_coro}{$coro+0};	2999	delete $self->{_coro}{$coro+0};
1752	});	3000	});
1753		3001
…		…
1780	our $safe = new Safe "safe";	3028	our $safe = new Safe "safe";
1781	our $safe_hole = new Safe::Hole;	3029	our $safe_hole = new Safe::Hole;
1782		3030
1783	$SIG{FPE} = 'IGNORE';	3031	$SIG{FPE} = 'IGNORE';
1784		3032
1785	$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	));
1786		3038
1787	# here we export the classes and methods available to script code	3039	# here we export the classes and methods available to script code
1788		3040
1789	=pod	3041	=pod
1790		3042
1791	The following fucntions and emthods are available within a safe environment:	3043	The following functions and methods are available within a safe environment:
1792		3044
1793	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
1794	cf::object::player player	3049	cf::object::player
1795	cf::player peaceful	3050	player
1796	cf::map trigger	3051
		3052	cf::player
		3053	peaceful
		3054
		3055	cf::map
		3056	trigger
1797		3057
1798	=cut	3058	=cut
1799		3059
1800	for (	3060	for (
1801	["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)],
1802	["cf::object::player" => qw(player)],	3064	["cf::object::player" => qw(player)],
1803	["cf::player" => qw(peaceful)],	3065	["cf::player" => qw(peaceful)],
1804	["cf::map" => qw(trigger)],	3066	["cf::map" => qw(trigger)],
1805	) {	3067	) {
1806	no strict 'refs';	3068	no strict 'refs';
…		…
1877	=back	3139	=back
1878		3140
1879	=cut	3141	=cut
1880		3142
1881	#############################################################################	3143	#############################################################################
		3144	# the server's init and main functions
1882		3145
1883	=head2 EXTENSION DATABASE SUPPORT	3146	sub load_facedata($) {
		3147	my ($path) = @_;
1884		3148
1885	Crossfire maintains a very simple database for extension use. It can	3149	# HACK to clear player env face cache, we need some signal framework
1886	currently store anything that can be serialised using Storable, which	3150	# for this (global event?)
1887	excludes objects.	3151	%ext::player_env::MUSIC_FACE_CACHE = ();
1888		3152
1889	The parameter C<$family> should best start with the name of the extension	3153	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1890	using it, it should be unique.
1891		3154
1892	=over 4	3155	warn "loading facedata from $path\n";
1893		3156
1894	=item $hashref = cf::db_get $family	3157	my $facedata;
		3158	0 < aio_load $path, $facedata
		3159	or die "$path: $!";
1895		3160
1896	Return a hashref for use by the extension C<$family>, which can be	3161	$facedata = Coro::Storable::thaw $facedata;
1897	modified. After modifications, you have to call C<cf::db_dirty> or
1898	C<cf::db_sync>.
1899		3162
1900	=item $value = cf::db_get $family => $key	3163	$facedata->{version} == 2
		3164	or cf::cleanup "$path: version mismatch, cannot proceed.";
1901		3165
1902	Returns a single value from the database	3166	# patch in the exptable
1903		3167	$facedata->{resource}{"res/exp_table"} = {
1904	=item cf::db_put $family => $hashref	3168	type => FT_RSRC,
1905		3169	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1906	Stores the given family hashref into the database. Updates are delayed, if
1907	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1908
1909	=item cf::db_put $family => $key => $value
1910
1911	Stores the given C<$value> in the family hash. Updates are delayed, if you
1912	want the data to be synced to disk immediately, use C<cf::db_sync>.
1913
1914	=item cf::db_dirty
1915
1916	Marks the database as dirty, to be updated at a later time.
1917
1918	=item cf::db_sync
1919
1920	Immediately write the database to disk I<if it is dirty>.
1921
1922	=cut
1923
1924	our $DB;
1925
1926	{
1927	my $path = cf::localdir . "/database.pst";
1928
1929	sub db_load() {
1930	$DB = stat $path ? Storable::retrieve $path : { };
1931	}
1932
1933	my $pid;
1934
1935	sub db_save() {
1936	waitpid $pid, 0 if $pid;
1937	if (0 == ($pid = fork)) {
1938	$DB->{_meta}{version} = 1;
1939	Storable::nstore $DB, "$path~";
1940	rename "$path~", $path;
1941	cf::_exit 0 if defined $pid;
1942	}
1943	}
1944
1945	my $dirty;
1946
1947	sub db_sync() {
1948	db_save if $dirty;
1949	undef $dirty;
1950	}
1951
1952	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1953	db_sync;
1954	});	3170	};
		3171	cf::cede_to_tick;
1955		3172
1956	sub db_dirty() {
1957	$dirty = 1;
1958	$idle->start;
1959	}	3173	{
		3174	my $faces = $facedata->{faceinfo};
1960		3175
1961	sub db_get($;$) {	3176	while (my ($face, $info) = each %$faces) {
1962	@_ >= 2	3177	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1963	? $DB->{$_[0]}{$_[1]}
1964	: ($DB->{$_[0]} ||= { })
1965	}
1966		3178
1967	sub db_put($$;$) {	3179	cf::face::set_visibility $idx, $info->{visibility};
1968	if (@_ >= 3) {	3180	cf::face::set_magicmap $idx, $info->{magicmap};
1969	$DB->{$_[0]}{$_[1]} = $_[2];	3181	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1970	} else {	3182	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1971	$DB->{$_[0]} = $_[1];
1972	}
1973	db_dirty;
1974	}
1975		3183
1976	cf::global->attach (	3184	cf::cede_to_tick;
1977	prio => 10000,
1978	on_cleanup => sub {
1979	db_sync;
1980	},	3185	}
1981	);
1982	}
1983		3186
1984	#############################################################################	3187	while (my ($face, $info) = each %$faces) {
1985	# the server's main()	3188	next unless $info->{smooth};
1986		3189
1987	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 {
1988	open my $fh, "<:utf8", cf::confdir . "/config"	3332	open my $fh, "<:utf8", "$CONFDIR/config"
1989	or return;	3333	or return;
1990		3334
1991	local $/;	3335	local $/;
1992	*CFG = YAML::Syck::Load <$fh>;	3336	*CFG = YAML::Load <$fh>;
		3337
		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};
		3342
		3343	if (exists $CFG{mlockall}) {
		3344	eval {
		3345	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3346	and die "WARNING: m(un)lockall failed: $!\n";
		3347	};
		3348	warn $@ if $@;
		3349	}
1993	}	3350	}
1994		3351
1995	sub main {	3352	sub main {
1996	# we must not ever block the main coroutine	3353	# we must not ever block the main coroutine
1997	local $Coro::idle = sub {	3354	local $Coro::idle = sub {
1998	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#
1999	(Coro::unblock_sub {	3356	(async {
2000	Event::one_event;	3357	$Coro::current->{desc} = "IDLE BUG HANDLER";
2001	})->();	3358	EV::loop EV::LOOP_ONESHOT;
		3359	})->prio (Coro::PRIO_MAX);
2002	};	3360	};
2003		3361
2004	cfg_load;	3362	reload_config;
2005	db_load;	3363	db_init;
2006	load_extensions;	3364	load_extensions;
		3365
		3366	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3367	evthread_start IO::AIO::poll_fileno;
2007	Event::loop;	3368	EV::loop;
2008	}	3369	}
2009		3370
2010	#############################################################################	3371	#############################################################################
2011	# initialisation	3372	# initialisation and cleanup
2012		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
2013	sub reload() {	3463	sub do_reload_perl() {
2014	# can/must only be called in main	3464	# can/must only be called in main
2015	if ($Coro::current != $Coro::main) {	3465	if ($Coro::current != $Coro::main) {
2016	warn "can only reload from main coroutine\n";	3466	warn "can only reload from main coroutine";
2017	return;	3467	return;
2018	}	3468	}
2019		3469
2020	warn "reloading...";	3470	warn "reloading...";
2021		3471
2022	local $FREEZE = 1;	3472	warn "entering sync_job";
		3473
		3474	cf::sync_job {
		3475	cf::write_runtime; # external watchdog should not bark
2023	cf::emergency_save;	3476	cf::emergency_save;
		3477	cf::write_runtime; # external watchdog should not bark
2024		3478
2025	eval {	3479	warn "syncing database to disk";
		3480	BDB::db_env_txn_checkpoint $DB_ENV;
		3481
2026	# 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
2027		3483
2028	# cancel all watchers	3484	warn "flushing outstanding aio requests";
2029	for (Event::all_watchers) {	3485	for (;;) {
2030	$_->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...";
2031	}	3491	}
2032		3492
		3493	++$RELOAD;
		3494
2033	# cancel all extension coros	3495	warn "cancelling all extension coros";
2034	$_->cancel for values %EXT_CORO;	3496	$_->cancel for values %EXT_CORO;
2035	%EXT_CORO = ();	3497	%EXT_CORO = ();
2036		3498
2037	# unload all extensions	3499	warn "removing commands";
2038	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) {
2039	warn "unloading <$_>";	3508	warn "... unloading $pkg";
2040	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: $@";
2041	}	3515	}
2042		3516
		3517	warn "... nuking $pkg";
		3518	Symbol::delete_package $pkg;
		3519	}
		3520
2043	# unload all modules loaded from $LIBDIR	3521	warn "unloading all perl modules loaded from $LIBDIR";
2044	while (my ($k, $v) = each %INC) {	3522	while (my ($k, $v) = each %INC) {
2045	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3523	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2046		3524
2047	warn "removing <$k>";	3525	warn "... unloading $k";
2048	delete $INC{$k};	3526	delete $INC{$k};
2049		3527
2050	$k =~ s/\.pm$//;	3528	$k =~ s/\.pm$//;
2051	$k =~ s/\//::/g;	3529	$k =~ s/\//::/g;
2052		3530
…		…
2055	}	3533	}
2056		3534
2057	Symbol::delete_package $k;	3535	Symbol::delete_package $k;
2058	}	3536	}
2059		3537
2060	# sync database to disk
2061	cf::db_sync;
2062	IO::AIO::flush;
2063
2064	# get rid of safe::, as good as possible	3538	warn "getting rid of safe::, as good as possible";
2065	Symbol::delete_package "safe::$_"	3539	Symbol::delete_package "safe::$_"
2066	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);
2067		3541
2068	# remove register_script_function callbacks
2069	# TODO
2070
2071	# unload cf.pm "a bit"	3542	warn "unloading cf.pm \"a bit\"";
2072	delete $INC{"cf.pm"};	3543	delete $INC{"cf.pm"};
		3544	delete $INC{"cf/pod.pm"};
2073		3545
2074	# don't, removes xs symbols, too,	3546	# don't, removes xs symbols, too,
2075	# and global variables created in xs	3547	# and global variables created in xs
2076	#Symbol::delete_package __PACKAGE__;	3548	#Symbol::delete_package __PACKAGE__;
2077		3549
2078	# reload cf.pm	3550	warn "unload completed, starting to reload now";
		3551
2079	warn "reloading cf.pm";	3552	warn "reloading cf.pm";
2080	require cf;	3553	require cf;
2081	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3554	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2082		3555
2083	# load config and database again	3556	warn "loading config and database again";
2084	cf::cfg_load;	3557	cf::reload_config;
2085	cf::db_load;
2086		3558
2087	# load extensions
2088	warn "load extensions";	3559	warn "loading extensions";
2089	cf::load_extensions;	3560	cf::load_extensions;
2090		3561
2091	# reattach attachments to objects	3562	warn "reattaching attachments to objects/players";
2092	warn "reattach";	3563	_global_reattach; # objects, sockets
2093	_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.";
2094	};	3575	};
2095		3576
2096	if ($@) {	3577	warn "reloaded";
2097	warn $@;
2098	warn "error while reloading, exiting.";
2099	exit 1;
2100	}
2101
2102	warn "reloaded successfully";
2103	};	3578	};
2104		3579
2105	#############################################################################	3580	our $RELOAD_WATCHER; # used only during reload
2106		3581
2107	unless ($LINK_MAP) {	3582	sub reload_perl() {
2108	$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.
2109		3585
2110	$LINK_MAP->width (41);	3586	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
2111	$LINK_MAP->height (41);	3587	do_reload_perl;
2112	$LINK_MAP->alloc;	3588	undef $RELOAD_WATCHER;
2113	$LINK_MAP->path ("{link}");	3589	};
2114	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2115	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2116
2117	# dirty hack because... archetypes are not yet loaded
2118	Event->timer (
2119	after => 2,
2120	cb => sub {
2121	$_[0]->w->cancel;
2122
2123	# provide some exits "home"
2124	my $exit = cf::object::new "exit";
2125
2126	$exit->slaying ($EMERGENCY_POSITION->[0]);
2127	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2128	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2129
2130	$LINK_MAP->insert ($exit->clone, 19, 19);
2131	$LINK_MAP->insert ($exit->clone, 19, 20);
2132	$LINK_MAP->insert ($exit->clone, 19, 21);
2133	$LINK_MAP->insert ($exit->clone, 20, 19);
2134	$LINK_MAP->insert ($exit->clone, 20, 21);
2135	$LINK_MAP->insert ($exit->clone, 21, 19);
2136	$LINK_MAP->insert ($exit->clone, 21, 20);
2137	$LINK_MAP->insert ($exit->clone, 21, 21);
2138
2139	$exit->destroy;
2140	});
2141
2142	$LINK_MAP->{deny_save} = 1;
2143	$LINK_MAP->{deny_reset} = 1;
2144
2145	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2146	}	3590	}
2147
2148	register "<global>", __PACKAGE__;
2149		3591
2150	register_command "reload" => sub {	3592	register_command "reload" => sub {
2151	my ($who, $arg) = @_;	3593	my ($who, $arg) = @_;
2152		3594
2153	if ($who->flag (FLAG_WIZ)) {	3595	if ($who->flag (FLAG_WIZ)) {
2154	$who->message ("start of reload.");
2155	reload;
2156	$who->message ("end of reload.");	3596	$who->message ("reloading server.");
		3597	async {
		3598	$Coro::current->{desc} = "perl_reload";
		3599	reload_perl;
		3600	};
2157	}	3601	}
2158	};	3602	};
2159		3603
2160	unshift @INC, $LIBDIR;	3604	unshift @INC, $LIBDIR;
2161		3605
2162	$TICK_WATCHER = Event->timer (	3606	my $bug_warning = 0;
2163	reentrant => 0,	3607
2164	prio => 0,	3608	our @WAIT_FOR_TICK;
2165	at => $NEXT_TICK || $TICK,	3609	our @WAIT_FOR_TICK_BEGIN;
2166	data => WF_AUTOCANCEL,	3610
2167	cb => sub {	3611	sub wait_for_tick {
2168	unless ($FREEZE) {	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
2169	cf::server_tick; # one server iteration	3636	cf::server_tick; # one server iteration
2170	$RUNTIME += $TICK;
2171	}
2172		3637
2173	$NEXT_TICK += $TICK;	3638	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2174		3639	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2175	# if we are delayed by four ticks or more, skip them all	3640	Coro::async_pool {
2176	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3641	$Coro::current->{desc} = "runtime saver";
2177
2178	$TICK_WATCHER->at ($NEXT_TICK);
2179	$TICK_WATCHER->start;
2180	},
2181	);
2182
2183	IO::AIO::max_poll_time $TICK * 0.2;
2184
2185	Event->io (
2186	fd => IO::AIO::poll_fileno,
2187	poll => 'r',
2188	prio => 5,
2189	data => WF_AUTOCANCEL,
2190	cb => \&IO::AIO::poll_cb,
2191	);
2192
2193	Event->timer (
2194	data => WF_AUTOCANCEL,
2195	after => 0,
2196	interval => 10,
2197	cb => sub {
2198	(Coro::unblock_sub {
2199	write_runtime	3642	write_runtime
2200	or warn "ERROR: unable to write runtime file: $!";	3643	or warn "ERROR: unable to write runtime file: $!";
2201	})->();	3644	};
2202	},	3645	}
2203	);	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;
2204		3757
2205	END { cf::emergency_save }	3758	END { cf::emergency_save }
2206		3759
2207	1	3760	1
2208		3761

Diff Legend

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