~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-09-22 06:19:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050922061933-4b71d0f1e205b153
- keep track of number of checked revisions

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
 
 
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
 
                
 
18
import bzrlib.errors
42
19
 
43
20
 
44
21
class Revision(object):
50
27
 
51
28
    After bzr 0.0.5 revisions are allowed to have multiple parents.
52
29
 
53
 
    parents
54
 
        List of parent revisions, each is a RevisionReference.
 
30
    parent_ids
 
31
        List of parent revision_ids
55
32
    """
56
33
    inventory_id = None
57
34
    inventory_sha1 = None
63
40
    
64
41
    def __init__(self, **args):
65
42
        self.__dict__.update(args)
66
 
        self.parents = []
 
43
        self.parent_ids = []
 
44
        self.parent_sha1s = []
67
45
 
68
46
 
69
47
    def __repr__(self):
70
48
        return "<Revision id %s>" % self.revision_id
71
49
 
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
 
 
 
50
    def __eq__(self, other):
 
51
        if not isinstance(other, Revision):
 
52
            return False
 
53
        return (self.inventory_id == other.inventory_id
 
54
                and self.inventory_sha1 == other.inventory_sha1
 
55
                and self.revision_id == other.revision_id
 
56
                and self.timestamp == other.timestamp
 
57
                and self.message == other.message
 
58
                and self.timezone == other.timezone
 
59
                and self.committer == other.committer)
 
60
 
 
61
    def __ne__(self, other):
 
62
        return not self.__eq__(other)
 
63
 
 
64
        
158
65
 
159
66
REVISION_ID_RE = None
160
67
 
167
74
 
168
75
    if not REVISION_ID_RE.match(rid):
169
76
        raise ValueError("malformed revision-id %r" % rid)
170
 
    
 
77
 
 
78
 
 
79
def is_ancestor(revision_id, candidate_id, branch):
 
80
    """Return true if candidate_id is an ancestor of revision_id.
 
81
 
 
82
    A false negative will be returned if any intermediate descendent of
 
83
    candidate_id is not present in any of the revision_sources.
 
84
    
 
85
    revisions_source is an object supporting a get_revision operation that
 
86
    behaves like Branch's.
 
87
    """
 
88
    return candidate_id in branch.get_ancestry(revision_id)
 
89
 
 
90
 
 
91
def iter_ancestors(revision_id, revision_source, only_present=False):
 
92
    ancestors = (revision_id,)
 
93
    distance = 0
 
94
    while len(ancestors) > 0:
 
95
        new_ancestors = []
 
96
        for ancestor in ancestors:
 
97
            if not only_present:
 
98
                yield ancestor, distance
 
99
            try:
 
100
                revision = revision_source.get_revision(ancestor)
 
101
            except bzrlib.errors.NoSuchRevision, e:
 
102
                if e.revision == revision_id:
 
103
                    raise 
 
104
                else:
 
105
                    continue
 
106
            if only_present:
 
107
                yield ancestor, distance
 
108
            new_ancestors.extend(revision.parent_ids)
 
109
        ancestors = new_ancestors
 
110
        distance += 1
 
111
 
 
112
 
 
113
def find_present_ancestors(revision_id, revision_source):
 
114
    """Return the ancestors of a revision present in a branch.
 
115
 
 
116
    It's possible that a branch won't have the complete ancestry of
 
117
    one of its revisions.  
 
118
 
 
119
    """
 
120
    found_ancestors = {}
 
121
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
122
                         only_present=True))
 
123
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
124
        if not found_ancestors.has_key(anc_id):
 
125
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
126
    return found_ancestors
 
127
    
 
128
 
 
129
def __get_closest(intersection):
 
130
    intersection.sort()
 
131
    matches = [] 
 
132
    for entry in intersection:
 
133
        if entry[0] == intersection[0][0]:
 
134
            matches.append(entry[2])
 
135
    return matches
 
136
 
 
137
 
 
138
def common_ancestor(revision_a, revision_b, revision_source):
 
139
    """Find the ancestor common to both revisions that is closest to both.
 
140
    """
 
141
    from bzrlib.trace import mutter
 
142
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
143
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
144
    a_intersection = []
 
145
    b_intersection = []
 
146
    # a_order is used as a tie-breaker when two equally-good bases are found
 
147
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
148
        if b_ancestors.has_key(revision):
 
149
            a_intersection.append((a_distance, a_order, revision))
 
150
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
151
    mutter("a intersection: %r" % a_intersection)
 
152
    mutter("b intersection: %r" % b_intersection)
 
153
 
 
154
    a_closest = __get_closest(a_intersection)
 
155
    if len(a_closest) == 0:
 
156
        return None
 
157
    b_closest = __get_closest(b_intersection)
 
158
    assert len(b_closest) != 0
 
159
    mutter ("a_closest %r" % a_closest)
 
160
    mutter ("b_closest %r" % b_closest)
 
161
    if a_closest[0] in b_closest:
 
162
        return a_closest[0]
 
163
    elif b_closest[0] in a_closest:
 
164
        return b_closest[0]
 
165
    else:
 
166
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
167
    return a_closest[0]
 
168
 
 
169
class MultipleRevisionSources(object):
 
170
    """Proxy that looks in multiple branches for revisions."""
 
171
    def __init__(self, *args):
 
172
        object.__init__(self)
 
173
        assert len(args) != 0
 
174
        self._revision_sources = args
 
175
 
 
176
    def get_revision(self, revision_id):
 
177
        for source in self._revision_sources:
 
178
            try:
 
179
                return source.get_revision(revision_id)
 
180
            except bzrlib.errors.NoSuchRevision, e:
 
181
                pass
 
182
        raise e
 
183
 
 
184
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
185
                              revision_history=None):
 
186
    """Find the longest line of descent from maybe_ancestor to revision.
 
187
    Revision history is followed where possible.
 
188
 
 
189
    If ancestor_id == rev_id, list will be empty.
 
190
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
191
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
192
    """
 
193
    [rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
 
194
    if ancestor_id == rev_id:
 
195
        return []
 
196
    def historical_lines(line):
 
197
        """Return a tuple of historical/non_historical lines, for sorting.
 
198
        The non_historical count is negative, since non_historical lines are
 
199
        a bad thing.
 
200
        """
 
201
        good_count = 0
 
202
        bad_count = 0
 
203
        for revision in line:
 
204
            if revision in revision_history:
 
205
                good_count += 1
 
206
            else:
 
207
                bad_count -= 1
 
208
        return good_count, bad_count
 
209
    active = [[rev_id]]
 
210
    successful_lines = []
 
211
    while len(active) > 0:
 
212
        new_active = []
 
213
        for line in active:
 
214
            for parent in rev_source.get_revision(line[-1]).parent_ids:
 
215
                line_copy = line[:]
 
216
                if parent == ancestor_id:
 
217
                    successful_lines.append(line_copy)
 
218
                else:
 
219
                    line_copy.append(parent)
 
220
                    new_active.append(line_copy)
 
221
        active = new_active
 
222
    if len(successful_lines) == 0:
 
223
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
224
    for line in successful_lines:
 
225
        line.reverse()
 
226
    if revision_history is not None:
 
227
        by_historical_lines = []
 
228
        for line in successful_lines:
 
229
            count = historical_lines(line)
 
230
            by_historical_lines.append((count, line))
 
231
        by_historical_lines.sort()
 
232
        if by_historical_lines[-1][0][0] > 0:
 
233
            return by_historical_lines[-1][1]
 
234
    assert len(successful_lines)
 
235
    successful_lines.sort(cmp, len)
 
236
    return successful_lines[-1]