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.
 
 
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.
 
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
20
class RevisionReference(object):
 
 
22
    Reference to a stored revision.
 
 
24
    Includes the revision_id and revision_sha1.
 
 
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
 
 
33
            raise ValueError('bad revision_id %r' % revision_id)
 
 
35
        if revision_sha1 != None:
 
 
36
            if isinstance(revision_sha1, basestring) \
 
 
37
               and len(revision_sha1) == 40:
 
 
38
                self.revision_sha1 = revision_sha1
 
 
40
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
 
 
44
class Revision(object):
 
 
45
    """Single revision on a branch.
 
 
47
    Revisions may know their revision_hash, but only once they've been
 
 
48
    written out.  This is not stored because you cannot write the hash
 
 
49
    into the file it describes.
 
 
51
    After bzr 0.0.5 revisions are allowed to have multiple parents.
 
 
54
        List of parent revisions, each is a RevisionReference.
 
 
64
    def __init__(self, **args):
 
 
65
        self.__dict__.update(args)
 
 
70
        return "<Revision id %s>" % self.revision_id
 
 
74
        from bzrlib.xml import Element, SubElement
 
 
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,
 
 
84
            root.set('timezone', str(self.timezone))
 
 
87
        msg = SubElement(root, 'message')
 
 
88
        msg.text = self.message
 
 
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')
 
 
99
                p.set('revision_id', rr.revision_id)
 
 
101
                    p.set('revision_sha1', rr.revision_sha1)
 
 
106
    def from_element(cls, elt):
 
 
107
        return unpack_revision(elt)
 
 
109
    from_element = classmethod(from_element)
 
 
113
def unpack_revision(elt):
 
 
114
    """Convert XML element into Revision object."""
 
 
115
    # <changeset> is deprecated...
 
 
116
    from bzrlib.errors import BzrError
 
 
118
    if elt.tag not in ('revision', 'changeset'):
 
 
119
        raise BzrError("unexpected tag in revision file: %r" % elt)
 
 
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')
 
 
128
    precursor = elt.get('precursor')
 
 
129
    precursor_sha1 = elt.get('precursor_sha1')
 
 
131
    pelts = elt.find('parents')
 
 
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)
 
 
143
            prec_parent = rev.parents[0].revision_id
 
 
144
            assert prec_parent == 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)
 
 
151
    v = elt.get('timezone')
 
 
152
    rev.timezone = v and int(v)
 
 
154
    rev.message = elt.findtext('message') # text of <message>
 
 
159
REVISION_ID_RE = None
 
 
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:
 
 
166
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
 
 
168
    if not REVISION_ID_RE.match(rid):
 
 
169
        raise ValueError("malformed revision-id %r" % rid)