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.
18
21
import bzrlib.errors
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)
22
import bzrlib.errors as errors
23
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
24
from bzrlib.osutils import contains_whitespace
25
from bzrlib.progress import DummyProgress
26
from bzrlib.symbol_versioning import *
45
30
class Revision(object):
46
31
"""Single revision on a branch.
73
59
def __eq__(self, other):
74
60
if not isinstance(other, Revision):
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
62
# FIXME: rbc 20050930 parent_ids are not being compared
64
self.inventory_sha1 == other.inventory_sha1
78
65
and self.revision_id == other.revision_id
79
66
and self.timestamp == other.timestamp
80
67
and self.message == other.message
81
68
and self.timezone == other.timezone
82
and self.committer == other.committer)
69
and self.committer == other.committer
70
and self.properties == other.properties)
84
72
def __ne__(self, other):
85
73
return not self.__eq__(other)
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):
75
def _check_properties(self):
76
"""Verify that all revision properties are OK.
78
for name, value in self.properties.iteritems():
79
if not isinstance(name, basestring) or contains_whitespace(name):
80
raise ValueError("invalid property name %r" % name)
81
if not isinstance(value, basestring):
82
raise ValueError("invalid property value %r for %r" %
85
def get_history(self, repository):
86
"""Return the canonical line-of-history for this revision.
88
If ghosts are present this may differ in result from a ghost-free
91
current_revision = self
93
while current_revision is not None:
94
reversed_result.append(current_revision.revision_id)
95
if not len (current_revision.parent_ids):
96
reversed_result.append(None)
97
current_revision = None
99
next_revision_id = current_revision.parent_ids[0]
100
current_revision = repository.get_revision(next_revision_id)
101
reversed_result.reverse()
102
return reversed_result
104
def get_summary(self):
105
"""Get the first line of the log message for this revision.
107
return self.message.split('\n', 1)[0]
110
def is_ancestor(revision_id, candidate_id, branch):
102
111
"""Return true if candidate_id is an ancestor of revision_id.
103
113
A false negative will be returned if any intermediate descendent of
104
114
candidate_id is not present in any of the revision_sources.
106
116
revisions_source is an object supporting a get_revision operation that
107
117
behaves like Branch's.
119
return candidate_id in branch.repository.get_ancestry(revision_id)
110
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
if ancestor_id == candidate_id:
115
122
def iter_ancestors(revision_id, revision_source, only_present=False):
116
123
ancestors = (revision_id,)
162
def common_ancestor(revision_a, revision_b, revision_source):
163
"""Find the ancestor common to both revisions that is closest to both.
169
def revision_graph(revision, revision_source):
170
"""Produce a graph of the ancestry of the specified revision.
172
:return: root, ancestors map, descendants map
165
from bzrlib.trace import mutter
166
a_ancestors = find_present_ancestors(revision_a, revision_source)
167
b_ancestors = find_present_ancestors(revision_b, revision_source)
170
# a_order is used as a tie-breaker when two equally-good bases are found
171
for revision, (a_order, a_distance) in a_ancestors.iteritems():
172
if b_ancestors.has_key(revision):
173
a_intersection.append((a_distance, a_order, revision))
174
b_intersection.append((b_ancestors[revision][1], a_order, revision))
175
mutter("a intersection: %r" % a_intersection)
176
mutter("b intersection: %r" % b_intersection)
178
a_closest = __get_closest(a_intersection)
179
if len(a_closest) == 0:
174
revision_source.lock_read()
176
return _revision_graph(revision, revision_source)
178
revision_source.unlock()
181
def _revision_graph(revision, revision_source):
182
"""See revision_graph."""
183
from bzrlib.tsort import topo_sort
184
graph = revision_source.get_revision_graph(revision)
185
# mark all no-parent revisions as being NULL_REVISION parentage.
186
for node, parents in graph.items():
187
if len(parents) == 0:
188
graph[node] = [NULL_REVISION]
189
# add NULL_REVISION to the graph
190
graph[NULL_REVISION] = []
192
# pick a root. If there are multiple roots
193
# this could pick a random one.
194
topo_order = topo_sort(graph.items())
200
# map the descendants of the graph.
201
# and setup our set based return graph.
202
for node in graph.keys():
203
descendants[node] = {}
204
for node, parents in graph.items():
205
for parent in parents:
206
descendants[parent][node] = 1
207
ancestors[node] = set(parents)
209
assert root not in descendants[root]
210
assert root not in ancestors[root]
211
return root, ancestors, descendants
214
def combined_graph(revision_a, revision_b, revision_source):
215
"""Produce a combined ancestry graph.
216
Return graph root, ancestors map, descendants map, set of common nodes"""
217
root, ancestors, descendants = revision_graph(
218
revision_a, revision_source)
219
root_b, ancestors_b, descendants_b = revision_graph(
220
revision_b, revision_source)
222
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
224
for node, node_anc in ancestors_b.iteritems():
225
if node in ancestors:
228
ancestors[node] = set()
229
ancestors[node].update(node_anc)
230
for node, node_dec in descendants_b.iteritems():
231
if node not in descendants:
232
descendants[node] = {}
233
descendants[node].update(node_dec)
234
return root, ancestors, descendants, common
237
def common_ancestor(revision_a, revision_b, revision_source,
239
if None in (revision_a, revision_b):
181
b_closest = __get_closest(b_intersection)
182
assert len(b_closest) != 0
183
mutter ("a_closest %r" % a_closest)
184
mutter ("b_closest %r" % b_closest)
185
if a_closest[0] in b_closest:
187
elif b_closest[0] in a_closest:
190
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
241
# trivial optimisation
242
if revision_a == revision_b:
246
pb.update('Picking ancestor', 1, 3)
247
graph = revision_source.get_revision_graph_with_ghosts(
248
[revision_a, revision_b])
249
# convert to a NULL_REVISION based graph.
250
ancestors = graph.get_ancestors()
251
descendants = graph.get_descendants()
252
common = set(graph.get_ancestry(revision_a)).intersection(
253
set(graph.get_ancestry(revision_b)))
254
descendants[NULL_REVISION] = {}
255
ancestors[NULL_REVISION] = []
256
for root in graph.roots:
257
descendants[NULL_REVISION][root] = 1
258
ancestors[root].append(NULL_REVISION)
259
for ghost in graph.ghosts:
260
# ghosts act as roots for the purpose of finding
261
# the longest paths from the root: any ghost *might*
262
# be directly attached to the root, so we treat them
264
# ghost now descends from NULL
265
descendants[NULL_REVISION][ghost] = 1
266
# that is it has an ancestor of NULL
267
ancestors[ghost] = [NULL_REVISION]
268
# ghost is common if any of ghosts descendants are common:
269
for ghost_descendant in descendants[ghost]:
270
if ghost_descendant in common:
274
common.add(NULL_REVISION)
275
except bzrlib.errors.NoCommonRoot:
276
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
278
pb.update('Picking ancestor', 2, 3)
279
distances = node_distances (descendants, ancestors, root)
280
pb.update('Picking ancestor', 3, 2)
281
farthest = select_farthest(distances, common)
282
if farthest is None or farthest == NULL_REVISION:
283
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
193
289
class MultipleRevisionSources(object):
194
290
"""Proxy that looks in multiple branches for revisions."""
208
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
312
def get_revision_graph(self, revision_id):
313
# we could probe incrementally until the pending
314
# ghosts list stop growing, but its cheaper for now
315
# to just ask for the complete graph for each repository.
317
for source in self._revision_sources:
318
ghost_graph = source.get_revision_graph_with_ghosts()
319
graphs.append(ghost_graph)
322
if not revision_id in graph.get_ancestors():
324
if absent == len(graphs):
325
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
329
pending = set([revision_id])
330
def find_parents(node_id):
331
"""find the parents for node_id."""
333
ancestors = graph.get_ancestors()
335
return ancestors[node_id]
338
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
340
# all the graphs should have identical parent lists
341
node_id = pending.pop()
343
result[node_id] = find_parents(node_id)
344
for parent_node in result[node_id]:
345
if not parent_node in result:
346
pending.add(parent_node)
347
except errors.NoSuchRevision:
352
def get_revision_graph_with_ghosts(self, revision_ids):
353
# query all the sources for their entire graphs
354
# and then build a combined graph for just
357
for source in self._revision_sources:
358
ghost_graph = source.get_revision_graph_with_ghosts()
359
graphs.append(ghost_graph.get_ancestors())
360
for revision_id in revision_ids:
363
if not revision_id in graph:
365
if absent == len(graphs):
366
raise errors.NoSuchRevision(self._revision_sources[0],
371
pending = set(revision_ids)
373
def find_parents(node_id):
374
"""find the parents for node_id."""
377
return graph[node_id]
380
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
382
# all the graphs should have identical parent lists
383
node_id = pending.pop()
385
parents = find_parents(node_id)
386
for parent_node in parents:
388
if (parent_node not in pending and
389
parent_node not in done):
391
pending.add(parent_node)
392
result.add_node(node_id, parents)
394
except errors.NoSuchRevision:
396
result.add_ghost(node_id)
401
for source in self._revision_sources:
405
for source in self._revision_sources:
409
@deprecated_function(zero_eight)
410
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
209
411
revision_history=None):
210
412
"""Find the longest line of descent from maybe_ancestor to revision.
211
413
Revision history is followed where possible.
214
416
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
215
417
If ancestor_id is not an ancestor, NotAncestor will be thrown
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]
419
root, ancestors, descendants = revision_graph(rev_id, rev_source)
420
if len(descendants) == 0:
421
raise NoSuchRevision(rev_source, rev_id)
422
if ancestor_id not in descendants:
423
rev_source.get_revision(ancestor_id)
424
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
425
root_descendants = all_descendants(descendants, ancestor_id)
426
root_descendants.add(ancestor_id)
427
if rev_id not in root_descendants:
428
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
429
distances = node_distances(descendants, ancestors, ancestor_id,
430
root_descendants=root_descendants)
432
def best_ancestor(rev_id):
434
for anc_id in ancestors[rev_id]:
436
distance = distances[anc_id]
439
if revision_history is not None and anc_id in revision_history:
441
elif best is None or distance > best[1]:
442
best = (anc_id, distance)
447
while next != ancestor_id:
449
next = best_ancestor(next)
added
removed
bzrlib/revision.py
