1
# Copyright (C) 2005-2011 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 bugtracker
29
from bzrlib.osutils import contains_whitespace
32
CURRENT_REVISION="current:"
35
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):
36
55
"""Single revision on a branch.
38
57
Revisions may know their revision_hash, but only once they've been
40
59
into the file it describes.
42
61
After bzr 0.0.5 revisions are allowed to have multiple parents.
45
List of parent revision_ids
48
Dictionary of revision properties. These are attached to the
49
revision as extra metadata. The name must be a single
50
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.
53
def __init__(self, revision_id, properties=None, **args):
54
self.revision_id = revision_id
55
if properties is None:
58
self.properties = properties
59
self._check_properties()
62
self.parent_sha1s = []
63
"""Not used anymore - legacy from for 4."""
77
def __init__(self, **args):
64
78
self.__dict__.update(args)
81
def _get_precursor(self):
82
from warnings import warn
83
warn("Revision.precursor is deprecated", stacklevel=2)
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", stacklevel=2)
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)
66
108
def __repr__(self):
67
109
return "<Revision id %s>" % self.revision_id
69
def __eq__(self, other):
70
if not isinstance(other, Revision):
73
self.inventory_sha1 == other.inventory_sha1
74
and self.revision_id == other.revision_id
75
and self.timestamp == other.timestamp
76
and self.message == other.message
77
and self.timezone == other.timezone
78
and self.committer == other.committer
79
and self.properties == other.properties
80
and self.parent_ids == other.parent_ids)
82
def __ne__(self, other):
83
return not self.__eq__(other)
85
def _check_properties(self):
86
"""Verify that all revision properties are OK."""
87
for name, value in self.properties.iteritems():
88
if not isinstance(name, basestring) or contains_whitespace(name):
89
raise ValueError("invalid property name %r" % name)
90
if not isinstance(value, basestring):
91
raise ValueError("invalid property value %r for %r" %
94
def get_history(self, repository):
95
"""Return the canonical line-of-history for this revision.
97
If ghosts are present this may differ in result from a ghost-free
100
current_revision = self
102
while current_revision is not None:
103
reversed_result.append(current_revision.revision_id)
104
if not len (current_revision.parent_ids):
105
reversed_result.append(None)
106
current_revision = None
108
next_revision_id = current_revision.parent_ids[0]
109
current_revision = repository.get_revision(next_revision_id)
110
reversed_result.reverse()
111
return reversed_result
113
def get_summary(self):
114
"""Get the first line of the log message for this revision.
116
Return an empty string if message is None.
119
return self.message.lstrip().split('\n', 1)[0]
123
def get_apparent_authors(self):
124
"""Return the apparent authors of this revision.
126
If the revision properties contain the names of the authors,
127
return them. Otherwise return the committer name.
129
The return value will be a list containing at least one element.
131
authors = self.properties.get('authors', None)
133
author = self.properties.get('author', self.committer)
138
return authors.split("\n")
141
"""Iterate over the bugs associated with this revision."""
142
bug_property = self.properties.get('bugs', None)
143
if bug_property is None:
145
for line in bug_property.splitlines():
147
url, status = line.split(None, 2)
149
raise errors.InvalidLineInBugsProperty(line)
150
if status not in bugtracker.ALLOWED_BUG_STATUSES:
151
raise errors.InvalidBugStatus(status)
155
def iter_ancestors(revision_id, revision_source, only_present=False):
156
ancestors = (revision_id,)
158
while len(ancestors) > 0:
160
for ancestor in ancestors:
162
yield ancestor, distance
164
revision = revision_source.get_revision(ancestor)
165
except errors.NoSuchRevision, e:
166
if e.revision == revision_id:
171
yield ancestor, distance
172
new_ancestors.extend(revision.parent_ids)
173
ancestors = new_ancestors
177
def find_present_ancestors(revision_id, revision_source):
178
"""Return the ancestors of a revision present in a branch.
180
It's possible that a branch won't have the complete ancestry of
181
one of its revisions.
185
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
187
for anc_order, (anc_id, anc_distance) in anc_iter:
188
if anc_id not in found_ancestors:
189
found_ancestors[anc_id] = (anc_order, anc_distance)
190
return found_ancestors
193
def __get_closest(intersection):
196
for entry in intersection:
197
if entry[0] == intersection[0][0]:
198
matches.append(entry[2])
202
def is_reserved_id(revision_id):
203
"""Determine whether a revision id is reserved
205
:return: True if the revision is reserved, False otherwise
207
return isinstance(revision_id, basestring) and revision_id.endswith(':')
210
def check_not_reserved_id(revision_id):
211
"""Raise ReservedId if the supplied revision_id is reserved"""
212
if is_reserved_id(revision_id):
213
raise errors.ReservedId(revision_id)
216
def ensure_null(revision_id):
217
"""Ensure only NULL_REVISION is used to represent the null revision"""
218
if revision_id is None:
219
symbol_versioning.warn('NULL_REVISION should be used for the null'
220
' revision instead of None, as of bzr 0.91.',
221
DeprecationWarning, stacklevel=2)
227
def is_null(revision_id):
228
if revision_id is None:
229
symbol_versioning.warn('NULL_REVISION should be used for the null'
230
' revision instead of None, as of bzr 0.90.',
231
DeprecationWarning, stacklevel=2)
232
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))
124
msg = SubElement(root, 'message')
125
msg.text = self.message
129
# first parent stored as precursor for compatability with 0.0.5 and
132
assert pr.revision_id
133
root.set('precursor', pr.revision_id)
135
root.set('precursor_sha1', pr.revision_sha1)
138
pelts = SubElement(root, 'parents')
139
pelts.tail = pelts.text = '\n'
140
for rr in self.parents:
141
assert isinstance(rr, RevisionReference)
142
p = SubElement(pelts, 'revision_ref')
144
assert rr.revision_id
145
p.set('revision_id', rr.revision_id)
147
p.set('revision_sha1', rr.revision_sha1)
152
def from_element(cls, elt):
153
return unpack_revision(elt)
155
from_element = classmethod(from_element)
159
def unpack_revision(elt):
160
"""Convert XML element into Revision object."""
161
# <changeset> is deprecated...
162
if elt.tag not in ('revision', 'changeset'):
163
raise BzrError("unexpected tag in revision file: %r" % elt)
165
rev = Revision(committer = elt.get('committer'),
166
timestamp = float(elt.get('timestamp')),
167
revision_id = elt.get('revision_id'),
168
inventory_id = elt.get('inventory_id'),
169
inventory_sha1 = elt.get('inventory_sha1')
172
precursor = elt.get('precursor')
173
precursor_sha1 = elt.get('precursor_sha1')
175
pelts = elt.find('parents')
178
# revisions written prior to 0.0.5 have a single precursor
179
# give as an attribute
180
rev_ref = RevisionReference(precursor, precursor_sha1)
181
rev.parents.append(rev_ref)
184
assert p.tag == 'revision_ref', \
185
"bad parent node tag %r" % p.tag
186
rev_ref = RevisionReference(p.get('revision_id'),
187
p.get('revision_sha1'))
188
rev.parents.append(rev_ref)
190
v = elt.get('timezone')
191
rev.timezone = v and int(v)
193
rev.message = elt.findtext('message') # text of <message>
added
removed
bzrlib/revision.py
