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)
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
102
105
def is_ancestor(revision_id, candidate_id, branch):
161
def common_ancestor(revision_a, revision_b, revision_source):
162
"""Find the ancestor common to both revisions that is closest to both.
164
def revision_graph(revision, revision_source):
165
"""Produce a graph of the ancestry of the specified revision.
167
:return: root, ancestors map, descendants map
164
from bzrlib.trace import mutter
165
a_ancestors = find_present_ancestors(revision_a, revision_source)
166
b_ancestors = find_present_ancestors(revision_b, revision_source)
169
# a_order is used as a tie-breaker when two equally-good bases are found
170
for revision, (a_order, a_distance) in a_ancestors.iteritems():
171
if b_ancestors.has_key(revision):
172
a_intersection.append((a_distance, a_order, revision))
173
b_intersection.append((b_ancestors[revision][1], a_order, revision))
174
mutter("a intersection: %r" % a_intersection)
175
mutter("b intersection: %r" % b_intersection)
177
a_closest = __get_closest(a_intersection)
178
if len(a_closest) == 0:
169
revision_source.lock_read()
171
return _revision_graph(revision, revision_source)
173
revision_source.unlock()
176
def _revision_graph(revision, revision_source):
177
"""See revision_graph."""
178
from bzrlib.tsort import topo_sort
179
graph = revision_source.get_revision_graph(revision)
180
# mark all no-parent revisions as being NULL_REVISION parentage.
181
for node, parents in graph.items():
182
if len(parents) == 0:
183
graph[node] = [NULL_REVISION]
184
# add NULL_REVISION to the graph
185
graph[NULL_REVISION] = []
187
# pick a root. If there are multiple roots
188
# this could pick a random one.
189
topo_order = topo_sort(graph.items())
195
# map the descendants of the graph.
196
# and setup our set based return graph.
197
for node in graph.keys():
198
descendants[node] = {}
199
for node, parents in graph.items():
200
for parent in parents:
201
descendants[parent][node] = 1
202
ancestors[node] = set(parents)
204
assert root not in descendants[root]
205
assert root not in ancestors[root]
206
return root, ancestors, descendants
209
def combined_graph(revision_a, revision_b, revision_source):
210
"""Produce a combined ancestry graph.
211
Return graph root, ancestors map, descendants map, set of common nodes"""
212
root, ancestors, descendants = revision_graph(
213
revision_a, revision_source)
214
root_b, ancestors_b, descendants_b = revision_graph(
215
revision_b, revision_source)
217
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
219
for node, node_anc in ancestors_b.iteritems():
220
if node in ancestors:
223
ancestors[node] = set()
224
ancestors[node].update(node_anc)
225
for node, node_dec in descendants_b.iteritems():
226
if node not in descendants:
227
descendants[node] = {}
228
descendants[node].update(node_dec)
229
return root, ancestors, descendants, common
232
def common_ancestor(revision_a, revision_b, revision_source,
234
if None in (revision_a, revision_b):
180
b_closest = __get_closest(b_intersection)
181
assert len(b_closest) != 0
182
mutter ("a_closest %r" % a_closest)
183
mutter ("b_closest %r" % b_closest)
184
if a_closest[0] in b_closest:
186
elif b_closest[0] in a_closest:
189
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
236
# trivial optimisation
237
if revision_a == revision_b:
241
pb.update('Picking ancestor', 1, 3)
242
graph = revision_source.get_revision_graph_with_ghosts(
243
[revision_a, revision_b])
244
# convert to a NULL_REVISION based graph.
245
ancestors = graph.get_ancestors()
246
descendants = graph.get_descendants()
247
common = set(graph.get_ancestry(revision_a)).intersection(
248
set(graph.get_ancestry(revision_b)))
249
descendants[NULL_REVISION] = {}
250
ancestors[NULL_REVISION] = []
251
for root in graph.roots:
252
descendants[NULL_REVISION][root] = 1
253
ancestors[root].append(NULL_REVISION)
254
for ghost in graph.ghosts:
255
# ghosts act as roots for the purpose of finding
256
# the longest paths from the root: any ghost *might*
257
# be directly attached to the root, so we treat them
259
# ghost now descends from NULL
260
descendants[NULL_REVISION][ghost] = 1
261
# that is it has an ancestor of NULL
262
ancestors[ghost] = [NULL_REVISION]
263
# ghost is common if any of ghosts descendants are common:
264
for ghost_descendant in descendants[ghost]:
265
if ghost_descendant in common:
269
common.add(NULL_REVISION)
270
except bzrlib.errors.NoCommonRoot:
271
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
273
pb.update('Picking ancestor', 2, 3)
274
distances = node_distances (descendants, ancestors, root)
275
pb.update('Picking ancestor', 3, 2)
276
farthest = select_farthest(distances, common)
277
if farthest is None or farthest == NULL_REVISION:
278
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
192
284
class MultipleRevisionSources(object):
193
285
"""Proxy that looks in multiple branches for revisions."""
207
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
208
revision_history=None):
209
"""Find the longest line of descent from maybe_ancestor to revision.
210
Revision history is followed where possible.
212
If ancestor_id == rev_id, list will be empty.
213
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
214
If ancestor_id is not an ancestor, NotAncestor will be thrown
216
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
217
if ancestor_id == rev_id:
219
def historical_lines(line):
220
"""Return a tuple of historical/non_historical lines, for sorting.
221
The non_historical count is negative, since non_historical lines are
226
for revision in line:
227
if revision in revision_history:
231
return good_count, bad_count
233
successful_lines = []
234
while len(active) > 0:
237
parent_ids = [p.revision_id for p in
238
rev_source.get_revision(line[-1]).parents]
239
for parent in parent_ids:
241
if parent == ancestor_id:
242
successful_lines.append(line_copy)
244
line_copy.append(parent)
245
new_active.append(line_copy)
247
if len(successful_lines) == 0:
248
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
249
for line in successful_lines:
251
if revision_history is not None:
252
by_historical_lines = []
253
for line in successful_lines:
254
count = historical_lines(line)
255
by_historical_lines.append((count, line))
256
by_historical_lines.sort()
257
if by_historical_lines[-1][0][0] > 0:
258
return by_historical_lines[-1][1]
259
assert len(successful_lines)
260
successful_lines.sort(cmp, len)
261
return successful_lines[-1]
307
def get_revision_graph(self, revision_id):
308
# we could probe incrementally until the pending
309
# ghosts list stop growing, but its cheaper for now
310
# to just ask for the complete graph for each repository.
312
for source in self._revision_sources:
313
ghost_graph = source.get_revision_graph_with_ghosts()
314
graphs.append(ghost_graph)
317
if not revision_id in graph.get_ancestors():
319
if absent == len(graphs):
320
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
324
pending = set([revision_id])
325
def find_parents(node_id):
326
"""find the parents for node_id."""
328
ancestors = graph.get_ancestors()
330
return ancestors[node_id]
333
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
335
# all the graphs should have identical parent lists
336
node_id = pending.pop()
338
result[node_id] = find_parents(node_id)
339
for parent_node in result[node_id]:
340
if not parent_node in result:
341
pending.add(parent_node)
342
except errors.NoSuchRevision:
347
def get_revision_graph_with_ghosts(self, revision_ids):
348
# query all the sources for their entire graphs
349
# and then build a combined graph for just
352
for source in self._revision_sources:
353
ghost_graph = source.get_revision_graph_with_ghosts()
354
graphs.append(ghost_graph.get_ancestors())
355
for revision_id in revision_ids:
358
if not revision_id in graph:
360
if absent == len(graphs):
361
raise errors.NoSuchRevision(self._revision_sources[0],
366
pending = set(revision_ids)
368
def find_parents(node_id):
369
"""find the parents for node_id."""
372
return graph[node_id]
375
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
377
# all the graphs should have identical parent lists
378
node_id = pending.pop()
380
parents = find_parents(node_id)
381
for parent_node in parents:
383
if (parent_node not in pending and
384
parent_node not in done):
386
pending.add(parent_node)
387
result.add_node(node_id, parents)
389
except errors.NoSuchRevision:
391
result.add_ghost(node_id)
396
for source in self._revision_sources:
400
for source in self._revision_sources:
added
removed
bzrlib/revision.py
