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, traceback, 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
:todo: Don't show unchanged files unless ``--all`` is given?
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.
377
# FIXME: If given a file list, compare only those files rather
378
# than comparing everything and then throwing stuff away.
380
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
382
if file_list and new_name not in file_list:
385
# Don't show this by default; maybe do it if an option is passed
386
# idlabel = ' {%s}' % fid
389
# FIXME: Something about the diff format makes patch unhappy
390
# with newly-added files.
392
def diffit(oldlines, newlines, **kw):
393
# FIXME: difflib is wrong if there is no trailing newline.
395
# Special workaround for Python2.3, where difflib fails if
396
# both sequences are empty.
397
if oldlines or newlines:
398
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
401
if file_state in ['.', '?', 'I']:
403
elif file_state == 'A':
404
print '*** added %s %r' % (kind, new_name)
407
new_tree.get_file(fid).readlines(),
409
tofile=new_label + new_name + idlabel)
410
elif file_state == 'D':
411
assert isinstance(old_name, types.StringTypes)
412
print '*** deleted %s %r' % (kind, old_name)
414
diffit(old_tree.get_file(fid).readlines(), [],
415
fromfile=old_label + old_name + idlabel,
417
elif file_state in ['M', 'R']:
418
if file_state == 'M':
419
assert kind == 'file'
420
assert old_name == new_name
421
print '*** modified %s %r' % (kind, new_name)
422
elif file_state == 'R':
423
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
426
diffit(old_tree.get_file(fid).readlines(),
427
new_tree.get_file(fid).readlines(),
428
fromfile=old_label + old_name + idlabel,
429
tofile=new_label + new_name)
431
bailout("can't represent state %s {%s}" % (file_state, fid))
435
def cmd_deleted(show_ids=False):
436
"""List files deleted in the working tree.
438
TODO: Show files deleted since a previous revision, or between two revisions.
442
new = b.working_tree()
444
## TODO: Much more efficient way to do this: read in new
445
## directories with readdir, rather than stating each one. Same
446
## level of effort but possibly much less IO. (Or possibly not,
447
## if the directories are very large...)
449
for path, ie in old.inventory.iter_entries():
450
if not new.has_id(ie.file_id):
452
print '%-50s %s' % (path, ie.file_id)
458
def cmd_parse_inventory():
461
cElementTree.ElementTree().parse(file('.bzr/inventory'))
465
def cmd_load_inventory():
466
"""Load inventory for timing purposes"""
467
Branch('.').basis_tree().inventory
470
def cmd_dump_inventory():
471
Branch('.').read_working_inventory().write_xml(sys.stdout)
474
def cmd_dump_new_inventory():
475
import bzrlib.newinventory
476
inv = Branch('.').basis_tree().inventory
477
bzrlib.newinventory.write_inventory(inv, sys.stdout)
480
def cmd_load_new_inventory():
481
import bzrlib.newinventory
482
bzrlib.newinventory.read_new_inventory(sys.stdin)
485
def cmd_dump_slacker_inventory():
486
import bzrlib.newinventory
487
inv = Branch('.').basis_tree().inventory
488
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
492
def cmd_root(filename=None):
493
"""Print the branch root."""
494
print bzrlib.branch.find_branch_root(filename)
497
def cmd_log(timezone='original'):
498
"""Show log of this branch.
500
:todo: Options for utc; to show ids; to limit range; etc.
502
Branch('.').write_log(show_timezone=timezone)
505
def cmd_ls(revision=None, verbose=False):
506
"""List files in a tree.
508
:todo: Take a revision or remote path and list that tree instead.
512
tree = b.working_tree()
514
tree = b.revision_tree(b.lookup_revision(revision))
516
for fp, fc, kind, fid in tree.list_files():
518
if kind == 'directory':
525
print '%-8s %s%s' % (fc, fp, kindch)
532
"""List unknown files"""
533
for f in Branch('.').unknowns():
539
"""List ignored files and the patterns that matched them.
541
tree = Branch('.').working_tree()
542
for path, file_class, kind, file_id in tree.list_files():
543
if file_class != 'I':
545
## XXX: Slightly inefficient since this was already calculated
546
pat = tree.is_ignored(path)
547
print '%-50s %s' % (path, pat)
550
def cmd_lookup_revision(revno):
554
bailout("usage: lookup-revision REVNO",
555
["REVNO is a non-negative revision number for this branch"])
557
print Branch('.').lookup_revision(revno) or NONE_STRING
561
def cmd_export(revno, dest):
562
"""Export past revision to destination directory."""
564
rh = b.lookup_revision(int(revno))
565
t = b.revision_tree(rh)
568
def cmd_cat(revision, filename):
569
"""Print file to stdout."""
571
b.print_file(b.relpath(filename), int(revision))
574
######################################################################
575
# internal/test commands
579
"""Print a newly-generated UUID."""
580
print bzrlib.osutils.uuid()
584
def cmd_local_time_offset():
585
print bzrlib.osutils.local_time_offset()
589
def cmd_commit(message=None, verbose=False):
590
"""Commit changes to a new revision.
593
Description of changes in this revision; free form text.
594
It is recommended that the first line be a single-sentence
597
Show status of changed files,
599
TODO: Commit only selected files.
601
TODO: Run hooks on tree to-be-committed, and after commit.
603
TODO: Strict commit that fails if there are unknown or deleted files.
607
bailout("please specify a commit message")
608
Branch('.').commit(message, verbose=verbose)
611
def cmd_check(dir='.'):
612
"""check: Consistency check of branch history.
614
usage: bzr check [-v] [BRANCH]
617
--verbose, -v Show progress of checking.
619
This command checks various invariants about the branch storage to
620
detect data corruption or bzr bugs.
623
bzrlib.check.check(Branch(dir, find_root=False))
626
def cmd_is(pred, *rest):
627
"""Test whether PREDICATE is true."""
629
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
631
bailout("unknown predicate: %s" % quotefn(pred))
635
except BzrCheckError:
636
# by default we don't print the message so that this can
637
# be used from shell scripts without producing noise
642
print bzrlib.osutils.username()
645
def cmd_user_email():
646
print bzrlib.osutils.user_email()
649
def cmd_gen_revision_id():
650
print bzrlib.branch._gen_revision_id(time.time())
654
"""Run internal test suite"""
655
## -v, if present, is seen by doctest; the argument is just here
656
## so our parser doesn't complain
658
## TODO: --verbose option
660
failures, tests = 0, 0
662
import doctest, bzrlib.store, bzrlib.tests
663
bzrlib.trace.verbose = False
665
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
666
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
667
mf, mt = doctest.testmod(m)
670
print '%-40s %3d tests' % (m.__name__, mt),
672
print '%3d FAILED!' % mf
676
print '%-40s %3d tests' % ('total', tests),
678
print '%3d FAILED!' % failures
685
cmd_doctest = cmd_selftest
688
######################################################################
692
def cmd_help(topic=None):
697
# otherwise, maybe the name of a command?
699
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
701
bailout("no help for %r" % topic)
705
bailout("sorry, no detailed help yet for %r" % topic)
713
print "bzr (bazaar-ng) %s" % bzrlib.__version__
714
print bzrlib.__copyright__
715
print "http://bazaar-ng.org/"
718
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
719
you may use, modify and redistribute it under the terms of the GNU
720
General Public License version 2 or later."""
724
"""Statement of optimism."""
725
print "it sure does!"
729
######################################################################
733
# list of all available options; the rhs can be either None for an
734
# option that takes no argument, or a constructor function that checks
754
# List of options that apply to particular commands; commands not
759
'commit': ['message', 'verbose'],
760
'deleted': ['show-ids'],
761
'diff': ['revision'],
762
'inventory': ['revision'],
764
'ls': ['revision', 'verbose'],
765
'remove': ['verbose'],
775
'export': ['revno', 'dest'],
776
'file-id': ['filename'],
777
'file-id-path': ['filename'],
778
'get-file-text': ['text_id'],
779
'get-inventory': ['inventory_id'],
780
'get-revision': ['revision_id'],
781
'get-revision-inventory': ['revision_id'],
785
'lookup-revision': ['revno'],
786
'move': ['source$', 'dest'],
787
'relpath': ['filename'],
789
'rename': ['from_name', 'to_name'],
791
'root': ['filename?'],
796
def parse_args(argv):
797
"""Parse command line.
799
Arguments and options are parsed at this level before being passed
800
down to specific command handlers. This routine knows, from a
801
lookup table, something about the available options, what optargs
802
they take, and which commands will accept them.
804
>>> parse_args('--help'.split())
806
>>> parse_args('--version'.split())
807
([], {'version': True})
808
>>> parse_args('status --all'.split())
809
(['status'], {'all': True})
810
>>> parse_args('commit --message=biter'.split())
811
(['commit'], {'message': u'biter'})
816
# TODO: Maybe handle '--' to end options?
823
mutter(" got option %r" % a)
825
optname, optarg = a[2:].split('=', 1)
828
if optname not in OPTIONS:
829
bailout('unknown long option %r' % a)
832
if shortopt not in SHORT_OPTIONS:
833
bailout('unknown short option %r' % a)
834
optname = SHORT_OPTIONS[shortopt]
837
# XXX: Do we ever want to support this, e.g. for -r?
838
bailout('repeated option %r' % a)
840
optargfn = OPTIONS[optname]
844
bailout('option %r needs an argument' % a)
847
opts[optname] = optargfn(optarg)
850
bailout('option %r takes no argument' % optname)
859
def _match_args(cmd, args):
860
"""Check non-option arguments match required pattern.
862
>>> _match_args('status', ['asdasdsadasd'])
863
Traceback (most recent call last):
865
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
866
>>> _match_args('add', ['asdasdsadasd'])
867
{'file_list': ['asdasdsadasd']}
868
>>> _match_args('add', 'abc def gj'.split())
869
{'file_list': ['abc', 'def', 'gj']}
871
# match argument pattern
872
argform = cmd_args.get(cmd, [])
874
# TODO: Need a way to express 'cp SRC... DEST', where it matches
877
# step through args and argform, allowing appropriate 0-many matches
882
argdict[argname] = args.pop(0)
883
elif ap[-1] == '*': # all remaining arguments
885
argdict[argname + '_list'] = args[:]
888
argdict[argname + '_list'] = None
891
bailout("command %r needs one or more %s"
892
% (cmd, argname.upper()))
894
argdict[argname + '_list'] = args[:]
896
elif ap[-1] == '$': # all but one
898
bailout("command %r needs one or more %s"
899
% (cmd, argname.upper()))
900
argdict[argname + '_list'] = args[:-1]
906
bailout("command %r requires argument %s"
907
% (cmd, argname.upper()))
909
argdict[argname] = args.pop(0)
912
bailout("extra arguments to command %s: %r"
920
"""Execute a command.
922
This is similar to main(), but without all the trappings for
923
logging and error handling.
926
args, opts = parse_args(argv[1:])
928
# TODO: pass down other arguments in case they asked for
929
# help on a command name?
935
elif 'version' in opts:
940
log_error('usage: bzr COMMAND\n')
941
log_error(' try "bzr help"\n')
945
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
947
bailout("unknown command " + `cmd`)
950
if 'profile' in opts:
956
# check options are reasonable
957
allowed = cmd_options.get(cmd, [])
959
if oname not in allowed:
960
bailout("option %r is not allowed for command %r"
963
# TODO: give an error if there are any mandatory options which are
964
# not specified? Or maybe there shouldn't be any "mandatory
965
# options" (it is an oxymoron)
967
# mix arguments and options into one dictionary
968
cmdargs = _match_args(cmd, args)
969
for k, v in opts.items():
970
cmdargs[k.replace('-', '_')] = v
974
prof = hotshot.Profile('.bzr.profile')
975
ret = prof.runcall(cmd_handler, **cmdargs) or 0
979
stats = hotshot.stats.load('.bzr.profile')
981
stats.sort_stats('time')
982
stats.print_stats(20)
986
return cmd_handler(**cmdargs) or 0
991
## TODO: Handle command-line options; probably know what options are valid for
994
## TODO: If the arguments are wrong, give a usage message rather
995
## than just a backtrace.
997
bzrlib.trace.create_tracefile(argv)
1003
log_error('bzr: error: ' + e.args[0] + '\n')
1006
log_error(' ' + h + '\n')
1007
traceback.print_exc(None, bzrlib.trace._tracefile)
1008
log_error('(see $HOME/.bzr.log for debug information)\n')
1010
except Exception, e:
1011
log_error('bzr: exception: %s\n' % e)
1012
log_error('(see $HOME/.bzr.log for debug information)\n')
1013
traceback.print_exc(None, bzrlib.trace._tracefile)
1014
## traceback.print_exc(None, sys.stderr)
1017
# TODO: Maybe nicer handling of IOError?
1021
if __name__ == '__main__':
1022
sys.exit(main(sys.argv))
1024
##profile.run('main(sys.argv)')