code.grnet.gr Git - kamaki/blob - kamaki/cli/command_shell.py

   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         print('SHELL: START')
  71         return line
  72
  73     def greet(self, version):
  74         print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
  75             % version)
  76
  77     def set_prompt(self, new_prompt):
  78         self.prompt = '[%s]:' % new_prompt
  79
  80     def do_exit(self, line):
  81         print('')
  82         return True
  83
  84     def do_shell(self, line):
  85         output = popen(line).read()
  86         print(output)
  87
  88     @property
  89     def path(self):
  90         if self._cmd:
  91             return self._cmd.path
  92         return ''
  93
  94     @classmethod
  95     def _register_method(self, method, name):
  96         self.__dict__[name] = method
  97
  98     @classmethod
  99     def _unregister_method(self, name):
 100         try:
 101             self.__dict__.pop(name)
 102         except KeyError:
 103             pass
 104
 105     def _roll_command(self, cmd_path):
 106         for subname in self.cmd_tree.get_subnames(cmd_path):
 107             self._unregister_method('do_%s' % subname)
 108             self._unregister_method('complete_%s' % subname)
 109             self._unregister_method('help_%s' % subname)
 110
 111     @classmethod
 112     def _backup(self):
 113         return dict(self.__dict__)
 114
 115     @classmethod
 116     def _restore(self, oldcontext):
 117         self.__dict__ = oldcontext
 118
 119     def _register_command(self, cmd_path):
 120         cmd = self.cmd_tree.get_command(cmd_path)
 121         _history = self._history
 122
 123         def do_method(self, line):
 124             """ Template for all cmd.Cmd methods of the form do_<cmd name>
 125                 Parse cmd + args and decide to execute or change context
 126                 <cmd> <term> <term> <args> is always parsed to most specific
 127                 even if cmd_term_term is not a terminal path
 128             """
 129             if _history:
 130                 _history.add(' '.join([cmd.path.replace('_', ' '), line]))
 131             subcmd, cmd_args = cmd.parse_out(line.split())
 132             active_terms = [cmd.name] +\
 133                 subcmd.path.split('_')[len(cmd.path.split('_')):]
 134             subname = '_'.join(active_terms)
 135             cmd_parser = ArgumentParser(subname, add_help=False)
 136             cmd_parser.description = subcmd.help
 137
 138             # exec command or change context
 139             if subcmd.is_command:  # exec command
 140                 cls = subcmd.get_class()
 141                 instance = cls(dict(_arguments))
 142                 cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
 143                     cls.syntax)
 144                 update_arguments(cmd_parser, instance.arguments)
 145                 #_update_parser(cmd_parser, instance.arguments)
 146                 if '-h' in cmd_args or '--help' in cmd_args:
 147                     cmd_parser.print_help()
 148                     return
 149                 parsed, unparsed = cmd_parser.parse_known_args(cmd_args)
 150
 151                 for name, arg in instance.arguments.items():
 152                     arg.value = getattr(parsed, name, arg.default)
 153                 try:
 154                     _exec_cmd(instance, unparsed, cmd_parser.print_help)
 155                 except CLIError as err:
 156                     _print_error_message(err)
 157             elif ('-h' in cmd_args or '--help' in cmd_args) \
 158             or len(cmd_args):  # print options
 159                 print('%s: %s' % (subname, subcmd.help))
 160                 options = {}
 161                 for sub in subcmd.get_subcommands():
 162                     options[sub.name] = sub.help
 163                 print_dict(options)
 164             else:  # change context
 165                 new_context = self
 166                 backup_context = self._backup()
 167                 old_prompt = self.prompt
 168                 new_context._roll_command(cmd.parent_path)
 169                 new_context.set_prompt(subcmd.path.replace('_', ' '))
 170                 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
 171                 for subcmd in newcmds:
 172                     new_context._register_command(subcmd.path)
 173                 new_context.cmdloop()
 174                 self.prompt = old_prompt
 175                 #when new context is over, roll back to the old one
 176                 self._restore(backup_context)
 177         self._register_method(do_method, 'do_%s' % cmd.name)
 178
 179         def help_method(self):
 180             print('%s (%s -h for more options)' % (cmd.help, cmd.name))
 181         self._register_method(help_method, 'help_%s' % cmd.name)
 182
 183         def complete_method(self, text, line, begidx, endidx):
 184             subcmd, cmd_args = cmd.parse_out(line.split()[1:])
 185             if subcmd.is_command:
 186                 cls = subcmd.get_class()
 187                 instance = cls(dict(_arguments))
 188                 empty, sep, subname = subcmd.path.partition(cmd.path)
 189                 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
 190                 print('\n%s\nSyntax:\t%s %s'\
 191                     % (cls.description, cmd_name, cls.syntax))
 192                 cmd_args = {}
 193                 for arg in instance.arguments.values():
 194                     cmd_args[','.join(arg.parsed_name)] = arg.help
 195                 print_dict(cmd_args, ident=2)
 196                 stdout.write('%s %s' % (self.prompt, line))
 197             return subcmd.get_subnames()
 198         self._register_method(complete_method, 'complete_%s' % cmd.name)
 199
 200     @property
 201     def doc_header(self):
 202         tmp_partition = self.prompt.partition(self._prefix)
 203         tmp_partition = tmp_partition[2].partition(self._suffix)
 204         hdr = tmp_partition[0].strip()
 205         return '%s commands:' % hdr
 206
 207     def run(self, path=''):
 208         self._history = History(_arguments['config'].get('history', 'file'))
 209         if path:
 210             cmd = self.cmd_tree.get_command(path)
 211             intro = cmd.path.replace('_', ' ')
 212         else:
 213             intro = self.cmd_tree.name
 214
 215         for subcmd in self.cmd_tree.get_subcommands(path):
 216             self._register_command(subcmd.path)
 217
 218         self.set_prompt(intro)
 219
 220         self.cmdloop()