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

Diff Legend

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