1 # Copyright 2012-2013 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, username='', userid=''):
50 parser.arguments.pop('version', None)
52 shell.set_prompt(exe_string)
53 from kamaki import __version__ as version
54 shell.greet(version, username, userid)
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:'
79 def postcmd(self, post, line):
80 if self._context_stack:
82 self._restore(self._context_stack.pop())
84 self._prompt_stack.pop()[len(self._prefix):-len(self._suffix)])
86 return Cmd.postcmd(self, post, line)
88 def precmd(self, line):
89 if line.startswith('/'):
90 start, end = len(self._prefix), -len(self._suffix)
91 cur_cmd_path = self.prompt.replace(' ', '_')[start:end]
92 if cur_cmd_path != self.cmd_tree.name:
93 cur_cmd = self.cmd_tree.get_command(cur_cmd_path)
94 self._context_stack.append(self._backup())
95 self._prompt_stack.append(self.prompt)
97 self._roll_command(cur_cmd.path)
98 new_context.set_prompt(self.cmd_tree.name)
99 for grp_cmd in self.cmd_tree.get_subcommands():
100 self._register_command(grp_cmd.path)
104 def greet(self, version, username='', userid=''):
105 print('kamaki v%s - Interactive Shell\n' % version)
106 print('\t/exit \tterminate kamaki')
107 print('\texit or ^D\texit context')
108 print('\t? or help \tavailable commands')
109 print('\t?command \thelp on command')
110 print('\t!<command>\texecute OS shell command')
112 if username or userid:
113 print('Session user is %s (uuid: %s)' % (username, userid))
115 def set_prompt(self, new_prompt):
116 self.prompt = '%s%s%s' % (self._prefix, new_prompt, self._suffix)
122 except KeyboardInterrupt:
123 print(' - interrupted')
127 def do_exit(self, line):
129 start, end = len(self._prefix), -len(self._suffix)
130 if self.prompt[start:end] == self.cmd_tree.name:
134 def do_shell(self, line):
135 output = popen(line).read()
141 return self._cmd.path
145 def _register_method(self, method, name):
146 self.__dict__[name] = method
149 def _unregister_method(self, name):
151 self.__dict__.pop(name)
155 def _roll_command(self, cmd_path=None):
156 for subname in self.cmd_tree.subnames(cmd_path):
157 self._unregister_method('do_%s' % subname)
158 self._unregister_method('complete_%s' % subname)
159 self._unregister_method('help_%s' % subname)
163 return dict(self.__dict__)
166 def _restore(self, oldcontext):
167 self.__dict__ = oldcontext
170 def _create_help_method(cmd_name, args, descr, syntax):
171 tmp_args = dict(args)
172 tmp_args.pop('options', None)
173 tmp_args.pop('cloud', None)
174 tmp_args.pop('debug', None)
175 tmp_args.pop('verbose', None)
176 tmp_args.pop('include', None)
177 tmp_args.pop('silent', None)
178 tmp_args.pop('config', None)
179 help_parser = ArgumentParseManager(cmd_name, tmp_args)
180 help_parser.parser.description = descr
181 help_parser.syntax = syntax
182 return help_parser.parser.print_help
184 def _register_command(self, cmd_path):
185 cmd = self.cmd_tree.get_command(cmd_path)
186 arguments = self._parser.arguments
188 def do_method(new_context, line):
189 """ Template for all cmd.Cmd methods of the form do_<cmd name>
190 Parse cmd + args and decide to execute or change context
191 <cmd> <term> <term> <args> is always parsed to most specific
192 even if cmd_term_term is not a terminal path
194 subcmd, cmd_args = cmd.parse_out(split_input(line))
195 self._history.add(' '.join([cmd.path.replace('_', ' '), line]))
196 cmd_parser = ArgumentParseManager(
197 cmd.name, dict(self._parser.arguments))
198 cmd_parser.parser.description = subcmd.help
200 # exec command or change context
201 if subcmd.is_command: # exec command
203 cls = subcmd.cmd_class
204 ldescr = getattr(cls, 'long_description', '')
205 if subcmd.path == 'history_run':
207 dict(cmd_parser.arguments), self.auth_base,
208 cmd_tree=self.cmd_tree)
211 dict(cmd_parser.arguments),
212 self.auth_base, self.cloud)
213 cmd_parser.update_arguments(instance.arguments)
214 cmd_parser.arguments = instance.arguments
215 cmd_parser.syntax = '%s %s' % (
216 subcmd.path.replace('_', ' '), cls.syntax)
217 help_method = self._create_help_method(
218 cmd.name, cmd_parser.arguments,
219 subcmd.help, cmd_parser.syntax)
220 if '-h' in cmd_args or '--help' in cmd_args:
226 cmd_parser.parse(cmd_args)
228 for name, arg in instance.arguments.items():
230 cmd_parser.parsed, name, arg.default)
232 exec_cmd(instance, cmd_parser.unparsed, help_method)
233 #[term for term in cmd_parser.unparsed\
234 # if not term.startswith('-')],
235 except (ClientError, CLIError) as err:
236 print_error_message(err)
237 elif ('-h' in cmd_args or '--help' in cmd_args) or len(cmd_args):
239 print('%s' % cmd.help)
240 print_subcommands_help(cmd)
241 else: # change context
243 backup_context = self._backup()
244 old_prompt = self.prompt
245 new_context._roll_command(cmd.parent_path)
246 new_context.set_prompt(subcmd.path.replace('_', ' '))
247 newcmds = [subcmd for subcmd in subcmd.subcommands.values()]
248 for subcmd in newcmds:
249 new_context._register_command(subcmd.path)
250 new_context.cmdloop()
251 self.prompt = old_prompt
252 #when new context is over, roll back to the old one
253 self._restore(backup_context)
254 self._register_method(do_method, 'do_%s' % cmd.name)
256 def help_method(self):
257 print('%s (%s -h for more options)' % (cmd.help, cmd.name))
260 ldescr = getattr(cls, 'long_description', '')
261 #_construct_command_syntax(cls)
262 plist = self.prompt[len(self._prefix):-len(self._suffix)]
263 plist = plist.split(' ')
264 clist = cmd.path.split('_')
268 for i, term in enumerate(plist):
274 print('Syntax: %s %s' % (' '.join(clist[upto:]), cls.syntax))
276 print_subcommands_help(cmd)
278 self._register_method(help_method, 'help_%s' % cmd.name)
280 def complete_method(self, text, line, begidx, endidx):
281 subcmd, cmd_args = cmd.parse_out(split_input(line)[1:])
282 if subcmd.is_command:
283 cls = subcmd.cmd_class
284 instance = cls(dict(arguments))
285 empty, sep, subname = subcmd.path.partition(cmd.path)
286 cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' '))
287 print('\n%s\nSyntax:\t%s %s' % (
288 cls.help, cmd_name, cls.syntax))
290 for arg in instance.arguments.values():
291 cmd_args[','.join(arg.parsed_name)] = arg.help
292 print_dict(cmd_args, indent=2)
293 stdout.write('%s %s' % (self.prompt, line))
294 return subcmd.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 acceptable = parser.arguments['config'].groups
317 total = self.cmd_tree.groups.keys()
318 self.cmd_tree.exclude(set(total).difference(acceptable))
320 for subcmd in self.cmd_tree.get_subcommands(path):
321 self._register_command(subcmd.path)
323 self.set_prompt(intro)
327 except Exception as e:
329 from traceback import print_stack