blended.updater.config.ProfileLookup.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blended.updater.config Show documentation

Configurations for Updater and Launcher

There is a newer version: 2.5.0-M10

Show newest version

package blended.updater.config

import java.io.File

import scala.collection.JavaConverters._
import scala.util.Try

import com.typesafe.config.Config
import com.typesafe.config.ConfigFactory

/**
 * Information used by the Blended Launcher and Blended Updater to determine or persist
 * the currently selected and active profile configuration.
 *
 * @param profileName The name of the profile.
 * @param profileVersion The version of the profile.
 * @param profileBaseDir The directory, where the files of the profile will be looked up.
 *   The determine the concrete profile directory, use [[ProfileLookup#materializedDir]]
 * @param overlays The active applied overlays for this profile.
 *
 * @see [[blended.launcher.Launcher]]
 * @see [[blended.updater.Updater]]
 */
case class ProfileLookup(
    profileName: String,
    profileVersion: String,
    profileBaseDir: File,
    overlays: Seq[OverlayRef]) {

  override def toString(): String = s"${getClass.getSimpleName}(profileName=${profileName}, profileVersion=${profileVersion},profileBaseDir=${profileBaseDir},overlays=${overlays.mkString("[", ",", "]")})"

  /**
   * The directory where the profile including it's overlays is installed.
   * It is always a sub directory of the `profileBaseDir`.
   *
   * @see [[OverlayConfig#materializedDir]]
   */
  def materializedDir: File = {
    val pureProfileDir = new File(profileBaseDir, s"${profileName}/${profileVersion}")
    // LocalOverlays.materializedDir(overlays, pureProfileDir)
    pureProfileDir
  }

}

object ProfileLookup {

  /**
   * Try to read a [[ProfileLookup]] from a [[Config]].
   */
  def read(config: Config): Try[ProfileLookup] = Try {
    val profileName = config.getString("profile.name")
    val profileVersion = config.getString("profile.version")
    val profileBaseDir = new File(config.getString("profile.baseDir"))
    val overlays =
      if (config.hasPath("profile.overlays"))
        config.getStringList("profile.overlays").asScala.map { o =>
          o.split("[:]", 2) match {
            case Array(n, v) => OverlayRef(n, v)
            case invalid => sys.error("Invalid overlay id: " + invalid)
          }
        }
      else Nil

    ProfileLookup(
      profileName = profileName,
      profileVersion = profileVersion,
      profileBaseDir = profileBaseDir,
      overlays = overlays
    )
  }

  /**
   * Create a [[Config]] from a [[ProfileLookup]].
   */
  def toConfig(profileLookup: ProfileLookup): Config = {
    val config = Map(
      "profile.name" -> profileLookup.profileName,
      "profile.version" -> profileLookup.profileVersion,
      "profile.baseDir" -> profileLookup.profileBaseDir.getPath(),
      "profile.overlays" -> profileLookup.overlays.map(o => s"${o.name}:${o.version}").asJava
    ).asJava

    ConfigFactory.parseMap(config)
  }
}