~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-06-24 05:34:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050624053425-6fab66f10cf619f4
- log messages from a particular test are printed if that test fails

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import bzrlib.errors
19
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
20
 
 
21
 
NULL_REVISION="null:"
22
 
 
23
 
class Revision(object):
 
18
 
 
19
 
 
20
from xml import XMLMixin
 
21
 
 
22
try:
 
23
    from cElementTree import Element, ElementTree, SubElement
 
24
except ImportError:
 
25
    from elementtree.ElementTree import Element, ElementTree, SubElement
 
26
 
 
27
from errors import BzrError
 
28
 
 
29
 
 
30
class RevisionReference:
 
31
    """
 
32
    Reference to a stored revision.
 
33
 
 
34
    Includes the revision_id and revision_sha1.
 
35
    """
 
36
    revision_id = None
 
37
    revision_sha1 = None
 
38
    def __init__(self, revision_id, revision_sha1):
 
39
        if revision_id == None \
 
40
           or isinstance(revision_id, basestring):
 
41
            self.revision_id = revision_id
 
42
        else:
 
43
            raise ValueError('bad revision_id %r' % revision_id)
 
44
 
 
45
        if revision_sha1 != None:
 
46
            if isinstance(revision_sha1, basestring) \
 
47
               and len(revision_sha1) == 40:
 
48
                self.revision_sha1 = revision_sha1
 
49
            else:
 
50
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
 
51
                
 
52
 
 
53
 
 
54
class Revision(XMLMixin):
24
55
    """Single revision on a branch.
25
56
 
26
57
    Revisions may know their revision_hash, but only once they've been
28
59
    into the file it describes.
29
60
 
30
61
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
62
    To support old clients this is written out in a slightly redundant
 
63
    form: the first parent as the predecessor.  This will eventually
 
64
    be dropped.
31
65
 
32
 
    parent_ids
33
 
        List of parent revision_ids
 
66
    parents
 
67
        List of parent revisions, each is a RevisionReference.
34
68
    """
35
69
    inventory_id = None
36
70
    inventory_sha1 = None
42
76
    
43
77
    def __init__(self, **args):
44
78
        self.__dict__.update(args)
45
 
        self.parent_ids = []
46
 
        self.parent_sha1s = []
 
79
        self.parents = []
 
80
 
 
81
    def _get_precursor(self):
 
82
        from warnings import warn
 
83
        warn("Revision.precursor is deprecated", stacklevel=2)
 
84
        if self.parents:
 
85
            return self.parents[0].revision_id
 
86
        else:
 
87
            return None
 
88
 
 
89
 
 
90
    def _get_precursor_sha1(self):
 
91
        from warnings import warn
 
92
        warn("Revision.precursor_sha1 is deprecated", stacklevel=2)
 
93
        if self.parents:
 
94
            return self.parents[0].revision_sha1
 
95
        else:
 
96
            return None    
 
97
 
 
98
 
 
99
    def _fail(self):
 
100
        raise Exception("can't assign to precursor anymore")
 
101
 
 
102
 
 
103
    precursor = property(_get_precursor, _fail, _fail)
 
104
    precursor_sha1 = property(_get_precursor_sha1, _fail, _fail)
 
105
 
47
106
 
48
107
 
49
108
    def __repr__(self):
50
109
        return "<Revision id %s>" % self.revision_id
51
110
 
52
 
    def __eq__(self, other):
53
 
        if not isinstance(other, Revision):
54
 
            return False
55
 
        return (self.inventory_id == other.inventory_id
56
 
                and self.inventory_sha1 == other.inventory_sha1
57
 
                and self.revision_id == other.revision_id
58
 
                and self.timestamp == other.timestamp
59
 
                and self.message == other.message
60
 
                and self.timezone == other.timezone
61
 
                and self.committer == other.committer)
62
 
 
63
 
    def __ne__(self, other):
64
 
        return not self.__eq__(other)
65
 
 
66
 
        
67
 
 
68
 
REVISION_ID_RE = None
69
 
 
70
 
def validate_revision_id(rid):
71
 
    """Check rid is syntactically valid for a revision id."""
72
 
    global REVISION_ID_RE
73
 
    if not REVISION_ID_RE:
74
 
        import re
75
 
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
76
 
 
77
 
    if not REVISION_ID_RE.match(rid):
78
 
        raise ValueError("malformed revision-id %r" % rid)
79
 
 
80
 
 
81
 
def is_ancestor(revision_id, candidate_id, branch):
82
 
    """Return true if candidate_id is an ancestor of revision_id.
83
 
 
84
 
    A false negative will be returned if any intermediate descendent of
85
 
    candidate_id is not present in any of the revision_sources.
86
 
    
87
 
    revisions_source is an object supporting a get_revision operation that
88
 
    behaves like Branch's.
89
 
    """
90
 
    return candidate_id in branch.get_ancestry(revision_id)
91
 
 
92
 
 
93
 
def iter_ancestors(revision_id, revision_source, only_present=False):
94
 
    ancestors = (revision_id,)
95
 
    distance = 0
96
 
    while len(ancestors) > 0:
97
 
        new_ancestors = []
98
 
        for ancestor in ancestors:
99
 
            if not only_present:
100
 
                yield ancestor, distance
101
 
            try:
102
 
                revision = revision_source.get_revision(ancestor)
103
 
            except bzrlib.errors.NoSuchRevision, e:
104
 
                if e.revision == revision_id:
105
 
                    raise 
106
 
                else:
107
 
                    continue
108
 
            if only_present:
109
 
                yield ancestor, distance
110
 
            new_ancestors.extend(revision.parent_ids)
111
 
        ancestors = new_ancestors
112
 
        distance += 1
113
 
 
114
 
 
115
 
def find_present_ancestors(revision_id, revision_source):
116
 
    """Return the ancestors of a revision present in a branch.
117
 
 
118
 
    It's possible that a branch won't have the complete ancestry of
119
 
    one of its revisions.  
120
 
 
121
 
    """
122
 
    found_ancestors = {}
123
 
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
124
 
                         only_present=True))
125
 
    for anc_order, (anc_id, anc_distance) in anc_iter:
126
 
        if not found_ancestors.has_key(anc_id):
127
 
            found_ancestors[anc_id] = (anc_order, anc_distance)
128
 
    return found_ancestors
129
 
    
130
 
 
131
 
def __get_closest(intersection):
132
 
    intersection.sort()
133
 
    matches = [] 
134
 
    for entry in intersection:
135
 
        if entry[0] == intersection[0][0]:
136
 
            matches.append(entry[2])
137
 
    return matches
138
 
 
139
 
 
140
 
def old_common_ancestor(revision_a, revision_b, revision_source):
141
 
    """Find the ancestor common to both revisions that is closest to both.
142
 
    """
143
 
    from bzrlib.trace import mutter
144
 
    a_ancestors = find_present_ancestors(revision_a, revision_source)
145
 
    b_ancestors = find_present_ancestors(revision_b, revision_source)
146
 
    a_intersection = []
147
 
    b_intersection = []
148
 
    # a_order is used as a tie-breaker when two equally-good bases are found
149
 
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
150
 
        if b_ancestors.has_key(revision):
151
 
            a_intersection.append((a_distance, a_order, revision))
152
 
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
153
 
    mutter("a intersection: %r" % a_intersection)
154
 
    mutter("b intersection: %r" % b_intersection)
155
 
 
156
 
    a_closest = __get_closest(a_intersection)
157
 
    if len(a_closest) == 0:
158
 
        return None
159
 
    b_closest = __get_closest(b_intersection)
160
 
    assert len(b_closest) != 0
161
 
    mutter ("a_closest %r" % a_closest)
162
 
    mutter ("b_closest %r" % b_closest)
163
 
    if a_closest[0] in b_closest:
164
 
        return a_closest[0]
165
 
    elif b_closest[0] in a_closest:
166
 
        return b_closest[0]
167
 
    else:
168
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
169
 
    return a_closest[0]
170
 
 
171
 
def revision_graph(revision, revision_source):
172
 
    """Produce a graph of the ancestry of the specified revision.
173
 
    Return root, ancestors map, descendants map
174
 
 
175
 
    TODO: Produce graphs with the NULL revision as root, so that we can find
176
 
    a common even when trees are not branches don't represent a single line
177
 
    of descent.
178
 
    """
179
 
    ancestors = {}
180
 
    descendants = {}
181
 
    lines = [revision]
182
 
    root = None
183
 
    descendants[revision] = {}
184
 
    while len(lines) > 0:
185
 
        new_lines = set()
186
 
        for line in lines:
187
 
            if line == NULL_REVISION:
188
 
                parents = []
189
 
                root = NULL_REVISION
190
 
            else:
191
 
                try:
192
 
                    rev = revision_source.get_revision(line)
193
 
                    parents = list(rev.parent_ids)
194
 
                    if len(parents) == 0:
195
 
                        parents = [NULL_REVISION]
196
 
                except bzrlib.errors.NoSuchRevision:
197
 
                    if line == revision:
198
 
                        raise
199
 
                    parents = None
200
 
            if parents is not None:
201
 
                for parent in parents:
202
 
                    if parent not in ancestors:
203
 
                        new_lines.add(parent)
204
 
                    if parent not in descendants:
205
 
                        descendants[parent] = {}
206
 
                    descendants[parent][line] = 1
207
 
            if parents is not None:
208
 
                ancestors[line] = set(parents)
209
 
        lines = new_lines
210
 
    assert root not in descendants[root]
211
 
    assert root not in ancestors[root]
212
 
    return root, ancestors, descendants
213
 
 
214
 
def combined_graph(revision_a, revision_b, revision_source):
215
 
    """Produce a combined ancestry graph.
216
 
    Return graph root, ancestors map, descendants map, set of common nodes"""
217
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
218
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
219
 
                                                        revision_source)
220
 
    if root != root_b:
221
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
222
 
    common = set()
223
 
    for node, node_anc in ancestors_b.iteritems():
224
 
        if node in ancestors:
225
 
            common.add(node)
226
 
        else:
227
 
            ancestors[node] = set()
228
 
        ancestors[node].update(node_anc)
229
 
    for node, node_dec in descendants_b.iteritems():
230
 
        if node not in descendants:
231
 
            descendants[node] = {}
232
 
        descendants[node].update(node_dec)
233
 
    return root, ancestors, descendants, common
234
 
 
235
 
def common_ancestor(revision_a, revision_b, revision_source):
236
 
    try:
237
 
        root, ancestors, descendants, common = \
238
 
            combined_graph(revision_a, revision_b, revision_source)
239
 
    except bzrlib.errors.NoCommonRoot:
240
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
241
 
        
242
 
    distances = node_distances (descendants, ancestors, root)
243
 
    farthest = select_farthest(distances, common)
244
 
    if farthest is None or farthest == NULL_REVISION:
245
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
246
 
    return farthest
247
 
 
248
 
class MultipleRevisionSources(object):
249
 
    """Proxy that looks in multiple branches for revisions."""
250
 
    def __init__(self, *args):
251
 
        object.__init__(self)
252
 
        assert len(args) != 0
253
 
        self._revision_sources = args
254
 
 
255
 
    def get_revision(self, revision_id):
256
 
        for source in self._revision_sources:
257
 
            try:
258
 
                return source.get_revision(revision_id)
259
 
            except bzrlib.errors.NoSuchRevision, e:
260
 
                pass
261
 
        raise e
262
 
 
263
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
264
 
                              revision_history=None):
265
 
    """Find the longest line of descent from maybe_ancestor to revision.
266
 
    Revision history is followed where possible.
267
 
 
268
 
    If ancestor_id == rev_id, list will be empty.
269
 
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
270
 
    If ancestor_id is not an ancestor, NotAncestor will be thrown
271
 
    """
272
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
273
 
    if len(descendants) == 0:
274
 
        raise NoSuchRevision(rev_source, rev_id)
275
 
    if ancestor_id not in descendants:
276
 
        rev_source.get_revision(ancestor_id)
277
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
278
 
    root_descendants = all_descendants(descendants, ancestor_id)
279
 
    root_descendants.add(ancestor_id)
280
 
    if rev_id not in root_descendants:
281
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
282
 
    distances = node_distances(descendants, ancestors, ancestor_id,
283
 
                               root_descendants=root_descendants)
284
 
 
285
 
    def best_ancestor(rev_id):
286
 
        best = None
287
 
        for anc_id in ancestors[rev_id]:
288
 
            try:
289
 
                distance = distances[anc_id]
290
 
            except KeyError:
291
 
                continue
292
 
            if revision_history is not None and anc_id in revision_history:
293
 
                return anc_id
294
 
            elif best is None or distance > best[1]:
295
 
                best = (anc_id, distance)
296
 
        return best[0]
297
 
 
298
 
    next = rev_id
299
 
    path = []
300
 
    while next != ancestor_id:
301
 
        path.append(next)
302
 
        next = best_ancestor(next)
303
 
    path.reverse()
304
 
    return path
 
111
        
 
112
    def to_element(self):
 
113
        root = Element('revision',
 
114
                       committer = self.committer,
 
115
                       timestamp = '%.9f' % self.timestamp,
 
116
                       revision_id = self.revision_id,
 
117
                       inventory_id = self.inventory_id,
 
118
                       inventory_sha1 = self.inventory_sha1,
 
119
                       )
 
120
        if self.timezone:
 
121
            root.set('timezone', str(self.timezone))
 
122
        root.text = '\n'
 
123
        
 
124
        msg = SubElement(root, 'message')
 
125
        msg.text = self.message
 
126
        msg.tail = '\n'
 
127
 
 
128
        if self.parents:
 
129
            # first parent stored as precursor for compatability with 0.0.5 and
 
130
            # earlier
 
131
            pr = self.parents[0]
 
132
            assert pr.revision_id
 
133
            root.set('precursor', pr.revision_id)
 
134
            if pr.revision_sha1:
 
135
                root.set('precursor_sha1', pr.revision_sha1)
 
136
                
 
137
        if self.parents:
 
138
            pelts = SubElement(root, 'parents')
 
139
            pelts.tail = pelts.text = '\n'
 
140
            for rr in self.parents:
 
141
                assert isinstance(rr, RevisionReference)
 
142
                p = SubElement(pelts, 'revision_ref')
 
143
                p.tail = '\n'
 
144
                assert rr.revision_id
 
145
                p.set('revision_id', rr.revision_id)
 
146
                if rr.revision_sha1:
 
147
                    p.set('revision_sha1', rr.revision_sha1)
 
148
 
 
149
        return root
 
150
 
 
151
 
 
152
    def from_element(cls, elt):
 
153
        return unpack_revision(elt)
 
154
 
 
155
    from_element = classmethod(from_element)
 
156
 
 
157
 
 
158
 
 
159
def unpack_revision(elt):
 
160
    """Convert XML element into Revision object."""
 
161
    # <changeset> is deprecated...
 
162
    if elt.tag not in ('revision', 'changeset'):
 
163
        raise BzrError("unexpected tag in revision file: %r" % elt)
 
164
 
 
165
    rev = Revision(committer = elt.get('committer'),
 
166
                   timestamp = float(elt.get('timestamp')),
 
167
                   revision_id = elt.get('revision_id'),
 
168
                   inventory_id = elt.get('inventory_id'),
 
169
                   inventory_sha1 = elt.get('inventory_sha1')
 
170
                   )
 
171
 
 
172
    precursor = elt.get('precursor')
 
173
    precursor_sha1 = elt.get('precursor_sha1')
 
174
 
 
175
    pelts = elt.find('parents')
 
176
 
 
177
    if precursor:
 
178
        # revisions written prior to 0.0.5 have a single precursor
 
179
        # give as an attribute
 
180
        rev_ref = RevisionReference(precursor, precursor_sha1)
 
181
        rev.parents.append(rev_ref)
 
182
    elif pelts:
 
183
        for p in pelts:
 
184
            assert p.tag == 'revision_ref', \
 
185
                   "bad parent node tag %r" % p.tag
 
186
            rev_ref = RevisionReference(p.get('revision_id'),
 
187
                                        p.get('revision_sha1'))
 
188
            rev.parents.append(rev_ref)
 
189
 
 
190
    v = elt.get('timezone')
 
191
    rev.timezone = v and int(v)
 
192
 
 
193
    rev.message = elt.findtext('message') # text of <message>
 
194
    return rev