/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/xml_serializer.py

  • Committer: Vincent Ladeuil
  • Date: 2010-09-24 08:40:33 UTC
  • mto: This revision was merged to the branch mainline in revision 5446.
  • Revision ID: v.ladeuil+lp@free.fr-20100924084033-0ehn0nrovthrhuvo
Fix typo in Branch.pre_commit HookPoint docstring.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.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
"""XML externalization support."""
 
18
 
 
19
# "XML is like violence: if it doesn't solve your problem, you aren't
 
20
# using enough of it." -- various
 
21
 
 
22
# importing this module is fairly slow because it has to load several
 
23
# ElementTree bits
 
24
 
 
25
import re
 
26
 
 
27
from bzrlib.serializer import Serializer
 
28
from bzrlib.trace import mutter
 
29
 
 
30
try:
 
31
    try:
 
32
        # it's in this package in python2.5
 
33
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
 
34
            XMLTreeBuilder, fromstring, tostring)
 
35
        import xml.etree as elementtree
 
36
    except ImportError:
 
37
        from cElementTree import (ElementTree, SubElement, Element,
 
38
                                  XMLTreeBuilder, fromstring, tostring)
 
39
        import elementtree.ElementTree
 
40
    ParseError = SyntaxError
 
41
except ImportError:
 
42
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
 
43
           " and make sure it's on your PYTHONPATH")
 
44
    # this copy is shipped with bzr
 
45
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
46
                                              Element, XMLTreeBuilder,
 
47
                                              fromstring, tostring)
 
48
    import util.elementtree as elementtree
 
49
    from xml.parsers.expat import ExpatError as ParseError
 
50
 
 
51
from bzrlib import errors
 
52
 
 
53
 
 
54
class XMLSerializer(Serializer):
 
55
    """Abstract XML object serialize/deserialize"""
 
56
 
 
57
    squashes_xml_invalid_characters = True
 
58
 
 
59
    def read_inventory_from_string(self, xml_string, revision_id=None,
 
60
                                   entry_cache=None, return_from_cache=False):
 
61
        """Read xml_string into an inventory object.
 
62
 
 
63
        :param xml_string: The xml to read.
 
64
        :param revision_id: If not-None, the expected revision id of the
 
65
            inventory. Some serialisers use this to set the results' root
 
66
            revision. This should be supplied for deserialising all
 
67
            from-repository inventories so that xml5 inventories that were
 
68
            serialised without a revision identifier can be given the right
 
69
            revision id (but not for working tree inventories where users can
 
70
            edit the data without triggering checksum errors or anything).
 
71
        :param entry_cache: An optional cache of InventoryEntry objects. If
 
72
            supplied we will look up entries via (file_id, revision_id) which
 
73
            should map to a valid InventoryEntry (File/Directory/etc) object.
 
74
        :param return_from_cache: Return entries directly from the cache,
 
75
            rather than copying them first. This is only safe if the caller
 
76
            promises not to mutate the returned inventory entries, but it can
 
77
            make some operations significantly faster.
 
78
        """
 
79
        try:
 
80
            return self._unpack_inventory(fromstring(xml_string), revision_id,
 
81
                                          entry_cache=entry_cache,
 
82
                                          return_from_cache=return_from_cache)
 
83
        except ParseError, e:
 
84
            raise errors.UnexpectedInventoryFormat(e)
 
85
 
 
86
    def read_inventory(self, f, revision_id=None):
 
87
        try:
 
88
            try:
 
89
                return self._unpack_inventory(self._read_element(f),
 
90
                    revision_id=None)
 
91
            finally:
 
92
                f.close()
 
93
        except ParseError, e:
 
94
            raise errors.UnexpectedInventoryFormat(e)
 
95
 
 
96
    def write_revision(self, rev, f):
 
97
        self._write_element(self._pack_revision(rev), f)
 
98
 
 
99
    def write_revision_to_string(self, rev):
 
100
        return tostring(self._pack_revision(rev)) + '\n'
 
101
 
 
102
    def read_revision(self, f):
 
103
        return self._unpack_revision(self._read_element(f))
 
104
 
 
105
    def read_revision_from_string(self, xml_string):
 
106
        return self._unpack_revision(fromstring(xml_string))
 
107
 
 
108
    def _write_element(self, elt, f):
 
109
        ElementTree(elt).write(f, 'utf-8')
 
110
        f.write('\n')
 
111
 
 
112
    def _read_element(self, f):
 
113
        return ElementTree().parse(f)
 
114
 
 
115
 
 
116
def escape_invalid_chars(message):
 
117
    """Escape the XML-invalid characters in a commit message.
 
118
 
 
119
    :param message: Commit message to escape
 
120
    :return: tuple with escaped message and number of characters escaped
 
121
    """
 
122
    if message is None:
 
123
        return None, 0
 
124
    # Python strings can include characters that can't be
 
125
    # represented in well-formed XML; escape characters that
 
126
    # aren't listed in the XML specification
 
127
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
128
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
129
            lambda match: match.group(0).encode('unicode_escape'),
 
130
            message)