1
# Copyright (C) 2005, 2006 Canonical
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
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.
21
import bzrlib.errors as errors
22
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
23
from bzrlib.osutils import contains_whitespace
24
from bzrlib.progress import DummyProgress
25
from bzrlib.symbol_versioning import (deprecated_function,
32
class Revision(object):
20
from xml import XMLMixin
23
from cElementTree import Element, ElementTree, SubElement
25
from elementtree.ElementTree import Element, ElementTree, SubElement
27
from errors import BzrError
30
class Revision(XMLMixin):
33
31
"""Single revision on a branch.
35
33
Revisions may know their revision_hash, but only once they've been
36
34
written out. This is not stored because you cannot write the hash
37
35
into the file it describes.
39
After bzr 0.0.5 revisions are allowed to have multiple parents.
42
List of parent revision_ids
45
Dictionary of revision properties. These are attached to the
46
revision as extra metadata. The name must be a single
47
word; the value can be an arbitrary string.
37
TODO: Perhaps make predecessor be a child element, not an attribute?
50
def __init__(self, revision_id, properties=None, **args):
51
self.revision_id = revision_id
52
self.properties = properties or {}
53
self._check_properties()
55
self.parent_sha1s = []
56
"""Not used anymore - legacy from for 4."""
39
def __init__(self, **args):
40
self.inventory_id = None
41
self.revision_id = None
57
47
self.__dict__.update(args)
59
50
def __repr__(self):
60
51
return "<Revision id %s>" % self.revision_id
62
def __eq__(self, other):
63
if not isinstance(other, Revision):
65
# FIXME: rbc 20050930 parent_ids are not being compared
67
self.inventory_sha1 == other.inventory_sha1
68
and self.revision_id == other.revision_id
69
and self.timestamp == other.timestamp
70
and self.message == other.message
71
and self.timezone == other.timezone
72
and self.committer == other.committer
73
and self.properties == other.properties)
75
def __ne__(self, other):
76
return not self.__eq__(other)
78
def _check_properties(self):
79
"""Verify that all revision properties are OK."""
80
for name, value in self.properties.iteritems():
81
if not isinstance(name, basestring) or contains_whitespace(name):
82
raise ValueError("invalid property name %r" % name)
83
if not isinstance(value, basestring):
84
raise ValueError("invalid property value %r for %r" %
87
def get_history(self, repository):
88
"""Return the canonical line-of-history for this revision.
90
If ghosts are present this may differ in result from a ghost-free
93
current_revision = self
95
while current_revision is not None:
96
reversed_result.append(current_revision.revision_id)
97
if not len (current_revision.parent_ids):
98
reversed_result.append(None)
99
current_revision = None
101
next_revision_id = current_revision.parent_ids[0]
102
current_revision = repository.get_revision(next_revision_id)
103
reversed_result.reverse()
104
return reversed_result
106
def get_summary(self):
107
"""Get the first line of the log message for this revision.
109
return self.message.split('\n', 1)[0]
112
def is_ancestor(revision_id, candidate_id, branch):
113
"""Return true if candidate_id is an ancestor of revision_id.
115
A false negative will be returned if any intermediate descendent of
116
candidate_id is not present in any of the revision_sources.
118
revisions_source is an object supporting a get_revision operation that
119
behaves like Branch's.
121
return candidate_id in branch.repository.get_ancestry(revision_id)
124
def iter_ancestors(revision_id, revision_source, only_present=False):
125
ancestors = (revision_id,)
127
while len(ancestors) > 0:
129
for ancestor in ancestors:
131
yield ancestor, distance
133
revision = revision_source.get_revision(ancestor)
134
except errors.NoSuchRevision, e:
135
if e.revision == revision_id:
140
yield ancestor, distance
141
new_ancestors.extend(revision.parent_ids)
142
ancestors = new_ancestors
146
def find_present_ancestors(revision_id, revision_source):
147
"""Return the ancestors of a revision present in a branch.
149
It's possible that a branch won't have the complete ancestry of
150
one of its revisions.
154
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
156
for anc_order, (anc_id, anc_distance) in anc_iter:
157
if not found_ancestors.has_key(anc_id):
158
found_ancestors[anc_id] = (anc_order, anc_distance)
159
return found_ancestors
162
def __get_closest(intersection):
165
for entry in intersection:
166
if entry[0] == intersection[0][0]:
167
matches.append(entry[2])
171
def revision_graph(revision, revision_source):
172
"""Produce a graph of the ancestry of the specified revision.
174
:return: root, ancestors map, descendants map
176
revision_source.lock_read()
178
return _revision_graph(revision, revision_source)
180
revision_source.unlock()
183
def _revision_graph(revision, revision_source):
184
"""See revision_graph."""
185
from bzrlib.tsort import topo_sort
186
graph = revision_source.get_revision_graph(revision)
187
# mark all no-parent revisions as being NULL_REVISION parentage.
188
for node, parents in graph.items():
189
if len(parents) == 0:
190
graph[node] = [NULL_REVISION]
191
# add NULL_REVISION to the graph
192
graph[NULL_REVISION] = []
194
# pick a root. If there are multiple roots
195
# this could pick a random one.
196
topo_order = topo_sort(graph.items())
202
# map the descendants of the graph.
203
# and setup our set based return graph.
204
for node in graph.keys():
205
descendants[node] = {}
206
for node, parents in graph.items():
207
for parent in parents:
208
descendants[parent][node] = 1
209
ancestors[node] = 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(
220
revision_a, revision_source)
221
root_b, ancestors_b, descendants_b = revision_graph(
222
revision_b, revision_source)
224
raise errors.NoCommonRoot(revision_a, revision_b)
226
for node, node_anc in ancestors_b.iteritems():
227
if node in ancestors:
230
ancestors[node] = set()
231
ancestors[node].update(node_anc)
232
for node, node_dec in descendants_b.iteritems():
233
if node not in descendants:
234
descendants[node] = {}
235
descendants[node].update(node_dec)
236
return root, ancestors, descendants, common
239
def common_ancestor(revision_a, revision_b, revision_source,
241
if None in (revision_a, revision_b):
243
if NULL_REVISION in (revision_a, revision_b):
245
# trivial optimisation
246
if revision_a == revision_b:
250
pb.update('Picking ancestor', 1, 3)
251
graph = revision_source.get_revision_graph_with_ghosts(
252
[revision_a, revision_b])
253
# convert to a NULL_REVISION based graph.
254
ancestors = graph.get_ancestors()
255
descendants = graph.get_descendants()
256
common = set(graph.get_ancestry(revision_a)).intersection(
257
set(graph.get_ancestry(revision_b)))
258
descendants[NULL_REVISION] = {}
259
ancestors[NULL_REVISION] = []
260
for root in graph.roots:
261
descendants[NULL_REVISION][root] = 1
262
ancestors[root].append(NULL_REVISION)
263
for ghost in graph.ghosts:
264
# ghosts act as roots for the purpose of finding
265
# the longest paths from the root: any ghost *might*
266
# be directly attached to the root, so we treat them
268
# ghost now descends from NULL
269
descendants[NULL_REVISION][ghost] = 1
270
# that is it has an ancestor of NULL
271
ancestors[ghost] = [NULL_REVISION]
272
# ghost is common if any of ghosts descendants are common:
273
for ghost_descendant in descendants[ghost]:
274
if ghost_descendant in common:
278
common.add(NULL_REVISION)
279
except errors.NoCommonRoot:
280
raise errors.NoCommonAncestor(revision_a, revision_b)
282
pb.update('Picking ancestor', 2, 3)
283
distances = node_distances (descendants, ancestors, root)
284
pb.update('Picking ancestor', 3, 2)
285
farthest = select_farthest(distances, common)
286
if farthest is None or farthest == NULL_REVISION:
287
raise errors.NoCommonAncestor(revision_a, revision_b)
293
class MultipleRevisionSources(object):
294
"""Proxy that looks in multiple branches for revisions."""
295
def __init__(self, *args):
296
object.__init__(self)
297
assert len(args) != 0
298
self._revision_sources = args
300
def revision_parents(self, revision_id):
301
for source in self._revision_sources:
303
return source.revision_parents(revision_id)
304
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
308
def get_revision(self, revision_id):
309
for source in self._revision_sources:
311
return source.get_revision(revision_id)
312
except errors.NoSuchRevision, e:
316
def get_revision_graph(self, revision_id):
317
# we could probe incrementally until the pending
318
# ghosts list stop growing, but its cheaper for now
319
# to just ask for the complete graph for each repository.
321
for source in self._revision_sources:
322
ghost_graph = source.get_revision_graph_with_ghosts()
323
graphs.append(ghost_graph)
326
if not revision_id in graph.get_ancestors():
328
if absent == len(graphs):
329
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
333
pending = set([revision_id])
334
def find_parents(node_id):
335
"""find the parents for node_id."""
337
ancestors = graph.get_ancestors()
339
return ancestors[node_id]
342
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
344
# all the graphs should have identical parent lists
345
node_id = pending.pop()
347
result[node_id] = find_parents(node_id)
348
for parent_node in result[node_id]:
349
if not parent_node in result:
350
pending.add(parent_node)
351
except errors.NoSuchRevision:
356
def get_revision_graph_with_ghosts(self, revision_ids):
357
# query all the sources for their entire graphs
358
# and then build a combined graph for just
361
for source in self._revision_sources:
362
ghost_graph = source.get_revision_graph_with_ghosts()
363
graphs.append(ghost_graph.get_ancestors())
364
for revision_id in revision_ids:
367
if not revision_id in graph:
369
if absent == len(graphs):
370
raise errors.NoSuchRevision(self._revision_sources[0],
375
pending = set(revision_ids)
377
def find_parents(node_id):
378
"""find the parents for node_id."""
381
return graph[node_id]
384
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
386
# all the graphs should have identical parent lists
387
node_id = pending.pop()
389
parents = find_parents(node_id)
390
for parent_node in parents:
392
if (parent_node not in pending and
393
parent_node not in done):
395
pending.add(parent_node)
396
result.add_node(node_id, parents)
398
except errors.NoSuchRevision:
400
result.add_ghost(node_id)
405
for source in self._revision_sources:
409
for source in self._revision_sources:
413
@deprecated_function(zero_eight)
414
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
415
revision_history=None):
416
"""Find the longest line of descent from maybe_ancestor to revision.
417
Revision history is followed where possible.
419
If ancestor_id == rev_id, list will be empty.
420
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
421
If ancestor_id is not an ancestor, NotAncestor will be thrown
423
root, ancestors, descendants = revision_graph(rev_id, rev_source)
424
if len(descendants) == 0:
425
raise errors.NoSuchRevision(rev_source, rev_id)
426
if ancestor_id not in descendants:
427
rev_source.get_revision(ancestor_id)
428
raise errors.NotAncestor(rev_id, ancestor_id)
429
root_descendants = all_descendants(descendants, ancestor_id)
430
root_descendants.add(ancestor_id)
431
if rev_id not in root_descendants:
432
raise errors.NotAncestor(rev_id, ancestor_id)
433
distances = node_distances(descendants, ancestors, ancestor_id,
434
root_descendants=root_descendants)
436
def best_ancestor(rev_id):
438
for anc_id in ancestors[rev_id]:
440
distance = distances[anc_id]
443
if revision_history is not None and anc_id in revision_history:
445
elif best is None or distance > best[1]:
446
best = (anc_id, distance)
451
while next != ancestor_id:
453
next = best_ancestor(next)
55
root = Element('revision',
56
committer = self.committer,
57
timestamp = '%.9f' % self.timestamp,
58
revision_id = self.revision_id,
59
inventory_id = self.inventory_id,
60
timezone = str(self.timezone))
62
root.set('precursor', self.precursor)
65
msg = SubElement(root, 'message')
66
msg.text = self.message
72
def from_element(cls, elt):
73
# <changeset> is deprecated...
74
if elt.tag not in ('revision', 'changeset'):
75
raise BzrError("unexpected tag in revision file: %r" % elt)
77
cs = cls(committer = elt.get('committer'),
78
timestamp = float(elt.get('timestamp')),
79
precursor = elt.get('precursor'),
80
revision_id = elt.get('revision_id'),
81
inventory_id = elt.get('inventory_id'))
83
v = elt.get('timezone')
84
cs.timezone = v and int(v)
86
cs.message = elt.findtext('message') # text of <message>
89
from_element = classmethod(from_element)
added
removed
bzrlib/revision.py
