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
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.
25
from bzrlib.deprecated_graph import (
31
from bzrlib.osutils import contains_whitespace
32
from bzrlib.progress import DummyProgress
33
from bzrlib.symbol_versioning import (deprecated_function,
37
CURRENT_REVISION="current:"
40
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):
41
31
"""Single revision on a branch.
43
33
Revisions may know their revision_hash, but only once they've been
44
34
written out. This is not stored because you cannot write the hash
45
35
into the file it describes.
47
After bzr 0.0.5 revisions are allowed to have multiple parents.
50
List of parent revision_ids
53
Dictionary of revision properties. These are attached to the
54
revision as extra metadata. The name must be a single
55
word; the value can be an arbitrary string.
37
TODO: Perhaps make predecessor be a child element, not an attribute?
58
def __init__(self, revision_id, properties=None, **args):
59
self.revision_id = revision_id
60
self.properties = properties or {}
61
self._check_properties()
63
self.parent_sha1s = []
64
"""Not used anymore - legacy from for 4."""
39
def __init__(self, **args):
40
self.inventory_id = None
41
self.revision_id = None
65
47
self.__dict__.update(args)
67
50
def __repr__(self):
68
51
return "<Revision id %s>" % self.revision_id
70
def __eq__(self, other):
71
if not isinstance(other, Revision):
73
# FIXME: rbc 20050930 parent_ids are not being compared
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)
83
def __ne__(self, other):
84
return not self.__eq__(other)
86
def _check_properties(self):
87
"""Verify that all revision properties are OK."""
88
for name, value in self.properties.iteritems():
89
if not isinstance(name, basestring) or contains_whitespace(name):
90
raise ValueError("invalid property name %r" % name)
91
if not isinstance(value, basestring):
92
raise ValueError("invalid property value %r for %r" %
95
def get_history(self, repository):
96
"""Return the canonical line-of-history for this revision.
98
If ghosts are present this may differ in result from a ghost-free
101
current_revision = self
103
while current_revision is not None:
104
reversed_result.append(current_revision.revision_id)
105
if not len (current_revision.parent_ids):
106
reversed_result.append(None)
107
current_revision = None
109
next_revision_id = current_revision.parent_ids[0]
110
current_revision = repository.get_revision(next_revision_id)
111
reversed_result.reverse()
112
return reversed_result
114
def get_summary(self):
115
"""Get the first line of the log message for this revision.
117
return self.message.lstrip().split('\n', 1)[0]
119
def get_apparent_author(self):
120
"""Return the apparent author of this revision.
122
If the revision properties contain the author name,
123
return it. Otherwise return the committer name.
125
return self.properties.get('author', self.committer)
128
def is_ancestor(revision_id, candidate_id, branch):
129
"""Return true if candidate_id is an ancestor of revision_id.
131
A false negative will be returned if any intermediate descendent of
132
candidate_id is not present in any of the revision_sources.
134
revisions_source is an object supporting a get_revision operation that
135
behaves like Branch's.
137
if is_null(candidate_id):
139
return (candidate_id in branch.repository.get_ancestry(revision_id,
143
def iter_ancestors(revision_id, revision_source, only_present=False):
144
ancestors = (revision_id,)
146
while len(ancestors) > 0:
148
for ancestor in ancestors:
150
yield ancestor, distance
152
revision = revision_source.get_revision(ancestor)
153
except errors.NoSuchRevision, e:
154
if e.revision == revision_id:
159
yield ancestor, distance
160
new_ancestors.extend(revision.parent_ids)
161
ancestors = new_ancestors
165
def find_present_ancestors(revision_id, revision_source):
166
"""Return the ancestors of a revision present in a branch.
168
It's possible that a branch won't have the complete ancestry of
169
one of its revisions.
173
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
175
for anc_order, (anc_id, anc_distance) in anc_iter:
176
if anc_id not in found_ancestors:
177
found_ancestors[anc_id] = (anc_order, anc_distance)
178
return found_ancestors
181
def __get_closest(intersection):
184
for entry in intersection:
185
if entry[0] == intersection[0][0]:
186
matches.append(entry[2])
190
def revision_graph(revision, revision_source):
191
"""Produce a graph of the ancestry of the specified revision.
193
:return: root, ancestors map, descendants map
195
revision_source.lock_read()
197
return _revision_graph(revision, revision_source)
199
revision_source.unlock()
202
def _revision_graph(revision, revision_source):
203
"""See revision_graph."""
204
from bzrlib.tsort import topo_sort
205
graph = revision_source.get_revision_graph(revision)
206
# mark all no-parent revisions as being NULL_REVISION parentage.
207
for node, parents in graph.items():
208
if len(parents) == 0:
209
graph[node] = [NULL_REVISION]
210
# add NULL_REVISION to the graph
211
graph[NULL_REVISION] = []
213
# pick a root. If there are multiple roots
214
# this could pick a random one.
215
topo_order = topo_sort(graph.items())
221
# map the descendants of the graph.
222
# and setup our set based return graph.
223
for node in graph.keys():
224
descendants[node] = {}
225
for node, parents in graph.items():
226
for parent in parents:
227
descendants[parent][node] = 1
228
ancestors[node] = set(parents)
230
assert root not in descendants[root]
231
assert root not in ancestors[root]
232
return root, ancestors, descendants
235
def combined_graph(revision_a, revision_b, revision_source):
236
"""Produce a combined ancestry graph.
237
Return graph root, ancestors map, descendants map, set of common nodes"""
238
root, ancestors, descendants = revision_graph(
239
revision_a, revision_source)
240
root_b, ancestors_b, descendants_b = revision_graph(
241
revision_b, revision_source)
243
raise errors.NoCommonRoot(revision_a, revision_b)
245
for node, node_anc in ancestors_b.iteritems():
246
if node in ancestors:
249
ancestors[node] = set()
250
ancestors[node].update(node_anc)
251
for node, node_dec in descendants_b.iteritems():
252
if node not in descendants:
253
descendants[node] = {}
254
descendants[node].update(node_dec)
255
return root, ancestors, descendants, common
258
def common_ancestor(revision_a, revision_b, revision_source,
260
if None in (revision_a, revision_b):
262
if NULL_REVISION in (revision_a, revision_b):
264
# trivial optimisation
265
if revision_a == revision_b:
269
pb.update('Picking ancestor', 1, 3)
270
graph = revision_source.get_revision_graph_with_ghosts(
271
[revision_a, revision_b])
272
# Shortcut the case where one of the tips is already included in
273
# the other graphs ancestry.
274
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
275
if revision_b in ancestry_a:
277
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
278
if revision_a in ancestry_b:
280
# convert to a NULL_REVISION based graph.
281
ancestors = graph.get_ancestors()
282
descendants = graph.get_descendants()
283
common = set(ancestry_a)
284
common.intersection_update(ancestry_b)
285
descendants[NULL_REVISION] = {}
286
ancestors[NULL_REVISION] = []
287
for root in graph.roots:
288
descendants[NULL_REVISION][root] = 1
289
ancestors[root].append(NULL_REVISION)
290
for ghost in graph.ghosts:
291
# ghosts act as roots for the purpose of finding
292
# the longest paths from the root: any ghost *might*
293
# be directly attached to the root, so we treat them
295
# ghost now descends from NULL
296
descendants[NULL_REVISION][ghost] = 1
297
# that is it has an ancestor of NULL
298
ancestors[ghost] = [NULL_REVISION]
299
# ghost is common if any of ghosts descendants are common:
300
for ghost_descendant in descendants[ghost]:
301
if ghost_descendant in common:
305
common.add(NULL_REVISION)
306
except errors.NoCommonRoot:
307
raise errors.NoCommonAncestor(revision_a, revision_b)
309
pb.update('Picking ancestor', 2, 3)
310
distances = node_distances (descendants, ancestors, root)
311
pb.update('Picking ancestor', 3, 2)
312
farthest = select_farthest(distances, common)
313
if farthest is None or farthest == NULL_REVISION:
314
raise errors.NoCommonAncestor(revision_a, revision_b)
320
class MultipleRevisionSources(object):
321
"""Proxy that looks in multiple branches for revisions."""
322
def __init__(self, *args):
323
object.__init__(self)
324
assert len(args) != 0
325
self._revision_sources = args
327
def revision_parents(self, revision_id):
328
for source in self._revision_sources:
330
return source.revision_parents(revision_id)
331
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
335
def get_revision(self, revision_id):
336
for source in self._revision_sources:
338
return source.get_revision(revision_id)
339
except errors.NoSuchRevision, e:
343
def get_revision_graph(self, revision_id):
344
# we could probe incrementally until the pending
345
# ghosts list stop growing, but its cheaper for now
346
# to just ask for the complete graph for each repository.
348
for source in self._revision_sources:
349
ghost_graph = source.get_revision_graph_with_ghosts()
350
graphs.append(ghost_graph)
353
if not revision_id in graph.get_ancestors():
355
if absent == len(graphs):
356
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
360
pending = set([revision_id])
361
def find_parents(node_id):
362
"""find the parents for node_id."""
364
ancestors = graph.get_ancestors()
366
return ancestors[node_id]
369
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
371
# all the graphs should have identical parent lists
372
node_id = pending.pop()
374
result[node_id] = find_parents(node_id)
375
for parent_node in result[node_id]:
376
if not parent_node in result:
377
pending.add(parent_node)
378
except errors.NoSuchRevision:
383
def get_revision_graph_with_ghosts(self, revision_ids):
384
# query all the sources for their entire graphs
385
# and then build a combined graph for just
388
for source in self._revision_sources:
389
ghost_graph = source.get_revision_graph_with_ghosts()
390
graphs.append(ghost_graph.get_ancestors())
391
for revision_id in revision_ids:
394
if not revision_id in graph:
396
if absent == len(graphs):
397
raise errors.NoSuchRevision(self._revision_sources[0],
402
pending = set(revision_ids)
404
def find_parents(node_id):
405
"""find the parents for node_id."""
408
return graph[node_id]
411
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
413
# all the graphs should have identical parent lists
414
node_id = pending.pop()
416
parents = find_parents(node_id)
417
for parent_node in parents:
419
if (parent_node not in pending and
420
parent_node not in done):
422
pending.add(parent_node)
423
result.add_node(node_id, parents)
425
except errors.NoSuchRevision:
427
result.add_ghost(node_id)
432
for source in self._revision_sources:
436
for source in self._revision_sources:
440
def is_reserved_id(revision_id):
441
"""Determine whether a revision id is reserved
443
:return: True if the revision is is reserved, False otherwise
445
return isinstance(revision_id, basestring) and revision_id.endswith(':')
448
def check_not_reserved_id(revision_id):
449
"""Raise ReservedId if the supplied revision_id is reserved"""
450
if is_reserved_id(revision_id):
451
raise errors.ReservedId(revision_id)
454
def ensure_null(revision_id):
455
"""Ensure only NULL_REVISION is used to represent the null revisionn"""
456
if revision_id is None:
457
symbol_versioning.warn('NULL_REVISION should be used for the null'
458
' revision instead of None, as of bzr 0.91.',
459
DeprecationWarning, stacklevel=2)
465
def is_null(revision_id):
466
if revision_id is None:
467
symbol_versioning.warn('NULL_REVISION should be used for the null'
468
' revision instead of None, as of bzr 0.90.',
469
DeprecationWarning, stacklevel=2)
470
return revision_id in (None, NULL_REVISION)
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
