CasbahConfiguration.java

/*******************************************************************************
 * Copyright (C) 2010 Marco Sandrini
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public
 * License along with this program.
 * If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package org.casbah.configuration;

import java.io.File;
import java.io.FileNotFoundException;
import java.util.logging.Logger;

import javax.security.auth.x500.X500Principal;

import org.casbah.common.CasbahException;
import org.casbah.common.EqualsUtil;
import org.casbah.provider.CAProvider;


public class CasbahConfiguration {

	private static final Logger logger = Logger.getLogger(CasbahConfiguration.class.getCanonicalName());
	
	private static final String CASBAH_DEFAULT_DIR = ".casbah";
	private static final String USER_HOME = "user.home";
	private static final String CASBAH_HOME = "CASBAH_HOME";
	private static final String CONFIG_FILE = "casbah-config.xml";
	
	private File casbahHomeDirectory;
	private ProviderConfiguration providerConfiguration;

	private CasbahConfiguration(File casbahHomeDirectory) {
		this.casbahHomeDirectory = casbahHomeDirectory;
	}
	
	public CasbahConfiguration() {
		// public constructor needed by Castor unmarshalling
	}
	
	public File getCasbahHomeDirectory() throws CasbahException {
		return casbahHomeDirectory;
	}
	
	private static File calculateHomeDirectory() throws CasbahException {
		String casbahRoot = System.getProperty(CASBAH_HOME, System.getenv(CASBAH_HOME));
		File casbahHome = null;
		if (casbahRoot == null) {

			File userHome = new File(System.getProperty(USER_HOME));
			casbahHome = new File(userHome, CASBAH_DEFAULT_DIR);
			logger.info("CASBAH_HOME not detected, defaulting to " + casbahHome.getAbsolutePath() );
			
		} else {
			casbahHome = new File(casbahRoot);
		}
		if (casbahHome.exists()) {
			if (!casbahHome.isDirectory()) {
				throw new CasbahException("CASBAH_HOME is set to " + casbahHome.getAbsolutePath() + " but is not a directory.", null);
			}
		} else {
			logger.info(casbahHome.getAbsolutePath() + " does not exist, trying to create it");
			casbahHome.mkdirs();
		}
		return casbahHome;		
	}
	
	public static X500Principal getDefaultPrincipal() {
		return new X500Principal("C=FI, ST=Uusimaa, L=Helsinki, O=Harhaanjohtaja.com, CN=Casbah Test CA");
	}
	
	public static CasbahConfiguration getDefaultConfiguration() throws CasbahException {
		
		CasbahConfiguration config = new CasbahConfiguration(calculateHomeDirectory());
		OpenSslProviderConfiguration providerConfiguration = new OpenSslProviderConfiguration();
		providerConfiguration.setKeypass("casbah");
		providerConfiguration.setExecutablePath("");
		providerConfiguration.setCaroot("caroot");
		config.setProviderConfiguration(providerConfiguration);
		return config;
	}
	

	public void setProviderConfiguration(ProviderConfiguration providerConfiguration) {
		this.providerConfiguration = providerConfiguration;		
	}

	public static CasbahConfiguration loadConfiguration() throws CasbahException {
		File casbahHome = calculateHomeDirectory();
		File configFile = new File(casbahHome, CONFIG_FILE);
		CasbahConfiguration result = null;
		try {
			result = CasbahConfigurationHelper.loadFromFile(configFile);
		} catch (FileNotFoundException fnfe) {
			logger.warning("No configuration file found, creating one based on default");
			result = getDefaultConfiguration();
			CasbahConfigurationHelper.writeToFile(result, configFile);
		}
		result.setCasbahHomeDirectory(casbahHome);
		return result;
	}

	public CAProvider getProvider() throws CasbahException {
		return providerConfiguration.getInstance(casbahHomeDirectory);
	}
	
	public void setCasbahHomeDirectory(File casbahHomeDirectory) {
		this.casbahHomeDirectory = casbahHomeDirectory;
	}

	public ProviderConfiguration getProviderConfiguration() {
		return providerConfiguration;
	}
	
	@Override
	public boolean equals(Object other) {
		if (other == this) {
			return true;
		}
		if (!(other instanceof CasbahConfiguration)) {
			return false;
		}
		CasbahConfiguration otherConfig = (CasbahConfiguration) other;
		return EqualsUtil.areEqual(this.providerConfiguration, otherConfig.getProviderConfiguration());
		
	}

	@Override
	public int hashCode() {
		return (this.providerConfiguration == null ? 0 : this.providerConfiguration.hashCode());
	}
	

	
}