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
 
 
22
from bzrlib.trace import mutter, note, log_error
 
 
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
 
24
from bzrlib.osutils import quotefn
 
 
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
 
 
29
def _squish_command_name(cmd):
 
 
30
    return 'cmd_' + cmd.replace('-', '_')
 
 
33
def _unsquish_command_name(cmd):
 
 
34
    assert cmd.startswith("cmd_")
 
 
35
    return cmd[4:].replace('_','-')
 
 
37
def _parse_revision_str(revstr):
 
 
38
    """This handles a revision string -> revno. 
 
 
40
    There are several possibilities:
 
 
43
        '234:345'   -> [234, 345]
 
 
47
    In the future we will also support:
 
 
48
        'uuid:blah-blah-blah'   -> ?
 
 
49
        'hash:blahblahblah'     -> ?
 
 
53
    if revstr.find(':') != -1:
 
 
54
        revs = revstr.split(':')
 
 
56
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
 
 
61
            revs[0] = int(revs[0])
 
 
66
            revs[1] = int(revs[1])
 
 
72
    """Return canonical name and class for all registered commands."""
 
 
73
    for k, v in globals().iteritems():
 
 
74
        if k.startswith("cmd_"):
 
 
75
            yield _unsquish_command_name(k), v
 
 
77
def get_cmd_class(cmd):
 
 
78
    """Return the canonical name and command class for a command.
 
 
80
    cmd = str(cmd)                      # not unicode
 
 
82
    # first look up this command under the specified name
 
 
84
        return cmd, globals()[_squish_command_name(cmd)]
 
 
88
    # look for any command which claims this as an alias
 
 
89
    for cmdname, cmdclass in get_all_cmds():
 
 
90
        if cmd in cmdclass.aliases:
 
 
91
            return cmdname, cmdclass
 
 
93
    cmdclass = ExternalCommand.find_command(cmd)
 
 
97
    raise BzrCommandError("unknown command %r" % cmd)
 
 
100
class Command(object):
 
 
101
    """Base class for commands.
 
 
103
    The docstring for an actual command should give a single-line
 
 
104
    summary, then a complete description of the command.  A grammar
 
 
105
    description will be inserted.
 
 
108
        List of argument forms, marked with whether they are optional,
 
 
112
        List of options that may be given for this command.
 
 
115
        If true, this command isn't advertised.
 
 
124
    def __init__(self, options, arguments):
 
 
125
        """Construct and run the command.
 
 
127
        Sets self.status to the return value of run()."""
 
 
128
        assert isinstance(options, dict)
 
 
129
        assert isinstance(arguments, dict)
 
 
130
        cmdargs = options.copy()
 
 
131
        cmdargs.update(arguments)
 
 
132
        assert self.__doc__ != Command.__doc__, \
 
 
133
               ("No help message set for %r" % self)
 
 
134
        self.status = self.run(**cmdargs)
 
 
138
        """Override this in sub-classes.
 
 
140
        This is invoked with the options and arguments bound to
 
 
143
        Return 0 or None if the command was successful, or a shell
 
 
149
class ExternalCommand(Command):
 
 
150
    """Class to wrap external commands.
 
 
152
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
 
153
    an object we construct that has the appropriate path, help, options etc for the
 
 
156
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
 
157
    method, which we override to call the Command.__init__ method. That then calls
 
 
158
    our run method which is pretty straight forward.
 
 
160
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
 
161
    back into command line options and arguments for the script.
 
 
164
    def find_command(cls, cmd):
 
 
166
        bzrpath = os.environ.get('BZRPATH', '')
 
 
168
        for dir in bzrpath.split(':'):
 
 
169
            path = os.path.join(dir, cmd)
 
 
170
            if os.path.isfile(path):
 
 
171
                return ExternalCommand(path)
 
 
175
    find_command = classmethod(find_command)
 
 
177
    def __init__(self, path):
 
 
180
        # TODO: If either of these fail, we should detect that and
 
 
181
        # assume that path is not really a bzr plugin after all.
 
 
183
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
 
184
        self.takes_options = pipe.readline().split()
 
 
185
        self.takes_args = pipe.readline().split()
 
 
188
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
 
189
        self.__doc__ = pipe.read()
 
 
192
    def __call__(self, options, arguments):
 
 
193
        Command.__init__(self, options, arguments)
 
 
196
    def run(self, **kargs):
 
 
204
            if OPTIONS.has_key(name):
 
 
206
                opts.append('--%s' % name)
 
 
207
                if value is not None and value is not True:
 
 
208
                    opts.append(str(value))
 
 
210
                # it's an arg, or arg list
 
 
211
                if type(value) is not list:
 
 
217
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
 
221
class cmd_status(Command):
 
 
222
    """Display status summary.
 
 
224
    This reports on versioned and unknown files, reporting them
 
 
225
    grouped by state.  Possible states are:
 
 
228
        Versioned in the working copy but not in the previous revision.
 
 
231
        Versioned in the previous revision but removed or deleted
 
 
235
        Path of this file changed from the previous revision;
 
 
236
        the text may also have changed.  This includes files whose
 
 
237
        parent directory was renamed.
 
 
240
        Text has changed since the previous revision.
 
 
243
        Nothing about this file has changed since the previous revision.
 
 
244
        Only shown with --all.
 
 
247
        Not versioned and not matching an ignore pattern.
 
 
249
    To see ignored files use 'bzr ignored'.  For details in the
 
 
250
    changes to file texts, use 'bzr diff'.
 
 
252
    If no arguments are specified, the status of the entire working
 
 
253
    directory is shown.  Otherwise, only the status of the specified
 
 
254
    files or directories is reported.  If a directory is given, status
 
 
255
    is reported for everything inside that directory.
 
 
257
    takes_args = ['file*']
 
 
258
    takes_options = ['all', 'show-ids']
 
 
259
    aliases = ['st', 'stat']
 
 
261
    def run(self, all=False, show_ids=False, file_list=None):
 
 
263
            b = Branch(file_list[0])
 
 
264
            file_list = [b.relpath(x) for x in file_list]
 
 
265
            # special case: only one path was given and it's the root
 
 
267
            if file_list == ['']:
 
 
272
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
273
                           specific_files=file_list)
 
 
276
class cmd_cat_revision(Command):
 
 
277
    """Write out metadata for a revision."""
 
 
280
    takes_args = ['revision_id']
 
 
282
    def run(self, revision_id):
 
 
283
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
 
286
class cmd_revno(Command):
 
 
287
    """Show current revision number.
 
 
289
    This is equal to the number of revisions on this branch."""
 
 
291
        print Branch('.').revno()
 
 
294
class cmd_add(Command):
 
 
295
    """Add specified files or directories.
 
 
297
    In non-recursive mode, all the named items are added, regardless
 
 
298
    of whether they were previously ignored.  A warning is given if
 
 
299
    any of the named files are already versioned.
 
 
301
    In recursive mode (the default), files are treated the same way
 
 
302
    but the behaviour for directories is different.  Directories that
 
 
303
    are already versioned do not give a warning.  All directories,
 
 
304
    whether already versioned or not, are searched for files or
 
 
305
    subdirectories that are neither versioned or ignored, and these
 
 
306
    are added.  This search proceeds recursively into versioned
 
 
309
    Therefore simply saying 'bzr add .' will version all files that
 
 
310
    are currently unknown.
 
 
312
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
313
    recursively add that parent, rather than giving an error?
 
 
315
    takes_args = ['file+']
 
 
316
    takes_options = ['verbose', 'no-recurse']
 
 
318
    def run(self, file_list, verbose=False, no_recurse=False):
 
 
319
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
 
 
322
class cmd_relpath(Command):
 
 
323
    """Show path of a file relative to root"""
 
 
324
    takes_args = ['filename']
 
 
327
    def run(self, filename):
 
 
328
        print Branch(filename).relpath(filename)
 
 
332
class cmd_inventory(Command):
 
 
333
    """Show inventory of the current working copy or a revision."""
 
 
334
    takes_options = ['revision', 'show-ids']
 
 
336
    def run(self, revision=None, show_ids=False):
 
 
339
            inv = b.read_working_inventory()
 
 
341
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
 
343
        for path, entry in inv.entries():
 
 
345
                print '%-50s %s' % (path, entry.file_id)
 
 
350
class cmd_move(Command):
 
 
351
    """Move files to a different directory.
 
 
356
    The destination must be a versioned directory in the same branch.
 
 
358
    takes_args = ['source$', 'dest']
 
 
359
    def run(self, source_list, dest):
 
 
362
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
365
class cmd_rename(Command):
 
 
366
    """Change the name of an entry.
 
 
369
      bzr rename frob.c frobber.c
 
 
370
      bzr rename src/frob.c lib/frob.c
 
 
372
    It is an error if the destination name exists.
 
 
374
    See also the 'move' command, which moves files into a different
 
 
375
    directory without changing their name.
 
 
377
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
379
    takes_args = ['from_name', 'to_name']
 
 
381
    def run(self, from_name, to_name):
 
 
383
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
387
class cmd_renames(Command):
 
 
388
    """Show list of renamed files.
 
 
390
    TODO: Option to show renames between two historical versions.
 
 
392
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
394
    takes_args = ['dir?']
 
 
396
    def run(self, dir='.'):
 
 
398
        old_inv = b.basis_tree().inventory
 
 
399
        new_inv = b.read_working_inventory()
 
 
401
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
403
        for old_name, new_name in renames:
 
 
404
            print "%s => %s" % (old_name, new_name)        
 
 
407
class cmd_info(Command):
 
 
408
    """Show statistical information about a branch."""
 
 
409
    takes_args = ['branch?']
 
 
411
    def run(self, branch=None):
 
 
414
        from branch import find_branch
 
 
415
        b = find_branch(branch)
 
 
419
class cmd_remove(Command):
 
 
420
    """Make a file unversioned.
 
 
422
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
423
    not delete the working copy.
 
 
425
    takes_args = ['file+']
 
 
426
    takes_options = ['verbose']
 
 
428
    def run(self, file_list, verbose=False):
 
 
429
        b = Branch(file_list[0])
 
 
430
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
433
class cmd_file_id(Command):
 
 
434
    """Print file_id of a particular file or directory.
 
 
436
    The file_id is assigned when the file is first added and remains the
 
 
437
    same through all revisions where the file exists, even when it is
 
 
441
    takes_args = ['filename']
 
 
442
    def run(self, filename):
 
 
444
        i = b.inventory.path2id(b.relpath(filename))
 
 
446
            bailout("%r is not a versioned file" % filename)
 
 
451
class cmd_file_path(Command):
 
 
452
    """Print path of file_ids to a file or directory.
 
 
454
    This prints one line for each directory down to the target,
 
 
455
    starting at the branch root."""
 
 
457
    takes_args = ['filename']
 
 
458
    def run(self, filename):
 
 
461
        fid = inv.path2id(b.relpath(filename))
 
 
463
            bailout("%r is not a versioned file" % filename)
 
 
464
        for fip in inv.get_idpath(fid):
 
 
468
class cmd_revision_history(Command):
 
 
469
    """Display list of revision ids on this branch."""
 
 
472
        for patchid in Branch('.').revision_history():
 
 
476
class cmd_directories(Command):
 
 
477
    """Display list of versioned directories in this branch."""
 
 
479
        for name, ie in Branch('.').read_working_inventory().directories():
 
 
486
class cmd_init(Command):
 
 
487
    """Make a directory into a versioned branch.
 
 
489
    Use this to create an empty branch, or before importing an
 
 
492
    Recipe for importing a tree of files:
 
 
497
        bzr commit -m 'imported project'
 
 
500
        Branch('.', init=True)
 
 
503
class cmd_diff(Command):
 
 
504
    """Show differences in working tree.
 
 
506
    If files are listed, only the changes in those files are listed.
 
 
507
    Otherwise, all changes for the tree are listed.
 
 
509
    TODO: Given two revision arguments, show the difference between them.
 
 
511
    TODO: Allow diff across branches.
 
 
513
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
516
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
517
          either fix it up or prefer to use an external diff.
 
 
519
    TODO: If a directory is given, diff everything under that.
 
 
521
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
524
    TODO: This probably handles non-Unix newlines poorly.
 
 
527
    takes_args = ['file*']
 
 
528
    takes_options = ['revision', 'diff-options']
 
 
531
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
532
        from bzrlib.diff import show_diff
 
 
533
        from bzrlib import find_branch
 
 
536
            b = find_branch(file_list[0])
 
 
537
            file_list = [b.relpath(f) for f in file_list]
 
 
538
            if file_list == ['']:
 
 
539
                # just pointing to top-of-tree
 
 
544
        show_diff(b, revision, specific_files=file_list,
 
 
545
                  external_diff_options=diff_options)
 
 
551
class cmd_deleted(Command):
 
 
552
    """List files deleted in the working tree.
 
 
554
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
556
    def run(self, show_ids=False):
 
 
559
        new = b.working_tree()
 
 
561
        ## TODO: Much more efficient way to do this: read in new
 
 
562
        ## directories with readdir, rather than stating each one.  Same
 
 
563
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
564
        ## if the directories are very large...)
 
 
566
        for path, ie in old.inventory.iter_entries():
 
 
567
            if not new.has_id(ie.file_id):
 
 
569
                    print '%-50s %s' % (path, ie.file_id)
 
 
574
class cmd_modified(Command):
 
 
575
    """List files modified in working tree."""
 
 
580
        inv = b.read_working_inventory()
 
 
581
        sc = statcache.update_cache(b, inv)
 
 
582
        basis = b.basis_tree()
 
 
583
        basis_inv = basis.inventory
 
 
585
        # We used to do this through iter_entries(), but that's slow
 
 
586
        # when most of the files are unmodified, as is usually the
 
 
587
        # case.  So instead we iterate by inventory entry, and only
 
 
588
        # calculate paths as necessary.
 
 
590
        for file_id in basis_inv:
 
 
591
            cacheentry = sc.get(file_id)
 
 
592
            if not cacheentry:                 # deleted
 
 
594
            ie = basis_inv[file_id]
 
 
595
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
 
596
                path = inv.id2path(file_id)
 
 
601
class cmd_added(Command):
 
 
602
    """List files added in working tree."""
 
 
606
        wt = b.working_tree()
 
 
607
        basis_inv = b.basis_tree().inventory
 
 
610
            if file_id in basis_inv:
 
 
612
            path = inv.id2path(file_id)
 
 
613
            if not os.access(b.abspath(path), os.F_OK):
 
 
619
class cmd_root(Command):
 
 
620
    """Show the tree root directory.
 
 
622
    The root is the nearest enclosing directory with a .bzr control
 
 
624
    takes_args = ['filename?']
 
 
625
    def run(self, filename=None):
 
 
626
        """Print the branch root."""
 
 
627
        from branch import find_branch
 
 
628
        b = find_branch(filename)
 
 
629
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
 
632
class cmd_log(Command):
 
 
633
    """Show log of this branch.
 
 
635
    To request a range of logs, you can use the command -r begin:end
 
 
636
    -r revision requests a specific revision, -r :end or -r begin: are
 
 
639
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
643
    takes_args = ['filename?']
 
 
644
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
 
 
646
    def run(self, filename=None, timezone='original',
 
 
651
        from bzrlib import show_log, find_branch
 
 
654
        direction = (forward and 'forward') or 'reverse'
 
 
657
            b = find_branch(filename)
 
 
658
            fp = b.relpath(filename)
 
 
660
                file_id = b.read_working_inventory().path2id(fp)
 
 
662
                file_id = None  # points to branch root
 
 
668
            revision = [None, None]
 
 
669
        elif isinstance(revision, int):
 
 
670
            revision = [revision, revision]
 
 
675
        assert len(revision) == 2
 
 
677
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
 
678
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
 
 
681
                 show_timezone=timezone,
 
 
686
                 start_revision=revision[0],
 
 
687
                 end_revision=revision[1])
 
 
691
class cmd_touching_revisions(Command):
 
 
692
    """Return revision-ids which affected a particular file.
 
 
694
    A more user-friendly interface is "bzr log FILE"."""
 
 
696
    takes_args = ["filename"]
 
 
697
    def run(self, filename):
 
 
699
        inv = b.read_working_inventory()
 
 
700
        file_id = inv.path2id(b.relpath(filename))
 
 
701
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
702
            print "%6d %s" % (revno, what)
 
 
705
class cmd_ls(Command):
 
 
706
    """List files in a tree.
 
 
708
    TODO: Take a revision or remote path and list that tree instead.
 
 
711
    def run(self, revision=None, verbose=False):
 
 
714
            tree = b.working_tree()
 
 
716
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
718
        for fp, fc, kind, fid in tree.list_files():
 
 
720
                if kind == 'directory':
 
 
727
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
733
class cmd_unknowns(Command):
 
 
734
    """List unknown files"""
 
 
736
        for f in Branch('.').unknowns():
 
 
741
class cmd_ignore(Command):
 
 
742
    """Ignore a command or pattern
 
 
744
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
746
    If the pattern contains a slash, it is compared to the whole path
 
 
747
    from the branch root.  Otherwise, it is comapred to only the last
 
 
748
    component of the path.
 
 
750
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
752
    Note: wildcards must be quoted from the shell on Unix.
 
 
755
        bzr ignore ./Makefile
 
 
758
    takes_args = ['name_pattern']
 
 
760
    def run(self, name_pattern):
 
 
761
        from bzrlib.atomicfile import AtomicFile
 
 
765
        ifn = b.abspath('.bzrignore')
 
 
767
        if os.path.exists(ifn):
 
 
770
                igns = f.read().decode('utf-8')
 
 
776
        # TODO: If the file already uses crlf-style termination, maybe
 
 
777
        # we should use that for the newly added lines?
 
 
779
        if igns and igns[-1] != '\n':
 
 
781
        igns += name_pattern + '\n'
 
 
784
            f = AtomicFile(ifn, 'wt')
 
 
785
            f.write(igns.encode('utf-8'))
 
 
790
        inv = b.working_tree().inventory
 
 
791
        if inv.path2id('.bzrignore'):
 
 
792
            mutter('.bzrignore is already versioned')
 
 
794
            mutter('need to make new .bzrignore file versioned')
 
 
795
            b.add(['.bzrignore'])
 
 
799
class cmd_ignored(Command):
 
 
800
    """List ignored files and the patterns that matched them.
 
 
802
    See also: bzr ignore"""
 
 
804
        tree = Branch('.').working_tree()
 
 
805
        for path, file_class, kind, file_id in tree.list_files():
 
 
806
            if file_class != 'I':
 
 
808
            ## XXX: Slightly inefficient since this was already calculated
 
 
809
            pat = tree.is_ignored(path)
 
 
810
            print '%-50s %s' % (path, pat)
 
 
813
class cmd_lookup_revision(Command):
 
 
814
    """Lookup the revision-id from a revision-number
 
 
817
        bzr lookup-revision 33
 
 
820
    takes_args = ['revno']
 
 
822
    def run(self, revno):
 
 
826
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
828
        print Branch('.').lookup_revision(revno)
 
 
831
class cmd_export(Command):
 
 
832
    """Export past revision to destination directory.
 
 
834
    If no revision is specified this exports the last committed revision."""
 
 
835
    takes_args = ['dest']
 
 
836
    takes_options = ['revision']
 
 
837
    def run(self, dest, revision=None):
 
 
840
            rh = b.revision_history()[-1]
 
 
842
            rh = b.lookup_revision(int(revision))
 
 
843
        t = b.revision_tree(rh)
 
 
847
class cmd_cat(Command):
 
 
848
    """Write a file's text from a previous revision."""
 
 
850
    takes_options = ['revision']
 
 
851
    takes_args = ['filename']
 
 
853
    def run(self, filename, revision=None):
 
 
855
            raise BzrCommandError("bzr cat requires a revision number")
 
 
857
        b.print_file(b.relpath(filename), int(revision))
 
 
860
class cmd_local_time_offset(Command):
 
 
861
    """Show the offset in seconds from GMT to local time."""
 
 
864
        print bzrlib.osutils.local_time_offset()
 
 
868
class cmd_commit(Command):
 
 
869
    """Commit changes into a new revision.
 
 
871
    If selected files are specified, only changes to those files are
 
 
872
    committed.  If a directory is specified then its contents are also
 
 
875
    A selected-file commit may fail in some cases where the committed
 
 
876
    tree would be invalid, such as trying to commit a file in a
 
 
877
    newly-added directory that is not itself committed.
 
 
879
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
881
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
883
    takes_args = ['selected*']
 
 
884
    takes_options = ['message', 'file', 'verbose']
 
 
885
    aliases = ['ci', 'checkin']
 
 
887
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
 
888
        from bzrlib.commit import commit
 
 
890
        ## Warning: shadows builtin file()
 
 
891
        if not message and not file:
 
 
892
            raise BzrCommandError("please specify a commit message",
 
 
893
                                  ["use either --message or --file"])
 
 
894
        elif message and file:
 
 
895
            raise BzrCommandError("please specify either --message or --file")
 
 
899
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
902
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
 
905
class cmd_check(Command):
 
 
906
    """Validate consistency of branch history.
 
 
908
    This command checks various invariants about the branch storage to
 
 
909
    detect data corruption or bzr bugs.
 
 
911
    takes_args = ['dir?']
 
 
912
    def run(self, dir='.'):
 
 
914
        bzrlib.check.check(Branch(dir))
 
 
918
class cmd_whoami(Command):
 
 
919
    """Show bzr user id."""
 
 
920
    takes_options = ['email']
 
 
922
    def run(self, email=False):
 
 
924
            print bzrlib.osutils.user_email()
 
 
926
            print bzrlib.osutils.username()
 
 
929
class cmd_selftest(Command):
 
 
930
    """Run internal test suite"""
 
 
933
        failures, tests = 0, 0
 
 
935
        import doctest, bzrlib.store
 
 
936
        bzrlib.trace.verbose = False
 
 
938
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
 
939
            bzrlib.tree, bzrlib.commands, bzrlib.add:
 
 
940
            mf, mt = doctest.testmod(m)
 
 
943
            print '%-40s %3d tests' % (m.__name__, mt),
 
 
945
                print '%3d FAILED!' % mf
 
 
949
        print '%-40s %3d tests' % ('total', tests),
 
 
951
            print '%3d FAILED!' % failures
 
 
959
class cmd_version(Command):
 
 
960
    """Show version of bzr"""
 
 
965
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
966
    print bzrlib.__copyright__
 
 
967
    print "http://bazaar-ng.org/"
 
 
969
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
970
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
971
    print "General Public License version 2 or later."
 
 
974
class cmd_rocks(Command):
 
 
975
    """Statement of optimism."""
 
 
978
        print "it sure does!"
 
 
980
def parse_spec(spec):
 
 
982
        parsed = spec.split('/@')
 
 
983
        assert len(parsed) == 2
 
 
987
            parsed[1] = int(parsed[1])
 
 
990
        parsed = [spec, None]
 
 
993
class cmd_merge(Command):
 
 
994
    """Perform a three-way merge of trees."""
 
 
995
    takes_args = ['other_spec', 'base_spec']
 
 
997
    def run(self, other_spec, base_spec):
 
 
998
        from bzrlib.merge import merge
 
 
999
        merge(parse_spec(other_spec), parse_spec(base_spec))
 
 
1001
class cmd_assert_fail(Command):
 
 
1002
    """Test reporting of assertion failures"""
 
 
1005
        assert False, "always fails"
 
 
1008
class cmd_help(Command):
 
 
1009
    """Show help on a command or other topic.
 
 
1011
    For a list of all available commands, say 'bzr help commands'."""
 
 
1012
    takes_args = ['topic?']
 
 
1015
    def run(self, topic=None):
 
 
1020
class cmd_update_stat_cache(Command):
 
 
1021
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
 
1023
    For testing only."""
 
 
1028
        statcache.update_cache(b.base, b.read_working_inventory())
 
 
1032
# list of all available options; the rhs can be either None for an
 
 
1033
# option that takes no argument, or a constructor function that checks
 
 
1037
    'diff-options':           str,
 
 
1044
    'revision':               _parse_revision_str,
 
 
1061
def parse_args(argv):
 
 
1062
    """Parse command line.
 
 
1064
    Arguments and options are parsed at this level before being passed
 
 
1065
    down to specific command handlers.  This routine knows, from a
 
 
1066
    lookup table, something about the available options, what optargs
 
 
1067
    they take, and which commands will accept them.
 
 
1069
    >>> parse_args('--help'.split())
 
 
1070
    ([], {'help': True})
 
 
1071
    >>> parse_args('--version'.split())
 
 
1072
    ([], {'version': True})
 
 
1073
    >>> parse_args('status --all'.split())
 
 
1074
    (['status'], {'all': True})
 
 
1075
    >>> parse_args('commit --message=biter'.split())
 
 
1076
    (['commit'], {'message': u'biter'})
 
 
1081
    # TODO: Maybe handle '--' to end options?
 
 
1086
            # option names must not be unicode
 
 
1090
                mutter("  got option %r" % a)
 
 
1092
                    optname, optarg = a[2:].split('=', 1)
 
 
1095
                if optname not in OPTIONS:
 
 
1096
                    bailout('unknown long option %r' % a)
 
 
1099
                if shortopt not in SHORT_OPTIONS:
 
 
1100
                    bailout('unknown short option %r' % a)
 
 
1101
                optname = SHORT_OPTIONS[shortopt]
 
 
1104
                # XXX: Do we ever want to support this, e.g. for -r?
 
 
1105
                bailout('repeated option %r' % a)
 
 
1107
            optargfn = OPTIONS[optname]
 
 
1111
                        bailout('option %r needs an argument' % a)
 
 
1113
                        optarg = argv.pop(0)
 
 
1114
                opts[optname] = optargfn(optarg)
 
 
1117
                    bailout('option %r takes no argument' % optname)
 
 
1118
                opts[optname] = True
 
 
1127
def _match_argform(cmd, takes_args, args):
 
 
1130
    # step through args and takes_args, allowing appropriate 0-many matches
 
 
1131
    for ap in takes_args:
 
 
1135
                argdict[argname] = args.pop(0)
 
 
1136
        elif ap[-1] == '*': # all remaining arguments
 
 
1138
                argdict[argname + '_list'] = args[:]
 
 
1141
                argdict[argname + '_list'] = None
 
 
1144
                raise BzrCommandError("command %r needs one or more %s"
 
 
1145
                        % (cmd, argname.upper()))
 
 
1147
                argdict[argname + '_list'] = args[:]
 
 
1149
        elif ap[-1] == '$': # all but one
 
 
1151
                raise BzrCommandError("command %r needs one or more %s"
 
 
1152
                        % (cmd, argname.upper()))
 
 
1153
            argdict[argname + '_list'] = args[:-1]
 
 
1159
                raise BzrCommandError("command %r requires argument %s"
 
 
1160
                        % (cmd, argname.upper()))
 
 
1162
                argdict[argname] = args.pop(0)
 
 
1165
        raise BzrCommandError("extra argument to command %s: %s"
 
 
1173
    """Execute a command.
 
 
1175
    This is similar to main(), but without all the trappings for
 
 
1176
    logging and error handling.  
 
 
1178
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
 
1181
        args, opts = parse_args(argv[1:])
 
 
1189
        elif 'version' in opts:
 
 
1192
        cmd = str(args.pop(0))
 
 
1199
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
 
1202
    if 'profile' in opts:
 
 
1208
    # check options are reasonable
 
 
1209
    allowed = cmd_class.takes_options
 
 
1211
        if oname not in allowed:
 
 
1212
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
 
1215
    # mix arguments and options into one dictionary
 
 
1216
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
 
1218
    for k, v in opts.items():
 
 
1219
        cmdopts[k.replace('-', '_')] = v
 
 
1222
        import hotshot, tempfile
 
 
1223
        pffileno, pfname = tempfile.mkstemp()
 
 
1225
            prof = hotshot.Profile(pfname)
 
 
1226
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
 
1229
            import hotshot.stats
 
 
1230
            stats = hotshot.stats.load(pfname)
 
 
1232
            stats.sort_stats('time')
 
 
1233
            ## XXX: Might like to write to stderr or the trace file instead but
 
 
1234
            ## print_stats seems hardcoded to stdout
 
 
1235
            stats.print_stats(20)
 
 
1243
        return cmd_class(cmdopts, cmdargs).status 
 
 
1246
def _report_exception(summary, quiet=False):
 
 
1248
    log_error('bzr: ' + summary)
 
 
1249
    bzrlib.trace.log_exception()
 
 
1252
        tb = sys.exc_info()[2]
 
 
1253
        exinfo = traceback.extract_tb(tb)
 
 
1255
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
 
1256
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
 
1263
    bzrlib.open_tracefile(argv)
 
 
1268
                return run_bzr(argv)
 
 
1270
                # do this here inside the exception wrappers to catch EPIPE
 
 
1273
            quiet = isinstance(e, (BzrCommandError))
 
 
1274
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
 
1277
                    # some explanation or hints
 
 
1280
        except AssertionError, e:
 
 
1281
            msg = 'assertion failed'
 
 
1283
                msg += ': ' + str(e)
 
 
1284
            _report_exception(msg)
 
 
1286
        except KeyboardInterrupt, e:
 
 
1287
            _report_exception('interrupted', quiet=True)
 
 
1289
        except Exception, e:
 
 
1291
            if (isinstance(e, IOError) 
 
 
1292
                and hasattr(e, 'errno')
 
 
1293
                and e.errno == errno.EPIPE):
 
 
1297
                msg = str(e).rstrip('\n')
 
 
1298
            _report_exception(msg, quiet)
 
 
1301
        bzrlib.trace.close_trace()
 
 
1304
if __name__ == '__main__':
 
 
1305
    sys.exit(main(sys.argv))