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

Diff Legend

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