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
27
from bzrlib import osutils
28
from bzrlib.branch import Branch
29
from bzrlib.config import config_dir, ensure_config_dir_exists
30
from bzrlib.commands import get_cmd_object, get_all_cmds, get_alias
31
from bzrlib.errors import BzrError
32
from bzrlib.workingtree import WorkingTree
37
SHELL_BLACKLIST = set(['rm', 'ls'])
38
COMPLETION_BLACKLIST = set(['shell'])
41
class BlackListedCommand(BzrError):
42
def __init__(self, command):
43
BzrError.__init__(self, "The command %s is blacklisted for shell use" %
47
class CompletionContext(object):
48
def __init__(self, text, command=None, prev_opt=None, arg_pos=None):
50
self.command = command
51
self.prev_opt = prev_opt
54
def get_completions(self):
56
return self.get_completions_or_raise()
61
def get_option_completions(self):
63
command_obj = get_cmd_object(self.command)
66
opts = [o+" " for o in iter_opt_completions(command_obj)]
67
return list(filter_completions(opts, self.text))
69
def get_completions_or_raise(self):
70
if self.command is None:
72
iter = iter_executables(self.text)
74
iter = (c+" " for c in iter_command_names() if
75
c not in COMPLETION_BLACKLIST)
76
return list(filter_completions(iter, self.text))
77
if self.prev_opt is None:
78
completions = self.get_option_completions()
79
if self.command == "cd":
80
iter = iter_dir_completions(self.text)
81
completions.extend(list(filter_completions(iter, self.text)))
83
iter = iter_file_completions(self.text)
84
completions.extend(filter_completions(iter, self.text))
88
class PromptCmd(cmd.Cmd):
91
cmd.Cmd.__init__(self)
94
self.tree = WorkingTree.open_containing('.')[0]
99
self.identchars += '-'
100
ensure_config_dir_exists()
101
self.history_file = osutils.pathjoin(config_dir(), 'shell-history')
102
readline.set_completer_delims(string.whitespace)
103
if os.access(self.history_file, os.R_OK) and \
104
os.path.isfile(self.history_file):
105
readline.read_history_file(self.history_file)
106
self.cwd = os.getcwd()
108
def write_history(self):
109
readline.write_history_file(self.history_file)
111
def do_quit(self, args):
115
def do_exit(self, args):
118
def do_EOF(self, args):
122
def postcmd(self, line, bar):
126
def set_prompt(self):
127
if self.tree is not None:
129
prompt_data = (self.tree.branch.nick, self.tree.branch.revno(),
130
self.tree.relpath('.'))
131
prompt = " %s:%d/%s" % prompt_data
136
self.prompt = "bzr%s> " % prompt
138
def set_title(self, command=None):
140
b = Branch.open_containing('.')[0]
141
version = "%s:%d" % (b.nick, b.revno())
143
version = "[no version]"
146
sys.stdout.write(terminal.term_title("bzr %s %s" % (command, version)))
148
def do_cd(self, line):
151
line = os.path.expanduser(line)
152
if os.path.isabs(line):
155
newcwd = self.cwd+'/'+line
156
newcwd = os.path.normpath(newcwd)
163
self.tree = WorkingTree.open_containing(".")[0]
167
def do_help(self, line):
168
self.default("help "+line)
170
def default(self, line):
171
args = shlex.split(line)
172
alias_args = get_alias(args[0])
173
if alias_args is not None:
174
args[0] = alias_args.pop(0)
176
commandname = args.pop(0)
177
for char in ('|', '<', '>'):
178
commandname = commandname.split(char)[0]
179
if commandname[-1] in ('|', '<', '>'):
180
commandname = commandname[:-1]
182
if commandname in SHELL_BLACKLIST:
183
raise BlackListedCommand(commandname)
184
cmd_obj = get_cmd_object(commandname)
185
except (BlackListedCommand, BzrError):
186
return os.system(line)
189
if too_complicated(line):
190
return os.system("bzr "+line)
192
return (cmd_obj.run_argv_aliases(args, alias_args) or 0)
195
except KeyboardInterrupt, e:
198
# print "Unhandled error:\n%s" % errors.exception_str(e)
199
print "Unhandled error:\n%s" % (e)
202
def completenames(self, text, line, begidx, endidx):
203
return CompletionContext(text).get_completions()
205
def completedefault(self, text, line, begidx, endidx):
206
"""Perform completion for native commands.
208
:param text: The text to complete
210
:param line: The entire line to complete
212
:param begidx: The start of the text in the line
214
:param endidx: The end of the text in the line
217
(cmd, args, foo) = self.parseline(line)
220
return CompletionContext(text, command=cmd).get_completions()
229
prompt.write_history()
230
except StopIteration:
234
def iter_opt_completions(command_obj):
235
for option_name, option in command_obj.options().items():
236
yield "--" + option_name
237
short_name = option.short_name()
239
yield "-" + short_name
242
def iter_file_completions(arg, only_dirs = False):
243
"""Generate an iterator that iterates through filename completions.
245
:param arg: The filename fragment to match
247
:param only_dirs: If true, match only directories
248
:type only_dirs: bool
255
(dir, file) = os.path.split(arg)
257
listingdir = os.path.expanduser(dir)
260
for file in chain(os.listdir(listingdir), extras):
262
userfile = dir+'/'+file
265
if userfile.startswith(arg):
266
if os.path.isdir(listingdir+'/'+file):
273
def iter_dir_completions(arg):
274
"""Generate an iterator that iterates through directory name completions.
276
:param arg: The directory name fragment to match
279
return iter_file_completions(arg, True)
282
def iter_command_names(hidden=False):
283
for real_cmd_name, cmd_class in get_all_cmds():
284
if not hidden and cmd_class.hidden:
286
for name in [real_cmd_name] + cmd_class.aliases:
287
# Don't complete on aliases that are prefixes of the canonical name
288
if name == real_cmd_name or not real_cmd_name.startswith(name):
292
def iter_executables(path):
293
dirname, partial = os.path.split(path)
294
for filename in os.listdir(dirname):
295
if not filename.startswith(partial):
297
fullpath = os.path.join(dirname, filename)
298
mode=os.lstat(fullpath)[stat.ST_MODE]
299
if stat.S_ISREG(mode) and 0111 & mode:
303
def filter_completions(iter, arg):
304
return (c for c in iter if c.startswith(arg))
307
def iter_munged_completions(iter, arg, text):
308
for completion in iter:
309
completion = str(completion)
310
if completion.startswith(arg):
311
yield completion[len(arg)-len(text):]+" "
314
def too_complicated(line):
added
removed
shell.py
