gitbucket.core.util.FileUtil.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitbucket_2.13 Show documentation
gitbucket
The newest version!
package gitbucket.core.util

import org.apache.commons.io.FileUtils
import org.apache.tika.Tika
import java.io.File
import scala.util.Random

object FileUtil {

  def getMimeType(name: String): String = {
    val tika = new Tika()
    tika.detect(name) match {
      case null     => "application/octet-stream"
      case mimeType => mimeType
    }
  }

  def getMimeType(name: String, bytes: Array[Byte]): String = {
    val mimeType = getMimeType(name)
    if (mimeType == "application/octet-stream" && isText(bytes)) {
      "text/plain"
    } else {
      mimeType
    }
  }

  def getSafeMimeType(name: String, safeMode: Boolean = true): String = {
    val mimeType = getMimeType(name)
      .replace("text/html", "text/plain")

    if (safeMode) {
      mimeType.replace("image/svg+xml", "text/plain; charset=UTF-8")
    } else {
      mimeType
    }
  }

  def isImage(name: String, safeMode: Boolean = true): Boolean = getSafeMimeType(name, safeMode).startsWith("image/")

  def isLarge(size: Long): Boolean = (size > 1024 * 1000)

  def isText(content: Array[Byte]): Boolean = !content.contains(0)

  def generateFileId: String = s"${System.currentTimeMillis}${Random.alphanumeric.take(10).mkString}"

  def getExtension(name: String): String =
    name.lastIndexOf('.') match {
      case i if (i >= 0) => name.substring(i + 1)
      case _             => ""
    }

  def withTmpDir[A](dir: File)(action: File => A): A = {
    if (dir.exists()) {
      FileUtils.deleteDirectory(dir)
    }
    try {
      action(dir)
    } finally {
      FileUtils.deleteDirectory(dir)
    }
  }

  def getLfsFilePath(owner: String, repository: String, oid: String): String =
    s"${Directory.getLfsDir(owner, repository)}/${checkFilename(oid)}"

  def readableSize(size: Long): String = FileUtils.byteCountToDisplaySize(size)

  /**
   * Delete the given directory if it's empty.
   * Do nothing if the given File is not a directory or not empty.
   */
  def deleteDirectoryIfEmpty(dir: File): Unit = {
    if (dir.isDirectory() && dir.list().isEmpty) {
      FileUtils.deleteDirectory(dir)
    }
  }

  /**
   * Delete file or directory forcibly.
   */
  def deleteIfExists(file: java.io.File): java.io.File = {
    if (file.exists) {
      FileUtils.forceDelete(file)
    }
    file
  }

  /**
   * Create an instance of java.io.File safely.
   */
  def checkFilename(name: String): String = {
    if (name.contains("..")) {
      throw new IllegalArgumentException(s"Invalid file name: ${name}")
    }
    name
  }

  /**
   * Delete given folder recursively.
   */
  def deleteRecursively(f: File): Boolean = {
    if (f.isDirectory) f.listFiles match {
      case files: Array[File] => files.foreach(deleteRecursively)
      case null               =>
    }
    f.delete()
  }
}