~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-08-30 06:10:39 UTC
  • Revision ID: mbp@sourcefrog.net-20050830061039-1d0347fb236c39ad
- clean up some code in revision.py

- move all exceptions to bzrlib.errors

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
 
18
18
import bzrlib.errors
19
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
20
 
 
21
 
NULL_REVISION="null:"
 
19
 
 
20
 
 
21
class RevisionReference(object):
 
22
    """
 
23
    Reference to a stored revision.
 
24
 
 
25
    Includes the revision_id and revision_sha1.
 
26
    """
 
27
    revision_id = None
 
28
    revision_sha1 = None
 
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
 
33
        else:
 
34
            raise ValueError('bad revision_id %r' % revision_id)
 
35
 
 
36
        if revision_sha1 != None:
 
37
            if isinstance(revision_sha1, basestring) \
 
38
               and len(revision_sha1) == 40:
 
39
                self.revision_sha1 = revision_sha1
 
40
            else:
 
41
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
 
42
                
 
43
 
22
44
 
23
45
class Revision(object):
24
46
    """Single revision on a branch.
29
51
 
30
52
    After bzr 0.0.5 revisions are allowed to have multiple parents.
31
53
 
32
 
    parent_ids
33
 
        List of parent revision_ids
 
54
    parents
 
55
        List of parent revisions, each is a RevisionReference.
34
56
    """
35
57
    inventory_id = None
36
58
    inventory_sha1 = None
42
64
    
43
65
    def __init__(self, **args):
44
66
        self.__dict__.update(args)
45
 
        self.parent_ids = []
46
 
        self.parent_sha1s = []
 
67
        self.parents = []
47
68
 
48
69
 
49
70
    def __repr__(self):
50
71
        return "<Revision id %s>" % self.revision_id
51
72
 
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
 
        
 
73
        
 
74
    def to_element(self):
 
75
        from bzrlib.xml import Element, SubElement
 
76
        
 
77
        root = Element('revision',
 
78
                       committer = self.committer,
 
79
                       timestamp = '%.9f' % self.timestamp,
 
80
                       revision_id = self.revision_id,
 
81
                       inventory_id = self.inventory_id,
 
82
                       inventory_sha1 = self.inventory_sha1,
 
83
                       )
 
84
        if self.timezone:
 
85
            root.set('timezone', str(self.timezone))
 
86
        root.text = '\n'
 
87
        
 
88
        msg = SubElement(root, 'message')
 
89
        msg.text = self.message
 
90
        msg.tail = '\n'
 
91
 
 
92
        if self.parents:
 
93
            pelts = SubElement(root, 'parents')
 
94
            pelts.tail = pelts.text = '\n'
 
95
            for rr in self.parents:
 
96
                assert isinstance(rr, RevisionReference)
 
97
                p = SubElement(pelts, 'revision_ref')
 
98
                p.tail = '\n'
 
99
                assert rr.revision_id
 
100
                p.set('revision_id', rr.revision_id)
 
101
                if rr.revision_sha1:
 
102
                    p.set('revision_sha1', rr.revision_sha1)
 
103
 
 
104
        return root
 
105
 
 
106
 
 
107
    def from_element(cls, elt):
 
108
        return unpack_revision(elt)
 
109
 
 
110
    from_element = classmethod(from_element)
 
111
 
 
112
 
 
113
 
 
114
def unpack_revision(elt):
 
115
    """Convert XML element into Revision object."""
 
116
    # <changeset> is deprecated...
 
117
    if elt.tag not in ('revision', 'changeset'):
 
118
        raise bzrlib.errors.BzrError("unexpected tag in revision file: %r" % elt)
 
119
 
 
120
    rev = Revision(committer = elt.get('committer'),
 
121
                   timestamp = float(elt.get('timestamp')),
 
122
                   revision_id = elt.get('revision_id'),
 
123
                   inventory_id = elt.get('inventory_id'),
 
124
                   inventory_sha1 = elt.get('inventory_sha1')
 
125
                   )
 
126
 
 
127
    precursor = elt.get('precursor')
 
128
    precursor_sha1 = elt.get('precursor_sha1')
 
129
 
 
130
    pelts = elt.find('parents')
 
131
 
 
132
    if pelts:
 
133
        for p in pelts:
 
134
            assert p.tag == 'revision_ref', \
 
135
                   "bad parent node tag %r" % p.tag
 
136
            rev_ref = RevisionReference(p.get('revision_id'),
 
137
                                        p.get('revision_sha1'))
 
138
            rev.parents.append(rev_ref)
 
139
 
 
140
        if precursor:
 
141
            # must be consistent
 
142
            prec_parent = rev.parents[0].revision_id
 
143
            assert prec_parent == precursor
 
144
    elif precursor:
 
145
        # revisions written prior to 0.0.5 have a single precursor
 
146
        # give as an attribute
 
147
        rev_ref = RevisionReference(precursor, precursor_sha1)
 
148
        rev.parents.append(rev_ref)
 
149
 
 
150
    v = elt.get('timezone')
 
151
    rev.timezone = v and int(v)
 
152
 
 
153
    rev.message = elt.findtext('message') # text of <message>
 
154
    return rev
 
155
 
 
156
 
67
157
 
68
158
REVISION_ID_RE = None
69
159
 
77
167
    if not REVISION_ID_RE.match(rid):
78
168
        raise ValueError("malformed revision-id %r" % rid)
79
169
 
80
 
 
81
 
def is_ancestor(revision_id, candidate_id, branch):
 
170
def is_ancestor(revision_id, candidate_id, revision_source):
82
171
    """Return true if candidate_id is an ancestor of revision_id.
83
 
 
84
172
    A false negative will be returned if any intermediate descendent of
85
173
    candidate_id is not present in any of the revision_sources.
86
174
    
87
175
    revisions_source is an object supporting a get_revision operation that
88
176
    behaves like Branch's.
89
177
    """
90
 
    return candidate_id in branch.get_ancestry(revision_id)
91
178
 
 
179
    for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
 
180
        if ancestor_id == candidate_id:
 
181
            return True
 
182
    return False
92
183
 
93
184
def iter_ancestors(revision_id, revision_source, only_present=False):
94
185
    ancestors = (revision_id,)
107
198
                    continue
108
199
            if only_present:
109
200
                yield ancestor, distance
110
 
            new_ancestors.extend(revision.parent_ids)
 
201
            new_ancestors.extend([p.revision_id for p in revision.parents])
111
202
        ancestors = new_ancestors
112
203
        distance += 1
113
204
 
137
228
    return matches
138
229
 
139
230
 
140
 
def old_common_ancestor(revision_a, revision_b, revision_source):
 
231
def common_ancestor(revision_a, revision_b, revision_source):
141
232
    """Find the ancestor common to both revisions that is closest to both.
142
233
    """
143
234
    from bzrlib.trace import mutter
165
256
    elif b_closest[0] in a_closest:
166
257
        return b_closest[0]
167
258
    else:
168
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
259
        raise AmbiguousBase((a_closest[0], b_closest[0]))
169
260
    return a_closest[0]
170
261
 
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
262
class MultipleRevisionSources(object):
249
263
    """Proxy that looks in multiple branches for revisions."""
250
264
    def __init__(self, *args):
259
273
            except bzrlib.errors.NoSuchRevision, e:
260
274
                pass
261
275
        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