LoggingConfiguration.java

/*
 *
 *  Copyright 2014 http://Bither.net
 *
 *  Licensed 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.
 * /
 */

package net.bither.logging;

import ch.qos.logback.classic.Level;
import com.google.common.collect.Maps;
import net.bither.ApplicationDataDirectoryLocator;
import net.bither.bitherj.BitherjSettings;

import java.io.File;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;

/**
 * <p>Configuration to provide the following to logging framework:</p>
 * <ul>
 * <li>Configuration of console logger</li>
 * <li>Configuration of file logger</li>
 * </ul>
 *
 * @since 0.0.1
 */
@SuppressWarnings("UnusedDeclaration")
public class LoggingConfiguration {

    static final TimeZone UTC = TimeZone.getTimeZone("UTC");

    private Level level = Level.WARN;

    private Map<String, Level> loggers = Maps.newHashMap();

    private ConsoleConfiguration console = new ConsoleConfiguration();

    private FileConfiguration file = new FileConfiguration();

    private SyslogConfiguration syslog = new SyslogConfiguration();

    public LoggingConfiguration() {
        if (BitherjSettings.LOG_DEBUG) {
            loggers.put("net.bither", Level.DEBUG);
        } else {
            loggers.put("net.bither", Level.INFO);
        }

    }

    public Level getLevel() {
        return level;
    }

    public void setLevel(Level level) {
        this.level = level;
    }

    public Map<String, Level> getLoggers() {
        return loggers;
    }

    public void setLoggers(Map<String, Level> loggers) {
        this.loggers = loggers;
    }

    public ConsoleConfiguration getConsoleConfiguration() {
        return console;
    }

    public void setConsoleConfiguration(ConsoleConfiguration config) {
        this.console = config;
    }

    public FileConfiguration getFileConfiguration() {
        return file;
    }

    public void setFileConfiguration(FileConfiguration config) {
        this.file = config;
    }

    public SyslogConfiguration getSyslogConfiguration() {
        return syslog;
    }

    public void setSyslogConfiguration(SyslogConfiguration config) {
        this.syslog = config;
    }

    /**
     * @return A deep copy of this object
     */
    public LoggingConfiguration deepCopy() {

        LoggingConfiguration logging = new LoggingConfiguration();

        // Only configure the basics to match the properties file
        logging.setLevel(getLevel());
        logging.setLoggers(getLoggers());
        logging.getFileConfiguration().setArchivedLogFilenamePattern(getFileConfiguration().getArchivedLogFilenamePattern());
        logging.getFileConfiguration().setCurrentLogFilename(getFileConfiguration().getCurrentLogFilename());

        return logging;
    }

    // Output configurations (console, file, system etc)

    public static class ConsoleConfiguration {

        private boolean enabled = true;

        private Level threshold = Level.ALL;

        private TimeZone timeZone = UTC;

        private String logFormat;

        public boolean isEnabled() {
            return enabled;
        }

        public void setEnabled(boolean enabled) {
            this.enabled = enabled;
        }

        public Level getThreshold() {
            return threshold;
        }

        public void setThreshold(Level threshold) {
            this.threshold = threshold;
        }

        public TimeZone getTimeZone() {
            return timeZone;
        }

        public void setTimeZone(TimeZone timeZone) {
            this.timeZone = timeZone;
        }

        public String getLogFormat() {
            return logFormat;
        }

        public void setLogFormat(String logFormat) {
            this.logFormat = logFormat;
        }
    }

    public static class FileConfiguration {

        private static String OUTPUT_DIRECTORY = "log";
        private static String CONSOLE_OUTPUT_FILENAME = "bither.log";

        static {
            ApplicationDataDirectoryLocator applicationDataDirectoryLocator = new ApplicationDataDirectoryLocator();


            if ("".equals(applicationDataDirectoryLocator.getApplicationDataDirectory())) {
            } else {
                // Use defined data directory as the root
                OUTPUT_DIRECTORY = applicationDataDirectoryLocator.getApplicationDataDirectory() + File.separator
                        + OUTPUT_DIRECTORY;
                CONSOLE_OUTPUT_FILENAME = OUTPUT_DIRECTORY + File.separator + CONSOLE_OUTPUT_FILENAME;
            }

        }

        private boolean enabled = true;

        private Level threshold = Level.ALL;

        private String currentLogFilename = CONSOLE_OUTPUT_FILENAME;

        private boolean archive = true;

        private String archivedLogFilenamePattern = OUTPUT_DIRECTORY + "/bither-%d.log.gz";

        private int archivedFileCount = 5;

        private TimeZone timeZone = UTC;

        private String logFormat;

        public boolean isValidArchiveConfiguration() {
            return !enabled || !archive || (archivedLogFilenamePattern != null);
        }

        public boolean isConfigured() {
            return !enabled || (currentLogFilename != null);
        }

        public boolean isEnabled() {
            return enabled;
        }

        public void setEnabled(boolean enabled) {
            this.enabled = enabled;
        }

        public Level getThreshold() {
            return threshold;
        }

        public void setThreshold(Level level) {
            this.threshold = level;
        }

        public String getCurrentLogFilename() {
            return currentLogFilename;
        }

        public void setCurrentLogFilename(String filename) {
            this.currentLogFilename = filename;
        }

        public boolean isArchive() {
            return archive;
        }

        public void setArchive(boolean archive) {
            this.archive = archive;
        }

        public int getArchivedFileCount() {
            return archivedFileCount;
        }

        public void setArchivedFileCount(int count) {
            this.archivedFileCount = count;
        }

        public String getArchivedLogFilenamePattern() {
            return archivedLogFilenamePattern;
        }

        public void setArchivedLogFilenamePattern(String pattern) {
            this.archivedLogFilenamePattern = pattern;
        }

        public TimeZone getTimeZone() {
            return timeZone;
        }

        public void setTimeZone(TimeZone timeZone) {
            this.timeZone = timeZone;
        }

        public String getLogFormat() {
            return logFormat;
        }

        public void setLogFormat(String logFormat) {
            this.logFormat = logFormat;
        }
    }

    public static class SyslogConfiguration {

        public enum Facility {
            AUTH, AUTHPRIV, DAEMON, CRON, FTP, LPR, KERN, MAIL, NEWS, SYSLOG, USER, UUCP,
            LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7;

            @Override
            public String toString() {
                return super.toString().replace("_", "+").toLowerCase(Locale.ENGLISH);
            }

            public static Facility parse(String facility) {
                return valueOf(facility.toUpperCase(Locale.ENGLISH).replace('+', '_'));
            }
        }

        private boolean enabled = false;

        private Level threshold = Level.ALL;

        private String host = "localhost";

        private Facility facility = Facility.LOCAL0;

        private TimeZone timeZone = UTC;

        private String logFormat;

        public boolean isEnabled() {
            return enabled;
        }

        public void setEnabled(boolean enabled) {
            this.enabled = enabled;
        }

        public Level getThreshold() {
            return threshold;
        }

        public void setThreshold(Level threshold) {
            this.threshold = threshold;
        }

        public String getHost() {
            return host;
        }

        public void setHost(String host) {
            this.host = host;
        }

        public Facility getFacility() {
            return facility;
        }

        public void setFacility(Facility facility) {
            this.facility = facility;
        }

        public TimeZone getTimeZone() {
            return timeZone;
        }

        public void setTimeZone(TimeZone timeZone) {
            this.timeZone = timeZone;
        }

        public String getLogFormat() {
            return logFormat;
        }

        public void setLogFormat(String logFormat) {
            this.logFormat = logFormat;
        }
    }

}