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.276 by root, Sun Jun 10 04:05:47 2007 UTC vs.
Revision 1.358 by root, Fri Sep 7 18:10:52 2007 UTC

…		…
10	use Event;	10	use Event;
11	use Opcode;	11	use Opcode;
12	use Safe;	12	use Safe;
13	use Safe::Hole;	13	use Safe::Hole;
14		14
15	use Coro 3.61 ();	15	use Coro 3.64 ();
16	use Coro::State;	16	use Coro::State;
17	use Coro::Handle;	17	use Coro::Handle;
18	use Coro::Event;	18	use Coro::Event;
19	use Coro::Timer;	19	use Coro::Timer;
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
		24	use Coro::Util ();
24		25
		26	use JSON::XS ();
25	use BDB ();	27	use BDB ();
26	use Data::Dumper;	28	use Data::Dumper;
27	use Digest::MD5;	29	use Digest::MD5;
28	use Fcntl;	30	use Fcntl;
29	use YAML::Syck ();	31	use YAML::Syck ();
30	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
31	use Time::HiRes;	33	use Time::HiRes;
32	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
33		36
34	# configure various modules to our taste	37	# configure various modules to our taste
35	#	38	#
36	$Storable::canonical = 1; # reduce rsync transfers	39	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	52	our %COMMAND = ();
50	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
51		54
52	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
56		60
57	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
58	our @EVENT;	62	our @EVENT;
…		…
83	our %CFG;	87	our %CFG;
84		88
85	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
86	our $RUNTIME;	90	our $RUNTIME;
87		91
88	our %PLAYER; # all users	92	our (%PLAYER, %PLAYER_LOADING); # all users
89	our %MAP; # all maps	93	our (%MAP, %MAP_LOADING ); # all maps
90	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
91		95
92	# used to convert map paths into valid unix filenames by replacing / by ∕	96	# used to convert map paths into valid unix filenames by replacing / by ∕
93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94		98
…		…
163	=item cf::wait_for_tick, cf::wait_for_tick_begin	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
164		168
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166	returns directly I<after> the tick processing (and consequently, can only wake one process	170	returns directly I<after> the tick processing (and consequently, can only wake one process
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
168		178
169	=back	179	=back
170		180
171	=cut	181	=cut
172		182
…		…
206	}	216	}
207		217
208	$Event::DIED = sub {	218	$Event::DIED = sub {
209	warn "error in event callback: @_";	219	warn "error in event callback: @_";
210	};	220	};
		221
		222	#############################################################################
211		223
212	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
213		225
214	=over 4	226	=over 4
215		227
…		…
234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235	$d	247	$d
236	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
237	}	249	}
238		250
239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
242		252
243	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
244		254
245	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
246		256
247	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
		258
		259	=cut
		260
		261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		262
		263	sub to_json ($) { $json_coder->encode ($_[0]) }
		264	sub from_json ($) { $json_coder->decode ($_[0]) }
248		265
249	=item cf::lock_wait $string	266	=item cf::lock_wait $string
250		267
251	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
252		269
…		…
255	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
256	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
258	returned.	275	returned.
259		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
260	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
261	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
262		282
263	=item $locked = cf::lock_active $string	283	=item $locked = cf::lock_active $string
264		284
265	Return true if the lock is currently active, i.e. somebody has locked it.	285	Return true if the lock is currently active, i.e. somebody has locked it.
266		286
267	=cut	287	=cut
268		288
269	our %LOCK;	289	our %LOCK;
		290	our %LOCKER;#d#
270		291
271	sub lock_wait($) {	292	sub lock_wait($) {
272	my ($key) = @_;	293	my ($key) = @_;
		294
		295	if ($LOCKER{$key} == $Coro::current) {#d#
		296	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		297	return;#d#
		298	}#d#
273		299
274	# wait for lock, if any	300	# wait for lock, if any
275	while ($LOCK{$key}) {	301	while ($LOCK{$key}) {
276	push @{ $LOCK{$key} }, $Coro::current;	302	push @{ $LOCK{$key} }, $Coro::current;
277	Coro::schedule;	303	Coro::schedule;
…		…
283		309
284	# wait, to be sure we are not locked	310	# wait, to be sure we are not locked
285	lock_wait $key;	311	lock_wait $key;
286		312
287	$LOCK{$key} = [];	313	$LOCK{$key} = [];
		314	$LOCKER{$key} = $Coro::current;#d#
288		315
289	Coro::guard {	316	Coro::guard {
		317	delete $LOCKER{$key};#d#
290	# wake up all waiters, to be on the safe side	318	# wake up all waiters, to be on the safe side
291	$_->ready for @{ delete $LOCK{$key} };	319	$_->ready for @{ delete $LOCK{$key} };
292	}	320	}
293	}	321	}
294		322
…		…
306	};	334	};
307	$TICK_WATCHER->stop;	335	$TICK_WATCHER->stop;
308	$guard	336	$guard
309	}	337	}
310		338
		339	=item cf::get_slot $time[, $priority[, $name]]
		340
		341	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		342	This call blocks and returns only when you have at least C<$time> seconds
		343	of cpu time till the next tick. The slot is only valid till the next cede.
		344
		345	The optional C<$name> can be used to identify the job to run. It might be
		346	used for statistical purposes and should identify the same time-class.
		347
		348	Useful for short background jobs.
		349
		350	=cut
		351
		352	our @SLOT_QUEUE;
		353	our $SLOT_QUEUE;
		354
		355	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		356	$SLOT_QUEUE = Coro::async {
		357	my $signal = new Coro::Signal;
		358
		359	while () {
		360	next_job:
		361	my $avail = cf::till_tick;
		362	if ($avail > 0.01) {
		363	for (0 .. $#SLOT_QUEUE) {
		364	if ($SLOT_QUEUE[$_][0] < $avail) {
		365	my $job = splice @SLOT_QUEUE, $_, 1, ();
		366	$job->[2]->send;
		367	Coro::cede;
		368	goto next_job;
		369	}
		370	}
		371	}
		372
		373	if (@SLOT_QUEUE) {
		374	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		375	push @cf::WAIT_FOR_TICK, $signal;
		376	$signal->wait;
		377	} else {
		378	Coro::schedule;
		379	}
		380	}
		381	};
		382
		383	sub get_slot($;$$) {
		384	my ($time, $pri, $name) = @_;
		385
		386	$time = $TICK * .6 if $time > $TICK * .6;
		387	my $sig = new Coro::Signal;
		388
		389	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		390	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		391	$SLOT_QUEUE->ready;
		392	$sig->wait;
		393	}
		394
311	=item cf::async { BLOCK }	395	=item cf::async { BLOCK }
312		396
313	Currently the same as Coro::async_pool, meaning you cannot use	397	Currently the same as Coro::async_pool, meaning you cannot use
314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	398	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315	thing you are allowed to do is call C<prio> on it.	399	thing you are allowed to do is call C<prio> on it.
…		…
318		402
319	BEGIN { *async = \&Coro::async_pool }	403	BEGIN { *async = \&Coro::async_pool }
320		404
321	=item cf::sync_job { BLOCK }	405	=item cf::sync_job { BLOCK }
322		406
323	The design of crossfire+ requires that the main coro ($Coro::main) is	407	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324	always able to handle events or runnable, as crossfire+ is only partly	408	is always able to handle events or runnable, as Crossfire TRT is only
325	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	409	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		410	acceptable.
326		411
327	If it must be done, put the blocking parts into C<sync_job>. This will run	412	If it must be done, put the blocking parts into C<sync_job>. This will run
328	the given BLOCK in another coroutine while waiting for the result. The	413	the given BLOCK in another coroutine while waiting for the result. The
329	server will be frozen during this time, so the block should either finish	414	server will be frozen during this time, so the block should either finish
330	fast or be very important.	415	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	475	$EXT_CORO{$coro+0} = $coro;
391		476
392	$coro	477	$coro
393	}	478	}
394		479
395	sub write_runtime {	480	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		481
398	# first touch the runtime file to show we are still running:	482	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	483	process, returning the results. Everything must be serialisable with
		484	Coro::Storable. May, of course, block. Note that the executed sub may
		485	never block itself or use any form of Event handling.
400		486
401	IO::AIO::aio_utime $runtime, undef, undef;	487	=cut
402		488
403	my $guard = cf::lock_acquire "write_runtime";	489	sub fork_call(&@) {
		490	my ($cb, @args) = @_;
404		491
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	492	# we seemingly have to make a local copy of the whole thing,
406	or return;	493	# otherwise perl prematurely frees the stuff :/
		494	# TODO: investigate and fix (likely this will be rather laborious)
407		495
408	my $value = $cf::RUNTIME + 90 + 10;	496	my @res = Coro::Util::fork_eval {
409	# 10 is the runtime save interval, for a monotonic clock	497	reset_signals;
410	# 60 allows for the watchdog to kill the server.	498	&$cb
		499	}, @args;
411		500
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0	501	wantarray ? @res : $res[-1]
413	and return;	502	}
414		503
415	# always fsync - this file is important	504	=item $value = cf::db_get $family => $key
416	aio_fsync $fh
417	and return;
418		505
419	# touch it again to show we are up-to-date	506	Returns a single value from the environment database.
420	aio_utime $fh, undef, undef;
421		507
422	close $fh	508	=item cf::db_put $family => $key => $value
423	or return;
424		509
425	aio_rename "$runtime~", $runtime	510	Stores the given C<$value> in the family. It can currently store binary
426	and return;	511	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427		512
428	warn "runtime file written.\n";	513	=cut
429		514
		515	our $DB;
		516
		517	sub db_init {
		518	unless ($DB) {
		519	$DB = BDB::db_create $DB_ENV;
		520
		521	cf::sync_job {
		522	eval {
		523	$DB->set_flags (BDB::CHKSUM);
		524
		525	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		526	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		527	cf::cleanup "db_open(db): $!" if $!;
		528	};
		529	cf::cleanup "db_open(db): $@" if $@;
		530	};
430	1	531	}
		532	}
		533
		534	sub db_get($$) {
		535	my $key = "$_[0]/$_[1]";
		536
		537	cf::sync_job {
		538	BDB::db_get $DB, undef, $key, my $data;
		539
		540	$! ? ()
		541	: $data
		542	}
		543	}
		544
		545	sub db_put($$$) {
		546	BDB::dbreq_pri 4;
		547	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		548	}
		549
		550	=item cf::cache $id => [$paths...], $processversion => $process
		551
		552	Generic caching function that returns the value of the resource $id,
		553	caching and regenerating as required.
		554
		555	This function can block.
		556
		557	=cut
		558
		559	sub cache {
		560	my ($id, $src, $processversion, $process) = @_;
		561
		562	my $meta =
		563	join "\x00",
		564	$processversion,
		565	map {
		566	aio_stat $_
		567	and Carp::croak "$_: $!";
		568
		569	($_, (stat _)[7,9])
		570	} @$src;
		571
		572	my $dbmeta = db_get cache => "$id/meta";
		573	if ($dbmeta ne $meta) {
		574	# changed, we may need to process
		575
		576	my @data;
		577	my $md5;
		578
		579	for (0 .. $#$src) {
		580	0 <= aio_load $src->[$_], $data[$_]
		581	or Carp::croak "$src->[$_]: $!";
		582	}
		583
		584	# if processing is expensive, check
		585	# checksum first
		586	if (1) {
		587	$md5 =
		588	join "\x00",
		589	$processversion,
		590	map {
		591	cf::cede_to_tick;
		592	($src->[$_], Digest::MD5::md5_hex $data[$_])
		593	} 0.. $#$src;
		594
		595
		596	my $dbmd5 = db_get cache => "$id/md5";
		597	if ($dbmd5 eq $md5) {
		598	db_put cache => "$id/meta", $meta;
		599
		600	return db_get cache => "$id/data";
		601	}
		602	}
		603
		604	my $t1 = Time::HiRes::time;
		605	my $data = $process->(\@data);
		606	my $t2 = Time::HiRes::time;
		607
		608	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		609
		610	db_put cache => "$id/data", $data;
		611	db_put cache => "$id/md5" , $md5;
		612	db_put cache => "$id/meta", $meta;
		613
		614	return $data;
		615	}
		616
		617	db_get cache => "$id/data"
431	}	618	}
432		619
433	=item cf::datalog type => key => value, ...	620	=item cf::datalog type => key => value, ...
434		621
435	Log a datalog packet of the given type with the given key-value pairs.	622	Log a datalog packet of the given type with the given key-value pairs.
…		…
453	attach callbacks/event handlers (a collection of which is called an "attachment")	640	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	641	to it. All such attachable objects support the following methods.
455		642
456	In the following description, CLASS can be any of C<global>, C<object>	643	In the following description, CLASS can be any of C<global>, C<object>
457	C<player>, C<client> or C<map> (i.e. the attachable objects in	644	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	645	Crossfire TRT).
459		646
460	=over 4	647	=over 4
461		648
462	=item $attachable->attach ($attachment, key => $value...)	649	=item $attachable->attach ($attachment, key => $value...)
463		650
…		…
665	_attach $registry, $klass, @attach;	852	_attach $registry, $klass, @attach;
666	}	853	}
667		854
668	$obj->{$name} = \%arg;	855	$obj->{$name} = \%arg;
669	} else {	856	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	857	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	858	}
672		859
673	$obj->{_attachment}{$name} = undef;	860	$obj->{_attachment}{$name} = undef;
674	}	861	}
675		862
…		…
715	";	902	";
716	die if $@;	903	die if $@;
717	}	904	}
718		905
719	our $override;	906	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	907	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		908
722	sub override {	909	sub override {
723	$override = 1;	910	$override = 1;
724	@invoke_results = ();	911	@INVOKE_RESULTS = (@_);
725	}	912	}
726		913
727	sub do_invoke {	914	sub do_invoke {
728	my $event = shift;	915	my $event = shift;
729	my $callbacks = shift;	916	my $callbacks = shift;
730		917
731	@invoke_results = ();	918	@INVOKE_RESULTS = ();
732		919
733	local $override;	920	local $override;
734		921
735	for (@$callbacks) {	922	for (@$callbacks) {
736	eval { &{$_->[1]} };	923	eval { &{$_->[1]} };
…		…
753		940
754	Generate an object-specific event with the given arguments.	941	Generate an object-specific event with the given arguments.
755		942
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	943	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757	removed in future versions), and there is no public API to access override	944	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	945	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		946
760	=back	947	=back
761		948
762	=cut	949	=cut
763		950
764	#############################################################################	951	#############################################################################
765	# object support	952	# object support
		953	#
		954
		955	sub _can_merge {
		956	my ($ob1, $ob2) = @_;
		957
		958	local $Storable::canonical = 1;
		959	my $fob1 = Storable::freeze $ob1;
		960	my $fob2 = Storable::freeze $ob2;
		961
		962	$fob1 eq $fob2
		963	}
766		964
767	sub reattach {	965	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	966	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	967	my ($obj) = @_;
770		968
…		…
814	},	1012	},
815	);	1013	);
816		1014
817	sub object_freezer_save {	1015	sub object_freezer_save {
818	my ($filename, $rdata, $objs) = @_;	1016	my ($filename, $rdata, $objs) = @_;
		1017
		1018	my $guard = cf::lock_acquire "io";
819		1019
820	sync_job {	1020	sync_job {
821	if (length $$rdata) {	1021	if (length $$rdata) {
822	warn sprintf "saving %s (%d,%d)\n",	1022	warn sprintf "saving %s (%d,%d)\n",
823	$filename, length $$rdata, scalar @$objs;	1023	$filename, length $$rdata, scalar @$objs;
…		…
847	}	1047	}
848	} else {	1048	} else {
849	aio_unlink $filename;	1049	aio_unlink $filename;
850	aio_unlink "$filename.pst";	1050	aio_unlink "$filename.pst";
851	}	1051	}
852	}	1052	};
		1053
		1054	undef $guard;
853	}	1055	}
854		1056
855	sub object_freezer_as_string {	1057	sub object_freezer_as_string {
856	my ($rdata, $objs) = @_;	1058	my ($rdata, $objs) = @_;
857		1059
…		…
862		1064
863	sub object_thawer_load {	1065	sub object_thawer_load {
864	my ($filename) = @_;	1066	my ($filename) = @_;
865		1067
866	my ($data, $av);	1068	my ($data, $av);
		1069
		1070	my $guard = cf::lock_acquire "io";
867		1071
868	(aio_load $filename, $data) >= 0	1072	(aio_load $filename, $data) >= 0
869	or return;	1073	or return;
870		1074
871	unless (aio_stat "$filename.pst") {	1075	unless (aio_stat "$filename.pst") {
872	(aio_load "$filename.pst", $av) >= 0	1076	(aio_load "$filename.pst", $av) >= 0
873	or return;	1077	or return;
		1078
		1079	undef $guard;
874	$av = eval { (Storable::thaw $av)->{objs} };	1080	$av = eval { (Storable::thaw $av)->{objs} };
875	}	1081	}
876		1082
877	warn sprintf "loading %s (%d)\n",	1083	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1084	$filename, length $data, scalar @{$av || []};
		1085
879	return ($data, $av);	1086	($data, $av)
880	}	1087	}
		1088
		1089	=head2 COMMAND CALLBACKS
		1090
		1091	=over 4
		1092
		1093	=cut
881		1094
882	#############################################################################	1095	#############################################################################
883	# command handling &c	1096	# command handling &c
884		1097
885	=item cf::register_command $name => \&callback($ob,$args);	1098	=item cf::register_command $name => \&callback($ob,$args);
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1111	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1112	}
900		1113
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1114	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1115
903	Register a callbackf ro execution when the client sends an extcmd packet.	1116	Register a callback for execution when the client sends an (synchronous)
		1117	extcmd packet. Ext commands will be processed in the order they are
		1118	received by the server, like other user commands. The first argument is
		1119	the logged-in player. Ext commands can only be processed after a player
		1120	has logged in successfully.
904		1121
905	If the callback returns something, it is sent back as if reply was being	1122	If the callback returns something, it is sent back as if reply was being
906	called.	1123	called.
907		1124
		1125	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1126
		1127	Register a callback for execution when the client sends an (asynchronous)
		1128	exticmd packet. Exti commands are processed by the server as soon as they
		1129	are received, i.e. out of order w.r.t. other commands. The first argument
		1130	is a client socket. Exti commands can be received anytime, even before
		1131	log-in.
		1132
		1133	If the callback returns something, it is sent back as if reply was being
		1134	called.
		1135
908	=cut	1136	=cut
909		1137
910	sub register_extcmd {	1138	sub register_extcmd {
911	my ($name, $cb) = @_;	1139	my ($name, $cb) = @_;
912		1140
913	$EXTCMD{$name} = $cb;	1141	$EXTCMD{$name} = $cb;
		1142	}
		1143
		1144	sub register_exticmd {
		1145	my ($name, $cb) = @_;
		1146
		1147	$EXTICMD{$name} = $cb;
914	}	1148	}
915		1149
916	cf::player->attach (	1150	cf::player->attach (
917	on_command => sub {	1151	on_command => sub {
918	my ($pl, $name, $params) = @_;	1152	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1161	cf::override;
928	},	1162	},
929	on_extcmd => sub {	1163	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1164	my ($pl, $buf) = @_;
931		1165
932	my $msg = eval { from_json $buf };	1166	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1167
934	if (ref $msg) {	1168	if (ref $msg) {
		1169	my ($type, $reply, @payload) =
		1170	"ARRAY" eq ref $msg
		1171	? @$msg
		1172	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1173
		1174	my @reply;
		1175
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1176	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1177	@reply = $cb->($pl, @payload);
937	$pl->ext_reply ($msg->{msgid}, %reply);
938	}
939	}	1178	}
		1179
		1180	$pl->ext_reply ($reply, @reply)
		1181	if $reply;
		1182
940	} else {	1183	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1184	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1185	}
943		1186
944	cf::override;	1187	cf::override;
945	},	1188	},
946	);	1189	);
947		1190
948	sub load_extension {
949	my ($path) = @_;
950
951	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
952	my $base = $1;
953	my $pkg = $1;
954	$pkg =~ s/[^[:word:]]/_/g;
955	$pkg = "ext::$pkg";
956
957	warn "... loading '$path' into '$pkg'\n";
958
959	open my $fh, "<:utf8", $path
960	or die "$path: $!";
961
962	my $source =
963	"package $pkg; use strict; use utf8;\n"
964	. "#line 1 \"$path\"\n{\n"
965	. (do { local $/; <$fh> })
966	. "\n};\n1";
967
968	unless (eval $source) {
969	my $msg = $@ ? "$path: $@\n"
970	: "extension disabled.\n";
971	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972	warn $@;
973	warn "mandatory extension failed to load, exiting.\n";
974	exit 1;
975	}
976	die $@;
977	}
978
979	push @EXTS, $pkg;
980	}
981
982	sub load_extensions {	1191	sub load_extensions {
		1192	cf::sync_job {
		1193	my %todo;
		1194
983	for my $ext (<$LIBDIR/*.ext>) {	1195	for my $path (<$LIBDIR/*.ext>) {
984	next unless -r $ext;	1196	next unless -r $path;
985	eval {	1197
986	load_extension $ext;	1198	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1199	my $base = $1;
		1200	my $pkg = $1;
		1201	$pkg =~ s/[^[:word:]]/_/g;
		1202	$pkg = "ext::$pkg";
		1203
		1204	open my $fh, "<:utf8", $path
		1205	or die "$path: $!";
		1206
		1207	my $source = do { local $/; <$fh> };
		1208
		1209	my %ext = (
		1210	path => $path,
		1211	base => $base,
		1212	pkg => $pkg,
		1213	);
		1214
		1215	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1216	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1217
		1218	$ext{source} =
		1219	"package $pkg; use strict; use utf8;\n"
		1220	. "#line 1 \"$path\"\n{\n"
		1221	. $source
		1222	. "\n};\n1";
		1223
		1224	$todo{$base} = \%ext;
		1225	}
		1226
		1227	my %done;
		1228	while (%todo) {
		1229	my $progress;
		1230
		1231	while (my ($k, $v) = each %todo) {
		1232	for (split /,\s*/, $v->{meta}{depends}) {
		1233	goto skip
		1234	unless exists $done{$_};
		1235	}
		1236
		1237	warn "... loading '$k' into '$v->{pkg}'\n";
		1238
		1239	unless (eval $v->{source}) {
		1240	my $msg = $@ ? "$v->{path}: $@\n"
		1241	: "$v->{base}: extension inactive.\n";
		1242
		1243	if (exists $v->{meta}{mandatory}) {
		1244	warn $msg;
		1245	warn "mandatory extension failed to load, exiting.\n";
		1246	exit 1;
		1247	}
		1248
		1249	warn $msg;
		1250	}
		1251
		1252	$done{$k} = delete $todo{$k};
		1253	push @EXTS, $v->{pkg};
		1254	$progress = 1;
987	1	1255	}
988	} or warn "$ext not loaded: $@";	1256
		1257	skip:
		1258	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1259	unless $progress;
		1260	}
989	}	1261	};
990	}	1262	}
991		1263
992	#############################################################################	1264	#############################################################################
		1265
		1266	=back
993		1267
994	=head2 CORE EXTENSIONS	1268	=head2 CORE EXTENSIONS
995		1269
996	Functions and methods that extend core crossfire objects.	1270	Functions and methods that extend core crossfire objects.
997		1271
…		…
1047	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1321	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1048	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1322	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1049	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1323	aio_unlink +(playerdir $login) . "/$login.pl.pst";
1050	aio_unlink +(playerdir $login) . "/$login.pl";	1324	aio_unlink +(playerdir $login) . "/$login.pl";
1051		1325
1052	my $pl = load_pl path $login	1326	my $f = new_from_file cf::object::thawer path $login
1053	or return;	1327	or return;
		1328
		1329	$f->next;
		1330	my $pl = cf::player::load_pl $f
		1331	or return;
		1332	local $cf::PLAYER_LOADING{$login} = $pl;
		1333	$f->resolve_delayed_derefs;
1054	$cf::PLAYER{$login} = $pl	1334	$cf::PLAYER{$login} = $pl
1055	}	1335	}
1056	}	1336	}
1057	}	1337	}
1058		1338
…		…
1068		1348
1069	aio_mkdir playerdir $pl, 0770;	1349	aio_mkdir playerdir $pl, 0770;
1070	$pl->{last_save} = $cf::RUNTIME;	1350	$pl->{last_save} = $cf::RUNTIME;
1071		1351
1072	$pl->save_pl ($path);	1352	$pl->save_pl ($path);
1073	Coro::cede;	1353	cf::cede_to_tick;
1074	}	1354	}
1075		1355
1076	sub new($) {	1356	sub new($) {
1077	my ($login) = @_;	1357	my ($login) = @_;
1078		1358
…		…
1082	$self->{deny_save} = 1;	1362	$self->{deny_save} = 1;
1083		1363
1084	$cf::PLAYER{$login} = $self;	1364	$cf::PLAYER{$login} = $self;
1085		1365
1086	$self	1366	$self
		1367	}
		1368
		1369	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1370
		1371	=cut
		1372
		1373	sub send_msg {
		1374	my $ns = shift->ns
		1375	or return;
		1376	$ns->send_msg (@_);
1087	}	1377	}
1088		1378
1089	=item $pl->quit_character	1379	=item $pl->quit_character
1090		1380
1091	Nukes the player without looking back. If logged in, the connection will	1381	Nukes the player without looking back. If logged in, the connection will
…		…
1146	or return [];	1436	or return [];
1147		1437
1148	my @logins;	1438	my @logins;
1149		1439
1150	for my $login (@$dirs) {	1440	for my $login (@$dirs) {
		1441	my $path = path $login;
		1442
		1443	# a .pst is a dead give-away for a valid player
		1444	unless (-e "$path.pst") {
1151	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1445	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1152	aio_read $fh, 0, 512, my $buf, 0 or next;	1446	aio_read $fh, 0, 512, my $buf, 0 or next;
1153	$buf !~ /^password -------------$/m or next; # official not-valid tag	1447	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1448	}
1154		1449
1155	utf8::decode $login;	1450	utf8::decode $login;
1156	push @logins, $login;	1451	push @logins, $login;
1157	}	1452	}
1158		1453
…		…
1185	}	1480	}
1186		1481
1187	\@paths	1482	\@paths
1188	}	1483	}
1189		1484
		1485	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1486
		1487	Expand crossfire pod fragments into protocol xml.
		1488
		1489	=cut
		1490
		1491	sub expand_cfpod {
		1492	((my $self), (local $_)) = @_;
		1493
		1494	# escape & and <
		1495	s/&/&amp;/g;
		1496	s/(?<![BIUGHT])</&lt;/g;
		1497
		1498	# this is buggy, it needs to properly take care of nested <'s
		1499
		1500	1 while
		1501	# replace B<>, I<>, U<> etc.
		1502	s/B<([^\>]*)>/<b>$1<\/b>/
		1503	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1504	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1505	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1506	# replace G<male|female> tags
		1507	|| s{G<([^>|]*)\|([^>]*)>}{
		1508	$self->gender ? $2 : $1
		1509	}ge
		1510	# replace H<hint text>
		1511	|| s{H<([^\>]*)>}
		1512	{
		1513	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1514	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1515	"")
		1516	[$self->{hintmode}]
		1517	}ge;
		1518
		1519	# create single paragraphs (very hackish)
		1520	s/(?<=\S)\n(?=\w)/ /g;
		1521
		1522	# compress some whitespace
		1523	s/\s+\n/\n/g; # ws line-ends
		1524	s/\n\n+/\n/g; # double lines
		1525	s/^\n+//; # beginning lines
		1526	s/\n+$//; # ending lines
		1527
		1528	$_
		1529	}
		1530
		1531	sub hintmode {
		1532	$_[0]{hintmode} = $_[1] if @_ > 1;
		1533	$_[0]{hintmode}
		1534	}
		1535
1190	=item $player->ext_reply ($msgid, %msg)	1536	=item $player->ext_reply ($msgid, @msg)
1191		1537
1192	Sends an ext reply to the player.	1538	Sends an ext reply to the player.
1193		1539
1194	=cut	1540	=cut
1195		1541
1196	sub ext_reply($$%) {	1542	sub ext_reply($$@) {
1197	my ($self, $id, %msg) = @_;	1543	my ($self, $id, @msg) = @_;
1198		1544
1199	$msg{msgid} = $id;	1545	$self->ns->ext_reply ($id, @msg)
1200
1201	$self->send ("ext " . cf::to_json \%msg);
1202	}	1546	}
1203		1547
1204	=item $player->ext_event ($type, %msg)	1548	=item $player->ext_msg ($type, @msg)
1205		1549
1206	Sends an ext event to the client.	1550	Sends an ext event to the client.
1207		1551
1208	=cut	1552	=cut
1209		1553
1210	sub ext_event($$%) {	1554	sub ext_msg($$@) {
1211	my ($self, $type, %msg) = @_;	1555	my ($self, $type, @msg) = @_;
1212		1556
1213	$self->ns->ext_event ($type, %msg);	1557	$self->ns->ext_msg ($type, @msg);
1214	}	1558	}
1215		1559
1216	=head3 cf::region	1560	=head3 cf::region
1217		1561
1218	=over 4	1562	=over 4
…		…
1221		1565
1222	package cf::region;	1566	package cf::region;
1223		1567
1224	=item cf::region::find_by_path $path	1568	=item cf::region::find_by_path $path
1225		1569
1226	Tries to decuce the probable region for a map knowing only its path.	1570	Tries to decuce the likely region for a map knowing only its path.
1227		1571
1228	=cut	1572	=cut
1229		1573
1230	sub find_by_path($) {	1574	sub find_by_path($) {
1231	my ($path) = @_;	1575	my ($path) = @_;
1232		1576
1233	my ($match, $specificity);	1577	my ($match, $specificity);
1234		1578
1235	for my $region (list) {	1579	for my $region (list) {
1236	if ($region->match && $path =~ $region->match) {	1580	if ($region->{match} && $path =~ $region->{match}) {
1237	($match, $specificity) = ($region, $region->specificity)	1581	($match, $specificity) = ($region, $region->specificity)
1238	if $region->specificity > $specificity;	1582	if $region->specificity > $specificity;
1239	}	1583	}
1240	}	1584	}
1241		1585
…		…
1361	$self->init; # pass $1 etc.	1705	$self->init; # pass $1 etc.
1362	return $self;	1706	return $self;
1363	}	1707	}
1364	}	1708	}
1365		1709
1366	Carp::carp "unable to resolve path '$path' (base '$base').";	1710	Carp::cluck "unable to resolve path '$path' (base '$base').";
1367	()	1711	()
1368	}	1712	}
1369		1713
1370	sub init {	1714	sub init {
1371	my ($self) = @_;	1715	my ($self) = @_;
…		…
1434		1778
1435	sub load_header_from($) {	1779	sub load_header_from($) {
1436	my ($self, $path) = @_;	1780	my ($self, $path) = @_;
1437		1781
1438	utf8::encode $path;	1782	utf8::encode $path;
1439	#aio_open $path, O_RDONLY, 0	1783	my $f = new_from_file cf::object::thawer $path
1440	# or return;
1441
1442	$self->_load_header ($path)
1443	or return;	1784	or return;
		1785
		1786	$self->_load_header ($f)
		1787	or return;
		1788
		1789	local $MAP_LOADING{$self->{path}} = $self;
		1790	$f->resolve_delayed_derefs;
1444		1791
1445	$self->{load_path} = $path;	1792	$self->{load_path} = $path;
1446		1793
1447	1	1794	1
1448	}	1795	}
…		…
1502	sub find {	1849	sub find {
1503	my ($path, $origin) = @_;	1850	my ($path, $origin) = @_;
1504		1851
1505	$path = normalise $path, $origin && $origin->path;	1852	$path = normalise $path, $origin && $origin->path;
1506		1853
		1854	cf::lock_wait "map_data:$path";#d#remove
1507	cf::lock_wait "map_find:$path";	1855	cf::lock_wait "map_find:$path";
1508		1856
1509	$cf::MAP{$path} || do {	1857	$cf::MAP{$path} || do {
1510	my $guard = cf::lock_acquire "map_find:$path";	1858	my $guard1 = cf::lock_acquire "map_find:$path";
		1859	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1860
1511	my $map = new_from_path cf::map $path	1861	my $map = new_from_path cf::map $path
1512	or return;	1862	or return;
1513		1863
1514	$map->{last_save} = $cf::RUNTIME;	1864	$map->{last_save} = $cf::RUNTIME;
1515		1865
…		…
1517	or return;	1867	or return;
1518		1868
1519	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)	1869	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1520	# doing this can freeze the server in a sync job, obviously	1870	# doing this can freeze the server in a sync job, obviously
1521	#$cf::WAIT_FOR_TICK->wait;	1871	#$cf::WAIT_FOR_TICK->wait;
		1872	undef $guard1;
		1873	undef $guard2;
1522	$map->reset;	1874	$map->reset;
1523	undef $guard;
1524	return find $path;	1875	return find $path;
1525	}	1876	}
1526		1877
1527	$cf::MAP{$path} = $map	1878	$cf::MAP{$path} = $map
1528	}	1879	}
…		…
1537	local $self->{deny_reset} = 1; # loading can take a long time	1888	local $self->{deny_reset} = 1; # loading can take a long time
1538		1889
1539	my $path = $self->{path};	1890	my $path = $self->{path};
1540		1891
1541	{	1892	{
1542	my $guard = cf::lock_acquire "map_load:$path";	1893	my $guard = cf::lock_acquire "map_data:$path";
1543		1894
		1895	return unless $self->valid;
1544	return if $self->in_memory != cf::MAP_SWAPPED;	1896	return if $self->in_memory != cf::MAP_SWAPPED;
1545		1897
1546	$self->in_memory (cf::MAP_LOADING);	1898	$self->in_memory (cf::MAP_LOADING);
1547		1899
1548	$self->alloc;	1900	$self->alloc;
1549		1901
1550	$self->pre_load;	1902	$self->pre_load;
1551	Coro::cede;	1903	cf::cede_to_tick;
1552		1904
		1905	my $f = new_from_file cf::object::thawer $self->{load_path};
		1906	$f->skip_block;
1553	$self->_load_objects ($self->{load_path}, 1)	1907	$self->_load_objects ($f)
1554	or return;	1908	or return;
1555		1909
1556	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1910	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1557	if delete $self->{load_original};	1911	if delete $self->{load_original};
1558		1912
1559	if (my $uniq = $self->uniq_path) {	1913	if (my $uniq = $self->uniq_path) {
1560	utf8::encode $uniq;	1914	utf8::encode $uniq;
1561	if (aio_open $uniq, O_RDONLY, 0) {	1915	unless (aio_stat $uniq) {
		1916	if (my $f = new_from_file cf::object::thawer $uniq) {
1562	$self->clear_unique_items;	1917	$self->clear_unique_items;
1563	$self->_load_objects ($uniq, 0);	1918	$self->_load_objects ($f);
		1919	$f->resolve_delayed_derefs;
		1920	}
1564	}	1921	}
1565	}	1922	}
1566		1923
1567	Coro::cede;	1924	$f->resolve_delayed_derefs;
		1925
		1926	cf::cede_to_tick;
1568	# now do the right thing for maps	1927	# now do the right thing for maps
1569	$self->link_multipart_objects;	1928	$self->link_multipart_objects;
1570	$self->difficulty ($self->estimate_difficulty)	1929	$self->difficulty ($self->estimate_difficulty)
1571	unless $self->difficulty;	1930	unless $self->difficulty;
1572	Coro::cede;	1931	cf::cede_to_tick;
1573		1932
1574	unless ($self->{deny_activate}) {	1933	unless ($self->{deny_activate}) {
1575	$self->decay_objects;	1934	$self->decay_objects;
1576	$self->fix_auto_apply;	1935	$self->fix_auto_apply;
1577	$self->update_buttons;	1936	$self->update_buttons;
1578	Coro::cede;	1937	cf::cede_to_tick;
1579	$self->set_darkness_map;	1938	$self->set_darkness_map;
1580	Coro::cede;	1939	cf::cede_to_tick;
1581	$self->activate;	1940	$self->activate;
1582	}	1941	}
		1942
		1943	$self->{last_save} = $cf::RUNTIME;
		1944	$self->last_access ($cf::RUNTIME);
1583		1945
1584	$self->in_memory (cf::MAP_IN_MEMORY);	1946	$self->in_memory (cf::MAP_IN_MEMORY);
1585	}	1947	}
1586		1948
1587	$self->post_load;	1949	$self->post_load;
…		…
1598		1960
1599	$self	1961	$self
1600	}	1962	}
1601		1963
1602	# find and load all maps in the 3x3 area around a map	1964	# find and load all maps in the 3x3 area around a map
1603	sub load_diag {	1965	sub load_neighbours {
1604	my ($map) = @_;	1966	my ($map) = @_;
1605		1967
1606	my @diag; # diagonal neighbours	1968	my @neigh; # diagonal neighbours
1607		1969
1608	for (0 .. 3) {	1970	for (0 .. 3) {
1609	my $neigh = $map->tile_path ($_)	1971	my $neigh = $map->tile_path ($_)
1610	or next;	1972	or next;
1611	$neigh = find $neigh, $map	1973	$neigh = find $neigh, $map
1612	or next;	1974	or next;
1613	$neigh->load;	1975	$neigh->load;
1614		1976
		1977	push @neigh,
1615	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1978	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1616	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1979	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1617	}	1980	}
1618		1981
1619	for (@diag) {	1982	for (grep defined $_->[0], @neigh) {
		1983	my ($path, $origin) = @$_;
1620	my $neigh = find @$_	1984	my $neigh = find $path, $origin
1621	or next;	1985	or next;
1622	$neigh->load;	1986	$neigh->load;
1623	}	1987	}
1624	}	1988	}
1625		1989
…		…
1630	}	1994	}
1631		1995
1632	sub do_load_sync {	1996	sub do_load_sync {
1633	my ($map) = @_;	1997	my ($map) = @_;
1634		1998
		1999	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2000	if $Coro::current == $Coro::main;
		2001
1635	cf::sync_job { $map->load };	2002	cf::sync_job { $map->load };
1636	}	2003	}
1637		2004
1638	our %MAP_PREFETCH;	2005	our %MAP_PREFETCH;
1639	our $MAP_PREFETCHER = undef;	2006	our $MAP_PREFETCHER = undef;
1640		2007
1641	sub find_async {	2008	sub find_async {
1642	my ($path, $origin) = @_;	2009	my ($path, $origin, $load) = @_;
1643		2010
1644	$path = normalise $path, $origin && $origin->{path};	2011	$path = normalise $path, $origin && $origin->{path};
1645		2012
1646	if (my $map = $cf::MAP{$path}) {	2013	if (my $map = $cf::MAP{$path}) {
1647	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2014	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1648	}	2015	}
1649		2016
1650	undef $MAP_PREFETCH{$path};	2017	$MAP_PREFETCH{$path} |= $load;
		2018
1651	$MAP_PREFETCHER ||= cf::async {	2019	$MAP_PREFETCHER ||= cf::async {
1652	while (%MAP_PREFETCH) {	2020	while (%MAP_PREFETCH) {
1653	for my $path (keys %MAP_PREFETCH) {	2021	while (my ($k, $v) = each %MAP_PREFETCH) {
1654	my $map = find $path	2022	if (my $map = find $k) {
1655	or next;
1656	$map->load;	2023	$map->load if $v;
		2024	}
1657		2025
1658	delete $MAP_PREFETCH{$path};	2026	delete $MAP_PREFETCH{$k};
1659	}	2027	}
1660	}	2028	}
1661	undef $MAP_PREFETCHER;	2029	undef $MAP_PREFETCHER;
1662	};	2030	};
1663	$MAP_PREFETCHER->prio (6);	2031	$MAP_PREFETCHER->prio (6);
…		…
1666	}	2034	}
1667		2035
1668	sub save {	2036	sub save {
1669	my ($self) = @_;	2037	my ($self) = @_;
1670		2038
1671	my $lock = cf::lock_acquire "map_data:" . $self->path;	2039	my $lock = cf::lock_acquire "map_data:$self->{path}";
1672		2040
1673	$self->{last_save} = $cf::RUNTIME;	2041	$self->{last_save} = $cf::RUNTIME;
1674		2042
1675	return unless $self->dirty;	2043	return unless $self->dirty;
1676		2044
…		…
1699	my ($self) = @_;	2067	my ($self) = @_;
1700		2068
1701	# save first because save cedes	2069	# save first because save cedes
1702	$self->save;	2070	$self->save;
1703		2071
1704	my $lock = cf::lock_acquire "map_data:" . $self->path;	2072	my $lock = cf::lock_acquire "map_data:$self->{path}";
1705		2073
1706	return if $self->players;	2074	return if $self->players;
1707	return if $self->in_memory != cf::MAP_IN_MEMORY;	2075	return if $self->in_memory != cf::MAP_IN_MEMORY;
1708	return if $self->{deny_save};	2076	return if $self->{deny_save};
1709		2077
		2078	$self->deactivate;
1710	$self->clear;	2079	$self->clear;
1711	$self->in_memory (cf::MAP_SWAPPED);	2080	$self->in_memory (cf::MAP_SWAPPED);
1712	}	2081	}
1713		2082
1714	sub reset_at {	2083	sub reset_at {
…		…
1748	if $uniq;	2117	if $uniq;
1749	}	2118	}
1750		2119
1751	delete $cf::MAP{$self->path};	2120	delete $cf::MAP{$self->path};
1752		2121
		2122	$self->deactivate;
1753	$self->clear;	2123	$self->clear;
1754		2124
1755	$_->clear_links_to ($self) for values %cf::MAP;	2125	$_->clear_links_to ($self) for values %cf::MAP;
1756		2126
1757	$self->unlink_save;	2127	$self->unlink_save;
…		…
1761	my $nuke_counter = "aaaa";	2131	my $nuke_counter = "aaaa";
1762		2132
1763	sub nuke {	2133	sub nuke {
1764	my ($self) = @_;	2134	my ($self) = @_;
1765		2135
		2136	{
		2137	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2138
1766	delete $cf::MAP{$self->path};	2139	delete $cf::MAP{$self->path};
1767		2140
1768	$self->unlink_save;	2141	$self->unlink_save;
1769		2142
1770	bless $self, "cf::map";	2143	bless $self, "cf::map";
1771	delete $self->{deny_reset};	2144	delete $self->{deny_reset};
1772	$self->{deny_save} = 1;	2145	$self->{deny_save} = 1;
1773	$self->reset_timeout (1);	2146	$self->reset_timeout (1);
1774	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2147	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1775		2148
1776	$cf::MAP{$self->path} = $self;	2149	$cf::MAP{$self->path} = $self;
		2150	}
1777		2151
1778	$self->reset; # polite request, might not happen	2152	$self->reset; # polite request, might not happen
1779	}	2153	}
1780		2154
1781	=item $maps = cf::map::tmp_maps	2155	=item $maps = cf::map::tmp_maps
1782		2156
1783	Returns an arrayref with all map paths of currently instantiated and saved	2157	Returns an arrayref with all map paths of currently instantiated and saved
1784	maps.	2158	maps. May block.
1785		2159
1786	=cut	2160	=cut
1787		2161
1788	sub tmp_maps() {	2162	sub tmp_maps() {
1789	[	2163	[
1790	map {	2164	map {
1791	utf8::decode $_;	2165	utf8::decode $_;
1792	!/\.(?:pst|meta)$/ && /^$PATH_SEP/o	2166	/\.map$/
1793	? normalise $_	2167	? normalise $_
1794	: ()	2168	: ()
1795	} @{ aio_readdir $TMPDIR or [] }	2169	} @{ aio_readdir $TMPDIR or [] }
1796	]	2170	]
1797	}	2171	}
1798		2172
		2173	=item $maps = cf::map::random_maps
		2174
		2175	Returns an arrayref with all map paths of currently instantiated and saved
		2176	random maps. May block.
		2177
		2178	=cut
		2179
		2180	sub random_maps() {
		2181	[
		2182	map {
		2183	utf8::decode $_;
		2184	/\.map$/
		2185	? normalise "?random/$_"
		2186	: ()
		2187	} @{ aio_readdir $RANDOMDIR or [] }
		2188	]
		2189	}
		2190
1799	=item cf::map::unique_maps	2191	=item cf::map::unique_maps
1800		2192
1801	Returns an arrayref of paths of all shared maps that have	2193	Returns an arrayref of paths of all shared maps that have
1802	instantiated unique items. May block.	2194	instantiated unique items. May block.
1803		2195
…		…
1805		2197
1806	sub unique_maps() {	2198	sub unique_maps() {
1807	[	2199	[
1808	map {	2200	map {
1809	utf8::decode $_;	2201	utf8::decode $_;
1810	!/\.(?:pst|meta)$/ && /^$PATH_SEP/o	2202	/\.map$/
1811	? normalise $_	2203	? normalise $_
1812	: ()	2204	: ()
1813	} @{ aio_readdir $UNIQUEDIR or [] }	2205	} @{ aio_readdir $UNIQUEDIR or [] }
1814	]	2206	]
1815	}	2207	}
…		…
1837	map { $_, inv_recursive_ $_->inv } @_	2229	map { $_, inv_recursive_ $_->inv } @_
1838	}	2230	}
1839		2231
1840	sub inv_recursive {	2232	sub inv_recursive {
1841	inv_recursive_ inv $_[0]	2233	inv_recursive_ inv $_[0]
		2234	}
		2235
		2236	=item $ref = $ob->ref
		2237
		2238	creates and returns a persistent reference to an objetc that can be stored as a string.
		2239
		2240	=item $ob = cf::object::deref ($refstring)
		2241
		2242	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2243	even if the object actually exists. May block.
		2244
		2245	=cut
		2246
		2247	sub deref {
		2248	my ($ref) = @_;
		2249
		2250	# temporary compatibility#TODO#remove
		2251	$ref =~ s{^<}{player/<};
		2252
		2253	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2254	my ($uuid, $name) = ($1, $2);
		2255	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2256	or return;
		2257	$pl->ob->uuid eq $uuid
		2258	or return;
		2259
		2260	$pl->ob
		2261	} else {
		2262	warn "$ref: cannot resolve object reference\n";
		2263	undef
		2264	}
1842	}	2265	}
1843		2266
1844	package cf;	2267	package cf;
1845		2268
1846	=back	2269	=back
…		…
1865		2288
1866	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2289	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1867		2290
1868	if ($self->{record_replies}) {	2291	if ($self->{record_replies}) {
1869	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2292	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2293
1870	} else {	2294	} else {
		2295	my $pl = $self->contr;
		2296
		2297	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2298	my $dialog = $pl->{npc_dialog};
		2299	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2300
		2301	} else {
1871	$msg = $npc->name . " says: $msg" if $npc;	2302	$msg = $npc->name . " says: $msg" if $npc;
1872	$self->message ($msg, $flags);	2303	$self->message ($msg, $flags);
		2304	}
1873	}	2305	}
		2306	}
		2307
		2308	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2309
		2310	=cut
		2311
		2312	sub cf::object::send_msg {
		2313	my $pl = shift->contr
		2314	or return;
		2315	$pl->send_msg (@_);
1874	}	2316	}
1875		2317
1876	=item $player_object->may ("access")	2318	=item $player_object->may ("access")
1877		2319
1878	Returns wether the given player is authorized to access resource "access"	2320	Returns wether the given player is authorized to access resource "access"
…		…
1957	# use -1 or undef as default coordinates, not 0, 0	2399	# use -1 or undef as default coordinates, not 0, 0
1958	($x, $y) = ($map->enter_x, $map->enter_y)	2400	($x, $y) = ($map->enter_x, $map->enter_y)
1959	if $x <=0 && $y <= 0;	2401	if $x <=0 && $y <= 0;
1960		2402
1961	$map->load;	2403	$map->load;
1962	$map->load_diag;	2404	$map->load_neighbours;
1963		2405
1964	return unless $self->contr->active;	2406	return unless $self->contr->active;
1965	$self->activate_recursive;	2407	$self->activate_recursive;
1966		2408
1967	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2409	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1968	$self->enter_map ($map, $x, $y);	2410	$self->enter_map ($map, $x, $y);
1969	}	2411	}
1970		2412
1971	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2413	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1972		2414
1973	Moves the player to the given map-path and coordinates by first freezing	2415	Moves the player to the given map-path and coordinates by first freezing
1974	her, loading and preparing them map, calling the provided $check callback	2416	her, loading and preparing them map, calling the provided $check callback
1975	that has to return the map if sucecssful, and then unfreezes the player on	2417	that has to return the map if sucecssful, and then unfreezes the player on
1976	the new (success) or old (failed) map position.	2418	the new (success) or old (failed) map position. In either case, $done will
		2419	be called at the end of this process.
1977		2420
1978	=cut	2421	=cut
1979		2422
1980	our $GOTOGEN;	2423	our $GOTOGEN;
1981		2424
1982	sub cf::object::player::goto {	2425	sub cf::object::player::goto {
1983	my ($self, $path, $x, $y, $check) = @_;	2426	my ($self, $path, $x, $y, $check, $done) = @_;
1984		2427
1985	# do generation counting so two concurrent goto's will be executed in-order	2428	# do generation counting so two concurrent goto's will be executed in-order
1986	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2429	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1987		2430
1988	$self->enter_link;	2431	$self->enter_link;
…		…
2008		2451
2009	if ($gen == $self->{_goto_generation}) {	2452	if ($gen == $self->{_goto_generation}) {
2010	delete $self->{_goto_generation};	2453	delete $self->{_goto_generation};
2011	$self->leave_link ($map, $x, $y);	2454	$self->leave_link ($map, $x, $y);
2012	}	2455	}
		2456
		2457	$done->() if $done;
2013	})->prio (1);	2458	})->prio (1);
2014	}	2459	}
2015		2460
2016	=item $player_object->enter_exit ($exit_object)	2461	=item $player_object->enter_exit ($exit_object)
2017		2462
…		…
2086	my $hp = $exit->stats->hp;	2531	my $hp = $exit->stats->hp;
2087	my $sp = $exit->stats->sp;	2532	my $sp = $exit->stats->sp;
2088		2533
2089	$self->enter_link;	2534	$self->enter_link;
2090		2535
		2536	# if exit is damned, update players death & WoR home-position
		2537	$self->contr->savebed ($slaying, $hp, $sp)
		2538	if $exit->flag (FLAG_DAMNED);
		2539
2091	(async {	2540	(async {
2092	$self->deactivate_recursive; # just to be sure	2541	$self->deactivate_recursive; # just to be sure
2093	unless (eval {	2542	unless (eval {
2094	$self->goto ($slaying, $hp, $sp);	2543	$self->goto ($slaying, $hp, $sp);
2095		2544
…		…
2122		2571
2123	utf8::encode $text;	2572	utf8::encode $text;
2124	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2573	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2125	}	2574	}
2126		2575
		2576	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2577
		2578	Send a drawinfo or msg packet to the client, formatting the msg for the
		2579	client if neccessary. C<$type> should be a string identifying the type of
		2580	the message, with C<log> being the default. If C<$color> is negative, suppress
		2581	the message unless the client supports the msg packet.
		2582
		2583	=cut
		2584
		2585	our %CHANNEL = (
		2586	"c/identify" => {
		2587	id => "identify",
		2588	title => "Identify",
		2589	reply => undef,
		2590	tooltip => "Items recently identified",
		2591	},
		2592	"c/examine" => {
		2593	id => "examine",
		2594	title => "Examine",
		2595	reply => undef,
		2596	tooltip => "Signs and other items you examined",
		2597	},
		2598	);
		2599
		2600	sub cf::client::send_msg {
		2601	my ($self, $channel, $msg, $color, @extra) = @_;
		2602
		2603	$msg = $self->pl->expand_cfpod ($msg);
		2604
		2605	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2606
		2607	# check predefined channels, for the benefit of C
		2608	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2609
		2610	if (ref $channel) {
		2611	# send meta info to client, if not yet sent
		2612	unless (exists $self->{channel}{$channel->{id}}) {
		2613	$self->{channel}{$channel->{id}} = $channel;
		2614	$self->ext_msg (channel_info => $channel)
		2615	if $self->can_msg;
		2616	}
		2617
		2618	$channel = $channel->{id};
		2619	}
		2620
		2621	return unless @extra || length $msg;
		2622
		2623	if ($self->can_msg) {
		2624	# default colour, mask it out
		2625	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2626	if $color & cf::NDI_DEF;
		2627
		2628	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2629	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2630	} else {
		2631	if ($color >= 0) {
		2632	# replace some tags by gcfclient-compatible ones
		2633	for ($msg) {
		2634	1 while
		2635	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2636	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2637	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2638	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2639	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2640	}
		2641
		2642	$color &= cf::NDI_COLOR_MASK;
		2643
		2644	utf8::encode $msg;
		2645
		2646	if (0 && $msg =~ /\[/) {
		2647	# COMMAND/INFO
		2648	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2649	} else {
		2650	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2651	$self->send_packet ("drawinfo $color $msg")
		2652	}
		2653	}
		2654	}
		2655	}
		2656
2127	=item $client->ext_event ($type, %msg)	2657	=item $client->ext_msg ($type, @msg)
2128		2658
2129	Sends an exti event to the client.	2659	Sends an ext event to the client.
2130		2660
2131	=cut	2661	=cut
2132		2662
2133	sub cf::client::ext_event($$%) {	2663	sub cf::client::ext_msg($$@) {
2134	my ($self, $type, %msg) = @_;	2664	my ($self, $type, @msg) = @_;
2135		2665
		2666	if ($self->extcmd == 2) {
		2667	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2668	} elsif ($self->extcmd == 1) { # TODO: remove
2136	$msg{msgtype} = "event_$type";	2669	push @msg, msgtype => "event_$type";
2137	$self->send_packet ("ext " . cf::to_json \%msg);	2670	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2671	}
		2672	}
		2673
		2674	=item $client->ext_reply ($msgid, @msg)
		2675
		2676	Sends an ext reply to the client.
		2677
		2678	=cut
		2679
		2680	sub cf::client::ext_reply($$@) {
		2681	my ($self, $id, @msg) = @_;
		2682
		2683	if ($self->extcmd == 2) {
		2684	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2685	} elsif ($self->extcmd == 1) {
		2686	#TODO: version 1, remove
		2687	unshift @msg, msgtype => "reply", msgid => $id;
		2688	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2689	}
2138	}	2690	}
2139		2691
2140	=item $success = $client->query ($flags, "text", \&cb)	2692	=item $success = $client->query ($flags, "text", \&cb)
2141		2693
2142	Queues a query to the client, calling the given callback with	2694	Queues a query to the client, calling the given callback with
2143	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2695	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2144	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2696	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2145		2697
2146	Queries can fail, so check the return code. Or don't, as queries will become	2698	Queries can fail, so check the return code. Or don't, as queries will
2147	reliable at some point in the future.	2699	become reliable at some point in the future.
2148		2700
2149	=cut	2701	=cut
2150		2702
2151	sub cf::client::query {	2703	sub cf::client::query {
2152	my ($self, $flags, $text, $cb) = @_;	2704	my ($self, $flags, $text, $cb) = @_;
…		…
2160	utf8::encode $text;	2712	utf8::encode $text;
2161	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2713	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2162		2714
2163	$self->send_packet ($self->{query_queue}[0][0])	2715	$self->send_packet ($self->{query_queue}[0][0])
2164	if @{ $self->{query_queue} } == 1;	2716	if @{ $self->{query_queue} } == 1;
		2717
		2718	1
2165	}	2719	}
2166		2720
2167	cf::client->attach (	2721	cf::client->attach (
		2722	on_connect => sub {
		2723	my ($ns) = @_;
		2724
		2725	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2726	},
2168	on_reply => sub {	2727	on_reply => sub {
2169	my ($ns, $msg) = @_;	2728	my ($ns, $msg) = @_;
2170		2729
2171	# this weird shuffling is so that direct followup queries	2730	# this weird shuffling is so that direct followup queries
2172	# get handled first	2731	# get handled first
…		…
2184	} else {	2743	} else {
2185	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2744	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2186	}	2745	}
2187	}	2746	}
2188	},	2747	},
		2748	on_exticmd => sub {
		2749	my ($ns, $buf) = @_;
		2750
		2751	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2752
		2753	if (ref $msg) {
		2754	my ($type, $reply, @payload) =
		2755	"ARRAY" eq ref $msg
		2756	? @$msg
		2757	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2758
		2759	my @reply;
		2760
		2761	if (my $cb = $EXTICMD{$type}) {
		2762	@reply = $cb->($ns, @payload);
		2763	}
		2764
		2765	$ns->ext_reply ($reply, @reply)
		2766	if $reply;
		2767
		2768	} else {
		2769	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2770	}
		2771
		2772	cf::override;
		2773	},
2189	);	2774	);
2190		2775
2191	=item $client->async (\&cb)	2776	=item $client->async (\&cb)
2192		2777
2193	Create a new coroutine, running the specified callback. The coroutine will	2778	Create a new coroutine, running the specified callback. The coroutine will
…		…
2234	our $safe = new Safe "safe";	2819	our $safe = new Safe "safe";
2235	our $safe_hole = new Safe::Hole;	2820	our $safe_hole = new Safe::Hole;
2236		2821
2237	$SIG{FPE} = 'IGNORE';	2822	$SIG{FPE} = 'IGNORE';
2238		2823
2239	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2824	$safe->permit_only (Opcode::opset qw(
		2825	:base_core :base_mem :base_orig :base_math
		2826	grepstart grepwhile mapstart mapwhile
		2827	sort time
		2828	));
2240		2829
2241	# here we export the classes and methods available to script code	2830	# here we export the classes and methods available to script code
2242		2831
2243	=pod	2832	=pod
2244		2833
2245	The following functions and methods are available within a safe environment:	2834	The following functions and methods are available within a safe environment:
2246		2835
2247	cf::object contr pay_amount pay_player map	2836	cf::object
		2837	contr pay_amount pay_player map x y force_find force_add
		2838	insert remove name archname title slaying race decrease_ob_nr
		2839
2248	cf::object::player player	2840	cf::object::player
2249	cf::player peaceful	2841	player
2250	cf::map trigger	2842
		2843	cf::player
		2844	peaceful
		2845
		2846	cf::map
		2847	trigger
2251		2848
2252	=cut	2849	=cut
2253		2850
2254	for (	2851	for (
2255	["cf::object" => qw(contr pay_amount pay_player map)],	2852	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2853	insert remove inv name archname title slaying race
		2854	decrease_ob_nr)],
2256	["cf::object::player" => qw(player)],	2855	["cf::object::player" => qw(player)],
2257	["cf::player" => qw(peaceful)],	2856	["cf::player" => qw(peaceful)],
2258	["cf::map" => qw(trigger)],	2857	["cf::map" => qw(trigger)],
2259	) {	2858	) {
2260	no strict 'refs';	2859	no strict 'refs';
…		…
2331	=back	2930	=back
2332		2931
2333	=cut	2932	=cut
2334		2933
2335	#############################################################################	2934	#############################################################################
2336
2337	=head2 EXTENSION DATABASE SUPPORT
2338
2339	Crossfire maintains a very simple database for extension use. It can
2340	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2341	convert to/from binary).
2342
2343	The parameter C<$family> should best start with the name of the extension
2344	using it, it should be unique.
2345
2346	=over 4
2347
2348	=item $value = cf::db_get $family => $key
2349
2350	Returns a single value from the database.
2351
2352	=item cf::db_put $family => $key => $value
2353
2354	Stores the given C<$value> in the family.
2355
2356	=cut
2357
2358	our $DB;
2359
2360	sub db_init {
2361	unless ($DB) {
2362	$DB = BDB::db_create $DB_ENV;
2363
2364	cf::sync_job {
2365	eval {
2366	$DB->set_flags (BDB::CHKSUM);
2367
2368	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2369	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2370	cf::cleanup "db_open(db): $!" if $!;
2371	};
2372	cf::cleanup "db_open(db): $@" if $@;
2373	};
2374	}
2375	}
2376
2377	sub db_get($$) {
2378	my $key = "$_[0]/$_[1]";
2379
2380	cf::sync_job {
2381	BDB::db_get $DB, undef, $key, my $data;
2382
2383	$! ? ()
2384	: $data
2385	}
2386	}
2387
2388	sub db_put($$$) {
2389	BDB::dbreq_pri 4;
2390	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2391	}
2392
2393	=item cf::cache $id => [$paths...], $processversion => $process
2394
2395	Generic caching function that returns the value of the resource $id,
2396	caching and regenerating as required.
2397
2398	This function can block.
2399
2400	=cut
2401
2402	sub cache {
2403	my ($id, $src, $processversion, $process) = @_;
2404
2405	my $meta =
2406	join "\x00",
2407	$processversion,
2408	map {
2409	aio_stat $_
2410	and Carp::croak "$_: $!";
2411
2412	($_, (stat _)[7,9])
2413	} @$src;
2414
2415	my $dbmeta = db_get cache => "$id/meta";
2416	if ($dbmeta ne $meta) {
2417	# changed, we may need to process
2418
2419	my @data;
2420	my $md5;
2421
2422	for (0 .. $#$src) {
2423	0 <= aio_load $src->[$_], $data[$_]
2424	or Carp::croak "$src->[$_]: $!";
2425	}
2426
2427	# if processing is expensive, check
2428	# checksum first
2429	if (1) {
2430	$md5 =
2431	join "\x00",
2432	$processversion,
2433	map {
2434	Coro::cede;
2435	($src->[$_], Digest::MD5::md5_hex $data[$_])
2436	} 0.. $#$src;
2437
2438
2439	my $dbmd5 = db_get cache => "$id/md5";
2440	if ($dbmd5 eq $md5) {
2441	db_put cache => "$id/meta", $meta;
2442
2443	return db_get cache => "$id/data";
2444	}
2445	}
2446
2447	my $t1 = Time::HiRes::time;
2448	my $data = $process->(\@data);
2449	my $t2 = Time::HiRes::time;
2450
2451	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2452
2453	db_put cache => "$id/data", $data;
2454	db_put cache => "$id/md5" , $md5;
2455	db_put cache => "$id/meta", $meta;
2456
2457	return $data;
2458	}
2459
2460	db_get cache => "$id/data"
2461	}
2462
2463	=item fork_call { }, $args
2464
2465	Executes the given code block with the given arguments in a seperate
2466	process, returning the results. Everything must be serialisable with
2467	Coro::Storable. May, of course, block. Note that the executed sub may
2468	never block itself or use any form of Event handling.
2469
2470	=cut
2471
2472	sub fork_call(&@) {
2473	my ($cb, @args) = @_;
2474
2475	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2476	# or die "socketpair: $!";
2477	pipe my $fh1, my $fh2
2478	or die "pipe: $!";
2479
2480	if (my $pid = fork) {
2481	close $fh2;
2482
2483	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2484	$res = Coro::Storable::thaw $res;
2485
2486	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2487
2488	die $$res unless "ARRAY" eq ref $res;
2489
2490	return wantarray ? @$res : $res->[-1];
2491	} else {
2492	reset_signals;
2493	local $SIG{__WARN__};
2494	local $SIG{__DIE__};
2495	eval {
2496	close $fh1;
2497
2498	my @res = eval { $cb->(@args) };
2499	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2500	};
2501
2502	warn $@ if $@;
2503	_exit 0;
2504	}
2505	}
2506
2507	#############################################################################
2508	# the server's init and main functions	2935	# the server's init and main functions
2509		2936
2510	sub load_facedata($) {	2937	sub load_facedata($) {
2511	my ($path) = @_;	2938	my ($path) = @_;
		2939
		2940	# HACK to clear player env face cache, we need some signal framework
		2941	# for this (global event?)
		2942	%ext::player_env::MUSIC_FACE_CACHE = ();
		2943
		2944	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2512		2945
2513	warn "loading facedata from $path\n";	2946	warn "loading facedata from $path\n";
2514		2947
2515	my $facedata;	2948	my $facedata;
2516	0 < aio_load $path, $facedata	2949	0 < aio_load $path, $facedata
…		…
2519	$facedata = Coro::Storable::thaw $facedata;	2952	$facedata = Coro::Storable::thaw $facedata;
2520		2953
2521	$facedata->{version} == 2	2954	$facedata->{version} == 2
2522	or cf::cleanup "$path: version mismatch, cannot proceed.";	2955	or cf::cleanup "$path: version mismatch, cannot proceed.";
2523		2956
		2957	# patch in the exptable
		2958	$facedata->{resource}{"res/exp_table"} = {
		2959	type => FT_RSRC,
		2960	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2961	};
		2962	cf::cede_to_tick;
		2963
2524	{	2964	{
2525	my $faces = $facedata->{faceinfo};	2965	my $faces = $facedata->{faceinfo};
2526		2966
2527	while (my ($face, $info) = each %$faces) {	2967	while (my ($face, $info) = each %$faces) {
2528	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2968	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2529	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2969	cf::face::set_visibility $idx, $info->{visibility};
		2970	cf::face::set_magicmap $idx, $info->{magicmap};
2530	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2971	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2531	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2972	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2532	Coro::cede;	2973
		2974	cf::cede_to_tick;
2533	}	2975	}
2534		2976
2535	while (my ($face, $info) = each %$faces) {	2977	while (my ($face, $info) = each %$faces) {
2536	next unless $info->{smooth};	2978	next unless $info->{smooth};
2537	my $idx = cf::face::find $face	2979	my $idx = cf::face::find $face
2538	or next;	2980	or next;
2539	if (my $smooth = cf::face::find $info->{smooth}) {	2981	if (my $smooth = cf::face::find $info->{smooth}) {
		2982	cf::face::set_smooth $idx, $smooth;
2540	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2983	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2541	} else {	2984	} else {
2542	warn "smooth face '$info->{smooth}' not found for face '$face'";	2985	warn "smooth face '$info->{smooth}' not found for face '$face'";
2543	}	2986	}
2544	Coro::cede;	2987
		2988	cf::cede_to_tick;
2545	}	2989	}
2546	}	2990	}
2547		2991
2548	{	2992	{
2549	my $anims = $facedata->{animinfo};	2993	my $anims = $facedata->{animinfo};
2550		2994
2551	while (my ($anim, $info) = each %$anims) {	2995	while (my ($anim, $info) = each %$anims) {
2552	cf::anim::set $anim, $info->{frames}, $info->{facings};	2996	cf::anim::set $anim, $info->{frames}, $info->{facings};
2553	Coro::cede;	2997	cf::cede_to_tick;
2554	}	2998	}
2555		2999
2556	cf::anim::invalidate_all; # d'oh	3000	cf::anim::invalidate_all; # d'oh
2557	}	3001	}
2558		3002
		3003	{
		3004	# TODO: for gcfclient pleasure, we should give resources
		3005	# that gcfclient doesn't grok a >10000 face index.
		3006	my $res = $facedata->{resource};
		3007
		3008	my $soundconf = delete $res->{"res/sound.conf"};
		3009
		3010	while (my ($name, $info) = each %$res) {
		3011	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3012	my $data;
		3013
		3014	if ($info->{type} & 1) {
		3015	# prepend meta info
		3016
		3017	my $meta = $enc->encode ({
		3018	name => $name,
		3019	%{ $info->{meta} || {} },
		3020	});
		3021
		3022	$data = pack "(w/a*)*", $meta, $info->{data};
		3023	} else {
		3024	$data = $info->{data};
		3025	}
		3026
		3027	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3028	cf::face::set_type $idx, $info->{type};
		3029
		3030	cf::cede_to_tick;
		3031	}
		3032
		3033	if ($soundconf) {
		3034	$soundconf = $enc->decode (delete $soundconf->{data});
		3035
		3036	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3037	my $sound = $soundconf->{compat}[$_]
		3038	or next;
		3039
		3040	my $face = cf::face::find "sound/$sound->[1]";
		3041	cf::sound::set $sound->[0] => $face;
		3042	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3043	}
		3044
		3045	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3046	my $face = cf::face::find "sound/$v";
		3047	cf::sound::set $k => $face;
		3048	}
		3049	}
		3050	}
		3051
2559	1	3052	1
2560	}	3053	}
2561		3054
		3055	register_exticmd fx_want => sub {
		3056	my ($ns, $want) = @_;
		3057
		3058	while (my ($k, $v) = each %$want) {
		3059	$ns->fx_want ($k, $v);
		3060	}
		3061	};
		3062
2562	sub reload_regions {	3063	sub reload_regions {
		3064	# HACK to clear player env face cache, we need some signal framework
		3065	# for this (global event?)
		3066	%ext::player_env::MUSIC_FACE_CACHE = ();
		3067
2563	load_resource_file "$MAPDIR/regions"	3068	load_resource_file "$MAPDIR/regions"
2564	or die "unable to load regions file\n";	3069	or die "unable to load regions file\n";
		3070
		3071	for (cf::region::list) {
		3072	$_->{match} = qr/$_->{match}/
		3073	if exists $_->{match};
		3074	}
2565	}	3075	}
2566		3076
2567	sub reload_facedata {	3077	sub reload_facedata {
2568	load_facedata "$DATADIR/facedata"	3078	load_facedata "$DATADIR/facedata"
2569	or die "unable to load facedata\n";	3079	or die "unable to load facedata\n";
2570	}	3080	}
2571		3081
2572	sub reload_archetypes {	3082	sub reload_archetypes {
		3083	load_resource_file "$DATADIR/archetypes"
		3084	or die "unable to load archetypes\n";
		3085	#d# NEED to laod twice to resolve forward references
		3086	# this really needs to be done in an extra post-pass
		3087	# (which needs to be synchronous, so solve it differently)
2573	load_resource_file "$DATADIR/archetypes"	3088	load_resource_file "$DATADIR/archetypes"
2574	or die "unable to load archetypes\n";	3089	or die "unable to load archetypes\n";
2575	}	3090	}
2576		3091
2577	sub reload_treasures {	3092	sub reload_treasures {
…		…
2593		3108
2594	sub init {	3109	sub init {
2595	reload_resources;	3110	reload_resources;
2596	}	3111	}
2597		3112
2598	sub cfg_load {	3113	sub reload_config {
2599	open my $fh, "<:utf8", "$CONFDIR/config"	3114	open my $fh, "<:utf8", "$CONFDIR/config"
2600	or return;	3115	or return;
2601		3116
2602	local $/;	3117	local $/;
2603	*CFG = YAML::Syck::Load <$fh>;	3118	*CFG = YAML::Syck::Load <$fh>;
…		…
2623	(async {	3138	(async {
2624	Event::one_event;	3139	Event::one_event;
2625	})->prio (Coro::PRIO_MAX);	3140	})->prio (Coro::PRIO_MAX);
2626	};	3141	};
2627		3142
2628	cfg_load;	3143	reload_config;
2629	db_init;	3144	db_init;
2630	load_extensions;	3145	load_extensions;
2631		3146
2632	$TICK_WATCHER->start;	3147	$TICK_WATCHER->start;
2633	Event::loop;	3148	Event::loop;
…		…
2649	},	3164	},
2650	);	3165	);
2651	}	3166	}
2652	}	3167	}
2653		3168
		3169	sub write_runtime {
		3170	my $runtime = "$LOCALDIR/runtime";
		3171
		3172	# first touch the runtime file to show we are still running:
		3173	# the fsync below can take a very very long time.
		3174
		3175	IO::AIO::aio_utime $runtime, undef, undef;
		3176
		3177	my $guard = cf::lock_acquire "write_runtime";
		3178
		3179	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3180	or return;
		3181
		3182	my $value = $cf::RUNTIME + 90 + 10;
		3183	# 10 is the runtime save interval, for a monotonic clock
		3184	# 60 allows for the watchdog to kill the server.
		3185
		3186	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3187	and return;
		3188
		3189	# always fsync - this file is important
		3190	aio_fsync $fh
		3191	and return;
		3192
		3193	# touch it again to show we are up-to-date
		3194	aio_utime $fh, undef, undef;
		3195
		3196	close $fh
		3197	or return;
		3198
		3199	aio_rename "$runtime~", $runtime
		3200	and return;
		3201
		3202	warn "runtime file written.\n";
		3203
		3204	1
		3205	}
		3206
2654	sub emergency_save() {	3207	sub emergency_save() {
2655	my $freeze_guard = cf::freeze_mainloop;	3208	my $freeze_guard = cf::freeze_mainloop;
2656		3209
2657	warn "enter emergency perl save\n";	3210	warn "enter emergency perl save\n";
2658		3211
…		…
2733	%EXT_CORO = ();	3286	%EXT_CORO = ();
2734		3287
2735	warn "removing commands";	3288	warn "removing commands";
2736	%COMMAND = ();	3289	%COMMAND = ();
2737		3290
2738	warn "removing ext commands";	3291	warn "removing ext/exti commands";
2739	%EXTCMD = ();	3292	%EXTCMD = ();
		3293	%EXTICMD = ();
2740		3294
2741	warn "unloading/nuking all extensions";	3295	warn "unloading/nuking all extensions";
2742	for my $pkg (@EXTS) {	3296	for my $pkg (@EXTS) {
2743	warn "... unloading $pkg";	3297	warn "... unloading $pkg";
2744		3298
…		…
2787	warn "reloading cf.pm";	3341	warn "reloading cf.pm";
2788	require cf;	3342	require cf;
2789	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3343	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2790		3344
2791	warn "loading config and database again";	3345	warn "loading config and database again";
2792	cf::cfg_load;	3346	cf::reload_config;
2793		3347
2794	warn "loading extensions";	3348	warn "loading extensions";
2795	cf::load_extensions;	3349	cf::load_extensions;
2796		3350
2797	warn "reattaching attachments to objects/players";	3351	warn "reattaching attachments to objects/players";
…		…
2890	or die;	3444	or die;
2891		3445
2892	$map->width (50);	3446	$map->width (50);
2893	$map->height (50);	3447	$map->height (50);
2894	$map->alloc;	3448	$map->alloc;
2895	$map->_load_objects ("/tmp/x.map", 1);	3449	$map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
2896	my $t = Event::time - $t;	3450	my $t = Event::time - $t;
2897		3451
2898	#next unless $t < 0.0013;#d#	3452	#next unless $t < 0.0013;#d#
2899	if ($t < $min) {	3453	if ($t < $min) {
2900	$min = $t;	3454	$min = $t;

Diff Legend

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