File Coverage

blib/lib/Config/Framework.pm

Criterion	Covered	Total	%
statement	7	9	77.7
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod			n/a
total	10	12	83.3

####################################################
## Config::Framework.pm
## Andrew N. Hicox
##
## This package provides configuration info to
## homegrown modules.
###################################################


## Global Stuff ###################################
  package Config::Framework;
  use 5.6.0;
  use Carp;

  use Data::DumpXML;
  use Data::DumpXML::Parser;

  require Exporter;
  use AutoLoader qw(AUTOLOAD);

## Class Global Values ############################
our @ISA = qw(Exporter);
our $VERSION = '2.5';
our $errstr = ();
our @EXPORT_OK = ($VERSION, $errstr);
our @temp = split (/\//,$0);
our %GLOB_CONFIG = (
	#name of program running this code
	'program'		=> $temp[$#temp],
	#virtual root: everything lives under this
	'v_root'			=> "",
	#global configuration files live in this subdirectory
	'config_loc'		=> "",
	#sybase home directory
	'SYBASE'			=> "/",
	#oracle home directory
	'ORACLE_HOME'		=> "/",
	#set this library path
	'LD_LIBRARY_PATH'	=> "/",
	#where sendmail resides
	'sendmail'			=> "",
	#someone to phone home to when things go really wrong
	'admin'				=> "",
	#export these keys from GLOB_CONFIG to the shell environment
	'EnvExportList'		=> [
		"SYBASE",
		"ORACLE_HOME",
		"ORACLE_SID",
		"ARTCPPORT",
		"LD_LIBRARY_PATH"
	],
	#we're using this encryption module
	'Crypt'				=> "",
	#it's under the virtual doormat
	'Key'				=> "",
	#automatically load child configs
	'LoadChildren'		=> 1
 );


## new ############################################
sub new {
	my $class = shift();
	my $self = bless ({@_}, $class);

	#insert default global config items unless overriden by user input
	foreach (keys %GLOB_CONFIG){ $self->{$_} = $GLOB_CONFIG{$_} unless exists($self->{$_}); }

	#export items in EnvExportList
	foreach (@{$self->{'EnvExportList'}}){ $main::ENV{$_} = $self->{$_} if exists($self->{$_}); }

	#export other user-defined export items
	foreach (keys %{$self->{'Export'}}){ $main::ENV{$_} = $self->{'Export'}->{$_}; }

	#set up a shortcut to the applications 'framework' directory
	$self->{'FrameworkDir'} = "$self->{'v_root'}/$self->{'config_loc'}/ApplicationFrameworks/$self->{'program'}";

	#fix string-specified files for multiple file compatibility
	if ((exists ($self->{'File'})) && (ref ($self->{'File'}) ne "ARRAY")){
		my $temp = $self->{'File'};
		delete($self->{'File'});
		push (@{$self->{'File'}}, $temp);
	}

	#load all of the specified configs
	foreach (@{$self->{'File'}}){
		$self->LoadConfig(File => $_) || do {
			$errstr = "new: ";
			$errstr.= $self->{'errstr'};
			return (undef);
		};
	}

	#load the secure config, if directed
	if ($self->{'GetSecure'}){
		$self->LoadConfig(
			File 			=> "$self->{'v_root'}/$self->{'config_loc'}/passwds.xml",
			configNamespace	=> "Secure"
		) || do {
			$errstr = "new: can't load secure config: $self->{'errstr'}";
			return (undef);
		};
	}

	#weed out descriptors under Secure namespace
	#ugly hack
	foreach (keys %{$self->{'Secure'}}){
		if (ref ($self->{'Secure'}->{$_}) eq "HASH"){
			if (exists($self->{'Secure'}->{$_}->{'content'})){
				$self->{'Secure'}->{$_} = $self->{'Secure'}->{$_}->{'content'};
			}
		}
	}

	#send back the constructed object
	return ($self);
}



## True for perl include ##########################
 1;
__END__