paths_util.sh

#!/usr/bin/env bash
# vim:tw=0:ts=2:sw=2:et:norl:ft=sh
# Author: Landon Bouma (landonb @ retrosoft . com)
# Project: https://github.com/landonb/home-fries#🍟
# License: MIT

# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #

check_deps () {
  check_dep 'path_prefix'
  check_dep 'path_suffix'
}

# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #

# Some of the standard system path components will already exist, but
# set them here so our code reorders these, keeping them clustered
# together.

home_fries_add_to_path_bins () {
  # No whep. 2016.04.28 and this is the first time I've seen this.
  #   $ ifconfig
  #   Command 'ifconfig' is available in '/sbin/ifconfig'
  #   The command could not be located because '/sbin' is not included in the PATH environment variable.
  #   This is most likely caused by the lack of administrative privileges associated with your user account.
  #   ifconfig: command not found
  path_prefix "/sbin"
  path_prefix "/bin"
}

home_fries_add_to_path_usr_bins () {
  path_prefix "/usr/sbin"
  path_prefix "/usr/bin"
}

home_fries_add_to_path_usr_local_bins () {
  # 2020-08-26: On macOS, default `bash --noprofile --norc` PATH is:
  #   /usr/bin:/bin:/usr/sbin:/sbin
  # Where's /usr/local/bin? Did I do something to mess it up?
  path_prefix "/usr/local/sbin"
  path_prefix "/usr/local/bin"
}

# For MacPorts. [2021-08-20: That I installed and then uninstalled.
# Nonetheless, seems useful to at least check for /opt/local/s?bin.]
home_fries_add_to_path_opt_local_bins () {
  path_prefix "/opt/local/bin"
  # 2021-08-04: Interesting. Just one sbin file. And not sure if
  # they mean the prefix literally or not. It's an empty file.
  #   /opt/local/sbin/.turd_MacPorts
  path_prefix "/opt/local/sbin"
}

# ++++++++++++++++++++++++++++++ #

home_fries_add_to_path_home_fries_lib () {
  # Make sourcing Home Fries files easy.
  path_prefix "${HOMEFRIES_DIR}/lib"
}

home_fries_add_to_path_home_fries_bin () {
  # Make Home Fries commands available.
  path_prefix "${HOMEFRIES_DIR}/bin"
}

home_fries_add_to_path_home_local_bin () {
  # Make commands installed by Zoidy Pooh et al available.
  # E.g., ~/.local/bin is where `pip install --user blah` installs.
  # And where zoidy_apps_et_al installs non-apt/-snap applications.
  path_prefix "${HOME}/.local/bin"
}

# ++++++++++++++++++++++++++++++ #

# MEH/2019-09-16: Some of these paths are author-specific.
# But they're also paths to commands installed via Zoidy Pooh Ansible.
# So it's not that much of a stretch to include them herein, as
# opposed to moving to the author's private startup script.

# MAYBE/2019-09-16: You could move these Java-/Android-, and golang-specific functions
# to new language-specific files, e.g., .homefries/lib/java_util.sh, golang_util.sh.

home_fries_add_to_path_java_jdk_jre () {
  local install_dir="${HF_DOWNLOADS_DIR:-${HOME}/.downloads}"

  local jdk_dir="${install_dir}/jdk"
  if [ -d "${jdk_dir}" ]; then
    # FIXME/2019-09-16: Seems like a weird side-effect of updating PATH
    #                   to also be exporting other variables.
    export JAVA_HOME="${jdk_dir}"
    export JRE_HOME="${JAVA_HOME}/jre"

    path_suffix "${JAVA_HOME}/bin"
    path_suffix "${JRE_HOME}/bin"
  fi
}

home_fries_add_to_path_android_studio () {
  local install_dir="${HF_DOWNLOADS_DIR:-${HOME}/.downloads}"

  path_suffix "${install_dir}/android-studio/bin"
  path_suffix "${install_dir}/android-sdk/platform-tools"

  # 2017-02-25: Have I been missing ANDROID_HOME for this long??
  local sdk_dir="${install_dir}/Android/Sdk"
  if [ -d "${sdk_dir}" ]; then
    # FIXME/2019-09-16: Seems like a weird side-effect of updating PATH
    #                   to also be exporting other variables.
    export ANDROID_HOME=${install_dir}/Android/Sdk
    path_suffix "${ANDROID_HOME}/tools"
  fi
}

home_fries_add_to_path_golang () {
  local go_dir="${HOME}/.gopath"

  if [ -d "${go_dir}" ]; then
    # FIXME/2019-09-16: Seems like a weird side-effect of updating PATH
    #                   to also be exporting other variables.
    export GOPATH="${go_dir}"
    # You can check GOPATH with: `go env`.

    path_prefix "${GOPATH}/bin"
    path_prefix "${GOPATH}"
  fi
}

# 2023-04-20 16:32: Last Ubuntu 22.04/Linux Mint 21.1 installs
# apt's `fd-find`'s `fd` to /usr/lib/cargo/bin/fd (was /usr/bin/fd).
home_fries_add_to_path_rust_cargo_bin () {
  path_suffix "/usr/lib/cargo/bin"
}

# ++++++++++++++++++++++++++++++ #

home_fries_set_path_environ () {

  # Add systemwide path prefixes first, so the the
  # local paths added later take precedence.

  home_fries_add_to_path_bins
  unset -f home_fries_add_to_path_bins

  home_fries_add_to_path_usr_bins
  unset -f home_fries_add_to_path_usr_bins

  home_fries_add_to_path_usr_local_bins
  unset -f home_fries_add_to_path_usr_local_bins

  home_fries_add_to_path_opt_local_bins
  unset -f home_fries_add_to_path_opt_local_bins

  # ++++++++++++++++++++++++++++++ #

  home_fries_add_to_path_java_jdk_jre
  unset -f home_fries_add_to_path_java_jdk_jre

  home_fries_add_to_path_android_studio
  unset -f home_fries_add_to_path_android_studio

  home_fries_add_to_path_golang
  unset -f home_fries_add_to_path_golang

  home_fries_add_to_path_rust_cargo_bin
  unset -f home_fries_add_to_path_rust_cargo_bin

  # ++++++++++++++++++++++++++++++ #

  home_fries_add_to_path_home_local_bin
  unset -f home_fries_add_to_path_home_local_bin

  home_fries_add_to_path_home_fries_lib
  unset -f home_fries_add_to_path_home_fries_lib

  # 2020-12-16: Until now, it did not matter that ~/.homefries/bin
  # followed ~/.local/bin in PATH (first two entries), but now I've
  # added a reset utility (promoted alias to function to file). So
  # ~/.homefries/bin should be V. First. Also because it's closest
  # to home (and ~/.local/bin is mostly third-party, second-class).
  home_fries_add_to_path_home_fries_bin
  unset -f home_fries_add_to_path_home_fries_bin
}

# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #

main () {
  check_deps
  unset -f check_deps
}

main "$@"
unset -f main