001/*
002 * Logback: the reliable, generic, fast and flexible logging framework.
003 * Copyright (C) 1999-2026, QOS.ch. All rights reserved.
004 *
005 * This program and the accompanying materials are dual-licensed under
006 * either the terms of the Eclipse Public License v2.0 as published by
007 * the Eclipse Foundation
008 *
009 *   or (per the licensee's choosing)
010 *
011 * under the terms of the GNU Lesser General Public License version 2.1
012 * as published by the Free Software Foundation.
013 */
014
015package ch.qos.logback.classic.model.processor;
016
017import static ch.qos.logback.core.joran.JoranConstants.NULL;
018
019import ch.qos.logback.classic.Level;
020import ch.qos.logback.classic.Logger;
021import ch.qos.logback.classic.LoggerContext;
022import ch.qos.logback.classic.model.LoggerModel;
023import ch.qos.logback.core.Context;
024import ch.qos.logback.core.joran.JoranConstants;
025import ch.qos.logback.core.model.Model;
026import ch.qos.logback.core.model.processor.ModelHandlerBase;
027import ch.qos.logback.core.model.processor.ModelHandlerException;
028import ch.qos.logback.core.model.processor.ModelInterpretationContext;
029import ch.qos.logback.core.spi.ErrorCodes;
030import ch.qos.logback.core.util.OptionHelper;
031
032public class LoggerModelHandler extends ModelHandlerBase {
033
034    Logger logger;
035    boolean inError = false;
036
037    public LoggerModelHandler(Context context) {
038        super(context);
039    }
040
041    static public ModelHandlerBase makeInstance(Context context, ModelInterpretationContext mic) {
042        return new LoggerModelHandler(context);
043    }
044
045    protected Class<LoggerModel> getSupportedModelClass() {
046        return LoggerModel.class;
047    }
048
049    @Override
050    public void handle(ModelInterpretationContext mic, Model model) throws ModelHandlerException {
051        inError = false;
052
053        LoggerModel loggerModel = (LoggerModel) model;
054
055        String finalLoggerName = mic.subst(loggerModel.getName());
056
057        LoggerContext loggerContext = (LoggerContext) this.context;
058
059        logger = loggerContext.getLogger(finalLoggerName);
060
061        String levelStr = mic.subst(loggerModel.getLevel());
062        if (!OptionHelper.isNullOrEmptyOrAllSpaces(levelStr)) {
063            if (JoranConstants.INHERITED.equalsIgnoreCase(levelStr) || NULL.equalsIgnoreCase(levelStr)) {
064                if(Logger.ROOT_LOGGER_NAME.equalsIgnoreCase(finalLoggerName)) {
065                    addError(ErrorCodes.ROOT_LEVEL_CANNOT_BE_SET_TO_NULL);
066                } else {
067                    addInfo("Setting level of logger [" + finalLoggerName + "] to null, i.e. INHERITED");
068                    logger.setLevel(null);
069                }
070            } else {
071                Level level = Level.toLevel(levelStr);
072                addInfo("Setting level of logger [" + finalLoggerName + "] to " + level);
073                logger.setLevel(level);
074            }
075        }
076
077        String additivityStr = mic.subst(loggerModel.getAdditivity());
078        if (!OptionHelper.isNullOrEmptyOrAllSpaces(additivityStr)) {
079            boolean additive = OptionHelper.toBoolean(additivityStr, true);
080            addInfo("Setting additivity of logger [" + finalLoggerName + "] to " + additive);
081            logger.setAdditive(additive);
082        }
083
084        mic.pushObject(logger);
085    }
086
087    @Override
088    public void postHandle(ModelInterpretationContext mic, Model model) {
089        if (inError) {
090            return;
091        }
092        Object o = mic.peekObject();
093        if (o != logger) {
094            LoggerModel loggerModel = (LoggerModel) model;
095            addWarn("The object [" + o + "] on the top the of the stack is not the expected logger named "
096                    + loggerModel.getName());
097        } else {
098            mic.popObject();
099        }
100
101    }
102
103}