~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: 2008-06-20 01:09:18 UTC
  • mfrom: (3505.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080620010918-64z4xylh1ap5hgyf
Accept user names with @s in URLs (Neil Martinsen-Burrell)

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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
 
18
 
 
19
 
 
20
 
from xml import XMLMixin
21
 
 
22
 
try:
23
 
    from cElementTree import Element, ElementTree, SubElement
24
 
except ImportError:
25
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
26
 
 
27
 
from errors import BzrError
28
 
 
29
 
 
30
 
class Revision(XMLMixin):
 
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 import (
 
22
    errors,
 
23
    symbol_versioning,
 
24
    )
 
25
from bzrlib.osutils import contains_whitespace
 
26
from bzrlib.progress import DummyProgress
 
27
 
 
28
NULL_REVISION="null:"
 
29
CURRENT_REVISION="current:"
 
30
 
 
31
 
 
32
class Revision(object):
31
33
    """Single revision on a branch.
32
34
 
33
35
    Revisions may know their revision_hash, but only once they've been
34
36
    written out.  This is not stored because you cannot write the hash
35
37
    into the file it describes.
36
38
 
37
 
    TODO: Perhaps make predecessor be a child element, not an attribute?
 
39
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
40
 
 
41
    parent_ids
 
42
        List of parent revision_ids
 
43
 
 
44
    properties
 
45
        Dictionary of revision properties.  These are attached to the
 
46
        revision as extra metadata.  The name must be a single 
 
47
        word; the value can be an arbitrary string.
38
48
    """
39
 
    def __init__(self, **args):
40
 
        self.inventory_id = None
41
 
        self.revision_id = None
42
 
        self.timestamp = None
43
 
        self.message = None
44
 
        self.timezone = None
45
 
        self.committer = None
46
 
        self.precursor = None
 
49
    
 
50
    def __init__(self, revision_id, properties=None, **args):
 
51
        self.revision_id = revision_id
 
52
        self.properties = properties or {}
 
53
        self._check_properties()
 
54
        self.parent_ids = []
 
55
        self.parent_sha1s = []
 
56
        """Not used anymore - legacy from for 4."""
47
57
        self.__dict__.update(args)
48
58
 
49
 
 
50
59
    def __repr__(self):
51
60
        return "<Revision id %s>" % self.revision_id
52
61
 
53
 
        
54
 
    def to_element(self):
55
 
        root = Element('revision',
56
 
                       committer = self.committer,
57
 
                       timestamp = '%.9f' % self.timestamp,
58
 
                       revision_id = self.revision_id,
59
 
                       inventory_id = self.inventory_id,
60
 
                       timezone = str(self.timezone))
61
 
        if self.precursor:
62
 
            root.set('precursor', self.precursor)
63
 
        root.text = '\n'
64
 
        
65
 
        msg = SubElement(root, 'message')
66
 
        msg.text = self.message
67
 
        msg.tail = '\n'
68
 
 
69
 
        return root
70
 
 
71
 
 
72
 
    def from_element(cls, elt):
73
 
        # <changeset> is deprecated...
74
 
        if elt.tag not in ('revision', 'changeset'):
75
 
            raise BzrError("unexpected tag in revision file: %r" % elt)
76
 
 
77
 
        cs = cls(committer = elt.get('committer'),
78
 
                 timestamp = float(elt.get('timestamp')),
79
 
                 precursor = elt.get('precursor'),
80
 
                 revision_id = elt.get('revision_id'),
81
 
                 inventory_id = elt.get('inventory_id'))
82
 
 
83
 
        v = elt.get('timezone')
84
 
        cs.timezone = v and int(v)
85
 
 
86
 
        cs.message = elt.findtext('message') # text of <message>
87
 
        return cs
88
 
 
89
 
    from_element = classmethod(from_element)
90
 
 
 
62
    def __eq__(self, other):
 
63
        if not isinstance(other, Revision):
 
64
            return False
 
65
        # FIXME: rbc 20050930 parent_ids are not being compared
 
66
        return (
 
67
                self.inventory_sha1 == other.inventory_sha1
 
68
                and self.revision_id == other.revision_id
 
69
                and self.timestamp == other.timestamp
 
70
                and self.message == other.message
 
71
                and self.timezone == other.timezone
 
72
                and self.committer == other.committer
 
73
                and self.properties == other.properties)
 
74
 
 
75
    def __ne__(self, other):
 
76
        return not self.__eq__(other)
 
77
 
 
78
    def _check_properties(self):
 
79
        """Verify that all revision properties are OK."""
 
80
        for name, value in self.properties.iteritems():
 
81
            if not isinstance(name, basestring) or contains_whitespace(name):
 
82
                raise ValueError("invalid property name %r" % name)
 
83
            if not isinstance(value, basestring):
 
84
                raise ValueError("invalid property value %r for %r" % 
 
85
                                 (name, value))
 
86
 
 
87
    def get_history(self, repository):
 
88
        """Return the canonical line-of-history for this revision.
 
89
 
 
90
        If ghosts are present this may differ in result from a ghost-free
 
91
        repository.
 
92
        """
 
93
        current_revision = self
 
94
        reversed_result = []
 
95
        while current_revision is not None:
 
96
            reversed_result.append(current_revision.revision_id)
 
97
            if not len (current_revision.parent_ids):
 
98
                reversed_result.append(None)
 
99
                current_revision = None
 
100
            else:
 
101
                next_revision_id = current_revision.parent_ids[0]
 
102
                current_revision = repository.get_revision(next_revision_id)
 
103
        reversed_result.reverse()
 
104
        return reversed_result
 
105
 
 
106
    def get_summary(self):
 
107
        """Get the first line of the log message for this revision.
 
108
        """
 
109
        return self.message.lstrip().split('\n', 1)[0]
 
110
 
 
111
    def get_apparent_author(self):
 
112
        """Return the apparent author of this revision.
 
113
 
 
114
        If the revision properties contain the author name,
 
115
        return it. Otherwise return the committer name.
 
116
        """
 
117
        return self.properties.get('author', self.committer)
 
118
 
 
119
 
 
120
def iter_ancestors(revision_id, revision_source, only_present=False):
 
121
    ancestors = (revision_id,)
 
122
    distance = 0
 
123
    while len(ancestors) > 0:
 
124
        new_ancestors = []
 
125
        for ancestor in ancestors:
 
126
            if not only_present:
 
127
                yield ancestor, distance
 
128
            try:
 
129
                revision = revision_source.get_revision(ancestor)
 
130
            except errors.NoSuchRevision, e:
 
131
                if e.revision == revision_id:
 
132
                    raise 
 
133
                else:
 
134
                    continue
 
135
            if only_present:
 
136
                yield ancestor, distance
 
137
            new_ancestors.extend(revision.parent_ids)
 
138
        ancestors = new_ancestors
 
139
        distance += 1
 
140
 
 
141
 
 
142
def find_present_ancestors(revision_id, revision_source):
 
143
    """Return the ancestors of a revision present in a branch.
 
144
 
 
145
    It's possible that a branch won't have the complete ancestry of
 
146
    one of its revisions.  
 
147
 
 
148
    """
 
149
    found_ancestors = {}
 
150
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
 
151
                         only_present=True))
 
152
    for anc_order, (anc_id, anc_distance) in anc_iter:
 
153
        if anc_id not in found_ancestors:
 
154
            found_ancestors[anc_id] = (anc_order, anc_distance)
 
155
    return found_ancestors
 
156
    
 
157
 
 
158
def __get_closest(intersection):
 
159
    intersection.sort()
 
160
    matches = [] 
 
161
    for entry in intersection:
 
162
        if entry[0] == intersection[0][0]:
 
163
            matches.append(entry[2])
 
164
    return matches
 
165
 
 
166
 
 
167
def is_reserved_id(revision_id):
 
168
    """Determine whether a revision id is reserved
 
169
 
 
170
    :return: True if the revision is is reserved, False otherwise
 
171
    """
 
172
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
 
173
 
 
174
 
 
175
def check_not_reserved_id(revision_id):
 
176
    """Raise ReservedId if the supplied revision_id is reserved"""
 
177
    if is_reserved_id(revision_id):
 
178
        raise errors.ReservedId(revision_id)
 
179
 
 
180
 
 
181
def ensure_null(revision_id):
 
182
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
183
    if revision_id is None:
 
184
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
185
            ' revision instead of None, as of bzr 0.91.',
 
186
            DeprecationWarning, stacklevel=2)
 
187
        return NULL_REVISION
 
188
    else:
 
189
        return revision_id
 
190
 
 
191
 
 
192
def is_null(revision_id):
 
193
    if revision_id is None:
 
194
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
195
            ' revision instead of None, as of bzr 0.90.',
 
196
            DeprecationWarning, stacklevel=2)
 
197
    return revision_id in (None, NULL_REVISION)