/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml4.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
7
 
#
 
5
 
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
9
# GNU General Public License for more details.
12
 
#
 
10
 
13
11
# You should have received a copy of the GNU General Public License
14
12
# 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
 
from ...bzr.xml_serializer import (
18
 
    Element,
19
 
    SubElement,
20
 
    XMLSerializer,
21
 
    escape_invalid_chars,
22
 
    )
23
 
from ...bzr.inventory import ROOT_ID, Inventory
24
 
from ...bzr import inventory
25
 
from ...revision import Revision
26
 
from ...errors import BzrError
27
 
 
28
 
 
29
 
class _Serializer_v4(XMLSerializer):
 
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
14
 
 
15
 
 
16
from bzrlib.xml import ElementTree, SubElement, Element, Serializer
 
17
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
18
import bzrlib.inventory as inventory
 
19
from bzrlib.revision import Revision        
 
20
from bzrlib.errors import BzrError
 
21
 
 
22
 
 
23
 
 
24
 
 
25
 
 
26
 
 
27
class _Serializer_v4(Serializer):
30
28
    """Version 0.0.4 serializer
31
29
 
32
 
    You should use the serializer_v4 singleton.
33
 
 
34
 
    v4 serialisation is no longer supported, only deserialisation.
35
 
    """
36
 
 
 
30
    You should use the serialzer_v4 singleton."""
 
31
    
37
32
    __slots__ = []
 
33
    
 
34
    def _pack_inventory(self, inv):
 
35
        """Convert to XML Element"""
 
36
        e = Element('inventory')
 
37
        e.text = '\n'
 
38
        if inv.root.file_id not in (None, ROOT_ID):
 
39
            e.set('file_id', inv.root.file_id)
 
40
        for path, ie in inv.iter_entries():
 
41
            e.append(self._pack_entry(ie))
 
42
        return e
 
43
 
38
44
 
39
45
    def _pack_entry(self, ie):
40
46
        """Convert InventoryEntry to XML element"""
41
47
        e = Element('entry')
42
48
        e.set('name', ie.name)
43
 
        e.set('file_id', ie.file_id.decode('ascii'))
 
49
        e.set('file_id', ie.file_id)
44
50
        e.set('kind', ie.kind)
45
51
 
46
 
        if ie.text_size is not None:
 
52
        if ie.text_size != None:
47
53
            e.set('text_size', '%d' % ie.text_size)
48
54
 
49
55
        for f in ['text_id', 'text_sha1', 'symlink_target']:
50
56
            v = getattr(ie, f)
51
 
            if v is not None:
 
57
            if v != None:
52
58
                e.set(f, v)
53
59
 
54
60
        # to be conservative, we don't externalize the root pointers
55
61
        # for now, leaving them as null in the xml form.  in a future
56
62
        # version it will be implied by nested elements.
57
63
        if ie.parent_id != ROOT_ID:
 
64
            assert isinstance(ie.parent_id, basestring)
58
65
            e.set('parent_id', ie.parent_id)
59
66
 
60
67
        e.tail = '\n'
61
68
 
62
69
        return e
63
70
 
64
 
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
65
 
                          return_from_cache=False):
 
71
 
 
72
    def _unpack_inventory(self, elt):
66
73
        """Construct from XML Element
67
 
 
68
 
        :param revision_id: Ignored parameter used by xml5.
69
74
        """
70
 
        root_id = elt.get('file_id')
71
 
        root_id = (root_id.encode('ascii') if root_id else ROOT_ID)
 
75
        assert elt.tag == 'inventory'
 
76
        root_id = elt.get('file_id') or ROOT_ID
72
77
        inv = Inventory(root_id)
73
78
        for e in elt:
74
 
            ie = self._unpack_entry(e, entry_cache=entry_cache,
75
 
                                    return_from_cache=return_from_cache)
 
79
            ie = self._unpack_entry(e)
76
80
            if ie.parent_id == ROOT_ID:
77
81
                ie.parent_id = root_id
78
82
            inv.add(ie)
79
83
        return inv
80
84
 
81
 
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
82
 
        # original format inventories don't have a parent_id for
83
 
        # nodes in the root directory, but it's cleaner to use one
84
 
        # internally.
 
85
 
 
86
    def _unpack_entry(self, elt):
 
87
        assert elt.tag == 'entry'
 
88
 
 
89
        ## original format inventories don't have a parent_id for
 
90
        ## nodes in the root directory, but it's cleaner to use one
 
91
        ## internally.
85
92
        parent_id = elt.get('parent_id')
86
 
        parent_id = (parent_id.encode('ascii') if parent_id else ROOT_ID)
 
93
        if parent_id == None:
 
94
            parent_id = ROOT_ID
87
95
 
88
 
        file_id = elt.get('file_id').encode('ascii')
89
96
        kind = elt.get('kind')
90
97
        if kind == 'directory':
91
 
            ie = inventory.InventoryDirectory(file_id,
 
98
            ie = inventory.InventoryDirectory(elt.get('file_id'),
92
99
                                              elt.get('name'),
93
100
                                              parent_id)
94
101
        elif kind == 'file':
95
 
            ie = inventory.InventoryFile(file_id,
 
102
            ie = inventory.InventoryFile(elt.get('file_id'),
96
103
                                         elt.get('name'),
97
104
                                         parent_id)
98
105
            ie.text_id = elt.get('text_id')
99
 
            if ie.text_id is not None:
100
 
                ie.text_id = ie.text_id.encode('utf-8')
101
106
            ie.text_sha1 = elt.get('text_sha1')
102
 
            if ie.text_sha1 is not None:
103
 
                ie.text_sha1 = ie.text_sha1.encode('ascii')
104
107
            v = elt.get('text_size')
105
108
            ie.text_size = v and int(v)
106
109
        elif kind == 'symlink':
107
 
            ie = inventory.InventoryLink(file_id,
 
110
            ie = inventory.InventoryLink(elt.get('file_id'),
108
111
                                         elt.get('name'),
109
112
                                         parent_id)
110
113
            ie.symlink_target = elt.get('symlink_target')
115
118
 
116
119
        return ie
117
120
 
 
121
 
118
122
    def _pack_revision(self, rev):
119
123
        """Revision object -> xml tree"""
120
124
        root = Element('revision',
121
 
                       committer=rev.committer,
122
 
                       timestamp='%.9f' % rev.timestamp,
123
 
                       revision_id=rev.revision_id,
124
 
                       inventory_id=rev.inventory_id,
125
 
                       inventory_sha1=rev.inventory_sha1,
 
125
                       committer = rev.committer,
 
126
                       timestamp = '%.9f' % rev.timestamp,
 
127
                       revision_id = rev.revision_id,
 
128
                       inventory_id = rev.inventory_id,
 
129
                       inventory_sha1 = rev.inventory_sha1,
126
130
                       )
127
131
        if rev.timezone:
128
132
            root.set('timezone', str(rev.timezone))
129
133
        root.text = '\n'
130
134
 
131
135
        msg = SubElement(root, 'message')
132
 
        msg.text = escape_invalid_chars(rev.message)[0]
 
136
        msg.text = rev.message
133
137
        msg.tail = '\n'
134
138
 
135
139
        if rev.parents:
138
142
            for i, parent_id in enumerate(rev.parents):
139
143
                p = SubElement(pelts, 'revision_ref')
140
144
                p.tail = '\n'
 
145
                assert parent_id
141
146
                p.set('revision_id', parent_id)
142
147
                if i < len(rev.parent_sha1s):
143
148
                    p.set('revision_sha1', rev.parent_sha1s[i])
144
149
        return root
145
150
 
146
 
    def write_revision_to_string(self, rev):
147
 
        return tostring(self._pack_revision(rev)) + b'\n'
148
 
 
149
 
    def _write_element(self, elt, f):
150
 
        ElementTree(elt).write(f, 'utf-8')
151
 
        f.write(b'\n')
152
 
 
 
151
    
153
152
    def _unpack_revision(self, elt):
154
153
        """XML Element -> Revision object"""
155
 
 
 
154
        
156
155
        # <changeset> is deprecated...
157
156
        if elt.tag not in ('revision', 'changeset'):
158
157
            raise BzrError("unexpected tag in revision file: %r" % elt)
159
158
 
160
 
        rev = Revision(committer=elt.get('committer'),
161
 
                       timestamp=float(elt.get('timestamp')),
162
 
                       revision_id=elt.get('revision_id'),
163
 
                       inventory_id=elt.get('inventory_id'),
164
 
                       inventory_sha1=elt.get('inventory_sha1')
 
159
        rev = Revision(committer = elt.get('committer'),
 
160
                       timestamp = float(elt.get('timestamp')),
 
161
                       revision_id = elt.get('revision_id'),
 
162
                       inventory_id = elt.get('inventory_id'),
 
163
                       inventory_sha1 = elt.get('inventory_sha1')
165
164
                       )
166
165
 
167
166
        precursor = elt.get('precursor')
171
170
 
172
171
        if pelts:
173
172
            for p in pelts:
 
173
                assert p.tag == 'revision_ref', \
 
174
                       "bad parent node tag %r" % p.tag
174
175
                rev.parent_ids.append(p.get('revision_id'))
175
176
                rev.parent_sha1s.append(p.get('revision_sha1'))
176
177
            if precursor:
177
178
                # must be consistent
178
179
                prec_parent = rev.parent_ids[0]
 
180
                assert prec_parent == precursor
179
181
        elif precursor:
180
182
            # revisions written prior to 0.0.5 have a single precursor
181
183
            # give as an attribute
185
187
        v = elt.get('timezone')
186
188
        rev.timezone = v and int(v)
187
189
 
188
 
        rev.message = elt.findtext('message')  # text of <message>
 
190
        rev.message = elt.findtext('message') # text of <message>
189
191
        return rev
190
192
 
191
193
 
 
194
 
 
195
 
192
196
"""singleton instance"""
193
197
serializer_v4 = _Serializer_v4()
 
198