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.
 
 
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.
 
 
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
 
 
21
class RevisionReference(object):
 
 
23
    Reference to a stored revision.
 
 
25
    Includes the revision_id and revision_sha1.
 
 
29
    def __init__(self, revision_id, revision_sha1=None):
 
 
30
        if revision_id == None \
 
 
31
           or isinstance(revision_id, basestring):
 
 
32
            self.revision_id = revision_id
 
 
34
            raise ValueError('bad revision_id %r' % revision_id)
 
 
36
        if revision_sha1 != None:
 
 
37
            if isinstance(revision_sha1, basestring) \
 
 
38
               and len(revision_sha1) == 40:
 
 
39
                self.revision_sha1 = revision_sha1
 
 
41
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
 
 
45
class Revision(object):
 
 
46
    """Single revision on a branch.
 
 
48
    Revisions may know their revision_hash, but only once they've been
 
 
49
    written out.  This is not stored because you cannot write the hash
 
 
50
    into the file it describes.
 
 
52
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
 
55
        List of parent revisions, each is a RevisionReference.
 
 
65
    def __init__(self, **args):
 
 
66
        self.__dict__.update(args)
 
 
71
        return "<Revision id %s>" % self.revision_id
 
 
73
    def __eq__(self, other):
 
 
74
        if not isinstance(other, Revision):
 
 
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)
 
 
84
    def __ne__(self, other):
 
 
85
        return not self.__eq__(other)
 
 
91
def validate_revision_id(rid):
 
 
92
    """Check rid is syntactically valid for a revision id."""
 
 
94
    if not REVISION_ID_RE:
 
 
96
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
 
 
98
    if not REVISION_ID_RE.match(rid):
 
 
99
        raise ValueError("malformed revision-id %r" % rid)
 
 
102
def is_ancestor(revision_id, candidate_id, branch):
 
 
103
    """Return true if candidate_id is an ancestor of revision_id.
 
 
105
    A false negative will be returned if any intermediate descendent of
 
 
106
    candidate_id is not present in any of the revision_sources.
 
 
108
    revisions_source is an object supporting a get_revision operation that
 
 
109
    behaves like Branch's.
 
 
111
    return candidate_id in branch.get_ancestry(revision_id)
 
 
114
def iter_ancestors(revision_id, revision_source, only_present=False):
 
 
115
    ancestors = (revision_id,)
 
 
117
    while len(ancestors) > 0:
 
 
119
        for ancestor in ancestors:
 
 
121
                yield ancestor, distance
 
 
123
                revision = revision_source.get_revision(ancestor)
 
 
124
            except bzrlib.errors.NoSuchRevision, e:
 
 
125
                if e.revision == revision_id:
 
 
130
                yield ancestor, distance
 
 
131
            new_ancestors.extend([p.revision_id for p in revision.parents])
 
 
132
        ancestors = new_ancestors
 
 
136
def find_present_ancestors(revision_id, revision_source):
 
 
137
    """Return the ancestors of a revision present in a branch.
 
 
139
    It's possible that a branch won't have the complete ancestry of
 
 
140
    one of its revisions.  
 
 
144
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
 
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
 
 
152
def __get_closest(intersection):
 
 
155
    for entry in intersection:
 
 
156
        if entry[0] == intersection[0][0]:
 
 
157
            matches.append(entry[2])
 
 
161
def common_ancestor(revision_a, revision_b, revision_source):
 
 
162
    """Find the ancestor common to both revisions that is closest to both.
 
 
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)
 
 
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)
 
 
177
    a_closest = __get_closest(a_intersection)
 
 
178
    if len(a_closest) == 0:
 
 
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:
 
 
186
    elif b_closest[0] in a_closest:
 
 
189
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
 
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
 
 
199
    def get_revision(self, revision_id):
 
 
200
        for source in self._revision_sources:
 
 
202
                return source.get_revision(revision_id)
 
 
203
            except bzrlib.errors.NoSuchRevision, e:
 
 
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.
 
 
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
 
 
216
    [rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
 
 
217
    if ancestor_id == rev_id:
 
 
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
 
 
226
        for revision in line:
 
 
227
            if revision in revision_history:
 
 
231
        return good_count, bad_count
 
 
233
    successful_lines = []
 
 
234
    while len(active) > 0:
 
 
237
            parent_ids = [p.revision_id for p in 
 
 
238
                          rev_source.get_revision(line[-1]).parents]
 
 
239
            for parent in parent_ids:
 
 
241
                if parent == ancestor_id:
 
 
242
                    successful_lines.append(line_copy)
 
 
244
                    line_copy.append(parent)
 
 
245
                    new_active.append(line_copy)
 
 
247
    if len(successful_lines) == 0:
 
 
248
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
 
249
    for line in successful_lines:
 
 
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]