1
# Copyright (C) 2005, 2006 Canonical Ltd
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.deprecated_graph import (
28
from bzrlib.osutils import contains_whitespace
29
from bzrlib.progress import DummyProgress
30
from bzrlib.symbol_versioning import (deprecated_function,
35
CURRENT_REVISION="current:"
38
class Revision(object):
39
"""Single revision on a branch.
41
Revisions may know their revision_hash, but only once they've been
42
written out. This is not stored because you cannot write the hash
43
into the file it describes.
45
After bzr 0.0.5 revisions are allowed to have multiple parents.
48
List of parent revision_ids
51
Dictionary of revision properties. These are attached to the
52
revision as extra metadata. The name must be a single
53
word; the value can be an arbitrary string.
56
def __init__(self, revision_id, properties=None, **args):
57
self.revision_id = revision_id
58
self.properties = properties or {}
59
self._check_properties()
61
self.parent_sha1s = []
62
"""Not used anymore - legacy from for 4."""
63
self.__dict__.update(args)
66
return "<Revision id %s>" % self.revision_id
68
def __eq__(self, other):
69
if not isinstance(other, Revision):
71
# FIXME: rbc 20050930 parent_ids are not being compared
73
self.inventory_sha1 == other.inventory_sha1
74
and self.revision_id == other.revision_id
75
and self.timestamp == other.timestamp
76
and self.message == other.message
77
and self.timezone == other.timezone
78
and self.committer == other.committer
79
and self.properties == other.properties)
81
def __ne__(self, other):
82
return not self.__eq__(other)
84
def _check_properties(self):
85
"""Verify that all revision properties are OK."""
86
for name, value in self.properties.iteritems():
87
if not isinstance(name, basestring) or contains_whitespace(name):
88
raise ValueError("invalid property name %r" % name)
89
if not isinstance(value, basestring):
90
raise ValueError("invalid property value %r for %r" %
93
def get_history(self, repository):
94
"""Return the canonical line-of-history for this revision.
96
If ghosts are present this may differ in result from a ghost-free
99
current_revision = self
101
while current_revision is not None:
102
reversed_result.append(current_revision.revision_id)
103
if not len (current_revision.parent_ids):
104
reversed_result.append(None)
105
current_revision = None
107
next_revision_id = current_revision.parent_ids[0]
108
current_revision = repository.get_revision(next_revision_id)
109
reversed_result.reverse()
110
return reversed_result
112
def get_summary(self):
113
"""Get the first line of the log message for this revision.
115
return self.message.split('\n', 1)[0]
118
def is_ancestor(revision_id, candidate_id, branch):
119
"""Return true if candidate_id is an ancestor of revision_id.
121
A false negative will be returned if any intermediate descendent of
122
candidate_id is not present in any of the revision_sources.
124
revisions_source is an object supporting a get_revision operation that
125
behaves like Branch's.
127
return (candidate_id in branch.repository.get_ancestry(revision_id))
130
def iter_ancestors(revision_id, revision_source, only_present=False):
131
ancestors = (revision_id,)
133
while len(ancestors) > 0:
135
for ancestor in ancestors:
137
yield ancestor, distance
139
revision = revision_source.get_revision(ancestor)
140
except errors.NoSuchRevision, e:
141
if e.revision == revision_id:
146
yield ancestor, distance
147
new_ancestors.extend(revision.parent_ids)
148
ancestors = new_ancestors
152
def find_present_ancestors(revision_id, revision_source):
153
"""Return the ancestors of a revision present in a branch.
155
It's possible that a branch won't have the complete ancestry of
156
one of its revisions.
160
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
162
for anc_order, (anc_id, anc_distance) in anc_iter:
163
if anc_id not in found_ancestors:
164
found_ancestors[anc_id] = (anc_order, anc_distance)
165
return found_ancestors
168
def __get_closest(intersection):
171
for entry in intersection:
172
if entry[0] == intersection[0][0]:
173
matches.append(entry[2])
177
def revision_graph(revision, revision_source):
178
"""Produce a graph of the ancestry of the specified revision.
180
:return: root, ancestors map, descendants map
182
revision_source.lock_read()
184
return _revision_graph(revision, revision_source)
186
revision_source.unlock()
189
def _revision_graph(revision, revision_source):
190
"""See revision_graph."""
191
from bzrlib.tsort import topo_sort
192
graph = revision_source.get_revision_graph(revision)
193
# mark all no-parent revisions as being NULL_REVISION parentage.
194
for node, parents in graph.items():
195
if len(parents) == 0:
196
graph[node] = [NULL_REVISION]
197
# add NULL_REVISION to the graph
198
graph[NULL_REVISION] = []
200
# pick a root. If there are multiple roots
201
# this could pick a random one.
202
topo_order = topo_sort(graph.items())
208
# map the descendants of the graph.
209
# and setup our set based return graph.
210
for node in graph.keys():
211
descendants[node] = {}
212
for node, parents in graph.items():
213
for parent in parents:
214
descendants[parent][node] = 1
215
ancestors[node] = set(parents)
217
assert root not in descendants[root]
218
assert root not in ancestors[root]
219
return root, ancestors, descendants
222
def combined_graph(revision_a, revision_b, revision_source):
223
"""Produce a combined ancestry graph.
224
Return graph root, ancestors map, descendants map, set of common nodes"""
225
root, ancestors, descendants = revision_graph(
226
revision_a, revision_source)
227
root_b, ancestors_b, descendants_b = revision_graph(
228
revision_b, revision_source)
230
raise errors.NoCommonRoot(revision_a, revision_b)
232
for node, node_anc in ancestors_b.iteritems():
233
if node in ancestors:
236
ancestors[node] = set()
237
ancestors[node].update(node_anc)
238
for node, node_dec in descendants_b.iteritems():
239
if node not in descendants:
240
descendants[node] = {}
241
descendants[node].update(node_dec)
242
return root, ancestors, descendants, common
245
def common_ancestor(revision_a, revision_b, revision_source,
247
if None in (revision_a, revision_b):
249
if NULL_REVISION in (revision_a, revision_b):
251
# trivial optimisation
252
if revision_a == revision_b:
256
pb.update('Picking ancestor', 1, 3)
257
graph = revision_source.get_revision_graph_with_ghosts(
258
[revision_a, revision_b])
259
# Shortcut the case where one of the tips is already included in
260
# the other graphs ancestry.
261
ancestry_a = graph.get_ancestry(revision_a)
262
if revision_b in ancestry_a:
264
ancestry_b = graph.get_ancestry(revision_b)
265
if revision_a in ancestry_b:
267
# convert to a NULL_REVISION based graph.
268
ancestors = graph.get_ancestors()
269
descendants = graph.get_descendants()
270
common = set(ancestry_a)
271
common.intersection_update(ancestry_b)
272
descendants[NULL_REVISION] = {}
273
ancestors[NULL_REVISION] = []
274
for root in graph.roots:
275
descendants[NULL_REVISION][root] = 1
276
ancestors[root].append(NULL_REVISION)
277
for ghost in graph.ghosts:
278
# ghosts act as roots for the purpose of finding
279
# the longest paths from the root: any ghost *might*
280
# be directly attached to the root, so we treat them
282
# ghost now descends from NULL
283
descendants[NULL_REVISION][ghost] = 1
284
# that is it has an ancestor of NULL
285
ancestors[ghost] = [NULL_REVISION]
286
# ghost is common if any of ghosts descendants are common:
287
for ghost_descendant in descendants[ghost]:
288
if ghost_descendant in common:
292
common.add(NULL_REVISION)
293
except errors.NoCommonRoot:
294
raise errors.NoCommonAncestor(revision_a, revision_b)
296
pb.update('Picking ancestor', 2, 3)
297
distances = node_distances (descendants, ancestors, root)
298
pb.update('Picking ancestor', 3, 2)
299
farthest = select_farthest(distances, common)
300
if farthest is None or farthest == NULL_REVISION:
301
raise errors.NoCommonAncestor(revision_a, revision_b)
307
class MultipleRevisionSources(object):
308
"""Proxy that looks in multiple branches for revisions."""
309
def __init__(self, *args):
310
object.__init__(self)
311
assert len(args) != 0
312
self._revision_sources = args
314
def revision_parents(self, revision_id):
315
for source in self._revision_sources:
317
return source.revision_parents(revision_id)
318
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
322
def get_revision(self, revision_id):
323
for source in self._revision_sources:
325
return source.get_revision(revision_id)
326
except errors.NoSuchRevision, e:
330
def get_revision_graph(self, revision_id):
331
# we could probe incrementally until the pending
332
# ghosts list stop growing, but its cheaper for now
333
# to just ask for the complete graph for each repository.
335
for source in self._revision_sources:
336
ghost_graph = source.get_revision_graph_with_ghosts()
337
graphs.append(ghost_graph)
340
if not revision_id in graph.get_ancestors():
342
if absent == len(graphs):
343
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
347
pending = set([revision_id])
348
def find_parents(node_id):
349
"""find the parents for node_id."""
351
ancestors = graph.get_ancestors()
353
return ancestors[node_id]
356
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
358
# all the graphs should have identical parent lists
359
node_id = pending.pop()
361
result[node_id] = find_parents(node_id)
362
for parent_node in result[node_id]:
363
if not parent_node in result:
364
pending.add(parent_node)
365
except errors.NoSuchRevision:
370
def get_revision_graph_with_ghosts(self, revision_ids):
371
# query all the sources for their entire graphs
372
# and then build a combined graph for just
375
for source in self._revision_sources:
376
ghost_graph = source.get_revision_graph_with_ghosts()
377
graphs.append(ghost_graph.get_ancestors())
378
for revision_id in revision_ids:
381
if not revision_id in graph:
383
if absent == len(graphs):
384
raise errors.NoSuchRevision(self._revision_sources[0],
389
pending = set(revision_ids)
391
def find_parents(node_id):
392
"""find the parents for node_id."""
395
return graph[node_id]
398
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
400
# all the graphs should have identical parent lists
401
node_id = pending.pop()
403
parents = find_parents(node_id)
404
for parent_node in parents:
406
if (parent_node not in pending and
407
parent_node not in done):
409
pending.add(parent_node)
410
result.add_node(node_id, parents)
412
except errors.NoSuchRevision:
414
result.add_ghost(node_id)
419
for source in self._revision_sources:
423
for source in self._revision_sources:
427
@deprecated_function(zero_eight)
428
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
429
revision_history=None):
430
"""Find the longest line of descent from maybe_ancestor to revision.
431
Revision history is followed where possible.
433
If ancestor_id == rev_id, list will be empty.
434
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
435
If ancestor_id is not an ancestor, NotAncestor will be thrown
437
root, ancestors, descendants = revision_graph(rev_id, rev_source)
438
if len(descendants) == 0:
439
raise errors.NoSuchRevision(rev_source, rev_id)
440
if ancestor_id not in descendants:
441
rev_source.get_revision(ancestor_id)
442
raise errors.NotAncestor(rev_id, ancestor_id)
443
root_descendants = all_descendants(descendants, ancestor_id)
444
root_descendants.add(ancestor_id)
445
if rev_id not in root_descendants:
446
raise errors.NotAncestor(rev_id, ancestor_id)
447
distances = node_distances(descendants, ancestors, ancestor_id,
448
root_descendants=root_descendants)
450
def best_ancestor(rev_id):
452
for anc_id in ancestors[rev_id]:
454
distance = distances[anc_id]
457
if revision_history is not None and anc_id in revision_history:
459
elif best is None or distance > best[1]:
460
best = (anc_id, distance)
465
while next != ancestor_id:
467
next = best_ancestor(next)
472
def is_reserved_id(revision_id):
473
"""Determine whether a revision id is reserved
475
:return: True if the revision is is reserved, False otherwise
477
return isinstance(revision_id, basestring) and revision_id.endswith(':')
480
def check_not_reserved_id(revision_id):
481
"""Raise ReservedId if the supplied revision_id is reserved"""
482
if is_reserved_id(revision_id):
483
raise errors.ReservedId(revision_id)
485
def ensure_null(revision_id):
486
"""Ensure only NULL_REVISION is used to represent the null revisionn"""
487
if revision_id is None:
added
removed
bzrlib/revision.py
