18
18
import bzrlib.errors
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
21
class RevisionReference(object):
23
Reference to a stored revision.
25
Includes the revision_id and revision_sha1.
29
def __init__(self, revision_id, revision_sha1=None):
30
if revision_id == None \
31
or isinstance(revision_id, basestring):
32
self.revision_id = revision_id
34
raise ValueError('bad revision_id %r' % revision_id)
36
if revision_sha1 != None:
37
if isinstance(revision_sha1, basestring) \
38
and len(revision_sha1) == 40:
39
self.revision_sha1 = revision_sha1
41
raise ValueError('bad revision_sha1 %r' % revision_sha1)
23
45
class Revision(object):
24
46
"""Single revision on a branch.
30
52
After bzr 0.0.5 revisions are allowed to have multiple parents.
33
List of parent revision_ids
55
List of parent revisions, each is a RevisionReference.
36
def __init__(self, revision_id, **args):
37
self.revision_id = revision_id
65
def __init__(self, **args):
38
66
self.__dict__.update(args)
40
self.parent_sha1s = []
42
70
def __repr__(self):
43
71
return "<Revision id %s>" % self.revision_id
45
def __eq__(self, other):
46
if not isinstance(other, Revision):
48
# FIXME: rbc 20050930 parent_ids are not being compared
50
self.inventory_sha1 == other.inventory_sha1
51
and self.revision_id == other.revision_id
52
and self.timestamp == other.timestamp
53
and self.message == other.message
54
and self.timezone == other.timezone
55
and self.committer == other.committer)
57
def __ne__(self, other):
58
return not self.__eq__(other)
75
from bzrlib.xml import Element, SubElement
77
root = Element('revision',
78
committer = self.committer,
79
timestamp = '%.9f' % self.timestamp,
80
revision_id = self.revision_id,
81
inventory_id = self.inventory_id,
82
inventory_sha1 = self.inventory_sha1,
85
root.set('timezone', str(self.timezone))
88
msg = SubElement(root, 'message')
89
msg.text = self.message
93
pelts = SubElement(root, 'parents')
94
pelts.tail = pelts.text = '\n'
95
for rr in self.parents:
96
assert isinstance(rr, RevisionReference)
97
p = SubElement(pelts, 'revision_ref')
100
p.set('revision_id', rr.revision_id)
102
p.set('revision_sha1', rr.revision_sha1)
107
def from_element(cls, elt):
108
return unpack_revision(elt)
110
from_element = classmethod(from_element)
114
def unpack_revision(elt):
115
"""Convert XML element into Revision object."""
116
# <changeset> is deprecated...
117
if elt.tag not in ('revision', 'changeset'):
118
raise bzrlib.errors.BzrError("unexpected tag in revision file: %r" % elt)
120
rev = Revision(committer = elt.get('committer'),
121
timestamp = float(elt.get('timestamp')),
122
revision_id = elt.get('revision_id'),
123
inventory_id = elt.get('inventory_id'),
124
inventory_sha1 = elt.get('inventory_sha1')
127
precursor = elt.get('precursor')
128
precursor_sha1 = elt.get('precursor_sha1')
130
pelts = elt.find('parents')
134
assert p.tag == 'revision_ref', \
135
"bad parent node tag %r" % p.tag
136
rev_ref = RevisionReference(p.get('revision_id'),
137
p.get('revision_sha1'))
138
rev.parents.append(rev_ref)
142
prec_parent = rev.parents[0].revision_id
143
assert prec_parent == precursor
145
# revisions written prior to 0.0.5 have a single precursor
146
# give as an attribute
147
rev_ref = RevisionReference(precursor, precursor_sha1)
148
rev.parents.append(rev_ref)
150
v = elt.get('timezone')
151
rev.timezone = v and int(v)
153
rev.message = elt.findtext('message') # text of <message>
61
158
REVISION_ID_RE = None
63
160
def validate_revision_id(rid):
65
162
global REVISION_ID_RE
66
163
if not REVISION_ID_RE:
68
REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
165
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
70
167
if not REVISION_ID_RE.match(rid):
71
168
raise ValueError("malformed revision-id %r" % rid)
74
def is_ancestor(revision_id, candidate_id, branch):
170
def is_ancestor(revision_id, candidate_id, revision_source):
75
171
"""Return true if candidate_id is an ancestor of revision_id.
77
172
A false negative will be returned if any intermediate descendent of
78
173
candidate_id is not present in any of the revision_sources.
80
175
revisions_source is an object supporting a get_revision operation that
81
176
behaves like Branch's.
83
return candidate_id in branch.get_ancestry(revision_id)
179
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
180
if ancestor_id == candidate_id:
86
184
def iter_ancestors(revision_id, revision_source, only_present=False):
87
185
ancestors = (revision_id,)
161
259
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
162
260
return a_closest[0]
164
def revision_graph(revision, revision_source):
165
"""Produce a graph of the ancestry of the specified revision.
166
Return root, ancestors map, descendants map
168
TODO: Produce graphs with the NULL revision as root, so that we can find
169
a common even when trees are not branches don't represent a single line
176
descendants[revision] = {}
177
while len(lines) > 0:
180
if line == NULL_REVISION:
185
rev = revision_source.get_revision(line)
186
parents = list(rev.parent_ids)
187
if len(parents) == 0:
188
parents = [NULL_REVISION]
189
except bzrlib.errors.NoSuchRevision:
193
if parents is not None:
194
for parent in parents:
195
if parent not in ancestors:
196
new_lines.add(parent)
197
if parent not in descendants:
198
descendants[parent] = {}
199
descendants[parent][line] = 1
200
if parents is not None:
201
ancestors[line] = set(parents)
203
assert root not in descendants[root]
204
assert root not in ancestors[root]
205
return root, ancestors, descendants
208
def combined_graph(revision_a, revision_b, revision_source):
209
"""Produce a combined ancestry graph.
210
Return graph root, ancestors map, descendants map, set of common nodes"""
211
root, ancestors, descendants = revision_graph(revision_a, revision_source)
212
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
215
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
217
for node, node_anc in ancestors_b.iteritems():
218
if node in ancestors:
221
ancestors[node] = set()
222
ancestors[node].update(node_anc)
223
for node, node_dec in descendants_b.iteritems():
224
if node not in descendants:
225
descendants[node] = {}
226
descendants[node].update(node_dec)
227
return root, ancestors, descendants, common
230
def common_ancestor(revision_a, revision_b, revision_source):
232
root, ancestors, descendants, common = \
233
combined_graph(revision_a, revision_b, revision_source)
234
except bzrlib.errors.NoCommonRoot:
235
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
237
distances = node_distances (descendants, ancestors, root)
238
farthest = select_farthest(distances, common)
239
if farthest is None or farthest == NULL_REVISION:
240
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
244
262
class MultipleRevisionSources(object):
245
263
"""Proxy that looks in multiple branches for revisions."""
246
264
def __init__(self, *args):
255
273
except bzrlib.errors.NoSuchRevision, e:
259
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
260
revision_history=None):
261
"""Find the longest line of descent from maybe_ancestor to revision.
262
Revision history is followed where possible.
264
If ancestor_id == rev_id, list will be empty.
265
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
266
If ancestor_id is not an ancestor, NotAncestor will be thrown
268
root, ancestors, descendants = revision_graph(rev_id, rev_source)
269
if len(descendants) == 0:
270
raise NoSuchRevision(rev_source, rev_id)
271
if ancestor_id not in descendants:
272
rev_source.get_revision(ancestor_id)
273
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
274
root_descendants = all_descendants(descendants, ancestor_id)
275
root_descendants.add(ancestor_id)
276
if rev_id not in root_descendants:
277
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
278
distances = node_distances(descendants, ancestors, ancestor_id,
279
root_descendants=root_descendants)
281
def best_ancestor(rev_id):
283
for anc_id in ancestors[rev_id]:
285
distance = distances[anc_id]
288
if revision_history is not None and anc_id in revision_history:
290
elif best is None or distance > best[1]:
291
best = (anc_id, distance)
296
while next != ancestor_id:
298
next = best_ancestor(next)