~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2005-09-16 09:56:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050916095623-ca0dff452934f21f
- make progress bar more tolerant of out-of-range values

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
17
 
20
18
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:"
 
19
 
 
20
 
 
21
class RevisionReference(object):
 
22
    """
 
23
    Reference to a stored revision.
 
24
 
 
25
    Includes the revision_id and revision_sha1.
 
26
    """
 
27
    revision_id = None
 
28
    revision_sha1 = None
 
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
 
33
        else:
 
34
            raise ValueError('bad revision_id %r' % revision_id)
 
35
 
 
36
        if revision_sha1 != None:
 
37
            if isinstance(revision_sha1, basestring) \
 
38
               and len(revision_sha1) == 40:
 
39
                self.revision_sha1 = revision_sha1
 
40
            else:
 
41
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
 
42
                
 
43
 
25
44
 
26
45
class Revision(object):
27
46
    """Single revision on a branch.
32
51
 
33
52
    After bzr 0.0.5 revisions are allowed to have multiple parents.
34
53
 
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.
 
54
    parents
 
55
        List of parent revisions, each is a RevisionReference.
42
56
    """
 
57
    inventory_id = None
 
58
    inventory_sha1 = None
 
59
    revision_id = None
 
60
    timestamp = None
 
61
    message = None
 
62
    timezone = None
 
63
    committer = None
43
64
    
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 = []
 
65
    def __init__(self, **args):
50
66
        self.__dict__.update(args)
 
67
        self.parents = []
 
68
 
51
69
 
52
70
    def __repr__(self):
53
71
        return "<Revision id %s>" % self.revision_id
55
73
    def __eq__(self, other):
56
74
        if not isinstance(other, Revision):
57
75
            return False
58
 
        # FIXME: rbc 20050930 parent_ids are not being compared
59
 
        return (
60
 
                self.inventory_sha1 == other.inventory_sha1
 
76
        return (self.inventory_id == other.inventory_id
 
77
                and self.inventory_sha1 == other.inventory_sha1
61
78
                and self.revision_id == other.revision_id
62
79
                and self.timestamp == other.timestamp
63
80
                and self.message == other.message
64
81
                and self.timezone == other.timezone
65
 
                and self.committer == other.committer
66
 
                and self.properties == other.properties)
 
82
                and self.committer == other.committer)
67
83
 
68
84
    def __ne__(self, other):
69
85
        return not self.__eq__(other)
70
86
 
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
 
    def get_history(self, repository):
82
 
        """Return the canonical line-of-history for this revision.
83
 
 
84
 
        If ghosts are present this may differ in result from a ghost-free
85
 
        repository.
86
 
        """
87
 
        current_revision = self
88
 
        reversed_result = []
89
 
        while current_revision is not None:
90
 
            reversed_result.append(current_revision.revision_id)
91
 
            if not len (current_revision.parent_ids):
92
 
                reversed_result.append(None)
93
 
                current_revision = None
94
 
            else:
95
 
                next_revision_id = current_revision.parent_ids[0]
96
 
                current_revision = repository.get_revision(next_revision_id)
97
 
        reversed_result.reverse()
98
 
        return reversed_result
 
87
        
 
88
 
 
89
REVISION_ID_RE = None
 
90
 
 
91
def validate_revision_id(rid):
 
92
    """Check rid is syntactically valid for a revision id."""
 
93
    global REVISION_ID_RE
 
94
    if not REVISION_ID_RE:
 
95
        import re
 
96
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
 
97
 
 
98
    if not REVISION_ID_RE.match(rid):
 
99
        raise ValueError("malformed revision-id %r" % rid)
99
100
 
100
101
 
101
102
def is_ancestor(revision_id, candidate_id, branch):
107
108
    revisions_source is an object supporting a get_revision operation that
108
109
    behaves like Branch's.
109
110
    """
110
 
    return candidate_id in branch.repository.get_ancestry(revision_id)
 
111
    return candidate_id in branch.get_ancestry(revision_id)
111
112
 
112
113
 
113
114
def iter_ancestors(revision_id, revision_source, only_present=False):
127
128
                    continue
128
129
            if only_present:
129
130
                yield ancestor, distance
130
 
            new_ancestors.extend(revision.parent_ids)
 
131
            new_ancestors.extend([p.revision_id for p in revision.parents])
131
132
        ancestors = new_ancestors
132
133
        distance += 1
133
134
 
157
158
    return matches
158
159
 
159
160
 
160
 
def old_common_ancestor(revision_a, revision_b, revision_source):
 
161
def common_ancestor(revision_a, revision_b, revision_source):
161
162
    """Find the ancestor common to both revisions that is closest to both.
162
163
    """
163
164
    from bzrlib.trace import mutter
170
171
        if b_ancestors.has_key(revision):
171
172
            a_intersection.append((a_distance, a_order, revision))
172
173
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
173
 
    mutter("a intersection: %r", a_intersection)
174
 
    mutter("b intersection: %r", b_intersection)
 
174
    mutter("a intersection: %r" % a_intersection)
 
175
    mutter("b intersection: %r" % b_intersection)
175
176
 
176
177
    a_closest = __get_closest(a_intersection)
177
178
    if len(a_closest) == 0:
178
179
        return None
179
180
    b_closest = __get_closest(b_intersection)
180
181
    assert len(b_closest) != 0
181
 
    mutter ("a_closest %r", a_closest)
182
 
    mutter ("b_closest %r", b_closest)
 
182
    mutter ("a_closest %r" % a_closest)
 
183
    mutter ("b_closest %r" % b_closest)
183
184
    if a_closest[0] in b_closest:
184
185
        return a_closest[0]
185
186
    elif b_closest[0] in a_closest:
188
189
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
189
190
    return a_closest[0]
190
191
 
191
 
def revision_graph(revision, revision_source):
192
 
    """Produce a graph of the ancestry of the specified revision.
193
 
    Return root, ancestors map, descendants map
194
 
 
195
 
    TODO: Produce graphs with the NULL revision as root, so that we can find
196
 
    a common even when trees are not branches don't represent a single line
197
 
    of descent.
198
 
    RBC: 20051024: note that when we have two partial histories, this may not
199
 
         be possible. But if we are willing to pretend :)... sure.
200
 
    """
201
 
    ancestors = {}
202
 
    descendants = {}
203
 
    lines = [revision]
204
 
    root = None
205
 
    descendants[revision] = {}
206
 
    while len(lines) > 0:
207
 
        new_lines = set()
208
 
        for line in lines:
209
 
            if line == NULL_REVISION:
210
 
                parents = []
211
 
                root = NULL_REVISION
212
 
            else:
213
 
                try:
214
 
                    rev = revision_source.get_revision(line)
215
 
                    parents = list(rev.parent_ids)
216
 
                    if len(parents) == 0:
217
 
                        parents = [NULL_REVISION]
218
 
                except bzrlib.errors.NoSuchRevision:
219
 
                    if line == revision:
220
 
                        raise
221
 
                    parents = None
222
 
            if parents is not None:
223
 
                for parent in parents:
224
 
                    if parent not in ancestors:
225
 
                        new_lines.add(parent)
226
 
                    if parent not in descendants:
227
 
                        descendants[parent] = {}
228
 
                    descendants[parent][line] = 1
229
 
            if parents is not None:
230
 
                ancestors[line] = set(parents)
231
 
        lines = new_lines
232
 
    if root is None:
233
 
        # The history for revision becomes inaccessible without
234
 
        # actually hitting a no-parents revision. This then
235
 
        # makes these asserts below trigger. So, if root is None
236
 
        # determine the actual root by walking the accessible tree
237
 
        # and then stash NULL_REVISION at the end.
238
 
        root = NULL_REVISION
239
 
        descendants[root] = {}
240
 
        # for every revision, check we can access at least
241
 
        # one parent, if we cant, add NULL_REVISION and
242
 
        # a link
243
 
        for rev in ancestors:
244
 
            if len(ancestors[rev]) == 0:
245
 
                raise RuntimeError('unreachable code ?!')
246
 
            ok = False
247
 
            for parent in ancestors[rev]:
248
 
                if parent in ancestors:
249
 
                    ok = True
250
 
            if ok:
251
 
                continue
252
 
            descendants[root][rev] = 1
253
 
            ancestors[rev].add(root)
254
 
        ancestors[root] = set()
255
 
    assert root not in descendants[root]
256
 
    assert root not in ancestors[root]
257
 
    return root, ancestors, descendants
258
 
 
259
 
 
260
 
def combined_graph(revision_a, revision_b, revision_source):
261
 
    """Produce a combined ancestry graph.
262
 
    Return graph root, ancestors map, descendants map, set of common nodes"""
263
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
264
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
265
 
                                                        revision_source)
266
 
    if root != root_b:
267
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
268
 
    common = set()
269
 
    for node, node_anc in ancestors_b.iteritems():
270
 
        if node in ancestors:
271
 
            common.add(node)
272
 
        else:
273
 
            ancestors[node] = set()
274
 
        ancestors[node].update(node_anc)
275
 
    for node, node_dec in descendants_b.iteritems():
276
 
        if node not in descendants:
277
 
            descendants[node] = {}
278
 
        descendants[node].update(node_dec)
279
 
    return root, ancestors, descendants, common
280
 
 
281
 
 
282
 
def common_ancestor(revision_a, revision_b, revision_source):
283
 
    try:
284
 
        root, ancestors, descendants, common = \
285
 
            combined_graph(revision_a, revision_b, revision_source)
286
 
    except bzrlib.errors.NoCommonRoot:
287
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
288
 
        
289
 
    distances = node_distances (descendants, ancestors, root)
290
 
    farthest = select_farthest(distances, common)
291
 
    if farthest is None or farthest == NULL_REVISION:
292
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
293
 
    return farthest
294
 
 
295
 
 
296
192
class MultipleRevisionSources(object):
297
193
    """Proxy that looks in multiple branches for revisions."""
298
194
    def __init__(self, *args):
317
213
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
318
214
    If ancestor_id is not an ancestor, NotAncestor will be thrown
319
215
    """
320
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
321
 
    if len(descendants) == 0:
322
 
        raise NoSuchRevision(rev_source, rev_id)
323
 
    if ancestor_id not in descendants:
324
 
        rev_source.get_revision(ancestor_id)
325
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
326
 
    root_descendants = all_descendants(descendants, ancestor_id)
327
 
    root_descendants.add(ancestor_id)
328
 
    if rev_id not in root_descendants:
329
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
330
 
    distances = node_distances(descendants, ancestors, ancestor_id,
331
 
                               root_descendants=root_descendants)
332
 
 
333
 
    def best_ancestor(rev_id):
334
 
        best = None
335
 
        for anc_id in ancestors[rev_id]:
336
 
            try:
337
 
                distance = distances[anc_id]
338
 
            except KeyError:
339
 
                continue
340
 
            if revision_history is not None and anc_id in revision_history:
341
 
                return anc_id
342
 
            elif best is None or distance > best[1]:
343
 
                best = (anc_id, distance)
344
 
        return best[0]
345
 
 
346
 
    next = rev_id
347
 
    path = []
348
 
    while next != ancestor_id:
349
 
        path.append(next)
350
 
        next = best_ancestor(next)
351
 
    path.reverse()
352
 
    return path
 
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]