command_shell.py 10 KB
Newer Older
1
2
3
4
5
6
7
# Copyright 2012 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
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
32
33
34
35
#
# 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 cmd import Cmd
from os import popen
36
from sys import stdout
37
from argparse import ArgumentParser
Stavros Sachtouris's avatar
Stavros Sachtouris committed
38
from re import compile as regex_compile
39

Stavros Sachtouris's avatar
Stavros Sachtouris committed
40
from kamaki.cli import _exec_cmd, _print_error_message
Stavros Sachtouris's avatar
Stavros Sachtouris committed
41
from kamaki.cli.argument import update_arguments
42
43
from kamaki.cli.utils import print_dict
from kamaki.cli.history import History
Stavros Sachtouris's avatar
Stavros Sachtouris committed
44
from kamaki.cli.errors import CLIError
45

46

Stavros Sachtouris's avatar
Stavros Sachtouris committed
47
48
49
50
51
def _parse_with_regex(line, regex):
    re_parser = regex_compile(regex)
    return (re_parser.split(line), re_parser.findall(line))


52
53
54
55
def _split_input(line):
    """Use regular expressions to split a line correctly
    """
    line = ' %s ' % line
Stavros Sachtouris's avatar
Stavros Sachtouris committed
56
    (trivial_parts, interesting_parts) = _parse_with_regex(line, ' \'.*?\' ')
57
58
    terms = []
    for i, ipart in enumerate(interesting_parts):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
59
60
61
62
63
64
        tpart = trivial_parts[i]
        (sub_trivials, sub_interesting) = _parse_with_regex(tpart, ' ".*?" ')
        for subi, subipart in enumerate(sub_interesting):
            terms += sub_trivials[subi].split()
            terms.append(subipart[2:-2])
        terms += sub_trivials[-1].split()
65
        terms.append(ipart[2:-2])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
66
67
68
69
70
71
    tpart = trivial_parts[-1]
    (sub_trivials, sub_interesting) = _parse_with_regex(tpart, ' ".*?" ')
    for subi, subipart in enumerate(sub_interesting):
        terms += sub_trivials[subi].split()
        terms.append(subipart[2:-2])
    terms += sub_trivials[-1].split()
72
73
74
    return terms


75
76
77
78
79
80
81
82
83
84
85
86
87
def _init_shell(exe_string, arguments):
    arguments.pop('version', None)
    arguments.pop('options', None)
    arguments.pop('history', None)
    shell = Shell()
    shell.set_prompt(exe_string)
    from kamaki import __version__ as version
    shell.greet(version)
    shell.do_EOF = shell.do_exit
    from kamaki.cli.command_tree import CommandTree
    shell.cmd_tree = CommandTree(
        'kamaki', 'A command line tool for poking clouds')
    return shell
88

89
90

class Shell(Cmd):
91
92
93
94
95
    """Kamaki interactive shell"""
    _prefix = '['
    _suffix = ']:'
    cmd_tree = None
    _history = None
96
97
98
99
    _arguments = None
    _context_stack = []
    _prompt_stack = []

100
101
    undoc_header = 'interactive shell commands:'

102
103
104
105
    def postcmd(self, post, line):
        if self._context_stack:
            self._roll_command()
            self._restore(self._context_stack.pop())
106
            self.set_prompt(self._prompt_stack.pop()[1:-2])
107
108
109

        return Cmd.postcmd(self, post, line)

110
    def precmd(self, line):
111
        if line.startswith('/'):
112
113
            cur_cmd_path = self.prompt.replace(' ', '_')[1:-2]
            if cur_cmd_path != self.cmd_tree.name:
114
115
116
117
                cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
                self._context_stack.append(self._backup())
                self._prompt_stack.append(self.prompt)
                new_context = self
118
                self._roll_command(cur_cmd.path)
119
120
121
122
                new_context.set_prompt(self.cmd_tree.name)
                for grp_cmd in self.cmd_tree.get_subcommands():
                    self._register_command(grp_cmd.path)
            return line[1:]
123
124
        return line

125
126
127
128
129
130
131
132
133
    def greet(self, version):
        print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
            % version)

    def set_prompt(self, new_prompt):
        self.prompt = '[%s]:' % new_prompt

    def do_exit(self, line):
        print('')
134
135
        if self.prompt[1:-2] == self.cmd_tree.name:
            exit(0)
136
137
138
139
140
141
142
143
144
        return True

    def do_shell(self, line):
        output = popen(line).read()
        print(output)

    @property
    def path(self):
        if self._cmd:
145
            return self._cmd.path
146
147
148
149
150
151
152
153
154
155
156
157
158
        return ''

    @classmethod
    def _register_method(self, method, name):
        self.__dict__[name] = method

    @classmethod
    def _unregister_method(self, name):
        try:
            self.__dict__.pop(name)
        except KeyError:
            pass

159
    def _roll_command(self, cmd_path=None):
160
161
162
163
164
165
166
167
168
169
170
171
172
        for subname in self.cmd_tree.get_subnames(cmd_path):
            self._unregister_method('do_%s' % subname)
            self._unregister_method('complete_%s' % subname)
            self._unregister_method('help_%s' % subname)

    @classmethod
    def _backup(self):
        return dict(self.__dict__)

    @classmethod
    def _restore(self, oldcontext):
        self.__dict__ = oldcontext

Stavros Sachtouris's avatar
Stavros Sachtouris committed
173
    def _register_command(self, cmd_path):
174
        cmd = self.cmd_tree.get_command(cmd_path)
175
        arguments = self._arguments
176

177
        def do_method(new_context, line):
178
179
180
181
182
            """ Template for all cmd.Cmd methods of the form do_<cmd name>
                Parse cmd + args and decide to execute or change context
                <cmd> <term> <term> <args> is always parsed to most specific
                even if cmd_term_term is not a terminal path
            """
183
            subcmd, cmd_args = cmd.parse_out(_split_input(line))
184
185
186
            if self._history:
                self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
            cmd_parser = ArgumentParser(cmd.name, add_help=False)
187
188
189
190
191
            cmd_parser.description = subcmd.help

            # exec command or change context
            if subcmd.is_command:  # exec command
                cls = subcmd.get_class()
192
                instance = cls(dict(arguments))
193
194
                cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
                    cls.syntax)
195
                update_arguments(cmd_parser, instance.arguments)
196
197
198
199
200
201
202
                if '-h' in cmd_args or '--help' in cmd_args:
                    cmd_parser.print_help()
                    return
                parsed, unparsed = cmd_parser.parse_known_args(cmd_args)

                for name, arg in instance.arguments.items():
                    arg.value = getattr(parsed, name, arg.default)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
203
204
205
206
                try:
                    _exec_cmd(instance, unparsed, cmd_parser.print_help)
                except CLIError as err:
                    _print_error_message(err)
207
208
            elif ('-h' in cmd_args or '--help' in cmd_args) \
            or len(cmd_args):  # print options
209
                print('%s: %s' % (cmd.name, subcmd.help))
210
211
212
213
214
                options = {}
                for sub in subcmd.get_subcommands():
                    options[sub.name] = sub.help
                print_dict(options)
            else:  # change context
215
                #new_context = this
216
217
218
219
220
221
                backup_context = self._backup()
                old_prompt = self.prompt
                new_context._roll_command(cmd.parent_path)
                new_context.set_prompt(subcmd.path.replace('_', ' '))
                newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
                for subcmd in newcmds:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
222
                    new_context._register_command(subcmd.path)
223
224
225
226
227
228
229
230
231
232
233
                new_context.cmdloop()
                self.prompt = old_prompt
                #when new context is over, roll back to the old one
                self._restore(backup_context)
        self._register_method(do_method, 'do_%s' % cmd.name)

        def help_method(self):
            print('%s (%s -h for more options)' % (cmd.help, cmd.name))
        self._register_method(help_method, 'help_%s' % cmd.name)

        def complete_method(self, text, line, begidx, endidx):
234
            subcmd, cmd_args = cmd.parse_out(_split_input(line)[1:])
235
236
            if subcmd.is_command:
                cls = subcmd.get_class()
237
                instance = cls(dict(arguments))
238
239
240
241
242
243
244
                empty, sep, subname = subcmd.path.partition(cmd.path)
                cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
                print('\n%s\nSyntax:\t%s %s'\
                    % (cls.description, cmd_name, cls.syntax))
                cmd_args = {}
                for arg in instance.arguments.values():
                    cmd_args[','.join(arg.parsed_name)] = arg.help
Stavros Sachtouris's avatar
Stavros Sachtouris committed
245
                print_dict(cmd_args, ident=2)
246
247
248
249
250
251
252
253
254
255
256
                stdout.write('%s %s' % (self.prompt, line))
            return subcmd.get_subnames()
        self._register_method(complete_method, 'complete_%s' % cmd.name)

    @property
    def doc_header(self):
        tmp_partition = self.prompt.partition(self._prefix)
        tmp_partition = tmp_partition[2].partition(self._suffix)
        hdr = tmp_partition[0].strip()
        return '%s commands:' % hdr

257
258
259
    def run(self, arguments, path=''):
        self._history = History(arguments['config'].get('history', 'file'))
        self._arguments = arguments
Stavros Sachtouris's avatar
Stavros Sachtouris committed
260
        if path:
261
262
263
264
265
266
            cmd = self.cmd_tree.get_command(path)
            intro = cmd.path.replace('_', ' ')
        else:
            intro = self.cmd_tree.name

        for subcmd in self.cmd_tree.get_subcommands(path):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
267
            self._register_command(subcmd.path)
268
269

        self.set_prompt(intro)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
270

271
        self.cmdloop()