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.
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
29
from bzrlib.osutils import contains_whitespace
30
from bzrlib.progress import DummyProgress
31
from bzrlib.symbol_versioning import (deprecated_function,
35
CURRENT_REVISION="current:"
38
class Revision(object):
39
"""Single revision on a branch.
41
Revisions may know their revision_hash, but only once they've been
42
written out. This is not stored because you cannot write the hash
43
into the file it describes.
45
After bzr 0.0.5 revisions are allowed to have multiple parents.
48
List of parent revision_ids
51
Dictionary of revision properties. These are attached to the
52
revision as extra metadata. The name must be a single
53
word; the value can be an arbitrary string.
56
def __init__(self, revision_id, properties=None, **args):
57
self.revision_id = revision_id
58
self.properties = properties or {}
59
self._check_properties()
61
self.parent_sha1s = []
62
"""Not used anymore - legacy from for 4."""
63
self.__dict__.update(args)
66
return "<Revision id %s>" % self.revision_id
68
def __eq__(self, other):
69
if not isinstance(other, Revision):
71
# FIXME: rbc 20050930 parent_ids are not being compared
73
self.inventory_sha1 == other.inventory_sha1
74
and self.revision_id == other.revision_id
75
and self.timestamp == other.timestamp
76
and self.message == other.message
77
and self.timezone == other.timezone
78
and self.committer == other.committer
79
and self.properties == other.properties)
81
def __ne__(self, other):
82
return not self.__eq__(other)
84
def _check_properties(self):
85
"""Verify that all revision properties are OK."""
86
for name, value in self.properties.iteritems():
87
if not isinstance(name, basestring) or contains_whitespace(name):
88
raise ValueError("invalid property name %r" % name)
89
if not isinstance(value, basestring):
90
raise ValueError("invalid property value %r for %r" %
93
def get_history(self, repository):
94
"""Return the canonical line-of-history for this revision.
96
If ghosts are present this may differ in result from a ghost-free
99
current_revision = self
101
while current_revision is not None:
102
reversed_result.append(current_revision.revision_id)
103
if not len (current_revision.parent_ids):
104
reversed_result.append(None)
105
current_revision = None
107
next_revision_id = current_revision.parent_ids[0]
108
current_revision = repository.get_revision(next_revision_id)
109
reversed_result.reverse()
110
return reversed_result
112
def get_summary(self):
113
"""Get the first line of the log message for this revision.
115
return self.message.lstrip().split('\n', 1)[0]
117
def get_apparent_author(self):
118
"""Return the apparent author of this revision.
120
If the revision properties contain the author name,
121
return it. Otherwise return the committer name.
123
return self.properties.get('author', self.committer)
126
@deprecated_function(symbol_versioning.one_zero)
127
def is_ancestor(revision_id, candidate_id, branch):
128
"""Return true if candidate_id is an ancestor of revision_id.
130
A false negative will be returned if any intermediate descendent of
131
candidate_id is not present in any of the revision_sources.
133
revisions_source is an object supporting a get_revision operation that
134
behaves like Branch's.
136
This function is deprecated, it is better for callers to directly use
137
Graph.is_ancestor() (just watch out that the parameter order is switched)
139
return branch.repository.get_graph().is_ancestor(candidate_id, revision_id)
142
def iter_ancestors(revision_id, revision_source, only_present=False):
143
ancestors = (revision_id,)
145
while len(ancestors) > 0:
147
for ancestor in ancestors:
149
yield ancestor, distance
151
revision = revision_source.get_revision(ancestor)
152
except errors.NoSuchRevision, e:
153
if e.revision == revision_id:
158
yield ancestor, distance
159
new_ancestors.extend(revision.parent_ids)
160
ancestors = new_ancestors
164
def find_present_ancestors(revision_id, revision_source):
165
"""Return the ancestors of a revision present in a branch.
167
It's possible that a branch won't have the complete ancestry of
168
one of its revisions.
172
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
174
for anc_order, (anc_id, anc_distance) in anc_iter:
175
if anc_id not in found_ancestors:
176
found_ancestors[anc_id] = (anc_order, anc_distance)
177
return found_ancestors
180
def __get_closest(intersection):
183
for entry in intersection:
184
if entry[0] == intersection[0][0]:
185
matches.append(entry[2])
189
def revision_graph(revision, revision_source):
190
"""Produce a graph of the ancestry of the specified revision.
192
:return: root, ancestors map, descendants map
194
revision_source.lock_read()
196
return _revision_graph(revision, revision_source)
198
revision_source.unlock()
201
def _revision_graph(revision, revision_source):
202
"""See revision_graph."""
203
from bzrlib.tsort import topo_sort
204
graph = revision_source.get_revision_graph(revision)
205
# mark all no-parent revisions as being NULL_REVISION parentage.
206
for node, parents in graph.items():
207
if len(parents) == 0:
208
graph[node] = [NULL_REVISION]
209
# add NULL_REVISION to the graph
210
graph[NULL_REVISION] = []
212
# pick a root. If there are multiple roots
213
# this could pick a random one.
214
topo_order = topo_sort(graph.items())
220
# map the descendants of the graph.
221
# and setup our set based return graph.
222
for node in graph.keys():
223
descendants[node] = {}
224
for node, parents in graph.items():
225
for parent in parents:
226
descendants[parent][node] = 1
227
ancestors[node] = set(parents)
229
assert root not in descendants[root]
230
assert root not in ancestors[root]
231
return root, ancestors, descendants
234
@deprecated_function(symbol_versioning.one_three)
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
@deprecated_function(symbol_versioning.one_three)
259
def common_ancestor(revision_a, revision_b, revision_source,
261
if None in (revision_a, revision_b):
263
if NULL_REVISION in (revision_a, revision_b):
265
# trivial optimisation
266
if revision_a == revision_b:
270
pb.update('Picking ancestor', 1, 3)
271
graph = revision_source.get_revision_graph_with_ghosts(
272
[revision_a, revision_b])
273
# Shortcut the case where one of the tips is already included in
274
# the other graphs ancestry.
275
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
276
if revision_b in ancestry_a:
278
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
279
if revision_a in ancestry_b:
281
# convert to a NULL_REVISION based graph.
282
ancestors = graph.get_ancestors()
283
descendants = graph.get_descendants()
284
common = set(ancestry_a)
285
common.intersection_update(ancestry_b)
286
descendants[NULL_REVISION] = {}
287
ancestors[NULL_REVISION] = []
288
for root in graph.roots:
289
descendants[NULL_REVISION][root] = 1
290
ancestors[root].append(NULL_REVISION)
291
for ghost in graph.ghosts:
292
# ghosts act as roots for the purpose of finding
293
# the longest paths from the root: any ghost *might*
294
# be directly attached to the root, so we treat them
296
# ghost now descends from NULL
297
descendants[NULL_REVISION][ghost] = 1
298
# that is it has an ancestor of NULL
299
ancestors[ghost] = [NULL_REVISION]
300
# ghost is common if any of ghosts descendants are common:
301
for ghost_descendant in descendants[ghost]:
302
if ghost_descendant in common:
306
common.add(NULL_REVISION)
307
except errors.NoCommonRoot:
308
raise errors.NoCommonAncestor(revision_a, revision_b)
310
pb.update('Picking ancestor', 2, 3)
311
distances = deprecated_graph.node_distances(
312
descendants, ancestors, root)
313
pb.update('Picking ancestor', 3, 2)
314
farthest = deprecated_graph.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."""
325
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
326
def __init__(self, *args):
327
object.__init__(self)
328
assert len(args) != 0
329
self._revision_sources = args
331
def revision_parents(self, revision_id):
332
for source in self._revision_sources:
334
return source.revision_parents(revision_id)
335
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
339
def get_revision(self, revision_id):
340
for source in self._revision_sources:
342
return source.get_revision(revision_id)
343
except errors.NoSuchRevision, e:
347
def get_revision_graph(self, revision_id):
348
# we could probe incrementally until the pending
349
# ghosts list stop growing, but its cheaper for now
350
# to just ask for the complete graph for each repository.
352
for source in self._revision_sources:
353
ghost_graph = source.get_revision_graph_with_ghosts()
354
graphs.append(ghost_graph)
357
if not revision_id in graph.get_ancestors():
359
if absent == len(graphs):
360
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
364
pending = set([revision_id])
365
def find_parents(node_id):
366
"""find the parents for node_id."""
368
ancestors = graph.get_ancestors()
370
return ancestors[node_id]
373
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
375
# all the graphs should have identical parent lists
376
node_id = pending.pop()
378
result[node_id] = find_parents(node_id)
379
for parent_node in result[node_id]:
380
if not parent_node in result:
381
pending.add(parent_node)
382
except errors.NoSuchRevision:
387
def get_revision_graph_with_ghosts(self, revision_ids):
388
# query all the sources for their entire graphs
389
# and then build a combined graph for just
392
for source in self._revision_sources:
393
ghost_graph = source.get_revision_graph_with_ghosts()
394
graphs.append(ghost_graph.get_ancestors())
395
for revision_id in revision_ids:
398
if not revision_id in graph:
400
if absent == len(graphs):
401
raise errors.NoSuchRevision(self._revision_sources[0],
405
result = deprecated_graph.Graph()
406
pending = set(revision_ids)
408
def find_parents(node_id):
409
"""find the parents for node_id."""
412
return graph[node_id]
415
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
417
# all the graphs should have identical parent lists
418
node_id = pending.pop()
420
parents = find_parents(node_id)
421
for parent_node in parents:
423
if (parent_node not in pending and
424
parent_node not in done):
426
pending.add(parent_node)
427
result.add_node(node_id, parents)
429
except errors.NoSuchRevision:
431
result.add_ghost(node_id)
436
for source in self._revision_sources:
440
for source in self._revision_sources:
444
def is_reserved_id(revision_id):
445
"""Determine whether a revision id is reserved
447
:return: True if the revision is is reserved, False otherwise
449
return isinstance(revision_id, basestring) and revision_id.endswith(':')
452
def check_not_reserved_id(revision_id):
453
"""Raise ReservedId if the supplied revision_id is reserved"""
454
if is_reserved_id(revision_id):
455
raise errors.ReservedId(revision_id)
458
def ensure_null(revision_id):
459
"""Ensure only NULL_REVISION is used to represent the null revision"""
460
if revision_id is None:
461
symbol_versioning.warn('NULL_REVISION should be used for the null'
462
' revision instead of None, as of bzr 0.91.',
463
DeprecationWarning, stacklevel=2)
469
def is_null(revision_id):
470
if revision_id is None:
471
symbol_versioning.warn('NULL_REVISION should be used for the null'
472
' revision instead of None, as of bzr 0.90.',
473
DeprecationWarning, stacklevel=2)
474
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
