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.275 by root, Thu Jun 7 19:12:22 2007 UTC vs.
Revision 1.326 by root, Tue Jul 31 17:33:15 2007 UTC

…		…
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		24
		25	use JSON::XS 1.4 ();
25	use BDB ();	26	use BDB ();
26	use Data::Dumper;	27	use Data::Dumper;
27	use Digest::MD5;	28	use Digest::MD5;
28	use Fcntl;	29	use Fcntl;
29	use YAML::Syck ();	30	use YAML::Syck ();
30	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
31	use Time::HiRes;	32	use Time::HiRes;
32	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
33		35
34	# configure various modules to our taste	36	# configure various modules to our taste
35	#	37	#
36	$Storable::canonical = 1; # reduce rsync transfers	38	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	51	our %COMMAND = ();
50	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
51		53
52	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
56		59
57	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
58	our @EVENT;	61	our @EVENT;
…		…
164		167
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	168	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	169	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.	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
		177
169	=back	178	=back
170		179
171	=cut	180	=cut
172		181
173	BEGIN {	182	BEGIN {
…		…
206	}	215	}
207		216
208	$Event::DIED = sub {	217	$Event::DIED = sub {
209	warn "error in event callback: @_";	218	warn "error in event callback: @_";
210	};	219	};
		220
		221	#############################################################################
211		222
212	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
213		224
214	=over 4	225	=over 4
215		226
…		…
234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235	$d	246	$d
236	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
237	}	248	}
238		249
239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
242		251
243	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
244		253
245	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
246		255
247	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
248		264
249	=item cf::lock_wait $string	265	=item cf::lock_wait $string
250		266
251	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
252		268
…		…
306	};	322	};
307	$TICK_WATCHER->stop;	323	$TICK_WATCHER->stop;
308	$guard	324	$guard
309	}	325	}
310		326
		327	=item cf::get_slot $time[, $priority[, $name]]
		328
		329	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		330	This call blocks and returns only when you have at least C<$time> seconds
		331	of cpu time till the next tick. The slot is only valid till the next cede.
		332
		333	The optional C<$name> can be used to identify the job to run. It might be
		334	used for statistical purposes and should identify the same time-class.
		335
		336	Useful for short background jobs.
		337
		338	=cut
		339
		340	our @SLOT_QUEUE;
		341	our $SLOT_QUEUE;
		342
		343	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		344	$SLOT_QUEUE = Coro::async {
		345	my $signal = new Coro::Signal;
		346
		347	while () {
		348	next_job:
		349	my $avail = cf::till_tick;
		350	if ($avail > 0.01) {
		351	for (0 .. $#SLOT_QUEUE) {
		352	if ($SLOT_QUEUE[$_][0] < $avail) {
		353	my $job = splice @SLOT_QUEUE, $_, 1, ();
		354	$job->[2]->send;
		355	Coro::cede;
		356	goto next_job;
		357	}
		358	}
		359	}
		360
		361	if (@SLOT_QUEUE) {
		362	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		363	push @cf::WAIT_FOR_TICK, $signal;
		364	$signal->wait;
		365	} else {
		366	Coro::schedule;
		367	}
		368	}
		369	};
		370
		371	sub get_slot($;$$) {
		372	my ($time, $pri, $name) = @_;
		373
		374	$time = $TICK * .6 if $time > $TICK * .6;
		375	my $sig = new Coro::Signal;
		376
		377	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		378	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		379	$SLOT_QUEUE->ready;
		380	$sig->wait;
		381	}
		382
311	=item cf::async { BLOCK }	383	=item cf::async { BLOCK }
312		384
313	Currently the same as Coro::async_pool, meaning you cannot use	385	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	386	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.	387	thing you are allowed to do is call C<prio> on it.
…		…
318		390
319	BEGIN { *async = \&Coro::async_pool }	391	BEGIN { *async = \&Coro::async_pool }
320		392
321	=item cf::sync_job { BLOCK }	393	=item cf::sync_job { BLOCK }
322		394
323	The design of crossfire+ requires that the main coro ($Coro::main) is	395	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	396	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.	397	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		398	acceptable.
326		399
327	If it must be done, put the blocking parts into C<sync_job>. This will run	400	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	401	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	402	server will be frozen during this time, so the block should either finish
330	fast or be very important.	403	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	463	$EXT_CORO{$coro+0} = $coro;
391		464
392	$coro	465	$coro
393	}	466	}
394		467
395	sub write_runtime {	468	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		469
398	# first touch the runtime file to show we are still running:	470	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	471	process, returning the results. Everything must be serialisable with
		472	Coro::Storable. May, of course, block. Note that the executed sub may
		473	never block itself or use any form of Event handling.
400		474
401	IO::AIO::aio_utime $runtime, undef, undef;	475	=cut
402		476
403	my $guard = cf::lock_acquire "write_runtime";	477	sub _store_scalar {
404		478	open my $fh, ">", \my $buf
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	479	or die "fork_call: cannot open fh-to-buf in child : $!";
406	or return;	480	Storable::store_fd $_[0], $fh;
407
408	my $value = $cf::RUNTIME + 90 + 10;
409	# 10 is the runtime save interval, for a monotonic clock
410	# 60 allows for the watchdog to kill the server.
411
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0
413	and return;
414
415	# always fsync - this file is important
416	aio_fsync $fh
417	and return;
418
419	# touch it again to show we are up-to-date
420	aio_utime $fh, undef, undef;
421
422	close $fh	481	close $fh;
423	or return;
424		482
425	aio_rename "$runtime~", $runtime	483	$buf
426	and return;	484	}
427		485
428	warn "runtime file written.\n";	486	sub fork_call(&@) {
		487	my ($cb, @args) = @_;
429		488
		489	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		490	# or die "socketpair: $!";
		491	pipe my $fh1, my $fh2
		492	or die "pipe: $!";
		493
		494	if (my $pid = fork) {
		495	close $fh2;
		496
		497	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		498	warn "pst<$res>" unless $res =~ /^pst/;
		499	$res = Coro::Storable::thaw $res;
		500
		501	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		502
		503	Carp::confess $$res unless "ARRAY" eq ref $res;
		504
		505	return wantarray ? @$res : $res->[-1];
		506	} else {
		507	reset_signals;
		508	local $SIG{__WARN__};
		509	local $SIG{__DIE__};
		510	# just in case, this hack effectively disables event
		511	# in the child. cleaner and slower would be canceling all watchers,
		512	# but this works for the time being.
		513	local $Coro::idle;
		514	$Coro::current->prio (Coro::PRIO_MAX);
		515
		516	eval {
		517	close $fh1;
		518
		519	my @res = eval { $cb->(@args) };
		520
		521	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		522	close $fh2;
		523	};
		524
		525	warn $@ if $@;
		526	_exit 0;
430	1	527	}
		528	}
		529
		530	=item $value = cf::db_get $family => $key
		531
		532	Returns a single value from the environment database.
		533
		534	=item cf::db_put $family => $key => $value
		535
		536	Stores the given C<$value> in the family. It can currently store binary
		537	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		538
		539	=cut
		540
		541	our $DB;
		542
		543	sub db_init {
		544	unless ($DB) {
		545	$DB = BDB::db_create $DB_ENV;
		546
		547	cf::sync_job {
		548	eval {
		549	$DB->set_flags (BDB::CHKSUM);
		550
		551	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		552	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		553	cf::cleanup "db_open(db): $!" if $!;
		554	};
		555	cf::cleanup "db_open(db): $@" if $@;
		556	};
		557	}
		558	}
		559
		560	sub db_get($$) {
		561	my $key = "$_[0]/$_[1]";
		562
		563	cf::sync_job {
		564	BDB::db_get $DB, undef, $key, my $data;
		565
		566	$! ? ()
		567	: $data
		568	}
		569	}
		570
		571	sub db_put($$$) {
		572	BDB::dbreq_pri 4;
		573	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		574	}
		575
		576	=item cf::cache $id => [$paths...], $processversion => $process
		577
		578	Generic caching function that returns the value of the resource $id,
		579	caching and regenerating as required.
		580
		581	This function can block.
		582
		583	=cut
		584
		585	sub cache {
		586	my ($id, $src, $processversion, $process) = @_;
		587
		588	my $meta =
		589	join "\x00",
		590	$processversion,
		591	map {
		592	aio_stat $_
		593	and Carp::croak "$_: $!";
		594
		595	($_, (stat _)[7,9])
		596	} @$src;
		597
		598	my $dbmeta = db_get cache => "$id/meta";
		599	if ($dbmeta ne $meta) {
		600	# changed, we may need to process
		601
		602	my @data;
		603	my $md5;
		604
		605	for (0 .. $#$src) {
		606	0 <= aio_load $src->[$_], $data[$_]
		607	or Carp::croak "$src->[$_]: $!";
		608	}
		609
		610	# if processing is expensive, check
		611	# checksum first
		612	if (1) {
		613	$md5 =
		614	join "\x00",
		615	$processversion,
		616	map {
		617	Coro::cede;
		618	($src->[$_], Digest::MD5::md5_hex $data[$_])
		619	} 0.. $#$src;
		620
		621
		622	my $dbmd5 = db_get cache => "$id/md5";
		623	if ($dbmd5 eq $md5) {
		624	db_put cache => "$id/meta", $meta;
		625
		626	return db_get cache => "$id/data";
		627	}
		628	}
		629
		630	my $t1 = Time::HiRes::time;
		631	my $data = $process->(\@data);
		632	my $t2 = Time::HiRes::time;
		633
		634	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		635
		636	db_put cache => "$id/data", $data;
		637	db_put cache => "$id/md5" , $md5;
		638	db_put cache => "$id/meta", $meta;
		639
		640	return $data;
		641	}
		642
		643	db_get cache => "$id/data"
431	}	644	}
432		645
433	=item cf::datalog type => key => value, ...	646	=item cf::datalog type => key => value, ...
434		647
435	Log a datalog packet of the given type with the given key-value pairs.	648	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")	666	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	667	to it. All such attachable objects support the following methods.
455		668
456	In the following description, CLASS can be any of C<global>, C<object>	669	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	670	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	671	Crossfire TRT).
459		672
460	=over 4	673	=over 4
461		674
462	=item $attachable->attach ($attachment, key => $value...)	675	=item $attachable->attach ($attachment, key => $value...)
463		676
…		…
665	_attach $registry, $klass, @attach;	878	_attach $registry, $klass, @attach;
666	}	879	}
667		880
668	$obj->{$name} = \%arg;	881	$obj->{$name} = \%arg;
669	} else {	882	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	883	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	884	}
672		885
673	$obj->{_attachment}{$name} = undef;	886	$obj->{_attachment}{$name} = undef;
674	}	887	}
675		888
…		…
715	";	928	";
716	die if $@;	929	die if $@;
717	}	930	}
718		931
719	our $override;	932	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	933	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		934
722	sub override {	935	sub override {
723	$override = 1;	936	$override = 1;
724	@invoke_results = ();	937	@INVOKE_RESULTS = (@_);
725	}	938	}
726		939
727	sub do_invoke {	940	sub do_invoke {
728	my $event = shift;	941	my $event = shift;
729	my $callbacks = shift;	942	my $callbacks = shift;
730		943
731	@invoke_results = ();	944	@INVOKE_RESULTS = ();
732		945
733	local $override;	946	local $override;
734		947
735	for (@$callbacks) {	948	for (@$callbacks) {
736	eval { &{$_->[1]} };	949	eval { &{$_->[1]} };
…		…
753		966
754	Generate an object-specific event with the given arguments.	967	Generate an object-specific event with the given arguments.
755		968
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	969	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	970	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	971	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		972
760	=back	973	=back
761		974
762	=cut	975	=cut
763		976
764	#############################################################################	977	#############################################################################
765	# object support	978	# object support
		979	#
		980
		981	sub _can_merge {
		982	my ($ob1, $ob2) = @_;
		983
		984	local $Storable::canonical = 1;
		985	my $fob1 = Storable::freeze $ob1;
		986	my $fob2 = Storable::freeze $ob2;
		987
		988	$fob1 eq $fob2
		989	}
766		990
767	sub reattach {	991	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	992	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	993	my ($obj) = @_;
770		994
…		…
877	warn sprintf "loading %s (%d)\n",	1101	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1102	$filename, length $data, scalar @{$av || []};
879	return ($data, $av);	1103	return ($data, $av);
880	}	1104	}
881		1105
		1106	=head2 COMMAND CALLBACKS
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
882	#############################################################################	1112	#############################################################################
883	# command handling &c	1113	# command handling &c
884		1114
885	=item cf::register_command $name => \&callback($ob,$args);	1115	=item cf::register_command $name => \&callback($ob,$args);
886		1116
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1128	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1129	}
900		1130
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1131	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1132
903	Register a callbackf ro execution when the client sends an extcmd packet.	1133	Register a callback for execution when the client sends an (synchronous)
		1134	extcmd packet. Ext commands will be processed in the order they are
		1135	received by the server, like other user commands. The first argument is
		1136	the logged-in player. Ext commands can only be processed after a player
		1137	has logged in successfully.
904		1138
905	If the callback returns something, it is sent back as if reply was being	1139	If the callback returns something, it is sent back as if reply was being
906	called.	1140	called.
907		1141
		1142	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1143
		1144	Register a callback for execution when the client sends an (asynchronous)
		1145	exticmd packet. Exti commands are processed by the server as soon as they
		1146	are received, i.e. out of order w.r.t. other commands. The first argument
		1147	is a client socket. Exti commands can be received anytime, even before
		1148	log-in.
		1149
		1150	If the callback returns something, it is sent back as if reply was being
		1151	called.
		1152
908	=cut	1153	=cut
909		1154
910	sub register_extcmd {	1155	sub register_extcmd {
911	my ($name, $cb) = @_;	1156	my ($name, $cb) = @_;
912		1157
913	$EXTCMD{$name} = $cb;	1158	$EXTCMD{$name} = $cb;
		1159	}
		1160
		1161	sub register_exticmd {
		1162	my ($name, $cb) = @_;
		1163
		1164	$EXTICMD{$name} = $cb;
914	}	1165	}
915		1166
916	cf::player->attach (	1167	cf::player->attach (
917	on_command => sub {	1168	on_command => sub {
918	my ($pl, $name, $params) = @_;	1169	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1178	cf::override;
928	},	1179	},
929	on_extcmd => sub {	1180	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1181	my ($pl, $buf) = @_;
931		1182
932	my $msg = eval { from_json $buf };	1183	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1184
934	if (ref $msg) {	1185	if (ref $msg) {
		1186	my ($type, $reply, @payload) =
		1187	"ARRAY" eq ref $msg
		1188	? @$msg
		1189	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1190
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1192	my @reply = $cb->($pl, @payload);
		1193
937	$pl->ext_reply ($msg->{msgid}, %reply);	1194	$pl->ext_reply ($reply, @reply)
938	}	1195	if $reply;
939	}	1196	}
940	} else {	1197	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1198	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1199	}
943		1200
944	cf::override;	1201	cf::override;
945	},	1202	},
946	);	1203	);
947		1204
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 {	1205	sub load_extensions {
		1206	cf::sync_job {
		1207	my %todo;
		1208
983	for my $ext (<$LIBDIR/*.ext>) {	1209	for my $path (<$LIBDIR/*.ext>) {
984	next unless -r $ext;	1210	next unless -r $path;
985	eval {	1211
986	load_extension $ext;	1212	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1213	my $base = $1;
		1214	my $pkg = $1;
		1215	$pkg =~ s/[^[:word:]]/_/g;
		1216	$pkg = "ext::$pkg";
		1217
		1218	open my $fh, "<:utf8", $path
		1219	or die "$path: $!";
		1220
		1221	my $source = do { local $/; <$fh> };
		1222
		1223	my %ext = (
		1224	path => $path,
		1225	base => $base,
		1226	pkg => $pkg,
		1227	);
		1228
		1229	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1230	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1231
		1232	$ext{source} =
		1233	"package $pkg; use strict; use utf8;\n"
		1234	. "#line 1 \"$path\"\n{\n"
		1235	. $source
		1236	. "\n};\n1";
		1237
		1238	$todo{$base} = \%ext;
		1239	}
		1240
		1241	my %done;
		1242	while (%todo) {
		1243	my $progress;
		1244
		1245	while (my ($k, $v) = each %todo) {
		1246	for (split /,\s*/, $v->{meta}{depends}) {
		1247	goto skip
		1248	unless exists $done{$_};
		1249	}
		1250
		1251	warn "... loading '$k' into '$v->{pkg}'\n";
		1252
		1253	unless (eval $v->{source}) {
		1254	my $msg = $@ ? "$v->{path}: $@\n"
		1255	: "$v->{base}: extension inactive.\n";
		1256
		1257	if (exists $v->{meta}{mandatory}) {
		1258	warn $msg;
		1259	warn "mandatory extension failed to load, exiting.\n";
		1260	exit 1;
		1261	}
		1262
		1263	warn $msg;
		1264	}
		1265
		1266	$done{$k} = delete $todo{$k};
		1267	push @EXTS, $v->{pkg};
		1268	$progress = 1;
987	1	1269	}
988	} or warn "$ext not loaded: $@";	1270
		1271	skip:
		1272	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1273	unless $progress;
		1274	}
989	}	1275	};
990	}	1276	}
991		1277
992	#############################################################################	1278	#############################################################################
		1279
		1280	=back
993		1281
994	=head2 CORE EXTENSIONS	1282	=head2 CORE EXTENSIONS
995		1283
996	Functions and methods that extend core crossfire objects.	1284	Functions and methods that extend core crossfire objects.
997		1285
…		…
1185	}	1473	}
1186		1474
1187	\@paths	1475	\@paths
1188	}	1476	}
1189		1477
		1478	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1479
		1480	Expand crossfire pod fragments into protocol xml.
		1481
		1482	=cut
		1483
		1484	sub expand_cfpod {
		1485	((my $self), (local $_)) = @_;
		1486
		1487	# escape & and <
		1488	s/&/&amp;/g;
		1489	s/(?<![BIUGH])</&lt;/g;
		1490
		1491	# this is buggy, it needs to properly take care of nested <'s
		1492
		1493	1 while
		1494	# replace B<>, I<>, U<> etc.
		1495	s/B<([^\>]*)>/<b>$1<\/b>/
		1496	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1497	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1498	# replace G<male|female> tags
		1499	|| s{G<([^>|]*)\|([^>]*)>}{
		1500	$self->gender ? $2 : $1
		1501	}ge
		1502	# replace H<hint text>
		1503	|| s{H<([^\>]*)>}
		1504	{
		1505	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1506	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1507	"")
		1508	[$self->{hintmode}]
		1509	}ge;
		1510
		1511	# create single paragraphs (very hackish)
		1512	s/(?<=\S)\n(?=\w)/ /g;
		1513
		1514	# compress some whitespace
		1515	s/\s+\n/\n/g; # ws line-ends
		1516	s/\n\n+/\n/g; # double lines
		1517	s/^\n+//; # beginning lines
		1518	s/\n+$//; # ending lines
		1519
		1520	$_
		1521	}
		1522
		1523	sub hintmode {
		1524	$_[0]{hintmode} = $_[1] if @_ > 1;
		1525	$_[0]{hintmode}
		1526	}
		1527
1190	=item $player->ext_reply ($msgid, %msg)	1528	=item $player->ext_reply ($msgid, @msg)
1191		1529
1192	Sends an ext reply to the player.	1530	Sends an ext reply to the player.
1193		1531
1194	=cut	1532	=cut
1195		1533
1196	sub ext_reply($$%) {	1534	sub ext_reply($$@) {
1197	my ($self, $id, %msg) = @_;	1535	my ($self, $id, @msg) = @_;
1198		1536
1199	$msg{msgid} = $id;	1537	if ($self->ns->extcmd == 2) {
1200		1538	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1201	$self->send ("ext " . cf::to_json \%msg);	1539	} elsif ($self->ns->extcmd == 1) {
		1540	#TODO: version 1, remove
		1541	unshift @msg, msgtype => "reply", msgid => $id;
		1542	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1543	}
1202	}	1544	}
1203		1545
1204	=item $player->ext_event ($type, %msg)	1546	=item $player->ext_msg ($type, @msg)
1205		1547
1206	Sends an ext event to the client.	1548	Sends an ext event to the client.
1207		1549
1208	=cut	1550	=cut
1209		1551
1210	sub ext_event($$%) {	1552	sub ext_msg($$@) {
1211	my ($self, $type, %msg) = @_;	1553	my ($self, $type, @msg) = @_;
1212		1554
1213	$self->ns->ext_event ($type, %msg);	1555	$self->ns->ext_msg ($type, @msg);
1214	}	1556	}
1215		1557
1216	=head3 cf::region	1558	=head3 cf::region
1217		1559
1218	=over 4	1560	=over 4
…		…
1221		1563
1222	package cf::region;	1564	package cf::region;
1223		1565
1224	=item cf::region::find_by_path $path	1566	=item cf::region::find_by_path $path
1225		1567
1226	Tries to decuce the probable region for a map knowing only its path.	1568	Tries to decuce the likely region for a map knowing only its path.
1227		1569
1228	=cut	1570	=cut
1229		1571
1230	sub find_by_path($) {	1572	sub find_by_path($) {
1231	my ($path) = @_;	1573	my ($path) = @_;
1232		1574
1233	my ($match, $specificity);	1575	my ($match, $specificity);
1234		1576
1235	for my $region (list) {	1577	for my $region (list) {
1236	if ($region->match && $path =~ $region->match) {	1578	if ($region->{match} && $path =~ $region->{match}) {
1237	($match, $specificity) = ($region, $region->specificity)	1579	($match, $specificity) = ($region, $region->specificity)
1238	if $region->specificity > $specificity;	1580	if $region->specificity > $specificity;
1239	}	1581	}
1240	}	1582	}
1241		1583
…		…
1361	$self->init; # pass $1 etc.	1703	$self->init; # pass $1 etc.
1362	return $self;	1704	return $self;
1363	}	1705	}
1364	}	1706	}
1365		1707
1366	Carp::carp "unable to resolve path '$path' (base '$base').";	1708	Carp::cluck "unable to resolve path '$path' (base '$base').";
1367	()	1709	()
1368	}	1710	}
1369		1711
1370	sub init {	1712	sub init {
1371	my ($self) = @_;	1713	my ($self) = @_;
…		…
1579	$self->set_darkness_map;	1921	$self->set_darkness_map;
1580	Coro::cede;	1922	Coro::cede;
1581	$self->activate;	1923	$self->activate;
1582	}	1924	}
1583		1925
		1926	$self->{last_save} = $cf::RUNTIME;
		1927	$self->last_access ($cf::RUNTIME);
		1928
1584	$self->in_memory (cf::MAP_IN_MEMORY);	1929	$self->in_memory (cf::MAP_IN_MEMORY);
1585	}	1930	}
1586		1931
1587	$self->post_load;	1932	$self->post_load;
1588	}	1933	}
…		…
1649		1994
1650	undef $MAP_PREFETCH{$path};	1995	undef $MAP_PREFETCH{$path};
1651	$MAP_PREFETCHER ||= cf::async {	1996	$MAP_PREFETCHER ||= cf::async {
1652	while (%MAP_PREFETCH) {	1997	while (%MAP_PREFETCH) {
1653	for my $path (keys %MAP_PREFETCH) {	1998	for my $path (keys %MAP_PREFETCH) {
1654	my $map = find $path	1999	if (my $map = find $path) {
1655	or next;
1656	$map->load;	2000	$map->load;
		2001	}
1657		2002
1658	delete $MAP_PREFETCH{$path};	2003	delete $MAP_PREFETCH{$path};
1659	}	2004	}
1660	}	2005	}
1661	undef $MAP_PREFETCHER;	2006	undef $MAP_PREFETCHER;
…		…
1776	$cf::MAP{$self->path} = $self;	2121	$cf::MAP{$self->path} = $self;
1777		2122
1778	$self->reset; # polite request, might not happen	2123	$self->reset; # polite request, might not happen
1779	}	2124	}
1780		2125
		2126	=item $maps = cf::map::tmp_maps
		2127
		2128	Returns an arrayref with all map paths of currently instantiated and saved
		2129	maps. May block.
		2130
		2131	=cut
		2132
		2133	sub tmp_maps() {
		2134	[
		2135	map {
		2136	utf8::decode $_;
		2137	/\.map$/
		2138	? normalise $_
		2139	: ()
		2140	} @{ aio_readdir $TMPDIR or [] }
		2141	]
		2142	}
		2143
		2144	=item $maps = cf::map::random_maps
		2145
		2146	Returns an arrayref with all map paths of currently instantiated and saved
		2147	random maps. May block.
		2148
		2149	=cut
		2150
		2151	sub random_maps() {
		2152	[
		2153	map {
		2154	utf8::decode $_;
		2155	/\.map$/
		2156	? normalise "?random/$_"
		2157	: ()
		2158	} @{ aio_readdir $RANDOMDIR or [] }
		2159	]
		2160	}
		2161
1781	=item cf::map::unique_maps	2162	=item cf::map::unique_maps
1782		2163
1783	Returns an arrayref of paths of all shared maps that have	2164	Returns an arrayref of paths of all shared maps that have
1784	instantiated unique items. May block.	2165	instantiated unique items. May block.
1785		2166
1786	=cut	2167	=cut
1787		2168
1788	sub unique_maps() {	2169	sub unique_maps() {
1789	my $files = aio_readdir $UNIQUEDIR	2170	[
1790	or return;	2171	map {
1791
1792	my @paths;
1793
1794	for (@$files) {
1795	utf8::decode $_;	2172	utf8::decode $_;
1796	next if /\.pst$/;	2173	/\.map$/
1797	next unless /^$PATH_SEP/o;	2174	? normalise $_
1798		2175	: ()
1799	push @paths, cf::map::normalise $_;	2176	} @{ aio_readdir $UNIQUEDIR or [] }
1800	}	2177	]
1801
1802	\@paths
1803	}	2178	}
1804		2179
1805	package cf;	2180	package cf;
1806		2181
1807	=back	2182	=back
…		…
1853		2228
1854	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2229	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1855		2230
1856	if ($self->{record_replies}) {	2231	if ($self->{record_replies}) {
1857	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2232	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2233
1858	} else {	2234	} else {
		2235	my $pl = $self->contr;
		2236
		2237	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2238	my $dialog = $pl->{npc_dialog};
		2239	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2240
		2241	} else {
1859	$msg = $npc->name . " says: $msg" if $npc;	2242	$msg = $npc->name . " says: $msg" if $npc;
1860	$self->message ($msg, $flags);	2243	$self->message ($msg, $flags);
		2244	}
1861	}	2245	}
1862	}	2246	}
1863		2247
1864	=item $player_object->may ("access")	2248	=item $player_object->may ("access")
1865		2249
…		…
1954		2338
1955	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2339	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1956	$self->enter_map ($map, $x, $y);	2340	$self->enter_map ($map, $x, $y);
1957	}	2341	}
1958		2342
1959	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2343	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1960		2344
1961	Moves the player to the given map-path and coordinates by first freezing	2345	Moves the player to the given map-path and coordinates by first freezing
1962	her, loading and preparing them map, calling the provided $check callback	2346	her, loading and preparing them map, calling the provided $check callback
1963	that has to return the map if sucecssful, and then unfreezes the player on	2347	that has to return the map if sucecssful, and then unfreezes the player on
1964	the new (success) or old (failed) map position.	2348	the new (success) or old (failed) map position. In either case, $done will
		2349	be called at the end of this process.
1965		2350
1966	=cut	2351	=cut
1967		2352
1968	our $GOTOGEN;	2353	our $GOTOGEN;
1969		2354
1970	sub cf::object::player::goto {	2355	sub cf::object::player::goto {
1971	my ($self, $path, $x, $y, $check) = @_;	2356	my ($self, $path, $x, $y, $check, $done) = @_;
1972		2357
1973	# do generation counting so two concurrent goto's will be executed in-order	2358	# do generation counting so two concurrent goto's will be executed in-order
1974	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2359	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1975		2360
1976	$self->enter_link;	2361	$self->enter_link;
…		…
1996		2381
1997	if ($gen == $self->{_goto_generation}) {	2382	if ($gen == $self->{_goto_generation}) {
1998	delete $self->{_goto_generation};	2383	delete $self->{_goto_generation};
1999	$self->leave_link ($map, $x, $y);	2384	$self->leave_link ($map, $x, $y);
2000	}	2385	}
		2386
		2387	$done->() if $done;
2001	})->prio (1);	2388	})->prio (1);
2002	}	2389	}
2003		2390
2004	=item $player_object->enter_exit ($exit_object)	2391	=item $player_object->enter_exit ($exit_object)
2005		2392
…		…
2074	my $hp = $exit->stats->hp;	2461	my $hp = $exit->stats->hp;
2075	my $sp = $exit->stats->sp;	2462	my $sp = $exit->stats->sp;
2076		2463
2077	$self->enter_link;	2464	$self->enter_link;
2078		2465
		2466	# if exit is damned, update players death & WoR home-position
		2467	$self->contr->savebed ($slaying, $hp, $sp)
		2468	if $exit->flag (FLAG_DAMNED);
		2469
2079	(async {	2470	(async {
2080	$self->deactivate_recursive; # just to be sure	2471	$self->deactivate_recursive; # just to be sure
2081	unless (eval {	2472	unless (eval {
2082	$self->goto ($slaying, $hp, $sp);	2473	$self->goto ($slaying, $hp, $sp);
2083		2474
…		…
2110		2501
2111	utf8::encode $text;	2502	utf8::encode $text;
2112	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2503	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2113	}	2504	}
2114		2505
		2506	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2507
		2508	Send a drawinfo or msg packet to the client, formatting the msg for the
		2509	client if neccessary. C<$type> should be a string identifying the type of
		2510	the message, with C<log> being the default. If C<$color> is negative, suppress
		2511	the message unless the client supports the msg packet.
		2512
		2513	=cut
		2514
		2515	sub cf::client::send_msg {
		2516	my ($self, $channel, $msg, $color, @extra) = @_;
		2517
		2518	$msg = $self->pl->expand_cfpod ($msg);
		2519
		2520	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2521
		2522	if (ref $channel) {
		2523	# send meta info to client, if not yet sent
		2524	unless (exists $self->{channel}{$channel->{id}}) {
		2525	$self->{channel}{$channel->{id}} = $channel;
		2526	$self->ext_msg (channel_info => $channel);
		2527	}
		2528
		2529	$channel = $channel->{id};
		2530	}
		2531
		2532	return unless @extra || length $msg;
		2533
		2534	if ($self->can_msg) {
		2535	# default colour, mask it out
		2536	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2537	if $color & cf::NDI_DEF;
		2538
		2539	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2540	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2541	} else {
		2542	if ($color >= 0) {
		2543	# replace some tags by gcfclient-compatible ones
		2544	for ($msg) {
		2545	1 while
		2546	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2547	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2548	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2549	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2550	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2551	}
		2552
		2553	$color &= cf::NDI_COLOR_MASK;
		2554
		2555	if (0 && $msg =~ /\[/) {
		2556	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2557	} else {
		2558	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2559	$self->send_packet ("drawinfo $color $msg")
		2560	}
		2561	}
		2562	}
		2563	}
		2564
2115	=item $client->ext_event ($type, %msg)	2565	=item $client->ext_msg ($type, @msg)
2116		2566
2117	Sends an exti event to the client.	2567	Sends an ext event to the client.
2118		2568
2119	=cut	2569	=cut
2120		2570
2121	sub cf::client::ext_event($$%) {	2571	sub cf::client::ext_msg($$@) {
2122	my ($self, $type, %msg) = @_;	2572	my ($self, $type, @msg) = @_;
2123		2573
		2574	my $extcmd = $self->extcmd;
		2575
		2576	if ($extcmd == 2) {
		2577	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2578	} elsif ($extcmd == 1) { # TODO: remove
2124	$msg{msgtype} = "event_$type";	2579	push @msg, msgtype => "event_$type";
2125	$self->send_packet ("ext " . cf::to_json \%msg);	2580	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2581	}
2126	}	2582	}
2127		2583
2128	=item $success = $client->query ($flags, "text", \&cb)	2584	=item $success = $client->query ($flags, "text", \&cb)
2129		2585
2130	Queues a query to the client, calling the given callback with	2586	Queues a query to the client, calling the given callback with
2131	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2587	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2132	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2588	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2133		2589
2134	Queries can fail, so check the return code. Or don't, as queries will become	2590	Queries can fail, so check the return code. Or don't, as queries will
2135	reliable at some point in the future.	2591	become reliable at some point in the future.
2136		2592
2137	=cut	2593	=cut
2138		2594
2139	sub cf::client::query {	2595	sub cf::client::query {
2140	my ($self, $flags, $text, $cb) = @_;	2596	my ($self, $flags, $text, $cb) = @_;
…		…
2148	utf8::encode $text;	2604	utf8::encode $text;
2149	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2605	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2150		2606
2151	$self->send_packet ($self->{query_queue}[0][0])	2607	$self->send_packet ($self->{query_queue}[0][0])
2152	if @{ $self->{query_queue} } == 1;	2608	if @{ $self->{query_queue} } == 1;
		2609
		2610	1
2153	}	2611	}
2154		2612
2155	cf::client->attach (	2613	cf::client->attach (
		2614	on_connect => sub {
		2615	my ($ns) = @_;
		2616
		2617	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2618	},
2156	on_reply => sub {	2619	on_reply => sub {
2157	my ($ns, $msg) = @_;	2620	my ($ns, $msg) = @_;
2158		2621
2159	# this weird shuffling is so that direct followup queries	2622	# this weird shuffling is so that direct followup queries
2160	# get handled first	2623	# get handled first
…		…
2172	} else {	2635	} else {
2173	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2636	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2174	}	2637	}
2175	}	2638	}
2176	},	2639	},
		2640	on_exticmd => sub {
		2641	my ($ns, $buf) = @_;
		2642
		2643	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2644
		2645	if (ref $msg) {
		2646	my ($type, $reply, @payload) =
		2647	"ARRAY" eq ref $msg
		2648	? @$msg
		2649	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2650
		2651	if (my $cb = $EXTICMD{$type}) {
		2652	my @reply = $cb->($ns, @payload);
		2653
		2654	$ns->ext_reply ($reply, @reply)
		2655	if $reply;
		2656	}
		2657	} else {
		2658	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2659	}
		2660
		2661	cf::override;
		2662	},
2177	);	2663	);
2178		2664
2179	=item $client->async (\&cb)	2665	=item $client->async (\&cb)
2180		2666
2181	Create a new coroutine, running the specified callback. The coroutine will	2667	Create a new coroutine, running the specified callback. The coroutine will
…		…
2230		2716
2231	=pod	2717	=pod
2232		2718
2233	The following functions and methods are available within a safe environment:	2719	The following functions and methods are available within a safe environment:
2234		2720
2235	cf::object contr pay_amount pay_player map	2721	cf::object
		2722	contr pay_amount pay_player map x y force_find force_add
		2723	insert remove
		2724
2236	cf::object::player player	2725	cf::object::player
2237	cf::player peaceful	2726	player
2238	cf::map trigger	2727
		2728	cf::player
		2729	peaceful
		2730
		2731	cf::map
		2732	trigger
2239		2733
2240	=cut	2734	=cut
2241		2735
2242	for (	2736	for (
2243	["cf::object" => qw(contr pay_amount pay_player map)],	2737	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2738	insert remove)],
2244	["cf::object::player" => qw(player)],	2739	["cf::object::player" => qw(player)],
2245	["cf::player" => qw(peaceful)],	2740	["cf::player" => qw(peaceful)],
2246	["cf::map" => qw(trigger)],	2741	["cf::map" => qw(trigger)],
2247	) {	2742	) {
2248	no strict 'refs';	2743	no strict 'refs';
…		…
2319	=back	2814	=back
2320		2815
2321	=cut	2816	=cut
2322		2817
2323	#############################################################################	2818	#############################################################################
2324
2325	=head2 EXTENSION DATABASE SUPPORT
2326
2327	Crossfire maintains a very simple database for extension use. It can
2328	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2329	convert to/from binary).
2330
2331	The parameter C<$family> should best start with the name of the extension
2332	using it, it should be unique.
2333
2334	=over 4
2335
2336	=item $value = cf::db_get $family => $key
2337
2338	Returns a single value from the database.
2339
2340	=item cf::db_put $family => $key => $value
2341
2342	Stores the given C<$value> in the family.
2343
2344	=cut
2345
2346	our $DB;
2347
2348	sub db_init {
2349	unless ($DB) {
2350	$DB = BDB::db_create $DB_ENV;
2351
2352	cf::sync_job {
2353	eval {
2354	$DB->set_flags (BDB::CHKSUM);
2355
2356	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2357	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2358	cf::cleanup "db_open(db): $!" if $!;
2359	};
2360	cf::cleanup "db_open(db): $@" if $@;
2361	};
2362	}
2363	}
2364
2365	sub db_get($$) {
2366	my $key = "$_[0]/$_[1]";
2367
2368	cf::sync_job {
2369	BDB::db_get $DB, undef, $key, my $data;
2370
2371	$! ? ()
2372	: $data
2373	}
2374	}
2375
2376	sub db_put($$$) {
2377	BDB::dbreq_pri 4;
2378	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2379	}
2380
2381	=item cf::cache $id => [$paths...], $processversion => $process
2382
2383	Generic caching function that returns the value of the resource $id,
2384	caching and regenerating as required.
2385
2386	This function can block.
2387
2388	=cut
2389
2390	sub cache {
2391	my ($id, $src, $processversion, $process) = @_;
2392
2393	my $meta =
2394	join "\x00",
2395	$processversion,
2396	map {
2397	aio_stat $_
2398	and Carp::croak "$_: $!";
2399
2400	($_, (stat _)[7,9])
2401	} @$src;
2402
2403	my $dbmeta = db_get cache => "$id/meta";
2404	if ($dbmeta ne $meta) {
2405	# changed, we may need to process
2406
2407	my @data;
2408	my $md5;
2409
2410	for (0 .. $#$src) {
2411	0 <= aio_load $src->[$_], $data[$_]
2412	or Carp::croak "$src->[$_]: $!";
2413	}
2414
2415	# if processing is expensive, check
2416	# checksum first
2417	if (1) {
2418	$md5 =
2419	join "\x00",
2420	$processversion,
2421	map {
2422	Coro::cede;
2423	($src->[$_], Digest::MD5::md5_hex $data[$_])
2424	} 0.. $#$src;
2425
2426
2427	my $dbmd5 = db_get cache => "$id/md5";
2428	if ($dbmd5 eq $md5) {
2429	db_put cache => "$id/meta", $meta;
2430
2431	return db_get cache => "$id/data";
2432	}
2433	}
2434
2435	my $t1 = Time::HiRes::time;
2436	my $data = $process->(\@data);
2437	my $t2 = Time::HiRes::time;
2438
2439	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2440
2441	db_put cache => "$id/data", $data;
2442	db_put cache => "$id/md5" , $md5;
2443	db_put cache => "$id/meta", $meta;
2444
2445	return $data;
2446	}
2447
2448	db_get cache => "$id/data"
2449	}
2450
2451	=item fork_call { }, $args
2452
2453	Executes the given code block with the given arguments in a seperate
2454	process, returning the results. Everything must be serialisable with
2455	Coro::Storable. May, of course, block. Note that the executed sub may
2456	never block itself or use any form of Event handling.
2457
2458	=cut
2459
2460	sub fork_call(&@) {
2461	my ($cb, @args) = @_;
2462
2463	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2464	# or die "socketpair: $!";
2465	pipe my $fh1, my $fh2
2466	or die "pipe: $!";
2467
2468	if (my $pid = fork) {
2469	close $fh2;
2470
2471	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2472	$res = Coro::Storable::thaw $res;
2473
2474	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2475
2476	die $$res unless "ARRAY" eq ref $res;
2477
2478	return wantarray ? @$res : $res->[-1];
2479	} else {
2480	reset_signals;
2481	local $SIG{__WARN__};
2482	local $SIG{__DIE__};
2483	eval {
2484	close $fh1;
2485
2486	my @res = eval { $cb->(@args) };
2487	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2488	};
2489
2490	warn $@ if $@;
2491	_exit 0;
2492	}
2493	}
2494
2495	#############################################################################
2496	# the server's init and main functions	2819	# the server's init and main functions
2497		2820
2498	sub load_facedata($) {	2821	sub load_facedata($) {
2499	my ($path) = @_;	2822	my ($path) = @_;
2500		2823
…		…
2512	{	2835	{
2513	my $faces = $facedata->{faceinfo};	2836	my $faces = $facedata->{faceinfo};
2514		2837
2515	while (my ($face, $info) = each %$faces) {	2838	while (my ($face, $info) = each %$faces) {
2516	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2839	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2517	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2840	cf::face::set_visibility $idx, $info->{visibility};
		2841	cf::face::set_magicmap $idx, $info->{magicmap};
2518	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2842	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2519	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2843	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2520	Coro::cede;	2844
		2845	cf::cede_to_tick;
2521	}	2846	}
2522		2847
2523	while (my ($face, $info) = each %$faces) {	2848	while (my ($face, $info) = each %$faces) {
2524	next unless $info->{smooth};	2849	next unless $info->{smooth};
2525	my $idx = cf::face::find $face	2850	my $idx = cf::face::find $face
2526	or next;	2851	or next;
2527	if (my $smooth = cf::face::find $info->{smooth}) {	2852	if (my $smooth = cf::face::find $info->{smooth}) {
		2853	cf::face::set_smooth $idx, $smooth;
2528	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2854	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2529	} else {	2855	} else {
2530	warn "smooth face '$info->{smooth}' not found for face '$face'";	2856	warn "smooth face '$info->{smooth}' not found for face '$face'";
2531	}	2857	}
2532	Coro::cede;	2858
		2859	cf::cede_to_tick;
2533	}	2860	}
2534	}	2861	}
2535		2862
2536	{	2863	{
2537	my $anims = $facedata->{animinfo};	2864	my $anims = $facedata->{animinfo};
2538		2865
2539	while (my ($anim, $info) = each %$anims) {	2866	while (my ($anim, $info) = each %$anims) {
2540	cf::anim::set $anim, $info->{frames}, $info->{facings};	2867	cf::anim::set $anim, $info->{frames}, $info->{facings};
2541	Coro::cede;	2868	cf::cede_to_tick;
2542	}	2869	}
2543		2870
2544	cf::anim::invalidate_all; # d'oh	2871	cf::anim::invalidate_all; # d'oh
2545	}	2872	}
2546		2873
		2874	{
		2875	# TODO: for gcfclient pleasure, we should give resources
		2876	# that gcfclient doesn't grok a >10000 face index.
		2877	my $res = $facedata->{resource};
		2878	my $enc = JSON::XS->new->utf8->canonical;
		2879
		2880	my $soundconf = delete $res->{"res/sound.conf"};
		2881
		2882	while (my ($name, $info) = each %$res) {
		2883	my $meta = $enc->encode ({
		2884	name => $name,
		2885	%{ $info->{meta} || {} },
		2886	});
		2887
		2888	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2889
		2890	if ($info->{type} & 1) {
		2891	# prepend meta info
		2892
		2893	my $data = pack "(w/a*)*", $meta, $info->{data};
		2894	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2895
		2896	cf::face::set_data $idx, 0, $data, $chk;
		2897	} else {
		2898	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2899	}
		2900
		2901	cf::face::set_type $idx, $info->{type};
		2902
		2903	cf::cede_to_tick;
		2904	}
		2905
		2906	if ($soundconf) {
		2907	$soundconf = $enc->decode (delete $soundconf->{data});
		2908
		2909	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2910	my $sound = $soundconf->{compat}[$_]
		2911	or next;
		2912
		2913	my $face = cf::face::find "sound/$sound->[1]";
		2914	cf::sound::set $sound->[0] => $face;
		2915	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2916	}
		2917
		2918	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2919	my $face = cf::face::find "sound/$v";
		2920	cf::sound::set $k => $face;
		2921	}
		2922	}
		2923	}
		2924
2547	1	2925	1
2548	}	2926	}
		2927
		2928	register_exticmd fx_want => sub {
		2929	my ($ns, $want) = @_;
		2930
		2931	while (my ($k, $v) = each %$want) {
		2932	$ns->fx_want ($k, $v);
		2933	}
		2934	};
2549		2935
2550	sub reload_regions {	2936	sub reload_regions {
2551	load_resource_file "$MAPDIR/regions"	2937	load_resource_file "$MAPDIR/regions"
2552	or die "unable to load regions file\n";	2938	or die "unable to load regions file\n";
		2939
		2940	for (cf::region::list) {
		2941	$_->{match} = qr/$_->{match}/
		2942	if exists $_->{match};
		2943	}
2553	}	2944	}
2554		2945
2555	sub reload_facedata {	2946	sub reload_facedata {
2556	load_facedata "$DATADIR/facedata"	2947	load_facedata "$DATADIR/facedata"
2557	or die "unable to load facedata\n";	2948	or die "unable to load facedata\n";
2558	}	2949	}
2559		2950
2560	sub reload_archetypes {	2951	sub reload_archetypes {
		2952	load_resource_file "$DATADIR/archetypes"
		2953	or die "unable to load archetypes\n";
		2954	#d# NEED to laod twice to resolve forward references
		2955	# this really needs to be done in an extra post-pass
		2956	# (which needs to be synchronous, so solve it differently)
2561	load_resource_file "$DATADIR/archetypes"	2957	load_resource_file "$DATADIR/archetypes"
2562	or die "unable to load archetypes\n";	2958	or die "unable to load archetypes\n";
2563	}	2959	}
2564		2960
2565	sub reload_treasures {	2961	sub reload_treasures {
…		…
2637	},	3033	},
2638	);	3034	);
2639	}	3035	}
2640	}	3036	}
2641		3037
		3038	sub write_runtime {
		3039	my $runtime = "$LOCALDIR/runtime";
		3040
		3041	# first touch the runtime file to show we are still running:
		3042	# the fsync below can take a very very long time.
		3043
		3044	IO::AIO::aio_utime $runtime, undef, undef;
		3045
		3046	my $guard = cf::lock_acquire "write_runtime";
		3047
		3048	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3049	or return;
		3050
		3051	my $value = $cf::RUNTIME + 90 + 10;
		3052	# 10 is the runtime save interval, for a monotonic clock
		3053	# 60 allows for the watchdog to kill the server.
		3054
		3055	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3056	and return;
		3057
		3058	# always fsync - this file is important
		3059	aio_fsync $fh
		3060	and return;
		3061
		3062	# touch it again to show we are up-to-date
		3063	aio_utime $fh, undef, undef;
		3064
		3065	close $fh
		3066	or return;
		3067
		3068	aio_rename "$runtime~", $runtime
		3069	and return;
		3070
		3071	warn "runtime file written.\n";
		3072
		3073	1
		3074	}
		3075
2642	sub emergency_save() {	3076	sub emergency_save() {
2643	my $freeze_guard = cf::freeze_mainloop;	3077	my $freeze_guard = cf::freeze_mainloop;
2644		3078
2645	warn "enter emergency perl save\n";	3079	warn "enter emergency perl save\n";
2646		3080
…		…
2721	%EXT_CORO = ();	3155	%EXT_CORO = ();
2722		3156
2723	warn "removing commands";	3157	warn "removing commands";
2724	%COMMAND = ();	3158	%COMMAND = ();
2725		3159
2726	warn "removing ext commands";	3160	warn "removing ext/exti commands";
2727	%EXTCMD = ();	3161	%EXTCMD = ();
		3162	%EXTICMD = ();
2728		3163
2729	warn "unloading/nuking all extensions";	3164	warn "unloading/nuking all extensions";
2730	for my $pkg (@EXTS) {	3165	for my $pkg (@EXTS) {
2731	warn "... unloading $pkg";	3166	warn "... unloading $pkg";
2732		3167

Diff Legend

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