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

Diff Legend

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