Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / command_shell.py @ 75c3fc42

History | View | Annotate | Download (8.7 kB)

1
# Copyright 2012 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
37
from argparse import ArgumentParser
38

    
39
from kamaki.cli import _exec_cmd, _print_error_message
40
from kamaki.cli.argument import _arguments, update_arguments
41
from kamaki.cli.utils import print_dict
42
from kamaki.cli.history import History
43
from kamaki.cli.errors import CLIError
44

    
45

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

    
60

    
61
class Shell(Cmd):
62
    """Kamaki interactive shell"""
63
    _prefix = '['
64
    _suffix = ']:'
65
    cmd_tree = None
66
    _history = None
67
    undoc_header = 'interactive shell commands:'
68

    
69
    def precmd(self, line):
70
        if line.startswith('/'):
71
            print('NEED TO GO TOP')
72
            print('\tsave context')
73
            print('\tload initial context')
74
            print('\treturn line')
75
            print('\tMaybe postcmd can do the trick')
76
        elif line.startswith('../'):
77
            print('NEED TO DO STUFF')
78
            print('\tsave context')
79
            print('\tload initial context')
80
            print('\treturn line')
81
            print('\tMaybe postcmd can do the trick')
82
        return line
83

    
84
    def greet(self, version):
85
        print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
86
            % version)
87

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

    
91
    def do_exit(self, line):
92
        print('')
93
        return True
94

    
95
    def do_shell(self, line):
96
        output = popen(line).read()
97
        print(output)
98

    
99
    @property
100
    def path(self):
101
        if self._cmd:
102
            return self._cmd.path
103
        return ''
104

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

    
109
    @classmethod
110
    def _unregister_method(self, name):
111
        try:
112
            self.__dict__.pop(name)
113
        except KeyError:
114
            pass
115

    
116
    def _roll_command(self, cmd_path):
117
        for subname in self.cmd_tree.get_subnames(cmd_path):
118
            self._unregister_method('do_%s' % subname)
119
            self._unregister_method('complete_%s' % subname)
120
            self._unregister_method('help_%s' % subname)
121

    
122
    @classmethod
123
    def _backup(self):
124
        return dict(self.__dict__)
125

    
126
    @classmethod
127
    def _restore(self, oldcontext):
128
        self.__dict__ = oldcontext
129

    
130
    def _push_in_command(self, cmd_path):
131
        cmd = self.cmd_tree.get_command(cmd_path)
132
        self.cmd_tree = self.cmd_tree
133
        _history = self._history
134

    
135
        def do_method(self, line):
136
            """ Template for all cmd.Cmd methods of the form do_<cmd name>
137
                Parse cmd + args and decide to execute or change context
138
                <cmd> <term> <term> <args> is always parsed to most specific
139
                even if cmd_term_term is not a terminal path
140
            """
141
            if _history:
142
                _history.add(' '.join([cmd.path.replace('_', ' '), line]))
143
            subcmd, cmd_args = cmd.parse_out(line.split())
144
            active_terms = [cmd.name] +\
145
                subcmd.path.split('_')[len(cmd.path.split('_')):]
146
            subname = '_'.join(active_terms)
147
            cmd_parser = ArgumentParser(subname, add_help=False)
148
            cmd_parser.description = subcmd.help
149

    
150
            # exec command or change context
151
            if subcmd.is_command:  # exec command
152
                cls = subcmd.get_class()
153
                instance = cls(dict(_arguments))
154
                cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
155
                    cls.syntax)
156
                update_arguments(cmd_parser, instance.arguments)
157
                #_update_parser(cmd_parser, instance.arguments)
158
                if '-h' in cmd_args or '--help' in cmd_args:
159
                    cmd_parser.print_help()
160
                    return
161
                parsed, unparsed = cmd_parser.parse_known_args(cmd_args)
162

    
163
                for name, arg in instance.arguments.items():
164
                    arg.value = getattr(parsed, name, arg.default)
165
                try:
166
                    _exec_cmd(instance, unparsed, cmd_parser.print_help)
167
                except CLIError as err:
168
                    _print_error_message(err)
169
            elif ('-h' in cmd_args or '--help' in cmd_args) \
170
            or len(cmd_args):  # print options
171
                print('%s: %s' % (subname, subcmd.help))
172
                options = {}
173
                for sub in subcmd.get_subcommands():
174
                    options[sub.name] = sub.help
175
                print_dict(options)
176
            else:  # change context
177
                new_context = self
178
                backup_context = self._backup()
179
                old_prompt = self.prompt
180
                new_context._roll_command(cmd.parent_path)
181
                new_context.set_prompt(subcmd.path.replace('_', ' '))
182
                newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
183
                for subcmd in newcmds:
184
                    new_context._push_in_command(subcmd.path)
185
                new_context.cmdloop()
186
                self.prompt = old_prompt
187
                #when new context is over, roll back to the old one
188
                self._restore(backup_context)
189
        self._register_method(do_method, 'do_%s' % cmd.name)
190

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

    
195
        def complete_method(self, text, line, begidx, endidx):
196
            subcmd, cmd_args = cmd.parse_out(line.split()[1:])
197
            if subcmd.is_command:
198
                cls = subcmd.get_class()
199
                instance = cls(dict(_arguments))
200
                empty, sep, subname = subcmd.path.partition(cmd.path)
201
                cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
202
                print('\n%s\nSyntax:\t%s %s'\
203
                    % (cls.description, cmd_name, cls.syntax))
204
                cmd_args = {}
205
                for arg in instance.arguments.values():
206
                    cmd_args[','.join(arg.parsed_name)] = arg.help
207
                print_dict(cmd_args, ident=2)
208
                stdout.write('%s %s' % (self.prompt, line))
209
            return subcmd.get_subnames()
210
        self._register_method(complete_method, 'complete_%s' % cmd.name)
211

    
212
    @property
213
    def doc_header(self):
214
        tmp_partition = self.prompt.partition(self._prefix)
215
        tmp_partition = tmp_partition[2].partition(self._suffix)
216
        hdr = tmp_partition[0].strip()
217
        return '%s commands:' % hdr
218

    
219
    def run(self, path=''):
220
        self._history = History(_arguments['config'].get('history', 'file'))
221
        if path:
222
            cmd = self.cmd_tree.get_command(path)
223
            intro = cmd.path.replace('_', ' ')
224
        else:
225
            intro = self.cmd_tree.name
226

    
227
        for subcmd in self.cmd_tree.get_subcommands(path):
228
            self._push_in_command(subcmd.path)
229

    
230
        self.set_prompt(intro)
231

    
232
        self.cmdloop()