15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Split the command framework away from the actual commands.
20
# TODO: probably should say which arguments are candidates for glob
21
# expansion on windows and do that at the command level.
27
from bzrlib.trace import mutter, note, log_error, warning
22
from bzrlib.trace import mutter, note, log_error
28
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
from bzrlib.branch import find_branch
30
from bzrlib import BZRDIR
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
36
def register_command(cmd):
32
def register_plugin_command(cmd):
37
33
"Utility function to help register a command"
56
52
assert cmd.startswith("cmd_")
57
53
return cmd[4:].replace('_','-')
60
55
def _parse_revision_str(revstr):
61
"""This handles a revision string -> revno.
63
This always returns a list. The list will have one element for
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
68
>>> _parse_revision_str('234')
70
>>> _parse_revision_str('234..567')
72
>>> _parse_revision_str('..')
74
>>> _parse_revision_str('..234')
76
>>> _parse_revision_str('234..')
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
80
>>> _parse_revision_str('234....789') # Error?
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
98
>>> _parse_revision_str('-5')
100
>>> _parse_revision_str('123a')
102
>>> _parse_revision_str('abc')
56
"""This handles a revision string -> revno.
58
There are several possibilities:
61
'234:345' -> [234, 345]
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
109
warning('Colon separator for revision numbers is deprecated.'
112
for rev in revstr.split(':'):
114
revs.append(int(rev))
119
for x in revstr.split('..'):
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
79
revs[0] = int(revs[0])
84
revs[1] = int(revs[1])
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
134
return merge_types[typestring][0]
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
145
91
def _get_cmd_dict(plugins_override=True):
242
185
class ExternalCommand(Command):
243
186
"""Class to wrap external commands.
245
We cheat a little here, when get_cmd_class() calls us we actually
246
give it back an object we construct that has the appropriate path,
247
help, options etc for the specified command.
249
When run_bzr() tries to instantiate that 'class' it gets caught by
250
the __call__ method, which we override to call the Command.__init__
251
method. That then calls our run method which is pretty straight
254
The only wrinkle is that we have to map bzr's dictionary of options
255
and arguments back into command line options and arguments for the
188
We cheat a little here, when get_cmd_class() calls us we actually give it back
189
an object we construct that has the appropriate path, help, options etc for the
192
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
193
method, which we override to call the Command.__init__ method. That then calls
194
our run method which is pretty straight forward.
196
The only wrinkle is that we have to map bzr's dictionary of options and arguments
197
back into command line options and arguments for the script.
259
200
def find_command(cls, cmd):
356
297
directory is shown. Otherwise, only the status of the specified
357
298
files or directories is reported. If a directory is given, status
358
299
is reported for everything inside that directory.
360
If a revision is specified, the changes since that revision are shown.
362
301
takes_args = ['file*']
363
takes_options = ['all', 'show-ids', 'revision']
302
takes_options = ['all', 'show-ids']
364
303
aliases = ['st', 'stat']
366
305
def run(self, all=False, show_ids=False, file_list=None):
368
b = find_branch(file_list[0])
307
b = Branch(file_list[0])
369
308
file_list = [b.relpath(x) for x in file_list]
370
309
# special case: only one path was given and it's the root
372
311
if file_list == ['']:
377
from bzrlib.status import show_status
378
show_status(b, show_unchanged=all, show_ids=show_ids,
379
specific_files=file_list)
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
382
320
class cmd_cat_revision(Command):
433
348
whether already versioned or not, are searched for files or
434
349
subdirectories that are neither versioned or ignored, and these
435
350
are added. This search proceeds recursively into versioned
436
directories. If no names are given '.' is assumed.
438
Therefore simply saying 'bzr add' will version all files that
353
Therefore simply saying 'bzr add .' will version all files that
439
354
are currently unknown.
441
356
TODO: Perhaps adding a file whose directly is not versioned should
442
357
recursively add that parent, rather than giving an error?
444
takes_args = ['file*']
359
takes_args = ['file+']
445
360
takes_options = ['verbose', 'no-recurse']
447
362
def run(self, file_list, verbose=False, no_recurse=False):
448
from bzrlib.add import smart_add
449
smart_add(file_list, verbose, not no_recurse)
453
class cmd_mkdir(Command):
454
"""Create a new versioned directory.
456
This is equivalent to creating the directory and then adding it.
458
takes_args = ['dir+']
460
def run(self, dir_list):
467
b.add([d], verbose=True)
363
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
470
366
class cmd_relpath(Command):
531
423
takes_args = ['from_name', 'to_name']
533
425
def run(self, from_name, to_name):
535
427
b.rename_one(b.relpath(from_name), b.relpath(to_name))
539
class cmd_mv(Command):
540
"""Move or rename a file.
543
bzr mv OLDNAME NEWNAME
544
bzr mv SOURCE... DESTINATION
546
If the last argument is a versioned directory, all the other names
547
are moved into it. Otherwise, there must be exactly two arguments
548
and the file is changed to a new name, which must not already exist.
550
Files cannot be moved between branches.
552
takes_args = ['names*']
553
def run(self, names_list):
554
if len(names_list) < 2:
555
raise BzrCommandError("missing file argument")
556
b = find_branch(names_list[0])
558
rel_names = [b.relpath(x) for x in names_list]
560
if os.path.isdir(names_list[-1]):
561
# move into existing directory
562
b.move(rel_names[:-1], rel_names[-1])
564
if len(names_list) != 2:
565
raise BzrCommandError('to mv multiple files the destination '
566
'must be a versioned directory')
567
b.move(rel_names[0], rel_names[1])
572
433
class cmd_pull(Command):
605
464
print "Using last location: %s" % stored_loc
606
465
location = stored_loc
607
cache_root = tempfile.mkdtemp()
608
from bzrlib.branch import DivergedBranches
466
from branch import find_branch, DivergedBranches
609
467
br_from = find_branch(location)
610
468
location = pull_loc(br_from)
611
469
old_revno = br_to.revno()
613
from branch import find_cached_branch, DivergedBranches
614
br_from = find_cached_branch(location, cache_root)
615
location = pull_loc(br_from)
616
old_revno = br_to.revno()
618
br_to.update_revisions(br_from)
619
except DivergedBranches:
620
raise BzrCommandError("These branches have diverged."
623
merge(('.', -1), ('.', old_revno), check_clean=False)
624
if location != stored_loc:
625
br_to.controlfile("x-pull", "wb").write(location + "\n")
471
br_to.update_revisions(br_from)
472
except DivergedBranches:
473
raise BzrCommandError("These branches have diverged. Try merge.")
475
merge(('.', -1), ('.', old_revno), check_clean=False)
476
if location != stored_loc:
477
br_to.controlfile("x-pull", "wb").write(location + "\n")
640
490
takes_args = ['from_location', 'to_location?']
641
491
takes_options = ['revision']
642
aliases = ['get', 'clone']
644
493
def run(self, from_location, to_location=None, revision=None):
646
495
from bzrlib.merge import merge
647
from bzrlib.branch import DivergedBranches, \
648
find_cached_branch, Branch
496
from branch import find_branch, DivergedBranches, NoSuchRevision
649
497
from shutil import rmtree
650
from meta_store import CachedStore
652
cache_root = tempfile.mkdtemp()
656
elif len(revision) > 1:
657
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
661
br_from = find_cached_branch(from_location, cache_root)
663
if e.errno == errno.ENOENT:
664
raise BzrCommandError('Source location "%s" does not'
665
' exist.' % to_location)
669
if to_location is None:
670
to_location = os.path.basename(from_location.rstrip("/\\"))
673
os.mkdir(to_location)
675
if e.errno == errno.EEXIST:
676
raise BzrCommandError('Target directory "%s" already'
677
' exists.' % to_location)
678
if e.errno == errno.ENOENT:
679
raise BzrCommandError('Parent of "%s" does not exist.' %
683
br_to = Branch(to_location, init=True)
685
br_to.set_root_id(br_from.get_root_id())
688
if revision[0] is None:
689
revno = br_from.revno()
691
revno, rev_id = br_from.get_revision_info(revision[0])
693
br_to.update_revisions(br_from, stop_revision=revno)
694
except bzrlib.errors.NoSuchRevision:
696
msg = "The branch %s has no revision %d." % (from_location,
698
raise BzrCommandError(msg)
700
merge((to_location, -1), (to_location, 0), this_dir=to_location,
701
check_clean=False, ignore_zero=True)
702
from_location = pull_loc(br_from)
703
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
499
br_from = find_branch(from_location)
501
if e.errno == errno.ENOENT:
502
raise BzrCommandError('Source location "%s" does not exist.' %
507
if to_location is None:
508
to_location = os.path.basename(from_location.rstrip("/\\"))
511
os.mkdir(to_location)
513
if e.errno == errno.EEXIST:
514
raise BzrCommandError('Target directory "%s" already exists.' %
516
if e.errno == errno.ENOENT:
517
raise BzrCommandError('Parent of "%s" does not exist.' %
521
br_to = Branch(to_location, init=True)
524
br_to.update_revisions(br_from, stop_revision=revision)
525
except NoSuchRevision:
527
msg = "The branch %s has no revision %d." % (from_location,
529
raise BzrCommandError(msg)
530
merge((to_location, -1), (to_location, 0), this_dir=to_location,
531
check_clean=False, ignore_zero=True)
532
from_location = pull_loc(br_from)
533
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
708
536
def pull_loc(branch):
912
734
"""List files modified in working tree."""
915
from bzrlib.delta import compare_trees
918
td = compare_trees(b.basis_tree(), b.working_tree())
920
for path, id, kind in td.modified:
739
inv = b.read_working_inventory()
740
sc = statcache.update_cache(b, inv)
741
basis = b.basis_tree()
742
basis_inv = basis.inventory
744
# We used to do this through iter_entries(), but that's slow
745
# when most of the files are unmodified, as is usually the
746
# case. So instead we iterate by inventory entry, and only
747
# calculate paths as necessary.
749
for file_id in basis_inv:
750
cacheentry = sc.get(file_id)
751
if not cacheentry: # deleted
753
ie = basis_inv[file_id]
754
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
755
path = inv.id2path(file_id)
959
795
-r revision requests a specific revision, -r :end or -r begin: are
962
--message allows you to give a regular expression, which will be evaluated
963
so that only matching entries will be displayed.
965
798
TODO: Make --revision support uuid: and hash: [future tag:] notation.
969
802
takes_args = ['filename?']
970
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
803
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
972
805
def run(self, filename=None, timezone='original',
979
from bzrlib.branch import find_branch
980
from bzrlib.log import log_formatter, show_log
810
from bzrlib import show_log, find_branch
983
813
direction = (forward and 'forward') or 'reverse'
1182
996
If no revision is specified this exports the last committed revision.
1184
998
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1185
given, try to find the format with the extension. If no extension
1186
is found exports to a directory (equivalent to --format=dir).
1188
Root may be the top directory for tar, tgz and tbz2 formats. If none
1189
is given, the top directory will be the root name of the file."""
999
given, exports to a directory (equivalent to --format=dir)."""
1190
1000
# TODO: list known exporters
1191
1001
takes_args = ['dest']
1192
takes_options = ['revision', 'format', 'root']
1193
def run(self, dest, revision=None, format=None, root=None):
1195
b = find_branch('.')
1196
if revision is None:
1197
rev_id = b.last_patch()
1002
takes_options = ['revision', 'format']
1003
def run(self, dest, revision=None, format='dir'):
1005
if revision == None:
1006
rh = b.revision_history()[-1]
1199
if len(revision) != 1:
1200
raise BzrError('bzr export --revision takes exactly 1 argument')
1201
revno, rev_id = b.get_revision_info(revision[0])
1202
t = b.revision_tree(rev_id)
1203
root, ext = os.path.splitext(dest)
1205
if ext in (".tar",):
1207
elif ext in (".gz", ".tgz"):
1209
elif ext in (".bz2", ".tbz2"):
1213
t.export(dest, format, root)
1008
rh = b.lookup_revision(int(revision))
1009
t = b.revision_tree(rh)
1010
t.export(dest, format)
1216
1013
class cmd_cat(Command):
1254
1047
TODO: Strict commit that fails if there are unknown or deleted files.
1256
1049
takes_args = ['selected*']
1257
takes_options = ['message', 'file', 'verbose', 'unchanged']
1050
takes_options = ['message', 'file', 'verbose']
1258
1051
aliases = ['ci', 'checkin']
1260
# TODO: Give better message for -s, --summary, used by tla people
1262
def run(self, message=None, file=None, verbose=True, selected_list=None,
1264
from bzrlib.errors import PointlessCommit
1265
from bzrlib.osutils import get_text_message
1053
def run(self, message=None, file=None, verbose=True, selected_list=None):
1054
from bzrlib.commit import commit
1267
1056
## Warning: shadows builtin file()
1268
1057
if not message and not file:
1269
# FIXME: Ugly; change status code to send to a provided function?
1273
catcher = cStringIO.StringIO()
1274
sys.stdout = catcher
1275
cmd_status({"file_list":selected_list}, {})
1276
info = catcher.getvalue()
1278
message = get_text_message(info)
1281
raise BzrCommandError("please specify a commit message",
1282
["use either --message or --file"])
1058
raise BzrCommandError("please specify a commit message",
1059
["use either --message or --file"])
1283
1060
elif message and file:
1284
1061
raise BzrCommandError("please specify either --message or --file")
1288
1065
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1290
b = find_branch('.')
1292
selected_list = [b.relpath(s) for s in selected_list]
1295
b.commit(message, verbose=verbose,
1296
specific_files=selected_list,
1297
allow_pointless=unchanged)
1298
except PointlessCommit:
1299
# FIXME: This should really happen before the file is read in;
1300
# perhaps prepare the commit; get the message; then actually commit
1301
raise BzrCommandError("no changes to commit",
1302
["use --unchanged to commit anyhow"])
1068
commit(b, message, verbose=verbose, specific_files=selected_list)
1305
1071
class cmd_check(Command):
1455
1193
--force is given.
1457
1195
takes_args = ['other_spec', 'base_spec?']
1458
takes_options = ['force', 'merge-type']
1196
takes_options = ['force']
1460
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1198
def run(self, other_spec, base_spec=None, force=False):
1461
1199
from bzrlib.merge import merge
1462
from bzrlib.merge_core import ApplyMerge3
1463
if merge_type is None:
1464
merge_type = ApplyMerge3
1465
1200
merge(parse_spec(other_spec), parse_spec(base_spec),
1466
check_clean=(not force), merge_type=merge_type)
1201
check_clean=(not force))
1469
1204
class cmd_revert(Command):
1470
1205
"""Reverse all changes since the last commit.
1472
Only versioned files are affected. Specify filenames to revert only
1473
those files. By default, any files that are changed will be backed up
1474
first. Backup files have a '~' appended to their name.
1207
Only versioned files are affected.
1209
TODO: Store backups of any files that will be reverted, so
1210
that the revert can be undone.
1476
takes_options = ['revision', 'no-backup']
1477
takes_args = ['file*']
1478
aliases = ['merge-revert']
1212
takes_options = ['revision']
1480
def run(self, revision=None, no_backup=False, file_list=None):
1214
def run(self, revision=-1):
1481
1215
from bzrlib.merge import merge
1482
if file_list is not None:
1483
if len(file_list) == 0:
1484
raise BzrCommandError("No files specified")
1485
if revision is None:
1487
elif len(revision) != 1:
1488
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1489
merge(('.', revision[0]), parse_spec('.'),
1216
merge(('.', revision), parse_spec('.'),
1490
1217
check_clean=False,
1492
backup_files=not no_backup,
1493
file_list=file_list)
1496
1221
class cmd_assert_fail(Command):
1586
1298
>>> parse_args('commit --message=biter'.split())
1587
1299
(['commit'], {'message': u'biter'})
1588
1300
>>> parse_args('log -r 500'.split())
1589
(['log'], {'revision': [500]})
1590
>>> parse_args('log -r500..600'.split())
1301
(['log'], {'revision': 500})
1302
>>> parse_args('log -r500:600'.split())
1591
1303
(['log'], {'revision': [500, 600]})
1592
>>> parse_args('log -vr500..600'.split())
1304
>>> parse_args('log -vr500:600'.split())
1593
1305
(['log'], {'verbose': True, 'revision': [500, 600]})
1594
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1595
(['log'], {'revision': ['v500', 600]})
1306
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1307
Traceback (most recent call last):
1309
ValueError: invalid literal for int(): v500
1429
def _parse_master_args(argv):
1430
"""Parse the arguments that always go with the original command.
1431
These are things like bzr --no-plugins, etc.
1433
There are now 2 types of option flags. Ones that come *before* the command,
1434
and ones that come *after* the command.
1435
Ones coming *before* the command are applied against all possible commands.
1436
And are generally applied before plugins are loaded.
1438
The current list are:
1439
--builtin Allow plugins to load, but don't let them override builtin commands,
1440
they will still be allowed if they do not override a builtin.
1441
--no-plugins Don't load any plugins. This lets you get back to official source
1443
--profile Enable the hotspot profile before running the command.
1444
For backwards compatibility, this is also a non-master option.
1445
--version Spit out the version of bzr that is running and exit.
1446
This is also a non-master option.
1447
--help Run help and exit, also a non-master option (I think that should stay, though)
1449
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1450
Traceback (most recent call last):
1452
BzrCommandError: Invalid master option: 'test'
1453
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1456
>>> print opts['version']
1458
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1460
['command', '--more-options']
1461
>>> print opts['profile']
1463
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1466
>>> print opts['no-plugins']
1468
>>> print opts['profile']
1470
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1472
['command', '--profile']
1473
>>> print opts['profile']
1476
master_opts = {'builtin':False,
1483
# This is the point where we could hook into argv[0] to determine
1484
# what front-end is supposed to be run
1485
# For now, we are just ignoring it.
1486
cmd_name = argv.pop(0)
1488
if arg[:2] != '--': # at the first non-option, we return the rest
1490
arg = arg[2:] # Remove '--'
1491
if arg not in master_opts:
1492
# We could say that this is not an error, that we should
1493
# just let it be handled by the main section instead
1494
raise BzrCommandError('Invalid master option: %r' % arg)
1495
argv.pop(0) # We are consuming this entry
1496
master_opts[arg] = True
1497
return argv, master_opts
1716
1501
def run_bzr(argv):
1717
1502
"""Execute a command.
1719
1504
This is similar to main(), but without all the trappings for
1720
1505
logging and error handling.
1723
The command-line arguments, without the program name from argv[0]
1725
Returns a command status or raises an exception.
1727
Special master options: these must come before the command because
1728
they control how the command is interpreted.
1731
Do not load plugin modules at all
1734
Only use builtin commands. (Plugins are still allowed to change
1738
Run under the Python profiler.
1741
1507
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1743
opt_profile = opt_no_plugins = opt_builtin = False
1745
# --no-plugins is handled specially at a very early stage. We need
1746
# to load plugins before doing other command parsing so that they
1747
# can override commands, but this needs to happen first.
1750
if a == '--profile':
1752
elif a == '--no-plugins':
1753
opt_no_plugins = True
1754
elif a == '--builtin':
1760
if not opt_no_plugins:
1761
from bzrlib.plugin import load_plugins
1764
args, opts = parse_args(argv)
1767
from bzrlib.help import help
1774
if 'version' in opts:
1779
print >>sys.stderr, "please try 'bzr help' for help"
1510
# some options like --builtin and --no-plugins have special effects
1511
argv, master_opts = _parse_master_args(argv)
1512
if 'no-plugins' not in master_opts:
1513
bzrlib.load_plugins()
1515
args, opts = parse_args(argv)
1517
if master_opts['help']:
1518
from bzrlib.help import help
1526
from bzrlib.help import help
1532
elif 'version' in opts:
1535
elif args and args[0] == 'builtin':
1536
include_plugins=False
1538
cmd = str(args.pop(0))
1782
cmd = str(args.pop(0))
1784
canonical_cmd, cmd_class = \
1785
get_cmd_class(cmd, plugins_override=not opt_builtin)
1545
plugins_override = not (master_opts['builtin'])
1546
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1548
profile = master_opts['profile']
1549
# For backwards compatibility, I would rather stick with --profile being a
1550
# master/global option
1551
if 'profile' in opts:
1787
1555
# check options are reasonable
1788
1556
allowed = cmd_class.takes_options