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.278 by root, Mon Jun 11 21:38:14 2007 UTC vs.
Revision 1.345 by root, Tue Aug 28 19:30:11 2007 UTC

…		…
10	use Event;	10	use Event;
11	use Opcode;	11	use Opcode;
12	use Safe;	12	use Safe;
13	use Safe::Hole;	13	use Safe::Hole;
14		14
15	use Coro 3.61 ();	15	use Coro 3.64 ();
16	use Coro::State;	16	use Coro::State;
17	use Coro::Handle;	17	use Coro::Handle;
18	use Coro::Event;	18	use Coro::Event;
19	use Coro::Timer;	19	use Coro::Timer;
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
		24	use Coro::Util ();
24		25
		26	use JSON::XS ();
25	use BDB ();	27	use BDB ();
26	use Data::Dumper;	28	use Data::Dumper;
27	use Digest::MD5;	29	use Digest::MD5;
28	use Fcntl;	30	use Fcntl;
29	use YAML::Syck ();	31	use YAML::Syck ();
30	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
31	use Time::HiRes;	33	use Time::HiRes;
32	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
33		36
34	# configure various modules to our taste	37	# configure various modules to our taste
35	#	38	#
36	$Storable::canonical = 1; # reduce rsync transfers	39	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	52	our %COMMAND = ();
50	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
51		54
52	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
56		60
57	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
58	our @EVENT;	62	our @EVENT;
…		…
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
		1154	my @reply;
		1155
935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1156	if (my $cb = $EXTCMD{$type}) {
936	if (my %reply = $cb->($pl, $msg)) {	1157	@reply = $cb->($pl, @payload);
937	$pl->ext_reply ($msg->{msgid}, %reply);
938	}
939	}	1158	}
		1159
		1160	$pl->ext_reply ($reply, @reply)
		1161	if $reply;
		1162
940	} else {	1163	} else {
941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1164	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942	}	1165	}
943		1166
944	cf::override;	1167	cf::override;
…		…
967	path => $path,	1190	path => $path,
968	base => $base,	1191	base => $base,
969	pkg => $pkg,	1192	pkg => $pkg,
970	);	1193	);
971		1194
972	$ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }	1195	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973	if $source =~ /^#!.*?perl.*?#\s*(.*)$/;	1196	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974		1197
975	$ext{source} =	1198	$ext{source} =
976	"package $pkg; use strict; use utf8;\n"	1199	"package $pkg; use strict; use utf8;\n"
977	. "#line 1 \"$path\"\n{\n"	1200	. "#line 1 \"$path\"\n{\n"
978	. $source	1201	. $source
…		…
984	my %done;	1207	my %done;
985	while (%todo) {	1208	while (%todo) {
986	my $progress;	1209	my $progress;
987		1210
988	while (my ($k, $v) = each %todo) {	1211	while (my ($k, $v) = each %todo) {
989	for (split /,\s*/, $ext{meta}{depends}) {	1212	for (split /,\s*/, $v->{meta}{depends}) {
990	goto skip	1213	goto skip
991	unless exists $done{$_};	1214	unless exists $done{$_};
992	}	1215	}
993		1216
994	warn "... loading '$k' into '$v->{pkg}'\n";	1217	warn "... loading '$k' into '$v->{pkg}'\n";
995		1218
996	unless (eval $v->{source}) {	1219	unless (eval $v->{source}) {
997	my $msg = $@ ? "$v->{path}: $@\n"	1220	my $msg = $@ ? "$v->{path}: $@\n"
998	: "extension disabled.\n";	1221	: "$v->{base}: extension inactive.\n";
999		1222
1000	if (exists $v->{meta}{mandatory}) {	1223	if (exists $v->{meta}{mandatory}) {
1001	warn $msg;	1224	warn $msg;
1002	warn "mandatory extension failed to load, exiting.\n";	1225	warn "mandatory extension failed to load, exiting.\n";
1003	exit 1;	1226	exit 1;
1004	}	1227	}
1005		1228
1006	die $msg;	1229	warn $msg;
1007	}	1230	}
1008		1231
1009	$done{$k} = delete $todo{$k};	1232	$done{$k} = delete $todo{$k};
1010	push @EXTS, $v->{pkg};	1233	push @EXTS, $v->{pkg};
		1234	$progress = 1;
1011	}	1235	}
1012		1236
1013	skip:	1237	skip:
1014	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"	1238	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015	unless $progress;	1239	unless $progress;
1016	}	1240	}
1017	};	1241	};
1018	}	1242	}
1019		1243
1020	#############################################################################	1244	#############################################################################
		1245
		1246	=back
1021		1247
1022	=head2 CORE EXTENSIONS	1248	=head2 CORE EXTENSIONS
1023		1249
1024	Functions and methods that extend core crossfire objects.	1250	Functions and methods that extend core crossfire objects.
1025		1251
…		…
1112	$cf::PLAYER{$login} = $self;	1338	$cf::PLAYER{$login} = $self;
1113		1339
1114	$self	1340	$self
1115	}	1341	}
1116		1342
		1343	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1344
		1345	=cut
		1346
		1347	sub send_msg {
		1348	my $ns = shift->ns
		1349	or return;
		1350	$ns->send_msg (@_);
		1351	}
		1352
1117	=item $pl->quit_character	1353	=item $pl->quit_character
1118		1354
1119	Nukes the player without looking back. If logged in, the connection will	1355	Nukes the player without looking back. If logged in, the connection will
1120	be destroyed. May block for a long time.	1356	be destroyed. May block for a long time.
1121		1357
…		…
1213	}	1449	}
1214		1450
1215	\@paths	1451	\@paths
1216	}	1452	}
1217		1453
		1454	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1455
		1456	Expand crossfire pod fragments into protocol xml.
		1457
		1458	=cut
		1459
		1460	sub expand_cfpod {
		1461	((my $self), (local $_)) = @_;
		1462
		1463	# escape & and <
		1464	s/&/&amp;/g;
		1465	s/(?<![BIUGH])</&lt;/g;
		1466
		1467	# this is buggy, it needs to properly take care of nested <'s
		1468
		1469	1 while
		1470	# replace B<>, I<>, U<> etc.
		1471	s/B<([^\>]*)>/<b>$1<\/b>/
		1472	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1473	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1474	# replace G<male|female> tags
		1475	|| s{G<([^>|]*)\|([^>]*)>}{
		1476	$self->gender ? $2 : $1
		1477	}ge
		1478	# replace H<hint text>
		1479	|| s{H<([^\>]*)>}
		1480	{
		1481	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1482	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1483	"")
		1484	[$self->{hintmode}]
		1485	}ge;
		1486
		1487	# create single paragraphs (very hackish)
		1488	s/(?<=\S)\n(?=\w)/ /g;
		1489
		1490	# compress some whitespace
		1491	s/\s+\n/\n/g; # ws line-ends
		1492	s/\n\n+/\n/g; # double lines
		1493	s/^\n+//; # beginning lines
		1494	s/\n+$//; # ending lines
		1495
		1496	$_
		1497	}
		1498
		1499	sub hintmode {
		1500	$_[0]{hintmode} = $_[1] if @_ > 1;
		1501	$_[0]{hintmode}
		1502	}
		1503
1218	=item $player->ext_reply ($msgid, %msg)	1504	=item $player->ext_reply ($msgid, @msg)
1219		1505
1220	Sends an ext reply to the player.	1506	Sends an ext reply to the player.
1221		1507
1222	=cut	1508	=cut
1223		1509
1224	sub ext_reply($$%) {	1510	sub ext_reply($$@) {
1225	my ($self, $id, %msg) = @_;	1511	my ($self, $id, @msg) = @_;
1226		1512
1227	$msg{msgid} = $id;	1513	$self->ns->ext_reply ($id, @msg)
1228
1229	$self->send ("ext " . cf::to_json \%msg);
1230	}	1514	}
1231		1515
1232	=item $player->ext_event ($type, %msg)	1516	=item $player->ext_msg ($type, @msg)
1233		1517
1234	Sends an ext event to the client.	1518	Sends an ext event to the client.
1235		1519
1236	=cut	1520	=cut
1237		1521
1238	sub ext_event($$%) {	1522	sub ext_msg($$@) {
1239	my ($self, $type, %msg) = @_;	1523	my ($self, $type, @msg) = @_;
1240		1524
1241	$self->ns->ext_event ($type, %msg);	1525	$self->ns->ext_msg ($type, @msg);
1242	}	1526	}
1243		1527
1244	=head3 cf::region	1528	=head3 cf::region
1245		1529
1246	=over 4	1530	=over 4
…		…
1249		1533
1250	package cf::region;	1534	package cf::region;
1251		1535
1252	=item cf::region::find_by_path $path	1536	=item cf::region::find_by_path $path
1253		1537
1254	Tries to decuce the probable region for a map knowing only its path.	1538	Tries to decuce the likely region for a map knowing only its path.
1255		1539
1256	=cut	1540	=cut
1257		1541
1258	sub find_by_path($) {	1542	sub find_by_path($) {
1259	my ($path) = @_;	1543	my ($path) = @_;
1260		1544
1261	my ($match, $specificity);	1545	my ($match, $specificity);
1262		1546
1263	for my $region (list) {	1547	for my $region (list) {
1264	if ($region->match && $path =~ $region->match) {	1548	if ($region->{match} && $path =~ $region->{match}) {
1265	($match, $specificity) = ($region, $region->specificity)	1549	($match, $specificity) = ($region, $region->specificity)
1266	if $region->specificity > $specificity;	1550	if $region->specificity > $specificity;
1267	}	1551	}
1268	}	1552	}
1269		1553
…		…
1389	$self->init; # pass $1 etc.	1673	$self->init; # pass $1 etc.
1390	return $self;	1674	return $self;
1391	}	1675	}
1392	}	1676	}
1393		1677
1394	Carp::carp "unable to resolve path '$path' (base '$base').";	1678	Carp::cluck "unable to resolve path '$path' (base '$base').";
1395	()	1679	()
1396	}	1680	}
1397		1681
1398	sub init {	1682	sub init {
1399	my ($self) = @_;	1683	my ($self) = @_;
…		…
1565	local $self->{deny_reset} = 1; # loading can take a long time	1849	local $self->{deny_reset} = 1; # loading can take a long time
1566		1850
1567	my $path = $self->{path};	1851	my $path = $self->{path};
1568		1852
1569	{	1853	{
		1854	my $guard1 = cf::lock_acquire "map_data:$path";
1570	my $guard = cf::lock_acquire "map_load:$path";	1855	my $guard2 = cf::lock_acquire "map_load:$path";
1571		1856
1572	return if $self->in_memory != cf::MAP_SWAPPED;	1857	return if $self->in_memory != cf::MAP_SWAPPED;
1573		1858
1574	$self->in_memory (cf::MAP_LOADING);	1859	$self->in_memory (cf::MAP_LOADING);
1575		1860
…		…
1607	$self->set_darkness_map;	1892	$self->set_darkness_map;
1608	Coro::cede;	1893	Coro::cede;
1609	$self->activate;	1894	$self->activate;
1610	}	1895	}
1611		1896
		1897	$self->{last_save} = $cf::RUNTIME;
		1898	$self->last_access ($cf::RUNTIME);
		1899
1612	$self->in_memory (cf::MAP_IN_MEMORY);	1900	$self->in_memory (cf::MAP_IN_MEMORY);
1613	}	1901	}
1614		1902
1615	$self->post_load;	1903	$self->post_load;
1616	}	1904	}
…		…
1626		1914
1627	$self	1915	$self
1628	}	1916	}
1629		1917
1630	# find and load all maps in the 3x3 area around a map	1918	# find and load all maps in the 3x3 area around a map
1631	sub load_diag {	1919	sub load_neighbours {
1632	my ($map) = @_;	1920	my ($map) = @_;
1633		1921
1634	my @diag; # diagonal neighbours	1922	my @neigh; # diagonal neighbours
1635		1923
1636	for (0 .. 3) {	1924	for (0 .. 3) {
1637	my $neigh = $map->tile_path ($_)	1925	my $neigh = $map->tile_path ($_)
1638	or next;	1926	or next;
1639	$neigh = find $neigh, $map	1927	$neigh = find $neigh, $map
1640	or next;	1928	or next;
1641	$neigh->load;	1929	$neigh->load;
1642		1930
		1931	push @neigh,
1643	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1932	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1644	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1933	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1645	}	1934	}
1646		1935
1647	for (@diag) {	1936	for (grep defined $_->[0], @neigh) {
		1937	my ($path, $origin) = @$_;
1648	my $neigh = find @$_	1938	my $neigh = find $path, $origin
1649	or next;	1939	or next;
1650	$neigh->load;	1940	$neigh->load;
1651	}	1941	}
1652	}	1942	}
1653		1943
…		…
1658	}	1948	}
1659		1949
1660	sub do_load_sync {	1950	sub do_load_sync {
1661	my ($map) = @_;	1951	my ($map) = @_;
1662		1952
		1953	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1954	if $Coro::current == $Coro::main;
		1955
1663	cf::sync_job { $map->load };	1956	cf::sync_job { $map->load };
1664	}	1957	}
1665		1958
1666	our %MAP_PREFETCH;	1959	our %MAP_PREFETCH;
1667	our $MAP_PREFETCHER = undef;	1960	our $MAP_PREFETCHER = undef;
1668		1961
1669	sub find_async {	1962	sub find_async {
1670	my ($path, $origin) = @_;	1963	my ($path, $origin, $load) = @_;
1671		1964
1672	$path = normalise $path, $origin && $origin->{path};	1965	$path = normalise $path, $origin && $origin->{path};
1673		1966
1674	if (my $map = $cf::MAP{$path}) {	1967	if (my $map = $cf::MAP{$path}) {
1675	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1968	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1676	}	1969	}
1677		1970
1678	undef $MAP_PREFETCH{$path};	1971	$MAP_PREFETCH{$path} |= $load;
		1972
1679	$MAP_PREFETCHER ||= cf::async {	1973	$MAP_PREFETCHER ||= cf::async {
1680	while (%MAP_PREFETCH) {	1974	while (%MAP_PREFETCH) {
1681	for my $path (keys %MAP_PREFETCH) {	1975	while (my ($k, $v) = each %MAP_PREFETCH) {
1682	my $map = find $path	1976	if (my $map = find $k) {
1683	or next;
1684	$map->load;	1977	$map->load if $v;
		1978	}
1685		1979
1686	delete $MAP_PREFETCH{$path};	1980	delete $MAP_PREFETCH{$k};
1687	}	1981	}
1688	}	1982	}
1689	undef $MAP_PREFETCHER;	1983	undef $MAP_PREFETCHER;
1690	};	1984	};
1691	$MAP_PREFETCHER->prio (6);	1985	$MAP_PREFETCHER->prio (6);
…		…
1694	}	1988	}
1695		1989
1696	sub save {	1990	sub save {
1697	my ($self) = @_;	1991	my ($self) = @_;
1698		1992
1699	my $lock = cf::lock_acquire "map_data:" . $self->path;	1993	my $lock = cf::lock_acquire "map_data:$self->{path}";
1700		1994
1701	$self->{last_save} = $cf::RUNTIME;	1995	$self->{last_save} = $cf::RUNTIME;
1702		1996
1703	return unless $self->dirty;	1997	return unless $self->dirty;
1704		1998
…		…
1727	my ($self) = @_;	2021	my ($self) = @_;
1728		2022
1729	# save first because save cedes	2023	# save first because save cedes
1730	$self->save;	2024	$self->save;
1731		2025
1732	my $lock = cf::lock_acquire "map_data:" . $self->path;	2026	my $lock = cf::lock_acquire "map_data:$self->{path}";
1733		2027
1734	return if $self->players;	2028	return if $self->players;
1735	return if $self->in_memory != cf::MAP_IN_MEMORY;	2029	return if $self->in_memory != cf::MAP_IN_MEMORY;
1736	return if $self->{deny_save};	2030	return if $self->{deny_save};
1737		2031
…		…
1911		2205
1912	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2206	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1913		2207
1914	if ($self->{record_replies}) {	2208	if ($self->{record_replies}) {
1915	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2209	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2210
1916	} else {	2211	} else {
		2212	my $pl = $self->contr;
		2213
		2214	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2215	my $dialog = $pl->{npc_dialog};
		2216	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2217
		2218	} else {
1917	$msg = $npc->name . " says: $msg" if $npc;	2219	$msg = $npc->name . " says: $msg" if $npc;
1918	$self->message ($msg, $flags);	2220	$self->message ($msg, $flags);
		2221	}
1919	}	2222	}
		2223	}
		2224
		2225	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2226
		2227	=cut
		2228
		2229	sub cf::object::send_msg {
		2230	my $pl = shift->contr
		2231	or return;
		2232	$pl->send_msg (@_);
1920	}	2233	}
1921		2234
1922	=item $player_object->may ("access")	2235	=item $player_object->may ("access")
1923		2236
1924	Returns wether the given player is authorized to access resource "access"	2237	Returns wether the given player is authorized to access resource "access"
…		…
2003	# use -1 or undef as default coordinates, not 0, 0	2316	# use -1 or undef as default coordinates, not 0, 0
2004	($x, $y) = ($map->enter_x, $map->enter_y)	2317	($x, $y) = ($map->enter_x, $map->enter_y)
2005	if $x <=0 && $y <= 0;	2318	if $x <=0 && $y <= 0;
2006		2319
2007	$map->load;	2320	$map->load;
2008	$map->load_diag;	2321	$map->load_neighbours;
2009		2322
2010	return unless $self->contr->active;	2323	return unless $self->contr->active;
2011	$self->activate_recursive;	2324	$self->activate_recursive;
2012		2325
2013	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2326	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014	$self->enter_map ($map, $x, $y);	2327	$self->enter_map ($map, $x, $y);
2015	}	2328	}
2016		2329
2017	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2330	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2018		2331
2019	Moves the player to the given map-path and coordinates by first freezing	2332	Moves the player to the given map-path and coordinates by first freezing
2020	her, loading and preparing them map, calling the provided $check callback	2333	her, loading and preparing them map, calling the provided $check callback
2021	that has to return the map if sucecssful, and then unfreezes the player on	2334	that has to return the map if sucecssful, and then unfreezes the player on
2022	the new (success) or old (failed) map position.	2335	the new (success) or old (failed) map position. In either case, $done will
		2336	be called at the end of this process.
2023		2337
2024	=cut	2338	=cut
2025		2339
2026	our $GOTOGEN;	2340	our $GOTOGEN;
2027		2341
2028	sub cf::object::player::goto {	2342	sub cf::object::player::goto {
2029	my ($self, $path, $x, $y, $check) = @_;	2343	my ($self, $path, $x, $y, $check, $done) = @_;
2030		2344
2031	# do generation counting so two concurrent goto's will be executed in-order	2345	# do generation counting so two concurrent goto's will be executed in-order
2032	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2346	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033		2347
2034	$self->enter_link;	2348	$self->enter_link;
…		…
2054		2368
2055	if ($gen == $self->{_goto_generation}) {	2369	if ($gen == $self->{_goto_generation}) {
2056	delete $self->{_goto_generation};	2370	delete $self->{_goto_generation};
2057	$self->leave_link ($map, $x, $y);	2371	$self->leave_link ($map, $x, $y);
2058	}	2372	}
		2373
		2374	$done->() if $done;
2059	})->prio (1);	2375	})->prio (1);
2060	}	2376	}
2061		2377
2062	=item $player_object->enter_exit ($exit_object)	2378	=item $player_object->enter_exit ($exit_object)
2063		2379
…		…
2132	my $hp = $exit->stats->hp;	2448	my $hp = $exit->stats->hp;
2133	my $sp = $exit->stats->sp;	2449	my $sp = $exit->stats->sp;
2134		2450
2135	$self->enter_link;	2451	$self->enter_link;
2136		2452
		2453	# if exit is damned, update players death & WoR home-position
		2454	$self->contr->savebed ($slaying, $hp, $sp)
		2455	if $exit->flag (FLAG_DAMNED);
		2456
2137	(async {	2457	(async {
2138	$self->deactivate_recursive; # just to be sure	2458	$self->deactivate_recursive; # just to be sure
2139	unless (eval {	2459	unless (eval {
2140	$self->goto ($slaying, $hp, $sp);	2460	$self->goto ($slaying, $hp, $sp);
2141		2461
…		…
2168		2488
2169	utf8::encode $text;	2489	utf8::encode $text;
2170	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2490	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171	}	2491	}
2172		2492
		2493	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2494
		2495	Send a drawinfo or msg packet to the client, formatting the msg for the
		2496	client if neccessary. C<$type> should be a string identifying the type of
		2497	the message, with C<log> being the default. If C<$color> is negative, suppress
		2498	the message unless the client supports the msg packet.
		2499
		2500	=cut
		2501
		2502	sub cf::client::send_msg {
		2503	my ($self, $channel, $msg, $color, @extra) = @_;
		2504
		2505	$msg = $self->pl->expand_cfpod ($msg);
		2506
		2507	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2508
		2509	if (ref $channel) {
		2510	# send meta info to client, if not yet sent
		2511	unless (exists $self->{channel}{$channel->{id}}) {
		2512	$self->{channel}{$channel->{id}} = $channel;
		2513	$self->ext_msg (channel_info => $channel);
		2514	}
		2515
		2516	$channel = $channel->{id};
		2517	}
		2518
		2519	return unless @extra || length $msg;
		2520
		2521	if ($self->can_msg) {
		2522	# default colour, mask it out
		2523	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2524	if $color & cf::NDI_DEF;
		2525
		2526	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2527	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2528	} else {
		2529	if ($color >= 0) {
		2530	# replace some tags by gcfclient-compatible ones
		2531	for ($msg) {
		2532	1 while
		2533	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2534	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2535	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2536	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2537	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2538	}
		2539
		2540	$color &= cf::NDI_COLOR_MASK;
		2541
		2542	utf8::encode $msg;
		2543
		2544	if (0 && $msg =~ /\[/) {
		2545	# COMMAND/INFO
		2546	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2547	} else {
		2548	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2549	$self->send_packet ("drawinfo $color $msg")
		2550	}
		2551	}
		2552	}
		2553	}
		2554
2173	=item $client->ext_event ($type, %msg)	2555	=item $client->ext_msg ($type, @msg)
2174		2556
2175	Sends an exti event to the client.	2557	Sends an ext event to the client.
2176		2558
2177	=cut	2559	=cut
2178		2560
2179	sub cf::client::ext_event($$%) {	2561	sub cf::client::ext_msg($$@) {
2180	my ($self, $type, %msg) = @_;	2562	my ($self, $type, @msg) = @_;
2181		2563
		2564	if ($self->extcmd == 2) {
		2565	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2566	} elsif ($self->extcmd == 1) { # TODO: remove
2182	$msg{msgtype} = "event_$type";	2567	push @msg, msgtype => "event_$type";
2183	$self->send_packet ("ext " . cf::to_json \%msg);	2568	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2569	}
		2570	}
		2571
		2572	=item $client->ext_reply ($msgid, @msg)
		2573
		2574	Sends an ext reply to the client.
		2575
		2576	=cut
		2577
		2578	sub cf::client::ext_reply($$@) {
		2579	my ($self, $id, @msg) = @_;
		2580
		2581	if ($self->extcmd == 2) {
		2582	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2583	} elsif ($self->extcmd == 1) {
		2584	#TODO: version 1, remove
		2585	unshift @msg, msgtype => "reply", msgid => $id;
		2586	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2587	}
2184	}	2588	}
2185		2589
2186	=item $success = $client->query ($flags, "text", \&cb)	2590	=item $success = $client->query ($flags, "text", \&cb)
2187		2591
2188	Queues a query to the client, calling the given callback with	2592	Queues a query to the client, calling the given callback with
2189	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2593	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2190	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2594	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191		2595
2192	Queries can fail, so check the return code. Or don't, as queries will become	2596	Queries can fail, so check the return code. Or don't, as queries will
2193	reliable at some point in the future.	2597	become reliable at some point in the future.
2194		2598
2195	=cut	2599	=cut
2196		2600
2197	sub cf::client::query {	2601	sub cf::client::query {
2198	my ($self, $flags, $text, $cb) = @_;	2602	my ($self, $flags, $text, $cb) = @_;
…		…
2206	utf8::encode $text;	2610	utf8::encode $text;
2207	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2611	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208		2612
2209	$self->send_packet ($self->{query_queue}[0][0])	2613	$self->send_packet ($self->{query_queue}[0][0])
2210	if @{ $self->{query_queue} } == 1;	2614	if @{ $self->{query_queue} } == 1;
		2615
		2616	1
2211	}	2617	}
2212		2618
2213	cf::client->attach (	2619	cf::client->attach (
		2620	on_connect => sub {
		2621	my ($ns) = @_;
		2622
		2623	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2624	},
2214	on_reply => sub {	2625	on_reply => sub {
2215	my ($ns, $msg) = @_;	2626	my ($ns, $msg) = @_;
2216		2627
2217	# this weird shuffling is so that direct followup queries	2628	# this weird shuffling is so that direct followup queries
2218	# get handled first	2629	# get handled first
…		…
2230	} else {	2641	} else {
2231	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2642	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232	}	2643	}
2233	}	2644	}
2234	},	2645	},
		2646	on_exticmd => sub {
		2647	my ($ns, $buf) = @_;
		2648
		2649	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2650
		2651	if (ref $msg) {
		2652	my ($type, $reply, @payload) =
		2653	"ARRAY" eq ref $msg
		2654	? @$msg
		2655	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2656
		2657	my @reply;
		2658
		2659	if (my $cb = $EXTICMD{$type}) {
		2660	@reply = $cb->($ns, @payload);
		2661	}
		2662
		2663	$ns->ext_reply ($reply, @reply)
		2664	if $reply;
		2665
		2666	} else {
		2667	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2668	}
		2669
		2670	cf::override;
		2671	},
2235	);	2672	);
2236		2673
2237	=item $client->async (\&cb)	2674	=item $client->async (\&cb)
2238		2675
2239	Create a new coroutine, running the specified callback. The coroutine will	2676	Create a new coroutine, running the specified callback. The coroutine will
…		…
2280	our $safe = new Safe "safe";	2717	our $safe = new Safe "safe";
2281	our $safe_hole = new Safe::Hole;	2718	our $safe_hole = new Safe::Hole;
2282		2719
2283	$SIG{FPE} = 'IGNORE';	2720	$SIG{FPE} = 'IGNORE';
2284		2721
2285	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2722	$safe->permit_only (Opcode::opset qw(
		2723	:base_core :base_mem :base_orig :base_math
		2724	grepstart grepwhile mapstart mapwhile
		2725	sort time
		2726	));
2286		2727
2287	# here we export the classes and methods available to script code	2728	# here we export the classes and methods available to script code
2288		2729
2289	=pod	2730	=pod
2290		2731
2291	The following functions and methods are available within a safe environment:	2732	The following functions and methods are available within a safe environment:
2292		2733
2293	cf::object contr pay_amount pay_player map	2734	cf::object
		2735	contr pay_amount pay_player map x y force_find force_add
		2736	insert remove name archname title slaying race decrease_ob_nr
		2737
2294	cf::object::player player	2738	cf::object::player
2295	cf::player peaceful	2739	player
2296	cf::map trigger	2740
		2741	cf::player
		2742	peaceful
		2743
		2744	cf::map
		2745	trigger
2297		2746
2298	=cut	2747	=cut
2299		2748
2300	for (	2749	for (
2301	["cf::object" => qw(contr pay_amount pay_player map)],	2750	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2751	insert remove inv name archname title slaying race
		2752	decrease_ob_nr)],
2302	["cf::object::player" => qw(player)],	2753	["cf::object::player" => qw(player)],
2303	["cf::player" => qw(peaceful)],	2754	["cf::player" => qw(peaceful)],
2304	["cf::map" => qw(trigger)],	2755	["cf::map" => qw(trigger)],
2305	) {	2756	) {
2306	no strict 'refs';	2757	no strict 'refs';
…		…
2377	=back	2828	=back
2378		2829
2379	=cut	2830	=cut
2380		2831
2381	#############################################################################	2832	#############################################################################
2382
2383	=head2 EXTENSION DATABASE SUPPORT
2384
2385	Crossfire maintains a very simple database for extension use. It can
2386	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2387	convert to/from binary).
2388
2389	The parameter C<$family> should best start with the name of the extension
2390	using it, it should be unique.
2391
2392	=over 4
2393
2394	=item $value = cf::db_get $family => $key
2395
2396	Returns a single value from the database.
2397
2398	=item cf::db_put $family => $key => $value
2399
2400	Stores the given C<$value> in the family.
2401
2402	=cut
2403
2404	our $DB;
2405
2406	sub db_init {
2407	unless ($DB) {
2408	$DB = BDB::db_create $DB_ENV;
2409
2410	cf::sync_job {
2411	eval {
2412	$DB->set_flags (BDB::CHKSUM);
2413
2414	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2415	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2416	cf::cleanup "db_open(db): $!" if $!;
2417	};
2418	cf::cleanup "db_open(db): $@" if $@;
2419	};
2420	}
2421	}
2422
2423	sub db_get($$) {
2424	my $key = "$_[0]/$_[1]";
2425
2426	cf::sync_job {
2427	BDB::db_get $DB, undef, $key, my $data;
2428
2429	$! ? ()
2430	: $data
2431	}
2432	}
2433
2434	sub db_put($$$) {
2435	BDB::dbreq_pri 4;
2436	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2437	}
2438
2439	=item cf::cache $id => [$paths...], $processversion => $process
2440
2441	Generic caching function that returns the value of the resource $id,
2442	caching and regenerating as required.
2443
2444	This function can block.
2445
2446	=cut
2447
2448	sub cache {
2449	my ($id, $src, $processversion, $process) = @_;
2450
2451	my $meta =
2452	join "\x00",
2453	$processversion,
2454	map {
2455	aio_stat $_
2456	and Carp::croak "$_: $!";
2457
2458	($_, (stat _)[7,9])
2459	} @$src;
2460
2461	my $dbmeta = db_get cache => "$id/meta";
2462	if ($dbmeta ne $meta) {
2463	# changed, we may need to process
2464
2465	my @data;
2466	my $md5;
2467
2468	for (0 .. $#$src) {
2469	0 <= aio_load $src->[$_], $data[$_]
2470	or Carp::croak "$src->[$_]: $!";
2471	}
2472
2473	# if processing is expensive, check
2474	# checksum first
2475	if (1) {
2476	$md5 =
2477	join "\x00",
2478	$processversion,
2479	map {
2480	Coro::cede;
2481	($src->[$_], Digest::MD5::md5_hex $data[$_])
2482	} 0.. $#$src;
2483
2484
2485	my $dbmd5 = db_get cache => "$id/md5";
2486	if ($dbmd5 eq $md5) {
2487	db_put cache => "$id/meta", $meta;
2488
2489	return db_get cache => "$id/data";
2490	}
2491	}
2492
2493	my $t1 = Time::HiRes::time;
2494	my $data = $process->(\@data);
2495	my $t2 = Time::HiRes::time;
2496
2497	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499	db_put cache => "$id/data", $data;
2500	db_put cache => "$id/md5" , $md5;
2501	db_put cache => "$id/meta", $meta;
2502
2503	return $data;
2504	}
2505
2506	db_get cache => "$id/data"
2507	}
2508
2509	=item fork_call { }, $args
2510
2511	Executes the given code block with the given arguments in a seperate
2512	process, returning the results. Everything must be serialisable with
2513	Coro::Storable. May, of course, block. Note that the executed sub may
2514	never block itself or use any form of Event handling.
2515
2516	=cut
2517
2518	sub fork_call(&@) {
2519	my ($cb, @args) = @_;
2520
2521	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522	# or die "socketpair: $!";
2523	pipe my $fh1, my $fh2
2524	or die "pipe: $!";
2525
2526	if (my $pid = fork) {
2527	close $fh2;
2528
2529	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530	$res = Coro::Storable::thaw $res;
2531
2532	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534	die $$res unless "ARRAY" eq ref $res;
2535
2536	return wantarray ? @$res : $res->[-1];
2537	} else {
2538	reset_signals;
2539	local $SIG{__WARN__};
2540	local $SIG{__DIE__};
2541	eval {
2542	close $fh1;
2543
2544	my @res = eval { $cb->(@args) };
2545	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546	};
2547
2548	warn $@ if $@;
2549	_exit 0;
2550	}
2551	}
2552
2553	#############################################################################
2554	# the server's init and main functions	2833	# the server's init and main functions
2555		2834
2556	sub load_facedata($) {	2835	sub load_facedata($) {
2557	my ($path) = @_;	2836	my ($path) = @_;
		2837
		2838	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2558		2839
2559	warn "loading facedata from $path\n";	2840	warn "loading facedata from $path\n";
2560		2841
2561	my $facedata;	2842	my $facedata;
2562	0 < aio_load $path, $facedata	2843	0 < aio_load $path, $facedata
…		…
2565	$facedata = Coro::Storable::thaw $facedata;	2846	$facedata = Coro::Storable::thaw $facedata;
2566		2847
2567	$facedata->{version} == 2	2848	$facedata->{version} == 2
2568	or cf::cleanup "$path: version mismatch, cannot proceed.";	2849	or cf::cleanup "$path: version mismatch, cannot proceed.";
2569		2850
		2851	# patch in the exptable
		2852	$facedata->{resource}{"res/exp_table"} = {
		2853	type => FT_RSRC,
		2854	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2855	};
		2856	cf::cede_to_tick;
		2857
2570	{	2858	{
2571	my $faces = $facedata->{faceinfo};	2859	my $faces = $facedata->{faceinfo};
2572		2860
2573	while (my ($face, $info) = each %$faces) {	2861	while (my ($face, $info) = each %$faces) {
2574	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2862	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2863	cf::face::set_visibility $idx, $info->{visibility};
		2864	cf::face::set_magicmap $idx, $info->{magicmap};
2576	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2865	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2577	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2866	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2578	Coro::cede;	2867
		2868	cf::cede_to_tick;
2579	}	2869	}
2580		2870
2581	while (my ($face, $info) = each %$faces) {	2871	while (my ($face, $info) = each %$faces) {
2582	next unless $info->{smooth};	2872	next unless $info->{smooth};
2583	my $idx = cf::face::find $face	2873	my $idx = cf::face::find $face
2584	or next;	2874	or next;
2585	if (my $smooth = cf::face::find $info->{smooth}) {	2875	if (my $smooth = cf::face::find $info->{smooth}) {
		2876	cf::face::set_smooth $idx, $smooth;
2586	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2877	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2587	} else {	2878	} else {
2588	warn "smooth face '$info->{smooth}' not found for face '$face'";	2879	warn "smooth face '$info->{smooth}' not found for face '$face'";
2589	}	2880	}
2590	Coro::cede;	2881
		2882	cf::cede_to_tick;
2591	}	2883	}
2592	}	2884	}
2593		2885
2594	{	2886	{
2595	my $anims = $facedata->{animinfo};	2887	my $anims = $facedata->{animinfo};
2596		2888
2597	while (my ($anim, $info) = each %$anims) {	2889	while (my ($anim, $info) = each %$anims) {
2598	cf::anim::set $anim, $info->{frames}, $info->{facings};	2890	cf::anim::set $anim, $info->{frames}, $info->{facings};
2599	Coro::cede;	2891	cf::cede_to_tick;
2600	}	2892	}
2601		2893
2602	cf::anim::invalidate_all; # d'oh	2894	cf::anim::invalidate_all; # d'oh
2603	}	2895	}
2604		2896
		2897	{
		2898	# TODO: for gcfclient pleasure, we should give resources
		2899	# that gcfclient doesn't grok a >10000 face index.
		2900	my $res = $facedata->{resource};
		2901
		2902	my $soundconf = delete $res->{"res/sound.conf"};
		2903
		2904	while (my ($name, $info) = each %$res) {
		2905	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2906	my $data;
		2907
		2908	if ($info->{type} & 1) {
		2909	# prepend meta info
		2910
		2911	my $meta = $enc->encode ({
		2912	name => $name,
		2913	%{ $info->{meta} || {} },
		2914	});
		2915
		2916	$data = pack "(w/a*)*", $meta, $info->{data};
		2917	} else {
		2918	$data = $info->{data};
		2919	}
		2920
		2921	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2922	cf::face::set_type $idx, $info->{type};
		2923
		2924	cf::cede_to_tick;
		2925	}
		2926
		2927	if ($soundconf) {
		2928	$soundconf = $enc->decode (delete $soundconf->{data});
		2929
		2930	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2931	my $sound = $soundconf->{compat}[$_]
		2932	or next;
		2933
		2934	my $face = cf::face::find "sound/$sound->[1]";
		2935	cf::sound::set $sound->[0] => $face;
		2936	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2937	}
		2938
		2939	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2940	my $face = cf::face::find "sound/$v";
		2941	cf::sound::set $k => $face;
		2942	}
		2943	}
		2944	}
		2945
2605	1	2946	1
2606	}	2947	}
		2948
		2949	register_exticmd fx_want => sub {
		2950	my ($ns, $want) = @_;
		2951
		2952	while (my ($k, $v) = each %$want) {
		2953	$ns->fx_want ($k, $v);
		2954	}
		2955	};
2607		2956
2608	sub reload_regions {	2957	sub reload_regions {
2609	load_resource_file "$MAPDIR/regions"	2958	load_resource_file "$MAPDIR/regions"
2610	or die "unable to load regions file\n";	2959	or die "unable to load regions file\n";
		2960
		2961	for (cf::region::list) {
		2962	$_->{match} = qr/$_->{match}/
		2963	if exists $_->{match};
		2964	}
2611	}	2965	}
2612		2966
2613	sub reload_facedata {	2967	sub reload_facedata {
2614	load_facedata "$DATADIR/facedata"	2968	load_facedata "$DATADIR/facedata"
2615	or die "unable to load facedata\n";	2969	or die "unable to load facedata\n";
2616	}	2970	}
2617		2971
2618	sub reload_archetypes {	2972	sub reload_archetypes {
		2973	load_resource_file "$DATADIR/archetypes"
		2974	or die "unable to load archetypes\n";
		2975	#d# NEED to laod twice to resolve forward references
		2976	# this really needs to be done in an extra post-pass
		2977	# (which needs to be synchronous, so solve it differently)
2619	load_resource_file "$DATADIR/archetypes"	2978	load_resource_file "$DATADIR/archetypes"
2620	or die "unable to load archetypes\n";	2979	or die "unable to load archetypes\n";
2621	}	2980	}
2622		2981
2623	sub reload_treasures {	2982	sub reload_treasures {
…		…
2639		2998
2640	sub init {	2999	sub init {
2641	reload_resources;	3000	reload_resources;
2642	}	3001	}
2643		3002
2644	sub cfg_load {	3003	sub reload_config {
2645	open my $fh, "<:utf8", "$CONFDIR/config"	3004	open my $fh, "<:utf8", "$CONFDIR/config"
2646	or return;	3005	or return;
2647		3006
2648	local $/;	3007	local $/;
2649	*CFG = YAML::Syck::Load <$fh>;	3008	*CFG = YAML::Syck::Load <$fh>;
…		…
2669	(async {	3028	(async {
2670	Event::one_event;	3029	Event::one_event;
2671	})->prio (Coro::PRIO_MAX);	3030	})->prio (Coro::PRIO_MAX);
2672	};	3031	};
2673		3032
2674	cfg_load;	3033	reload_config;
2675	db_init;	3034	db_init;
2676	load_extensions;	3035	load_extensions;
2677		3036
2678	$TICK_WATCHER->start;	3037	$TICK_WATCHER->start;
2679	Event::loop;	3038	Event::loop;
…		…
2695	},	3054	},
2696	);	3055	);
2697	}	3056	}
2698	}	3057	}
2699		3058
		3059	sub write_runtime {
		3060	my $runtime = "$LOCALDIR/runtime";
		3061
		3062	# first touch the runtime file to show we are still running:
		3063	# the fsync below can take a very very long time.
		3064
		3065	IO::AIO::aio_utime $runtime, undef, undef;
		3066
		3067	my $guard = cf::lock_acquire "write_runtime";
		3068
		3069	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3070	or return;
		3071
		3072	my $value = $cf::RUNTIME + 90 + 10;
		3073	# 10 is the runtime save interval, for a monotonic clock
		3074	# 60 allows for the watchdog to kill the server.
		3075
		3076	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3077	and return;
		3078
		3079	# always fsync - this file is important
		3080	aio_fsync $fh
		3081	and return;
		3082
		3083	# touch it again to show we are up-to-date
		3084	aio_utime $fh, undef, undef;
		3085
		3086	close $fh
		3087	or return;
		3088
		3089	aio_rename "$runtime~", $runtime
		3090	and return;
		3091
		3092	warn "runtime file written.\n";
		3093
		3094	1
		3095	}
		3096
2700	sub emergency_save() {	3097	sub emergency_save() {
2701	my $freeze_guard = cf::freeze_mainloop;	3098	my $freeze_guard = cf::freeze_mainloop;
2702		3099
2703	warn "enter emergency perl save\n";	3100	warn "enter emergency perl save\n";
2704		3101
…		…
2779	%EXT_CORO = ();	3176	%EXT_CORO = ();
2780		3177
2781	warn "removing commands";	3178	warn "removing commands";
2782	%COMMAND = ();	3179	%COMMAND = ();
2783		3180
2784	warn "removing ext commands";	3181	warn "removing ext/exti commands";
2785	%EXTCMD = ();	3182	%EXTCMD = ();
		3183	%EXTICMD = ();
2786		3184
2787	warn "unloading/nuking all extensions";	3185	warn "unloading/nuking all extensions";
2788	for my $pkg (@EXTS) {	3186	for my $pkg (@EXTS) {
2789	warn "... unloading $pkg";	3187	warn "... unloading $pkg";
2790		3188
…		…
2833	warn "reloading cf.pm";	3231	warn "reloading cf.pm";
2834	require cf;	3232	require cf;
2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3233	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2836		3234
2837	warn "loading config and database again";	3235	warn "loading config and database again";
2838	cf::cfg_load;	3236	cf::reload_config;
2839		3237
2840	warn "loading extensions";	3238	warn "loading extensions";
2841	cf::load_extensions;	3239	cf::load_extensions;
2842		3240
2843	warn "reattaching attachments to objects/players";	3241	warn "reattaching attachments to objects/players";

Diff Legend

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