14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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.
20
18
import bzrlib.errors
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
22
from bzrlib.osutils import contains_whitespace
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)
26
45
class Revision(object):
27
46
"""Single revision on a branch.
33
52
After bzr 0.0.5 revisions are allowed to have multiple parents.
36
List of parent revision_ids
39
Dictionary of revision properties. These are attached to the
40
revision as extra metadata. The name must be a single
41
word; the value can be an arbitrary string.
55
List of parent revisions, each is a RevisionReference.
44
def __init__(self, revision_id, properties=None, **args):
45
self.revision_id = revision_id
46
self.properties = properties or {}
47
self._check_properties()
65
def __init__(self, **args):
48
66
self.__dict__.update(args)
50
self.parent_sha1s = []
52
70
def __repr__(self):
53
71
return "<Revision id %s>" % self.revision_id
55
def __eq__(self, other):
56
if not isinstance(other, Revision):
58
# FIXME: rbc 20050930 parent_ids are not being compared
60
self.inventory_sha1 == other.inventory_sha1
61
and self.revision_id == other.revision_id
62
and self.timestamp == other.timestamp
63
and self.message == other.message
64
and self.timezone == other.timezone
65
and self.committer == other.committer
66
and self.properties == other.properties)
68
def __ne__(self, other):
69
return not self.__eq__(other)
71
def _check_properties(self):
72
"""Verify that all revision properties are OK.
74
for name, value in self.properties.iteritems():
75
if not isinstance(name, basestring) or contains_whitespace(name):
76
raise ValueError("invalid property name %r" % name)
77
if not isinstance(value, basestring):
78
raise ValueError("invalid property value %r for %r" %
82
def is_ancestor(revision_id, candidate_id, branch):
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):
83
171
"""Return true if candidate_id is an ancestor of revision_id.
85
172
A false negative will be returned if any intermediate descendent of
86
173
candidate_id is not present in any of the revision_sources.
88
175
revisions_source is an object supporting a get_revision operation that
89
176
behaves like Branch's.
91
return candidate_id in branch.get_ancestry(revision_id)
179
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
180
if ancestor_id == candidate_id:
94
184
def iter_ancestors(revision_id, revision_source, only_present=False):
95
185
ancestors = (revision_id,)
169
259
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
170
260
return a_closest[0]
172
def revision_graph(revision, revision_source):
173
"""Produce a graph of the ancestry of the specified revision.
174
Return root, ancestors map, descendants map
176
TODO: Produce graphs with the NULL revision as root, so that we can find
177
a common even when trees are not branches don't represent a single line
184
descendants[revision] = {}
185
while len(lines) > 0:
188
if line == NULL_REVISION:
193
rev = revision_source.get_revision(line)
194
parents = list(rev.parent_ids)
195
if len(parents) == 0:
196
parents = [NULL_REVISION]
197
except bzrlib.errors.NoSuchRevision:
201
if parents is not None:
202
for parent in parents:
203
if parent not in ancestors:
204
new_lines.add(parent)
205
if parent not in descendants:
206
descendants[parent] = {}
207
descendants[parent][line] = 1
208
if parents is not None:
209
ancestors[line] = set(parents)
211
assert root not in descendants[root]
212
assert root not in ancestors[root]
213
return root, ancestors, descendants
216
def combined_graph(revision_a, revision_b, revision_source):
217
"""Produce a combined ancestry graph.
218
Return graph root, ancestors map, descendants map, set of common nodes"""
219
root, ancestors, descendants = revision_graph(revision_a, revision_source)
220
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
223
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
225
for node, node_anc in ancestors_b.iteritems():
226
if node in ancestors:
229
ancestors[node] = set()
230
ancestors[node].update(node_anc)
231
for node, node_dec in descendants_b.iteritems():
232
if node not in descendants:
233
descendants[node] = {}
234
descendants[node].update(node_dec)
235
return root, ancestors, descendants, common
238
def common_ancestor(revision_a, revision_b, revision_source):
240
root, ancestors, descendants, common = \
241
combined_graph(revision_a, revision_b, revision_source)
242
except bzrlib.errors.NoCommonRoot:
243
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
245
distances = node_distances (descendants, ancestors, root)
246
farthest = select_farthest(distances, common)
247
if farthest is None or farthest == NULL_REVISION:
248
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
252
262
class MultipleRevisionSources(object):
253
263
"""Proxy that looks in multiple branches for revisions."""
254
264
def __init__(self, *args):
273
283
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
274
284
If ancestor_id is not an ancestor, NotAncestor will be thrown
276
root, ancestors, descendants = revision_graph(rev_id, rev_source)
277
if len(descendants) == 0:
278
raise NoSuchRevision(rev_source, rev_id)
279
if ancestor_id not in descendants:
280
rev_source.get_revision(ancestor_id)
281
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
282
root_descendants = all_descendants(descendants, ancestor_id)
283
root_descendants.add(ancestor_id)
284
if rev_id not in root_descendants:
285
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
286
distances = node_distances(descendants, ancestors, ancestor_id,
287
root_descendants=root_descendants)
289
def best_ancestor(rev_id):
291
for anc_id in ancestors[rev_id]:
293
distance = distances[anc_id]
296
if revision_history is not None and anc_id in revision_history:
298
elif best is None or distance > best[1]:
299
best = (anc_id, distance)
304
while next != ancestor_id:
306
next = best_ancestor(next)
286
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
287
if ancestor_id == rev_id:
289
def historical_lines(line):
290
"""Return a tuple of historical/non_historical lines, for sorting.
291
The non_historical count is negative, since non_historical lines are
296
for revision in line:
297
if revision in revision_history:
301
return good_count, bad_count
303
successful_lines = []
304
while len(active) > 0:
307
parent_ids = [p.revision_id for p in
308
rev_source.get_revision(line[-1]).parents]
309
for parent in parent_ids:
311
if parent == ancestor_id:
312
successful_lines.append(line_copy)
314
line_copy.append(parent)
315
new_active.append(line_copy)
317
if len(successful_lines) == 0:
318
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
319
for line in successful_lines:
321
if revision_history is not None:
322
by_historical_lines = []
323
for line in successful_lines:
324
count = historical_lines(line)
325
by_historical_lines.append((count, line))
326
by_historical_lines.sort()
327
if by_historical_lines[-1][0][0] > 0:
328
return by_historical_lines[-1][1]
329
assert len(successful_lines)
330
successful_lines.sort(cmp, len)
331
return successful_lines[-1]
added
removed
bzrlib/revision.py
