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, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
69
from pprint import pprint
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
113
## TODO: move command; check destination is a directory and will not
116
## TODO: command to show renames, one per line, as to->from
121
def cmd_status(all=False):
122
"""Display status summary.
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
128
:todo: Don't show unchanged files unless ``--all`` is given?
130
Branch('.').show_status(show_all=all)
134
######################################################################
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
147
######################################################################
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
175
bzrlib.add.smart_add(file_list, verbose)
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
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)
199
"""info: Show statistical information for this branch
203
info.show_info(Branch('.'))
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
213
def cmd_file_id(filename):
215
i = b.inventory.path2id(b.relpath(filename))
217
bailout("%s is not a versioned file" % filename)
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
225
bailout("%s is not a live file id" % fileid)
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
235
def cmd_directories():
236
for name, ie in Branch('.').read_working_inventory().directories():
244
# TODO: Check we're not already in a working directory? At the
245
# moment you'll get an ugly error.
247
# TODO: What if we're in a subdirectory of a branch? Would like
248
# to allow that, but then the parent may need to understand that
249
# the children have disappeared, or should they be versioned in
252
# TODO: Take an argument/option for branch name.
253
Branch('.', init=True)
256
def cmd_diff(revision=None):
257
"""bzr diff: Show differences in working tree.
259
usage: bzr diff [-r REV]
262
Show changes since REV, rather than predecessor.
264
TODO: Given two revision arguments, show the difference between them.
266
TODO: Allow diff across branches.
268
TODO: Option to use external diff command; could be GNU diff, wdiff,
271
TODO: Diff selected files.
274
## TODO: Shouldn't be in the cmd function.
279
old_tree = b.basis_tree()
281
old_tree = b.revision_tree(b.lookup_revision(revision))
283
new_tree = b.working_tree()
284
old_inv = old_tree.inventory
285
new_inv = new_tree.inventory
287
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
291
DEVNULL = '/dev/null'
292
# Windows users, don't panic about this filename -- it is a
293
# special signal to GNU patch that the file should be created or
294
# deleted respectively.
296
# TODO: Generation of pseudo-diffs for added/deleted files could
297
# be usefully made into a much faster special case.
299
# TODO: Better to return them in sorted order I think.
301
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
304
# Don't show this by default; maybe do it if an option is passed
305
# idlabel = ' {%s}' % fid
308
# FIXME: Something about the diff format makes patch unhappy
309
# with newly-added files.
311
def diffit(*a, **kw):
312
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
315
if file_state in ['.', '?', 'I']:
317
elif file_state == 'A':
318
print '*** added %s %r' % (kind, new_name)
321
new_tree.get_file(fid).readlines(),
323
tofile=new_label + new_name + idlabel)
324
elif file_state == 'D':
325
assert isinstance(old_name, types.StringTypes)
326
print '*** deleted %s %r' % (kind, old_name)
328
diffit(old_tree.get_file(fid).readlines(), [],
329
fromfile=old_label + old_name + idlabel,
331
elif file_state in ['M', 'R']:
332
if file_state == 'M':
333
assert kind == 'file'
334
assert old_name == new_name
335
print '*** modified %s %r' % (kind, new_name)
336
elif file_state == 'R':
337
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
340
diffit(old_tree.get_file(fid).readlines(),
341
new_tree.get_file(fid).readlines(),
342
fromfile=old_label + old_name + idlabel,
343
tofile=new_label + new_name)
345
bailout("can't represent state %s {%s}" % (file_state, fid))
349
def cmd_deleted(show_ids=False):
350
"""List files deleted in the working tree.
352
TODO: Show files deleted since a previous revision, or between two revisions.
356
new = b.working_tree()
358
## TODO: Much more efficient way to do this: read in new
359
## directories with readdir, rather than stating each one. Same
360
## level of effort but possibly much less IO. (Or possibly not,
361
## if the directories are very large...)
363
for path, ie in old.inventory.iter_entries():
364
if not new.has_id(ie.file_id):
366
print '%-50s %s' % (path, ie.file_id)
372
def cmd_parse_inventory():
375
cElementTree.ElementTree().parse(file('.bzr/inventory'))
379
def cmd_load_inventory():
380
inv = Branch('.').basis_tree().inventory
384
def cmd_dump_new_inventory():
385
import bzrlib.newinventory
386
inv = Branch('.').basis_tree().inventory
387
bzrlib.newinventory.write_inventory(inv, sys.stdout)
390
def cmd_load_new_inventory():
391
import bzrlib.newinventory
392
bzrlib.newinventory.read_new_inventory(sys.stdin)
395
def cmd_dump_slacker_inventory():
396
import bzrlib.newinventory
397
inv = Branch('.').basis_tree().inventory
398
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
402
def cmd_root(filename=None):
403
"""Print the branch root."""
404
print bzrlib.branch.find_branch_root(filename)
407
def cmd_log(timezone='original'):
408
"""Show log of this branch.
410
:todo: Options for utc; to show ids; to limit range; etc.
412
Branch('.').write_log(show_timezone=timezone)
415
def cmd_ls(revision=None, verbose=False):
416
"""List files in a tree.
418
:todo: Take a revision or remote path and list that tree instead.
422
tree = b.working_tree()
424
tree = b.revision_tree(b.lookup_revision(revision))
426
for fp, fc, kind, fid in tree.list_files():
428
if kind == 'directory':
435
print '%-8s %s%s' % (fc, fp, kindch)
442
"""List unknown files"""
443
for f in Branch('.').unknowns():
448
def cmd_ignored(verbose=True):
449
"""List ignored files and the patterns that matched them.
451
tree = Branch('.').working_tree()
452
for path, file_class, kind, id in tree.list_files():
453
if file_class != 'I':
455
## XXX: Slightly inefficient since this was already calculated
456
pat = tree.is_ignored(path)
457
print '%-50s %s' % (path, pat)
460
def cmd_lookup_revision(revno):
464
bailout("usage: lookup-revision REVNO",
465
["REVNO is a non-negative revision number for this branch"])
467
print Branch('.').lookup_revision(revno) or NONE_STRING
471
def cmd_export(revno, dest):
472
"""Export past revision to destination directory."""
474
rh = b.lookup_revision(int(revno))
475
t = b.revision_tree(rh)
480
######################################################################
481
# internal/test commands
485
"""Print a newly-generated UUID."""
486
print bzrlib.osutils.uuid()
490
def cmd_local_time_offset():
491
print bzrlib.osutils.local_time_offset()
495
def cmd_commit(message=None, verbose=False):
496
"""Commit changes to a new revision.
499
Description of changes in this revision; free form text.
500
It is recommended that the first line be a single-sentence
503
Show status of changed files,
505
TODO: Commit only selected files.
507
TODO: Run hooks on tree to-be-committed, and after commit.
509
TODO: Strict commit that fails if there are unknown or deleted files.
513
bailout("please specify a commit message")
514
Branch('.').commit(message, verbose=verbose)
517
def cmd_check(dir='.'):
518
"""check: Consistency check of branch history.
520
usage: bzr check [-v] [BRANCH]
523
--verbose, -v Show progress of checking.
525
This command checks various invariants about the branch storage to
526
detect data corruption or bzr bugs.
529
bzrlib.check.check(Branch(dir, find_root=False))
532
def cmd_is(pred, *rest):
533
"""Test whether PREDICATE is true."""
535
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
537
bailout("unknown predicate: %s" % quotefn(pred))
541
except BzrCheckError:
542
# by default we don't print the message so that this can
543
# be used from shell scripts without producing noise
548
print bzrlib.osutils.username()
551
def cmd_user_email():
552
print bzrlib.osutils.user_email()
555
def cmd_gen_revision_id():
557
print bzrlib.branch._gen_revision_id(time.time())
560
def cmd_selftest(verbose=False):
561
"""Run internal test suite"""
562
## -v, if present, is seen by doctest; the argument is just here
563
## so our parser doesn't complain
565
## TODO: --verbose option
567
failures, tests = 0, 0
569
import doctest, bzrlib.store, bzrlib.tests
570
bzrlib.trace.verbose = False
572
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
573
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
574
mf, mt = doctest.testmod(m)
577
print '%-40s %3d tests' % (m.__name__, mt),
579
print '%3d FAILED!' % mf
583
print '%-40s %3d tests' % ('total', tests),
585
print '%3d FAILED!' % failures
592
cmd_doctest = cmd_selftest
595
######################################################################
599
def cmd_help(topic=None):
604
# otherwise, maybe the name of a command?
606
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
608
bailout("no help for %r" % topic)
612
bailout("sorry, no detailed help yet for %r" % topic)
620
print "bzr (bazaar-ng) %s" % bzrlib.__version__
621
print bzrlib.__copyright__
622
print "http://bazaar-ng.org/"
625
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
626
you may use, modify and redistribute it under the terms of the GNU
627
General Public License version 2 or later."""
631
"""Statement of optimism."""
632
print "it sure does!"
636
######################################################################
640
# list of all available options; the rhs can be either None for an
641
# option that takes no argument, or a constructor function that checks
661
# List of options that apply to particular commands; commands not
665
'commit': ['message', 'verbose'],
666
'deleted': ['show-ids'],
667
'diff': ['revision'],
668
'inventory': ['revision'],
670
'ls': ['revision', 'verbose'],
671
'remove': ['verbose'],
680
'export': ['revno', 'dest'],
681
'file-id': ['filename'],
682
'get-file-text': ['text_id'],
683
'get-inventory': ['inventory_id'],
684
'get-revision': ['revision_id'],
685
'get-revision-inventory': ['revision_id'],
689
'lookup-revision': ['revno'],
690
'relpath': ['filename'],
692
'root': ['filename?'],
697
def parse_args(argv):
698
"""Parse command line.
700
Arguments and options are parsed at this level before being passed
701
down to specific command handlers. This routine knows, from a
702
lookup table, something about the available options, what optargs
703
they take, and which commands will accept them.
705
>>> parse_args('--help'.split())
707
>>> parse_args('--version'.split())
708
([], {'version': True})
709
>>> parse_args('status --all'.split())
710
(['status'], {'all': True})
711
>>> parse_args('commit --message=biter'.split())
712
(['commit'], {'message': u'biter'})
717
# TODO: Maybe handle '--' to end options?
724
mutter(" got option %r" % a)
726
optname, optarg = a[2:].split('=', 1)
729
if optname not in OPTIONS:
730
bailout('unknown long option %r' % a)
733
if shortopt not in SHORT_OPTIONS:
734
bailout('unknown short option %r' % a)
735
optname = SHORT_OPTIONS[shortopt]
738
# XXX: Do we ever want to support this, e.g. for -r?
739
bailout('repeated option %r' % a)
741
optargfn = OPTIONS[optname]
745
bailout('option %r needs an argument' % a)
748
opts[optname] = optargfn(optarg)
751
bailout('option %r takes no argument' % optname)
760
def _match_args(cmd, args):
761
"""Check non-option arguments match required pattern.
763
>>> _match_args('status', ['asdasdsadasd'])
764
Traceback (most recent call last):
766
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
767
>>> _match_args('add', ['asdasdsadasd'])
768
{'file_list': ['asdasdsadasd']}
769
>>> _match_args('add', 'abc def gj'.split())
770
{'file_list': ['abc', 'def', 'gj']}
772
# match argument pattern
773
argform = cmd_args.get(cmd, [])
775
# TODO: Need a way to express 'cp SRC... DEST', where it matches
778
# step through args and argform, allowing appropriate 0-many matches
783
argdict[argname] = args.pop(0)
788
bailout("command %r needs one or more %s"
789
% (cmd, argname.upper()))
791
argdict[argname + '_list'] = args[:]
797
bailout("command %r requires argument %s"
798
% (cmd, argname.upper()))
800
argdict[argname] = args.pop(0)
803
bailout("extra arguments to command %s: %r"
811
"""Execute a command.
813
This is similar to main(), but without all the trappings for
814
logging and error handling.
817
args, opts = parse_args(argv[1:])
819
# TODO: pass down other arguments in case they asked for
820
# help on a command name?
823
elif 'version' in opts:
828
log_error('usage: bzr COMMAND\n')
829
log_error(' try "bzr help"\n')
833
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
835
bailout("unknown command " + `cmd`)
838
if 'profile' in opts:
844
# check options are reasonable
845
allowed = cmd_options.get(cmd, [])
847
if oname not in allowed:
848
bailout("option %r is not allowed for command %r"
851
# mix arguments and options into one dictionary
852
cmdargs = _match_args(cmd, args)
853
for k, v in opts.items():
854
cmdargs[k.replace('-', '_')] = v
858
prof = hotshot.Profile('.bzr.profile')
859
ret = prof.runcall(cmd_handler, **cmdargs) or 0
863
stats = hotshot.stats.load('.bzr.profile')
865
stats.sort_stats('time')
866
stats.print_stats(20)
868
return cmd_handler(**cmdargs) or 0
873
## TODO: Handle command-line options; probably know what options are valid for
876
## TODO: If the arguments are wrong, give a usage message rather
877
## than just a backtrace.
879
bzrlib.trace.create_tracefile(argv)
885
log_error('bzr: error: ' + e.args[0] + '\n')
888
log_error(' ' + h + '\n')
891
log_error('bzr: exception: %s\n' % e)
892
log_error(' see .bzr.log for details\n')
893
traceback.print_exc(None, bzrlib.trace._tracefile)
894
traceback.print_exc(None, sys.stderr)
897
# TODO: Maybe nicer handling of IOError?
901
if __name__ == '__main__':
902
sys.exit(main(sys.argv))
904
##profile.run('main(sys.argv)')