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

Diff Legend

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