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

Diff Legend

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