~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-01 13:53:24 UTC
  • mfrom: (4990.1.2 rm-obsolete)
  • Revision ID: pqm@pqm.ubuntu.com-20100201135324-cuhuolr97guf5xjp
(Jelmer) Remove obsolete (and broken) biobench and history2revfiles
        tools.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# (C) 2005 Canonical
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
 
19
 
 
20
 
class RevisionReference(object):
21
 
    """
22
 
    Reference to a stored revision.
23
 
 
24
 
    Includes the revision_id and revision_sha1.
25
 
    """
26
 
    revision_id = None
27
 
    revision_sha1 = None
28
 
    def __init__(self, revision_id, revision_sha1=None):
29
 
        if revision_id == None \
30
 
           or isinstance(revision_id, basestring):
31
 
            self.revision_id = revision_id
32
 
        else:
33
 
            raise ValueError('bad revision_id %r' % revision_id)
34
 
 
35
 
        if revision_sha1 != None:
36
 
            if isinstance(revision_sha1, basestring) \
37
 
               and len(revision_sha1) == 40:
38
 
                self.revision_sha1 = revision_sha1
39
 
            else:
40
 
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
41
 
                
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
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
 
 
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
    )
 
30
from bzrlib.osutils import contains_whitespace
 
31
from bzrlib.progress import DummyProgress
 
32
 
 
33
NULL_REVISION="null:"
 
34
CURRENT_REVISION="current:"
42
35
 
43
36
 
44
37
class Revision(object):
50
43
 
51
44
    After bzr 0.0.5 revisions are allowed to have multiple parents.
52
45
 
53
 
    parents
54
 
        List of parent revisions, each is a RevisionReference.
 
46
    parent_ids
 
47
        List of parent revision_ids
 
48
 
 
49
    properties
 
50
        Dictionary of revision properties.  These are attached to the
 
51
        revision as extra metadata.  The name must be a single
 
52
        word; the value can be an arbitrary string.
55
53
    """
56
 
    inventory_id = None
57
 
    inventory_sha1 = None
58
 
    revision_id = None
59
 
    timestamp = None
60
 
    message = None
61
 
    timezone = None
62
 
    committer = None
63
 
    
64
 
    def __init__(self, **args):
 
54
 
 
55
    def __init__(self, revision_id, properties=None, **args):
 
56
        self.revision_id = revision_id
 
57
        if properties is None:
 
58
            self.properties = {}
 
59
        else:
 
60
            self.properties = properties
 
61
            self._check_properties()
 
62
        self.committer = None
 
63
        self.parent_ids = []
 
64
        self.parent_sha1s = []
 
65
        """Not used anymore - legacy from for 4."""
65
66
        self.__dict__.update(args)
66
 
        self.parents = []
67
 
 
68
67
 
69
68
    def __repr__(self):
70
69
        return "<Revision id %s>" % self.revision_id
71
70
 
72
 
        
73
 
    def to_element(self):
74
 
        from bzrlib.xml import Element, SubElement
75
 
        
76
 
        root = Element('revision',
77
 
                       committer = self.committer,
78
 
                       timestamp = '%.9f' % self.timestamp,
79
 
                       revision_id = self.revision_id,
80
 
                       inventory_id = self.inventory_id,
81
 
                       inventory_sha1 = self.inventory_sha1,
82
 
                       )
83
 
        if self.timezone:
84
 
            root.set('timezone', str(self.timezone))
85
 
        root.text = '\n'
86
 
        
87
 
        msg = SubElement(root, 'message')
88
 
        msg.text = self.message
89
 
        msg.tail = '\n'
90
 
 
91
 
        if self.parents:
92
 
            pelts = SubElement(root, 'parents')
93
 
            pelts.tail = pelts.text = '\n'
94
 
            for rr in self.parents:
95
 
                assert isinstance(rr, RevisionReference)
96
 
                p = SubElement(pelts, 'revision_ref')
97
 
                p.tail = '\n'
98
 
                assert rr.revision_id
99
 
                p.set('revision_id', rr.revision_id)
100
 
                if rr.revision_sha1:
101
 
                    p.set('revision_sha1', rr.revision_sha1)
102
 
 
103
 
        return root
104
 
 
105
 
 
106
 
    def from_element(cls, elt):
107
 
        return unpack_revision(elt)
108
 
 
109
 
    from_element = classmethod(from_element)
110
 
 
111
 
 
112
 
 
113
 
def unpack_revision(elt):
114
 
    """Convert XML element into Revision object."""
115
 
    # <changeset> is deprecated...
116
 
    from bzrlib.errors import BzrError
117
 
    
118
 
    if elt.tag not in ('revision', 'changeset'):
119
 
        raise BzrError("unexpected tag in revision file: %r" % elt)
120
 
 
121
 
    rev = Revision(committer = elt.get('committer'),
122
 
                   timestamp = float(elt.get('timestamp')),
123
 
                   revision_id = elt.get('revision_id'),
124
 
                   inventory_id = elt.get('inventory_id'),
125
 
                   inventory_sha1 = elt.get('inventory_sha1')
126
 
                   )
127
 
 
128
 
    precursor = elt.get('precursor')
129
 
    precursor_sha1 = elt.get('precursor_sha1')
130
 
 
131
 
    pelts = elt.find('parents')
132
 
 
133
 
    if pelts:
134
 
        for p in pelts:
135
 
            assert p.tag == 'revision_ref', \
136
 
                   "bad parent node tag %r" % p.tag
137
 
            rev_ref = RevisionReference(p.get('revision_id'),
138
 
                                        p.get('revision_sha1'))
139
 
            rev.parents.append(rev_ref)
140
 
 
141
 
        if precursor:
142
 
            # must be consistent
143
 
            prec_parent = rev.parents[0].revision_id
144
 
            assert prec_parent == precursor
145
 
    elif precursor:
146
 
        # revisions written prior to 0.0.5 have a single precursor
147
 
        # give as an attribute
148
 
        rev_ref = RevisionReference(precursor, precursor_sha1)
149
 
        rev.parents.append(rev_ref)
150
 
 
151
 
    v = elt.get('timezone')
152
 
    rev.timezone = v and int(v)
153
 
 
154
 
    rev.message = elt.findtext('message') # text of <message>
155
 
    return rev
156
 
 
157
 
 
158
 
 
159
 
REVISION_ID_RE = None
160
 
 
161
 
def validate_revision_id(rid):
162
 
    """Check rid is syntactically valid for a revision id."""
163
 
    global REVISION_ID_RE
164
 
    if not REVISION_ID_RE:
165
 
        import re
166
 
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
167
 
 
168
 
    if not REVISION_ID_RE.match(rid):
169
 
        raise ValueError("malformed revision-id %r" % rid)
170
 
    
 
71
    def __eq__(self, other):
 
72
        if not isinstance(other, Revision):
 
73
            return False
 
74
        return (
 
75
                self.inventory_sha1 == other.inventory_sha1
 
76
                and self.revision_id == other.revision_id
 
77
                and self.timestamp == other.timestamp
 
78
                and self.message == other.message
 
79
                and self.timezone == other.timezone
 
80
                and self.committer == other.committer
 
81
                and self.properties == other.properties
 
82
                and self.parent_ids == other.parent_ids)
 
83
 
 
84
    def __ne__(self, other):
 
85
        return not self.__eq__(other)
 
86
 
 
87
    def _check_properties(self):
 
88
        """Verify that all revision properties are OK."""
 
89
        for name, value in self.properties.iteritems():
 
90
            if not isinstance(name, basestring) or contains_whitespace(name):
 
91
                raise ValueError("invalid property name %r" % name)
 
92
            if not isinstance(value, basestring):
 
93
                raise ValueError("invalid property value %r for %r" %
 
94
                                 (value, name))
 
95
 
 
96
    def get_history(self, repository):
 
97
        """Return the canonical line-of-history for this revision.
 
98
 
 
99
        If ghosts are present this may differ in result from a ghost-free
 
100
        repository.
 
101
        """
 
102
        current_revision = self
 
103
        reversed_result = []
 
104
        while current_revision is not None:
 
105
            reversed_result.append(current_revision.revision_id)
 
106
            if not len (current_revision.parent_ids):
 
107
                reversed_result.append(None)
 
108
                current_revision = None
 
109
            else:
 
110
                next_revision_id = current_revision.parent_ids[0]
 
111
                current_revision = repository.get_revision(next_revision_id)
 
112
        reversed_result.reverse()
 
113
        return reversed_result
 
114
 
 
115
    def get_summary(self):
 
116
        """Get the first line of the log message for this revision.
 
117
 
 
118
        Return an empty string if message is None.
 
119
        """
 
120
        if self.message:
 
121
            return self.message.lstrip().split('\n', 1)[0]
 
122
        else:
 
123
            return ''
 
124
 
 
125
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
 
126
    def get_apparent_author(self):
 
127
        """Return the apparent author of this revision.
 
128
 
 
129
        This method is deprecated in favour of get_apparent_authors.
 
130
 
 
131
        If the revision properties contain any author names,
 
132
        return the first. Otherwise return the committer name.
 
133
        """
 
134
        authors = self.get_apparent_authors()
 
135
        if authors:
 
136
            return authors[0]
 
137
        else:
 
138
            return None
 
139
 
 
140
    def get_apparent_authors(self):
 
141
        """Return the apparent authors of this revision.
 
142
 
 
143
        If the revision properties contain the names of the authors,
 
144
        return them. Otherwise return the committer name.
 
145
 
 
146
        The return value will be a list containing at least one element.
 
147
        """
 
148
        authors = self.properties.get('authors', None)
 
149
        if authors is None:
 
150
            author = self.properties.get('author', self.committer)
 
151
            if author is None:
 
152
                return []
 
153
            return [author]
 
154
        else:
 
155
            return authors.split("\n")
 
156
 
 
157
    def iter_bugs(self):
 
158
        """Iterate over the bugs associated with this revision."""
 
159
        bug_property = self.properties.get('bugs', None)
 
160
        if bug_property is None:
 
161
            return
 
162
        for line in bug_property.splitlines():
 
163
            try:
 
164
                url, status = line.split(None, 2)
 
165
            except ValueError:
 
166
                raise errors.InvalidLineInBugsProperty(line)
 
167
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
 
168
                raise errors.InvalidBugStatus(status)
 
169
            yield url, status
 
170
 
 
171
 
 
172
def iter_ancestors(revision_id, revision_source, only_present=False):
 
173
    ancestors = (revision_id,)
 
174
    distance = 0
 
175
    while len(ancestors) > 0:
 
176
        new_ancestors = []
 
177
        for ancestor in ancestors:
 
178
            if not only_present:
 
179
                yield ancestor, distance
 
180
            try:
 
181
                revision = revision_source.get_revision(ancestor)
 
182
            except errors.NoSuchRevision, e:
 
183
                if e.revision == revision_id:
 
184
                    raise
 
185
                else:
 
186
                    continue
 
187
            if only_present:
 
188
                yield ancestor, distance
 
189
            new_ancestors.extend(revision.parent_ids)
 
190
        ancestors = new_ancestors
 
191
        distance += 1
 
192
 
 
193
 
 
194
def find_present_ancestors(revision_id, revision_source):
 
195
    """Return the ancestors of a revision present in a branch.
 
196
 
 
197
    It's possible that a branch won't have the complete ancestry of
 
198
    one of its revisions.
 
199
 
 
200
    """
 
201
    found_ancestors = {}
 
202
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
203
                         only_present=True))
 
204
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
205
        if anc_id not in found_ancestors:
 
206
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
207
    return found_ancestors
 
208
 
 
209
 
 
210
def __get_closest(intersection):
 
211
    intersection.sort()
 
212
    matches = []
 
213
    for entry in intersection:
 
214
        if entry[0] == intersection[0][0]:
 
215
            matches.append(entry[2])
 
216
    return matches
 
217
 
 
218
 
 
219
def is_reserved_id(revision_id):
 
220
    """Determine whether a revision id is reserved
 
221
 
 
222
    :return: True if the revision is reserved, False otherwise
 
223
    """
 
224
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
 
225
 
 
226
 
 
227
def check_not_reserved_id(revision_id):
 
228
    """Raise ReservedId if the supplied revision_id is reserved"""
 
229
    if is_reserved_id(revision_id):
 
230
        raise errors.ReservedId(revision_id)
 
231
 
 
232
 
 
233
def ensure_null(revision_id):
 
234
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
235
    if revision_id is None:
 
236
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
237
            ' revision instead of None, as of bzr 0.91.',
 
238
            DeprecationWarning, stacklevel=2)
 
239
        return NULL_REVISION
 
240
    else:
 
241
        return revision_id
 
242
 
 
243
 
 
244
def is_null(revision_id):
 
245
    if revision_id is None:
 
246
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
247
            ' revision instead of None, as of bzr 0.90.',
 
248
            DeprecationWarning, stacklevel=2)
 
249
    return revision_id in (None, NULL_REVISION)