1
# Copyright (C) 2004, 2005 Aaron Bentley
2
# <aaron@aaronbentley.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from itertools import chain
32
from bzrlib import osutils, trace
33
from bzrlib.branch import Branch
34
from bzrlib.config import config_dir, ensure_config_dir_exists
35
from bzrlib.commands import get_cmd_object, all_command_names, get_alias
36
from bzrlib.errors import BzrError
37
from bzrlib.workingtree import WorkingTree
42
SHELL_BLACKLIST = set(['rm', 'ls'])
43
COMPLETION_BLACKLIST = set(['shell'])
46
class BlackListedCommand(BzrError):
47
def __init__(self, command):
48
BzrError.__init__(self, "The command %s is blacklisted for shell use" %
52
class CompletionContext(object):
53
def __init__(self, text, command=None, prev_opt=None, arg_pos=None):
55
self.command = command
56
self.prev_opt = prev_opt
59
def get_completions(self):
61
return self.get_completions_or_raise()
66
def get_option_completions(self):
68
command_obj = get_cmd_object(self.command)
71
opts = [o+" " for o in iter_opt_completions(command_obj)]
72
return list(filter_completions(opts, self.text))
74
def get_completions_or_raise(self):
75
if self.command is None:
77
iter = iter_executables(self.text)
79
iter = (c+" " for c in iter_command_names() if
80
c not in COMPLETION_BLACKLIST)
81
return list(filter_completions(iter, self.text))
82
if self.prev_opt is None:
83
completions = self.get_option_completions()
84
if self.command == "cd":
85
iter = iter_dir_completions(self.text)
86
completions.extend(list(filter_completions(iter, self.text)))
88
iter = iter_file_completions(self.text)
89
completions.extend(filter_completions(iter, self.text))
93
class PromptCmd(cmd.Cmd):
96
cmd.Cmd.__init__(self)
99
self.tree = WorkingTree.open_containing('.')[0]
104
self.identchars += '-'
105
ensure_config_dir_exists()
106
self.history_file = osutils.pathjoin(config_dir(), 'shell-history')
107
whitespace = ''.join(c for c in string.whitespace if c < chr(127))
109
readline.set_completer_delims(whitespace)
110
if os.access(self.history_file, os.R_OK) and \
111
os.path.isfile(self.history_file):
112
readline.read_history_file(self.history_file)
113
self.cwd = os.getcwd()
115
def write_history(self):
117
readline.write_history_file(self.history_file)
119
def do_quit(self, args):
123
def do_exit(self, args):
126
def do_EOF(self, args):
130
def postcmd(self, line, bar):
134
def set_prompt(self):
135
if self.tree is not None:
137
prompt_data = (self.tree.branch.nick, self.tree.branch.revno(),
138
self.tree.relpath('.'))
139
prompt = " %s:%d/%s" % prompt_data
144
self.prompt = "bzr%s> " % prompt
146
def set_title(self, command=None):
148
b = Branch.open_containing('.')[0]
149
version = "%s:%d" % (b.nick, b.revno())
151
version = "[no version]"
154
sys.stdout.write(terminal.term_title("bzr %s %s" % (command, version)))
156
def do_cd(self, line):
159
line = os.path.expanduser(line)
160
if os.path.isabs(line):
163
newcwd = self.cwd+'/'+line
164
newcwd = os.path.normpath(newcwd)
171
self.tree = WorkingTree.open_containing(".")[0]
175
def do_help(self, line):
176
self.default("help "+line)
178
def default(self, line):
180
args = shlex.split(line)
181
except ValueError, e:
182
print 'Parse error:', e
185
alias_args = get_alias(args[0])
186
if alias_args is not None:
187
args[0] = alias_args.pop(0)
189
commandname = args.pop(0)
190
for char in ('|', '<', '>'):
191
commandname = commandname.split(char)[0]
192
if commandname[-1] in ('|', '<', '>'):
193
commandname = commandname[:-1]
195
if commandname in SHELL_BLACKLIST:
196
raise BlackListedCommand(commandname)
197
cmd_obj = get_cmd_object(commandname)
198
except (BlackListedCommand, BzrError):
199
return os.system(line)
202
is_qbzr = cmd_obj.__module__.startswith('bzrlib.plugins.qbzr.')
203
if too_complicated(line) or is_qbzr:
204
return os.system("bzr "+line)
206
return (cmd_obj.run_argv_aliases(args, alias_args) or 0)
208
trace.log_exception_quietly()
210
except KeyboardInterrupt, e:
213
trace.log_exception_quietly()
214
print "Unhandled error:\n%s" % (e)
217
def completenames(self, text, line, begidx, endidx):
218
return CompletionContext(text).get_completions()
220
def completedefault(self, text, line, begidx, endidx):
221
"""Perform completion for native commands.
223
:param text: The text to complete
225
:param line: The entire line to complete
227
:param begidx: The start of the text in the line
229
:param endidx: The end of the text in the line
232
(cmd, args, foo) = self.parseline(line)
235
return CompletionContext(text, command=cmd).get_completions()
238
def run_shell(directory=None):
240
if not directory is None:
247
except KeyboardInterrupt:
250
prompt.write_history()
251
except StopIteration:
255
def iter_opt_completions(command_obj):
256
for option_name, option in command_obj.options().items():
257
yield "--" + option_name
258
short_name = option.short_name()
260
yield "-" + short_name
263
def iter_file_completions(arg, only_dirs = False):
264
"""Generate an iterator that iterates through filename completions.
266
:param arg: The filename fragment to match
268
:param only_dirs: If true, match only directories
269
:type only_dirs: bool
276
(dir, file) = os.path.split(arg)
278
listingdir = os.path.expanduser(dir)
281
for file in chain(os.listdir(listingdir), extras):
283
userfile = dir+'/'+file
286
if userfile.startswith(arg):
287
if os.path.isdir(listingdir+'/'+file):
294
def iter_dir_completions(arg):
295
"""Generate an iterator that iterates through directory name completions.
297
:param arg: The directory name fragment to match
300
return iter_file_completions(arg, True)
303
def iter_command_names(hidden=False):
304
for real_cmd_name in all_command_names():
305
cmd_obj = get_cmd_object(real_cmd_name)
306
if not hidden and cmd_obj.hidden:
308
for name in [real_cmd_name] + cmd_obj.aliases:
309
# Don't complete on aliases that are prefixes of the canonical name
310
if name == real_cmd_name or not real_cmd_name.startswith(name):
314
def iter_executables(path):
315
dirname, partial = os.path.split(path)
316
for filename in os.listdir(dirname):
317
if not filename.startswith(partial):
319
fullpath = os.path.join(dirname, filename)
320
mode=os.lstat(fullpath)[stat.ST_MODE]
321
if stat.S_ISREG(mode) and 0111 & mode:
325
def filter_completions(iter, arg):
326
return (c for c in iter if c.startswith(arg))
329
def iter_munged_completions(iter, arg, text):
330
for completion in iter:
331
completion = str(completion)
332
if completion.startswith(arg):
333
yield completion[len(arg)-len(text):]+" "
336
def too_complicated(line):
added
removed
shell.py
