1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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, fnmatch, difflib, os.path
67
from pprint import pprint
70
from inspect import getdoc
73
from bzrlib.store import ImmutableStore
74
from bzrlib.trace import mutter, note, log_error
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
## standard representation
86
NONE_STRING = '(none)'
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
112
## TODO: move command; check destination is a directory and will not
115
## TODO: command to show renames, one per line, as to->from
120
def cmd_status(all=False):
121
"""Display status summary.
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
127
#import bzrlib.status
128
#bzrlib.status.tree_status(Branch('.'))
129
Branch('.').show_status(show_all=all)
133
######################################################################
135
def cmd_get_revision(revision_id):
136
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
139
def cmd_get_file_text(text_id):
140
"""Get contents of a file by hash."""
141
sf = Branch('.').text_store[text_id]
142
pumpfile(sf, sys.stdout)
146
######################################################################
151
"""Show number of revisions on this branch"""
152
print Branch('.').revno()
156
def cmd_add(file_list, verbose=False):
157
"""Add specified files or directories.
159
In non-recursive mode, all the named items are added, regardless
160
of whether they were previously ignored. A warning is given if
161
any of the named files are already versioned.
163
In recursive mode (the default), files are treated the same way
164
but the behaviour for directories is different. Directories that
165
are already versioned do not give a warning. All directories,
166
whether already versioned or not, are searched for files or
167
subdirectories that are neither versioned or ignored, and these
168
are added. This search proceeds recursively into versioned
171
Therefore simply saying 'bzr add .' will version all files that
172
are currently unknown.
174
bzrlib.add.smart_add(file_list, verbose)
177
def cmd_relpath(filename):
178
"""Show path of file relative to root"""
179
print Branch(filename).relpath(filename)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
198
# TODO: Maybe a 'mv' command that has the combined move/rename
199
# special behaviour of Unix?
201
def cmd_move(source_list, dest):
204
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
208
def cmd_rename(from_name, to_name):
209
"""Change the name of an entry.
211
usage: bzr rename FROM_NAME TO_NAME
214
bzr rename frob.c frobber.c
215
bzr rename src/frob.c lib/frob.c
217
It is an error if the destination name exists.
219
See also the 'move' command, which moves files into a different
220
directory without changing their name.
222
TODO: Some way to rename multiple files without invoking bzr for each
225
b.rename_one(b.relpath(from_name), b.relpath(to_name))
230
def cmd_renames(dir='.'):
231
"""Show list of renamed files.
233
usage: bzr renames [BRANCH]
235
TODO: Option to show renames between two historical versions.
237
TODO: Only show renames under dir, rather than in the whole branch.
240
old_inv = b.basis_tree().inventory
241
new_inv = b.read_working_inventory()
243
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
245
for old_name, new_name in renames:
246
print "%s => %s" % (old_name, new_name)
251
"""info: Show statistical information for this branch
255
info.show_info(Branch('.'))
259
def cmd_remove(file_list, verbose=False):
260
b = Branch(file_list[0])
261
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
265
def cmd_file_id(filename):
266
"""Print file_id of a particular file or directory.
268
usage: bzr file-id FILE
270
The file_id is assigned when the file is first added and remains the
271
same through all revisions where the file exists, even when it is
275
i = b.inventory.path2id(b.relpath(filename))
277
bailout("%r is not a versioned file" % filename)
282
def cmd_file_id_path(filename):
283
"""Print path of file_ids to a file or directory.
285
usage: bzr file-id-path FILE
287
This prints one line for each directory down to the target,
288
starting at the branch root."""
291
fid = inv.path2id(b.relpath(filename))
293
bailout("%r is not a versioned file" % filename)
294
for fip in inv.get_idpath(fid):
298
def cmd_revision_history():
299
for patchid in Branch('.').revision_history():
303
def cmd_directories():
304
for name, ie in Branch('.').read_working_inventory().directories():
312
for name, ie in Branch('.').working_tree().missing():
317
# TODO: Check we're not already in a working directory? At the
318
# moment you'll get an ugly error.
320
# TODO: What if we're in a subdirectory of a branch? Would like
321
# to allow that, but then the parent may need to understand that
322
# the children have disappeared, or should they be versioned in
325
# TODO: Take an argument/option for branch name.
326
Branch('.', init=True)
329
def cmd_diff(revision=None, file_list=None):
330
"""bzr diff: Show differences in working tree.
332
usage: bzr diff [-r REV] [FILE...]
335
Show changes since REV, rather than predecessor.
337
If files are listed, only the changes in those files are listed.
338
Otherwise, all changes for the tree are listed.
340
TODO: Given two revision arguments, show the difference between them.
342
TODO: Allow diff across branches.
344
TODO: Option to use external diff command; could be GNU diff, wdiff,
347
TODO: If a directory is given, diff everything under that.
349
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
352
## TODO: Shouldn't be in the cmd function.
357
old_tree = b.basis_tree()
359
old_tree = b.revision_tree(b.lookup_revision(revision))
361
new_tree = b.working_tree()
363
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
367
DEVNULL = '/dev/null'
368
# Windows users, don't panic about this filename -- it is a
369
# special signal to GNU patch that the file should be created or
370
# deleted respectively.
372
# TODO: Generation of pseudo-diffs for added/deleted files could
373
# be usefully made into a much faster special case.
375
# TODO: Better to return them in sorted order I think.
378
file_list = [b.relpath(f) for f in file_list]
380
# FIXME: If given a file list, compare only those files rather
381
# than comparing everything and then throwing stuff away.
383
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
385
if file_list and (new_name not in file_list):
388
# Don't show this by default; maybe do it if an option is passed
389
# idlabel = ' {%s}' % fid
392
# FIXME: Something about the diff format makes patch unhappy
393
# with newly-added files.
395
def diffit(oldlines, newlines, **kw):
396
# FIXME: difflib is wrong if there is no trailing newline.
398
# Special workaround for Python2.3, where difflib fails if
399
# both sequences are empty.
400
if oldlines or newlines:
401
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
404
if file_state in ['.', '?', 'I']:
406
elif file_state == 'A':
407
print '*** added %s %r' % (kind, new_name)
410
new_tree.get_file(fid).readlines(),
412
tofile=new_label + new_name + idlabel)
413
elif file_state == 'D':
414
assert isinstance(old_name, types.StringTypes)
415
print '*** deleted %s %r' % (kind, old_name)
417
diffit(old_tree.get_file(fid).readlines(), [],
418
fromfile=old_label + old_name + idlabel,
420
elif file_state in ['M', 'R']:
421
if file_state == 'M':
422
assert kind == 'file'
423
assert old_name == new_name
424
print '*** modified %s %r' % (kind, new_name)
425
elif file_state == 'R':
426
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
429
diffit(old_tree.get_file(fid).readlines(),
430
new_tree.get_file(fid).readlines(),
431
fromfile=old_label + old_name + idlabel,
432
tofile=new_label + new_name)
434
bailout("can't represent state %s {%s}" % (file_state, fid))
438
def cmd_deleted(show_ids=False):
439
"""List files deleted in the working tree.
441
TODO: Show files deleted since a previous revision, or between two revisions.
445
new = b.working_tree()
447
## TODO: Much more efficient way to do this: read in new
448
## directories with readdir, rather than stating each one. Same
449
## level of effort but possibly much less IO. (Or possibly not,
450
## if the directories are very large...)
452
for path, ie in old.inventory.iter_entries():
453
if not new.has_id(ie.file_id):
455
print '%-50s %s' % (path, ie.file_id)
461
def cmd_parse_inventory():
464
cElementTree.ElementTree().parse(file('.bzr/inventory'))
468
def cmd_load_inventory():
469
"""Load inventory for timing purposes"""
470
Branch('.').basis_tree().inventory
473
def cmd_dump_inventory():
474
Branch('.').read_working_inventory().write_xml(sys.stdout)
477
def cmd_dump_new_inventory():
478
import bzrlib.newinventory
479
inv = Branch('.').basis_tree().inventory
480
bzrlib.newinventory.write_inventory(inv, sys.stdout)
483
def cmd_load_new_inventory():
484
import bzrlib.newinventory
485
bzrlib.newinventory.read_new_inventory(sys.stdin)
488
def cmd_dump_slacker_inventory():
489
import bzrlib.newinventory
490
inv = Branch('.').basis_tree().inventory
491
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
495
def cmd_dump_text_inventory():
496
import bzrlib.textinv
497
inv = Branch('.').basis_tree().inventory
498
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
501
def cmd_load_text_inventory():
502
import bzrlib.textinv
503
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
504
print 'loaded %d entries' % len(inv)
508
def cmd_root(filename=None):
509
"""Print the branch root."""
510
print bzrlib.branch.find_branch_root(filename)
513
def cmd_log(timezone='original', verbose=False):
514
"""Show log of this branch.
516
TODO: Options for utc; to show ids; to limit range; etc.
518
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
521
def cmd_ls(revision=None, verbose=False):
522
"""List files in a tree.
524
TODO: Take a revision or remote path and list that tree instead.
528
tree = b.working_tree()
530
tree = b.revision_tree(b.lookup_revision(revision))
532
for fp, fc, kind, fid in tree.list_files():
534
if kind == 'directory':
541
print '%-8s %s%s' % (fc, fp, kindch)
548
"""List unknown files"""
549
for f in Branch('.').unknowns():
555
"""List ignored files and the patterns that matched them.
557
tree = Branch('.').working_tree()
558
for path, file_class, kind, file_id in tree.list_files():
559
if file_class != 'I':
561
## XXX: Slightly inefficient since this was already calculated
562
pat = tree.is_ignored(path)
563
print '%-50s %s' % (path, pat)
566
def cmd_lookup_revision(revno):
570
bailout("usage: lookup-revision REVNO",
571
["REVNO is a non-negative revision number for this branch"])
573
print Branch('.').lookup_revision(revno) or NONE_STRING
577
def cmd_export(revno, dest):
578
"""Export past revision to destination directory."""
580
rh = b.lookup_revision(int(revno))
581
t = b.revision_tree(rh)
584
def cmd_cat(revision, filename):
585
"""Print file to stdout."""
587
b.print_file(b.relpath(filename), int(revision))
590
######################################################################
591
# internal/test commands
595
"""Print a newly-generated UUID."""
596
print bzrlib.osutils.uuid()
600
def cmd_local_time_offset():
601
print bzrlib.osutils.local_time_offset()
605
def cmd_commit(message=None, verbose=False):
606
"""Commit changes to a new revision.
609
Description of changes in this revision; free form text.
610
It is recommended that the first line be a single-sentence
613
Show status of changed files,
615
TODO: Commit only selected files.
617
TODO: Run hooks on tree to-be-committed, and after commit.
619
TODO: Strict commit that fails if there are unknown or deleted files.
623
bailout("please specify a commit message")
624
Branch('.').commit(message, verbose=verbose)
627
def cmd_check(dir='.'):
628
"""check: Consistency check of branch history.
630
usage: bzr check [-v] [BRANCH]
633
--verbose, -v Show progress of checking.
635
This command checks various invariants about the branch storage to
636
detect data corruption or bzr bugs.
639
bzrlib.check.check(Branch(dir, find_root=False))
642
def cmd_is(pred, *rest):
643
"""Test whether PREDICATE is true."""
645
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
647
bailout("unknown predicate: %s" % quotefn(pred))
651
except BzrCheckError:
652
# by default we don't print the message so that this can
653
# be used from shell scripts without producing noise
660
TODO: Command to show only the email-address part as parsed out.
662
print bzrlib.osutils.username()
665
def cmd_gen_revision_id():
666
print bzrlib.branch._gen_revision_id(time.time())
670
"""Run internal test suite"""
671
## -v, if present, is seen by doctest; the argument is just here
672
## so our parser doesn't complain
674
## TODO: --verbose option
676
failures, tests = 0, 0
678
import doctest, bzrlib.store, bzrlib.tests
679
bzrlib.trace.verbose = False
681
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
682
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
683
mf, mt = doctest.testmod(m)
686
print '%-40s %3d tests' % (m.__name__, mt),
688
print '%3d FAILED!' % mf
692
print '%-40s %3d tests' % ('total', tests),
694
print '%3d FAILED!' % failures
701
cmd_doctest = cmd_selftest
704
######################################################################
708
def cmd_help(topic=None):
713
# otherwise, maybe the name of a command?
715
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
717
bailout("no help for %r" % topic)
721
bailout("sorry, no detailed help yet for %r" % topic)
729
print "bzr (bazaar-ng) %s" % bzrlib.__version__
730
print bzrlib.__copyright__
731
print "http://bazaar-ng.org/"
734
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
735
you may use, modify and redistribute it under the terms of the GNU
736
General Public License version 2 or later."""
740
"""Statement of optimism."""
741
print "it sure does!"
745
######################################################################
749
# list of all available options; the rhs can be either None for an
750
# option that takes no argument, or a constructor function that checks
770
# List of options that apply to particular commands; commands not
775
'commit': ['message', 'verbose'],
776
'deleted': ['show-ids'],
777
'diff': ['revision'],
778
'inventory': ['revision'],
779
'log': ['timezone', 'verbose'],
780
'ls': ['revision', 'verbose'],
781
'remove': ['verbose'],
791
'export': ['revno', 'dest'],
792
'file-id': ['filename'],
793
'file-id-path': ['filename'],
794
'get-file-text': ['text_id'],
795
'get-inventory': ['inventory_id'],
796
'get-revision': ['revision_id'],
797
'get-revision-inventory': ['revision_id'],
801
'lookup-revision': ['revno'],
802
'move': ['source$', 'dest'],
803
'relpath': ['filename'],
805
'rename': ['from_name', 'to_name'],
807
'root': ['filename?'],
812
def parse_args(argv):
813
"""Parse command line.
815
Arguments and options are parsed at this level before being passed
816
down to specific command handlers. This routine knows, from a
817
lookup table, something about the available options, what optargs
818
they take, and which commands will accept them.
820
>>> parse_args('--help'.split())
822
>>> parse_args('--version'.split())
823
([], {'version': True})
824
>>> parse_args('status --all'.split())
825
(['status'], {'all': True})
826
>>> parse_args('commit --message=biter'.split())
827
(['commit'], {'message': u'biter'})
832
# TODO: Maybe handle '--' to end options?
837
# option names must not be unicode
841
mutter(" got option %r" % a)
843
optname, optarg = a[2:].split('=', 1)
846
if optname not in OPTIONS:
847
bailout('unknown long option %r' % a)
850
if shortopt not in SHORT_OPTIONS:
851
bailout('unknown short option %r' % a)
852
optname = SHORT_OPTIONS[shortopt]
855
# XXX: Do we ever want to support this, e.g. for -r?
856
bailout('repeated option %r' % a)
858
optargfn = OPTIONS[optname]
862
bailout('option %r needs an argument' % a)
865
opts[optname] = optargfn(optarg)
868
bailout('option %r takes no argument' % optname)
877
def _match_args(cmd, args):
878
"""Check non-option arguments match required pattern.
880
>>> _match_args('status', ['asdasdsadasd'])
881
Traceback (most recent call last):
883
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
884
>>> _match_args('add', ['asdasdsadasd'])
885
{'file_list': ['asdasdsadasd']}
886
>>> _match_args('add', 'abc def gj'.split())
887
{'file_list': ['abc', 'def', 'gj']}
889
# match argument pattern
890
argform = cmd_args.get(cmd, [])
892
# TODO: Need a way to express 'cp SRC... DEST', where it matches
895
# step through args and argform, allowing appropriate 0-many matches
900
argdict[argname] = args.pop(0)
901
elif ap[-1] == '*': # all remaining arguments
903
argdict[argname + '_list'] = args[:]
906
argdict[argname + '_list'] = None
909
bailout("command %r needs one or more %s"
910
% (cmd, argname.upper()))
912
argdict[argname + '_list'] = args[:]
914
elif ap[-1] == '$': # all but one
916
bailout("command %r needs one or more %s"
917
% (cmd, argname.upper()))
918
argdict[argname + '_list'] = args[:-1]
924
bailout("command %r requires argument %s"
925
% (cmd, argname.upper()))
927
argdict[argname] = args.pop(0)
930
bailout("extra arguments to command %s: %r"
938
"""Execute a command.
940
This is similar to main(), but without all the trappings for
941
logging and error handling.
944
argv = [a.decode(bzrlib.user_encoding) for a in argv]
947
args, opts = parse_args(argv[1:])
949
# TODO: pass down other arguments in case they asked for
950
# help on a command name?
956
elif 'version' in opts:
959
cmd = str(args.pop(0))
961
log_error('usage: bzr COMMAND')
962
log_error(' try "bzr help"')
966
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
968
bailout("unknown command " + `cmd`)
971
if 'profile' in opts:
977
# check options are reasonable
978
allowed = cmd_options.get(cmd, [])
980
if oname not in allowed:
981
bailout("option %r is not allowed for command %r"
984
# TODO: give an error if there are any mandatory options which are
985
# not specified? Or maybe there shouldn't be any "mandatory
986
# options" (it is an oxymoron)
988
# mix arguments and options into one dictionary
989
cmdargs = _match_args(cmd, args)
990
for k, v in opts.items():
991
cmdargs[k.replace('-', '_')] = v
995
pffileno, pfname = tempfile.mkstemp()
997
prof = hotshot.Profile(pfname)
998
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1001
import hotshot.stats
1002
stats = hotshot.stats.load(pfname)
1004
stats.sort_stats('time')
1005
## XXX: Might like to write to stderr or the trace file instead but
1006
## print_stats seems hardcoded to stdout
1007
stats.print_stats(20)
1015
return cmd_handler(**cmdargs) or 0
1019
def _report_exception(e, summary):
1021
log_error('bzr: ' + summary)
1022
bzrlib.trace.log_exception(e)
1023
tb = sys.exc_info()[2]
1024
exinfo = traceback.extract_tb(tb, 1)
1026
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[0][:3])
1027
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1030
def cmd_assert_fail():
1031
assert False, "always fails"
1035
bzrlib.trace.create_tracefile(argv)
1042
_report_exception(e, 'error: ' + e.args[0])
1045
# some explanation or hints
1048
except AssertionError, e:
1049
msg = 'assertion failed'
1051
msg += ': ' + str(e)
1052
_report_exception(e, msg)
1053
except Exception, e:
1054
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1057
bzrlib.trace.close_trace()
1059
## TODO: Trap AssertionError
1061
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1065
if __name__ == '__main__':
1066
sys.exit(main(sys.argv))