org.xwiki.tool.resource.XWikiProcessRemoteResourcesMojo Maven / Gradle / Ivy

Go to download
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.tool.resource;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.model.License;
import org.apache.maven.model.Model;
import org.apache.maven.model.Organization;
import org.apache.maven.plugin.resources.remote.ProcessRemoteResourcesMojo;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.InvalidProjectModelException;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectBuilder;
import org.apache.maven.project.ProjectBuildingException;

/**
 * Extends the Maven Remote Resources plugin to fix memory issue found in it, see
 * XCOMMONS-1421.
 * 
 * To be removed when MRRESOURCES-106 is fixed on
 * the Maven side.
 *
 * @version $Id: 097b27c9116d5970c408db6c5e71e732c85be7ff $
 * @since 9.11.5
 * @since 10.5RC1
 */
@Mojo(name = "process", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, threadSafe = true, requiresProject = true,
    requiresDependencyResolution = ResolutionScope.RUNTIME)
public class XWikiProcessRemoteResourcesMojo extends ProcessRemoteResourcesMojo
{
    /**
     * Control what is injected in the "projects" Velocity binding.
     * 
     * @version $Id: 097b27c9116d5970c408db6c5e71e732c85be7ff $
     */
    public enum ProjectData
    {
        /**
         * "projects" is empty.
         */
        NONE,

        /**
         * "projects" only contains licenses.
         */
        LICENSES,

        /**
         * "projects" contains full MavenProject metadata (very expensive but standard Maven Resource plugin behavior).
         */
        FULL
    }

    @Parameter(defaultValue = "NONE")
    protected ProjectData projectsData;

    @Parameter(defaultValue = "${project}", readonly = true)
    private MavenProject projectThis;

    @Parameter(defaultValue = "${localRepository}", readonly = true, required = true)
    private ArtifactRepository localRepositoryThis;

    @Component(role = MavenProjectBuilder.class)
    private MavenProjectBuilder mavenProjectBuilderThis;

    /**
     * List of Remote Repositories used by the resolver.
     */
    @Parameter(defaultValue = "${project.remoteArtifactRepositories}", readonly = true, required = true)
    private List remoteArtifactRepositoriesThis;

    @Override
    protected List getProjects()
    {
        switch (this.projectsData) {
            case FULL:
                return super.getProjects();

            case LICENSES:
                return getLicenses();

            default:
                break;
        }

        return Collections.emptyList();
    }

    private List getLicenses()
    {
        Set artifacts = this.projectThis.getArtifacts();

        List licenses = new ArrayList<>(artifacts.size());

        for (Artifact artifact : artifacts) {
            try {
                getLog().debug(String.format("Building project for [%s]", artifact));

                MavenProject dependencyProject = null;
                try {
                    dependencyProject = this.mavenProjectBuilderThis.buildFromRepository(artifact,
                        this.remoteArtifactRepositoriesThis, this.localRepositoryThis);
                } catch (InvalidProjectModelException e) {
                    getLog().warn(String.format(
                        "Invalid project model for artifact [%s:%s:%s]. It will be ignored by "
                            + "the remote resources Mojo.",
                        artifact.getGroupId(), artifact.getArtifactId(), artifact.getVersion()));
                    continue;
                }

                // Extract license and a summary of the project metadata
                Model miniModel = new Model();
                MavenProject miniProject = new MavenProject(miniModel);
                miniProject.setArtifact(dependencyProject.getArtifact());
                miniProject.setGroupId(dependencyProject.getGroupId());
                miniProject.setArtifactId(dependencyProject.getArtifactId());
                miniProject.setVersion(dependencyProject.getVersion());
                miniProject.setUrl(dependencyProject.getUrl());
                for (License license : dependencyProject.getLicenses()) {
                    // Get rid of XML source metadata
                    miniProject.addLicense(cloneLicense(license));
                }
                // Get rid of XML source metadata
                miniProject.setOrganization(cloneOrganization(dependencyProject.getOrganization()));

                licenses.add(miniProject);
            } catch (ProjectBuildingException e) {
                throw new IllegalStateException(e.getMessage(), e);
            }
        }

        return licenses;
    }

    private static License cloneLicense(License src)
    {
        if (src == null) {
            return null;
        }

        License result = new License();

        result.setComments(src.getComments());
        result.setDistribution(src.getDistribution());
        result.setName(src.getName());
        result.setUrl(src.getUrl());

        return result;
    }

    private static Organization cloneOrganization(Organization src)
    {
        if (src == null) {
            return null;
        }

        Organization result = new Organization();

        result.setName(src.getName());
        result.setUrl(src.getUrl());

        return result;
    }
}