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.
21
18
import bzrlib.errors
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 *
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
28
21
NULL_REVISION="null:"
23
class RevisionReference(object):
25
Reference to a stored revision.
27
Includes the revision_id and revision_sha1.
30
def __eq__(self, other):
32
return self.revision_id == other.revision_id and \
33
self.revision_sha1 == other.revision_sha1
34
except AttributeError:
37
def __init__(self, revision_id, revision_sha1=None):
38
self.revision_id = None
39
self.revision_sha1 = None
40
if revision_id == None \
41
or isinstance(revision_id, basestring):
42
self.revision_id = revision_id
44
raise ValueError('bad revision_id %r' % revision_id)
46
if revision_sha1 != None:
47
if isinstance(revision_sha1, basestring) \
48
and len(revision_sha1) == 40:
49
self.revision_sha1 = revision_sha1
51
raise ValueError('bad revision_sha1 %r' % revision_sha1)
30
55
class Revision(object):
31
56
"""Single revision on a branch.
37
62
After bzr 0.0.5 revisions are allowed to have multiple parents.
40
List of parent revision_ids
43
Dictionary of revision properties. These are attached to the
44
revision as extra metadata. The name must be a single
45
word; the value can be an arbitrary string.
65
List of parent revisions, each is a RevisionReference.
48
def __init__(self, revision_id, properties=None, **args):
68
def __init__(self, inventory_id=None, inventory_sha1=None,
69
revision_id=None, timestamp=None,
70
message=None, timezone=None,
71
committer=None, parents=None):
72
self.inventory_id = inventory_id
73
self.inventory_sha1 = inventory_sha1
49
74
self.revision_id = revision_id
50
self.properties = properties or {}
51
self._check_properties()
53
self.parent_sha1s = []
54
self.__dict__.update(args)
75
self.timestamp = timestamp
76
self.message = message
77
self.timezone = timezone
78
self.committer = committer
79
if parents is not None:
80
self.parents = parents
84
def __eq__(self, other):
86
return self.inventory_id == other.inventory_id and \
87
self.inventory_sha1 == other.inventory_sha1 and \
88
self.revision_id == other.revision_id and \
89
self.timestamp == other.timestamp and \
90
self.message == other.message and \
91
self.timezone == other.timezone and \
92
self.committer == other.committer and \
93
self.parents == other.parents
94
except AttributeError:
56
97
def __repr__(self):
57
98
return "<Revision id %s>" % self.revision_id
59
100
def __eq__(self, other):
60
101
if not isinstance(other, Revision):
62
# FIXME: rbc 20050930 parent_ids are not being compared
64
self.inventory_sha1 == other.inventory_sha1
103
return (self.inventory_id == other.inventory_id
104
and self.inventory_sha1 == other.inventory_sha1
65
105
and self.revision_id == other.revision_id
66
106
and self.timestamp == other.timestamp
67
107
and self.message == other.message
68
108
and self.timezone == other.timezone
69
and self.committer == other.committer
70
and self.properties == other.properties)
109
and self.committer == other.committer)
72
111
def __ne__(self, other):
73
112
return not self.__eq__(other)
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
105
def is_ancestor(revision_id, candidate_id, branch):
115
REVISION_ID_RE = None
117
def validate_revision_id(rid):
118
"""Check rid is syntactically valid for a revision id."""
119
global REVISION_ID_RE
120
if not REVISION_ID_RE:
122
REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
124
if not REVISION_ID_RE.match(rid):
125
raise ValueError("malformed revision-id %r" % rid)
127
def is_ancestor(revision_id, candidate_id, revision_source):
106
128
"""Return true if candidate_id is an ancestor of revision_id.
108
129
A false negative will be returned if any intermediate descendent of
109
130
candidate_id is not present in any of the revision_sources.
111
132
revisions_source is an object supporting a get_revision operation that
112
133
behaves like Branch's.
114
return candidate_id in branch.repository.get_ancestry(revision_id)
135
if candidate_id is None:
137
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
138
if ancestor_id == candidate_id:
117
142
def iter_ancestors(revision_id, revision_source, only_present=False):
118
143
ancestors = (revision_id,)
189
def old_common_ancestor(revision_a, revision_b, revision_source):
190
"""Find the ancestor common to both revisions that is closest to both.
192
from bzrlib.trace import mutter
193
a_ancestors = find_present_ancestors(revision_a, revision_source)
194
b_ancestors = find_present_ancestors(revision_b, revision_source)
197
# a_order is used as a tie-breaker when two equally-good bases are found
198
for revision, (a_order, a_distance) in a_ancestors.iteritems():
199
if b_ancestors.has_key(revision):
200
a_intersection.append((a_distance, a_order, revision))
201
b_intersection.append((b_ancestors[revision][1], a_order, revision))
202
mutter("a intersection: %r" % a_intersection)
203
mutter("b intersection: %r" % b_intersection)
205
a_closest = __get_closest(a_intersection)
206
if len(a_closest) == 0:
208
b_closest = __get_closest(b_intersection)
209
assert len(b_closest) != 0
210
mutter ("a_closest %r" % a_closest)
211
mutter ("b_closest %r" % b_closest)
212
if a_closest[0] in b_closest:
214
elif b_closest[0] in a_closest:
217
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
164
220
def revision_graph(revision, revision_source):
165
221
"""Produce a graph of the ancestry of the specified revision.
167
:return: root, ancestors map, descendants map
222
Return root, ancestors map, descendants map
224
TODO: Produce graphs with the NULL revision as root, so that we can find
225
a common even when trees are not branches don't represent a single line
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)
232
descendants[revision] = {}
233
while len(lines) > 0:
236
if line == NULL_REVISION:
241
rev = revision_source.get_revision(line)
242
parents = [p.revision_id for p in rev.parents]
243
if len(parents) == 0:
244
parents = [NULL_REVISION]
245
except bzrlib.errors.NoSuchRevision:
249
if parents is not None:
250
for parent in parents:
251
if parent not in ancestors:
252
new_lines.add(parent)
253
if parent not in descendants:
254
descendants[parent] = {}
255
descendants[parent][line] = 1
256
if parents is not None:
257
ancestors[line] = set(parents)
204
259
assert root not in descendants[root]
205
260
assert root not in ancestors[root]
206
261
return root, ancestors, descendants
209
264
def combined_graph(revision_a, revision_b, revision_source):
210
265
"""Produce a combined ancestry graph.
211
266
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)
267
root, ancestors, descendants = revision_graph(revision_a, revision_source)
268
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
216
270
if root != root_b:
217
271
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
229
283
return root, ancestors, descendants, common
232
def common_ancestor(revision_a, revision_b, revision_source,
234
if None in (revision_a, revision_b):
236
# trivial optimisation
237
if revision_a == revision_b:
286
def common_ancestor(revision_a, revision_b, revision_source):
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)
288
root, ancestors, descendants, common = \
289
combined_graph(revision_a, revision_b, revision_source)
290
except bzrlib.errors.NoCommonRoot:
291
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
293
distances = node_distances (descendants, ancestors, root)
294
farthest = select_farthest(distances, common)
295
if farthest is None or farthest == NULL_REVISION:
296
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
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:
404
@deprecated_method(zero_eight)
405
315
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
406
316
revision_history=None):
407
317
"""Find the longest line of descent from maybe_ancestor to revision.
added
removed
bzrlib/revision.py
