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()
65
def __init__(self, **args):
48
66
self.__dict__.update(args)
50
self.parent_sha1s = []
52
70
def __repr__(self):
53
71
return "<Revision id %s>" % self.revision_id
55
73
def __eq__(self, other):
56
74
if not isinstance(other, Revision):
58
# FIXME: rbc 20050930 parent_ids are not being compared
60
self.inventory_sha1 == other.inventory_sha1
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
61
78
and self.revision_id == other.revision_id
62
79
and self.timestamp == other.timestamp
63
80
and self.message == other.message
64
81
and self.timezone == other.timezone
65
and self.committer == other.committer
66
and self.properties == other.properties)
82
and self.committer == other.committer)
68
84
def __ne__(self, other):
69
85
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):
91
def validate_revision_id(rid):
92
"""Check rid is syntactically valid for a revision id."""
94
if not REVISION_ID_RE:
96
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
98
if not REVISION_ID_RE.match(rid):
99
raise ValueError("malformed revision-id %r" % rid)
101
def is_ancestor(revision_id, candidate_id, revision_source):
83
102
"""Return true if candidate_id is an ancestor of revision_id.
85
103
A false negative will be returned if any intermediate descendent of
86
104
candidate_id is not present in any of the revision_sources.
88
106
revisions_source is an object supporting a get_revision operation that
89
107
behaves like Branch's.
91
return candidate_id in branch.get_ancestry(revision_id)
110
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
if ancestor_id == candidate_id:
94
115
def iter_ancestors(revision_id, revision_source, only_present=False):
95
116
ancestors = (revision_id,)
169
190
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
170
191
return a_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
193
class MultipleRevisionSources(object):
278
194
"""Proxy that looks in multiple branches for revisions."""
279
195
def __init__(self, *args):
298
214
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
299
215
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)
217
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
218
if ancestor_id == rev_id:
220
def historical_lines(line):
221
"""Return a tuple of historical/non_historical lines, for sorting.
222
The non_historical count is negative, since non_historical lines are
227
for revision in line:
228
if revision in revision_history:
232
return good_count, bad_count
234
successful_lines = []
235
while len(active) > 0:
238
parent_ids = [p.revision_id for p in
239
rev_source.get_revision(line[-1]).parents]
240
for parent in parent_ids:
242
if parent == ancestor_id:
243
successful_lines.append(line_copy)
245
line_copy.append(parent)
246
new_active.append(line_copy)
248
if len(successful_lines) == 0:
249
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
250
for line in successful_lines:
252
if revision_history is not None:
253
by_historical_lines = []
254
for line in successful_lines:
255
count = historical_lines(line)
256
by_historical_lines.append((count, line))
257
by_historical_lines.sort()
258
if by_historical_lines[-1][0][0] > 0:
259
return by_historical_lines[-1][1]
260
assert len(successful_lines)
261
successful_lines.sort(cmp, len)
262
return successful_lines[-1]
added
removed
bzrlib/revision.py
