← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/weave_fmt/xml4.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/weave_fmt/xml4.py
1
 
#! /usr/bin/env python
2
 
 
 
1
# Copyright (C) 2005-2010 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
 
# 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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
from bzrlib.xml_serializer import (
 
20
    Element,
 
21
    SubElement,
 
22
    XMLSerializer,
 
23
    escape_invalid_chars,
 
24
    )
 
25
from bzrlib.inventory import ROOT_ID, Inventory
20
26
import bzrlib.inventory as inventory
21
 
from bzrlib.revision import Revision        
 
27
from bzrlib.revision import Revision
22
28
from bzrlib.errors import BzrError
23
29
 
24
30
 
25
 
 
26
 
 
27
 
 
28
 
 
29
 
class _Serializer_v4(Serializer):
 
31
class _Serializer_v4(XMLSerializer):
30
32
    """Version 0.0.4 serializer
31
33
 
32
 
    You should use the serialzer_v4 singleton."""
33
 
    
 
34
    You should use the serializer_v4 singleton.
 
35
 
 
36
    v4 serialisation is no longer supported, only deserialisation.
 
37
    """
 
38
 
34
39
    __slots__ = []
35
 
    
36
 
    def _pack_inventory(self, inv):
37
 
        """Convert to XML Element"""
38
 
        e = Element('inventory')
39
 
        e.text = '\n'
40
 
        if inv.root.file_id not in (None, ROOT_ID):
41
 
            e.set('file_id', inv.root.file_id)
42
 
        for path, ie in inv.iter_entries():
43
 
            e.append(self._pack_entry(ie))
44
 
        return e
45
 
 
46
40
 
47
41
    def _pack_entry(self, ie):
48
42
        """Convert InventoryEntry to XML element"""
51
45
        e.set('file_id', ie.file_id)
52
46
        e.set('kind', ie.kind)
53
47
 
54
 
        if ie.text_size != None:
 
48
        if ie.text_size is not None:
55
49
            e.set('text_size', '%d' % ie.text_size)
56
50
 
57
51
        for f in ['text_id', 'text_sha1', 'symlink_target']:
58
52
            v = getattr(ie, f)
59
 
            if v != None:
 
53
            if v is not None:
60
54
                e.set(f, v)
61
55
 
62
56
        # to be conservative, we don't externalize the root pointers
63
57
        # for now, leaving them as null in the xml form.  in a future
64
58
        # version it will be implied by nested elements.
65
59
        if ie.parent_id != ROOT_ID:
66
 
            assert isinstance(ie.parent_id, basestring)
67
60
            e.set('parent_id', ie.parent_id)
68
61
 
69
62
        e.tail = '\n'
71
64
        return e
72
65
 
73
66
 
74
 
    def _unpack_inventory(self, elt):
 
67
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
 
68
                          return_from_cache=False):
75
69
        """Construct from XML Element
 
70
 
 
71
        :param revision_id: Ignored parameter used by xml5.
76
72
        """
77
 
        assert elt.tag == 'inventory'
78
73
        root_id = elt.get('file_id') or ROOT_ID
79
74
        inv = Inventory(root_id)
80
75
        for e in elt:
81
 
            ie = self._unpack_entry(e)
 
76
            ie = self._unpack_entry(e, entry_cache=entry_cache,
 
77
                                    return_from_cache=return_from_cache)
82
78
            if ie.parent_id == ROOT_ID:
83
79
                ie.parent_id = root_id
84
80
            inv.add(ie)
85
81
        return inv
86
82
 
87
83
 
88
 
    def _unpack_entry(self, elt):
89
 
        assert elt.tag == 'entry'
90
 
 
 
84
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
91
85
        ## original format inventories don't have a parent_id for
92
86
        ## nodes in the root directory, but it's cleaner to use one
93
87
        ## internally.
94
88
        parent_id = elt.get('parent_id')
95
 
        if parent_id == None:
 
89
        if parent_id is None:
96
90
            parent_id = ROOT_ID
97
91
 
98
92
        kind = elt.get('kind')
116
110
        else:
117
111
            raise BzrError("unknown kind %r" % kind)
118
112
 
119
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
113
        ## mutter("read inventoryentry: %r", elt.attrib)
120
114
 
121
115
        return ie
122
116
 
135
129
        root.text = '\n'
136
130
 
137
131
        msg = SubElement(root, 'message')
138
 
        msg.text = rev.message
 
132
        msg.text = escape_invalid_chars(rev.message)[0]
139
133
        msg.tail = '\n'
140
134
 
141
135
        if rev.parents:
144
138
            for i, parent_id in enumerate(rev.parents):
145
139
                p = SubElement(pelts, 'revision_ref')
146
140
                p.tail = '\n'
147
 
                assert parent_id
148
141
                p.set('revision_id', parent_id)
149
142
                if i < len(rev.parent_sha1s):
150
143
                    p.set('revision_sha1', rev.parent_sha1s[i])
151
144
        return root
152
145
 
153
 
    
 
146
 
154
147
    def _unpack_revision(self, elt):
155
148
        """XML Element -> Revision object"""
156
 
        
 
149
 
157
150
        # <changeset> is deprecated...
158
151
        if elt.tag not in ('revision', 'changeset'):
159
152
            raise BzrError("unexpected tag in revision file: %r" % elt)
172
165
 
173
166
        if pelts:
174
167
            for p in pelts:
175
 
                assert p.tag == 'revision_ref', \
176
 
                       "bad parent node tag %r" % p.tag
177
168
                rev.parent_ids.append(p.get('revision_id'))
178
169
                rev.parent_sha1s.append(p.get('revision_sha1'))
179
170
            if precursor:
180
171
                # must be consistent
181
172
                prec_parent = rev.parent_ids[0]
182
 
                assert prec_parent == precursor
183
173
        elif precursor:
184
174
            # revisions written prior to 0.0.5 have a single precursor
185
175
            # give as an attribute