14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
31
from warnings import warn
32
from inspect import getdoc
19
"""Bazaar-NG -- a free distributed version-control tool
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
67
from pprint import pprint
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
44
def register_command(cmd):
45
"Utility function to help register a command"
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
60
def _squish_command_name(cmd):
61
return 'cmd_' + cmd.replace('-', '_')
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
66
return cmd[4:].replace('_','-')
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
72
This always returns a list. The list will have one element for
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
153
def _builtin_commands():
154
import bzrlib.builtins
156
builtins = bzrlib.builtins.__dict__
157
for name in builtins:
158
if name.startswith("cmd_"):
159
real_name = _unsquish_command_name(name)
160
r[real_name] = builtins[name]
165
def builtin_command_names():
166
"""Return list of builtin command names."""
167
return _builtin_commands().keys()
170
def plugin_command_names():
171
return plugin_cmds.keys()
174
def _get_cmd_dict(plugins_override=True):
175
"""Return name->class mapping for all commands."""
176
d = _builtin_commands()
178
d.update(plugin_cmds)
182
def get_all_cmds(plugins_override=True):
183
"""Return canonical name and class for all registered commands."""
184
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
188
def get_cmd_object(cmd_name, plugins_override=True):
189
"""Return the canonical name and command class for a command.
192
If true, plugin commands can override builtins.
194
from bzrlib.externalcommand import ExternalCommand
196
cmd_name = str(cmd_name) # not unicode
198
# first look up this command under the specified name
199
cmds = _get_cmd_dict(plugins_override=plugins_override)
201
return cmds[cmd_name]()
205
# look for any command which claims this as an alias
206
for real_cmd_name, cmd_class in cmds.iteritems():
207
if cmd_name in cmd_class.aliases:
210
cmd_obj = ExternalCommand.find_command(cmd_name)
214
raise BzrCommandError("unknown command %r" % cmd_name)
217
class Command(object):
218
"""Base class for commands.
220
Commands are the heart of the command-line bzr interface.
222
The command object mostly handles the mapping of command-line
223
parameters into one or more bzrlib operations, and of the results
226
Commands normally don't have any state. All their arguments are
227
passed in to the run method. (Subclasses may take a different
228
policy if the behaviour of the instance needs to depend on e.g. a
229
shell plugin and not just its Python class.)
231
The docstring for an actual command should give a single-line
232
summary, then a complete description of the command. A grammar
233
description will be inserted.
236
Other accepted names for this command.
239
List of argument forms, marked with whether they are optional,
243
List of options that may be given for this command.
246
If true, this command isn't advertised. This is typically
247
for commands intended for expert users.
257
"""Construct an instance of this command."""
258
if self.__doc__ == Command.__doc__:
259
warn("No help message set for %r" % self)
262
def run_argv(self, argv):
263
"""Parse command line and run."""
264
args, opts = parse_args(argv)
266
if 'help' in opts: # e.g. bzr add --help
267
from bzrlib.help import help_on_command
268
help_on_command(self.name())
271
# check options are reasonable
272
allowed = self.takes_options
274
if oname not in allowed:
275
raise BzrCommandError("option '--%s' is not allowed for command %r"
276
% (oname, self.name()))
278
# mix arguments and options into one dictionary
279
cmdargs = _match_argform(self.name(), self.takes_args, args)
281
for k, v in opts.items():
282
cmdopts[k.replace('-', '_')] = v
284
all_cmd_args = cmdargs.copy()
285
all_cmd_args.update(cmdopts)
287
return self.run(**all_cmd_args)
291
"""Actually run the command.
293
This is invoked with the options and arguments bound to
296
Return 0 or None if the command was successful, or a non-zero
297
shell error code if not. It's OK for this method to allow
298
an exception to raise up.
300
raise NotImplementedError()
304
"""Return help message for this class."""
305
if self.__doc__ is Command.__doc__:
310
return _unsquish_command_name(self.__class__.__name__)
313
def parse_spec(spec):
319
>>> parse_spec("../@")
321
>>> parse_spec("../f/@35")
323
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
324
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
329
parsed = spec.split('/@')
330
assert len(parsed) == 2
335
parsed[1] = int(parsed[1])
337
pass # We can allow stuff like ./@revid:blahblahblah
341
parsed = [spec, None]
72
from bzrlib.store import ImmutableStore
73
from bzrlib.trace import mutter, note, log_error
74
from bzrlib.errors import bailout, BzrError, BzrCheckError
75
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
76
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
77
from bzrlib.revision import Revision
78
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
82
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
84
## standard representation
85
NONE_STRING = '(none)'
89
## TODO: Perhaps a different version of inventory commands that
90
## returns iterators...
92
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
94
## TODO: Some kind of locking on branches. Perhaps there should be a
95
## parameter to the branch object saying whether we want a read or
96
## write lock; release it from destructor. Perhaps don't even need a
97
## read lock to look at immutable objects?
99
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
100
## to compare output?
102
## TODO: Some kind of global code to generate the right Branch object
103
## to work on. Almost, but not quite all, commands need one, and it
104
## can be taken either from their parameters or their working
107
## TODO: rename command, needed soon: check destination doesn't exist
108
## either in working copy or tree; move working copy; update
109
## inventory; write out
111
## TODO: move command; check destination is a directory and will not
114
## TODO: command to show renames, one per line, as to->from
119
def cmd_status(all=False):
120
"""Display status summary.
122
For each file there is a single line giving its file state and name.
123
The name is that in the current revision unless it is deleted or
124
missing, in which case the old name is shown.
126
:todo: Don't show unchanged files unless ``--all`` is given?
128
Branch('.').show_status(show_all=all)
132
######################################################################
134
def cmd_get_revision(revision_id):
135
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
def cmd_get_file_text(text_id):
139
"""Get contents of a file by hash."""
140
sf = Branch('.').text_store[text_id]
141
pumpfile(sf, sys.stdout)
145
######################################################################
150
"""Show number of revisions on this branch"""
151
print Branch('.').revno()
155
def cmd_add(file_list, verbose=False):
156
"""Add specified files or directories.
158
In non-recursive mode, all the named items are added, regardless
159
of whether they were previously ignored. A warning is given if
160
any of the named files are already versioned.
162
In recursive mode (the default), files are treated the same way
163
but the behaviour for directories is different. Directories that
164
are already versioned do not give a warning. All directories,
165
whether already versioned or not, are searched for files or
166
subdirectories that are neither versioned or ignored, and these
167
are added. This search proceeds recursively into versioned
170
Therefore simply saying 'bzr add .' will version all files that
171
are currently unknown.
173
bzrlib.add.smart_add(file_list, verbose)
176
def cmd_relpath(filename):
177
"""Show path of file relative to root"""
178
print Branch(filename).relpath(filename)
182
def cmd_inventory(revision=None):
183
"""Show inventory of the current working copy."""
184
## TODO: Also optionally show a previous inventory
185
## TODO: Format options
188
inv = b.read_working_inventory()
190
inv = b.get_revision_inventory(b.lookup_revision(revision))
192
for path, entry in inv.iter_entries():
193
print '%-50s %s' % (entry.file_id, path)
197
# TODO: Maybe a 'mv' command that has the combined move/rename
198
# special behaviour of Unix?
200
def cmd_move(source_list, dest):
203
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
207
def cmd_rename(from_name, to_name):
208
"""Change the name of an entry.
210
usage: bzr rename FROM_NAME TO_NAME
213
bzr rename frob.c frobber.c
214
bzr rename src/frob.c lib/frob.c
216
It is an error if the destination name exists.
218
See also the 'move' command, which moves files into a different
219
directory without changing their name.
221
TODO: Some way to rename multiple files without invoking bzr for each
224
b.rename_one(b.relpath(from_name), b.relpath(to_name))
229
def cmd_renames(dir='.'):
230
"""Show list of renamed files.
232
usage: bzr renames [BRANCH]
234
TODO: Option to show renames between two historical versions.
236
TODO: Only show renames under dir, rather than in the whole branch.
239
old_inv = b.basis_tree().inventory
240
new_inv = b.read_working_inventory()
242
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
244
for old_name, new_name in renames:
245
print "%s => %s" % (old_name, new_name)
250
"""info: Show statistical information for this branch
254
info.show_info(Branch('.'))
258
def cmd_remove(file_list, verbose=False):
259
b = Branch(file_list[0])
260
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
264
def cmd_file_id(filename):
265
"""Print file_id of a particular file or directory.
267
usage: bzr file-id FILE
269
The file_id is assigned when the file is first added and remains the
270
same through all revisions where the file exists, even when it is
274
i = b.inventory.path2id(b.relpath(filename))
276
bailout("%r is not a versioned file" % filename)
281
def cmd_file_id_path(filename):
282
"""Print path of file_ids to a file or directory.
284
usage: bzr file-id-path FILE
286
This prints one line for each directory down to the target,
287
starting at the branch root."""
290
fid = inv.path2id(b.relpath(filename))
292
bailout("%r is not a versioned file" % filename)
293
for fip in inv.get_idpath(fid):
297
def cmd_revision_history():
298
for patchid in Branch('.').revision_history():
302
def cmd_directories():
303
for name, ie in Branch('.').read_working_inventory().directories():
311
for name, ie in Branch('.').working_tree().missing():
316
# TODO: Check we're not already in a working directory? At the
317
# moment you'll get an ugly error.
319
# TODO: What if we're in a subdirectory of a branch? Would like
320
# to allow that, but then the parent may need to understand that
321
# the children have disappeared, or should they be versioned in
324
# TODO: Take an argument/option for branch name.
325
Branch('.', init=True)
328
def cmd_diff(revision=None, file_list=None):
329
"""bzr diff: Show differences in working tree.
331
usage: bzr diff [-r REV] [FILE...]
334
Show changes since REV, rather than predecessor.
336
If files are listed, only the changes in those files are listed.
337
Otherwise, all changes for the tree are listed.
339
TODO: Given two revision arguments, show the difference between them.
341
TODO: Allow diff across branches.
343
TODO: Option to use external diff command; could be GNU diff, wdiff,
346
TODO: If a directory is given, diff everything under that.
348
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
351
## TODO: Shouldn't be in the cmd function.
356
old_tree = b.basis_tree()
358
old_tree = b.revision_tree(b.lookup_revision(revision))
360
new_tree = b.working_tree()
362
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
366
DEVNULL = '/dev/null'
367
# Windows users, don't panic about this filename -- it is a
368
# special signal to GNU patch that the file should be created or
369
# deleted respectively.
371
# TODO: Generation of pseudo-diffs for added/deleted files could
372
# be usefully made into a much faster special case.
374
# TODO: Better to return them in sorted order I think.
376
# FIXME: If given a file list, compare only those files rather
377
# than comparing everything and then throwing stuff away.
379
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
381
if file_list and new_name not in file_list:
384
# Don't show this by default; maybe do it if an option is passed
385
# idlabel = ' {%s}' % fid
388
# FIXME: Something about the diff format makes patch unhappy
389
# with newly-added files.
391
def diffit(oldlines, newlines, **kw):
392
# FIXME: difflib is wrong if there is no trailing newline.
394
# Special workaround for Python2.3, where difflib fails if
395
# both sequences are empty.
396
if oldlines or newlines:
397
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
400
if file_state in ['.', '?', 'I']:
402
elif file_state == 'A':
403
print '*** added %s %r' % (kind, new_name)
406
new_tree.get_file(fid).readlines(),
408
tofile=new_label + new_name + idlabel)
409
elif file_state == 'D':
410
assert isinstance(old_name, types.StringTypes)
411
print '*** deleted %s %r' % (kind, old_name)
413
diffit(old_tree.get_file(fid).readlines(), [],
414
fromfile=old_label + old_name + idlabel,
416
elif file_state in ['M', 'R']:
417
if file_state == 'M':
418
assert kind == 'file'
419
assert old_name == new_name
420
print '*** modified %s %r' % (kind, new_name)
421
elif file_state == 'R':
422
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
425
diffit(old_tree.get_file(fid).readlines(),
426
new_tree.get_file(fid).readlines(),
427
fromfile=old_label + old_name + idlabel,
428
tofile=new_label + new_name)
430
bailout("can't represent state %s {%s}" % (file_state, fid))
434
def cmd_deleted(show_ids=False):
435
"""List files deleted in the working tree.
437
TODO: Show files deleted since a previous revision, or between two revisions.
441
new = b.working_tree()
443
## TODO: Much more efficient way to do this: read in new
444
## directories with readdir, rather than stating each one. Same
445
## level of effort but possibly much less IO. (Or possibly not,
446
## if the directories are very large...)
448
for path, ie in old.inventory.iter_entries():
449
if not new.has_id(ie.file_id):
451
print '%-50s %s' % (path, ie.file_id)
457
def cmd_parse_inventory():
460
cElementTree.ElementTree().parse(file('.bzr/inventory'))
464
def cmd_load_inventory():
465
"""Load inventory for timing purposes"""
466
Branch('.').basis_tree().inventory
469
def cmd_dump_inventory():
470
Branch('.').read_working_inventory().write_xml(sys.stdout)
473
def cmd_dump_new_inventory():
474
import bzrlib.newinventory
475
inv = Branch('.').basis_tree().inventory
476
bzrlib.newinventory.write_inventory(inv, sys.stdout)
479
def cmd_load_new_inventory():
480
import bzrlib.newinventory
481
bzrlib.newinventory.read_new_inventory(sys.stdin)
484
def cmd_dump_slacker_inventory():
485
import bzrlib.newinventory
486
inv = Branch('.').basis_tree().inventory
487
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
491
def cmd_root(filename=None):
492
"""Print the branch root."""
493
print bzrlib.branch.find_branch_root(filename)
496
def cmd_log(timezone='original'):
497
"""Show log of this branch.
499
:todo: Options for utc; to show ids; to limit range; etc.
501
Branch('.').write_log(show_timezone=timezone)
504
def cmd_ls(revision=None, verbose=False):
505
"""List files in a tree.
507
:todo: Take a revision or remote path and list that tree instead.
511
tree = b.working_tree()
513
tree = b.revision_tree(b.lookup_revision(revision))
515
for fp, fc, kind, fid in tree.list_files():
517
if kind == 'directory':
524
print '%-8s %s%s' % (fc, fp, kindch)
531
"""List unknown files"""
532
for f in Branch('.').unknowns():
538
"""List ignored files and the patterns that matched them.
540
tree = Branch('.').working_tree()
541
for path, file_class, kind, file_id in tree.list_files():
542
if file_class != 'I':
544
## XXX: Slightly inefficient since this was already calculated
545
pat = tree.is_ignored(path)
546
print '%-50s %s' % (path, pat)
549
def cmd_lookup_revision(revno):
553
bailout("usage: lookup-revision REVNO",
554
["REVNO is a non-negative revision number for this branch"])
556
print Branch('.').lookup_revision(revno) or NONE_STRING
560
def cmd_export(revno, dest):
561
"""Export past revision to destination directory."""
563
rh = b.lookup_revision(int(revno))
564
t = b.revision_tree(rh)
567
def cmd_cat(revision, filename):
568
"""Print file to stdout."""
570
b.print_file(b.relpath(filename), int(revision))
573
######################################################################
574
# internal/test commands
578
"""Print a newly-generated UUID."""
579
print bzrlib.osutils.uuid()
583
def cmd_local_time_offset():
584
print bzrlib.osutils.local_time_offset()
588
def cmd_commit(message=None, verbose=False):
589
"""Commit changes to a new revision.
592
Description of changes in this revision; free form text.
593
It is recommended that the first line be a single-sentence
596
Show status of changed files,
598
TODO: Commit only selected files.
600
TODO: Run hooks on tree to-be-committed, and after commit.
602
TODO: Strict commit that fails if there are unknown or deleted files.
606
bailout("please specify a commit message")
607
Branch('.').commit(message, verbose=verbose)
610
def cmd_check(dir='.'):
611
"""check: Consistency check of branch history.
613
usage: bzr check [-v] [BRANCH]
616
--verbose, -v Show progress of checking.
618
This command checks various invariants about the branch storage to
619
detect data corruption or bzr bugs.
622
bzrlib.check.check(Branch(dir, find_root=False))
625
def cmd_is(pred, *rest):
626
"""Test whether PREDICATE is true."""
628
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
630
bailout("unknown predicate: %s" % quotefn(pred))
634
except BzrCheckError:
635
# by default we don't print the message so that this can
636
# be used from shell scripts without producing noise
641
print bzrlib.osutils.username()
644
def cmd_user_email():
645
print bzrlib.osutils.user_email()
648
def cmd_gen_revision_id():
649
print bzrlib.branch._gen_revision_id(time.time())
653
"""Run internal test suite"""
654
## -v, if present, is seen by doctest; the argument is just here
655
## so our parser doesn't complain
657
## TODO: --verbose option
659
failures, tests = 0, 0
661
import doctest, bzrlib.store, bzrlib.tests
662
bzrlib.trace.verbose = False
664
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
665
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
666
mf, mt = doctest.testmod(m)
669
print '%-40s %3d tests' % (m.__name__, mt),
671
print '%3d FAILED!' % mf
675
print '%-40s %3d tests' % ('total', tests),
677
print '%3d FAILED!' % failures
684
cmd_doctest = cmd_selftest
687
######################################################################
691
def cmd_help(topic=None):
696
# otherwise, maybe the name of a command?
698
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
700
bailout("no help for %r" % topic)
704
bailout("sorry, no detailed help yet for %r" % topic)
712
print "bzr (bazaar-ng) %s" % bzrlib.__version__
713
print bzrlib.__copyright__
714
print "http://bazaar-ng.org/"
717
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
718
you may use, modify and redistribute it under the terms of the GNU
719
General Public License version 2 or later."""
723
"""Statement of optimism."""
724
print "it sure does!"
728
######################################################################
347
732
# list of all available options; the rhs can be either None for an