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