commonMain.debian.Dpkg.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kommandline Show documentation
Kotlin DSL for popular CLI commands.
The newest version!
@file:Suppress("unused")

package pl.mareklangiewicz.kommand.debian

import pl.mareklangiewicz.annotations.DelicateApi
import pl.mareklangiewicz.kommand.*
import pl.mareklangiewicz.udata.strf

/**
 * @return null means command was not found at all,
 *  an empty list means dpkg haven't found any package containing command path
 */
@OptIn(DelicateApi::class)
fun searchCommand(command: String): ReducedScript?> = ReducedScript {
  val first = whichFirstOrNull(command).ax() ?: return@ReducedScript null
  dpkg(DpkgAct.Search(first.strf)).ax()
}

/** There has to be exactly one action in each invocation */
@DelicateApi
fun dpkg(act: DpkgAct, init: Dpkg.() -> Unit = {}) = dpkg { init(); -act }

/** There has to be exactly one option: action (DpkgAct) in each invocation */
@DelicateApi
fun dpkg(init: Dpkg.() -> Unit = {}) = Dpkg().apply(init)


/** [linux man](https://man7.org/linux/man-pages/man1/dpkg.1.html) */
@DelicateApi
data class Dpkg(
  val opts: MutableList = mutableListOf(),
) : Kommand {
  override val name get() = "dpkg"
  override val args get() = opts.flatMap { it.toArgs() }
  operator fun DpkgOpt.unaryMinus() = opts.add(this)
}

@DelicateApi
interface DpkgAct : DpkgOpt {

  // region [GNU Common Opts]
  // https://www.gnu.org/software/coreutils/manual/html_node/Common-options.html
  data object Help : KOptLN(), DpkgAct // Don't risk short -h (ambiguity: sudo -h host; ls -h (human-readable), etc.)
  data object Version : KOptLN(), DpkgAct // Don't risk short -v (ambiguity with "verbose" for many commands)
  // endregion [GNU Common Opts]

  /**
   * Install the package.
   * @param debFileOrDir Single .deb file, or directory when the [Recursive] option enabled
   */
  data class Install(val debFileOrDir: String) : KOptS("i", debFileOrDir), DpkgAct

  /**
   * Unpack the package, but don't configure it.
   * @param debFileOrDir Single .deb file, or directory when the [Recursive] option enabled.
   */
  data class Unpack(val debFileOrDir: String) : KOptLN(debFileOrDir), DpkgAct

  /**
   * Configure a package which has been unpacked but not yet configured.
   * @param pkgName Single package, or null if Pending option enabled.
   */
  data class Configure(val pkgName: String? = null) : KOptLN(pkgName, nameSeparator = " "), DpkgAct

  /**
   * Remove an installed package.
   * @param pkgName Single package, or null if Pending option enabled.
   */
  data class Remove(val pkgName: String? = null) : KOptS("r", pkgName), DpkgAct

  /**
   * Purge an installed or already removed package.
   * @param pkgName Single package, or null if Pending option enabled.
   */
  data class Purge(val pkgName: String? = null) : KOptS("P", pkgName), DpkgAct

  /**
   * Verifies the integrity of package-name or all packages if omitted.
   * @param pkgName Single package, or null to verify all packages.
   */
  data class Verify(val pkgName: String? = null) : KOptS("V", pkgName), DpkgAct

  data object PrintArchitecture : KOptLN(), DpkgAct
  data class ListPackages(val pkgNamePattern: String) : KOptS("l", pkgNamePattern), DpkgAct
  data class ListFiles(val pkgName: String) : KOptS("L", pkgName), DpkgAct
  data class Status(val pkgName: String) : KOptS("l", pkgName), DpkgAct

  /**
   * Display details about package-name, as found in /var/lib/dpkg/available.
   * Users of APT-based frontends should use apt show package-name instead.
   */
  data class Details(val pkgName: String) : KOptS("p", pkgName), DpkgAct
  data class Search(val fileSearchPattern: String) : KOptS("S", fileSearchPattern), DpkgAct
}

@DelicateApi
interface DpkgOpt : KOpt {
  data object Recursive : KOptLN(), DpkgOpt // Don't risk short -r or -R (better to be explicit about RECURSIVE)
  data object Pending : KOptLN(), DpkgOpt
  data object DryRun : KOptLN(), DpkgOpt
  data object RefuseDowngrade : KOptLN(), DpkgOpt
  data object SkipSameVersion : KOptLN(), DpkgOpt
  /** Use a machine-readable output format. */
  data object Robot : KOptLN(), DpkgOpt
  data object NoPager : KOptLN(), DpkgOpt
}