~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

MergeĀ fromĀ jam-storage.

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
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
22
from bzrlib.osutils import contains_whitespace
20
23
 
21
24
NULL_REVISION="null:"
22
25
 
23
 
class RevisionReference(object):
24
 
    """
25
 
    Reference to a stored revision.
26
 
 
27
 
    Includes the revision_id and revision_sha1.
28
 
    """
29
 
    revision_id = None
30
 
    revision_sha1 = None
31
 
    def __init__(self, revision_id, revision_sha1=None):
32
 
        if revision_id == None \
33
 
           or isinstance(revision_id, basestring):
34
 
            self.revision_id = revision_id
35
 
        else:
36
 
            raise ValueError('bad revision_id %r' % revision_id)
37
 
 
38
 
        if revision_sha1 != None:
39
 
            if isinstance(revision_sha1, basestring) \
40
 
               and len(revision_sha1) == 40:
41
 
                self.revision_sha1 = revision_sha1
42
 
            else:
43
 
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
44
 
                
45
 
 
46
 
 
47
26
class Revision(object):
48
27
    """Single revision on a branch.
49
28
 
53
32
 
54
33
    After bzr 0.0.5 revisions are allowed to have multiple parents.
55
34
 
56
 
    parents
57
 
        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.
58
42
    """
59
 
    inventory_id = None
60
 
    inventory_sha1 = None
61
 
    revision_id = None
62
 
    timestamp = None
63
 
    message = None
64
 
    timezone = None
65
 
    committer = None
66
43
    
67
 
    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()
 
48
        self.parent_ids = []
 
49
        self.parent_sha1s = []
68
50
        self.__dict__.update(args)
69
 
        self.parents = []
70
 
 
71
51
 
72
52
    def __repr__(self):
73
53
        return "<Revision id %s>" % self.revision_id
75
55
    def __eq__(self, other):
76
56
        if not isinstance(other, Revision):
77
57
            return False
78
 
        return (self.inventory_id == other.inventory_id
79
 
                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
80
61
                and self.revision_id == other.revision_id
81
62
                and self.timestamp == other.timestamp
82
63
                and self.message == other.message
83
64
                and self.timezone == other.timezone
84
 
                and self.committer == other.committer)
 
65
                and self.committer == other.committer
 
66
                and self.properties == other.properties)
85
67
 
86
68
    def __ne__(self, other):
87
69
        return not self.__eq__(other)
88
70
 
89
 
        
90
 
 
91
 
REVISION_ID_RE = None
92
 
 
93
 
def validate_revision_id(rid):
94
 
    """Check rid is syntactically valid for a revision id."""
95
 
    global REVISION_ID_RE
96
 
    if not REVISION_ID_RE:
97
 
        import re
98
 
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
99
 
 
100
 
    if not REVISION_ID_RE.match(rid):
101
 
        raise ValueError("malformed revision-id %r" % rid)
102
 
 
103
 
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):
104
83
    """Return true if candidate_id is an ancestor of revision_id.
 
84
 
105
85
    A false negative will be returned if any intermediate descendent of
106
86
    candidate_id is not present in any of the revision_sources.
107
87
    
108
88
    revisions_source is an object supporting a get_revision operation that
109
89
    behaves like Branch's.
110
90
    """
111
 
    if candidate_id is None:
112
 
        return True
113
 
    for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
114
 
        if ancestor_id == candidate_id:
115
 
            return True
116
 
    return False
 
91
    return candidate_id in branch.repository.get_ancestry(revision_id)
 
92
 
117
93
 
118
94
def iter_ancestors(revision_id, revision_source, only_present=False):
119
95
    ancestors = (revision_id,)
132
108
                    continue
133
109
            if only_present:
134
110
                yield ancestor, distance
135
 
            new_ancestors.extend([p.revision_id for p in revision.parents])
 
111
            new_ancestors.extend(revision.parent_ids)
136
112
        ancestors = new_ancestors
137
113
        distance += 1
138
114
 
175
151
        if b_ancestors.has_key(revision):
176
152
            a_intersection.append((a_distance, a_order, revision))
177
153
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
178
 
    mutter("a intersection: %r" % a_intersection)
179
 
    mutter("b intersection: %r" % b_intersection)
 
154
    mutter("a intersection: %r", a_intersection)
 
155
    mutter("b intersection: %r", b_intersection)
180
156
 
181
157
    a_closest = __get_closest(a_intersection)
182
158
    if len(a_closest) == 0:
183
159
        return None
184
160
    b_closest = __get_closest(b_intersection)
185
161
    assert len(b_closest) != 0
186
 
    mutter ("a_closest %r" % a_closest)
187
 
    mutter ("b_closest %r" % b_closest)
 
162
    mutter ("a_closest %r", a_closest)
 
163
    mutter ("b_closest %r", b_closest)
188
164
    if a_closest[0] in b_closest:
189
165
        return a_closest[0]
190
166
    elif b_closest[0] in a_closest:
200
176
    TODO: Produce graphs with the NULL revision as root, so that we can find
201
177
    a common even when trees are not branches don't represent a single line
202
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.
203
181
    """
204
182
    ancestors = {}
205
183
    descendants = {}
215
193
            else:
216
194
                try:
217
195
                    rev = revision_source.get_revision(line)
218
 
                    parents = [p.revision_id for p in rev.parents]
 
196
                    parents = list(rev.parent_ids)
219
197
                    if len(parents) == 0:
220
198
                        parents = [NULL_REVISION]
221
199
                except bzrlib.errors.NoSuchRevision:
232
210
            if parents is not None:
233
211
                ancestors[line] = set(parents)
234
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()
235
236
    assert root not in descendants[root]
236
237
    assert root not in ancestors[root]
237
238
    return root, ancestors, descendants
238
239
 
 
240
 
239
241
def combined_graph(revision_a, revision_b, revision_source):
240
242
    """Produce a combined ancestry graph.
241
243
    Return graph root, ancestors map, descendants map, set of common nodes"""
257
259
        descendants[node].update(node_dec)
258
260
    return root, ancestors, descendants, common
259
261
 
 
262
 
260
263
def common_ancestor(revision_a, revision_b, revision_source):
261
264
    try:
262
265
        root, ancestors, descendants, common = \
270
273
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
271
274
    return farthest
272
275
 
 
276
 
273
277
class MultipleRevisionSources(object):
274
278
    """Proxy that looks in multiple branches for revisions."""
275
279
    def __init__(self, *args):