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.
20
18
import bzrlib.errors
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
22
from bzrlib.osutils import contains_whitespace
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)
26
45
class Revision(object):
27
46
"""Single revision on a branch.
33
52
After bzr 0.0.5 revisions are allowed to have multiple parents.
36
List of parent revision_ids
39
Dictionary of revision properties. These are attached to the
40
revision as extra metadata. The name must be a single
41
word; the value can be an arbitrary string.
55
List of parent revisions, each is a RevisionReference.
44
def __init__(self, revision_id, properties=None, **args):
45
self.revision_id = revision_id
46
self.properties = properties or {}
47
self._check_properties()
49
self.parent_sha1s = []
65
def __init__(self, **args):
50
66
self.__dict__.update(args)
52
70
def __repr__(self):
53
71
return "<Revision id %s>" % self.revision_id
55
73
def __eq__(self, other):
56
74
if not isinstance(other, Revision):
58
# FIXME: rbc 20050930 parent_ids are not being compared
60
self.inventory_sha1 == other.inventory_sha1
76
return (self.inventory_id == other.inventory_id
77
and self.inventory_sha1 == other.inventory_sha1
61
78
and self.revision_id == other.revision_id
62
79
and self.timestamp == other.timestamp
63
80
and self.message == other.message
64
81
and self.timezone == other.timezone
65
and self.committer == other.committer
66
and self.properties == other.properties)
82
and self.committer == other.committer)
68
84
def __ne__(self, other):
69
85
return not self.__eq__(other)
71
def _check_properties(self):
72
"""Verify that all revision properties are OK.
74
for name, value in self.properties.iteritems():
75
if not isinstance(name, basestring) or contains_whitespace(name):
76
raise ValueError("invalid property name %r" % name)
77
if not isinstance(value, basestring):
78
raise ValueError("invalid property value %r for %r" %
81
def get_history(self, repository):
82
"""Return the canonical line-of-history for this revision.
84
If ghosts are present this may differ in result from a ghost-free
87
current_revision = self
89
while current_revision is not None:
90
reversed_result.append(current_revision.revision_id)
91
if not len (current_revision.parent_ids):
92
reversed_result.append(None)
93
current_revision = None
95
next_revision_id = current_revision.parent_ids[0]
96
current_revision = repository.get_revision(next_revision_id)
97
reversed_result.reverse()
98
return reversed_result
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
102
def is_ancestor(revision_id, candidate_id, branch):
170
171
if b_ancestors.has_key(revision):
171
172
a_intersection.append((a_distance, a_order, revision))
172
173
b_intersection.append((b_ancestors[revision][1], a_order, revision))
173
mutter("a intersection: %r", a_intersection)
174
mutter("b intersection: %r", b_intersection)
174
mutter("a intersection: %r" % a_intersection)
175
mutter("b intersection: %r" % b_intersection)
176
177
a_closest = __get_closest(a_intersection)
177
178
if len(a_closest) == 0:
179
180
b_closest = __get_closest(b_intersection)
180
181
assert len(b_closest) != 0
181
mutter ("a_closest %r", a_closest)
182
mutter ("b_closest %r", b_closest)
182
mutter ("a_closest %r" % a_closest)
183
mutter ("b_closest %r" % b_closest)
183
184
if a_closest[0] in b_closest:
184
185
return a_closest[0]
185
186
elif b_closest[0] in a_closest:
188
189
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
189
190
return a_closest[0]
191
def revision_graph(revision, revision_source):
192
"""Produce a graph of the ancestry of the specified revision.
193
Return root, ancestors map, descendants map
195
TODO: Produce graphs with the NULL revision as root, so that we can find
196
a common even when trees are not branches don't represent a single line
198
RBC: 20051024: note that when we have two partial histories, this may not
199
be possible. But if we are willing to pretend :)... sure.
205
descendants[revision] = {}
206
while len(lines) > 0:
209
if line == NULL_REVISION:
214
rev = revision_source.get_revision(line)
215
parents = list(rev.parent_ids)
216
if len(parents) == 0:
217
parents = [NULL_REVISION]
218
except bzrlib.errors.NoSuchRevision:
222
if parents is not None:
223
for parent in parents:
224
if parent not in ancestors:
225
new_lines.add(parent)
226
if parent not in descendants:
227
descendants[parent] = {}
228
descendants[parent][line] = 1
229
if parents is not None:
230
ancestors[line] = set(parents)
233
# The history for revision becomes inaccessible without
234
# actually hitting a no-parents revision. This then
235
# makes these asserts below trigger. So, if root is None
236
# determine the actual root by walking the accessible tree
237
# and then stash NULL_REVISION at the end.
239
descendants[root] = {}
240
# for every revision, check we can access at least
241
# one parent, if we cant, add NULL_REVISION and
243
for rev in ancestors:
244
if len(ancestors[rev]) == 0:
245
raise RuntimeError('unreachable code ?!')
247
for parent in ancestors[rev]:
248
if parent in ancestors:
252
descendants[root][rev] = 1
253
ancestors[rev].add(root)
254
ancestors[root] = set()
255
assert root not in descendants[root]
256
assert root not in ancestors[root]
257
return root, ancestors, descendants
260
def combined_graph(revision_a, revision_b, revision_source):
261
"""Produce a combined ancestry graph.
262
Return graph root, ancestors map, descendants map, set of common nodes"""
263
root, ancestors, descendants = revision_graph(revision_a, revision_source)
264
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
267
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
269
for node, node_anc in ancestors_b.iteritems():
270
if node in ancestors:
273
ancestors[node] = set()
274
ancestors[node].update(node_anc)
275
for node, node_dec in descendants_b.iteritems():
276
if node not in descendants:
277
descendants[node] = {}
278
descendants[node].update(node_dec)
279
return root, ancestors, descendants, common
282
def common_ancestor(revision_a, revision_b, revision_source):
284
root, ancestors, descendants, common = \
285
combined_graph(revision_a, revision_b, revision_source)
286
except bzrlib.errors.NoCommonRoot:
287
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
289
distances = node_distances (descendants, ancestors, root)
290
farthest = select_farthest(distances, common)
291
if farthest is None or farthest == NULL_REVISION:
292
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
296
192
class MultipleRevisionSources(object):
297
193
"""Proxy that looks in multiple branches for revisions."""
298
194
def __init__(self, *args):
317
213
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
318
214
If ancestor_id is not an ancestor, NotAncestor will be thrown
320
root, ancestors, descendants = revision_graph(rev_id, rev_source)
321
if len(descendants) == 0:
322
raise NoSuchRevision(rev_source, rev_id)
323
if ancestor_id not in descendants:
324
rev_source.get_revision(ancestor_id)
325
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
326
root_descendants = all_descendants(descendants, ancestor_id)
327
root_descendants.add(ancestor_id)
328
if rev_id not in root_descendants:
329
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
330
distances = node_distances(descendants, ancestors, ancestor_id,
331
root_descendants=root_descendants)
333
def best_ancestor(rev_id):
335
for anc_id in ancestors[rev_id]:
337
distance = distances[anc_id]
340
if revision_history is not None and anc_id in revision_history:
342
elif best is None or distance > best[1]:
343
best = (anc_id, distance)
348
while next != ancestor_id:
350
next = best_ancestor(next)
216
[rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
217
if ancestor_id == rev_id:
219
def historical_lines(line):
220
"""Return a tuple of historical/non_historical lines, for sorting.
221
The non_historical count is negative, since non_historical lines are
226
for revision in line:
227
if revision in revision_history:
231
return good_count, bad_count
233
successful_lines = []
234
while len(active) > 0:
237
parent_ids = [p.revision_id for p in
238
rev_source.get_revision(line[-1]).parents]
239
for parent in parent_ids:
241
if parent == ancestor_id:
242
successful_lines.append(line_copy)
244
line_copy.append(parent)
245
new_active.append(line_copy)
247
if len(successful_lines) == 0:
248
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
249
for line in successful_lines:
251
if revision_history is not None:
252
by_historical_lines = []
253
for line in successful_lines:
254
count = historical_lines(line)
255
by_historical_lines.append((count, line))
256
by_historical_lines.sort()
257
if by_historical_lines[-1][0][0] > 0:
258
return by_historical_lines[-1][1]
259
assert len(successful_lines)
260
successful_lines.sort(cmp, len)
261
return successful_lines[-1]