1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
19
import sys, os, time, os.path
 
 
23
from bzrlib.trace import mutter, note, log_error
 
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
 
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
 
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
 
27
from bzrlib.revision import Revision
 
 
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
 
32
def _squish_command_name(cmd):
 
 
33
    return 'cmd_' + cmd.replace('-', '_')
 
 
36
def _unsquish_command_name(cmd):
 
 
37
    assert cmd.startswith("cmd_")
 
 
38
    return cmd[4:].replace('_','-')
 
 
41
    """Return canonical name and class for all registered commands."""
 
 
42
    for k, v in globals().iteritems():
 
 
43
        if k.startswith("cmd_"):
 
 
44
            yield _unsquish_command_name(k), v
 
 
46
def get_cmd_class(cmd):
 
 
47
    """Return the canonical name and command class for a command.
 
 
49
    cmd = str(cmd)                      # not unicode
 
 
51
    # first look up this command under the specified name
 
 
53
        return cmd, globals()[_squish_command_name(cmd)]
 
 
57
    # look for any command which claims this as an alias
 
 
58
    for cmdname, cmdclass in get_all_cmds():
 
 
59
        if cmd in cmdclass.aliases:
 
 
60
            return cmdname, cmdclass
 
 
62
        raise BzrCommandError("unknown command %r" % cmd)
 
 
66
    """Base class for commands.
 
 
68
    The docstring for an actual command should give a single-line
 
 
69
    summary, then a complete description of the command.  A grammar
 
 
70
    description will be inserted.
 
 
73
        List of argument forms, marked with whether they are optional,
 
 
77
        List of options that may be given for this command.
 
 
80
        If true, this command isn't advertised.
 
 
89
    def __init__(self, options, arguments):
 
 
90
        """Construct and run the command.
 
 
92
        Sets self.status to the return value of run()."""
 
 
93
        assert isinstance(options, dict)
 
 
94
        assert isinstance(arguments, dict)
 
 
95
        cmdargs = options.copy()
 
 
96
        cmdargs.update(arguments)
 
 
97
        assert self.__doc__ != Command.__doc__, \
 
 
98
               ("No help message set for %r" % self)
 
 
99
        self.status = self.run(**cmdargs)
 
 
103
        """Override this in sub-classes.
 
 
105
        This is invoked with the options and arguments bound to
 
 
108
        Return 0 or None if the command was successful, or a shell
 
 
115
class cmd_status(Command):
 
 
116
    """Display status summary.
 
 
118
    For each file there is a single line giving its file state and name.
 
 
119
    The name is that in the current revision unless it is deleted or
 
 
120
    missing, in which case the old name is shown.
 
 
122
    takes_options = ['all']
 
 
123
    aliases = ['st', 'stat']
 
 
125
    def run(self, all=False):
 
 
126
        #import bzrlib.status
 
 
127
        #bzrlib.status.tree_status(Branch('.'))
 
 
128
        Branch('.').show_status(show_all=all)
 
 
131
class cmd_cat_revision(Command):
 
 
132
    """Write out metadata for a revision."""
 
 
135
    takes_args = ['revision_id']
 
 
137
    def run(self, revision_id):
 
 
138
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
 
141
class cmd_revno(Command):
 
 
142
    """Show current revision number.
 
 
144
    This is equal to the number of revisions on this branch."""
 
 
146
        print Branch('.').revno()
 
 
149
class cmd_add(Command):
 
 
150
    """Add specified files or directories.
 
 
152
    In non-recursive mode, all the named items are added, regardless
 
 
153
    of whether they were previously ignored.  A warning is given if
 
 
154
    any of the named files are already versioned.
 
 
156
    In recursive mode (the default), files are treated the same way
 
 
157
    but the behaviour for directories is different.  Directories that
 
 
158
    are already versioned do not give a warning.  All directories,
 
 
159
    whether already versioned or not, are searched for files or
 
 
160
    subdirectories that are neither versioned or ignored, and these
 
 
161
    are added.  This search proceeds recursively into versioned
 
 
164
    Therefore simply saying 'bzr add .' will version all files that
 
 
165
    are currently unknown.
 
 
167
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
168
    recursively add that parent, rather than giving an error?
 
 
170
    takes_args = ['file+']
 
 
171
    takes_options = ['verbose']
 
 
173
    def run(self, file_list, verbose=False):
 
 
174
        bzrlib.add.smart_add(file_list, verbose)
 
 
177
def Relpath(Command):
 
 
178
    """Show path of a file relative to root"""
 
 
179
    takes_args = ('filename')
 
 
182
        print Branch(self.args['filename']).relpath(filename)
 
 
186
class cmd_inventory(Command):
 
 
187
    """Show inventory of the current working copy or a revision."""
 
 
188
    takes_options = ['revision']
 
 
190
    def run(self, revision=None):
 
 
193
            inv = b.read_working_inventory()
 
 
195
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
 
197
        for path, entry in inv.iter_entries():
 
 
198
            print '%-50s %s' % (entry.file_id, path)
 
 
201
class cmd_move(Command):
 
 
202
    """Move files to a different directory.
 
 
207
    The destination must be a versioned directory in the same branch.
 
 
209
    takes_args = ['source$', 'dest']
 
 
210
    def run(self, source_list, dest):
 
 
213
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
216
class cmd_rename(Command):
 
 
217
    """Change the name of an entry.
 
 
220
      bzr rename frob.c frobber.c
 
 
221
      bzr rename src/frob.c lib/frob.c
 
 
223
    It is an error if the destination name exists.
 
 
225
    See also the 'move' command, which moves files into a different
 
 
226
    directory without changing their name.
 
 
228
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
230
    takes_args = ['from_name', 'to_name']
 
 
232
    def run(self, from_name, to_name):
 
 
234
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
238
class cmd_renames(Command):
 
 
239
    """Show list of renamed files.
 
 
241
    TODO: Option to show renames between two historical versions.
 
 
243
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
245
    takes_args = ['dir?']
 
 
247
    def run(self, dir='.'):
 
 
249
        old_inv = b.basis_tree().inventory
 
 
250
        new_inv = b.read_working_inventory()
 
 
252
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
254
        for old_name, new_name in renames:
 
 
255
            print "%s => %s" % (old_name, new_name)        
 
 
258
class cmd_info(Command):
 
 
259
    """Show statistical information for this branch"""
 
 
262
        info.show_info(Branch('.'))        
 
 
265
class cmd_remove(Command):
 
 
266
    """Make a file unversioned.
 
 
268
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
269
    not delete the working copy.
 
 
271
    takes_args = ['file+']
 
 
272
    takes_options = ['verbose']
 
 
274
    def run(self, file_list, verbose=False):
 
 
275
        b = Branch(file_list[0])
 
 
276
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
279
class cmd_file_id(Command):
 
 
280
    """Print file_id of a particular file or directory.
 
 
282
    The file_id is assigned when the file is first added and remains the
 
 
283
    same through all revisions where the file exists, even when it is
 
 
287
    takes_args = ['filename']
 
 
288
    def run(self, filename):
 
 
290
        i = b.inventory.path2id(b.relpath(filename))
 
 
292
            bailout("%r is not a versioned file" % filename)
 
 
297
class cmd_file_path(Command):
 
 
298
    """Print path of file_ids to a file or directory.
 
 
300
    This prints one line for each directory down to the target,
 
 
301
    starting at the branch root."""
 
 
303
    takes_args = ['filename']
 
 
304
    def run(self, filename):
 
 
307
        fid = inv.path2id(b.relpath(filename))
 
 
309
            bailout("%r is not a versioned file" % filename)
 
 
310
        for fip in inv.get_idpath(fid):
 
 
314
class cmd_revision_history(Command):
 
 
315
    """Display list of revision ids on this branch."""
 
 
317
        for patchid in Branch('.').revision_history():
 
 
321
class cmd_directories(Command):
 
 
322
    """Display list of versioned directories in this branch."""
 
 
324
        for name, ie in Branch('.').read_working_inventory().directories():
 
 
331
class cmd_init(Command):
 
 
332
    """Make a directory into a versioned branch.
 
 
334
    Use this to create an empty branch, or before importing an
 
 
337
    Recipe for importing a tree of files:
 
 
342
        bzr commit -m 'imported project'
 
 
345
        Branch('.', init=True)
 
 
348
class cmd_diff(Command):
 
 
349
    """Show differences in working tree.
 
 
351
    If files are listed, only the changes in those files are listed.
 
 
352
    Otherwise, all changes for the tree are listed.
 
 
354
    TODO: Given two revision arguments, show the difference between them.
 
 
356
    TODO: Allow diff across branches.
 
 
358
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
361
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
362
          either fix it up or prefer to use an external diff.
 
 
364
    TODO: If a directory is given, diff everything under that.
 
 
366
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
369
    TODO: This probably handles non-Unix newlines poorly.
 
 
372
    takes_args = ['file*']
 
 
373
    takes_options = ['revision']
 
 
376
    def run(self, revision=None, file_list=None):
 
 
377
        from bzrlib.diff import show_diff
 
 
379
        show_diff(Branch('.'), revision, file_list)
 
 
382
class cmd_deleted(Command):
 
 
383
    """List files deleted in the working tree.
 
 
385
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
387
    def run(self, show_ids=False):
 
 
390
        new = b.working_tree()
 
 
392
        ## TODO: Much more efficient way to do this: read in new
 
 
393
        ## directories with readdir, rather than stating each one.  Same
 
 
394
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
395
        ## if the directories are very large...)
 
 
397
        for path, ie in old.inventory.iter_entries():
 
 
398
            if not new.has_id(ie.file_id):
 
 
400
                    print '%-50s %s' % (path, ie.file_id)
 
 
404
class cmd_root(Command):
 
 
405
    """Show the tree root directory.
 
 
407
    The root is the nearest enclosing directory with a .bzr control
 
 
409
    takes_args = ['filename?']
 
 
410
    def run(self, filename=None):
 
 
411
        """Print the branch root."""
 
 
412
        print bzrlib.branch.find_branch_root(filename)
 
 
416
class cmd_log(Command):
 
 
417
    """Show log of this branch.
 
 
419
    TODO: Option to limit range.
 
 
421
    TODO: Perhaps show most-recent first with an option for last.
 
 
423
    TODO: Option to limit to only a single file or to get log for a
 
 
426
    takes_options = ['timezone', 'verbose', 'show-ids']
 
 
427
    def run(self, timezone='original', verbose=False, show_ids=False):
 
 
428
        b = Branch('.', lock_mode='r')
 
 
430
                        show_timezone=timezone,
 
 
435
class cmd_ls(Command):
 
 
436
    """List files in a tree.
 
 
438
    TODO: Take a revision or remote path and list that tree instead.
 
 
441
    def run(self, revision=None, verbose=False):
 
 
444
            tree = b.working_tree()
 
 
446
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
448
        for fp, fc, kind, fid in tree.list_files():
 
 
450
                if kind == 'directory':
 
 
457
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
463
class cmd_unknowns(Command):
 
 
464
    """List unknown files"""
 
 
466
        for f in Branch('.').unknowns():
 
 
471
class cmd_ignore(Command):
 
 
472
    """Ignore a command or pattern"""
 
 
473
    takes_args = ['name_pattern']
 
 
475
    def run(self, name_pattern):
 
 
478
        # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
 
 
479
        f = open(b.abspath('.bzrignore'), 'at')
 
 
480
        f.write(name_pattern + '\n')
 
 
483
        inv = b.working_tree().inventory
 
 
484
        if inv.path2id('.bzrignore'):
 
 
485
            mutter('.bzrignore is already versioned')
 
 
487
            mutter('need to make new .bzrignore file versioned')
 
 
488
            b.add(['.bzrignore'])
 
 
492
class cmd_ignored(Command):
 
 
493
    """List ignored files and the patterns that matched them."""
 
 
495
        tree = Branch('.').working_tree()
 
 
496
        for path, file_class, kind, file_id in tree.list_files():
 
 
497
            if file_class != 'I':
 
 
499
            ## XXX: Slightly inefficient since this was already calculated
 
 
500
            pat = tree.is_ignored(path)
 
 
501
            print '%-50s %s' % (path, pat)
 
 
504
class cmd_lookup_revision(Command):
 
 
505
    """Lookup the revision-id from a revision-number
 
 
508
        bzr lookup-revision 33
 
 
511
    takes_args = ['revno']
 
 
513
    def run(self, revno):
 
 
517
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
519
        print Branch('.').lookup_revision(revno)
 
 
522
class cmd_export(Command):
 
 
523
    """Export past revision to destination directory.
 
 
525
    If no revision is specified this exports the last committed revision."""
 
 
526
    takes_args = ['dest']
 
 
527
    takes_options = ['revision']
 
 
528
    def run(self, dest, revno=None):
 
 
531
            rh = b.revision_history[-1]
 
 
533
            rh = b.lookup_revision(int(revno))
 
 
534
        t = b.revision_tree(rh)
 
 
538
class cmd_cat(Command):
 
 
539
    """Write a file's text from a previous revision."""
 
 
541
    takes_options = ['revision']
 
 
542
    takes_args = ['filename']
 
 
544
    def run(self, filename, revision=None):
 
 
546
            raise BzrCommandError("bzr cat requires a revision number")
 
 
548
        b.print_file(b.relpath(filename), int(revision))
 
 
551
class cmd_local_time_offset(Command):
 
 
552
    """Show the offset in seconds from GMT to local time."""
 
 
555
        print bzrlib.osutils.local_time_offset()
 
 
559
class cmd_commit(Command):
 
 
560
    """Commit changes into a new revision.
 
 
562
    TODO: Commit only selected files.
 
 
564
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
566
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
568
    takes_options = ['message', 'verbose']
 
 
569
    aliases = ['ci', 'checkin']
 
 
571
    def run(self, message=None, verbose=False):
 
 
573
            raise BzrCommandError("please specify a commit message")
 
 
574
        Branch('.').commit(message, verbose=verbose)
 
 
577
class cmd_check(Command):
 
 
578
    """Validate consistency of branch history.
 
 
580
    This command checks various invariants about the branch storage to
 
 
581
    detect data corruption or bzr bugs.
 
 
583
    takes_args = ['dir?']
 
 
584
    def run(self, dir='.'):
 
 
586
        bzrlib.check.check(Branch(dir, find_root=False))
 
 
590
class cmd_whoami(Command):
 
 
591
    """Show bzr user id."""
 
 
592
    takes_options = ['email']
 
 
594
    def run(self, email=False):
 
 
596
            print bzrlib.osutils.user_email()
 
 
598
            print bzrlib.osutils.username()
 
 
601
class cmd_selftest(Command):
 
 
602
    """Run internal test suite"""
 
 
605
        failures, tests = 0, 0
 
 
607
        import doctest, bzrlib.store, bzrlib.tests
 
 
608
        bzrlib.trace.verbose = False
 
 
610
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
 
611
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
 
612
            mf, mt = doctest.testmod(m)
 
 
615
            print '%-40s %3d tests' % (m.__name__, mt),
 
 
617
                print '%3d FAILED!' % mf
 
 
621
        print '%-40s %3d tests' % ('total', tests),
 
 
623
            print '%3d FAILED!' % failures
 
 
629
class cmd_version(Command):
 
 
630
    """Show version of bzr"""
 
 
635
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
636
    print bzrlib.__copyright__
 
 
637
    print "http://bazaar-ng.org/"
 
 
639
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
640
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
641
    print "General Public License version 2 or later."
 
 
644
class cmd_rocks(Command):
 
 
645
    """Statement of optimism."""
 
 
648
        print "it sure does!"
 
 
651
class cmd_assert_fail(Command):
 
 
652
    """Test reporting of assertion failures"""
 
 
655
        assert False, "always fails"
 
 
658
class cmd_help(Command):
 
 
659
    """Show help on a command or other topic.
 
 
661
    For a list of all available commands, say 'bzr help commands'."""
 
 
662
    takes_args = ['topic?']
 
 
665
    def run(self, topic=None):
 
 
670
######################################################################
 
 
674
# list of all available options; the rhs can be either None for an
 
 
675
# option that takes no argument, or a constructor function that checks
 
 
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?
 
 
722
            # option names must not be unicode
 
 
726
                mutter("  got option %r" % a)
 
 
728
                    optname, optarg = a[2:].split('=', 1)
 
 
731
                if optname not in OPTIONS:
 
 
732
                    bailout('unknown long option %r' % a)
 
 
735
                if shortopt not in SHORT_OPTIONS:
 
 
736
                    bailout('unknown short option %r' % a)
 
 
737
                optname = SHORT_OPTIONS[shortopt]
 
 
740
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
741
                bailout('repeated option %r' % a)
 
 
743
            optargfn = OPTIONS[optname]
 
 
747
                        bailout('option %r needs an argument' % a)
 
 
750
                opts[optname] = optargfn(optarg)
 
 
753
                    bailout('option %r takes no argument' % optname)
 
 
763
def _match_argform(cmd, takes_args, args):
 
 
766
    # step through args and takes_args, allowing appropriate 0-many matches
 
 
767
    for ap in takes_args:
 
 
771
                argdict[argname] = args.pop(0)
 
 
772
        elif ap[-1] == '*': # all remaining arguments
 
 
774
                argdict[argname + '_list'] = args[:]
 
 
777
                argdict[argname + '_list'] = None
 
 
780
                raise BzrCommandError("command %r needs one or more %s"
 
 
781
                        % (cmd, argname.upper()))
 
 
783
                argdict[argname + '_list'] = args[:]
 
 
785
        elif ap[-1] == '$': # all but one
 
 
787
                raise BzrCommandError("command %r needs one or more %s"
 
 
788
                        % (cmd, argname.upper()))
 
 
789
            argdict[argname + '_list'] = args[:-1]
 
 
795
                raise BzrCommandError("command %r requires argument %s"
 
 
796
                        % (cmd, argname.upper()))
 
 
798
                argdict[argname] = args.pop(0)
 
 
801
        raise BzrCommandError("extra argument to command %s: %s"
 
 
809
    """Execute a command.
 
 
811
    This is similar to main(), but without all the trappings for
 
 
812
    logging and error handling.  
 
 
814
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
817
        args, opts = parse_args(argv[1:])
 
 
825
        elif 'version' in opts:
 
 
828
        cmd = str(args.pop(0))
 
 
830
        log_error('usage: bzr COMMAND')
 
 
831
        log_error('  try "bzr help"')
 
 
834
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
 
837
    if 'profile' in opts:
 
 
843
    # check options are reasonable
 
 
844
    allowed = cmd_class.takes_options
 
 
846
        if oname not in allowed:
 
 
847
            raise BzrCommandError("option %r is not allowed for command %r"
 
 
850
    # mix arguments and options into one dictionary
 
 
851
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
 
853
    for k, v in opts.items():
 
 
854
        cmdopts[k.replace('-', '_')] = v
 
 
857
        import hotshot, tempfile
 
 
858
        pffileno, pfname = tempfile.mkstemp()
 
 
860
            prof = hotshot.Profile(pfname)
 
 
861
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
 
865
            stats = hotshot.stats.load(pfname)
 
 
867
            stats.sort_stats('time')
 
 
868
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
869
            ## print_stats seems hardcoded to stdout
 
 
870
            stats.print_stats(20)
 
 
878
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
 
881
def _report_exception(summary, quiet=False):
 
 
883
    log_error('bzr: ' + summary)
 
 
884
    bzrlib.trace.log_exception()
 
 
887
        tb = sys.exc_info()[2]
 
 
888
        exinfo = traceback.extract_tb(tb)
 
 
890
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
 
891
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
 
898
    bzrlib.open_tracefile(argv)
 
 
905
                # do this here inside the exception wrappers to catch EPIPE
 
 
908
            quiet = isinstance(e, (BzrCommandError))
 
 
909
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
 
912
                    # some explanation or hints
 
 
915
        except AssertionError, e:
 
 
916
            msg = 'assertion failed'
 
 
919
            _report_exception(msg)
 
 
921
        except KeyboardInterrupt, e:
 
 
922
            _report_exception('interrupted', quiet=True)
 
 
926
            if isinstance(e, IOError) and e.errno == errno.EPIPE:
 
 
930
                msg = str(e).rstrip('\n')
 
 
931
            _report_exception(msg, quiet)
 
 
934
        bzrlib.trace.close_trace()
 
 
937
if __name__ == '__main__':
 
 
938
    sys.exit(main(sys.argv))