1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""Make a copy of an entire branch and all its history.
 
 
19
This is the underlying function for the branch/get/clone commands."""
 
 
21
# TODO: This could be done *much* more efficiently by just copying
 
 
22
# all the whole weaves and revisions, rather than getting one
 
 
25
# TODO: Optionally, after copying, discard any irrelevant information from
 
 
26
# the destination, such as revisions committed after the last one we're interested 
 
 
27
# in.  This needs to apply a weave prune operation (not written yet) to each
 
 
30
# Copying must be done in a way that supports http transports, where we
 
 
31
# can't list a directory, and therefore have to rely on information
 
 
32
# retrieved from top-level objects whose names we do know.
 
 
34
# In practice this means we first fetch the revision history and ancestry.
 
 
35
# These give us a list of all the revisions that need to be fetched.  We 
 
 
36
# also get the inventory weave.  We then just need to get a list of all 
 
 
37
# file-ids ever referenced by this tree.  (It might be nice to keep a list
 
 
38
# of them directly.)  This is done by walking over the inventories of all
 
 
39
# copied revisions and accumulating a list of file ids.
 
 
41
# For local branches it is possible to optimize this considerably in two
 
 
42
# ways.  One is to hardlink the files (if possible and requested), rather
 
 
43
# than copying them.  Another is to simply list the directory rather than
 
 
44
# walking through the inventories to find out what files are present -- but
 
 
45
# there it may be better to just be consistent with remote branches.
 
 
51
from bzrlib.merge import build_working_dir
 
 
52
from bzrlib.branch import Branch
 
 
53
from bzrlib.trace import mutter, note
 
 
54
from bzrlib.store import copy_all
 
 
56
def copy_branch(branch_from, to_location, revision=None, basis_branch=None):
 
 
57
    """Copy branch_from into the existing directory to_location.
 
 
59
    Returns the newly created branch object.
 
 
62
        If not None, only revisions up to this point will be copied.
 
 
63
        The head of the new branch will be that revision.  Must be a
 
 
66
    to_location -- The destination directory; must either exist and be 
 
 
67
        empty, or not exist, in which case it is created.
 
 
70
        A local branch to copy revisions from, related to branch_from. 
 
 
71
        This is used when branching from a remote (slow) branch, and we have
 
 
72
        a local branch that might contain some relevant revisions.
 
 
74
    assert isinstance(branch_from, Branch)
 
 
75
    assert isinstance(to_location, basestring)
 
 
76
    if basis_branch is not None:
 
 
77
        note("basis_branch is not supported for fast weave copy yet.")
 
 
78
    if not (branch_from.weave_store.listable()
 
 
79
            and branch_from.revision_store.listable()):
 
 
80
        return copy_branch_slower(branch_from, to_location, revision,
 
 
82
    history = _get_truncated_history(branch_from, revision)
 
 
83
    if not bzrlib.osutils.lexists(to_location):
 
 
85
    branch_to = Branch.initialize(to_location)
 
 
86
    mutter("copy branch from %s to %s", branch_from, branch_to)
 
 
87
    branch_to.set_root_id(branch_from.get_root_id())
 
 
88
    branch_to.append_revision(*history)
 
 
89
    _copy_control_weaves(branch_from, branch_to)
 
 
90
    _copy_text_weaves(branch_from, branch_to)
 
 
91
    _copy_revision_store(branch_from, branch_to)
 
 
92
    build_working_dir(to_location)
 
 
93
    branch_to.set_parent(branch_from.base)
 
 
98
def _get_truncated_history(branch_from, revision):
 
 
99
    history = branch_from.revision_history()
 
 
103
        idx = history.index(revision)
 
 
105
        raise InvalidRevisionId('revision {%s} is not on the mainline of %s' 
 
 
106
                                % (revision, branch_from))
 
 
107
    return history[:idx+1]
 
 
109
def _copy_text_weaves(branch_from, branch_to):
 
 
110
    copy_all(branch_from.weave_store, branch_to.weave_store)
 
 
113
def _copy_revision_store(branch_from, branch_to):
 
 
114
    copy_all(branch_from.revision_store, branch_to.revision_store)
 
 
117
def _copy_control_weaves(branch_from, branch_to):
 
 
118
    to_control = branch_to.control_weaves
 
 
119
    from_control = branch_from.control_weaves
 
 
120
    to_control.copy_multi(from_control, ['inventory', 'ancestry'])
 
 
123
def copy_branch_slower(branch_from, to_location, revision=None, basis_branch=None):
 
 
124
    """Copy branch_from into the existing directory to_location.
 
 
127
        If not None, only revisions up to this point will be copied.
 
 
128
        The head of the new branch will be that revision.  Must be a
 
 
131
    to_location -- The destination directory; must either exist and be 
 
 
132
        empty, or not exist, in which case it is created.
 
 
135
        The revision to copy up to
 
 
138
        A local branch to copy revisions from, related to branch_from. 
 
 
139
        This is used when branching from a remote (slow) branch, and we have
 
 
140
        a local branch that might contain some relevant revisions.
 
 
142
    assert isinstance(branch_from, Branch)
 
 
143
    assert isinstance(to_location, basestring)
 
 
144
    if not bzrlib.osutils.lexists(to_location):
 
 
145
        os.mkdir(to_location)
 
 
146
    br_to = Branch.initialize(to_location)
 
 
147
    mutter("copy branch from %s to %s", branch_from, br_to)
 
 
148
    if basis_branch is not None:
 
 
149
        basis_branch.push_stores(br_to)
 
 
150
    br_to.set_root_id(branch_from.get_root_id())
 
 
152
        revision = branch_from.last_revision()
 
 
153
    br_to.update_revisions(branch_from, stop_revision=revision)
 
 
154
    build_working_dir(to_location)
 
 
155
    br_to.set_parent(branch_from.base)