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():
 
 
237
    # TODO: Check we're not already in a working directory?  At the
 
 
238
    # moment you'll get an ugly error.
 
 
240
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
 
241
    # to allow that, but then the parent may need to understand that
 
 
242
    # the children have disappeared, or should they be versioned in
 
 
245
    # TODO: Take an argument/option for branch name.
 
 
246
    Branch('.', init=True)
 
 
249
def cmd_diff(revision=None):
 
 
250
    """bzr diff: Show differences in working tree.
 
 
252
usage: bzr diff [-r REV]
 
 
255
    Show changes since REV, rather than predecessor.
 
 
257
TODO: Given two revision arguments, show the difference between them.
 
 
259
TODO: Allow diff across branches.
 
 
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
264
TODO: Diff selected files.
 
 
267
    ## TODO: Shouldn't be in the cmd function.
 
 
272
        old_tree = b.basis_tree()
 
 
274
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
 
276
    new_tree = b.working_tree()
 
 
277
    old_inv = old_tree.inventory
 
 
278
    new_inv = new_tree.inventory
 
 
280
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
284
    DEVNULL = '/dev/null'
 
 
285
    # Windows users, don't panic about this filename -- it is a
 
 
286
    # special signal to GNU patch that the file should be created or
 
 
287
    # deleted respectively.
 
 
289
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
290
    # be usefully made into a much faster special case.
 
 
292
    # TODO: Better to return them in sorted order I think.
 
 
294
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
 
297
        # Don't show this by default; maybe do it if an option is passed
 
 
298
        # idlabel = '      {%s}' % fid
 
 
301
        # FIXME: Something about the diff format makes patch unhappy
 
 
302
        # with newly-added files.
 
 
304
        def diffit(*a, **kw):
 
 
305
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
 
 
308
        if file_state in ['.', '?', 'I']:
 
 
310
        elif file_state == 'A':
 
 
311
            print '*** added %s %r' % (kind, new_name)
 
 
314
                       new_tree.get_file(fid).readlines(),
 
 
316
                       tofile=new_label + new_name + idlabel)
 
 
317
        elif file_state == 'D':
 
 
318
            assert isinstance(old_name, types.StringTypes)
 
 
319
            print '*** deleted %s %r' % (kind, old_name)
 
 
321
                diffit(old_tree.get_file(fid).readlines(), [],
 
 
322
                       fromfile=old_label + old_name + idlabel,
 
 
324
        elif file_state in ['M', 'R']:
 
 
325
            if file_state == 'M':
 
 
326
                assert kind == 'file'
 
 
327
                assert old_name == new_name
 
 
328
                print '*** modified %s %r' % (kind, new_name)
 
 
329
            elif file_state == 'R':
 
 
330
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
 
333
                diffit(old_tree.get_file(fid).readlines(),
 
 
334
                       new_tree.get_file(fid).readlines(),
 
 
335
                       fromfile=old_label + old_name + idlabel,
 
 
336
                       tofile=new_label + new_name)
 
 
338
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
 
342
def cmd_deleted(show_ids=False):
 
 
343
    """List files deleted in the working tree.
 
 
345
TODO: Show files deleted since a previous revision, or between two revisions.
 
 
349
    new = b.working_tree()
 
 
351
    for path, ie in old.inventory.iter_entries():
 
 
352
        if not new.has_id(ie.file_id):
 
 
354
                print '%-50s %s' % (path, ie.file_id)
 
 
361
def cmd_root(filename=None):
 
 
362
    """Print the branch root."""
 
 
363
    print bzrlib.branch.find_branch_root(filename)
 
 
366
def cmd_log(timezone='original'):
 
 
367
    """Show log of this branch.
 
 
369
    :todo: Options for utc; to show ids; to limit range; etc.
 
 
371
    Branch('.').write_log(show_timezone=timezone)
 
 
374
def cmd_ls(revision=None, verbose=False):
 
 
375
    """List files in a tree.
 
 
377
    :todo: Take a revision or remote path and list that tree instead.
 
 
381
        tree = b.working_tree()
 
 
383
        tree = b.revision_tree(b.lookup_revision(revision))
 
 
385
    for fp, fc, kind, fid in tree.list_files():
 
 
387
            if kind == 'directory':
 
 
394
            print '%-8s %s%s' % (fc, fp, kindch)
 
 
401
    """List unknown files"""
 
 
402
    for f in Branch('.').unknowns():
 
 
407
def cmd_ignored(verbose=True):
 
 
408
    """List ignored files and the patterns that matched them.
 
 
410
    tree = Branch('.').working_tree()
 
 
411
    for path, file_class, kind, id in tree.list_files():
 
 
412
        if file_class != 'I':
 
 
414
        ## XXX: Slightly inefficient since this was already calculated
 
 
415
        pat = tree.is_ignored(path)
 
 
416
        print '%-50s %s' % (path, pat)
 
 
419
def cmd_lookup_revision(revno):
 
 
423
        bailout("usage: lookup-revision REVNO",
 
 
424
                ["REVNO is a non-negative revision number for this branch"])
 
 
426
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
 
430
def cmd_export(revno, dest):
 
 
431
    """Export past revision to destination directory."""
 
 
433
    rh = b.lookup_revision(int(revno))
 
 
434
    t = b.revision_tree(rh)
 
 
439
######################################################################
 
 
440
# internal/test commands
 
 
444
    """Print a newly-generated UUID."""
 
 
445
    print bzrlib.osutils.uuid()
 
 
449
def cmd_local_time_offset():
 
 
450
    print bzrlib.osutils.local_time_offset()
 
 
454
def cmd_commit(message=None, verbose=False):
 
 
455
    """Commit changes to a new revision.
 
 
458
    Description of changes in this revision; free form text.
 
 
459
    It is recommended that the first line be a single-sentence
 
 
462
    Show status of changed files,
 
 
464
TODO: Commit only selected files.
 
 
466
TODO: Run hooks on tree to-be-committed, and after commit.
 
 
468
TODO: Strict commit that fails if there are unknown or deleted files.
 
 
472
        bailout("please specify a commit message")
 
 
473
    Branch('.').commit(message, verbose=verbose)
 
 
476
def cmd_check(dir='.'):
 
 
477
    """check: Consistency check of branch history.
 
 
479
usage: bzr check [-v] [BRANCH]
 
 
482
  --verbose, -v         Show progress of checking.
 
 
484
This command checks various invariants about the branch storage to
 
 
485
detect data corruption or bzr bugs.
 
 
488
    bzrlib.check.check(Branch(dir, find_root=False))
 
 
491
def cmd_is(pred, *rest):
 
 
492
    """Test whether PREDICATE is true."""
 
 
494
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
 
496
        bailout("unknown predicate: %s" % quotefn(pred))
 
 
500
    except BzrCheckError:
 
 
501
        # by default we don't print the message so that this can
 
 
502
        # be used from shell scripts without producing noise
 
 
507
    print bzrlib.osutils.username()
 
 
510
def cmd_user_email():
 
 
511
    print bzrlib.osutils.user_email()
 
 
514
def cmd_gen_revision_id():
 
 
516
    print bzrlib.branch._gen_revision_id(time.time())
 
 
519
def cmd_selftest(verbose=False):
 
 
520
    """Run internal test suite"""
 
 
521
    ## -v, if present, is seen by doctest; the argument is just here
 
 
522
    ## so our parser doesn't complain
 
 
524
    ## TODO: --verbose option
 
 
526
    failures, tests = 0, 0
 
 
528
    import doctest, bzrlib.store, bzrlib.tests
 
 
529
    bzrlib.trace.verbose = False
 
 
531
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
 
532
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
 
533
        mf, mt = doctest.testmod(m)
 
 
536
        print '%-40s %3d tests' % (m.__name__, mt),
 
 
538
            print '%3d FAILED!' % mf
 
 
542
    print '%-40s %3d tests' % ('total', tests),
 
 
544
        print '%3d FAILED!' % failures
 
 
551
cmd_doctest = cmd_selftest
 
 
554
######################################################################
 
 
558
def cmd_help(topic=None):
 
 
563
    # otherwise, maybe the name of a command?
 
 
565
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
 
 
567
        bailout("no help for %r" % topic)
 
 
571
        bailout("sorry, no detailed help yet for %r" % topic)
 
 
579
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
580
    print bzrlib.__copyright__
 
 
581
    print "http://bazaar-ng.org/"
 
 
584
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
 
585
you may use, modify and redistribute it under the terms of the GNU 
 
 
586
General Public License version 2 or later."""
 
 
590
    """Statement of optimism."""
 
 
591
    print "it sure does!"
 
 
595
######################################################################
 
 
599
# list of all available options; the rhs can be either None for an
 
 
600
# option that takes no argument, or a constructor function that checks
 
 
620
# List of options that apply to particular commands; commands not
 
 
624
    'commit':                 ['message', 'verbose'],
 
 
625
    'deleted':                ['show-ids'],
 
 
626
    'diff':                   ['revision'],
 
 
627
    'inventory':              ['revision'],
 
 
629
    'ls':                     ['revision', 'verbose'],
 
 
630
    'remove':                 ['verbose'],
 
 
639
    'export':                 ['revno', 'dest'],
 
 
640
    'file-id':                ['filename'],
 
 
641
    'get-file-text':          ['text_id'],
 
 
642
    'get-inventory':          ['inventory_id'],
 
 
643
    'get-revision':           ['revision_id'],
 
 
644
    'get-revision-inventory': ['revision_id'],
 
 
648
    'lookup-revision':        ['revno'],
 
 
649
    'relpath':                ['filename'],
 
 
651
    'root':                   ['filename?'],
 
 
656
def parse_args(argv):
 
 
657
    """Parse command line.
 
 
659
    Arguments and options are parsed at this level before being passed
 
 
660
    down to specific command handlers.  This routine knows, from a
 
 
661
    lookup table, something about the available options, what optargs
 
 
662
    they take, and which commands will accept them.
 
 
664
    >>> parse_args('--help'.split())
 
 
666
    >>> parse_args('--version'.split())
 
 
667
    ([], {'version': True})
 
 
668
    >>> parse_args('status --all'.split())
 
 
669
    (['status'], {'all': True})
 
 
670
    >>> parse_args('commit --message=biter'.split())
 
 
671
    (['commit'], {'message': u'biter'})
 
 
676
    # TODO: Maybe handle '--' to end options?
 
 
683
                mutter("  got option %r" % a)
 
 
685
                    optname, optarg = a[2:].split('=', 1)
 
 
688
                if optname not in OPTIONS:
 
 
689
                    bailout('unknown long option %r' % a)
 
 
692
                if shortopt not in SHORT_OPTIONS:
 
 
693
                    bailout('unknown short option %r' % a)
 
 
694
                optname = SHORT_OPTIONS[shortopt]
 
 
697
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
698
                bailout('repeated option %r' % a)
 
 
700
            optargfn = OPTIONS[optname]
 
 
704
                        bailout('option %r needs an argument' % a)
 
 
707
                opts[optname] = optargfn(optarg)
 
 
710
                    bailout('option %r takes no argument' % optname)
 
 
719
def _match_args(cmd, args):
 
 
720
    """Check non-option arguments match required pattern.
 
 
722
    >>> _match_args('status', ['asdasdsadasd'])
 
 
723
    Traceback (most recent call last):
 
 
725
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
 
726
    >>> _match_args('add', ['asdasdsadasd'])
 
 
727
    {'file_list': ['asdasdsadasd']}
 
 
728
    >>> _match_args('add', 'abc def gj'.split())
 
 
729
    {'file_list': ['abc', 'def', 'gj']}
 
 
731
    # match argument pattern
 
 
732
    argform = cmd_args.get(cmd, [])
 
 
734
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
 
737
    # step through args and argform, allowing appropriate 0-many matches
 
 
742
                argdict[argname] = args.pop(0)
 
 
747
                bailout("command %r needs one or more %s"
 
 
748
                        % (cmd, argname.upper()))
 
 
750
                argdict[argname + '_list'] = args[:]
 
 
756
                bailout("command %r requires argument %s"
 
 
757
                        % (cmd, argname.upper()))
 
 
759
                argdict[argname] = args.pop(0)
 
 
762
        bailout("extra arguments to command %s: %r"
 
 
770
    """Execute a command.
 
 
772
    This is similar to main(), but without all the trappings for
 
 
773
    logging and error handling.
 
 
776
        args, opts = parse_args(argv[1:])
 
 
778
            # TODO: pass down other arguments in case they asked for
 
 
779
            # help on a command name?
 
 
782
        elif 'version' in opts:
 
 
787
        log_error('usage: bzr COMMAND\n')
 
 
788
        log_error('  try "bzr help"\n')
 
 
792
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
 
794
        bailout("unknown command " + `cmd`)
 
 
797
    if 'profile' in opts:
 
 
803
    # check options are reasonable
 
 
804
    allowed = cmd_options.get(cmd, [])
 
 
806
        if oname not in allowed:
 
 
807
            bailout("option %r is not allowed for command %r"
 
 
810
    # mix arguments and options into one dictionary
 
 
811
    cmdargs = _match_args(cmd, args)
 
 
812
    for k, v in opts.items():
 
 
813
        cmdargs[k.replace('-', '_')] = v
 
 
817
        prof = hotshot.Profile('.bzr.profile')
 
 
818
        ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
 
822
        stats = hotshot.stats.load('.bzr.profile')
 
 
824
        stats.sort_stats('cumulative', 'calls')
 
 
825
        stats.print_stats(20)
 
 
827
        return cmd_handler(**cmdargs) or 0
 
 
832
    ## TODO: Handle command-line options; probably know what options are valid for
 
 
835
    ## TODO: If the arguments are wrong, give a usage message rather
 
 
836
    ## than just a backtrace.
 
 
838
    bzrlib.trace.create_tracefile(argv)
 
 
844
        log_error('bzr: error: ' + e.args[0] + '\n')
 
 
847
                log_error('  ' + h + '\n')
 
 
850
        log_error('bzr: exception: %s\n' % e)
 
 
851
        log_error('    see .bzr.log for details\n')
 
 
852
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
 
853
        traceback.print_exc(None, sys.stderr)
 
 
856
    # TODO: Maybe nicer handling of IOError?
 
 
860
if __name__ == '__main__':
 
 
861
    sys.exit(main(sys.argv))
 
 
863
    ##profile.run('main(sys.argv)')