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