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