~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-07-11 03:42:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050711034253-412281abeb9f56ad
doc

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