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.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:"
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)
38
45
class Revision(object):
68
73
def __eq__(self, other):
69
74
if not isinstance(other, Revision):
71
# FIXME: rbc 20050930 parent_ids are not being compared
73
self.inventory_sha1 == other.inventory_sha1
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
74
78
and self.revision_id == other.revision_id
75
79
and self.timestamp == other.timestamp
76
80
and self.message == other.message
77
81
and self.timezone == other.timezone
78
and self.committer == other.committer
79
and self.properties == other.properties)
82
and self.committer == other.committer)
81
84
def __ne__(self, other):
82
85
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):
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):
119
102
"""Return true if candidate_id is an ancestor of revision_id.
121
103
A false negative will be returned if any intermediate descendent of
122
104
candidate_id is not present in any of the revision_sources.
124
106
revisions_source is an object supporting a get_revision operation that
125
107
behaves like Branch's.
127
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:
131
115
def iter_ancestors(revision_id, revision_source, only_present=False):
132
116
ancestors = (revision_id,)
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
162
def common_ancestor(revision_a, revision_b, revision_source):
163
"""Find the ancestor common to both revisions that is closest to both.
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):
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:
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)
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]))
308
193
class MultipleRevisionSources(object):
309
194
"""Proxy that looks in multiple branches for revisions."""
312
197
assert len(args) != 0
313
198
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
200
def get_revision(self, revision_id):
324
201
for source in self._revision_sources:
326
203
return source.get_revision(revision_id)
327
except errors.NoSuchRevision, e:
204
except bzrlib.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,
208
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
430
209
revision_history=None):
431
210
"""Find the longest line of descent from maybe_ancestor to revision.
432
211
Revision history is followed where possible.
435
214
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
436
215
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:
217
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
218
if ancestor_id == rev_id:
220
def historical_lines(line):
221
"""Return a tuple of historical/non_historical lines, for sorting.
222
The non_historical count is negative, since non_historical lines are
227
for revision in line:
228
if revision in revision_history:
232
return good_count, bad_count
234
successful_lines = []
235
while len(active) > 0:
238
parent_ids = [p.revision_id for p in
239
rev_source.get_revision(line[-1]).parents]
240
for parent in parent_ids:
242
if parent == ancestor_id:
243
successful_lines.append(line_copy)
245
line_copy.append(parent)
246
new_active.append(line_copy)
248
if len(successful_lines) == 0:
249
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
250
for line in successful_lines:
252
if revision_history is not None:
253
by_historical_lines = []
254
for line in successful_lines:
255
count = historical_lines(line)
256
by_historical_lines.append((count, line))
257
by_historical_lines.sort()
258
if by_historical_lines[-1][0][0] > 0:
259
return by_historical_lines[-1][1]
260
assert len(successful_lines)
261
successful_lines.sort(cmp, len)
262
return successful_lines[-1]
added
removed
bzrlib/revision.py
