~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2004, 2005 by Canonical Ltd

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import sys, os

import bzrlib

from bzrlib.trace import mutter, note, log_error

from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError

from bzrlib.osutils import quotefn

from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \

     format_date

def _squish_command_name(cmd):

    return 'cmd_' + cmd.replace('-', '_')

def _unsquish_command_name(cmd):

    assert cmd.startswith("cmd_")

    return cmd[4:].replace('_','-')

def _parse_revision_str(revstr):

    """This handles a revision string -> revno. 

    There are several possibilities:

        '234'       -> 234

        '234:345'   -> [234, 345]

        ':234'      -> [None, 234]

        '234:'      -> [234, None]

    In the future we will also support:

        'uuid:blah-blah-blah'   -> ?

        'hash:blahblahblah'     -> ?

        potentially:

        'tag:mytag'             -> ?

    """

    if revstr.find(':') != -1:

        revs = revstr.split(':')

        if len(revs) > 2:

            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)

        if not revs[0]:

            revs[0] = None

        else:

            revs[0] = int(revs[0])

        if not revs[1]:

            revs[1] = None

        else:

            revs[1] = int(revs[1])

    else:

        revs = int(revstr)

    return revs

def get_all_cmds():

    """Return canonical name and class for all registered commands."""

    for k, v in globals().iteritems():

        if k.startswith("cmd_"):

            yield _unsquish_command_name(k), v

def get_cmd_class(cmd):

    """Return the canonical name and command class for a command.

    """

    cmd = str(cmd)                      # not unicode

    # first look up this command under the specified name

    try:

        return cmd, globals()[_squish_command_name(cmd)]

    except KeyError:

        pass

    # look for any command which claims this as an alias

    for cmdname, cmdclass in get_all_cmds():

        if cmd in cmdclass.aliases:

            return cmdname, cmdclass

    cmdclass = ExternalCommand.find_command(cmd)

    if cmdclass:

        return cmd, cmdclass

    raise BzrCommandError("unknown command %r" % cmd)

class Command(object):

    """Base class for commands.

    The docstring for an actual command should give a single-line

    summary, then a complete description of the command.  A grammar

    description will be inserted.

    takes_args

        List of argument forms, marked with whether they are optional,

        repeated, etc.

    takes_options

        List of options that may be given for this command.

    hidden

        If true, this command isn't advertised.

    """

    aliases = []

    takes_args = []

    takes_options = []

    hidden = False

    def __init__(self, options, arguments):

        """Construct and run the command.

        Sets self.status to the return value of run()."""

        assert isinstance(options, dict)

        assert isinstance(arguments, dict)

        cmdargs = options.copy()

        cmdargs.update(arguments)

        assert self.__doc__ != Command.__doc__, \

               ("No help message set for %r" % self)

        self.status = self.run(**cmdargs)

    def run(self):

        """Override this in sub-classes.

        This is invoked with the options and arguments bound to

        keyword parameters.

        Return 0 or None if the command was successful, or a shell

        error code if not.

        """

        return 0

class ExternalCommand(Command):

    """Class to wrap external commands.

    We cheat a little here, when get_cmd_class() calls us we actually give it back

    an object we construct that has the appropriate path, help, options etc for the

    specified command.

    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__

    method, which we override to call the Command.__init__ method. That then calls

    our run method which is pretty straight forward.

    The only wrinkle is that we have to map bzr's dictionary of options and arguments

    back into command line options and arguments for the script.

    """

    def find_command(cls, cmd):

        import os.path

        bzrpath = os.environ.get('BZRPATH', '')

        for dir in bzrpath.split(':'):

            path = os.path.join(dir, cmd)

            if os.path.isfile(path):

                return ExternalCommand(path)

        return None

    find_command = classmethod(find_command)

    def __init__(self, path):

        self.path = path

        # TODO: If either of these fail, we should detect that and

        # assume that path is not really a bzr plugin after all.

        pipe = os.popen('%s --bzr-usage' % path, 'r')

        self.takes_options = pipe.readline().split()

        self.takes_args = pipe.readline().split()

        pipe.close()

        pipe = os.popen('%s --bzr-help' % path, 'r')

        self.__doc__ = pipe.read()

        pipe.close()

    def __call__(self, options, arguments):

        Command.__init__(self, options, arguments)

        return self

    def run(self, **kargs):

        opts = []

        args = []

        keys = kargs.keys()

        keys.sort()

        for name in keys:

            value = kargs[name]

            if OPTIONS.has_key(name):

                # it's an option

                opts.append('--%s' % name)

                if value is not None and value is not True:

                    opts.append(str(value))

            else:

                # it's an arg, or arg list

                if type(value) is not list:

                    value = [value]

                for v in value:

                    if v is not None:

                        args.append(str(v))

        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)

        return self.status

class cmd_status(Command):

    """Display status summary.

    This reports on versioned and unknown files, reporting them

    grouped by state.  Possible states are:

    added

        Versioned in the working copy but not in the previous revision.

    removed

        Versioned in the previous revision but removed or deleted

        in the working copy.

    renamed

        Path of this file changed from the previous revision;

        the text may also have changed.  This includes files whose

        parent directory was renamed.

    modified

        Text has changed since the previous revision.

    unchanged

        Nothing about this file has changed since the previous revision.

        Only shown with --all.

    unknown

        Not versioned and not matching an ignore pattern.

    To see ignored files use 'bzr ignored'.  For details in the

    changes to file texts, use 'bzr diff'.

    If no arguments are specified, the status of the entire working

    directory is shown.  Otherwise, only the status of the specified

    files or directories is reported.  If a directory is given, status

    is reported for everything inside that directory.

    """

    takes_args = ['file*']

    takes_options = ['all', 'show-ids']

    aliases = ['st', 'stat']

    def run(self, all=False, show_ids=False, file_list=None):

        if file_list:

            b = Branch(file_list[0])

            file_list = [b.relpath(x) for x in file_list]

            # special case: only one path was given and it's the root

            # of the branch

            if file_list == ['']:

                file_list = None

        else:

            b = Branch('.')

        import status

        status.show_status(b, show_unchanged=all, show_ids=show_ids,

                           specific_files=file_list)

class cmd_cat_revision(Command):

    """Write out metadata for a revision."""

    hidden = True

    takes_args = ['revision_id']

    def run(self, revision_id):

        Branch('.').get_revision(revision_id).write_xml(sys.stdout)

class cmd_revno(Command):

    """Show current revision number.

    This is equal to the number of revisions on this branch."""

    def run(self):

        print Branch('.').revno()

class cmd_add(Command):

    """Add specified files or directories.

    In non-recursive mode, all the named items are added, regardless

    of whether they were previously ignored.  A warning is given if

    any of the named files are already versioned.

    In recursive mode (the default), files are treated the same way

    but the behaviour for directories is different.  Directories that

    are already versioned do not give a warning.  All directories,

    whether already versioned or not, are searched for files or

    subdirectories that are neither versioned or ignored, and these

    are added.  This search proceeds recursively into versioned

    directories.

    Therefore simply saying 'bzr add .' will version all files that

    are currently unknown.

    TODO: Perhaps adding a file whose directly is not versioned should

    recursively add that parent, rather than giving an error?

    """

    takes_args = ['file+']

    takes_options = ['verbose', 'no-recurse']

    def run(self, file_list, verbose=False, no_recurse=False):

        bzrlib.add.smart_add(file_list, verbose, not no_recurse)

class cmd_relpath(Command):

    """Show path of a file relative to root"""

    takes_args = ['filename']

    hidden = True

    def run(self, filename):

        print Branch(filename).relpath(filename)

class cmd_inventory(Command):

    """Show inventory of the current working copy or a revision."""

    takes_options = ['revision', 'show-ids']

    def run(self, revision=None, show_ids=False):

        b = Branch('.')

        if revision == None:

            inv = b.read_working_inventory()

        else:

            inv = b.get_revision_inventory(b.lookup_revision(revision))

        for path, entry in inv.entries():

            if show_ids:

                print '%-50s %s' % (path, entry.file_id)

            else:

                print path

class cmd_move(Command):

    """Move files to a different directory.

    examples:

        bzr move *.txt doc

    The destination must be a versioned directory in the same branch.

    """

    takes_args = ['source$', 'dest']

    def run(self, source_list, dest):

        b = Branch('.')

        b.move([b.relpath(s) for s in source_list], b.relpath(dest))

class cmd_rename(Command):

    """Change the name of an entry.

    examples:

      bzr rename frob.c frobber.c

      bzr rename src/frob.c lib/frob.c

    It is an error if the destination name exists.

    See also the 'move' command, which moves files into a different

    directory without changing their name.

    TODO: Some way to rename multiple files without invoking bzr for each

    one?"""

    takes_args = ['from_name', 'to_name']

    def run(self, from_name, to_name):

        b = Branch('.')

        b.rename_one(b.relpath(from_name), b.relpath(to_name))

class cmd_renames(Command):

    """Show list of renamed files.

    TODO: Option to show renames between two historical versions.

    TODO: Only show renames under dir, rather than in the whole branch.

    """

    takes_args = ['dir?']

    def run(self, dir='.'):

        b = Branch(dir)

        old_inv = b.basis_tree().inventory

        new_inv = b.read_working_inventory()

        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))

        renames.sort()

        for old_name, new_name in renames:

            print "%s => %s" % (old_name, new_name)        

class cmd_info(Command):

    """Show statistical information about a branch."""

    takes_args = ['branch?']

    def run(self, branch=None):

        import info

        from branch import find_branch

        b = find_branch(branch)

        info.show_info(b)

class cmd_remove(Command):

    """Make a file unversioned.

    This makes bzr stop tracking changes to a versioned file.  It does

    not delete the working copy.

    """

    takes_args = ['file+']

    takes_options = ['verbose']

    def run(self, file_list, verbose=False):

        b = Branch(file_list[0])

        b.remove([b.relpath(f) for f in file_list], verbose=verbose)

class cmd_file_id(Command):

    """Print file_id of a particular file or directory.

    The file_id is assigned when the file is first added and remains the

    same through all revisions where the file exists, even when it is

    moved or renamed.

    """

    hidden = True

    takes_args = ['filename']

    def run(self, filename):

        b = Branch(filename)

        i = b.inventory.path2id(b.relpath(filename))

        if i == None:

            bailout("%r is not a versioned file" % filename)

        else:

            print i

class cmd_file_path(Command):

    """Print path of file_ids to a file or directory.

    This prints one line for each directory down to the target,

    starting at the branch root."""

    hidden = True

    takes_args = ['filename']

    def run(self, filename):

        b = Branch(filename)

        inv = b.inventory

        fid = inv.path2id(b.relpath(filename))

        if fid == None:

            bailout("%r is not a versioned file" % filename)

        for fip in inv.get_idpath(fid):

            print fip

class cmd_revision_history(Command):

    """Display list of revision ids on this branch."""

    hidden = True

    def run(self):

        for patchid in Branch('.').revision_history():

            print patchid

class cmd_directories(Command):

    """Display list of versioned directories in this branch."""

    def run(self):

        for name, ie in Branch('.').read_working_inventory().directories():

            if name == '':

                print '.'

            else:

                print name

class cmd_init(Command):

    """Make a directory into a versioned branch.

    Use this to create an empty branch, or before importing an

    existing project.

    Recipe for importing a tree of files:

        cd ~/project

        bzr init

        bzr add -v .

        bzr status

        bzr commit -m 'imported project'

    """

    def run(self):

        Branch('.', init=True)

class cmd_diff(Command):

    """Show differences in working tree.

    If files are listed, only the changes in those files are listed.

    Otherwise, all changes for the tree are listed.

    TODO: Given two revision arguments, show the difference between them.

    TODO: Allow diff across branches.

    TODO: Option to use external diff command; could be GNU diff, wdiff,

          or a graphical diff.

    TODO: Python difflib is not exactly the same as unidiff; should

          either fix it up or prefer to use an external diff.

    TODO: If a directory is given, diff everything under that.

    TODO: Selected-file diff is inefficient and doesn't show you

          deleted files.

    TODO: This probably handles non-Unix newlines poorly.

    """

    takes_args = ['file*']

    takes_options = ['revision', 'diff-options']

    aliases = ['di']

    def run(self, revision=None, file_list=None, diff_options=None):

        from bzrlib.diff import show_diff

        from bzrlib import find_branch

        if file_list:

            b = find_branch(file_list[0])

            file_list = [b.relpath(f) for f in file_list]

            if file_list == ['']:

                # just pointing to top-of-tree

                file_list = None

        else:

            b = Branch('.')

        show_diff(b, revision, specific_files=file_list,

                  external_diff_options=diff_options)

class cmd_deleted(Command):

    """List files deleted in the working tree.

    TODO: Show files deleted since a previous revision, or between two revisions.

    """

    def run(self, show_ids=False):

        b = Branch('.')

        old = b.basis_tree()

        new = b.working_tree()

        ## TODO: Much more efficient way to do this: read in new

        ## directories with readdir, rather than stating each one.  Same

        ## level of effort but possibly much less IO.  (Or possibly not,

        ## if the directories are very large...)

        for path, ie in old.inventory.iter_entries():

            if not new.has_id(ie.file_id):

                if show_ids:

                    print '%-50s %s' % (path, ie.file_id)

                else:

                    print path

class cmd_modified(Command):

    """List files modified in working tree."""

    hidden = True

    def run(self):

        import statcache

        b = Branch('.')

        inv = b.read_working_inventory()

        sc = statcache.update_cache(b, inv)

        basis = b.basis_tree()

        basis_inv = basis.inventory

        # We used to do this through iter_entries(), but that's slow

        # when most of the files are unmodified, as is usually the

        # case.  So instead we iterate by inventory entry, and only

        # calculate paths as necessary.

        for file_id in basis_inv:

            cacheentry = sc.get(file_id)

            if not cacheentry:                 # deleted

                continue

            ie = basis_inv[file_id]

            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:

                path = inv.id2path(file_id)

                print path

class cmd_added(Command):

    """List files added in working tree."""

    hidden = True

    def run(self):

        b = Branch('.')

        wt = b.working_tree()

        basis_inv = b.basis_tree().inventory

        inv = wt.inventory

        for file_id in inv:

            if file_id in basis_inv:

                continue

            path = inv.id2path(file_id)

            if not os.access(b.abspath(path), os.F_OK):

                continue

            print path

class cmd_root(Command):

    """Show the tree root directory.

    The root is the nearest enclosing directory with a .bzr control

    directory."""

    takes_args = ['filename?']

    def run(self, filename=None):

        """Print the branch root."""

        from branch import find_branch

        b = find_branch(filename)

        print getattr(b, 'base', None) or getattr(b, 'baseurl')

class cmd_log(Command):

    """Show log of this branch.

    To request a range of logs, you can use the command -r begin:end

    -r revision requests a specific revision, -r :end or -r begin: are

    also valid.

    TODO: Make --revision support uuid: and hash: [future tag:] notation.

    """

    takes_args = ['filename?']

    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']

    def run(self, filename=None, timezone='original',

            verbose=False,

            show_ids=False,

            forward=False,

            revision=None):

        from bzrlib import show_log, find_branch

        import codecs

        direction = (forward and 'forward') or 'reverse'

        if filename:

            b = find_branch(filename)

            fp = b.relpath(filename)

            if fp:

                file_id = b.read_working_inventory().path2id(fp)

            else:

                file_id = None  # points to branch root

        else:

            b = find_branch('.')

            file_id = None

        if revision == None:

            revision = [None, None]

        elif isinstance(revision, int):

            revision = [revision, revision]

        else:

            # pair of revisions?

            pass

        assert len(revision) == 2

        mutter('encoding log as %r' % bzrlib.user_encoding)

        # use 'replace' so that we don't abort if trying to write out

        # in e.g. the default C locale.

        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')

        show_log(b, file_id,

                 show_timezone=timezone,

                 verbose=verbose,

                 show_ids=show_ids,

                 to_file=outf,

                 direction=direction,

                 start_revision=revision[0],

                 end_revision=revision[1])

class cmd_touching_revisions(Command):

    """Return revision-ids which affected a particular file.

    A more user-friendly interface is "bzr log FILE"."""

    hidden = True

    takes_args = ["filename"]

    def run(self, filename):

        b = Branch(filename)

        inv = b.read_working_inventory()

        file_id = inv.path2id(b.relpath(filename))

        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):

            print "%6d %s" % (revno, what)

class cmd_ls(Command):

    """List files in a tree.

    TODO: Take a revision or remote path and list that tree instead.

    """

    hidden = True

    def run(self, revision=None, verbose=False):

        b = Branch('.')

        if revision == None:

            tree = b.working_tree()

        else:

            tree = b.revision_tree(b.lookup_revision(revision))

        for fp, fc, kind, fid in tree.list_files():

            if verbose:

                if kind == 'directory':

                    kindch = '/'

                elif kind == 'file':

                    kindch = ''

                else:

                    kindch = '???'

                print '%-8s %s%s' % (fc, fp, kindch)

            else:

                print fp

class cmd_unknowns(Command):

    """List unknown files"""

    def run(self):

        for f in Branch('.').unknowns():

            print quotefn(f)

class cmd_ignore(Command):

    """Ignore a command or pattern

    To remove patterns from the ignore list, edit the .bzrignore file.

    If the pattern contains a slash, it is compared to the whole path

    from the branch root.  Otherwise, it is comapred to only the last

    component of the path.

    Ignore patterns are case-insensitive on case-insensitive systems.

    Note: wildcards must be quoted from the shell on Unix.

    examples:

        bzr ignore ./Makefile

        bzr ignore '*.class'

    """

    takes_args = ['name_pattern']

    def run(self, name_pattern):