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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.427 by root, Sat Apr 26 12:25:45 2008 UTC

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

Diff Legend

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