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