1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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):
41
"""Single revision on a branch.
43
Revisions may know their revision_hash, but only once they've been
44
written out. This is not stored because you cannot write the hash
45
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.
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."""
65
self.__dict__.update(args)
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.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
@deprecated_function(symbol_versioning.one_zero)
129
def is_ancestor(revision_id, candidate_id, branch):
130
"""Return true if candidate_id is an ancestor of revision_id.
132
A false negative will be returned if any intermediate descendent of
133
candidate_id is not present in any of the revision_sources.
135
revisions_source is an object supporting a get_revision operation that
136
behaves like Branch's.
138
This function is deprecated, it is better for callers to directly use
139
Graph.is_ancestor() (just watch out that the parameter order is switched)
141
return branch.repository.get_graph().is_ancestor(candidate_id, revision_id)
144
def iter_ancestors(revision_id, revision_source, only_present=False):
145
ancestors = (revision_id,)
147
while len(ancestors) > 0:
149
for ancestor in ancestors:
151
yield ancestor, distance
153
revision = revision_source.get_revision(ancestor)
154
except errors.NoSuchRevision, e:
155
if e.revision == revision_id:
160
yield ancestor, distance
161
new_ancestors.extend(revision.parent_ids)
162
ancestors = new_ancestors
166
def find_present_ancestors(revision_id, revision_source):
167
"""Return the ancestors of a revision present in a branch.
169
It's possible that a branch won't have the complete ancestry of
170
one of its revisions.
174
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
176
for anc_order, (anc_id, anc_distance) in anc_iter:
177
if anc_id not in found_ancestors:
178
found_ancestors[anc_id] = (anc_order, anc_distance)
179
return found_ancestors
182
def __get_closest(intersection):
185
for entry in intersection:
186
if entry[0] == intersection[0][0]:
187
matches.append(entry[2])
191
def revision_graph(revision, revision_source):
192
"""Produce a graph of the ancestry of the specified revision.
194
:return: root, ancestors map, descendants map
196
revision_source.lock_read()
198
return _revision_graph(revision, revision_source)
200
revision_source.unlock()
203
def _revision_graph(revision, revision_source):
204
"""See revision_graph."""
205
from bzrlib.tsort import topo_sort
206
graph = revision_source.get_revision_graph(revision)
207
# mark all no-parent revisions as being NULL_REVISION parentage.
208
for node, parents in graph.items():
209
if len(parents) == 0:
210
graph[node] = [NULL_REVISION]
211
# add NULL_REVISION to the graph
212
graph[NULL_REVISION] = []
214
# pick a root. If there are multiple roots
215
# this could pick a random one.
216
topo_order = topo_sort(graph.items())
222
# map the descendants of the graph.
223
# and setup our set based return graph.
224
for node in graph.keys():
225
descendants[node] = {}
226
for node, parents in graph.items():
227
for parent in parents:
228
descendants[parent][node] = 1
229
ancestors[node] = set(parents)
231
assert root not in descendants[root]
232
assert root not in ancestors[root]
233
return root, ancestors, descendants
236
def combined_graph(revision_a, revision_b, revision_source):
237
"""Produce a combined ancestry graph.
238
Return graph root, ancestors map, descendants map, set of common nodes"""
239
root, ancestors, descendants = revision_graph(
240
revision_a, revision_source)
241
root_b, ancestors_b, descendants_b = revision_graph(
242
revision_b, revision_source)
244
raise errors.NoCommonRoot(revision_a, revision_b)
246
for node, node_anc in ancestors_b.iteritems():
247
if node in ancestors:
250
ancestors[node] = set()
251
ancestors[node].update(node_anc)
252
for node, node_dec in descendants_b.iteritems():
253
if node not in descendants:
254
descendants[node] = {}
255
descendants[node].update(node_dec)
256
return root, ancestors, descendants, common
259
@deprecated_function(symbol_versioning.one_three)
260
def common_ancestor(revision_a, revision_b, revision_source,
262
if None in (revision_a, revision_b):
264
if NULL_REVISION in (revision_a, revision_b):
266
# trivial optimisation
267
if revision_a == revision_b:
271
pb.update('Picking ancestor', 1, 3)
272
graph = revision_source.get_revision_graph_with_ghosts(
273
[revision_a, revision_b])
274
# Shortcut the case where one of the tips is already included in
275
# the other graphs ancestry.
276
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
277
if revision_b in ancestry_a:
279
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
280
if revision_a in ancestry_b:
282
# convert to a NULL_REVISION based graph.
283
ancestors = graph.get_ancestors()
284
descendants = graph.get_descendants()
285
common = set(ancestry_a)
286
common.intersection_update(ancestry_b)
287
descendants[NULL_REVISION] = {}
288
ancestors[NULL_REVISION] = []
289
for root in graph.roots:
290
descendants[NULL_REVISION][root] = 1
291
ancestors[root].append(NULL_REVISION)
292
for ghost in graph.ghosts:
293
# ghosts act as roots for the purpose of finding
294
# the longest paths from the root: any ghost *might*
295
# be directly attached to the root, so we treat them
297
# ghost now descends from NULL
298
descendants[NULL_REVISION][ghost] = 1
299
# that is it has an ancestor of NULL
300
ancestors[ghost] = [NULL_REVISION]
301
# ghost is common if any of ghosts descendants are common:
302
for ghost_descendant in descendants[ghost]:
303
if ghost_descendant in common:
307
common.add(NULL_REVISION)
308
except errors.NoCommonRoot:
309
raise errors.NoCommonAncestor(revision_a, revision_b)
311
pb.update('Picking ancestor', 2, 3)
312
distances = node_distances (descendants, ancestors, root)
313
pb.update('Picking ancestor', 3, 2)
314
farthest = select_farthest(distances, common)
315
if farthest is None or farthest == NULL_REVISION:
316
raise errors.NoCommonAncestor(revision_a, revision_b)
322
class MultipleRevisionSources(object):
323
"""Proxy that looks in multiple branches for revisions."""
324
def __init__(self, *args):
325
object.__init__(self)
326
assert len(args) != 0
327
self._revision_sources = args
329
def revision_parents(self, revision_id):
330
for source in self._revision_sources:
332
return source.revision_parents(revision_id)
333
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
337
def get_revision(self, revision_id):
338
for source in self._revision_sources:
340
return source.get_revision(revision_id)
341
except errors.NoSuchRevision, e:
345
def get_revision_graph(self, revision_id):
346
# we could probe incrementally until the pending
347
# ghosts list stop growing, but its cheaper for now
348
# to just ask for the complete graph for each repository.
350
for source in self._revision_sources:
351
ghost_graph = source.get_revision_graph_with_ghosts()
352
graphs.append(ghost_graph)
355
if not revision_id in graph.get_ancestors():
357
if absent == len(graphs):
358
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
362
pending = set([revision_id])
363
def find_parents(node_id):
364
"""find the parents for node_id."""
366
ancestors = graph.get_ancestors()
368
return ancestors[node_id]
371
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
373
# all the graphs should have identical parent lists
374
node_id = pending.pop()
376
result[node_id] = find_parents(node_id)
377
for parent_node in result[node_id]:
378
if not parent_node in result:
379
pending.add(parent_node)
380
except errors.NoSuchRevision:
385
def get_revision_graph_with_ghosts(self, revision_ids):
386
# query all the sources for their entire graphs
387
# and then build a combined graph for just
390
for source in self._revision_sources:
391
ghost_graph = source.get_revision_graph_with_ghosts()
392
graphs.append(ghost_graph.get_ancestors())
393
for revision_id in revision_ids:
396
if not revision_id in graph:
398
if absent == len(graphs):
399
raise errors.NoSuchRevision(self._revision_sources[0],
404
pending = set(revision_ids)
406
def find_parents(node_id):
407
"""find the parents for node_id."""
410
return graph[node_id]
413
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
415
# all the graphs should have identical parent lists
416
node_id = pending.pop()
418
parents = find_parents(node_id)
419
for parent_node in parents:
421
if (parent_node not in pending and
422
parent_node not in done):
424
pending.add(parent_node)
425
result.add_node(node_id, parents)
427
except errors.NoSuchRevision:
429
result.add_ghost(node_id)
434
for source in self._revision_sources:
438
for source in self._revision_sources:
442
def is_reserved_id(revision_id):
443
"""Determine whether a revision id is reserved
445
:return: True if the revision is is reserved, False otherwise
447
return isinstance(revision_id, basestring) and revision_id.endswith(':')
450
def check_not_reserved_id(revision_id):
451
"""Raise ReservedId if the supplied revision_id is reserved"""
452
if is_reserved_id(revision_id):
453
raise errors.ReservedId(revision_id)
456
def ensure_null(revision_id):
457
"""Ensure only NULL_REVISION is used to represent the null revision"""
458
if revision_id is None:
459
symbol_versioning.warn('NULL_REVISION should be used for the null'
460
' revision instead of None, as of bzr 0.91.',
461
DeprecationWarning, stacklevel=2)
467
def is_null(revision_id):
468
if revision_id is None:
469
symbol_versioning.warn('NULL_REVISION should be used for the null'
470
' revision instead of None, as of bzr 0.90.',
471
DeprecationWarning, stacklevel=2)
472
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
