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.
21
import bzrlib.errors as errors
22
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
23
from bzrlib.osutils import contains_whitespace
24
from bzrlib.progress import DummyProgress
25
from bzrlib.symbol_versioning import (deprecated_function,
30
CURRENT_REVISION="current:"
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)
33
45
class Revision(object):
40
52
After bzr 0.0.5 revisions are allowed to have multiple parents.
43
List of parent revision_ids
46
Dictionary of revision properties. These are attached to the
47
revision as extra metadata. The name must be a single
48
word; the value can be an arbitrary string.
55
List of parent revisions, each is a RevisionReference.
51
def __init__(self, revision_id, properties=None, **args):
52
self.revision_id = revision_id
53
self.properties = properties or {}
54
self._check_properties()
56
self.parent_sha1s = []
57
"""Not used anymore - legacy from for 4."""
65
def __init__(self, **args):
58
66
self.__dict__.update(args)
60
70
def __repr__(self):
61
71
return "<Revision id %s>" % self.revision_id
63
73
def __eq__(self, other):
64
74
if not isinstance(other, Revision):
66
# FIXME: rbc 20050930 parent_ids are not being compared
68
self.inventory_sha1 == other.inventory_sha1
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
69
78
and self.revision_id == other.revision_id
70
79
and self.timestamp == other.timestamp
71
80
and self.message == other.message
72
81
and self.timezone == other.timezone
73
and self.committer == other.committer
74
and self.properties == other.properties)
82
and self.committer == other.committer)
76
84
def __ne__(self, other):
77
85
return not self.__eq__(other)
79
def _check_properties(self):
80
"""Verify that all revision properties are OK."""
81
for name, value in self.properties.iteritems():
82
if not isinstance(name, basestring) or contains_whitespace(name):
83
raise ValueError("invalid property name %r" % name)
84
if not isinstance(value, basestring):
85
raise ValueError("invalid property value %r for %r" %
88
def get_history(self, repository):
89
"""Return the canonical line-of-history for this revision.
91
If ghosts are present this may differ in result from a ghost-free
94
current_revision = self
96
while current_revision is not None:
97
reversed_result.append(current_revision.revision_id)
98
if not len (current_revision.parent_ids):
99
reversed_result.append(None)
100
current_revision = None
102
next_revision_id = current_revision.parent_ids[0]
103
current_revision = repository.get_revision(next_revision_id)
104
reversed_result.reverse()
105
return reversed_result
107
def get_summary(self):
108
"""Get the first line of the log message for this revision.
110
return self.message.split('\n', 1)[0]
113
def is_ancestor(revision_id, candidate_id, branch):
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):
114
102
"""Return true if candidate_id is an ancestor of revision_id.
116
103
A false negative will be returned if any intermediate descendent of
117
104
candidate_id is not present in any of the revision_sources.
119
106
revisions_source is an object supporting a get_revision operation that
120
107
behaves like Branch's.
122
return (candidate_id in branch.repository.get_ancestry(revision_id))
110
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
if ancestor_id == candidate_id:
125
115
def iter_ancestors(revision_id, revision_source, only_present=False):
126
116
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]))
172
193
def revision_graph(revision, revision_source):
173
194
"""Produce a graph of the ancestry of the specified revision.
175
:return: root, ancestors map, descendants map
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
177
revision_source.lock_read()
179
return _revision_graph(revision, revision_source)
181
revision_source.unlock()
184
def _revision_graph(revision, revision_source):
185
"""See revision_graph."""
186
from bzrlib.tsort import topo_sort
187
graph = revision_source.get_revision_graph(revision)
188
# mark all no-parent revisions as being NULL_REVISION parentage.
189
for node, parents in graph.items():
190
if len(parents) == 0:
191
graph[node] = [NULL_REVISION]
192
# add NULL_REVISION to the graph
193
graph[NULL_REVISION] = []
195
# pick a root. If there are multiple roots
196
# this could pick a random one.
197
topo_order = topo_sort(graph.items())
203
# map the descendants of the graph.
204
# and setup our set based return graph.
205
for node in graph.keys():
206
descendants[node] = {}
207
for node, parents in graph.items():
208
for parent in parents:
209
descendants[parent][node] = 1
210
ancestors[node] = set(parents)
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)
212
228
assert root not in descendants[root]
213
229
assert root not in ancestors[root]
214
230
return root, ancestors, descendants
217
232
def combined_graph(revision_a, revision_b, revision_source):
218
233
"""Produce a combined ancestry graph.
219
234
Return graph root, ancestors map, descendants map, set of common nodes"""
220
root, ancestors, descendants = revision_graph(
221
revision_a, revision_source)
222
root_b, ancestors_b, descendants_b = revision_graph(
223
revision_b, revision_source)
225
raise errors.NoCommonRoot(revision_a, revision_b)
235
root, ancestors, descendants = revision_graph(revision_a, revision_source)
236
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
238
assert root == root_b
227
240
for node, node_anc in ancestors_b.iteritems():
228
241
if node in ancestors:
232
245
ancestors[node].update(node_anc)
233
246
for node, node_dec in descendants_b.iteritems():
234
247
if node not in descendants:
235
descendants[node] = {}
248
descendants[node] = set()
236
249
descendants[node].update(node_dec)
237
250
return root, ancestors, descendants, common
240
def common_ancestor(revision_a, revision_b, revision_source,
242
if None in (revision_a, revision_b):
244
if NULL_REVISION in (revision_a, revision_b):
246
# trivial optimisation
247
if revision_a == revision_b:
251
pb.update('Picking ancestor', 1, 3)
252
graph = revision_source.get_revision_graph_with_ghosts(
253
[revision_a, revision_b])
254
# Shortcut the case where one of the tips is already included in
255
# the other graphs ancestry.
256
ancestry_a = graph.get_ancestry(revision_a)
257
if revision_b in ancestry_a:
259
ancestry_b = graph.get_ancestry(revision_b)
260
if revision_a in ancestry_b:
262
# convert to a NULL_REVISION based graph.
263
ancestors = graph.get_ancestors()
264
descendants = graph.get_descendants()
265
common = set(ancestry_a)
266
common.intersection_update(ancestry_b)
267
descendants[NULL_REVISION] = {}
268
ancestors[NULL_REVISION] = []
269
for root in graph.roots:
270
descendants[NULL_REVISION][root] = 1
271
ancestors[root].append(NULL_REVISION)
272
for ghost in graph.ghosts:
273
# ghosts act as roots for the purpose of finding
274
# the longest paths from the root: any ghost *might*
275
# be directly attached to the root, so we treat them
277
# ghost now descends from NULL
278
descendants[NULL_REVISION][ghost] = 1
279
# that is it has an ancestor of NULL
280
ancestors[ghost] = [NULL_REVISION]
281
# ghost is common if any of ghosts descendants are common:
282
for ghost_descendant in descendants[ghost]:
283
if ghost_descendant in common:
287
common.add(NULL_REVISION)
288
except errors.NoCommonRoot:
289
raise errors.NoCommonAncestor(revision_a, revision_b)
291
pb.update('Picking ancestor', 2, 3)
292
distances = node_distances (descendants, ancestors, root)
293
pb.update('Picking ancestor', 3, 2)
294
farthest = select_farthest(distances, common)
295
if farthest is None or farthest == NULL_REVISION:
296
raise errors.NoCommonAncestor(revision_a, revision_b)
252
def common_ancestor(revision_a, revision_b, revision_source):
253
root, ancestors, descendants, common = \
254
combined_graph(revision_a, revision_b, revision_source)
255
nodes = farthest_nodes(descendants, ancestors, root)
302
260
class MultipleRevisionSources(object):
303
261
"""Proxy that looks in multiple branches for revisions."""
306
264
assert len(args) != 0
307
265
self._revision_sources = args
309
def revision_parents(self, revision_id):
310
for source in self._revision_sources:
312
return source.revision_parents(revision_id)
313
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
317
267
def get_revision(self, revision_id):
318
268
for source in self._revision_sources:
320
270
return source.get_revision(revision_id)
321
except errors.NoSuchRevision, e:
271
except bzrlib.errors.NoSuchRevision, e:
325
def get_revision_graph(self, revision_id):
326
# we could probe incrementally until the pending
327
# ghosts list stop growing, but its cheaper for now
328
# to just ask for the complete graph for each repository.
330
for source in self._revision_sources:
331
ghost_graph = source.get_revision_graph_with_ghosts()
332
graphs.append(ghost_graph)
335
if not revision_id in graph.get_ancestors():
337
if absent == len(graphs):
338
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
342
pending = set([revision_id])
343
def find_parents(node_id):
344
"""find the parents for node_id."""
346
ancestors = graph.get_ancestors()
348
return ancestors[node_id]
351
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
353
# all the graphs should have identical parent lists
354
node_id = pending.pop()
356
result[node_id] = find_parents(node_id)
357
for parent_node in result[node_id]:
358
if not parent_node in result:
359
pending.add(parent_node)
360
except errors.NoSuchRevision:
365
def get_revision_graph_with_ghosts(self, revision_ids):
366
# query all the sources for their entire graphs
367
# and then build a combined graph for just
370
for source in self._revision_sources:
371
ghost_graph = source.get_revision_graph_with_ghosts()
372
graphs.append(ghost_graph.get_ancestors())
373
for revision_id in revision_ids:
376
if not revision_id in graph:
378
if absent == len(graphs):
379
raise errors.NoSuchRevision(self._revision_sources[0],
384
pending = set(revision_ids)
386
def find_parents(node_id):
387
"""find the parents for node_id."""
390
return graph[node_id]
393
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
395
# all the graphs should have identical parent lists
396
node_id = pending.pop()
398
parents = find_parents(node_id)
399
for parent_node in parents:
401
if (parent_node not in pending and
402
parent_node not in done):
404
pending.add(parent_node)
405
result.add_node(node_id, parents)
407
except errors.NoSuchRevision:
409
result.add_ghost(node_id)
414
for source in self._revision_sources:
418
for source in self._revision_sources:
422
@deprecated_function(zero_eight)
423
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
275
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
424
276
revision_history=None):
425
277
"""Find the longest line of descent from maybe_ancestor to revision.
426
278
Revision history is followed where possible.
432
284
root, ancestors, descendants = revision_graph(rev_id, rev_source)
433
285
if len(descendants) == 0:
434
raise errors.NoSuchRevision(rev_source, rev_id)
286
raise NoSuchRevision(rev_source, rev_id)
435
287
if ancestor_id not in descendants:
436
288
rev_source.get_revision(ancestor_id)
437
raise errors.NotAncestor(rev_id, ancestor_id)
289
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
438
290
root_descendants = all_descendants(descendants, ancestor_id)
439
291
root_descendants.add(ancestor_id)
440
292
if rev_id not in root_descendants:
441
raise errors.NotAncestor(rev_id, ancestor_id)
293
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
442
294
distances = node_distances(descendants, ancestors, ancestor_id,
443
295
root_descendants=root_descendants)
added
removed
bzrlib/revision.py
