command_shell.py 10.3 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

Stavros Sachtouris's avatar
Stavros Sachtouris committed
38
from kamaki.cli import _exec_cmd, _print_error_message
39
from kamaki.cli.argument import ArgumentParseManager
40
from kamaki.cli.utils import print_dict, split_input, print_items
41
from kamaki.cli.history import History
Stavros Sachtouris's avatar
Stavros Sachtouris committed
42
from kamaki.cli.errors import CLIError
43

44

45
46
def _init_shell(exe_string, parser):
    parser.arguments.pop('version', None)
47
48
49
50
51
    parser.arguments.pop('options', None)
    parser.arguments.pop('debug', None)
    parser.arguments.pop('verbose', None)
    parser.arguments.pop('include', None)
    parser.arguments.pop('silent', None)
52
53
54
55
56
57
58
59
60
    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
61

62
63

class Shell(Cmd):
64
65
66
67
68
    """Kamaki interactive shell"""
    _prefix = '['
    _suffix = ']:'
    cmd_tree = None
    _history = None
69
70
    _context_stack = []
    _prompt_stack = []
71
    _parser = None
72

73
74
    undoc_header = 'interactive shell commands:'

75
76
77
78
    def postcmd(self, post, line):
        if self._context_stack:
            self._roll_command()
            self._restore(self._context_stack.pop())
79
            self.set_prompt(self._prompt_stack.pop()[1:-2])
80
81
82

        return Cmd.postcmd(self, post, line)

83
    def precmd(self, line):
84
        if line.startswith('/'):
85
86
            cur_cmd_path = self.prompt.replace(' ', '_')[1:-2]
            if cur_cmd_path != self.cmd_tree.name:
87
88
89
90
                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
91
                self._roll_command(cur_cmd.path)
92
93
94
95
                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:]
96
97
        return line

98
99
100
101
102
103
104
105
106
    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('')
107
108
        if self.prompt[1:-2] == self.cmd_tree.name:
            exit(0)
109
110
111
112
113
114
115
116
117
        return True

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

    @property
    def path(self):
        if self._cmd:
118
            return self._cmd.path
119
120
121
122
123
124
125
126
127
128
129
130
131
        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

132
    def _roll_command(self, cmd_path=None):
133
134
135
136
137
138
139
140
141
142
143
144
145
        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
146
    def _register_command(self, cmd_path):
147
        cmd = self.cmd_tree.get_command(cmd_path)
148
        arguments = self._parser.arguments
149

150
        def do_method(new_context, line):
151
152
153
154
155
            """ 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
            """
156
            subcmd, cmd_args = cmd.parse_out(split_input(line))
157
158
159
160
161
162
            self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
            cmd_parser = ArgumentParseManager(
                cmd.name,
                dict(self._parser.arguments))

            cmd_parser.parser.description = subcmd.help
163
164
165
166

            # exec command or change context
            if subcmd.is_command:  # exec command
                cls = subcmd.get_class()
167
168
                instance = cls(dict(cmd_parser.arguments))
                cmd_parser.update_arguments(instance.arguments)
169
                instance.arguments.pop('config')
170
                cmd_parser = ArgumentParseManager(subcmd.path,
171
                    instance.arguments)
172
173
                cmd_parser.syntax = '%s %s' % (
                    subcmd.path.replace('_', ' '), cls.syntax)
174
                if '-h' in cmd_args or '--help' in cmd_args:
175
                    cmd_parser.parser.print_help()
176
                    print('\n%s' % subcmd.help)
177
                    return
Stavros Sachtouris's avatar
Stavros Sachtouris committed
178
                cmd_parser.parse(cmd_args)
179
180

                for name, arg in instance.arguments.items():
181
                    arg.value = getattr(cmd_parser.parsed, name, arg.default)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
182
                try:
183
184
185
                    _exec_cmd(instance,
                        cmd_parser.unparsed,
                        cmd_parser.parser.print_help)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
186
187
                except CLIError as err:
                    _print_error_message(err)
188
189
            elif ('-h' in cmd_args or '--help' in cmd_args) \
            or len(cmd_args):  # print options
190
                print('%s: %s' % (cmd.name, subcmd.help))
191
192
193
194
195
                options = {}
                for sub in subcmd.get_subcommands():
                    options[sub.name] = sub.help
                print_dict(options)
            else:  # change context
196
                #new_context = this
197
198
199
200
201
202
                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
203
                    new_context._register_command(subcmd.path)
204
205
206
207
208
209
210
211
                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))
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
            if cmd.is_command:
                cls = cmd.get_class()
                #_construct_command_syntax(cls)
                plist = self.prompt[len(self._prefix):-len(self._suffix)]
                plist = plist.split(' ')
                clist = cmd.path.split('_')
                upto = 0
                for i, term in enumerate(plist):
                    try:
                        if clist[i] == term:
                            upto += 1
                    except IndexError:
                        break
                print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax))
            else:
                options = dict(name='Options:')
                for sub in cmd.get_subcommands():
                    options[sub.name] = sub.help
                print_items([options])

232
233
234
        self._register_method(help_method, 'help_%s' % cmd.name)

        def complete_method(self, text, line, begidx, endidx):
235
            subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
236
237
            if subcmd.is_command:
                cls = subcmd.get_class()
238
                instance = cls(dict(arguments))
239
240
241
242
243
244
245
                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
246
                print_dict(cmd_args, ident=2)
247
248
249
250
251
252
253
254
255
256
257
                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

258
259
260
261
    def run(self, parser, path=''):
        self._parser = parser
        self._history = History(
            parser.arguments['config'].get('history', 'file'))
Stavros Sachtouris's avatar
Stavros Sachtouris committed
262
        if path:
263
264
265
266
267
268
            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
269
            self._register_command(subcmd.path)
270
271

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

273
274
275
276
277
        try:
            self.cmdloop()
        except Exception:
            from traceback import print_stack
            print_stack()