ConfigUtil.java

package org.jbake.app;

import org.apache.commons.configuration.CompositeConfiguration;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.PropertiesConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;

/**
 * Provides Configuration related functions.
 *
 * @author Jonathan Bullock <jonbullock@gmail.com>
 */
public class ConfigUtil {
	
	/**
	 * Set of config keys used by JBake
	 * @author ndx
	 *
	 */
	public static interface Keys {

		/**
		 * Output filename for archive file, is only used when {@link #RENDER_ARCHIVE} is true
		 */
		static final String ARCHIVE_FILE = "archive.file";
		
		/**
		 * Asciidoctor attributes to be set when processing input
		 */
		static final String ASCIIDOCTOR_ATTRIBUTES = "asciidoctor.attributes";
		
		/**
		 * Flag indicating if JBake properties should be made available to Asciidoctor
		 */
		static final String ASCIIDOCTOR_ATTRIBUTES_EXPORT = "asciidoctor.attributes.export";
		
		/**
		 * Prefix to be used when exporting JBake properties to Asciidoctor
		 */
		static final String ASCIIDOCTOR_ATTRIBUTES_EXPORT_PREFIX = "asciidoctor.attributes.export.prefix";
		
		/**
		 * Asciidoctor options to be set when processing input
		 */
		static final String ASCIIDOCTOR_OPTION = "asciidoctor.option";
		
		/**
		 * Folder where assets are stored, they are copied directly in output folder and not processed
		 */
		static final String ASSET_FOLDER = "asset.folder";

		/**
		 * Flag indicating if hidden asset resources should be ignored
		 */
		static final String ASSET_IGNORE_HIDDEN = "asset.ignore";

		/**
		 * Timestamp that records when JBake build was made
		 */
		static final String BUILD_TIMESTAMP = "build.timestamp";
		
		/**
		 * Folder where content (that's to say files to be transformed) resides in
		 */
		static final String CONTENT_FOLDER = "content.folder";
		
		/**
		 * How date is formated
		 */
		static final String DATE_FORMAT = "date.format";
		
		/**
		 * Folder to store database files in
		 */
		static final String DB_PATH = "db.path";
		
		/**
		 * Flag to identify if database is kept in memory (memory) or persisted to disk (local)
		 */
		static final String DB_STORE = "db.store";
		
		/**
		 * Default status to use (in order to avoid putting it in all files)
		 */
		static final String DEFAULT_STATUS = "default.status";
		
		/**
		 * Folder where rendered files are output
		 */
		static final String DESTINATION_FOLDER = "destination.folder";
		
		/**
		 * Suffix used to identify draft files
		 */
		static final String DRAFT_SUFFIX = "draft.suffix";
		
        /**
         * Output filename for feed file, is only used when {@link #RENDER_FEED} is true
         */
        static final String FEED_FILE = "feed.file";
        
        /**
         * Flag indicating if index page shows excerpts or full bodies, 
         * is only used when {@link #RENDER_INDEX} is true
         */
        static final String INDEX_SUMMERY = "index.summery";
        
        /**
         * Flag indicating if feed page shows excerpts or full bodies, 
         * is only used when {@link #RENDER_INDEX} is true
         */
        static final String FEED_SUMMERY = "feed.summery";
        
        /**
         * The max length of an excerpt used as summary.
         * 
         * By default: -1, i.e. no limit.
         */
        static final String SUMMERY_MAX_LENGTH = "summary.max.length";
        
        /*
         * The unit used to truncate the body, either character, Unicode code point or word.
         * 
         * By default: world
         */
        static final String SUMMERY_LENGTH_UNIT = "summary.length.unit";

        /**
         * The ellipsis used with an excerpt shorter than the page/post body content.
         * 
         * By default: ...
         */
        static final String SUMMERY_ELLIPSIS = "summary.ellipsis";
        
        /**
         * The readmore label used with an excerpt shorter than the page/post body content.
         * 
         * If a pattern is provided then it will be interpolated with the post/page link. 
         * By default: empty string
         */
        static final String SUMMERY_READMORE = "summary.readmore";
        
        /**
         * Output filename for index, is only used when {@link #RENDER_INDEX} is true
         */
        static final String INDEX_FILE = "index.file";
        
		/**
		 * File extension to be used for all output files
		 */
		static final String OUTPUT_EXTENSION = "output.extension";
		
		/**
		 * Flag indicating if archive file should be generated
		 */
		static final String RENDER_ARCHIVE = "render.archive";
		
		/**
		 * Encoding used when rendering files
		 */
		static final String RENDER_ENCODING = "render.encoding";
		
		/**
		 * Flag indicating if feed file should be generated
		 */
		static final String RENDER_FEED = "render.feed";
		
		/**
		 * Flag indicating if index file should be generated
		 */
		static final String RENDER_INDEX = "render.index";
		
		/**
		 * Flag indicating if sitemap file should be generated
		 */
		static final String RENDER_SITEMAP = "render.sitemap";
		
		/**
		 * Flag indicating if tag files should be generated
		 */
		static final String RENDER_TAGS = "render.tags";
		
		/**
		 * Port used when running Jetty server
		 */
		static final String SERVER_PORT = "server.port";
		
		/**
		 * Sitemap template file name. Used only when {@link #RENDER_SITEMAP} is set to true
		 */
		static final String SITEMAP_FILE = "sitemap.file";
		
		/**
		 * Tags output path, used only when {@link #RENDER_TAGS} is true
		 */
		static final String TAG_PATH = "tag.path";
		
		/**
		 * Should the tag value be sanitized?
		 */
		static final String TAG_SANITIZE = "tag.sanitize";
		
		/**
		 * Encoding to be used for template files
		 */
		static final String TEMPLATE_ENCODING = "template.encoding";
		
		/**
		 * Folder where template files are looked for
		 */
		static final String TEMPLATE_FOLDER = "template.folder";
		
		/**
		 * Locale used for Thymeleaf template rendering
		 */
		static final String THYMELEAF_LOCALE = "thymeleaf.locale";
		
		/**
		 * Version of JBake
		 */
		static final String VERSION = "version";
		
	}

	private final static Logger LOGGER = LoggerFactory.getLogger(ConfigUtil.class);
	private final static String LEGACY_CONFIG_FILE = "custom.properties";
	private final static String CONFIG_FILE = "jbake.properties";
	private final static String DEFAULT_CONFIG_FILE = "default.properties";
	private static boolean LEGACY_CONFIG_FILE_WARNING_SHOWN = false;
	
    public static CompositeConfiguration load(File source) throws ConfigurationException {
        CompositeConfiguration config = new CompositeConfiguration();
        config.setListDelimiter(',');
        File customConfigFile = new File(source, LEGACY_CONFIG_FILE);
        if (customConfigFile.exists()) {
        	if (!LEGACY_CONFIG_FILE_WARNING_SHOWN) {
	        	LOGGER.warn(String.format("You have defined a part of your JBake configuration in %s located at: %s", LEGACY_CONFIG_FILE, customConfigFile.getParent()));
	        	LOGGER.warn(String.format("Usage of this file is being deprecated, please rename this file to: %s to remove this warning", CONFIG_FILE));
	        	LEGACY_CONFIG_FILE_WARNING_SHOWN = true;
        	}
            config.addConfiguration(new PropertiesConfiguration(customConfigFile));
        }
        customConfigFile = new File(source, CONFIG_FILE);
        if (customConfigFile.exists()) {
            config.addConfiguration(new PropertiesConfiguration(customConfigFile));
        }
        config.addConfiguration(new PropertiesConfiguration(DEFAULT_CONFIG_FILE));
        return config;
    }
}