ch.qos.logback.classic.model.processor.ConfigurationModelHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of logback-classic Show documentation
There is a newer version: 1.3.5
package ch.qos.logback.classic.model.processor;

import java.net.URL;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.ReconfigureOnChangeTask;
import ch.qos.logback.classic.model.ConfigurationModel;
import ch.qos.logback.classic.util.EnvUtil;
import ch.qos.logback.core.Context;
import ch.qos.logback.core.CoreConstants;
import ch.qos.logback.core.joran.spi.InterpretationContext;
import ch.qos.logback.core.joran.util.ConfigurationWatchListUtil;
import ch.qos.logback.core.model.Model;
import ch.qos.logback.core.model.processor.ModelHandlerBase;
import ch.qos.logback.core.status.OnConsoleStatusListener;
import ch.qos.logback.core.util.ContextUtil;
import ch.qos.logback.core.util.Duration;
import ch.qos.logback.core.util.OptionHelper;
import ch.qos.logback.core.util.StatusListenerConfigHelper;

public class ConfigurationModelHandler extends ModelHandlerBase {

	static final String DEBUG_SYSTEM_PROPERTY_KEY = "logback.debug";
	static final Duration SCAN_PERIOD_DEFAULT = Duration.buildByMinutes(1);

	public ConfigurationModelHandler(Context context) {
		super(context);
	}

	protected Class getSupportedModelClass() {
		return ConfigurationModel.class;
	}

	@Override
	public void handle(InterpretationContext intercon, Model model) {

		ConfigurationModel configurationModel = (ConfigurationModel) model;

		// See LOGBACK-527 (the system property is looked up first. Thus, it overrides
		// the equivalent property in the config file. This reversal of scope priority
		// is justified
		// by the use case: the admin trying to chase rogue config file
		String debugAttrib = getSystemProperty(DEBUG_SYSTEM_PROPERTY_KEY);
		if (debugAttrib == null) {
			debugAttrib = intercon.subst(configurationModel.getDebugStr());
		}

		if (!(OptionHelper.isNullOrEmpty(debugAttrib) || debugAttrib.equalsIgnoreCase("false")
				|| debugAttrib.equalsIgnoreCase("null"))) {
			StatusListenerConfigHelper.addOnConsoleListenerInstance(context, new OnConsoleStatusListener());
		}

		processScanAttrib(intercon, configurationModel);

		LoggerContext lc = (LoggerContext) context;
		boolean packagingData = OptionHelper.toBoolean(intercon.subst(configurationModel.getPackagingDataStr()),
				LoggerContext.DEFAULT_PACKAGING_DATA);
		lc.setPackagingDataEnabled(packagingData);

		if (EnvUtil.isGroovyAvailable()) {
			ContextUtil contextUtil = new ContextUtil(context);
			contextUtil.addGroovyPackages(lc.getFrameworkPackages());
		}
	}

	String getSystemProperty(String name) {
		/*
		 * LOGBACK-743: accessing a system property in the presence of a SecurityManager
		 * (e.g. applet sandbox) can result in a SecurityException.
		 */
		try {
			return System.getProperty(name);
		} catch (SecurityException ex) {
			return null;
		}
	}

	void processScanAttrib(InterpretationContext ic, ConfigurationModel configurationModel) {
		String scanStr = ic.subst(configurationModel.getScanStr());
		if (!OptionHelper.isNullOrEmpty(scanStr) && !"false".equalsIgnoreCase(scanStr)) {

			ScheduledExecutorService scheduledExecutorService = context.getScheduledExecutorService();
			URL mainURL = ConfigurationWatchListUtil.getMainWatchURL(context);
			if (mainURL == null) {
				addWarn("Due to missing top level configuration file, reconfiguration on change (configuration file scanning) cannot be done.");
				return;
			}
			ReconfigureOnChangeTask rocTask = new ReconfigureOnChangeTask();
			rocTask.setContext(context);

			context.putObject(CoreConstants.RECONFIGURE_ON_CHANGE_TASK, rocTask);

			String scanPeriodStr = ic.subst(configurationModel.getScanPeriodStr());
			Duration duration = getDurationOfScanPeriodAttribute(scanPeriodStr, SCAN_PERIOD_DEFAULT);

			addInfo("Will scan for changes in [" + mainURL + "] ");
			// Given that included files are encountered at a later phase, the complete list
			// of files
			// to scan can only be determined when the configuration is loaded in full.
			// However, scan can be active if mainURL is set. Otherwise, when changes are
			// detected
			// the top level config file cannot be accessed.
			addInfo("Setting ReconfigureOnChangeTask scanning period to " + duration);

			ScheduledFuture scheduledFuture = scheduledExecutorService.scheduleAtFixedRate(rocTask,
					duration.getMilliseconds(), duration.getMilliseconds(), TimeUnit.MILLISECONDS);
			context.addScheduledFuture(scheduledFuture);
		}
	}

	private Duration getDurationOfScanPeriodAttribute(String scanPeriodAttrib, Duration defaultDuration) {
		Duration duration = null;

		if (!OptionHelper.isNullOrEmpty(scanPeriodAttrib)) {
			try {
				duration = Duration.valueOf(scanPeriodAttrib);
			} catch (IllegalStateException | IllegalArgumentException e) {
				addWarn("Failed to parse 'scanPeriod' attribute [" + scanPeriodAttrib + "]", e);
				// default duration will be set below
			}
		}

		if (duration == null) {
			addInfo("No 'scanPeriod' specified. Defaulting to " + defaultDuration.toString());
			duration = defaultDuration;
		}
		return duration;
	}

}