com.sonicle.webtop.core.app.util.LogbackHelper.java Source code

Introduction

Here is the source code for com.sonicle.webtop.core.app.util.LogbackHelper.java

Source

/*
 * Copyright (C) 2019 Sonicle S.r.l.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY SONICLE, SONICLE DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 *
 * You can contact Sonicle S.r.l. at email address sonicle[at]sonicle[dot]com
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * Sonicle logo and Sonicle copyright notice. If the display of the logo is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Copyright (C) 2019 Sonicle S.r.l.".
 */
package com.sonicle.webtop.core.app.util;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.classic.util.ContextInitializer;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.util.Loader;
import ch.qos.logback.core.util.OptionHelper;
import com.sonicle.commons.PathUtils;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Properties;
import org.apache.commons.lang3.StringUtils;
import org.atmosphere.util.IOUtils;

/**
 *
 * @author malbinola
 */
public class LogbackHelper {
    public static final String LOGBACK_PROPERTIES_FILE = "logback.properties";
    public static final String PROP_APPENDER = "logback.webtop.log.appender";
    public static final String PROP_LOG_DIR = "logback.webtop.log.dir";
    public static final String PROP_LOG_FILE_BASENAME = "logback.webtop.log.file.basename";

    public static void reloadConfiguration(LoggerContext loggerContext) throws JoranException {
        ContextInitializer ci = new ContextInitializer(loggerContext);
        loggerContext.reset();
        ci.configureByResource(ci.findURLOfDefaultConfigurationFile(true));
    }

    public static void loadConfiguration(LoggerContext loggerContext, URL url) throws JoranException {
        // https://stackoverflow.com/questions/24235296/how-to-define-logback-variables-properties-before-logback-auto-load-logback-xml
        JoranConfigurator jc = new JoranConfigurator();
        jc.setContext(loggerContext);
        loggerContext.reset();
        jc.doConfigure(url);

        //ContextInitializer ci = new ContextInitializer(loggerContext);
        //loggerContext.reset();
        //ci.configureByResource(url);
    }

    public static void writeProperties(ClassLoader classLoader, Properties properties)
            throws IOException, URISyntaxException {
        FileOutputStream out = null;
        try {
            out = new FileOutputStream(new File(classLoader.getResource(LOGBACK_PROPERTIES_FILE).toURI()));
            properties.store(out, "");
        } finally {
            IOUtils.close(out);
        }
    }

    public static URL findURLOfCustomConfigurationFile(String webappsConfigDir, String webappFullName) {
        File file = null;
        if (!StringUtils.isBlank(webappsConfigDir)) {
            // Try to get file under: "/path/to/webappsConfig/myAppName/logback.xml"
            file = new File(PathUtils.concatPathParts(webappsConfigDir, webappFullName,
                    ContextInitializer.AUTOCONFIG_FILE));
            if (file.exists() && file.isFile()) {
                try {
                    return file.toURI().toURL();
                } catch (MalformedURLException e1) {
                }
            }

            // Try to get file under: "/path/to/webappsConfig/logback.xml"
            file = new File(PathUtils.concatPathParts(webappsConfigDir, ContextInitializer.AUTOCONFIG_FILE));
            if (file.exists() && file.isFile()) {
                try {
                    return file.toURI().toURL();
                } catch (MalformedURLException e1) {
                }
            }
        }
        return null;
    }

    public static URL findURLOfDefaultConfigurationFile(ClassLoader classLoader) {
        URL url = findConfigFileURLFromSystemProperties(classLoader);
        if (url != null)
            return url;
        return Loader.getResource(ContextInitializer.AUTOCONFIG_FILE, classLoader);
    }

    public static URL findConfigFileURLFromSystemProperties(ClassLoader classLoader) {
        String logbackConfigFile = OptionHelper.getSystemProperty(ContextInitializer.CONFIG_FILE_PROPERTY);
        if (logbackConfigFile != null) {
            URL result = null;
            try {
                result = new URL(logbackConfigFile);
                return result;
            } catch (MalformedURLException e) {
                // so, resource is not a URL:
                // attempt to get the resource from the class path
                result = Loader.getResource(logbackConfigFile, classLoader);
                if (result != null) {
                    return result;
                }
                File f = new File(logbackConfigFile);
                if (f.exists() && f.isFile()) {
                    try {
                        result = f.toURI().toURL();
                    } catch (MalformedURLException e1) {
                    }
                }
            }
        }
        return null;
    }
}