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 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)
50 print('SHELL? [%s]' % arguments['config'].value)
52 shell.set_prompt(exe_string)
53 from kamaki import __version__ as 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')
63 """Kamaki interactive shell"""
72 undoc_header = 'interactive shell commands:'
74 def postcmd(self, post, line):
75 if self._context_stack:
77 self._restore(self._context_stack.pop())
78 self.set_prompt(self._prompt_stack.pop()[1:-2])
80 return Cmd.postcmd(self, post, line)
82 def precmd(self, line):
83 if line.startswith('/'):
84 cur_cmd_path = self.prompt.replace(' ', '_')[1:-2]
85 if cur_cmd_path != self.cmd_tree.name:
86 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
87 self._context_stack.append(self._backup())
88 self._prompt_stack.append(self.prompt)
90 self._roll_command(cur_cmd.path)
91 new_context.set_prompt(self.cmd_tree.name)
92 for grp_cmd in self.cmd_tree.get_subcommands():
93 self._register_command(grp_cmd.path)
97 def greet(self, version):
98 print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
101 def set_prompt(self, new_prompt):
102 self.prompt = '[%s]:' % new_prompt
104 def do_exit(self, line):
106 if self.prompt[1:-2] == self.cmd_tree.name:
110 def do_shell(self, line):
111 output = popen(line).read()
117 return self._cmd.path
121 def _register_method(self, method, name):
122 self.__dict__[name] = method
125 def _unregister_method(self, name):
127 self.__dict__.pop(name)
131 def _roll_command(self, cmd_path=None):
132 for subname in self.cmd_tree.get_subnames(cmd_path):
133 self._unregister_method('do_%s' % subname)
134 self._unregister_method('complete_%s' % subname)
135 self._unregister_method('help_%s' % subname)
139 return dict(self.__dict__)
142 def _restore(self, oldcontext):
143 self.__dict__ = oldcontext
145 def _register_command(self, cmd_path):
146 cmd = self.cmd_tree.get_command(cmd_path)
147 arguments = self._arguments
149 def do_method(new_context, line):
150 """ Template for all cmd.Cmd methods of the form do_<cmd name>
151 Parse cmd + args and decide to execute or change context
152 <cmd> <term> <term> <args> is always parsed to most specific
153 even if cmd_term_term is not a terminal path
155 subcmd, cmd_args = cmd.parse_out(line.split())
157 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
158 cmd_parser = ArgumentParser(cmd.name, add_help=False)
159 cmd_parser.description = subcmd.help
161 # exec command or change context
162 if subcmd.is_command: # exec command
163 cls = subcmd.get_class()
164 instance = cls(dict(arguments))
165 cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
167 update_arguments(cmd_parser, instance.arguments)
168 if '-h' in cmd_args or '--help' in cmd_args:
169 cmd_parser.print_help()
171 parsed, unparsed = cmd_parser.parse_known_args(cmd_args)
173 for name, arg in instance.arguments.items():
174 arg.value = getattr(parsed, name, arg.default)
176 _exec_cmd(instance, unparsed, cmd_parser.print_help)
177 except CLIError as err:
178 _print_error_message(err)
179 elif ('-h' in cmd_args or '--help' in cmd_args) \
180 or len(cmd_args): # print options
181 print('%s: %s' % (cmd.name, subcmd.help))
183 for sub in subcmd.get_subcommands():
184 options[sub.name] = sub.help
186 else: # change context
188 backup_context = self._backup()
189 old_prompt = self.prompt
190 new_context._roll_command(cmd.parent_path)
191 new_context.set_prompt(subcmd.path.replace('_', ' '))
192 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
193 for subcmd in newcmds:
194 new_context._register_command(subcmd.path)
195 new_context.cmdloop()
196 self.prompt = old_prompt
197 #when new context is over, roll back to the old one
198 self._restore(backup_context)
199 self._register_method(do_method, 'do_%s' % cmd.name)
201 def help_method(self):
202 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
203 self._register_method(help_method, 'help_%s' % cmd.name)
205 def complete_method(self, text, line, begidx, endidx):
206 subcmd, cmd_args = cmd.parse_out(line.split()[1:])
207 if subcmd.is_command:
208 cls = subcmd.get_class()
209 instance = cls(dict(arguments))
210 empty, sep, subname = subcmd.path.partition(cmd.path)
211 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
212 print('\n%s\nSyntax:\t%s %s'\
213 % (cls.description, cmd_name, cls.syntax))
215 for arg in instance.arguments.values():
216 cmd_args[','.join(arg.parsed_name)] = arg.help
217 print_dict(cmd_args, ident=2)
218 stdout.write('%s %s' % (self.prompt, line))
219 return subcmd.get_subnames()
220 self._register_method(complete_method, 'complete_%s' % cmd.name)
223 def doc_header(self):
224 tmp_partition = self.prompt.partition(self._prefix)
225 tmp_partition = tmp_partition[2].partition(self._suffix)
226 hdr = tmp_partition[0].strip()
227 return '%s commands:' % hdr
229 def run(self, arguments, path=''):
230 self._history = History(arguments['config'].get('history', 'file'))
231 self._arguments = arguments
233 cmd = self.cmd_tree.get_command(path)
234 intro = cmd.path.replace('_', ' ')
236 intro = self.cmd_tree.name
238 for subcmd in self.cmd_tree.get_subcommands(path):
239 self._register_command(subcmd.path)
241 self.set_prompt(intro)