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.140 by root, Fri Jan 5 20:04:02 2007 UTC vs.
Revision 1.434 by root, Thu May 29 03:27:37 2008 UTC

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

Diff Legend

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