~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-08-29 06:56:22 UTC
  • Revision ID: mbp@sourcefrog.net-20050829065622-5aa7add87c38f188
- additional trace messages for plugins

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# (C) 2005 Canonical
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
17
 
19
 
 
20
 
 
21
 
from xml import XMLMixin
22
 
 
23
 
try:
24
 
    from cElementTree import Element, ElementTree, SubElement
25
 
except ImportError:
26
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
27
 
 
28
 
 
29
 
class Revision(XMLMixin):
 
18
import bzrlib.errors
 
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
 
 
44
 
 
45
class Revision(object):
30
46
    """Single revision on a branch.
31
47
 
32
48
    Revisions may know their revision_hash, but only once they've been
33
49
    written out.  This is not stored because you cannot write the hash
34
50
    into the file it describes.
35
51
 
36
 
    :todo: Perhaps make predecessor be a child element, not an attribute?
 
52
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
53
 
 
54
    parents
 
55
        List of parent revisions, each is a RevisionReference.
37
56
    """
 
57
    inventory_id = None
 
58
    inventory_sha1 = None
 
59
    revision_id = None
 
60
    timestamp = None
 
61
    message = None
 
62
    timezone = None
 
63
    committer = None
 
64
    
38
65
    def __init__(self, **args):
39
 
        self.inventory_id = None
40
 
        self.revision_id = None
41
 
        self.timestamp = None
42
 
        self.message = None
43
 
        self.timezone = None
44
66
        self.__dict__.update(args)
 
67
        self.parents = []
45
68
 
46
69
 
47
70
    def __repr__(self):
48
 
        if self.revision_id:
49
 
            return "<Revision id %s>" % self.revision_id
 
71
        return "<Revision id %s>" % self.revision_id
50
72
 
51
73
        
52
74
    def to_element(self):
 
75
        from bzrlib.xml import Element, SubElement
 
76
        
53
77
        root = Element('revision',
54
78
                       committer = self.committer,
55
79
                       timestamp = '%.9f' % self.timestamp,
56
80
                       revision_id = self.revision_id,
57
81
                       inventory_id = self.inventory_id,
58
 
                       timezone = str(self.timezone))
59
 
        if self.precursor:
60
 
            root.set('precursor', self.precursor)
 
82
                       inventory_sha1 = self.inventory_sha1,
 
83
                       )
 
84
        if self.timezone:
 
85
            root.set('timezone', str(self.timezone))
61
86
        root.text = '\n'
62
87
        
63
88
        msg = SubElement(root, 'message')
64
89
        msg.text = self.message
65
90
        msg.tail = '\n'
66
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
 
67
104
        return root
68
105
 
69
106
 
70
107
    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)
74
 
 
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'))
80
 
 
81
 
        v = elt.get('timezone')
82
 
        cs.timezone = v and int(v)
83
 
 
84
 
        cs.message = elt.findtext('message') # text of <message>
85
 
        return cs
 
108
        return unpack_revision(elt)
86
109
 
87
110
    from_element = classmethod(from_element)
88
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
 
 
157
 
 
158
REVISION_ID_RE = None
 
159
 
 
160
def validate_revision_id(rid):
 
161
    """Check rid is syntactically valid for a revision id."""
 
162
    global REVISION_ID_RE
 
163
    if not REVISION_ID_RE:
 
164
        import re
 
165
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
 
166
 
 
167
    if not REVISION_ID_RE.match(rid):
 
168
        raise ValueError("malformed revision-id %r" % rid)
 
169
 
 
170
def is_ancestor(revision_id, candidate_id, revision_source):
 
171
    """Return true if candidate_id is an ancestor of revision_id.
 
172
    A false negative will be returned if any intermediate descendent of
 
173
    candidate_id is not present in any of the revision_sources.
 
174
    
 
175
    revisions_source is an object supporting a get_revision operation that
 
176
    behaves like Branch's.
 
177
    """
 
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
 
183
 
 
184
def iter_ancestors(revision_id, revision_source, only_present=False):
 
185
    ancestors = (revision_id,)
 
186
    distance = 0
 
187
    while len(ancestors) > 0:
 
188
        new_ancestors = []
 
189
        for ancestor in ancestors:
 
190
            if not only_present:
 
191
                yield ancestor, distance
 
192
            try:
 
193
                revision = revision_source.get_revision(ancestor)
 
194
            except bzrlib.errors.NoSuchRevision, e:
 
195
                if e.revision == revision_id:
 
196
                    raise 
 
197
                else:
 
198
                    continue
 
199
            if only_present:
 
200
                yield ancestor, distance
 
201
            new_ancestors.extend([p.revision_id for p in revision.parents])
 
202
        ancestors = new_ancestors
 
203
        distance += 1
 
204
 
 
205
 
 
206
def find_present_ancestors(revision_id, revision_source):
 
207
    """Return the ancestors of a revision present in a branch.
 
208
 
 
209
    It's possible that a branch won't have the complete ancestry of
 
210
    one of its revisions.  
 
211
 
 
212
    """
 
213
    found_ancestors = {}
 
214
    count = 0
 
215
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
216
                         only_present=True))
 
217
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
218
        if not found_ancestors.has_key(anc_id):
 
219
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
220
    return found_ancestors
 
221
    
 
222
class AmbiguousBase(bzrlib.errors.BzrError):
 
223
    def __init__(self, bases):
 
224
        msg = "The correct base is unclear, becase %s are all equally close" %\
 
225
            ", ".join(bases)
 
226
        bzrlib.errors.BzrError.__init__(self, msg)
 
227
        self.bases = bases
 
228
 
 
229
def common_ancestor(revision_a, revision_b, revision_source):
 
230
    """Find the ancestor common to both revisions that is closest to both.
 
231
    """
 
232
    from bzrlib.trace import mutter
 
233
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
234
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
235
    a_intersection = []
 
236
    b_intersection = []
 
237
    # a_order is used as a tie-breaker when two equally-good bases are found
 
238
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
239
        if b_ancestors.has_key(revision):
 
240
            a_intersection.append((a_distance, a_order, revision))
 
241
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
242
    mutter("a intersection: %r" % a_intersection)
 
243
    mutter("b intersection: %r" % b_intersection)
 
244
    def get_closest(intersection):
 
245
        intersection.sort()
 
246
        matches = [] 
 
247
        for entry in intersection:
 
248
            if entry[0] == intersection[0][0]:
 
249
                matches.append(entry[2])
 
250
        return matches
 
251
 
 
252
    a_closest = get_closest(a_intersection)
 
253
    if len(a_closest) == 0:
 
254
        return None
 
255
    b_closest = get_closest(b_intersection)
 
256
    assert len(b_closest) != 0
 
257
    mutter ("a_closest %r" % a_closest)
 
258
    mutter ("b_closest %r" % b_closest)
 
259
    if a_closest[0] in b_closest:
 
260
        return a_closest[0]
 
261
    elif b_closest[0] in a_closest:
 
262
        return b_closest[0]
 
263
    else:
 
264
        raise AmbiguousBase((a_closest[0], b_closest[0]))
 
265
    return a_closest[0]
 
266
 
 
267
class MultipleRevisionSources(object):
 
268
    def __init__(self, *args):
 
269
        object.__init__(self)
 
270
        assert len(args) != 0
 
271
        self._revision_sources = args
 
272
 
 
273
    def get_revision(self, revision_id):
 
274
        for source in self._revision_sources:
 
275
            try:
 
276
                return source.get_revision(revision_id)
 
277
            except bzrlib.errors.NoSuchRevision, e:
 
278
                pass
 
279
        raise e