All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.codehaus.plexus.archiver.AbstractArchiver Maven / Gradle / Ivy

Go to download

The newest version!
/**
 *
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed 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.codehaus.plexus.archiver;

import javax.annotation.Nonnull;
import javax.inject.Inject;
import javax.inject.Provider;

import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.UndeclaredThrowableException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.attribute.FileTime;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;

import org.codehaus.plexus.archiver.manager.ArchiverManager;
import org.codehaus.plexus.archiver.manager.NoSuchArchiverException;
import org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributeUtils;
import org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes;
import org.codehaus.plexus.components.io.attributes.SimpleResourceAttributes;
import org.codehaus.plexus.components.io.functions.ResourceAttributeSupplier;
import org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollection;
import org.codehaus.plexus.components.io.resources.EncodingSupported;
import org.codehaus.plexus.components.io.resources.PlexusIoArchivedResourceCollection;
import org.codehaus.plexus.components.io.resources.PlexusIoFileResourceCollection;
import org.codehaus.plexus.components.io.resources.PlexusIoResource;
import org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection;
import org.codehaus.plexus.components.io.resources.proxy.PlexusIoProxyResourceCollection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.codehaus.plexus.archiver.util.DefaultArchivedFileSet.archivedFileSet;
import static org.codehaus.plexus.archiver.util.DefaultFileSet.fileSet;

public abstract class AbstractArchiver implements Archiver, FinalizerEnabled {

    private final Logger logger = LoggerFactory.getLogger(getClass());

    protected Logger getLogger() {
        return logger;
    }

    private File destFile;

    /**
     * A list of the following objects:
     * 
    
     * 
  • Instances of {@link ArchiveEntry}, which are passed back by {@link #getResources()} without modifications
     * .
    • 
     * 
  • Instances of {@link PlexusIoResourceCollection}, which are converted into an {@link Iterator} over instances
     * of {@link ArchiveEntry} by {@link #getResources()}.
     * 

     */
    private final List resources = new ArrayList<>();

    private boolean includeEmptyDirs = true;

    private int forcedFileMode = -1; // Will always be used

    private int forcedDirectoryMode = -1; // Will always be used

    private int defaultFileMode = -1; // Optionally used if a value is needed

    private int defaultDirectoryMode = -1; // Optionally used if a value is needed

    private int umask = -1;

    private boolean forced = true;

    private List finalizers;

    private File dotFileDirectory;

    private String duplicateBehavior = Archiver.DUPLICATES_SKIP;

    // On lunix-like systems, we replace windows backslashes with forward slashes
    private final boolean replacePathSlashesToJavaPaths = File.separatorChar == '/';

    private final List closeables = new ArrayList<>();

    /**
     * since 2.2 is on by default
     *
     * @since 1.1
     */
    private boolean useJvmChmod = true;

    private FileTime lastModifiedTime;

    /**
     * @since 4.2.0
     */
    private Comparator filenameComparator;

    /**
     * @since 4.2.0
     */
    private int overrideUid = -1;

    /**
     * @since 4.2.0
     */
    private String overrideUserName;

    /**
     * @since 4.2.0
     */
    private int overrideGid = -1;

    /**
     * @since 4.2.0
     */
    private String overrideGroupName;

    /**
     * Injected: Allows us to pull the ArchiverManager instance out of the container without causing a chicken-and-egg
     * instantiation/composition problem.
     */
    @Inject
    private Provider archiverManagerProvider;

    private static class AddedResourceCollection {

        private final PlexusIoResourceCollection resources;

        private final int forcedFileMode;

        private final int forcedDirectoryMode;

        public AddedResourceCollection(PlexusIoResourceCollection resources, int forcedFileMode, int forcedDirMode) {
            this.resources = resources;
            this.forcedFileMode = forcedFileMode;
            this.forcedDirectoryMode = forcedDirMode;
        }

        private int maybeOverridden(int suggestedMode, boolean isDir) {
            if (isDir) {
                return forcedDirectoryMode >= 0 ? forcedDirectoryMode : suggestedMode;
            } else {
                return forcedFileMode >= 0 ? forcedFileMode : suggestedMode;
            }
        }
    }

    /**
     * @since 1.1
     */
    private boolean ignorePermissions = false;

    @Override
    public String getDuplicateBehavior() {
        return duplicateBehavior;
    }

    @Override
    public void setDuplicateBehavior(final String duplicate) {
        if (!Archiver.DUPLICATES_VALID_BEHAVIORS.contains(duplicate)) {
            throw new IllegalArgumentException("Invalid duplicate-file behavior: '" + duplicate
                    + "'. Please specify one of: " + Archiver.DUPLICATES_VALID_BEHAVIORS);
        }

        duplicateBehavior = duplicate;
    }

    @Override
    public final void setFileMode(final int mode) {
        if (mode >= 0) {
            forcedFileMode = (mode & UnixStat.PERM_MASK) | UnixStat.FILE_FLAG;
        } else {
            forcedFileMode = -1;
        }
    }

    @Override
    public final void setDefaultFileMode(final int mode) {
        defaultFileMode = (mode & UnixStat.PERM_MASK) | UnixStat.FILE_FLAG;
    }

    @Override
    public final int getOverrideFileMode() {
        return forcedFileMode;
    }

    @Override
    public final int getFileMode() {
        if (forcedFileMode < 0) {
            if (defaultFileMode < 0) {
                return DEFAULT_FILE_MODE;
            }

            return defaultFileMode;
        }

        return forcedFileMode;
    }

    @Override
    public final int getDefaultFileMode() {
        return defaultFileMode;
    }

    /**
     * @deprecated Use {@link Archiver#getDefaultFileMode()}.
     */
    @Deprecated
    public final int getRawDefaultFileMode() {
        return getDefaultFileMode();
    }

    @Override
    public final void setDirectoryMode(final int mode) {
        if (mode >= 0) {
            forcedDirectoryMode = (mode & UnixStat.PERM_MASK) | UnixStat.DIR_FLAG;
        } else {
            forcedDirectoryMode = -1;
        }
    }

    @Override
    public final void setDefaultDirectoryMode(final int mode) {
        defaultDirectoryMode = (mode & UnixStat.PERM_MASK) | UnixStat.DIR_FLAG;
    }

    @Override
    public final int getOverrideDirectoryMode() {
        return forcedDirectoryMode;
    }

    @Override
    public final int getDirectoryMode() {
        if (forcedDirectoryMode < 0) {
            if (defaultDirectoryMode < 0) {
                return DEFAULT_DIR_MODE;
            }

            return defaultDirectoryMode;
        }

        return forcedDirectoryMode;
    }

    @Override
    public final int getDefaultDirectoryMode() {
        if (defaultDirectoryMode < 0) {
            return DEFAULT_DIR_MODE;
        } else {
            return defaultDirectoryMode;
        }
    }

    @Override
    public boolean getIncludeEmptyDirs() {
        return includeEmptyDirs;
    }

    @Override
    public void setIncludeEmptyDirs(final boolean includeEmptyDirs) {
        this.includeEmptyDirs = includeEmptyDirs;
    }

    @Override
    public void addDirectory(@Nonnull final File directory) throws ArchiverException {
        addFileSet(fileSet(directory).prefixed("").includeExclude(null, null).includeEmptyDirs(includeEmptyDirs));
    }

    @Override
    public void addDirectory(@Nonnull final File directory, final String prefix) throws ArchiverException {
        addFileSet(
                fileSet(directory).prefixed(prefix).includeExclude(null, null).includeEmptyDirs(includeEmptyDirs));
    }

    @Override
    public void addDirectory(@Nonnull final File directory, final String[] includes, final String[] excludes)
            throws ArchiverException {
        addFileSet(fileSet(directory)
                .prefixed("")
                .includeExclude(includes, excludes)
                .includeEmptyDirs(includeEmptyDirs));
    }

    @Override
    public void addDirectory(
            @Nonnull final File directory, final String prefix, final String[] includes, final String[] excludes)
            throws ArchiverException {
        addFileSet(fileSet(directory)
                .prefixed(prefix)
                .includeExclude(includes, excludes)
                .includeEmptyDirs(includeEmptyDirs));
    }

    @Override
    public void addFileSet(@Nonnull final FileSet fileSet) throws ArchiverException {
        final File directory = fileSet.getDirectory();
        if (directory == null) {
            throw new ArchiverException("The file sets base directory is null.");
        }

        if (!directory.isDirectory()) {
            throw new ArchiverException(directory.getAbsolutePath() + " isn't a directory.");
        }

        // The PlexusIoFileResourceCollection contains platform-specific File.separatorChar which
        // is an interesting cause of grief, see PLXCOMP-192
        final PlexusIoFileResourceCollection collection = new PlexusIoFileResourceCollection();
        collection.setFollowingSymLinks(false);

        collection.setIncludes(fileSet.getIncludes());
        collection.setExcludes(fileSet.getExcludes());
        collection.setBaseDir(directory);
        collection.setFileSelectors(fileSet.getFileSelectors());
        collection.setIncludingEmptyDirectories(fileSet.isIncludingEmptyDirectories());
        collection.setPrefix(fileSet.getPrefix());
        collection.setCaseSensitive(fileSet.isCaseSensitive());
        collection.setUsingDefaultExcludes(fileSet.isUsingDefaultExcludes());
        collection.setStreamTransformer(fileSet.getStreamTransformer());
        collection.setFileMappers(fileSet.getFileMappers());
        collection.setFilenameComparator(getFilenameComparator());

        if (getOverrideDirectoryMode() > -1
                || getOverrideFileMode() > -1
                || getOverrideUid() > -1
                || getOverrideGid() > -1
                || getOverrideUserName() != null
                || getOverrideGroupName() != null) {
            collection.setOverrideAttributes(
                    getOverrideUid(),
                    getOverrideUserName(),
                    getOverrideGid(),
                    getOverrideGroupName(),
                    getOverrideFileMode(),
                    getOverrideDirectoryMode());
        }

        if (getDefaultDirectoryMode() > -1 || getDefaultFileMode() > -1) {
            collection.setDefaultAttributes(-1, null, -1, null, getDefaultFileMode(), getDefaultDirectoryMode());
        }

        addResources(collection);
    }

    @Override
    public void addFile(@Nonnull final File inputFile, @Nonnull final String destFileName) throws ArchiverException {
        int permissions;
        if (forcedFileMode > 0) {
            permissions = forcedFileMode;
        } else {
            permissions = PlexusIoResourceAttributes.UNKNOWN_OCTAL_MODE;
            try {
                permissions = PlexusIoResourceAttributeUtils.getFileAttributes(inputFile)
                        .getOctalMode();
            } catch (IOException ioe) {
                // ignore
            }
        }

        addFile(inputFile, destFileName, permissions);
    }

    @Override
    public void addSymlink(String symlinkName, String symlinkDestination) throws ArchiverException {
        final int fileMode = getOverrideFileMode();

        addSymlink(symlinkName, fileMode, symlinkDestination);
    }

    @Override
    public void addSymlink(String symlinkName, int permissions, String symlinkDestination) throws ArchiverException {
        doAddResource(
                ArchiveEntry.createSymlinkEntry(symlinkName, permissions, symlinkDestination, getDirectoryMode()));
    }

    private ArchiveEntry updateArchiveEntryAttributes(ArchiveEntry entry) {
        if (getOverrideUid() > -1
                || getOverrideGid() > -1
                || getOverrideUserName() != null
                || getOverrideGroupName() != null) {
            entry.setResourceAttributes(new SimpleResourceAttributes(
                    getOverrideUid(),
                    getOverrideUserName(),
                    getOverrideGid(),
                    getOverrideGroupName(),
                    entry.getMode()));
        }
        return entry;
    }

    protected ArchiveEntry asArchiveEntry(
            @Nonnull final PlexusIoResource resource,
            final String destFileName,
            int permissions,
            PlexusIoResourceCollection collection)
            throws ArchiverException {
        if (!resource.isExisting()) {
            throw new ArchiverException(resource.getName() + " not found.");
        }

        if (umask > 0 && permissions != PlexusIoResourceAttributes.UNKNOWN_OCTAL_MODE) {
            permissions &= ~umask;
        }

        ArchiveEntry entry;
        if (resource.isFile()) {
            entry = ArchiveEntry.createFileEntry(destFileName, resource, permissions, collection, getDirectoryMode());
        } else {
            entry = ArchiveEntry.createDirectoryEntry(destFileName, resource, permissions, getDirectoryMode());
        }

        return updateArchiveEntryAttributes(entry);
    }

    private ArchiveEntry asArchiveEntry(final AddedResourceCollection collection, final PlexusIoResource resource)
            throws ArchiverException {
        final String destFileName = collection.resources.getName(resource);

        int fromResource = PlexusIoResourceAttributes.UNKNOWN_OCTAL_MODE;
        if (resource instanceof ResourceAttributeSupplier) {
            final PlexusIoResourceAttributes attrs = ((ResourceAttributeSupplier) resource).getAttributes();

            if (attrs != null) {
                fromResource = attrs.getOctalMode();
            }
        }

        return asArchiveEntry(
                resource,
                destFileName,
                collection.maybeOverridden(fromResource, resource.isDirectory()),
                collection.resources);
    }

    @Override
    public void addResource(final PlexusIoResource resource, final String destFileName, final int permissions)
            throws ArchiverException {
        doAddResource(asArchiveEntry(resource, destFileName, permissions, null));
    }

    @Override
    public void addFile(@Nonnull final File inputFile, @Nonnull String destFileName, int permissions)
            throws ArchiverException {
        if (!inputFile.isFile() || !inputFile.exists()) {
            throw new ArchiverException(inputFile.getAbsolutePath() + " isn't a file.");
        }

        if (replacePathSlashesToJavaPaths) {
            destFileName = destFileName.replace('\\', '/');
        }

        if (permissions < 0) {
            permissions = getOverrideFileMode();
        }

        if (umask > 0 && permissions != PlexusIoResourceAttributes.UNKNOWN_OCTAL_MODE) {
            permissions &= ~umask;
        }

        try {
            // do a null check here, to avoid creating a file stream if there are no filters...
            ArchiveEntry entry = ArchiveEntry.createFileEntry(destFileName, inputFile, permissions, getDirectoryMode());
            doAddResource(updateArchiveEntryAttributes(entry));
        } catch (final IOException e) {
            throw new ArchiverException("Failed to determine inclusion status for: " + inputFile, e);
        }
    }

    @Nonnull
    @Override
    public ResourceIterator getResources() throws ArchiverException {
        return new ResourceIterator() {

            private final Iterator addedResourceIter = resources.iterator();

            private AddedResourceCollection currentResourceCollection;

            private Iterator ioResourceIter;

            private ArchiveEntry nextEntry;

            private final Set seenEntries = new HashSet<>();

            @Override
            public boolean hasNext() {
                do {
                    if (nextEntry == null) {
                        if (ioResourceIter == null) {
                            if (addedResourceIter.hasNext()) {
                                final Object o = addedResourceIter.next();
                                if (o instanceof ArchiveEntry) {
                                    nextEntry = (ArchiveEntry) o;
                                } else if (o instanceof AddedResourceCollection) {
                                    currentResourceCollection = (AddedResourceCollection) o;

                                    try {
                                        ioResourceIter = currentResourceCollection.resources.getResources();
                                    } catch (final IOException e) {
                                        throw new ArchiverException(e.getMessage(), e);
                                    }
                                } else {
                                    return throwIllegalResourceType(o);
                                }
                            } else {
                                nextEntry = null;
                            }
                        } else {
                            if (ioResourceIter.hasNext()) {
                                final PlexusIoResource resource = (PlexusIoResource) ioResourceIter.next();
                                nextEntry = asArchiveEntry(currentResourceCollection, resource);
                            } else {
                                // this will leak handles in the IO iterator if the iterator is not fully consumed.
                                // alternately we'd have to make this method return a Closeable iterator back
                                // to the client and ditch the whole issue onto the client.
                                // this does not really make any sense either, might equally well change the
                                // api into something that is not broken by design.
                                addCloseable(ioResourceIter);
                                ioResourceIter = null;
                            }
                        }
                    }

                    if (nextEntry != null && seenEntries.contains(normalizedForDuplicateCheck(nextEntry))) {
                        final String path = nextEntry.getName();

                        if (Archiver.DUPLICATES_PRESERVE.equals(duplicateBehavior)
                                || Archiver.DUPLICATES_SKIP.equals(duplicateBehavior)) {
                            if (nextEntry.getType() == ArchiveEntry.FILE) {
                                getLogger().debug(path + " already added, skipping");
                            }

                            nextEntry = null;
                        } else if (Archiver.DUPLICATES_FAIL.equals(duplicateBehavior)) {
                            throw new ArchiverException("Duplicate file " + path + " was found and the duplicate "
                                    + "attribute is 'fail'.");
                        } else {
                            // duplicate equal to add, so we continue
                            getLogger().debug("duplicate file " + path + " found, adding.");
                        }
                    }
                } while (nextEntry == null && !(ioResourceIter == null && !addedResourceIter.hasNext()));

                return nextEntry != null;
            }

            private boolean throwIllegalResourceType(Object o) {
                throw new IllegalStateException(
                        "An invalid resource of type: " + o.getClass().getName() + " was added to archiver: "
                                + getClass().getName());
            }

            @Override
            public ArchiveEntry next() {
                if (!hasNext()) {
                    throw new NoSuchElementException();
                }

                final ArchiveEntry next = nextEntry;
                nextEntry = null;

                seenEntries.add(normalizedForDuplicateCheck(next));

                return next;
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException("Does not support iterator");
            }

            private String normalizedForDuplicateCheck(ArchiveEntry entry) {
                return entry.getName().replace('\\', '/');
            }
        };
    }

    private static void closeIfCloseable(Object resource) throws IOException {
        if (resource == null) {
            return;
        }
        if (resource instanceof Closeable) {
            ((Closeable) resource).close();
        }
    }

    private static void closeQuietlyIfCloseable(Object resource) {
        try {
            closeIfCloseable(resource);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    @Override
    public Map getFiles() {
        try {
            final Map map = new HashMap<>();
            for (final ResourceIterator iter = getResources(); iter.hasNext(); ) {
                final ArchiveEntry entry = iter.next();
                if (includeEmptyDirs || entry.getType() == ArchiveEntry.FILE) {
                    map.put(entry.getName(), entry);
                }
            }
            return map;
        } catch (final ArchiverException e) {
            throw new UndeclaredThrowableException(e);
        }
    }

    @Override
    public File getDestFile() {
        return destFile;
    }

    @Override
    public void setDestFile(final File destFile) {
        this.destFile = destFile;

        if (destFile != null && destFile.getParentFile() != null) {
            destFile.getParentFile().mkdirs();
        }
    }

    protected PlexusIoResourceCollection asResourceCollection(final ArchivedFileSet fileSet, Charset charset)
            throws ArchiverException {
        final File archiveFile = fileSet.getArchive();

        final PlexusIoResourceCollection resources;
        try {
            resources = archiverManagerProvider.get().getResourceCollection(archiveFile);
        } catch (final NoSuchArchiverException e) {
            throw new ArchiverException(
                    "Error adding archived file-set. PlexusIoResourceCollection not found for: " + archiveFile, e);
        }

        if (resources instanceof EncodingSupported) {
            ((EncodingSupported) resources).setEncoding(charset);
        }

        if (resources instanceof PlexusIoArchivedResourceCollection) {
            ((PlexusIoArchivedResourceCollection) resources).setFile(fileSet.getArchive());
        } else {
            throw new ArchiverException("Expected " + PlexusIoArchivedResourceCollection.class.getName() + ", got "
                    + resources.getClass().getName());
        }

        if (resources instanceof AbstractPlexusIoResourceCollection) {
            ((AbstractPlexusIoResourceCollection) resources).setStreamTransformer(fileSet.getStreamTransformer());
        }
        final PlexusIoProxyResourceCollection proxy = new PlexusIoProxyResourceCollection(resources);

        proxy.setExcludes(fileSet.getExcludes());
        proxy.setIncludes(fileSet.getIncludes());
        proxy.setIncludingEmptyDirectories(fileSet.isIncludingEmptyDirectories());
        proxy.setCaseSensitive(fileSet.isCaseSensitive());
        proxy.setPrefix(fileSet.getPrefix());
        proxy.setUsingDefaultExcludes(fileSet.isUsingDefaultExcludes());
        proxy.setFileSelectors(fileSet.getFileSelectors());
        proxy.setStreamTransformer(fileSet.getStreamTransformer());
        proxy.setFileMappers(fileSet.getFileMappers());

        if (getOverrideDirectoryMode() > -1 || getOverrideFileMode() > -1) {
            proxy.setOverrideAttributes(-1, null, -1, null, getOverrideFileMode(), getOverrideDirectoryMode());
        }

        if (getDefaultDirectoryMode() > -1 || getDefaultFileMode() > -1) {
            proxy.setDefaultAttributes(-1, null, -1, null, getDefaultFileMode(), getDefaultDirectoryMode());
        }

        return proxy;
    }

    /**
     * Adds a resource collection to the archive.
     */
    @Override
    public void addResources(final PlexusIoResourceCollection collection) throws ArchiverException {
        doAddResource(new AddedResourceCollection(collection, forcedFileMode, forcedDirectoryMode));
    }

    private void doAddResource(Object item) {
        resources.add(item);
    }

    @Override
    public void addArchivedFileSet(final ArchivedFileSet fileSet) throws ArchiverException {
        final PlexusIoResourceCollection resourceCollection = asResourceCollection(fileSet, null);
        addResources(resourceCollection);
    }

    @Override
    public void addArchivedFileSet(final ArchivedFileSet fileSet, Charset charset) throws ArchiverException {
        final PlexusIoResourceCollection resourceCollection = asResourceCollection(fileSet, charset);
        addResources(resourceCollection);
    }

    /**
     * @since 1.0-alpha-7
     */
    @Override
    public void addArchivedFileSet(
            @Nonnull final File archiveFile, final String prefix, final String[] includes, final String[] excludes)
            throws ArchiverException {
        addArchivedFileSet(archivedFileSet(archiveFile)
                .prefixed(prefix)
                .includeExclude(includes, excludes)
                .includeEmptyDirs(includeEmptyDirs));
    }

    /**
     * @since 1.0-alpha-7
     */
    @Override
    public void addArchivedFileSet(@Nonnull final File archiveFile, final String prefix) throws ArchiverException {
        addArchivedFileSet(archivedFileSet(archiveFile).prefixed(prefix).includeEmptyDirs(includeEmptyDirs));
    }

    /**
     * @since 1.0-alpha-7
     */
    @Override
    public void addArchivedFileSet(@Nonnull final File archiveFile, final String[] includes, final String[] excludes)
            throws ArchiverException {
        addArchivedFileSet(
                archivedFileSet(archiveFile).includeExclude(includes, excludes).includeEmptyDirs(includeEmptyDirs));
    }

    /**
     * @since 1.0-alpha-7
     */
    @Override
    public void addArchivedFileSet(@Nonnull final File archiveFile) throws ArchiverException {
        addArchivedFileSet(archivedFileSet(archiveFile).includeEmptyDirs(includeEmptyDirs));
    }

    @Override
    public boolean isForced() {
        return forced;
    }

    @Override
    public void setForced(final boolean forced) {
        this.forced = forced;
    }

    @Override
    public void addArchiveFinalizer(final ArchiveFinalizer finalizer) {
        if (finalizers == null) {
            finalizers = new ArrayList<>();
        }

        finalizers.add(finalizer);
    }

    @Override
    public void setArchiveFinalizers(final List archiveFinalizers) {
        finalizers = archiveFinalizers;
    }

    @Override
    public void setDotFileDirectory(final File dotFileDirectory) {
        this.dotFileDirectory = dotFileDirectory;
    }

    protected boolean isUptodate() throws ArchiverException {
        final File zipFile = getDestFile();
        if (!zipFile.exists()) {
            getLogger().debug("isUp2date: false (Destination " + zipFile.getPath() + " not found.)");
            return false; // File doesn't yet exist
        }
        final long destTimestamp = getFileLastModifiedTime(zipFile);

        final Iterator it = resources.iterator();
        if (!it.hasNext()) {
            getLogger().debug("isUp2date: false (No input files.)");
            return false; // No timestamp to compare
        }

        while (it.hasNext()) {
            final Object o = it.next();
            final long l;
            if (o instanceof ArchiveEntry) {
                l = ((ArchiveEntry) o).getResource().getLastModified();
            } else if (o instanceof AddedResourceCollection) {
                try {
                    l = ((AddedResourceCollection) o).resources.getLastModified();
                } catch (final IOException e) {
                    throw new ArchiverException(e.getMessage(), e);
                }
            } else {
                throw new IllegalStateException(
                        "Invalid object type: " + o.getClass().getName());
            }
            if (l == PlexusIoResource.UNKNOWN_MODIFICATION_DATE) {
                // Don't know what to do. Safe thing is to assume not up2date.
                getLogger().debug("isUp2date: false (Resource with unknown modification date found.)");
                return false;
            }
            if (l > destTimestamp) {
                getLogger().debug("isUp2date: false (Resource with newer modification date found.)");
                return false;
            }
        }

        getLogger().debug("isUp2date: true");
        return true;
    }

    /**
     * Returns the last modified time in milliseconds of a file.
     * It avoids the bug where milliseconds precision is lost on File#lastModified (JDK-8177809) on JDK8 and Linux.
     * @param file The file where the last modified time will be returned for.
     * @return The last modified time in milliseconds of the file.
     * @throws ArchiverException In the case of an IOException, for example when the file does not exists.
     */
    private long getFileLastModifiedTime(File file) throws ArchiverException {
        try {
            return Files.getLastModifiedTime(file.toPath()).toMillis();
        } catch (IOException e) {
            throw new ArchiverException(e.getMessage(), e);
        }
    }

    protected boolean checkForced() throws ArchiverException {
        if (!isForced() && isSupportingForced() && isUptodate()) {
            getLogger().debug("Archive " + getDestFile() + " is uptodate.");
            return false;
        }
        return true;
    }

    @Override
    public boolean isSupportingForced() {
        return false;
    }

    protected void runArchiveFinalizers() throws ArchiverException {
        if (finalizers != null) {
            for (final ArchiveFinalizer finalizer : finalizers) {
                finalizer.finalizeArchiveCreation(this);
            }
        }
    }

    @Override
    public final void createArchive() throws ArchiverException, IOException {
        validate();
        try {
            try {
                if (dotFileDirectory != null) {
                    addArchiveFinalizer(new DotDirectiveArchiveFinalizer(dotFileDirectory));
                }

                runArchiveFinalizers();

                execute();
            } finally {
                close();
            }
        } catch (final IOException e) {
            String msg = "Problem creating " + getArchiveType() + ": " + e.getMessage();

            final StringBuffer revertBuffer = new StringBuffer();
            if (!revert(revertBuffer)) {
                msg += revertBuffer.toString();
            }

            throw new ArchiverException(msg, e);
        } finally {
            cleanUp();
        }

        postCreateArchive();
    }

    protected boolean hasVirtualFiles() {
        if (finalizers != null) {
            for (final ArchiveFinalizer finalizer : finalizers) {
                final List virtualFiles = finalizer.getVirtualFiles();

                if ((virtualFiles != null) && !virtualFiles.isEmpty()) {
                    return true;
                }
            }
        }
        return false;
    }

    protected boolean revert(final StringBuffer messageBuffer) {
        return true;
    }

    protected void validate() throws ArchiverException, IOException {}

    /**
     * This method is called after the archive creation
     * completes successfully (no exceptions are thrown).
     *
     * Subclasses may override this method in order to
     * augment or validate the archive after it is
     * created.
     *
     * @since 3.6
     */
    protected void postCreateArchive() throws ArchiverException, IOException {}

    protected abstract String getArchiveType();

    private void addCloseable(Object maybeCloseable) {
        if (maybeCloseable instanceof Closeable) {
            closeables.add((Closeable) maybeCloseable);
        }
    }

    private void closeIterators() {
        for (Closeable closeable : closeables) {
            closeQuietlyIfCloseable(closeable);
        }
    }

    protected abstract void close() throws IOException;

    protected void cleanUp() throws IOException {
        closeIterators();

        for (Object resource : resources) {
            if (resource instanceof PlexusIoProxyResourceCollection) {
                resource = ((PlexusIoProxyResourceCollection) resource).getSrc();
            }

            closeIfCloseable(resource);
        }
        resources.clear();
    }

    protected abstract void execute() throws ArchiverException, IOException;

    /**
     * @since 1.1
     */
    @Override
    public boolean isUseJvmChmod() {
        return useJvmChmod;
    }

    /**
     * @since 1.1
     */
    @Override
    public void setUseJvmChmod(final boolean useJvmChmod) {
        this.useJvmChmod = useJvmChmod;
    }

    /**
     * @since 1.1
     */
    @Override
    public boolean isIgnorePermissions() {
        return ignorePermissions;
    }

    /**
     * @since 1.1
     */
    @Override
    public void setIgnorePermissions(final boolean ignorePermissions) {
        this.ignorePermissions = ignorePermissions;
    }

    /**
     * @deprecated Use {@link #setLastModifiedTime(FileTime)} instead.
     */
    @Override
    @Deprecated
    public void setLastModifiedDate(Date lastModifiedDate) {
        this.lastModifiedTime = lastModifiedDate != null ? FileTime.fromMillis(lastModifiedDate.getTime()) : null;
    }

    /**
     * @deprecated Use {@link #getLastModifiedTime()} instead.
     */
    @Override
    @Deprecated
    public Date getLastModifiedDate() {
        return lastModifiedTime != null ? new Date(lastModifiedTime.toMillis()) : null;
    }

    @Override
    public void setLastModifiedTime(FileTime lastModifiedTime) {
        this.lastModifiedTime = lastModifiedTime;
    }

    @Override
    public FileTime getLastModifiedTime() {
        return lastModifiedTime;
    }

    @Override
    public void setFilenameComparator(Comparator filenameComparator) {
        this.filenameComparator = filenameComparator;
    }

    public Comparator getFilenameComparator() {
        return filenameComparator;
    }

    @Override
    public void setOverrideUid(int uid) {
        overrideUid = uid;
    }

    @Override
    public void setOverrideUserName(String userName) {
        overrideUserName = userName;
    }

    @Override
    public int getOverrideUid() {
        return overrideUid;
    }

    @Override
    public String getOverrideUserName() {
        return overrideUserName;
    }

    @Override
    public void setOverrideGid(int gid) {
        overrideGid = gid;
    }

    @Override
    public void setOverrideGroupName(String groupName) {
        overrideGroupName = groupName;
    }

    @Override
    public int getOverrideGid() {
        return overrideGid;
    }

    @Override
    public String getOverrideGroupName() {
        return overrideGroupName;
    }

    @Override
    public void setUmask(int umask) {
        this.umask = umask;
    }

    @Override
    public int getUmask() {
        return umask;
    }

    /**
     * @deprecated Use {@link #configureReproducibleBuild(FileTime)} instead.
     */
    @Override
    @Deprecated
    public void configureReproducible(Date lastModifiedDate) {
        configureReproducibleBuild(FileTime.fromMillis(lastModifiedDate.getTime()));
    }

    @Override
    public void configureReproducibleBuild(FileTime lastModifiedTime) {
        // 1. force last modified date
        setLastModifiedTime(normalizeLastModifiedTime(lastModifiedTime));

        // 2. sort filenames in each directory when scanning filesystem
        setFilenameComparator(String::compareTo);

        // 3. ignore uid/gid from filesystem (for tar)
        setOverrideUid(0);
        setOverrideUserName("root"); // is it possible to avoid this, like "tar --numeric-owner"?
        setOverrideGid(0);
        setOverrideGroupName("root");

        // 4. set umask to 022 to avoid environment umask value particularly on group write
        setUmask(0_022);
    }

    /**
     * Normalize last modified time value to get reproducible archive entries, based on
     * archive binary format.
     *
     * 
tar uses UTC timestamp, but zip uses local time then requires
     * tweaks to make the value reproducible whatever the current timezone is.
     *
     * @param lastModifiedTime The last modification time
     * @return The normalized last modification time
     *
     * @see #configureReproducibleBuild(FileTime)
     */
    protected FileTime normalizeLastModifiedTime(FileTime lastModifiedTime) {
        return lastModifiedTime;
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy