Synnefo » ./kamaki

# Copyright 2011-2013 GRNET S.A. All rights reserved.

#

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

#

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

#

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

#

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

#

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

from sys import stdout, stdin

from re import compile as regex_compile

from time import sleep

from os import walk, path

from json import dumps

from kamaki.cli.errors import raiseCLIError

INDENT_TAB = 4

suggest = dict(ansicolors=dict(

        active=False,

        url='#install-ansicolors-progress',

        description='Add colors to console responses'))

try:

    from colors import magenta, red, yellow, bold

except ImportError:

    def dummy(val):

        return val

    red = yellow = magenta = bold = dummy

    suggest['ansicolors']['active'] = True

def _print(w):

    """Print wrapper is used to help unittests check what is printed"""

    print w

def _write(w):

    """stdout.write wrapper is used to help unittests check what is printed"""

    stdout.write(w)

def _flush():

    """stdout.flush wrapper is used to help unittests check what is called"""

    stdout.flush()

def _readline():

    """stdout.readline wrapper is used to help unittests"""

    return stdout.readline()

def suggest_missing(miss=None, exclude=[]):

    global suggest

    sgs = dict(suggest)

    for exc in exclude:

        try:

            sgs.pop(exc)

        except KeyError:

            pass

    kamaki_docs = 'http://www.synnefo.org/docs/kamaki/latest'

    for k, v in (miss, sgs[miss]) if miss else sgs.items():

        if v['active'] and stdout.isatty():

            print('Suggestion: for better user experience install %s' % k)

            print('\t%s' % v['description'])

            print('\tIt is easy, here are the instructions:')

            print('\t%s/installation.html%s' % (kamaki_docs, v['url']))

            print('')

def guess_mime_type(

        filename,

        default_content_type='application/octet-stream',

        default_encoding=None):

    assert filename, 'Cannot guess mimetype for empty filename'

    try:

        from mimetypes import guess_type

        ctype, cenc = guess_type(filename)

        return ctype or default_content_type, cenc or default_encoding

    except ImportError:

        print 'WARNING: Cannot import mimetypes, using defaults'

        return (default_content_type, default_encoding)

def remove_colors():

    global bold

    global red

    global yellow

    global magenta

    def dummy(val):

        return val

    red = yellow = magenta = bold = dummy

def pretty_keys(d, delim='_', recursive=False):

    """<term>delim<term> to <term> <term> transformation"""

    new_d = dict(d)

    for k, v in d.items():

        new_v = new_d.pop(k)

        new_d[k.replace(delim, ' ').strip()] = pretty_keys(

            new_v, delim, True) if (

                recursive and isinstance(v, dict)) else new_v

    return new_d

def print_json(data):

    """Print a list or dict as json in console

    :param data: json-dumpable data

    """

    _print(dumps(data, indent=INDENT_TAB))

def pretty_dict(d, *args, **kwargs):

    print_dict(pretty_keys(d, *args, **kwargs))

def print_dict(

        d,

        exclude=(), indent=0,

        with_enumeration=False, recursive_enumeration=False):

    """Pretty-print a dictionary object

    <indent>key: <non iterable item>

    <indent>key:

    <indent + INDENT_TAB><pretty-print iterable>

    :param d: (dict)

    :param exclude: (iterable of strings) keys to exclude from printing

    :param indent: (int) initial indentation (recursive)

    :param with_enumeration: (bool) enumerate 1st-level keys

    :param recursive_enumeration: (bool) recursively enumerate iterables (does

        not enumerate 1st level keys)

    :raises CLIError: if preconditions fail

    """

    assert isinstance(d, dict), 'print_dict input must be a dict'

    assert indent >= 0, 'print_dict indent must be >= 0'

    for i, (k, v) in enumerate(d.items()):

        k = ('%s' % k).strip()

        if k in exclude:

            continue

        print_str = ' ' * indent

        print_str += '%s.' % (i + 1) if with_enumeration else ''

        print_str += '%s:' % k

        if isinstance(v, dict):

            _print(print_str)

            print_dict(

                v, exclude, indent + INDENT_TAB,

                recursive_enumeration, recursive_enumeration)

        elif isinstance(v, list) or isinstance(v, tuple):

            _print(print_str)

            print_list(

                v, exclude, indent + INDENT_TAB,

                recursive_enumeration, recursive_enumeration)

        else:

            _print('%s %s' % (print_str, v))

def print_list(

        l,

        exclude=(), indent=0,

        with_enumeration=False, recursive_enumeration=False):

    """Pretty-print a list of items

    <indent>key: <non iterable item>

    <indent>key:

    <indent + INDENT_TAB><pretty-print iterable>

    :param l: (list)

    :param exclude: (iterable of strings) items to exclude from printing

    :param indent: (int) initial indentation (recursive)

    :param with_enumeration: (bool) enumerate 1st-level items

    :param recursive_enumeration: (bool) recursively enumerate iterables (does

        not enumerate 1st level keys)

    :raises CLIError: if preconditions fail

    """

    assert isinstance(l, list) or isinstance(l, tuple), (

        'print_list prinbts a list or tuple')

    assert indent >= 0, 'print_list indent must be >= 0'

    for i, item in enumerate(l):

        print_str = ' ' * indent

        print_str += '%s.' % (i + 1) if with_enumeration else ''

        if isinstance(item, dict):

            if with_enumeration:

                _print(print_str)

            elif i and i < len(l):

                _print('')

            print_dict(

                item, exclude,

                indent + (INDENT_TAB if with_enumeration else 0),

                recursive_enumeration, recursive_enumeration)

        elif isinstance(item, list) or isinstance(item, tuple):

            if with_enumeration:

                _print(print_str)

            elif i and i < len(l):

                _print()

            print_list(

                item, exclude, indent + INDENT_TAB,

                recursive_enumeration, recursive_enumeration)

        else:

            item = ('%s' % item).strip()

            if item in exclude:

                continue

            _print('%s%s' % (print_str, item))

def page_hold(index, limit, maxlen):

    """Check if there are results to show, and hold the page when needed

    :param index: (int) > 0, index of current element

    :param limit: (int) 0 < limit <= max, page hold if limit mod index == 0

    :param maxlen: (int) Don't hold if index reaches maxlen

    :returns: True if there are more to show, False if all results are shown

    """

    if index >= maxlen:

        return False

    if index and index % limit == 0:

        raw_input('(%s listed - %s more - "enter" to continue)' % (

            index, maxlen - index))

    return True

def print_items(

        items, title=('id', 'name'),

        with_enumeration=False, with_redundancy=False,

        page_size=0):

    """print dict or list items in a list, using some values as title

    Objects of next level don't inherit enumeration (default: off) or titles

    :param items: (list) items are lists or dict

    :param title: (tuple) keys to use their values as title

    :param with_enumeration: (boolean) enumerate items (order id on title)

    :param with_redundancy: (boolean) values in title also appear on body

    :param page_size: (int) show results in pages of page_size items, enter to

        continue

    """

    if not items:

        return

    if not (isinstance(items, dict) or isinstance(items, list) or isinstance(

                items, tuple)):

        _print('%s' % items)

        return

    page_size = int(page_size)

    try:

        page_size = page_size if page_size > 0 else len(items)

    except:

        page_size = len(items)

    num_of_pages = len(items) // page_size

    num_of_pages += 1 if len(items) % page_size else 0

    for i, item in enumerate(items):

        if with_enumeration:

            _write('%s. ' % (i + 1))

        if isinstance(item, dict):

            item = dict(item)

            title = sorted(set(title).intersection(item))

            pick = item.get if with_redundancy else item.pop

            header = ' '.join('%s' % pick(key) for key in title)

            _print(bold(header))

            print_dict(item, indent=INDENT_TAB)

        elif isinstance(item, list) or isinstance(item, tuple):

            print_list(item, indent=INDENT_TAB)

        else:

            _print(' %s' % item)

        page_hold(i + 1, page_size, len(items))

def format_size(size, decimal_factors=False):

    units = ('B', 'KB', 'MB', 'GB', 'TB') if decimal_factors else (

        'B', 'KiB', 'MiB', 'GiB', 'TiB')

    step = 1000 if decimal_factors else 1024

    fstep = float(step)

    try:

        size = float(size)

    except (ValueError, TypeError) as err:

        raiseCLIError(err, 'Cannot format %s in bytes' % (

            ','.join(size) if isinstance(size, tuple) else size))

    for i, unit in enumerate(units):

        if size < step or i + 1 == len(units):

            break

        size /= fstep

    s = ('%.2f' % size)

    s = s.replace('%s' % step, '%s.99' % (step - 1)) if size <= fstep else s

    while '.' in s and s[-1] in ('0', '.'):

        s = s[:-1]

    return s + unit

def to_bytes(size, format):

    """

    :param size: (float) the size in the given format

    :param format: (case insensitive) KiB, KB, MiB, MB, GiB, GB, TiB, TB

    :returns: (int) the size in bytes

    :raises ValueError: if invalid size or format

    :raises AttributeError: if format is not str

    :raises TypeError: if size is not arithmetic or convertible to arithmetic

    """

    format = format.upper()

    if format == 'B':

        return int(size)

    size = float(size)

    units_dc = ('KB', 'MB', 'GB', 'TB')

    units_bi = ('KIB', 'MIB', 'GIB', 'TIB')

    factor = 1024 if format in units_bi else 1000 if format in units_dc else 0

    if not factor:

        raise ValueError('Invalid data size format %s' % format)

    for prefix in ('K', 'M', 'G', 'T'):

        size *= factor

        if format.startswith(prefix):

            break

    return int(size)

def dict2file(d, f, depth=0):

    for k, v in d.items():

        f.write('%s%s: ' % (' ' * INDENT_TAB * depth, k))

        if isinstance(v, dict):

            f.write('\n')

            dict2file(v, f, depth + 1)

        elif isinstance(v, list) or isinstance(v, tuple):

            f.write('\n')

            list2file(v, f, depth + 1)

        else:

            f.write('%s\n' % v)

def list2file(l, f, depth=1):

    for item in l:

        if isinstance(item, dict):

            dict2file(item, f, depth + 1)

        elif isinstance(item, list) or isinstance(item, tuple):

            list2file(item, f, depth + 1)

        else:

            f.write('%s%s\n' % (' ' * INDENT_TAB * depth, item))

# Split input auxiliary

def _parse_with_regex(line, regex):

    re_parser = regex_compile(regex)

    return (re_parser.split(line), re_parser.findall(line))

def _get_from_parsed(parsed_str):

    try:

        parsed_str = parsed_str.strip()

    except:

        return None

    return ([parsed_str[1:-1]] if (

        parsed_str[0] == parsed_str[-1] and parsed_str[0] in ("'", '"')) else (

            parsed_str.split(' '))) if parsed_str else None

def split_input(line):

    if not line:

        return []

    reg_expr = '\'.*?\'|".*?"|^[\S]*$'

    (trivial_parts, interesting_parts) = _parse_with_regex(line, reg_expr)

    assert(len(trivial_parts) == 1 + len(interesting_parts))

    terms = []

    for i, tpart in enumerate(trivial_parts):

        part = _get_from_parsed(tpart)

        if part:

            terms += part

        try:

            part = _get_from_parsed(interesting_parts[i])

        except IndexError:

            break

        if part:

            terms += part

    return terms

def ask_user(msg, true_resp=('y', )):

    """Print msg and read user response

    :param true_resp: (tuple of chars)

    :returns: (bool) True if reponse in true responses, False otherwise

    """

    _write('%s [%s/N]: ' % (msg, ', '.join(true_resp)))

    _flush()

    user_response = _readline()

    return user_response[0].lower() in true_resp

def spiner(size=None):

    spins = ('/', '-', '\\', '|')

    _write(' ')

    size = size or -1

    i = 0

    while size - i:

        _write('\b%s' % spins[i % len(spins)])

        _flush()

        i += 1

        sleep(0.1)

        yield

    yield

def get_path_size(testpath):

    if path.isfile(testpath):

        return path.getsize(testpath)

    total_size = 0

    for top, dirs, files in walk(path.abspath(testpath)):

        for f in files:

            f = path.join(top, f)

            if path.isfile(f):

                total_size += path.getsize(f)

    return total_size

def remove_from_items(list_of_dicts, key_to_remove):

    for item in list_of_dicts:

        assert isinstance(item, dict), 'Item %s not a dict' % item

        item.pop(key_to_remove, None)