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