/brz/remove-bazaar

# 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

"""Copying of history from one branch to another.

The basic plan is that every branch knows the history of everything

that has merged into it.  As the first step of a merge, pull, or

branch operation we copy history from the source into the destination

branch.

The copying is done in a slightly complicated order.  We don't want to

add a revision to the store until everything it refers to is also

stored, so that if a revision is present we can totally recreate it.

However, we can't know what files are included in a revision until we

read its inventory.  So we query the inventory store of the source for

the ids we need, and then pull those ids and finally actually join

the inventories.

"""

import bzrlib

import bzrlib.errors as errors

from bzrlib.errors import InstallFailed

from bzrlib.graph import SearchResult

from bzrlib.progress import ProgressPhase

from bzrlib.revision import is_null, NULL_REVISION

from bzrlib.symbol_versioning import (deprecated_function,

        deprecated_method,

        )

from bzrlib.trace import mutter

import bzrlib.ui

from bzrlib.lazy_import import lazy_import

# TODO: Avoid repeatedly opening weaves so many times.

# XXX: This doesn't handle ghost (not present in branch) revisions at

# all yet.  I'm not sure they really should be supported.

# NOTE: This doesn't copy revisions which may be present but not

# merged into the last revision.  I'm not sure we want to do that.

# - get a list of revisions that need to be pulled in

# - for each one, pull in that revision file

#   and get the inventory, and store the inventory with right

#   parents.

# - and get the ancestry, and store that with right parents too

# - and keep a note of all file ids and version seen

# - then go through all files; for each one get the weave,

#   and add in all file versions

class RepoFetcher(object):

    """Pull revisions and texts from one repository to another.

    last_revision

        if set, try to limit to the data this revision references.

    after running:

    count_copied -- number of revisions copied

    This should not be used directly, it's essential a object to encapsulate

    the logic in InterRepository.fetch().

    """

    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,

        find_ghosts=True):

        """Create a repo fetcher.

        :param find_ghosts: If True search the entire history for ghosts.

        """

        # result variables.

        self.failed_revisions = []

        self.count_copied = 0

        if to_repository.has_same_location(from_repository):

            # repository.fetch should be taking care of this case.

            raise errors.BzrError('RepoFetcher run '

                    'between two objects at the same location: '

                    '%r and %r' % (to_repository, from_repository))

        self.to_repository = to_repository

        self.from_repository = from_repository

        # must not mutate self._last_revision as its potentially a shared instance

        self._last_revision = last_revision

        self.find_ghosts = find_ghosts

        if pb is None:

            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()

            self.nested_pb = self.pb

        else:

            self.pb = pb

            self.nested_pb = None

        self.from_repository.lock_read()

        try:

            self.to_repository.lock_write()

            try:

                self.to_repository.start_write_group()

                try:

                    self.__fetch()

                except:

                    self.to_repository.abort_write_group()

                    raise

                else:

                    self.to_repository.commit_write_group()

            finally:

                if self.nested_pb is not None:

                    self.nested_pb.finished()

                self.to_repository.unlock()

        finally:

            self.from_repository.unlock()

    def __fetch(self):

        """Primary worker function.

        This initialises all the needed variables, and then fetches the 

        requested revisions, finally clearing the progress bar.

        """

        self.to_weaves = self.to_repository.weave_store

        self.from_weaves = self.from_repository.weave_store

        self.count_total = 0

        self.file_ids_names = {}

        pp = ProgressPhase('Transferring', 4, self.pb)

        try:

            pp.next_phase()

            revs = self._revids_to_fetch().get_keys()

            if not revs:

                return

            self._fetch_everything_for_revisions(revs, pp)

        finally:

            self.pb.clear()

    def _fetch_everything_for_revisions(self, revs, pp):

        """Fetch all data for the given set of revisions."""

        # The first phase is "file".  We pass the progress bar for it directly

        # into item_keys_introduced_by, which has more information about how

        # that phase is progressing than we do.  Progress updates for the other

        # phases are taken care of in this function.

        # XXX: there should be a clear owner of the progress reporting.  Perhaps

        # item_keys_introduced_by should have a richer API than it does at the

        # moment, so that it can feed the progress information back to this

        # function?

        phase = 'file'

        pb = bzrlib.ui.ui_factory.nested_progress_bar()

        try:

            data_to_fetch = self.from_repository.item_keys_introduced_by(revs, pb)

            for knit_kind, file_id, revisions in data_to_fetch:

                if knit_kind != phase:

                    phase = knit_kind

                    # Make a new progress bar for this phase

                    pb.finished()

                    pp.next_phase()

                    pb = bzrlib.ui.ui_factory.nested_progress_bar()

                if knit_kind == "file":

                    self._fetch_weave_text(file_id, revisions)

                elif knit_kind == "inventory":

                    # XXX:

                    # Once we've processed all the files, then we generate the root

                    # texts (if necessary), then we process the inventory.  It's a

                    # bit distasteful to have knit_kind == "inventory" mean this,

                    # perhaps it should happen on the first non-"file" knit, in case

                    # it's not always inventory?

                    self._generate_root_texts(revs)

                    self._fetch_inventory_weave(revs, pb)

                elif knit_kind == "signatures":

                    # Nothing to do here; this will be taken care of when

                    # _fetch_revision_texts happens.

                    pass

                elif knit_kind == "revisions":

                    self._fetch_revision_texts(revs, pb)

                else:

                    raise AssertionError("Unknown knit kind %r" % knit_kind)

        finally:

            if pb is not None:

                pb.finished()

        self.count_copied += len(revs)

    def _revids_to_fetch(self):

        """Determines the exact revisions needed from self.from_repository to

        install self._last_revision in self.to_repository.

        If no revisions need to be fetched, then this just returns None.

        """

        mutter('fetch up to rev {%s}', self._last_revision)

        if self._last_revision is NULL_REVISION:

            # explicit limit of no revisions needed

            return SearchResult(set(), set(), 0, set())

        if (self._last_revision is not None and

            self.to_repository.has_revision(self._last_revision)):

            return SearchResult(set(), set(), 0, set())

        try:

            return self.to_repository.search_missing_revision_ids(

                self.from_repository, self._last_revision,

                find_ghosts=self.find_ghosts)

        except errors.NoSuchRevision:

            raise InstallFailed([self._last_revision])

    def _fetch_weave_text(self, file_id, required_versions):

        to_weave = self.to_weaves.get_weave_or_empty(file_id,

            self.to_repository.get_transaction())

        from_weave = self.from_weaves.get_weave(file_id,

            self.from_repository.get_transaction())

        # we fetch all the texts, because texts do

        # not reference anything, and its cheap enough

        to_weave.join(from_weave, version_ids=required_versions)

        # we don't need *all* of this data anymore, but we dont know

        # what we do. This cache clearing will result in a new read 

        # of the knit data when we do the checkout, but probably we

        # want to emit the needed data on the fly rather than at the

        # end anyhow.

        # the from weave should know not to cache data being joined,

        # but its ok to ask it to clear.

        from_weave.clear_cache()

        to_weave.clear_cache()

    def _fetch_inventory_weave(self, revs, pb):

        pb.update("fetch inventory", 0, 2)

        to_weave = self.to_repository.get_inventory_weave()

        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()

        try:

            # just merge, this is optimisable and its means we don't

            # copy unreferenced data such as not-needed inventories.

            pb.update("fetch inventory", 1, 3)

            from_weave = self.from_repository.get_inventory_weave()

            pb.update("fetch inventory", 2, 3)

            # we fetch only the referenced inventories because we do not

            # know for unselected inventories whether all their required

            # texts are present in the other repository - it could be

            # corrupt.

            to_weave.join(from_weave, pb=child_pb, msg='merge inventory',

                          version_ids=revs)

            from_weave.clear_cache()

        finally:

            child_pb.finished()

    def _generate_root_texts(self, revs):

        """This will be called by __fetch between fetching weave texts and

        fetching the inventory weave.

        Subclasses should override this if they need to generate root texts

        after fetching weave texts.

        """

        pass

class GenericRepoFetcher(RepoFetcher):

    """This is a generic repo to repo fetcher.

    This makes minimal assumptions about repo layout and contents.

    It triggers a reconciliation after fetching to ensure integrity.

    """

    def _fetch_revision_texts(self, revs, pb):

        """Fetch revision object texts"""

        to_txn = self.to_transaction = self.to_repository.get_transaction()

        count = 0

        total = len(revs)

        to_store = self.to_repository._revision_store

        for rev in revs:

            pb.update('copying revisions', count, total)

            try:

                sig_text = self.from_repository.get_signature_text(rev)

                to_store.add_revision_signature_text(rev, sig_text, to_txn)

            except errors.NoSuchRevision:

                # not signed.

                pass

            to_store.add_revision(self.from_repository.get_revision(rev),

                                  to_txn)

            count += 1

        # fixup inventory if needed: 

        # this is expensive because we have no inverse index to current ghosts.

        # but on local disk its a few seconds and sftp push is already insane.

        # so we just-do-it.

        # FIXME: repository should inform if this is needed.

        self.to_repository.reconcile()

class KnitRepoFetcher(RepoFetcher):

    """This is a knit format repository specific fetcher.

    This differs from the GenericRepoFetcher by not doing a 

    reconciliation after copying, and using knit joining to

    copy revision texts.

    """

    def _fetch_revision_texts(self, revs, pb):

        # may need to be a InterRevisionStore call here.

        from_transaction = self.from_repository.get_transaction()

        to_transaction = self.to_repository.get_transaction()

        to_sf = self.to_repository._revision_store.get_signature_file(

            to_transaction)

        from_sf = self.from_repository._revision_store.get_signature_file(

            from_transaction)

        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)

        to_rf = self.to_repository._revision_store.get_revision_file(

            to_transaction)

        from_rf = self.from_repository._revision_store.get_revision_file(

            from_transaction)

        to_rf.join(from_rf, version_ids=revs)

class Inter1and2Helper(object):

    """Helper for operations that convert data from model 1 and 2

    This is for use by fetchers and converters.

    """

    def __init__(self, source, target):

        """Constructor.

        :param source: The repository data comes from

        :param target: The repository data goes to

        """

        self.source = source

        self.target = target

    def iter_rev_trees(self, revs):

        """Iterate through RevisionTrees efficiently.

        Additionally, the inventory's revision_id is set if unset.

        Trees are retrieved in batches of 100, and then yielded in the order

        they were requested.

        :param revs: A list of revision ids

        """

        # In case that revs is not a list.

        revs = list(revs)

        while revs:

            for tree in self.source.revision_trees(revs[:100]):

                if tree.inventory.revision_id is None:

                    tree.inventory.revision_id = tree.get_revision_id()

                yield tree

            revs = revs[100:]

    def generate_root_texts(self, revs):

        """Generate VersionedFiles for all root ids.

        :param revs: the revisions to include

        """

        inventory_weave = self.source.get_inventory_weave()

        parent_texts = {}

        versionedfile = {}

        to_store = self.target.weave_store

        for tree in self.iter_rev_trees(revs):

            revision_id = tree.inventory.root.revision

            root_id = tree.get_root_id()

            parents = inventory_weave.get_parents(revision_id)

            if root_id not in versionedfile:

                versionedfile[root_id] = to_store.get_weave_or_empty(root_id, 

                    self.target.get_transaction())

            _, _, parent_texts[root_id] = versionedfile[root_id].add_lines(

                revision_id, parents, [], parent_texts)

    def regenerate_inventory(self, revs):

        """Generate a new inventory versionedfile in target, convertin data.

        The inventory is retrieved from the source, (deserializing it), and

        stored in the target (reserializing it in a different format).

        :param revs: The revisions to include

        """

        for tree in self.iter_rev_trees(revs):

            parents = tree.get_parent_ids()

            self.target.add_inventory(tree.get_revision_id(), tree.inventory,

                                      parents)

class Model1toKnit2Fetcher(GenericRepoFetcher):

    """Fetch from a Model1 repository into a Knit2 repository

    """

    def __init__(self, to_repository, from_repository, last_revision=None,

                 pb=None, find_ghosts=True):

        self.helper = Inter1and2Helper(from_repository, to_repository)

        GenericRepoFetcher.__init__(self, to_repository, from_repository,

            last_revision, pb, find_ghosts)

    def _generate_root_texts(self, revs):

        self.helper.generate_root_texts(revs)

    def _fetch_inventory_weave(self, revs, pb):

        self.helper.regenerate_inventory(revs)

class Knit1to2Fetcher(KnitRepoFetcher):

    """Fetch from a Knit1 repository into a Knit2 repository"""

    def __init__(self, to_repository, from_repository, last_revision=None, 

                 pb=None, find_ghosts=True):

        self.helper = Inter1and2Helper(from_repository, to_repository)

        KnitRepoFetcher.__init__(self, to_repository, from_repository,

            last_revision, pb, find_ghosts)

    def _generate_root_texts(self, revs):

        self.helper.generate_root_texts(revs)

    def _fetch_inventory_weave(self, revs, pb):

        self.helper.regenerate_inventory(revs)

class RemoteToOtherFetcher(GenericRepoFetcher):

    def _fetch_everything_for_revisions(self, revs, pp):

        data_stream = self.from_repository.get_data_stream(revs)

        self.to_repository.insert_data_stream(data_stream)