← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

Update news and readme

- better explanation of dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
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:
 
17
# TODO: Some kind of command-line display of revision properties: 
18
18
# perhaps show them in log -v and allow them as options to the commit command.
19
19
 
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import deprecated_graph
24
 
from bzrlib import bugtracker
25
 
""")
26
 
from bzrlib import (
27
 
    errors,
28
 
    symbol_versioning,
29
 
    )
 
20
import bzrlib.errors
 
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
30
22
from bzrlib.osutils import contains_whitespace
31
23
 
32
24
NULL_REVISION="null:"
33
 
CURRENT_REVISION="current:"
34
 
 
35
25
 
36
26
class Revision(object):
37
27
    """Single revision on a branch.
47
37
 
48
38
    properties
49
39
        Dictionary of revision properties.  These are attached to the
50
 
        revision as extra metadata.  The name must be a single
 
40
        revision as extra metadata.  The name must be a single 
51
41
        word; the value can be an arbitrary string.
52
42
    """
53
 
 
 
43
    
54
44
    def __init__(self, revision_id, properties=None, **args):
55
45
        self.revision_id = revision_id
56
 
        if properties is None:
57
 
            self.properties = {}
58
 
        else:
59
 
            self.properties = properties
60
 
            self._check_properties()
61
 
        self.committer = None
 
46
        self.properties = properties or {}
 
47
        self._check_properties()
 
48
        self.__dict__.update(args)
62
49
        self.parent_ids = []
63
50
        self.parent_sha1s = []
64
 
        """Not used anymore - legacy from for 4."""
65
 
        self.__dict__.update(args)
66
51
 
67
52
    def __repr__(self):
68
53
        return "<Revision id %s>" % self.revision_id
70
55
    def __eq__(self, other):
71
56
        if not isinstance(other, Revision):
72
57
            return False
 
58
        # FIXME: rbc 20050930 parent_ids are not being compared
73
59
        return (
74
60
                self.inventory_sha1 == other.inventory_sha1
75
61
                and self.revision_id == other.revision_id
77
63
                and self.message == other.message
78
64
                and self.timezone == other.timezone
79
65
                and self.committer == other.committer
80
 
                and self.properties == other.properties
81
 
                and self.parent_ids == other.parent_ids)
 
66
                and self.properties == other.properties)
82
67
 
83
68
    def __ne__(self, other):
84
69
        return not self.__eq__(other)
85
70
 
86
71
    def _check_properties(self):
87
 
        """Verify that all revision properties are OK."""
 
72
        """Verify that all revision properties are OK.
 
73
        """
88
74
        for name, value in self.properties.iteritems():
89
75
            if not isinstance(name, basestring) or contains_whitespace(name):
90
76
                raise ValueError("invalid property name %r" % name)
91
77
            if not isinstance(value, basestring):
92
 
                raise ValueError("invalid property value %r for %r" %
93
 
                                 (value, name))
94
 
 
95
 
    def get_history(self, repository):
96
 
        """Return the canonical line-of-history for this revision.
97
 
 
98
 
        If ghosts are present this may differ in result from a ghost-free
99
 
        repository.
100
 
        """
101
 
        current_revision = self
102
 
        reversed_result = []
103
 
        while current_revision is not None:
104
 
            reversed_result.append(current_revision.revision_id)
105
 
            if not len (current_revision.parent_ids):
106
 
                reversed_result.append(None)
107
 
                current_revision = None
108
 
            else:
109
 
                next_revision_id = current_revision.parent_ids[0]
110
 
                current_revision = repository.get_revision(next_revision_id)
111
 
        reversed_result.reverse()
112
 
        return reversed_result
113
 
 
114
 
    def get_summary(self):
115
 
        """Get the first line of the log message for this revision.
116
 
 
117
 
        Return an empty string if message is None.
118
 
        """
119
 
        if self.message:
120
 
            return self.message.lstrip().split('\n', 1)[0]
121
 
        else:
122
 
            return ''
123
 
 
124
 
    def get_apparent_authors(self):
125
 
        """Return the apparent authors of this revision.
126
 
 
127
 
        If the revision properties contain the names of the authors,
128
 
        return them. Otherwise return the committer name.
129
 
 
130
 
        The return value will be a list containing at least one element.
131
 
        """
132
 
        authors = self.properties.get('authors', None)
133
 
        if authors is None:
134
 
            author = self.properties.get('author', self.committer)
135
 
            if author is None:
136
 
                return []
137
 
            return [author]
138
 
        else:
139
 
            return authors.split("\n")
140
 
 
141
 
    def iter_bugs(self):
142
 
        """Iterate over the bugs associated with this revision."""
143
 
        bug_property = self.properties.get('bugs', None)
144
 
        if bug_property is None:
145
 
            return
146
 
        for line in bug_property.splitlines():
147
 
            try:
148
 
                url, status = line.split(None, 2)
149
 
            except ValueError:
150
 
                raise errors.InvalidLineInBugsProperty(line)
151
 
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
152
 
                raise errors.InvalidBugStatus(status)
153
 
            yield url, status
 
78
                raise ValueError("invalid property value %r for %r" % 
 
79
                                 (name, value))
 
80
 
 
81
 
 
82
def is_ancestor(revision_id, candidate_id, branch):
 
83
    """Return true if candidate_id is an ancestor of revision_id.
 
84
 
 
85
    A false negative will be returned if any intermediate descendent of
 
86
    candidate_id is not present in any of the revision_sources.
 
87
    
 
88
    revisions_source is an object supporting a get_revision operation that
 
89
    behaves like Branch's.
 
90
    """
 
91
    return candidate_id in branch.get_ancestry(revision_id)
154
92
 
155
93
 
156
94
def iter_ancestors(revision_id, revision_source, only_present=False):
163
101
                yield ancestor, distance
164
102
            try:
165
103
                revision = revision_source.get_revision(ancestor)
166
 
            except errors.NoSuchRevision, e:
 
104
            except bzrlib.errors.NoSuchRevision, e:
167
105
                if e.revision == revision_id:
168
 
                    raise
 
106
                    raise 
169
107
                else:
170
108
                    continue
171
109
            if only_present:
179
117
    """Return the ancestors of a revision present in a branch.
180
118
 
181
119
    It's possible that a branch won't have the complete ancestry of
182
 
    one of its revisions.
 
120
    one of its revisions.  
183
121
 
184
122
    """
185
123
    found_ancestors = {}
186
124
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
187
125
                         only_present=True))
188
126
    for anc_order, (anc_id, anc_distance) in anc_iter:
189
 
        if anc_id not in found_ancestors:
 
127
        if not found_ancestors.has_key(anc_id):
190
128
            found_ancestors[anc_id] = (anc_order, anc_distance)
191
129
    return found_ancestors
192
 
 
 
130
    
193
131
 
194
132
def __get_closest(intersection):
195
133
    intersection.sort()
196
 
    matches = []
 
134
    matches = [] 
197
135
    for entry in intersection:
198
136
        if entry[0] == intersection[0][0]:
199
137
            matches.append(entry[2])
200
138
    return matches
201
139
 
202
140
 
203
 
def is_reserved_id(revision_id):
204
 
    """Determine whether a revision id is reserved
205
 
 
206
 
    :return: True if the revision is reserved, False otherwise
 
141
def old_common_ancestor(revision_a, revision_b, revision_source):
 
142
    """Find the ancestor common to both revisions that is closest to both.
207
143
    """
208
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
209
 
 
210
 
 
211
 
def check_not_reserved_id(revision_id):
212
 
    """Raise ReservedId if the supplied revision_id is reserved"""
213
 
    if is_reserved_id(revision_id):
214
 
        raise errors.ReservedId(revision_id)
215
 
 
216
 
 
217
 
def ensure_null(revision_id):
218
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
219
 
    if revision_id is None:
220
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
221
 
            ' revision instead of None, as of bzr 0.91.',
222
 
            DeprecationWarning, stacklevel=2)
223
 
        return NULL_REVISION
 
144
    from bzrlib.trace import mutter
 
145
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
146
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
147
    a_intersection = []
 
148
    b_intersection = []
 
149
    # a_order is used as a tie-breaker when two equally-good bases are found
 
150
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
151
        if b_ancestors.has_key(revision):
 
152
            a_intersection.append((a_distance, a_order, revision))
 
153
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
154
    mutter("a intersection: %r" % a_intersection)
 
155
    mutter("b intersection: %r" % b_intersection)
 
156
 
 
157
    a_closest = __get_closest(a_intersection)
 
158
    if len(a_closest) == 0:
 
159
        return None
 
160
    b_closest = __get_closest(b_intersection)
 
161
    assert len(b_closest) != 0
 
162
    mutter ("a_closest %r" % a_closest)
 
163
    mutter ("b_closest %r" % b_closest)
 
164
    if a_closest[0] in b_closest:
 
165
        return a_closest[0]
 
166
    elif b_closest[0] in a_closest:
 
167
        return b_closest[0]
224
168
    else:
225
 
        return revision_id
226
 
 
227
 
 
228
 
def is_null(revision_id):
229
 
    if revision_id is None:
230
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
231
 
            ' revision instead of None, as of bzr 0.90.',
232
 
            DeprecationWarning, stacklevel=2)
233
 
    return revision_id in (None, NULL_REVISION)
 
169
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
170
    return a_closest[0]
 
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
    """
 
180
    ancestors = {}
 
181
    descendants = {}
 
182
    lines = [revision]
 
183
    root = None
 
184
    descendants[revision] = {}
 
185
    while len(lines) > 0:
 
186
        new_lines = set()
 
187
        for line in lines:
 
188
            if line == NULL_REVISION:
 
189
                parents = []
 
190
                root = NULL_REVISION
 
191
            else:
 
192
                try:
 
193
                    rev = revision_source.get_revision(line)
 
194
                    parents = list(rev.parent_ids)
 
195
                    if len(parents) == 0:
 
196
                        parents = [NULL_REVISION]
 
197
                except bzrlib.errors.NoSuchRevision:
 
198
                    if line == revision:
 
199
                        raise
 
200
                    parents = None
 
201
            if parents is not None:
 
202
                for parent in parents:
 
203
                    if parent not in ancestors:
 
204
                        new_lines.add(parent)
 
205
                    if parent not in descendants:
 
206
                        descendants[parent] = {}
 
207
                    descendants[parent][line] = 1
 
208
            if parents is not None:
 
209
                ancestors[line] = set(parents)
 
210
        lines = new_lines
 
211
    assert root not in descendants[root]
 
212
    assert root not in ancestors[root]
 
213
    return root, ancestors, descendants
 
214
 
 
215
 
 
216
def combined_graph(revision_a, revision_b, revision_source):
 
217
    """Produce a combined ancestry graph.
 
218
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
219
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
220
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
221
                                                        revision_source)
 
222
    if root != root_b:
 
223
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
224
    common = set()
 
225
    for node, node_anc in ancestors_b.iteritems():
 
226
        if node in ancestors:
 
227
            common.add(node)
 
228
        else:
 
229
            ancestors[node] = set()
 
230
        ancestors[node].update(node_anc)
 
231
    for node, node_dec in descendants_b.iteritems():
 
232
        if node not in descendants:
 
233
            descendants[node] = {}
 
234
        descendants[node].update(node_dec)
 
235
    return root, ancestors, descendants, common
 
236
 
 
237
 
 
238
def common_ancestor(revision_a, revision_b, revision_source):
 
239
    try:
 
240
        root, ancestors, descendants, common = \
 
241
            combined_graph(revision_a, revision_b, revision_source)
 
242
    except bzrlib.errors.NoCommonRoot:
 
243
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
244
        
 
245
    distances = node_distances (descendants, ancestors, root)
 
246
    farthest = select_farthest(distances, common)
 
247
    if farthest is None or farthest == NULL_REVISION:
 
248
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
249
    return farthest
 
250
 
 
251
 
 
252
class MultipleRevisionSources(object):
 
253
    """Proxy that looks in multiple branches for revisions."""
 
254
    def __init__(self, *args):
 
255
        object.__init__(self)
 
256
        assert len(args) != 0
 
257
        self._revision_sources = args
 
258
 
 
259
    def get_revision(self, revision_id):
 
260
        for source in self._revision_sources:
 
261
            try:
 
262
                return source.get_revision(revision_id)
 
263
            except bzrlib.errors.NoSuchRevision, e:
 
264
                pass
 
265
        raise e
 
266
 
 
267
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
268
                              revision_history=None):
 
269
    """Find the longest line of descent from maybe_ancestor to revision.
 
270
    Revision history is followed where possible.
 
271
 
 
272
    If ancestor_id == rev_id, list will be empty.
 
273
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
274
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
275
    """
 
276
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
277
    if len(descendants) == 0:
 
278
        raise NoSuchRevision(rev_source, rev_id)
 
279
    if ancestor_id not in descendants:
 
280
        rev_source.get_revision(ancestor_id)
 
281
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
282
    root_descendants = all_descendants(descendants, ancestor_id)
 
283
    root_descendants.add(ancestor_id)
 
284
    if rev_id not in root_descendants:
 
285
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
286
    distances = node_distances(descendants, ancestors, ancestor_id,
 
287
                               root_descendants=root_descendants)
 
288
 
 
289
    def best_ancestor(rev_id):
 
290
        best = None
 
291
        for anc_id in ancestors[rev_id]:
 
292
            try:
 
293
                distance = distances[anc_id]
 
294
            except KeyError:
 
295
                continue
 
296
            if revision_history is not None and anc_id in revision_history:
 
297
                return anc_id
 
298
            elif best is None or distance > best[1]:
 
299
                best = (anc_id, distance)
 
300
        return best[0]
 
301
 
 
302
    next = rev_id
 
303
    path = []
 
304
    while next != ancestor_id:
 
305
        path.append(next)
 
306
        next = best_ancestor(next)
 
307
    path.reverse()
 
308
    return path