← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Vincent Ladeuil
  • Date: 2011-08-20 09:28:27 UTC
  • mfrom: (5050.78.2 2.2)
  • mto: (5609.48.8 2.3)
  • mto: This revision was merged to the branch mainline in revision 6090.
  • Revision ID: v.ladeuil+lp@free.fr-20110820092827-9dyakfslp0r3hb1k
Merge 2.2 into 2.3 (including fix for #614713, #609187 and #812928)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
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
 
 
32
NULL_REVISION="null:"
 
33
CURRENT_REVISION="current:"
 
34
 
 
35
 
 
36
class Revision(object):
 
37
    """Single revision on a branch.
 
38
 
 
39
    Revisions may know their revision_hash, but only once they've been
 
40
    written out.  This is not stored because you cannot write the hash
 
41
    into the file it describes.
 
42
 
 
43
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
44
 
 
45
    parent_ids
 
46
        List of parent revision_ids
 
47
 
 
48
    properties
 
49
        Dictionary of revision properties.  These are attached to the
 
50
        revision as extra metadata.  The name must be a single
 
51
        word; the value can be an arbitrary string.
 
52
    """
 
53
 
 
54
    def __init__(self, revision_id, properties=None, **args):
 
55
        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
 
62
        self.parent_ids = []
 
63
        self.parent_sha1s = []
 
64
        """Not used anymore - legacy from for 4."""
 
65
        self.__dict__.update(args)
 
66
 
 
67
    def __repr__(self):
 
68
        return "<Revision id %s>" % self.revision_id
 
69
 
 
70
    def __eq__(self, other):
 
71
        if not isinstance(other, Revision):
 
72
            return False
 
73
        return (
 
74
                self.inventory_sha1 == other.inventory_sha1
 
75
                and self.revision_id == other.revision_id
 
76
                and self.timestamp == other.timestamp
 
77
                and self.message == other.message
 
78
                and self.timezone == other.timezone
 
79
                and self.committer == other.committer
 
80
                and self.properties == other.properties
 
81
                and self.parent_ids == other.parent_ids)
 
82
 
 
83
    def __ne__(self, other):
 
84
        return not self.__eq__(other)
 
85
 
 
86
    def _check_properties(self):
 
87
        """Verify that all revision properties are OK."""
 
88
        for name, value in self.properties.iteritems():
 
89
            if not isinstance(name, basestring) or contains_whitespace(name):
 
90
                raise ValueError("invalid property name %r" % name)
 
91
            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
 
154
 
 
155
 
 
156
def iter_ancestors(revision_id, revision_source, only_present=False):
 
157
    ancestors = (revision_id,)
 
158
    distance = 0
 
159
    while len(ancestors) > 0:
 
160
        new_ancestors = []
 
161
        for ancestor in ancestors:
 
162
            if not only_present:
 
163
                yield ancestor, distance
 
164
            try:
 
165
                revision = revision_source.get_revision(ancestor)
 
166
            except errors.NoSuchRevision, e:
 
167
                if e.revision == revision_id:
 
168
                    raise
 
169
                else:
 
170
                    continue
 
171
            if only_present:
 
172
                yield ancestor, distance
 
173
            new_ancestors.extend(revision.parent_ids)
 
174
        ancestors = new_ancestors
 
175
        distance += 1
 
176
 
 
177
 
 
178
def find_present_ancestors(revision_id, revision_source):
 
179
    """Return the ancestors of a revision present in a branch.
 
180
 
 
181
    It's possible that a branch won't have the complete ancestry of
 
182
    one of its revisions.
 
183
 
 
184
    """
 
185
    found_ancestors = {}
 
186
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
187
                         only_present=True))
 
188
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
189
        if anc_id not in found_ancestors:
 
190
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
191
    return found_ancestors
 
192
 
 
193
 
 
194
def __get_closest(intersection):
 
195
    intersection.sort()
 
196
    matches = []
 
197
    for entry in intersection:
 
198
        if entry[0] == intersection[0][0]:
 
199
            matches.append(entry[2])
 
200
    return matches
 
201
 
 
202
 
 
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
 
207
    """
 
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
 
224
    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)