1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
24
from bzrlib import bugtracker
30
from bzrlib.osutils import contains_whitespace
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
32
21
NULL_REVISION="null:"
33
CURRENT_REVISION="current:"
36
23
class Revision(object):
37
24
"""Single revision on a branch.
77
54
and self.message == other.message
78
55
and self.timezone == other.timezone
79
56
and self.committer == other.committer
80
and self.properties == other.properties
81
and self.parent_ids == other.parent_ids)
57
and self.properties == other.properties)
83
59
def __ne__(self, other):
84
60
return not self.__eq__(other)
86
def _check_properties(self):
87
"""Verify that all revision properties are OK."""
88
for name, value in self.properties.iteritems():
89
if not isinstance(name, basestring) or contains_whitespace(name):
90
raise ValueError("invalid property name %r" % name)
91
if not isinstance(value, basestring):
92
raise ValueError("invalid property value %r for %r" %
95
def get_history(self, repository):
96
"""Return the canonical line-of-history for this revision.
98
If ghosts are present this may differ in result from a ghost-free
101
current_revision = self
103
while current_revision is not None:
104
reversed_result.append(current_revision.revision_id)
105
if not len (current_revision.parent_ids):
106
reversed_result.append(None)
107
current_revision = None
109
next_revision_id = current_revision.parent_ids[0]
110
current_revision = repository.get_revision(next_revision_id)
111
reversed_result.reverse()
112
return reversed_result
114
def get_summary(self):
115
"""Get the first line of the log message for this revision.
117
Return an empty string if message is None.
120
return self.message.lstrip().split('\n', 1)[0]
124
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
125
def get_apparent_author(self):
126
"""Return the apparent author of this revision.
128
This method is deprecated in favour of get_apparent_authors.
130
If the revision properties contain any author names,
131
return the first. Otherwise return the committer name.
133
authors = self.get_apparent_authors()
139
def get_apparent_authors(self):
140
"""Return the apparent authors of this revision.
142
If the revision properties contain the names of the authors,
143
return them. Otherwise return the committer name.
145
The return value will be a list containing at least one element.
147
authors = self.properties.get('authors', None)
149
author = self.properties.get('author', self.committer)
154
return authors.split("\n")
157
"""Iterate over the bugs associated with this revision."""
158
bug_property = self.properties.get('bugs', None)
159
if bug_property is None:
161
for line in bug_property.splitlines():
163
url, status = line.split(None, 2)
165
raise errors.InvalidLineInBugsProperty(line)
166
if status not in bugtracker.ALLOWED_BUG_STATUSES:
167
raise errors.InvalidBugStatus(status)
63
def is_ancestor(revision_id, candidate_id, branch):
64
"""Return true if candidate_id is an ancestor of revision_id.
66
A false negative will be returned if any intermediate descendent of
67
candidate_id is not present in any of the revision_sources.
69
revisions_source is an object supporting a get_revision operation that
70
behaves like Branch's.
72
return candidate_id in branch.get_ancestry(revision_id)
171
75
def iter_ancestors(revision_id, revision_source, only_present=False):
194
98
"""Return the ancestors of a revision present in a branch.
196
100
It's possible that a branch won't have the complete ancestry of
197
one of its revisions.
101
one of its revisions.
200
104
found_ancestors = {}
201
105
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
202
106
only_present=True))
203
107
for anc_order, (anc_id, anc_distance) in anc_iter:
204
if anc_id not in found_ancestors:
108
if not found_ancestors.has_key(anc_id):
205
109
found_ancestors[anc_id] = (anc_order, anc_distance)
206
110
return found_ancestors
209
113
def __get_closest(intersection):
210
114
intersection.sort()
212
116
for entry in intersection:
213
117
if entry[0] == intersection[0][0]:
214
118
matches.append(entry[2])
218
def is_reserved_id(revision_id):
219
"""Determine whether a revision id is reserved
221
:return: True if the revision is reserved, False otherwise
122
def old_common_ancestor(revision_a, revision_b, revision_source):
123
"""Find the ancestor common to both revisions that is closest to both.
223
return isinstance(revision_id, basestring) and revision_id.endswith(':')
226
def check_not_reserved_id(revision_id):
227
"""Raise ReservedId if the supplied revision_id is reserved"""
228
if is_reserved_id(revision_id):
229
raise errors.ReservedId(revision_id)
232
def ensure_null(revision_id):
233
"""Ensure only NULL_REVISION is used to represent the null revision"""
234
if revision_id is None:
235
symbol_versioning.warn('NULL_REVISION should be used for the null'
236
' revision instead of None, as of bzr 0.91.',
237
DeprecationWarning, stacklevel=2)
125
from bzrlib.trace import mutter
126
a_ancestors = find_present_ancestors(revision_a, revision_source)
127
b_ancestors = find_present_ancestors(revision_b, revision_source)
130
# a_order is used as a tie-breaker when two equally-good bases are found
131
for revision, (a_order, a_distance) in a_ancestors.iteritems():
132
if b_ancestors.has_key(revision):
133
a_intersection.append((a_distance, a_order, revision))
134
b_intersection.append((b_ancestors[revision][1], a_order, revision))
135
mutter("a intersection: %r" % a_intersection)
136
mutter("b intersection: %r" % b_intersection)
138
a_closest = __get_closest(a_intersection)
139
if len(a_closest) == 0:
141
b_closest = __get_closest(b_intersection)
142
assert len(b_closest) != 0
143
mutter ("a_closest %r" % a_closest)
144
mutter ("b_closest %r" % b_closest)
145
if a_closest[0] in b_closest:
147
elif b_closest[0] in a_closest:
243
def is_null(revision_id):
244
if revision_id is None:
245
symbol_versioning.warn('NULL_REVISION should be used for the null'
246
' revision instead of None, as of bzr 0.90.',
247
DeprecationWarning, stacklevel=2)
248
return revision_id in (None, NULL_REVISION)
150
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
153
def revision_graph(revision, revision_source):
154
"""Produce a graph of the ancestry of the specified revision.
155
Return root, ancestors map, descendants map
157
TODO: Produce graphs with the NULL revision as root, so that we can find
158
a common even when trees are not branches don't represent a single line
165
descendants[revision] = {}
166
while len(lines) > 0:
169
if line == NULL_REVISION:
174
rev = revision_source.get_revision(line)
175
parents = list(rev.parent_ids)
176
if len(parents) == 0:
177
parents = [NULL_REVISION]
178
except bzrlib.errors.NoSuchRevision:
182
if parents is not None:
183
for parent in parents:
184
if parent not in ancestors:
185
new_lines.add(parent)
186
if parent not in descendants:
187
descendants[parent] = {}
188
descendants[parent][line] = 1
189
if parents is not None:
190
ancestors[line] = set(parents)
192
assert root not in descendants[root]
193
assert root not in ancestors[root]
194
return root, ancestors, descendants
197
def combined_graph(revision_a, revision_b, revision_source):
198
"""Produce a combined ancestry graph.
199
Return graph root, ancestors map, descendants map, set of common nodes"""
200
root, ancestors, descendants = revision_graph(revision_a, revision_source)
201
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
204
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
206
for node, node_anc in ancestors_b.iteritems():
207
if node in ancestors:
210
ancestors[node] = set()
211
ancestors[node].update(node_anc)
212
for node, node_dec in descendants_b.iteritems():
213
if node not in descendants:
214
descendants[node] = {}
215
descendants[node].update(node_dec)
216
return root, ancestors, descendants, common
219
def common_ancestor(revision_a, revision_b, revision_source):
221
root, ancestors, descendants, common = \
222
combined_graph(revision_a, revision_b, revision_source)
223
except bzrlib.errors.NoCommonRoot:
224
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
226
distances = node_distances (descendants, ancestors, root)
227
farthest = select_farthest(distances, common)
228
if farthest is None or farthest == NULL_REVISION:
229
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
233
class MultipleRevisionSources(object):
234
"""Proxy that looks in multiple branches for revisions."""
235
def __init__(self, *args):
236
object.__init__(self)
237
assert len(args) != 0
238
self._revision_sources = args
240
def get_revision(self, revision_id):
241
for source in self._revision_sources:
243
return source.get_revision(revision_id)
244
except bzrlib.errors.NoSuchRevision, e:
248
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
249
revision_history=None):
250
"""Find the longest line of descent from maybe_ancestor to revision.
251
Revision history is followed where possible.
253
If ancestor_id == rev_id, list will be empty.
254
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
255
If ancestor_id is not an ancestor, NotAncestor will be thrown
257
root, ancestors, descendants = revision_graph(rev_id, rev_source)
258
if len(descendants) == 0:
259
raise NoSuchRevision(rev_source, rev_id)
260
if ancestor_id not in descendants:
261
rev_source.get_revision(ancestor_id)
262
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
263
root_descendants = all_descendants(descendants, ancestor_id)
264
root_descendants.add(ancestor_id)
265
if rev_id not in root_descendants:
266
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
267
distances = node_distances(descendants, ancestors, ancestor_id,
268
root_descendants=root_descendants)
270
def best_ancestor(rev_id):
272
for anc_id in ancestors[rev_id]:
274
distance = distances[anc_id]
277
if revision_history is not None and anc_id in revision_history:
279
elif best is None or distance > best[1]:
280
best = (anc_id, distance)
285
while next != ancestor_id:
287
next = best_ancestor(next)
added
removed
bzrlib/revision.py
