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 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 _split_input(line):
  47     """Use regular expressions to split a line correctly
  48     """
  49     line = ' %s ' % line
  50     import re
  51     pattern = '[ ]["].*?["][ ]'
  52     re_parser = re.compile(pattern)
  53     trivial_parts = re_parser.split(line)
  54     interesting_parts = re_parser.findall(line)
  55     print('Trivial parts: %s' % trivial_parts)
  56     print('Interesting parts: %s ' % interesting_parts)
  57     terms = []
  58     for i, ipart in enumerate(interesting_parts):
  59         terms += trivial_parts[i].split()
  60         terms.append(ipart[2:-2])
  61     terms += trivial_parts[-1].split()
  62     return terms
  63
  64
  65 def _init_shell(exe_string, arguments):
  66     arguments.pop('version', None)
  67     arguments.pop('options', None)
  68     arguments.pop('history', None)
  69     shell = Shell()
  70     shell.set_prompt(exe_string)
  71     from kamaki import __version__ as version
  72     shell.greet(version)
  73     shell.do_EOF = shell.do_exit
  74     from kamaki.cli.command_tree import CommandTree
  75     shell.cmd_tree = CommandTree(
  76         'kamaki', 'A command line tool for poking clouds')
  77     return shell
  78
  79
  80 class Shell(Cmd):
  81     """Kamaki interactive shell"""
  82     _prefix = '['
  83     _suffix = ']:'
  84     cmd_tree = None
  85     _history = None
  86     _arguments = None
  87     _context_stack = []
  88     _prompt_stack = []
  89
  90     undoc_header = 'interactive shell commands:'
  91
  92     def postcmd(self, post, line):
  93         if self._context_stack:
  94             self._roll_command()
  95             self._restore(self._context_stack.pop())
  96             self.set_prompt(self._prompt_stack.pop()[1:-2])
  97
  98         return Cmd.postcmd(self, post, line)
  99
 100     def precmd(self, line):
 101         if line.startswith('/'):
 102             cur_cmd_path = self.prompt.replace(' ', '_')[1:-2]
 103             if cur_cmd_path != self.cmd_tree.name:
 104                 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
 105                 self._context_stack.append(self._backup())
 106                 self._prompt_stack.append(self.prompt)
 107                 new_context = self
 108                 self._roll_command(cur_cmd.path)
 109                 new_context.set_prompt(self.cmd_tree.name)
 110                 for grp_cmd in self.cmd_tree.get_subcommands():
 111                     self._register_command(grp_cmd.path)
 112             return line[1:]
 113         return line
 114
 115     def greet(self, version):
 116         print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
 117             % version)
 118
 119     def set_prompt(self, new_prompt):
 120         self.prompt = '[%s]:' % new_prompt
 121
 122     def do_exit(self, line):
 123         print('')
 124         if self.prompt[1:-2] == self.cmd_tree.name:
 125             exit(0)
 126         return True
 127
 128     def do_shell(self, line):
 129         output = popen(line).read()
 130         print(output)
 131
 132     @property
 133     def path(self):
 134         if self._cmd:
 135             return self._cmd.path
 136         return ''
 137
 138     @classmethod
 139     def _register_method(self, method, name):
 140         self.__dict__[name] = method
 141
 142     @classmethod
 143     def _unregister_method(self, name):
 144         try:
 145             self.__dict__.pop(name)
 146         except KeyError:
 147             pass
 148
 149     def _roll_command(self, cmd_path=None):
 150         for subname in self.cmd_tree.get_subnames(cmd_path):
 151             self._unregister_method('do_%s' % subname)
 152             self._unregister_method('complete_%s' % subname)
 153             self._unregister_method('help_%s' % subname)
 154
 155     @classmethod
 156     def _backup(self):
 157         return dict(self.__dict__)
 158
 159     @classmethod
 160     def _restore(self, oldcontext):
 161         self.__dict__ = oldcontext
 162
 163     def _register_command(self, cmd_path):
 164         cmd = self.cmd_tree.get_command(cmd_path)
 165         arguments = self._arguments
 166
 167         def do_method(new_context, line):
 168             """ Template for all cmd.Cmd methods of the form do_<cmd name>
 169                 Parse cmd + args and decide to execute or change context
 170                 <cmd> <term> <term> <args> is always parsed to most specific
 171                 even if cmd_term_term is not a terminal path
 172             """
 173             subcmd, cmd_args = cmd.parse_out(_split_input(line))
 174             if self._history:
 175                 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
 176             cmd_parser = ArgumentParser(cmd.name, add_help=False)
 177             cmd_parser.description = subcmd.help
 178
 179             # exec command or change context
 180             if subcmd.is_command:  # exec command
 181                 cls = subcmd.get_class()
 182                 instance = cls(dict(arguments))
 183                 cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
 184                     cls.syntax)
 185                 update_arguments(cmd_parser, instance.arguments)
 186                 if '-h' in cmd_args or '--help' in cmd_args:
 187                     cmd_parser.print_help()
 188                     return
 189                 parsed, unparsed = cmd_parser.parse_known_args(cmd_args)
 190
 191                 for name, arg in instance.arguments.items():
 192                     arg.value = getattr(parsed, name, arg.default)
 193                 try:
 194                     _exec_cmd(instance, unparsed, cmd_parser.print_help)
 195                 except 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         self._register_method(help_method, 'help_%s' % cmd.name)
 222
 223         def complete_method(self, text, line, begidx, endidx):
 224             subcmd, cmd_args = cmd.parse_out(_split_input(line)[1:])
 225             if subcmd.is_command:
 226                 cls = subcmd.get_class()
 227                 instance = cls(dict(arguments))
 228                 empty, sep, subname = subcmd.path.partition(cmd.path)
 229                 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
 230                 print('\n%s\nSyntax:\t%s %s'\
 231                     % (cls.description, cmd_name, cls.syntax))
 232                 cmd_args = {}
 233                 for arg in instance.arguments.values():
 234                     cmd_args[','.join(arg.parsed_name)] = arg.help
 235                 print_dict(cmd_args, ident=2)
 236                 stdout.write('%s %s' % (self.prompt, line))
 237             return subcmd.get_subnames()
 238         self._register_method(complete_method, 'complete_%s' % cmd.name)
 239
 240     @property
 241     def doc_header(self):
 242         tmp_partition = self.prompt.partition(self._prefix)
 243         tmp_partition = tmp_partition[2].partition(self._suffix)
 244         hdr = tmp_partition[0].strip()
 245         return '%s commands:' % hdr
 246
 247     def run(self, arguments, path=''):
 248         self._history = History(arguments['config'].get('history', 'file'))
 249         self._arguments = arguments
 250         if path:
 251             cmd = self.cmd_tree.get_command(path)
 252             intro = cmd.path.replace('_', ' ')
 253         else:
 254             intro = self.cmd_tree.name
 255
 256         for subcmd in self.cmd_tree.get_subcommands(path):
 257             self._register_command(subcmd.path)
 258
 259         self.set_prompt(intro)
 260
 261         self.cmdloop()