/*
     * Copyright (c) 2024 QOS.ch Sarl (Switzerland)
     * All rights reserved.
     *
     * Permission is hereby granted, free  of charge, to any person obtaining
     * a  copy  of this  software  and  associated  documentation files  (the
     * "Software"), to  deal in  the Software without  restriction, including
     * without limitation  the rights to  use, copy, modify,  merge, publish,
     * distribute,  sublicense, and/or sell  copies of  the Software,  and to
     * permit persons to whom the Software  is furnished to do so, subject to
     * the following conditions:
     *
     * The  above  copyright  notice  and  this permission  notice  shall  be
     * included in all copies or substantial portions of the Software.
     *
     * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
     * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
     * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
     * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
     * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     *
     *
     *
     */

    package ch.qos.logback.tyler.base;

    import ch.qos.logback.classic.Level;
    import ch.qos.logback.classic.LoggerContext;
    import ch.qos.logback.classic.spi.Configurator;
    import ch.qos.logback.classic.tyler.TylerConfiguratorBase;
    import ch.qos.logback.core.Context;
    import ch.qos.logback.core.model.processor.ModelInterpretationContext;
    import ch.qos.logback.tyler.base.spi.StaticImportData;
    import ch.qos.logback.tyler.base.util.VariableNameUtil;
    import com.squareup.javapoet.*;

    import javax.lang.model.element.Modifier;

    import java.util.*;

    import static ch.qos.logback.tyler.base.TylerConstants.*;

    public class TylerModelInterpretationContext extends ModelInterpretationContext {

        final public TypeSpec.Builder tylerConfiguratorTSB;
        final public MethodSpec.Builder configureMethodSpecBuilder;
        final public Map<String, MethodSpec.Builder> mapOfMethodSpecBuilders = new LinkedHashMap<>();

        final FieldSpec contextFieldSpec = FieldSpec.builder(LoggerContext.class, CONTEXT_FIELD_NAME, Modifier.PRIVATE).build();
        final ParameterSpec contextParameterSpec = ParameterSpec.builder(LoggerContext.class, LOGGER_CONTEXT_PARAMETER_NAME).build();
        final ParameterSpec levelParameterSpec = ParameterSpec.builder(Level.class, LEVEL_FIELD_NAME).build();

        final List<FieldSpec> appenderFieldSpecs = new ArrayList<>();

        final List<StaticImportData> staticImportsList = new ArrayList<>();

        public TylerModelInterpretationContext(Context context) {
            super(context);
            this.configureMethodSpecBuilder = initializeConfigureMethodSpecBuilder();
            this.tylerConfiguratorTSB = initializeTylerConfiguratorTSB();
        }

        public void addStaticImport(StaticImportData sid) {
            if (!staticImportsList.contains(sid))
                staticImportsList.add(sid);
        }

        TypeSpec.Builder initializeTylerConfiguratorTSB() {
            //MethodSpec setupLoggerMS = makeSetupLoggerMethodSpec();

            TypeSpec.Builder tsb = TypeSpec.classBuilder(TylerConstants.TYLER_CONFIGURATOR).addJavadoc("""
                                            
                                            <p>This file was generated by logback-tyler version %s</p>
                                            
                                            <p>Eventual errors and warnings are appended at the end.</p>                    
                                            
                                            <p>You may experiment with logback.xml to Java translation, i.e. 
                                            TylerConfigurator generation, at the following URL:</p>
                                            
                                            <p>     https://logback.qos.ch/translator/services/xml2Java.html </p>
                                            
                                            <p>This generated TylerConfigurator class is intended to be copied and integrated 
                                            into the user's project as a custom configurator. It will configure logback 
                                            without XML. You are free to rename TylerConfigurator as you wish.</p>
                                            
                                            <p>It requires logback-classic version %s or later at runtime.</p>
                                            
                                            <p>Custom configurators are looked up via Java's service-provide facility. If a 
                                            custom provider is found, it takes precedence over logback's own configurators, 
                                            e.g. DefaultJoranConfigurator.</p>
                                            
                                            <p>To install your custom configurator to your project, add a 
                                            provider-configuration file to the following path:</p> 
                                            
                                            <pre>  META-INF/services/ch.qos.logback.classic.spi.Configurator</pre>
                                            
                                            <p>This provider-configuration file should contain a line with the fully 
                                            qualified class name of your tyler configurator.</p>
                                            
                                            <p>See also item 1 of 'Configuration at initialization' section at </p>
                                            
                                            <p>  https://logback.qos.ch/manual/configuration.html#auto_configuration</p> 
                                            
                                            <p>With recent versions of logback and logback-tyler you can still
                                            configure logger levels dynamically using properties files. Note that
                                            configuration files in properties format can be watched for
                                            changes. See the documentation on PropertiesConfigurator for more details.</p>
                                            
                                            <p>https://logback.qos.ch/manual/configuration.html#propertiesConfigurator</p>
                                            
                                            <p>Keep in mind that by integrating a .properties configuration file info 
                                            your tyler configurator, you can still change logger levels dynamically, without 
                                            redeploying your application.</p>
                                            
                                            """.formatted(TYLER_VERSION, REQUIRED_LOGBACK_VERSION))
                            .addSuperinterface(Configurator.class)
                            .superclass(TylerConfiguratorBase.class)
                            .addModifiers(Modifier.PUBLIC);
            return tsb;
        }

        private MethodSpec.Builder initializeConfigureMethodSpecBuilder() {
            MethodSpec.Builder msb = MethodSpec.methodBuilder(CONFIGURE_METHOD_NAME).addJavadoc("""
                                            <p>This method performs configuration per {@link $T} interface.</p>
                                            
                                            <p>If <code>TylerConfigurator</code> is installed as a configurator service, this 
                                            method will be called by logback-classic during initialization.</p>
                                            """, Configurator.class).addAnnotation(Override.class).addModifiers(Modifier.PUBLIC).addParameter(contextParameterSpec)
                            .returns(Configurator.ExecutionStatus.class)
                            .addStatement("$N($N)", TylerConfiguratorBase.SET_CONTEXT_METHOD_NAME, contextParameterSpec);

            return msb;
        }

        public FieldSpec getContextFieldSpec() {
            return contextFieldSpec;
        }

//        Shows how to build fields with generic types
//
//        public FieldSpec createAppenderBagSpec() {
//            ParameterizedTypeName mapTypeName = ParameterizedTypeName.get(Map.class, String.class, Appender.class);
//            FieldSpec.Builder fieldSpecBuilder = FieldSpec.builder(mapTypeName, TYLER_APPENDER_BAG_FIELD_NAME).addModifiers(Modifier.PROTECTED, Modifier.FINAL);
//            fieldSpecBuilder.initializer("new $T<>()", HashMap.class);
//            fieldSpecBuilder.addJavadoc("A map used to reference appenders during configuration.");
//
//            return fieldSpecBuilder.build();
//        }

        public FieldSpec createAppenderFieldSpec(ClassName desiredAppenderCN, String appenderName) {
            String appenderVariableName = VariableNameUtil.appenderNameToVariableName(appenderName);
            FieldSpec.Builder fieldSpecBuilder = FieldSpec.builder(desiredAppenderCN, appenderVariableName).addModifiers(Modifier.PROTECTED);
            fieldSpecBuilder.addJavadoc("Appender variable referencing the appender named $S.", appenderName);
            return fieldSpecBuilder.build();
        }

        public Collection<FieldSpec> getAppenderFieldSpecs() {
            return appenderFieldSpecs;
        }
    }