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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.407 by root, Sun Jan 13 09:53:53 2008 UTC

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

Diff Legend

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