root / kamaki / cli / command_shell.py @ 54d800e8
History | View | Annotate | Download (10.3 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 |
|
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 |
42 |
from kamaki.cli.errors import CLIError |
43 |
|
44 |
|
45 |
def _init_shell(exe_string, parser): |
46 |
parser.arguments.pop('version', None) |
47 |
parser.arguments.pop('options', None) |
48 |
parser.arguments.pop('debug', None) |
49 |
parser.arguments.pop('verbose', None) |
50 |
parser.arguments.pop('include', None) |
51 |
parser.arguments.pop('silent', None) |
52 |
shell = Shell() |
53 |
shell.set_prompt(exe_string) |
54 |
from kamaki import __version__ as version |
55 |
shell.greet(version) |
56 |
shell.do_EOF = shell.do_exit |
57 |
from kamaki.cli.command_tree import CommandTree |
58 |
shell.cmd_tree = CommandTree( |
59 |
'kamaki', 'A command line tool for poking clouds') |
60 |
return shell
|
61 |
|
62 |
|
63 |
class Shell(Cmd): |
64 |
"""Kamaki interactive shell"""
|
65 |
_prefix = '['
|
66 |
_suffix = ']:'
|
67 |
cmd_tree = None
|
68 |
_history = None
|
69 |
_context_stack = [] |
70 |
_prompt_stack = [] |
71 |
_parser = None
|
72 |
|
73 |
undoc_header = 'interactive shell commands:'
|
74 |
|
75 |
def postcmd(self, post, line): |
76 |
if self._context_stack: |
77 |
self._roll_command()
|
78 |
self._restore(self._context_stack.pop()) |
79 |
self.set_prompt(self._prompt_stack.pop()[1:-2]) |
80 |
|
81 |
return Cmd.postcmd(self, post, line) |
82 |
|
83 |
def precmd(self, line): |
84 |
if line.startswith('/'): |
85 |
cur_cmd_path = self.prompt.replace(' ', '_')[1:-2] |
86 |
if cur_cmd_path != self.cmd_tree.name: |
87 |
cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
|
88 |
self._context_stack.append(self._backup()) |
89 |
self._prompt_stack.append(self.prompt) |
90 |
new_context = self
|
91 |
self._roll_command(cur_cmd.path)
|
92 |
new_context.set_prompt(self.cmd_tree.name)
|
93 |
for grp_cmd in self.cmd_tree.get_subcommands(): |
94 |
self._register_command(grp_cmd.path)
|
95 |
return line[1:] |
96 |
return line
|
97 |
|
98 |
def greet(self, version): |
99 |
print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
|
100 |
% version) |
101 |
|
102 |
def set_prompt(self, new_prompt): |
103 |
self.prompt = '[%s]:' % new_prompt |
104 |
|
105 |
def do_exit(self, line): |
106 |
print('')
|
107 |
if self.prompt[1:-2] == self.cmd_tree.name: |
108 |
exit(0) |
109 |
return True |
110 |
|
111 |
def do_shell(self, line): |
112 |
output = popen(line).read() |
113 |
print(output) |
114 |
|
115 |
@property
|
116 |
def path(self): |
117 |
if self._cmd: |
118 |
return self._cmd.path |
119 |
return '' |
120 |
|
121 |
@classmethod
|
122 |
def _register_method(self, method, name): |
123 |
self.__dict__[name] = method
|
124 |
|
125 |
@classmethod
|
126 |
def _unregister_method(self, name): |
127 |
try:
|
128 |
self.__dict__.pop(name)
|
129 |
except KeyError: |
130 |
pass
|
131 |
|
132 |
def _roll_command(self, cmd_path=None): |
133 |
for subname in self.cmd_tree.get_subnames(cmd_path): |
134 |
self._unregister_method('do_%s' % subname) |
135 |
self._unregister_method('complete_%s' % subname) |
136 |
self._unregister_method('help_%s' % subname) |
137 |
|
138 |
@classmethod
|
139 |
def _backup(self): |
140 |
return dict(self.__dict__) |
141 |
|
142 |
@classmethod
|
143 |
def _restore(self, oldcontext): |
144 |
self.__dict__ = oldcontext
|
145 |
|
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 |
""" Template for all cmd.Cmd methods of the form do_<cmd name>
|
152 |
Parse cmd + args and decide to execute or change context
|
153 |
<cmd> <term> <term> <args> is always parsed to most specific
|
154 |
even if cmd_term_term is not a terminal path
|
155 |
"""
|
156 |
subcmd, cmd_args = cmd.parse_out(split_input(line)) |
157 |
self._history.add(' '.join([cmd.path.replace('_', ' '), line])) |
158 |
cmd_parser = ArgumentParseManager( |
159 |
cmd.name, |
160 |
dict(self._parser.arguments)) |
161 |
|
162 |
cmd_parser.parser.description = subcmd.help |
163 |
|
164 |
# exec command or change context
|
165 |
if subcmd.is_command: # exec command |
166 |
cls = subcmd.get_class() |
167 |
instance = cls(dict(cmd_parser.arguments))
|
168 |
cmd_parser.update_arguments(instance.arguments) |
169 |
instance.arguments.pop('config')
|
170 |
cmd_parser = ArgumentParseManager(subcmd.path, |
171 |
instance.arguments) |
172 |
cmd_parser.syntax = '%s %s' % (
|
173 |
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
|
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)
|
182 |
try:
|
183 |
_exec_cmd(instance, |
184 |
cmd_parser.unparsed, |
185 |
cmd_parser.parser.print_help) |
186 |
except CLIError as err: |
187 |
_print_error_message(err) |
188 |
elif ('-h' in cmd_args or '--help' in cmd_args) \ |
189 |
or len(cmd_args): # print options |
190 |
print('%s: %s' % (cmd.name, subcmd.help))
|
191 |
options = {} |
192 |
for sub in subcmd.get_subcommands(): |
193 |
options[sub.name] = sub.help |
194 |
print_dict(options) |
195 |
else: # change context |
196 |
#new_context = this
|
197 |
backup_context = self._backup()
|
198 |
old_prompt = self.prompt
|
199 |
new_context._roll_command(cmd.parent_path) |
200 |
new_context.set_prompt(subcmd.path.replace('_', ' ')) |
201 |
newcmds = [subcmd for subcmd in subcmd.get_subcommands()] |
202 |
for subcmd in newcmds: |
203 |
new_context._register_command(subcmd.path) |
204 |
new_context.cmdloop() |
205 |
self.prompt = old_prompt
|
206 |
#when new context is over, roll back to the old one
|
207 |
self._restore(backup_context)
|
208 |
self._register_method(do_method, 'do_%s' % cmd.name) |
209 |
|
210 |
def help_method(self): |
211 |
print('%s (%s -h for more options)' % (cmd.help, cmd.name))
|
212 |
if cmd.is_command:
|
213 |
cls = cmd.get_class() |
214 |
#_construct_command_syntax(cls)
|
215 |
plist = self.prompt[len(self._prefix):-len(self._suffix)] |
216 |
plist = plist.split(' ')
|
217 |
clist = cmd.path.split('_')
|
218 |
upto = 0
|
219 |
for i, term in enumerate(plist): |
220 |
try:
|
221 |
if clist[i] == term:
|
222 |
upto += 1
|
223 |
except IndexError: |
224 |
break
|
225 |
print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax)) |
226 |
else:
|
227 |
options = dict(name='Options:') |
228 |
for sub in cmd.get_subcommands(): |
229 |
options[sub.name] = sub.help |
230 |
print_items([options]) |
231 |
|
232 |
self._register_method(help_method, 'help_%s' % cmd.name) |
233 |
|
234 |
def complete_method(self, text, line, begidx, endidx): |
235 |
subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
|
236 |
if subcmd.is_command:
|
237 |
cls = subcmd.get_class() |
238 |
instance = cls(dict(arguments))
|
239 |
empty, sep, subname = subcmd.path.partition(cmd.path) |
240 |
cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' ')) |
241 |
print('\n%s\nSyntax:\t%s %s'\
|
242 |
% (cls.description, cmd_name, cls.syntax)) |
243 |
cmd_args = {} |
244 |
for arg in instance.arguments.values(): |
245 |
cmd_args[','.join(arg.parsed_name)] = arg.help
|
246 |
print_dict(cmd_args, ident=2)
|
247 |
stdout.write('%s %s' % (self.prompt, line)) |
248 |
return subcmd.get_subnames()
|
249 |
self._register_method(complete_method, 'complete_%s' % cmd.name) |
250 |
|
251 |
@property
|
252 |
def doc_header(self): |
253 |
tmp_partition = self.prompt.partition(self._prefix) |
254 |
tmp_partition = tmp_partition[2].partition(self._suffix) |
255 |
hdr = tmp_partition[0].strip()
|
256 |
return '%s commands:' % hdr |
257 |
|
258 |
def run(self, parser, path=''): |
259 |
self._parser = parser
|
260 |
self._history = History(
|
261 |
parser.arguments['config'].get('history', 'file')) |
262 |
if path:
|
263 |
cmd = self.cmd_tree.get_command(path)
|
264 |
intro = cmd.path.replace('_', ' ') |
265 |
else:
|
266 |
intro = self.cmd_tree.name
|
267 |
|
268 |
for subcmd in self.cmd_tree.get_subcommands(path): |
269 |
self._register_command(subcmd.path)
|
270 |
|
271 |
self.set_prompt(intro)
|
272 |
|
273 |
try:
|
274 |
self.cmdloop()
|
275 |
except Exception: |
276 |
from traceback import print_stack |
277 |
print_stack() |