[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 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	IO::AIO::aio_utime $runtime, undef, undef;	419	=cut
401		420
402	my $guard = cf::lock_acquire "write_runtime";	421	sub _store_scalar {
403		422	open my $fh, ">", \my $buf
404	my $fh = aio_open "$runtime~", O_WRONLY \| O_CREAT, 0644	423	or die "fork_call: cannot open fh-to-buf in child : $!";
405	or return;	424	Storable::store_fd $_[0], $fh;
406
407	my $value = $cf::RUNTIME + 90 + 10;
408	# 10 is the runtime save interval, for a monotonic clock
409	# 60 allows for the watchdog to kill the server.
410
411	(aio_write $fh, 0, (length $value), $value, 0) <= 0
412	and return;
413
414	# always fsync - this file is important
415	aio_fsync $fh
416	and return;
417
418	# touch it again to show we are up-to-date
419	aio_utime $fh, undef, undef;
420
421	close $fh	425	close $fh;
422	or return;
423		426
424	aio_rename "$runtime~", $runtime	427	$buf
425	and return;	428	}
426		429
427	warn "runtime file written.\n";#d#	430	sub fork_call(&@) {
		431	my ($cb, @args) = @_;
428		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;
429	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"
430	}	588	}
431		589
432	=item cf::datalog type => key => value, ...	590	=item cf::datalog type => key => value, ...
433		591
434	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.
…		…
452	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")
453	to it. All such attachable objects support the following methods.	611	to it. All such attachable objects support the following methods.
454		612
455	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>
456	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
457	crossfire+).	615	Crossfire TRT).
458		616
459	=over 4	617	=over 4
460		618
461	=item $attachable->attach ($attachment, key => $value...)	619	=item $attachable->attach ($attachment, key => $value...)
462		620
…		…
664	_attach $registry, $klass, @attach;	822	_attach $registry, $klass, @attach;
665	}	823	}
666		824
667	$obj->{$name} = \%arg;	825	$obj->{$name} = \%arg;
668	} else {	826	} else {
669	warn "object uses attachment '$name' that is not available, postponing.\n";	827	warn "object uses attachment '$name' which is not available, postponing.\n";
670	}	828	}
671		829
672	$obj->{_attachment}{$name} = undef;	830	$obj->{_attachment}{$name} = undef;
673	}	831	}
674		832
…		…
714	";	872	";
715	die if $@;	873	die if $@;
716	}	874	}
717		875
718	our $override;	876	our $override;
719	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?
720		878
721	sub override {	879	sub override {
722	$override = 1;	880	$override = 1;
723	@invoke_results = ();	881	@INVOKE_RESULTS = (@_);
724	}	882	}
725		883
726	sub do_invoke {	884	sub do_invoke {
727	my $event = shift;	885	my $event = shift;
728	my $callbacks = shift;	886	my $callbacks = shift;
729		887
730	@invoke_results = ();	888	@INVOKE_RESULTS = ();
731		889
732	local $override;	890	local $override;
733		891
734	for (@$callbacks) {	892	for (@$callbacks) {
735	eval { &{$_->[1]} };	893	eval { &{$_->[1]} };
…		…
752		910
753	Generate an object-specific event with the given arguments.	911	Generate an object-specific event with the given arguments.
754		912
755	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
756	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
757	results (if you must, access C<@cf::invoke_results> directly).	915	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758		916
759	=back	917	=back
760		918
761	=cut	919	=cut
762		920
…		…
872	or return;	1030	or return;
873	$av = eval { (Storable::thaw $av)->{objs} };	1031	$av = eval { (Storable::thaw $av)->{objs} };
874	}	1032	}
875		1033
876	warn sprintf "loading %s (%d)\n",	1034	warn sprintf "loading %s (%d)\n",
877	$filename, length $data, scalar @{$av \|\| []};#d#	1035	$filename, length $data, scalar @{$av \|\| []};
878	return ($data, $av);	1036	return ($data, $av);
879	}	1037	}
		1038
		1039	=head2 COMMAND CALLBACKS
		1040
		1041	=over 4
		1042
		1043	=cut
880		1044
881	#############################################################################	1045	#############################################################################
882	# command handling &c	1046	# command handling &c
883		1047
884	=item cf::register_command $name => \&callback($ob,$args);	1048	=item cf::register_command $name => \&callback($ob,$args);
…		…
897	push @{ $COMMAND{$name} }, [$caller, $cb];	1061	push @{ $COMMAND{$name} }, [$caller, $cb];
898	}	1062	}
899		1063
900	=item cf::register_extcmd $name => \&callback($pl,$packet);	1064	=item cf::register_extcmd $name => \&callback($pl,$packet);
901		1065
902	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.
903		1071
904	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
905	called.	1073	called.
906		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
907	=cut	1086	=cut
908		1087
909	sub register_extcmd {	1088	sub register_extcmd {
910	my ($name, $cb) = @_;	1089	my ($name, $cb) = @_;
911		1090
912	$EXTCMD{$name} = $cb;	1091	$EXTCMD{$name} = $cb;
		1092	}
		1093
		1094	sub register_exticmd {
		1095	my ($name, $cb) = @_;
		1096
		1097	$EXTICMD{$name} = $cb;
913	}	1098	}
914		1099
915	cf::player->attach (	1100	cf::player->attach (
916	on_command => sub {	1101	on_command => sub {
917	my ($pl, $name, $params) = @_;	1102	my ($pl, $name, $params) = @_;
…		…
926	cf::override;	1111	cf::override;
927	},	1112	},
928	on_extcmd => sub {	1113	on_extcmd => sub {
929	my ($pl, $buf) = @_;	1114	my ($pl, $buf) = @_;
930		1115
931	my $msg = eval { from_json $buf };	1116	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932		1117
933	if (ref $msg) {	1118	if (ref $msg) {
934	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1119	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
935	if (my %reply = $cb->($pl, $msg)) {	1120	if (my %reply = $cb->($pl, $msg)) {
936	$pl->ext_reply ($msg->{msgid}, %reply);	1121	$pl->ext_reply ($msg->{msgid}, %reply);
…		…
942		1127
943	cf::override;	1128	cf::override;
944	},	1129	},
945	);	1130	);
946		1131
947	sub load_extension {
948	my ($path) = @_;
949
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955
956	warn "... loading '$path' into '$pkg'\n";
957
958	open my $fh, "<:utf8", $path
959	or die "$path: $!";
960
961	my $source =
962	"package $pkg; use strict; use utf8;\n"
963	. "#line 1 \"$path\"\n{\n"
964	. (do { local $/; <$fh> })
965	. "\n};\n1";
966
967	unless (eval $source) {
968	my $msg = $@ ? "$path: $@\n"
969	: "extension disabled.\n";
970	if ($source =~ /^#!.perl.#.*MANDATORY/m) { # ugly match
971	warn $@;
972	warn "mandatory extension failed to load, exiting.\n";
973	exit 1;
974	}
975	die $@;
976	}
977
978	push @EXTS, $pkg;
979	}
980
981	sub load_extensions {	1132	sub load_extensions {
		1133	cf::sync_job {
		1134	my %todo;
		1135
982	for my $ext (<$LIBDIR/*.ext>) {	1136	for my $path (<$LIBDIR/*.ext>) {
983	next unless -r $ext;	1137	next unless -r $path;
984	eval {	1138
985	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;
986	1	1196	}
987	} or warn "$ext not loaded: $@";	1197
		1198	skip:
		1199	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1200	unless $progress;
		1201	}
988	}	1202	};
989	}	1203	}
990		1204
991	#############################################################################	1205	#############################################################################
		1206
		1207	=back
992		1208
993	=head2 CORE EXTENSIONS	1209	=head2 CORE EXTENSIONS
994		1210
995	Functions and methods that extend core crossfire objects.	1211	Functions and methods that extend core crossfire objects.
996		1212
…		…
1184	}	1400	}
1185		1401
1186	\@paths	1402	\@paths
1187	}	1403	}
1188		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/&/&/g;
		1416	s/(?<![BIUGH])</</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
1189	=item $player->ext_reply ($msgid, %msg)	1455	=item $player->ext_reply ($msgid, %msg)
1190		1456
1191	Sends an ext reply to the player.	1457	Sends an ext reply to the player.
1192		1458
1193	=cut	1459	=cut
1194		1460
1195	sub ext_reply($$%) {	1461	sub ext_reply($$%) {
1196	my ($self, $id, %msg) = @_;	1462	my ($self, $id, %msg) = @_;
1197		1463
1198	$msg{msgid} = $id;	1464	$msg{msgid} = $id;
1199		1465	$self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1200	$self->send ("ext " . cf::to_json \%msg);
1201	}	1466	}
1202		1467
1203	=item $player->ext_event ($type, %msg)	1468	=item $player->ext_event ($type, %msg)
1204		1469
1205	Sends an ext event to the client.	1470	Sends an ext event to the client.
…		…
1220		1485
1221	package cf::region;	1486	package cf::region;
1222		1487
1223	=item cf::region::find_by_path $path	1488	=item cf::region::find_by_path $path
1224		1489
1225	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.
1226		1491
1227	=cut	1492	=cut
1228		1493
1229	sub find_by_path($) {	1494	sub find_by_path($) {
1230	my ($path) = @_;	1495	my ($path) = @_;
1231		1496
1232	my ($match, $specificity);	1497	my ($match, $specificity);
1233		1498
1234	for my $region (list) {	1499	for my $region (list) {
1235	if ($region->match && $path =~ $region->match) {	1500	if ($region->{match} && $path =~ $region->{match}) {
1236	($match, $specificity) = ($region, $region->specificity)	1501	($match, $specificity) = ($region, $region->specificity)
1237	if $region->specificity > $specificity;	1502	if $region->specificity > $specificity;
1238	}	1503	}
1239	}	1504	}
1240		1505
…		…
1304	my ($self, $merge) = @_;	1569	my ($self, $merge) = @_;
1305		1570
1306	# we have to keep some variables in memory intact	1571	# we have to keep some variables in memory intact
1307	local $self->{path};	1572	local $self->{path};
1308	local $self->{load_path};	1573	local $self->{load_path};
1309	local $self->{deny_save};
1310	local $self->{deny_reset};
1311		1574
1312	$self->SUPER::thawer_merge ($merge);	1575	$self->SUPER::thawer_merge ($merge);
1313	}	1576	}
1314		1577
1315	sub normalise {	1578	sub normalise {
…		…
1362	$self->init; # pass $1 etc.	1625	$self->init; # pass $1 etc.
1363	return $self;	1626	return $self;
1364	}	1627	}
1365	}	1628	}
1366		1629
1367	Carp::carp "unable to resolve path '$path' (base '$base').";	1630	Carp::cluck "unable to resolve path '$path' (base '$base').";
1368	()	1631	()
1369	}	1632	}
1370		1633
1371	sub init {	1634	sub init {
1372	my ($self) = @_;	1635	my ($self) = @_;
…		…
1413	sub change_all_map_light {	1676	sub change_all_map_light {
1414	my ($change) = @_;	1677	my ($change) = @_;
1415		1678
1416	$_->change_map_light ($change)	1679	$_->change_map_light ($change)
1417	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;
1418	}	1689	}
1419		1690
1420	sub unlink_save {	1691	sub unlink_save {
1421	my ($self) = @_;	1692	my ($self) = @_;
1422		1693
…		…
1480	$self->load_header_orig	1751	$self->load_header_orig
1481	or return;	1752	or return;
1482	$self->prepare_orig;	1753	$self->prepare_orig;
1483	}	1754	}
1484		1755
		1756	$self->{deny_reset} = 1
		1757	if $self->no_reset;
		1758
1485	$self->default_region (cf::region::find_by_path $self->{path})	1759	$self->default_region (cf::region::find_by_path $self->{path})
1486	unless $self->default_region;	1760	unless $self->default_region;
1487		1761
1488	1	1762	1
1489	}	1763	}
…		…
1504	$map->{last_save} = $cf::RUNTIME;	1778	$map->{last_save} = $cf::RUNTIME;
1505		1779
1506	$map->load_header	1780	$map->load_header
1507	or return;	1781	or return;
1508		1782
1509	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1783	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510	# doing this can freeze the server in a sync job, obviously	1784	# doing this can freeze the server in a sync job, obviously
1511	#$cf::WAIT_FOR_TICK->wait;	1785	#$cf::WAIT_FOR_TICK->wait;
1512	$map->reset;	1786	$map->reset;
1513	undef $guard;	1787	undef $guard;
1514	return find $path;	1788	return find $path;
…		…
1581	my ($self, $ob) = @_;	1855	my ($self, $ob) = @_;
1582		1856
1583	return find "~" . $ob->name . "/" . $self->{path}	1857	return find "~" . $ob->name . "/" . $self->{path}
1584	if $self->per_player;	1858	if $self->per_player;
1585		1859
		1860	# return find "?party/" . $ob->name . "/" . $self->{path}
		1861	# if $self->per_party;
		1862
1586	$self	1863	$self
1587	}	1864	}
1588		1865
1589	# 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
1590	sub load_diag {	1867	sub load_diag {
…		…
1636		1913
1637	undef $MAP_PREFETCH{$path};	1914	undef $MAP_PREFETCH{$path};
1638	$MAP_PREFETCHER \|\|= cf::async {	1915	$MAP_PREFETCHER \|\|= cf::async {
1639	while (%MAP_PREFETCH) {	1916	while (%MAP_PREFETCH) {
1640	for my $path (keys %MAP_PREFETCH) {	1917	for my $path (keys %MAP_PREFETCH) {
1641	my $map = find $path	1918	if (my $map = find $path) {
1642	or next;
1643	$map->load;	1919	$map->load;
		1920	}
1644		1921
1645	delete $MAP_PREFETCH{$path};	1922	delete $MAP_PREFETCH{$path};
1646	}	1923	}
1647	}	1924	}
1648	undef $MAP_PREFETCHER;	1925	undef $MAP_PREFETCHER;
…		…
1700		1977
1701	sub reset_at {	1978	sub reset_at {
1702	my ($self) = @_;	1979	my ($self) = @_;
1703		1980
1704	# TODO: safety, remove and allow resettable per-player maps	1981	# TODO: safety, remove and allow resettable per-player maps
1705	return 1e99 if $self->isa ("ext::map_per_player");#d#
1706	return 1e99 if $self->{deny_reset};	1982	return 1e99 if $self->{deny_reset};
1707		1983
1708	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1984	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709	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;
1710		1986
…		…
1721	my ($self) = @_;	1997	my ($self) = @_;
1722		1998
1723	my $lock = cf::lock_acquire "map_data:$self->{path}";	1999	my $lock = cf::lock_acquire "map_data:$self->{path}";
1724		2000
1725	return if $self->players;	2001	return if $self->players;
1726	return if $self->isa ("ext::map_per_player");#d#
1727		2002
1728	warn "resetting map ", $self->path;#d#	2003	warn "resetting map ", $self->path;
1729		2004
1730	$self->in_memory (cf::MAP_SWAPPED);	2005	$self->in_memory (cf::MAP_SWAPPED);
1731		2006
1732	# need to save uniques path	2007	# need to save uniques path
1733	unless ($self->{deny_save}) {	2008	unless ($self->{deny_save}) {
…		…
1765	$cf::MAP{$self->path} = $self;	2040	$cf::MAP{$self->path} = $self;
1766		2041
1767	$self->reset; # polite request, might not happen	2042	$self->reset; # polite request, might not happen
1768	}	2043	}
1769		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
1770	=item cf::map::unique_maps	2081	=item cf::map::unique_maps
1771		2082
1772	Returns an arrayref of paths of all shared maps that have	2083	Returns an arrayref of paths of all shared maps that have
1773	instantiated unique items. May block.	2084	instantiated unique items. May block.
1774		2085
1775	=cut	2086	=cut
1776		2087
1777	sub unique_maps() {	2088	sub unique_maps() {
1778	my $files = aio_readdir $UNIQUEDIR	2089	[
1779	or return;	2090	map {
1780
1781	my @paths;
1782
1783	for (@$files) {
1784	utf8::decode $_;	2091	utf8::decode $_;
1785	next if /\.pst$/;	2092	/\.map$/
1786	next unless /^$PATH_SEP/o;	2093	? normalise $_
1787		2094	: ()
1788	push @paths, cf::map::normalise $_;	2095	} @{ aio_readdir $UNIQUEDIR or [] }
1789	}	2096	]
1790
1791	\@paths
1792	}	2097	}
1793		2098
1794	package cf;	2099	package cf;
1795		2100
1796	=back	2101	=back
…		…
1842		2147
1843	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	2148	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
1844		2149
1845	if ($self->{record_replies}) {	2150	if ($self->{record_replies}) {
1846	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2151	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2152
1847	} 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 {
1848	$msg = $npc->name . " says: $msg" if $npc;	2166	$msg = $npc->name . " says: $msg" if $npc;
1849	$self->message ($msg, $flags);	2167	$self->message ($msg, $flags);
		2168	}
1850	}	2169	}
1851	}	2170	}
1852		2171
1853	=item $player_object->may ("access")	2172	=item $player_object->may ("access")
1854		2173
…		…
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	=item $player_object->goto ($path, $x, $y[, $check->($map)])	2267	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949		2268
1950	Moves the player to the given map-path and coordinates by first freezing	2269	Moves the player to the given map-path and coordinates by first freezing
1951	her, loading and preparing them map, calling the provided $check callback	2270	her, loading and preparing them map, calling the provided $check callback
1952	that has to return the map if sucecssful, and then unfreezes the player on	2271	that has to return the map if sucecssful, and then unfreezes the player on
1953	the new (success) or old (failed) map position.	2272	the new (success) or old (failed) map position. In either case, $done will
		2273	be called at the end of this process.
1954		2274
1955	=cut	2275	=cut
1956		2276
1957	our $GOTOGEN;	2277	our $GOTOGEN;
1958		2278
1959	sub cf::object::player::goto {	2279	sub cf::object::player::goto {
1960	my ($self, $path, $x, $y, $check) = @_;	2280	my ($self, $path, $x, $y, $check, $done) = @_;
1961		2281
1962	# do generation counting so two concurrent goto's will be executed in-order	2282	# do generation counting so two concurrent goto's will be executed in-order
1963	my $gen = $self->{_goto_generation} = ++$GOTOGEN;	2283	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964		2284
1965	$self->enter_link;	2285	$self->enter_link;
…		…
1985		2305
1986	if ($gen == $self->{_goto_generation}) {	2306	if ($gen == $self->{_goto_generation}) {
1987	delete $self->{_goto_generation};	2307	delete $self->{_goto_generation};
1988	$self->leave_link ($map, $x, $y);	2308	$self->leave_link ($map, $x, $y);
1989	}	2309	}
		2310
		2311	$done->() if $done;
1990	})->prio (1);	2312	})->prio (1);
1991	}	2313	}
1992		2314
1993	=item $player_object->enter_exit ($exit_object)	2315	=item $player_object->enter_exit ($exit_object)
1994		2316
…		…
2063	my $hp = $exit->stats->hp;	2385	my $hp = $exit->stats->hp;
2064	my $sp = $exit->stats->sp;	2386	my $sp = $exit->stats->sp;
2065		2387
2066	$self->enter_link;	2388	$self->enter_link;
2067		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
2068	(async {	2394	(async {
2069	$self->deactivate_recursive; # just to be sure	2395	$self->deactivate_recursive; # just to be sure
2070	unless (eval {	2396	unless (eval {
2071	$self->goto ($slaying, $hp, $sp);	2397	$self->goto ($slaying, $hp, $sp);
2072		2398
…		…
2099		2425
2100	utf8::encode $text;	2426	utf8::encode $text;
2101	$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);
2102	}	2428	}
2103		2429
		2430	=item $client->send_msg ($color, $type, $msg, [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, $color, $type, $msg, @extra) = @_;
		2441
		2442	$msg = $self->pl->expand_cfpod ($msg);
		2443
		2444	return unless @extra \|\| length $msg;
		2445
		2446	if ($self->can_msg) {
		2447	$self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
		2448	} else {
		2449	# replace some tags by gcfclient-compatible ones
		2450	for ($msg) {
		2451	1 while
		2452	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2453	\|\| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2454	\|\| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2455	\|\| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2456	\|\| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2457	}
		2458
		2459	if ($color >= 0) {
		2460	if (0 && $msg =~ /\[/) {
		2461	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2462	} else {
		2463	$msg =~ s/\[\/?(?:b\|i\|u\|fixed\|color)[^\]]*\]//g;
		2464	$self->send_packet ("drawinfo $color $msg")
		2465	}
		2466	}
		2467	}
		2468	}
		2469
2104	=item $client->ext_event ($type, %msg)	2470	=item $client->ext_event ($type, %msg)
2105		2471
2106	Sends an exti event to the client.	2472	Sends an ext event to the client.
2107		2473
2108	=cut	2474	=cut
2109		2475
2110	sub cf::client::ext_event($$%) {	2476	sub cf::client::ext_event($$%) {
2111	my ($self, $type, %msg) = @_;	2477	my ($self, $type, %msg) = @_;
2112		2478
		2479	return unless $self->extcmd;
		2480
2113	$msg{msgtype} = "event_$type";	2481	$msg{msgtype} = "event_$type";
2114	$self->send_packet ("ext " . cf::to_json \%msg);	2482	$self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2115	}	2483	}
2116		2484
2117	=item $success = $client->query ($flags, "text", \&cb)	2485	=item $success = $client->query ($flags, "text", \&cb)
2118		2486
2119	Queues a query to the client, calling the given callback with	2487	Queues a query to the client, calling the given callback with
2120	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2488	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2121	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2489	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122		2490
2123	Queries can fail, so check the return code. Or don't, as queries will become	2491	Queries can fail, so check the return code. Or don't, as queries will
2124	reliable at some point in the future.	2492	become reliable at some point in the future.
2125		2493
2126	=cut	2494	=cut
2127		2495
2128	sub cf::client::query {	2496	sub cf::client::query {
2129	my ($self, $flags, $text, $cb) = @_;	2497	my ($self, $flags, $text, $cb) = @_;
…		…
2137	utf8::encode $text;	2505	utf8::encode $text;
2138	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2506	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139		2507
2140	$self->send_packet ($self->{query_queue}[0][0])	2508	$self->send_packet ($self->{query_queue}[0][0])
2141	if @{ $self->{query_queue} } == 1;	2509	if @{ $self->{query_queue} } == 1;
		2510
		2511	1
2142	}	2512	}
2143		2513
2144	cf::client->attach (	2514	cf::client->attach (
		2515	on_connect => sub {
		2516	my ($ns) = @_;
		2517
		2518	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2519	},
2145	on_reply => sub {	2520	on_reply => sub {
2146	my ($ns, $msg) = @_;	2521	my ($ns, $msg) = @_;
2147		2522
2148	# this weird shuffling is so that direct followup queries	2523	# this weird shuffling is so that direct followup queries
2149	# get handled first	2524	# get handled first
…		…
2161	} else {	2536	} else {
2162	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2537	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163	}	2538	}
2164	}	2539	}
2165	},	2540	},
		2541	on_exticmd => sub {
		2542	my ($ns, $buf) = @_;
		2543
		2544	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2545
		2546	if (ref $msg) {
		2547	if (my $cb = $EXTICMD{$msg->{msgtype}}) {
		2548	if (my %reply = $cb->($ns, $msg)) {
		2549	$reply{msgid} = $msg->{msgid};
		2550	$ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
		2551	}
		2552	}
		2553	} else {
		2554	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2555	}
		2556
		2557	cf::override;
		2558	},
2166	);	2559	);
2167		2560
2168	=item $client->async (\&cb)	2561	=item $client->async (\&cb)
2169		2562
2170	Create a new coroutine, running the specified callback. The coroutine will	2563	Create a new coroutine, running the specified callback. The coroutine will
…		…
2219		2612
2220	=pod	2613	=pod
2221		2614
2222	The following functions and methods are available within a safe environment:	2615	The following functions and methods are available within a safe environment:
2223		2616
2224	cf::object contr pay_amount pay_player map	2617	cf::object
		2618	contr pay_amount pay_player map x y force_find force_add
		2619	insert remove
		2620
2225	cf::object::player player	2621	cf::object::player
2226	cf::player peaceful	2622	player
2227	cf::map trigger	2623
		2624	cf::player
		2625	peaceful
		2626
		2627	cf::map
		2628	trigger
2228		2629
2229	=cut	2630	=cut
2230		2631
2231	for (	2632	for (
2232	["cf::object" => qw(contr pay_amount pay_player map)],	2633	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2634	insert remove)],
2233	["cf::object::player" => qw(player)],	2635	["cf::object::player" => qw(player)],
2234	["cf::player" => qw(peaceful)],	2636	["cf::player" => qw(peaceful)],
2235	["cf::map" => qw(trigger)],	2637	["cf::map" => qw(trigger)],
2236	) {	2638	) {
2237	no strict 'refs';	2639	no strict 'refs';
…		…
2308	=back	2710	=back
2309		2711
2310	=cut	2712	=cut
2311		2713
2312	#############################################################################	2714	#############################################################################
2313
2314	=head2 EXTENSION DATABASE SUPPORT
2315
2316	Crossfire maintains a very simple database for extension use. It can
2317	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2318	convert to/from binary).
2319
2320	The parameter C<$family> should best start with the name of the extension
2321	using it, it should be unique.
2322
2323	=over 4
2324
2325	=item $value = cf::db_get $family => $key
2326
2327	Returns a single value from the database.
2328
2329	=item cf::db_put $family => $key => $value
2330
2331	Stores the given C<$value> in the family.
2332
2333	=cut
2334
2335	our $DB;
2336
2337	sub db_init {
2338	unless ($DB) {
2339	$DB = BDB::db_create $DB_ENV;
2340
2341	cf::sync_job {
2342	eval {
2343	$DB->set_flags (BDB::CHKSUM);
2344
2345	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2346	BDB::CREATE \| BDB::AUTO_COMMIT, 0666;
2347	cf::cleanup "db_open(db): $!" if $!;
2348	};
2349	cf::cleanup "db_open(db): $@" if $@;
2350	};
2351	}
2352	}
2353
2354	sub db_get($$) {
2355	my $key = "$_[0]/$_[1]";
2356
2357	cf::sync_job {
2358	BDB::db_get $DB, undef, $key, my $data;
2359
2360	$! ? ()
2361	: $data
2362	}
2363	}
2364
2365	sub db_put($$$) {
2366	BDB::dbreq_pri 4;
2367	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2368	}
2369
2370	=item cf::cache $id => [$paths...], $processversion => $process
2371
2372	Generic caching function that returns the value of the resource $id,
2373	caching and regenerating as required.
2374
2375	This function can block.
2376
2377	=cut
2378
2379	sub cache {
2380	my ($id, $src, $processversion, $process) = @_;
2381
2382	my $meta =
2383	join "\x00",
2384	$processversion,
2385	map {
2386	aio_stat $_
2387	and Carp::croak "$_: $!";
2388
2389	($_, (stat _)[7,9])
2390	} @$src;
2391
2392	my $dbmeta = db_get cache => "$id/meta";
2393	if ($dbmeta ne $meta) {
2394	# changed, we may need to process
2395
2396	my @data;
2397	my $md5;
2398
2399	for (0 .. $#$src) {
2400	0 <= aio_load $src->[$_], $data[$_]
2401	or Carp::croak "$src->[$_]: $!";
2402	}
2403
2404	# if processing is expensive, check
2405	# checksum first
2406	if (1) {
2407	$md5 =
2408	join "\x00",
2409	$processversion,
2410	map {
2411	Coro::cede;
2412	($src->[$_], Digest::MD5::md5_hex $data[$_])
2413	} 0.. $#$src;
2414
2415
2416	my $dbmd5 = db_get cache => "$id/md5";
2417	if ($dbmd5 eq $md5) {
2418	db_put cache => "$id/meta", $meta;
2419
2420	return db_get cache => "$id/data";
2421	}
2422	}
2423
2424	my $t1 = Time::HiRes::time;
2425	my $data = $process->(\@data);
2426	my $t2 = Time::HiRes::time;
2427
2428	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2429
2430	db_put cache => "$id/data", $data;
2431	db_put cache => "$id/md5" , $md5;
2432	db_put cache => "$id/meta", $meta;
2433
2434	return $data;
2435	}
2436
2437	db_get cache => "$id/data"
2438	}
2439
2440	=item fork_call { }, $args
2441
2442	Executes the given code block with the given arguments in a seperate
2443	process, returning the results. Everything must be serialisable with
2444	Coro::Storable. May, of course, block. Note that the executed sub may
2445	never block itself or use any form of Event handling.
2446
2447	=cut
2448
2449	sub fork_call(&@) {
2450	my ($cb, @args) = @_;
2451
2452	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2453	# or die "socketpair: $!";
2454	pipe my $fh1, my $fh2
2455	or die "pipe: $!";
2456
2457	if (my $pid = fork) {
2458	close $fh2;
2459
2460	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2461	$res = Coro::Storable::thaw $res;
2462
2463	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2464
2465	die $$res unless "ARRAY" eq ref $res;
2466
2467	return wantarray ? @$res : $res->[-1];
2468	} else {
2469	reset_signals;
2470	local $SIG{__WARN__};
2471	local $SIG{__DIE__};
2472	eval {
2473	close $fh1;
2474
2475	my @res = eval { $cb->(@args) };
2476	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2477	};
2478
2479	warn $@ if $@;
2480	_exit 0;
2481	}
2482	}
2483
2484	#############################################################################
2485	# the server's init and main functions	2715	# the server's init and main functions
2486		2716
2487	sub load_facedata($) {	2717	sub load_facedata($) {
2488	my ($path) = @_;	2718	my ($path) = @_;
2489		2719
…		…
2501	{	2731	{
2502	my $faces = $facedata->{faceinfo};	2732	my $faces = $facedata->{faceinfo};
2503		2733
2504	while (my ($face, $info) = each %$faces) {	2734	while (my ($face, $info) = each %$faces) {
2505	my $idx = (cf::face::find $face) \|\| cf::face::alloc $face;	2735	my $idx = (cf::face::find $face) \|\| cf::face::alloc $face;
2506	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2736	cf::face::set_visibility $idx, $info->{visibility};
		2737	cf::face::set_magicmap $idx, $info->{magicmap};
2507	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2738	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2508	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2739	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2509	Coro::cede;	2740
		2741	cf::cede_to_tick;
2510	}	2742	}
2511		2743
2512	while (my ($face, $info) = each %$faces) {	2744	while (my ($face, $info) = each %$faces) {
2513	next unless $info->{smooth};	2745	next unless $info->{smooth};
2514	my $idx = cf::face::find $face	2746	my $idx = cf::face::find $face
2515	or next;	2747	or next;
2516	if (my $smooth = cf::face::find $info->{smooth}) {	2748	if (my $smooth = cf::face::find $info->{smooth}) {
		2749	cf::face::set_smooth $idx, $smooth;
2517	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2750	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2518	} else {	2751	} else {
2519	warn "smooth face '$info->{smooth}' not found for face '$face'";	2752	warn "smooth face '$info->{smooth}' not found for face '$face'";
2520	}	2753	}
2521	Coro::cede;	2754
		2755	cf::cede_to_tick;
2522	}	2756	}
2523	}	2757	}
2524		2758
2525	{	2759	{
2526	my $anims = $facedata->{animinfo};	2760	my $anims = $facedata->{animinfo};
2527		2761
2528	while (my ($anim, $info) = each %$anims) {	2762	while (my ($anim, $info) = each %$anims) {
2529	cf::anim::set $anim, $info->{frames}, $info->{facings};	2763	cf::anim::set $anim, $info->{frames}, $info->{facings};
2530	Coro::cede;	2764	cf::cede_to_tick;
2531	}	2765	}
2532		2766
2533	cf::anim::invalidate_all; # d'oh	2767	cf::anim::invalidate_all; # d'oh
		2768	}
		2769
		2770	{
		2771	# TODO: for gcfclient pleasure, we should give resources
		2772	# that gcfclient doesn't grok a >10000 face index.
		2773	my $res = $facedata->{resource};
		2774	my $enc = JSON::XS->new->utf8->canonical;
		2775
		2776	while (my ($name, $info) = each %$res) {
		2777	my $meta = $enc->encode ({
		2778	name => $name,
		2779	type => $info->{type},
		2780	copyright => $info->{copyright}, #TODO#
		2781	});
		2782
		2783	my $idx = (cf::face::find $name) \|\| cf::face::alloc $name;
		2784
		2785	if ($name =~ /\.jpg$/) {
		2786	cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
		2787	cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
		2788	} else {
		2789	my $data = pack "(w/a)", $meta, $info->{data};
		2790	my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
		2791
		2792	cf::face::set_type $idx, 1;
		2793	cf::face::set_data $idx, 0, $data, $chk;
		2794	}
		2795
		2796	cf::cede_to_tick;
		2797	}
2534	}	2798	}
2535		2799
2536	1	2800	1
2537	}	2801	}
2538		2802
2539	sub reload_regions {	2803	sub reload_regions {
2540	load_resource_file "$MAPDIR/regions"	2804	load_resource_file "$MAPDIR/regions"
2541	or die "unable to load regions file\n";	2805	or die "unable to load regions file\n";
		2806
		2807	for (cf::region::list) {
		2808	$_->{match} = qr/$_->{match}/
		2809	if exists $_->{match};
		2810	}
2542	}	2811	}
2543		2812
2544	sub reload_facedata {	2813	sub reload_facedata {
2545	load_facedata "$DATADIR/facedata"	2814	load_facedata "$DATADIR/facedata"
2546	or die "unable to load facedata\n";	2815	or die "unable to load facedata\n";
2547	}	2816	}
2548		2817
2549	sub reload_archetypes {	2818	sub reload_archetypes {
2550	load_resource_file "$DATADIR/archetypes"	2819	load_resource_file "$DATADIR/archetypes"
2551	or die "unable to load archetypes\n";	2820	or die "unable to load archetypes\n";
		2821	#d# NEED to laod twice to resolve forward references
		2822	# this really needs to be done in an extra post-pass
		2823	# (which needs to be synchronous, so solve it differently)
		2824	load_resource_file "$DATADIR/archetypes"
		2825	or die "unable to load archetypes\n";
2552	}	2826	}
2553		2827
2554	sub reload_treasures {	2828	sub reload_treasures {
2555	load_resource_file "$DATADIR/treasures"	2829	load_resource_file "$DATADIR/treasures"
2556	or die "unable to load treasurelists\n";	2830	or die "unable to load treasurelists\n";
…		…
2559	sub reload_resources {	2833	sub reload_resources {
2560	warn "reloading resource files...\n";	2834	warn "reloading resource files...\n";
2561		2835
2562	reload_regions;	2836	reload_regions;
2563	reload_facedata;	2837	reload_facedata;
		2838	#reload_archetypes;#d#
2564	reload_archetypes;	2839	reload_archetypes;
2565	reload_treasures;	2840	reload_treasures;
2566		2841
2567	warn "finished reloading resource files\n";	2842	warn "finished reloading resource files\n";
2568	}	2843	}
…		…
2625	},	2900	},
2626	);	2901	);
2627	}	2902	}
2628	}	2903	}
2629		2904
		2905	sub write_runtime {
		2906	my $runtime = "$LOCALDIR/runtime";
		2907
		2908	# first touch the runtime file to show we are still running:
		2909	# the fsync below can take a very very long time.
		2910
		2911	IO::AIO::aio_utime $runtime, undef, undef;
		2912
		2913	my $guard = cf::lock_acquire "write_runtime";
		2914
		2915	my $fh = aio_open "$runtime~", O_WRONLY \| O_CREAT, 0644
		2916	or return;
		2917
		2918	my $value = $cf::RUNTIME + 90 + 10;
		2919	# 10 is the runtime save interval, for a monotonic clock
		2920	# 60 allows for the watchdog to kill the server.
		2921
		2922	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2923	and return;
		2924
		2925	# always fsync - this file is important
		2926	aio_fsync $fh
		2927	and return;
		2928
		2929	# touch it again to show we are up-to-date
		2930	aio_utime $fh, undef, undef;
		2931
		2932	close $fh
		2933	or return;
		2934
		2935	aio_rename "$runtime~", $runtime
		2936	and return;
		2937
		2938	warn "runtime file written.\n";
		2939
		2940	1
		2941	}
		2942
2630	sub emergency_save() {	2943	sub emergency_save() {
2631	my $freeze_guard = cf::freeze_mainloop;	2944	my $freeze_guard = cf::freeze_mainloop;
2632		2945
2633	warn "enter emergency perl save\n";	2946	warn "enter emergency perl save\n";
2634		2947
…		…
2709	%EXT_CORO = ();	3022	%EXT_CORO = ();
2710		3023
2711	warn "removing commands";	3024	warn "removing commands";
2712	%COMMAND = ();	3025	%COMMAND = ();
2713		3026
2714	warn "removing ext commands";	3027	warn "removing ext/exti commands";
2715	%EXTCMD = ();	3028	%EXTCMD = ();
		3029	%EXTICMD = ();
2716		3030
2717	warn "unloading/nuking all extensions";	3031	warn "unloading/nuking all extensions";
2718	for my $pkg (@EXTS) {	3032	for my $pkg (@EXTS) {
2719	warn "... unloading $pkg";	3033	warn "... unloading $pkg";
2720		3034

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs. Revision 1.310 by elmex, Mon Jul 16 15:43:49 2007 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 2007 UTC