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
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,
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
36
21
NULL_REVISION="null:"
37
CURRENT_REVISION="current:"
23
class RevisionReference(object):
25
Reference to a stored revision.
27
Includes the revision_id and revision_sha1.
31
def __init__(self, revision_id, revision_sha1=None):
32
if revision_id == None \
33
or isinstance(revision_id, basestring):
34
self.revision_id = revision_id
36
raise ValueError('bad revision_id %r' % revision_id)
38
if revision_sha1 != None:
39
if isinstance(revision_sha1, basestring) \
40
and len(revision_sha1) == 40:
41
self.revision_sha1 = revision_sha1
43
raise ValueError('bad revision_sha1 %r' % revision_sha1)
40
47
class Revision(object):
70
75
def __eq__(self, other):
71
76
if not isinstance(other, Revision):
73
# FIXME: rbc 20050930 parent_ids are not being compared
75
self.inventory_sha1 == other.inventory_sha1
78
return (self.inventory_id == other.inventory_id
79
and self.inventory_sha1 == other.inventory_sha1
76
80
and self.revision_id == other.revision_id
77
81
and self.timestamp == other.timestamp
78
82
and self.message == other.message
79
83
and self.timezone == other.timezone
80
and self.committer == other.committer
81
and self.properties == other.properties)
84
and self.committer == other.committer)
83
86
def __ne__(self, other):
84
87
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
def is_ancestor(revision_id, candidate_id, branch):
93
def validate_revision_id(rid):
94
"""Check rid is syntactically valid for a revision id."""
96
if not REVISION_ID_RE:
98
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
100
if not REVISION_ID_RE.match(rid):
101
raise ValueError("malformed revision-id %r" % rid)
103
def is_ancestor(revision_id, candidate_id, revision_source):
129
104
"""Return true if candidate_id is an ancestor of revision_id.
131
105
A false negative will be returned if any intermediate descendent of
132
106
candidate_id is not present in any of the revision_sources.
134
108
revisions_source is an object supporting a get_revision operation that
135
109
behaves like Branch's.
137
if is_null(candidate_id):
111
if candidate_id is None:
139
return (candidate_id in branch.repository.get_ancestry(revision_id,
113
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
114
if ancestor_id == candidate_id:
143
118
def iter_ancestors(revision_id, revision_source, only_present=False):
144
119
ancestors = (revision_id,)
165
def old_common_ancestor(revision_a, revision_b, revision_source):
166
"""Find the ancestor common to both revisions that is closest to both.
168
from bzrlib.trace import mutter
169
a_ancestors = find_present_ancestors(revision_a, revision_source)
170
b_ancestors = find_present_ancestors(revision_b, revision_source)
173
# a_order is used as a tie-breaker when two equally-good bases are found
174
for revision, (a_order, a_distance) in a_ancestors.iteritems():
175
if b_ancestors.has_key(revision):
176
a_intersection.append((a_distance, a_order, revision))
177
b_intersection.append((b_ancestors[revision][1], a_order, revision))
178
mutter("a intersection: %r" % a_intersection)
179
mutter("b intersection: %r" % b_intersection)
181
a_closest = __get_closest(a_intersection)
182
if len(a_closest) == 0:
184
b_closest = __get_closest(b_intersection)
185
assert len(b_closest) != 0
186
mutter ("a_closest %r" % a_closest)
187
mutter ("b_closest %r" % b_closest)
188
if a_closest[0] in b_closest:
190
elif b_closest[0] in a_closest:
193
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
190
196
def revision_graph(revision, revision_source):
191
197
"""Produce a graph of the ancestry of the specified revision.
193
:return: root, ancestors map, descendants map
198
Return root, ancestors map, descendants map
200
TODO: Produce graphs with the NULL revision as root, so that we can find
201
a common even when trees are not branches don't represent a single line
195
revision_source.lock_read()
197
return _revision_graph(revision, revision_source)
199
revision_source.unlock()
202
def _revision_graph(revision, revision_source):
203
"""See revision_graph."""
204
from bzrlib.tsort import topo_sort
205
graph = revision_source.get_revision_graph(revision)
206
# mark all no-parent revisions as being NULL_REVISION parentage.
207
for node, parents in graph.items():
208
if len(parents) == 0:
209
graph[node] = [NULL_REVISION]
210
# add NULL_REVISION to the graph
211
graph[NULL_REVISION] = []
213
# pick a root. If there are multiple roots
214
# this could pick a random one.
215
topo_order = topo_sort(graph.items())
221
# map the descendants of the graph.
222
# and setup our set based return graph.
223
for node in graph.keys():
224
descendants[node] = {}
225
for node, parents in graph.items():
226
for parent in parents:
227
descendants[parent][node] = 1
228
ancestors[node] = set(parents)
208
descendants[revision] = {}
209
while len(lines) > 0:
212
if line == NULL_REVISION:
217
rev = revision_source.get_revision(line)
218
parents = [p.revision_id for p in rev.parents]
219
if len(parents) == 0:
220
parents = [NULL_REVISION]
221
except bzrlib.errors.NoSuchRevision:
225
if parents is not None:
226
for parent in parents:
227
if parent not in ancestors:
228
new_lines.add(parent)
229
if parent not in descendants:
230
descendants[parent] = {}
231
descendants[parent][line] = 1
232
if parents is not None:
233
ancestors[line] = set(parents)
230
235
assert root not in descendants[root]
231
236
assert root not in ancestors[root]
232
237
return root, ancestors, descendants
235
239
def combined_graph(revision_a, revision_b, revision_source):
236
240
"""Produce a combined ancestry graph.
237
241
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)
242
root, ancestors, descendants = revision_graph(revision_a, revision_source)
243
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
242
245
if root != root_b:
243
raise errors.NoCommonRoot(revision_a, revision_b)
246
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
245
248
for node, node_anc in ancestors_b.iteritems():
246
249
if node in ancestors:
250
253
ancestors[node].update(node_anc)
251
254
for node, node_dec in descendants_b.iteritems():
252
255
if node not in descendants:
253
descendants[node] = {}
256
descendants[node] = set()
254
257
descendants[node].update(node_dec)
255
258
return root, ancestors, descendants, common
258
def common_ancestor(revision_a, revision_b, revision_source,
260
if None in (revision_a, revision_b):
262
if NULL_REVISION in (revision_a, revision_b):
264
# trivial optimisation
265
if revision_a == revision_b:
260
def common_ancestor(revision_a, revision_b, revision_source):
269
pb.update('Picking ancestor', 1, 3)
270
graph = revision_source.get_revision_graph_with_ghosts(
271
[revision_a, revision_b])
272
# Shortcut the case where one of the tips is already included in
273
# the other graphs ancestry.
274
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
275
if revision_b in ancestry_a:
277
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
278
if revision_a in ancestry_b:
280
# convert to a NULL_REVISION based graph.
281
ancestors = graph.get_ancestors()
282
descendants = graph.get_descendants()
283
common = set(ancestry_a)
284
common.intersection_update(ancestry_b)
285
descendants[NULL_REVISION] = {}
286
ancestors[NULL_REVISION] = []
287
for root in graph.roots:
288
descendants[NULL_REVISION][root] = 1
289
ancestors[root].append(NULL_REVISION)
290
for ghost in graph.ghosts:
291
# ghosts act as roots for the purpose of finding
292
# the longest paths from the root: any ghost *might*
293
# be directly attached to the root, so we treat them
295
# ghost now descends from NULL
296
descendants[NULL_REVISION][ghost] = 1
297
# that is it has an ancestor of NULL
298
ancestors[ghost] = [NULL_REVISION]
299
# ghost is common if any of ghosts descendants are common:
300
for ghost_descendant in descendants[ghost]:
301
if ghost_descendant in common:
305
common.add(NULL_REVISION)
306
except errors.NoCommonRoot:
307
raise errors.NoCommonAncestor(revision_a, revision_b)
309
pb.update('Picking ancestor', 2, 3)
310
distances = node_distances (descendants, ancestors, root)
311
pb.update('Picking ancestor', 3, 2)
312
farthest = select_farthest(distances, common)
313
if farthest is None or farthest == NULL_REVISION:
314
raise errors.NoCommonAncestor(revision_a, revision_b)
262
root, ancestors, descendants, common = \
263
combined_graph(revision_a, revision_b, revision_source)
264
except bzrlib.errors.NoCommonRoot:
265
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
267
distances = node_distances (descendants, ancestors, root)
268
farthest = select_farthest(distances, common)
269
if farthest is None or farthest == NULL_REVISION:
270
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
320
273
class MultipleRevisionSources(object):
321
274
"""Proxy that looks in multiple branches for revisions."""
322
275
def __init__(self, *args):
324
277
assert len(args) != 0
325
278
self._revision_sources = args
327
def revision_parents(self, revision_id):
328
for source in self._revision_sources:
330
return source.revision_parents(revision_id)
331
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
335
280
def get_revision(self, revision_id):
336
281
for source in self._revision_sources:
338
283
return source.get_revision(revision_id)
339
except errors.NoSuchRevision, e:
284
except bzrlib.errors.NoSuchRevision, e:
343
def get_revision_graph(self, revision_id):
344
# we could probe incrementally until the pending
345
# ghosts list stop growing, but its cheaper for now
346
# to just ask for the complete graph for each repository.
348
for source in self._revision_sources:
349
ghost_graph = source.get_revision_graph_with_ghosts()
350
graphs.append(ghost_graph)
353
if not revision_id in graph.get_ancestors():
355
if absent == len(graphs):
356
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
360
pending = set([revision_id])
361
def find_parents(node_id):
362
"""find the parents for node_id."""
364
ancestors = graph.get_ancestors()
366
return ancestors[node_id]
369
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
371
# all the graphs should have identical parent lists
372
node_id = pending.pop()
374
result[node_id] = find_parents(node_id)
375
for parent_node in result[node_id]:
376
if not parent_node in result:
377
pending.add(parent_node)
378
except errors.NoSuchRevision:
383
def get_revision_graph_with_ghosts(self, revision_ids):
384
# query all the sources for their entire graphs
385
# and then build a combined graph for just
388
for source in self._revision_sources:
389
ghost_graph = source.get_revision_graph_with_ghosts()
390
graphs.append(ghost_graph.get_ancestors())
391
for revision_id in revision_ids:
394
if not revision_id in graph:
396
if absent == len(graphs):
397
raise errors.NoSuchRevision(self._revision_sources[0],
402
pending = set(revision_ids)
404
def find_parents(node_id):
405
"""find the parents for node_id."""
408
return graph[node_id]
411
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
413
# all the graphs should have identical parent lists
414
node_id = pending.pop()
416
parents = find_parents(node_id)
417
for parent_node in parents:
419
if (parent_node not in pending and
420
parent_node not in done):
422
pending.add(parent_node)
423
result.add_node(node_id, parents)
425
except errors.NoSuchRevision:
427
result.add_ghost(node_id)
288
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
289
revision_history=None):
290
"""Find the longest line of descent from maybe_ancestor to revision.
291
Revision history is followed where possible.
293
If ancestor_id == rev_id, list will be empty.
294
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
295
If ancestor_id is not an ancestor, NotAncestor will be thrown
297
root, ancestors, descendants = revision_graph(rev_id, rev_source)
298
if len(descendants) == 0:
299
raise NoSuchRevision(rev_source, rev_id)
300
if ancestor_id not in descendants:
301
rev_source.get_revision(ancestor_id)
302
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
303
root_descendants = all_descendants(descendants, ancestor_id)
304
root_descendants.add(ancestor_id)
305
if rev_id not in root_descendants:
306
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
307
distances = node_distances(descendants, ancestors, ancestor_id,
308
root_descendants=root_descendants)
310
def best_ancestor(rev_id):
312
for anc_id in ancestors[rev_id]:
314
distance = distances[anc_id]
432
for source in self._revision_sources:
436
for source in self._revision_sources:
440
def is_reserved_id(revision_id):
441
"""Determine whether a revision id is reserved
443
:return: True if the revision is is reserved, False otherwise
445
return isinstance(revision_id, basestring) and revision_id.endswith(':')
448
def check_not_reserved_id(revision_id):
449
"""Raise ReservedId if the supplied revision_id is reserved"""
450
if is_reserved_id(revision_id):
451
raise errors.ReservedId(revision_id)
454
def ensure_null(revision_id):
455
"""Ensure only NULL_REVISION is used to represent the null revisionn"""
456
if revision_id is None:
457
symbol_versioning.warn('NULL_REVISION should be used for the null'
458
' revision instead of None, as of bzr 0.91.',
459
DeprecationWarning, stacklevel=2)
465
def is_null(revision_id):
466
if revision_id is None:
467
symbol_versioning.warn('NULL_REVISION should be used for the null'
468
' revision instead of None, as of bzr 0.90.',
469
DeprecationWarning, stacklevel=2)
470
return revision_id in (None, NULL_REVISION)
317
if revision_history is not None and anc_id in revision_history:
319
elif best is None or distance > best[1]:
320
best = (anc_id, distance)
325
while next != ancestor_id:
327
next = best_ancestor(next)
added
removed
bzrlib/revision.py
