← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

  • Committer: Martin Pool
  • Date: 2005-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml4.py
1
 
#! /usr/bin/env python
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
from bzrlib.xml import ElementTree, SubElement, Element, Serializer
19
 
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
20
 
from bzrlib.revision import Revision        
21
 
from bzrlib.errors import BzrError
22
 
 
23
 
 
24
 
 
25
 
 
26
 
 
27
 
 
28
 
class _Serializer_v4(Serializer):
29
 
    """Version 0.0.4 serializer
30
 
 
31
 
    You should use the serialzer_v4 singleton."""
32
 
    
33
 
    __slots__ = []
34
 
    
35
 
    def _pack_inventory(self, inv):
36
 
        """Convert to XML Element"""
37
 
        e = Element('inventory')
38
 
        e.text = '\n'
39
 
        if inv.root.file_id not in (None, ROOT_ID):
40
 
            e.set('file_id', inv.root.file_id)
41
 
        for path, ie in inv.iter_entries():
42
 
            e.append(self._pack_entry(ie))
43
 
        return e
44
 
 
45
 
 
46
 
    def _pack_entry(self, ie):
47
 
        """Convert InventoryEntry to XML element"""
48
 
        e = Element('entry')
49
 
        e.set('name', ie.name)
50
 
        e.set('file_id', ie.file_id)
51
 
        e.set('kind', ie.kind)
52
 
 
53
 
        if ie.text_size != None:
54
 
            e.set('text_size', '%d' % ie.text_size)
55
 
 
56
 
        for f in ['text_id', 'text_sha1']:
57
 
            v = getattr(ie, f)
58
 
            if v != None:
59
 
                e.set(f, v)
60
 
 
61
 
        # to be conservative, we don't externalize the root pointers
62
 
        # for now, leaving them as null in the xml form.  in a future
63
 
        # version it will be implied by nested elements.
64
 
        if ie.parent_id != ROOT_ID:
65
 
            assert isinstance(ie.parent_id, basestring)
66
 
            e.set('parent_id', ie.parent_id)
67
 
 
68
 
        e.tail = '\n'
69
 
 
70
 
        return e
71
 
 
72
 
 
73
 
    def _unpack_inventory(self, elt):
74
 
        """Construct from XML Element
75
 
        """
76
 
        assert elt.tag == 'inventory'
77
 
        root_id = elt.get('file_id') or ROOT_ID
78
 
        inv = Inventory(root_id)
79
 
        for e in elt:
80
 
            ie = self._unpack_entry(e)
81
 
            if ie.parent_id == ROOT_ID:
82
 
                ie.parent_id = root_id
83
 
            inv.add(ie)
84
 
        return inv
85
 
 
86
 
 
87
 
    def _unpack_entry(self, elt):
88
 
        assert elt.tag == 'entry'
89
 
 
90
 
        ## original format inventories don't have a parent_id for
91
 
        ## nodes in the root directory, but it's cleaner to use one
92
 
        ## internally.
93
 
        parent_id = elt.get('parent_id')
94
 
        if parent_id == None:
95
 
            parent_id = ROOT_ID
96
 
 
97
 
        ie = InventoryEntry(elt.get('file_id'),
98
 
                            elt.get('name'),
99
 
                            elt.get('kind'),
100
 
                            parent_id)
101
 
        ie.text_id = elt.get('text_id')
102
 
        ie.text_sha1 = elt.get('text_sha1')
103
 
 
104
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
105
 
 
106
 
        v = elt.get('text_size')
107
 
        ie.text_size = v and int(v)
108
 
 
109
 
        return ie
110
 
 
111
 
 
112
 
    def _pack_revision(self, rev):
113
 
        """Revision object -> xml tree"""
114
 
        root = Element('revision',
115
 
                       committer = rev.committer,
116
 
                       timestamp = '%.9f' % rev.timestamp,
117
 
                       revision_id = rev.revision_id,
118
 
                       inventory_id = rev.inventory_id,
119
 
                       inventory_sha1 = rev.inventory_sha1,
120
 
                       )
121
 
        if rev.timezone:
122
 
            root.set('timezone', str(rev.timezone))
123
 
        root.text = '\n'
124
 
 
125
 
        msg = SubElement(root, 'message')
126
 
        msg.text = rev.message
127
 
        msg.tail = '\n'
128
 
 
129
 
        if rev.parents:
130
 
            pelts = SubElement(root, 'parents')
131
 
            pelts.tail = pelts.text = '\n'
132
 
            for i, parent_id in enumerate(rev.parents):
133
 
                p = SubElement(pelts, 'revision_ref')
134
 
                p.tail = '\n'
135
 
                assert parent_id
136
 
                p.set('revision_id', parent_id)
137
 
                if i < len(rev.parent_sha1s):
138
 
                    p.set('revision_sha1', rev.parent_sha1s[i])
139
 
        return root
140
 
 
141
 
    
142
 
    def _unpack_revision(self, elt):
143
 
        """XML Element -> Revision object"""
144
 
        
145
 
        # <changeset> is deprecated...
146
 
        if elt.tag not in ('revision', 'changeset'):
147
 
            raise BzrError("unexpected tag in revision file: %r" % elt)
148
 
 
149
 
        rev = Revision(committer = elt.get('committer'),
150
 
                       timestamp = float(elt.get('timestamp')),
151
 
                       revision_id = elt.get('revision_id'),
152
 
                       inventory_id = elt.get('inventory_id'),
153
 
                       inventory_sha1 = elt.get('inventory_sha1')
154
 
                       )
155
 
 
156
 
        precursor = elt.get('precursor')
157
 
        precursor_sha1 = elt.get('precursor_sha1')
158
 
 
159
 
        pelts = elt.find('parents')
160
 
 
161
 
        if pelts:
162
 
            for p in pelts:
163
 
                assert p.tag == 'revision_ref', \
164
 
                       "bad parent node tag %r" % p.tag
165
 
                rev.parent_ids.append(p.get('revision_id'))
166
 
                rev.parent_sha1s.append(p.get('revision_sha1'))
167
 
            if precursor:
168
 
                # must be consistent
169
 
                prec_parent = rev.parent_ids[0]
170
 
                assert prec_parent == precursor
171
 
        elif precursor:
172
 
            # revisions written prior to 0.0.5 have a single precursor
173
 
            # give as an attribute
174
 
            rev.parent_ids.append(precursor)
175
 
            rev.parent_sha1s.append(precursor_sha1)
176
 
 
177
 
        v = elt.get('timezone')
178
 
        rev.timezone = v and int(v)
179
 
 
180
 
        rev.message = elt.findtext('message') # text of <message>
181
 
        return rev
182
 
 
183
 
 
184
 
 
185
 
 
186
 
"""singleton instance"""
187
 
serializer_v4 = _Serializer_v4()
188