/*
 * 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.impl.model;

import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.function.BiFunction;

import org.apache.maven.api.di.Inject;
import org.apache.maven.api.di.Named;
import org.apache.maven.api.di.Singleton;
import org.apache.maven.api.model.Build;
import org.apache.maven.api.model.Model;
import org.apache.maven.api.model.Reporting;
import org.apache.maven.api.model.Resource;
import org.apache.maven.api.model.Source;
import org.apache.maven.api.services.ModelBuilderRequest;
import org.apache.maven.api.services.model.ModelPathTranslator;
import org.apache.maven.api.services.model.PathTranslator;

/**
 * Resolves relative paths within a model against a specific base directory.
 *
 */
@Named
@Singleton
public class DefaultModelPathTranslator implements ModelPathTranslator {

    private final PathTranslator pathTranslator;

    @Inject
    public DefaultModelPathTranslator(PathTranslator pathTranslator) {
        this.pathTranslator = pathTranslator;
    }

    @Override
    public Model alignToBaseDirectory(Model model, Path basedir, ModelBuilderRequest request) {
        if (model == null || basedir == null) {
            return model;
        }

        Build build = model.getBuild();
        Build newBuild = null;
        if (build != null) {
            newBuild = Build.newBuilder(build)
                    .sources(map(build.getSources(), this::alignToBaseDirectory, basedir))
                    .directory(alignToBaseDirectory(build.getDirectory(), basedir))
                    .sourceDirectory(alignToBaseDirectory(build.getSourceDirectory(), basedir))
                    .testSourceDirectory(alignToBaseDirectory(build.getTestSourceDirectory(), basedir))
                    .scriptSourceDirectory(alignToBaseDirectory(build.getScriptSourceDirectory(), basedir))
                    .resources(map(build.getResources(), this::alignToBaseDirectory, basedir))
                    .testResources(map(build.getTestResources(), this::alignToBaseDirectory, basedir))
                    .filters(map(build.getFilters(), this::alignToBaseDirectory, basedir))
                    .outputDirectory(alignToBaseDirectory(build.getOutputDirectory(), basedir))
                    .testOutputDirectory(alignToBaseDirectory(build.getTestOutputDirectory(), basedir))
                    .build();
        }

        Reporting reporting = model.getReporting();
        Reporting newReporting = null;
        if (reporting != null) {
            newReporting = Reporting.newBuilder(reporting)
                    .outputDirectory(alignToBaseDirectory(reporting.getOutputDirectory(), basedir))
                    .build();
        }
        if (newBuild != build || newReporting != reporting) {
            model = Model.newBuilder(model)
                    .build(newBuild)
                    .reporting(newReporting)
                    .build();
        }
        return model;
    }

    /**
     * Replaces in a new list all elements of the given list using the given function.
     * If no list element has changed, then this method returns the previous list instance.
     * The given list is never modified.
     *
     * @param resource the list for which to replace elements
     * @param mapper one of the {@code this::alignToBaseDirectory} methods
     * @param basedir the new base directory
     * @return list with modified elements, or {@code resources} if there is no change
     */
    private <T> List<T> map(List<T> resources, BiFunction<T, Path, T> mapper, Path basedir) {
        List<T> newResources = null;
        if (resources != null) {
            for (int i = 0; i < resources.size(); i++) {
                T resource = resources.get(i);
                T newResource = mapper.apply(resource, basedir);
                if (newResource != resource) {
                    if (newResources == null) {
                        newResources = new ArrayList<>(resources);
                    }
                    newResources.set(i, newResource);
                }
            }
        }
        return newResources;
    }

    /**
     * Returns a source with all properties identical to the given source, except the paths
     * which are resolved according the given {@code basedir}. If the paths are unchanged,
     * then this method returns the previous instance.
     *
     * @param source the source to relocate, or {@code null}
     * @param basedir the new base directory
     * @return relocated source, or {@code null} if the given source was null
     */
    @SuppressWarnings("StringEquality") // Identity comparison is ok in this method.
    private Source alignToBaseDirectory(Source source, Path basedir) {
        if (source != null) {
            String oldDir = source.getDirectory();
            String newDir = alignToBaseDirectory(oldDir, basedir);
            if (newDir != oldDir) {
                source = source.withDirectory(newDir);
            }
            // Note: targetPath is intentionally NOT aligned to basedir.
            // It is relative to the output directory (target/classes or target/test-classes),
            // not to the project base directory. See maven.mdo Source.targetPath documentation.
        }
        return source;
    }

    /**
     * Returns a resource with all properties identical to the given resource, except the paths
     * which are resolved according the given {@code basedir}. If the paths are unchanged, then
     * this method returns the previous instance.
     *
     * @param resource the resource to relocate, or {@code null}
     * @param basedir the new base directory
     * @return relocated resource, or {@code null} if the given resource was null
     */
    @SuppressWarnings("StringEquality") // Identity comparison is ok in this method.
    private Resource alignToBaseDirectory(Resource resource, Path basedir) {
        if (resource != null) {
            String oldDir = resource.getDirectory();
            String newDir = alignToBaseDirectory(oldDir, basedir);
            if (newDir != oldDir) {
                return resource.withDirectory(newDir);
            }
        }
        return resource;
    }

    /**
     * Returns a path relocated to the given base directory. If the result of this operation
     * is the same path as before, then this method returns the old {@code path} instance.
     * It is okay for the caller to compare the {@link String} instances using the identity
     * comparator for detecting changes.
     *
     * @param path the path to relocate, or {@code null}
     * @param basedir the new base directory
     * @return relocated path, or {@code null} if the given path was null
     */
    private String alignToBaseDirectory(String path, Path basedir) {
        String newPath = pathTranslator.alignToBaseDirectory(path, basedir);
        return Objects.equals(path, newPath) ? path : newPath;
    }
}
