bashhub 3.0.2__py3-none-any.whl

bashhub/shell/deps/bash-preexec.sh

@@ -0,0 +1,341 @@
+# bash-preexec.sh -- Bash support for ZSH-like 'preexec' and 'precmd' functions.
+# https://github.com/rcaloras/bash-preexec
+#
+#
+# 'preexec' functions are executed before each interactive command is
+# executed, with the interactive command as its argument. The 'precmd'
+# function is executed before each prompt is displayed.
+#
+# Author: Ryan Caloras (ryan@bashhub.com)
+# Forked from Original Author: Glyph Lefkowitz
+#
+# V0.4.1
+#
+
+# General Usage:
+#
+#  1. Source this file at the end of your bash profile so as not to interfere
+#     with anything else that's using PROMPT_COMMAND.
+#
+#  2. Add any precmd or preexec functions by appending them to their arrays:
+#       e.g.
+#       precmd_functions+=(my_precmd_function)
+#       precmd_functions+=(some_other_precmd_function)
+#
+#       preexec_functions+=(my_preexec_function)
+#
+#  3. Consider changing anything using the DEBUG trap or PROMPT_COMMAND
+#     to use preexec and precmd instead. Preexisting usages will be
+#     preserved, but doing so manually may be less surprising.
+#
+#  Note: This module requires two Bash features which you must not otherwise be
+#  using: the "DEBUG" trap, and the "PROMPT_COMMAND" variable. If you override
+#  either of these after bash-preexec has been installed it will most likely break.
+
+# Avoid duplicate inclusion
+if [[ "${__bp_imported:-}" == "defined" ]]; then
+    return 0
+fi
+__bp_imported="defined"
+
+# Should be available to each precmd and preexec
+# functions, should they want it. $? and $_ are available as $? and $_, but
+# $PIPESTATUS is available only in a copy, $BP_PIPESTATUS.
+# TODO: Figure out how to restore PIPESTATUS before each precmd or preexec
+# function.
+__bp_last_ret_value="$?"
+BP_PIPESTATUS=("${PIPESTATUS[@]}")
+__bp_last_argument_prev_command="$_"
+
+__bp_inside_precmd=0
+__bp_inside_preexec=0
+
+# Initial PROMPT_COMMAND string that is removed from PROMPT_COMMAND post __bp_install
+__bp_install_string=$'__bp_trap_string="$(trap -p DEBUG)"\ntrap - DEBUG\n__bp_install'
+
+# Fails if any of the given variables are readonly
+# Reference https://stackoverflow.com/a/4441178
+__bp_require_not_readonly() {
+  local var
+  for var; do
+    if ! ( unset "$var" 2> /dev/null ); then
+      echo "bash-preexec requires write access to ${var}" >&2
+      return 1
+    fi
+  done
+}
+
+# Remove ignorespace and or replace ignoreboth from HISTCONTROL
+# so we can accurately invoke preexec with a command from our
+# history even if it starts with a space.
+__bp_adjust_histcontrol() {
+    local histcontrol
+    histcontrol="${HISTCONTROL//ignorespace}"
+    # Replace ignoreboth with ignoredups
+    if [[ "$histcontrol" == *"ignoreboth"* ]]; then
+        histcontrol="ignoredups:${histcontrol//ignoreboth}"
+    fi;
+    export HISTCONTROL="$histcontrol"
+}
+
+# This variable describes whether we are currently in "interactive mode";
+# i.e. whether this shell has just executed a prompt and is waiting for user
+# input.  It documents whether the current command invoked by the trace hook is
+# run interactively by the user; it's set immediately after the prompt hook,
+# and unset as soon as the trace hook is run.
+__bp_preexec_interactive_mode=""
+
+# Trims leading and trailing whitespace from $2 and writes it to the variable
+# name passed as $1
+__bp_trim_whitespace() {
+    local var=${1:?} text=${2:-}
+    text="${text#"${text%%[![:space:]]*}"}"   # remove leading whitespace characters
+    text="${text%"${text##*[![:space:]]}"}"   # remove trailing whitespace characters
+    printf -v "$var" '%s' "$text"
+}
+
+
+# Trims whitespace and removes any leading or trailing semicolons from $2 and
+# writes the resulting string to the variable name passed as $1. Used for
+# manipulating substrings in PROMPT_COMMAND
+__bp_sanitize_string() {
+    local var=${1:?} text=${2:-} sanitized
+    __bp_trim_whitespace sanitized "$text"
+    sanitized=${sanitized%;}
+    sanitized=${sanitized#;}
+    __bp_trim_whitespace sanitized "$sanitized"
+    printf -v "$var" '%s' "$sanitized"
+}
+
+# This function is installed as part of the PROMPT_COMMAND;
+# It sets a variable to indicate that the prompt was just displayed,
+# to allow the DEBUG trap to know that the next command is likely interactive.
+__bp_interactive_mode() {
+    __bp_preexec_interactive_mode="on";
+}
+
+
+# This function is installed as part of the PROMPT_COMMAND.
+# It will invoke any functions defined in the precmd_functions array.
+__bp_precmd_invoke_cmd() {
+    # Save the returned value from our last command, and from each process in
+    # its pipeline. Note: this MUST be the first thing done in this function.
+    __bp_last_ret_value="$?" BP_PIPESTATUS=("${PIPESTATUS[@]}")
+
+    # Don't invoke precmds if we are inside an execution of an "original
+    # prompt command" by another precmd execution loop. This avoids infinite
+    # recursion.
+    if (( __bp_inside_precmd > 0 )); then
+      return
+    fi
+    local __bp_inside_precmd=1
+
+    # Invoke every function defined in our function array.
+    local precmd_function
+    for precmd_function in "${precmd_functions[@]}"; do
+
+        # Only execute this function if it actually exists.
+        # Test existence of functions with: declare -[Ff]
+        if type -t "$precmd_function" 1>/dev/null; then
+            __bp_set_ret_value "$__bp_last_ret_value" "$__bp_last_argument_prev_command"
+            # Quote our function invocation to prevent issues with IFS
+            "$precmd_function"
+        fi
+    done
+}
+
+# Sets a return value in $?. We may want to get access to the $? variable in our
+# precmd functions. This is available for instance in zsh. We can simulate it in bash
+# by setting the value here.
+__bp_set_ret_value() {
+    return ${1:-}
+}
+
+__bp_in_prompt_command() {
+
+    local prompt_command_array
+    IFS=$'\n;' read -rd '' -a prompt_command_array <<< "$PROMPT_COMMAND"
+
+    local trimmed_arg
+    __bp_trim_whitespace trimmed_arg "${1:-}"
+
+    local command trimmed_command
+    for command in "${prompt_command_array[@]:-}"; do
+        __bp_trim_whitespace trimmed_command "$command"
+        if [[ "$trimmed_command" == "$trimmed_arg" ]]; then
+            return 0
+        fi
+    done
+
+    return 1
+}
+
+# This function is installed as the DEBUG trap.  It is invoked before each
+# interactive prompt display.  Its purpose is to inspect the current
+# environment to attempt to detect if the current command is being invoked
+# interactively, and invoke 'preexec' if so.
+__bp_preexec_invoke_exec() {
+
+    # Save the contents of $_ so that it can be restored later on.
+    # https://stackoverflow.com/questions/40944532/bash-preserve-in-a-debug-trap#40944702
+    __bp_last_argument_prev_command="${1:-}"
+    # Don't invoke preexecs if we are inside of another preexec.
+    if (( __bp_inside_preexec > 0 )); then
+      return
+    fi
+    local __bp_inside_preexec=1
+
+    # Checks if the file descriptor is not standard out (i.e. '1')
+    # __bp_delay_install checks if we're in test. Needed for bats to run.
+    # Prevents preexec from being invoked for functions in PS1
+    if [[ ! -t 1 && -z "${__bp_delay_install:-}" ]]; then
+        return
+    fi
+
+    if [[ -n "${COMP_LINE:-}" ]]; then
+        # We're in the middle of a completer. This obviously can't be
+        # an interactively issued command.
+        return
+    fi
+    if [[ -z "${__bp_preexec_interactive_mode:-}" ]]; then
+        # We're doing something related to displaying the prompt.  Let the
+        # prompt set the title instead of me.
+        return
+    else
+        # If we're in a subshell, then the prompt won't be re-displayed to put
+        # us back into interactive mode, so let's not set the variable back.
+        # In other words, if you have a subshell like
+        #   (sleep 1; sleep 2)
+        # You want to see the 'sleep 2' as a set_command_title as well.
+        if [[ 0 -eq "${BASH_SUBSHELL:-}" ]]; then
+            __bp_preexec_interactive_mode=""
+        fi
+    fi
+
+    if  __bp_in_prompt_command "${BASH_COMMAND:-}"; then
+        # If we're executing something inside our prompt_command then we don't
+        # want to call preexec. Bash prior to 3.1 can't detect this at all :/
+        __bp_preexec_interactive_mode=""
+        return
+    fi
+
+    local this_command
+    this_command=$(
+        export LC_ALL=C
+        HISTTIMEFORMAT= builtin history 1 | sed '1 s/^ *[0-9][0-9]*[* ] //'
+    )
+
+    # Sanity check to make sure we have something to invoke our function with.
+    if [[ -z "$this_command" ]]; then
+        return
+    fi
+
+    # Invoke every function defined in our function array.
+    local preexec_function
+    local preexec_function_ret_value
+    local preexec_ret_value=0
+    for preexec_function in "${preexec_functions[@]:-}"; do
+
+        # Only execute each function if it actually exists.
+        # Test existence of function with: declare -[fF]
+        if type -t "$preexec_function" 1>/dev/null; then
+            __bp_set_ret_value ${__bp_last_ret_value:-}
+            # Quote our function invocation to prevent issues with IFS
+            "$preexec_function" "$this_command"
+            preexec_function_ret_value="$?"
+            if [[ "$preexec_function_ret_value" != 0 ]]; then
+                preexec_ret_value="$preexec_function_ret_value"
+            fi
+        fi
+    done
+
+    # Restore the last argument of the last executed command, and set the return
+    # value of the DEBUG trap to be the return code of the last preexec function
+    # to return an error.
+    # If `extdebug` is enabled a non-zero return value from any preexec function
+    # will cause the user's command not to execute.
+    # Run `shopt -s extdebug` to enable
+    __bp_set_ret_value "$preexec_ret_value" "$__bp_last_argument_prev_command"
+}
+
+__bp_install() {
+    # Exit if we already have this installed.
+    if [[ "${PROMPT_COMMAND:-}" == *"__bp_precmd_invoke_cmd"* ]]; then
+        return 1;
+    fi
+
+    trap '__bp_preexec_invoke_exec "$_"' DEBUG
+
+    # Preserve any prior DEBUG trap as a preexec function
+    local prior_trap=$(sed "s/[^']*'\(.*\)'[^']*/\1/" <<<"${__bp_trap_string:-}")
+    unset __bp_trap_string
+    if [[ -n "$prior_trap" ]]; then
+        eval '__bp_original_debug_trap() {
+          '"$prior_trap"'
+        }'
+        preexec_functions+=(__bp_original_debug_trap)
+    fi
+
+    # Adjust our HISTCONTROL Variable if needed.
+    __bp_adjust_histcontrol
+
+    # Issue #25. Setting debug trap for subshells causes sessions to exit for
+    # backgrounded subshell commands (e.g. (pwd)& ). Believe this is a bug in Bash.
+    #
+    # Disabling this by default. It can be enabled by setting this variable.
+    if [[ -n "${__bp_enable_subshells:-}" ]]; then
+
+        # Set so debug trap will work be invoked in subshells.
+        set -o functrace > /dev/null 2>&1
+        shopt -s extdebug > /dev/null 2>&1
+    fi;
+
+    local existing_prompt_command
+    # Remove setting our trap install string and sanitize the existing prompt command string
+    existing_prompt_command="${PROMPT_COMMAND//$__bp_install_string[;$'\n']}" # Edge case of appending to PROMPT_COMMAND
+    existing_prompt_command="${existing_prompt_command//$__bp_install_string}"
+    __bp_sanitize_string existing_prompt_command "$existing_prompt_command"
+
+    # Install our hooks in PROMPT_COMMAND to allow our trap to know when we've
+    # actually entered something.
+    PROMPT_COMMAND=$'__bp_precmd_invoke_cmd\n'
+    if [[ -n "$existing_prompt_command" ]]; then
+        PROMPT_COMMAND+=${existing_prompt_command}$'\n'
+    fi;
+    PROMPT_COMMAND+='__bp_interactive_mode'
+
+    # Add two functions to our arrays for convenience
+    # of definition.
+    precmd_functions+=(precmd)
+    preexec_functions+=(preexec)
+
+    # Invoke our two functions manually that were added to $PROMPT_COMMAND
+    __bp_precmd_invoke_cmd
+    __bp_interactive_mode
+}
+
+# Sets an installation string as part of our PROMPT_COMMAND to install
+# after our session has started. This allows bash-preexec to be included
+# at any point in our bash profile.
+__bp_install_after_session_init() {
+    # Make sure this is bash that's running this and return otherwise.
+    if [[ -z "${BASH_VERSION:-}" ]]; then
+        return 1;
+    fi
+
+    # bash-preexec needs to modify these variables in order to work correctly
+    # if it can't, just stop the installation
+    __bp_require_not_readonly PROMPT_COMMAND HISTCONTROL HISTTIMEFORMAT || return
+
+    local sanitized_prompt_command
+    __bp_sanitize_string sanitized_prompt_command "$PROMPT_COMMAND"
+    if [[ -n "$sanitized_prompt_command" ]]; then
+        PROMPT_COMMAND=${sanitized_prompt_command}$'\n'
+    fi;
+    PROMPT_COMMAND+=${__bp_install_string}
+}
+
+# Run our install so long as we're not delaying it.
+if [[ -z "${__bp_delay_install:-}" ]]; then
+    __bp_install_after_session_init
+fi;

bashhub/shell/deps/lib-bashhub.sh

@@ -0,0 +1,161 @@
+#
+# lib-bashhub.sh
+# This file should contain the common bashhub
+# shell functions between bash and zsh
+#
+
+__bh_path_add() {
+    if [ -d "$1" ] && [[ ":$PATH:" != *":$1:"* ]]; then
+        PATH="${PATH:+"$PATH:"}$1"
+    fi
+}
+
+#
+# Checks if an element is present in an array.
+#
+# @param The element to check if present
+# @param the array to check in
+# @return 0 if present 1 otherwise
+#
+contains_element() {
+  local e
+  for e in "${@:2}"; do [[ "$e" == "$1" ]] && return 0; done
+  return 1
+}
+
+# Make sure our bin directory is on our path
+__bh_path_add "$HOME/.bashhub/bin"
+
+#
+# Function to be run by our preexec hook.
+#
+# Saves the directory this command is being executed in to track (cd-ing), and
+# sets a variable so we know that a command was just executed and should be
+# saved.
+#
+# GLOBALS:
+#   __BH_PWD The directory this command is being executed in
+#   __BH_SAVE_COMMAND The command that is being executed and to be saved.
+#
+# Arguments:
+#  $1 The command just entered, about to be executed.
+#
+__bh_preexec() {
+    __BH_PWD="$PWD"
+    __BH_SAVE_COMMAND="$1"
+}
+
+__bh_precmd() {
+
+    # Set this initially to properly catch the exit status.
+    __BH_EXIT_STATUS="$?"
+
+    local bashhub_dir
+    bashhub_dir=${BH_HOME_DIRECTORY:=~/.bashhub}
+
+    local command="$__BH_SAVE_COMMAND"
+
+    # Check if we need to process a command. If so, unset it as it will be
+    # processed and saved.
+    if [[ -n "$__BH_SAVE_COMMAND" ]]; then
+        unset __BH_SAVE_COMMAND
+    else
+        return 0
+    fi
+
+    if [[ -e "$bashhub_dir" ]]; then
+        (__bh_process_command "$command"&) >> "$bashhub_dir"/log.txt 2>&1
+    fi;
+}
+
+#
+# Send our command to the server if everything
+# looks good.
+#
+# @param A trimmed command from the command line
+#
+__bh_process_command() {
+
+    local bh_command
+    bh_command=$(__bh_trim_whitespace "$1")
+
+    # Sanity empty check
+    if [[ -z "$bh_command" ]]; then
+        return 0;
+    fi;
+
+    # Check to make sure bashhub is still installed. Otherwise, this will
+    # simply fail and spam the user that files dont exist.
+    if ! type "bashhub" &> /dev/null; then
+        return 0;
+    fi;
+
+    local process_id=$$
+
+    # This is non-standard across systems. GNU Date and BSD Date
+    # both convert to epoch differently. Using python for cross system
+    # compatibility.
+    local process_start_stamp
+    process_start_stamp=$(LC_ALL=C ps -p $$ -o lstart=)
+
+    local process_start=$(bashhub util parsedate "$process_start_stamp")
+    local working_directory="$__BH_PWD"
+    local exit_status="$__BH_EXIT_STATUS"
+
+    (bashhub save "$bh_command" "$working_directory" \
+    "$process_id" "$process_start" "$exit_status"&)
+}
+
+# Small function to check our Bashhub installation.
+# It's added to our precmd functions. On its initial run
+# it removes itself from the precmd function array.
+# This means it runs exactly once.
+__bh_check_bashhub_installation() {
+    local ret
+    ret=0
+    if [[ -n "$BASH_VERSION" && -n "$__bp_enable_subshells" && "$(trap)" != *"__bp_preexec_invoke_exec"* ]]; then
+        echo "Bashhub's preexec hook is being overriden and is not saving commands. Please resolve what may be holding the DEBUG trap."
+        ret=1
+    elif [[ ! -f "$BH_HOME_DIRECTORY/config" ]]; then
+        echo "Missing Bashhub config file. Please run 'bashhub setup' to generate one."
+        ret=2
+    elif ! grep -Fq "access_token" "$BH_HOME_DIRECTORY/config"; then
+        echo "Missing Bashhub access token. Please run 'bashhub setup' to re-login."
+        ret=3
+    elif ! grep -Fq "system_name" "$BH_HOME_DIRECTORY/config"; then
+        echo "Missing system name. Please run 'bashhub setup' to re-login."
+        ret=4
+    elif grep -Fq "save_commands = False" "$BH_HOME_DIRECTORY/config"; then
+        echo "Bashhub is currently disabled. Run 'bashhub on' to re-enable."
+        ret=5
+    fi;
+
+    # Remove from precmd_functions so it only runs once when the session starts.
+    local delete
+    delete=(__bh_check_bashhub_installation)
+    precmd_functions=( "${precmd_functions[@]/$delete}" )
+
+    return $ret
+}
+
+# Allows bashhub to manipulate session state by
+# manipulating variables when invoked by precmd.
+__bh_precmd_run_script() {
+    if [[ -e $BH_HOME_DIRECTORY/script.bh ]]; then
+        local command
+        command=$(head -n 1 "$BH_HOME_DIRECTORY/script.bh")
+        rm "$BH_HOME_DIRECTORY/script.bh"
+        eval "$command"
+     fi;
+}
+
+# Check our bashhub installation when the session starts.
+precmd_functions+=(__bh_check_bashhub_installation)
+precmd_functions+=(__bh_precmd_run_script)
+
+__bh_trim_whitespace() {
+    local var=$@
+    var="${var#"${var%%[![:space:]]*}"}"   # remove leading whitespace characters
+    var="${var%"${var##*[![:space:]]}"}"   # remove trailing whitespace characters
+    echo -n "$var"
+}

bashhub/shell_utils.py

@@ -0,0 +1,17 @@
+import os
+import dateutil.parser
+from time import *
+from .bashhub_globals import *
+
+
+def get_session_information():
+    ppid = os.getppid()
+
+    # Non standard across systems GNU Date and BSD Date
+    # both convert to epoch differently. Need to use
+    # python date util to make standard.
+    start_time_command = "ps -p {0} -o lstart | sed -n 2p".format(ppid)
+    date_string = os.popen(start_time_command).read().strip()
+    date = dateutil.parser.parse(date_string)
+    start_time = int(mktime(date.timetuple())) * 1000
+    return (ppid, start_time)

bashhub/version.py

@@ -0,0 +1,5 @@
+import platform
+
+__version__ = '3.0.2'
+
+version_str = 'Bashhub {0} (python {1})'.format(__version__, platform.python_version())

bashhub/view/status.py

@@ -0,0 +1,25 @@
+import dateutil.parser
+import datetime
+import humanize
+from bashhub.bashhub_globals import BH_URL
+
+status_view = """\
+=== Bashhub Status
+{0}/{1}
+Total Commands: {2}
+Total Sessions: {3}
+Total Systems:  {4}
+===
+Session PID {5} Started {6}
+Commands In Session: {7}
+Commands Today: {8}
+"""
+
+def build_status_view(model):
+    date = datetime.datetime.fromtimestamp(model.session_start_time / 1000.0)
+    date_str = humanize.naturaltime(date)
+    return status_view.format(
+        BH_URL.rstrip('/'), model.username,
+        model.total_commands, model.total_sessions,
+        model.total_systems, model.session_name, date_str,
+        model.session_total_commands, model.total_commands_today)