catcli/catcli/utils.py

"""
author: deadc0de6 (https://github.com/deadc0de6)
Copyright (c) 2017, deadc0de6

helpers
"""

import os
import hashlib
import tempfile
import subprocess
import datetime

# local imports
from catcli import nodes
from catcli.exceptions import CatcliException


WILD = '*'


def path_to_top(path: str) -> str:
    """path pivot under top"""
    pre = f'{os.path.sep}{nodes.NAME_TOP}'
    if not path.startswith(pre):
        # prepend with top node path
        path = pre + path
    return path


def path_to_search_all(path: str) -> str:
    """path to search for all subs"""
    if not path:
        path = os.path.sep
    if not path.startswith(os.path.sep):
        path = os.path.sep + path
    pre = f'{os.path.sep}{nodes.NAME_TOP}'
    if not path.startswith(pre):
        # prepend with top node path
        path = pre + path
    if not path.endswith(os.path.sep):
        # ensure ends with a separator
        path += os.path.sep
    # if not path.endswith(WILD):
    #     # add wild card
    #     path += WILD
    return path


def md5sum(path: str) -> str:
    """
    calculate md5 sum of a file
    may raise exception
    """
    rpath = os.path.realpath(path)
    if not os.path.exists(rpath):
        raise CatcliException(f'md5sum - file does not exist: {rpath}')
    try:
        with open(rpath, mode='rb') as file:
            hashv = hashlib.md5()
            while True:
                buf = file.read(4096)
                if not buf:
                    break
                hashv.update(buf)
            return hashv.hexdigest()
    except PermissionError:
        pass
    except OSError as exc:
        raise CatcliException(f'md5sum error: {exc}') from exc
    return ''


def size_to_str(size: float,
                raw: bool = True) -> str:
    """convert size to string, optionally human readable"""
    div = 1024.
    suf = ['B', 'K', 'M', 'G', 'T', 'P']
    if raw or size < div:
        return f'{size}'
    for i in suf:
        if size < div:
            return f'{size:.1f}{i}'
        size = size / div
    sufix = suf[-1]
    return f'{size:.1f}{sufix}'


def epoch_to_str(epoch: float) -> str:
    """convert epoch to string"""
    if not epoch:
        return ''
    fmt = '%Y-%m-%d %H:%M:%S'
    timestamp = datetime.datetime.fromtimestamp(epoch)
    return timestamp.strftime(fmt)


def ask(question: str) -> bool:
    """ask the user what to do"""
    resp = input(f'{question} [y|N] ? ')
    return resp.lower() == 'y'


def edit(string: str) -> str:
    """edit the information with the default EDITOR"""
    data = string.encode('utf-8')
    editor = os.environ.get('EDITOR', 'vim')
    with tempfile.NamedTemporaryFile(prefix='catcli', suffix='.tmp') as file:
        file.write(data)
        file.flush()
        subprocess.call([editor, file.name])
        file.seek(0)
        new = file.read()
    return new.decode('utf-8')


def fix_badchars(string: str) -> str:
    """fix none utf-8 chars in string"""
    return string.encode('utf-8', 'ignore').decode('utf-8')