22
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
24
from bzrlib.osutils import quotefn
25
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
32
def register_command(cmd):
33
"Utility function to help register a command"
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
29
47
def _squish_command_name(cmd):
30
48
return 'cmd_' + cmd.replace('-', '_')
72
"""Return canonical name and class for all registered commands."""
91
def _get_cmd_dict(plugins_override=True):
73
93
for k, v in globals().iteritems():
74
94
if k.startswith("cmd_"):
75
yield _unsquish_command_name(k), v
77
def get_cmd_class(cmd):
95
d[_unsquish_command_name(k)] = v
96
# If we didn't load plugins, the plugin_cmds dict will be empty
100
d2 = plugin_cmds.copy()
106
def get_all_cmds(plugins_override=True):
107
"""Return canonical name and class for all registered commands."""
108
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
112
def get_cmd_class(cmd, plugins_override=True):
78
113
"""Return the canonical name and command class for a command.
80
115
cmd = str(cmd) # not unicode
82
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
84
return cmd, globals()[_squish_command_name(cmd)]
120
return cmd, cmds[cmd]
88
124
# look for any command which claims this as an alias
89
for cmdname, cmdclass in get_all_cmds():
125
for cmdname, cmdclass in cmds.iteritems():
90
126
if cmd in cmdclass.aliases:
91
127
return cmdname, cmdclass
177
213
def __init__(self, path):
180
# TODO: If either of these fail, we should detect that and
181
# assume that path is not really a bzr plugin after all.
183
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
184
217
self.takes_options = pipe.readline().split()
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
224
# TODO: Is there any way to check takes_args is valid here?
185
225
self.takes_args = pipe.readline().split()
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
188
230
pipe = os.popen('%s --bzr-help' % path, 'r')
189
231
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
192
235
def __call__(self, options, arguments):
193
236
Command.__init__(self, options, arguments)
454
class cmd_pull(Command):
455
"""Pull any changes from another branch into the current one.
457
If the location is omitted, the last-used location will be used.
458
Both the revision history and the working directory will be
461
This command only works on branches that have not diverged. Branches are
462
considered diverged if both branches have had commits without first
463
pulling from the other.
465
If branches have diverged, you can use 'bzr merge' to pull the text changes
466
from one into the other.
468
takes_args = ['location?']
470
def run(self, location=None):
471
from bzrlib.merge import merge
473
from shutil import rmtree
479
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
481
if e.errno != errno.ENOENT:
484
if stored_loc is None:
485
raise BzrCommandError("No pull location known or specified.")
487
print "Using last location: %s" % stored_loc
488
location = stored_loc
489
cache_root = tempfile.mkdtemp()
491
from branch import find_cached_branch, DivergedBranches
492
br_from = find_cached_branch(location, cache_root)
493
location = pull_loc(br_from)
494
old_revno = br_to.revno()
496
br_to.update_revisions(br_from)
497
except DivergedBranches:
498
raise BzrCommandError("These branches have diverged."
501
merge(('.', -1), ('.', old_revno), check_clean=False)
502
if location != stored_loc:
503
br_to.controlfile("x-pull", "wb").write(location + "\n")
509
class cmd_branch(Command):
510
"""Create a new copy of a branch.
512
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
513
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
515
To retrieve the branch as of a particular revision, supply the --revision
516
parameter, as in "branch foo/bar -r 5".
518
takes_args = ['from_location', 'to_location?']
519
takes_options = ['revision']
521
def run(self, from_location, to_location=None, revision=None):
523
from bzrlib.merge import merge
524
from branch import find_cached_branch, DivergedBranches, NoSuchRevision
525
from shutil import rmtree
526
from meta_store import CachedStore
528
cache_root = tempfile.mkdtemp()
531
br_from = find_cached_branch(from_location, cache_root)
533
if e.errno == errno.ENOENT:
534
raise BzrCommandError('Source location "%s" does not'
535
' exist.' % to_location)
539
if to_location is None:
540
to_location = os.path.basename(from_location.rstrip("/\\"))
543
os.mkdir(to_location)
545
if e.errno == errno.EEXIST:
546
raise BzrCommandError('Target directory "%s" already'
547
' exists.' % to_location)
548
if e.errno == errno.ENOENT:
549
raise BzrCommandError('Parent of "%s" does not exist.' %
553
br_to = Branch(to_location, init=True)
556
br_to.update_revisions(br_from, stop_revision=revision)
557
except NoSuchRevision:
559
msg = "The branch %s has no revision %d." % (from_location,
561
raise BzrCommandError(msg)
562
merge((to_location, -1), (to_location, 0), this_dir=to_location,
563
check_clean=False, ignore_zero=True)
564
from_location = pull_loc(br_from)
565
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
570
def pull_loc(branch):
571
# TODO: Should perhaps just make attribute be 'base' in
572
# RemoteBranch and Branch?
573
if hasattr(branch, "baseurl"):
574
return branch.baseurl
387
580
class cmd_renames(Command):
388
581
"""Show list of renamed files.
834
1027
class cmd_export(Command):
835
1028
"""Export past revision to destination directory.
837
If no revision is specified this exports the last committed revision."""
1030
If no revision is specified this exports the last committed revision.
1032
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1033
given, exports to a directory (equivalent to --format=dir)."""
1034
# TODO: list known exporters
838
1035
takes_args = ['dest']
839
takes_options = ['revision']
840
def run(self, dest, revision=None):
1036
takes_options = ['revision', 'format']
1037
def run(self, dest, revision=None, format='dir'):
842
1039
if revision == None:
843
1040
rh = b.revision_history()[-1]
845
1042
rh = b.lookup_revision(int(revision))
846
1043
t = b.revision_tree(rh)
1044
t.export(dest, format)
850
1047
class cmd_cat(Command):
890
1087
def run(self, message=None, file=None, verbose=True, selected_list=None):
891
1088
from bzrlib.commit import commit
1089
from bzrlib.osutils import get_text_message
893
1091
## Warning: shadows builtin file()
894
1092
if not message and not file:
895
raise BzrCommandError("please specify a commit message",
896
["use either --message or --file"])
1095
catcher = cStringIO.StringIO()
1096
sys.stdout = catcher
1097
cmd_status({"file_list":selected_list}, {})
1098
info = catcher.getvalue()
1100
message = get_text_message(info)
1103
raise BzrCommandError("please specify a commit message",
1104
["use either --message or --file"])
897
1105
elif message and file:
898
1106
raise BzrCommandError("please specify either --message or --file")
979
1213
parsed = [spec, None]
982
1218
class cmd_merge(Command):
983
"""Perform a three-way merge of trees."""
984
takes_args = ['other_spec', 'base_spec']
986
def run(self, other_spec, base_spec):
987
from bzrlib.merge import merge
988
merge(parse_spec(other_spec), parse_spec(base_spec))
1219
"""Perform a three-way merge of trees.
1221
The SPEC parameters are working tree or revision specifiers. Working trees
1222
are specified using standard paths or urls. No component of a directory
1223
path may begin with '@'.
1225
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1227
Revisions are specified using a dirname/@revno pair, where dirname is the
1228
branch directory and revno is the revision within that branch. If no revno
1229
is specified, the latest revision is used.
1231
Revision examples: './@127', 'foo/@', '../@1'
1233
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1234
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1237
merge refuses to run if there are any uncommitted changes, unless
1240
takes_args = ['other_spec', 'base_spec?']
1241
takes_options = ['force']
1243
def run(self, other_spec, base_spec=None, force=False):
1244
from bzrlib.merge import merge
1245
merge(parse_spec(other_spec), parse_spec(base_spec),
1246
check_clean=(not force))
1250
class cmd_revert(Command):
1251
"""Restore selected files from a previous revision.
1253
takes_args = ['file+']
1254
def run(self, file_list):
1255
from bzrlib.branch import find_branch
1260
b = find_branch(file_list[0])
1262
b.revert([b.relpath(f) for f in file_list])
1265
class cmd_merge_revert(Command):
1266
"""Reverse all changes since the last commit.
1268
Only versioned files are affected.
1270
TODO: Store backups of any files that will be reverted, so
1271
that the revert can be undone.
1273
takes_options = ['revision']
1275
def run(self, revision=-1):
1276
from bzrlib.merge import merge
1277
merge(('.', revision), parse_spec('.'),
990
1282
class cmd_assert_fail(Command):
991
1283
"""Test reporting of assertion failures"""
1063
1368
(['status'], {'all': True})
1064
1369
>>> parse_args('commit --message=biter'.split())
1065
1370
(['commit'], {'message': u'biter'})
1371
>>> parse_args('log -r 500'.split())
1372
(['log'], {'revision': 500})
1373
>>> parse_args('log -r500:600'.split())
1374
(['log'], {'revision': [500, 600]})
1375
>>> parse_args('log -vr500:600'.split())
1376
(['log'], {'verbose': True, 'revision': [500, 600]})
1377
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1378
Traceback (most recent call last):
1380
ValueError: invalid literal for int(): v500
1083
1398
optname = a[2:]
1084
1399
if optname not in OPTIONS:
1085
bailout('unknown long option %r' % a)
1400
raise BzrError('unknown long option %r' % a)
1087
1402
shortopt = a[1:]
1088
if shortopt not in SHORT_OPTIONS:
1089
bailout('unknown short option %r' % a)
1090
optname = SHORT_OPTIONS[shortopt]
1403
if shortopt in SHORT_OPTIONS:
1404
# Multi-character options must have a space to delimit
1406
optname = SHORT_OPTIONS[shortopt]
1408
# Single character short options, can be chained,
1409
# and have their value appended to their name
1411
if shortopt not in SHORT_OPTIONS:
1412
# We didn't find the multi-character name, and we
1413
# didn't find the single char name
1414
raise BzrError('unknown short option %r' % a)
1415
optname = SHORT_OPTIONS[shortopt]
1418
# There are extra things on this option
1419
# see if it is the value, or if it is another
1421
optargfn = OPTIONS[optname]
1422
if optargfn is None:
1423
# This option does not take an argument, so the
1424
# next entry is another short option, pack it back
1426
argv.insert(0, '-' + a[2:])
1428
# This option takes an argument, so pack it
1092
1432
if optname in opts:
1093
1433
# XXX: Do we ever want to support this, e.g. for -r?
1094
bailout('repeated option %r' % a)
1434
raise BzrError('repeated option %r' % a)
1096
1436
optargfn = OPTIONS[optname]
1098
1438
if optarg == None:
1100
bailout('option %r needs an argument' % a)
1440
raise BzrError('option %r needs an argument' % a)
1102
1442
optarg = argv.pop(0)
1103
1443
opts[optname] = optargfn(optarg)
1105
1445
if optarg != None:
1106
bailout('option %r takes no argument' % optname)
1446
raise BzrError('option %r takes no argument' % optname)
1107
1447
opts[optname] = True
1500
def _parse_master_args(argv):
1501
"""Parse the arguments that always go with the original command.
1502
These are things like bzr --no-plugins, etc.
1504
There are now 2 types of option flags. Ones that come *before* the command,
1505
and ones that come *after* the command.
1506
Ones coming *before* the command are applied against all possible commands.
1507
And are generally applied before plugins are loaded.
1509
The current list are:
1510
--builtin Allow plugins to load, but don't let them override builtin commands,
1511
they will still be allowed if they do not override a builtin.
1512
--no-plugins Don't load any plugins. This lets you get back to official source
1514
--profile Enable the hotspot profile before running the command.
1515
For backwards compatibility, this is also a non-master option.
1516
--version Spit out the version of bzr that is running and exit.
1517
This is also a non-master option.
1518
--help Run help and exit, also a non-master option (I think that should stay, though)
1520
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1521
Traceback (most recent call last):
1523
BzrCommandError: Invalid master option: 'test'
1524
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1527
>>> print opts['version']
1529
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1531
['command', '--more-options']
1532
>>> print opts['profile']
1534
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1537
>>> print opts['no-plugins']
1539
>>> print opts['profile']
1541
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1543
['command', '--profile']
1544
>>> print opts['profile']
1547
master_opts = {'builtin':False,
1554
# This is the point where we could hook into argv[0] to determine
1555
# what front-end is supposed to be run
1556
# For now, we are just ignoring it.
1557
cmd_name = argv.pop(0)
1559
if arg[:2] != '--': # at the first non-option, we return the rest
1561
arg = arg[2:] # Remove '--'
1562
if arg not in master_opts:
1563
# We could say that this is not an error, that we should
1564
# just let it be handled by the main section instead
1565
raise BzrCommandError('Invalid master option: %r' % arg)
1566
argv.pop(0) # We are consuming this entry
1567
master_opts[arg] = True
1568
return argv, master_opts
1161
1572
def run_bzr(argv):
1162
1573
"""Execute a command.