1
# Copyright (C) 2005, 2006 Canonical
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.
21
import bzrlib.errors as errors
22
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
23
from bzrlib.osutils import contains_whitespace
24
from bzrlib.progress import DummyProgress
25
from bzrlib.symbol_versioning import (deprecated_function,
31
class Revision(object):
32
"""Single revision on a branch.
34
Revisions may know their revision_hash, but only once they've been
35
written out. This is not stored because you cannot write the hash
36
into the file it describes.
38
After bzr 0.0.5 revisions are allowed to have multiple parents.
41
List of parent revision_ids
44
Dictionary of revision properties. These are attached to the
45
revision as extra metadata. The name must be a single
46
word; the value can be an arbitrary string.
49
def __init__(self, revision_id, properties=None, **args):
50
self.revision_id = revision_id
51
self.properties = properties or {}
52
self._check_properties()
54
self.parent_sha1s = []
55
"""Not used anymore - legacy from for 4."""
56
self.__dict__.update(args)
59
return "<Revision id %s>" % self.revision_id
61
def __eq__(self, other):
62
if not isinstance(other, Revision):
64
# FIXME: rbc 20050930 parent_ids are not being compared
66
self.inventory_sha1 == other.inventory_sha1
67
and self.revision_id == other.revision_id
68
and self.timestamp == other.timestamp
69
and self.message == other.message
70
and self.timezone == other.timezone
71
and self.committer == other.committer
72
and self.properties == other.properties)
74
def __ne__(self, other):
75
return not self.__eq__(other)
77
def _check_properties(self):
78
"""Verify that all revision properties are OK."""
79
for name, value in self.properties.iteritems():
80
if not isinstance(name, basestring) or contains_whitespace(name):
81
raise ValueError("invalid property name %r" % name)
82
if not isinstance(value, basestring):
83
raise ValueError("invalid property value %r for %r" %
86
def get_history(self, repository):
87
"""Return the canonical line-of-history for this revision.
89
If ghosts are present this may differ in result from a ghost-free
92
current_revision = self
94
while current_revision is not None:
95
reversed_result.append(current_revision.revision_id)
96
if not len (current_revision.parent_ids):
97
reversed_result.append(None)
98
current_revision = None
100
next_revision_id = current_revision.parent_ids[0]
101
current_revision = repository.get_revision(next_revision_id)
102
reversed_result.reverse()
103
return reversed_result
105
def get_summary(self):
106
"""Get the first line of the log message for this revision.
108
return self.message.split('\n', 1)[0]
111
def is_ancestor(revision_id, candidate_id, branch):
112
"""Return true if candidate_id is an ancestor of revision_id.
114
A false negative will be returned if any intermediate descendent of
115
candidate_id is not present in any of the revision_sources.
117
revisions_source is an object supporting a get_revision operation that
118
behaves like Branch's.
120
return candidate_id in branch.repository.get_ancestry(revision_id)
123
def iter_ancestors(revision_id, revision_source, only_present=False):
124
ancestors = (revision_id,)
126
while len(ancestors) > 0:
128
for ancestor in ancestors:
130
yield ancestor, distance
132
revision = revision_source.get_revision(ancestor)
133
except errors.NoSuchRevision, e:
134
if e.revision == revision_id:
139
yield ancestor, distance
140
new_ancestors.extend(revision.parent_ids)
141
ancestors = new_ancestors
145
def find_present_ancestors(revision_id, revision_source):
146
"""Return the ancestors of a revision present in a branch.
148
It's possible that a branch won't have the complete ancestry of
149
one of its revisions.
153
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
155
for anc_order, (anc_id, anc_distance) in anc_iter:
156
if not found_ancestors.has_key(anc_id):
157
found_ancestors[anc_id] = (anc_order, anc_distance)
158
return found_ancestors
161
def __get_closest(intersection):
164
for entry in intersection:
165
if entry[0] == intersection[0][0]:
166
matches.append(entry[2])
170
def revision_graph(revision, revision_source):
171
"""Produce a graph of the ancestry of the specified revision.
173
:return: root, ancestors map, descendants map
175
revision_source.lock_read()
177
return _revision_graph(revision, revision_source)
179
revision_source.unlock()
182
def _revision_graph(revision, revision_source):
183
"""See revision_graph."""
184
from bzrlib.tsort import topo_sort
185
graph = revision_source.get_revision_graph(revision)
186
# mark all no-parent revisions as being NULL_REVISION parentage.
187
for node, parents in graph.items():
188
if len(parents) == 0:
189
graph[node] = [NULL_REVISION]
190
# add NULL_REVISION to the graph
191
graph[NULL_REVISION] = []
193
# pick a root. If there are multiple roots
194
# this could pick a random one.
195
topo_order = topo_sort(graph.items())
201
# map the descendants of the graph.
202
# and setup our set based return graph.
203
for node in graph.keys():
204
descendants[node] = {}
205
for node, parents in graph.items():
206
for parent in parents:
207
descendants[parent][node] = 1
208
ancestors[node] = set(parents)
210
assert root not in descendants[root]
211
assert root not in ancestors[root]
212
return root, ancestors, descendants
215
def combined_graph(revision_a, revision_b, revision_source):
216
"""Produce a combined ancestry graph.
217
Return graph root, ancestors map, descendants map, set of common nodes"""
218
root, ancestors, descendants = revision_graph(
219
revision_a, revision_source)
220
root_b, ancestors_b, descendants_b = revision_graph(
221
revision_b, revision_source)
223
raise errors.NoCommonRoot(revision_a, revision_b)
225
for node, node_anc in ancestors_b.iteritems():
226
if node in ancestors:
229
ancestors[node] = set()
230
ancestors[node].update(node_anc)
231
for node, node_dec in descendants_b.iteritems():
232
if node not in descendants:
233
descendants[node] = {}
234
descendants[node].update(node_dec)
235
return root, ancestors, descendants, common
238
def common_ancestor(revision_a, revision_b, revision_source,
240
if None in (revision_a, revision_b):
242
if NULL_REVISION in (revision_a, revision_b):
244
# trivial optimisation
245
if revision_a == revision_b:
249
pb.update('Picking ancestor', 1, 3)
250
graph = revision_source.get_revision_graph_with_ghosts(
251
[revision_a, revision_b])
252
# convert to a NULL_REVISION based graph.
253
ancestors = graph.get_ancestors()
254
descendants = graph.get_descendants()
255
common = set(graph.get_ancestry(revision_a)).intersection(
256
set(graph.get_ancestry(revision_b)))
257
descendants[NULL_REVISION] = {}
258
ancestors[NULL_REVISION] = []
259
for root in graph.roots:
260
descendants[NULL_REVISION][root] = 1
261
ancestors[root].append(NULL_REVISION)
262
for ghost in graph.ghosts:
263
# ghosts act as roots for the purpose of finding
264
# the longest paths from the root: any ghost *might*
265
# be directly attached to the root, so we treat them
267
# ghost now descends from NULL
268
descendants[NULL_REVISION][ghost] = 1
269
# that is it has an ancestor of NULL
270
ancestors[ghost] = [NULL_REVISION]
271
# ghost is common if any of ghosts descendants are common:
272
for ghost_descendant in descendants[ghost]:
273
if ghost_descendant in common:
277
common.add(NULL_REVISION)
278
except errors.NoCommonRoot:
279
raise errors.NoCommonAncestor(revision_a, revision_b)
281
pb.update('Picking ancestor', 2, 3)
282
distances = node_distances (descendants, ancestors, root)
283
pb.update('Picking ancestor', 3, 2)
284
farthest = select_farthest(distances, common)
285
if farthest is None or farthest == NULL_REVISION:
286
raise errors.NoCommonAncestor(revision_a, revision_b)
292
class MultipleRevisionSources(object):
293
"""Proxy that looks in multiple branches for revisions."""
294
def __init__(self, *args):
295
object.__init__(self)
296
assert len(args) != 0
297
self._revision_sources = args
299
def revision_parents(self, revision_id):
300
for source in self._revision_sources:
302
return source.revision_parents(revision_id)
303
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
307
def get_revision(self, revision_id):
308
for source in self._revision_sources:
310
return source.get_revision(revision_id)
311
except errors.NoSuchRevision, e:
315
def get_revision_graph(self, revision_id):
316
# we could probe incrementally until the pending
317
# ghosts list stop growing, but its cheaper for now
318
# to just ask for the complete graph for each repository.
320
for source in self._revision_sources:
321
ghost_graph = source.get_revision_graph_with_ghosts()
322
graphs.append(ghost_graph)
325
if not revision_id in graph.get_ancestors():
327
if absent == len(graphs):
328
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
332
pending = set([revision_id])
333
def find_parents(node_id):
334
"""find the parents for node_id."""
336
ancestors = graph.get_ancestors()
338
return ancestors[node_id]
341
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
343
# all the graphs should have identical parent lists
344
node_id = pending.pop()
346
result[node_id] = find_parents(node_id)
347
for parent_node in result[node_id]:
348
if not parent_node in result:
349
pending.add(parent_node)
350
except errors.NoSuchRevision:
355
def get_revision_graph_with_ghosts(self, revision_ids):
356
# query all the sources for their entire graphs
357
# and then build a combined graph for just
360
for source in self._revision_sources:
361
ghost_graph = source.get_revision_graph_with_ghosts()
362
graphs.append(ghost_graph.get_ancestors())
363
for revision_id in revision_ids:
366
if not revision_id in graph:
368
if absent == len(graphs):
369
raise errors.NoSuchRevision(self._revision_sources[0],
374
pending = set(revision_ids)
376
def find_parents(node_id):
377
"""find the parents for node_id."""
380
return graph[node_id]
383
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
385
# all the graphs should have identical parent lists
386
node_id = pending.pop()
388
parents = find_parents(node_id)
389
for parent_node in parents:
391
if (parent_node not in pending and
392
parent_node not in done):
394
pending.add(parent_node)
395
result.add_node(node_id, parents)
397
except errors.NoSuchRevision:
399
result.add_ghost(node_id)
404
for source in self._revision_sources:
408
for source in self._revision_sources:
412
@deprecated_function(zero_eight)
413
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
414
revision_history=None):
415
"""Find the longest line of descent from maybe_ancestor to revision.
416
Revision history is followed where possible.
418
If ancestor_id == rev_id, list will be empty.
419
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
420
If ancestor_id is not an ancestor, NotAncestor will be thrown
422
root, ancestors, descendants = revision_graph(rev_id, rev_source)
423
if len(descendants) == 0:
424
raise errors.NoSuchRevision(rev_source, rev_id)
425
if ancestor_id not in descendants:
426
rev_source.get_revision(ancestor_id)
427
raise errors.NotAncestor(rev_id, ancestor_id)
428
root_descendants = all_descendants(descendants, ancestor_id)
429
root_descendants.add(ancestor_id)
430
if rev_id not in root_descendants:
431
raise errors.NotAncestor(rev_id, ancestor_id)
432
distances = node_distances(descendants, ancestors, ancestor_id,
433
root_descendants=root_descendants)
435
def best_ancestor(rev_id):
437
for anc_id in ancestors[rev_id]:
439
distance = distances[anc_id]
442
if revision_history is not None and anc_id in revision_history:
444
elif best is None or distance > best[1]:
445
best = (anc_id, distance)
450
while next != ancestor_id:
452
next = best_ancestor(next)
added
removed
bzrlib/revision.py
