.bash_aliases

# This file is part of eRCaGuy_dotfiles: https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles

# INSTALLATION & USAGE INSTRUCTIONS:
# - If you are pulling in my bash configuration files for your usage, I recommend you leave this
#   file exactly as-is and copy and edit and customize the ".bash_aliases_private" file instead.
# - See the "eRCaGuy_dotfiles/home/README.md" file, with full instructions and details, here:
#   https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles/tree/master/home
#
# 1. Make a symlink to this file in your home (~) dir:
#       cd path/to/eRCaGuy_dotfiles/home
#       ln -si "${PWD}/.bash_aliases" ~

# Note: to remind yourself what the definition is for any given alias, just run
# `alias some_alias_name` at the terminal. To see all aliases, run just `alias`. To see
# ALL my custom aliases AND functions AND executable scripts, type `gs_` then press Tab Tab
# (Tab two times).

RETURN_CODE_SUCCESS=0
RETURN_CODE_ERROR=1

# Get the path to this file and then also to the eRCaGuy_dotfiles repo root dir.
# See my ans: https://stackoverflow.com/a/60157372/4561887
FULL_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIRECTORY="$(dirname "$FULL_PATH_TO_SCRIPT")"
SCRIPT_FILENAME="$(basename "$FULL_PATH_TO_SCRIPT")"
# This assumes that ~/.bash_aliases is a **symlink** to this file in the repo
ERCAGUY_DOTFILES_ROOT_DIR="$(dirname "$SCRIPT_DIRECTORY")"
# This assumes that this repo is inside of my main "dev" development folder
DEV_ROOT_DIR="$ERCAGUY_DOTFILES_ROOT_DIR/.."

# ==================================================================================================
# 1. GENERAL (PUBLICLY SHARED) Bash Setup, Variables, Aliases, & Functions
# ==================================================================================================

# cd into my/your main "dev" development directory where I store my repos and do my engineering and
# code development. This path for me is usually: "$HOME/GS/dev", which generally expands to
# "/home/gabriel/GS/dev". However, for you it may be different, so this trick will cd into the dir
# you have which contains this repo, assuming that that location is **your** main "dev" type
# directory, just as it is for me!
alias gs_cd_to_dev="cd \"$DEV_ROOT_DIR\""

# DEUG PRINTS:
# echo "FULL_PATH_TO_SCRIPT = $FULL_PATH_TO_SCRIPT"  # debugging
# echo "SCRIPT_DIRECTORY = $SCRIPT_DIRECTORY"  # debugging
# echo "SCRIPT_FILENAME = $SCRIPT_FILENAME"  # debugging
# echo "ERCAGUY_DOTFILES_ROOT_DIR = $ERCAGUY_DOTFILES_ROOT_DIR"  # debugging


# Import this ".bash_prompt_str" file, if it exists.
if [ -f "$SCRIPT_DIRECTORY/.bash_prompt_str" ]; then
    . "$SCRIPT_DIRECTORY/.bash_prompt_str"
fi

# Import this ".git_aliases" file, if it exists.
if [ -f "$SCRIPT_DIRECTORY/.git_aliases" ]; then
    . "$SCRIPT_DIRECTORY/.git_aliases"
fi

# Import this ".git_custom_hooks" file, if it exists.
if [ -f "$SCRIPT_DIRECTORY/.git_custom_hooks" ]; then
    . "$SCRIPT_DIRECTORY/.git_custom_hooks"
fi

# Import this ".bash_useful_functions" utilities file, if it exists.
if [ -f "$SCRIPT_DIRECTORY/.bash_useful_functions" ]; then
    . "$SCRIPT_DIRECTORY/.bash_useful_functions"
fi

# Find a file built by Bazel and therefor sitting in the "build/bin" dir.
alias gs_find_bazel_build_file='find -L build/bin | grep'
# note: the below could also be done with `gs_find_bazel_build_file -i somefilename`
alias gs_find_bazel_build_file_i='find -L build/bin | grep -i'

# Put computer to sleep (ie: suspend it).
# See: https://askubuntu.com/questions/1792/how-can-i-suspend-hibernate-from-command-line/1795#1795
alias gs_suspend='systemctl suspend'

# ssh into another computer. Override this ssh command by re-defining it in
# "~/.bash_aliases_private"! Make the username, domain_name, & options what they should be for you.
# Notes:
# 1) enable X11 window forwarding with `-X`; see here:
#    https://unix.stackexchange.com/questions/12755/how-to-forward-x-over-ssh-to-run-graphics-applications-remotely/12772#12772
# 2) keep the connection alive with `-o "ServerAliveInterval 60"`; see here:
#    https://superuser.com/questions/699676/how-to-prevent-ssh-from-disconnecting-if-its-been-idle-for-a-while/699680#699680
alias gs_ssh="ssh -X -o \"ServerAliveInterval 60\" username@domain_name"

# Remotely decrypt a LUKS-encrypted hard drive on a computer during boot, by sshing into a Dropbear
# server on your machine. Here's a Google search to get started learning about this:
# "dropbear ssh remotely decrypt hard drive":
# https://www.google.com/search?q=dropbear+ssh+remotely+decrypt+hard+drive&oq=dropbear+ssh+remotely+decrypt+hard+drive&aqs=chrome..69i57.193j0j4&sourceid=chrome&ie=UTF-8
# NB: I recommend you set this below alias in ~/.bash_aliases_private instead of here.
# alias gs_ssh_dropbear=""

# Mount a remote file system securely over ssh, using sshfs (SSH File System).
# See my own answer here!:
# https://askubuntu.com/questions/791002/how-to-prevent-sshfs-mount-freeze-after-changing-connection-after-suspend/942820#942820
alias gs_sshfs="sshfs -o reconnect,ServerAliveInterval=15,ServerAliveCountMax=3 \
username@server_hostname:/path/on/server/to/mount ~/mnt/my_server"
alias gs_sshfs_umount="sudo umount ~/mnt/my_server"

# Copied from my code here:
# https://github.com/ElectricRCAircraftGuy/eRCaGuy_hello_world/blob/master/bash/sound_bell_lib.sh
#
# Description:
# Play the bell sound "ding" to alert the user of something.
#
# Usage:
#       sound_bell [number_of_times [second_delay_between_sounds]]
# Examples
#       sound_bell          # sound bell once
#       sound_bell 1        # sound bell once
#       sound bell 2        # sound bell 2x with default delay between each
#       sound bell 2 .2     # sound bell 2x with delay of 0.2 sec between each
#       sound bell 3 .5     # sound bell 3x with delay of 0.5 sec between each
sound_bell() {
    # set default values
    num_times="1"
    delay_sec="0.12"

    # set to user-defined values if the user passes them in as args
    if [ -n "$1" ]; then
        num_times="$1"
    fi
    if [ -n "$2" ]; then
        delay_sec="$2"
    fi

    # sound the bell
    for (( i=0; i<"$num_times"; i++ )); do
        printf "%b" "\a"  # bell sound

        # Only sleep the delay time **between** bell sounds, and NOT after the last one
        # - for how to do arithmetic expansion (math in Bash), see my answer here:
        #   https://stackoverflow.com/a/71567705/4561887
        if [ "$i" -lt "$((num_times-1))" ]; then
            sleep "$delay_sec"
        fi
    done
}

# Play sound; very useful to add to the end of a long cmd you want to be notified of when it completes!
# Ex: `long_cmd; gs_sound_bell` will play a bell sound when `long_cmd` completes!
# alias gs_sound_bell="echo -e \"\a\""
alias gs_sound_bell="sound_bell"

# Even better, have a pop-up notification too!
# Ex: `long_cmd; gs_alert` will play the sound above *and* pop up a notification when complete!
# See more details & a screenshot of the popup on my answer here:
#   https://askubuntu.com/questions/277215/how-to-make-a-sound-once-a-process-is-complete/1213564#1213564
# For other popup window options, see my other answer here:
#   https://superuser.com/questions/31917/is-there-a-way-to-show-notification-from-bash-script-in-ubuntu/1310142#1310142
alias gs_alert="gs_sound_bell 2; alert \"task complete\""

# More sounds:
# From: https://askubuntu.com/questions/277215/how-to-make-a-sound-once-a-process-is-complete/604116#604116
sound() {
    # plays sounds in sequence and waits for them to finish
    for s in $@; do
        paplay $s
    done
}
# Run these commands directly from the terminal to play these sounds; ex: `sn1`, `sn2`, `sn3`
# Tick!
sn1() {
  sound /usr/share/sounds/ubuntu/stereo/dialog-information.ogg
}
# Dingggg!
sn2() {
  sound /usr/share/sounds/freedesktop/stereo/complete.oga
}
# Beeebeebeeebeeebeee!
sn3() {
  sound /usr/share/sounds/freedesktop/stereo/suspend-error.oga
}

# Text to speech as a sound: use cmd: `spd-say "some text to read"`
# Ex: `long_cmd; spd-say done` OR `long_cmd; gs_say_done` <=== AMAZING!
# See also: https://askubuntu.com/questions/277215/how-to-make-a-sound-once-a-process-is-complete/587575#587575
alias gs_say_done="spd-say \"Done!\""
alias gs_say_complete="spd-say \"Operation Complete!\""

# Find and replace strings in a file.
# I posted this as an answer here:
# https://stackoverflow.com/questions/12144158/how-to-check-if-sed-has-changed-a-file/61238414#61238414
# Usage: `gs_replace_str "regex_search_pattern" "replacement_string" "file_path"`
# Ex:    `gs_replace_str "myFunc(" "myNewFunc(" "my_file.cpp"`
gs_replace_str() {
    CMD="gs_replace_str"
    # Help menu
    if [ "$1" == "-h" ] || [ "$1" == "-?" ]; then
        echo "Find and replace strings in a file."
        echo "Usage:   $CMD <\"regex_search_pattern\"> <\"replacement_string\"> <\"file_path\">"
        echo "Example: $CMD \"myFunc(\" \"myNewFunc(\" \"my_file.cpp\""
        return $EXIT_SUCCESS
    fi

    REGEX_SEARCH="$1"
    REPLACEMENT_STR="$2"
    FILENAME="$3"

    num_lines_matched=$(grep -c -E "$REGEX_SEARCH" "$FILENAME")
    # Also count number of matches, NOT just lines (`grep -c` counts lines), in case there are
    # multiple matches per line; see:
    # https://superuser.com/questions/339522/counting-total-number-of-matches-with-grep-instead-of-just-how-many-lines-match/339523#339523
    num_matches=$(grep -o -E "$REGEX_SEARCH" "$FILENAME" | wc -l)

    echo -e "\n${num_matches} matches found on ${num_lines_matched} lines in file \"${FILENAME}\":"

    if [ "$num_matches" -gt 0 ]; then
        # Now *show these exact matches* with their corresponding line 'n'umbers in the file
        grep -n --color=always -E "$REGEX_SEARCH" "$FILENAME"
        # Now actually *DO the string replacing* on the files 'i'n place using the `sed`
        # 's'tream 'ed'itor!
        sed -i "s|${REGEX_SEARCH}|${REPLACEMENT_STR}|g" "$FILENAME"
    fi
}

# Set the title string at the top of your current terminal window or terminal window tab.
# See: https://unix.stackexchange.com/questions/177572/how-to-rename-terminal-tab-title-in-gnome-terminal/566383#566383
# and: https://askubuntu.com/questions/315408/open-terminal-with-multiple-tabs-and-execute-application/1026563#1026563
# - Example usage:
#   - A) Static title strings (title remains fixed):
#     - `gs_set_title my tab 1` OR `gs_set_title "my tab 1"`
#     - `gs_set_title $PWD` OR `gs_set_title "$PWD"`
#   - B) Dynamic title strings (title updates each time you enter any terminal command): you may
#     use function calls or variables within your title string and have them *dynamically*
#     updated each time you enter a new command. Simply enter a command or access a global
#     variable inside your title string. **Be sure to use _single quotes_ (`'`) around the title
#     string for this to work!**:
#     - `gs_set_title '$PWD'` - this updates the title to the Present Working Directory every
#        time you `cd` to a new directory!
#     - `gs_set_title '$(date "+%m/%d/%Y - %k:%M:%S")'` - this updates the title to the new
#        date and time every time it changes *and* you enter a new terminal command! The
#        date output of the above command looks like this: `02/06/2020 - 23:32:58`
gs_set_title() {
    CMD="gs_set_title"
    # Help menu
    if [ "$1" == "-h" ] || [ "$1" == "-?" ]; then
        echo "Set the title of your currently-opened terminal tab."
        echo "Usage:"
        echo "  1. set a **static** title"
        echo "          $CMD any title you want"
        echo "          # OR"
        echo "          $CMD \"any title you want\""
        echo "  2. set a **dynamic** title, which relies on variables or functions"
        echo "          $CMD '\$(some_cmd)'       # with a dynamically-run command"
        echo "          $CMD '\${SOME_VARIABLE}'  # with a dynamically-expanded variable"
        echo ""
        echo "Examples:"
        echo "  1. static title"
        echo "          $CMD my new title"
        echo "  2. dynamic title"
        echo "          $CMD 'Current Directory is \"\$PWD\"'"
        echo "          $CMD 'Date and time of last cmd is \"\$(date)\"'"
        echo "          # [MY FAVORITE!] To actively show just the directory name"
        echo "          $CMD '\$(basename \"\$(pwd)\")'"
        return $EXIT_SUCCESS
    fi

    TITLE="$@"
    # Set the PS1 title escape sequence; see "Customizing the terminal window title" here:
    # https://wiki.archlinux.org/index.php/Bash/Prompt_customization#Customizing_the_terminal_window_title
    ESCAPED_TITLE="\[\e]2;${TITLE}\a\]"

    # Delete any existing title strings, if any, in the current PS1 variable. See my Q here:
    # https://askubuntu.com/questions/1310665/how-to-replace-terminal-title-using-sed-in-ps1-prompt-string
    PS1_NO_TITLE="$(echo "$PS1" | sed 's|\\\[\\e\]2;.*\\a\\\]||g')"
    PS1="${PS1_NO_TITLE}${ESCAPED_TITLE}"
}


# ===================================== SECTION 2 START ============================================
# 2. PERSONAL (PRIVATE) Bash Setup, Variables, Aliases, & Functions
# - Add your personal, custom, or otherwise unshared bash aliases and functions to
#   the "~/.bash_aliases_private" file, which is sourced (imported) here.
# - It is recommended that you edit the "~/.bash_aliases_private" file rather than modifying
#   this file, so that you can keep this file as a symlink to the file in the repo, and easily
#   and regularly pull the latest version of this file from the repo.
# - All bash aliases or functions in "~/.bash_aliases_private", or below, will override any
#   above if they have the same name.

# Import this "~/.bash_aliases_private" file, if it exists.
if [ -f ~/.bash_aliases_private ]; then
    . ~/.bash_aliases_private
fi

# ====================================== SECTION 2 END =============================================


# Back to more GENERAL (PUBLICLY SHARED) Bash Setup, Variables, Aliases, & Functions below:


#--------------------------- CUSTOM TERMINAL TABS & TITLES (START) ---------------------------------

# Set the terminal title to a user-specified value each time your open a terminal or re-source
# the "~/.bashrc" file if and only if `DEFAULT_TERMINAL_TITLE` has been previously set and/or
# exported by the user. This can be accomplished in a number of ways:
# 1. (Best option) Simply assign `DEFAULT_TERMINAL_TITLE` to some value inside
# "~/.bash_aliases_private":
#   a. to use a default title:
#           DEFAULT_TERMINAL_TITLE="some default title"
#   b. to NOT use a default title, either don't define this variable, or define it to be an empty
#   string:
#           DEFAULT_TERMINAL_TITLE=
# 2. In an open terminal, export a value for this variable, then re-source your "~/.bashrc" file:
#   a. turn it on:
#           export DEFAULT_TERMINAL_TITLE="some title"
#           . ~/.bashrc
#   b. turn it off:
#           DEFAULT_TERMINAL_TITLE=
#           # OR
#           unset DEFAULT_TERMINAL_TITLE
#           # then
#           . ~/.bashrc
# 3. Assign and pass in a variable as you re-source the "~/.bashrc" file:
#           DEFAULT_TERMINAL_TITLE="some title" . ~/.bashrc
#
# Note that sourcing the "~/.bashrc" file is done automatically by bash each time you open a new
# bash terminal, as long as it is an interactive type terminal. You can use `bash -i` (if calling
# bash directly) to force it to be an interactive terminal.
if [[ -n "$DEFAULT_TERMINAL_TITLE" ]]; then # If length of this is NONzero (see `man test`)
    gs_set_title "$DEFAULT_TERMINAL_TITLE"
fi

# See the description for this function in its help string just below.
gs_open_default_tabs() {
    CMD="gs_open_default_tabs"
    HELP_STR="\
Call this function to open up a bunch of terminal tabs, as configured in your
\"~/.bash_aliases_private\" file, calling the desired command in each tab and setting the title of
each tab as desired. This is really helpful to get your programming environment set up each day
for software development work, for instance."

    # Help menu
    if [ "$1" == "-h" ] || [ "$1" == "-?" ]; then
        echo "$HELP_STR"
        return $EXIT_SUCCESS
    fi

    # Process all terminal tabs

    num_elements="${#TERMINAL_TABS[@]}"
    num_rows=$(($num_elements/$TERMINAL_TABS_NUM_COLS))
    num_cols="$TERMINAL_TABS_NUM_COLS"

    for ((row=0; row<num_rows; row++)); do
        i_title=$(( $row*$num_cols + 0 ))    # index at column 0
        i_command=$(( $row*$num_cols + 1 ))  # index at column 1

        title="${TERMINAL_TABS[$i_title]}"
        command="${TERMINAL_TABS[$i_command]}"

        # Open the terminal tab with the desired title and command

        if [ "$TERMINAL" == "terminator" ]; then
            # Example of how to do this in the `terminator` terminal:
            #       terminator --new-tab --command='ls; cd dev; ls; exec bash;'

            # Note: the `bash -ic` trick below is required in order to make the shell command calls
            # "interactive", thereby giving the terminal access to bash aliases and functions defined
            # in "~/.bashrc", "~/.bash_aliases" above, or "~/.bash_aliases_private". Without that trick,
            # commands such as `ll` would NOT work for the user as a `TERMINAL_TAB_CMD`, as `ll` isn't
            # defined yet! (It is defined inside "~/.bashrc" as the bash terminal is opening and
            # sourcing this file).

            terminator --new-tab --command="export DEFAULT_TERMINAL_TITLE='$title'; bash -ic '$command; exec bash;'"

        elif [ "$TERMINAL" == "gnome-terminal" ]; then
            gnome-terminal --tab -- bash -ic "export DEFAULT_TERMINAL_TITLE='$title'; $command; exec bash;"
        fi
    done
} # gs_open_default_tabs

# This chunk of code allows one to essentially call `gs_open_default_tabs` from another script to
# open up all default tabs in a brand new terminal window. See
# "eRCaGuy_dotfiles/useful_scripts/open_programming_tools.sh" for a full example and more-detailed
# comments.
# You must add these lines to your script:
#       mkdir -p ~/temp
#       if [ ! -f ~/temp/.open_default_tabs ]; then
#           touch ~/temp/.open_default_tabs
#       fi
#       # then either:
#       terminator&
#       # OR
#       gnome-terminal&
# As the terminal opens now, it will see that the file "~/temp/.open_default_tabs" has been created,
# and it will use this as an indicator it should open up all the default tabs automatically!
mkdir -p ~/temp
OPEN_DEFAULT_TABS="false"
if [ -f ~/temp/.open_default_tabs ]; then  # see `man test` for meaning of `-f`
    OPEN_DEFAULT_TABS="true"
fi
if [ "$OPEN_DEFAULT_TABS" == "true" ]; then
    rm ~/temp/.open_default_tabs
    gs_open_default_tabs
    # close the calling process so only the "default tabs" are left open while the initial
    # `gnome-terminal` or `terminator` tab that opened all the other tabs is now closed.
    exit 0
fi

#--------------------------- CUSTOM TERMINAL TABS & TITLES (END) -----------------------------------


# Auto-start the ssh agent and add necessary keys once per reboot.
#
# This is recommended to be added to your ~/.bash_aliases (preferred) or ~/.bashrc file on any
# remote ssh server development machine that you generally ssh into, and from which you must ssh
# into other machines or servers, such as to push code to GitHub over ssh. If you only graphically
# log into this machine, however, there is no need to do this, as Ubuntu's Gnome window manager,
# for instance, will automatically start and manage the `ssh-agent` for you instead.
#
# See:
# https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles/tree/master/home/.ssh#auto-starting-the-the-ssh-agent-on-a-remote-ssh-based-development-machine
#
# ^^ COPY AND PASTE THE LATEST CODE BLOCK FROM THE LINK JUST ABOVE INTO THIS SPACE BELOW IF THE
# DESCRIPTION JUST ABOVE APPLIES TO THIS MACHINE AND YOU'D LIKE TO AUTOMATICALLY START THE SSH-AGENT
# AND AUTOMATICALLY ADD YOUR SSH-KEYS TO IT ONCE PER REBOOT.

# Continually watch the live log output from "eRCaGuy_dotfiles/useful_scripts/cpu_logger.py"
alias gs_cpu_logger_watch='less -N --follow-name +F ~/cpu_log.log'

# # Do `git add -A && git commit` all at once. Example
# #       git add-commit -m 'My commit message'
# # See [my answer] https://stackoverflow.com/a/71150235/4561887
# # Nah, just use a git alias, like this: https://stackoverflow.com/a/4299159/4561887
# git-add-commit() {
#     starting_dir="$PWD"
#     # See: https://stackoverflow.com/a/957978/4561887
#     repo_root_dir="$(git rev-parse --show-toplevel)"
#     cd "$repo_root_dir"
#     git add -A
#     git commit "$@"
#     cd "starting_dir"
# }

# Fuzzy search my "git & Linux cmds doc"
# See my comment: https://github.com/junegunn/fzf/issues/1034#issuecomment-1054558594
# alias gs_fzf_git_and_linux_cmds_doc="grep -n '' \
#     '$ERCAGUY_DOTFILES_ROOT_DIR/git & Linux cmds, help, tips & tricks - Gabriel.txt' \
#     | fzf -m --reverse"
# Make this a function instead, which accepts additional arguments I can pass to `fzf`!
gs_fzf_git_and_linux_cmds_doc() {
    grep -n '' \
    "$ERCAGUY_DOTFILES_ROOT_DIR/git & Linux cmds, help, tips & tricks - Gabriel.txt" \
    | fzf -m --reverse "$@"
}

# Re-authenticate into your Google cloud (gcloud) account withOUT launching a browser, in case you
# are in an ssh session where launching the browser wouldn't show up since it's a GUI launching
# on the remote machine.
# Note that in newer versions of `gcloud`, `--no-launch-browser` is the old flag and is now
# deprecated. Use `--no-browser` instead.
# See:
# 1. https://cloud.google.com/sdk/gcloud/reference/auth/login
# 1. https://cloud.google.com/sdk/gcloud/reference/auth/login#--no-browser
# 1. https://cloud.google.com/sdk/gcloud/reference/auth/login#--launch-browser
# 1. `gcloud auth login --help`
#
# To update `gcloud`: https://cloud.google.com/sdk/gcloud/reference/components/update <===
#
# Common commands:
#       gcloud version
#           check version
#           See: https://cloud.google.com/sdk/gcloud/reference/components/update
#       gcloud components update
#           update gcloud
#           See: https://cloud.google.com/sdk/gcloud/reference/components/update
#       gcloud components update --version=1.2.3
#           update all installed components to a fixed Google Cloud CLI version 1.2.3
#           See: https://cloud.google.com/sdk/gcloud/reference/components/update
#
alias gs_gcloud_get_new_credentials="gcloud auth login --no-launch-browser"

# HashiCorp vault: used inside some build systems by some companies for user authentication,
# for example.
# [keywords: `vault login`]
#
# References:
# 1. https://learn.hashicorp.com/tutorials/vault/getting-started-intro?in=vault/getting-started
# 1. *****+ Install `vault`:
#    https://learn.hashicorp.com/tutorials/vault/getting-started-install?in=vault/getting-started#install-vault
# 1. Authentication:
#    https://learn.hashicorp.com/tutorials/vault/getting-started-authentication?in=vault/getting-started
# 1. *****+ Okta Auth Method in `vault`: https://www.vaultproject.io/docs/auth/okta
# 1. Commands: https://www.vaultproject.io/docs/commands
# 1. *****+ Source code on GitHub!: https://github.com/hashicorp/vault
# 1. *****+ How to install or upgrade `vault` on Linux Ubuntu:
#    https://www.cyberithub.com/how-to-install-hashicorp-vault-on-ubuntu-20-04-lts/
#
# How to install or upgrade `vault`:
# - See: https://www.cyberithub.com/how-to-install-hashicorp-vault-on-ubuntu-20-04-lts/
# ```bash
# # Check version
# vault --version
# # Install
# curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
# sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
# sudo apt install vault
# # Re-source your bash startup file
# . ~/.bashrc
# # Ensure your version is higher now, indicating a successful install
# vault --version
# ```
#
# Common commands:
#       vault --help
#           view the main help menu
#       vault
#           same as above--show the help menu
#       vault login --help | less
#           view the `vault login` help menu
#       vault --version
#           view version information
#
#
# `VAULT_TOKEN_PATH` examples & info.:
# 1. https://github.com/hashicorp/vault/issues/1492#issuecomment-453527482
# 1. https://socket.dev/npm/package/@twentyfourg/vault
VAULT_TOKEN_PATH_DEFAULT="$HOME/.vault-token"
# NB: you may need to set this to `$VAULT_TOKEN_PATH_DEFAULT` instead. Set it to that by default,
# and change it only if you need to.
# export VAULT_TOKEN_PATH="$VAULT_TOKEN_PATH_DEFAULT"
export VAULT_TOKEN_PATH="$HOME"
# alias to manually log into the vault whenever you need to authenticate again
alias gs_vault_login='vault login -method=okta username=$USER; gs_gcloud_get_new_credentials'

# Take the sha256sum of all files in an entire dir, and then sha256sum that
# entire output to obtain a _single_ sha256sum which represents the _entire_
# dir.
# See:
# 1. my answer with this function: https://stackoverflow.com/a/72073333/4561887
# 1. my answer about using `find` to find all non-directory files:
#    https://stackoverflow.com/a/72070772/4561887
sha256sum_dir() {
    return_code="$RETURN_CODE_SUCCESS"
    if [ "$#" -eq 0 ]; then
        echo "ERROR: too few arguments."
        return_code="$RETURN_CODE_ERROR"
    fi
    # Print help string if requested
    if [ "$#" -eq 0 ] || [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
        # Help string
        echo "Obtain a sha256sum of all files in a directory."
        echo "Usage:  ${FUNCNAME[0]} [-h|--help] <dir>"
        return "$return_code"
    fi

    starting_dir="$(pwd)"
    target_dir="$1"
    cd "$target_dir"

    # See my answer: https://stackoverflow.com/a/72070772/4561887
    filenames="$(find . -not -type d | sort -V)"
    IFS=$'\n' read -r -d '' -a filenames_array <<< "$filenames"
    time all_hashes_str="$(sha256sum "${filenames_array[@]}")"
    cd "$starting_dir"

    echo ""
    echo "Note: you may now call:"
    echo "1. 'printf \"%s\n\" \"\$all_hashes_str\"' to view the individual" \
         "hashes of each file in the dir. Or:"
    echo "2. 'printf \"%s\" \"\$all_hashes_str\" | sha256sum' to see that" \
         "the hash of that output is what we are using as the final hash" \
         "for the entire dir."
    echo ""
    printf "%s" "$all_hashes_str" | sha256sum | awk '{ print $1 }'
    return "$?"
}
# Note: I prefix this with my initials to find my custom functions easier
alias gs_sha256sum_dir="sha256sum_dir"

# Compare dir1 against dir2 to see if they are equal or if they differ.
# See:
# 1. my answer with this function: https://stackoverflow.com/a/72073333/4561887
# 1. How to `diff` two dirs: https://stackoverflow.com/a/16404554/4561887
diff_dir() {
    return_code="$RETURN_CODE_SUCCESS"
    if [ "$#" -eq 0 ]; then
        echo "ERROR: too few arguments."
        return_code="$RETURN_CODE_ERROR"
    fi
    # Print help string if requested
    if [ "$#" -eq 0 ] || [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
        echo "Compare (diff) two directories to see if dir1 contains the same" \
             "content as dir2."
        echo "NB: the output will be **empty** if both directories match!"
        echo "Usage:  ${FUNCNAME[0]} [-h|--help] <dir1> <dir2>"
        return "$return_code"
    fi

    dir1="$1"
    dir2="$2"
    time diff -r -q "$dir1" "$dir2"
    return_code="$?"
    if [ "$return_code" -eq 0 ]; then
        echo -e "\nDirectories match!"
    fi

    # echo "$return_code"
    return "$return_code"
}
# Note: I prefix this with my initials to find my custom functions easier
alias gs_diff_dir="diff_dir"

# Connect to a VPN via `openconnect-sso`. See my answer here:
# https://superuser.com/a/1753172/425838
# - NB: use single quotes here so as to NOT do bash variable expansion yet.
#   Rather, do that expansion at call-time.
# - The variables in this cmd must be defined inside your
#   ~/.bash_aliases_private file.
alias gs_vpn_openconnect-sso='openconnect-sso \
    --server "${VPN_SERVER_ADDRESS}/${VPN_SAML_GROUP}" --user "${VPN_USER}"'
# Custom configuration to solve some problems while using `openconnect-sso` in Ubuntu 22.04.
# See my comment & instructions:
# https://github.com/vlaci/openconnect-sso/issues/81#issuecomment-1363355533
export QTWEBENGINE_DISABLE_SANDBOX=1
export OPENSSL_CONF=~/.my_ssl.conf

# For the alacritty terminal--to enable autocompletions in bash.
# See:
# 1. Where we install the bash completions for alacritty:
#    https://github.com/alacritty/alacritty/blob/master/INSTALL.md#bash
# 1. Why one might consider using the alacritty terminal in the first place (it supports copy/paste
#    operations in the `micro` editor over ssh):
#    [see my comment here--see also the discussion just above my comment]
#    https://github.com/zyedidia/micro/issues/538#issuecomment-1406713447
if [ -f ~/.bash_completion/alacritty ]; then
    . ~/.bash_completion/alacritty
fi

# Add Cmake binary executables to our PATH.
# - This includes the Cmake GUI tool, `cmake-gui`, for instance.
# - All tools included are:
#
#       ccmake
#       cmake
#       cmake-gui
#       cpack
#       ctest
#
# - Download the latest version of Cmake here: https://cmake.org/download/. The .sh
#   Linux x86_64 installer works well.
# - Update this `DIR` path as necessary!
DIR="$HOME/Downloads/Install_Files/CMake/cmake-3.28.0-rc5-linux-x86_64/bin"
if [ -d "$DIR" ]; then
    PATH="$DIR:$PATH"
fi

# Bring in my magical alarm_timer.sh script, which I use to set a timer to go off in a certain
# number of minutes, and then play a sound and pop up a notification when the timer goes off.
# See: 
# 1. https://github.com/ElectricRCAircraftGuy/eRCaGuy_hello_world/blob/master/bash/alarm_lib.sh
FILE="$DEV_ROOT_DIR/eRCaGuy_hello_world/bash/alarm_lib.sh"
if [ -f "$FILE" ]; then
    # get access to the `alarm_timer` func
    . "$FILE"
    alias gs_alarm_timer="alarm_timer"
fi

# Add doxygen binaries to the PATH
DIR="$HOME/Downloads/Install_Files/Doxygen/doxygen-1.10.0/bin"
if [ -d "$DIR" ]; then
    PATH="$DIR:$PATH"
fi