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
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)
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:"
45
37
class Revision(object):
73
71
def __eq__(self, other):
74
72
if not isinstance(other, Revision):
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
75
self.inventory_sha1 == other.inventory_sha1
78
76
and self.revision_id == other.revision_id
79
77
and self.timestamp == other.timestamp
80
78
and self.message == other.message
81
79
and self.timezone == other.timezone
82
and self.committer == other.committer)
80
and self.committer == other.committer
81
and self.properties == other.properties
82
and self.parent_ids == other.parent_ids)
84
84
def __ne__(self, other):
85
85
return not self.__eq__(other)
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:
87
def _check_properties(self):
88
"""Verify that all revision properties are OK."""
89
for name, value in self.properties.iteritems():
90
if not isinstance(name, basestring) or contains_whitespace(name):
91
raise ValueError("invalid property name %r" % name)
92
if not isinstance(value, basestring):
93
raise ValueError("invalid property value %r for %r" %
96
def get_history(self, repository):
97
"""Return the canonical line-of-history for this revision.
99
If ghosts are present this may differ in result from a ghost-free
102
current_revision = self
104
while current_revision is not None:
105
reversed_result.append(current_revision.revision_id)
106
if not len (current_revision.parent_ids):
107
reversed_result.append(None)
108
current_revision = None
110
next_revision_id = current_revision.parent_ids[0]
111
current_revision = repository.get_revision(next_revision_id)
112
reversed_result.reverse()
113
return reversed_result
115
def get_summary(self):
116
"""Get the first line of the log message for this revision.
118
Return an empty string if message is None.
121
return self.message.lstrip().split('\n', 1)[0]
125
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
126
def get_apparent_author(self):
127
"""Return the apparent author of this revision.
129
This method is deprecated in favour of get_apparent_authors.
131
If the revision properties contain any author names,
132
return the first. Otherwise return the committer name.
134
authors = self.get_apparent_authors()
140
def get_apparent_authors(self):
141
"""Return the apparent authors of this revision.
143
If the revision properties contain the names of the authors,
144
return them. Otherwise return the committer name.
146
The return value will be a list containing at least one element.
148
authors = self.properties.get('authors', None)
150
author = self.properties.get('author', self.committer)
155
return authors.split("\n")
158
"""Iterate over the bugs associated with this revision."""
159
bug_property = self.properties.get('bugs', None)
160
if bug_property is None:
162
for line in bug_property.splitlines():
164
url, status = line.split(None, 2)
166
raise errors.InvalidLineInBugsProperty(line)
167
if status not in bugtracker.ALLOWED_BUG_STATUSES:
168
raise errors.InvalidBugStatus(status)
115
172
def iter_ancestors(revision_id, revision_source, only_present=False):
116
173
ancestors = (revision_id,)
138
195
"""Return the ancestors of a revision present in a branch.
140
197
It's possible that a branch won't have the complete ancestry of
141
one of its revisions.
198
one of its revisions.
144
201
found_ancestors = {}
145
202
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
146
203
only_present=True))
147
204
for anc_order, (anc_id, anc_distance) in anc_iter:
148
if not found_ancestors.has_key(anc_id):
205
if anc_id not in found_ancestors:
149
206
found_ancestors[anc_id] = (anc_order, anc_distance)
150
207
return found_ancestors
153
210
def __get_closest(intersection):
154
211
intersection.sort()
156
213
for entry in intersection:
157
214
if entry[0] == intersection[0][0]:
158
215
matches.append(entry[2])
162
def common_ancestor(revision_a, revision_b, revision_source):
163
"""Find the ancestor common to both revisions that is closest to both.
219
def is_reserved_id(revision_id):
220
"""Determine whether a revision id is reserved
222
:return: True if the revision is reserved, False otherwise
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:
224
return isinstance(revision_id, basestring) and revision_id.endswith(':')
227
def check_not_reserved_id(revision_id):
228
"""Raise ReservedId if the supplied revision_id is reserved"""
229
if is_reserved_id(revision_id):
230
raise errors.ReservedId(revision_id)
233
def ensure_null(revision_id):
234
"""Ensure only NULL_REVISION is used to represent the null revision"""
235
if revision_id is None:
236
symbol_versioning.warn('NULL_REVISION should be used for the null'
237
' revision instead of None, as of bzr 0.91.',
238
DeprecationWarning, stacklevel=2)
190
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
193
class MultipleRevisionSources(object):
194
"""Proxy that looks in multiple branches for revisions."""
195
def __init__(self, *args):
196
object.__init__(self)
197
assert len(args) != 0
198
self._revision_sources = args
200
def get_revision(self, revision_id):
201
for source in self._revision_sources:
203
return source.get_revision(revision_id)
204
except bzrlib.errors.NoSuchRevision, e:
208
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
209
revision_history=None):
210
"""Find the longest line of descent from maybe_ancestor to revision.
211
Revision history is followed where possible.
213
If ancestor_id == rev_id, list will be empty.
214
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
215
If ancestor_id is not an ancestor, NotAncestor will be thrown
217
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
218
if ancestor_id == rev_id:
220
def historical_lines(line):
221
"""Return a tuple of historical/non_historical lines, for sorting.
222
The non_historical count is negative, since non_historical lines are
227
for revision in line:
228
if revision in revision_history:
232
return good_count, bad_count
234
successful_lines = []
235
while len(active) > 0:
238
parent_ids = [p.revision_id for p in
239
rev_source.get_revision(line[-1]).parents]
240
for parent in parent_ids:
242
if parent == ancestor_id:
243
successful_lines.append(line_copy)
245
line_copy.append(parent)
246
new_active.append(line_copy)
248
if len(successful_lines) == 0:
249
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
250
for line in successful_lines:
252
if revision_history is not None:
253
by_historical_lines = []
254
for line in successful_lines:
255
count = historical_lines(line)
256
by_historical_lines.append((count, line))
257
by_historical_lines.sort()
258
if by_historical_lines[-1][0][0] > 0:
259
return by_historical_lines[-1][1]
260
assert len(successful_lines)
261
successful_lines.sort(cmp, len)
262
return successful_lines[-1]
244
def is_null(revision_id):
245
if revision_id is None:
246
symbol_versioning.warn('NULL_REVISION should be used for the null'
247
' revision instead of None, as of bzr 0.90.',
248
DeprecationWarning, stacklevel=2)
249
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
