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.267 by root, Sat May 19 00:08:11 2007 UTC vs.
Revision 1.311 by root, Fri Jul 20 16:11:10 2007 UTC

…		…
20	use Coro::Signal;	20	use Coro::Signal;
21	use Coro::Semaphore;	21	use Coro::Semaphore;
22	use Coro::AIO;	22	use Coro::AIO;
23	use Coro::Storable;	23	use Coro::Storable;
24		24
		25	use JSON::XS 1.4 ();
25	use BDB ();	26	use BDB ();
26	use Data::Dumper;	27	use Data::Dumper;
27	use Digest::MD5;	28	use Digest::MD5;
28	use Fcntl;	29	use Fcntl;
29	use YAML::Syck ();	30	use YAML::Syck ();
30	use IO::AIO 2.32 ();	31	use IO::AIO 2.32 ();
31	use Time::HiRes;	32	use Time::HiRes;
32	use Compress::LZF;	33	use Compress::LZF;
		34	use Digest::MD5 ();
33		35
34	# configure various modules to our taste	36	# configure various modules to our taste
35	#	37	#
36	$Storable::canonical = 1; # reduce rsync transfers	38	$Storable::canonical = 1; # reduce rsync transfers
37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	39	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
49	our %COMMAND = ();	51	our %COMMAND = ();
50	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
51		53
52	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
53	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
54	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
55	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
56		59
57	our $RELOAD; # number of reloads so far	60	our $RELOAD; # number of reloads so far
58	our @EVENT;	61	our @EVENT;
…		…
164		167
165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only	168	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166	returns directly I<after> the tick processing (and consequently, can only wake one process	169	returns directly I<after> the tick processing (and consequently, can only wake one process
167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.	170	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168		171
		172	=item @cf::INVOKE_RESULTS
		173
		174	This array contains the results of the last C<invoke ()> call. When
		175	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		176	that call.
		177
169	=back	178	=back
170		179
171	=cut	180	=cut
172		181
173	BEGIN {	182	BEGIN {
…		…
187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	196	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	197	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	198	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	199	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	200	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		201	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	202	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193		203
194	# we bless all objects into (empty) derived classes to force a method lookup	204	# we bless all objects into (empty) derived classes to force a method lookup
195	# within the Safe compartment.	205	# within the Safe compartment.
196	for my $pkg (qw(	206	for my $pkg (qw(
197	cf::global cf::attachable	207	cf::global cf::attachable
…		…
205	}	215	}
206		216
207	$Event::DIED = sub {	217	$Event::DIED = sub {
208	warn "error in event callback: @_";	218	warn "error in event callback: @_";
209	};	219	};
		220
		221	#############################################################################
210		222
211	=head2 UTILITY FUNCTIONS	223	=head2 UTILITY FUNCTIONS
212		224
213	=over 4	225	=over 4
214		226
…		…
233	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	245	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234	$d	246	$d
235	} || "[unable to dump $_[0]: '$@']";	247	} || "[unable to dump $_[0]: '$@']";
236	}	248	}
237		249
238	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240	=item $ref = cf::from_json $json	250	=item $ref = cf::from_json $json
241		251
242	Converts a JSON string into the corresponding perl data structure.	252	Converts a JSON string into the corresponding perl data structure.
243		253
244	=item $json = cf::to_json $ref	254	=item $json = cf::to_json $ref
245		255
246	Converts a perl data structure into its JSON representation.	256	Converts a perl data structure into its JSON representation.
		257
		258	=cut
		259
		260	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		261
		262	sub to_json ($) { $json_coder->encode ($_[0]) }
		263	sub from_json ($) { $json_coder->decode ($_[0]) }
247		264
248	=item cf::lock_wait $string	265	=item cf::lock_wait $string
249		266
250	Wait until the given lock is available. See cf::lock_acquire.	267	Wait until the given lock is available. See cf::lock_acquire.
251		268
…		…
317		334
318	BEGIN { *async = \&Coro::async_pool }	335	BEGIN { *async = \&Coro::async_pool }
319		336
320	=item cf::sync_job { BLOCK }	337	=item cf::sync_job { BLOCK }
321		338
322	The design of crossfire+ requires that the main coro ($Coro::main) is	339	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323	always able to handle events or runnable, as crossfire+ is only partly	340	is always able to handle events or runnable, as Crossfire TRT is only
324	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	341	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		342	acceptable.
325		343
326	If it must be done, put the blocking parts into C<sync_job>. This will run	344	If it must be done, put the blocking parts into C<sync_job>. This will run
327	the given BLOCK in another coroutine while waiting for the result. The	345	the given BLOCK in another coroutine while waiting for the result. The
328	server will be frozen during this time, so the block should either finish	346	server will be frozen during this time, so the block should either finish
329	fast or be very important.	347	fast or be very important.
…		…
389	$EXT_CORO{$coro+0} = $coro;	407	$EXT_CORO{$coro+0} = $coro;
390		408
391	$coro	409	$coro
392	}	410	}
393		411
394	sub write_runtime {	412	=item fork_call { }, $args
395	my $runtime = "$LOCALDIR/runtime";
396		413
397	# first touch the runtime file to show we are still running:	414	Executes the given code block with the given arguments in a seperate
398	# the fsync below can take a very very long time.	415	process, returning the results. Everything must be serialisable with
		416	Coro::Storable. May, of course, block. Note that the executed sub may
		417	never block itself or use any form of Event handling.
399		418
400	if (my $fh = aio_open $runtime, O_WRONLY, 0) {	419	=cut
401	utime undef, undef, $fh;
402	}
403		420
404	my $guard = cf::lock_acquire "write_runtime";	421	sub _store_scalar {
405		422	open my $fh, ">", \my $buf
406	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	423	or die "fork_call: cannot open fh-to-buf in child : $!";
407	or return;	424	Storable::store_fd $_[0], $fh;
408
409	my $value = $cf::RUNTIME + 90 + 10;
410	# 10 is the runtime save interval, for a monotonic clock
411	# 60 allows for the watchdog to kill the server.
412
413	(aio_write $fh, 0, (length $value), $value, 0) <= 0
414	and return;
415
416	# always fsync - this file is important
417	aio_fsync $fh
418	and return;
419
420	# touch it again to show we are up-to-date
421	utime undef, undef, $fh;
422
423	close $fh	425	close $fh;
424	or return;
425		426
426	aio_rename "$runtime~", $runtime	427	$buf
427	and return;	428	}
428		429
429	warn "runtime file written.\n";#d#	430	sub fork_call(&@) {
		431	my ($cb, @args) = @_;
430		432
		433	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		434	# or die "socketpair: $!";
		435	pipe my $fh1, my $fh2
		436	or die "pipe: $!";
		437
		438	if (my $pid = fork) {
		439	close $fh2;
		440
		441	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		442	warn "pst<$res>" unless $res =~ /^pst/;
		443	$res = Coro::Storable::thaw $res;
		444
		445	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		446
		447	Carp::confess $$res unless "ARRAY" eq ref $res;
		448
		449	return wantarray ? @$res : $res->[-1];
		450	} else {
		451	reset_signals;
		452	local $SIG{__WARN__};
		453	local $SIG{__DIE__};
		454	# just in case, this hack effectively disables event
		455	# in the child. cleaner and slower would be canceling all watchers,
		456	# but this works for the time being.
		457	local $Coro::idle;
		458	$Coro::current->prio (Coro::PRIO_MAX);
		459
		460	eval {
		461	close $fh1;
		462
		463	my @res = eval { $cb->(@args) };
		464
		465	syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
		466	close $fh2;
		467	};
		468
		469	warn $@ if $@;
		470	_exit 0;
431	1	471	}
		472	}
		473
		474	=item $value = cf::db_get $family => $key
		475
		476	Returns a single value from the environment database.
		477
		478	=item cf::db_put $family => $key => $value
		479
		480	Stores the given C<$value> in the family. It can currently store binary
		481	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		482
		483	=cut
		484
		485	our $DB;
		486
		487	sub db_init {
		488	unless ($DB) {
		489	$DB = BDB::db_create $DB_ENV;
		490
		491	cf::sync_job {
		492	eval {
		493	$DB->set_flags (BDB::CHKSUM);
		494
		495	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		496	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		497	cf::cleanup "db_open(db): $!" if $!;
		498	};
		499	cf::cleanup "db_open(db): $@" if $@;
		500	};
		501	}
		502	}
		503
		504	sub db_get($$) {
		505	my $key = "$_[0]/$_[1]";
		506
		507	cf::sync_job {
		508	BDB::db_get $DB, undef, $key, my $data;
		509
		510	$! ? ()
		511	: $data
		512	}
		513	}
		514
		515	sub db_put($$$) {
		516	BDB::dbreq_pri 4;
		517	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		518	}
		519
		520	=item cf::cache $id => [$paths...], $processversion => $process
		521
		522	Generic caching function that returns the value of the resource $id,
		523	caching and regenerating as required.
		524
		525	This function can block.
		526
		527	=cut
		528
		529	sub cache {
		530	my ($id, $src, $processversion, $process) = @_;
		531
		532	my $meta =
		533	join "\x00",
		534	$processversion,
		535	map {
		536	aio_stat $_
		537	and Carp::croak "$_: $!";
		538
		539	($_, (stat _)[7,9])
		540	} @$src;
		541
		542	my $dbmeta = db_get cache => "$id/meta";
		543	if ($dbmeta ne $meta) {
		544	# changed, we may need to process
		545
		546	my @data;
		547	my $md5;
		548
		549	for (0 .. $#$src) {
		550	0 <= aio_load $src->[$_], $data[$_]
		551	or Carp::croak "$src->[$_]: $!";
		552	}
		553
		554	# if processing is expensive, check
		555	# checksum first
		556	if (1) {
		557	$md5 =
		558	join "\x00",
		559	$processversion,
		560	map {
		561	Coro::cede;
		562	($src->[$_], Digest::MD5::md5_hex $data[$_])
		563	} 0.. $#$src;
		564
		565
		566	my $dbmd5 = db_get cache => "$id/md5";
		567	if ($dbmd5 eq $md5) {
		568	db_put cache => "$id/meta", $meta;
		569
		570	return db_get cache => "$id/data";
		571	}
		572	}
		573
		574	my $t1 = Time::HiRes::time;
		575	my $data = $process->(\@data);
		576	my $t2 = Time::HiRes::time;
		577
		578	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		579
		580	db_put cache => "$id/data", $data;
		581	db_put cache => "$id/md5" , $md5;
		582	db_put cache => "$id/meta", $meta;
		583
		584	return $data;
		585	}
		586
		587	db_get cache => "$id/data"
432	}	588	}
433		589
434	=item cf::datalog type => key => value, ...	590	=item cf::datalog type => key => value, ...
435		591
436	Log a datalog packet of the given type with the given key-value pairs.	592	Log a datalog packet of the given type with the given key-value pairs.
…		…
454	attach callbacks/event handlers (a collection of which is called an "attachment")	610	attach callbacks/event handlers (a collection of which is called an "attachment")
455	to it. All such attachable objects support the following methods.	611	to it. All such attachable objects support the following methods.
456		612
457	In the following description, CLASS can be any of C<global>, C<object>	613	In the following description, CLASS can be any of C<global>, C<object>
458	C<player>, C<client> or C<map> (i.e. the attachable objects in	614	C<player>, C<client> or C<map> (i.e. the attachable objects in
459	crossfire+).	615	Crossfire TRT).
460		616
461	=over 4	617	=over 4
462		618
463	=item $attachable->attach ($attachment, key => $value...)	619	=item $attachable->attach ($attachment, key => $value...)
464		620
…		…
666	_attach $registry, $klass, @attach;	822	_attach $registry, $klass, @attach;
667	}	823	}
668		824
669	$obj->{$name} = \%arg;	825	$obj->{$name} = \%arg;
670	} else {	826	} else {
671	warn "object uses attachment '$name' that is not available, postponing.\n";	827	warn "object uses attachment '$name' which is not available, postponing.\n";
672	}	828	}
673		829
674	$obj->{_attachment}{$name} = undef;	830	$obj->{_attachment}{$name} = undef;
675	}	831	}
676		832
…		…
716	";	872	";
717	die if $@;	873	die if $@;
718	}	874	}
719		875
720	our $override;	876	our $override;
721	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	877	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
722		878
723	sub override {	879	sub override {
724	$override = 1;	880	$override = 1;
725	@invoke_results = ();	881	@INVOKE_RESULTS = (@_);
726	}	882	}
727		883
728	sub do_invoke {	884	sub do_invoke {
729	my $event = shift;	885	my $event = shift;
730	my $callbacks = shift;	886	my $callbacks = shift;
731		887
732	@invoke_results = ();	888	@INVOKE_RESULTS = ();
733		889
734	local $override;	890	local $override;
735		891
736	for (@$callbacks) {	892	for (@$callbacks) {
737	eval { &{$_->[1]} };	893	eval { &{$_->[1]} };
…		…
754		910
755	Generate an object-specific event with the given arguments.	911	Generate an object-specific event with the given arguments.
756		912
757	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	913	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
758	removed in future versions), and there is no public API to access override	914	removed in future versions), and there is no public API to access override
759	results (if you must, access C<@cf::invoke_results> directly).	915	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760		916
761	=back	917	=back
762		918
763	=cut	919	=cut
764		920
…		…
874	or return;	1030	or return;
875	$av = eval { (Storable::thaw $av)->{objs} };	1031	$av = eval { (Storable::thaw $av)->{objs} };
876	}	1032	}
877		1033
878	warn sprintf "loading %s (%d)\n",	1034	warn sprintf "loading %s (%d)\n",
879	$filename, length $data, scalar @{$av || []};#d#	1035	$filename, length $data, scalar @{$av || []};
880	return ($data, $av);	1036	return ($data, $av);
881	}	1037	}
		1038
		1039	=head2 COMMAND CALLBACKS
		1040
		1041	=over 4
		1042
		1043	=cut
882		1044
883	#############################################################################	1045	#############################################################################
884	# command handling &c	1046	# command handling &c
885		1047
886	=item cf::register_command $name => \&callback($ob,$args);	1048	=item cf::register_command $name => \&callback($ob,$args);
…		…
899	push @{ $COMMAND{$name} }, [$caller, $cb];	1061	push @{ $COMMAND{$name} }, [$caller, $cb];
900	}	1062	}
901		1063
902	=item cf::register_extcmd $name => \&callback($pl,$packet);	1064	=item cf::register_extcmd $name => \&callback($pl,$packet);
903		1065
904	Register a callbackf ro execution when the client sends an extcmd packet.	1066	Register a callback for execution when the client sends an (synchronous)
		1067	extcmd packet. Ext commands will be processed in the order they are
		1068	received by the server, like other user commands. The first argument is
		1069	the logged-in player. Ext commands can only be processed after a player
		1070	has logged in successfully.
905		1071
906	If the callback returns something, it is sent back as if reply was being	1072	If the callback returns something, it is sent back as if reply was being
907	called.	1073	called.
908		1074
		1075	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1076
		1077	Register a callback for execution when the client sends an (asynchronous)
		1078	exticmd packet. Exti commands are processed by the server as soon as they
		1079	are received, i.e. out of order w.r.t. other commands. The first argument
		1080	is a client socket. Exti commands can be received anytime, even before
		1081	log-in.
		1082
		1083	If the callback returns something, it is sent back as if reply was being
		1084	called.
		1085
909	=cut	1086	=cut
910		1087
911	sub register_extcmd {	1088	sub register_extcmd {
912	my ($name, $cb) = @_;	1089	my ($name, $cb) = @_;
913		1090
914	$EXTCMD{$name} = $cb;	1091	$EXTCMD{$name} = $cb;
		1092	}
		1093
		1094	sub register_exticmd {
		1095	my ($name, $cb) = @_;
		1096
		1097	$EXTICMD{$name} = $cb;
915	}	1098	}
916		1099
917	cf::player->attach (	1100	cf::player->attach (
918	on_command => sub {	1101	on_command => sub {
919	my ($pl, $name, $params) = @_;	1102	my ($pl, $name, $params) = @_;
…		…
928	cf::override;	1111	cf::override;
929	},	1112	},
930	on_extcmd => sub {	1113	on_extcmd => sub {
931	my ($pl, $buf) = @_;	1114	my ($pl, $buf) = @_;
932		1115
933	my $msg = eval { from_json $buf };	1116	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934		1117
935	if (ref $msg) {	1118	if (ref $msg) {
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1119	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
937	if (my %reply = $cb->($pl, $msg)) {	1120	if (my %reply = $cb->($pl, $msg)) {
938	$pl->ext_reply ($msg->{msgid}, %reply);	1121	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
944		1127
945	cf::override;	1128	cf::override;
946	},	1129	},
947	);	1130	);
948		1131
949	sub load_extension {
950	my ($path) = @_;
951
952	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
953	my $base = $1;
954	my $pkg = $1;
955	$pkg =~ s/[^[:word:]]/_/g;
956	$pkg = "ext::$pkg";
957
958	warn "... loading '$path' into '$pkg'\n";
959
960	open my $fh, "<:utf8", $path
961	or die "$path: $!";
962
963	my $source =
964	"package $pkg; use strict; use utf8;\n"
965	. "#line 1 \"$path\"\n{\n"
966	. (do { local $/; <$fh> })
967	. "\n};\n1";
968
969	unless (eval $source) {
970	my $msg = $@ ? "$path: $@\n"
971	: "extension disabled.\n";
972	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973	warn $@;
974	warn "mandatory extension failed to load, exiting.\n";
975	exit 1;
976	}
977	die $@;
978	}
979
980	push @EXTS, $pkg;
981	}
982
983	sub load_extensions {	1132	sub load_extensions {
		1133	cf::sync_job {
		1134	my %todo;
		1135
984	for my $ext (<$LIBDIR/*.ext>) {	1136	for my $path (<$LIBDIR/*.ext>) {
985	next unless -r $ext;	1137	next unless -r $path;
986	eval {	1138
987	load_extension $ext;	1139	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1140	my $base = $1;
		1141	my $pkg = $1;
		1142	$pkg =~ s/[^[:word:]]/_/g;
		1143	$pkg = "ext::$pkg";
		1144
		1145	open my $fh, "<:utf8", $path
		1146	or die "$path: $!";
		1147
		1148	my $source = do { local $/; <$fh> };
		1149
		1150	my %ext = (
		1151	path => $path,
		1152	base => $base,
		1153	pkg => $pkg,
		1154	);
		1155
		1156	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1157	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1158
		1159	$ext{source} =
		1160	"package $pkg; use strict; use utf8;\n"
		1161	. "#line 1 \"$path\"\n{\n"
		1162	. $source
		1163	. "\n};\n1";
		1164
		1165	$todo{$base} = \%ext;
		1166	}
		1167
		1168	my %done;
		1169	while (%todo) {
		1170	my $progress;
		1171
		1172	while (my ($k, $v) = each %todo) {
		1173	for (split /,\s*/, $v->{meta}{depends}) {
		1174	goto skip
		1175	unless exists $done{$_};
		1176	}
		1177
		1178	warn "... loading '$k' into '$v->{pkg}'\n";
		1179
		1180	unless (eval $v->{source}) {
		1181	my $msg = $@ ? "$v->{path}: $@\n"
		1182	: "$v->{base}: extension inactive.\n";
		1183
		1184	if (exists $v->{meta}{mandatory}) {
		1185	warn $msg;
		1186	warn "mandatory extension failed to load, exiting.\n";
		1187	exit 1;
		1188	}
		1189
		1190	warn $msg;
		1191	}
		1192
		1193	$done{$k} = delete $todo{$k};
		1194	push @EXTS, $v->{pkg};
		1195	$progress = 1;
988	1	1196	}
989	} or warn "$ext not loaded: $@";	1197
		1198	skip:
		1199	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1200	unless $progress;
		1201	}
990	}	1202	};
991	}	1203	}
992		1204
993	#############################################################################	1205	#############################################################################
		1206
		1207	=back
994		1208
995	=head2 CORE EXTENSIONS	1209	=head2 CORE EXTENSIONS
996		1210
997	Functions and methods that extend core crossfire objects.	1211	Functions and methods that extend core crossfire objects.
998		1212
…		…
1186	}	1400	}
1187		1401
1188	\@paths	1402	\@paths
1189	}	1403	}
1190		1404
		1405	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1406
		1407	Expand crossfire pod fragments into protocol xml.
		1408
		1409	=cut
		1410
		1411	sub expand_cfpod {
		1412	((my $self), (local $_)) = @_;
		1413
		1414	# escape & and <
		1415	s/&/&amp;/g;
		1416	s/(?<![BIUGH])</&lt;/g;
		1417
		1418	# this is buggy, it needs to properly take care of nested <'s
		1419
		1420	1 while
		1421	# replace B<>, I<>, U<> etc.
		1422	s/B<([^\>]*)>/<b>$1<\/b>/
		1423	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1424	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1425	# replace G<male|female> tags
		1426	|| s{G<([^>|]*)\|([^>]*)>}{
		1427	$self->gender ? $2 : $1
		1428	}ge
		1429	# replace H<hint text>
		1430	|| s{H<([^\>]*)>}
		1431	{
		1432	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1433	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1434	"")
		1435	[$self->{hintmode}]
		1436	}ge;
		1437
		1438	# create single paragraphs (very hackish)
		1439	s/(?<=\S)\n(?=\w)/ /g;
		1440
		1441	# compress some whitespace
		1442	s/\s+\n/\n/g; # ws line-ends
		1443	s/\n\n+/\n/g; # double lines
		1444	s/^\n+//; # beginning lines
		1445	s/\n+$//; # ending lines
		1446
		1447	$_
		1448	}
		1449
		1450	sub hintmode {
		1451	$_[0]{hintmode} = $_[1] if @_ > 1;
		1452	$_[0]{hintmode}
		1453	}
		1454
1191	=item $player->ext_reply ($msgid, %msg)	1455	=item $player->ext_reply ($msgid, %msg)
1192		1456
1193	Sends an ext reply to the player.	1457	Sends an ext reply to the player.
1194		1458
1195	=cut	1459	=cut
1196		1460
1197	sub ext_reply($$%) {	1461	sub ext_reply($$%) {
1198	my ($self, $id, %msg) = @_;	1462	my ($self, $id, %msg) = @_;
1199		1463
1200	$msg{msgid} = $id;	1464	$msg{msgid} = $id;
1201		1465	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1202	$self->send ("ext " . cf::to_json \%msg);
1203	}	1466	}
1204		1467
1205	=item $player->ext_event ($type, %msg)	1468	=item $player->ext_event ($type, %msg)
1206		1469
1207	Sends an ext event to the client.	1470	Sends an ext event to the client.
…		…
1222		1485
1223	package cf::region;	1486	package cf::region;
1224		1487
1225	=item cf::region::find_by_path $path	1488	=item cf::region::find_by_path $path
1226		1489
1227	Tries to decuce the probable region for a map knowing only its path.	1490	Tries to decuce the likely region for a map knowing only its path.
1228		1491
1229	=cut	1492	=cut
1230		1493
1231	sub find_by_path($) {	1494	sub find_by_path($) {
1232	my ($path) = @_;	1495	my ($path) = @_;
1233		1496
1234	my ($match, $specificity);	1497	my ($match, $specificity);
1235		1498
1236	for my $region (list) {	1499	for my $region (list) {
1237	if ($region->match && $path =~ $region->match) {	1500	if ($region->{match} && $path =~ $region->{match}) {
1238	($match, $specificity) = ($region, $region->specificity)	1501	($match, $specificity) = ($region, $region->specificity)
1239	if $region->specificity > $specificity;	1502	if $region->specificity > $specificity;
1240	}	1503	}
1241	}	1504	}
1242		1505
…		…
1306	my ($self, $merge) = @_;	1569	my ($self, $merge) = @_;
1307		1570
1308	# we have to keep some variables in memory intact	1571	# we have to keep some variables in memory intact
1309	local $self->{path};	1572	local $self->{path};
1310	local $self->{load_path};	1573	local $self->{load_path};
1311	local $self->{deny_save};
1312	local $self->{deny_reset};
1313		1574
1314	$self->SUPER::thawer_merge ($merge);	1575	$self->SUPER::thawer_merge ($merge);
1315	}	1576	}
1316		1577
1317	sub normalise {	1578	sub normalise {
…		…
1364	$self->init; # pass $1 etc.	1625	$self->init; # pass $1 etc.
1365	return $self;	1626	return $self;
1366	}	1627	}
1367	}	1628	}
1368		1629
1369	Carp::carp "unable to resolve path '$path' (base '$base').";	1630	Carp::cluck "unable to resolve path '$path' (base '$base').";
1370	()	1631	()
1371	}	1632	}
1372		1633
1373	sub init {	1634	sub init {
1374	my ($self) = @_;	1635	my ($self) = @_;
…		…
1415	sub change_all_map_light {	1676	sub change_all_map_light {
1416	my ($change) = @_;	1677	my ($change) = @_;
1417		1678
1418	$_->change_map_light ($change)	1679	$_->change_map_light ($change)
1419	for grep $_->outdoor, values %cf::MAP;	1680	for grep $_->outdoor, values %cf::MAP;
		1681	}
		1682
		1683	sub decay_objects {
		1684	my ($self) = @_;
		1685
		1686	return if $self->{deny_reset};
		1687
		1688	$self->do_decay_objects;
1420	}	1689	}
1421		1690
1422	sub unlink_save {	1691	sub unlink_save {
1423	my ($self) = @_;	1692	my ($self) = @_;
1424		1693
…		…
1482	$self->load_header_orig	1751	$self->load_header_orig
1483	or return;	1752	or return;
1484	$self->prepare_orig;	1753	$self->prepare_orig;
1485	}	1754	}
1486		1755
		1756	$self->{deny_reset} = 1
		1757	if $self->no_reset;
		1758
1487	$self->default_region (cf::region::find_by_path $self->{path})	1759	$self->default_region (cf::region::find_by_path $self->{path})
1488	unless $self->default_region;	1760	unless $self->default_region;
1489		1761
1490	1	1762	1
1491	}	1763	}
…		…
1506	$map->{last_save} = $cf::RUNTIME;	1778	$map->{last_save} = $cf::RUNTIME;
1507		1779
1508	$map->load_header	1780	$map->load_header
1509	or return;	1781	or return;
1510		1782
1511	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1783	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512	# doing this can freeze the server in a sync job, obviously	1784	# doing this can freeze the server in a sync job, obviously
1513	#$cf::WAIT_FOR_TICK->wait;	1785	#$cf::WAIT_FOR_TICK->wait;
1514	$map->reset;	1786	$map->reset;
1515	undef $guard;	1787	undef $guard;
1516	return find $path;	1788	return find $path;
…		…
1583	my ($self, $ob) = @_;	1855	my ($self, $ob) = @_;
1584		1856
1585	return find "~" . $ob->name . "/" . $self->{path}	1857	return find "~" . $ob->name . "/" . $self->{path}
1586	if $self->per_player;	1858	if $self->per_player;
1587		1859
		1860	# return find "?party/" . $ob->name . "/" . $self->{path}
		1861	# if $self->per_party;
		1862
1588	$self	1863	$self
1589	}	1864	}
1590		1865
1591	# find and load all maps in the 3x3 area around a map	1866	# find and load all maps in the 3x3 area around a map
1592	sub load_diag {	1867	sub load_diag {
…		…
1638		1913
1639	undef $MAP_PREFETCH{$path};	1914	undef $MAP_PREFETCH{$path};
1640	$MAP_PREFETCHER ||= cf::async {	1915	$MAP_PREFETCHER ||= cf::async {
1641	while (%MAP_PREFETCH) {	1916	while (%MAP_PREFETCH) {
1642	for my $path (keys %MAP_PREFETCH) {	1917	for my $path (keys %MAP_PREFETCH) {
1643	my $map = find $path	1918	if (my $map = find $path) {
1644	or next;
1645	$map->load;	1919	$map->load;
		1920	}
1646		1921
1647	delete $MAP_PREFETCH{$path};	1922	delete $MAP_PREFETCH{$path};
1648	}	1923	}
1649	}	1924	}
1650	undef $MAP_PREFETCHER;	1925	undef $MAP_PREFETCHER;
…		…
1702		1977
1703	sub reset_at {	1978	sub reset_at {
1704	my ($self) = @_;	1979	my ($self) = @_;
1705		1980
1706	# TODO: safety, remove and allow resettable per-player maps	1981	# TODO: safety, remove and allow resettable per-player maps
1707	return 1e99 if $self->isa ("ext::map_per_player");#d#
1708	return 1e99 if $self->{deny_reset};	1982	return 1e99 if $self->{deny_reset};
1709		1983
1710	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1984	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1985	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712		1986
…		…
1723	my ($self) = @_;	1997	my ($self) = @_;
1724		1998
1725	my $lock = cf::lock_acquire "map_data:$self->{path}";	1999	my $lock = cf::lock_acquire "map_data:$self->{path}";
1726		2000
1727	return if $self->players;	2001	return if $self->players;
1728	return if $self->isa ("ext::map_per_player");#d#
1729		2002
1730	warn "resetting map ", $self->path;#d#	2003	warn "resetting map ", $self->path;
1731		2004
1732	$self->in_memory (cf::MAP_SWAPPED);	2005	$self->in_memory (cf::MAP_SWAPPED);
1733		2006
1734	# need to save uniques path	2007	# need to save uniques path
1735	unless ($self->{deny_save}) {	2008	unless ($self->{deny_save}) {
…		…
1767	$cf::MAP{$self->path} = $self;	2040	$cf::MAP{$self->path} = $self;
1768		2041
1769	$self->reset; # polite request, might not happen	2042	$self->reset; # polite request, might not happen
1770	}	2043	}
1771		2044
		2045	=item $maps = cf::map::tmp_maps
		2046
		2047	Returns an arrayref with all map paths of currently instantiated and saved
		2048	maps. May block.
		2049
		2050	=cut
		2051
		2052	sub tmp_maps() {
		2053	[
		2054	map {
		2055	utf8::decode $_;
		2056	/\.map$/
		2057	? normalise $_
		2058	: ()
		2059	} @{ aio_readdir $TMPDIR or [] }
		2060	]
		2061	}
		2062
		2063	=item $maps = cf::map::random_maps
		2064
		2065	Returns an arrayref with all map paths of currently instantiated and saved
		2066	random maps. May block.
		2067
		2068	=cut
		2069
		2070	sub random_maps() {
		2071	[
		2072	map {
		2073	utf8::decode $_;
		2074	/\.map$/
		2075	? normalise "?random/$_"
		2076	: ()
		2077	} @{ aio_readdir $RANDOMDIR or [] }
		2078	]
		2079	}
		2080
1772	=item cf::map::unique_maps	2081	=item cf::map::unique_maps
1773		2082
1774	Returns an arrayref of paths of all shared maps that have	2083	Returns an arrayref of paths of all shared maps that have
1775	instantiated unique items. May block.	2084	instantiated unique items. May block.
1776		2085
1777	=cut	2086	=cut
1778		2087
1779	sub unique_maps() {	2088	sub unique_maps() {
1780	my $files = aio_readdir $UNIQUEDIR	2089	[
1781	or return;	2090	map {
1782
1783	my @paths;
1784
1785	for (@$files) {
1786	utf8::decode $_;	2091	utf8::decode $_;
1787	next if /\.pst$/;	2092	/\.map$/
1788	next unless /^$PATH_SEP/o;	2093	? normalise $_
1789		2094	: ()
1790	push @paths, cf::map::normalise $_;	2095	} @{ aio_readdir $UNIQUEDIR or [] }
1791	}	2096	]
1792
1793	\@paths
1794	}	2097	}
1795		2098
1796	package cf;	2099	package cf;
1797		2100
1798	=back	2101	=back
…		…
1844		2147
1845	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2148	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846		2149
1847	if ($self->{record_replies}) {	2150	if ($self->{record_replies}) {
1848	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2151	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2152
1849	} else {	2153	} else {
		2154	my $pl = $self->contr;
		2155
		2156	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2157	my $diag = $pl->{npc_dialog};
		2158	$diag->{pl}->ext_reply (
		2159	$diag->{id},
		2160	msgtype => "reply",
		2161	msg => $diag->{pl}->expand_cfpod ($msg),
		2162	add_topics => []
		2163	);
		2164
		2165	} else {
1850	$msg = $npc->name . " says: $msg" if $npc;	2166	$msg = $npc->name . " says: $msg" if $npc;
1851	$self->message ($msg, $flags);	2167	$self->message ($msg, $flags);
		2168	}
1852	}	2169	}
1853	}	2170	}
1854		2171
1855	=item $player_object->may ("access")	2172	=item $player_object->may ("access")
1856		2173
…		…
1904	$self->deactivate_recursive;	2221	$self->deactivate_recursive;
1905		2222
1906	return if UNIVERSAL::isa $self->map, "ext::map_link";	2223	return if UNIVERSAL::isa $self->map, "ext::map_link";
1907		2224
1908	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2225	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909	if $self->map;	2226	if $self->map && $self->map->{path} ne "{link}";
1910		2227
1911	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2228	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1912	}	2229	}
1913		2230
1914	sub cf::object::player::leave_link {	2231	sub cf::object::player::leave_link {
1915	my ($self, $map, $x, $y) = @_;	2232	my ($self, $map, $x, $y) = @_;
		2233
		2234	return unless $self->contr->active;
1916		2235
1917	my $link_pos = delete $self->{_link_pos};	2236	my $link_pos = delete $self->{_link_pos};
1918		2237
1919	unless ($map) {	2238	unless ($map) {
1920	# restore original map position	2239	# restore original map position
…		…
1943		2262
1944	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2263	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945	$self->enter_map ($map, $x, $y);	2264	$self->enter_map ($map, $x, $y);
1946	}	2265	}
1947		2266
1948	cf::player->attach (	2267	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949	on_logout => sub {
1950	my ($pl) = @_;
1951		2268
1952	# abort map switching before logout	2269	Moves the player to the given map-path and coordinates by first freezing
1953	if ($pl->ob->{_link_pos}) {	2270	her, loading and preparing them map, calling the provided $check callback
1954	cf::sync_job {	2271	that has to return the map if sucecssful, and then unfreezes the player on
1955	$pl->ob->leave_link	2272	the new (success) or old (failed) map position. In either case, $done will
1956	};	2273	be called at the end of this process.
1957	}
1958	},
1959	on_login => sub {
1960	my ($pl) = @_;
1961		2274
1962	# try to abort aborted map switching on player login :)
1963	# should happen only on crashes
1964	if ($pl->ob->{_link_pos}) {
1965	$pl->ob->enter_link;
1966	(async {
1967	$pl->ob->reply (undef,
1968	"There was an internal problem at your last logout, "
1969	. "the server will try to bring you to your intended destination in a second.",
1970	cf::NDI_RED);
1971	# we need this sleep as the login has a concurrent enter_exit running
1972	# and this sleep increases chances of the player not ending up in scorn
1973	Coro::Timer::sleep 1;
1974	$pl->ob->leave_link;
1975	})->prio (2);
1976	}
1977	},
1978	);
1979
1980	=item $player_object->goto ($path, $x, $y)
1981
1982	=cut	2275	=cut
		2276
		2277	our $GOTOGEN;
1983		2278
1984	sub cf::object::player::goto {	2279	sub cf::object::player::goto {
1985	my ($self, $path, $x, $y) = @_;	2280	my ($self, $path, $x, $y, $check, $done) = @_;
		2281
		2282	# do generation counting so two concurrent goto's will be executed in-order
		2283	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1986		2284
1987	$self->enter_link;	2285	$self->enter_link;
1988		2286
1989	(async {	2287	(async {
1990	my $map = eval {	2288	my $map = eval {
1991	my $map = cf::map::find $path;	2289	my $map = cf::map::find $path;
		2290
		2291	if ($map) {
1992	$map = $map->customise_for ($self) if $map;	2292	$map = $map->customise_for ($self);
		2293	$map = $check->($map) if $check && $map;
		2294	} else {
		2295	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2296	}
		2297
1993	$map	2298	$map
		2299	};
		2300
		2301	if ($@) {
		2302	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2303	LOG llevError | logBacktrace, Carp::longmess $@;
1994	} or	2304	}
1995	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1996		2305
		2306	if ($gen == $self->{_goto_generation}) {
		2307	delete $self->{_goto_generation};
1997	$self->leave_link ($map, $x, $y);	2308	$self->leave_link ($map, $x, $y);
		2309	}
		2310
		2311	$done->() if $done;
1998	})->prio (1);	2312	})->prio (1);
1999	}	2313	}
2000		2314
2001	=item $player_object->enter_exit ($exit_object)	2315	=item $player_object->enter_exit ($exit_object)
2002		2316
…		…
2071	my $hp = $exit->stats->hp;	2385	my $hp = $exit->stats->hp;
2072	my $sp = $exit->stats->sp;	2386	my $sp = $exit->stats->sp;
2073		2387
2074	$self->enter_link;	2388	$self->enter_link;
2075		2389
		2390	# if exit is damned, update players death & WoR home-position
		2391	$self->contr->savebed ($slaying, $hp, $sp)
		2392	if $exit->flag (FLAG_DAMNED);
		2393
2076	(async {	2394	(async {
2077	$self->deactivate_recursive; # just to be sure	2395	$self->deactivate_recursive; # just to be sure
2078	unless (eval {	2396	unless (eval {
2079	$self->goto ($slaying, $hp, $sp);	2397	$self->goto ($slaying, $hp, $sp);
2080		2398
…		…
2107		2425
2108	utf8::encode $text;	2426	utf8::encode $text;
2109	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2427	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2110	}	2428	}
2111		2429
		2430	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2431
		2432	Send a drawinfo or msg packet to the client, formatting the msg for the
		2433	client if neccessary. C<$type> should be a string identifying the type of
		2434	the message, with C<log> being the default. If C<$color> is negative, suppress
		2435	the message unless the client supports the msg packet.
		2436
		2437	=cut
		2438
		2439	sub cf::client::send_msg {
		2440	my ($self, $channel, $msg, $color, @extra) = @_;
		2441
		2442	$msg = $self->pl->expand_cfpod ($msg);
		2443
		2444	return unless @extra || length $msg;
		2445
		2446	$color &= ~cf::NDI_UNIQUE; # just in case...
		2447
		2448	if (ref $channel) {
		2449	# send meta info to client, if not yet sent
		2450	unless (exists $self->{channel}{$channel->{id}}) {
		2451	$self->{channel}{$channel->{id}} = $channel;
		2452	$self->ext_event (channel_info => %$channel);
		2453	}
		2454
		2455	$channel = $channel->{id};
		2456	}
		2457
		2458	if ($self->can_msg) {
		2459	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
		2460	} else {
		2461	# replace some tags by gcfclient-compatible ones
		2462	for ($msg) {
		2463	1 while
		2464	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2465	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2466	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2467	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2468	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2469	}
		2470
		2471	if ($color >= 0) {
		2472	if (0 && $msg =~ /\[/) {
		2473	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2474	} else {
		2475	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2476	$self->send_packet ("drawinfo $color $msg")
		2477	}
		2478	}
		2479	}
		2480	}
		2481
2112	=item $client->ext_event ($type, %msg)	2482	=item $client->ext_event ($type, %msg)
2113		2483
2114	Sends an exti event to the client.	2484	Sends an ext event to the client.
2115		2485
2116	=cut	2486	=cut
2117		2487
2118	sub cf::client::ext_event($$%) {	2488	sub cf::client::ext_event($$%) {
2119	my ($self, $type, %msg) = @_;	2489	my ($self, $type, %msg) = @_;
2120		2490
		2491	return unless $self->extcmd;
		2492
2121	$msg{msgtype} = "event_$type";	2493	$msg{msgtype} = "event_$type";
2122	$self->send_packet ("ext " . cf::to_json \%msg);	2494	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2123	}	2495	}
2124		2496
2125	=item $success = $client->query ($flags, "text", \&cb)	2497	=item $success = $client->query ($flags, "text", \&cb)
2126		2498
2127	Queues a query to the client, calling the given callback with	2499	Queues a query to the client, calling the given callback with
2128	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2500	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2129	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2501	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2130		2502
2131	Queries can fail, so check the return code. Or don't, as queries will become	2503	Queries can fail, so check the return code. Or don't, as queries will
2132	reliable at some point in the future.	2504	become reliable at some point in the future.
2133		2505
2134	=cut	2506	=cut
2135		2507
2136	sub cf::client::query {	2508	sub cf::client::query {
2137	my ($self, $flags, $text, $cb) = @_;	2509	my ($self, $flags, $text, $cb) = @_;
…		…
2145	utf8::encode $text;	2517	utf8::encode $text;
2146	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2518	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2147		2519
2148	$self->send_packet ($self->{query_queue}[0][0])	2520	$self->send_packet ($self->{query_queue}[0][0])
2149	if @{ $self->{query_queue} } == 1;	2521	if @{ $self->{query_queue} } == 1;
		2522
		2523	1
2150	}	2524	}
2151		2525
2152	cf::client->attach (	2526	cf::client->attach (
		2527	on_connect => sub {
		2528	my ($ns) = @_;
		2529
		2530	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2531	},
2153	on_reply => sub {	2532	on_reply => sub {
2154	my ($ns, $msg) = @_;	2533	my ($ns, $msg) = @_;
2155		2534
2156	# this weird shuffling is so that direct followup queries	2535	# this weird shuffling is so that direct followup queries
2157	# get handled first	2536	# get handled first
…		…
2169	} else {	2548	} else {
2170	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2549	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2171	}	2550	}
2172	}	2551	}
2173	},	2552	},
		2553	on_exticmd => sub {
		2554	my ($ns, $buf) = @_;
		2555
		2556	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2557
		2558	if (ref $msg) {
		2559	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2560	if (my %reply = $cb->($ns, $msg)) {
		2561	$reply{msgid} = $msg->{msgid};
		2562	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2563	}
		2564	}
		2565	} else {
		2566	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2567	}
		2568
		2569	cf::override;
		2570	},
2174	);	2571	);
2175		2572
2176	=item $client->async (\&cb)	2573	=item $client->async (\&cb)
2177		2574
2178	Create a new coroutine, running the specified callback. The coroutine will	2575	Create a new coroutine, running the specified callback. The coroutine will
…		…
2227		2624
2228	=pod	2625	=pod
2229		2626
2230	The following functions and methods are available within a safe environment:	2627	The following functions and methods are available within a safe environment:
2231		2628
2232	cf::object contr pay_amount pay_player map	2629	cf::object
		2630	contr pay_amount pay_player map x y force_find force_add
		2631	insert remove
		2632
2233	cf::object::player player	2633	cf::object::player
2234	cf::player peaceful	2634	player
2235	cf::map trigger	2635
		2636	cf::player
		2637	peaceful
		2638
		2639	cf::map
		2640	trigger
2236		2641
2237	=cut	2642	=cut
2238		2643
2239	for (	2644	for (
2240	["cf::object" => qw(contr pay_amount pay_player map)],	2645	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2646	insert remove)],
2241	["cf::object::player" => qw(player)],	2647	["cf::object::player" => qw(player)],
2242	["cf::player" => qw(peaceful)],	2648	["cf::player" => qw(peaceful)],
2243	["cf::map" => qw(trigger)],	2649	["cf::map" => qw(trigger)],
2244	) {	2650	) {
2245	no strict 'refs';	2651	no strict 'refs';
…		…
2316	=back	2722	=back
2317		2723
2318	=cut	2724	=cut
2319		2725
2320	#############################################################################	2726	#############################################################################
2321
2322	=head2 EXTENSION DATABASE SUPPORT
2323
2324	Crossfire maintains a very simple database for extension use. It can
2325	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2326	convert to/from binary).
2327
2328	The parameter C<$family> should best start with the name of the extension
2329	using it, it should be unique.
2330
2331	=over 4
2332
2333	=item $value = cf::db_get $family => $key
2334
2335	Returns a single value from the database.
2336
2337	=item cf::db_put $family => $key => $value
2338
2339	Stores the given C<$value> in the family.
2340
2341	=cut
2342
2343	our $DB;
2344
2345	sub db_init {
2346	unless ($DB) {
2347	$DB = BDB::db_create $DB_ENV;
2348
2349	cf::sync_job {
2350	eval {
2351	$DB->set_flags (BDB::CHKSUM);
2352
2353	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2354	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2355	cf::cleanup "db_open(db): $!" if $!;
2356	};
2357	cf::cleanup "db_open(db): $@" if $@;
2358	};
2359	}
2360	}
2361
2362	sub db_get($$) {
2363	my $key = "$_[0]/$_[1]";
2364
2365	cf::sync_job {
2366	BDB::db_get $DB, undef, $key, my $data;
2367
2368	$! ? ()
2369	: $data
2370	}
2371	}
2372
2373	sub db_put($$$) {
2374	BDB::dbreq_pri 4;
2375	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2376	}
2377
2378	=item cf::cache $id => [$paths...], $processversion => $process
2379
2380	Generic caching function that returns the value of the resource $id,
2381	caching and regenerating as required.
2382
2383	This function can block.
2384
2385	=cut
2386
2387	sub cache {
2388	my ($id, $src, $processversion, $process) = @_;
2389
2390	my $meta =
2391	join "\x00",
2392	$processversion,
2393	map {
2394	aio_stat $_
2395	and Carp::croak "$_: $!";
2396
2397	($_, (stat _)[7,9])
2398	} @$src;
2399
2400	my $dbmeta = db_get cache => "$id/meta";
2401	if ($dbmeta ne $meta) {
2402	# changed, we may need to process
2403
2404	my @data;
2405	my $md5;
2406
2407	for (0 .. $#$src) {
2408	0 <= aio_load $src->[$_], $data[$_]
2409	or Carp::croak "$src->[$_]: $!";
2410	}
2411
2412	# if processing is expensive, check
2413	# checksum first
2414	if (1) {
2415	$md5 =
2416	join "\x00",
2417	$processversion,
2418	map {
2419	Coro::cede;
2420	($src->[$_], Digest::MD5::md5_hex $data[$_])
2421	} 0.. $#$src;
2422
2423
2424	my $dbmd5 = db_get cache => "$id/md5";
2425	if ($dbmd5 eq $md5) {
2426	db_put cache => "$id/meta", $meta;
2427
2428	return db_get cache => "$id/data";
2429	}
2430	}
2431
2432	my $t1 = Time::HiRes::time;
2433	my $data = $process->(\@data);
2434	my $t2 = Time::HiRes::time;
2435
2436	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2437
2438	db_put cache => "$id/data", $data;
2439	db_put cache => "$id/md5" , $md5;
2440	db_put cache => "$id/meta", $meta;
2441
2442	return $data;
2443	}
2444
2445	db_get cache => "$id/data"
2446	}
2447
2448	=item fork_call { }, $args
2449
2450	Executes the given code block with the given arguments in a seperate
2451	process, returning the results. Everything must be serialisable with
2452	Coro::Storable. May, of course, block. Note that the executed sub may
2453	never block itself or use any form of Event handling.
2454
2455	=cut
2456
2457	sub fork_call(&@) {
2458	my ($cb, @args) = @_;
2459
2460	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2461	# or die "socketpair: $!";
2462	pipe my $fh1, my $fh2
2463	or die "pipe: $!";
2464
2465	if (my $pid = fork) {
2466	close $fh2;
2467
2468	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2469	$res = Coro::Storable::thaw $res;
2470
2471	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2472
2473	die $$res unless "ARRAY" eq ref $res;
2474
2475	return wantarray ? @$res : $res->[-1];
2476	} else {
2477	reset_signals;
2478	local $SIG{__WARN__};
2479	local $SIG{__DIE__};
2480	eval {
2481	close $fh1;
2482
2483	my @res = eval { $cb->(@args) };
2484	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2485	};
2486
2487	warn $@ if $@;
2488	_exit 0;
2489	}
2490	}
2491
2492
2493
2494	#############################################################################
2495	# the server's init and main functions	2727	# the server's init and main functions
2496		2728
2497	sub load_facedata($) {	2729	sub load_facedata($) {
2498	my ($path) = @_;	2730	my ($path) = @_;
2499		2731
…		…
2511	{	2743	{
2512	my $faces = $facedata->{faceinfo};	2744	my $faces = $facedata->{faceinfo};
2513		2745
2514	while (my ($face, $info) = each %$faces) {	2746	while (my ($face, $info) = each %$faces) {
2515	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2747	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2516	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2748	cf::face::set_visibility $idx, $info->{visibility};
		2749	cf::face::set_magicmap $idx, $info->{magicmap};
2517	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2750	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2518	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2751	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2519	Coro::cede;	2752
		2753	cf::cede_to_tick;
2520	}	2754	}
2521		2755
2522	while (my ($face, $info) = each %$faces) {	2756	while (my ($face, $info) = each %$faces) {
2523	next unless $info->{smooth};	2757	next unless $info->{smooth};
2524	my $idx = cf::face::find $face	2758	my $idx = cf::face::find $face
2525	or next;	2759	or next;
2526	if (my $smooth = cf::face::find $info->{smooth}) {	2760	if (my $smooth = cf::face::find $info->{smooth}) {
		2761	cf::face::set_smooth $idx, $smooth;
2527	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2762	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2528	} else {	2763	} else {
2529	warn "smooth face '$info->{smooth}' not found for face '$face'";	2764	warn "smooth face '$info->{smooth}' not found for face '$face'";
2530	}	2765	}
2531	Coro::cede;	2766
		2767	cf::cede_to_tick;
2532	}	2768	}
2533	}	2769	}
2534		2770
2535	{	2771	{
2536	my $anims = $facedata->{animinfo};	2772	my $anims = $facedata->{animinfo};
2537		2773
2538	while (my ($anim, $info) = each %$anims) {	2774	while (my ($anim, $info) = each %$anims) {
2539	cf::anim::set $anim, $info->{frames}, $info->{facings};	2775	cf::anim::set $anim, $info->{frames}, $info->{facings};
2540	Coro::cede;	2776	cf::cede_to_tick;
2541	}	2777	}
2542		2778
2543	cf::anim::invalidate_all; # d'oh	2779	cf::anim::invalidate_all; # d'oh
		2780	}
		2781
		2782	{
		2783	# TODO: for gcfclient pleasure, we should give resources
		2784	# that gcfclient doesn't grok a >10000 face index.
		2785	my $res = $facedata->{resource};
		2786	my $enc = JSON::XS->new->utf8->canonical;
		2787
		2788	while (my ($name, $info) = each %$res) {
		2789	my $meta = $enc->encode ({
		2790	name => $name,
		2791	type => $info->{type},
		2792	copyright => $info->{copyright}, #TODO#
		2793	});
		2794
		2795	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2796
		2797	if ($name =~ /\.jpg$/) {
		2798	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2799	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2800	} else {
		2801	my $data = pack "(w/a*)*", $meta, $info->{data};
		2802	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2803
		2804	cf::face::set_type $idx, 1;
		2805	cf::face::set_data $idx, 0, $data, $chk;
		2806	}
		2807
		2808	cf::cede_to_tick;
		2809	}
2544	}	2810	}
2545		2811
2546	1	2812	1
2547	}	2813	}
2548		2814
2549	sub reload_regions {	2815	sub reload_regions {
2550	load_resource_file "$MAPDIR/regions"	2816	load_resource_file "$MAPDIR/regions"
2551	or die "unable to load regions file\n";	2817	or die "unable to load regions file\n";
		2818
		2819	for (cf::region::list) {
		2820	$_->{match} = qr/$_->{match}/
		2821	if exists $_->{match};
		2822	}
2552	}	2823	}
2553		2824
2554	sub reload_facedata {	2825	sub reload_facedata {
2555	load_facedata "$DATADIR/facedata"	2826	load_facedata "$DATADIR/facedata"
2556	or die "unable to load facedata\n";	2827	or die "unable to load facedata\n";
2557	}	2828	}
2558		2829
2559	sub reload_archetypes {	2830	sub reload_archetypes {
2560	load_resource_file "$DATADIR/archetypes"	2831	load_resource_file "$DATADIR/archetypes"
2561	or die "unable to load archetypes\n";	2832	or die "unable to load archetypes\n";
		2833	#d# NEED to laod twice to resolve forward references
		2834	# this really needs to be done in an extra post-pass
		2835	# (which needs to be synchronous, so solve it differently)
		2836	load_resource_file "$DATADIR/archetypes"
		2837	or die "unable to load archetypes\n";
2562	}	2838	}
2563		2839
2564	sub reload_treasures {	2840	sub reload_treasures {
2565	load_resource_file "$DATADIR/treasures"	2841	load_resource_file "$DATADIR/treasures"
2566	or die "unable to load treasurelists\n";	2842	or die "unable to load treasurelists\n";
…		…
2569	sub reload_resources {	2845	sub reload_resources {
2570	warn "reloading resource files...\n";	2846	warn "reloading resource files...\n";
2571		2847
2572	reload_regions;	2848	reload_regions;
2573	reload_facedata;	2849	reload_facedata;
		2850	#reload_archetypes;#d#
2574	reload_archetypes;	2851	reload_archetypes;
2575	reload_treasures;	2852	reload_treasures;
2576		2853
2577	warn "finished reloading resource files\n";	2854	warn "finished reloading resource files\n";
2578	}	2855	}
…		…
2635	},	2912	},
2636	);	2913	);
2637	}	2914	}
2638	}	2915	}
2639		2916
		2917	sub write_runtime {
		2918	my $runtime = "$LOCALDIR/runtime";
		2919
		2920	# first touch the runtime file to show we are still running:
		2921	# the fsync below can take a very very long time.
		2922
		2923	IO::AIO::aio_utime $runtime, undef, undef;
		2924
		2925	my $guard = cf::lock_acquire "write_runtime";
		2926
		2927	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2928	or return;
		2929
		2930	my $value = $cf::RUNTIME + 90 + 10;
		2931	# 10 is the runtime save interval, for a monotonic clock
		2932	# 60 allows for the watchdog to kill the server.
		2933
		2934	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2935	and return;
		2936
		2937	# always fsync - this file is important
		2938	aio_fsync $fh
		2939	and return;
		2940
		2941	# touch it again to show we are up-to-date
		2942	aio_utime $fh, undef, undef;
		2943
		2944	close $fh
		2945	or return;
		2946
		2947	aio_rename "$runtime~", $runtime
		2948	and return;
		2949
		2950	warn "runtime file written.\n";
		2951
		2952	1
		2953	}
		2954
2640	sub emergency_save() {	2955	sub emergency_save() {
2641	my $freeze_guard = cf::freeze_mainloop;	2956	my $freeze_guard = cf::freeze_mainloop;
2642		2957
2643	warn "enter emergency perl save\n";	2958	warn "enter emergency perl save\n";
2644		2959
…		…
2719	%EXT_CORO = ();	3034	%EXT_CORO = ();
2720		3035
2721	warn "removing commands";	3036	warn "removing commands";
2722	%COMMAND = ();	3037	%COMMAND = ();
2723		3038
2724	warn "removing ext commands";	3039	warn "removing ext/exti commands";
2725	%EXTCMD = ();	3040	%EXTCMD = ();
		3041	%EXTICMD = ();
2726		3042
2727	warn "unloading/nuking all extensions";	3043	warn "unloading/nuking all extensions";
2728	for my $pkg (@EXTS) {	3044	for my $pkg (@EXTS) {
2729	warn "... unloading $pkg";	3045	warn "... unloading $pkg";
2730		3046
…		…
2848	my $signal = new Coro::Signal;	3164	my $signal = new Coro::Signal;
2849	push @WAIT_FOR_TICK_BEGIN, $signal;	3165	push @WAIT_FOR_TICK_BEGIN, $signal;
2850	$signal->wait;	3166	$signal->wait;
2851	}	3167	}
2852		3168
		3169	my $min = 1e6;#d#
		3170	my $avg = 10;
2853	$TICK_WATCHER = Event->timer (	3171	$TICK_WATCHER = Event->timer (
2854	reentrant => 0,	3172	reentrant => 0,
2855	parked => 1,	3173	parked => 1,
2856	prio => 0,	3174	prio => 0,
2857	at => $NEXT_TICK || $TICK,	3175	at => $NEXT_TICK || $TICK,
…		…
2864	}	3182	}
2865		3183
2866	$NOW = $tick_start = Event::time;	3184	$NOW = $tick_start = Event::time;
2867		3185
2868	cf::server_tick; # one server iteration	3186	cf::server_tick; # one server iteration
		3187
		3188	0 && sync_job {#d#
		3189	for(1..10) {
		3190	my $t = Event::time;
		3191	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3192	or die;
		3193
		3194	$map->width (50);
		3195	$map->height (50);
		3196	$map->alloc;
		3197	$map->_load_objects ("/tmp/x.map", 1);
		3198	my $t = Event::time - $t;
		3199
		3200	#next unless $t < 0.0013;#d#
		3201	if ($t < $min) {
		3202	$min = $t;
		3203	}
		3204	$avg = $avg * 0.99 + $t * 0.01;
		3205	}
		3206	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3207	exit 0;
		3208	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3209	};
2869		3210
2870	$RUNTIME += $TICK;	3211	$RUNTIME += $TICK;
2871	$NEXT_TICK += $TICK;	3212	$NEXT_TICK += $TICK;
2872		3213
2873	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3214	if ($NOW >= $NEXT_RUNTIME_WRITE) {

Diff Legend

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