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:"
36
class Revision(object):
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from xml import XMLMixin
23
from cElementTree import Element, ElementTree, SubElement
25
from elementtree.ElementTree import Element, ElementTree, SubElement
27
from errors import BzrError
30
class RevisionReference:
32
Reference to a stored revision.
34
Includes the revision_id and revision_sha1.
38
def __init__(self, revision_id, revision_sha1):
39
if revision_id == None \
40
or isinstance(revision_id, basestring):
41
self.revision_id = revision_id
43
raise ValueError('bad revision_id %r' % revision_id)
45
if revision_sha1 != None:
46
if isinstance(revision_sha1, basestring) \
47
and len(revision_sha1) == 40:
48
self.revision_sha1 = revision_sha1
50
raise ValueError('bad revision_sha1 %r' % revision_sha1)
54
class Revision(XMLMixin):
37
55
"""Single revision on a branch.
39
57
Revisions may know their revision_hash, but only once they've been
41
59
into the file it describes.
43
61
After bzr 0.0.5 revisions are allowed to have multiple parents.
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.
62
To support old clients this is written out in a slightly redundant
63
form: the first parent as the predecessor. This will eventually
67
List of parent revisions, each is a RevisionReference.
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."""
77
def __init__(self, **args):
65
78
self.__dict__.update(args)
81
def _get_precursor(self):
82
##from warnings import warn
83
##warn("Revision.precursor is deprecated")
85
return self.parents[0].revision_id
90
def _get_precursor_sha1(self):
91
##from warnings import warn
92
##warn("Revision.precursor_sha1 is deprecated")
94
return self.parents[0].revision_sha1
100
raise Exception("can't assign to precursor anymore")
103
precursor = property(_get_precursor, _fail, _fail)
104
precursor_sha1 = property(_get_precursor_sha1, _fail, _fail)
67
108
def __repr__(self):
68
109
return "<Revision id %s>" % self.revision_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)
171
def iter_ancestors(revision_id, revision_source, only_present=False):
172
ancestors = (revision_id,)
174
while len(ancestors) > 0:
176
for ancestor in ancestors:
178
yield ancestor, distance
180
revision = revision_source.get_revision(ancestor)
181
except errors.NoSuchRevision, e:
182
if e.revision == revision_id:
187
yield ancestor, distance
188
new_ancestors.extend(revision.parent_ids)
189
ancestors = new_ancestors
193
def find_present_ancestors(revision_id, revision_source):
194
"""Return the ancestors of a revision present in a branch.
196
It's possible that a branch won't have the complete ancestry of
197
one of its revisions.
201
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
203
for anc_order, (anc_id, anc_distance) in anc_iter:
204
if anc_id not in found_ancestors:
205
found_ancestors[anc_id] = (anc_order, anc_distance)
206
return found_ancestors
209
def __get_closest(intersection):
212
for entry in intersection:
213
if entry[0] == intersection[0][0]:
214
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
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)
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)
112
def to_element(self):
113
root = Element('revision',
114
committer = self.committer,
115
timestamp = '%.9f' % self.timestamp,
116
revision_id = self.revision_id,
117
inventory_id = self.inventory_id,
118
inventory_sha1 = self.inventory_sha1,
121
root.set('timezone', str(self.timezone))
123
root.set('precursor', self.precursor)
124
if self.precursor_sha1:
125
root.set('precursor_sha1', self.precursor_sha1)
128
msg = SubElement(root, 'message')
129
msg.text = self.message
133
pelts = SubElement(root, 'parents')
134
for rr in self.parents:
135
assert isinstance(rr, RevisionReference)
136
p = SubElement(pelts, 'revision_ref')
137
p.set('revision_id', rr.revision_id)
139
p.set('revision_sha1', rr.revision_sha1)
144
def from_element(cls, elt):
145
return unpack_revision(elt)
147
from_element = classmethod(from_element)
151
def unpack_revision(elt):
152
"""Convert XML element into Revision object."""
153
# <changeset> is deprecated...
154
if elt.tag not in ('revision', 'changeset'):
155
raise BzrError("unexpected tag in revision file: %r" % elt)
157
rev = Revision(committer = elt.get('committer'),
158
timestamp = float(elt.get('timestamp')),
159
revision_id = elt.get('revision_id'),
160
inventory_id = elt.get('inventory_id'),
161
inventory_sha1 = elt.get('inventory_sha1')
164
precursor = elt.get('precursor')
165
precursor_sha1 = elt.get('precursor_sha1')
167
pelts = elt.find('parents')
170
# revisions written prior to 0.0.5 have a single precursor
171
# give as an attribute
172
rev_ref = RevisionReference(precursor, precursor_sha1)
173
rev.parents.append(rev_ref)
176
assert p.tag == 'revision_ref', \
177
"bad parent node tag %r" % p.tag
178
rev_ref = RevisionReference(p.get('revision_id'),
179
p.get('revision_sha1'))
180
rev.parents.append(rev_ref)
182
v = elt.get('timezone')
183
rev.timezone = v and int(v)
185
rev.message = elt.findtext('message') # text of <message>
added
removed
bzrlib/revision.py
