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