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
"""Not used anymore - legacy from for 4."""
55
self.__dict__.update(args)
58
return "<Revision id %s>" % self.revision_id
60
def __eq__(self, other):
61
if not isinstance(other, Revision):
63
# FIXME: rbc 20050930 parent_ids are not being compared
65
self.inventory_sha1 == other.inventory_sha1
66
and self.revision_id == other.revision_id
67
and self.timestamp == other.timestamp
68
and self.message == other.message
69
and self.timezone == other.timezone
70
and self.committer == other.committer
71
and self.properties == other.properties)
73
def __ne__(self, other):
74
return not self.__eq__(other)
76
def _check_properties(self):
77
"""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 bzrlib.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 bzrlib.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
# trivial optimisation
243
if revision_a == revision_b:
247
pb.update('Picking ancestor', 1, 3)
248
graph = revision_source.get_revision_graph_with_ghosts(
249
[revision_a, revision_b])
250
# convert to a NULL_REVISION based graph.
251
ancestors = graph.get_ancestors()
252
descendants = graph.get_descendants()
253
common = set(graph.get_ancestry(revision_a)).intersection(
254
set(graph.get_ancestry(revision_b)))
255
descendants[NULL_REVISION] = {}
256
ancestors[NULL_REVISION] = []
257
for root in graph.roots:
258
descendants[NULL_REVISION][root] = 1
259
ancestors[root].append(NULL_REVISION)
260
for ghost in graph.ghosts:
261
# ghosts act as roots for the purpose of finding
262
# the longest paths from the root: any ghost *might*
263
# be directly attached to the root, so we treat them
265
# ghost now descends from NULL
266
descendants[NULL_REVISION][ghost] = 1
267
# that is it has an ancestor of NULL
268
ancestors[ghost] = [NULL_REVISION]
269
# ghost is common if any of ghosts descendants are common:
270
for ghost_descendant in descendants[ghost]:
271
if ghost_descendant in common:
275
common.add(NULL_REVISION)
276
except bzrlib.errors.NoCommonRoot:
277
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
279
pb.update('Picking ancestor', 2, 3)
280
distances = node_distances (descendants, ancestors, root)
281
pb.update('Picking ancestor', 3, 2)
282
farthest = select_farthest(distances, common)
283
if farthest is None or farthest == NULL_REVISION:
284
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
290
class MultipleRevisionSources(object):
291
"""Proxy that looks in multiple branches for revisions."""
292
def __init__(self, *args):
293
object.__init__(self)
294
assert len(args) != 0
295
self._revision_sources = args
297
def revision_parents(self, revision_id):
298
for source in self._revision_sources:
300
return source.revision_parents(revision_id)
301
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
305
def get_revision(self, revision_id):
306
for source in self._revision_sources:
308
return source.get_revision(revision_id)
309
except bzrlib.errors.NoSuchRevision, e:
313
def get_revision_graph(self, revision_id):
314
# we could probe incrementally until the pending
315
# ghosts list stop growing, but its cheaper for now
316
# to just ask for the complete graph for each repository.
318
for source in self._revision_sources:
319
ghost_graph = source.get_revision_graph_with_ghosts()
320
graphs.append(ghost_graph)
323
if not revision_id in graph.get_ancestors():
325
if absent == len(graphs):
326
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
330
pending = set([revision_id])
331
def find_parents(node_id):
332
"""find the parents for node_id."""
334
ancestors = graph.get_ancestors()
336
return ancestors[node_id]
339
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
341
# all the graphs should have identical parent lists
342
node_id = pending.pop()
344
result[node_id] = find_parents(node_id)
345
for parent_node in result[node_id]:
346
if not parent_node in result:
347
pending.add(parent_node)
348
except errors.NoSuchRevision:
353
def get_revision_graph_with_ghosts(self, revision_ids):
354
# query all the sources for their entire graphs
355
# and then build a combined graph for just
358
for source in self._revision_sources:
359
ghost_graph = source.get_revision_graph_with_ghosts()
360
graphs.append(ghost_graph.get_ancestors())
361
for revision_id in revision_ids:
364
if not revision_id in graph:
366
if absent == len(graphs):
367
raise errors.NoSuchRevision(self._revision_sources[0],
372
pending = set(revision_ids)
374
def find_parents(node_id):
375
"""find the parents for node_id."""
378
return graph[node_id]
381
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
383
# all the graphs should have identical parent lists
384
node_id = pending.pop()
386
parents = find_parents(node_id)
387
for parent_node in parents:
389
if (parent_node not in pending and
390
parent_node not in done):
392
pending.add(parent_node)
393
result.add_node(node_id, parents)
395
except errors.NoSuchRevision:
397
result.add_ghost(node_id)
402
for source in self._revision_sources:
406
for source in self._revision_sources:
410
@deprecated_function(zero_eight)
411
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
412
revision_history=None):
413
"""Find the longest line of descent from maybe_ancestor to revision.
414
Revision history is followed where possible.
416
If ancestor_id == rev_id, list will be empty.
417
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
418
If ancestor_id is not an ancestor, NotAncestor will be thrown
420
root, ancestors, descendants = revision_graph(rev_id, rev_source)
421
if len(descendants) == 0:
422
raise NoSuchRevision(rev_source, rev_id)
423
if ancestor_id not in descendants:
424
rev_source.get_revision(ancestor_id)
425
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
426
root_descendants = all_descendants(descendants, ancestor_id)
427
root_descendants.add(ancestor_id)
428
if rev_id not in root_descendants:
429
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
430
distances = node_distances(descendants, ancestors, ancestor_id,
431
root_descendants=root_descendants)
433
def best_ancestor(rev_id):
435
for anc_id in ancestors[rev_id]:
437
distance = distances[anc_id]
440
if revision_history is not None and anc_id in revision_history:
442
elif best is None or distance > best[1]:
443
best = (anc_id, distance)
448
while next != ancestor_id:
450
next = best_ancestor(next)
added
removed
bzrlib/revision.py
