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.
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 *
30
class Revision(object):
31
"""Single revision on a branch.
33
Revisions may know their revision_hash, but only once they've been
34
written out. This is not stored because you cannot write the hash
35
into the file it describes.
37
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.
48
def __init__(self, revision_id, properties=None, **args):
49
self.revision_id = revision_id
50
self.properties = properties or {}
51
self._check_properties()
53
self.parent_sha1s = []
54
self.__dict__.update(args)
57
return "<Revision id %s>" % self.revision_id
59
def __eq__(self, other):
60
if not isinstance(other, Revision):
62
# FIXME: rbc 20050930 parent_ids are not being compared
64
self.inventory_sha1 == other.inventory_sha1
65
and self.revision_id == other.revision_id
66
and self.timestamp == other.timestamp
67
and self.message == other.message
68
and self.timezone == other.timezone
69
and self.committer == other.committer
70
and self.properties == other.properties)
72
def __ne__(self, other):
73
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):
106
"""Return true if candidate_id is an ancestor of revision_id.
108
A false negative will be returned if any intermediate descendent of
109
candidate_id is not present in any of the revision_sources.
111
revisions_source is an object supporting a get_revision operation that
112
behaves like Branch's.
114
return candidate_id in branch.repository.get_ancestry(revision_id)
117
def iter_ancestors(revision_id, revision_source, only_present=False):
118
ancestors = (revision_id,)
120
while len(ancestors) > 0:
122
for ancestor in ancestors:
124
yield ancestor, distance
126
revision = revision_source.get_revision(ancestor)
127
except bzrlib.errors.NoSuchRevision, e:
128
if e.revision == revision_id:
133
yield ancestor, distance
134
new_ancestors.extend(revision.parent_ids)
135
ancestors = new_ancestors
139
def find_present_ancestors(revision_id, revision_source):
140
"""Return the ancestors of a revision present in a branch.
142
It's possible that a branch won't have the complete ancestry of
143
one of its revisions.
147
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
149
for anc_order, (anc_id, anc_distance) in anc_iter:
150
if not found_ancestors.has_key(anc_id):
151
found_ancestors[anc_id] = (anc_order, anc_distance)
152
return found_ancestors
155
def __get_closest(intersection):
158
for entry in intersection:
159
if entry[0] == intersection[0][0]:
160
matches.append(entry[2])
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
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):
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)
284
class MultipleRevisionSources(object):
285
"""Proxy that looks in multiple branches for revisions."""
286
def __init__(self, *args):
287
object.__init__(self)
288
assert len(args) != 0
289
self._revision_sources = args
291
def revision_parents(self, revision_id):
292
for source in self._revision_sources:
294
return source.revision_parents(revision_id)
295
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
299
def get_revision(self, revision_id):
300
for source in self._revision_sources:
302
return source.get_revision(revision_id)
303
except bzrlib.errors.NoSuchRevision, e:
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
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
406
revision_history=None):
407
"""Find the longest line of descent from maybe_ancestor to revision.
408
Revision history is followed where possible.
410
If ancestor_id == rev_id, list will be empty.
411
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
412
If ancestor_id is not an ancestor, NotAncestor will be thrown
414
root, ancestors, descendants = revision_graph(rev_id, rev_source)
415
if len(descendants) == 0:
416
raise NoSuchRevision(rev_source, rev_id)
417
if ancestor_id not in descendants:
418
rev_source.get_revision(ancestor_id)
419
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
420
root_descendants = all_descendants(descendants, ancestor_id)
421
root_descendants.add(ancestor_id)
422
if rev_id not in root_descendants:
423
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
424
distances = node_distances(descendants, ancestors, ancestor_id,
425
root_descendants=root_descendants)
427
def best_ancestor(rev_id):
429
for anc_id in ancestors[rev_id]:
431
distance = distances[anc_id]
434
if revision_history is not None and anc_id in revision_history:
436
elif best is None or distance > best[1]:
437
best = (anc_id, distance)
442
while next != ancestor_id:
444
next = best_ancestor(next)
added
removed
bzrlib/revision.py
