/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 breezy/bzr/xml8.py

  • Committer: Jelmer Vernooij
  • Date: 2018-11-23 01:35:56 UTC
  • mto: (7211.10.3 git-empty-dirs)
  • mto: This revision was merged to the branch mainline in revision 7215.
  • Revision ID: jelmer@jelmer.uk-20181123013556-mu7ct9ovl7fozjc2
Update comment about ssl.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/bzr/xml8.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
from io import BytesIO
 
20
 
 
21
from .. import (
 
22
    cache_utf8,
 
23
    lazy_regex,
 
24
    revision as _mod_revision,
 
25
    trace,
 
26
    )
 
27
from .xml_serializer import (
 
28
    Element,
 
29
    SubElement,
 
30
    XMLSerializer,
 
31
    encode_and_escape,
 
32
    escape_invalid_chars,
 
33
    get_utf8_or_ascii,
 
34
    serialize_inventory_flat,
 
35
    unpack_inventory_entry,
 
36
    unpack_inventory_flat,
 
37
    )
 
38
from ..revision import Revision
 
39
from ..sixish import unichr
 
40
from ..errors import BzrError
 
41
 
 
42
 
 
43
_xml_unescape_map = {
 
44
    b'apos': b"'",
 
45
    b'quot': b'"',
 
46
    b'amp': b'&',
 
47
    b'lt': b'<',
 
48
    b'gt': b'>'
 
49
}
 
50
 
 
51
 
 
52
def _unescaper(match, _map=_xml_unescape_map):
 
53
    code = match.group(1)
 
54
    try:
 
55
        return _map[code]
 
56
    except KeyError:
 
57
        if not code.startswith(b'#'):
 
58
            raise
 
59
        return unichr(int(code[1:])).encode('utf8')
 
60
 
 
61
 
 
62
_unescape_re = lazy_regex.lazy_compile(b'\\&([^;]*);')
 
63
 
 
64
 
 
65
def _unescape_xml(data):
 
66
    """Unescape predefined XML entities in a string of data."""
 
67
    return _unescape_re.sub(_unescaper, data)
 
68
 
 
69
 
 
70
class Serializer_v8(XMLSerializer):
 
71
    """This serialiser adds rich roots.
 
72
 
 
73
    Its revision format number matches its inventory number.
 
74
    """
 
75
 
 
76
    __slots__ = []
 
77
 
 
78
    root_id = None
 
79
    support_altered_by_hack = True
 
80
    # This format supports the altered-by hack that reads file ids directly out
 
81
    # of the versionedfile, without doing XML parsing.
 
82
 
 
83
    supported_kinds = {'file', 'directory', 'symlink'}
 
84
    format_num = b'8'
 
85
    revision_format_num = None
 
86
 
 
87
    # The search regex used by xml based repositories to determine what things
 
88
    # where changed in a single commit.
 
89
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
90
        b'file_id="(?P<file_id>[^"]+)"'
 
91
        b'.* revision="(?P<revision_id>[^"]+)"'
 
92
        )
 
93
 
 
94
    def _check_revisions(self, inv):
 
95
        """Extension point for subclasses to check during serialisation.
 
96
 
 
97
        :param inv: An inventory about to be serialised, to be checked.
 
98
        :raises: AssertionError if an error has occurred.
 
99
        """
 
100
        if inv.revision_id is None:
 
101
            raise AssertionError("inv.revision_id is None")
 
102
        if inv.root.revision is None:
 
103
            raise AssertionError("inv.root.revision is None")
 
104
 
 
105
    def _check_cache_size(self, inv_size, entry_cache):
 
106
        """Check that the entry_cache is large enough.
 
107
 
 
108
        We want the cache to be ~2x the size of an inventory. The reason is
 
109
        because we use a FIFO cache, and how Inventory records are likely to
 
110
        change. In general, you have a small number of records which change
 
111
        often, and a lot of records which do not change at all. So when the
 
112
        cache gets full, you actually flush out a lot of the records you are
 
113
        interested in, which means you need to recreate all of those records.
 
114
        An LRU Cache would be better, but the overhead negates the cache
 
115
        coherency benefit.
 
116
 
 
117
        One way to look at it, only the size of the cache > len(inv) is your
 
118
        'working' set. And in general, it shouldn't be a problem to hold 2
 
119
        inventories in memory anyway.
 
120
 
 
121
        :param inv_size: The number of entries in an inventory.
 
122
        """
 
123
        if entry_cache is None:
 
124
            return
 
125
        # 1.5 times might also be reasonable.
 
126
        recommended_min_cache_size = inv_size * 1.5
 
127
        if entry_cache.cache_size() < recommended_min_cache_size:
 
128
            recommended_cache_size = inv_size * 2
 
129
            trace.mutter('Resizing the inventory entry cache from %d to %d',
 
130
                         entry_cache.cache_size(), recommended_cache_size)
 
131
            entry_cache.resize(recommended_cache_size)
 
132
 
 
133
    def write_inventory_to_lines(self, inv):
 
134
        """Return a list of lines with the encoded inventory."""
 
135
        return self.write_inventory(inv, None)
 
136
 
 
137
    def write_inventory_to_string(self, inv, working=False):
 
138
        """Just call write_inventory with a BytesIO and return the value.
 
139
 
 
140
        :param working: If True skip history data - text_sha1, text_size,
 
141
            reference_revision, symlink_target.
 
142
        """
 
143
        sio = BytesIO()
 
144
        self.write_inventory(inv, sio, working)
 
145
        return sio.getvalue()
 
146
 
 
147
    def write_inventory(self, inv, f, working=False):
 
148
        """Write inventory to a file.
 
149
 
 
150
        :param inv: the inventory to write.
 
151
        :param f: the file to write. (May be None if the lines are the desired
 
152
            output).
 
153
        :param working: If True skip history data - text_sha1, text_size,
 
154
            reference_revision, symlink_target.
 
155
        :return: The inventory as a list of lines.
 
156
        """
 
157
        output = []
 
158
        append = output.append
 
159
        self._append_inventory_root(append, inv)
 
160
        serialize_inventory_flat(inv, append,
 
161
                                 self.root_id, self.supported_kinds, working)
 
162
        if f is not None:
 
163
            f.writelines(output)
 
164
        # Just to keep the cache from growing without bounds
 
165
        # but we may actually not want to do clear the cache
 
166
        # _clear_cache()
 
167
        return output
 
168
 
 
169
    def _append_inventory_root(self, append, inv):
 
170
        """Append the inventory root to output."""
 
171
        if inv.revision_id is not None:
 
172
            revid1 = b' revision_id="'
 
173
            revid2 = encode_and_escape(inv.revision_id)
 
174
        else:
 
175
            revid1 = b""
 
176
            revid2 = b""
 
177
        append(b'<inventory format="%s"%s%s>\n' % (
 
178
            self.format_num, revid1, revid2))
 
179
        append(b'<directory file_id="%s name="%s revision="%s />\n' % (
 
180
            encode_and_escape(inv.root.file_id),
 
181
            encode_and_escape(inv.root.name),
 
182
            encode_and_escape(inv.root.revision)))
 
183
 
 
184
    def _pack_revision(self, rev):
 
185
        """Revision object -> xml tree"""
 
186
        # For the XML format, we need to write them as Unicode rather than as
 
187
        # utf-8 strings. So that cElementTree can handle properly escaping
 
188
        # them.
 
189
        decode_utf8 = cache_utf8.decode
 
190
        revision_id = rev.revision_id
 
191
        format_num = self.format_num
 
192
        if self.revision_format_num is not None:
 
193
            format_num = self.revision_format_num
 
194
        root = Element('revision',
 
195
                       committer=rev.committer,
 
196
                       timestamp='%.3f' % rev.timestamp,
 
197
                       revision_id=decode_utf8(revision_id),
 
198
                       inventory_sha1=rev.inventory_sha1.decode('ascii'),
 
199
                       format=format_num.decode(),
 
200
                       )
 
201
        if rev.timezone is not None:
 
202
            root.set('timezone', str(rev.timezone))
 
203
        root.text = '\n'
 
204
        msg = SubElement(root, 'message')
 
205
        msg.text = escape_invalid_chars(rev.message)[0]
 
206
        msg.tail = '\n'
 
207
        if rev.parent_ids:
 
208
            pelts = SubElement(root, 'parents')
 
209
            pelts.tail = pelts.text = '\n'
 
210
            for parent_id in rev.parent_ids:
 
211
                _mod_revision.check_not_reserved_id(parent_id)
 
212
                p = SubElement(pelts, 'revision_ref')
 
213
                p.tail = '\n'
 
214
                p.set('revision_id', decode_utf8(parent_id))
 
215
        if rev.properties:
 
216
            self._pack_revision_properties(rev, root)
 
217
        return root
 
218
 
 
219
    def _pack_revision_properties(self, rev, under_element):
 
220
        top_elt = SubElement(under_element, 'properties')
 
221
        for prop_name, prop_value in sorted(rev.properties.items()):
 
222
            prop_elt = SubElement(top_elt, 'property')
 
223
            prop_elt.set('name', prop_name)
 
224
            prop_elt.text = prop_value
 
225
            prop_elt.tail = '\n'
 
226
        top_elt.tail = '\n'
 
227
 
 
228
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
 
229
        # This is here because it's overridden by xml7
 
230
        return unpack_inventory_entry(elt, entry_cache,
 
231
                                      return_from_cache)
 
232
 
 
233
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
 
234
                          return_from_cache=False):
 
235
        """Construct from XML Element"""
 
236
        inv = unpack_inventory_flat(elt, self.format_num, self._unpack_entry,
 
237
                                    entry_cache, return_from_cache)
 
238
        self._check_cache_size(len(inv), entry_cache)
 
239
        return inv
 
240
 
 
241
    def _unpack_revision(self, elt):
 
242
        """XML Element -> Revision object"""
 
243
        format = elt.get('format')
 
244
        format_num = self.format_num
 
245
        if self.revision_format_num is not None:
 
246
            format_num = self.revision_format_num
 
247
        if format is not None:
 
248
            if format.encode() != format_num:
 
249
                raise BzrError("invalid format version %r on revision"
 
250
                               % format)
 
251
        get_cached = get_utf8_or_ascii
 
252
        rev = Revision(committer=elt.get('committer'),
 
253
                       timestamp=float(elt.get('timestamp')),
 
254
                       revision_id=get_cached(elt.get('revision_id')),
 
255
                       inventory_sha1=elt.get('inventory_sha1').encode('ascii')
 
256
                       )
 
257
        parents = elt.find('parents') or []
 
258
        for p in parents:
 
259
            rev.parent_ids.append(get_cached(p.get('revision_id')))
 
260
        self._unpack_revision_properties(elt, rev)
 
261
        v = elt.get('timezone')
 
262
        if v is None:
 
263
            rev.timezone = 0
 
264
        else:
 
265
            rev.timezone = int(v)
 
266
        rev.message = elt.findtext('message')  # text of <message>
 
267
        return rev
 
268
 
 
269
    def _unpack_revision_properties(self, elt, rev):
 
270
        """Unpack properties onto a revision."""
 
271
        props_elt = elt.find('properties')
 
272
        if props_elt is None:
 
273
            return
 
274
        for prop_elt in props_elt:
 
275
            if prop_elt.tag != 'property':
 
276
                raise AssertionError(
 
277
                    "bad tag under properties list: %r" % prop_elt.tag)
 
278
            name = prop_elt.get('name')
 
279
            value = prop_elt.text
 
280
            # If a property had an empty value ('') cElementTree reads
 
281
            # that back as None, convert it back to '', so that all
 
282
            # properties have string values
 
283
            if value is None:
 
284
                value = ''
 
285
            if name in rev.properties:
 
286
                raise AssertionError("repeated property %r" % name)
 
287
            rev.properties[name] = value
 
288
 
 
289
    def _find_text_key_references(self, line_iterator):
 
290
        """Core routine for extracting references to texts from inventories.
 
291
 
 
292
        This performs the translation of xml lines to revision ids.
 
293
 
 
294
        :param line_iterator: An iterator of lines, origin_version_id
 
295
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
296
            to whether they were referred to by the inventory of the
 
297
            revision_id that they contain. Note that if that revision_id was
 
298
            not part of the line_iterator's output then False will be given -
 
299
            even though it may actually refer to that key.
 
300
        """
 
301
        if not self.support_altered_by_hack:
 
302
            raise AssertionError(
 
303
                "_find_text_key_references only "
 
304
                "supported for branches which store inventory as unnested xml"
 
305
                ", not on %r" % self)
 
306
        result = {}
 
307
 
 
308
        # this code needs to read every new line in every inventory for the
 
309
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
310
        # not present in one of those inventories is unnecessary but not
 
311
        # harmful because we are filtering by the revision id marker in the
 
312
        # inventory lines : we only select file ids altered in one of those
 
313
        # revisions. We don't need to see all lines in the inventory because
 
314
        # only those added in an inventory in rev X can contain a revision=X
 
315
        # line.
 
316
        unescape_revid_cache = {}
 
317
        unescape_fileid_cache = {}
 
318
 
 
319
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
320
        # of lines, so it has had a lot of inlining and optimizing done.
 
321
        # Sorry that it is a little bit messy.
 
322
        # Move several functions to be local variables, since this is a long
 
323
        # running loop.
 
324
        search = self._file_ids_altered_regex.search
 
325
        unescape = _unescape_xml
 
326
        setdefault = result.setdefault
 
327
        for line, line_key in line_iterator:
 
328
            match = search(line)
 
329
            if match is None:
 
330
                continue
 
331
            # One call to match.group() returning multiple items is quite a
 
332
            # bit faster than 2 calls to match.group() each returning 1
 
333
            file_id, revision_id = match.group('file_id', 'revision_id')
 
334
 
 
335
            # Inlining the cache lookups helps a lot when you make 170,000
 
336
            # lines and 350k ids, versus 8.4 unique ids.
 
337
            # Using a cache helps in 2 ways:
 
338
            #   1) Avoids unnecessary decoding calls
 
339
            #   2) Re-uses cached strings, which helps in future set and
 
340
            #      equality checks.
 
341
            # (2) is enough that removing encoding entirely along with
 
342
            # the cache (so we are using plain strings) results in no
 
343
            # performance improvement.
 
344
            try:
 
345
                revision_id = unescape_revid_cache[revision_id]
 
346
            except KeyError:
 
347
                unescaped = unescape(revision_id)
 
348
                unescape_revid_cache[revision_id] = unescaped
 
349
                revision_id = unescaped
 
350
 
 
351
            # Note that unconditionally unescaping means that we deserialise
 
352
            # every fileid, which for general 'pull' is not great, but we don't
 
353
            # really want to have some many fulltexts that this matters anyway.
 
354
            # RBC 20071114.
 
355
            try:
 
356
                file_id = unescape_fileid_cache[file_id]
 
357
            except KeyError:
 
358
                unescaped = unescape(file_id)
 
359
                unescape_fileid_cache[file_id] = unescaped
 
360
                file_id = unescaped
 
361
 
 
362
            key = (file_id, revision_id)
 
363
            setdefault(key, False)
 
364
            if revision_id == line_key[-1]:
 
365
                result[key] = True
 
366
        return result
 
367
 
 
368
 
 
369
serializer_v8 = Serializer_v8()