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

Diff Legend

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