~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-07-04 11:57:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050704115718-b532986c0714e7a7
- don't write precursor field in new revision xml
- make parents more primary; remove more precursor code
- test commit of revision with parents

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