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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
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
21
32
NULL_REVISION="null:"
33
CURRENT_REVISION="current:"
23
36
class Revision(object):
24
37
"""Single revision on a branch.
45
70
def __eq__(self, other):
46
71
if not isinstance(other, Revision):
48
# FIXME: rbc 20050930 parent_ids are not being compared
50
74
self.inventory_sha1 == other.inventory_sha1
51
75
and self.revision_id == other.revision_id
52
76
and self.timestamp == other.timestamp
53
77
and self.message == other.message
54
78
and self.timezone == other.timezone
55
and self.committer == other.committer)
79
and self.committer == other.committer
80
and self.properties == other.properties
81
and self.parent_ids == other.parent_ids)
57
83
def __ne__(self, other):
58
84
return not self.__eq__(other)
63
def validate_revision_id(rid):
64
"""Check rid is syntactically valid for a revision id."""
66
if not REVISION_ID_RE:
68
REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
70
if not REVISION_ID_RE.match(rid):
71
raise ValueError("malformed revision-id %r" % rid)
74
def is_ancestor(revision_id, candidate_id, branch):
75
"""Return true if candidate_id is an ancestor of revision_id.
77
A false negative will be returned if any intermediate descendent of
78
candidate_id is not present in any of the revision_sources.
80
revisions_source is an object supporting a get_revision operation that
81
behaves like Branch's.
83
return candidate_id in branch.get_ancestry(revision_id)
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)
86
171
def iter_ancestors(revision_id, revision_source, only_present=False):
109
194
"""Return the ancestors of a revision present in a branch.
111
196
It's possible that a branch won't have the complete ancestry of
112
one of its revisions.
197
one of its revisions.
115
200
found_ancestors = {}
116
201
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
117
202
only_present=True))
118
203
for anc_order, (anc_id, anc_distance) in anc_iter:
119
if not found_ancestors.has_key(anc_id):
204
if anc_id not in found_ancestors:
120
205
found_ancestors[anc_id] = (anc_order, anc_distance)
121
206
return found_ancestors
124
209
def __get_closest(intersection):
125
210
intersection.sort()
127
212
for entry in intersection:
128
213
if entry[0] == intersection[0][0]:
129
214
matches.append(entry[2])
133
def old_common_ancestor(revision_a, revision_b, revision_source):
134
"""Find the ancestor common to both revisions that is closest to both.
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
136
from bzrlib.trace import mutter
137
a_ancestors = find_present_ancestors(revision_a, revision_source)
138
b_ancestors = find_present_ancestors(revision_b, revision_source)
141
# a_order is used as a tie-breaker when two equally-good bases are found
142
for revision, (a_order, a_distance) in a_ancestors.iteritems():
143
if b_ancestors.has_key(revision):
144
a_intersection.append((a_distance, a_order, revision))
145
b_intersection.append((b_ancestors[revision][1], a_order, revision))
146
mutter("a intersection: %r" % a_intersection)
147
mutter("b intersection: %r" % b_intersection)
149
a_closest = __get_closest(a_intersection)
150
if len(a_closest) == 0:
152
b_closest = __get_closest(b_intersection)
153
assert len(b_closest) != 0
154
mutter ("a_closest %r" % a_closest)
155
mutter ("b_closest %r" % b_closest)
156
if a_closest[0] in b_closest:
158
elif b_closest[0] in a_closest:
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)
161
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
164
def revision_graph(revision, revision_source):
165
"""Produce a graph of the ancestry of the specified revision.
166
Return root, ancestors map, descendants map
168
TODO: Produce graphs with the NULL revision as root, so that we can find
169
a common even when trees are not branches don't represent a single line
176
descendants[revision] = {}
177
while len(lines) > 0:
180
if line == NULL_REVISION:
185
rev = revision_source.get_revision(line)
186
parents = list(rev.parent_ids)
187
if len(parents) == 0:
188
parents = [NULL_REVISION]
189
except bzrlib.errors.NoSuchRevision:
193
if parents is not None:
194
for parent in parents:
195
if parent not in ancestors:
196
new_lines.add(parent)
197
if parent not in descendants:
198
descendants[parent] = {}
199
descendants[parent][line] = 1
200
if parents is not None:
201
ancestors[line] = set(parents)
203
assert root not in descendants[root]
204
assert root not in ancestors[root]
205
return root, ancestors, descendants
208
def combined_graph(revision_a, revision_b, revision_source):
209
"""Produce a combined ancestry graph.
210
Return graph root, ancestors map, descendants map, set of common nodes"""
211
root, ancestors, descendants = revision_graph(revision_a, revision_source)
212
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
215
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
217
for node, node_anc in ancestors_b.iteritems():
218
if node in ancestors:
221
ancestors[node] = set()
222
ancestors[node].update(node_anc)
223
for node, node_dec in descendants_b.iteritems():
224
if node not in descendants:
225
descendants[node] = {}
226
descendants[node].update(node_dec)
227
return root, ancestors, descendants, common
230
def common_ancestor(revision_a, revision_b, revision_source):
232
root, ancestors, descendants, common = \
233
combined_graph(revision_a, revision_b, revision_source)
234
except bzrlib.errors.NoCommonRoot:
235
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
237
distances = node_distances (descendants, ancestors, root)
238
farthest = select_farthest(distances, common)
239
if farthest is None or farthest == NULL_REVISION:
240
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
244
class MultipleRevisionSources(object):
245
"""Proxy that looks in multiple branches for revisions."""
246
def __init__(self, *args):
247
object.__init__(self)
248
assert len(args) != 0
249
self._revision_sources = args
251
def get_revision(self, revision_id):
252
for source in self._revision_sources:
254
return source.get_revision(revision_id)
255
except bzrlib.errors.NoSuchRevision, e:
259
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
260
revision_history=None):
261
"""Find the longest line of descent from maybe_ancestor to revision.
262
Revision history is followed where possible.
264
If ancestor_id == rev_id, list will be empty.
265
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
266
If ancestor_id is not an ancestor, NotAncestor will be thrown
268
root, ancestors, descendants = revision_graph(rev_id, rev_source)
269
if len(descendants) == 0:
270
raise NoSuchRevision(rev_source, rev_id)
271
if ancestor_id not in descendants:
272
rev_source.get_revision(ancestor_id)
273
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
274
root_descendants = all_descendants(descendants, ancestor_id)
275
root_descendants.add(ancestor_id)
276
if rev_id not in root_descendants:
277
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
278
distances = node_distances(descendants, ancestors, ancestor_id,
279
root_descendants=root_descendants)
281
def best_ancestor(rev_id):
283
for anc_id in ancestors[rev_id]:
285
distance = distances[anc_id]
288
if revision_history is not None and anc_id in revision_history:
290
elif best is None or distance > best[1]:
291
best = (anc_id, distance)
296
while next != ancestor_id:
298
next = best_ancestor(next)
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)
added
removed
bzrlib/revision.py
