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
28
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
from bzrlib.branch import find_branch
30
from bzrlib import BZRDIR
36
def register_command(cmd):
37
"Utility function to help register a command"
40
if k.startswith("cmd_"):
41
k_unsquished = _unsquish_command_name(k)
44
if not plugin_cmds.has_key(k_unsquished):
45
plugin_cmds[k_unsquished] = cmd
47
log_error('Two plugins defined the same command: %r' % k)
48
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
51
29
def _squish_command_name(cmd):
56
34
assert cmd.startswith("cmd_")
57
35
return cmd[4:].replace('_','-')
60
37
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')
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'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('..'):
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
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)
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
145
def _get_cmd_dict(plugins_override=True):
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
147
145
for k, v in globals().iteritems():
148
146
if k.startswith("cmd_"):
149
147
d[_unsquish_command_name(k)] = v
150
# If we didn't load plugins, the plugin_cmds dict will be empty
152
d.update(plugin_cmds)
154
d2 = plugin_cmds.copy()
149
d.update(_find_plugins())
160
def get_all_cmds(plugins_override=True):
152
def get_all_cmds(include_plugins=True):
161
153
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
166
def get_cmd_class(cmd, plugins_override=True):
158
def get_cmd_class(cmd,include_plugins=True):
167
159
"""Return the canonical name and command class for a command.
169
161
cmd = str(cmd) # not unicode
171
163
# first look up this command under the specified name
172
cmds = _get_cmd_dict(plugins_override=plugins_override)
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
174
166
return cmd, cmds[cmd]
242
231
class ExternalCommand(Command):
243
232
"""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
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
259
246
def find_command(cls, cmd):
272
259
def __init__(self, path):
262
# TODO: If either of these fail, we should detect that and
263
# assume that path is not really a bzr plugin after all.
275
265
pipe = os.popen('%s --bzr-usage' % path, 'r')
276
266
self.takes_options = pipe.readline().split()
278
for opt in self.takes_options:
279
if not opt in OPTIONS:
280
raise BzrError("Unknown option '%s' returned by external command %s"
283
# TODO: Is there any way to check takes_args is valid here?
284
267
self.takes_args = pipe.readline().split()
286
if pipe.close() is not None:
287
raise BzrError("Failed funning '%s --bzr-usage'" % path)
289
270
pipe = os.popen('%s --bzr-help' % path, 'r')
290
271
self.__doc__ = pipe.read()
291
if pipe.close() is not None:
292
raise BzrError("Failed funning '%s --bzr-help'" % path)
294
274
def __call__(self, options, arguments):
295
275
Command.__init__(self, options, arguments)
356
335
directory is shown. Otherwise, only the status of the specified
357
336
files or directories is reported. If a directory is given, status
358
337
is reported for everything inside that directory.
360
If a revision is specified, the changes since that revision are shown.
362
339
takes_args = ['file*']
363
takes_options = ['all', 'show-ids', 'revision']
340
takes_options = ['all', 'show-ids']
364
341
aliases = ['st', 'stat']
366
343
def run(self, all=False, show_ids=False, file_list=None):
368
b = find_branch(file_list[0])
345
b = Branch(file_list[0])
369
346
file_list = [b.relpath(x) for x in file_list]
370
347
# special case: only one path was given and it's the root
372
349
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)
354
status.show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
382
358
class cmd_cat_revision(Command):
433
386
whether already versioned or not, are searched for files or
434
387
subdirectories that are neither versioned or ignored, and these
435
388
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
391
Therefore simply saying 'bzr add .' will version all files that
439
392
are currently unknown.
441
394
TODO: Perhaps adding a file whose directly is not versioned should
442
395
recursively add that parent, rather than giving an error?
444
takes_args = ['file*']
397
takes_args = ['file+']
445
398
takes_options = ['verbose', 'no-recurse']
447
400
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)
401
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
470
404
class cmd_relpath(Command):
531
461
takes_args = ['from_name', 'to_name']
533
463
def run(self, from_name, to_name):
535
465
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
471
class cmd_pull(Command):
588
487
def run(self, location=None):
589
488
from bzrlib.merge import merge
591
from shutil import rmtree
594
br_to = find_branch('.')
595
492
stored_loc = None
597
494
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
598
495
except IOError, e:
599
if e.errno != errno.ENOENT:
496
if errno == errno.ENOENT:
601
498
if location is None:
602
if stored_loc is None:
603
raise BzrCommandError("No pull location known or specified.")
605
print "Using last location: %s" % stored_loc
606
location = stored_loc
607
cache_root = tempfile.mkdtemp()
608
from bzrlib.branch import DivergedBranches
499
location = stored_loc
501
raise BzrCommandError("No pull location known or specified.")
502
from branch import find_branch, DivergedBranches
609
503
br_from = find_branch(location)
610
504
location = pull_loc(br_from)
611
505
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")
507
br_to.update_revisions(br_from)
508
except DivergedBranches:
509
raise BzrCommandError("These branches have diverged. Try merge.")
511
merge(('.', -1), ('.', old_revno), check_clean=False)
512
if location != stored_loc:
513
br_to.controlfile("x-pull", "wb").write(location + "\n")
640
526
takes_args = ['from_location', 'to_location?']
641
527
takes_options = ['revision']
642
aliases = ['get', 'clone']
644
529
def run(self, from_location, to_location=None, revision=None):
646
531
from bzrlib.merge import merge
647
from bzrlib.branch import DivergedBranches, \
648
find_cached_branch, Branch
532
from branch import find_branch, DivergedBranches, NoSuchRevision
649
533
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")
535
br_from = find_branch(from_location)
537
if e.errno == errno.ENOENT:
538
raise BzrCommandError('Source location "%s" does not exist.' %
543
if to_location is None:
544
to_location = os.path.basename(from_location.rstrip("/\\"))
547
os.mkdir(to_location)
549
if e.errno == errno.EEXIST:
550
raise BzrCommandError('Target directory "%s" already exists.' %
552
if e.errno == errno.ENOENT:
553
raise BzrCommandError('Parent of "%s" does not exist.' %
557
br_to = Branch(to_location, init=True)
560
br_to.update_revisions(br_from, stop_revision=revision)
561
except NoSuchRevision:
563
msg = "The branch %s has no revision %d." % (from_location,
565
raise BzrCommandError(msg)
566
merge((to_location, -1), (to_location, 0), this_dir=to_location,
568
from_location = pull_loc(br_from)
569
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
708
572
def pull_loc(branch):
959
831
-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
834
TODO: Make --revision support uuid: and hash: [future tag:] notation.
969
838
takes_args = ['filename?']
970
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
839
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
972
841
def run(self, filename=None, timezone='original',
979
from bzrlib.branch import find_branch
980
from bzrlib.log import log_formatter, show_log
846
from bzrlib import show_log, find_branch
983
849
direction = (forward and 'forward') or 'reverse'
1182
1032
If no revision is specified this exports the last committed revision.
1184
1034
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."""
1035
given, exports to a directory (equivalent to --format=dir)."""
1190
1036
# TODO: list known exporters
1191
1037
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()
1038
takes_options = ['revision', 'format']
1039
def run(self, dest, revision=None, format='dir'):
1041
if revision == None:
1042
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)
1044
rh = b.lookup_revision(int(revision))
1045
t = b.revision_tree(rh)
1046
t.export(dest, format)
1216
1049
class cmd_cat(Command):
1254
1083
TODO: Strict commit that fails if there are unknown or deleted files.
1256
1085
takes_args = ['selected*']
1257
takes_options = ['message', 'file', 'verbose', 'unchanged']
1086
takes_options = ['message', 'file', 'verbose']
1258
1087
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
1089
def run(self, message=None, file=None, verbose=True, selected_list=None):
1090
from bzrlib.commit import commit
1267
1092
## Warning: shadows builtin file()
1268
1093
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"])
1094
raise BzrCommandError("please specify a commit message",
1095
["use either --message or --file"])
1283
1096
elif message and file:
1284
1097
raise BzrCommandError("please specify either --message or --file")
1455
1220
--force is given.
1457
1222
takes_args = ['other_spec', 'base_spec?']
1458
takes_options = ['force', 'merge-type']
1223
takes_options = ['force']
1460
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1225
def run(self, other_spec, base_spec=None, force=False):
1461
1226
from bzrlib.merge import merge
1462
from bzrlib.merge_core import ApplyMerge3
1463
if merge_type is None:
1464
merge_type = ApplyMerge3
1465
1227
merge(parse_spec(other_spec), parse_spec(base_spec),
1466
check_clean=(not force), merge_type=merge_type)
1228
check_clean=(not force))
1469
1231
class cmd_revert(Command):
1470
1232
"""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.
1234
Only versioned files are affected.
1236
TODO: Store backups of any files that will be reverted, so
1237
that the revert can be undone.
1476
takes_options = ['revision', 'no-backup']
1477
takes_args = ['file*']
1478
aliases = ['merge-revert']
1239
takes_options = ['revision']
1480
def run(self, revision=None, no_backup=False, file_list=None):
1241
def run(self, revision=-1):
1481
1242
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('.'),
1243
merge(('.', revision), parse_spec('.'),
1490
1244
check_clean=False,
1492
backup_files=not no_backup,
1493
file_list=file_list)
1496
1248
class cmd_assert_fail(Command):
1586
1325
>>> parse_args('commit --message=biter'.split())
1587
1326
(['commit'], {'message': u'biter'})
1588
1327
>>> parse_args('log -r 500'.split())
1589
(['log'], {'revision': [500]})
1590
>>> parse_args('log -r500..600'.split())
1328
(['log'], {'revision': 500})
1329
>>> parse_args('log -r500:600'.split())
1591
1330
(['log'], {'revision': [500, 600]})
1592
>>> parse_args('log -vr500..600'.split())
1331
>>> parse_args('log -vr500:600'.split())
1593
1332
(['log'], {'verbose': True, 'revision': [500, 600]})
1594
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1595
(['log'], {'revision': ['v500', 600]})
1333
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1334
Traceback (most recent call last):
1336
ValueError: invalid literal for int(): v500
1719
1460
This is similar to main(), but without all the trappings for
1720
1461
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
1463
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"
1465
include_plugins=True
1467
args, opts = parse_args(argv[1:])
1475
elif 'version' in opts:
1478
elif args and args[0] == 'builtin':
1479
include_plugins=False
1481
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)
1488
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1491
if 'profile' in opts:
1787
1497
# check options are reasonable
1788
1498
allowed = cmd_class.takes_options