package com.atlassian.core.util.zip;
   
   import javax.annotation.Nonnull;
   import java.io.File;
   import java.io.IOException;
   
   /**
    * This class is able to append directory recursively to the archive related to provided
    * {@link com.atlassian.core.util.zip.FileArchiver}
   *
   * @since v6.4
   */
  public class FolderAppender
  {
      private final FileArchiver fileArchiver;
      private final File archiveFile;
      private final File rootFolderToCompress;
      private final ArchiveParams archiveParams;
  
      /**
       *
       * @param fileArchiver the {@link com.atlassian.core.util.zip.FileArchiver}
       * @param rootFolderToCompress handle to directory which will be appended to archive with all subdirectories recursively
       * @param targetRootArchivePath the path used as target directory within archive, so all files and directories inside
       * archive will start with this path
       * @param archiveFile handle to result archive file, needed to avoid compressing himself
       */
      public FolderAppender(final FileArchiver fileArchiver, final File rootFolderToCompress, final String targetRootArchivePath,
              final File archiveFile)
      {
          this.fileArchiver = fileArchiver;
          this.rootFolderToCompress = rootFolderToCompress;
          this.archiveParams = ArchiveParams.builder().withArchiveFolderName(targetRootArchivePath).build();
          this.archiveFile = archiveFile;
      }
  
      /**
       * @param fileArchiver          the {@link com.atlassian.core.util.zip.FileArchiver}
       * @param rootFolderToCompress  handle to directory which will be appended to archive with all subdirectories
       *                              recursively
       * @param archiveParams         parameters for the files in the folder to be added the to archive
       */
      public FolderAppender(final FileArchiver fileArchiver, final File rootFolderToCompress, final ArchiveParams archiveParams,
                            final File archiveFile)
      {
          this.fileArchiver = fileArchiver;
          this.rootFolderToCompress = rootFolderToCompress;
          this.archiveParams = archiveParams;
          this.archiveFile = archiveFile;
      }
  
      /**
       * Appends file or directory based on parameters used to construct the {@link com.atlassian.core.util.zip.FolderAppender}
       * object.
       * @throws IOException
       */
      public void append() throws IOException
      {
          append(rootFolderToCompress);
      }
  
      private void append(final File file) throws IOException
      {
          if ((file != null) && file.exists() && (archiveParams.isIncludeHiddenFiles() || !file.isHidden()))
          {
              if (file.isFile())
              {
                  appendFile(file);
              }
              else if (file.isDirectory())
              {
                  appendFolder(file);
              }
          }
      }
  
      private void appendFolder(@Nonnull final File file) throws IOException
      {
          fileArchiver.addDirectoryToArchive(file, getPathInsideArchive(file), archiveParams.getArchiveFolderName());
          final File[] files = file.listFiles();
          if (files != null)
          {
              for (final File f : files)
              {
                  append(f);
              }
          }
      }
  
      private void appendFile(@Nonnull final File file) throws IOException
      {
          if (file.isFile() && !file.equals(archiveFile))
          {
              fileArchiver.addToArchive(file, getPathInsideArchive(file), archiveParams.getArchiveFolderName());
          }
      }
  
  
      /**
      * Builds a file path for an entry inside of the archive
      *
      * @param file file to add to archive
      * @return related path inside of the archive
      */
     private String getPathInsideArchive(@Nonnull final File file)
     {
         return file.getPath().substring(rootFolderToCompress.getPath().length());
     }
 }