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=None):
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):
51
44
After bzr 0.0.5 revisions are allowed to have multiple parents.
54
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.
64
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()
60
self.parent_sha1s = []
61
"""Not used anymore - legacy from for 4."""
65
62
self.__dict__.update(args)
69
64
def __repr__(self):
70
65
return "<Revision id %s>" % self.revision_id
74
from bzrlib.xml import Element, SubElement
76
root = Element('revision',
77
committer = self.committer,
78
timestamp = '%.9f' % self.timestamp,
79
revision_id = self.revision_id,
80
inventory_id = self.inventory_id,
81
inventory_sha1 = self.inventory_sha1,
84
root.set('timezone', str(self.timezone))
87
msg = SubElement(root, 'message')
88
msg.text = self.message
92
pelts = SubElement(root, 'parents')
93
pelts.tail = pelts.text = '\n'
94
for rr in self.parents:
95
assert isinstance(rr, RevisionReference)
96
p = SubElement(pelts, 'revision_ref')
99
p.set('revision_id', rr.revision_id)
101
p.set('revision_sha1', rr.revision_sha1)
106
def from_element(cls, elt):
107
return unpack_revision(elt)
109
from_element = classmethod(from_element)
113
def unpack_revision(elt):
114
"""Convert XML element into Revision object."""
115
# <changeset> is deprecated...
116
from bzrlib.errors import BzrError
118
if elt.tag not in ('revision', 'changeset'):
119
raise BzrError("unexpected tag in revision file: %r" % elt)
121
rev = Revision(committer = elt.get('committer'),
122
timestamp = float(elt.get('timestamp')),
123
revision_id = elt.get('revision_id'),
124
inventory_id = elt.get('inventory_id'),
125
inventory_sha1 = elt.get('inventory_sha1')
128
precursor = elt.get('precursor')
129
precursor_sha1 = elt.get('precursor_sha1')
131
pelts = elt.find('parents')
135
assert p.tag == 'revision_ref', \
136
"bad parent node tag %r" % p.tag
137
rev_ref = RevisionReference(p.get('revision_id'),
138
p.get('revision_sha1'))
139
rev.parents.append(rev_ref)
143
prec_parent = rev.parents[0].revision_id
144
assert prec_parent == precursor
146
# revisions written prior to 0.0.5 have a single precursor
147
# give as an attribute
148
rev_ref = RevisionReference(precursor, precursor_sha1)
149
rev.parents.append(rev_ref)
151
v = elt.get('timezone')
152
rev.timezone = v and int(v)
154
rev.message = elt.findtext('message') # text of <message>
159
REVISION_ID_RE = None
161
def validate_revision_id(rid):
162
"""Check rid is syntactically valid for a revision id."""
163
global REVISION_ID_RE
164
if not REVISION_ID_RE:
166
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
168
if not REVISION_ID_RE.match(rid):
169
raise ValueError("malformed revision-id %r" % rid)
171
def is_ancestor(revision_id, candidate_id, revision_source):
172
"""Return true if candidate_id is an ancestor of revision_id.
173
A false negative will be returned if any intermediate descendent of
174
candidate_id is not present in any of the revision_sources.
176
revisions_source is an object supporting a get_revision operation that
177
behaves like Branch's.
180
from bzrlib.branch import NoSuchRevision
67
def __eq__(self, other):
68
if not isinstance(other, Revision):
70
# FIXME: rbc 20050930 parent_ids are not being compared
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)
80
def __ne__(self, other):
81
return not self.__eq__(other)
83
def _check_properties(self):
84
"""Verify that all revision properties are OK."""
85
for name, value in self.properties.iteritems():
86
if not isinstance(name, basestring) or contains_whitespace(name):
87
raise ValueError("invalid property name %r" % name)
88
if not isinstance(value, basestring):
89
raise ValueError("invalid property value %r for %r" %
92
def get_history(self, repository):
93
"""Return the canonical line-of-history for this revision.
95
If ghosts are present this may differ in result from a ghost-free
98
current_revision = self
100
while current_revision is not None:
101
reversed_result.append(current_revision.revision_id)
102
if not len (current_revision.parent_ids):
103
reversed_result.append(None)
104
current_revision = None
106
next_revision_id = current_revision.parent_ids[0]
107
current_revision = repository.get_revision(next_revision_id)
108
reversed_result.reverse()
109
return reversed_result
111
def get_summary(self):
112
"""Get the first line of the log message for this revision.
114
return self.message.lstrip().split('\n', 1)[0]
116
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
117
def get_apparent_author(self):
118
"""Return the apparent author of this revision.
120
This method is deprecated in favour of get_apparent_authors.
122
If the revision properties contain any author names,
123
return the first. Otherwise return the committer name.
125
return self.get_apparent_authors()[0]
127
def get_apparent_authors(self):
128
"""Return the apparent authors of this revision.
130
If the revision properties contain the names of the authors,
131
return them. Otherwise return the committer name.
133
The return value will be a list containing at least one element.
135
authors = self.properties.get('authors', None)
137
author = self.properties.get('author', None)
139
return [self.committer]
142
return authors.split("\n")
145
"""Iterate over the bugs associated with this revision."""
146
bug_property = self.properties.get('bugs', None)
147
if bug_property is None:
149
for line in bug_property.splitlines():
151
url, status = line.split(None, 2)
153
raise errors.InvalidLineInBugsProperty(line)
154
if status not in bugtracker.ALLOWED_BUG_STATUSES:
155
raise errors.InvalidBugStatus(status)
159
def iter_ancestors(revision_id, revision_source, only_present=False):
181
160
ancestors = (revision_id,)
182
162
while len(ancestors) > 0:
183
163
new_ancestors = []
184
164
for ancestor in ancestors:
185
if ancestor == candidate_id:
166
yield ancestor, distance
188
168
revision = revision_source.get_revision(ancestor)
189
except NoSuchRevision, e:
169
except errors.NoSuchRevision, e:
190
170
if e.revision == revision_id:
194
new_ancestors.extend([p.revision_id for p in revision.parents])
175
yield ancestor, distance
176
new_ancestors.extend(revision.parent_ids)
195
177
ancestors = new_ancestors
198
class MultipleRevisionSources(object):
199
def __init__(self, *args):
200
object.__init__(self)
201
assert len(args) != 0
202
self._revision_sources = args
204
def get_revision(self, revision_id):
205
from bzrlib.branch import NoSuchRevision
206
for source in self._revision_sources:
208
return source.get_revision(revision_id)
209
except NoSuchRevision, e:
181
def find_present_ancestors(revision_id, revision_source):
182
"""Return the ancestors of a revision present in a branch.
184
It's possible that a branch won't have the complete ancestry of
185
one of its revisions.
189
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
191
for anc_order, (anc_id, anc_distance) in anc_iter:
192
if anc_id not in found_ancestors:
193
found_ancestors[anc_id] = (anc_order, anc_distance)
194
return found_ancestors
197
def __get_closest(intersection):
200
for entry in intersection:
201
if entry[0] == intersection[0][0]:
202
matches.append(entry[2])
206
def is_reserved_id(revision_id):
207
"""Determine whether a revision id is reserved
209
:return: True if the revision is reserved, False otherwise
211
return isinstance(revision_id, basestring) and revision_id.endswith(':')
214
def check_not_reserved_id(revision_id):
215
"""Raise ReservedId if the supplied revision_id is reserved"""
216
if is_reserved_id(revision_id):
217
raise errors.ReservedId(revision_id)
220
def ensure_null(revision_id):
221
"""Ensure only NULL_REVISION is used to represent the null revision"""
222
if revision_id is None:
223
symbol_versioning.warn('NULL_REVISION should be used for the null'
224
' revision instead of None, as of bzr 0.91.',
225
DeprecationWarning, stacklevel=2)
231
def is_null(revision_id):
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.90.',
235
DeprecationWarning, stacklevel=2)
236
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
