Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / command_shell.py @ 9b3c8fd9

History | View | Annotate | Download (12.7 kB)

1
# Copyright 2012-2013 GRNET S.A. All rights reserved.
2
#
3
# Redistribution and use in source and binary forms, with or
4
# without modification, are permitted provided that the following
5
# conditions are met:
6
#
7
#   1. Redistributions of source code must retain the above
8
#      copyright notice, this list of conditions and the following
9
#      disclaimer.
10
#
11
#   2. Redistributions in binary form must reproduce the above
12
#      copyright notice, this list of conditions and the following
13
#      disclaimer in the documentation and/or other materials
14
#      provided with the distribution.
15
#
16
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
#
29
# The views and conclusions contained in the software and
30
# documentation are those of the authors and should not be
31
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.
33

    
34
from cmd import Cmd
35
from os import popen
36
from sys import stdout, stderr
37

    
38
from kamaki.cli import exec_cmd, print_error_message, print_subcommands_help
39
from kamaki.cli.argument import ArgumentParseManager
40
from kamaki.cli.utils import print_dict, split_input
41
from kamaki.cli.history import History
42
from kamaki.cli.errors import CLIError
43
from kamaki.clients import ClientError
44
from kamaki.cli.logger import add_file_logger
45

    
46
log = add_file_logger(__name__)
47

    
48

    
49
def _init_shell(exe_string, parser, username='', userid=''):
50
    parser.arguments.pop('version', None)
51
    shell = Shell()
52
    shell.set_prompt(exe_string)
53
    from kamaki import __version__ as version
54
    shell.greet(version, username, userid)
55
    shell.do_EOF = shell.do_exit
56
    from kamaki.cli.command_tree import CommandTree
57
    shell.cmd_tree = CommandTree(
58
        'kamaki', 'A command line tool for poking clouds')
59
    return shell
60

    
61

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

    
74
    undoc_header = 'interactive shell commands:'
75

    
76
    def emptyline(self):
77
        self.lastcmd = ''
78

    
79
    def postcmd(self, post, line):
80
        if self._context_stack:
81
            self._roll_command()
82
            self._restore(self._context_stack.pop())
83
            self.set_prompt(
84
                self._prompt_stack.pop()[len(self._prefix):-len(self._suffix)])
85

    
86
        return Cmd.postcmd(self, post, line)
87

    
88
    def precmd(self, line):
89
        if line.startswith('/'):
90
            start, end = len(self._prefix), -len(self._suffix)
91
            cur_cmd_path = self.prompt.replace(' ', '_')[start:end]
92
            if cur_cmd_path != self.cmd_tree.name:
93
                cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
94
                self._context_stack.append(self._backup())
95
                self._prompt_stack.append(self.prompt)
96
                new_context = self
97
                self._roll_command(cur_cmd.path)
98
                new_context.set_prompt(self.cmd_tree.name)
99
                for grp_cmd in self.cmd_tree.get_subcommands():
100
                    self._register_command(grp_cmd.path)
101
            return line[1:]
102
        return line
103

    
104
    def greet(self, version, username='', userid=''):
105
        print('kamaki v%s - Interactive Shell\n' % version)
106
        print('\t/exit     \tterminate kamaki')
107
        print('\texit or ^D\texit context')
108
        print('\t? or help \tavailable commands')
109
        print('\t?command  \thelp on command')
110
        print('\t!<command>\texecute OS shell command')
111
        print('')
112
        if username or userid:
113
            print('Session user is %s (uuid: %s)' % (username, userid))
114

    
115
    def set_prompt(self, new_prompt):
116
        self.prompt = '%s%s%s' % (self._prefix, new_prompt, self._suffix)
117

    
118
    def cmdloop(self):
119
        while True:
120
            try:
121
                Cmd.cmdloop(self)
122
            except KeyboardInterrupt:
123
                print(' - interrupted')
124
                continue
125
            break
126

    
127
    def do_exit(self, line):
128
        print('')
129
        start, end = len(self._prefix), -len(self._suffix)
130
        if self.prompt[start:end] == self.cmd_tree.name:
131
            exit(0)
132
        return True
133

    
134
    def do_shell(self, line):
135
        output = popen(line).read()
136
        print(output)
137

    
138
    @property
139
    def path(self):
140
        if self._cmd:
141
            return self._cmd.path
142
        return ''
143

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

    
148
    @classmethod
149
    def _unregister_method(self, name):
150
        try:
151
            self.__dict__.pop(name)
152
        except KeyError:
153
            pass
154

    
155
    def _roll_command(self, cmd_path=None):
156
        for subname in self.cmd_tree.subnames(cmd_path):
157
            self._unregister_method('do_%s' % subname)
158
            self._unregister_method('complete_%s' % subname)
159
            self._unregister_method('help_%s' % subname)
160

    
161
    @classmethod
162
    def _backup(self):
163
        return dict(self.__dict__)
164

    
165
    @classmethod
166
    def _restore(self, oldcontext):
167
        self.__dict__ = oldcontext
168

    
169
    @staticmethod
170
    def _create_help_method(cmd_name, args, required, descr, syntax):
171
        tmp_args = dict(args)
172
        #tmp_args.pop('options', None)
173
        tmp_args.pop('cloud', None)
174
        tmp_args.pop('debug', None)
175
        tmp_args.pop('verbose', None)
176
        tmp_args.pop('silent', None)
177
        tmp_args.pop('config', None)
178
        help_parser = ArgumentParseManager(
179
            cmd_name, tmp_args, required,
180
            syntax=syntax, description=descr, check_required=False)
181
        return help_parser.print_help
182

    
183
    def _register_command(self, cmd_path):
184
        cmd = self.cmd_tree.get_command(cmd_path)
185
        arguments = self._parser.arguments
186

    
187
        def do_method(new_context, line):
188
            """ Template for all cmd.Cmd methods of the form do_<cmd name>
189
                Parse cmd + args and decide to execute or change context
190
                <cmd> <term> <term> <args> is always parsed to most specific
191
                even if cmd_term_term is not a terminal path
192
            """
193
            subcmd, cmd_args = cmd.parse_out(split_input(line))
194
            self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
195
            cmd_parser = ArgumentParseManager(
196
                cmd.name, dict(self._parser.arguments))
197
            cmd_parser.parser.description = subcmd.help
198

    
199
            # exec command or change context
200
            if subcmd.is_command:  # exec command
201
                try:
202
                    cls = subcmd.cmd_class
203
                    cmd_parser.required = getattr(cls, 'required', None)
204
                    ldescr = getattr(cls, 'long_description', '')
205
                    if subcmd.path == 'history_run':
206
                        instance = cls(
207
                            dict(cmd_parser.arguments), self.auth_base,
208
                            cmd_tree=self.cmd_tree)
209
                    else:
210
                        instance = cls(
211
                            dict(cmd_parser.arguments),
212
                            self.auth_base, self.cloud)
213
                    cmd_parser.update_arguments(instance.arguments)
214
                    cmd_parser.arguments = instance.arguments
215
                    subpath = subcmd.path.split('_')[
216
                        (len(cmd.path.split('_')) - 1):]
217
                    cmd_parser.syntax = '%s %s' % (
218
                        ' '.join(subpath), instance.syntax)
219
                    help_method = self._create_help_method(
220
                        cmd.name, cmd_parser.arguments,
221
                        cmd_parser.required, subcmd.help, cmd_parser.syntax)
222
                    if '-h' in cmd_args or '--help' in cmd_args:
223
                        help_method()
224
                        if ldescr.strip():
225
                            print('\nDetails:')
226
                            print('%s' % ldescr)
227
                        return
228
                    cmd_parser.parse(cmd_args)
229

    
230
                    for name, arg in instance.arguments.items():
231
                        arg.value = getattr(
232
                            cmd_parser.parsed, name, arg.default)
233

    
234
                    exec_cmd(instance, cmd_parser.unparsed, help_method)
235
                        #[term for term in cmd_parser.unparsed\
236
                        #    if not term.startswith('-')],
237
                except (ClientError, CLIError) as err:
238
                    print_error_message(err)
239
            elif ('-h' in cmd_args or '--help' in cmd_args) or len(cmd_args):
240
                # print options
241
                print('%s' % cmd.help)
242
                print_subcommands_help(cmd)
243
            else:  # change context
244
                #new_context = this
245
                backup_context = self._backup()
246
                old_prompt = self.prompt
247
                new_context._roll_command(cmd.parent_path)
248
                new_context.set_prompt(subcmd.path.replace('_', ' '))
249
                newcmds = [subcmd for subcmd in subcmd.subcommands.values()]
250
                for subcmd in newcmds:
251
                    new_context._register_command(subcmd.path)
252
                new_context.cmdloop()
253
                self.prompt = old_prompt
254
                #when new context is over, roll back to the old one
255
                self._restore(backup_context)
256
        self._register_method(do_method, 'do_%s' % cmd.name)
257

    
258
        def help_method(self):
259
            print('%s (%s -h for more options)' % (cmd.help, cmd.name))
260
            if cmd.is_command:
261
                cls = cmd.cmd_class
262
                ldescr = getattr(cls, 'long_description', '')
263
                #_construct_command_syntax(cls)
264
                plist = self.prompt[len(self._prefix):-len(self._suffix)]
265
                plist = plist.split(' ')
266
                clist = cmd.path.split('_')
267
                upto = 0
268
                if ldescr:
269
                    print('%s' % ldescr)
270
                for i, term in enumerate(plist):
271
                    try:
272
                        if clist[i] == term:
273
                            upto += 1
274
                    except IndexError:
275
                        break
276
                print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax))
277
            if cmd.subcommands:
278
                print_subcommands_help(cmd)
279

    
280
        self._register_method(help_method, 'help_%s' % cmd.name)
281

    
282
        def complete_method(self, text, line, begidx, endidx):
283
            subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
284
            if subcmd.is_command:
285
                cls = subcmd.cmd_class
286
                instance = cls(dict(arguments))
287
                empty, sep, subname = subcmd.path.partition(cmd.path)
288
                cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
289
                print('\n%s\nSyntax:\t%s %s' % (
290
                    cls.help, cmd_name, cls.syntax))
291
                cmd_args = {}
292
                for arg in instance.arguments.values():
293
                    cmd_args[','.join(arg.parsed_name)] = arg.help
294
                print_dict(cmd_args, indent=2)
295
                stdout.write('%s %s' % (self.prompt, line))
296
            return subcmd.subnames()
297
        self._register_method(complete_method, 'complete_%s' % cmd.name)
298

    
299
    @property
300
    def doc_header(self):
301
        tmp_partition = self.prompt.partition(self._prefix)
302
        tmp_partition = tmp_partition[2].partition(self._suffix)
303
        hdr = tmp_partition[0].strip()
304
        return '%s commands:' % hdr
305

    
306
    def run(self, auth_base, cloud, parser, path=''):
307
        self.auth_base = auth_base
308
        self.cloud = cloud
309
        self._parser = parser
310
        self._history = History(
311
            parser.arguments['config'].get('global', 'history_file'))
312
        if path:
313
            cmd = self.cmd_tree.get_command(path)
314
            intro = cmd.path.replace('_', ' ')
315
        else:
316
            intro = self.cmd_tree.name
317

    
318
        acceptable = parser.arguments['config'].groups
319
        total = self.cmd_tree.groups.keys()
320
        self.cmd_tree.exclude(set(total).difference(acceptable))
321

    
322
        for subcmd in self.cmd_tree.get_subcommands(path):
323
            self._register_command(subcmd.path)
324

    
325
        self.set_prompt(intro)
326

    
327
        try:
328
            self.cmdloop()
329
        except Exception as e:
330
            print('(%s)' % e)
331
            from traceback import print_stack
332
            print_stack()