1
# Copyright (C) 2005, 2006 Canonical Ltd
2
# -*- coding: UTF-8 -*-
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
12
# GNU General Public License for more details.
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# 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):
21
from xml import XMLMixin
24
from cElementTree import Element, ElementTree, SubElement
26
from elementtree.ElementTree import Element, ElementTree, SubElement
29
class Revision(XMLMixin):
41
30
"""Single revision on a branch.
43
32
Revisions may know their revision_hash, but only once they've been
44
33
written out. This is not stored because you cannot write the hash
45
34
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.
36
: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."""
38
def __init__(self, **args):
39
self.inventory_id = None
40
self.revision_id = None
65
44
self.__dict__.update(args)
67
47
def __repr__(self):
68
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.split('\n', 1)[0]
120
def is_ancestor(revision_id, candidate_id, branch):
121
"""Return true if candidate_id is an ancestor of revision_id.
123
A false negative will be returned if any intermediate descendent of
124
candidate_id is not present in any of the revision_sources.
126
revisions_source is an object supporting a get_revision operation that
127
behaves like Branch's.
129
if is_null(candidate_id):
131
return (candidate_id in branch.repository.get_ancestry(revision_id,
135
def iter_ancestors(revision_id, revision_source, only_present=False):
136
ancestors = (revision_id,)
138
while len(ancestors) > 0:
140
for ancestor in ancestors:
142
yield ancestor, distance
144
revision = revision_source.get_revision(ancestor)
145
except errors.NoSuchRevision, e:
146
if e.revision == revision_id:
151
yield ancestor, distance
152
new_ancestors.extend(revision.parent_ids)
153
ancestors = new_ancestors
157
def find_present_ancestors(revision_id, revision_source):
158
"""Return the ancestors of a revision present in a branch.
160
It's possible that a branch won't have the complete ancestry of
161
one of its revisions.
165
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
167
for anc_order, (anc_id, anc_distance) in anc_iter:
168
if anc_id not in found_ancestors:
169
found_ancestors[anc_id] = (anc_order, anc_distance)
170
return found_ancestors
173
def __get_closest(intersection):
176
for entry in intersection:
177
if entry[0] == intersection[0][0]:
178
matches.append(entry[2])
182
def revision_graph(revision, revision_source):
183
"""Produce a graph of the ancestry of the specified revision.
185
:return: root, ancestors map, descendants map
187
revision_source.lock_read()
189
return _revision_graph(revision, revision_source)
191
revision_source.unlock()
194
def _revision_graph(revision, revision_source):
195
"""See revision_graph."""
196
from bzrlib.tsort import topo_sort
197
graph = revision_source.get_revision_graph(revision)
198
# mark all no-parent revisions as being NULL_REVISION parentage.
199
for node, parents in graph.items():
200
if len(parents) == 0:
201
graph[node] = [NULL_REVISION]
202
# add NULL_REVISION to the graph
203
graph[NULL_REVISION] = []
205
# pick a root. If there are multiple roots
206
# this could pick a random one.
207
topo_order = topo_sort(graph.items())
213
# map the descendants of the graph.
214
# and setup our set based return graph.
215
for node in graph.keys():
216
descendants[node] = {}
217
for node, parents in graph.items():
218
for parent in parents:
219
descendants[parent][node] = 1
220
ancestors[node] = set(parents)
222
assert root not in descendants[root]
223
assert root not in ancestors[root]
224
return root, ancestors, descendants
227
def combined_graph(revision_a, revision_b, revision_source):
228
"""Produce a combined ancestry graph.
229
Return graph root, ancestors map, descendants map, set of common nodes"""
230
root, ancestors, descendants = revision_graph(
231
revision_a, revision_source)
232
root_b, ancestors_b, descendants_b = revision_graph(
233
revision_b, revision_source)
235
raise errors.NoCommonRoot(revision_a, revision_b)
237
for node, node_anc in ancestors_b.iteritems():
238
if node in ancestors:
241
ancestors[node] = set()
242
ancestors[node].update(node_anc)
243
for node, node_dec in descendants_b.iteritems():
244
if node not in descendants:
245
descendants[node] = {}
246
descendants[node].update(node_dec)
247
return root, ancestors, descendants, common
250
def common_ancestor(revision_a, revision_b, revision_source,
252
if None in (revision_a, revision_b):
254
if NULL_REVISION in (revision_a, revision_b):
256
# trivial optimisation
257
if revision_a == revision_b:
261
pb.update('Picking ancestor', 1, 3)
262
graph = revision_source.get_revision_graph_with_ghosts(
263
[revision_a, revision_b])
264
# Shortcut the case where one of the tips is already included in
265
# the other graphs ancestry.
266
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
267
if revision_b in ancestry_a:
269
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
270
if revision_a in ancestry_b:
272
# convert to a NULL_REVISION based graph.
273
ancestors = graph.get_ancestors()
274
descendants = graph.get_descendants()
275
common = set(ancestry_a)
276
common.intersection_update(ancestry_b)
277
descendants[NULL_REVISION] = {}
278
ancestors[NULL_REVISION] = []
279
for root in graph.roots:
280
descendants[NULL_REVISION][root] = 1
281
ancestors[root].append(NULL_REVISION)
282
for ghost in graph.ghosts:
283
# ghosts act as roots for the purpose of finding
284
# the longest paths from the root: any ghost *might*
285
# be directly attached to the root, so we treat them
287
# ghost now descends from NULL
288
descendants[NULL_REVISION][ghost] = 1
289
# that is it has an ancestor of NULL
290
ancestors[ghost] = [NULL_REVISION]
291
# ghost is common if any of ghosts descendants are common:
292
for ghost_descendant in descendants[ghost]:
293
if ghost_descendant in common:
297
common.add(NULL_REVISION)
298
except errors.NoCommonRoot:
299
raise errors.NoCommonAncestor(revision_a, revision_b)
301
pb.update('Picking ancestor', 2, 3)
302
distances = node_distances (descendants, ancestors, root)
303
pb.update('Picking ancestor', 3, 2)
304
farthest = select_farthest(distances, common)
305
if farthest is None or farthest == NULL_REVISION:
306
raise errors.NoCommonAncestor(revision_a, revision_b)
312
class MultipleRevisionSources(object):
313
"""Proxy that looks in multiple branches for revisions."""
314
def __init__(self, *args):
315
object.__init__(self)
316
assert len(args) != 0
317
self._revision_sources = args
319
def revision_parents(self, revision_id):
320
for source in self._revision_sources:
322
return source.revision_parents(revision_id)
323
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
327
def get_revision(self, revision_id):
328
for source in self._revision_sources:
330
return source.get_revision(revision_id)
331
except errors.NoSuchRevision, e:
335
def get_revision_graph(self, revision_id):
336
# we could probe incrementally until the pending
337
# ghosts list stop growing, but its cheaper for now
338
# to just ask for the complete graph for each repository.
340
for source in self._revision_sources:
341
ghost_graph = source.get_revision_graph_with_ghosts()
342
graphs.append(ghost_graph)
345
if not revision_id in graph.get_ancestors():
347
if absent == len(graphs):
348
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
352
pending = set([revision_id])
353
def find_parents(node_id):
354
"""find the parents for node_id."""
356
ancestors = graph.get_ancestors()
358
return ancestors[node_id]
361
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
363
# all the graphs should have identical parent lists
364
node_id = pending.pop()
366
result[node_id] = find_parents(node_id)
367
for parent_node in result[node_id]:
368
if not parent_node in result:
369
pending.add(parent_node)
370
except errors.NoSuchRevision:
375
def get_revision_graph_with_ghosts(self, revision_ids):
376
# query all the sources for their entire graphs
377
# and then build a combined graph for just
380
for source in self._revision_sources:
381
ghost_graph = source.get_revision_graph_with_ghosts()
382
graphs.append(ghost_graph.get_ancestors())
383
for revision_id in revision_ids:
386
if not revision_id in graph:
388
if absent == len(graphs):
389
raise errors.NoSuchRevision(self._revision_sources[0],
394
pending = set(revision_ids)
396
def find_parents(node_id):
397
"""find the parents for node_id."""
400
return graph[node_id]
403
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
405
# all the graphs should have identical parent lists
406
node_id = pending.pop()
408
parents = find_parents(node_id)
409
for parent_node in parents:
411
if (parent_node not in pending and
412
parent_node not in done):
414
pending.add(parent_node)
415
result.add_node(node_id, parents)
417
except errors.NoSuchRevision:
419
result.add_ghost(node_id)
424
for source in self._revision_sources:
428
for source in self._revision_sources:
432
def is_reserved_id(revision_id):
433
"""Determine whether a revision id is reserved
435
:return: True if the revision is is reserved, False otherwise
437
return isinstance(revision_id, basestring) and revision_id.endswith(':')
440
def check_not_reserved_id(revision_id):
441
"""Raise ReservedId if the supplied revision_id is reserved"""
442
if is_reserved_id(revision_id):
443
raise errors.ReservedId(revision_id)
446
def ensure_null(revision_id):
447
"""Ensure only NULL_REVISION is used to represent the null revisionn"""
448
if revision_id is None:
454
def is_null(revision_id):
455
if revision_id is None:
456
symbol_versioning.warn('NULL_REVISION should be used for the null'
457
' revision instead of None, as of bzr 0.90.',
458
DeprecationWarning, stacklevel=2)
459
return revision_id in (None, NULL_REVISION)
49
return "<Revision id %s>" % self.revision_id
53
root = Element('revision',
54
committer = self.committer,
55
timestamp = '%.9f' % self.timestamp,
56
revision_id = self.revision_id,
57
inventory_id = self.inventory_id,
58
timezone = str(self.timezone))
60
root.set('precursor', self.precursor)
63
msg = SubElement(root, 'message')
64
msg.text = self.message
70
def from_element(cls, elt):
71
# <changeset> is deprecated...
72
if elt.tag not in ('revision', 'changeset'):
73
bailout("unexpected tag in revision file: %r" % elt)
75
cs = cls(committer = elt.get('committer'),
76
timestamp = float(elt.get('timestamp')),
77
precursor = elt.get('precursor'),
78
revision_id = elt.get('revision_id'),
79
inventory_id = elt.get('inventory_id'))
81
v = elt.get('timezone')
82
cs.timezone = v and int(v)
84
cs.message = elt.findtext('message') # text of <message>
87
from_element = classmethod(from_element)
added
removed
bzrlib/revision.py
