com.github.jscancella.verify.internal.AbstractPayloadFileExistsInManifestsVistor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bagging Show documentation

This is a software library intended to support the creation, manipulation, and validation of "bags" from the bagit specification. It currently supports version 0.93 through 1.0.

There is a newer version: 5.2

Show newest version

package com.github.jscancella.verify.internal;

import java.io.IOException;
import java.nio.file.FileVisitResult;
import java.nio.file.Path;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ResourceBundle;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.github.jscancella.internal.PathUtils;

/**
 * Implements {@link SimpleFileVisitor} to ensure that the encountered file is in one of the manifests.
 */
@SuppressWarnings({"PMD.BeanMembersShouldSerialize"})
abstract public class AbstractPayloadFileExistsInManifestsVistor extends SimpleFileVisitor {
  private static final Logger logger = LoggerFactory.getLogger(AbstractPayloadFileExistsInManifestsVistor.class);
  private static final ResourceBundle messages = ResourceBundle.getBundle("MessageBundle");
  /**
   * Should hidden files be ignored
   */
  protected final boolean ignoreHiddenFiles;

  /**
   * constructor must be called before using!
   *
   * @param ignoreHiddenFiles Should hidden files be ignored
   */
  public AbstractPayloadFileExistsInManifestsVistor(final boolean ignoreHiddenFiles) {
    super();
    this.ignoreHiddenFiles = ignoreHiddenFiles;
  }

  @Override
  public FileVisitResult preVisitDirectory(final Path dir, final BasicFileAttributes attrs) throws IOException {
    FileVisitResult result = FileVisitResult.CONTINUE;

    if(ignoreHiddenFiles && PathUtils.isHidden(dir)){
      logger.debug(messages.getString("skipping_hidden_file"), dir);
      result = FileVisitResult.SKIP_SUBTREE;
    }

    return result;
  }

  /**
   * Returns true if the path exists in the provided set of manifest paths, false otherwise.
   * @param path The file path.
   * @param manifestPaths The manifest paths.
   * @return true if the path exists, false otherwise.
   */
  protected static boolean inManifest(final Path path, final Set manifestPaths) {
    final String normalizedPath = ManifestVerifier.toNormalizedString(path);
    return manifestPaths.stream().anyMatch(
        (mp) -> ManifestVerifier.toNormalizedString(mp).equals(normalizedPath)
    );
  }
}