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
import bzrlib.errors as errors
22
from bzrlib.deprecated_graph import (
28
from bzrlib.osutils import contains_whitespace
29
from bzrlib.progress import DummyProgress
30
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.split('\n', 1)[0]
118
def is_ancestor(revision_id, candidate_id, branch):
119
"""Return true if candidate_id is an ancestor of revision_id.
121
A false negative will be returned if any intermediate descendent of
122
candidate_id is not present in any of the revision_sources.
124
revisions_source is an object supporting a get_revision operation that
125
behaves like Branch's.
127
return (candidate_id in branch.repository.get_ancestry(revision_id,
131
def iter_ancestors(revision_id, revision_source, only_present=False):
132
ancestors = (revision_id,)
134
while len(ancestors) > 0:
136
for ancestor in ancestors:
138
yield ancestor, distance
140
revision = revision_source.get_revision(ancestor)
141
except errors.NoSuchRevision, e:
142
if e.revision == revision_id:
147
yield ancestor, distance
148
new_ancestors.extend(revision.parent_ids)
149
ancestors = new_ancestors
153
def find_present_ancestors(revision_id, revision_source):
154
"""Return the ancestors of a revision present in a branch.
156
It's possible that a branch won't have the complete ancestry of
157
one of its revisions.
161
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
163
for anc_order, (anc_id, anc_distance) in anc_iter:
164
if anc_id not in found_ancestors:
165
found_ancestors[anc_id] = (anc_order, anc_distance)
166
return found_ancestors
169
def __get_closest(intersection):
172
for entry in intersection:
173
if entry[0] == intersection[0][0]:
174
matches.append(entry[2])
178
def revision_graph(revision, revision_source):
179
"""Produce a graph of the ancestry of the specified revision.
181
:return: root, ancestors map, descendants map
183
revision_source.lock_read()
185
return _revision_graph(revision, revision_source)
187
revision_source.unlock()
190
def _revision_graph(revision, revision_source):
191
"""See revision_graph."""
192
from bzrlib.tsort import topo_sort
193
graph = revision_source.get_revision_graph(revision)
194
# mark all no-parent revisions as being NULL_REVISION parentage.
195
for node, parents in graph.items():
196
if len(parents) == 0:
197
graph[node] = [NULL_REVISION]
198
# add NULL_REVISION to the graph
199
graph[NULL_REVISION] = []
201
# pick a root. If there are multiple roots
202
# this could pick a random one.
203
topo_order = topo_sort(graph.items())
209
# map the descendants of the graph.
210
# and setup our set based return graph.
211
for node in graph.keys():
212
descendants[node] = {}
213
for node, parents in graph.items():
214
for parent in parents:
215
descendants[parent][node] = 1
216
ancestors[node] = set(parents)
218
assert root not in descendants[root]
219
assert root not in ancestors[root]
220
return root, ancestors, descendants
223
def combined_graph(revision_a, revision_b, revision_source):
224
"""Produce a combined ancestry graph.
225
Return graph root, ancestors map, descendants map, set of common nodes"""
226
root, ancestors, descendants = revision_graph(
227
revision_a, revision_source)
228
root_b, ancestors_b, descendants_b = revision_graph(
229
revision_b, revision_source)
231
raise errors.NoCommonRoot(revision_a, revision_b)
233
for node, node_anc in ancestors_b.iteritems():
234
if node in ancestors:
237
ancestors[node] = set()
238
ancestors[node].update(node_anc)
239
for node, node_dec in descendants_b.iteritems():
240
if node not in descendants:
241
descendants[node] = {}
242
descendants[node].update(node_dec)
243
return root, ancestors, descendants, common
246
def common_ancestor(revision_a, revision_b, revision_source,
248
if None in (revision_a, revision_b):
250
if NULL_REVISION in (revision_a, revision_b):
252
# trivial optimisation
253
if revision_a == revision_b:
257
pb.update('Picking ancestor', 1, 3)
258
graph = revision_source.get_revision_graph_with_ghosts(
259
[revision_a, revision_b])
260
# Shortcut the case where one of the tips is already included in
261
# the other graphs ancestry.
262
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
263
if revision_b in ancestry_a:
265
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
266
if revision_a in ancestry_b:
268
# convert to a NULL_REVISION based graph.
269
ancestors = graph.get_ancestors()
270
descendants = graph.get_descendants()
271
common = set(ancestry_a)
272
common.intersection_update(ancestry_b)
273
descendants[NULL_REVISION] = {}
274
ancestors[NULL_REVISION] = []
275
for root in graph.roots:
276
descendants[NULL_REVISION][root] = 1
277
ancestors[root].append(NULL_REVISION)
278
for ghost in graph.ghosts:
279
# ghosts act as roots for the purpose of finding
280
# the longest paths from the root: any ghost *might*
281
# be directly attached to the root, so we treat them
283
# ghost now descends from NULL
284
descendants[NULL_REVISION][ghost] = 1
285
# that is it has an ancestor of NULL
286
ancestors[ghost] = [NULL_REVISION]
287
# ghost is common if any of ghosts descendants are common:
288
for ghost_descendant in descendants[ghost]:
289
if ghost_descendant in common:
293
common.add(NULL_REVISION)
294
except errors.NoCommonRoot:
295
raise errors.NoCommonAncestor(revision_a, revision_b)
297
pb.update('Picking ancestor', 2, 3)
298
distances = node_distances (descendants, ancestors, root)
299
pb.update('Picking ancestor', 3, 2)
300
farthest = select_farthest(distances, common)
301
if farthest is None or farthest == NULL_REVISION:
302
raise errors.NoCommonAncestor(revision_a, revision_b)
308
class MultipleRevisionSources(object):
309
"""Proxy that looks in multiple branches for revisions."""
310
def __init__(self, *args):
311
object.__init__(self)
312
assert len(args) != 0
313
self._revision_sources = args
315
def revision_parents(self, revision_id):
316
for source in self._revision_sources:
318
return source.revision_parents(revision_id)
319
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
323
def get_revision(self, revision_id):
324
for source in self._revision_sources:
326
return source.get_revision(revision_id)
327
except errors.NoSuchRevision, e:
331
def get_revision_graph(self, revision_id):
332
# we could probe incrementally until the pending
333
# ghosts list stop growing, but its cheaper for now
334
# to just ask for the complete graph for each repository.
336
for source in self._revision_sources:
337
ghost_graph = source.get_revision_graph_with_ghosts()
338
graphs.append(ghost_graph)
341
if not revision_id in graph.get_ancestors():
343
if absent == len(graphs):
344
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
348
pending = set([revision_id])
349
def find_parents(node_id):
350
"""find the parents for node_id."""
352
ancestors = graph.get_ancestors()
354
return ancestors[node_id]
357
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
359
# all the graphs should have identical parent lists
360
node_id = pending.pop()
362
result[node_id] = find_parents(node_id)
363
for parent_node in result[node_id]:
364
if not parent_node in result:
365
pending.add(parent_node)
366
except errors.NoSuchRevision:
371
def get_revision_graph_with_ghosts(self, revision_ids):
372
# query all the sources for their entire graphs
373
# and then build a combined graph for just
376
for source in self._revision_sources:
377
ghost_graph = source.get_revision_graph_with_ghosts()
378
graphs.append(ghost_graph.get_ancestors())
379
for revision_id in revision_ids:
382
if not revision_id in graph:
384
if absent == len(graphs):
385
raise errors.NoSuchRevision(self._revision_sources[0],
390
pending = set(revision_ids)
392
def find_parents(node_id):
393
"""find the parents for node_id."""
396
return graph[node_id]
399
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
401
# all the graphs should have identical parent lists
402
node_id = pending.pop()
404
parents = find_parents(node_id)
405
for parent_node in parents:
407
if (parent_node not in pending and
408
parent_node not in done):
410
pending.add(parent_node)
411
result.add_node(node_id, parents)
413
except errors.NoSuchRevision:
415
result.add_ghost(node_id)
420
for source in self._revision_sources:
424
for source in self._revision_sources:
428
@deprecated_function(zero_eight)
429
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
430
revision_history=None):
431
"""Find the longest line of descent from maybe_ancestor to revision.
432
Revision history is followed where possible.
434
If ancestor_id == rev_id, list will be empty.
435
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
436
If ancestor_id is not an ancestor, NotAncestor will be thrown
438
root, ancestors, descendants = revision_graph(rev_id, rev_source)
439
if len(descendants) == 0:
440
raise errors.NoSuchRevision(rev_source, rev_id)
441
if ancestor_id not in descendants:
442
rev_source.get_revision(ancestor_id)
443
raise errors.NotAncestor(rev_id, ancestor_id)
444
root_descendants = all_descendants(descendants, ancestor_id)
445
root_descendants.add(ancestor_id)
446
if rev_id not in root_descendants:
447
raise errors.NotAncestor(rev_id, ancestor_id)
448
distances = node_distances(descendants, ancestors, ancestor_id,
449
root_descendants=root_descendants)
451
def best_ancestor(rev_id):
453
for anc_id in ancestors[rev_id]:
455
distance = distances[anc_id]
458
if revision_history is not None and anc_id in revision_history:
460
elif best is None or distance > best[1]:
461
best = (anc_id, distance)
466
while next != ancestor_id:
468
next = best_ancestor(next)
473
def is_reserved_id(revision_id):
474
"""Determine whether a revision id is reserved
476
:return: True if the revision is is reserved, False otherwise
478
return isinstance(revision_id, basestring) and revision_id.endswith(':')
481
def check_not_reserved_id(revision_id):
482
"""Raise ReservedId if the supplied revision_id is reserved"""
483
if is_reserved_id(revision_id):
484
raise errors.ReservedId(revision_id)
486
def ensure_null(revision_id):
487
"""Ensure only NULL_REVISION is used to represent the null revisionn"""
488
if revision_id is None:
added
removed
bzrlib/revision.py
