~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

[merge] fix \t in commit messages

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.
17
19
 
18
20
import bzrlib.errors
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
 
 
 
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
22
from bzrlib.osutils import contains_whitespace
 
23
 
 
24
NULL_REVISION="null:"
44
25
 
45
26
class Revision(object):
46
27
    """Single revision on a branch.
51
32
 
52
33
    After bzr 0.0.5 revisions are allowed to have multiple parents.
53
34
 
54
 
    parents
55
 
        List of parent revisions, each is a RevisionReference.
 
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.
56
42
    """
57
 
    inventory_id = None
58
 
    inventory_sha1 = None
59
 
    revision_id = None
60
 
    timestamp = None
61
 
    message = None
62
 
    timezone = None
63
 
    committer = None
64
43
    
65
 
    def __init__(self, **args):
 
44
    def __init__(self, revision_id, properties=None, **args):
 
45
        self.revision_id = revision_id
 
46
        self.properties = properties or {}
 
47
        self._check_properties()
66
48
        self.__dict__.update(args)
67
 
        self.parents = []
68
 
 
 
49
        self.parent_ids = []
 
50
        self.parent_sha1s = []
69
51
 
70
52
    def __repr__(self):
71
53
        return "<Revision id %s>" % self.revision_id
73
55
    def __eq__(self, other):
74
56
        if not isinstance(other, Revision):
75
57
            return False
76
 
        return (self.inventory_id == other.inventory_id
77
 
                and self.inventory_sha1 == other.inventory_sha1
 
58
        # FIXME: rbc 20050930 parent_ids are not being compared
 
59
        return (
 
60
                self.inventory_sha1 == other.inventory_sha1
78
61
                and self.revision_id == other.revision_id
79
62
                and self.timestamp == other.timestamp
80
63
                and self.message == other.message
81
64
                and self.timezone == other.timezone
82
 
                and self.committer == other.committer)
 
65
                and self.committer == other.committer
 
66
                and self.properties == other.properties)
83
67
 
84
68
    def __ne__(self, other):
85
69
        return not self.__eq__(other)
86
70
 
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)
100
 
 
101
 
def is_ancestor(revision_id, candidate_id, revision_source):
 
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):
102
83
    """Return true if candidate_id is an ancestor of revision_id.
 
84
 
103
85
    A false negative will be returned if any intermediate descendent of
104
86
    candidate_id is not present in any of the revision_sources.
105
87
    
106
88
    revisions_source is an object supporting a get_revision operation that
107
89
    behaves like Branch's.
108
90
    """
 
91
    return candidate_id in branch.get_ancestry(revision_id)
109
92
 
110
 
    for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
 
        if ancestor_id == candidate_id:
112
 
            return True
113
 
    return False
114
93
 
115
94
def iter_ancestors(revision_id, revision_source, only_present=False):
116
95
    ancestors = (revision_id,)
129
108
                    continue
130
109
            if only_present:
131
110
                yield ancestor, distance
132
 
            new_ancestors.extend([p.revision_id for p in revision.parents])
 
111
            new_ancestors.extend(revision.parent_ids)
133
112
        ancestors = new_ancestors
134
113
        distance += 1
135
114
 
159
138
    return matches
160
139
 
161
140
 
162
 
def common_ancestor(revision_a, revision_b, revision_source):
 
141
def old_common_ancestor(revision_a, revision_b, revision_source):
163
142
    """Find the ancestor common to both revisions that is closest to both.
164
143
    """
165
144
    from bzrlib.trace import mutter
172
151
        if b_ancestors.has_key(revision):
173
152
            a_intersection.append((a_distance, a_order, revision))
174
153
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
175
 
    mutter("a intersection: %r" % a_intersection)
176
 
    mutter("b intersection: %r" % b_intersection)
 
154
    mutter("a intersection: %r", a_intersection)
 
155
    mutter("b intersection: %r", b_intersection)
177
156
 
178
157
    a_closest = __get_closest(a_intersection)
179
158
    if len(a_closest) == 0:
180
159
        return None
181
160
    b_closest = __get_closest(b_intersection)
182
161
    assert len(b_closest) != 0
183
 
    mutter ("a_closest %r" % a_closest)
184
 
    mutter ("b_closest %r" % b_closest)
 
162
    mutter ("a_closest %r", a_closest)
 
163
    mutter ("b_closest %r", b_closest)
185
164
    if a_closest[0] in b_closest:
186
165
        return a_closest[0]
187
166
    elif b_closest[0] in a_closest:
190
169
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
191
170
    return a_closest[0]
192
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
 
 
276
 
193
277
class MultipleRevisionSources(object):
194
278
    """Proxy that looks in multiple branches for revisions."""
195
279
    def __init__(self, *args):
214
298
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
215
299
    If ancestor_id is not an ancestor, NotAncestor will be thrown
216
300
    """
217
 
    [rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
218
 
    if ancestor_id == rev_id:
219
 
        return []
220
 
    def historical_lines(line):
221
 
        """Return a tuple of historical/non_historical lines, for sorting.
222
 
        The non_historical count is negative, since non_historical lines are
223
 
        a bad thing.
224
 
        """
225
 
        good_count = 0
226
 
        bad_count = 0
227
 
        for revision in line:
228
 
            if revision in revision_history:
229
 
                good_count += 1
230
 
            else:
231
 
                bad_count -= 1
232
 
        return good_count, bad_count
233
 
    active = [[rev_id]]
234
 
    successful_lines = []
235
 
    while len(active) > 0:
236
 
        new_active = []
237
 
        for line in active:
238
 
            parent_ids = [p.revision_id for p in 
239
 
                          rev_source.get_revision(line[-1]).parents]
240
 
            for parent in parent_ids:
241
 
                line_copy = line[:]
242
 
                if parent == ancestor_id:
243
 
                    successful_lines.append(line_copy)
244
 
                else:
245
 
                    line_copy.append(parent)
246
 
                    new_active.append(line_copy)
247
 
        active = new_active
248
 
    if len(successful_lines) == 0:
249
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
250
 
    for line in successful_lines:
251
 
        line.reverse()
252
 
    if revision_history is not None:
253
 
        by_historical_lines = []
254
 
        for line in successful_lines:
255
 
            count = historical_lines(line)
256
 
            by_historical_lines.append((count, line))
257
 
        by_historical_lines.sort()
258
 
        if by_historical_lines[-1][0][0] > 0:
259
 
            return by_historical_lines[-1][1]
260
 
    assert len(successful_lines)
261
 
    successful_lines.sort(cmp, len)
262
 
    return successful_lines[-1]
 
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