/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Robert Collins
  • Date: 2005-10-10 01:32:08 UTC
  • Revision ID: robertc@robertcollins.net-20051010013208-163c23746972763a
branch: namespace

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# (C) 2005 Canonical
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import bzrlib.errors
 
19
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
20
 
 
21
NULL_REVISION="null:"
 
22
 
 
23
class Revision(object):
 
24
    """Single revision on a branch.
 
25
 
 
26
    Revisions may know their revision_hash, but only once they've been
 
27
    written out.  This is not stored because you cannot write the hash
 
28
    into the file it describes.
 
29
 
 
30
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
31
 
 
32
    parent_ids
 
33
        List of parent revision_ids
 
34
    """
 
35
    
 
36
    def __init__(self, revision_id, **args):
 
37
        self.revision_id = revision_id
 
38
        self.__dict__.update(args)
 
39
        self.parent_ids = []
 
40
        self.parent_sha1s = []
 
41
 
 
42
    def __repr__(self):
 
43
        return "<Revision id %s>" % self.revision_id
 
44
 
 
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
        
 
61
REVISION_ID_RE = None
 
62
 
 
63
def validate_revision_id(rid):
 
64
    """Check rid is syntactically valid for a revision id."""
 
65
    global REVISION_ID_RE
 
66
    if not REVISION_ID_RE:
 
67
        import re
 
68
        REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
 
69
 
 
70
    if not REVISION_ID_RE.match(rid):
 
71
        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