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, trace
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, all_command_names, 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
whitespace = ''.join(c for c in string.whitespace if c < chr(127))
103
readline.set_completer_delims(whitespace)
104
if os.access(self.history_file, os.R_OK) and \
105
os.path.isfile(self.history_file):
106
readline.read_history_file(self.history_file)
107
self.cwd = os.getcwd()
109
def write_history(self):
110
readline.write_history_file(self.history_file)
112
def do_quit(self, args):
116
def do_exit(self, args):
119
def do_EOF(self, args):
123
def postcmd(self, line, bar):
127
def set_prompt(self):
128
if self.tree is not None:
130
prompt_data = (self.tree.branch.nick, self.tree.branch.revno(),
131
self.tree.relpath('.'))
132
prompt = " %s:%d/%s" % prompt_data
137
self.prompt = "bzr%s> " % prompt
139
def set_title(self, command=None):
141
b = Branch.open_containing('.')[0]
142
version = "%s:%d" % (b.nick, b.revno())
144
version = "[no version]"
147
sys.stdout.write(terminal.term_title("bzr %s %s" % (command, version)))
149
def do_cd(self, line):
152
line = os.path.expanduser(line)
153
if os.path.isabs(line):
156
newcwd = self.cwd+'/'+line
157
newcwd = os.path.normpath(newcwd)
164
self.tree = WorkingTree.open_containing(".")[0]
168
def do_help(self, line):
169
self.default("help "+line)
171
def default(self, line):
173
args = shlex.split(line)
174
except ValueError, e:
175
print 'Parse error:', e
178
alias_args = get_alias(args[0])
179
if alias_args is not None:
180
args[0] = alias_args.pop(0)
182
commandname = args.pop(0)
183
for char in ('|', '<', '>'):
184
commandname = commandname.split(char)[0]
185
if commandname[-1] in ('|', '<', '>'):
186
commandname = commandname[:-1]
188
if commandname in SHELL_BLACKLIST:
189
raise BlackListedCommand(commandname)
190
cmd_obj = get_cmd_object(commandname)
191
except (BlackListedCommand, BzrError):
192
return os.system(line)
195
is_qbzr = cmd_obj.__module__.startswith('bzrlib.plugins.qbzr.')
196
if too_complicated(line) or is_qbzr:
197
return os.system("bzr "+line)
199
return (cmd_obj.run_argv_aliases(args, alias_args) or 0)
201
trace.log_exception_quietly()
203
except KeyboardInterrupt, e:
206
trace.log_exception_quietly()
207
print "Unhandled error:\n%s" % (e)
210
def completenames(self, text, line, begidx, endidx):
211
return CompletionContext(text).get_completions()
213
def completedefault(self, text, line, begidx, endidx):
214
"""Perform completion for native commands.
216
:param text: The text to complete
218
:param line: The entire line to complete
220
:param begidx: The start of the text in the line
222
:param endidx: The end of the text in the line
225
(cmd, args, foo) = self.parseline(line)
228
return CompletionContext(text, command=cmd).get_completions()
231
def run_shell(directory=None):
233
if not directory is None:
240
except KeyboardInterrupt:
243
prompt.write_history()
244
except StopIteration:
248
def iter_opt_completions(command_obj):
249
for option_name, option in command_obj.options().items():
250
yield "--" + option_name
251
short_name = option.short_name()
253
yield "-" + short_name
256
def iter_file_completions(arg, only_dirs = False):
257
"""Generate an iterator that iterates through filename completions.
259
:param arg: The filename fragment to match
261
:param only_dirs: If true, match only directories
262
:type only_dirs: bool
269
(dir, file) = os.path.split(arg)
271
listingdir = os.path.expanduser(dir)
274
for file in chain(os.listdir(listingdir), extras):
276
userfile = dir+'/'+file
279
if userfile.startswith(arg):
280
if os.path.isdir(listingdir+'/'+file):
287
def iter_dir_completions(arg):
288
"""Generate an iterator that iterates through directory name completions.
290
:param arg: The directory name fragment to match
293
return iter_file_completions(arg, True)
296
def iter_command_names(hidden=False):
297
for real_cmd_name in all_command_names():
298
cmd_obj = get_cmd_object(real_cmd_name)
299
if not hidden and cmd_obj.hidden:
301
for name in [real_cmd_name] + cmd_obj.aliases:
302
# Don't complete on aliases that are prefixes of the canonical name
303
if name == real_cmd_name or not real_cmd_name.startswith(name):
307
def iter_executables(path):
308
dirname, partial = os.path.split(path)
309
for filename in os.listdir(dirname):
310
if not filename.startswith(partial):
312
fullpath = os.path.join(dirname, filename)
313
mode=os.lstat(fullpath)[stat.ST_MODE]
314
if stat.S_ISREG(mode) and 0111 & mode:
318
def filter_completions(iter, arg):
319
return (c for c in iter if c.startswith(arg))
322
def iter_munged_completions(iter, arg, text):
323
for completion in iter:
324
completion = str(completion)
325
if completion.startswith(arg):
326
yield completion[len(arg)-len(text):]+" "
329
def too_complicated(line):
added
removed
shell.py
