com.nawforce.runtime.platform.Path.scala Maven / Gradle / Ivy

Go to download
/*
 Copyright (c) 2019 Kevin Jones, All rights reserved.
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.
 */
package com.nawforce.runtime.platform

import com.nawforce.pkgforce.path._
import com.nawforce.runtime.parsers.SourceData

import java.io.File
import java.nio.charset.StandardCharsets
import java.nio.file.{DirectoryStream, Files}
import scala.collection.mutable

final class Path(val native: java.nio.file.Path) extends PathLike {

  override def basename: String = {
    val filename = native.getFileName
    if (filename == null) "" else filename.toString
  }
  override def parent: Path         = join("..")
  override def exists: Boolean      = Files.exists(native)
  override def isRoot: Boolean      = this.toString == parent.toString
  override def isDirectory: Boolean = Files.isDirectory(native)
  override def isFile: Boolean      = Files.isRegularFile(native)
  override def size: Long           = if (isFile) Files.size(native) else 0

  override def join(args: String*): Path = {
    new Path(native.resolve(args.mkString(Path.separator)).normalize())
  }

  override def createFile(name: String, data: String): Either[String, Path] = {
    val created = join(name)
    created.write(data) match {
      case None      => Right(created)
      case Some(err) => Left(err)
    }
  }

  override def read(): Either[String, String] = {
    readBytes().map(new String(_, StandardCharsets.UTF_8))
  }

  override def readBytes(): Either[String, Array[Byte]] = {
    try {
      Right(Files.readAllBytes(native))
    } catch {
      case ex: java.io.IOException => Left(ex.toString)
    }
  }

  override def readSourceData(): Either[String, SourceData] = {
    readBytes().map(SourceData(_))
  }

  override def write(data: String): Option[String] = {
    write(data.getBytes(StandardCharsets.UTF_8))
  }

  override def write(data: Array[Byte]): Option[String] = {
    try {
      Files.write(native, data)
      None
    } catch {
      case ex: java.io.IOException => Some(ex.toString)
    }
  }

  override def delete(): Option[String] = {
    try {
      Files.delete(native)
      None
    } catch {
      case ex: java.io.IOException => Some(ex.toString)
    }
  }

  override def createDirectory(name: String): Either[String, PathLike] = {
    val dir: Path = join(name)
    if (!Files.exists(dir.native)) {
      try {
        Files.createDirectory(dir.native)
        Right(new Path(dir.native))
      } catch {
        case ex: java.io.IOException => Left(ex.toString)
      }
    } else if (dir.isDirectory) {
      Right(dir)
    } else {
      Left(s"Can not create directory '$dir', file already exists")
    }
  }

  override def directoryList(): Either[String, Seq[String]] = {
    if (isDirectory) {
      var files: List[String] = Nil
      val paths               = Files.newDirectoryStream(native)
      try {
        paths.forEach(file => {
          files = file.getFileName.toString :: files
        })
      } finally {
        paths.close()
      }
      Right(files)
    } else {
      Left(s"Path '$native' is not a directory'")
    }
  }

  override def splitDirectoryEntries(): (Array[PathLike], Array[PathLike]) = {
    val files       = mutable.ArrayBuffer[PathLike]()
    val directories = mutable.ArrayBuffer[PathLike]()

    var paths: DirectoryStream[java.nio.file.Path] = null
    try {
      paths = Files.newDirectoryStream(native)
      paths.forEach(path => {
        val pathLike = new Path(path)
        if (pathLike.isFile)
          files.append(pathLike)
        else if (pathLike.isDirectory)
          directories.append(pathLike)
      })
      (files.toArray, directories.toArray)
    } finally {
      if (paths != null) paths.close()
    }
  }

  override def lastModified(): Option[Long] = {
    try {
      Some(native.toFile.lastModified())
    } catch {
      case _: SecurityException             => None
      case _: UnsupportedOperationException => None
    }
  }

  /** As we are using an in-memory FS for testing we need to compare string-wise */
  override def equals(that: Any): Boolean = {
    that match {
      case other: Path =>
        other.canEqual(this) && other.toString == toString
      case _ => false
    }
  }

  def canEqual(that: Any): Boolean = that.isInstanceOf[Path]

  override def hashCode(): Int = toString.hashCode

  override def toString: String = {
    native.toString
  }
}

object Path {
  val separator: String = File.separator

  def apply(path: String): Path = {
    new Path(java.nio.file.Paths.get(path).toAbsolutePath.normalize())
  }

  def unapply(path: Path): Option[String] = {
    Some(path.toString)
  }

  def safeApply(path: String): Path = {
    apply(Option(path).getOrElse(""))
  }

  def apply(path: PathLike): Path = {
    path match {
      case p: Path => p
      case _       => Path(path.toString)
    }
  }
}