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