/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: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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