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
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
33
CURRENT_REVISION="current:"
45
36
class Revision(object):
52
43
After bzr 0.0.5 revisions are allowed to have multiple parents.
55
List of parent revisions, each is a RevisionReference.
46
List of parent revision_ids
49
Dictionary of revision properties. These are attached to the
50
revision as extra metadata. The name must be a single
51
word; the value can be an arbitrary string.
65
def __init__(self, **args):
54
def __init__(self, revision_id, properties=None, **args):
55
self.revision_id = revision_id
56
if properties is None:
59
self.properties = properties
60
self._check_properties()
63
self.parent_sha1s = []
64
"""Not used anymore - legacy from for 4."""
66
65
self.__dict__.update(args)
70
67
def __repr__(self):
71
68
return "<Revision id %s>" % self.revision_id
77
def validate_revision_id(rid):
78
"""Check rid is syntactically valid for a revision id."""
80
if not REVISION_ID_RE:
82
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
84
if not REVISION_ID_RE.match(rid):
85
raise ValueError("malformed revision-id %r" % rid)
87
def is_ancestor(revision_id, candidate_id, revision_source):
88
"""Return true if candidate_id is an ancestor of revision_id.
89
A false negative will be returned if any intermediate descendent of
90
candidate_id is not present in any of the revision_sources.
92
revisions_source is an object supporting a get_revision operation that
93
behaves like Branch's.
96
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
97
if ancestor_id == candidate_id:
70
def __eq__(self, other):
71
if not isinstance(other, Revision):
74
self.inventory_sha1 == other.inventory_sha1
75
and self.revision_id == other.revision_id
76
and self.timestamp == other.timestamp
77
and self.message == other.message
78
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)
83
def __ne__(self, other):
84
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)
101
171
def iter_ancestors(revision_id, revision_source, only_present=False):
102
172
ancestors = (revision_id,)
124
194
"""Return the ancestors of a revision present in a branch.
126
196
It's possible that a branch won't have the complete ancestry of
127
one of its revisions.
197
one of its revisions.
130
200
found_ancestors = {}
131
201
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
132
202
only_present=True))
133
203
for anc_order, (anc_id, anc_distance) in anc_iter:
134
if not found_ancestors.has_key(anc_id):
204
if anc_id not in found_ancestors:
135
205
found_ancestors[anc_id] = (anc_order, anc_distance)
136
206
return found_ancestors
139
209
def __get_closest(intersection):
140
210
intersection.sort()
142
212
for entry in intersection:
143
213
if entry[0] == intersection[0][0]:
144
214
matches.append(entry[2])
148
def common_ancestor(revision_a, revision_b, revision_source):
149
"""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
151
from bzrlib.trace import mutter
152
a_ancestors = find_present_ancestors(revision_a, revision_source)
153
b_ancestors = find_present_ancestors(revision_b, revision_source)
156
# a_order is used as a tie-breaker when two equally-good bases are found
157
for revision, (a_order, a_distance) in a_ancestors.iteritems():
158
if b_ancestors.has_key(revision):
159
a_intersection.append((a_distance, a_order, revision))
160
b_intersection.append((b_ancestors[revision][1], a_order, revision))
161
mutter("a intersection: %r" % a_intersection)
162
mutter("b intersection: %r" % b_intersection)
164
a_closest = __get_closest(a_intersection)
165
if len(a_closest) == 0:
167
b_closest = __get_closest(b_intersection)
168
assert len(b_closest) != 0
169
mutter ("a_closest %r" % a_closest)
170
mutter ("b_closest %r" % b_closest)
171
if a_closest[0] in b_closest:
173
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)
176
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
179
class MultipleRevisionSources(object):
180
"""Proxy that looks in multiple branches for revisions."""
181
def __init__(self, *args):
182
object.__init__(self)
183
assert len(args) != 0
184
self._revision_sources = args
186
def get_revision(self, revision_id):
187
for source in self._revision_sources:
189
return source.get_revision(revision_id)
190
except bzrlib.errors.NoSuchRevision, e:
194
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
195
revision_history=None):
196
"""Find the longest line of descent from maybe_ancestor to revision.
197
Revision history is followed where possible.
199
If ancestor_id == rev_id, list will be empty.
200
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
201
If ancestor_id is not an ancestor, NotAncestor will be thrown
203
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
204
if ancestor_id == rev_id:
206
def historical_lines(line):
207
"""Return a tuple of historical/non_historical lines, for sorting.
208
The non_historical count is negative, since non_historical lines are
213
for revision in line:
214
if revision in revision_history:
218
return good_count, bad_count
220
successful_lines = []
221
while len(active) > 0:
224
parent_ids = [p.revision_id for p in
225
rev_source.get_revision(line[-1]).parents]
226
for parent in parent_ids:
228
if parent == ancestor_id:
229
successful_lines.append(line_copy)
231
line_copy.append(parent)
232
new_active.append(line_copy)
234
if len(successful_lines) == 0:
235
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
236
for line in successful_lines:
238
if revision_history is not None:
239
by_historical_lines = []
240
for line in successful_lines:
241
count = historical_lines(line)
242
by_historical_lines.append((count, line))
243
by_historical_lines.sort()
244
if by_historical_lines[-1][0][0] > 0:
245
return by_historical_lines[-1][1]
246
assert len(successful_lines)
247
successful_lines.sort(cmp, len)
248
return successful_lines[-1]
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
