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.
18
21
import bzrlib.errors
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)
22
import bzrlib.errors as errors
23
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
24
from bzrlib.osutils import contains_whitespace
25
from bzrlib.progress import DummyProgress
45
29
class Revision(object):
46
30
"""Single revision on a branch.
52
36
After bzr 0.0.5 revisions are allowed to have multiple parents.
55
List of parent revisions, each is a RevisionReference.
39
List of parent revision_ids
42
Dictionary of revision properties. These are attached to the
43
revision as extra metadata. The name must be a single
44
word; the value can be an arbitrary string.
65
def __init__(self, **args):
47
def __init__(self, revision_id, properties=None, **args):
48
self.revision_id = revision_id
49
self.properties = properties or {}
50
self._check_properties()
52
self.parent_sha1s = []
66
53
self.__dict__.update(args)
70
55
def __repr__(self):
71
56
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):
58
def __eq__(self, other):
59
if not isinstance(other, Revision):
61
# FIXME: rbc 20050930 parent_ids are not being compared
63
self.inventory_sha1 == other.inventory_sha1
64
and self.revision_id == other.revision_id
65
and self.timestamp == other.timestamp
66
and self.message == other.message
67
and self.timezone == other.timezone
68
and self.committer == other.committer
69
and self.properties == other.properties)
71
def __ne__(self, other):
72
return not self.__eq__(other)
74
def _check_properties(self):
75
"""Verify that all revision properties are OK.
77
for name, value in self.properties.iteritems():
78
if not isinstance(name, basestring) or contains_whitespace(name):
79
raise ValueError("invalid property name %r" % name)
80
if not isinstance(value, basestring):
81
raise ValueError("invalid property value %r for %r" %
84
def get_history(self, repository):
85
"""Return the canonical line-of-history for this revision.
87
If ghosts are present this may differ in result from a ghost-free
90
current_revision = self
92
while current_revision is not None:
93
reversed_result.append(current_revision.revision_id)
94
if not len (current_revision.parent_ids):
95
reversed_result.append(None)
96
current_revision = None
98
next_revision_id = current_revision.parent_ids[0]
99
current_revision = repository.get_revision(next_revision_id)
100
reversed_result.reverse()
101
return reversed_result
104
def is_ancestor(revision_id, candidate_id, branch):
171
105
"""Return true if candidate_id is an ancestor of revision_id.
172
107
A false negative will be returned if any intermediate descendent of
173
108
candidate_id is not present in any of the revision_sources.
175
110
revisions_source is an object supporting a get_revision operation that
176
111
behaves like Branch's.
113
return candidate_id in branch.repository.get_ancestry(revision_id)
116
def iter_ancestors(revision_id, revision_source, only_present=False):
179
117
ancestors = (revision_id,)
180
119
while len(ancestors) > 0:
181
120
new_ancestors = []
182
121
for ancestor in ancestors:
183
if ancestor == candidate_id:
123
yield ancestor, distance
186
125
revision = revision_source.get_revision(ancestor)
187
126
except bzrlib.errors.NoSuchRevision, e:
192
new_ancestors.extend([p.revision_id for p in revision.parents])
132
yield ancestor, distance
133
new_ancestors.extend(revision.parent_ids)
193
134
ancestors = new_ancestors
138
def find_present_ancestors(revision_id, revision_source):
139
"""Return the ancestors of a revision present in a branch.
141
It's possible that a branch won't have the complete ancestry of
142
one of its revisions.
146
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
148
for anc_order, (anc_id, anc_distance) in anc_iter:
149
if not found_ancestors.has_key(anc_id):
150
found_ancestors[anc_id] = (anc_order, anc_distance)
151
return found_ancestors
154
def __get_closest(intersection):
157
for entry in intersection:
158
if entry[0] == intersection[0][0]:
159
matches.append(entry[2])
163
def revision_graph(revision, revision_source):
164
"""Produce a graph of the ancestry of the specified revision.
166
:return: root, ancestors map, descendants map
168
revision_source.lock_read()
170
return _revision_graph(revision, revision_source)
172
revision_source.unlock()
175
def _revision_graph(revision, revision_source):
176
"""See revision_graph."""
177
from bzrlib.tsort import topo_sort
178
graph = revision_source.get_revision_graph(revision)
179
# mark all no-parent revisions as being NULL_REVISION parentage.
180
for node, parents in graph.items():
181
if len(parents) == 0:
182
graph[node] = [NULL_REVISION]
183
# add NULL_REVISION to the graph
184
graph[NULL_REVISION] = []
186
# pick a root. If there are multiple roots
187
# this could pick a random one.
188
topo_order = topo_sort(graph.items())
194
# map the descendants of the graph.
195
# and setup our set based return graph.
196
for node in graph.keys():
197
descendants[node] = {}
198
for node, parents in graph.items():
199
for parent in parents:
200
descendants[parent][node] = 1
201
ancestors[node] = set(parents)
203
assert root not in descendants[root]
204
assert root not in ancestors[root]
205
return root, ancestors, descendants
208
def combined_graph(revision_a, revision_b, revision_source):
209
"""Produce a combined ancestry graph.
210
Return graph root, ancestors map, descendants map, set of common nodes"""
211
root, ancestors, descendants = revision_graph(
212
revision_a, revision_source)
213
root_b, ancestors_b, descendants_b = revision_graph(
214
revision_b, revision_source)
216
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
218
for node, node_anc in ancestors_b.iteritems():
219
if node in ancestors:
222
ancestors[node] = set()
223
ancestors[node].update(node_anc)
224
for node, node_dec in descendants_b.iteritems():
225
if node not in descendants:
226
descendants[node] = {}
227
descendants[node].update(node_dec)
228
return root, ancestors, descendants, common
231
def common_ancestor(revision_a, revision_b, revision_source,
233
if None in (revision_a, revision_b):
235
# trivial optimisation
236
if revision_a == revision_b:
240
pb.update('Picking ancestor', 1, 3)
241
graph = revision_source.get_revision_graph_with_ghosts(
242
[revision_a, revision_b])
243
# convert to a NULL_REVISION based graph.
244
ancestors = graph.get_ancestors()
245
descendants = graph.get_descendants()
246
common = set(graph.get_ancestry(revision_a)).intersection(
247
set(graph.get_ancestry(revision_b)))
248
descendants[NULL_REVISION] = {}
249
ancestors[NULL_REVISION] = []
250
for root in graph.roots:
251
descendants[NULL_REVISION][root] = 1
252
ancestors[root].append(NULL_REVISION)
253
for ghost in graph.ghosts:
254
# ghosts act as roots for the purpose of finding
255
# the longest paths from the root: any ghost *might*
256
# be directly attached to the root, so we treat them
258
# ghost now descends from NULL
259
descendants[NULL_REVISION][ghost] = 1
260
# that is it has an ancestor of NULL
261
ancestors[ghost] = [NULL_REVISION]
262
# ghost is common if any of ghosts descendants are common:
263
for ghost_descendant in descendants[ghost]:
264
if ghost_descendant in common:
268
common.add(NULL_REVISION)
269
except bzrlib.errors.NoCommonRoot:
270
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
272
pb.update('Picking ancestor', 2, 3)
273
distances = node_distances (descendants, ancestors, root)
274
pb.update('Picking ancestor', 3, 2)
275
farthest = select_farthest(distances, common)
276
if farthest is None or farthest == NULL_REVISION:
277
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
196
283
class MultipleRevisionSources(object):
284
"""Proxy that looks in multiple branches for revisions."""
197
285
def __init__(self, *args):
198
286
object.__init__(self)
199
287
assert len(args) != 0
200
288
self._revision_sources = args
290
def revision_parents(self, revision_id):
291
for source in self._revision_sources:
293
return source.revision_parents(revision_id)
294
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
202
298
def get_revision(self, revision_id):
203
299
for source in self._revision_sources:
206
302
except bzrlib.errors.NoSuchRevision, e:
306
def get_revision_graph(self, revision_id):
307
# we could probe incrementally until the pending
308
# ghosts list stop growing, but its cheaper for now
309
# to just ask for the complete graph for each repository.
311
for source in self._revision_sources:
312
ghost_graph = source.get_revision_graph_with_ghosts()
313
graphs.append(ghost_graph)
316
if not revision_id in graph.get_ancestors():
318
if absent == len(graphs):
319
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
323
pending = set([revision_id])
324
def find_parents(node_id):
325
"""find the parents for node_id."""
327
ancestors = graph.get_ancestors()
329
return ancestors[node_id]
332
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
334
# all the graphs should have identical parent lists
335
node_id = pending.pop()
337
result[node_id] = find_parents(node_id)
338
for parent_node in result[node_id]:
339
if not parent_node in result:
340
pending.add(parent_node)
341
except errors.NoSuchRevision:
346
def get_revision_graph_with_ghosts(self, revision_ids):
347
# query all the sources for their entire graphs
348
# and then build a combined graph for just
351
for source in self._revision_sources:
352
ghost_graph = source.get_revision_graph_with_ghosts()
353
graphs.append(ghost_graph.get_ancestors())
354
for revision_id in revision_ids:
357
if not revision_id in graph:
359
if absent == len(graphs):
360
raise errors.NoSuchRevision(self._revision_sources[0],
365
pending = set(revision_ids)
367
def find_parents(node_id):
368
"""find the parents for node_id."""
371
return graph[node_id]
374
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
376
# all the graphs should have identical parent lists
377
node_id = pending.pop()
379
parents = find_parents(node_id)
380
for parent_node in parents:
382
if (parent_node not in pending and
383
parent_node not in done):
385
pending.add(parent_node)
386
result.add_node(node_id, parents)
388
except errors.NoSuchRevision:
390
result.add_ghost(node_id)
395
for source in self._revision_sources:
399
for source in self._revision_sources:
403
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
404
revision_history=None):
405
"""Find the longest line of descent from maybe_ancestor to revision.
406
Revision history is followed where possible.
408
If ancestor_id == rev_id, list will be empty.
409
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
410
If ancestor_id is not an ancestor, NotAncestor will be thrown
412
root, ancestors, descendants = revision_graph(rev_id, rev_source)
413
if len(descendants) == 0:
414
raise NoSuchRevision(rev_source, rev_id)
415
if ancestor_id not in descendants:
416
rev_source.get_revision(ancestor_id)
417
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
418
root_descendants = all_descendants(descendants, ancestor_id)
419
root_descendants.add(ancestor_id)
420
if rev_id not in root_descendants:
421
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
422
distances = node_distances(descendants, ancestors, ancestor_id,
423
root_descendants=root_descendants)
425
def best_ancestor(rev_id):
427
for anc_id in ancestors[rev_id]:
429
distance = distances[anc_id]
432
if revision_history is not None and anc_id in revision_history:
434
elif best is None or distance > best[1]:
435
best = (anc_id, distance)
440
while next != ancestor_id:
442
next = best_ancestor(next)
added
removed
bzrlib/revision.py
