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, split_input
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 postcmd(self, post, line):
74 if self._context_stack:
76 self._restore(self._context_stack.pop())
77 self.set_prompt(self._prompt_stack.pop()[1:-2])
79 return Cmd.postcmd(self, post, line)
81 def precmd(self, line):
82 if line.startswith('/'):
83 cur_cmd_path = self.prompt.replace(' ', '_')[1:-2]
84 if cur_cmd_path != self.cmd_tree.name:
85 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
86 self._context_stack.append(self._backup())
87 self._prompt_stack.append(self.prompt)
89 self._roll_command(cur_cmd.path)
90 new_context.set_prompt(self.cmd_tree.name)
91 for grp_cmd in self.cmd_tree.get_subcommands():
92 self._register_command(grp_cmd.path)
96 def greet(self, version):
97 print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\
100 def set_prompt(self, new_prompt):
101 self.prompt = '[%s]:' % new_prompt
103 def do_exit(self, line):
105 if self.prompt[1:-2] == self.cmd_tree.name:
109 def do_shell(self, line):
110 output = popen(line).read()
116 return self._cmd.path
120 def _register_method(self, method, name):
121 self.__dict__[name] = method
124 def _unregister_method(self, name):
126 self.__dict__.pop(name)
130 def _roll_command(self, cmd_path=None):
131 for subname in self.cmd_tree.get_subnames(cmd_path):
132 self._unregister_method('do_%s' % subname)
133 self._unregister_method('complete_%s' % subname)
134 self._unregister_method('help_%s' % subname)
138 return dict(self.__dict__)
141 def _restore(self, oldcontext):
142 self.__dict__ = oldcontext
144 def _register_command(self, cmd_path):
145 cmd = self.cmd_tree.get_command(cmd_path)
146 arguments = self._arguments
148 def do_method(new_context, line):
149 """ Template for all cmd.Cmd methods of the form do_<cmd name>
150 Parse cmd + args and decide to execute or change context
151 <cmd> <term> <term> <args> is always parsed to most specific
152 even if cmd_term_term is not a terminal path
154 subcmd, cmd_args = cmd.parse_out(split_input(line))
156 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
157 cmd_parser = ArgumentParser(cmd.name, add_help=False)
158 cmd_parser.description = subcmd.help
160 # exec command or change context
161 if subcmd.is_command: # exec command
162 cls = subcmd.get_class()
163 instance = cls(dict(arguments))
164 cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '),
166 update_arguments(cmd_parser, instance.arguments)
167 if '-h' in cmd_args or '--help' in cmd_args:
168 cmd_parser.print_help()
170 parsed, unparsed = cmd_parser.parse_known_args(cmd_args)
172 for name, arg in instance.arguments.items():
173 arg.value = getattr(parsed, name, arg.default)
175 _exec_cmd(instance, unparsed, cmd_parser.print_help)
176 except CLIError as err:
177 _print_error_message(err)
178 elif ('-h' in cmd_args or '--help' in cmd_args) \
179 or len(cmd_args): # print options
180 print('%s: %s' % (cmd.name, subcmd.help))
182 for sub in subcmd.get_subcommands():
183 options[sub.name] = sub.help
185 else: # change context
187 backup_context = self._backup()
188 old_prompt = self.prompt
189 new_context._roll_command(cmd.parent_path)
190 new_context.set_prompt(subcmd.path.replace('_', ' '))
191 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
192 for subcmd in newcmds:
193 new_context._register_command(subcmd.path)
194 new_context.cmdloop()
195 self.prompt = old_prompt
196 #when new context is over, roll back to the old one
197 self._restore(backup_context)
198 self._register_method(do_method, 'do_%s' % cmd.name)
200 def help_method(self):
201 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
202 self._register_method(help_method, 'help_%s' % cmd.name)
204 def complete_method(self, text, line, begidx, endidx):
205 subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
206 if subcmd.is_command:
207 cls = subcmd.get_class()
208 instance = cls(dict(arguments))
209 empty, sep, subname = subcmd.path.partition(cmd.path)
210 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
211 print('\n%s\nSyntax:\t%s %s'\
212 % (cls.description, cmd_name, cls.syntax))
214 for arg in instance.arguments.values():
215 cmd_args[','.join(arg.parsed_name)] = arg.help
216 print_dict(cmd_args, ident=2)
217 stdout.write('%s %s' % (self.prompt, line))
218 return subcmd.get_subnames()
219 self._register_method(complete_method, 'complete_%s' % cmd.name)
222 def doc_header(self):
223 tmp_partition = self.prompt.partition(self._prefix)
224 tmp_partition = tmp_partition[2].partition(self._suffix)
225 hdr = tmp_partition[0].strip()
226 return '%s commands:' % hdr
228 def run(self, arguments, path=''):
229 self._history = History(arguments['config'].get('history', 'file'))
230 self._arguments = arguments
232 cmd = self.cmd_tree.get_command(path)
233 intro = cmd.path.replace('_', ' ')
235 intro = self.cmd_tree.name
237 for subcmd in self.cmd_tree.get_subcommands(path):
238 self._register_command(subcmd.path)
240 self.set_prompt(intro)