~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2005, 2006 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

from copy import deepcopy

from cStringIO import StringIO

from unittest import TestSuite

from warnings import warn

import bzrlib

from bzrlib import (

        bzrdir,

        cache_utf8,

        errors,

        lockdir,

        osutils,

        revision,

        transport,

        tree,

        ui,

        urlutils,

        )

from bzrlib.config import TreeConfig

from bzrlib.decorators import needs_read_lock, needs_write_lock

import bzrlib.errors as errors

from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches, 

                           HistoryMissing, InvalidRevisionId, 

                           InvalidRevisionNumber, LockError, NoSuchFile, 

                           NoSuchRevision, NoWorkingTree, NotVersionedError,

                           NotBranchError, UninitializableFormat, 

                           UnlistableStore, UnlistableBranch, 

                           )

from bzrlib.lockable_files import LockableFiles, TransportLock

from bzrlib.symbol_versioning import (deprecated_function,

                                      deprecated_method,

                                      DEPRECATED_PARAMETER,

                                      deprecated_passed,

                                      zero_eight, zero_nine,

                                      )

from bzrlib.trace import mutter, note

BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"

BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"

BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"

# TODO: Maybe include checks for common corruption of newlines, etc?

# TODO: Some operations like log might retrieve the same revisions

# repeatedly to calculate deltas.  We could perhaps have a weakref

# cache in memory to make this faster.  In general anything can be

# cached in memory between lock and unlock operations. .. nb thats

# what the transaction identity map provides

######################################################################

# branch objects

class Branch(object):

    """Branch holding a history of revisions.

    base

        Base directory/url of the branch.

    """

    # this is really an instance variable - FIXME move it there

    # - RBC 20060112

    base = None

    def __init__(self, *ignored, **ignored_too):

        raise NotImplementedError('The Branch class is abstract')

    def break_lock(self):

        """Break a lock if one is present from another instance.

        Uses the ui factory to ask for confirmation if the lock may be from

        an active process.

        This will probe the repository for its lock as well.

        """

        self.control_files.break_lock()

        self.repository.break_lock()

        master = self.get_master_branch()

        if master is not None:

            master.break_lock()

    @staticmethod

    @deprecated_method(zero_eight)

    def open_downlevel(base):

        """Open a branch which may be of an old format."""

        return Branch.open(base, _unsupported=True)

    @staticmethod

    def open(base, _unsupported=False):

        """Open the branch rooted at base.

        For instance, if the branch is at URL/.bzr/branch,

        Branch.open(URL) -> a Branch instance.

        """

        control = bzrdir.BzrDir.open(base, _unsupported)

        return control.open_branch(_unsupported)

    @staticmethod

    def open_containing(url):

        """Open an existing branch which contains url.

        This probes for a branch at url, and searches upwards from there.

        Basically we keep looking up until we find the control directory or

        run into the root.  If there isn't one, raises NotBranchError.

        If there is one and it is either an unrecognised format or an unsupported 

        format, UnknownFormatError or UnsupportedFormatError are raised.

        If there is one, it is returned, along with the unused portion of url.

        """

        control, relpath = bzrdir.BzrDir.open_containing(url)

        return control.open_branch(), relpath

    @staticmethod

    @deprecated_function(zero_eight)

    def initialize(base):

        """Create a new working tree and branch, rooted at 'base' (url)

        NOTE: This will soon be deprecated in favour of creation

        through a BzrDir.

        """

        return bzrdir.BzrDir.create_standalone_workingtree(base).branch

    @deprecated_function(zero_eight)

    def setup_caching(self, cache_root):

        """Subclasses that care about caching should override this, and set

        up cached stores located under cache_root.

        NOTE: This is unused.

        """

        pass

    def get_config(self):

        return bzrlib.config.BranchConfig(self)

    def _get_nick(self):

        return self.get_config().get_nickname()

    def _set_nick(self, nick):

        self.get_config().set_user_option('nickname', nick)

    nick = property(_get_nick, _set_nick)

    def is_locked(self):

        raise NotImplementedError(self.is_locked)

    def lock_write(self):

        raise NotImplementedError(self.lock_write)

    def lock_read(self):

        raise NotImplementedError(self.lock_read)

    def unlock(self):

        raise NotImplementedError(self.unlock)

    def peek_lock_mode(self):

        """Return lock mode for the Branch: 'r', 'w' or None"""

        raise NotImplementedError(self.peek_lock_mode)

    def get_physical_lock_status(self):

        raise NotImplementedError(self.get_physical_lock_status)

    def abspath(self, name):

        """Return absolute filename for something in the branch

        XXX: Robert Collins 20051017 what is this used for? why is it a branch

        method and not a tree method.

        """

        raise NotImplementedError(self.abspath)

    def bind(self, other):

        """Bind the local branch the other branch.

        :param other: The branch to bind to

        :type other: Branch

        """

        raise errors.UpgradeRequired(self.base)

    @needs_write_lock

    def fetch(self, from_branch, last_revision=None, pb=None):

        """Copy revisions from from_branch into this branch.

        :param from_branch: Where to copy from.

        :param last_revision: What revision to stop at (None for at the end

                              of the branch.

        :param pb: An optional progress bar to use.

        Returns the copied revision count and the failed revisions in a tuple:

        (copied, failures).

        """

        if self.base == from_branch.base:

            return (0, [])

        if pb is None:

            nested_pb = ui.ui_factory.nested_progress_bar()

            pb = nested_pb

        else:

            nested_pb = None

        from_branch.lock_read()

        try:

            if last_revision is None:

                pb.update('get source history')

                from_history = from_branch.revision_history()

                if from_history:

                    last_revision = from_history[-1]

                else:

                    # no history in the source branch

                    last_revision = revision.NULL_REVISION

            return self.repository.fetch(from_branch.repository,

                                         revision_id=last_revision,

                                         pb=nested_pb)

        finally:

            if nested_pb is not None:

                nested_pb.finished()

            from_branch.unlock()

    def get_bound_location(self):

        """Return the URL of the branch we are bound to.

        Older format branches cannot bind, please be sure to use a metadir

        branch.

        """

        return None

    def get_commit_builder(self, parents, config=None, timestamp=None, 

                           timezone=None, committer=None, revprops=None, 

                           revision_id=None):

        """Obtain a CommitBuilder for this branch.

        :param parents: Revision ids of the parents of the new revision.

        :param config: Optional configuration to use.

        :param timestamp: Optional timestamp recorded for commit.

        :param timezone: Optional timezone for timestamp.

        :param committer: Optional committer to set for commit.

        :param revprops: Optional dictionary of revision properties.

        :param revision_id: Optional revision id.

        """

        if config is None:

            config = self.get_config()

        return self.repository.get_commit_builder(self, parents, config, 

            timestamp, timezone, committer, revprops, revision_id)

    def get_master_branch(self):

        """Return the branch we are bound to.

        :return: Either a Branch, or None

        """

        return None

    def get_revision_delta(self, revno):

        """Return the delta for one revision.

        The delta is relative to its mainline predecessor, or the

        empty tree for revision 1.

        """

        assert isinstance(revno, int)

        rh = self.revision_history()

        if not (1 <= revno <= len(rh)):

            raise InvalidRevisionNumber(revno)

        return self.repository.get_revision_delta(rh[revno-1])

    def get_root_id(self):

        """Return the id of this branches root"""

        raise NotImplementedError(self.get_root_id)

    def print_file(self, file, revision_id):

        """Print `file` to stdout."""

        raise NotImplementedError(self.print_file)

    def append_revision(self, *revision_ids):

        raise NotImplementedError(self.append_revision)

    def set_revision_history(self, rev_history):

        raise NotImplementedError(self.set_revision_history)

    def revision_history(self):

        """Return sequence of revision hashes on to this branch."""

        raise NotImplementedError('revision_history is abstract')

    def revno(self):

        """Return current revision number for this branch.

        That is equivalent to the number of revisions committed to

        this branch.

        """

        return len(self.revision_history())

    def unbind(self):

        """Older format branches cannot bind or unbind."""

        raise errors.UpgradeRequired(self.base)

    def last_revision(self):

        """Return last revision id, or None"""

        ph = self.revision_history()

        if ph:

            return ph[-1]

        else:

            return None

    def missing_revisions(self, other, stop_revision=None):

        """Return a list of new revisions that would perfectly fit.

        If self and other have not diverged, return a list of the revisions

        present in other, but missing from self.

        """

        self_history = self.revision_history()

        self_len = len(self_history)

        other_history = other.revision_history()

        other_len = len(other_history)

        common_index = min(self_len, other_len) -1

        if common_index >= 0 and \

            self_history[common_index] != other_history[common_index]:

            raise DivergedBranches(self, other)

        if stop_revision is None:

            stop_revision = other_len

        else:

            assert isinstance(stop_revision, int)

            if stop_revision > other_len:

                raise errors.NoSuchRevision(self, stop_revision)

        return other_history[self_len:stop_revision]

    def update_revisions(self, other, stop_revision=None):

        """Pull in new perfect-fit revisions.

        :param other: Another Branch to pull from

        :param stop_revision: Updated until the given revision

        :return: None

        """

        raise NotImplementedError(self.update_revisions)

    def revision_id_to_revno(self, revision_id):

        """Given a revision id, return its revno"""

        if revision_id is None:

            return 0

        history = self.revision_history()

        try:

            return history.index(revision_id) + 1

        except ValueError:

            raise bzrlib.errors.NoSuchRevision(self, revision_id)

    def get_rev_id(self, revno, history=None):

        """Find the revision id of the specified revno."""

        if revno == 0:

            return None

        if history is None:

            history = self.revision_history()

        if revno <= 0 or revno > len(history):

            raise bzrlib.errors.NoSuchRevision(self, revno)

        return history[revno - 1]

    def pull(self, source, overwrite=False, stop_revision=None):

        raise NotImplementedError(self.pull)

    def basis_tree(self):

        """Return `Tree` object for last revision."""

        return self.repository.revision_tree(self.last_revision())

    def rename_one(self, from_rel, to_rel):

        """Rename one file.

        This can change the directory or the filename or both.

        """

        raise NotImplementedError(self.rename_one)

    def move(self, from_paths, to_name):

        """Rename files.

        to_name must exist as a versioned directory.

        If to_name exists and is a directory, the files are moved into

        it, keeping their old names.  If it is a directory, 

        Note that to_name is only the last component of the new name;

        this doesn't change the directory.

        This returns a list of (from_path, to_path) pairs for each

        entry that is moved.

        """

        raise NotImplementedError(self.move)

    def get_parent(self):

        """Return the parent location of the branch.

        This is the default location for push/pull/missing.  The usual

        pattern is that the user can override it by specifying a

        location.

        """

        raise NotImplementedError(self.get_parent)

    def get_submit_branch(self):

        """Return the submit location of the branch.

        This is the default location for bundle.  The usual

        pattern is that the user can override it by specifying a

        location.

        """

        return self.get_config().get_user_option('submit_branch')

    def set_submit_branch(self, location):

        """Return the submit location of the branch.

        This is the default location for bundle.  The usual

        pattern is that the user can override it by specifying a

        location.

        """

        self.get_config().set_user_option('submit_branch', location)

    def get_push_location(self):

        """Return the None or the location to push this branch to."""

        raise NotImplementedError(self.get_push_location)

    def set_push_location(self, location):

        """Set a new push location for this branch."""

        raise NotImplementedError(self.set_push_location)

    def set_parent(self, url):

        raise NotImplementedError(self.set_parent)

    @needs_write_lock

    def update(self):

        """Synchronise this branch with the master branch if any. 

        :return: None or the last_revision pivoted out during the update.

        """

        return None

    def check_revno(self, revno):

        """\

        Check whether a revno corresponds to any revision.

        Zero (the NULL revision) is considered valid.

        """

        if revno != 0:

            self.check_real_revno(revno)

    def check_real_revno(self, revno):

        """\

        Check whether a revno corresponds to a real revision.

        Zero (the NULL revision) is considered invalid

        """

        if revno < 1 or revno > self.revno():

            raise InvalidRevisionNumber(revno)

    @needs_read_lock

    def clone(self, *args, **kwargs):

        """Clone this branch into to_bzrdir preserving all semantic values.

        revision_id: if not None, the revision history in the new branch will

                     be truncated to end with revision_id.

        """

        # for API compatibility, until 0.8 releases we provide the old api:

        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):

        # after 0.8 releases, the *args and **kwargs should be changed:

        # def clone(self, to_bzrdir, revision_id=None):

        if (kwargs.get('to_location', None) or

            kwargs.get('revision', None) or

            kwargs.get('basis_branch', None) or

            (len(args) and isinstance(args[0], basestring))):

            # backwards compatibility api:

            warn("Branch.clone() has been deprecated for BzrDir.clone() from"

                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)

            # get basis_branch

            if len(args) > 2:

                basis_branch = args[2]

            else:

                basis_branch = kwargs.get('basis_branch', None)

            if basis_branch:

                basis = basis_branch.bzrdir

            else:

                basis = None

            # get revision

            if len(args) > 1:

                revision_id = args[1]

            else:

                revision_id = kwargs.get('revision', None)

            # get location

            if len(args):

                url = args[0]

            else:

                # no default to raise if not provided.

                url = kwargs.get('to_location')

            return self.bzrdir.clone(url,

                                     revision_id=revision_id,

                                     basis=basis).open_branch()

        # new cleaner api.

        # generate args by hand 

        if len(args) > 1:

            revision_id = args[1]

        else:

            revision_id = kwargs.get('revision_id', None)

        if len(args):

            to_bzrdir = args[0]

        else:

            # no default to raise if not provided.

            to_bzrdir = kwargs.get('to_bzrdir')

        result = self._format.initialize(to_bzrdir)

        self.copy_content_into(result, revision_id=revision_id)

        return  result

    @needs_read_lock

    def sprout(self, to_bzrdir, revision_id=None):

        """Create a new line of development from the branch, into to_bzrdir.

        revision_id: if not None, the revision history in the new branch will

                     be truncated to end with revision_id.

        """

        result = self._format.initialize(to_bzrdir)

        self.copy_content_into(result, revision_id=revision_id)

        result.set_parent(self.bzrdir.root_transport.base)

        return result

    @needs_read_lock

    def copy_content_into(self, destination, revision_id=None):

        """Copy the content of self into destination.

        revision_id: if not None, the revision history in the new branch will

                     be truncated to end with revision_id.

        """

        new_history = self.revision_history()

        if revision_id is not None:

            try:

                new_history = new_history[:new_history.index(revision_id) + 1]

            except ValueError:

                rev = self.repository.get_revision(revision_id)

                new_history = rev.get_history(self.repository)[1:]

        destination.set_revision_history(new_history)

        try:

            parent = self.get_parent()

        except errors.InaccessibleParent, e:

            mutter('parent was not accessible to copy: %s', e)

        else:

            if parent:

                destination.set_parent(parent)

    @needs_read_lock

    def check(self):

        """Check consistency of the branch.

        In particular this checks that revisions given in the revision-history

        do actually match up in the revision graph, and that they're all 

        present in the repository.

        Callers will typically also want to check the repository.

        :return: A BranchCheckResult.

        """

        mainline_parent_id = None

        for revision_id in self.revision_history():

            try:

                revision = self.repository.get_revision(revision_id)

            except errors.NoSuchRevision, e:

                raise errors.BzrCheckError("mainline revision {%s} not in repository"

                            % revision_id)

            # In general the first entry on the revision history has no parents.

            # But it's not illegal for it to have parents listed; this can happen

            # in imports from Arch when the parents weren't reachable.

            if mainline_parent_id is not None:

                if mainline_parent_id not in revision.parent_ids:

                    raise errors.BzrCheckError("previous revision {%s} not listed among "

                                        "parents of {%s}"

                                        % (mainline_parent_id, revision_id))

            mainline_parent_id = revision_id

        return BranchCheckResult(self)

    def create_checkout(self, to_location, revision_id=None, 

                        lightweight=False):

        """Create a checkout of a branch.

        :param to_location: The url to produce the checkout at

        :param revision_id: The revision to check out

        :param lightweight: If True, produce a lightweight checkout, otherwise,

        produce a bound branch (heavyweight checkout)

        :return: The tree of the created checkout

        """

        if lightweight:

            t = transport.get_transport(to_location)

            try:

                t.mkdir('.')

            except errors.FileExists:

                pass

            checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)

            BranchReferenceFormat().initialize(checkout, self)

        else:

            checkout_branch = bzrdir.BzrDir.create_branch_convenience(

                to_location, force_new_tree=False)

            checkout = checkout_branch.bzrdir

            checkout_branch.bind(self)

            if revision_id is not None:

                rh = checkout_branch.revision_history()

                new_rh = rh[:rh.index(revision_id) + 1]

                checkout_branch.set_revision_history(new_rh)

        return checkout.create_workingtree(revision_id)

class BranchFormat(object):

    """An encapsulation of the initialization and open routines for a format.

    Formats provide three things:

     * An initialization routine,

     * a format string,

     * an open routine.

    Formats are placed in an dict by their format string for reference 

    during branch opening. Its not required that these be instances, they

    can be classes themselves with class methods - it simply depends on 

    whether state is needed for a given format or not.

    Once a format is deprecated, just deprecate the initialize and open

    methods on the format class. Do not deprecate the object, as the 

    object will be created every time regardless.

    """

    _default_format = None

    """The default format used for new branches."""

    _formats = {}

    """The known formats."""

    @classmethod

    def find_format(klass, a_bzrdir):

        """Return the format for the branch object in a_bzrdir."""

        try:

            transport = a_bzrdir.get_branch_transport(None)

            format_string = transport.get("format").read()

            return klass._formats[format_string]

        except NoSuchFile:

            raise NotBranchError(path=transport.base)

        except KeyError:

            raise errors.UnknownFormatError(format=format_string)

    @classmethod

    def get_default_format(klass):

        """Return the current default format."""

        return klass._default_format

    def get_format_string(self):

        """Return the ASCII format string that identifies this format."""

        raise NotImplementedError(self.get_format_string)

    def get_format_description(self):

        """Return the short format description for this format."""

        raise NotImplementedError(self.get_format_string)

    def initialize(self, a_bzrdir):

        """Create a branch of this format in a_bzrdir."""

        raise NotImplementedError(self.initialize)

    def is_supported(self):

        """Is this format supported?

        Supported formats can be initialized and opened.

        Unsupported formats may not support initialization or committing or 

        some other features depending on the reason for not being supported.

        """

        return True

    def open(self, a_bzrdir, _found=False):

        """Return the branch object for a_bzrdir

        _found is a private parameter, do not use it. It is used to indicate

               if format probing has already be done.

        """

        raise NotImplementedError(self.open)

    @classmethod

    def register_format(klass, format):

        klass._formats[format.get_format_string()] = format

    @classmethod

    def set_default_format(klass, format):

        klass._default_format = format

    @classmethod

    def unregister_format(klass, format):

        assert klass._formats[format.get_format_string()] is format

        del klass._formats[format.get_format_string()]

    def __str__(self):

        return self.get_format_string().rstrip()

class BzrBranchFormat4(BranchFormat):

    """Bzr branch format 4.

    This format has:

     - a revision-history file.

     - a branch-lock lock file [ to be shared with the bzrdir ]

    """

    def get_format_description(self):

        """See BranchFormat.get_format_description()."""

        return "Branch format 4"

    def initialize(self, a_bzrdir):

        """Create a branch of this format in a_bzrdir."""

        mutter('creating branch in %s', a_bzrdir.transport.base)

        branch_transport = a_bzrdir.get_branch_transport(self)

        utf8_files = [('revision-history', ''),

                      ('branch-name', ''),

                      ]

        control_files = LockableFiles(branch_transport, 'branch-lock',

                                      TransportLock)

        control_files.create_lock()

        control_files.lock_write()

        try:

            for file, content in utf8_files:

                control_files.put_utf8(file, content)

        finally:

            control_files.unlock()

        return self.open(a_bzrdir, _found=True)

    def __init__(self):