code.grnet.gr Git - kamaki/blob - kamaki/cli/command_shell.py

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