~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: John Arbash Meinel
  • Date: 2005-11-08 18:36:26 UTC
  • mto: This revision was merged to the branch mainline in revision 1727.
  • Revision ID: john@arbash-meinel.com-20051108183626-71f8414338043265
Updating unified_diff to take a factory, using the new diff algorithm in the code.

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
 
from bzrlib.graph import farthest_nodes, node_distances, all_descendants
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
 
197
176
    TODO: Produce graphs with the NULL revision as root, so that we can find
198
177
    a common even when trees are not branches don't represent a single line
199
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.
200
181
    """
201
182
    ancestors = {}
202
183
    descendants = {}
206
187
    while len(lines) > 0:
207
188
        new_lines = set()
208
189
        for line in lines:
209
 
            try:
210
 
                rev = revision_source.get_revision(line)
211
 
                parents = [p.revision_id for p in rev.parents]
212
 
                if len(parents) == 0:
213
 
                    root = line
214
 
            except bzrlib.errors.NoSuchRevision:
215
 
                if line == revision:
216
 
                    raise
217
 
                parents = None
 
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
218
203
            if parents is not None:
219
204
                for parent in parents:
220
205
                    if parent not in ancestors:
225
210
            if parents is not None:
226
211
                ancestors[line] = set(parents)
227
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()
228
236
    assert root not in descendants[root]
229
237
    assert root not in ancestors[root]
230
238
    return root, ancestors, descendants
231
239
 
 
240
 
232
241
def combined_graph(revision_a, revision_b, revision_source):
233
242
    """Produce a combined ancestry graph.
234
243
    Return graph root, ancestors map, descendants map, set of common nodes"""
246
255
        ancestors[node].update(node_anc)
247
256
    for node, node_dec in descendants_b.iteritems():
248
257
        if node not in descendants:
249
 
            descendants[node] = set()
 
258
            descendants[node] = {}
250
259
        descendants[node].update(node_dec)
251
260
    return root, ancestors, descendants, common
252
261
 
 
262
 
253
263
def common_ancestor(revision_a, revision_b, revision_source):
254
264
    try:
255
265
        root, ancestors, descendants, common = \
257
267
    except bzrlib.errors.NoCommonRoot:
258
268
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
259
269
        
260
 
    nodes = farthest_nodes(descendants, ancestors, root)
261
 
    for node in nodes:
262
 
        if node in common:
263
 
            return node
264
 
    raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
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
 
265
276
 
266
277
class MultipleRevisionSources(object):
267
278
    """Proxy that looks in multiple branches for revisions."""