← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-10 15:46:03 UTC
  • mfrom: (4985.3.21 update)
  • mto: This revision was merged to the branch mainline in revision 5021.
  • Revision ID: v.ladeuil+lp@free.fr-20100210154603-k4no1gvfuqpzrw7p
https://launchpad.net/bugs/113809
Update performs two merges in a more logical order but stop on conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""XML externalization support."""
18
18
 
22
22
# importing this module is fairly slow because it has to load several
23
23
# ElementTree bits
24
24
 
25
 
from bzrlib import registry
 
25
from bzrlib.serializer import Serializer
26
26
from bzrlib.trace import mutter, warning
27
27
 
28
28
try:
49
49
from bzrlib import errors
50
50
 
51
51
 
52
 
class Serializer(object):
53
 
    """Abstract object serialize/deserialize"""
54
 
 
55
 
    def write_inventory(self, inv, f):
56
 
        """Write inventory to a file"""
57
 
        raise NotImplementedError(self.write_inventory)
58
 
 
59
 
    def write_inventory_to_string(self, inv):
60
 
        raise NotImplementedError(self.write_inventory_to_string)
 
52
class XMLSerializer(Serializer):
 
53
    """Abstract XML object serialize/deserialize"""
 
54
 
 
55
    squashes_xml_invalid_characters = True
61
56
 
62
57
    def read_inventory_from_string(self, xml_string, revision_id=None,
63
 
                                   entry_cache=None):
 
58
                                   entry_cache=None, return_from_cache=False):
64
59
        """Read xml_string into an inventory object.
65
60
 
66
61
        :param xml_string: The xml to read.
74
69
        :param entry_cache: An optional cache of InventoryEntry objects. If
75
70
            supplied we will look up entries via (file_id, revision_id) which
76
71
            should map to a valid InventoryEntry (File/Directory/etc) object.
 
72
        :param return_from_cache: Return entries directly from the cache,
 
73
            rather than copying them first. This is only safe if the caller
 
74
            promises not to mutate the returned inventory entries, but it can
 
75
            make some operations significantly faster.
77
76
        """
78
77
        try:
79
78
            return self._unpack_inventory(fromstring(xml_string), revision_id,
80
 
                                          entry_cache=entry_cache)
 
79
                                          entry_cache=entry_cache,
 
80
                                          return_from_cache=return_from_cache)
81
81
        except ParseError, e:
82
82
            raise errors.UnexpectedInventoryFormat(e)
83
83
 
122
122
    }
123
123
def _escape_replace(match, map=escape_map):
124
124
    return map[match.group()]
125
 
 
 
125
 
126
126
def _escape_attrib(text, encoding=None, replace=None):
127
127
    # escape attribute value
128
128
    try:
153
153
    }
154
154
def _escape_cdata_replace(match, map=escape_cdata_map):
155
155
    return map[match.group()]
156
 
 
 
156
 
157
157
def _escape_cdata(text, encoding=None, replace=None):
158
158
    # escape character data
159
159
    try:
175
175
elementtree.ElementTree._escape_cdata = _escape_cdata
176
176
 
177
177
 
178
 
class SerializerRegistry(registry.Registry):
179
 
    """Registry for serializer objects"""
180
 
 
181
 
 
182
 
format_registry = SerializerRegistry()
183
 
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
184
 
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
185
 
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
186
 
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
187
 
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')
 
178
def escape_invalid_chars(message):
 
179
    """Escape the XML-invalid characters in a commit message.
 
180
 
 
181
    :param message: Commit message to escape
 
182
    :return: tuple with escaped message and number of characters escaped
 
183
    """
 
184
    if message is None:
 
185
        return None, 0
 
186
    # Python strings can include characters that can't be
 
187
    # represented in well-formed XML; escape characters that
 
188
    # aren't listed in the XML specification
 
189
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
190
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
191
            lambda match: match.group(0).encode('unicode_escape'),
 
192
            message)