/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-02 21:51:29 UTC
  • mfrom: (1396)
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20051002215128-5686c7d24bf9bdb9
merge from martins newformat branch - brings in transport abstraction

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, **args):
 
37
        self.__dict__.update(args)
 
38
        self.parent_ids = []
 
39
        self.parent_sha1s = []
 
40
 
 
41
    def __repr__(self):
 
42
        return "<Revision id %s>" % self.revision_id
 
43
 
 
44
    def __eq__(self, other):
 
45
        if not isinstance(other, Revision):
 
46
            return False
 
47
        # FIXME: rbc 20050930 parent_ids are not being compared
 
48
        return (
 
49
                self.inventory_sha1 == other.inventory_sha1
 
50
                and self.revision_id == other.revision_id
 
51
                and self.timestamp == other.timestamp
 
52
                and self.message == other.message
 
53
                and self.timezone == other.timezone
 
54
                and self.committer == other.committer)
 
55
 
 
56
    def __ne__(self, other):
 
57
        return not self.__eq__(other)
 
58
 
 
59
        
 
60
REVISION_ID_RE = None
 
61
 
 
62
def validate_revision_id(rid):
 
63
    """Check rid is syntactically valid for a revision id."""
 
64
    global REVISION_ID_RE
 
65
    if not REVISION_ID_RE:
 
66
        import re
 
67
        REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
 
68
 
 
69
    if not REVISION_ID_RE.match(rid):
 
70
        raise ValueError("malformed revision-id %r" % rid)
 
71
 
 
72
 
 
73
def is_ancestor(revision_id, candidate_id, branch):
 
74
    """Return true if candidate_id is an ancestor of revision_id.
 
75
 
 
76
    A false negative will be returned if any intermediate descendent of
 
77
    candidate_id is not present in any of the revision_sources.
 
78
    
 
79
    revisions_source is an object supporting a get_revision operation that
 
80
    behaves like Branch's.
 
81
    """
 
82
    return candidate_id in branch.get_ancestry(revision_id)
 
83
 
 
84
 
 
85
def iter_ancestors(revision_id, revision_source, only_present=False):
 
86
    ancestors = (revision_id,)
 
87
    distance = 0
 
88
    while len(ancestors) > 0:
 
89
        new_ancestors = []
 
90
        for ancestor in ancestors:
 
91
            if not only_present:
 
92
                yield ancestor, distance
 
93
            try:
 
94
                revision = revision_source.get_revision(ancestor)
 
95
            except bzrlib.errors.NoSuchRevision, e:
 
96
                if e.revision == revision_id:
 
97
                    raise 
 
98
                else:
 
99
                    continue
 
100
            if only_present:
 
101
                yield ancestor, distance
 
102
            new_ancestors.extend(revision.parent_ids)
 
103
        ancestors = new_ancestors
 
104
        distance += 1
 
105
 
 
106
 
 
107
def find_present_ancestors(revision_id, revision_source):
 
108
    """Return the ancestors of a revision present in a branch.
 
109
 
 
110
    It's possible that a branch won't have the complete ancestry of
 
111
    one of its revisions.  
 
112
 
 
113
    """
 
114
    found_ancestors = {}
 
115
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
116
                         only_present=True))
 
117
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
118
        if not found_ancestors.has_key(anc_id):
 
119
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
120
    return found_ancestors
 
121
    
 
122
 
 
123
def __get_closest(intersection):
 
124
    intersection.sort()
 
125
    matches = [] 
 
126
    for entry in intersection:
 
127
        if entry[0] == intersection[0][0]:
 
128
            matches.append(entry[2])
 
129
    return matches
 
130
 
 
131
 
 
132
def old_common_ancestor(revision_a, revision_b, revision_source):
 
133
    """Find the ancestor common to both revisions that is closest to both.
 
134
    """
 
135
    from bzrlib.trace import mutter
 
136
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
137
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
138
    a_intersection = []
 
139
    b_intersection = []
 
140
    # a_order is used as a tie-breaker when two equally-good bases are found
 
141
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
142
        if b_ancestors.has_key(revision):
 
143
            a_intersection.append((a_distance, a_order, revision))
 
144
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
145
    mutter("a intersection: %r" % a_intersection)
 
146
    mutter("b intersection: %r" % b_intersection)
 
147
 
 
148
    a_closest = __get_closest(a_intersection)
 
149
    if len(a_closest) == 0:
 
150
        return None
 
151
    b_closest = __get_closest(b_intersection)
 
152
    assert len(b_closest) != 0
 
153
    mutter ("a_closest %r" % a_closest)
 
154
    mutter ("b_closest %r" % b_closest)
 
155
    if a_closest[0] in b_closest:
 
156
        return a_closest[0]
 
157
    elif b_closest[0] in a_closest:
 
158
        return b_closest[0]
 
159
    else:
 
160
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
161
    return a_closest[0]
 
162
 
 
163
def revision_graph(revision, revision_source):
 
164
    """Produce a graph of the ancestry of the specified revision.
 
165
    Return root, ancestors map, descendants map
 
166
 
 
167
    TODO: Produce graphs with the NULL revision as root, so that we can find
 
168
    a common even when trees are not branches don't represent a single line
 
169
    of descent.
 
170
    """
 
171
    ancestors = {}
 
172
    descendants = {}
 
173
    lines = [revision]
 
174
    root = None
 
175
    descendants[revision] = {}
 
176
    while len(lines) > 0:
 
177
        new_lines = set()
 
178
        for line in lines:
 
179
            if line == NULL_REVISION:
 
180
                parents = []
 
181
                root = NULL_REVISION
 
182
            else:
 
183
                try:
 
184
                    rev = revision_source.get_revision(line)
 
185
                    parents = list(rev.parent_ids)
 
186
                    if len(parents) == 0:
 
187
                        parents = [NULL_REVISION]
 
188
                except bzrlib.errors.NoSuchRevision:
 
189
                    if line == revision:
 
190
                        raise
 
191
                    parents = None
 
192
            if parents is not None:
 
193
                for parent in parents:
 
194
                    if parent not in ancestors:
 
195
                        new_lines.add(parent)
 
196
                    if parent not in descendants:
 
197
                        descendants[parent] = {}
 
198
                    descendants[parent][line] = 1
 
199
            if parents is not None:
 
200
                ancestors[line] = set(parents)
 
201
        lines = new_lines
 
202
    assert root not in descendants[root]
 
203
    assert root not in ancestors[root]
 
204
    return root, ancestors, descendants
 
205
 
 
206
 
 
207
def combined_graph(revision_a, revision_b, revision_source):
 
208
    """Produce a combined ancestry graph.
 
209
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
210
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
211
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
212
                                                        revision_source)
 
213
    if root != root_b:
 
214
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
215
    common = set()
 
216
    for node, node_anc in ancestors_b.iteritems():
 
217
        if node in ancestors:
 
218
            common.add(node)
 
219
        else:
 
220
            ancestors[node] = set()
 
221
        ancestors[node].update(node_anc)
 
222
    for node, node_dec in descendants_b.iteritems():
 
223
        if node not in descendants:
 
224
            descendants[node] = {}
 
225
        descendants[node].update(node_dec)
 
226
    return root, ancestors, descendants, common
 
227
 
 
228
 
 
229
def common_ancestor(revision_a, revision_b, revision_source):
 
230
    try:
 
231
        root, ancestors, descendants, common = \
 
232
            combined_graph(revision_a, revision_b, revision_source)
 
233
    except bzrlib.errors.NoCommonRoot:
 
234
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
235
        
 
236
    distances = node_distances (descendants, ancestors, root)
 
237
    farthest = select_farthest(distances, common)
 
238
    if farthest is None or farthest == NULL_REVISION:
 
239
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
240
    return farthest
 
241
 
 
242
 
 
243
class MultipleRevisionSources(object):
 
244
    """Proxy that looks in multiple branches for revisions."""
 
245
    def __init__(self, *args):
 
246
        object.__init__(self)
 
247
        assert len(args) != 0
 
248
        self._revision_sources = args
 
249
 
 
250
    def get_revision(self, revision_id):
 
251
        for source in self._revision_sources:
 
252
            try:
 
253
                return source.get_revision(revision_id)
 
254
            except bzrlib.errors.NoSuchRevision, e:
 
255
                pass
 
256
        raise e
 
257
 
 
258
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
259
                              revision_history=None):
 
260
    """Find the longest line of descent from maybe_ancestor to revision.
 
261
    Revision history is followed where possible.
 
262
 
 
263
    If ancestor_id == rev_id, list will be empty.
 
264
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
265
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
266
    """
 
267
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
268
    if len(descendants) == 0:
 
269
        raise NoSuchRevision(rev_source, rev_id)
 
270
    if ancestor_id not in descendants:
 
271
        rev_source.get_revision(ancestor_id)
 
272
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
273
    root_descendants = all_descendants(descendants, ancestor_id)
 
274
    root_descendants.add(ancestor_id)
 
275
    if rev_id not in root_descendants:
 
276
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
277
    distances = node_distances(descendants, ancestors, ancestor_id,
 
278
                               root_descendants=root_descendants)
 
279
 
 
280
    def best_ancestor(rev_id):
 
281
        best = None
 
282
        for anc_id in ancestors[rev_id]:
 
283
            try:
 
284
                distance = distances[anc_id]
 
285
            except KeyError:
 
286
                continue
 
287
            if revision_history is not None and anc_id in revision_history:
 
288
                return anc_id
 
289
            elif best is None or distance > best[1]:
 
290
                best = (anc_id, distance)
 
291
        return best[0]
 
292
 
 
293
    next = rev_id
 
294
    path = []
 
295
    while next != ancestor_id:
 
296
        path.append(next)
 
297
        next = best_ancestor(next)
 
298
    path.reverse()
 
299
    return path