__init__.py 13.8 KB
Newer Older
1
# Copyright 2012-2013 GRNET S.A. All rights reserved.
2
3
4
5
6
7
#
# 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
8
9
#      copyright notice, this list of conditions and the following
#      disclaimer.
10
11
#
#   2. Redistributions in binary form must reproduce the above
12
13
14
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#
# 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
32
# or implied, of GRNET S.A.command
33
34

import logging
35
from sys import argv, exit, stdout
36
from os.path import basename
37
from inspect import getargspec
38

39
from kamaki.cli.argument import ArgumentParseManager
40
from kamaki.cli.history import History
41
42
from kamaki.cli.utils import print_dict, print_list, red, magenta, yellow
from kamaki.cli.errors import CLIError
43

44
45
46
47
_help = False
_debug = False
_verbose = False
_colors = False
Stavros Sachtouris's avatar
Stavros Sachtouris committed
48
kloger = None
49
50


51
def _construct_command_syntax(cls):
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
        spec = getargspec(cls.main.im_func)
        args = spec.args[1:]
        n = len(args) - len(spec.defaults or ())
        required = ' '.join('<%s>' % x\
            .replace('____', '[:')\
            .replace('___', ':')\
            .replace('__', ']').\
            replace('_', ' ') for x in args[:n])
        optional = ' '.join('[%s]' % x\
            .replace('____', '[:')\
            .replace('___', ':')\
            .replace('__', ']').\
            replace('_', ' ') for x in args[n:])
        cls.syntax = ' '.join(x for x in [required, optional] if x)
        if spec.varargs:
            cls.syntax += ' <%s ...>' % spec.varargs


70
71
72
73
74
def _get_cmd_tree_from_spec(spec, cmd_tree_list):
    for tree in cmd_tree_list:
        if tree.name == spec:
            return tree
    return None
75

76

77
_best_match = []
78

79

80
81
def _num_of_matching_terms(basic_list, attack_list):
    if not attack_list:
82
        return len(basic_list)
83

84
85
86
87
88
89
90
91
92
    matching_terms = 0
    for i, term in enumerate(basic_list):
        try:
            if term != attack_list[i]:
                break
        except IndexError:
            break
        matching_terms += 1
    return matching_terms
93

94

95
96
97
98
99
def _update_best_match(name_terms, prefix=[]):
    if prefix:
        pref_list = prefix if isinstance(prefix, list) else prefix.split('_')
    else:
        pref_list = []
100

101
102
    num_of_matching_terms = _num_of_matching_terms(name_terms, pref_list)
    global _best_match
103
104
    if not prefix:
        _best_match = []
105

106
107
108
109
110
111
112
113
114
    if num_of_matching_terms and len(_best_match) <= num_of_matching_terms:
        if len(_best_match) < num_of_matching_terms:
            _best_match = name_terms[:num_of_matching_terms]
        return True
    return False


def command(cmd_tree, prefix='', descedants_depth=1):
    """Load a class as a command
115
116
117
        e.g. spec_cmd0_cmd1 will be command spec cmd0

        :param cmd_tree: is initialized in cmd_spec file and is the structure
118
            where commands are loaded. Var name should be _commands
119
120
        :param prefix: if given, load only commands prefixed with prefix,
        :param descedants_depth: is the depth of the tree descedants of the
121
122
            prefix command. It is used ONLY if prefix and if prefix is not
            a terminal command
123
124

        :returns: the specified class object
125
126
127
    """

    def wrap(cls):
128
        global kloger
129
130
131
132
        cls_name = cls.__name__

        if not cmd_tree:
            if _debug:
133
                kloger.warning('command %s found but not loaded' % cls_name)
134
            return cls
135

136
137
        name_terms = cls_name.split('_')
        if not _update_best_match(name_terms, prefix):
138
            if _debug:
139
                kloger.warning('%s failed to update_best_match' % cls_name)
140
            return None
141

142
143
144
145
146
147
        global _best_match
        max_len = len(_best_match) + descedants_depth
        if len(name_terms) > max_len:
            partial = '_'.join(name_terms[:max_len])
            if not cmd_tree.has_command(partial):  # add partial path
                cmd_tree.add_command(partial)
148
            if _debug:
149
                kloger.warning('%s failed max_len test' % cls_name)
150
            return None
151

152
153
154
        cls.description, sep, cls.long_description\
        = cls.__doc__.partition('\n')
        _construct_command_syntax(cls)
155

156
157
158
        cmd_tree.add_command(cls_name, cls.description, cls)
        return cls
    return wrap
159

160

161
162
163
164
165
166
167
168
169
170
171
def get_cmd_terms():
    global command
    return [term for term in command.func_defaults[0]\
        if not term.startswith('-')]

cmd_spec_locations = [
    'kamaki.cli.commands',
    'kamaki.commands',
    'kamaki.cli',
    'kamaki',
    '']
172

173

174
def _setup_logging(silent=False, debug=False, verbose=False, include=False):
175
176
177
178
179
180
181
182
183
184
185
186
    """handle logging for clients package"""

    def add_handler(name, level, prefix=''):
        h = logging.StreamHandler()
        fmt = logging.Formatter(prefix + '%(message)s')
        h.setFormatter(fmt)
        logger = logging.getLogger(name)
        logger.addHandler(h)
        logger.setLevel(level)

    if silent:
        add_handler('', logging.CRITICAL)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
187
188
189
        return

    if debug:
190
191
192
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.DEBUG, prefix='> ')
        add_handler('clients.recv', logging.DEBUG, prefix='< ')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
193
        add_handler('kamaki', logging.DEBUG, prefix='DEBUG: ')
194
195
196
197
    elif verbose:
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.INFO, prefix='> ')
        add_handler('clients.recv', logging.INFO, prefix='< ')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
198
        add_handler('kamaki', logging.INFO, prefix='INFO: ')
199
200
    elif include:
        add_handler('clients.recv', logging.INFO)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
201
202
203
    add_handler('kamaki', logging.WARNING, prefix='WARNING: ')
    global kloger
    kloger = logging.getLogger('kamaki.warning')
204

205

206
207
208
209
210
211
212
213
214
def _init_session(arguments):
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
    global _verbose
    _verbose = arguments['verbose'].value
    global _colors
    _colors = arguments['config'].get('global', 'colors')
215
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
216
217
        from kamaki.cli.utils import remove_colors
        remove_colors()
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
    _silent = arguments['silent'].value
    _include = arguments['include'].value
    _setup_logging(_silent, _debug, _verbose, _include)


def get_command_group(unparsed, arguments):
    groups = arguments['config'].get_groups()
    for term in unparsed:
        if term.startswith('-'):
            continue
        if term in groups:
            unparsed.remove(term)
            return term
        return None
    return None


def _load_spec_module(spec, arguments, module):
    spec_name = arguments['config'].get(spec, 'cli')
    if spec_name is None:
        return None
    pkg = None
    for location in cmd_spec_locations:
        location += spec_name if location == '' else '.%s' % spec_name
        try:
            pkg = __import__(location, fromlist=[module])
            return pkg
        except ImportError:
            continue
    return pkg


def _groups_help(arguments):
    global _debug
Stavros Sachtouris's avatar
Stavros Sachtouris committed
252
    global kloger
253
254
255
256
257
258
259
260
261
262
263
264
    descriptions = {}
    for spec in arguments['config'].get_groups():
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
            cmds = None
            try:
                cmds = [
                    cmd for cmd in getattr(pkg, '_commands')\
                    if arguments['config'].get(cmd.name, 'cli')
                ]
            except AttributeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
265
                    kloger.warning('No description for %s' % spec)
266
267
268
269
270
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
271
                    kloger.warning('no cmd specs in module %s' % spec)
272
        elif _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
273
            kloger.warning('Loading of %s cmd spec failed' % spec)
274
275
276
277
278
279
280
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


def _print_subcommands_help(cmd):
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
281
282
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
283
284
285
286
287
288
289
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


def _update_parser_help(parser, cmd):
    global _best_match
290
291
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
292
293
294

    if cmd.is_command:
        cls = cmd.get_class()
295
296
297
298
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
        # arguments = cls().arguments
        # update_arguments(parser, arguments)
299
    else:
300
        parser.syntax += ' <...>'
301
    if cmd.has_description:
302
        parser.parser.description = cmd.help
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326


def _print_error_message(cli_err):
    errmsg = '%s' % cli_err
    if cli_err.importance == 1:
        errmsg = magenta(errmsg)
    elif cli_err.importance == 2:
        errmsg = yellow(errmsg)
    elif cli_err.importance > 2:
        errmsg = red(errmsg)
    stdout.write(errmsg)
    print_list(cli_err.details)


def _get_best_match_from_cmd_tree(cmd_tree, unparsed):
    matched = [term for term in unparsed if not term.startswith('-')]
    while matched:
        try:
            return cmd_tree.get_command('_'.join(matched))
        except KeyError:
            matched = matched[:-1]
    return None


327
def _exec_cmd(instance, cmd_args, help_method):
328
329
330
331
332
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
333
334
335
            if _debug:
                raise err
            if _verbose:
336
337
338
339
340
341
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

342

343
344
345
346
347
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
348
349
    global command
    def_params = list(command.func_defaults)
350
    def_params[0] = parameters
351
352
353
    command.func_defaults = tuple(def_params)


354
355
356
#def one_cmd(parser, unparsed, arguments):
def one_cmd(parser):
    group = get_command_group(list(parser.unparsed), parser.arguments)
357
    if not group:
358
359
        parser.parser.print_help()
        _groups_help(parser.arguments)
360
361
        exit(0)

362
363
364
    nonargs = [term for term in parser.unparsed if not term.startswith('-')]
    set_command_params(nonargs)

365
366
367
    global _best_match
    _best_match = []

368
    spec_module = _load_spec_module(group, parser.arguments, '_commands')
369
370
371
372
373
374

    cmd_tree = _get_cmd_tree_from_spec(group, spec_module._commands)

    if _best_match:
        cmd = cmd_tree.get_command('_'.join(_best_match))
    else:
375
        cmd = _get_best_match_from_cmd_tree(cmd_tree, parser.unparsed)
376
377
378
379
        _best_match = cmd.path.split('_')
    if cmd is None:
        if _debug or _verbose:
            print('Unexpected error: failed to load command')
380
381
        exit(1)

382
383
384
    _update_parser_help(parser, cmd)

    if _help or not cmd.is_command:
385
        parser.parser.print_help()
386
387
388
389
        _print_subcommands_help(cmd)
        exit(0)

    cls = cmd.get_class()
390
391
392
    executable = cls(parser.arguments)
    parser.update_arguments(executable.arguments)
    #parsed, unparsed = parse_known_args(parser, executable.arguments)
393
    for term in _best_match:
394
395
        parser.unparsed.remove(term)
    _exec_cmd(executable, parser.unparsed, parser.parser.print_help)
396
397


Stavros Sachtouris's avatar
Stavros Sachtouris committed
398
def _load_all_commands(cmd_tree, arguments):
399
    _config = arguments['config']
400
    for spec in [spec for spec in _config.get_groups()\
401
            if _config.get(spec, 'cli')]:
402
403
404
405
406
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
407
408
                global kloger
                kloger.warning('No valid description for %s' % spec)
409
410
411
            continue
        for spec_tree in spec_commands:
            if spec_tree.name == spec:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
412
                cmd_tree.add_tree(spec_tree)
413
                break
Stavros Sachtouris's avatar
Stavros Sachtouris committed
414
415


416
def run_shell(exe_string, parser):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
417
    from command_shell import _init_shell
418
419
420
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
    shell.run(parser)
421

422
423

def main():
424
425
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
426
        parser = ArgumentParseManager(exe)
427

428
        if parser.arguments['version'].value:
429
430
            exit(0)

431
        _init_session(parser.arguments)
432

433
        if parser.unparsed:
434
435
            _history = History(
                parser.arguments['config'].get('history', 'file'))
436
            _history.add(' '.join([exe] + argv[1:]))
437
            one_cmd(parser)
438
        elif _help:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
439
            parser.parser.print_help()
440
            _groups_help(parser.arguments)
441
        else:
442
            run_shell(exe, parser)
443
    except CLIError as err:
444
        _print_error_message(err)
445
446
447
        if _debug:
            raise err
        exit(1)
448
449
    except Exception as er:
        print('Unknown Error: %s' % er)
450
        if _debug:
451
452
            raise
        exit(1)