1
# Copyright (C) 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
18
from cStringIO import StringIO
21
from bzrlib.trace import mutter, note, warning
22
from bzrlib.branch import Branch
23
from bzrlib.progress import ProgressBar
24
from bzrlib.xml5 import serializer_v5
25
from bzrlib.osutils import sha_string, split_lines
26
from bzrlib.errors import InstallFailed, NoSuchRevision, WeaveError
28
"""Copying of history from one branch to another.
30
The basic plan is that every branch knows the history of everything
31
that has merged into it. As the first step of a merge, pull, or
32
branch operation we copy history from the source into the destination
35
The copying is done in a slightly complicated order. We don't want to
36
add a revision to the store until everything it refers to is also
37
stored, so that if a revision is present we can totally recreate it.
38
However, we can't know what files are included in a revision until we
39
read its inventory. Therefore, we first pull the XML and hold it in
40
memory until we've updated all of the files referenced.
43
# TODO: Avoid repeatedly opening weaves so many times.
45
# XXX: This doesn't handle ghost (not present in branch) revisions at
46
# all yet. I'm not sure they really should be supported.
48
# NOTE: This doesn't copy revisions which may be present but not
49
# merged into the last revision. I'm not sure we want to do that.
51
# - get a list of revisions that need to be pulled in
52
# - for each one, pull in that revision file
53
# and get the inventory, and store the inventory with right
55
# - and get the ancestry, and store that with right parents too
56
# - and keep a note of all file ids and version seen
57
# - then go through all files; for each one get the weave,
58
# and add in all file versions
62
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
63
f = Fetcher(to_branch, from_branch, revision, pb)
64
return f.count_copied, f.failed_revisions
68
class Fetcher(object):
69
"""Pull revisions and texts from one branch to another.
71
This doesn't update the destination's history; that can be done
72
separately if desired.
75
If set, pull only up to this revision_id.
79
last_revision -- if last_revision
80
is given it will be that, otherwise the last revision of
83
count_copied -- number of revisions copied
85
count_texts -- number of file texts copied
87
def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
88
self.to_branch = to_branch
89
self.to_weaves = to_branch.weave_store
90
self.to_control = to_branch.control_weaves
91
self.from_branch = from_branch
92
self.from_weaves = from_branch.weave_store
93
self.from_control = from_branch.control_weaves
94
self.failed_revisions = []
99
self.pb = bzrlib.ui.ui_factory.progress_bar()
103
self.last_revision = self._find_last_revision(last_revision)
104
except NoSuchRevision, e:
105
mutter('failed getting last revision: %s', e)
106
raise InstallFailed([last_revision])
107
mutter('fetch up to rev {%s}', self.last_revision)
109
revs_to_fetch = self._compare_ancestries()
111
raise InstallFailed([self.last_revision])
112
self._copy_revisions(revs_to_fetch)
113
self.new_ancestry = revs_to_fetch
116
def _find_last_revision(self, last_revision):
117
"""Find the limiting source revision.
119
Every ancestor of that revision will be merged across.
121
Returns the revision_id, or returns None if there's no history
122
in the source branch."""
123
self.pb.update('get source history')
124
from_history = self.from_branch.revision_history()
125
self.pb.update('get destination history')
127
self.from_branch.get_revision(last_revision)
130
return from_history[-1]
132
return None # no history in the source branch
135
def _compare_ancestries(self):
136
"""Get a list of revisions that must be copied.
138
That is, every revision that's in the ancestry of the source
139
branch and not in the destination branch."""
140
self.pb.update('get source ancestry')
141
self.from_ancestry = self.from_branch.get_ancestry(self.last_revision)
143
dest_last_rev = self.to_branch.last_revision()
144
self.pb.update('get destination ancestry')
146
dest_ancestry = self.to_branch.get_ancestry(dest_last_rev)
149
ss = set(dest_ancestry)
151
for rev_id in self.from_ancestry:
153
to_fetch.append(rev_id)
154
mutter('need to get revision {%s}', rev_id)
155
mutter('need to get %d revisions in total', len(to_fetch))
156
self.count_total = len(to_fetch)
159
def _copy_revisions(self, revs_to_fetch):
161
for rev_id in revs_to_fetch:
165
if self.to_branch.has_revision(rev_id):
167
self.pb.update('fetch revision', i, self.count_total)
168
self._copy_one_revision(rev_id)
169
self.count_copied += 1
172
def _copy_one_revision(self, rev_id):
173
"""Copy revision and everything referenced by it."""
174
mutter('copying revision {%s}', rev_id)
175
rev_xml = self.from_branch.get_revision_xml(rev_id)
176
inv_xml = self.from_branch.get_inventory_xml(rev_id)
177
rev = serializer_v5.read_revision_from_string(rev_xml)
178
inv = serializer_v5.read_inventory_from_string(inv_xml)
179
assert rev.revision_id == rev_id
180
assert rev.inventory_sha1 == sha_string(inv_xml)
181
mutter(' commiter %s, %d parents',
184
self._copy_new_texts(rev_id, inv)
185
self._copy_inventory(rev_id, inv_xml, rev.parent_ids)
186
self._copy_ancestry(rev_id, rev.parent_ids)
187
self.to_branch.revision_store.add(StringIO(rev_xml), rev_id)
190
def _copy_inventory(self, rev_id, inv_xml, parent_ids):
191
self.to_control.add_text('inventory', rev_id,
192
split_lines(inv_xml), parent_ids)
195
def _copy_ancestry(self, rev_id, parent_ids):
196
ancestry_lines = self.from_control.get_lines('ancestry', rev_id)
197
self.to_control.add_text('ancestry', rev_id, ancestry_lines,
201
def _copy_new_texts(self, rev_id, inv):
202
"""Copy any new texts occuring in this revision."""
203
# TODO: Rather than writing out weaves every time, hold them
204
# in memory until everything's done? But this way is nicer
205
# if it's interrupted.
206
for path, ie in inv.iter_entries():
207
if ie.kind != 'file':
209
if ie.text_version != rev_id:
211
mutter('%s {%s} is changed in this revision',
213
self._copy_one_text(rev_id, ie.file_id)
216
def _copy_one_text(self, rev_id, file_id):
217
"""Copy one file text."""
218
mutter('copy text version {%s} of file {%s}',
220
from_weave = self.from_weaves.get_weave(file_id)
221
from_idx = from_weave.lookup(rev_id)
222
from_parents = map(from_weave.idx_to_name, from_weave.parents(from_idx))
223
text_lines = from_weave.get(from_idx)
224
to_weave = self.to_weaves.get_weave_or_empty(file_id)
225
to_parents = map(to_weave.lookup, from_parents)
226
# it's ok to add even if the text is already there
227
to_weave.add(rev_id, to_parents, text_lines)
228
self.to_weaves.put_weave(file_id, to_weave)
229
self.count_texts += 1