← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2006-03-22 19:21:20 UTC
  • mto: (1668.1.8 bzr-0.8.mbp)
  • mto: This revision was merged to the branch mainline in revision 1710.
  • Revision ID: mbp@sourcefrog.net-20060322192120-133f1e99d4c79477
Update xmlrpc api

Prompt for user password when registering

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005-2011 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 bugtracker
24
 
""")
25
 
from bzrlib import (
26
 
    errors,
27
 
    symbol_versioning,
28
 
    )
29
 
from bzrlib.osutils import contains_whitespace
30
 
 
31
 
NULL_REVISION="null:"
32
 
CURRENT_REVISION="current:"
33
 
 
34
 
 
35
 
class Revision(object):
36
 
    """Single revision on a branch.
37
 
 
38
 
    Revisions may know their revision_hash, but only once they've been
39
 
    written out.  This is not stored because you cannot write the hash
40
 
    into the file it describes.
41
 
 
42
 
    After bzr 0.0.5 revisions are allowed to have multiple parents.
43
 
 
44
 
    parent_ids
45
 
        List of parent revision_ids
46
 
 
47
 
    properties
48
 
        Dictionary of revision properties.  These are attached to the
49
 
        revision as extra metadata.  The name must be a single
50
 
        word; the value can be an arbitrary string.
51
 
    """
52
 
 
53
 
    def __init__(self, revision_id, properties=None, **args):
54
 
        self.revision_id = revision_id
55
 
        if properties is None:
56
 
            self.properties = {}
57
 
        else:
58
 
            self.properties = properties
59
 
            self._check_properties()
60
 
        self.committer = None
61
 
        self.parent_ids = []
62
 
        self.parent_sha1s = []
63
 
        """Not used anymore - legacy from for 4."""
64
 
        self.__dict__.update(args)
65
 
 
66
 
    def __repr__(self):
67
 
        return "<Revision id %s>" % self.revision_id
68
 
 
69
 
    def __eq__(self, other):
70
 
        if not isinstance(other, Revision):
71
 
            return False
72
 
        return (
73
 
                self.inventory_sha1 == other.inventory_sha1
74
 
                and self.revision_id == other.revision_id
75
 
                and self.timestamp == other.timestamp
76
 
                and self.message == other.message
77
 
                and self.timezone == other.timezone
78
 
                and self.committer == other.committer
79
 
                and self.properties == other.properties
80
 
                and self.parent_ids == other.parent_ids)
81
 
 
82
 
    def __ne__(self, other):
83
 
        return not self.__eq__(other)
84
 
 
85
 
    def _check_properties(self):
86
 
        """Verify that all revision properties are OK."""
87
 
        for name, value in self.properties.iteritems():
88
 
            if not isinstance(name, basestring) or contains_whitespace(name):
89
 
                raise ValueError("invalid property name %r" % name)
90
 
            if not isinstance(value, basestring):
91
 
                raise ValueError("invalid property value %r for %r" %
92
 
                                 (value, name))
93
 
 
94
 
    def get_history(self, repository):
95
 
        """Return the canonical line-of-history for this revision.
96
 
 
97
 
        If ghosts are present this may differ in result from a ghost-free
98
 
        repository.
99
 
        """
100
 
        current_revision = self
101
 
        reversed_result = []
102
 
        while current_revision is not None:
103
 
            reversed_result.append(current_revision.revision_id)
104
 
            if not len (current_revision.parent_ids):
105
 
                reversed_result.append(None)
106
 
                current_revision = None
107
 
            else:
108
 
                next_revision_id = current_revision.parent_ids[0]
109
 
                current_revision = repository.get_revision(next_revision_id)
110
 
        reversed_result.reverse()
111
 
        return reversed_result
112
 
 
113
 
    def get_summary(self):
114
 
        """Get the first line of the log message for this revision.
115
 
 
116
 
        Return an empty string if message is None.
117
 
        """
118
 
        if self.message:
119
 
            return self.message.lstrip().split('\n', 1)[0]
120
 
        else:
121
 
            return ''
122
 
 
123
 
    def get_apparent_authors(self):
124
 
        """Return the apparent authors of this revision.
125
 
 
126
 
        If the revision properties contain the names of the authors,
127
 
        return them. Otherwise return the committer name.
128
 
 
129
 
        The return value will be a list containing at least one element.
130
 
        """
131
 
        authors = self.properties.get('authors', None)
132
 
        if authors is None:
133
 
            author = self.properties.get('author', self.committer)
134
 
            if author is None:
135
 
                return []
136
 
            return [author]
137
 
        else:
138
 
            return authors.split("\n")
139
 
 
140
 
    def iter_bugs(self):
141
 
        """Iterate over the bugs associated with this revision."""
142
 
        bug_property = self.properties.get('bugs', None)
143
 
        if bug_property is None:
144
 
            return
145
 
        for line in bug_property.splitlines():
146
 
            try:
147
 
                url, status = line.split(None, 2)
148
 
            except ValueError:
149
 
                raise errors.InvalidLineInBugsProperty(line)
150
 
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
151
 
                raise errors.InvalidBugStatus(status)
152
 
            yield url, status
153
 
 
154
 
 
155
 
def iter_ancestors(revision_id, revision_source, only_present=False):
156
 
    ancestors = (revision_id,)
157
 
    distance = 0
158
 
    while len(ancestors) > 0:
159
 
        new_ancestors = []
160
 
        for ancestor in ancestors:
161
 
            if not only_present:
162
 
                yield ancestor, distance
163
 
            try:
164
 
                revision = revision_source.get_revision(ancestor)
165
 
            except errors.NoSuchRevision, e:
166
 
                if e.revision == revision_id:
167
 
                    raise
168
 
                else:
169
 
                    continue
170
 
            if only_present:
171
 
                yield ancestor, distance
172
 
            new_ancestors.extend(revision.parent_ids)
173
 
        ancestors = new_ancestors
174
 
        distance += 1
175
 
 
176
 
 
177
 
def find_present_ancestors(revision_id, revision_source):
178
 
    """Return the ancestors of a revision present in a branch.
179
 
 
180
 
    It's possible that a branch won't have the complete ancestry of
181
 
    one of its revisions.
182
 
 
183
 
    """
184
 
    found_ancestors = {}
185
 
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
186
 
                         only_present=True))
187
 
    for anc_order, (anc_id, anc_distance) in anc_iter:
188
 
        if anc_id not in found_ancestors:
189
 
            found_ancestors[anc_id] = (anc_order, anc_distance)
190
 
    return found_ancestors
191
 
 
192
 
 
193
 
def __get_closest(intersection):
194
 
    intersection.sort()
195
 
    matches = []
196
 
    for entry in intersection:
197
 
        if entry[0] == intersection[0][0]:
198
 
            matches.append(entry[2])
199
 
    return matches
200
 
 
201
 
 
202
 
def is_reserved_id(revision_id):
203
 
    """Determine whether a revision id is reserved
204
 
 
205
 
    :return: True if the revision is reserved, False otherwise
206
 
    """
207
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
208
 
 
209
 
 
210
 
def check_not_reserved_id(revision_id):
211
 
    """Raise ReservedId if the supplied revision_id is reserved"""
212
 
    if is_reserved_id(revision_id):
213
 
        raise errors.ReservedId(revision_id)
214
 
 
215
 
 
216
 
def ensure_null(revision_id):
217
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
218
 
    if revision_id is None:
219
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
220
 
            ' revision instead of None, as of bzr 0.91.',
221
 
            DeprecationWarning, stacklevel=2)
222
 
        return NULL_REVISION
223
 
    else:
224
 
        return revision_id
225
 
 
226
 
 
227
 
def is_null(revision_id):
228
 
    if revision_id is None:
229
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
230
 
            ' revision instead of None, as of bzr 0.90.',
231
 
            DeprecationWarning, stacklevel=2)
232
 
    return revision_id in (None, NULL_REVISION)