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.332 by root, Sat Aug 18 17:33:53 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 1.4 ();
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;
…		…
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.
168		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.
		178
169	=back	179	=back
170		180
171	=cut	181	=cut
172		182
173	BEGIN {	183	BEGIN {
…		…
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
…		…
306	};	323	};
307	$TICK_WATCHER->stop;	324	$TICK_WATCHER->stop;
308	$guard	325	$guard
309	}	326	}
310		327
		328	=item cf::get_slot $time[, $priority[, $name]]
		329
		330	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		331	This call blocks and returns only when you have at least C<$time> seconds
		332	of cpu time till the next tick. The slot is only valid till the next cede.
		333
		334	The optional C<$name> can be used to identify the job to run. It might be
		335	used for statistical purposes and should identify the same time-class.
		336
		337	Useful for short background jobs.
		338
		339	=cut
		340
		341	our @SLOT_QUEUE;
		342	our $SLOT_QUEUE;
		343
		344	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		345	$SLOT_QUEUE = Coro::async {
		346	my $signal = new Coro::Signal;
		347
		348	while () {
		349	next_job:
		350	my $avail = cf::till_tick;
		351	if ($avail > 0.01) {
		352	for (0 .. $#SLOT_QUEUE) {
		353	if ($SLOT_QUEUE[$_][0] < $avail) {
		354	my $job = splice @SLOT_QUEUE, $_, 1, ();
		355	$job->[2]->send;
		356	Coro::cede;
		357	goto next_job;
		358	}
		359	}
		360	}
		361
		362	if (@SLOT_QUEUE) {
		363	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		364	push @cf::WAIT_FOR_TICK, $signal;
		365	$signal->wait;
		366	} else {
		367	Coro::schedule;
		368	}
		369	}
		370	};
		371
		372	sub get_slot($;$$) {
		373	my ($time, $pri, $name) = @_;
		374
		375	$time = $TICK * .6 if $time > $TICK * .6;
		376	my $sig = new Coro::Signal;
		377
		378	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		379	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		380	$SLOT_QUEUE->ready;
		381	$sig->wait;
		382	}
		383
311	=item cf::async { BLOCK }	384	=item cf::async { BLOCK }
312		385
313	Currently the same as Coro::async_pool, meaning you cannot use	386	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	387	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.	388	thing you are allowed to do is call C<prio> on it.
…		…
318		391
319	BEGIN { *async = \&Coro::async_pool }	392	BEGIN { *async = \&Coro::async_pool }
320		393
321	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
322		395
323	The design of crossfire+ requires that the main coro ($Coro::main) is	396	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	397	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.	398	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		399	acceptable.
326		400
327	If it must be done, put the blocking parts into C<sync_job>. This will run	401	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	402	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	403	server will be frozen during this time, so the block should either finish
330	fast or be very important.	404	fast or be very important.
…		…
390	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
391		465
392	$coro	466	$coro
393	}	467	}
394		468
395	sub write_runtime {	469	=item fork_call { }, $args
396	my $runtime = "$LOCALDIR/runtime";
397		470
398	# first touch the runtime file to show we are still running:	471	Executes the given code block with the given arguments in a seperate
399	# the fsync below can take a very very long time.	472	process, returning the results. Everything must be serialisable with
		473	Coro::Storable. May, of course, block. Note that the executed sub may
		474	never block itself or use any form of Event handling.
400		475
401	IO::AIO::aio_utime $runtime, undef, undef;	476	=cut
402		477
403	my $guard = cf::lock_acquire "write_runtime";	478	sub fork_call(&@) {
		479	my ($cb, @args) = @_;
404		480
405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	481	# we seemingly have to make a local copy of the whole thing,
406	or return;	482	# otherwise perl prematurely frees the stuff :/
		483	# TODO: investigate and fix (liekly this will be rather laborious)
407		484
408	my $value = $cf::RUNTIME + 90 + 10;	485	my @res = Coro::Util::fork_eval {
409	# 10 is the runtime save interval, for a monotonic clock	486	reset_signals;
410	# 60 allows for the watchdog to kill the server.	487	&$cb
		488	}, @args;
411		489
412	(aio_write $fh, 0, (length $value), $value, 0) <= 0	490	wantarray ? @res : $res[-1]
413	and return;	491	}
414		492
415	# always fsync - this file is important	493	=item $value = cf::db_get $family => $key
416	aio_fsync $fh
417	and return;
418		494
419	# touch it again to show we are up-to-date	495	Returns a single value from the environment database.
420	aio_utime $fh, undef, undef;
421		496
422	close $fh	497	=item cf::db_put $family => $key => $value
423	or return;
424		498
425	aio_rename "$runtime~", $runtime	499	Stores the given C<$value> in the family. It can currently store binary
426	and return;	500	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427		501
428	warn "runtime file written.\n";	502	=cut
429		503
		504	our $DB;
		505
		506	sub db_init {
		507	unless ($DB) {
		508	$DB = BDB::db_create $DB_ENV;
		509
		510	cf::sync_job {
		511	eval {
		512	$DB->set_flags (BDB::CHKSUM);
		513
		514	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		515	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		516	cf::cleanup "db_open(db): $!" if $!;
		517	};
		518	cf::cleanup "db_open(db): $@" if $@;
		519	};
430	1	520	}
		521	}
		522
		523	sub db_get($$) {
		524	my $key = "$_[0]/$_[1]";
		525
		526	cf::sync_job {
		527	BDB::db_get $DB, undef, $key, my $data;
		528
		529	$! ? ()
		530	: $data
		531	}
		532	}
		533
		534	sub db_put($$$) {
		535	BDB::dbreq_pri 4;
		536	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		537	}
		538
		539	=item cf::cache $id => [$paths...], $processversion => $process
		540
		541	Generic caching function that returns the value of the resource $id,
		542	caching and regenerating as required.
		543
		544	This function can block.
		545
		546	=cut
		547
		548	sub cache {
		549	my ($id, $src, $processversion, $process) = @_;
		550
		551	my $meta =
		552	join "\x00",
		553	$processversion,
		554	map {
		555	aio_stat $_
		556	and Carp::croak "$_: $!";
		557
		558	($_, (stat _)[7,9])
		559	} @$src;
		560
		561	my $dbmeta = db_get cache => "$id/meta";
		562	if ($dbmeta ne $meta) {
		563	# changed, we may need to process
		564
		565	my @data;
		566	my $md5;
		567
		568	for (0 .. $#$src) {
		569	0 <= aio_load $src->[$_], $data[$_]
		570	or Carp::croak "$src->[$_]: $!";
		571	}
		572
		573	# if processing is expensive, check
		574	# checksum first
		575	if (1) {
		576	$md5 =
		577	join "\x00",
		578	$processversion,
		579	map {
		580	Coro::cede;
		581	($src->[$_], Digest::MD5::md5_hex $data[$_])
		582	} 0.. $#$src;
		583
		584
		585	my $dbmd5 = db_get cache => "$id/md5";
		586	if ($dbmd5 eq $md5) {
		587	db_put cache => "$id/meta", $meta;
		588
		589	return db_get cache => "$id/data";
		590	}
		591	}
		592
		593	my $t1 = Time::HiRes::time;
		594	my $data = $process->(\@data);
		595	my $t2 = Time::HiRes::time;
		596
		597	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		598
		599	db_put cache => "$id/data", $data;
		600	db_put cache => "$id/md5" , $md5;
		601	db_put cache => "$id/meta", $meta;
		602
		603	return $data;
		604	}
		605
		606	db_get cache => "$id/data"
431	}	607	}
432		608
433	=item cf::datalog type => key => value, ...	609	=item cf::datalog type => key => value, ...
434		610
435	Log a datalog packet of the given type with the given key-value pairs.	611	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")	629	attach callbacks/event handlers (a collection of which is called an "attachment")
454	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
455		631
456	In the following description, CLASS can be any of C<global>, C<object>	632	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	633	C<player>, C<client> or C<map> (i.e. the attachable objects in
458	crossfire+).	634	Crossfire TRT).
459		635
460	=over 4	636	=over 4
461		637
462	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
463		639
…		…
665	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
666	}	842	}
667		843
668	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
669	} else {	845	} else {
670	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
671	}	847	}
672		848
673	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
674	}	850	}
675		851
…		…
715	";	891	";
716	die if $@;	892	die if $@;
717	}	893	}
718		894
719	our $override;	895	our $override;
720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	896	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721		897
722	sub override {	898	sub override {
723	$override = 1;	899	$override = 1;
724	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
725	}	901	}
726		902
727	sub do_invoke {	903	sub do_invoke {
728	my $event = shift;	904	my $event = shift;
729	my $callbacks = shift;	905	my $callbacks = shift;
730		906
731	@invoke_results = ();	907	@INVOKE_RESULTS = ();
732		908
733	local $override;	909	local $override;
734		910
735	for (@$callbacks) {	911	for (@$callbacks) {
736	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
753		929
754	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
755		931
756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	932	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	933	removed in future versions), and there is no public API to access override
758	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759		935
760	=back	936	=back
761		937
762	=cut	938	=cut
763		939
764	#############################################################################	940	#############################################################################
765	# object support	941	# object support
		942	#
		943
		944	sub _can_merge {
		945	my ($ob1, $ob2) = @_;
		946
		947	local $Storable::canonical = 1;
		948	my $fob1 = Storable::freeze $ob1;
		949	my $fob2 = Storable::freeze $ob2;
		950
		951	$fob1 eq $fob2
		952	}
766		953
767	sub reattach {	954	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	956	my ($obj) = @_;
770		957
…		…
877	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
878	$filename, length $data, scalar @{$av || []};	1065	$filename, length $data, scalar @{$av || []};
879	return ($data, $av);	1066	return ($data, $av);
880	}	1067	}
881		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
		1074
882	#############################################################################	1075	#############################################################################
883	# command handling &c	1076	# command handling &c
884		1077
885	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
886		1079
…		…
898	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
899	}	1092	}
900		1093
901	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
902		1095
903	Register a callbackf ro execution when the client sends an extcmd packet.	1096	Register a callback for execution when the client sends an (synchronous)
		1097	extcmd packet. Ext commands will be processed in the order they are
		1098	received by the server, like other user commands. The first argument is
		1099	the logged-in player. Ext commands can only be processed after a player
		1100	has logged in successfully.
904		1101
905	If the callback returns something, it is sent back as if reply was being	1102	If the callback returns something, it is sent back as if reply was being
906	called.	1103	called.
907		1104
		1105	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1106
		1107	Register a callback for execution when the client sends an (asynchronous)
		1108	exticmd packet. Exti commands are processed by the server as soon as they
		1109	are received, i.e. out of order w.r.t. other commands. The first argument
		1110	is a client socket. Exti commands can be received anytime, even before
		1111	log-in.
		1112
		1113	If the callback returns something, it is sent back as if reply was being
		1114	called.
		1115
908	=cut	1116	=cut
909		1117
910	sub register_extcmd {	1118	sub register_extcmd {
911	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
912		1120
913	$EXTCMD{$name} = $cb;	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
914	}	1128	}
915		1129
916	cf::player->attach (	1130	cf::player->attach (
917	on_command => sub {	1131	on_command => sub {
918	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
927	cf::override;	1141	cf::override;
928	},	1142	},
929	on_extcmd => sub {	1143	on_extcmd => sub {
930	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
931		1145
932	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933		1147
934	if (ref $msg) {	1148	if (ref $msg) {
		1149	my ($type, $reply, @payload) =
		1150	"ARRAY" eq ref $msg
		1151	? @$msg
		1152	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1153
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1154	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1155	my @reply = $cb->($pl, @payload);
		1156
937	$pl->ext_reply ($msg->{msgid}, %reply);	1157	$pl->ext_reply ($reply, @reply)
938	}	1158	if $reply;
939	}	1159	}
940	} else {	1160	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1161	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1162	}
943		1163
944	cf::override;	1164	cf::override;
945	},	1165	},
946	);	1166	);
947		1167
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 {	1168	sub load_extensions {
		1169	cf::sync_job {
		1170	my %todo;
		1171
983	for my $ext (<$LIBDIR/*.ext>) {	1172	for my $path (<$LIBDIR/*.ext>) {
984	next unless -r $ext;	1173	next unless -r $path;
985	eval {	1174
986	load_extension $ext;	1175	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1176	my $base = $1;
		1177	my $pkg = $1;
		1178	$pkg =~ s/[^[:word:]]/_/g;
		1179	$pkg = "ext::$pkg";
		1180
		1181	open my $fh, "<:utf8", $path
		1182	or die "$path: $!";
		1183
		1184	my $source = do { local $/; <$fh> };
		1185
		1186	my %ext = (
		1187	path => $path,
		1188	base => $base,
		1189	pkg => $pkg,
		1190	);
		1191
		1192	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1193	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1194
		1195	$ext{source} =
		1196	"package $pkg; use strict; use utf8;\n"
		1197	. "#line 1 \"$path\"\n{\n"
		1198	. $source
		1199	. "\n};\n1";
		1200
		1201	$todo{$base} = \%ext;
		1202	}
		1203
		1204	my %done;
		1205	while (%todo) {
		1206	my $progress;
		1207
		1208	while (my ($k, $v) = each %todo) {
		1209	for (split /,\s*/, $v->{meta}{depends}) {
		1210	goto skip
		1211	unless exists $done{$_};
		1212	}
		1213
		1214	warn "... loading '$k' into '$v->{pkg}'\n";
		1215
		1216	unless (eval $v->{source}) {
		1217	my $msg = $@ ? "$v->{path}: $@\n"
		1218	: "$v->{base}: extension inactive.\n";
		1219
		1220	if (exists $v->{meta}{mandatory}) {
		1221	warn $msg;
		1222	warn "mandatory extension failed to load, exiting.\n";
		1223	exit 1;
		1224	}
		1225
		1226	warn $msg;
		1227	}
		1228
		1229	$done{$k} = delete $todo{$k};
		1230	push @EXTS, $v->{pkg};
		1231	$progress = 1;
987	1	1232	}
988	} or warn "$ext not loaded: $@";	1233
		1234	skip:
		1235	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1236	unless $progress;
		1237	}
989	}	1238	};
990	}	1239	}
991		1240
992	#############################################################################	1241	#############################################################################
		1242
		1243	=back
993		1244
994	=head2 CORE EXTENSIONS	1245	=head2 CORE EXTENSIONS
995		1246
996	Functions and methods that extend core crossfire objects.	1247	Functions and methods that extend core crossfire objects.
997		1248
…		…
1084	$cf::PLAYER{$login} = $self;	1335	$cf::PLAYER{$login} = $self;
1085		1336
1086	$self	1337	$self
1087	}	1338	}
1088		1339
		1340	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1341
		1342	=cut
		1343
		1344	sub send_msg {
		1345	my $ns = shift->ns
		1346	or return;
		1347	$ns->send_msg (@_);
		1348	}
		1349
1089	=item $pl->quit_character	1350	=item $pl->quit_character
1090		1351
1091	Nukes the player without looking back. If logged in, the connection will	1352	Nukes the player without looking back. If logged in, the connection will
1092	be destroyed. May block for a long time.	1353	be destroyed. May block for a long time.
1093		1354
…		…
1185	}	1446	}
1186		1447
1187	\@paths	1448	\@paths
1188	}	1449	}
1189		1450
		1451	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1452
		1453	Expand crossfire pod fragments into protocol xml.
		1454
		1455	=cut
		1456
		1457	sub expand_cfpod {
		1458	((my $self), (local $_)) = @_;
		1459
		1460	# escape & and <
		1461	s/&/&amp;/g;
		1462	s/(?<![BIUGH])</&lt;/g;
		1463
		1464	# this is buggy, it needs to properly take care of nested <'s
		1465
		1466	1 while
		1467	# replace B<>, I<>, U<> etc.
		1468	s/B<([^\>]*)>/<b>$1<\/b>/
		1469	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1470	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1471	# replace G<male|female> tags
		1472	|| s{G<([^>|]*)\|([^>]*)>}{
		1473	$self->gender ? $2 : $1
		1474	}ge
		1475	# replace H<hint text>
		1476	|| s{H<([^\>]*)>}
		1477	{
		1478	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1479	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1480	"")
		1481	[$self->{hintmode}]
		1482	}ge;
		1483
		1484	# create single paragraphs (very hackish)
		1485	s/(?<=\S)\n(?=\w)/ /g;
		1486
		1487	# compress some whitespace
		1488	s/\s+\n/\n/g; # ws line-ends
		1489	s/\n\n+/\n/g; # double lines
		1490	s/^\n+//; # beginning lines
		1491	s/\n+$//; # ending lines
		1492
		1493	$_
		1494	}
		1495
		1496	sub hintmode {
		1497	$_[0]{hintmode} = $_[1] if @_ > 1;
		1498	$_[0]{hintmode}
		1499	}
		1500
1190	=item $player->ext_reply ($msgid, %msg)	1501	=item $player->ext_reply ($msgid, @msg)
1191		1502
1192	Sends an ext reply to the player.	1503	Sends an ext reply to the player.
1193		1504
1194	=cut	1505	=cut
1195		1506
1196	sub ext_reply($$%) {	1507	sub ext_reply($$@) {
1197	my ($self, $id, %msg) = @_;	1508	my ($self, $id, @msg) = @_;
1198		1509
1199	$msg{msgid} = $id;	1510	if ($self->ns->extcmd == 2) {
1200		1511	$self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1201	$self->send ("ext " . cf::to_json \%msg);	1512	} elsif ($self->ns->extcmd == 1) {
		1513	#TODO: version 1, remove
		1514	unshift @msg, msgtype => "reply", msgid => $id;
		1515	$self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
		1516	}
1202	}	1517	}
1203		1518
1204	=item $player->ext_event ($type, %msg)	1519	=item $player->ext_msg ($type, @msg)
1205		1520
1206	Sends an ext event to the client.	1521	Sends an ext event to the client.
1207		1522
1208	=cut	1523	=cut
1209		1524
1210	sub ext_event($$%) {	1525	sub ext_msg($$@) {
1211	my ($self, $type, %msg) = @_;	1526	my ($self, $type, @msg) = @_;
1212		1527
1213	$self->ns->ext_event ($type, %msg);	1528	$self->ns->ext_msg ($type, @msg);
1214	}	1529	}
1215		1530
1216	=head3 cf::region	1531	=head3 cf::region
1217		1532
1218	=over 4	1533	=over 4
…		…
1221		1536
1222	package cf::region;	1537	package cf::region;
1223		1538
1224	=item cf::region::find_by_path $path	1539	=item cf::region::find_by_path $path
1225		1540
1226	Tries to decuce the probable region for a map knowing only its path.	1541	Tries to decuce the likely region for a map knowing only its path.
1227		1542
1228	=cut	1543	=cut
1229		1544
1230	sub find_by_path($) {	1545	sub find_by_path($) {
1231	my ($path) = @_;	1546	my ($path) = @_;
1232		1547
1233	my ($match, $specificity);	1548	my ($match, $specificity);
1234		1549
1235	for my $region (list) {	1550	for my $region (list) {
1236	if ($region->match && $path =~ $region->match) {	1551	if ($region->{match} && $path =~ $region->{match}) {
1237	($match, $specificity) = ($region, $region->specificity)	1552	($match, $specificity) = ($region, $region->specificity)
1238	if $region->specificity > $specificity;	1553	if $region->specificity > $specificity;
1239	}	1554	}
1240	}	1555	}
1241		1556
…		…
1361	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1362	return $self;	1677	return $self;
1363	}	1678	}
1364	}	1679	}
1365		1680
1366	Carp::carp "unable to resolve path '$path' (base '$base').";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1367	()	1682	()
1368	}	1683	}
1369		1684
1370	sub init {	1685	sub init {
1371	my ($self) = @_;	1686	my ($self) = @_;
…		…
1579	$self->set_darkness_map;	1894	$self->set_darkness_map;
1580	Coro::cede;	1895	Coro::cede;
1581	$self->activate;	1896	$self->activate;
1582	}	1897	}
1583		1898
		1899	$self->{last_save} = $cf::RUNTIME;
		1900	$self->last_access ($cf::RUNTIME);
		1901
1584	$self->in_memory (cf::MAP_IN_MEMORY);	1902	$self->in_memory (cf::MAP_IN_MEMORY);
1585	}	1903	}
1586		1904
1587	$self->post_load;	1905	$self->post_load;
1588	}	1906	}
…		…
1649		1967
1650	undef $MAP_PREFETCH{$path};	1968	undef $MAP_PREFETCH{$path};
1651	$MAP_PREFETCHER ||= cf::async {	1969	$MAP_PREFETCHER ||= cf::async {
1652	while (%MAP_PREFETCH) {	1970	while (%MAP_PREFETCH) {
1653	for my $path (keys %MAP_PREFETCH) {	1971	for my $path (keys %MAP_PREFETCH) {
1654	my $map = find $path	1972	if (my $map = find $path) {
1655	or next;
1656	$map->load;	1973	$map->load;
		1974	}
1657		1975
1658	delete $MAP_PREFETCH{$path};	1976	delete $MAP_PREFETCH{$path};
1659	}	1977	}
1660	}	1978	}
1661	undef $MAP_PREFETCHER;	1979	undef $MAP_PREFETCHER;
…		…
1779	}	2097	}
1780		2098
1781	=item $maps = cf::map::tmp_maps	2099	=item $maps = cf::map::tmp_maps
1782		2100
1783	Returns an arrayref with all map paths of currently instantiated and saved	2101	Returns an arrayref with all map paths of currently instantiated and saved
1784	maps.	2102	maps. May block.
1785		2103
1786	=cut	2104	=cut
1787		2105
1788	sub tmp_maps() {	2106	sub tmp_maps() {
1789	[	2107	[
1790	map {	2108	map {
1791	utf8::decode $_;	2109	utf8::decode $_;
1792	!/\.(?:pst|meta)$/ && /^$PATH_SEP/o	2110	/\.map$/
1793	? normalise $_	2111	? normalise $_
1794	: ()	2112	: ()
1795	} @{ aio_readdir $TMPDIR or [] }	2113	} @{ aio_readdir $TMPDIR or [] }
1796	]	2114	]
1797	}	2115	}
1798		2116
		2117	=item $maps = cf::map::random_maps
		2118
		2119	Returns an arrayref with all map paths of currently instantiated and saved
		2120	random maps. May block.
		2121
		2122	=cut
		2123
		2124	sub random_maps() {
		2125	[
		2126	map {
		2127	utf8::decode $_;
		2128	/\.map$/
		2129	? normalise "?random/$_"
		2130	: ()
		2131	} @{ aio_readdir $RANDOMDIR or [] }
		2132	]
		2133	}
		2134
1799	=item cf::map::unique_maps	2135	=item cf::map::unique_maps
1800		2136
1801	Returns an arrayref of paths of all shared maps that have	2137	Returns an arrayref of paths of all shared maps that have
1802	instantiated unique items. May block.	2138	instantiated unique items. May block.
1803		2139
…		…
1805		2141
1806	sub unique_maps() {	2142	sub unique_maps() {
1807	[	2143	[
1808	map {	2144	map {
1809	utf8::decode $_;	2145	utf8::decode $_;
1810	!/\.(?:pst|meta)$/ && /^$PATH_SEP/o	2146	/\.map$/
1811	? normalise $_	2147	? normalise $_
1812	: ()	2148	: ()
1813	} @{ aio_readdir $UNIQUEDIR or [] }	2149	} @{ aio_readdir $UNIQUEDIR or [] }
1814	]	2150	]
1815	}	2151	}
…		…
1865		2201
1866	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2202	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1867		2203
1868	if ($self->{record_replies}) {	2204	if ($self->{record_replies}) {
1869	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2205	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2206
1870	} else {	2207	} else {
		2208	my $pl = $self->contr;
		2209
		2210	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2211	my $dialog = $pl->{npc_dialog};
		2212	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2213
		2214	} else {
1871	$msg = $npc->name . " says: $msg" if $npc;	2215	$msg = $npc->name . " says: $msg" if $npc;
1872	$self->message ($msg, $flags);	2216	$self->message ($msg, $flags);
		2217	}
1873	}	2218	}
		2219	}
		2220
		2221	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2222
		2223	=cut
		2224
		2225	sub cf::object::send_msg {
		2226	my $pl = shift->contr
		2227	or return;
		2228	$pl->send_msg (@_);
1874	}	2229	}
1875		2230
1876	=item $player_object->may ("access")	2231	=item $player_object->may ("access")
1877		2232
1878	Returns wether the given player is authorized to access resource "access"	2233	Returns wether the given player is authorized to access resource "access"
…		…
1966		2321
1967	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2322	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1968	$self->enter_map ($map, $x, $y);	2323	$self->enter_map ($map, $x, $y);
1969	}	2324	}
1970		2325
1971	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2326	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1972		2327
1973	Moves the player to the given map-path and coordinates by first freezing	2328	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	2329	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	2330	that has to return the map if sucecssful, and then unfreezes the player on
1976	the new (success) or old (failed) map position.	2331	the new (success) or old (failed) map position. In either case, $done will
		2332	be called at the end of this process.
1977		2333
1978	=cut	2334	=cut
1979		2335
1980	our $GOTOGEN;	2336	our $GOTOGEN;
1981		2337
1982	sub cf::object::player::goto {	2338	sub cf::object::player::goto {
1983	my ($self, $path, $x, $y, $check) = @_;	2339	my ($self, $path, $x, $y, $check, $done) = @_;
1984		2340
1985	# do generation counting so two concurrent goto's will be executed in-order	2341	# do generation counting so two concurrent goto's will be executed in-order
1986	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2342	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1987		2343
1988	$self->enter_link;	2344	$self->enter_link;
…		…
2008		2364
2009	if ($gen == $self->{_goto_generation}) {	2365	if ($gen == $self->{_goto_generation}) {
2010	delete $self->{_goto_generation};	2366	delete $self->{_goto_generation};
2011	$self->leave_link ($map, $x, $y);	2367	$self->leave_link ($map, $x, $y);
2012	}	2368	}
		2369
		2370	$done->() if $done;
2013	})->prio (1);	2371	})->prio (1);
2014	}	2372	}
2015		2373
2016	=item $player_object->enter_exit ($exit_object)	2374	=item $player_object->enter_exit ($exit_object)
2017		2375
…		…
2086	my $hp = $exit->stats->hp;	2444	my $hp = $exit->stats->hp;
2087	my $sp = $exit->stats->sp;	2445	my $sp = $exit->stats->sp;
2088		2446
2089	$self->enter_link;	2447	$self->enter_link;
2090		2448
		2449	# if exit is damned, update players death & WoR home-position
		2450	$self->contr->savebed ($slaying, $hp, $sp)
		2451	if $exit->flag (FLAG_DAMNED);
		2452
2091	(async {	2453	(async {
2092	$self->deactivate_recursive; # just to be sure	2454	$self->deactivate_recursive; # just to be sure
2093	unless (eval {	2455	unless (eval {
2094	$self->goto ($slaying, $hp, $sp);	2456	$self->goto ($slaying, $hp, $sp);
2095		2457
…		…
2122		2484
2123	utf8::encode $text;	2485	utf8::encode $text;
2124	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2486	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2125	}	2487	}
2126		2488
		2489	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2490
		2491	Send a drawinfo or msg packet to the client, formatting the msg for the
		2492	client if neccessary. C<$type> should be a string identifying the type of
		2493	the message, with C<log> being the default. If C<$color> is negative, suppress
		2494	the message unless the client supports the msg packet.
		2495
		2496	=cut
		2497
		2498	sub cf::client::send_msg {
		2499	my ($self, $channel, $msg, $color, @extra) = @_;
		2500
		2501	$msg = $self->pl->expand_cfpod ($msg);
		2502
		2503	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2504
		2505	if (ref $channel) {
		2506	# send meta info to client, if not yet sent
		2507	unless (exists $self->{channel}{$channel->{id}}) {
		2508	$self->{channel}{$channel->{id}} = $channel;
		2509	$self->ext_msg (channel_info => $channel);
		2510	}
		2511
		2512	$channel = $channel->{id};
		2513	}
		2514
		2515	return unless @extra || length $msg;
		2516
		2517	if ($self->can_msg) {
		2518	# default colour, mask it out
		2519	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2520	if $color & cf::NDI_DEF;
		2521
		2522	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2523	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2524	} else {
		2525	if ($color >= 0) {
		2526	# replace some tags by gcfclient-compatible ones
		2527	for ($msg) {
		2528	1 while
		2529	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2530	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2531	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2532	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2533	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2534	}
		2535
		2536	$color &= cf::NDI_COLOR_MASK;
		2537
		2538	utf8::encode $msg;
		2539
		2540	if (0 && $msg =~ /\[/) {
		2541	# COMMAND/INFO
		2542	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2543	} else {
		2544	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2545	$self->send_packet ("drawinfo $color $msg")
		2546	}
		2547	}
		2548	}
		2549	}
		2550
2127	=item $client->ext_event ($type, %msg)	2551	=item $client->ext_msg ($type, @msg)
2128		2552
2129	Sends an exti event to the client.	2553	Sends an ext event to the client.
2130		2554
2131	=cut	2555	=cut
2132		2556
2133	sub cf::client::ext_event($$%) {	2557	sub cf::client::ext_msg($$@) {
2134	my ($self, $type, %msg) = @_;	2558	my ($self, $type, @msg) = @_;
2135		2559
		2560	my $extcmd = $self->extcmd;
		2561
		2562	if ($extcmd == 2) {
		2563	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2564	} elsif ($extcmd == 1) { # TODO: remove
2136	$msg{msgtype} = "event_$type";	2565	push @msg, msgtype => "event_$type";
2137	$self->send_packet ("ext " . cf::to_json \%msg);	2566	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2567	}
2138	}	2568	}
2139		2569
2140	=item $success = $client->query ($flags, "text", \&cb)	2570	=item $success = $client->query ($flags, "text", \&cb)
2141		2571
2142	Queues a query to the client, calling the given callback with	2572	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>,	2573	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>.	2574	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2145		2575
2146	Queries can fail, so check the return code. Or don't, as queries will become	2576	Queries can fail, so check the return code. Or don't, as queries will
2147	reliable at some point in the future.	2577	become reliable at some point in the future.
2148		2578
2149	=cut	2579	=cut
2150		2580
2151	sub cf::client::query {	2581	sub cf::client::query {
2152	my ($self, $flags, $text, $cb) = @_;	2582	my ($self, $flags, $text, $cb) = @_;
…		…
2160	utf8::encode $text;	2590	utf8::encode $text;
2161	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2591	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2162		2592
2163	$self->send_packet ($self->{query_queue}[0][0])	2593	$self->send_packet ($self->{query_queue}[0][0])
2164	if @{ $self->{query_queue} } == 1;	2594	if @{ $self->{query_queue} } == 1;
		2595
		2596	1
2165	}	2597	}
2166		2598
2167	cf::client->attach (	2599	cf::client->attach (
		2600	on_connect => sub {
		2601	my ($ns) = @_;
		2602
		2603	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2604	},
2168	on_reply => sub {	2605	on_reply => sub {
2169	my ($ns, $msg) = @_;	2606	my ($ns, $msg) = @_;
2170		2607
2171	# this weird shuffling is so that direct followup queries	2608	# this weird shuffling is so that direct followup queries
2172	# get handled first	2609	# get handled first
…		…
2184	} else {	2621	} else {
2185	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2622	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2186	}	2623	}
2187	}	2624	}
2188	},	2625	},
		2626	on_exticmd => sub {
		2627	my ($ns, $buf) = @_;
		2628
		2629	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2630
		2631	if (ref $msg) {
		2632	my ($type, $reply, @payload) =
		2633	"ARRAY" eq ref $msg
		2634	? @$msg
		2635	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2636
		2637	if (my $cb = $EXTICMD{$type}) {
		2638	my @reply = $cb->($ns, @payload);
		2639
		2640	$ns->ext_reply ($reply, @reply)
		2641	if $reply;
		2642	}
		2643	} else {
		2644	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2645	}
		2646
		2647	cf::override;
		2648	},
2189	);	2649	);
2190		2650
2191	=item $client->async (\&cb)	2651	=item $client->async (\&cb)
2192		2652
2193	Create a new coroutine, running the specified callback. The coroutine will	2653	Create a new coroutine, running the specified callback. The coroutine will
…		…
2234	our $safe = new Safe "safe";	2694	our $safe = new Safe "safe";
2235	our $safe_hole = new Safe::Hole;	2695	our $safe_hole = new Safe::Hole;
2236		2696
2237	$SIG{FPE} = 'IGNORE';	2697	$SIG{FPE} = 'IGNORE';
2238		2698
2239	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2699	$safe->permit_only (Opcode::opset qw(
		2700	:base_core :base_mem :base_orig :base_math
		2701	grepstart grepwhile mapstart mapwhile
		2702	sort time
		2703	));
2240		2704
2241	# here we export the classes and methods available to script code	2705	# here we export the classes and methods available to script code
2242		2706
2243	=pod	2707	=pod
2244		2708
2245	The following functions and methods are available within a safe environment:	2709	The following functions and methods are available within a safe environment:
2246		2710
2247	cf::object contr pay_amount pay_player map	2711	cf::object
		2712	contr pay_amount pay_player map x y force_find force_add
		2713	insert remove name archname title slaying race
		2714
2248	cf::object::player player	2715	cf::object::player
2249	cf::player peaceful	2716	player
2250	cf::map trigger	2717
		2718	cf::player
		2719	peaceful
		2720
		2721	cf::map
		2722	trigger
2251		2723
2252	=cut	2724	=cut
2253		2725
2254	for (	2726	for (
2255	["cf::object" => qw(contr pay_amount pay_player map)],	2727	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2728	insert remove inv name archname title slaying race)],
2256	["cf::object::player" => qw(player)],	2729	["cf::object::player" => qw(player)],
2257	["cf::player" => qw(peaceful)],	2730	["cf::player" => qw(peaceful)],
2258	["cf::map" => qw(trigger)],	2731	["cf::map" => qw(trigger)],
2259	) {	2732	) {
2260	no strict 'refs';	2733	no strict 'refs';
…		…
2331	=back	2804	=back
2332		2805
2333	=cut	2806	=cut
2334		2807
2335	#############################################################################	2808	#############################################################################
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	2809	# the server's init and main functions
2509		2810
2510	sub load_facedata($) {	2811	sub load_facedata($) {
2511	my ($path) = @_;	2812	my ($path) = @_;
2512		2813
…		…
2524	{	2825	{
2525	my $faces = $facedata->{faceinfo};	2826	my $faces = $facedata->{faceinfo};
2526		2827
2527	while (my ($face, $info) = each %$faces) {	2828	while (my ($face, $info) = each %$faces) {
2528	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2829	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2529	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2830	cf::face::set_visibility $idx, $info->{visibility};
		2831	cf::face::set_magicmap $idx, $info->{magicmap};
2530	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2832	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2531	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2833	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2532	Coro::cede;	2834
		2835	cf::cede_to_tick;
2533	}	2836	}
2534		2837
2535	while (my ($face, $info) = each %$faces) {	2838	while (my ($face, $info) = each %$faces) {
2536	next unless $info->{smooth};	2839	next unless $info->{smooth};
2537	my $idx = cf::face::find $face	2840	my $idx = cf::face::find $face
2538	or next;	2841	or next;
2539	if (my $smooth = cf::face::find $info->{smooth}) {	2842	if (my $smooth = cf::face::find $info->{smooth}) {
		2843	cf::face::set_smooth $idx, $smooth;
2540	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2844	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2541	} else {	2845	} else {
2542	warn "smooth face '$info->{smooth}' not found for face '$face'";	2846	warn "smooth face '$info->{smooth}' not found for face '$face'";
2543	}	2847	}
2544	Coro::cede;	2848
		2849	cf::cede_to_tick;
2545	}	2850	}
2546	}	2851	}
2547		2852
2548	{	2853	{
2549	my $anims = $facedata->{animinfo};	2854	my $anims = $facedata->{animinfo};
2550		2855
2551	while (my ($anim, $info) = each %$anims) {	2856	while (my ($anim, $info) = each %$anims) {
2552	cf::anim::set $anim, $info->{frames}, $info->{facings};	2857	cf::anim::set $anim, $info->{frames}, $info->{facings};
2553	Coro::cede;	2858	cf::cede_to_tick;
2554	}	2859	}
2555		2860
2556	cf::anim::invalidate_all; # d'oh	2861	cf::anim::invalidate_all; # d'oh
2557	}	2862	}
2558		2863
		2864	{
		2865	# TODO: for gcfclient pleasure, we should give resources
		2866	# that gcfclient doesn't grok a >10000 face index.
		2867	my $res = $facedata->{resource};
		2868	my $enc = JSON::XS->new->utf8->canonical;
		2869
		2870	my $soundconf = delete $res->{"res/sound.conf"};
		2871
		2872	while (my ($name, $info) = each %$res) {
		2873	my $meta = $enc->encode ({
		2874	name => $name,
		2875	%{ $info->{meta} || {} },
		2876	});
		2877
		2878	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2879
		2880	if ($info->{type} & 1) {
		2881	# prepend meta info
		2882
		2883	my $data = pack "(w/a*)*", $meta, $info->{data};
		2884	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2885
		2886	cf::face::set_data $idx, 0, $data, $chk;
		2887	} else {
		2888	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
		2889	}
		2890
		2891	cf::face::set_type $idx, $info->{type};
		2892
		2893	cf::cede_to_tick;
		2894	}
		2895
		2896	if ($soundconf) {
		2897	$soundconf = $enc->decode (delete $soundconf->{data});
		2898
		2899	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2900	my $sound = $soundconf->{compat}[$_]
		2901	or next;
		2902
		2903	my $face = cf::face::find "sound/$sound->[1]";
		2904	cf::sound::set $sound->[0] => $face;
		2905	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2906	}
		2907
		2908	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2909	my $face = cf::face::find "sound/$v";
		2910	cf::sound::set $k => $face;
		2911	}
		2912	}
		2913	}
		2914
2559	1	2915	1
2560	}	2916	}
		2917
		2918	register_exticmd fx_want => sub {
		2919	my ($ns, $want) = @_;
		2920
		2921	while (my ($k, $v) = each %$want) {
		2922	$ns->fx_want ($k, $v);
		2923	}
		2924	};
2561		2925
2562	sub reload_regions {	2926	sub reload_regions {
2563	load_resource_file "$MAPDIR/regions"	2927	load_resource_file "$MAPDIR/regions"
2564	or die "unable to load regions file\n";	2928	or die "unable to load regions file\n";
		2929
		2930	for (cf::region::list) {
		2931	$_->{match} = qr/$_->{match}/
		2932	if exists $_->{match};
		2933	}
2565	}	2934	}
2566		2935
2567	sub reload_facedata {	2936	sub reload_facedata {
2568	load_facedata "$DATADIR/facedata"	2937	load_facedata "$DATADIR/facedata"
2569	or die "unable to load facedata\n";	2938	or die "unable to load facedata\n";
2570	}	2939	}
2571		2940
2572	sub reload_archetypes {	2941	sub reload_archetypes {
		2942	load_resource_file "$DATADIR/archetypes"
		2943	or die "unable to load archetypes\n";
		2944	#d# NEED to laod twice to resolve forward references
		2945	# this really needs to be done in an extra post-pass
		2946	# (which needs to be synchronous, so solve it differently)
2573	load_resource_file "$DATADIR/archetypes"	2947	load_resource_file "$DATADIR/archetypes"
2574	or die "unable to load archetypes\n";	2948	or die "unable to load archetypes\n";
2575	}	2949	}
2576		2950
2577	sub reload_treasures {	2951	sub reload_treasures {
…		…
2649	},	3023	},
2650	);	3024	);
2651	}	3025	}
2652	}	3026	}
2653		3027
		3028	sub write_runtime {
		3029	my $runtime = "$LOCALDIR/runtime";
		3030
		3031	# first touch the runtime file to show we are still running:
		3032	# the fsync below can take a very very long time.
		3033
		3034	IO::AIO::aio_utime $runtime, undef, undef;
		3035
		3036	my $guard = cf::lock_acquire "write_runtime";
		3037
		3038	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3039	or return;
		3040
		3041	my $value = $cf::RUNTIME + 90 + 10;
		3042	# 10 is the runtime save interval, for a monotonic clock
		3043	# 60 allows for the watchdog to kill the server.
		3044
		3045	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3046	and return;
		3047
		3048	# always fsync - this file is important
		3049	aio_fsync $fh
		3050	and return;
		3051
		3052	# touch it again to show we are up-to-date
		3053	aio_utime $fh, undef, undef;
		3054
		3055	close $fh
		3056	or return;
		3057
		3058	aio_rename "$runtime~", $runtime
		3059	and return;
		3060
		3061	warn "runtime file written.\n";
		3062
		3063	1
		3064	}
		3065
2654	sub emergency_save() {	3066	sub emergency_save() {
2655	my $freeze_guard = cf::freeze_mainloop;	3067	my $freeze_guard = cf::freeze_mainloop;
2656		3068
2657	warn "enter emergency perl save\n";	3069	warn "enter emergency perl save\n";
2658		3070
…		…
2733	%EXT_CORO = ();	3145	%EXT_CORO = ();
2734		3146
2735	warn "removing commands";	3147	warn "removing commands";
2736	%COMMAND = ();	3148	%COMMAND = ();
2737		3149
2738	warn "removing ext commands";	3150	warn "removing ext/exti commands";
2739	%EXTCMD = ();	3151	%EXTCMD = ();
		3152	%EXTICMD = ();
2740		3153
2741	warn "unloading/nuking all extensions";	3154	warn "unloading/nuking all extensions";
2742	for my $pkg (@EXTS) {	3155	for my $pkg (@EXTS) {
2743	warn "... unloading $pkg";	3156	warn "... unloading $pkg";
2744		3157

Diff Legend

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