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