00_core.sh

#!/usr/bin/env sh

# Purpose: Provide some basic functions
# Author : Anh K. Huynh
# License: Fair license (http://www.opensource.org/licenses/fair)
# Source : http://github.com/icy/pacapt/

# Copyright (C) 2010 - 2021 Anh K. Huynh
#
# Usage of the works is permitted provided that this instrument is
# retained with the works, so that any entity that uses the works is
# notified of this instrument.
#
# DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.

_error() {
  echo >&2 ":: Error: $*"
  return 1
}

_warn() {
  echo >&2 ":: Warning: $*"
  return 0
}

_die() {
  echo >&2 ":: $*"
  exit 1
}

_debug() {
  if [ -n "${PACAPT_DEBUG:-}" ]; then
    >&2 echo ":: [debug] $*"
  fi
}

_not_implemented() {
  # shellcheck disable=2153
  echo >&2 "${_PACMAN}: '${_POPT}:${_SOPT}:${_TOPT}' operation is invalid or not implemented."
  return 1
}

_removing_is_dangerous() {
  echo >&2 "${_PACMAN}: removing with '$*' is too dangerous"
  return 1
}

_require_programs() {
  for cmd in "$@"; do
    if ! command -v "$cmd" >/dev/null; then
      _die "pacapt(${_PACMAN:-_init}) requires '$cmd' but the tool is not found."
    fi
  done
}

# Detect package type from /etc/issue
# FIXME: Using new `issue` file (location)
_issue2pacman() {
  local_pacman="$1"; shift

  # The following line is added by Daniel YC Lin to support SunOS.
  #
  #   [ `uname` = "$1" ] && _PACMAN="$_pacman" && return
  #
  # This is quite tricky and fast, however I don't think it works
  # on Linux/BSD systems. To avoid extra check, I slightly modify
  # the code to make sure it's only applicable on SunOS.
  #
  [ "$(uname)" = "SunOS" ] && _PACMAN="$local_pacman" && return

  $GREP -qis "$@" /etc/issue \
  && _PACMAN="$local_pacman" && return

  $GREP -qis "$@" /etc/os-release \
  && _PACMAN="$local_pacman" && return
}

# Detect package type
_PACMAN_detect() {
  _PACMAN_found_from_script_name && return

  _issue2pacman sun_tools "SunOS" && return
  _issue2pacman pacman "Arch Linux" && return
  _issue2pacman dpkg "Debian GNU/Linux" && return
  _issue2pacman dpkg "Ubuntu" && return
  _issue2pacman cave "Exherbo Linux" && return
  _issue2pacman yum "CentOS" && return
  _issue2pacman yum "Red Hat" && return
  #
  # FIXME: The multiple package issue.
  #
  # On #63, Huy commented out this line. This is because new generation
  # of Fedora uses `dnf`, and `yum` becomes a legacy tool. On old Fedora
  # system, `yum` is still detectable by looking up `yum` binary.
  #
  # I'm not sure how to support this case easily. Let's wait, e.g, 5 years
  # from now to make `dnf` becomes a default? Oh no!
  #
  # And here why `pacman` is still smart. Debian has a set of tools.
  # Fedora has `yum` (and a set of add-ons). Now Fedora moves to `dnf`.
  # This means that a package manager is not a heart of a system ;)
  #
  # _issue2pacman yum "Fedora" && return
  _issue2pacman zypper "SUSE" && return
  _issue2pacman pkg_tools "OpenBSD" && return
  _issue2pacman pkg_tools "Bitrig" && return
  _issue2pacman apk "Alpine Linux" && return
  _issue2pacman opkg "OpenWrt" && return
  _issue2pacman xbps "Void" && return

  [ -z "$_PACMAN" ] || return

  # Prevent a loop when this script is installed on non-standard system
  if [ -x "/usr/bin/pacman" ]; then
    $GREP -q "_PACMAN_detect" '/usr/bin/pacman' >/dev/null 2>&1
    [ $? -ge 1 ] && _PACMAN="pacman" \
    && return
  fi

  if uname -a | "$GREP" -q Cygwin; then
    command -v "apt-cyg" >/dev/null && _PACMAN="apt_cyg" && return
  fi
  [ -x "/usr/bin/apt-get" ] && _PACMAN="dpkg" && return
  [ -x "/data/data/com.termux/files/usr/bin/apt-get" ] && _PACMAN="dpkg" && return
  [ -x "/usr/bin/cave" ] && _PACMAN="cave" && return
  [ -x "/usr/bin/dnf" ] && _PACMAN="dnf" && return
  [ -x "/usr/bin/yum" ] && _PACMAN="yum" && return
  [ -x "/opt/local/bin/port" ] && _PACMAN="macports" && return
  [ -x "/usr/bin/emerge" ] && _PACMAN="portage" && return
  [ -x "/usr/bin/zypper" ] && _PACMAN="zypper" && return
  [ -x "/usr/sbin/pkg" ] && _PACMAN="pkgng" && return
  # make sure pkg_add is after pkgng, FreeBSD base comes with it until converted
  [ -x "/usr/sbin/pkg_add" ] && _PACMAN="pkg_tools" && return
  [ -x "/usr/sbin/pkgadd" ] && _PACMAN="sun_tools" && return
  [ -x "/sbin/apk" ] && _PACMAN="apk" && return
  [ -x "/bin/opkg" ] && _PACMAN="opkg" && return
  [ -x "/usr/bin/tazpkg" ] && _PACMAN="tazpkg" && return
  [ -x "/usr/bin/swupd" ] && _PACMAN="swupd" && return
  [ -x "/bin/xbps-install" ] && _PACMAN="xbps" && return

  command -v brew >/dev/null && _PACMAN="homebrew" && return

  return 1
}

# Translate -w option. Please note this is only valid when installing
# a package from remote, aka. when '-S' operation is performed.
_translate_w() {

  echo "$_EOPT" | $GREP -q ":w:" || return 0

  local_opt=
  local_ret=0

  case "$_PACMAN" in
  "dpkg")     local_opt="-d";;
  "cave")     local_opt="-f";;
  "dnf")      local_opt="--downloadonly";;
  "macports") local_opt="fetch";;
  "portage")  local_opt="--fetchonly";;
  "zypper")   local_opt="--download-only";;
  "pkgng")    local_opt="fetch";;
  "yum")      local_opt="--downloadonly";
    if ! rpm -q 'yum-downloadonly' >/dev/null 2>&1; then
      _error "'yum-downloadonly' package is required when '-w' is used."
      local_ret=1
    fi
    ;;
  "tazpkg")
    _error "$_PACMAN: Use '$_PACMAN get' to download and save packages to current directory."
    local_ret=1
    ;;
  "apk")      local_opt="fetch";;
  "opkg")     local_opt="--download-only";;
  "xbps")     local_opt="-D";;
  *)
    local_opt=""
    local_ret=1

    _error "$_PACMAN: Option '-w' is not supported/implemented."
    ;;
  esac

  echo "$local_opt"
  return "$local_ret"
}

_translate_debug() {
  echo "$_EOPT" | $GREP -q ":v:" || return 0

  case "$_PACMAN" in
  "tazpkg")
    _error "$_PACMAN: Option '-v' (debug) is not supported/implemented by tazpkg"
    return 1
    ;;
  esac

  echo "-v"
}

# Translate the --noconfirm option.
# FIXME: does "yes | pacapt" just help?
_translate_noconfirm() {
  echo "$_EOPT" | $GREP -q ":noconfirm:" || return 0

  local_opt=
  local_ret=0

  case "$_PACMAN" in
  # FIXME: Update environment DEBIAN_FRONTEND=noninteractive
  # FIXME: There is also --force-yes for a stronger case
  "dpkg")   local_opt="--yes";;
  "dnf")    local_opt="--assumeyes";;
  "yum")    local_opt="--assumeyes";;
  # FIXME: pacman has 'assume-yes' and 'assume-no'
  # FIXME: zypper has better mode. Similar to dpkg (Debian).
  "zypper") local_opt="--no-confirm";;
  "pkgng")  local_opt="-y";;
  "tazpkg") local_opt="--auto";;
  "apk")    local_opt="";;
  "xbps")   local_opt="-y";;
  *)
    local_opt=""
    local_ret=1
    _error "$_PACMAN: Option '--noconfirm' is not supported/implemented."
    ;;
  esac

  echo "$local_opt"
  return "$local_ret"
}

_translate_all() {
  local_args=""
  local_debug=
  local_noconfirm=

  local_debug="$(_translate_debug)" || return 1
  local_noconfirm="$(_translate_noconfirm)" || return 1

  # WARNING: Order does matter, see also
  #   https://github.com/icy/pacapt/pull/219#issuecomment-1006079629
  local_args="$(_translate_w)" || return 1
  local_args="${local_args}${local_noconfirm:+ }${local_noconfirm}"
  local_args="${local_args}${local_debug:+ }${local_debug}"

  export _EOPT="${local_args# }"
}

_print_supported_operations() {
  local_pacman="$1"
  printf "pacapt(%s): available operations:" "$local_pacman"
  # shellcheck disable=2016
  $GREP -E "^(#_!_POSIX_# )?${local_pacman}_[^ \\t]+\\(\\)" "$0" \
  | $AWK -F '(' '{print $1}' \
  | sed -e "s/.*${local_pacman}_//g" \
  | while read -r O; do
      printf " %s" "$O"
    done
  echo
}

# NOTE: A few package managers will require their own implementation
# NOTE: hence it's better to give some flexible option here.
_quiet_field1() {
  if [ -z "${_TOPT}" ]; then
    cat
  else
    awk '{print $1}'
  fi
}

# Get nth char of from a string [the first index: 1]
# https://github.com/icy/pacapt/pull/161/files#r654797953
_string_nth() {
  local_idx="${1}"; shift
  local_args="${*}"

  local_args="${local_args}" local_idx="${local_idx}" \
  "$AWK" 'BEGIN{printf("%s",substr(ENVIRON["local_args"],ENVIRON["local_idx"],1))}'
}

# https://github.com/icy/pacapt/pull/161/files#r654799601
_string_less_than() {
  a="${1}" b="${2}" "$AWK" 'BEGIN {exit !(ENVIRON["a"] < ENVIRON["b"]) }'
}