bashhub 3.0.2__tar.gz → 3.0.3__tar.gz

{bashhub-3.0.2/bashhub.egg-info → bashhub-3.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bashhub
-Version: 3.0.2
+Version: 3.0.3
 Summary: Bashhub.com python client
 Author-email: Ryan Caloras <ryan@bashhub.com>
 License-Expression: Apache-2.0
@@ -24,9 +24,15 @@ Requires-Dist: inflection>=0.5.1
 Requires-Dist: humanize>=4.13.0
 Provides-Extra: test
 Requires-Dist: pytest>=3.3.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=3.3.1; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: types-python-dateutil; extra == "dev"
 Dynamic: license-file
 
-<img src="https://bashhub.com/assets/images/bashhub-logo.png" alt="Bashhub Logo">
+<img src="https://bashhub.com/static/web/images/bashhub-logo.png" alt="Bashhub Logo">
 
 Bashhub saves every terminal command entered across all sessions and systems and provides powerful querying across all commands.
 

{bashhub-3.0.2 → bashhub-3.0.3}/README.md

@@ -1,4 +1,4 @@
-<img src="https://bashhub.com/assets/images/bashhub-logo.png" alt="Bashhub Logo">
+<img src="https://bashhub.com/static/web/images/bashhub-logo.png" alt="Bashhub Logo">
 
 Bashhub saves every terminal command entered across all sessions and systems and provides powerful querying across all commands.
 

{bashhub-3.0.2 → bashhub-3.0.3}/bashhub/bashhub.py

@@ -1,29 +1,27 @@
 #!/usr/bin/python
-from time import *
+from __future__ import annotations
+
+import io
+import os
+import re
+import shutil
+import subprocess
+import sys
+from time import mktime
+
 import click
-import traceback
 import dateutil.parser
-import sys
-import os
-import io
+import requests
 
+from . import bashhub_globals, bashhub_setup, rest_client, shell_utils
+from .bashhub_globals import BH_FILTER, BH_HOME, write_to_config_file
 from .model import CommandForm
-from . import rest_client
-from . import bashhub_setup
-from . import bashhub_globals
-from .bashhub_globals import BH_FILTER, BH_HOME, BH_SAVE_COMMANDS
-from .bashhub_globals import write_to_config_file
 from .version import version_str
-import shutil
-import requests
-import subprocess
-from . import shell_utils
-import re
-from .view.status import *
+from .view.status import build_status_view
 
 
-
-def print_version(ctx, param, value):
+def print_version(ctx: click.Context, param: click.Parameter,
+                  value: bool) -> None:
     if not value or ctx.resilient_parsing:
         return
     click.echo(version_str)
@@ -42,13 +40,13 @@ CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
               help='Display version',
               expose_value=False,
               is_eager=True)
-def bashhub():
+def bashhub() -> None:
     """Bashhub command line client"""
     pass
 
 
 @bashhub.command()
-def version():
+def version() -> None:
     """Display version"""
     click.echo(version_str)
 
@@ -60,7 +58,7 @@ def version():
               default=False,
               is_flag=True,
               help="Turn off saving commands for all sessions.")
-def off(is_global):
+def off(is_global: bool) -> None:
     """Turn off saving commands to Bashhub. Applies for this current session."""
     if is_global:
         write_to_config_file('save_commands', 'False')
@@ -74,7 +72,7 @@ def off(is_global):
               "--local",
               help="Turn on saving commands for only this session.",
               is_flag=True)
-def on(local):
+def on(local: bool) -> None:
     """Turn on saving commands to Bashhub. Applies globally."""
     f = io.open(BH_HOME + '/script.bh', 'w+', encoding='utf-8')
 
@@ -91,22 +89,23 @@ def on(local):
 @click.argument('pid', type=int)
 @click.argument('process_start_time', type=int)
 @click.argument('exit_status', type=int)
-def save(command, path, pid, process_start_time, exit_status):
+def save(command: str, path: str, pid: int, process_start_time: int,
+         exit_status: int) -> None:
     """Save a command to Bashhub"""
     pid_start_time = unix_time_to_epoc_millis(process_start_time)
-    command = command.strip()
+    command_text = command.strip()
 
     # Check if we have commands saving turned on
     if not bashhub_globals.BH_SAVE_COMMANDS:
         return
 
     # Check if we should ignore this command.
-    if "#ignore" in command:
+    if "#ignore" in command_text:
         return
 
     # Check if we should filter this command.
     bh_filter = bashhub_globals.BH_FILTER
-    if bh_filter and re.findall(bh_filter, command):
+    if bh_filter and re.findall(bh_filter, command_text):
         return
 
     # Check that we have an auth token.
@@ -114,18 +113,18 @@ def save(command, path, pid, process_start_time, exit_status):
         print("No auth token found. Run 'bashhub setup' to login.")
         return
 
-    command = CommandForm(command, path, exit_status, pid, pid_start_time)
-    rest_client.save_command(command)
+    command_form = CommandForm(command_text, path, exit_status, pid, pid_start_time)
+    rest_client.save_command(command_form)
 
 
 @bashhub.command()
-def setup():
+def setup() -> None:
     """Run Bashhub user and system setup"""
     bashhub_setup.main()
 
 
 @bashhub.command()
-def status():
+def status() -> None:
     """Stats for this session and user"""
     # Get our user and session information from our context
     (ppid, start_time) = shell_utils.get_session_information()
@@ -136,9 +135,10 @@ def status():
 
 @bashhub.command()
 @click.pass_context
-def help(ctx):
+def help(ctx: click.Context) -> None:
     """Show this message and exit"""
-    click.echo(ctx.parent.get_help())
+    if ctx.parent is not None:
+        click.echo(ctx.parent.get_help())
 
 # Dynamic help text containing the BH_FILTER variable.
 filtered_text = "BH_FILTER={0}".format(
@@ -157,7 +157,7 @@ is configured via a regex exported as BH_FILTER.
               '--regex',
               default=BH_FILTER,
               help='Regex to filter against')
-def filter(command, regex):
+def filter(command: str, regex: str) -> None:
 
     # Check if the regex we receive is valid
     if not bashhub_globals.is_valid_regex(regex):
@@ -178,7 +178,7 @@ def filter(command, regex):
 
 @bashhub.command()
 @click.argument('version', type=str, default='')
-def update(version):
+def update(version: str) -> None:
     """Update your Bashhub installation"""
 
     if version != '':
@@ -201,40 +201,39 @@ def update(version):
 
 
 @bashhub.group()
-def util():
+def util() -> None:
     """Misc utils used by Bashhub"""
     pass
 
 
 @util.command()
-def update_system_info():
+def update_system_info() -> None:
     """Updates system info for Bashhub"""
     result = bashhub_setup.update_system_info()
     # Exit code based on if our update call was successful
-    sys.exit(0) if result != None else sys.exit(1)
+    sys.exit(0) if result is not None else sys.exit(1)
 
 
 @util.command()
 @click.argument('date_string', type=str)
-def parsedate(date_string):
+def parsedate(date_string: str) -> None:
     """date string to seconds since the unix epoch"""
     try:
         date = dateutil.parser.parse(date_string)
         unix_time = int(mktime(date.timetuple()))
         click.echo(unix_time)
-    except Exception as e:
+    except Exception:
         # Should really log an error here
         click.echo(0)
 
 
-def unix_time_to_epoc_millis(unix_time):
+def unix_time_to_epoc_millis(unix_time: int) -> int:
     return int(unix_time) * 1000
 
 
-def main():
+def main() -> None:
     try:
         bashhub()
     except Exception as e:
-        formatted = traceback.format_exc(e)
         click.echo("Oops, looks like an exception occured: " + str(e))
         sys.exit(1)

{bashhub-3.0.2 → bashhub-3.0.3}/bashhub/bashhub_globals.py

@@ -2,23 +2,25 @@
 This file should be used for declaring any global variables that need to be
 pulled in from environment variables or are just used across multiple files.
 """
+from __future__ import annotations
 
+import configparser
 import os
 import re
-import time
 import stat
+import time as _time
+from configparser import NoOptionError, NoSectionError
 
-import configparser
-from configparser import NoSectionError, NoOptionError
 
 # Current time in milleseconds to use across app.
-current_milli_time = lambda: int(round(time.time() * 1000))
+def current_milli_time() -> int:
+    return int(round(_time.time() * 1000))
 
 BH_HOME = '~/.bashhub' if 'HOME' not in list(os.environ.keys()) \
         else os.environ['HOME'] + '/.bashhub'
 
 
-def write_to_config_file(section, value):
+def write_to_config_file(section: str, value: str) -> bool:
     exists = os.path.exists(BH_HOME)
     file_path = BH_HOME + '/config'
     permissions = stat.S_IRUSR | stat.S_IWUSR
@@ -39,14 +41,14 @@ def write_to_config_file(section, value):
         return False
 
 
-def get_from_config(key, default=''):
+def get_from_config(key: str, default: str = '') -> str:
     try:
         config = configparser.ConfigParser()
         config.read(BH_HOME + '/config')
         return config.get('bashhub', key)
-    except NoSectionError as error:
+    except NoSectionError:
         return default
-    except NoOptionError as error:
+    except NoOptionError:
         return default
 
 # Optional environment variable to configure for development
@@ -58,6 +60,8 @@ BH_SAVE_COMMANDS = os.getenv('BH_SAVE_COMMANDS', \
 
 BH_SYSTEM_NAME = get_from_config("system_name")
 
+BH_MAC = get_from_config("mac")
+
 # Check if debug mode is enabled
 BH_DEBUG = os.getenv('BH_DEBUG', get_from_config("debug"))
 
@@ -65,18 +69,18 @@ BH_DEBUG = os.getenv('BH_DEBUG', get_from_config("debug"))
 # Get our token from the environment if one is present
 # otherwise retrieve it from our config. Needs to
 # be a function since we may change our token during setup
-def BH_AUTH():
+def BH_AUTH() -> str:
     return os.getenv('BH_ACCESS_TOKEN', get_from_config("access_token"))
 
 
-def is_valid_regex(regex):
+def is_valid_regex(regex: str) -> bool:
     try:
         re.compile(regex)
         return True
     except re.error:
         return False
 
-def get_bh_filter():
+def get_bh_filter() -> str:
     filter = os.getenv('BH_FILTER', get_from_config('filter'))
     return filter if is_valid_regex(filter) else '__invalid__'
 

{bashhub-3.0.2 → bashhub-3.0.3}/bashhub/bashhub_setup.py

@@ -1,26 +1,21 @@
 #!/usr/bin/python
-from time import *
-import jsonpickle
-import json
-import sys
-import requests
+from __future__ import annotations
+
 import getpass
+import socket
+import sys
 import traceback
 import uuid
-import stat
-import socket
+from typing import Callable
+
 from . import rest_client
-from .version import __version__
-from .model import *
 from .bashhub_globals import *
-import requests
-from requests import ConnectionError
-from requests import HTTPError
-import collections
-import configparser
+from .model import *
+from .validation import validate_email, validate_password, validate_username
+from .version import __version__
 
 
-def query_yes_no(question, default="yes"):
+def query_yes_no(question: str, default: str = "yes") -> bool:
     """Ask a yes/no question via input() and return their answer.
 
     "question" is a string that is presented to the user.
@@ -31,7 +26,7 @@ def query_yes_no(question, default="yes"):
     The "answer" return value is one of "yes" or "no".
     """
     valid = {"yes": True, "y": True, "ye": True, "no": False, "n": False}
-    if default == None:
+    if default is None:
         prompt = " [y/n] "
     elif default == "yes":
         prompt = " [Y/n] "
@@ -52,10 +47,39 @@ def query_yes_no(question, default="yes"):
                              "(or 'y' or 'n').\n")
 
 
-def get_new_user_information():
-    email = input("What's your email? ")
-    username = input("What username would you like? ")
-    password = getpass.getpass("What password? ")
+def prompt_until_valid(
+    prompt: str,
+    validator: Callable[[str], str | None],
+    secret: bool = False,
+) -> str:
+    """Prompt the user until validator() returns None. Re-prompts with the
+    error message on failure."""
+    while True:
+        value = getpass.getpass(prompt) if secret else input(prompt)
+        error = validator(value)
+        if error is None:
+            return value
+        print(error)
+
+
+def prompt_password_with_confirmation() -> str:
+    """Prompt for a password, validate it, then require a matching
+    confirmation. Re-prompts from the start if the confirmation doesn't
+    match."""
+    while True:
+        password = prompt_until_valid(
+            "What password? ", validate_password, secret=True)
+        confirm = getpass.getpass("Confirm password: ")
+        if password == confirm:
+            return password
+        print("Passwords did not match. Please try again.")
+
+
+def get_new_user_information() -> RegisterUser:
+    email = prompt_until_valid("What's your email? ", validate_email)
+    username = prompt_until_valid(
+        "What username would you like? ", validate_username)
+    password = prompt_password_with_confirmation()
     print("\nEmail: " + email + " Username: " + username)
     all_good = query_yes_no("Are these correct?")
 
@@ -65,59 +89,121 @@ def get_new_user_information():
         return get_new_user_information()
 
 
-def get_user_information_and_login(username=None, password=None, attempts=0):
+def get_user_information_and_login(
+    username: str | None = None,
+    password: str | None = None,
+    attempts: int = 0,
+) -> tuple[str | None, str | None, str | None]:
     if attempts == 4:
         print("Too many bad attempts.")
-        return None
+        return (None, None, None)
 
     # Only collect user information if we don't already have it
     # i.e. if we didn't just register a new user.
-    if username == None and password == None:
+    if username is None and password is None:
         print("Please enter your bashhub credentials")
         username = input("Username: ")
         password = getpass.getpass("Password: ")
 
     # login once we have all of our information
+    if username is None or password is None:
+        return (None, None, None)
     access_token = rest_client.login_user(LoginForm(username, password))
 
     # Package our result to include our credentials to later login our system.
     if access_token:
-        result = (username, password, access_token)
-    else:
-        result = get_user_information_and_login(attempts=attempts + 1) or (
-            None, None, None)
-
-    return result
-
+        return (username, password, access_token)
+    return get_user_information_and_login(attempts=attempts + 1) or (
+        None, None, None)
+
+
+def get_mac_address() -> str:
+    """Get the mac address for our system as a fingerprint.
+
+    The mac is our stable, opaque identifier for a machine — the
+    server keys systems on ``(user, mac)``. To avoid drift between
+    runs (multi-interface boxes, VPN/Docker churn, random-mac
+    fallbacks), we prefer a value that we've previously agreed on
+    with the server and persisted in ``~/.bashhub/config``.
+
+    Resolution order:
+      1. ``mac`` from the config file, if present. This is the
+         source of truth once we've successfully registered or
+         reconciled with the server.
+      2. ``uuid.getnode()`` — today's behavior, used only on the
+         very first run before anything has been written to config.
+      3. Hostname, if ``getnode()`` synthesized a random multicast
+         value (indicating it couldn't find any hardware MAC).
+
+    Note: we do *not* persist the computed value here. Persisting
+    happens only after the server confirms the value (on successful
+    register / PATCH / name-fallback resolve), so a transient bad
+    value never gets pinned into config.
+    """
 
-def get_mac_address():
-    """Get the mac address for our system as a fingerprint. If we can't
-    get the mac, use the hash of our hostname as a subtitute"""
+    cached = get_from_config("mac")
+    if cached:
+        return cached
 
-    mac = uuid.getnode()
+    mac_int = uuid.getnode()
     # check if getnode fails
-    if (mac >> 40) & 1:
+    if (mac_int >> 40) & 1:
         hostname = socket.gethostname()
         print("warning: cannot find MAC. Using hostname (%s) to identify system" % hostname)
-        mac = hostname
-    else:
-        mac = str(mac)
-    return mac
+        return hostname
+    return str(mac_int)
 
 
-# Update our hostname incase it changed.
-def update_system_info():
+# Update our hostname in case it changed, and opportunistically pin
+# the mac into local config / reconcile server-side if it drifted.
+def update_system_info() -> int | None:
     mac = get_mac_address()
     hostname = socket.gethostname()
     patch = SystemPatch(hostname=hostname, client_version=__version__)
-    return rest_client.patch_system(patch, mac)
+    result = rest_client.patch_system(patch, mac)
+
+    if result is not None:
+        # Happy path. Pin mac into config if it wasn't already there
+        # so future runs are immune to uuid.getnode() drift.
+        if not get_from_config("mac"):
+            write_to_config_file("mac", mac)
+        return result
+
+    # PATCH failed. If we have a stored system_name, try to self-heal
+    # by looking the system up by name and rewriting its mac on the
+    # server to match the one we just computed. This covers the
+    # common `bashhub update` scenario where uuid.getnode() returned
+    # a different value than what was originally registered.
+    system_name = get_from_config("system_name")
+    if not system_name:
+        return None
+
+    system = rest_client.get_system_information(name=system_name)
+    if system is None:
+        return None
+
+    reconcile = SystemPatch(
+        mac=mac, hostname=hostname, client_version=__version__)
+    reconciled = rest_client.patch_system(reconcile, system.mac)
+    if reconciled is not None:
+        write_to_config_file("mac", mac)
+    return reconciled
 
 
-def handle_system_information(username, password, attempts=0):
+def handle_system_information(
+    username: str,
+    password: str,
+    attempts: int = 0,
+) -> tuple[str | None, str | None]:
 
     mac = get_mac_address()
-    system = rest_client.get_system_information(mac)
-    system_name = None
+    # Pass both mac and the previously-stored system_name (if any) so
+    # the server's mac->name fallback can recognize this box in one
+    # round-trip when the mac has drifted since last registration.
+    stored_system_name = get_from_config("system_name") or None
+    system = rest_client.get_system_information(
+        mac=mac, name=stored_system_name)
+    system_name: str | None = None
     # Register a new System if this one isn't recognized
     if system is None:
         hostname = socket.gethostname()
@@ -130,9 +216,12 @@ def handle_system_information(username, password, attempts=0):
             name, mac, hostname, __version__))
         if system_name:
             print("Registered a new system " + name)
+            # Pin the mac we just registered into local config so
+            # future runs read it back instead of recomputing.
+            write_to_config_file("mac", mac)
         else:
             if attempts < 3:
-                print("Looks like registering your system failed. Lets retry.")
+                print("Looks like registering your system failed. Let's retry.")
                 return handle_system_information(username, password, attempts + 1)
             else:
                 return (None, None)
@@ -149,11 +238,21 @@ def handle_system_information(username, password, attempts=0):
         system_name = system.name
         print("Welcome back! Looks like this box is already registered as " +
               system.name + ".")
+        # The server may have matched by name rather than mac (the
+        # "drifted" case). If so, PATCH the server's mac to the
+        # current client value so both sides converge. Either way,
+        # pin the mac we agreed on into config.
+        if system.mac != mac:
+            hostname = socket.gethostname()
+            reconcile = SystemPatch(
+                mac=mac, hostname=hostname, client_version=__version__)
+            rest_client.patch_system(reconcile, system.mac)
+        write_to_config_file("mac", mac)
 
     return (access_token, system_name)
 
 
-def main():
+def main() -> None:
     try:
 
         ascii_art = r"""
@@ -171,9 +270,9 @@ def main():
         is_new_user = query_yes_no("Are you a new user?")
 
         # Initialize variaous Credentials for logging in.
-        username = None
-        password = None
-        access_token = None
+        username: str | None = None
+        password: str | None = None
+        access_token: str | None = None
 
         # If this is a new user walk them through the registration flow
         if is_new_user:
@@ -193,7 +292,7 @@ def main():
 
         (username, password, access_token) = get_user_information_and_login(
             username, password)
-        if access_token == None:
+        if access_token is None:
             print("\nSorry looks like logging in failed.")
             print("If you forgot your password please reset it. "
                   "https://bashhub.com/password-reset")
@@ -208,11 +307,14 @@ def main():
             print("Writing your config file failed.")
             sys.exit(1)
 
+        if username is None or password is None:
+            print("Sorry looks like getting your credentials failed. Exiting...")
+            sys.exit(1)
         (access_token, system_name) = handle_system_information(username,
                                                                 password)
 
-        if access_token == None:
-            print("Sorry looks like getting your info failed.\
+        if access_token is None or system_name is None:
+            print("Sorry looks like getting your access_token or system_name failed.\
                     Exiting...")
             sys.exit(0)