1
# Copyright (C) 2005, 2006 Canonical Ltd
2
# -*- coding: UTF-8 -*-
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
12
# GNU General Public License for more details.
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# 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:"
33
class Revision(object):
21
from xml import XMLMixin
24
from cElementTree import Element, ElementTree, SubElement
26
from elementtree.ElementTree import Element, ElementTree, SubElement
29
class Revision(XMLMixin):
34
30
"""Single revision on a branch.
36
32
Revisions may know their revision_hash, but only once they've been
37
33
written out. This is not stored because you cannot write the hash
38
34
into the file it describes.
40
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.
36
:todo: Perhaps make predecessor be a child element, not an attribute?
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."""
38
def __init__(self, **args):
39
self.inventory_id = None
40
self.revision_id = None
58
44
self.__dict__.update(args)
60
47
def __repr__(self):
61
return "<Revision id %s>" % self.revision_id
63
def __eq__(self, other):
64
if not isinstance(other, Revision):
66
# FIXME: rbc 20050930 parent_ids are not being compared
68
self.inventory_sha1 == other.inventory_sha1
69
and self.revision_id == other.revision_id
70
and self.timestamp == other.timestamp
71
and self.message == other.message
72
and self.timezone == other.timezone
73
and self.committer == other.committer
74
and self.properties == other.properties)
76
def __ne__(self, other):
77
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):
114
"""Return true if candidate_id is an ancestor of revision_id.
116
A false negative will be returned if any intermediate descendent of
117
candidate_id is not present in any of the revision_sources.
119
revisions_source is an object supporting a get_revision operation that
120
behaves like Branch's.
122
return (candidate_id in branch.repository.get_ancestry(revision_id))
125
def iter_ancestors(revision_id, revision_source, only_present=False):
126
ancestors = (revision_id,)
128
while len(ancestors) > 0:
130
for ancestor in ancestors:
132
yield ancestor, distance
134
revision = revision_source.get_revision(ancestor)
135
except errors.NoSuchRevision, e:
136
if e.revision == revision_id:
141
yield ancestor, distance
142
new_ancestors.extend(revision.parent_ids)
143
ancestors = new_ancestors
147
def find_present_ancestors(revision_id, revision_source):
148
"""Return the ancestors of a revision present in a branch.
150
It's possible that a branch won't have the complete ancestry of
151
one of its revisions.
155
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
157
for anc_order, (anc_id, anc_distance) in anc_iter:
158
if anc_id not in found_ancestors:
159
found_ancestors[anc_id] = (anc_order, anc_distance)
160
return found_ancestors
163
def __get_closest(intersection):
166
for entry in intersection:
167
if entry[0] == intersection[0][0]:
168
matches.append(entry[2])
172
def revision_graph(revision, revision_source):
173
"""Produce a graph of the ancestry of the specified revision.
175
:return: root, ancestors map, descendants map
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)
212
assert root not in descendants[root]
213
assert root not in ancestors[root]
214
return root, ancestors, descendants
217
def combined_graph(revision_a, revision_b, revision_source):
218
"""Produce a combined ancestry graph.
219
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)
227
for node, node_anc in ancestors_b.iteritems():
228
if node in ancestors:
231
ancestors[node] = set()
232
ancestors[node].update(node_anc)
233
for node, node_dec in descendants_b.iteritems():
234
if node not in descendants:
235
descendants[node] = {}
236
descendants[node].update(node_dec)
237
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)
302
class MultipleRevisionSources(object):
303
"""Proxy that looks in multiple branches for revisions."""
304
def __init__(self, *args):
305
object.__init__(self)
306
assert len(args) != 0
307
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
def get_revision(self, revision_id):
318
for source in self._revision_sources:
320
return source.get_revision(revision_id)
321
except 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,
424
revision_history=None):
425
"""Find the longest line of descent from maybe_ancestor to revision.
426
Revision history is followed where possible.
428
If ancestor_id == rev_id, list will be empty.
429
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
430
If ancestor_id is not an ancestor, NotAncestor will be thrown
432
root, ancestors, descendants = revision_graph(rev_id, rev_source)
433
if len(descendants) == 0:
434
raise errors.NoSuchRevision(rev_source, rev_id)
435
if ancestor_id not in descendants:
436
rev_source.get_revision(ancestor_id)
437
raise errors.NotAncestor(rev_id, ancestor_id)
438
root_descendants = all_descendants(descendants, ancestor_id)
439
root_descendants.add(ancestor_id)
440
if rev_id not in root_descendants:
441
raise errors.NotAncestor(rev_id, ancestor_id)
442
distances = node_distances(descendants, ancestors, ancestor_id,
443
root_descendants=root_descendants)
445
def best_ancestor(rev_id):
447
for anc_id in ancestors[rev_id]:
449
distance = distances[anc_id]
452
if revision_history is not None and anc_id in revision_history:
454
elif best is None or distance > best[1]:
455
best = (anc_id, distance)
460
while next != ancestor_id:
462
next = best_ancestor(next)
467
def is_reserved_id(revision_id):
468
"""Determine whether a revision id is reserved
470
:return: True if the revision is is reserved, False otherwise
472
return isinstance(revision_id, basestring) and revision_id.endswith(':')
475
def check_not_reserved_id(revision_id):
476
"""Raise ReservedId if the supplied revision_id is reserved"""
477
if is_reserved_id(revision_id):
478
raise errors.ReservedId(revision_id)
49
return "<Revision id %s>" % self.revision_id
53
root = Element('revision',
54
committer = self.committer,
55
timestamp = '%.9f' % self.timestamp,
56
revision_id = self.revision_id,
57
inventory_id = self.inventory_id,
58
timezone = str(self.timezone))
60
root.set('precursor', self.precursor)
63
msg = SubElement(root, 'message')
64
msg.text = self.message
70
def from_element(cls, elt):
71
# <changeset> is deprecated...
72
if elt.tag not in ('revision', 'changeset'):
73
bailout("unexpected tag in revision file: %r" % elt)
75
cs = cls(committer = elt.get('committer'),
76
timestamp = float(elt.get('timestamp')),
77
precursor = elt.get('precursor'),
78
revision_id = elt.get('revision_id'),
79
inventory_id = elt.get('inventory_id'))
81
v = elt.get('timezone')
82
cs.timezone = v and int(v)
84
cs.message = elt.findtext('message') # text of <message>
87
from_element = classmethod(from_element)
added
removed
bzrlib/revision.py
