1 # Copyright 2012 GRNET S.A. All rights reserved.
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
7 # 1. Redistributions of source code must retain the above
8 # copyright notice, this list of conditions and the following
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.
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.
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.
36 from sys import stdout
37 from argparse import ArgumentParser
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
46 def _init_shell(exe_string, arguments):
47 arguments.pop('version', None)
48 arguments.pop('options', None)
49 arguments.pop('history', None)
51 shell.set_prompt(exe_string)
52 from kamaki import __version__ as version
54 shell.do_EOF = shell.do_exit
55 from kamaki.cli.command_tree import CommandTree
56 shell.cmd_tree = CommandTree(
57 'kamaki', 'A command line tool for poking clouds')
62 """Kamaki interactive shell"""
71 undoc_header = 'interactive shell commands:'
73 def precmd(self, line):
74 if line.startswith('/'):
75 cur_cmd_path = self.prompt.replace(' ', '_')[1:-2]
76 if cur_cmd_path != self.cmd_tree.name:
77 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
79 self._context_stack.append(self._backup())
80 self._prompt_stack.append(self.prompt)
82 new_context._roll_command(cur_cmd_path)
83 new_context.set_prompt(self.cmd_tree.name)
84 for grp_cmd in self.cmd_tree.get_subcommands():
85 self._register_command(grp_cmd.path)
89 def greet(self, version):
90 print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
93 def set_prompt(self, new_prompt):
94 self.prompt = '[%s]:' % new_prompt
96 def do_exit(self, line):
100 def do_shell(self, line):
101 output = popen(line).read()
107 return self._cmd.path
111 def _register_method(self, method, name):
112 self.__dict__[name] = method
115 def _unregister_method(self, name):
117 self.__dict__.pop(name)
121 def _roll_command(self, cmd_path):
122 for subname in self.cmd_tree.get_subnames(cmd_path):
123 self._unregister_method('do_%s' % subname)
124 self._unregister_method('complete_%s' % subname)
125 self._unregister_method('help_%s' % subname)
130 return dict(self.__dict__)
133 def _restore(self, oldcontext):
134 self.__dict__ = oldcontext
136 def _register_command(self, cmd_path):
137 cmd = self.cmd_tree.get_command(cmd_path)
138 arguments = self._arguments
140 def do_method(new_context, line):
141 """ Template for all cmd.Cmd methods of the form do_<cmd name>
142 Parse cmd + args and decide to execute or change context
143 <cmd> <term> <term> <args> is always parsed to most specific
144 even if cmd_term_term is not a terminal path
146 subcmd, cmd_args = cmd.parse_out(line.split())
148 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
149 cmd_parser = ArgumentParser(cmd.name, add_help=False)
150 cmd_parser.description = subcmd.help
152 # exec command or change context
153 if subcmd.is_command: # exec command
154 cls = subcmd.get_class()
155 instance = cls(dict(arguments))
156 cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
158 update_arguments(cmd_parser, instance.arguments)
159 if '-h' in cmd_args or '--help' in cmd_args:
160 cmd_parser.print_help()
162 parsed, unparsed = cmd_parser.parse_known_args(cmd_args)
164 for name, arg in instance.arguments.items():
165 arg.value = getattr(parsed, name, arg.default)
167 _exec_cmd(instance, unparsed, cmd_parser.print_help)
168 except CLIError as err:
169 _print_error_message(err)
170 elif ('-h' in cmd_args or '--help' in cmd_args) \
171 or len(cmd_args): # print options
172 print('%s: %s' % (cmd.name, subcmd.help))
174 for sub in subcmd.get_subcommands():
175 options[sub.name] = sub.help
177 else: # change context
179 backup_context = self._backup()
180 old_prompt = self.prompt
181 new_context._roll_command(cmd.parent_path)
182 new_context.set_prompt(subcmd.path.replace('_', ' '))
183 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
184 for subcmd in newcmds:
185 new_context._register_command(subcmd.path)
186 new_context.cmdloop()
187 self.prompt = old_prompt
188 #when new context is over, roll back to the old one
189 self._restore(backup_context)
190 self._register_method(do_method, 'do_%s' % cmd.name)
192 def help_method(self):
193 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
194 self._register_method(help_method, 'help_%s' % cmd.name)
196 def complete_method(self, text, line, begidx, endidx):
197 subcmd, cmd_args = cmd.parse_out(line.split()[1:])
198 if subcmd.is_command:
199 cls = subcmd.get_class()
200 instance = cls(dict(arguments))
201 empty, sep, subname = subcmd.path.partition(cmd.path)
202 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
203 print('\n%s\nSyntax:\t%s %s'\
204 % (cls.description, cmd_name, cls.syntax))
206 for arg in instance.arguments.values():
207 cmd_args[','.join(arg.parsed_name)] = arg.help
208 print_dict(cmd_args, ident=2)
209 stdout.write('%s %s' % (self.prompt, line))
210 return subcmd.get_subnames()
211 self._register_method(complete_method, 'complete_%s' % cmd.name)
214 def doc_header(self):
215 tmp_partition = self.prompt.partition(self._prefix)
216 tmp_partition = tmp_partition[2].partition(self._suffix)
217 hdr = tmp_partition[0].strip()
218 return '%s commands:' % hdr
220 def run(self, arguments, path=''):
221 self._history = History(arguments['config'].get('history', 'file'))
222 self._arguments = arguments
224 cmd = self.cmd_tree.get_command(path)
225 intro = cmd.path.replace('_', ' ')
227 intro = self.cmd_tree.name
229 for subcmd in self.cmd_tree.get_subcommands(path):
230 self._register_command(subcmd.path)
232 self.set_prompt(intro)