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
20
class RevisionReference(object):
22
Reference to a stored revision.
24
Includes the revision_id and revision_sha1.
28
def __init__(self, revision_id, revision_sha1):
29
if revision_id == None \
30
or isinstance(revision_id, basestring):
31
self.revision_id = revision_id
33
raise ValueError('bad revision_id %r' % revision_id)
35
if revision_sha1 != None:
36
if isinstance(revision_sha1, basestring) \
37
and len(revision_sha1) == 40:
38
self.revision_sha1 = revision_sha1
40
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:"
44
37
class Revision(object):
49
42
into the file it describes.
51
44
After bzr 0.0.5 revisions are allowed to have multiple parents.
52
To support old clients this is written out in a slightly redundant
53
form: the first parent as the predecessor. This will eventually
57
List of parent revisions, each is a RevisionReference.
47
List of parent revision_ids
50
Dictionary of revision properties. These are attached to the
51
revision as extra metadata. The name must be a single
52
word; the value can be an arbitrary string.
67
def __init__(self, **args):
55
def __init__(self, revision_id, properties=None, **args):
56
self.revision_id = revision_id
57
self.properties = properties or {}
58
self._check_properties()
61
self.parent_sha1s = []
62
"""Not used anymore - legacy from for 4."""
68
63
self.__dict__.update(args)
71
def _get_precursor(self):
72
from warnings import warn
73
warn("Revision.precursor is deprecated", stacklevel=2)
75
return self.parents[0].revision_id
80
def _get_precursor_sha1(self):
81
from warnings import warn
82
warn("Revision.precursor_sha1 is deprecated", stacklevel=2)
84
return self.parents[0].revision_sha1
90
raise Exception("can't assign to precursor anymore")
93
precursor = property(_get_precursor, _fail, _fail)
94
precursor_sha1 = property(_get_precursor_sha1, _fail, _fail)
98
65
def __repr__(self):
99
66
return "<Revision id %s>" % self.revision_id
102
def to_element(self):
103
from bzrlib.xml import Element, SubElement
105
root = Element('revision',
106
committer = self.committer,
107
timestamp = '%.9f' % self.timestamp,
108
revision_id = self.revision_id,
109
inventory_id = self.inventory_id,
110
inventory_sha1 = self.inventory_sha1,
113
root.set('timezone', str(self.timezone))
116
msg = SubElement(root, 'message')
117
msg.text = self.message
121
# first parent stored as precursor for compatability with 0.0.5 and
124
assert pr.revision_id
125
root.set('precursor', pr.revision_id)
127
root.set('precursor_sha1', pr.revision_sha1)
130
pelts = SubElement(root, 'parents')
131
pelts.tail = pelts.text = '\n'
132
for rr in self.parents:
133
assert isinstance(rr, RevisionReference)
134
p = SubElement(pelts, 'revision_ref')
136
assert rr.revision_id
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
from bzrlib.errors import BzrError
156
if elt.tag not in ('revision', 'changeset'):
157
raise BzrError("unexpected tag in revision file: %r" % elt)
159
rev = Revision(committer = elt.get('committer'),
160
timestamp = float(elt.get('timestamp')),
161
revision_id = elt.get('revision_id'),
162
inventory_id = elt.get('inventory_id'),
163
inventory_sha1 = elt.get('inventory_sha1')
166
precursor = elt.get('precursor')
167
precursor_sha1 = elt.get('precursor_sha1')
169
pelts = elt.find('parents')
172
# revisions written prior to 0.0.5 have a single precursor
173
# give as an attribute
174
rev_ref = RevisionReference(precursor, precursor_sha1)
175
rev.parents.append(rev_ref)
178
assert p.tag == 'revision_ref', \
179
"bad parent node tag %r" % p.tag
180
rev_ref = RevisionReference(p.get('revision_id'),
181
p.get('revision_sha1'))
182
rev.parents.append(rev_ref)
184
v = elt.get('timezone')
185
rev.timezone = v and int(v)
187
rev.message = elt.findtext('message') # text of <message>
68
def __eq__(self, other):
69
if not isinstance(other, Revision):
72
self.inventory_sha1 == other.inventory_sha1
73
and self.revision_id == other.revision_id
74
and self.timestamp == other.timestamp
75
and self.message == other.message
76
and self.timezone == other.timezone
77
and self.committer == other.committer
78
and self.properties == other.properties
79
and self.parent_ids == other.parent_ids)
81
def __ne__(self, other):
82
return not self.__eq__(other)
84
def _check_properties(self):
85
"""Verify that all revision properties are OK."""
86
for name, value in self.properties.iteritems():
87
if not isinstance(name, basestring) or contains_whitespace(name):
88
raise ValueError("invalid property name %r" % name)
89
if not isinstance(value, basestring):
90
raise ValueError("invalid property value %r for %r" %
93
def get_history(self, repository):
94
"""Return the canonical line-of-history for this revision.
96
If ghosts are present this may differ in result from a ghost-free
99
current_revision = self
101
while current_revision is not None:
102
reversed_result.append(current_revision.revision_id)
103
if not len (current_revision.parent_ids):
104
reversed_result.append(None)
105
current_revision = None
107
next_revision_id = current_revision.parent_ids[0]
108
current_revision = repository.get_revision(next_revision_id)
109
reversed_result.reverse()
110
return reversed_result
112
def get_summary(self):
113
"""Get the first line of the log message for this revision.
115
Return an empty string if message is None.
118
return self.message.lstrip().split('\n', 1)[0]
122
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
123
def get_apparent_author(self):
124
"""Return the apparent author of this revision.
126
This method is deprecated in favour of get_apparent_authors.
128
If the revision properties contain any author names,
129
return the first. Otherwise return the committer name.
131
authors = self.get_apparent_authors()
137
def get_apparent_authors(self):
138
"""Return the apparent authors of this revision.
140
If the revision properties contain the names of the authors,
141
return them. Otherwise return the committer name.
143
The return value will be a list containing at least one element.
145
authors = self.properties.get('authors', None)
147
author = self.properties.get('author', self.committer)
152
return authors.split("\n")
155
"""Iterate over the bugs associated with this revision."""
156
bug_property = self.properties.get('bugs', None)
157
if bug_property is None:
159
for line in bug_property.splitlines():
161
url, status = line.split(None, 2)
163
raise errors.InvalidLineInBugsProperty(line)
164
if status not in bugtracker.ALLOWED_BUG_STATUSES:
165
raise errors.InvalidBugStatus(status)
169
def iter_ancestors(revision_id, revision_source, only_present=False):
170
ancestors = (revision_id,)
172
while len(ancestors) > 0:
174
for ancestor in ancestors:
176
yield ancestor, distance
178
revision = revision_source.get_revision(ancestor)
179
except errors.NoSuchRevision, e:
180
if e.revision == revision_id:
185
yield ancestor, distance
186
new_ancestors.extend(revision.parent_ids)
187
ancestors = new_ancestors
191
def find_present_ancestors(revision_id, revision_source):
192
"""Return the ancestors of a revision present in a branch.
194
It's possible that a branch won't have the complete ancestry of
195
one of its revisions.
199
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
201
for anc_order, (anc_id, anc_distance) in anc_iter:
202
if anc_id not in found_ancestors:
203
found_ancestors[anc_id] = (anc_order, anc_distance)
204
return found_ancestors
207
def __get_closest(intersection):
210
for entry in intersection:
211
if entry[0] == intersection[0][0]:
212
matches.append(entry[2])
216
def is_reserved_id(revision_id):
217
"""Determine whether a revision id is reserved
219
:return: True if the revision is reserved, False otherwise
221
return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
def check_not_reserved_id(revision_id):
225
"""Raise ReservedId if the supplied revision_id is reserved"""
226
if is_reserved_id(revision_id):
227
raise errors.ReservedId(revision_id)
230
def ensure_null(revision_id):
231
"""Ensure only NULL_REVISION is used to represent the null revision"""
232
if revision_id is None:
233
symbol_versioning.warn('NULL_REVISION should be used for the null'
234
' revision instead of None, as of bzr 0.91.',
235
DeprecationWarning, stacklevel=2)
241
def is_null(revision_id):
242
if revision_id is None:
243
symbol_versioning.warn('NULL_REVISION should be used for the null'
244
' revision instead of None, as of bzr 0.90.',
245
DeprecationWarning, stacklevel=2)
246
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
