    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.release.plugin.mojos;
    018
    019import java.io.File;
    020import java.io.IOException;
    021import java.io.InputStream;
    022import java.io.OutputStream;
    023import java.nio.file.Files;
    024import java.util.ArrayList;
    025import java.util.List;
    026import java.util.zip.ZipEntry;
    027import java.util.zip.ZipOutputStream;
    028
    029import org.apache.commons.io.IOUtils;
    030import org.apache.commons.lang3.StringUtils;
    031import org.apache.maven.plugin.AbstractMojo;
    032import org.apache.maven.plugin.MojoExecutionException;
    033import org.apache.maven.plugin.MojoFailureException;
    034import org.apache.maven.plugins.annotations.LifecyclePhase;
    035import org.apache.maven.plugins.annotations.Mojo;
    036import org.apache.maven.plugins.annotations.Parameter;
    037
    038/**
    039 * Takes the built <code>./target/site</code> directory and compresses it to
    040 * <code>./target/commons-release-plugin/site.zip</code>.
    041 *
    042 * @since 1.0
    043 * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the
    044 *               {@link CommonsDistributionStagingMojo}.
    045 */
    046@Deprecated
    047@Mojo(name = "compress-site",
    048        defaultPhase = LifecyclePhase.POST_SITE,
    049        threadSafe = true,
    050        aggregator = true)
    051public class CommonsSiteCompressionMojo extends AbstractMojo {
    052
    053    /**
    054     * The working directory for the plugin which, assuming the maven uses the default
    055     * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.
    056     */
    057    @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",
    058            property = "commons.outputDirectory")
    059    private File workingDirectory;
    060
    061    /**
    062     */
    063    @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")
    064    private File siteDirectory;
    065
    066    /**
    067     * The url of the subversion repository to which we wish the artifacts to be staged. Typically
    068     * this would need to be of the form:
    069     * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the
    070     * substring <code>https</code> is a requirement.
    071     */
    072    @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")
    073    private String distSvnStagingUrl;
    074
    075    /**
    076     * A parameter to generally avoid running unless it is specifically turned on by the consuming module.
    077     */
    078    @Parameter(defaultValue = "false", property = "commons.release.isDistModule")
    079    private Boolean isDistModule;
    080
    081    /**
    082     * The list of files to compress into the site.zip file.
    083     */
    084    private List<File> filesToCompress;
    085
    086    @Override
    087    public void execute() throws MojoExecutionException, MojoFailureException {
    088        if (!isDistModule) {
    089            getLog().info("This module is marked as a non distribution "
    090                    + "or assembly module, and the plugin will not run.");
    091            return;
    092        }
    093        if (StringUtils.isEmpty(distSvnStagingUrl)) {
    094            getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");
    095            return;
    096        }
    097        if (!siteDirectory.exists()) {
    098            getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");
    099            throw new MojoFailureException(
    100                    "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."
    101            );
    102        }
    103        if (!workingDirectory.exists()) {
    104            getLog().info("Current project contains no distributions. Not executing.");
    105            return;
    106        }
    107        try {
    108            filesToCompress = new ArrayList<>();
    109            getAllSiteFiles(siteDirectory, filesToCompress);
    110            writeZipFile(workingDirectory, siteDirectory, filesToCompress);
    111        } catch (final IOException e) {
    112            getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);
    113            throw new MojoExecutionException(
    114                    "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),
    115                    e
    116            );
    117        }
    118    }
    119
    120    /**
    121     * By default this method iterates across the <code>target/site</code> directory and adds all the files
    122     * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.
    123     *
    124     * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.
    125     * @param filesToCompress the {@link List} to which to add all the files.
    126     */
    127    private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {
    128        final File[] files = siteDirectory.listFiles();
    129        for (final File file : files) {
    130            filesToCompress.add(file);
    131            if (file.isDirectory()) {
    132                getAllSiteFiles(file, filesToCompress);
    133            }
    134        }
    135    }
    136
    137    /**
    138     * A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file
    139     * in the <code>workingDirectory</code>.
    140     *
    141     * @param outputDirectory is a {@link File} representing the place to put the site.zip file.
    142     * @param directoryToZip is a {@link File} representing the directory of the site (normally
    143     *                       <code>target/site</code>).
    144     * @param fileList the list of files to be zipped up, generally generated by
    145     *                 {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.
    146     * @throws IOException when the copying of the files goes incorrectly.
    147     */
    148    private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)
    149            throws IOException {
    150        try (OutputStream fos = Files.newOutputStream(new File(outputDirectory.getAbsolutePath() + "/site.zip")
    151                .toPath());
    152             ZipOutputStream zos = new ZipOutputStream(fos)) {
    153            for (final File file : fileList) {
    154                if (!file.isDirectory()) { // we only ZIP files, not directories
    155                    addToZip(directoryToZip, file, zos);
    156                }
    157            }
    158        }
    159    }
    160
    161    /**
    162     * Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by
    163     * <code>zos</code>.
    164     *
    165     * @param directoryToZip a {@link File} representing the directory from which the file exists that we are
    166     *                       compressing. Generally this is <code>target/site</code>.
    167     * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.
    168     * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.
    169     * @throws IOException if adding the <code>file</code> doesn't work out properly.
    170     */
    171    private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {
    172        try (InputStream fis = Files.newInputStream(file.toPath())) {
    173            // we want the zipEntry's path to be a relative path that is relative
    174            // to the directory being zipped, so chop off the rest of the path
    175            final String zipFilePath = file.getCanonicalPath().substring(
    176                    directoryToZip.getCanonicalPath().length() + 1,
    177                    file.getCanonicalPath().length());
    178            final ZipEntry zipEntry = new ZipEntry(zipFilePath);
    179            zos.putNextEntry(zipEntry);
    180            IOUtils.copy(fis, zos);
    181        }
    182    }
    183}