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

Diff Legend

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