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
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)
36
45
class Revision(object):
70
73
def __eq__(self, other):
71
74
if not isinstance(other, Revision):
74
self.inventory_sha1 == other.inventory_sha1
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
75
78
and self.revision_id == other.revision_id
76
79
and self.timestamp == other.timestamp
77
80
and self.message == other.message
78
81
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)
82
and self.committer == other.committer)
83
84
def __ne__(self, other):
84
85
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)
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)
102
def is_ancestor(revision_id, candidate_id, branch):
103
"""Return true if candidate_id is an ancestor of revision_id.
105
A false negative will be returned if any intermediate descendent of
106
candidate_id is not present in any of the revision_sources.
108
revisions_source is an object supporting a get_revision operation that
109
behaves like Branch's.
111
return candidate_id in branch.get_ancestry(revision_id)
171
114
def iter_ancestors(revision_id, revision_source, only_present=False):
194
137
"""Return the ancestors of a revision present in a branch.
196
139
It's possible that a branch won't have the complete ancestry of
197
one of its revisions.
140
one of its revisions.
200
143
found_ancestors = {}
201
144
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
202
145
only_present=True))
203
146
for anc_order, (anc_id, anc_distance) in anc_iter:
204
if anc_id not in found_ancestors:
147
if not found_ancestors.has_key(anc_id):
205
148
found_ancestors[anc_id] = (anc_order, anc_distance)
206
149
return found_ancestors
209
152
def __get_closest(intersection):
210
153
intersection.sort()
212
155
for entry in intersection:
213
156
if entry[0] == intersection[0][0]:
214
157
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
161
def common_ancestor(revision_a, revision_b, revision_source):
162
"""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)
164
from bzrlib.trace import mutter
165
a_ancestors = find_present_ancestors(revision_a, revision_source)
166
b_ancestors = find_present_ancestors(revision_b, revision_source)
169
# a_order is used as a tie-breaker when two equally-good bases are found
170
for revision, (a_order, a_distance) in a_ancestors.iteritems():
171
if b_ancestors.has_key(revision):
172
a_intersection.append((a_distance, a_order, revision))
173
b_intersection.append((b_ancestors[revision][1], a_order, revision))
174
mutter("a intersection: %r" % a_intersection)
175
mutter("b intersection: %r" % b_intersection)
177
a_closest = __get_closest(a_intersection)
178
if len(a_closest) == 0:
180
b_closest = __get_closest(b_intersection)
181
assert len(b_closest) != 0
182
mutter ("a_closest %r" % a_closest)
183
mutter ("b_closest %r" % b_closest)
184
if a_closest[0] in b_closest:
186
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)
189
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
192
class MultipleRevisionSources(object):
193
"""Proxy that looks in multiple branches for revisions."""
194
def __init__(self, *args):
195
object.__init__(self)
196
assert len(args) != 0
197
self._revision_sources = args
199
def get_revision(self, revision_id):
200
for source in self._revision_sources:
202
return source.get_revision(revision_id)
203
except bzrlib.errors.NoSuchRevision, e:
207
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
208
revision_history=None):
209
"""Find the longest line of descent from maybe_ancestor to revision.
210
Revision history is followed where possible.
212
If ancestor_id == rev_id, list will be empty.
213
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
214
If ancestor_id is not an ancestor, NotAncestor will be thrown
216
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
217
if ancestor_id == rev_id:
219
def historical_lines(line):
220
"""Return a tuple of historical/non_historical lines, for sorting.
221
The non_historical count is negative, since non_historical lines are
226
for revision in line:
227
if revision in revision_history:
231
return good_count, bad_count
233
successful_lines = []
234
while len(active) > 0:
237
parent_ids = [p.revision_id for p in
238
rev_source.get_revision(line[-1]).parents]
239
for parent in parent_ids:
241
if parent == ancestor_id:
242
successful_lines.append(line_copy)
244
line_copy.append(parent)
245
new_active.append(line_copy)
247
if len(successful_lines) == 0:
248
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
249
for line in successful_lines:
251
if revision_history is not None:
252
by_historical_lines = []
253
for line in successful_lines:
254
count = historical_lines(line)
255
by_historical_lines.append((count, line))
256
by_historical_lines.sort()
257
if by_historical_lines[-1][0][0] > 0:
258
return by_historical_lines[-1][1]
259
assert len(successful_lines)
260
successful_lines.sort(cmp, len)
261
return successful_lines[-1]
added
removed
bzrlib/revision.py
