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
# 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.
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
22
from bzrlib.osutils import contains_whitespace
26
class Revision(object):
27
"""Single revision on a branch.
29
Revisions may know their revision_hash, but only once they've been
30
written out. This is not stored because you cannot write the hash
31
into the file it describes.
33
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.
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 = []
50
self.__dict__.update(args)
53
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" %
81
def get_history(self, repository):
82
"""Return the canonical line-of-history for this revision.
84
If ghosts are present this may differ in result from a ghost-free
87
current_revision = self
89
while current_revision is not None:
90
reversed_result.append(current_revision.revision_id)
91
if not len (current_revision.parent_ids):
92
reversed_result.append(None)
93
current_revision = None
95
next_revision_id = current_revision.parent_ids[0]
96
current_revision = repository.get_revision(next_revision_id)
97
reversed_result.reverse()
98
return reversed_result
101
def is_ancestor(revision_id, candidate_id, branch):
102
"""Return true if candidate_id is an ancestor of revision_id.
104
A false negative will be returned if any intermediate descendent of
105
candidate_id is not present in any of the revision_sources.
107
revisions_source is an object supporting a get_revision operation that
108
behaves like Branch's.
110
return candidate_id in branch.repository.get_ancestry(revision_id)
113
def iter_ancestors(revision_id, revision_source, only_present=False):
114
ancestors = (revision_id,)
116
while len(ancestors) > 0:
118
for ancestor in ancestors:
120
yield ancestor, distance
122
revision = revision_source.get_revision(ancestor)
123
except bzrlib.errors.NoSuchRevision, e:
124
if e.revision == revision_id:
129
yield ancestor, distance
130
new_ancestors.extend(revision.parent_ids)
131
ancestors = new_ancestors
135
def find_present_ancestors(revision_id, revision_source):
136
"""Return the ancestors of a revision present in a branch.
138
It's possible that a branch won't have the complete ancestry of
139
one of its revisions.
143
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
145
for anc_order, (anc_id, anc_distance) in anc_iter:
146
if not found_ancestors.has_key(anc_id):
147
found_ancestors[anc_id] = (anc_order, anc_distance)
148
return found_ancestors
151
def __get_closest(intersection):
154
for entry in intersection:
155
if entry[0] == intersection[0][0]:
156
matches.append(entry[2])
160
def old_common_ancestor(revision_a, revision_b, revision_source):
161
"""Find the ancestor common to both revisions that is closest to both.
163
from bzrlib.trace import mutter
164
a_ancestors = find_present_ancestors(revision_a, revision_source)
165
b_ancestors = find_present_ancestors(revision_b, revision_source)
168
# a_order is used as a tie-breaker when two equally-good bases are found
169
for revision, (a_order, a_distance) in a_ancestors.iteritems():
170
if b_ancestors.has_key(revision):
171
a_intersection.append((a_distance, a_order, revision))
172
b_intersection.append((b_ancestors[revision][1], a_order, revision))
173
mutter("a intersection: %r", a_intersection)
174
mutter("b intersection: %r", b_intersection)
176
a_closest = __get_closest(a_intersection)
177
if len(a_closest) == 0:
179
b_closest = __get_closest(b_intersection)
180
assert len(b_closest) != 0
181
mutter ("a_closest %r", a_closest)
182
mutter ("b_closest %r", b_closest)
183
if a_closest[0] in b_closest:
185
elif b_closest[0] in a_closest:
188
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
191
def revision_graph(revision, revision_source):
192
"""Produce a graph of the ancestry of the specified revision.
193
Return root, ancestors map, descendants map
195
TODO: Produce graphs with the NULL revision as root, so that we can find
196
a common even when trees are not branches don't represent a single line
198
RBC: 20051024: note that when we have two partial histories, this may not
199
be possible. But if we are willing to pretend :)... sure.
205
descendants[revision] = {}
206
while len(lines) > 0:
209
if line == NULL_REVISION:
214
rev = revision_source.get_revision(line)
215
parents = list(rev.parent_ids)
216
if len(parents) == 0:
217
parents = [NULL_REVISION]
218
except bzrlib.errors.NoSuchRevision:
222
if parents is not None:
223
for parent in parents:
224
if parent not in ancestors:
225
new_lines.add(parent)
226
if parent not in descendants:
227
descendants[parent] = {}
228
descendants[parent][line] = 1
229
if parents is not None:
230
ancestors[line] = set(parents)
233
# The history for revision becomes inaccessible without
234
# actually hitting a no-parents revision. This then
235
# makes these asserts below trigger. So, if root is None
236
# determine the actual root by walking the accessible tree
237
# and then stash NULL_REVISION at the end.
239
descendants[root] = {}
240
# for every revision, check we can access at least
241
# one parent, if we cant, add NULL_REVISION and
243
for rev in ancestors:
244
if len(ancestors[rev]) == 0:
245
raise RuntimeError('unreachable code ?!')
247
for parent in ancestors[rev]:
248
if parent in ancestors:
252
descendants[root][rev] = 1
253
ancestors[rev].add(root)
254
ancestors[root] = set()
255
assert root not in descendants[root]
256
assert root not in ancestors[root]
257
return root, ancestors, descendants
260
def combined_graph(revision_a, revision_b, revision_source):
261
"""Produce a combined ancestry graph.
262
Return graph root, ancestors map, descendants map, set of common nodes"""
263
root, ancestors, descendants = revision_graph(revision_a, revision_source)
264
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
267
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
269
for node, node_anc in ancestors_b.iteritems():
270
if node in ancestors:
273
ancestors[node] = set()
274
ancestors[node].update(node_anc)
275
for node, node_dec in descendants_b.iteritems():
276
if node not in descendants:
277
descendants[node] = {}
278
descendants[node].update(node_dec)
279
return root, ancestors, descendants, common
282
def common_ancestor(revision_a, revision_b, revision_source):
284
root, ancestors, descendants, common = \
285
combined_graph(revision_a, revision_b, revision_source)
286
except bzrlib.errors.NoCommonRoot:
287
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
289
distances = node_distances (descendants, ancestors, root)
290
farthest = select_farthest(distances, common)
291
if farthest is None or farthest == NULL_REVISION:
292
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
296
class MultipleRevisionSources(object):
297
"""Proxy that looks in multiple branches for revisions."""
298
def __init__(self, *args):
299
object.__init__(self)
300
assert len(args) != 0
301
self._revision_sources = args
303
def get_revision(self, revision_id):
304
for source in self._revision_sources:
306
return source.get_revision(revision_id)
307
except bzrlib.errors.NoSuchRevision, e:
311
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
312
revision_history=None):
313
"""Find the longest line of descent from maybe_ancestor to revision.
314
Revision history is followed where possible.
316
If ancestor_id == rev_id, list will be empty.
317
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
318
If ancestor_id is not an ancestor, NotAncestor will be thrown
320
root, ancestors, descendants = revision_graph(rev_id, rev_source)
321
if len(descendants) == 0:
322
raise NoSuchRevision(rev_source, rev_id)
323
if ancestor_id not in descendants:
324
rev_source.get_revision(ancestor_id)
325
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
326
root_descendants = all_descendants(descendants, ancestor_id)
327
root_descendants.add(ancestor_id)
328
if rev_id not in root_descendants:
329
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
330
distances = node_distances(descendants, ancestors, ancestor_id,
331
root_descendants=root_descendants)
333
def best_ancestor(rev_id):
335
for anc_id in ancestors[rev_id]:
337
distance = distances[anc_id]
340
if revision_history is not None and anc_id in revision_history:
342
elif best is None or distance > best[1]:
343
best = (anc_id, distance)
348
while next != ancestor_id:
350
next = best_ancestor(next)
added
removed
bzrlib/revision.py
