1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from bzrlib.graph import farthest_nodes, node_distances, all_descendants
21
class RevisionReference(object):
23
Reference to a stored revision.
25
Includes the revision_id and revision_sha1.
29
def __init__(self, revision_id, revision_sha1=None):
30
if revision_id == None \
31
or isinstance(revision_id, basestring):
32
self.revision_id = revision_id
34
raise ValueError('bad revision_id %r' % revision_id)
36
if revision_sha1 != None:
37
if isinstance(revision_sha1, basestring) \
38
and len(revision_sha1) == 40:
39
self.revision_sha1 = revision_sha1
41
raise ValueError('bad revision_sha1 %r' % revision_sha1)
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:"
45
40
class Revision(object):
73
70
def __eq__(self, other):
74
71
if not isinstance(other, Revision):
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
73
# FIXME: rbc 20050930 parent_ids are not being compared
75
self.inventory_sha1 == other.inventory_sha1
78
76
and self.revision_id == other.revision_id
79
77
and self.timestamp == other.timestamp
80
78
and self.message == other.message
81
79
and self.timezone == other.timezone
82
and self.committer == other.committer)
80
and self.committer == other.committer
81
and self.properties == other.properties)
84
83
def __ne__(self, other):
85
84
return not self.__eq__(other)
91
def validate_revision_id(rid):
92
"""Check rid is syntactically valid for a revision id."""
94
if not REVISION_ID_RE:
96
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
98
if not REVISION_ID_RE.match(rid):
99
raise ValueError("malformed revision-id %r" % rid)
101
def is_ancestor(revision_id, candidate_id, revision_source):
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):
102
130
"""Return true if candidate_id is an ancestor of revision_id.
103
132
A false negative will be returned if any intermediate descendent of
104
133
candidate_id is not present in any of the revision_sources.
106
135
revisions_source is an object supporting a get_revision operation that
107
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)
110
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
if ancestor_id == candidate_id:
115
144
def iter_ancestors(revision_id, revision_source, only_present=False):
116
145
ancestors = (revision_id,)
162
def old_common_ancestor(revision_a, revision_b, revision_source):
163
"""Find the ancestor common to both revisions that is closest to both.
165
from bzrlib.trace import mutter
166
a_ancestors = find_present_ancestors(revision_a, revision_source)
167
b_ancestors = find_present_ancestors(revision_b, revision_source)
170
# a_order is used as a tie-breaker when two equally-good bases are found
171
for revision, (a_order, a_distance) in a_ancestors.iteritems():
172
if b_ancestors.has_key(revision):
173
a_intersection.append((a_distance, a_order, revision))
174
b_intersection.append((b_ancestors[revision][1], a_order, revision))
175
mutter("a intersection: %r" % a_intersection)
176
mutter("b intersection: %r" % b_intersection)
178
a_closest = __get_closest(a_intersection)
179
if len(a_closest) == 0:
181
b_closest = __get_closest(b_intersection)
182
assert len(b_closest) != 0
183
mutter ("a_closest %r" % a_closest)
184
mutter ("b_closest %r" % b_closest)
185
if a_closest[0] in b_closest:
187
elif b_closest[0] in a_closest:
190
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
191
@deprecated_function(symbol_versioning.one_four)
193
192
def revision_graph(revision, revision_source):
194
193
"""Produce a graph of the ancestry of the specified revision.
195
Return root, ancestors map, descendants map
197
TODO: Produce graphs with the NULL revision as root, so that we can find
198
a common even when trees are not branches don't represent a single line
195
:return: root, ancestors map, descendants map
197
revision_source.lock_read()
199
return _revision_graph(revision, revision_source)
201
revision_source.unlock()
204
def _revision_graph(revision, revision_source):
205
"""See revision_graph."""
206
from bzrlib.tsort import topo_sort
207
graph = revision_source.get_revision_graph(revision)
208
# mark all no-parent revisions as being NULL_REVISION parentage.
209
for node, parents in graph.items():
210
if len(parents) == 0:
211
graph[node] = [NULL_REVISION]
212
# add NULL_REVISION to the graph
213
graph[NULL_REVISION] = []
215
# pick a root. If there are multiple roots
216
# this could pick a random one.
217
topo_order = topo_sort(graph.items())
205
descendants[revision] = {}
206
while len(lines) > 0:
210
rev = revision_source.get_revision(line)
211
parents = [p.revision_id for p in rev.parents]
212
if len(parents) == 0:
214
except bzrlib.errors.NoSuchRevision:
218
if parents is not None:
219
for parent in parents:
220
if parent not in ancestors:
221
new_lines.add(parent)
222
if parent not in descendants:
223
descendants[parent] = {}
224
descendants[parent][line] = 1
225
if parents is not None:
226
ancestors[line] = set(parents)
223
# map the descendants of the graph.
224
# and setup our set based return graph.
225
for node in graph.keys():
226
descendants[node] = {}
227
for node, parents in graph.items():
228
for parent in parents:
229
descendants[parent][node] = 1
230
ancestors[node] = set(parents)
228
232
assert root not in descendants[root]
229
233
assert root not in ancestors[root]
230
234
return root, ancestors, descendants
237
@deprecated_function(symbol_versioning.one_three)
232
238
def combined_graph(revision_a, revision_b, revision_source):
233
239
"""Produce a combined ancestry graph.
234
240
Return graph root, ancestors map, descendants map, set of common nodes"""
235
root, ancestors, descendants = revision_graph(revision_a, revision_source)
236
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
241
root, ancestors, descendants = revision_graph(
242
revision_a, revision_source)
243
root_b, ancestors_b, descendants_b = revision_graph(
244
revision_b, revision_source)
238
245
if root != root_b:
239
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
246
raise errors.NoCommonRoot(revision_a, revision_b)
241
248
for node, node_anc in ancestors_b.iteritems():
242
249
if node in ancestors:
246
253
ancestors[node].update(node_anc)
247
254
for node, node_dec in descendants_b.iteritems():
248
255
if node not in descendants:
249
descendants[node] = set()
256
descendants[node] = {}
250
257
descendants[node].update(node_dec)
251
258
return root, ancestors, descendants, common
253
def common_ancestor(revision_a, revision_b, revision_source):
261
@deprecated_function(symbol_versioning.one_three)
262
def common_ancestor(revision_a, revision_b, revision_source,
264
if None in (revision_a, revision_b):
266
if NULL_REVISION in (revision_a, revision_b):
268
# trivial optimisation
269
if revision_a == revision_b:
255
root, ancestors, descendants, common = \
256
combined_graph(revision_a, revision_b, revision_source)
257
except bzrlib.errors.NoCommonRoot:
258
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
260
nodes = farthest_nodes(descendants, ancestors, root)
264
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
273
pb.update('Picking ancestor', 1, 3)
274
graph = revision_source.get_revision_graph_with_ghosts(
275
[revision_a, revision_b])
276
# Shortcut the case where one of the tips is already included in
277
# the other graphs ancestry.
278
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
279
if revision_b in ancestry_a:
281
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
282
if revision_a in ancestry_b:
284
# convert to a NULL_REVISION based graph.
285
ancestors = graph.get_ancestors()
286
descendants = graph.get_descendants()
287
common = set(ancestry_a)
288
common.intersection_update(ancestry_b)
289
descendants[NULL_REVISION] = {}
290
ancestors[NULL_REVISION] = []
291
for root in graph.roots:
292
descendants[NULL_REVISION][root] = 1
293
ancestors[root].append(NULL_REVISION)
294
for ghost in graph.ghosts:
295
# ghosts act as roots for the purpose of finding
296
# the longest paths from the root: any ghost *might*
297
# be directly attached to the root, so we treat them
299
# ghost now descends from NULL
300
descendants[NULL_REVISION][ghost] = 1
301
# that is it has an ancestor of NULL
302
ancestors[ghost] = [NULL_REVISION]
303
# ghost is common if any of ghosts descendants are common:
304
for ghost_descendant in descendants[ghost]:
305
if ghost_descendant in common:
309
common.add(NULL_REVISION)
310
except errors.NoCommonRoot:
311
raise errors.NoCommonAncestor(revision_a, revision_b)
313
pb.update('Picking ancestor', 2, 3)
314
distances = node_distances (descendants, ancestors, root)
315
pb.update('Picking ancestor', 3, 2)
316
farthest = select_farthest(distances, common)
317
if farthest is None or farthest == NULL_REVISION:
318
raise errors.NoCommonAncestor(revision_a, revision_b)
266
324
class MultipleRevisionSources(object):
267
325
"""Proxy that looks in multiple branches for revisions."""
327
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
268
328
def __init__(self, *args):
269
329
object.__init__(self)
270
330
assert len(args) != 0
271
331
self._revision_sources = args
333
def revision_parents(self, revision_id):
334
for source in self._revision_sources:
336
return source.revision_parents(revision_id)
337
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
273
341
def get_revision(self, revision_id):
274
342
for source in self._revision_sources:
276
344
return source.get_revision(revision_id)
277
except bzrlib.errors.NoSuchRevision, e:
345
except errors.NoSuchRevision, e:
281
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
282
revision_history=None):
283
"""Find the longest line of descent from maybe_ancestor to revision.
284
Revision history is followed where possible.
286
If ancestor_id == rev_id, list will be empty.
287
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
288
If ancestor_id is not an ancestor, NotAncestor will be thrown
290
root, ancestors, descendants = revision_graph(rev_id, rev_source)
291
if len(descendants) == 0:
292
raise NoSuchRevision(rev_source, rev_id)
293
if ancestor_id not in descendants:
294
rev_source.get_revision(ancestor_id)
295
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
296
root_descendants = all_descendants(descendants, ancestor_id)
297
root_descendants.add(ancestor_id)
298
if rev_id not in root_descendants:
299
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
300
distances = node_distances(descendants, ancestors, ancestor_id,
301
root_descendants=root_descendants)
303
def best_ancestor(rev_id):
305
for anc_id in ancestors[rev_id]:
307
distance = distances[anc_id]
349
def get_revision_graph(self, revision_id):
350
# we could probe incrementally until the pending
351
# ghosts list stop growing, but its cheaper for now
352
# to just ask for the complete graph for each repository.
354
for source in self._revision_sources:
355
ghost_graph = source.get_revision_graph_with_ghosts()
356
graphs.append(ghost_graph)
359
if not revision_id in graph.get_ancestors():
361
if absent == len(graphs):
362
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
366
pending = set([revision_id])
367
def find_parents(node_id):
368
"""find the parents for node_id."""
370
ancestors = graph.get_ancestors()
372
return ancestors[node_id]
375
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
377
# all the graphs should have identical parent lists
378
node_id = pending.pop()
380
result[node_id] = find_parents(node_id)
381
for parent_node in result[node_id]:
382
if not parent_node in result:
383
pending.add(parent_node)
384
except errors.NoSuchRevision:
389
def get_revision_graph_with_ghosts(self, revision_ids):
390
# query all the sources for their entire graphs
391
# and then build a combined graph for just
394
for source in self._revision_sources:
395
ghost_graph = source.get_revision_graph_with_ghosts()
396
graphs.append(ghost_graph.get_ancestors())
397
for revision_id in revision_ids:
400
if not revision_id in graph:
402
if absent == len(graphs):
403
raise errors.NoSuchRevision(self._revision_sources[0],
408
pending = set(revision_ids)
410
def find_parents(node_id):
411
"""find the parents for node_id."""
414
return graph[node_id]
417
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
419
# all the graphs should have identical parent lists
420
node_id = pending.pop()
422
parents = find_parents(node_id)
423
for parent_node in parents:
425
if (parent_node not in pending and
426
parent_node not in done):
428
pending.add(parent_node)
429
result.add_node(node_id, parents)
431
except errors.NoSuchRevision:
433
result.add_ghost(node_id)
310
if revision_history is not None and anc_id in revision_history:
312
elif best is None or distance > best[1]:
313
best = (anc_id, distance)
318
while next != ancestor_id:
320
next = best_ancestor(next)
438
for source in self._revision_sources:
442
for source in self._revision_sources:
446
def is_reserved_id(revision_id):
447
"""Determine whether a revision id is reserved
449
:return: True if the revision is is reserved, False otherwise
451
return isinstance(revision_id, basestring) and revision_id.endswith(':')
454
def check_not_reserved_id(revision_id):
455
"""Raise ReservedId if the supplied revision_id is reserved"""
456
if is_reserved_id(revision_id):
457
raise errors.ReservedId(revision_id)
460
def ensure_null(revision_id):
461
"""Ensure only NULL_REVISION is used to represent the null revision"""
462
if revision_id is None:
463
symbol_versioning.warn('NULL_REVISION should be used for the null'
464
' revision instead of None, as of bzr 0.91.',
465
DeprecationWarning, stacklevel=2)
471
def is_null(revision_id):
472
if revision_id is None:
473
symbol_versioning.warn('NULL_REVISION should be used for the null'
474
' revision instead of None, as of bzr 0.90.',
475
DeprecationWarning, stacklevel=2)
476
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
