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
33
CURRENT_REVISION="current:"
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
36
21
class Revision(object):
70
50
def __eq__(self, other):
71
51
if not isinstance(other, Revision):
74
self.inventory_sha1 == other.inventory_sha1
53
return (self.inventory_id == other.inventory_id
54
and self.inventory_sha1 == other.inventory_sha1
75
55
and self.revision_id == other.revision_id
76
56
and self.timestamp == other.timestamp
77
57
and self.message == other.message
78
58
and self.timezone == other.timezone
79
and self.committer == other.committer
80
and self.properties == other.properties
81
and self.parent_ids == other.parent_ids)
59
and self.committer == other.committer)
83
61
def __ne__(self, other):
84
62
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)
68
def validate_revision_id(rid):
69
"""Check rid is syntactically valid for a revision id."""
71
if not REVISION_ID_RE:
73
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
75
if not REVISION_ID_RE.match(rid):
76
raise ValueError("malformed revision-id %r" % rid)
79
def is_ancestor(revision_id, candidate_id, branch):
80
"""Return true if candidate_id is an ancestor of revision_id.
82
A false negative will be returned if any intermediate descendent of
83
candidate_id is not present in any of the revision_sources.
85
revisions_source is an object supporting a get_revision operation that
86
behaves like Branch's.
88
return candidate_id in branch.get_ancestry(revision_id)
171
91
def iter_ancestors(revision_id, revision_source, only_present=False):
194
114
"""Return the ancestors of a revision present in a branch.
196
116
It's possible that a branch won't have the complete ancestry of
197
one of its revisions.
117
one of its revisions.
200
120
found_ancestors = {}
201
121
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
202
122
only_present=True))
203
123
for anc_order, (anc_id, anc_distance) in anc_iter:
204
if anc_id not in found_ancestors:
124
if not found_ancestors.has_key(anc_id):
205
125
found_ancestors[anc_id] = (anc_order, anc_distance)
206
126
return found_ancestors
209
129
def __get_closest(intersection):
210
130
intersection.sort()
212
132
for entry in intersection:
213
133
if entry[0] == intersection[0][0]:
214
134
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
138
def common_ancestor(revision_a, revision_b, revision_source):
139
"""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)
141
from bzrlib.trace import mutter
142
a_ancestors = find_present_ancestors(revision_a, revision_source)
143
b_ancestors = find_present_ancestors(revision_b, revision_source)
146
# a_order is used as a tie-breaker when two equally-good bases are found
147
for revision, (a_order, a_distance) in a_ancestors.iteritems():
148
if b_ancestors.has_key(revision):
149
a_intersection.append((a_distance, a_order, revision))
150
b_intersection.append((b_ancestors[revision][1], a_order, revision))
151
mutter("a intersection: %r" % a_intersection)
152
mutter("b intersection: %r" % b_intersection)
154
a_closest = __get_closest(a_intersection)
155
if len(a_closest) == 0:
157
b_closest = __get_closest(b_intersection)
158
assert len(b_closest) != 0
159
mutter ("a_closest %r" % a_closest)
160
mutter ("b_closest %r" % b_closest)
161
if a_closest[0] in b_closest:
163
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)
166
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
169
class MultipleRevisionSources(object):
170
"""Proxy that looks in multiple branches for revisions."""
171
def __init__(self, *args):
172
object.__init__(self)
173
assert len(args) != 0
174
self._revision_sources = args
176
def get_revision(self, revision_id):
177
for source in self._revision_sources:
179
return source.get_revision(revision_id)
180
except bzrlib.errors.NoSuchRevision, e:
184
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
185
revision_history=None):
186
"""Find the longest line of descent from maybe_ancestor to revision.
187
Revision history is followed where possible.
189
If ancestor_id == rev_id, list will be empty.
190
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
191
If ancestor_id is not an ancestor, NotAncestor will be thrown
193
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
194
if ancestor_id == rev_id:
196
def historical_lines(line):
197
"""Return a tuple of historical/non_historical lines, for sorting.
198
The non_historical count is negative, since non_historical lines are
203
for revision in line:
204
if revision in revision_history:
208
return good_count, bad_count
210
successful_lines = []
211
while len(active) > 0:
214
for parent in rev_source.get_revision(line[-1]).parent_ids:
216
if parent == ancestor_id:
217
successful_lines.append(line_copy)
219
line_copy.append(parent)
220
new_active.append(line_copy)
222
if len(successful_lines) == 0:
223
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
224
for line in successful_lines:
226
if revision_history is not None:
227
by_historical_lines = []
228
for line in successful_lines:
229
count = historical_lines(line)
230
by_historical_lines.append((count, line))
231
by_historical_lines.sort()
232
if by_historical_lines[-1][0][0] > 0:
233
return by_historical_lines[-1][1]
234
assert len(successful_lines)
235
successful_lines.sort(cmp, len)
236
return successful_lines[-1]
added
removed
bzrlib/revision.py
