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_author(self):
120
"""Get the author of this revision.
122
return self.properties.get('author', self.committer)
125
def is_ancestor(revision_id, candidate_id, branch):
126
"""Return true if candidate_id is an ancestor of revision_id.
128
A false negative will be returned if any intermediate descendent of
129
candidate_id is not present in any of the revision_sources.
131
revisions_source is an object supporting a get_revision operation that
132
behaves like Branch's.
134
if is_null(candidate_id):
136
return (candidate_id in branch.repository.get_ancestry(revision_id,
140
def iter_ancestors(revision_id, revision_source, only_present=False):
141
ancestors = (revision_id,)
143
while len(ancestors) > 0:
145
for ancestor in ancestors:
147
yield ancestor, distance
149
revision = revision_source.get_revision(ancestor)
150
except errors.NoSuchRevision, e:
151
if e.revision == revision_id:
156
yield ancestor, distance
157
new_ancestors.extend(revision.parent_ids)
158
ancestors = new_ancestors
162
def find_present_ancestors(revision_id, revision_source):
163
"""Return the ancestors of a revision present in a branch.
165
It's possible that a branch won't have the complete ancestry of
166
one of its revisions.
170
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
172
for anc_order, (anc_id, anc_distance) in anc_iter:
173
if anc_id not in found_ancestors:
174
found_ancestors[anc_id] = (anc_order, anc_distance)
175
return found_ancestors
178
def __get_closest(intersection):
181
for entry in intersection:
182
if entry[0] == intersection[0][0]:
183
matches.append(entry[2])
187
def revision_graph(revision, revision_source):
188
"""Produce a graph of the ancestry of the specified revision.
190
:return: root, ancestors map, descendants map
192
revision_source.lock_read()
194
return _revision_graph(revision, revision_source)
196
revision_source.unlock()
199
def _revision_graph(revision, revision_source):
200
"""See revision_graph."""
201
from bzrlib.tsort import topo_sort
202
graph = revision_source.get_revision_graph(revision)
203
# mark all no-parent revisions as being NULL_REVISION parentage.
204
for node, parents in graph.items():
205
if len(parents) == 0:
206
graph[node] = [NULL_REVISION]
207
# add NULL_REVISION to the graph
208
graph[NULL_REVISION] = []
210
# pick a root. If there are multiple roots
211
# this could pick a random one.
212
topo_order = topo_sort(graph.items())
218
# map the descendants of the graph.
219
# and setup our set based return graph.
220
for node in graph.keys():
221
descendants[node] = {}
222
for node, parents in graph.items():
223
for parent in parents:
224
descendants[parent][node] = 1
225
ancestors[node] = set(parents)
227
assert root not in descendants[root]
228
assert root not in ancestors[root]
229
return root, ancestors, descendants
232
def combined_graph(revision_a, revision_b, revision_source):
233
"""Produce a combined ancestry graph.
234
Return graph root, ancestors map, descendants map, set of common nodes"""
235
root, ancestors, descendants = revision_graph(
236
revision_a, revision_source)
237
root_b, ancestors_b, descendants_b = revision_graph(
238
revision_b, revision_source)
240
raise errors.NoCommonRoot(revision_a, revision_b)
242
for node, node_anc in ancestors_b.iteritems():
243
if node in ancestors:
246
ancestors[node] = set()
247
ancestors[node].update(node_anc)
248
for node, node_dec in descendants_b.iteritems():
249
if node not in descendants:
250
descendants[node] = {}
251
descendants[node].update(node_dec)
252
return root, ancestors, descendants, common
255
def common_ancestor(revision_a, revision_b, revision_source,
257
if None in (revision_a, revision_b):
259
if NULL_REVISION in (revision_a, revision_b):
261
# trivial optimisation
262
if revision_a == revision_b:
266
pb.update('Picking ancestor', 1, 3)
267
graph = revision_source.get_revision_graph_with_ghosts(
268
[revision_a, revision_b])
269
# Shortcut the case where one of the tips is already included in
270
# the other graphs ancestry.
271
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
272
if revision_b in ancestry_a:
274
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
275
if revision_a in ancestry_b:
277
# convert to a NULL_REVISION based graph.
278
ancestors = graph.get_ancestors()
279
descendants = graph.get_descendants()
280
common = set(ancestry_a)
281
common.intersection_update(ancestry_b)
282
descendants[NULL_REVISION] = {}
283
ancestors[NULL_REVISION] = []
284
for root in graph.roots:
285
descendants[NULL_REVISION][root] = 1
286
ancestors[root].append(NULL_REVISION)
287
for ghost in graph.ghosts:
288
# ghosts act as roots for the purpose of finding
289
# the longest paths from the root: any ghost *might*
290
# be directly attached to the root, so we treat them
292
# ghost now descends from NULL
293
descendants[NULL_REVISION][ghost] = 1
294
# that is it has an ancestor of NULL
295
ancestors[ghost] = [NULL_REVISION]
296
# ghost is common if any of ghosts descendants are common:
297
for ghost_descendant in descendants[ghost]:
298
if ghost_descendant in common:
302
common.add(NULL_REVISION)
303
except errors.NoCommonRoot:
304
raise errors.NoCommonAncestor(revision_a, revision_b)
306
pb.update('Picking ancestor', 2, 3)
307
distances = node_distances (descendants, ancestors, root)
308
pb.update('Picking ancestor', 3, 2)
309
farthest = select_farthest(distances, common)
310
if farthest is None or farthest == NULL_REVISION:
311
raise errors.NoCommonAncestor(revision_a, revision_b)
317
class MultipleRevisionSources(object):
318
"""Proxy that looks in multiple branches for revisions."""
319
def __init__(self, *args):
320
object.__init__(self)
321
assert len(args) != 0
322
self._revision_sources = args
324
def revision_parents(self, revision_id):
325
for source in self._revision_sources:
327
return source.revision_parents(revision_id)
328
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
332
def get_revision(self, revision_id):
333
for source in self._revision_sources:
335
return source.get_revision(revision_id)
336
except errors.NoSuchRevision, e:
340
def get_revision_graph(self, revision_id):
341
# we could probe incrementally until the pending
342
# ghosts list stop growing, but its cheaper for now
343
# to just ask for the complete graph for each repository.
345
for source in self._revision_sources:
346
ghost_graph = source.get_revision_graph_with_ghosts()
347
graphs.append(ghost_graph)
350
if not revision_id in graph.get_ancestors():
352
if absent == len(graphs):
353
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
357
pending = set([revision_id])
358
def find_parents(node_id):
359
"""find the parents for node_id."""
361
ancestors = graph.get_ancestors()
363
return ancestors[node_id]
366
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
368
# all the graphs should have identical parent lists
369
node_id = pending.pop()
371
result[node_id] = find_parents(node_id)
372
for parent_node in result[node_id]:
373
if not parent_node in result:
374
pending.add(parent_node)
375
except errors.NoSuchRevision:
380
def get_revision_graph_with_ghosts(self, revision_ids):
381
# query all the sources for their entire graphs
382
# and then build a combined graph for just
385
for source in self._revision_sources:
386
ghost_graph = source.get_revision_graph_with_ghosts()
387
graphs.append(ghost_graph.get_ancestors())
388
for revision_id in revision_ids:
391
if not revision_id in graph:
393
if absent == len(graphs):
394
raise errors.NoSuchRevision(self._revision_sources[0],
399
pending = set(revision_ids)
401
def find_parents(node_id):
402
"""find the parents for node_id."""
405
return graph[node_id]
408
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
410
# all the graphs should have identical parent lists
411
node_id = pending.pop()
413
parents = find_parents(node_id)
414
for parent_node in parents:
416
if (parent_node not in pending and
417
parent_node not in done):
419
pending.add(parent_node)
420
result.add_node(node_id, parents)
422
except errors.NoSuchRevision:
424
result.add_ghost(node_id)
429
for source in self._revision_sources:
433
for source in self._revision_sources:
437
def is_reserved_id(revision_id):
438
"""Determine whether a revision id is reserved
440
:return: True if the revision is is reserved, False otherwise
442
return isinstance(revision_id, basestring) and revision_id.endswith(':')
445
def check_not_reserved_id(revision_id):
446
"""Raise ReservedId if the supplied revision_id is reserved"""
447
if is_reserved_id(revision_id):
448
raise errors.ReservedId(revision_id)
451
def ensure_null(revision_id):
452
"""Ensure only NULL_REVISION is used to represent the null revisionn"""
453
if revision_id is None:
459
def is_null(revision_id):
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.90.',
463
DeprecationWarning, stacklevel=2)
464
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
