app/src/main/java/org/apache/roller/weblogger/config/WebloggerConfig.java - roller - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  *  contributor license agreements.  The ASF licenses this file to You
  * under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.  For additional information regarding
  * copyright in this work, please see the NOTICE file in the top level
  * directory of this distribution.
  */

 package org.apache.roller.weblogger.config;

 import java.io.File;
 import java.io.FileInputStream;
 import java.io.InputStream;
 import java.util.Enumeration;
 import java.util.Properties;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.log4j.PropertyConfigurator;
 import org.apache.roller.util.PropertyExpander;


 /**
  * This is the single entry point for accessing configuration properties in Roller.
  */
 public final class WebloggerConfig {

     private static String default_config = "/org/apache/roller/weblogger/config/roller.properties";
     private static String custom_config = "/roller-custom.properties";
     private static String junit_config = "/roller-junit.properties";
     private static String custom_jvm_param = "roller.custom.config";
     private static File custom_config_file = null;

     private static Properties config;

     private static Log log = LogFactory.getLog(WebloggerConfig.class);


     /*
      * Static block run once at class loading
      *
      * We load the default properties and any custom properties we find
      */
     static {
         config = new Properties();

         try {
             // we'll need this to get at our properties files in the classpath
             Class configClass = Class.forName("org.apache.roller.weblogger.config.WebloggerConfig");

             // first, lets load our default properties
             InputStream is = configClass.getResourceAsStream(default_config);
             config.load(is);

             // first, see if we can find our junit testing config
             is = configClass.getResourceAsStream(junit_config);
             if (is != null) {

                 config.load(is);
                 System.out
                         .println("Roller Weblogger: Successfully loaded junit properties file from classpath");
                 System.out.println("File path : "
                         + configClass.getResource(junit_config).getFile());

             } else {

                 // now, see if we can find our custom config
                 is = configClass.getResourceAsStream(custom_config);

                 if (is != null) {
                     config.load(is);
                     System.out
                             .println("Roller Weblogger: Successfully loaded custom properties file from classpath");
                     System.out.println("File path : "
                             + configClass.getResource(custom_config).getFile());
                 } else {
                     System.out
                             .println("Roller Weblogger: No custom properties file found in classpath");
                 }

                 System.out
                 .println("(To run eclipse junit local tests see docs/testing/roller-junit.properties)");
             }

             // finally, check for an external config file
             String env_file = System.getProperty(custom_jvm_param);
             if(env_file != null && env_file.length() > 0) {
                 custom_config_file = new File(env_file);

                 // make sure the file exists, then try and load it
                 if(custom_config_file != null && custom_config_file.exists()) {
                     is = new FileInputStream(custom_config_file);
                     config.load(is);
                     System.out.println("Roller Weblogger: Successfully loaded custom properties from "+
                             custom_config_file.getAbsolutePath());
                 } else {
                     System.out.println("Roller Weblogger: Failed to load custom properties from "+
                             custom_config_file.getAbsolutePath());
                 }

             }

             // Now expand system properties for properties in the config.expandedProperties list,
             // replacing them by their expanded values.
             String expandedPropertiesDef = (String) config.get("config.expandedProperties");
             if (expandedPropertiesDef != null) {
                 String[] expandedProperties = expandedPropertiesDef.split(",");
                 for (int i = 0; i < expandedProperties.length; i++) {
                     String propName = expandedProperties[i].trim();
                     String initialValue = (String) config.get(propName);
                     if (initialValue != null) {
                         String expandedValue = PropertyExpander.expandSystemProperties(initialValue);
                         config.put(propName,expandedValue);
                     }
                 }
             }

             // initialize logging subsystem via WebloggerConfig
             PropertyConfigurator.configure(WebloggerConfig.getPropertiesStartingWith("log4j."));

             // finally we can start logging...

             // some debugging for those that want it
             if(log.isDebugEnabled()) {
                 log.debug("WebloggerConfig looks like this ...");

                 String key = null;
                 Enumeration keys = config.keys();
                 while(keys.hasMoreElements()) {
                     key = (String) keys.nextElement();
                     log.debug(key+"="+config.getProperty(key));
                 }
             }

         } catch (Exception e) {
             e.printStackTrace();
         }

     }


     // no, you may not instantiate this class :p
     private WebloggerConfig() {}


     /**
      * Retrieve a property value
      * @param     key Name of the property
      * @return    String Value of property requested, null if not found
      */
     public static String getProperty(String key) {
         log.debug("Fetching property ["+key+"="+config.getProperty(key)+"]");
         String value = config.getProperty(key);
         return value == null ? null : value.trim();
     }

     /**
      * Retrieve a property value
      * @param     key Name of the property
      * @param     defaultValue Default value of property if not found
      * @return    String Value of property requested or defaultValue
      */
     public static String getProperty(String key, String defaultValue) {
         log.debug("Fetching property ["+key+"="+config.getProperty(key)+",defaultValue="+defaultValue+"]");
         String value = config.getProperty(key);
         if (value == null) {
             return defaultValue;
         }

         return value.trim();
     }

     /**
      * Retrieve a property as a boolean ... defaults to false if not present.
      */
     public static boolean getBooleanProperty(String name) {
         return getBooleanProperty(name,false);
     }

     /**
      * Retrieve a property as a boolean ... with specified default if not present.
      */
     public static boolean getBooleanProperty(String name, boolean defaultValue) {
         // get the value first, then convert
         String value = WebloggerConfig.getProperty(name);

         if(value == null) {
             return defaultValue;
         }

         return Boolean.valueOf(value);
     }

     /**
      * Retrieve a property as an int ... defaults to 0 if not present.
      */
     public static int getIntProperty(String name) {
         return getIntProperty(name, 0);
     }

     /**
      * Retrieve a property as a int ... with specified default if not present.
      */
     public static int getIntProperty(String name, int defaultValue) {
         // get the value first, then convert
         String value = WebloggerConfig.getProperty(name);

         if (value == null) {
             return defaultValue;
         }

         return Integer.valueOf(value);
     }

     /**
      * Retrieve all property keys
      * @return Enumeration A list of all keys
      **/
     public static Enumeration keys() {
         return config.keys();
     }


     /**
      * Get properties starting with a specified string.
      */
     public static Properties getPropertiesStartingWith(String startingWith) {
         Properties props = new Properties();
         for (Enumeration it = config.keys(); it.hasMoreElements();) {
             String key = (String)it.nextElement();
             props.put(key, config.get(key));
         }
         return props;
     }


     /**
      * Set the "uploads.dir" property at runtime.
      * <p />
      * Properties are meant to be read-only, but we make this exception because
      * we know that some people are still writing their uploads to the webapp
      * context and we can only get that path at runtime (and for unit testing).
      * <p />
      * This property is *not* persisted in any way.
      */
     public static void setUploadsDir(String path) {
         // only do this if the user wants to use the webapp context
         if("${webapp.context}".equals(config.getProperty("uploads.dir"))) {
             config.setProperty("uploads.dir", path);
         }
     }

     /**
      * Set the "themes.dir" property at runtime.
      * <p />
      * Properties are meant to be read-only, but we make this exception because
      * we know that some people are still using their themes in the webapp
      * context and we can only get that path at runtime (and for unit testing).
      * <p />
      * This property is *not* persisted in any way.
      */
     public static void setThemesDir(String path) {
         // only do this if the user wants to use the webapp context
         if("${webapp.context}".equals(config.getProperty("themes.dir"))) {
             config.setProperty("themes.dir", path);
         }
     }

     /**
      * Return the value of the authentication.method property as an AuthMethod
      * enum value.  Matching is done by checking the propertyName of each AuthMethod
      * enum object.
      * <p />
      * @throws IllegalArgumentException if property value defined in the properties
      * file is missing or not the property name of any AuthMethod enum object.
      */
     public static AuthMethod getAuthMethod() {
         return AuthMethod.getAuthMethod(getProperty("authentication.method"));
     }

 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. The ASF licenses this file to You
	* under the Apache License, Version 2.0 (the "License"); you may not
	* use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License. For additional information regarding
	* copyright in this work, please see the NOTICE file in the top level
	* directory of this distribution.
	*/

	package org.apache.roller.weblogger.config;

	import java.io.File;
	import java.io.FileInputStream;
	import java.io.InputStream;
	import java.util.Enumeration;
	import java.util.Properties;
	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;
	import org.apache.log4j.PropertyConfigurator;
	import org.apache.roller.util.PropertyExpander;


	/**
	* This is the single entry point for accessing configuration properties in Roller.
	*/
	public final class WebloggerConfig {

	private static String default_config = "/org/apache/roller/weblogger/config/roller.properties";
	private static String custom_config = "/roller-custom.properties";
	private static String junit_config = "/roller-junit.properties";
	private static String custom_jvm_param = "roller.custom.config";
	private static File custom_config_file = null;

	private static Properties config;

	private static Log log = LogFactory.getLog(WebloggerConfig.class);


	/*
	* Static block run once at class loading
	*
	* We load the default properties and any custom properties we find
	*/
	static {
	config = new Properties();

	try {
	// we'll need this to get at our properties files in the classpath
	Class configClass = Class.forName("org.apache.roller.weblogger.config.WebloggerConfig");

	// first, lets load our default properties
	InputStream is = configClass.getResourceAsStream(default_config);
	config.load(is);

	// first, see if we can find our junit testing config
	is = configClass.getResourceAsStream(junit_config);
	if (is != null) {

	config.load(is);
	System.out
	.println("Roller Weblogger: Successfully loaded junit properties file from classpath");
	System.out.println("File path : "
	+ configClass.getResource(junit_config).getFile());

	} else {

	// now, see if we can find our custom config
	is = configClass.getResourceAsStream(custom_config);

	if (is != null) {
	config.load(is);
	System.out
	.println("Roller Weblogger: Successfully loaded custom properties file from classpath");
	System.out.println("File path : "
	+ configClass.getResource(custom_config).getFile());
	} else {
	System.out
	.println("Roller Weblogger: No custom properties file found in classpath");
	}

	System.out
	.println("(To run eclipse junit local tests see docs/testing/roller-junit.properties)");
	}

	// finally, check for an external config file
	String env_file = System.getProperty(custom_jvm_param);
	if(env_file != null && env_file.length() > 0) {
	custom_config_file = new File(env_file);

	// make sure the file exists, then try and load it
	if(custom_config_file != null && custom_config_file.exists()) {
	is = new FileInputStream(custom_config_file);
	config.load(is);
	System.out.println("Roller Weblogger: Successfully loaded custom properties from "+
	custom_config_file.getAbsolutePath());
	} else {
	System.out.println("Roller Weblogger: Failed to load custom properties from "+
	custom_config_file.getAbsolutePath());
	}

	}

	// Now expand system properties for properties in the config.expandedProperties list,
	// replacing them by their expanded values.
	String expandedPropertiesDef = (String) config.get("config.expandedProperties");
	if (expandedPropertiesDef != null) {
	String[] expandedProperties = expandedPropertiesDef.split(",");
	for (int i = 0; i < expandedProperties.length; i++) {
	String propName = expandedProperties[i].trim();
	String initialValue = (String) config.get(propName);
	if (initialValue != null) {
	String expandedValue = PropertyExpander.expandSystemProperties(initialValue);
	config.put(propName,expandedValue);
	}
	}
	}

	// initialize logging subsystem via WebloggerConfig
	PropertyConfigurator.configure(WebloggerConfig.getPropertiesStartingWith("log4j."));

	// finally we can start logging...

	// some debugging for those that want it
	if(log.isDebugEnabled()) {
	log.debug("WebloggerConfig looks like this ...");

	String key = null;
	Enumeration keys = config.keys();
	while(keys.hasMoreElements()) {
	key = (String) keys.nextElement();
	log.debug(key+"="+config.getProperty(key));
	}
	}

	} catch (Exception e) {
	e.printStackTrace();
	}

	}


	// no, you may not instantiate this class :p
	private WebloggerConfig() {}


	/**
	* Retrieve a property value
	* @param key Name of the property
	* @return String Value of property requested, null if not found
	*/
	public static String getProperty(String key) {
	log.debug("Fetching property ["+key+"="+config.getProperty(key)+"]");
	String value = config.getProperty(key);
	return value == null ? null : value.trim();
	}

	/**
	* Retrieve a property value
	* @param key Name of the property
	* @param defaultValue Default value of property if not found
	* @return String Value of property requested or defaultValue
	*/
	public static String getProperty(String key, String defaultValue) {
	log.debug("Fetching property ["+key+"="+config.getProperty(key)+",defaultValue="+defaultValue+"]");
	String value = config.getProperty(key);
	if (value == null) {
	return defaultValue;
	}

	return value.trim();
	}

	/**
	* Retrieve a property as a boolean ... defaults to false if not present.
	*/
	public static boolean getBooleanProperty(String name) {
	return getBooleanProperty(name,false);
	}

	/**
	* Retrieve a property as a boolean ... with specified default if not present.
	*/
	public static boolean getBooleanProperty(String name, boolean defaultValue) {
	// get the value first, then convert
	String value = WebloggerConfig.getProperty(name);

	if(value == null) {
	return defaultValue;
	}

	return Boolean.valueOf(value);
	}

	/**
	* Retrieve a property as an int ... defaults to 0 if not present.
	*/
	public static int getIntProperty(String name) {
	return getIntProperty(name, 0);
	}

	/**
	* Retrieve a property as a int ... with specified default if not present.
	*/
	public static int getIntProperty(String name, int defaultValue) {
	// get the value first, then convert
	String value = WebloggerConfig.getProperty(name);

	if (value == null) {
	return defaultValue;
	}

	return Integer.valueOf(value);
	}

	/**
	* Retrieve all property keys
	* @return Enumeration A list of all keys
	**/
	public static Enumeration keys() {
	return config.keys();
	}


	/**
	* Get properties starting with a specified string.
	*/
	public static Properties getPropertiesStartingWith(String startingWith) {
	Properties props = new Properties();
	for (Enumeration it = config.keys(); it.hasMoreElements();) {
	String key = (String)it.nextElement();
	props.put(key, config.get(key));
	}
	return props;
	}


	/**
	* Set the "uploads.dir" property at runtime.
	* <p />
	* Properties are meant to be read-only, but we make this exception because
	* we know that some people are still writing their uploads to the webapp
	* context and we can only get that path at runtime (and for unit testing).
	* <p />
	* This property is not persisted in any way.
	*/
	public static void setUploadsDir(String path) {
	// only do this if the user wants to use the webapp context
	if("${webapp.context}".equals(config.getProperty("uploads.dir"))) {
	config.setProperty("uploads.dir", path);
	}
	}

	/**
	* Set the "themes.dir" property at runtime.
	* <p />
	* Properties are meant to be read-only, but we make this exception because
	* we know that some people are still using their themes in the webapp
	* context and we can only get that path at runtime (and for unit testing).
	* <p />
	* This property is not persisted in any way.
	*/
	public static void setThemesDir(String path) {
	// only do this if the user wants to use the webapp context
	if("${webapp.context}".equals(config.getProperty("themes.dir"))) {
	config.setProperty("themes.dir", path);
	}
	}

	/**
	* Return the value of the authentication.method property as an AuthMethod
	* enum value. Matching is done by checking the propertyName of each AuthMethod
	* enum object.
	* <p />
	* @throws IllegalArgumentException if property value defined in the properties
	* file is missing or not the property name of any AuthMethod enum object.
	*/
	public static AuthMethod getAuthMethod() {
	return AuthMethod.getAuthMethod(getProperty("authentication.method"));
	}

	}