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.167 by root, Sat Jan 13 23:32:43 2007 UTC vs.
Revision 1.376 by root, Mon Oct 1 00:44:44 2007 UTC

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

Diff Legend

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