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"""
74 undoc_header = 'interactive shell commands:'
76 def postcmd(self, post, line):
77 if self._context_stack:
79 self._restore(self._context_stack.pop())
81 self._prompt_stack.pop()[len(self._prefix):-len(self._suffix)])
83 return Cmd.postcmd(self, post, line)
85 def precmd(self, line):
86 if line.startswith('/'):
87 start, end = len(self._prefix), -len(self._suffix)
88 cur_cmd_path = self.prompt.replace(' ', '_')[start:end]
89 if cur_cmd_path != self.cmd_tree.name:
90 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
91 self._context_stack.append(self._backup())
92 self._prompt_stack.append(self.prompt)
94 self._roll_command(cur_cmd.path)
95 new_context.set_prompt(self.cmd_tree.name)
96 for grp_cmd in self.cmd_tree.get_subcommands():
97 self._register_command(grp_cmd.path)
101 def greet(self, version):
102 print('kamaki v%s - Interactive Shell\n' % version)
103 print('\t/exit \tterminate kamaki')
104 print('\texit or ^D\texit context')
105 print('\t? or help \tavailable commands')
106 print('\t?command \thelp on command')
107 print('\t!<command>\texecute OS shell command')
110 def set_prompt(self, new_prompt):
111 self.prompt = '%s%s%s' % (self._prefix, new_prompt, self._suffix)
117 except KeyboardInterrupt:
118 print(' - interrupted')
122 def do_exit(self, line):
124 start, end = len(self._prefix), -len(self._suffix)
125 if self.prompt[start:end] == self.cmd_tree.name:
129 def do_shell(self, line):
130 output = popen(line).read()
136 return self._cmd.path
140 def _register_method(self, method, name):
141 self.__dict__[name] = method
144 def _unregister_method(self, name):
146 self.__dict__.pop(name)
150 def _roll_command(self, cmd_path=None):
151 for subname in self.cmd_tree.get_subnames(cmd_path):
152 self._unregister_method('do_%s' % subname)
153 self._unregister_method('complete_%s' % subname)
154 self._unregister_method('help_%s' % subname)
158 return dict(self.__dict__)
161 def _restore(self, oldcontext):
162 self.__dict__ = oldcontext
165 def _create_help_method(cmd_name, args, descr, syntax):
166 tmp_args = dict(args)
167 tmp_args.pop('options', None)
168 tmp_args.pop('cloud', None)
169 tmp_args.pop('debug', None)
170 tmp_args.pop('verbose', None)
171 tmp_args.pop('include', None)
172 tmp_args.pop('silent', None)
173 tmp_args.pop('config', None)
174 help_parser = ArgumentParseManager(cmd_name, tmp_args)
175 help_parser.parser.description = descr
176 help_parser.syntax = syntax
177 return help_parser.parser.print_help
179 def _register_command(self, cmd_path):
180 cmd = self.cmd_tree.get_command(cmd_path)
181 arguments = self._parser.arguments
183 def do_method(new_context, line):
184 """ Template for all cmd.Cmd methods of the form do_<cmd name>
185 Parse cmd + args and decide to execute or change context
186 <cmd> <term> <term> <args> is always parsed to most specific
187 even if cmd_term_term is not a terminal path
189 subcmd, cmd_args = cmd.parse_out(split_input(line))
190 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
191 cmd_parser = ArgumentParseManager(
192 cmd.name, dict(self._parser.arguments))
193 cmd_parser.parser.description = subcmd.help
195 # exec command or change context
196 if subcmd.is_command: # exec command
198 cls = subcmd.get_class()
199 ldescr = getattr(cls, 'long_description', '')
200 if subcmd.path == 'history_run':
202 dict(cmd_parser.arguments),
203 cmd_tree=self.cmd_tree)
206 dict(cmd_parser.arguments),
209 cmd_parser.update_arguments(instance.arguments)
210 cmd_parser.arguments = instance.arguments
211 cmd_parser.syntax = '%s %s' % (
212 subcmd.path.replace('_', ' '), cls.syntax)
213 help_method = self._create_help_method(
214 cmd.name, cmd_parser.arguments,
215 subcmd.help, cmd_parser.syntax)
216 if '-h' in cmd_args or '--help' in cmd_args:
222 cmd_parser.parse(cmd_args)
224 for name, arg in instance.arguments.items():
230 exec_cmd(instance, cmd_parser.unparsed, help_method)
231 #[term for term in cmd_parser.unparsed\
232 # if not term.startswith('-')],
233 except (ClientError, CLIError) as err:
234 print_error_message(err)
235 elif ('-h' in cmd_args or '--help' in cmd_args) or len(cmd_args):
237 print('%s' % cmd.help)
238 print_subcommands_help(cmd)
239 else: # change context
241 backup_context = self._backup()
242 old_prompt = self.prompt
243 new_context._roll_command(cmd.parent_path)
244 new_context.set_prompt(subcmd.path.replace('_', ' '))
245 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
246 for subcmd in newcmds:
247 new_context._register_command(subcmd.path)
248 new_context.cmdloop()
249 self.prompt = old_prompt
250 #when new context is over, roll back to the old one
251 self._restore(backup_context)
252 self._register_method(do_method, 'do_%s' % cmd.name)
254 def help_method(self):
255 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
257 cls = cmd.get_class()
258 ldescr = getattr(cls, 'long_description', '')
259 #_construct_command_syntax(cls)
260 plist = self.prompt[len(self._prefix):-len(self._suffix)]
261 plist = plist.split(' ')
262 clist = cmd.path.split('_')
266 for i, term in enumerate(plist):
272 print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax))
274 print_subcommands_help(cmd)
276 self._register_method(help_method, 'help_%s' % cmd.name)
278 def complete_method(self, text, line, begidx, endidx):
279 subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
280 if subcmd.is_command:
281 cls = subcmd.get_class()
282 instance = cls(dict(arguments))
283 empty, sep, subname = subcmd.path.partition(cmd.path)
284 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
285 print('\n%s\nSyntax:\t%s %s' % (
290 for arg in instance.arguments.values():
291 cmd_args[','.join(arg.parsed_name)] = arg.help
292 print_dict(cmd_args, ident=2)
293 stdout.write('%s %s' % (self.prompt, line))
294 return subcmd.get_subnames()
295 self._register_method(complete_method, 'complete_%s' % cmd.name)
298 def doc_header(self):
299 tmp_partition = self.prompt.partition(self._prefix)
300 tmp_partition = tmp_partition[2].partition(self._suffix)
301 hdr = tmp_partition[0].strip()
302 return '%s commands:' % hdr
304 def run(self, auth_base, cloud, parser, path=''):
305 self.auth_base = auth_base
307 self._parser = parser
308 self._history = History(
309 parser.arguments['config'].get_global('history_file'))
311 cmd = self.cmd_tree.get_command(path)
312 intro = cmd.path.replace('_', ' ')
314 intro = self.cmd_tree.name
316 for subcmd in self.cmd_tree.get_subcommands(path):
317 self._register_command(subcmd.path)
319 self.set_prompt(intro)
323 except Exception as e:
325 from traceback import print_stack