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)
184
def cmd_inventory(revision=None):
185
"""Show inventory of the current working copy."""
186
## TODO: Also optionally show a previous inventory
187
## TODO: Format options
190
inv = b.read_working_inventory()
192
inv = b.get_revision_inventory(b.lookup_revision(revision))
194
for path, entry in inv.iter_entries():
195
print '%-50s %s' % (entry.file_id, path)
199
def cmd_mv(source_list, dest):
202
b.rename([b.relpath(s) for s in source_list], b.relpath(dest))
206
def cmd_rename(from_name, to_name):
207
"""Change the name of an entry.
209
usage: bzr rename FROM_NAME TO_NAME
212
bzr rename frob.c frobber.c
213
bzr rename src/frob.c lib/frob.c
215
It is an error if the destination name exists.
217
See also the 'move' command, which moves files into a different
218
directory without changing their name.
220
TODO: Some way to rename multiple files without invoking bzr for each
223
b.rename_one(b.relpath(from_name), b.relpath(to_name))
228
def cmd_renames(dir='.'):
229
"""Show list of renamed files.
231
usage: bzr renames [BRANCH]
233
TODO: Option to show renames between two historical versions.
235
TODO: Only show renames under dir, rather than in the whole branch.
238
old_inv = b.basis_tree().inventory
239
new_inv = b.read_working_inventory()
241
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
243
for old_name, new_name in renames:
244
print "%s => %s" % (old_name, new_name)
249
"""info: Show statistical information for this branch
253
info.show_info(Branch('.'))
257
def cmd_remove(file_list, verbose=False):
258
b = Branch(file_list[0])
259
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
263
def cmd_file_id(filename):
265
i = b.inventory.path2id(b.relpath(filename))
267
bailout("%s is not a versioned file" % filename)
272
def cmd_find_filename(fileid):
273
n = find_filename(fileid)
275
bailout("%s is not a live file id" % fileid)
280
def cmd_revision_history():
281
for patchid in Branch('.').revision_history():
285
def cmd_directories():
286
for name, ie in Branch('.').read_working_inventory().directories():
294
for name, ie in Branch('.').working_tree().missing():
299
# TODO: Check we're not already in a working directory? At the
300
# moment you'll get an ugly error.
302
# TODO: What if we're in a subdirectory of a branch? Would like
303
# to allow that, but then the parent may need to understand that
304
# the children have disappeared, or should they be versioned in
307
# TODO: Take an argument/option for branch name.
308
Branch('.', init=True)
311
def cmd_diff(revision=None):
312
"""bzr diff: Show differences in working tree.
314
usage: bzr diff [-r REV]
317
Show changes since REV, rather than predecessor.
319
TODO: Given two revision arguments, show the difference between them.
321
TODO: Allow diff across branches.
323
TODO: Option to use external diff command; could be GNU diff, wdiff,
326
TODO: Diff selected files.
329
## TODO: Shouldn't be in the cmd function.
334
old_tree = b.basis_tree()
336
old_tree = b.revision_tree(b.lookup_revision(revision))
338
new_tree = b.working_tree()
339
old_inv = old_tree.inventory
340
new_inv = new_tree.inventory
342
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
346
DEVNULL = '/dev/null'
347
# Windows users, don't panic about this filename -- it is a
348
# special signal to GNU patch that the file should be created or
349
# deleted respectively.
351
# TODO: Generation of pseudo-diffs for added/deleted files could
352
# be usefully made into a much faster special case.
354
# TODO: Better to return them in sorted order I think.
356
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
359
# Don't show this by default; maybe do it if an option is passed
360
# idlabel = ' {%s}' % fid
363
# FIXME: Something about the diff format makes patch unhappy
364
# with newly-added files.
366
def diffit(oldlines, newlines, **kw):
367
# FIXME: difflib is wrong if there is no trailing newline.
369
# Special workaround for Python2.3, where difflib fails if
370
# both sequences are empty.
371
if oldlines or newlines:
372
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
375
if file_state in ['.', '?', 'I']:
377
elif file_state == 'A':
378
print '*** added %s %r' % (kind, new_name)
381
new_tree.get_file(fid).readlines(),
383
tofile=new_label + new_name + idlabel)
384
elif file_state == 'D':
385
assert isinstance(old_name, types.StringTypes)
386
print '*** deleted %s %r' % (kind, old_name)
388
diffit(old_tree.get_file(fid).readlines(), [],
389
fromfile=old_label + old_name + idlabel,
391
elif file_state in ['M', 'R']:
392
if file_state == 'M':
393
assert kind == 'file'
394
assert old_name == new_name
395
print '*** modified %s %r' % (kind, new_name)
396
elif file_state == 'R':
397
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
400
diffit(old_tree.get_file(fid).readlines(),
401
new_tree.get_file(fid).readlines(),
402
fromfile=old_label + old_name + idlabel,
403
tofile=new_label + new_name)
405
bailout("can't represent state %s {%s}" % (file_state, fid))
409
def cmd_deleted(show_ids=False):
410
"""List files deleted in the working tree.
412
TODO: Show files deleted since a previous revision, or between two revisions.
416
new = b.working_tree()
418
## TODO: Much more efficient way to do this: read in new
419
## directories with readdir, rather than stating each one. Same
420
## level of effort but possibly much less IO. (Or possibly not,
421
## if the directories are very large...)
423
for path, ie in old.inventory.iter_entries():
424
if not new.has_id(ie.file_id):
426
print '%-50s %s' % (path, ie.file_id)
432
def cmd_parse_inventory():
435
cElementTree.ElementTree().parse(file('.bzr/inventory'))
439
def cmd_load_inventory():
440
inv = Branch('.').basis_tree().inventory
444
def cmd_dump_new_inventory():
445
import bzrlib.newinventory
446
inv = Branch('.').basis_tree().inventory
447
bzrlib.newinventory.write_inventory(inv, sys.stdout)
450
def cmd_load_new_inventory():
451
import bzrlib.newinventory
452
bzrlib.newinventory.read_new_inventory(sys.stdin)
455
def cmd_dump_slacker_inventory():
456
import bzrlib.newinventory
457
inv = Branch('.').basis_tree().inventory
458
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
462
def cmd_root(filename=None):
463
"""Print the branch root."""
464
print bzrlib.branch.find_branch_root(filename)
467
def cmd_log(timezone='original'):
468
"""Show log of this branch.
470
:todo: Options for utc; to show ids; to limit range; etc.
472
Branch('.').write_log(show_timezone=timezone)
475
def cmd_ls(revision=None, verbose=False):
476
"""List files in a tree.
478
:todo: Take a revision or remote path and list that tree instead.
482
tree = b.working_tree()
484
tree = b.revision_tree(b.lookup_revision(revision))
486
for fp, fc, kind, fid in tree.list_files():
488
if kind == 'directory':
495
print '%-8s %s%s' % (fc, fp, kindch)
502
"""List unknown files"""
503
for f in Branch('.').unknowns():
508
def cmd_ignored(verbose=True):
509
"""List ignored files and the patterns that matched them.
511
tree = Branch('.').working_tree()
512
for path, file_class, kind, id in tree.list_files():
513
if file_class != 'I':
515
## XXX: Slightly inefficient since this was already calculated
516
pat = tree.is_ignored(path)
517
print '%-50s %s' % (path, pat)
520
def cmd_lookup_revision(revno):
524
bailout("usage: lookup-revision REVNO",
525
["REVNO is a non-negative revision number for this branch"])
527
print Branch('.').lookup_revision(revno) or NONE_STRING
531
def cmd_export(revno, dest):
532
"""Export past revision to destination directory."""
534
rh = b.lookup_revision(int(revno))
535
t = b.revision_tree(rh)
540
######################################################################
541
# internal/test commands
545
"""Print a newly-generated UUID."""
546
print bzrlib.osutils.uuid()
550
def cmd_local_time_offset():
551
print bzrlib.osutils.local_time_offset()
555
def cmd_commit(message=None, verbose=False):
556
"""Commit changes to a new revision.
559
Description of changes in this revision; free form text.
560
It is recommended that the first line be a single-sentence
563
Show status of changed files,
565
TODO: Commit only selected files.
567
TODO: Run hooks on tree to-be-committed, and after commit.
569
TODO: Strict commit that fails if there are unknown or deleted files.
573
bailout("please specify a commit message")
574
Branch('.').commit(message, verbose=verbose)
577
def cmd_check(dir='.'):
578
"""check: Consistency check of branch history.
580
usage: bzr check [-v] [BRANCH]
583
--verbose, -v Show progress of checking.
585
This command checks various invariants about the branch storage to
586
detect data corruption or bzr bugs.
589
bzrlib.check.check(Branch(dir, find_root=False))
592
def cmd_is(pred, *rest):
593
"""Test whether PREDICATE is true."""
595
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
597
bailout("unknown predicate: %s" % quotefn(pred))
601
except BzrCheckError:
602
# by default we don't print the message so that this can
603
# be used from shell scripts without producing noise
608
print bzrlib.osutils.username()
611
def cmd_user_email():
612
print bzrlib.osutils.user_email()
615
def cmd_gen_revision_id():
617
print bzrlib.branch._gen_revision_id(time.time())
620
def cmd_selftest(verbose=False):
621
"""Run internal test suite"""
622
## -v, if present, is seen by doctest; the argument is just here
623
## so our parser doesn't complain
625
## TODO: --verbose option
627
failures, tests = 0, 0
629
import doctest, bzrlib.store, bzrlib.tests
630
bzrlib.trace.verbose = False
632
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
633
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
634
mf, mt = doctest.testmod(m)
637
print '%-40s %3d tests' % (m.__name__, mt),
639
print '%3d FAILED!' % mf
643
print '%-40s %3d tests' % ('total', tests),
645
print '%3d FAILED!' % failures
652
cmd_doctest = cmd_selftest
655
######################################################################
659
def cmd_help(topic=None):
664
# otherwise, maybe the name of a command?
666
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
668
bailout("no help for %r" % topic)
672
bailout("sorry, no detailed help yet for %r" % topic)
680
print "bzr (bazaar-ng) %s" % bzrlib.__version__
681
print bzrlib.__copyright__
682
print "http://bazaar-ng.org/"
685
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
686
you may use, modify and redistribute it under the terms of the GNU
687
General Public License version 2 or later."""
691
"""Statement of optimism."""
692
print "it sure does!"
696
######################################################################
700
# list of all available options; the rhs can be either None for an
701
# option that takes no argument, or a constructor function that checks
721
# List of options that apply to particular commands; commands not
725
'commit': ['message', 'verbose'],
726
'deleted': ['show-ids'],
727
'diff': ['revision'],
728
'inventory': ['revision'],
730
'ls': ['revision', 'verbose'],
731
'remove': ['verbose'],
740
'export': ['revno', 'dest'],
741
'file-id': ['filename'],
742
'get-file-text': ['text_id'],
743
'get-inventory': ['inventory_id'],
744
'get-revision': ['revision_id'],
745
'get-revision-inventory': ['revision_id'],
749
'lookup-revision': ['revno'],
750
'mv': ['source$', 'dest'],
751
'relpath': ['filename'],
753
'rename': ['from_name', 'to_name'],
755
'root': ['filename?'],
760
def parse_args(argv):
761
"""Parse command line.
763
Arguments and options are parsed at this level before being passed
764
down to specific command handlers. This routine knows, from a
765
lookup table, something about the available options, what optargs
766
they take, and which commands will accept them.
768
>>> parse_args('--help'.split())
770
>>> parse_args('--version'.split())
771
([], {'version': True})
772
>>> parse_args('status --all'.split())
773
(['status'], {'all': True})
774
>>> parse_args('commit --message=biter'.split())
775
(['commit'], {'message': u'biter'})
780
# TODO: Maybe handle '--' to end options?
787
mutter(" got option %r" % a)
789
optname, optarg = a[2:].split('=', 1)
792
if optname not in OPTIONS:
793
bailout('unknown long option %r' % a)
796
if shortopt not in SHORT_OPTIONS:
797
bailout('unknown short option %r' % a)
798
optname = SHORT_OPTIONS[shortopt]
801
# XXX: Do we ever want to support this, e.g. for -r?
802
bailout('repeated option %r' % a)
804
optargfn = OPTIONS[optname]
808
bailout('option %r needs an argument' % a)
811
opts[optname] = optargfn(optarg)
814
bailout('option %r takes no argument' % optname)
823
def _match_args(cmd, args):
824
"""Check non-option arguments match required pattern.
826
>>> _match_args('status', ['asdasdsadasd'])
827
Traceback (most recent call last):
829
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
830
>>> _match_args('add', ['asdasdsadasd'])
831
{'file_list': ['asdasdsadasd']}
832
>>> _match_args('add', 'abc def gj'.split())
833
{'file_list': ['abc', 'def', 'gj']}
835
# match argument pattern
836
argform = cmd_args.get(cmd, [])
838
# TODO: Need a way to express 'cp SRC... DEST', where it matches
841
# step through args and argform, allowing appropriate 0-many matches
846
argdict[argname] = args.pop(0)
851
bailout("command %r needs one or more %s"
852
% (cmd, argname.upper()))
854
argdict[argname + '_list'] = args[:]
856
elif ap[-1] == '$': # all but one
858
bailout("command %r needs one or more %s"
859
% (cmd, argname.upper()))
860
argdict[argname + '_list'] = args[:-1]
866
bailout("command %r requires argument %s"
867
% (cmd, argname.upper()))
869
argdict[argname] = args.pop(0)
872
bailout("extra arguments to command %s: %r"
880
"""Execute a command.
882
This is similar to main(), but without all the trappings for
883
logging and error handling.
886
args, opts = parse_args(argv[1:])
888
# TODO: pass down other arguments in case they asked for
889
# help on a command name?
895
elif 'version' in opts:
900
log_error('usage: bzr COMMAND\n')
901
log_error(' try "bzr help"\n')
905
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
907
bailout("unknown command " + `cmd`)
910
if 'profile' in opts:
916
# check options are reasonable
917
allowed = cmd_options.get(cmd, [])
919
if oname not in allowed:
920
bailout("option %r is not allowed for command %r"
923
# mix arguments and options into one dictionary
924
cmdargs = _match_args(cmd, args)
925
for k, v in opts.items():
926
cmdargs[k.replace('-', '_')] = v
930
prof = hotshot.Profile('.bzr.profile')
931
ret = prof.runcall(cmd_handler, **cmdargs) or 0
935
stats = hotshot.stats.load('.bzr.profile')
937
stats.sort_stats('time')
938
stats.print_stats(20)
940
return cmd_handler(**cmdargs) or 0
945
## TODO: Handle command-line options; probably know what options are valid for
948
## TODO: If the arguments are wrong, give a usage message rather
949
## than just a backtrace.
951
bzrlib.trace.create_tracefile(argv)
957
log_error('bzr: error: ' + e.args[0] + '\n')
960
log_error(' ' + h + '\n')
963
log_error('bzr: exception: %s\n' % e)
964
log_error(' see .bzr.log for details\n')
965
traceback.print_exc(None, bzrlib.trace._tracefile)
966
traceback.print_exc(None, sys.stderr)
969
# TODO: Maybe nicer handling of IOError?
973
if __name__ == '__main__':
974
sys.exit(main(sys.argv))
976
##profile.run('main(sys.argv)')