~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-08-04 21:39:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050804213923-aaf986c9c9a29506
- merge bzrlib.revision.is_ancestor from aaron

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
# TODO: Some kind of command-line display of revision properties: 
18
 
# perhaps show them in log -v and allow them as options to the commit command.
19
 
 
20
 
import bzrlib.errors
21
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
22
 
from bzrlib.osutils import contains_whitespace
23
 
 
24
 
NULL_REVISION="null:"
 
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
                
 
42
 
25
43
 
26
44
class Revision(object):
27
45
    """Single revision on a branch.
32
50
 
33
51
    After bzr 0.0.5 revisions are allowed to have multiple parents.
34
52
 
35
 
    parent_ids
36
 
        List of parent revision_ids
37
 
 
38
 
    properties
39
 
        Dictionary of revision properties.  These are attached to the
40
 
        revision as extra metadata.  The name must be a single 
41
 
        word; the value can be an arbitrary string.
 
53
    parents
 
54
        List of parent revisions, each is a RevisionReference.
42
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
43
63
    
44
 
    def __init__(self, revision_id, properties=None, **args):
45
 
        self.revision_id = revision_id
46
 
        self.properties = properties or {}
47
 
        self._check_properties()
48
 
        self.parent_ids = []
49
 
        self.parent_sha1s = []
 
64
    def __init__(self, **args):
50
65
        self.__dict__.update(args)
 
66
        self.parents = []
 
67
 
51
68
 
52
69
    def __repr__(self):
53
70
        return "<Revision id %s>" % self.revision_id
54
71
 
55
 
    def __eq__(self, other):
56
 
        if not isinstance(other, Revision):
57
 
            return False
58
 
        # FIXME: rbc 20050930 parent_ids are not being compared
59
 
        return (
60
 
                self.inventory_sha1 == other.inventory_sha1
61
 
                and self.revision_id == other.revision_id
62
 
                and self.timestamp == other.timestamp
63
 
                and self.message == other.message
64
 
                and self.timezone == other.timezone
65
 
                and self.committer == other.committer
66
 
                and self.properties == other.properties)
67
 
 
68
 
    def __ne__(self, other):
69
 
        return not self.__eq__(other)
70
 
 
71
 
    def _check_properties(self):
72
 
        """Verify that all revision properties are OK.
73
 
        """
74
 
        for name, value in self.properties.iteritems():
75
 
            if not isinstance(name, basestring) or contains_whitespace(name):
76
 
                raise ValueError("invalid property name %r" % name)
77
 
            if not isinstance(value, basestring):
78
 
                raise ValueError("invalid property value %r for %r" % 
79
 
                                 (name, value))
80
 
 
81
 
 
82
 
def is_ancestor(revision_id, candidate_id, branch):
 
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
 
 
159
REVISION_ID_RE = None
 
160
 
 
161
def validate_revision_id(rid):
 
162
    """Check rid is syntactically valid for a revision id."""
 
163
    global REVISION_ID_RE
 
164
    if not REVISION_ID_RE:
 
165
        import re
 
166
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
 
167
 
 
168
    if not REVISION_ID_RE.match(rid):
 
169
        raise ValueError("malformed revision-id %r" % rid)
 
170
 
 
171
def is_ancestor(revision_id, candidate_id, revision_source):
83
172
    """Return true if candidate_id is an ancestor of revision_id.
84
 
 
85
173
    A false negative will be returned if any intermediate descendent of
86
174
    candidate_id is not present in any of the revision_sources.
87
175
    
88
176
    revisions_source is an object supporting a get_revision operation that
89
177
    behaves like Branch's.
90
178
    """
91
 
    return candidate_id in branch.repository.get_ancestry(revision_id)
92
 
 
93
 
 
94
 
def iter_ancestors(revision_id, revision_source, only_present=False):
 
179
 
 
180
    from bzrlib.branch import NoSuchRevision
95
181
    ancestors = (revision_id,)
96
 
    distance = 0
97
182
    while len(ancestors) > 0:
98
183
        new_ancestors = []
99
184
        for ancestor in ancestors:
100
 
            if not only_present:
101
 
                yield ancestor, distance
 
185
            if ancestor == candidate_id:
 
186
                return True
102
187
            try:
103
188
                revision = revision_source.get_revision(ancestor)
104
 
            except bzrlib.errors.NoSuchRevision, e:
 
189
            except NoSuchRevision, e:
105
190
                if e.revision == revision_id:
106
 
                    raise 
 
191
                    raise e
107
192
                else:
108
193
                    continue
109
 
            if only_present:
110
 
                yield ancestor, distance
111
 
            new_ancestors.extend(revision.parent_ids)
 
194
            new_ancestors.extend([p.revision_id for p in revision.parents])
112
195
        ancestors = new_ancestors
113
 
        distance += 1
114
 
 
115
 
 
116
 
def find_present_ancestors(revision_id, revision_source):
117
 
    """Return the ancestors of a revision present in a branch.
118
 
 
119
 
    It's possible that a branch won't have the complete ancestry of
120
 
    one of its revisions.  
121
 
 
122
 
    """
123
 
    found_ancestors = {}
124
 
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
125
 
                         only_present=True))
126
 
    for anc_order, (anc_id, anc_distance) in anc_iter:
127
 
        if not found_ancestors.has_key(anc_id):
128
 
            found_ancestors[anc_id] = (anc_order, anc_distance)
129
 
    return found_ancestors
130
 
    
131
 
 
132
 
def __get_closest(intersection):
133
 
    intersection.sort()
134
 
    matches = [] 
135
 
    for entry in intersection:
136
 
        if entry[0] == intersection[0][0]:
137
 
            matches.append(entry[2])
138
 
    return matches
139
 
 
140
 
 
141
 
def old_common_ancestor(revision_a, revision_b, revision_source):
142
 
    """Find the ancestor common to both revisions that is closest to both.
143
 
    """
144
 
    from bzrlib.trace import mutter
145
 
    a_ancestors = find_present_ancestors(revision_a, revision_source)
146
 
    b_ancestors = find_present_ancestors(revision_b, revision_source)
147
 
    a_intersection = []
148
 
    b_intersection = []
149
 
    # a_order is used as a tie-breaker when two equally-good bases are found
150
 
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
151
 
        if b_ancestors.has_key(revision):
152
 
            a_intersection.append((a_distance, a_order, revision))
153
 
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
154
 
    mutter("a intersection: %r", a_intersection)
155
 
    mutter("b intersection: %r", b_intersection)
156
 
 
157
 
    a_closest = __get_closest(a_intersection)
158
 
    if len(a_closest) == 0:
159
 
        return None
160
 
    b_closest = __get_closest(b_intersection)
161
 
    assert len(b_closest) != 0
162
 
    mutter ("a_closest %r", a_closest)
163
 
    mutter ("b_closest %r", b_closest)
164
 
    if a_closest[0] in b_closest:
165
 
        return a_closest[0]
166
 
    elif b_closest[0] in a_closest:
167
 
        return b_closest[0]
168
 
    else:
169
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
170
 
    return a_closest[0]
171
 
 
172
 
def revision_graph(revision, revision_source):
173
 
    """Produce a graph of the ancestry of the specified revision.
174
 
    Return root, ancestors map, descendants map
175
 
 
176
 
    TODO: Produce graphs with the NULL revision as root, so that we can find
177
 
    a common even when trees are not branches don't represent a single line
178
 
    of descent.
179
 
    RBC: 20051024: note that when we have two partial histories, this may not
180
 
         be possible. But if we are willing to pretend :)... sure.
181
 
    """
182
 
    ancestors = {}
183
 
    descendants = {}
184
 
    lines = [revision]
185
 
    root = None
186
 
    descendants[revision] = {}
187
 
    while len(lines) > 0:
188
 
        new_lines = set()
189
 
        for line in lines:
190
 
            if line == NULL_REVISION:
191
 
                parents = []
192
 
                root = NULL_REVISION
193
 
            else:
194
 
                try:
195
 
                    rev = revision_source.get_revision(line)
196
 
                    parents = list(rev.parent_ids)
197
 
                    if len(parents) == 0:
198
 
                        parents = [NULL_REVISION]
199
 
                except bzrlib.errors.NoSuchRevision:
200
 
                    if line == revision:
201
 
                        raise
202
 
                    parents = None
203
 
            if parents is not None:
204
 
                for parent in parents:
205
 
                    if parent not in ancestors:
206
 
                        new_lines.add(parent)
207
 
                    if parent not in descendants:
208
 
                        descendants[parent] = {}
209
 
                    descendants[parent][line] = 1
210
 
            if parents is not None:
211
 
                ancestors[line] = set(parents)
212
 
        lines = new_lines
213
 
    if root is None:
214
 
        # The history for revision becomes inaccessible without
215
 
        # actually hitting a no-parents revision. This then
216
 
        # makes these asserts below trigger. So, if root is None
217
 
        # determine the actual root by walking the accessible tree
218
 
        # and then stash NULL_REVISION at the end.
219
 
        root = NULL_REVISION
220
 
        descendants[root] = {}
221
 
        # for every revision, check we can access at least
222
 
        # one parent, if we cant, add NULL_REVISION and
223
 
        # a link
224
 
        for rev in ancestors:
225
 
            if len(ancestors[rev]) == 0:
226
 
                raise RuntimeError('unreachable code ?!')
227
 
            ok = False
228
 
            for parent in ancestors[rev]:
229
 
                if parent in ancestors:
230
 
                    ok = True
231
 
            if ok:
232
 
                continue
233
 
            descendants[root][rev] = 1
234
 
            ancestors[rev].add(root)
235
 
        ancestors[root] = set()
236
 
    assert root not in descendants[root]
237
 
    assert root not in ancestors[root]
238
 
    return root, ancestors, descendants
239
 
 
240
 
 
241
 
def combined_graph(revision_a, revision_b, revision_source):
242
 
    """Produce a combined ancestry graph.
243
 
    Return graph root, ancestors map, descendants map, set of common nodes"""
244
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
245
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
246
 
                                                        revision_source)
247
 
    if root != root_b:
248
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
249
 
    common = set()
250
 
    for node, node_anc in ancestors_b.iteritems():
251
 
        if node in ancestors:
252
 
            common.add(node)
253
 
        else:
254
 
            ancestors[node] = set()
255
 
        ancestors[node].update(node_anc)
256
 
    for node, node_dec in descendants_b.iteritems():
257
 
        if node not in descendants:
258
 
            descendants[node] = {}
259
 
        descendants[node].update(node_dec)
260
 
    return root, ancestors, descendants, common
261
 
 
262
 
 
263
 
def common_ancestor(revision_a, revision_b, revision_source):
264
 
    try:
265
 
        root, ancestors, descendants, common = \
266
 
            combined_graph(revision_a, revision_b, revision_source)
267
 
    except bzrlib.errors.NoCommonRoot:
268
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
269
 
        
270
 
    distances = node_distances (descendants, ancestors, root)
271
 
    farthest = select_farthest(distances, common)
272
 
    if farthest is None or farthest == NULL_REVISION:
273
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
274
 
    return farthest
275
196
 
276
197
 
277
198
class MultipleRevisionSources(object):
278
 
    """Proxy that looks in multiple branches for revisions."""
279
199
    def __init__(self, *args):
280
200
        object.__init__(self)
281
201
        assert len(args) != 0
282
202
        self._revision_sources = args
283
203
 
284
204
    def get_revision(self, revision_id):
 
205
        from bzrlib.branch import NoSuchRevision
285
206
        for source in self._revision_sources:
286
207
            try:
287
208
                return source.get_revision(revision_id)
288
 
            except bzrlib.errors.NoSuchRevision, e:
 
209
            except NoSuchRevision, e:
289
210
                pass
290
211
        raise e
291
 
 
292
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
293
 
                              revision_history=None):
294
 
    """Find the longest line of descent from maybe_ancestor to revision.
295
 
    Revision history is followed where possible.
296
 
 
297
 
    If ancestor_id == rev_id, list will be empty.
298
 
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
299
 
    If ancestor_id is not an ancestor, NotAncestor will be thrown
300
 
    """
301
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
302
 
    if len(descendants) == 0:
303
 
        raise NoSuchRevision(rev_source, rev_id)
304
 
    if ancestor_id not in descendants:
305
 
        rev_source.get_revision(ancestor_id)
306
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
307
 
    root_descendants = all_descendants(descendants, ancestor_id)
308
 
    root_descendants.add(ancestor_id)
309
 
    if rev_id not in root_descendants:
310
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
311
 
    distances = node_distances(descendants, ancestors, ancestor_id,
312
 
                               root_descendants=root_descendants)
313
 
 
314
 
    def best_ancestor(rev_id):
315
 
        best = None
316
 
        for anc_id in ancestors[rev_id]:
317
 
            try:
318
 
                distance = distances[anc_id]
319
 
            except KeyError:
320
 
                continue
321
 
            if revision_history is not None and anc_id in revision_history:
322
 
                return anc_id
323
 
            elif best is None or distance > best[1]:
324
 
                best = (anc_id, distance)
325
 
        return best[0]
326
 
 
327
 
    next = rev_id
328
 
    path = []
329
 
    while next != ancestor_id:
330
 
        path.append(next)
331
 
        next = best_ancestor(next)
332
 
    path.reverse()
333
 
    return path