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"""
72 undoc_header = 'interactive shell commands:'
74 def postcmd(self, post, line):
75 if self._context_stack:
77 self._restore(self._context_stack.pop())
79 self._prompt_stack.pop()[len(self._prefix):-len(self._suffix)])
81 return Cmd.postcmd(self, post, line)
83 def precmd(self, line):
84 if line.startswith('/'):
85 start, end = len(self._prefix), -len(self._suffix)
86 cur_cmd_path = self.prompt.replace(' ', '_')[start:end]
87 if cur_cmd_path != self.cmd_tree.name:
88 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
89 self._context_stack.append(self._backup())
90 self._prompt_stack.append(self.prompt)
92 self._roll_command(cur_cmd.path)
93 new_context.set_prompt(self.cmd_tree.name)
94 for grp_cmd in self.cmd_tree.get_subcommands():
95 self._register_command(grp_cmd.path)
99 def greet(self, version):
100 print('kamaki v%s - Interactive Shell\n' % version)
101 print('\t/exit \tterminate kamaki')
102 print('\texit or ^D\texit context')
103 print('\t? or help \tavailable commands')
104 print('\t?command \thelp on command')
105 print('\t!<command>\texecute OS shell command')
108 def set_prompt(self, new_prompt):
109 self.prompt = '%s%s%s' % (self._prefix, new_prompt, self._suffix)
115 except KeyboardInterrupt:
116 print(' - interrupted')
120 def do_exit(self, line):
122 start, end = len(self._prefix), -len(self._suffix)
123 if self.prompt[start:end] == self.cmd_tree.name:
127 def do_shell(self, line):
128 output = popen(line).read()
134 return self._cmd.path
138 def _register_method(self, method, name):
139 self.__dict__[name] = method
142 def _unregister_method(self, name):
144 self.__dict__.pop(name)
148 def _roll_command(self, cmd_path=None):
149 for subname in self.cmd_tree.get_subnames(cmd_path):
150 self._unregister_method('do_%s' % subname)
151 self._unregister_method('complete_%s' % subname)
152 self._unregister_method('help_%s' % subname)
156 return dict(self.__dict__)
159 def _restore(self, oldcontext):
160 self.__dict__ = oldcontext
163 def _create_help_method(cmd_name, args, descr):
164 tmp_args = dict(args)
165 tmp_args.pop('options', None)
166 tmp_args.pop('debug', None)
167 tmp_args.pop('verbose', None)
168 tmp_args.pop('include', None)
169 tmp_args.pop('silent', None)
170 tmp_args.pop('config', None)
171 help_parser = ArgumentParseManager(cmd_name, tmp_args)
172 help_parser.parser.description = descr
173 return help_parser.parser.print_help
175 def _register_command(self, cmd_path):
176 cmd = self.cmd_tree.get_command(cmd_path)
177 arguments = self._parser.arguments
179 def do_method(new_context, line):
180 """ Template for all cmd.Cmd methods of the form do_<cmd name>
181 Parse cmd + args and decide to execute or change context
182 <cmd> <term> <term> <args> is always parsed to most specific
183 even if cmd_term_term is not a terminal path
185 subcmd, cmd_args = cmd.parse_out(split_input(line))
186 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
187 cmd_parser = ArgumentParseManager(
188 cmd.name, dict(self._parser.arguments))
189 cmd_parser.parser.description = subcmd.help
191 # exec command or change context
192 if subcmd.is_command: # exec command
194 cls = subcmd.get_class()
195 ldescr = getattr(cls, 'long_description', '')
196 if subcmd.path == 'history_run':
198 dict(cmd_parser.arguments),
201 instance = cls(dict(cmd_parser.arguments))
202 cmd_parser.update_arguments(instance.arguments)
203 #instance.arguments.pop('config')
204 cmd_parser.arguments = instance.arguments
205 cmd_parser.syntax = '%s %s' % (
206 subcmd.path.replace('_', ' '), cls.syntax)
207 help_method = self._create_help_method(
208 cmd.name, cmd_parser.arguments, subcmd.help)
209 if '-h' in cmd_args or '--help' in cmd_args:
215 cmd_parser.parse(cmd_args)
217 for name, arg in instance.arguments.items():
223 exec_cmd(instance, cmd_parser.unparsed, help_method)
224 #[term for term in cmd_parser.unparsed\
225 # if not term.startswith('-')],
226 except (ClientError, CLIError) as err:
227 print_error_message(err)
228 elif ('-h' in cmd_args or '--help' in cmd_args) or len(cmd_args):
230 print('%s' % cmd.help)
231 print_subcommands_help(cmd)
232 else: # change context
234 backup_context = self._backup()
235 old_prompt = self.prompt
236 new_context._roll_command(cmd.parent_path)
237 new_context.set_prompt(subcmd.path.replace('_', ' '))
238 newcmds = [subcmd for subcmd in subcmd.get_subcommands()]
239 for subcmd in newcmds:
240 new_context._register_command(subcmd.path)
241 new_context.cmdloop()
242 self.prompt = old_prompt
243 #when new context is over, roll back to the old one
244 self._restore(backup_context)
245 self._register_method(do_method, 'do_%s' % cmd.name)
247 def help_method(self):
248 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
250 cls = cmd.get_class()
251 ldescr = getattr(cls, 'long_description', '')
252 #_construct_command_syntax(cls)
253 plist = self.prompt[len(self._prefix):-len(self._suffix)]
254 plist = plist.split(' ')
255 clist = cmd.path.split('_')
259 for i, term in enumerate(plist):
265 print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax))
267 print_subcommands_help(cmd)
269 self._register_method(help_method, 'help_%s' % cmd.name)
271 def complete_method(self, text, line, begidx, endidx):
272 subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
273 if subcmd.is_command:
274 cls = subcmd.get_class()
275 instance = cls(dict(arguments))
276 empty, sep, subname = subcmd.path.partition(cmd.path)
277 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
278 print('\n%s\nSyntax:\t%s %s' % (
283 for arg in instance.arguments.values():
284 cmd_args[','.join(arg.parsed_name)] = arg.help
285 print_dict(cmd_args, ident=2)
286 stdout.write('%s %s' % (self.prompt, line))
287 return subcmd.get_subnames()
288 self._register_method(complete_method, 'complete_%s' % cmd.name)
291 def doc_header(self):
292 tmp_partition = self.prompt.partition(self._prefix)
293 tmp_partition = tmp_partition[2].partition(self._suffix)
294 hdr = tmp_partition[0].strip()
295 return '%s commands:' % hdr
297 def run(self, parser, path=''):
298 self._parser = parser
299 self._history = History(
300 parser.arguments['config'].get('history', 'file'))
302 cmd = self.cmd_tree.get_command(path)
303 intro = cmd.path.replace('_', ' ')
305 intro = self.cmd_tree.name
307 for subcmd in self.cmd_tree.get_subcommands(path):
308 self._register_command(subcmd.path)
310 self.set_prompt(intro)
314 except Exception as e:
316 from traceback import print_stack