src/main/java/org/apache/maven/shared/filtering/BaseFilter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.maven.shared.filtering;

import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Properties;
import java.util.TreeSet;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.MavenProject;
import org.apache.maven.settings.Settings;
import org.codehaus.plexus.interpolation.Interpolator;
import org.codehaus.plexus.interpolation.PrefixAwareRecursionInterceptor;
import org.codehaus.plexus.interpolation.PrefixedObjectValueSource;
import org.codehaus.plexus.interpolation.PropertiesBasedValueSource;
import org.codehaus.plexus.interpolation.RecursionInterceptor;
import org.codehaus.plexus.interpolation.SimpleRecursionInterceptor;
import org.codehaus.plexus.interpolation.SingleResponseValueSource;
import org.codehaus.plexus.interpolation.ValueSource;
import org.codehaus.plexus.interpolation.multi.MultiDelimiterStringSearchInterpolator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class BaseFilter implements DefaultFilterInfo {
    private final Logger logger = LoggerFactory.getLogger(getClass());

    protected Logger getLogger() {
        return logger;
    }

    @Override
    public List<FilterWrapper> getDefaultFilterWrappers(
            final MavenProject mavenProject,
            List<String> filters,
            final boolean escapedBackslashesInFilePath,
            MavenSession mavenSession,
            MavenResourcesExecution mavenResourcesExecution)
            throws MavenFilteringException {

        MavenResourcesExecution mre =
                mavenResourcesExecution == null ? new MavenResourcesExecution() : mavenResourcesExecution.copyOf();

        mre.setMavenProject(mavenProject);
        mre.setMavenSession(mavenSession);
        mre.setFilters(filters);
        mre.setEscapedBackslashesInFilePath(escapedBackslashesInFilePath);

        return getDefaultFilterWrappers(mre);
    }

    @Override
    public List<FilterWrapper> getDefaultFilterWrappers(final AbstractMavenFilteringRequest request)
            throws MavenFilteringException {
        // backup values
        boolean supportMultiLineFiltering = request.isSupportMultiLineFiltering();

        request.setSupportMultiLineFiltering(supportMultiLineFiltering);

        // Here we build some properties which will be used to read some properties files
        // to interpolate the expression ${ } in this properties file

        // Take a copy of filterProperties to ensure that evaluated filterTokens are not propagated
        // to subsequent filter files. Note: this replicates current behaviour and seems to make sense.

        final Properties baseProps = new Properties();

        // Project properties
        if (request.getMavenProject() != null) {
            baseProps.putAll(
                    request.getMavenProject().getProperties() == null
                            ? Collections.emptyMap()
                            : request.getMavenProject().getProperties());
        }
        // TODO this is NPE free but do we consider this as normal
        // or do we have to throw an MavenFilteringException with mavenSession cannot be null
        //
        // khmarbaise: 2016-05-21:
        // If we throw an MavenFilteringException tests will fail which is
        // caused by for example:
        // void copyFile( File from, final File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers,
        // String encoding )
        // in MavenFileFilter interface where no MavenSession is given.
        // So changing here to throw a MavenFilteringException would make
        // it necessary to change the interface or we need to find a better solution.
        //
        if (request.getMavenSession() != null) {
            // User properties have precedence over system properties
            putAll(baseProps, request.getMavenSession().getSystemProperties());
            putAll(baseProps, request.getMavenSession().getUserProperties());
        }

        // now we build properties to use for resources interpolation

        final Properties filterProperties = new Properties();

        File basedir =
                request.getMavenProject() != null ? request.getMavenProject().getBasedir() : new File(".");

        loadProperties(filterProperties, basedir, request.getFileFilters(), baseProps);
        if (filterProperties.isEmpty()) {
            putAll(filterProperties, baseProps);
        }

        if (request.getMavenProject() != null) {
            if (request.isInjectProjectBuildFilters()) {
                List<String> buildFilters =
                        new ArrayList<>(request.getMavenProject().getBuild().getFilters());

                // JDK-8015656: (coll) unexpected NPE from removeAll
                if (request.getFileFilters() != null) {
                    buildFilters.removeAll(request.getFileFilters());
                }

                loadProperties(filterProperties, basedir, buildFilters, baseProps);
            }

            // Project properties
            filterProperties.putAll(
                    request.getMavenProject().getProperties() == null
                            ? Collections.emptyMap()
                            : request.getMavenProject().getProperties());
        }
        if (request.getMavenSession() != null) {
            // User properties have precedence over system properties
            putAll(filterProperties, request.getMavenSession().getSystemProperties());
            putAll(filterProperties, request.getMavenSession().getUserProperties());
        }

        if (request.getAdditionalProperties() != null) {
            // additional properties wins
            putAll(filterProperties, request.getAdditionalProperties());
        }

        List<FilterWrapper> defaultFilterWrappers =
                new ArrayList<>(request.getDelimiters().size() + 1);

        if (getLogger().isDebugEnabled()) {
            getLogger().debug("properties used:");
            for (String s : new TreeSet<>(filterProperties.stringPropertyNames())) {
                getLogger().debug(s + ": " + filterProperties.getProperty(s));
            }
        }

        final ValueSource propertiesValueSource = new PropertiesBasedValueSource(filterProperties);

        FilterWrapper wrapper = new Wrapper(
                request.getDelimiters(),
                request.getMavenProject(),
                request.getMavenSession(),
                propertiesValueSource,
                request.getProjectStartExpressions(),
                request.getEscapeString(),
                request.isEscapeWindowsPaths(),
                request.isSupportMultiLineFiltering());

        defaultFilterWrappers.add(wrapper);

        return defaultFilterWrappers;
    }

    @SuppressWarnings("SynchronizationOnLocalVariableOrMethodParameter")
    private static void putAll(Properties filterProperties, Properties request) {
        synchronized (request) {
            filterProperties.putAll(request);
        }
    }

    /**
     * default visibility only for testing reason !
     */
    void loadProperties(
            Properties filterProperties, File basedir, List<String> propertiesFilePaths, Properties baseProps)
            throws MavenFilteringException {
        if (propertiesFilePaths != null) {
            Properties workProperties = new Properties();
            putAll(workProperties, baseProps);

            for (String filterFile : propertiesFilePaths) {
                if (filterFile == null || filterFile.trim().isEmpty()) {
                    // skip empty file name
                    continue;
                }
                try {
                    File propFile = FilteringUtils.resolveFile(basedir, filterFile);
                    Properties properties = PropertyUtils.loadPropertyFile(propFile, workProperties, getLogger());
                    putAll(filterProperties, properties);
                    putAll(workProperties, properties);
                } catch (IOException e) {
                    throw new MavenFilteringException("Error loading property file '" + filterFile + "'", e);
                }
            }
        }
    }

    private static final class Wrapper extends FilterWrapper {

        private LinkedHashSet<String> delimiters;

        private MavenProject project;

        private ValueSource propertiesValueSource;

        private List<String> projectStartExpressions;

        private String escapeString;

        private boolean escapeWindowsPaths;

        private final MavenSession mavenSession;

        private boolean supportMultiLineFiltering;

        Wrapper(
                LinkedHashSet<String> delimiters,
                MavenProject project,
                MavenSession mavenSession,
                ValueSource propertiesValueSource,
                List<String> projectStartExpressions,
                String escapeString,
                boolean escapeWindowsPaths,
                boolean supportMultiLineFiltering) {
            super();
            this.delimiters = delimiters;
            this.project = project;
            this.mavenSession = mavenSession;
            this.propertiesValueSource = propertiesValueSource;
            this.projectStartExpressions = projectStartExpressions;
            this.escapeString = escapeString;
            this.escapeWindowsPaths = escapeWindowsPaths;
            this.supportMultiLineFiltering = supportMultiLineFiltering;
        }

        @Override
        public Reader getReader(Reader reader) {
            Interpolator interpolator = createInterpolator(
                    delimiters,
                    projectStartExpressions,
                    propertiesValueSource,
                    project,
                    mavenSession,
                    escapeString,
                    escapeWindowsPaths);

            MultiDelimiterInterpolatorFilterReaderLineEnding filterReader =
                    new MultiDelimiterInterpolatorFilterReaderLineEnding(
                            reader, interpolator, supportMultiLineFiltering);

            final RecursionInterceptor ri;
            if (projectStartExpressions != null && !projectStartExpressions.isEmpty()) {
                ri = new PrefixAwareRecursionInterceptor(projectStartExpressions, true);
            } else {
                ri = new SimpleRecursionInterceptor();
            }

            filterReader.setRecursionInterceptor(ri);
            filterReader.setDelimiterSpecs(delimiters);

            filterReader.setInterpolateWithPrefixPattern(false);
            filterReader.setEscapeString(escapeString);

            return filterReader;
        }
    }

    private static Interpolator createInterpolator(
            LinkedHashSet<String> delimiters,
            List<String> projectStartExpressions,
            ValueSource propertiesValueSource,
            MavenProject project,
            MavenSession mavenSession,
            String escapeString,
            boolean escapeWindowsPaths) {
        MultiDelimiterStringSearchInterpolator interpolator = new MultiDelimiterStringSearchInterpolator();
        interpolator.setDelimiterSpecs(delimiters);

        interpolator.addValueSource(propertiesValueSource);

        if (project != null) {
            interpolator.addValueSource(new PrefixedObjectValueSource(projectStartExpressions, project, true));
        }

        if (mavenSession != null) {
            interpolator.addValueSource(new PrefixedObjectValueSource("session", mavenSession));

            final Settings settings = mavenSession.getSettings();
            if (settings != null) {
                interpolator.addValueSource(new PrefixedObjectValueSource("settings", settings));
                interpolator.addValueSource(
                        new SingleResponseValueSource("localRepository", settings.getLocalRepository()));
            }
        }

        interpolator.setEscapeString(escapeString);

        if (escapeWindowsPaths) {
            interpolator.addPostProcessor((expression, value) ->
                    (value instanceof String) ? FilteringUtils.escapeWindowsPath((String) value) : value);
        }
        return interpolator;
    }
}