1
# Copyright (C) 2005, 2006 Canonical
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,
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
29
21
NULL_REVISION="null:"
41
33
List of parent revision_ids
44
Dictionary of revision properties. These are attached to the
45
revision as extra metadata. The name must be a single
46
word; the value can be an arbitrary string.
49
def __init__(self, revision_id, properties=None, **args):
36
def __init__(self, revision_id, **args):
50
37
self.revision_id = revision_id
51
self.properties = properties or {}
52
self._check_properties()
38
self.__dict__.update(args)
53
39
self.parent_ids = []
54
40
self.parent_sha1s = []
55
"""Not used anymore - legacy from for 4."""
56
self.__dict__.update(args)
58
42
def __repr__(self):
59
43
return "<Revision id %s>" % self.revision_id
68
52
and self.timestamp == other.timestamp
69
53
and self.message == other.message
70
54
and self.timezone == other.timezone
71
and self.committer == other.committer
72
and self.properties == other.properties)
55
and self.committer == other.committer)
74
57
def __ne__(self, other):
75
58
return not self.__eq__(other)
77
def _check_properties(self):
78
"""Verify that all revision properties are OK."""
79
for name, value in self.properties.iteritems():
80
if not isinstance(name, basestring) or contains_whitespace(name):
81
raise ValueError("invalid property name %r" % name)
82
if not isinstance(value, basestring):
83
raise ValueError("invalid property value %r for %r" %
86
def get_history(self, repository):
87
"""Return the canonical line-of-history for this revision.
89
If ghosts are present this may differ in result from a ghost-free
92
current_revision = self
94
while current_revision is not None:
95
reversed_result.append(current_revision.revision_id)
96
if not len (current_revision.parent_ids):
97
reversed_result.append(None)
98
current_revision = None
100
next_revision_id = current_revision.parent_ids[0]
101
current_revision = repository.get_revision(next_revision_id)
102
reversed_result.reverse()
103
return reversed_result
105
def get_summary(self):
106
"""Get the first line of the log message for this revision.
108
return self.message.split('\n', 1)[0]
63
def validate_revision_id(rid):
64
"""Check rid is syntactically valid for a revision id."""
66
if not REVISION_ID_RE:
68
REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
70
if not REVISION_ID_RE.match(rid):
71
raise ValueError("malformed revision-id %r" % rid)
111
74
def is_ancestor(revision_id, candidate_id, branch):
133
def old_common_ancestor(revision_a, revision_b, revision_source):
134
"""Find the ancestor common to both revisions that is closest to both.
136
from bzrlib.trace import mutter
137
a_ancestors = find_present_ancestors(revision_a, revision_source)
138
b_ancestors = find_present_ancestors(revision_b, revision_source)
141
# a_order is used as a tie-breaker when two equally-good bases are found
142
for revision, (a_order, a_distance) in a_ancestors.iteritems():
143
if b_ancestors.has_key(revision):
144
a_intersection.append((a_distance, a_order, revision))
145
b_intersection.append((b_ancestors[revision][1], a_order, revision))
146
mutter("a intersection: %r" % a_intersection)
147
mutter("b intersection: %r" % b_intersection)
149
a_closest = __get_closest(a_intersection)
150
if len(a_closest) == 0:
152
b_closest = __get_closest(b_intersection)
153
assert len(b_closest) != 0
154
mutter ("a_closest %r" % a_closest)
155
mutter ("b_closest %r" % b_closest)
156
if a_closest[0] in b_closest:
158
elif b_closest[0] in a_closest:
161
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
170
164
def revision_graph(revision, revision_source):
171
165
"""Produce a graph of the ancestry of the specified revision.
173
:return: root, ancestors map, descendants map
166
Return root, ancestors map, descendants map
168
TODO: Produce graphs with the NULL revision as root, so that we can find
169
a common even when trees are not branches don't represent a single line
175
revision_source.lock_read()
177
return _revision_graph(revision, revision_source)
179
revision_source.unlock()
182
def _revision_graph(revision, revision_source):
183
"""See revision_graph."""
184
from bzrlib.tsort import topo_sort
185
graph = revision_source.get_revision_graph(revision)
186
# mark all no-parent revisions as being NULL_REVISION parentage.
187
for node, parents in graph.items():
188
if len(parents) == 0:
189
graph[node] = [NULL_REVISION]
190
# add NULL_REVISION to the graph
191
graph[NULL_REVISION] = []
193
# pick a root. If there are multiple roots
194
# this could pick a random one.
195
topo_order = topo_sort(graph.items())
201
# map the descendants of the graph.
202
# and setup our set based return graph.
203
for node in graph.keys():
204
descendants[node] = {}
205
for node, parents in graph.items():
206
for parent in parents:
207
descendants[parent][node] = 1
208
ancestors[node] = set(parents)
176
descendants[revision] = {}
177
while len(lines) > 0:
180
if line == NULL_REVISION:
185
rev = revision_source.get_revision(line)
186
parents = list(rev.parent_ids)
187
if len(parents) == 0:
188
parents = [NULL_REVISION]
189
except bzrlib.errors.NoSuchRevision:
193
if parents is not None:
194
for parent in parents:
195
if parent not in ancestors:
196
new_lines.add(parent)
197
if parent not in descendants:
198
descendants[parent] = {}
199
descendants[parent][line] = 1
200
if parents is not None:
201
ancestors[line] = set(parents)
210
203
assert root not in descendants[root]
211
204
assert root not in ancestors[root]
212
205
return root, ancestors, descendants
215
208
def combined_graph(revision_a, revision_b, revision_source):
216
209
"""Produce a combined ancestry graph.
217
210
Return graph root, ancestors map, descendants map, set of common nodes"""
218
root, ancestors, descendants = revision_graph(
219
revision_a, revision_source)
220
root_b, ancestors_b, descendants_b = revision_graph(
221
revision_b, revision_source)
211
root, ancestors, descendants = revision_graph(revision_a, revision_source)
212
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
222
214
if root != root_b:
223
raise errors.NoCommonRoot(revision_a, revision_b)
215
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
225
217
for node, node_anc in ancestors_b.iteritems():
226
218
if node in ancestors:
235
227
return root, ancestors, descendants, common
238
def common_ancestor(revision_a, revision_b, revision_source,
240
if None in (revision_a, revision_b):
242
if NULL_REVISION in (revision_a, revision_b):
244
# trivial optimisation
245
if revision_a == revision_b:
230
def common_ancestor(revision_a, revision_b, revision_source):
249
pb.update('Picking ancestor', 1, 3)
250
graph = revision_source.get_revision_graph_with_ghosts(
251
[revision_a, revision_b])
252
# convert to a NULL_REVISION based graph.
253
ancestors = graph.get_ancestors()
254
descendants = graph.get_descendants()
255
common = set(graph.get_ancestry(revision_a)).intersection(
256
set(graph.get_ancestry(revision_b)))
257
descendants[NULL_REVISION] = {}
258
ancestors[NULL_REVISION] = []
259
for root in graph.roots:
260
descendants[NULL_REVISION][root] = 1
261
ancestors[root].append(NULL_REVISION)
262
for ghost in graph.ghosts:
263
# ghosts act as roots for the purpose of finding
264
# the longest paths from the root: any ghost *might*
265
# be directly attached to the root, so we treat them
267
# ghost now descends from NULL
268
descendants[NULL_REVISION][ghost] = 1
269
# that is it has an ancestor of NULL
270
ancestors[ghost] = [NULL_REVISION]
271
# ghost is common if any of ghosts descendants are common:
272
for ghost_descendant in descendants[ghost]:
273
if ghost_descendant in common:
277
common.add(NULL_REVISION)
278
except errors.NoCommonRoot:
279
raise errors.NoCommonAncestor(revision_a, revision_b)
281
pb.update('Picking ancestor', 2, 3)
282
distances = node_distances (descendants, ancestors, root)
283
pb.update('Picking ancestor', 3, 2)
284
farthest = select_farthest(distances, common)
285
if farthest is None or farthest == NULL_REVISION:
286
raise errors.NoCommonAncestor(revision_a, revision_b)
232
root, ancestors, descendants, common = \
233
combined_graph(revision_a, revision_b, revision_source)
234
except bzrlib.errors.NoCommonRoot:
235
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
237
distances = node_distances (descendants, ancestors, root)
238
farthest = select_farthest(distances, common)
239
if farthest is None or farthest == NULL_REVISION:
240
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
296
248
assert len(args) != 0
297
249
self._revision_sources = args
299
def revision_parents(self, revision_id):
300
for source in self._revision_sources:
302
return source.revision_parents(revision_id)
303
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
307
251
def get_revision(self, revision_id):
308
252
for source in self._revision_sources:
310
254
return source.get_revision(revision_id)
311
except errors.NoSuchRevision, e:
255
except bzrlib.errors.NoSuchRevision, e:
315
def get_revision_graph(self, revision_id):
316
# we could probe incrementally until the pending
317
# ghosts list stop growing, but its cheaper for now
318
# to just ask for the complete graph for each repository.
320
for source in self._revision_sources:
321
ghost_graph = source.get_revision_graph_with_ghosts()
322
graphs.append(ghost_graph)
325
if not revision_id in graph.get_ancestors():
327
if absent == len(graphs):
328
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
332
pending = set([revision_id])
333
def find_parents(node_id):
334
"""find the parents for node_id."""
336
ancestors = graph.get_ancestors()
338
return ancestors[node_id]
341
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
343
# all the graphs should have identical parent lists
344
node_id = pending.pop()
346
result[node_id] = find_parents(node_id)
347
for parent_node in result[node_id]:
348
if not parent_node in result:
349
pending.add(parent_node)
350
except errors.NoSuchRevision:
355
def get_revision_graph_with_ghosts(self, revision_ids):
356
# query all the sources for their entire graphs
357
# and then build a combined graph for just
360
for source in self._revision_sources:
361
ghost_graph = source.get_revision_graph_with_ghosts()
362
graphs.append(ghost_graph.get_ancestors())
363
for revision_id in revision_ids:
366
if not revision_id in graph:
368
if absent == len(graphs):
369
raise errors.NoSuchRevision(self._revision_sources[0],
374
pending = set(revision_ids)
376
def find_parents(node_id):
377
"""find the parents for node_id."""
380
return graph[node_id]
383
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
385
# all the graphs should have identical parent lists
386
node_id = pending.pop()
388
parents = find_parents(node_id)
389
for parent_node in parents:
391
if (parent_node not in pending and
392
parent_node not in done):
394
pending.add(parent_node)
395
result.add_node(node_id, parents)
397
except errors.NoSuchRevision:
399
result.add_ghost(node_id)
404
for source in self._revision_sources:
408
for source in self._revision_sources:
412
@deprecated_function(zero_eight)
413
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
259
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
414
260
revision_history=None):
415
261
"""Find the longest line of descent from maybe_ancestor to revision.
416
262
Revision history is followed where possible.
422
268
root, ancestors, descendants = revision_graph(rev_id, rev_source)
423
269
if len(descendants) == 0:
424
raise errors.NoSuchRevision(rev_source, rev_id)
270
raise NoSuchRevision(rev_source, rev_id)
425
271
if ancestor_id not in descendants:
426
272
rev_source.get_revision(ancestor_id)
427
raise errors.NotAncestor(rev_id, ancestor_id)
273
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
428
274
root_descendants = all_descendants(descendants, ancestor_id)
429
275
root_descendants.add(ancestor_id)
430
276
if rev_id not in root_descendants:
431
raise errors.NotAncestor(rev_id, ancestor_id)
277
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
432
278
distances = node_distances(descendants, ancestors, ancestor_id,
433
279
root_descendants=root_descendants)
added
removed
bzrlib/revision.py
