14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Some kind of command-line display of revision properties:
18
# perhaps show them in log -v and allow them as options to the commit command.
20
18
import bzrlib.errors
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
22
from bzrlib.osutils import contains_whitespace
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)
26
45
class Revision(object):
27
46
"""Single revision on a branch.
33
52
After bzr 0.0.5 revisions are allowed to have multiple parents.
36
List of parent revision_ids
39
Dictionary of revision properties. These are attached to the
40
revision as extra metadata. The name must be a single
41
word; the value can be an arbitrary string.
55
List of parent revisions, each is a RevisionReference.
44
def __init__(self, revision_id, properties=None, **args):
45
self.revision_id = revision_id
46
self.properties = properties or {}
47
self._check_properties()
49
self.parent_sha1s = []
65
def __init__(self, **args):
50
66
self.__dict__.update(args)
52
70
def __repr__(self):
53
71
return "<Revision id %s>" % self.revision_id
55
def __eq__(self, other):
56
if not isinstance(other, Revision):
58
# FIXME: rbc 20050930 parent_ids are not being compared
60
self.inventory_sha1 == other.inventory_sha1
61
and self.revision_id == other.revision_id
62
and self.timestamp == other.timestamp
63
and self.message == other.message
64
and self.timezone == other.timezone
65
and self.committer == other.committer
66
and self.properties == other.properties)
68
def __ne__(self, other):
69
return not self.__eq__(other)
71
def _check_properties(self):
72
"""Verify that all revision properties are OK.
74
for name, value in self.properties.iteritems():
75
if not isinstance(name, basestring) or contains_whitespace(name):
76
raise ValueError("invalid property name %r" % name)
77
if not isinstance(value, basestring):
78
raise ValueError("invalid property value %r for %r" %
82
def is_ancestor(revision_id, candidate_id, branch):
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>
158
REVISION_ID_RE = None
160
def validate_revision_id(rid):
161
"""Check rid is syntactically valid for a revision id."""
162
global REVISION_ID_RE
163
if not REVISION_ID_RE:
165
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
167
if not REVISION_ID_RE.match(rid):
168
raise ValueError("malformed revision-id %r" % rid)
170
def is_ancestor(revision_id, candidate_id, revision_source):
83
171
"""Return true if candidate_id is an ancestor of revision_id.
85
172
A false negative will be returned if any intermediate descendent of
86
173
candidate_id is not present in any of the revision_sources.
88
175
revisions_source is an object supporting a get_revision operation that
89
176
behaves like Branch's.
91
return candidate_id in branch.get_ancestry(revision_id)
94
def iter_ancestors(revision_id, revision_source, only_present=False):
95
179
ancestors = (revision_id,)
97
180
while len(ancestors) > 0:
98
181
new_ancestors = []
99
182
for ancestor in ancestors:
101
yield ancestor, distance
183
if ancestor == candidate_id:
103
186
revision = revision_source.get_revision(ancestor)
104
187
except bzrlib.errors.NoSuchRevision, e:
110
yield ancestor, distance
111
new_ancestors.extend(revision.parent_ids)
192
new_ancestors.extend([p.revision_id for p in revision.parents])
112
193
ancestors = new_ancestors
116
def find_present_ancestors(revision_id, revision_source):
117
"""Return the ancestors of a revision present in a branch.
119
It's possible that a branch won't have the complete ancestry of
120
one of its revisions.
124
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
126
for anc_order, (anc_id, anc_distance) in anc_iter:
127
if not found_ancestors.has_key(anc_id):
128
found_ancestors[anc_id] = (anc_order, anc_distance)
129
return found_ancestors
132
def __get_closest(intersection):
135
for entry in intersection:
136
if entry[0] == intersection[0][0]:
137
matches.append(entry[2])
141
def old_common_ancestor(revision_a, revision_b, revision_source):
142
"""Find the ancestor common to both revisions that is closest to both.
144
from bzrlib.trace import mutter
145
a_ancestors = find_present_ancestors(revision_a, revision_source)
146
b_ancestors = find_present_ancestors(revision_b, revision_source)
149
# a_order is used as a tie-breaker when two equally-good bases are found
150
for revision, (a_order, a_distance) in a_ancestors.iteritems():
151
if b_ancestors.has_key(revision):
152
a_intersection.append((a_distance, a_order, revision))
153
b_intersection.append((b_ancestors[revision][1], a_order, revision))
154
mutter("a intersection: %r", a_intersection)
155
mutter("b intersection: %r", b_intersection)
157
a_closest = __get_closest(a_intersection)
158
if len(a_closest) == 0:
160
b_closest = __get_closest(b_intersection)
161
assert len(b_closest) != 0
162
mutter ("a_closest %r", a_closest)
163
mutter ("b_closest %r", b_closest)
164
if a_closest[0] in b_closest:
166
elif b_closest[0] in a_closest:
169
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
172
def revision_graph(revision, revision_source):
173
"""Produce a graph of the ancestry of the specified revision.
174
Return root, ancestors map, descendants map
176
TODO: Produce graphs with the NULL revision as root, so that we can find
177
a common even when trees are not branches don't represent a single line
179
RBC: 20051024: note that when we have two partial histories, this may not
180
be possible. But if we are willing to pretend :)... sure.
186
descendants[revision] = {}
187
while len(lines) > 0:
190
if line == NULL_REVISION:
195
rev = revision_source.get_revision(line)
196
parents = list(rev.parent_ids)
197
if len(parents) == 0:
198
parents = [NULL_REVISION]
199
except bzrlib.errors.NoSuchRevision:
203
if parents is not None:
204
for parent in parents:
205
if parent not in ancestors:
206
new_lines.add(parent)
207
if parent not in descendants:
208
descendants[parent] = {}
209
descendants[parent][line] = 1
210
if parents is not None:
211
ancestors[line] = set(parents)
214
# The history for revision becomes inaccessible without
215
# actually hitting a no-parents revision. This then
216
# makes these asserts below trigger. So, if root is None
217
# determine the actual root by walking the accessible tree
218
# and then stash NULL_REVISION at the end.
220
descendants[root] = {}
221
# for every revision, check we can access at least
222
# one parent, if we cant, add NULL_REVISION and
224
for rev in ancestors:
225
if len(ancestors[rev]) == 0:
226
raise RuntimeError('unreachable code ?!')
228
for parent in ancestors[rev]:
229
if parent in ancestors:
233
descendants[root][rev] = 1
234
ancestors[rev].add(root)
235
ancestors[root] = set()
236
assert root not in descendants[root]
237
assert root not in ancestors[root]
238
return root, ancestors, descendants
241
def combined_graph(revision_a, revision_b, revision_source):
242
"""Produce a combined ancestry graph.
243
Return graph root, ancestors map, descendants map, set of common nodes"""
244
root, ancestors, descendants = revision_graph(revision_a, revision_source)
245
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
248
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
250
for node, node_anc in ancestors_b.iteritems():
251
if node in ancestors:
254
ancestors[node] = set()
255
ancestors[node].update(node_anc)
256
for node, node_dec in descendants_b.iteritems():
257
if node not in descendants:
258
descendants[node] = {}
259
descendants[node].update(node_dec)
260
return root, ancestors, descendants, common
263
def common_ancestor(revision_a, revision_b, revision_source):
265
root, ancestors, descendants, common = \
266
combined_graph(revision_a, revision_b, revision_source)
267
except bzrlib.errors.NoCommonRoot:
268
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
270
distances = node_distances (descendants, ancestors, root)
271
farthest = select_farthest(distances, common)
272
if farthest is None or farthest == NULL_REVISION:
273
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
277
196
class MultipleRevisionSources(object):
278
"""Proxy that looks in multiple branches for revisions."""
279
197
def __init__(self, *args):
280
198
object.__init__(self)
281
199
assert len(args) != 0
288
206
except bzrlib.errors.NoSuchRevision, e:
292
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
293
revision_history=None):
294
"""Find the longest line of descent from maybe_ancestor to revision.
295
Revision history is followed where possible.
297
If ancestor_id == rev_id, list will be empty.
298
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
299
If ancestor_id is not an ancestor, NotAncestor will be thrown
301
root, ancestors, descendants = revision_graph(rev_id, rev_source)
302
if len(descendants) == 0:
303
raise NoSuchRevision(rev_source, rev_id)
304
if ancestor_id not in descendants:
305
rev_source.get_revision(ancestor_id)
306
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
307
root_descendants = all_descendants(descendants, ancestor_id)
308
root_descendants.add(ancestor_id)
309
if rev_id not in root_descendants:
310
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
311
distances = node_distances(descendants, ancestors, ancestor_id,
312
root_descendants=root_descendants)
314
def best_ancestor(rev_id):
316
for anc_id in ancestors[rev_id]:
318
distance = distances[anc_id]
321
if revision_history is not None and anc_id in revision_history:
323
elif best is None or distance > best[1]:
324
best = (anc_id, distance)
329
while next != ancestor_id:
331
next = best_ancestor(next)
added
removed
bzrlib/revision.py
