container.Extractor.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of container_3 Show documentation
container
There is a newer version: 1.31
/*
 * Copyright (C) 2016 Vincent Hage
 * Copyright (C) 2019 Romain Reuillon
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package container

import better.files._
import java.io.IOException
import container.Status._
import scala.sys.process._
import container.ImageBuilder._
import org.apache.commons.compress.archivers.tar.{ TarArchiveEntry, TarArchiveOutputStream }

object Extractor {

  /**
   * Split a filepath into a path and a filename
   */
  def getPathAndFileName(filepath: String) = {
    val files = filepath.split('/')
    val filename = files(files.length - 1)
    val path = filepath.substring(0, filepath.length - filename.length)
    (path, filename)
  }

  /**
   * Detect whether a file is an archive or not
   * using its extension (quick and dirty way, yes).
   */
  def isAnArchive(filename: String) = {
    if (filename.endsWith(".tar") ||
      filename.endsWith(".gz") ||
      filename.endsWith(".tgz") ||
      filename.endsWith(".zip") ||
      filename.endsWith(".bz2") ||
      filename.endsWith(".xz") ||
      filename.endsWith(".7z") ||
      filename.endsWith(".rar"))
      true
    else
      false
  }

  /**
   * Create a directory path corresponding to an archive
   * by removing the extension from the archive name
   * and keeping the same path dsd.
   *
   * This function can be modified later to for example include
   * a random id in the directory name, if you want to make it
   * unique.
   */
  def getDirectoryPath(path: String, fileName: String) = {
    val directoryPath = if (path.isEmpty) "./" else path
    val directoryName = fileName.split('.')(0)
    directoryPath + directoryName
  }

  /**
   * Make sure that the path ends with '/'
   */
  def completeDirectoryPath(path: String) = {
    if (path.endsWith("/")) path
    else path + "/"
  }

  def createDirectory(directoryPath: String): Status = {
    val directory = File(directoryPath)
    if (directory.exists && !directory.isDirectory)
      return DIRECTORY_FILE_COLLISION.withArgument(directoryPath)

    try {
      directory.createDirectory()
      return OK
    } catch {
      case se: SecurityException => return SECURITY_ERROR.withArgument(se)
      case ioe: IOException => return IO_ERROR.withArgument(ioe)
      case e: Exception => return UNKNOWN_ERROR.withArgument(e)
    }
  }

  def executeCommand(cmd: String): (Int, String, String) = {
    val stdout = new StringBuilder
    val stderr = new StringBuilder
    val status = cmd ! ProcessLogger(stdout append _, stderr append _)
    if (status != 0) throw CommandExecutionError(status, stdout.toString(), stderr.toString())
    (status, stdout.toString(), stderr.toString())
  }

  def extractLines(file: File) = {
    val test = file.contentAsString
    val source = scala.io.Source.fromFile(file.pathAsString)
    val lines = try source.mkString finally source.close()
    //lines

    test
  }

}