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., 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
from __future__ import absolute_import
19
# TODO: Some kind of command-line display of revision properties:
20
# perhaps show them in log -v and allow them as options to the commit command.
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
25
from bzrlib import bugtracker
31
from bzrlib.osutils import contains_whitespace
34
CURRENT_REVISION="current:"
45
37
class Revision(object):
52
44
After bzr 0.0.5 revisions are allowed to have multiple parents.
55
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.
65
def __init__(self, **args):
55
def __init__(self, revision_id, properties=None, **args):
56
self.revision_id = revision_id
57
if properties is None:
60
self.properties = properties
61
self._check_properties()
64
self.parent_sha1s = []
65
"""Not used anymore - legacy from for 4."""
66
66
self.__dict__.update(args)
70
68
def __repr__(self):
71
69
return "<Revision id %s>" % self.revision_id
75
from bzrlib.xml import Element, SubElement
77
root = Element('revision',
78
committer = self.committer,
79
timestamp = '%.9f' % self.timestamp,
80
revision_id = self.revision_id,
81
inventory_id = self.inventory_id,
82
inventory_sha1 = self.inventory_sha1,
85
root.set('timezone', str(self.timezone))
88
msg = SubElement(root, 'message')
89
msg.text = self.message
93
pelts = SubElement(root, 'parents')
94
pelts.tail = pelts.text = '\n'
95
for rr in self.parents:
96
assert isinstance(rr, RevisionReference)
97
p = SubElement(pelts, 'revision_ref')
100
p.set('revision_id', rr.revision_id)
102
p.set('revision_sha1', rr.revision_sha1)
107
def from_element(cls, elt):
108
return unpack_revision(elt)
110
from_element = classmethod(from_element)
114
def unpack_revision(elt):
115
"""Convert XML element into Revision object."""
116
# <changeset> is deprecated...
117
if elt.tag not in ('revision', 'changeset'):
118
raise bzrlib.errors.BzrError("unexpected tag in revision file: %r" % elt)
120
rev = Revision(committer = elt.get('committer'),
121
timestamp = float(elt.get('timestamp')),
122
revision_id = elt.get('revision_id'),
123
inventory_id = elt.get('inventory_id'),
124
inventory_sha1 = elt.get('inventory_sha1')
127
precursor = elt.get('precursor')
128
precursor_sha1 = elt.get('precursor_sha1')
130
pelts = elt.find('parents')
134
assert p.tag == 'revision_ref', \
135
"bad parent node tag %r" % p.tag
136
rev_ref = RevisionReference(p.get('revision_id'),
137
p.get('revision_sha1'))
138
rev.parents.append(rev_ref)
142
prec_parent = rev.parents[0].revision_id
143
assert prec_parent == precursor
145
# revisions written prior to 0.0.5 have a single precursor
146
# give as an attribute
147
rev_ref = RevisionReference(precursor, precursor_sha1)
148
rev.parents.append(rev_ref)
150
v = elt.get('timezone')
151
rev.timezone = v and int(v)
153
rev.message = elt.findtext('message') # text of <message>
158
REVISION_ID_RE = None
160
def validate_revision_id(rid):
161
"""Check rid is syntactically valid for a revision id."""
162
global REVISION_ID_RE
163
if not REVISION_ID_RE:
165
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
167
if not REVISION_ID_RE.match(rid):
168
raise ValueError("malformed revision-id %r" % rid)
170
def is_ancestor(revision_id, candidate_id, revision_source):
171
"""Return true if candidate_id is an ancestor of revision_id.
172
A false negative will be returned if any intermediate descendent of
173
candidate_id is not present in any of the revision_sources.
175
revisions_source is an object supporting a get_revision operation that
176
behaves like Branch's.
71
def __eq__(self, other):
72
if not isinstance(other, Revision):
75
self.inventory_sha1 == other.inventory_sha1
76
and self.revision_id == other.revision_id
77
and self.timestamp == other.timestamp
78
and self.message == other.message
79
and self.timezone == other.timezone
80
and self.committer == other.committer
81
and self.properties == other.properties
82
and self.parent_ids == other.parent_ids)
84
def __ne__(self, other):
85
return not self.__eq__(other)
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
def get_apparent_authors(self):
126
"""Return the apparent authors of this revision.
128
If the revision properties contain the names of the authors,
129
return them. Otherwise return the committer name.
131
The return value will be a list containing at least one element.
133
authors = self.properties.get('authors', None)
135
author = self.properties.get('author', self.committer)
140
return authors.split("\n")
143
"""Iterate over the bugs associated with this revision."""
144
bug_property = self.properties.get('bugs', None)
145
if bug_property is None:
147
for line in bug_property.splitlines():
149
url, status = line.split(None, 2)
151
raise errors.InvalidLineInBugsProperty(line)
152
if status not in bugtracker.ALLOWED_BUG_STATUSES:
153
raise errors.InvalidBugStatus(status)
157
def iter_ancestors(revision_id, revision_source, only_present=False):
179
158
ancestors = (revision_id,)
180
160
while len(ancestors) > 0:
181
161
new_ancestors = []
182
162
for ancestor in ancestors:
183
if ancestor == candidate_id:
164
yield ancestor, distance
186
166
revision = revision_source.get_revision(ancestor)
187
except bzrlib.errors.NoSuchRevision, e:
167
except errors.NoSuchRevision, e:
188
168
if e.revision == revision_id:
192
new_ancestors.extend([p.revision_id for p in revision.parents])
173
yield ancestor, distance
174
new_ancestors.extend(revision.parent_ids)
193
175
ancestors = new_ancestors
196
class MultipleRevisionSources(object):
197
def __init__(self, *args):
198
object.__init__(self)
199
assert len(args) != 0
200
self._revision_sources = args
202
def get_revision(self, revision_id):
203
for source in self._revision_sources:
205
return source.get_revision(revision_id)
206
except bzrlib.errors.NoSuchRevision, e:
179
def find_present_ancestors(revision_id, revision_source):
180
"""Return the ancestors of a revision present in a branch.
182
It's possible that a branch won't have the complete ancestry of
183
one of its revisions.
187
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
189
for anc_order, (anc_id, anc_distance) in anc_iter:
190
if anc_id not in found_ancestors:
191
found_ancestors[anc_id] = (anc_order, anc_distance)
192
return found_ancestors
195
def __get_closest(intersection):
198
for entry in intersection:
199
if entry[0] == intersection[0][0]:
200
matches.append(entry[2])
204
def is_reserved_id(revision_id):
205
"""Determine whether a revision id is reserved
207
:return: True if the revision is reserved, False otherwise
209
return isinstance(revision_id, basestring) and revision_id.endswith(':')
212
def check_not_reserved_id(revision_id):
213
"""Raise ReservedId if the supplied revision_id is reserved"""
214
if is_reserved_id(revision_id):
215
raise errors.ReservedId(revision_id)
218
def ensure_null(revision_id):
219
"""Ensure only NULL_REVISION is used to represent the null revision"""
220
if revision_id is None:
221
symbol_versioning.warn('NULL_REVISION should be used for the null'
222
' revision instead of None, as of bzr 0.91.',
223
DeprecationWarning, stacklevel=2)
229
def is_null(revision_id):
230
if revision_id is None:
231
symbol_versioning.warn('NULL_REVISION should be used for the null'
232
' revision instead of None, as of bzr 0.90.',
233
DeprecationWarning, stacklevel=2)
234
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
