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
38 from kamaki.cli import exec_cmd, print_error_message, print_subcommands_help
39 from kamaki.cli.argument import ArgumentParseManager
40 from kamaki.cli.utils import print_dict, split_input
41 from kamaki.cli.history import History
42 from kamaki.cli.errors import CLIError
43 from kamaki.clients import ClientError
44 from kamaki.cli.logger import add_file_logger
46 log = add_file_logger(__name__)
49 def _init_shell(exe_string, parser):
50 parser.arguments.pop('version', None)
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"""
73 undoc_header = 'interactive shell commands:'
75 def postcmd(self, post, line):
76 if self._context_stack:
78 self._restore(self._context_stack.pop())
80 self._prompt_stack.pop()[len(self._prefix):-len(self._suffix)])
82 return Cmd.postcmd(self, post, line)
84 def precmd(self, line):
85 if line.startswith('/'):
86 start, end = len(self._prefix), -len(self._suffix)
87 cur_cmd_path = self.prompt.replace(' ', '_')[start:end]
88 if cur_cmd_path != self.cmd_tree.name:
89 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
90 self._context_stack.append(self._backup())
91 self._prompt_stack.append(self.prompt)
93 self._roll_command(cur_cmd.path)
94 new_context.set_prompt(self.cmd_tree.name)
95 for grp_cmd in self.cmd_tree.get_subcommands():
96 self._register_command(grp_cmd.path)
100 def greet(self, version):
101 print('kamaki v%s - Interactive Shell\n' % version)
102 print('\t/exit \tterminate kamaki')
103 print('\texit or ^D\texit context')
104 print('\t? or help \tavailable commands')
105 print('\t?command \thelp on command')
106 print('\t!<command>\texecute OS shell command')
109 def set_prompt(self, new_prompt):
110 self.prompt = '%s%s%s' % (self._prefix, new_prompt, self._suffix)
116 except KeyboardInterrupt:
117 print(' - interrupted')
121 def do_exit(self, line):
123 start, end = len(self._prefix), -len(self._suffix)
124 if self.prompt[start:end] == self.cmd_tree.name:
128 def do_shell(self, line):
129 output = popen(line).read()
135 return self._cmd.path
139 def _register_method(self, method, name):
140 self.__dict__[name] = method
143 def _unregister_method(self, name):
145 self.__dict__.pop(name)
149 def _roll_command(self, cmd_path=None):
150 for subname in self.cmd_tree.get_subnames(cmd_path):
151 self._unregister_method('do_%s' % subname)
152 self._unregister_method('complete_%s' % subname)
153 self._unregister_method('help_%s' % subname)
157 return dict(self.__dict__)
160 def _restore(self, oldcontext):
161 self.__dict__ = oldcontext
164 def _create_help_method(cmd_name, args, descr, syntax):
165 tmp_args = dict(args)
166 tmp_args.pop('options', None)
167 tmp_args.pop('cloud', None)
168 tmp_args.pop('debug', None)
169 tmp_args.pop('verbose', None)
170 tmp_args.pop('include', None)
171 tmp_args.pop('silent', None)
172 tmp_args.pop('config', None)
173 help_parser = ArgumentParseManager(cmd_name, tmp_args)
174 help_parser.parser.description = descr
175 help_parser.syntax = syntax
176 return help_parser.parser.print_help
178 def _register_command(self, cmd_path):
179 cmd = self.cmd_tree.get_command(cmd_path)
180 arguments = self._parser.arguments
182 def do_method(new_context, line):
183 """ Template for all cmd.Cmd methods of the form do_<cmd name>
184 Parse cmd + args and decide to execute or change context
185 <cmd> <term> <term> <args> is always parsed to most specific
186 even if cmd_term_term is not a terminal path
188 subcmd, cmd_args = cmd.parse_out(split_input(line))
189 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
190 cmd_parser = ArgumentParseManager(
191 cmd.name, dict(self._parser.arguments))
192 cmd_parser.parser.description = subcmd.help
194 # exec command or change context
195 if subcmd.is_command: # exec command
197 cls = subcmd.get_class()
198 ldescr = getattr(cls, 'long_description', '')
199 if subcmd.path == 'history_run':
201 dict(cmd_parser.arguments),
202 cmd_tree=self.cmd_tree)
205 dict(cmd_parser.arguments), self.auth_base)
206 cmd_parser.update_arguments(instance.arguments)
207 cmd_parser.arguments = instance.arguments
208 cmd_parser.syntax = '%s %s' % (
209 subcmd.path.replace('_', ' '), cls.syntax)
210 help_method = self._create_help_method(
211 cmd.name, cmd_parser.arguments,
212 subcmd.help, cmd_parser.syntax)
213 if '-h' in cmd_args or '--help' in cmd_args:
219 cmd_parser.parse(cmd_args)
221 for name, arg in instance.arguments.items():
227 exec_cmd(instance, cmd_parser.unparsed, help_method)
228 #[term for term in cmd_parser.unparsed\
229 # if not term.startswith('-')],
230 except (ClientError, CLIError) as err:
231 print_error_message(err)
232 elif ('-h' in cmd_args or '--help' in cmd_args) or len(cmd_args):
234 print('%s' % cmd.help)
235 print_subcommands_help(cmd)
236 else: # change context
238 backup_context = self._backup()
239 old_prompt = self.prompt
240 new_context._roll_command(cmd.parent_path)
241 new_context.set_prompt(subcmd.path.replace('_', ' '))
242 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
243 for subcmd in newcmds:
244 new_context._register_command(subcmd.path)
245 new_context.cmdloop()
246 self.prompt = old_prompt
247 #when new context is over, roll back to the old one
248 self._restore(backup_context)
249 self._register_method(do_method, 'do_%s' % cmd.name)
251 def help_method(self):
252 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
254 cls = cmd.get_class()
255 ldescr = getattr(cls, 'long_description', '')
256 #_construct_command_syntax(cls)
257 plist = self.prompt[len(self._prefix):-len(self._suffix)]
258 plist = plist.split(' ')
259 clist = cmd.path.split('_')
263 for i, term in enumerate(plist):
269 print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax))
271 print_subcommands_help(cmd)
273 self._register_method(help_method, 'help_%s' % cmd.name)
275 def complete_method(self, text, line, begidx, endidx):
276 subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
277 if subcmd.is_command:
278 cls = subcmd.get_class()
279 instance = cls(dict(arguments))
280 empty, sep, subname = subcmd.path.partition(cmd.path)
281 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
282 print('\n%s\nSyntax:\t%s %s' % (
287 for arg in instance.arguments.values():
288 cmd_args[','.join(arg.parsed_name)] = arg.help
289 print_dict(cmd_args, ident=2)
290 stdout.write('%s %s' % (self.prompt, line))
291 return subcmd.get_subnames()
292 self._register_method(complete_method, 'complete_%s' % cmd.name)
295 def doc_header(self):
296 tmp_partition = self.prompt.partition(self._prefix)
297 tmp_partition = tmp_partition[2].partition(self._suffix)
298 hdr = tmp_partition[0].strip()
299 return '%s commands:' % hdr
301 def run(self, auth_base, cloud, parser, path=''):
302 self.auth_base = auth_base
304 self._parser = parser
305 self._history = History(
306 parser.arguments['config'].get_global('history_file'))
308 cmd = self.cmd_tree.get_command(path)
309 intro = cmd.path.replace('_', ' ')
311 intro = self.cmd_tree.name
313 for subcmd in self.cmd_tree.get_subcommands(path):
314 self._register_command(subcmd.path)
316 self.set_prompt(intro)
320 except Exception as e:
322 from traceback import print_stack