1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# TODO: Some kind of command-line display of revision properties:
17
# TODO: Some kind of command-line display of revision properties:
18
18
# perhaps show them in log -v and allow them as options to the commit command.
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
24
from bzrlib import bugtracker
22
30
from bzrlib.osutils import contains_whitespace
31
from bzrlib.progress import DummyProgress
24
33
NULL_REVISION="null:"
34
CURRENT_REVISION="current:"
26
37
class Revision(object):
27
38
"""Single revision on a branch.
69
82
return not self.__eq__(other)
71
84
def _check_properties(self):
72
"""Verify that all revision properties are OK.
85
"""Verify that all revision properties are OK."""
74
86
for name, value in self.properties.iteritems():
75
87
if not isinstance(name, basestring) or contains_whitespace(name):
76
88
raise ValueError("invalid property name %r" % name)
77
89
if not isinstance(value, basestring):
78
raise ValueError("invalid property value %r for %r" %
90
raise ValueError("invalid property value %r for %r" %
82
def is_ancestor(revision_id, candidate_id, branch):
83
"""Return true if candidate_id is an ancestor of revision_id.
85
A false negative will be returned if any intermediate descendent of
86
candidate_id is not present in any of the revision_sources.
88
revisions_source is an object supporting a get_revision operation that
89
behaves like Branch's.
91
return candidate_id in branch.get_ancestry(revision_id)
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.lstrip().split('\n', 1)[0]
117
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
118
def get_apparent_author(self):
119
"""Return the apparent author of this revision.
121
This method is deprecated in favour of get_apparent_authors.
123
If the revision properties contain any author names,
124
return the first. Otherwise return the committer name.
126
authors = self.get_apparent_authors()
132
def get_apparent_authors(self):
133
"""Return the apparent authors of this revision.
135
If the revision properties contain the names of the authors,
136
return them. Otherwise return the committer name.
138
The return value will be a list containing at least one element.
140
authors = self.properties.get('authors', None)
142
author = self.properties.get('author', self.committer)
147
return authors.split("\n")
150
"""Iterate over the bugs associated with this revision."""
151
bug_property = self.properties.get('bugs', None)
152
if bug_property is None:
154
for line in bug_property.splitlines():
156
url, status = line.split(None, 2)
158
raise errors.InvalidLineInBugsProperty(line)
159
if status not in bugtracker.ALLOWED_BUG_STATUSES:
160
raise errors.InvalidBugStatus(status)
94
164
def iter_ancestors(revision_id, revision_source, only_present=False):
117
187
"""Return the ancestors of a revision present in a branch.
119
189
It's possible that a branch won't have the complete ancestry of
120
one of its revisions.
190
one of its revisions.
123
193
found_ancestors = {}
124
194
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
125
195
only_present=True))
126
196
for anc_order, (anc_id, anc_distance) in anc_iter:
127
if not found_ancestors.has_key(anc_id):
197
if anc_id not in found_ancestors:
128
198
found_ancestors[anc_id] = (anc_order, anc_distance)
129
199
return found_ancestors
132
202
def __get_closest(intersection):
133
203
intersection.sort()
135
205
for entry in intersection:
136
206
if entry[0] == intersection[0][0]:
137
207
matches.append(entry[2])
141
def old_common_ancestor(revision_a, revision_b, revision_source):
142
"""Find the ancestor common to both revisions that is closest to both.
211
def is_reserved_id(revision_id):
212
"""Determine whether a revision id is reserved
214
:return: True if the revision is reserved, False otherwise
144
from bzrlib.trace import mutter
145
a_ancestors = find_present_ancestors(revision_a, revision_source)
146
b_ancestors = find_present_ancestors(revision_b, revision_source)
149
# a_order is used as a tie-breaker when two equally-good bases are found
150
for revision, (a_order, a_distance) in a_ancestors.iteritems():
151
if b_ancestors.has_key(revision):
152
a_intersection.append((a_distance, a_order, revision))
153
b_intersection.append((b_ancestors[revision][1], a_order, revision))
154
mutter("a intersection: %r" % a_intersection)
155
mutter("b intersection: %r" % b_intersection)
157
a_closest = __get_closest(a_intersection)
158
if len(a_closest) == 0:
160
b_closest = __get_closest(b_intersection)
161
assert len(b_closest) != 0
162
mutter ("a_closest %r" % a_closest)
163
mutter ("b_closest %r" % b_closest)
164
if a_closest[0] in b_closest:
166
elif b_closest[0] in a_closest:
216
return isinstance(revision_id, basestring) and revision_id.endswith(':')
219
def check_not_reserved_id(revision_id):
220
"""Raise ReservedId if the supplied revision_id is reserved"""
221
if is_reserved_id(revision_id):
222
raise errors.ReservedId(revision_id)
225
def ensure_null(revision_id):
226
"""Ensure only NULL_REVISION is used to represent the null revision"""
227
if revision_id is None:
228
symbol_versioning.warn('NULL_REVISION should be used for the null'
229
' revision instead of None, as of bzr 0.91.',
230
DeprecationWarning, stacklevel=2)
169
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
172
def revision_graph(revision, revision_source):
173
"""Produce a graph of the ancestry of the specified revision.
174
Return root, ancestors map, descendants map
176
TODO: Produce graphs with the NULL revision as root, so that we can find
177
a common even when trees are not branches don't represent a single line
184
descendants[revision] = {}
185
while len(lines) > 0:
188
if line == NULL_REVISION:
193
rev = revision_source.get_revision(line)
194
parents = list(rev.parent_ids)
195
if len(parents) == 0:
196
parents = [NULL_REVISION]
197
except bzrlib.errors.NoSuchRevision:
201
if parents is not None:
202
for parent in parents:
203
if parent not in ancestors:
204
new_lines.add(parent)
205
if parent not in descendants:
206
descendants[parent] = {}
207
descendants[parent][line] = 1
208
if parents is not None:
209
ancestors[line] = set(parents)
211
assert root not in descendants[root]
212
assert root not in ancestors[root]
213
return root, ancestors, descendants
216
def combined_graph(revision_a, revision_b, revision_source):
217
"""Produce a combined ancestry graph.
218
Return graph root, ancestors map, descendants map, set of common nodes"""
219
root, ancestors, descendants = revision_graph(revision_a, revision_source)
220
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
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
root, ancestors, descendants, common = \
241
combined_graph(revision_a, revision_b, revision_source)
242
except bzrlib.errors.NoCommonRoot:
243
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
245
distances = node_distances (descendants, ancestors, root)
246
farthest = select_farthest(distances, common)
247
if farthest is None or farthest == NULL_REVISION:
248
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
252
class MultipleRevisionSources(object):
253
"""Proxy that looks in multiple branches for revisions."""
254
def __init__(self, *args):
255
object.__init__(self)
256
assert len(args) != 0
257
self._revision_sources = args
259
def get_revision(self, revision_id):
260
for source in self._revision_sources:
262
return source.get_revision(revision_id)
263
except bzrlib.errors.NoSuchRevision, e:
267
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
268
revision_history=None):
269
"""Find the longest line of descent from maybe_ancestor to revision.
270
Revision history is followed where possible.
272
If ancestor_id == rev_id, list will be empty.
273
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
274
If ancestor_id is not an ancestor, NotAncestor will be thrown
276
root, ancestors, descendants = revision_graph(rev_id, rev_source)
277
if len(descendants) == 0:
278
raise NoSuchRevision(rev_source, rev_id)
279
if ancestor_id not in descendants:
280
rev_source.get_revision(ancestor_id)
281
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
282
root_descendants = all_descendants(descendants, ancestor_id)
283
root_descendants.add(ancestor_id)
284
if rev_id not in root_descendants:
285
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
286
distances = node_distances(descendants, ancestors, ancestor_id,
287
root_descendants=root_descendants)
289
def best_ancestor(rev_id):
291
for anc_id in ancestors[rev_id]:
293
distance = distances[anc_id]
296
if revision_history is not None and anc_id in revision_history:
298
elif best is None or distance > best[1]:
299
best = (anc_id, distance)
304
while next != ancestor_id:
306
next = best_ancestor(next)
236
def is_null(revision_id):
237
if revision_id is None:
238
symbol_versioning.warn('NULL_REVISION should be used for the null'
239
' revision instead of None, as of bzr 0.90.',
240
DeprecationWarning, stacklevel=2)
241
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
