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