/brz/remove-bazaar

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

import errno

import os

import shutil

import sys

from unittest import TestSuite

from warnings import warn

import xml.sax.saxutils

import bzrlib

from bzrlib.config import TreeConfig

from bzrlib.decorators import needs_read_lock, needs_write_lock

from bzrlib.delta import compare_trees

import bzrlib.errors as errors

from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,

                           NoSuchRevision, HistoryMissing, NotBranchError,

                           DivergedBranches, LockError, 

                           UninitializableFormat,

                           UnlistableStore,

                           UnlistableBranch, NoSuchFile, NotVersionedError,

                           NoWorkingTree)

import bzrlib.inventory as inventory

from bzrlib.inventory import Inventory

from bzrlib.lockable_files import LockableFiles

from bzrlib.osutils import (isdir, quotefn,

                            rename, splitpath, sha_file,

                            file_kind, abspath, normpath, pathjoin,

                            safe_unicode,

                            )

from bzrlib.textui import show_status

from bzrlib.trace import mutter, note

from bzrlib.tree import EmptyTree, RevisionTree

from bzrlib.repository import Repository

from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)

from bzrlib.store import copy_all

from bzrlib.symbol_versioning import *

import bzrlib.transactions as transactions

from bzrlib.transport import Transport, get_transport

from bzrlib.tree import EmptyTree, RevisionTree

import bzrlib.ui

import bzrlib.xml5

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

    _default_initializer = None

    """The default initializer for making new branches."""

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

        raise NotImplementedError('The Branch class is abstract')

    @staticmethod

    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 an existing branch, rooted at 'base' (url)

        _unsupported is a private parameter to the Branch class.

        """

        t = get_transport(base)

        mutter("trying to open %r with transport %r", base, t)

        format = BzrBranchFormat.find_format(t)

        if not _unsupported and not format.is_supported():

            # see open_downlevel to open legacy branches.

            raise errors.UnsupportedFormatError(

                    'sorry, branch format %s not supported' % format,

                    ['use a different bzr version',

                     'or remove the .bzr directory'

                     ' and "bzr init" again'])

        return format.open(t)

    @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.

        """

        t = get_transport(url)

        # this gets the normalised url back. I.e. '.' -> the full path.

        url = t.base

        while True:

            try:

                format = BzrBranchFormat.find_format(t)

                return format.open(t), t.relpath(url)

            except NotBranchError, e:

                mutter('not a branch in: %r %s', t.base, e)

            new_t = t.clone('..')

            if new_t.base == t.base:

                # reached the root, whatever that may be

                raise NotBranchError(path=url)

            t = new_t

    @staticmethod

    def create(base):

        """Create a new Branch at the url 'bzr'.

        This will call the current default initializer with base

        as the only parameter.

        """

        return Branch._default_initializer(safe_unicode(base))

    @staticmethod

    @deprecated_function(zero_eight)

    def initialize(base):

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

        """

        # imported here to prevent scope creep as this is going.

        from bzrlib.workingtree import WorkingTree

        return WorkingTree.create_standalone(safe_unicode(base)).branch

    @staticmethod

    def get_default_initializer():

        """Return the initializer being used for new branches."""

        return Branch._default_initializer

    @staticmethod

    def set_default_initializer(initializer):

        """Set the initializer to be used for new branches."""

        Branch._default_initializer = staticmethod(initializer)

    def setup_caching(self, cache_root):

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

        up cached stores located under cache_root.

        """

        # seems to be unused, 2006-01-13 mbp

        warn('%s is deprecated' % self.setup_caching)

        self.cache_root = cache_root

    def _get_nick(self):

        cfg = self.tree_config()

        return cfg.get_option(u"nickname", default=self.base.split('/')[-2])

    def _set_nick(self, nick):

        cfg = self.tree_config()

        cfg.set_option(nick, "nickname")

        assert cfg.get_option("nickname") == nick

    nick = property(_get_nick, _set_nick)

    def push_stores(self, branch_to):

        """Copy the content of this branches store to branch_to."""

        raise NotImplementedError('push_stores is abstract')

    def lock_write(self):

        raise NotImplementedError('lock_write is abstract')

    def lock_read(self):

        raise NotImplementedError('lock_read is abstract')

    def unlock(self):

        raise NotImplementedError('unlock is abstract')

    def peek_lock_mode(self):

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

        raise NotImplementedError(self.peek_lock_mode)

    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('abspath is abstract')

    def get_root_id(self):

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

        raise NotImplementedError('get_root_id is abstract')

    def print_file(self, file, revision_id):

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

        raise NotImplementedError('print_file is abstract')

    def append_revision(self, *revision_ids):

        raise NotImplementedError('append_revision is abstract')

    def set_revision_history(self, rev_history):

        raise NotImplementedError('set_revision_history is abstract')

    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 last_revision(self):

        """Return last patch hash, or None if no history."""

        ph = self.revision_history()

        if ph:

            return ph[-1]

        else:

            return None

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

        """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.

        >>> bzrlib.trace.silent = True

        >>> br1 = ScratchBranch()

        >>> br2 = ScratchBranch()

        >>> br1.missing_revisions(br2)

        []

        >>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-1")

        >>> br1.missing_revisions(br2)

        [u'REVISION-ID-1']

        >>> br2.missing_revisions(br1)

        []

        >>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-1")

        >>> br1.missing_revisions(br2)

        []

        >>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-2A")

        >>> br1.missing_revisions(br2)

        [u'REVISION-ID-2A']

        >>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-2B")

        >>> br1.missing_revisions(br2)

        Traceback (most recent call last):

        DivergedBranches: These branches have diverged.  Try merge.

        """

        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 bzrlib.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."""

        raise NotImplementedError('update_revisions is abstract')

    def pullable_revisions(self, other, stop_revision):

        raise NotImplementedError('pullable_revisions is abstract')

    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()

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

            raise bzrlib.errors.NoSuchRevision(self, revno)

        return history[revno - 1]

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

        raise NotImplementedError('pull is abstract')

    def basis_tree(self):

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

        If there are no revisions yet, return an `EmptyTree`.

        """

        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('rename_one is abstract')

    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('move is abstract')

    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('get_parent is abstract')

    def get_push_location(self):

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

        raise NotImplementedError('get_push_location is abstract')

    def set_push_location(self, location):

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

        raise NotImplementedError('set_push_location is abstract')

    def set_parent(self, url):

        raise NotImplementedError('set_parent is abstract')

    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)

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

        """Copy this branch into the existing directory to_location.

        Returns the newly created branch object.

        revision

            If not None, only revisions up to this point will be copied.

            The head of the new branch will be that revision.  Must be a

            revid or None.

        to_location -- The destination directory; must either exist and be 

            empty, or not exist, in which case it is created.

        basis_branch

            A local branch to copy revisions from, related to this branch. 

            This is used when branching from a remote (slow) branch, and we have

            a local branch that might contain some relevant revisions.

        to_branch_type

            Branch type of destination branch

        """

        from bzrlib.workingtree import WorkingTree

        assert isinstance(to_location, basestring)

        segments = to_location.split('/')

        if segments and segments[-1] not in ('', '.'):

            parent = '/'.join(segments[:-1])

            t = get_transport(parent)

            try:

                t.mkdir(segments[-1])

            except errors.FileExists:

                pass

        if to_branch_format is None:

            # use the default

            br_to = Branch.create(to_location)

        else:

            br_to = to_branch_format.initialize(to_location)

        mutter("copy branch from %s to %s", self, br_to)

        if basis_branch is not None:

            basis_branch.push_stores(br_to)

        if revision is None:

            revision = self.last_revision()

        br_to.update_revisions(self, stop_revision=revision)

        br_to.set_parent(self.base)

        mutter("copied")

        return br_to

    def fileid_involved_between_revs(self, from_revid, to_revid):

        """ This function returns the file_id(s) involved in the

            changes between the from_revid revision and the to_revid

            revision

        """

        raise NotImplementedError('fileid_involved_between_revs is abstract')

    def fileid_involved(self, last_revid=None):

        """ This function returns the file_id(s) involved in the

            changes up to the revision last_revid

            If no parametr is passed, then all file_id[s] present in the

            repository are returned

        """

        raise NotImplementedError('fileid_involved is abstract')

    def fileid_involved_by_set(self, changes):

        """ This function returns the file_id(s) involved in the

            changes present in the set 'changes'

        """

        raise NotImplementedError('fileid_involved_by_set is abstract')

    def fileid_involved_between_revs(self, from_revid, to_revid):

        """ This function returns the file_id(s) involved in the

            changes between the from_revid revision and the to_revid

            revision

        """

        raise NotImplementedError('fileid_involved_between_revs is abstract')

    def fileid_involved(self, last_revid=None):

        """ This function returns the file_id(s) involved in the

            changes up to the revision last_revid

            If no parametr is passed, then all file_id[s] present in the

            repository are returned

        """

        raise NotImplementedError('fileid_involved is abstract')

    def fileid_involved_by_set(self, changes):

        """ This function returns the file_id(s) involved in the

            changes present in the set 'changes'

        """

        raise NotImplementedError('fileid_involved_by_set is abstract')

class BzrBranchFormat(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.

    """

    _formats = {}

    """The known formats."""

    @classmethod

    def find_format(klass, transport):

        """Return the format registered for URL."""

        try:

            format_string = transport.get(".bzr/branch-format").read()

            return klass._formats[format_string]

        except NoSuchFile:

            raise NotBranchError(path=transport.base)

        except KeyError:

            raise errors.UnknownFormatError(format_string)

    def get_format_string(self):

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

        raise NotImplementedError(self.get_format_string)

    def _find_modes(self, t):

        """Determine the appropriate modes for files and directories.

        FIXME: When this merges into, or from storage,

        this code becomes delgatable to a LockableFiles instance.

        For now its cribbed and returns (dir_mode, file_mode)

        """

        try:

            st = t.stat('.')

        except errors.TransportNotPossible:

            dir_mode = 0755

            file_mode = 0644

        else:

            dir_mode = st.st_mode & 07777

            # Remove the sticky and execute bits for files

            file_mode = dir_mode & ~07111

        if not BzrBranch._set_dir_mode:

            dir_mode = None

        if not BzrBranch._set_file_mode:

            file_mode = None

        return dir_mode, file_mode

    def initialize(self, url):

        """Create a branch of this format at url and return an open branch."""

        t = get_transport(url)

        from bzrlib.weavefile import write_weave_v5

        from bzrlib.weave import Weave

        # Create an empty weave

        sio = StringIO()

        bzrlib.weavefile.write_weave_v5(Weave(), sio)

        empty_weave = sio.getvalue()

        # Since we don't have a .bzr directory, inherit the

        # mode from the root directory

        temp_control = LockableFiles(t, '')

        temp_control._transport.mkdir('.bzr',

                                      mode=temp_control._dir_mode)

        file_mode = temp_control._file_mode

        del temp_control

        mutter('created control directory in ' + t.base)

        control = t.clone('.bzr')

        dirs = ['revision-store', 'weaves']

        lock_file = 'branch-lock'

        utf8_files = [('README', 

                       "This is a Bazaar-NG control directory.\n"

                       "Do not change any files in this directory.\n"),

                      ('branch-format', self.get_format_string()),

                      ('revision-history', ''),

                      ('branch-name', ''),

                      ]

        files = [('inventory.weave', StringIO(empty_weave)), 

                 ]

        # FIXME: RBC 20060125 dont peek under the covers

        # NB: no need to escape relative paths that are url safe.

        control.put(lock_file, StringIO(), mode=file_mode)

        control_files = LockableFiles(control, lock_file)

        control_files.lock_write()

        control_files._transport.mkdir_multi(dirs,

                mode=control_files._dir_mode)

        try:

            for file, content in utf8_files:

                control_files.put_utf8(file, content)

            for file, content in files:

                control_files.put(file, content)

        finally:

            control_files.unlock()

        return BzrBranch(t, _format=self, _control_files=control_files)

    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, transport):

        """Fill out the data in branch for the branch at url."""

        return BzrBranch(transport, _format=self)

    @classmethod

    def register_format(klass, format):

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

    @classmethod

    def unregister_format(klass, format):

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

        del klass._formats[format.get_format_string()]

class BzrBranchFormat4(BzrBranchFormat):

    """Bzr branch format 4.

    This format has:

     - flat stores

     - TextStores for texts, inventories,revisions.

    This format is deprecated: it indexes texts using a text it which is

    removed in format 5; write support for this format has been removed.

    """

    def get_format_string(self):

        """See BzrBranchFormat.get_format_string()."""

        return BZR_BRANCH_FORMAT_4

    def initialize(self, url):

        """Format 4 branches cannot be created."""

        raise UninitializableFormat(self)

    def is_supported(self):

        """Format 4 is not supported.

        It is not supported because the model changed from 4 to 5 and the

        conversion logic is expensive - so doing it on the fly was not 

        feasible.

        """

        return False

class BzrBranchFormat5(BzrBranchFormat):

    """Bzr branch format 5.

    This format has:

     - weaves for file texts and inventory

     - flat stores

     - TextStores for revisions and signatures.

    """

    def get_format_string(self):

        """See BzrBranchFormat.get_format_string()."""

        return BZR_BRANCH_FORMAT_5

class BzrBranchFormat6(BzrBranchFormat):

    """Bzr branch format 6.

    This format has:

     - weaves for file texts and inventory

     - hash subdirectory based stores.

     - TextStores for revisions and signatures.

    """

    def get_format_string(self):

        """See BzrBranchFormat.get_format_string()."""

        return BZR_BRANCH_FORMAT_6

BzrBranchFormat.register_format(BzrBranchFormat4())

BzrBranchFormat.register_format(BzrBranchFormat5())

BzrBranchFormat.register_format(BzrBranchFormat6())

# TODO: jam 20060108 Create a new branch format, and as part of upgrade

#       make sure that ancestry.weave is deleted (it is never used, but

#       used to be created)

class BzrBranch(Branch):

    """A branch stored in the actual filesystem.

    Note that it's "local" in the context of the filesystem; it doesn't

    really matter if it's on an nfs/smb/afs/coda/... share, as long as

    it's writable, and can be accessed via the normal filesystem API.

    """

    # We actually expect this class to be somewhat short-lived; part of its

    # purpose is to try to isolate what bits of the branch logic are tied to

    # filesystem access, so that in a later step, we can extricate them to

    # a separarte ("storage") class.

    _inventory_weave = None

    # Map some sort of prefix into a namespace

    # stuff like "revno:10", "revid:", etc.

    # This should match a prefix with a function which accepts

    REVISION_NAMESPACES = {}

    def push_stores(self, branch_to):

        """See Branch.push_stores."""

        if (not isinstance(self._branch_format, BzrBranchFormat4) or

            self._branch_format != branch_to._branch_format):

            from bzrlib.fetch import greedy_fetch

            mutter("Using fetch logic to push between %s(%s) and %s(%s)",

                   self, self._branch_format, branch_to, branch_to._branch_format)

            greedy_fetch(to_branch=branch_to, from_branch=self,

                         revision=self.last_revision())

            return

        # format 4 to format 4 logic only.

        store_pairs = ((self.text_store,      branch_to.text_store),

                       (self.inventory_store, branch_to.inventory_store),

                       (self.revision_store,  branch_to.revision_store))

        try:

            for from_store, to_store in store_pairs: 

                copy_all(from_store, to_store)

        except UnlistableStore:

            raise UnlistableBranch(from_store)

    def __init__(self, transport, init=DEPRECATED_PARAMETER,

                 relax_version_check=DEPRECATED_PARAMETER, _format=None,

                 _control_files=None):

        """Create new branch object at a particular location.

        transport -- A Transport object, defining how to access files.

        init -- If True, create new control files in a previously

             unversioned directory.  If False, the branch must already

             be versioned.

        relax_version_check -- If true, the usual check for the branch

            version is not applied.  This is intended only for

            upgrade/recovery type use; it's not guaranteed that

            all operations will work on old format branches.

        In the test suite, creation of new trees is tested using the

        `ScratchBranch` class.

        """

        assert isinstance(transport, Transport), \

            "%r is not a Transport" % transport

        self._transport = transport

        self._base = self._transport.base

        if _control_files is None:

            _control_files = LockableFiles(self._transport.clone(bzrlib.BZRDIR),

                                           'branch-lock')

        self.control_files = _control_files

        if deprecated_passed(init):

            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "

                 "deprecated as of bzr 0.8. Please use Branch.create().",

                 DeprecationWarning,

                 stacklevel=2)

            if init:

                # this is slower than before deprecation, oh well never mind.

                # -> its deprecated.

                self._initialize(transport.base)

        self._check_format(_format)

        if deprecated_passed(relax_version_check):

            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "

                 "relax_version_check parameter is deprecated as of bzr 0.8. "

                 "Please use Branch.open_downlevel, or a BzrBranchFormat's "

                 "open() method.",

                 DeprecationWarning,

                 stacklevel=2)

            if (not relax_version_check

                and not self._branch_format.is_supported()):