command_shell.py 7.55 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
36
#
# 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
from argparse import ArgumentParser
37
from kamaki.cli import _update_parser, _exec_cmd
38
from .argument import _arguments
39
from .utils import print_dict
40
from sys import stdout
Stavros Sachtouris's avatar
Stavros Sachtouris committed
41
from .history import History
42

43

44
def _fix_arguments():
45
46
47
48
    _arguments.pop('version', None)
    _arguments.pop('options', None)
    _arguments.pop('history', None)

49
50

class Shell(Cmd):
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
    """Kamaki interactive shell"""
    _prefix = '['
    _suffix = ']:'
    cmd_tree = None
    _history = None
    undoc_header = 'interactive shell commands:'

    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('')
        return True

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

    @property
    def path(self):
        if self._cmd:
76
            return self._cmd.path
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
        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

    def _roll_command(self, cmd_path):
        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

    def _push_in_command(self, cmd_path):
        cmd = self.cmd_tree.get_command(cmd_path)
106
        self.cmd_tree = self.cmd_tree
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
        _history = self._history

        def do_method(self, line):
            """ 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
            """
            if _history:
                _history.add(' '.join([cmd.path.replace('_', ' '), line]))
            subcmd, cmd_args = cmd.parse_out(line.split())
            active_terms = [cmd.name] +\
                subcmd.path.split('_')[len(cmd.path.split('_')):]
            subname = '_'.join(active_terms)
            cmd_parser = ArgumentParser(subname, add_help=False)
            cmd_parser.description = subcmd.help

            # exec command or change context
            if subcmd.is_command:  # exec command
                cls = subcmd.get_class()
                instance = cls(dict(_arguments))
                cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
                    cls.syntax)
                _update_parser(cmd_parser, instance.arguments)
                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)
                _exec_cmd(instance, unparsed, cmd_parser.print_help)
            elif ('-h' in cmd_args or '--help' in cmd_args) \
            or len(cmd_args):  # print options
                print('%s: %s' % (subname, subcmd.help))
                options = {}
                for sub in subcmd.get_subcommands():
                    options[sub.name] = sub.help
                print_dict(options)
            else:  # change context
                new_context = self
                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:
                    new_context._push_in_command(subcmd.path)
                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):
            subcmd, cmd_args = cmd.parse_out(line.split()[1:])
            if subcmd.is_command:
                cls = subcmd.get_class()
                instance = cls(dict(_arguments))
                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
                print_dict(cmd_args, ident=14)
                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

    def run(self, path=''):
        self._history = History(_arguments['config'].get('history', 'file'))
        if len(path):
            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):
            self._push_in_command(subcmd.path)

        self.set_prompt(intro)
        self.cmdloop()