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., 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
31
from bzrlib.progress import DummyProgress
34
CURRENT_REVISION="current:"
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from bzrlib.graph import farthest_nodes, node_distances, all_descendants
21
class RevisionReference(object):
23
Reference to a stored revision.
25
Includes the revision_id and revision_sha1.
29
def __init__(self, revision_id, revision_sha1=None):
30
if revision_id == None \
31
or isinstance(revision_id, basestring):
32
self.revision_id = revision_id
34
raise ValueError('bad revision_id %r' % revision_id)
36
if revision_sha1 != None:
37
if isinstance(revision_sha1, basestring) \
38
and len(revision_sha1) == 40:
39
self.revision_sha1 = revision_sha1
41
raise ValueError('bad revision_sha1 %r' % revision_sha1)
37
45
class Revision(object):
67
73
def __eq__(self, other):
68
74
if not isinstance(other, Revision):
70
# FIXME: rbc 20050930 parent_ids are not being compared
72
self.inventory_sha1 == other.inventory_sha1
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
73
78
and self.revision_id == other.revision_id
74
79
and self.timestamp == other.timestamp
75
80
and self.message == other.message
76
81
and self.timezone == other.timezone
77
and self.committer == other.committer
78
and self.properties == other.properties)
82
and self.committer == other.committer)
80
84
def __ne__(self, other):
81
85
return not self.__eq__(other)
83
def _check_properties(self):
84
"""Verify that all revision properties are OK."""
85
for name, value in self.properties.iteritems():
86
if not isinstance(name, basestring) or contains_whitespace(name):
87
raise ValueError("invalid property name %r" % name)
88
if not isinstance(value, basestring):
89
raise ValueError("invalid property value %r for %r" %
92
def get_history(self, repository):
93
"""Return the canonical line-of-history for this revision.
95
If ghosts are present this may differ in result from a ghost-free
98
current_revision = self
100
while current_revision is not None:
101
reversed_result.append(current_revision.revision_id)
102
if not len (current_revision.parent_ids):
103
reversed_result.append(None)
104
current_revision = None
106
next_revision_id = current_revision.parent_ids[0]
107
current_revision = repository.get_revision(next_revision_id)
108
reversed_result.reverse()
109
return reversed_result
111
def get_summary(self):
112
"""Get the first line of the log message for this revision.
114
return self.message.lstrip().split('\n', 1)[0]
116
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
117
def get_apparent_author(self):
118
"""Return the apparent author of this revision.
120
This method is deprecated in favour of get_apparent_authors.
122
If the revision properties contain any author names,
123
return the first. Otherwise return the committer name.
125
return self.get_apparent_authors()[0]
127
def get_apparent_authors(self):
128
"""Return the apparent authors of this revision.
130
If the revision properties contain the names of the authors,
131
return them. Otherwise return the committer name.
133
The return value will be a list containing at least one element.
135
authors = self.properties.get('authors', None)
137
author = self.properties.get('author', None)
139
return [self.committer]
142
return authors.split("\n")
145
"""Iterate over the bugs associated with this revision."""
146
bug_property = self.properties.get('bugs', None)
147
if bug_property is None:
149
for line in bug_property.splitlines():
151
url, status = line.split(None, 2)
153
raise errors.InvalidLineInBugsProperty(line)
154
if status not in bugtracker.ALLOWED_BUG_STATUSES:
155
raise errors.InvalidBugStatus(status)
91
def validate_revision_id(rid):
92
"""Check rid is syntactically valid for a revision id."""
94
if not REVISION_ID_RE:
96
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
98
if not REVISION_ID_RE.match(rid):
99
raise ValueError("malformed revision-id %r" % rid)
101
def is_ancestor(revision_id, candidate_id, revision_source):
102
"""Return true if candidate_id is an ancestor of revision_id.
103
A false negative will be returned if any intermediate descendent of
104
candidate_id is not present in any of the revision_sources.
106
revisions_source is an object supporting a get_revision operation that
107
behaves like Branch's.
110
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
if ancestor_id == candidate_id:
159
115
def iter_ancestors(revision_id, revision_source, only_present=False):
160
116
ancestors = (revision_id,)
182
138
"""Return the ancestors of a revision present in a branch.
184
140
It's possible that a branch won't have the complete ancestry of
185
one of its revisions.
141
one of its revisions.
188
144
found_ancestors = {}
189
145
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
190
146
only_present=True))
191
147
for anc_order, (anc_id, anc_distance) in anc_iter:
192
if anc_id not in found_ancestors:
148
if not found_ancestors.has_key(anc_id):
193
149
found_ancestors[anc_id] = (anc_order, anc_distance)
194
150
return found_ancestors
197
153
def __get_closest(intersection):
198
154
intersection.sort()
200
156
for entry in intersection:
201
157
if entry[0] == intersection[0][0]:
202
158
matches.append(entry[2])
206
def is_reserved_id(revision_id):
207
"""Determine whether a revision id is reserved
209
:return: True if the revision is is reserved, False otherwise
162
def old_common_ancestor(revision_a, revision_b, revision_source):
163
"""Find the ancestor common to both revisions that is closest to both.
211
return isinstance(revision_id, basestring) and revision_id.endswith(':')
214
def check_not_reserved_id(revision_id):
215
"""Raise ReservedId if the supplied revision_id is reserved"""
216
if is_reserved_id(revision_id):
217
raise errors.ReservedId(revision_id)
220
def ensure_null(revision_id):
221
"""Ensure only NULL_REVISION is used to represent the null revision"""
222
if revision_id is None:
223
symbol_versioning.warn('NULL_REVISION should be used for the null'
224
' revision instead of None, as of bzr 0.91.',
225
DeprecationWarning, stacklevel=2)
165
from bzrlib.trace import mutter
166
a_ancestors = find_present_ancestors(revision_a, revision_source)
167
b_ancestors = find_present_ancestors(revision_b, revision_source)
170
# a_order is used as a tie-breaker when two equally-good bases are found
171
for revision, (a_order, a_distance) in a_ancestors.iteritems():
172
if b_ancestors.has_key(revision):
173
a_intersection.append((a_distance, a_order, revision))
174
b_intersection.append((b_ancestors[revision][1], a_order, revision))
175
mutter("a intersection: %r" % a_intersection)
176
mutter("b intersection: %r" % b_intersection)
178
a_closest = __get_closest(a_intersection)
179
if len(a_closest) == 0:
181
b_closest = __get_closest(b_intersection)
182
assert len(b_closest) != 0
183
mutter ("a_closest %r" % a_closest)
184
mutter ("b_closest %r" % b_closest)
185
if a_closest[0] in b_closest:
187
elif b_closest[0] in a_closest:
231
def is_null(revision_id):
232
if revision_id is None:
233
symbol_versioning.warn('NULL_REVISION should be used for the null'
234
' revision instead of None, as of bzr 0.90.',
235
DeprecationWarning, stacklevel=2)
236
return revision_id in (None, NULL_REVISION)
190
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
193
def revision_graph(revision, revision_source):
194
"""Produce a graph of the ancestry of the specified revision.
195
Return root, ancestors map, descendants map
197
TODO: Produce graphs with the NULL revision as root, so that we can find
198
a common even when trees are not branches don't represent a single line
205
descendants[revision] = {}
206
while len(lines) > 0:
210
rev = revision_source.get_revision(line)
211
parents = [p.revision_id for p in rev.parents]
212
if len(parents) == 0:
214
except bzrlib.errors.NoSuchRevision:
218
if parents is not None:
219
for parent in parents:
220
if parent not in ancestors:
221
new_lines.add(parent)
222
if parent not in descendants:
223
descendants[parent] = {}
224
descendants[parent][line] = 1
225
if parents is not None:
226
ancestors[line] = set(parents)
228
assert root not in descendants[root]
229
assert root not in ancestors[root]
230
return root, ancestors, descendants
232
def combined_graph(revision_a, revision_b, revision_source):
233
"""Produce a combined ancestry graph.
234
Return graph root, ancestors map, descendants map, set of common nodes"""
235
root, ancestors, descendants = revision_graph(revision_a, revision_source)
236
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
239
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
241
for node, node_anc in ancestors_b.iteritems():
242
if node in ancestors:
245
ancestors[node] = set()
246
ancestors[node].update(node_anc)
247
for node, node_dec in descendants_b.iteritems():
248
if node not in descendants:
249
descendants[node] = set()
250
descendants[node].update(node_dec)
251
return root, ancestors, descendants, common
253
def common_ancestor(revision_a, revision_b, revision_source):
255
root, ancestors, descendants, common = \
256
combined_graph(revision_a, revision_b, revision_source)
257
except bzrlib.errors.NoCommonRoot:
258
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
260
nodes = farthest_nodes(descendants, ancestors, root)
264
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
266
class MultipleRevisionSources(object):
267
"""Proxy that looks in multiple branches for revisions."""
268
def __init__(self, *args):
269
object.__init__(self)
270
assert len(args) != 0
271
self._revision_sources = args
273
def get_revision(self, revision_id):
274
for source in self._revision_sources:
276
return source.get_revision(revision_id)
277
except bzrlib.errors.NoSuchRevision, e:
281
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
282
revision_history=None):
283
"""Find the longest line of descent from maybe_ancestor to revision.
284
Revision history is followed where possible.
286
If ancestor_id == rev_id, list will be empty.
287
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
288
If ancestor_id is not an ancestor, NotAncestor will be thrown
290
root, ancestors, descendants = revision_graph(rev_id, rev_source)
291
if len(descendants) == 0:
292
raise NoSuchRevision(rev_source, rev_id)
293
if ancestor_id not in descendants:
294
rev_source.get_revision(ancestor_id)
295
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
296
root_descendants = all_descendants(descendants, ancestor_id)
297
root_descendants.add(ancestor_id)
298
if rev_id not in root_descendants:
299
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
300
distances = node_distances(descendants, ancestors, ancestor_id,
301
root_descendants=root_descendants)
303
def best_ancestor(rev_id):
305
for anc_id in ancestors[rev_id]:
307
distance = distances[anc_id]
310
if revision_history is not None and anc_id in revision_history:
312
elif best is None or distance > best[1]:
313
best = (anc_id, distance)
318
while next != ancestor_id:
320
next = best_ancestor(next)
added
removed
bzrlib/revision.py
